rename cap and rem; bump versions

package.json

@@ -1,6 +1,6 @@
 {
   "name": "unofficial-umdearborn-catalog-api",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Unofficial course catalog APIs for the University of Michigan-Dearborn",
   "main": "./dist/src/library.js",
   "typings": "./src/library.ts",

src/parsers/schedule-detail.ts

@@ -4,7 +4,7 @@ import { range } from 'lodash';
 import { decode } from 'he';
 
 export function parseCapacityAndRemaining(seatsTbody: HTMLTableSectionElement) {
-  const empty = { cap: NaN, rem: NaN };
+  const empty = { capacity: NaN, remaining: NaN };
   const rows = (Array
     .from(seatsTbody.children)
     .filter(elem => elem.tagName.toLowerCase().trim() === 'tr')
@@ -50,13 +50,13 @@ export function parseCapacityAndRemaining(seatsTbody: HTMLTableSectionElement) {
   );
 
   if (result.crosslistseats) {
-    const cap = result.crosslistseats && result.crosslistseats.capacity || NaN;
-    const rem = result.crosslistseats && result.crosslistseats.remaining || NaN;
-    return { cap, rem };
+    const capacity = result.crosslistseats && result.crosslistseats.capacity || NaN;
+    const remaining = result.crosslistseats && result.crosslistseats.remaining || NaN;
+    return { capacity, remaining };
   } else if (result.seats) {
-    const cap = result.seats && result.seats.capacity || NaN;
-    const rem = result.seats && result.seats.remaining || NaN;
-    return { cap, rem };
+    const capacity = result.seats && result.seats.capacity || NaN;
+    const remaining = result.seats && result.seats.remaining || NaN;
+    return { capacity, remaining };
   }
 
   return empty;
@@ -114,15 +114,15 @@ export function parseCrossListedCourses(infoCell: Element) {
 }
 
 type ScheduleDetailResult = {
-  cap: number,
-  rem: number,
+  capacity: number,
+  remaining: number,
   credits: number,
   creditsMin: number | undefined,
   crossList: [string, string][],
 };
 
 /**
- * captures the `cap` and `rem` of a section detail HTML
+ * captures the `capacity` and `remaining` of a section detail HTML
  */
 export function parseScheduleDetail(html: string) {
   const document = new JSDOM(html).window.document;

swagger.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: Unofficial UMDearborn Catalog API
-  version: 0.2.0
+  version: 0.3.0
 components:
   schemas:
     term:

test/parsers/schedule-detail.test.ts

@@ -15,8 +15,8 @@ describe(`schedule detail parser`, function () {
   it(`parsers 'schedule-detail.html'`, function () {
     const result = parseScheduleDetail(scheduleDetailHtml);
     expect(result).to.be.deep.equal({
-      cap: 35,
-      rem: 1,
+      capacity: 35,
+      remaining: 1,
       credits: 4,
       creditsMin: undefined,
       crossList: [['ECE', '478']]
@@ -27,9 +27,9 @@ describe(`schedule detail parser`, function () {
       '.datadisplaytable tbody .datadisplaytable tbody'
     ) as HTMLTableSectionElement | null;
 
-    const { cap, rem } = parseCapacityAndRemaining(seatsTbody || document.createElement('tbody'));
-    expect(cap).to.be.equal(35);
-    expect(rem).to.be.equal(1);
+    const { capacity, remaining } = parseCapacityAndRemaining(seatsTbody || document.createElement('tbody'));
+    expect(capacity).to.be.equal(35);
+    expect(remaining).to.be.equal(1);
   });
   it(`parses the credits or credit range`, function () {
     const infoCell = document.querySelector(