use commonjs module for now as the tooling support for ES6 modules is not mature yet

Author: miklcct

.eslintrc

@@ -5,7 +5,10 @@
         "@typescript-eslint"
     ],
     "parserOptions" : {
-        "project" : ["./tsconfig.json"]
+        "project" : ["./tsconfig.eslint.json"]
+    },
+    "env" : {
+        "node" : true
     },
     "extends" : [
         "eslint:recommended",
@@ -14,12 +17,6 @@
         "plugin:@typescript-eslint/recommended-requiring-type-checking"
     ],
     "overrides" : [
-        {
-            "rules" : {
-                "no-debugger" : "off"
-            },
-            "files" : "**"
-        },
         {
             "files" : "*.js",
             "rules": {

.github/workflows/node.js.yml

@@ -11,10 +11,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        node-version: [ 10.x, 12.x, 14.x ]
+
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
         with:
-          node-version: 14.x
+          node-version: ${{ matrix.node-version }}
       - run: yarn
       - run: yarn prepack

.idea/inspectionProfiles/Project_Default.xml

@@ -4,39 +4,56 @@ This is a library for getting KMB data. It can get routes, stops, variants, and
 ## Example Usage
 ### Loading the library
 ```js
-// load the main API class
-import Kmb from "js-kmb-api";
-// load the type definitions
-import {Language, Stop, Stop, Route, Variant, StopRoute, Eta} from "js-kmb-api"
-```
+// import the library class
+const Kmb = require('js-kmb-api').default;
 
-### Using the library
-```js
-// create an API instance
+// create an API instance using the default setting
+const kmb = new Kmb;
+
+// create an API instance with caching in the browser
 // It's recommended to use localStorage to cache stops, and sessionStorage to cache stop routes
 // because stop names do not change often and are reloaded automatically
 const kmb = new Kmb('en', localStorage, sessionStorage);
+```
 
-// create an API instance without caching
-const kmb_no_cache = new Kmb('zh-hans');
-
-// Load the routes (directions) named '104'
-const routes = await kmb.getRoutes('104');
-
-// Load the main variant of the forward direction
-const variants = await routes.filter(route => route.bound === 1).getVariants();
-const variant = await variants.sort((a, b) => a.serviceType - b.serviceType)[0];
+### Using the library
+Refer to the `example-javascript.js` or `example-typescript.ts` files for the following example in a runnable form.
+```js
+// Load the forward route of 104
+const route = (await kmb.getRoutes('104')).find(route => route.bound === 1);
+if (route === undefined) {
+    throw new Error('route is not found');
+}
+
+// load the main variant
+const variant = (await route.getVariants()).sort((a, b) => a.serviceType - b.serviceType)[0];
+if (variant === undefined) {
+    throw new Error('No variants are found');
+}
 
 // Load the stop list of the main variant
 const stoppings = await variant.getStoppings();
 
 // Find a stop called "Immigration Tower"
 const stopping = stoppings.find(stopping => stopping.stop.name === 'Immigration Tower');
+if (stopping === undefined) {
+    throw new Error('Stop is not found');
+}
 
 // Get the ETA there
-const etas = await stopping.getEtas(); 
+const etas = await stopping.getEtas();
+console.log(etas);
 
-````
+// Get the stoppings of all other routes for that stop
+const stoppings_at_immigration_tower = await stopping.stop.getStoppings();
+console.log(stoppings_at_immigration_tower);
+```
+
+To run the example, use
+```shell script
+node example-javascript.js # Javascript example
+ts-node example-typescript.ts # Typescript example
+```
 
 ## Classes
 All the classes below are inside the kmb object tying them to the API instance

README.md

@@ -0,0 +1,99 @@
+Certificate:
+    Data:
+        Version: 3 (0x2)
+        Serial Number: 7 (0x7)
+        Signature Algorithm: sha256WithRSAEncryption
+        Issuer: C = US, ST = Arizona, L = Scottsdale, O = "GoDaddy.com, Inc.", CN = Go Daddy Root Certificate Authority - G2
+        Validity
+            Not Before: May  3 07:00:00 2011 GMT
+            Not After : May  3 07:00:00 2031 GMT
+        Subject: C = US, ST = Arizona, L = Scottsdale, O = "GoDaddy.com, Inc.", OU = http://certs.godaddy.com/repository/, CN = Go Daddy Secure Certificate Authority - G2
+        Subject Public Key Info:
+            Public Key Algorithm: rsaEncryption
+                RSA Public-Key: (2048 bit)
+                Modulus:
+                    00:b9:e0:cb:10:d4:af:76:bd:d4:93:62:eb:30:64:
+                    b8:81:08:6c:c3:04:d9:62:17:8e:2f:ff:3e:65:cf:
+                    8f:ce:62:e6:3c:52:1c:da:16:45:4b:55:ab:78:6b:
+                    63:83:62:90:ce:0f:69:6c:99:c8:1a:14:8b:4c:cc:
+                    45:33:ea:88:dc:9e:a3:af:2b:fe:80:61:9d:79:57:
+                    c4:cf:2e:f4:3f:30:3c:5d:47:fc:9a:16:bc:c3:37:
+                    96:41:51:8e:11:4b:54:f8:28:be:d0:8c:be:f0:30:
+                    38:1e:f3:b0:26:f8:66:47:63:6d:de:71:26:47:8f:
+                    38:47:53:d1:46:1d:b4:e3:dc:00:ea:45:ac:bd:bc:
+                    71:d9:aa:6f:00:db:db:cd:30:3a:79:4f:5f:4c:47:
+                    f8:1d:ef:5b:c2:c4:9d:60:3b:b1:b2:43:91:d8:a4:
+                    33:4e:ea:b3:d6:27:4f:ad:25:8a:a5:c6:f4:d5:d0:
+                    a6:ae:74:05:64:57:88:b5:44:55:d4:2d:2a:3a:3e:
+                    f8:b8:bd:e9:32:0a:02:94:64:c4:16:3a:50:f1:4a:
+                    ae:e7:79:33:af:0c:20:07:7f:e8:df:04:39:c2:69:
+                    02:6c:63:52:fa:77:c1:1b:c8:74:87:c8:b9:93:18:
+                    50:54:35:4b:69:4e:bc:3b:d3:49:2e:1f:dc:c1:d2:
+                    52:fb
+                Exponent: 65537 (0x10001)
+        X509v3 extensions:
+            X509v3 Basic Constraints: critical
+                CA:TRUE
+            X509v3 Key Usage: critical
+                Certificate Sign, CRL Sign
+            X509v3 Subject Key Identifier:
+                40:C2:BD:27:8E:CC:34:83:30:A2:33:D7:FB:6C:B3:F0:B4:2C:80:CE
+            X509v3 Authority Key Identifier:
+                keyid:3A:9A:85:07:10:67:28:B6:EF:F6:BD:05:41:6E:20:C1:94:DA:0F:DE
+
+            Authority Information Access:
+                OCSP - URI:http://ocsp.godaddy.com/
+
+            X509v3 CRL Distribution Points:
+
+                Full Name:
+                  URI:http://crl.godaddy.com/gdroot-g2.crl
+
+            X509v3 Certificate Policies:
+                Policy: X509v3 Any Policy
+                  CPS: https://certs.godaddy.com/repository/
+
+    Signature Algorithm: sha256WithRSAEncryption
+         08:7e:6c:93:10:c8:38:b8:96:a9:90:4b:ff:a1:5f:4f:04:ef:
+         6c:3e:9c:88:06:c9:50:8f:a6:73:f7:57:31:1b:be:bc:e4:2f:
+         db:f8:ba:d3:5b:e0:b4:e7:e6:79:62:0e:0c:a2:d7:6a:63:73:
+         31:b5:f5:a8:48:a4:3b:08:2d:a2:5d:90:d7:b4:7c:25:4f:11:
+         56:30:c4:b6:44:9d:7b:2c:9d:e5:5e:e6:ef:0c:61:aa:bf:e4:
+         2a:1b:ee:84:9e:b8:83:7d:c1:43:ce:44:a7:13:70:0d:91:1f:
+         f4:c8:13:ad:83:60:d9:d8:72:a8:73:24:1e:b5:ac:22:0e:ca:
+         17:89:62:58:44:1b:ab:89:25:01:00:0f:cd:c4:1b:62:db:51:
+         b4:d3:0f:51:2a:9b:f4:bc:73:fc:76:ce:36:a4:cd:d9:d8:2c:
+         ea:ae:9b:f5:2a:b2:90:d1:4d:75:18:8a:3f:8a:41:90:23:7d:
+         5b:4b:fe:a4:03:58:9b:46:b2:c3:60:60:83:f8:7d:50:41:ce:
+         c2:a1:90:c3:bb:ef:02:2f:d2:15:54:ee:44:15:d9:0a:ae:a7:
+         8a:33:ed:b1:2d:76:36:26:dc:04:eb:9f:f7:61:1f:15:dc:87:
+         6f:ee:46:96:28:ad:a1:26:7d:0a:09:a7:2e:04:a3:8d:bc:f8:
+         bc:04:30:01
+-----BEGIN CERTIFICATE-----
+MIIE0DCCA7igAwIBAgIBBzANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMCVVMx
+EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxGjAYBgNVBAoT
+EUdvRGFkZHkuY29tLCBJbmMuMTEwLwYDVQQDEyhHbyBEYWRkeSBSb290IENlcnRp
+ZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTExMDUwMzA3MDAwMFoXDTMxMDUwMzA3
+MDAwMFowgbQxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25hMRMwEQYDVQQH
+EwpTY290dHNkYWxlMRowGAYDVQQKExFHb0RhZGR5LmNvbSwgSW5jLjEtMCsGA1UE
+CxMkaHR0cDovL2NlcnRzLmdvZGFkZHkuY29tL3JlcG9zaXRvcnkvMTMwMQYDVQQD
+EypHbyBEYWRkeSBTZWN1cmUgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IC0gRzIwggEi
+MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC54MsQ1K92vdSTYuswZLiBCGzD
+BNliF44v/z5lz4/OYuY8UhzaFkVLVat4a2ODYpDOD2lsmcgaFItMzEUz6ojcnqOv
+K/6AYZ15V8TPLvQ/MDxdR/yaFrzDN5ZBUY4RS1T4KL7QjL7wMDge87Am+GZHY23e
+cSZHjzhHU9FGHbTj3ADqRay9vHHZqm8A29vNMDp5T19MR/gd71vCxJ1gO7GyQ5HY
+pDNO6rPWJ0+tJYqlxvTV0KaudAVkV4i1RFXULSo6Pvi4vekyCgKUZMQWOlDxSq7n
+eTOvDCAHf+jfBDnCaQJsY1L6d8EbyHSHyLmTGFBUNUtpTrw700kuH9zB0lL7AgMB
+AAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNV
+HQ4EFgQUQMK9J47MNIMwojPX+2yz8LQsgM4wHwYDVR0jBBgwFoAUOpqFBxBnKLbv
+9r0FQW4gwZTaD94wNAYIKwYBBQUHAQEEKDAmMCQGCCsGAQUFBzABhhhodHRwOi8v
+b2NzcC5nb2RhZGR5LmNvbS8wNQYDVR0fBC4wLDAqoCigJoYkaHR0cDovL2NybC5n
+b2RhZGR5LmNvbS9nZHJvb3QtZzIuY3JsMEYGA1UdIAQ/MD0wOwYEVR0gADAzMDEG
+CCsGAQUFBwIBFiVodHRwczovL2NlcnRzLmdvZGFkZHkuY29tL3JlcG9zaXRvcnkv
+MA0GCSqGSIb3DQEBCwUAA4IBAQAIfmyTEMg4uJapkEv/oV9PBO9sPpyIBslQj6Zz
+91cxG7685C/b+LrTW+C05+Z5Yg4MotdqY3MxtfWoSKQ7CC2iXZDXtHwlTxFWMMS2
+RJ17LJ3lXubvDGGqv+QqG+6EnriDfcFDzkSnE3ANkR/0yBOtg2DZ2HKocyQetawi
+DsoXiWJYRBuriSUBAA/NxBti21G00w9RKpv0vHP8ds42pM3Z2Czqrpv1KrKQ0U11
+GIo/ikGQI31bS/6kA1ibRrLDYGCD+H1QQc7CoZDDu+8CL9IVVO5EFdkKrqeKM+2x
+LXY2JtwE65/3YR8V3Idv7kaWKK2hJn0KCacuBKONvPi8BDAB
+-----END CERTIFICATE-----

cert.pem

@@ -0,0 +1,37 @@
+//const Kmb = require('js-kmb-api').default;
+const Kmb = require('./dist/src').default;
+
+const kmb = new Kmb;
+
+async function example() {
+    // Load the forward route of 104
+    const route = (await kmb.getRoutes('104')).find(route => route.bound === 1);
+    if (route === undefined) {
+        throw new Error('route is not found');
+    }
+
+    // load the main variant
+    const variant = (await route.getVariants()).sort((a, b) => a.serviceType - b.serviceType)[0];
+    if (variant === undefined) {
+        throw new Error('No variants are found');
+    }
+
+    // Load the stop list of the main variant
+    const stoppings = await variant.getStoppings();
+
+    // Find a stop called "Immigration Tower"
+    const stopping = stoppings.find(stopping => stopping.stop.name === 'Immigration Tower');
+    if (stopping === undefined) {
+        throw new Error('Stop is not found');
+    }
+
+    // Get the ETA there
+    const etas = await stopping.getEtas();
+    console.log(etas);
+
+    // Get the stoppings of all other routes for that stop
+    const stoppings_at_immigration_tower = await stopping.stop.getStoppings();
+    console.log(stoppings_at_immigration_tower);
+}
+
+void example();

example-javascript.js

@@ -0,0 +1,37 @@
+// import Kmb from "js-kmb-api"
+import Kmb from "./src";
+
+const kmb = new Kmb;
+
+async function example() {
+    // Load the forward route of 104
+    const route = (await kmb.getRoutes('104')).find(route => route.bound === 1);
+    if (route === undefined) {
+        throw new Error('route is not found');
+    }
+
+    // load the main variant
+    const variant = (await route.getVariants()).sort((a, b) => a.serviceType - b.serviceType)[0];
+    if (variant === undefined) {
+        throw new Error('No variants are found');
+    }
+
+    // Load the stop list of the main variant
+    const stoppings = await variant.getStoppings();
+
+    // Find a stop called "Immigration Tower"
+    const stopping = stoppings.find(stopping => stopping.stop.name === 'Immigration Tower');
+    if (stopping === undefined) {
+        throw new Error('Stop is not found');
+    }
+
+    // Get the ETA there
+    const etas = await stopping.getEtas();
+    console.log(etas);
+
+    // Get the stoppings of all other routes for that stop
+    const stoppings_at_immigration_tower = await stopping.stop.getStoppings();
+    console.log(stoppings_at_immigration_tower);
+}
+
+void example();

example-typescript.ts

@@ -23,19 +23,21 @@
         "chai-as-promised": "^7.1.1",
         "eslint": "^7.11.0",
         "mocha": "^8.1.3",
-        "mock-local-storage": "^1.1.15",
         "nock": "^13.0.4",
         "sinon": "^9.2.0",
         "source-map-support": "^0.5.19",
         "ts-node": "^9.0.0",
         "typescript": "^4.0.3"
     },
     "dependencies": {
+        "@types/node": "^14.14.2",
         "aes-js": "^3.1.2",
-        "axios": "^0.20.0"
+        "axios": "^0.20.0",
+        "node-storage-shim": "^2.0.1",
+        "ssl-root-cas": "^1.3.1"
     },
     "scripts": {
-        "build": "tsc",
+        "build": "tsc && cp cert.pem dist",
         "lint": "eslint .",
         "test": "mocha",
         "clean": "rm -fr dist",

modules.d.ts

@@ -1,12 +1,4 @@
-import Axios from 'axios';
-import httpAdapter from "axios/lib/adapters/http.js";
-import Chai from "chai";
-import ChaiAsPromised from "chai-as-promised";
-import TsNode from 'ts-node';
-import SourceMapSupport from 'source-map-support';
-
-SourceMapSupport.install();
-TsNode.register();
-import 'mock-local-storage';
-Axios.defaults.adapter = httpAdapter;
-Chai.use(ChaiAsPromised);
+require('source-map-support/register');
+require('ts-node/register');
+require('axios').default.defaults.adapter = require("axios/lib/adapters/http");
+require('chai').use(require('chai-as-promised'));

package.json

@@ -1,4 +1,4 @@
-import aesjs from "aes-js";
+import aesjs = require("aes-js");
 
 export default class Secret {
     constructor(public readonly apiKey : string, public readonly ctr : number) {