initial splitting from kmb-lwb-combined-eta

Author: miklcct

.eslintignore

@@ -0,0 +1,2 @@
+/node_modules/
+/dist/

.eslintrc

@@ -0,0 +1,26 @@
+{
+    "root" : true,
+    "parser" : "@typescript-eslint/parser",
+    "plugins" : [
+        "@typescript-eslint"
+    ],
+    "extends" : [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides" : [
+        {
+            "rules" : {
+                "no-debugger" : "off"
+            },
+            "files" : "**"
+        },
+        {
+            "files" : "*.js",
+            "rules": {
+                "@typescript-eslint/no-var-requires": "off"
+            }
+        }
+    ]
+}

.gitignore

@@ -0,0 +1,76 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+/node_modules/
+/dist/
+/scratch/
+/yarn-error.log

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+{
+    "extension" : ["ts"],
+    "spec" : "test",
+    "require" : "register-mocha-requires.js"
+}

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,9 @@
+Copyright 2020 Michael Tsang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+

.idea/jsLibraryMappings.xml

@@ -0,0 +1,33 @@
+# Javascript module for getting KMB data
+This is a library for getting KMB data. It can get routes, stops, variants, and ETAs.
+
+## Classes
+### `Route`
+Represents a route with number and bound.
+### `Stop`
+Represents a stop with ID, name, direction in route and sequence in route.
+The name is stored in localStorage automatically.
+
+Calling `Stop.get` with a variant will return the stop list of that variant.
+
+### `IncompleteStop`
+Represents a stop with ID only. The name property is retrieved from localStorage by `Stop`
+
+
+### `StopRoute`
+Represents a stop in a variant.
+
+Calling `StopRoute.get` with a stop will return all `StopRoute`s containing with all routes serving that stop.
+
+### `Variant`
+Represents a variant in a route.
+
+Calling `Variant.get` with a route will return all variants of that route.
+
+### `Eta`
+Represents an ETA entry.
+
+Calling `Eta.get` with a StopRoute will return the ETA for that stop for that route.
+
+## Node.js
+This library is designed for use on the browser. Usage on node.js requires [global-jsdom](https://www.npmjs.com/package/global-jsdom) to be loaded.

.idea/kmb-api.iml

@@ -0,0 +1,42 @@
+{
+    "name": "js-kmb-api",
+    "description": "Library for querying KMB data",
+    "version": "2.0.0-beta.1",
+    "type": "module",
+    "main": "dist/src/index.js",
+    "types": "dist/src/index.d.ts",
+    "author": "Michael Tsang",
+    "license": "MIT",
+    "files": [
+        "dist/src"
+    ],
+    "devDependencies": {
+        "@testdeck/mocha": "^0.1.2",
+        "@types/aes-js": "^3.1.1",
+        "@types/chai": "^4.2.13",
+        "@types/jquery": "^3.5.3",
+        "@types/mocha": "^8.0.3",
+        "@types/node-localstorage": "^1.3.0",
+        "@types/sinon": "^9.0.8",
+        "@typescript-eslint/eslint-plugin": "^4.4.1",
+        "@typescript-eslint/parser": "^4.4.1",
+        "chai": "^4.2.0",
+        "eslint": "^7.11.0",
+        "mocha": "^8.1.3",
+        "mock-local-storage": "^1.1.15",
+        "sinon": "^9.2.0",
+        "source-map-support": "^0.5.19",
+        "ts-node": "^9.0.0",
+        "typescript": "^4.0.3"
+    },
+    "dependencies": {
+        "aes-js": "^3.1.2",
+        "global-jsdom": "^7.0.0",
+        "jquery": "^3.5.1",
+        "jsdom": "^16.4.0"
+    },
+    "scripts": {
+        "build": "tsc",
+        "test": "mocha"
+    }
+}

.idea/modules.xml

@@ -0,0 +1,9 @@
+import TsNode from 'ts-node';
+import SourceMapSupport from 'source-map-support';
+import globalJsDom from 'global-jsdom';
+
+SourceMapSupport.install();
+TsNode.register({compilerOptions : {"module":"commonjs"}});
+globalJsDom();
+
+import 'mock-local-storage';

.idea/runConfigurations/test.xml

@@ -0,0 +1,60 @@
+import {Language} from "./Language";
+import $ from "jquery";
+
+export default class Common {
+    public static readonly PROXY_URL = 'https://miklcct.com/proxy/';
+    public static readonly API_ENDPOINT = 'https://search.kmb.hk/KMBWebSite/Function/FunctionRequest.ashx';
+
+    public static async callApi(query : Record<string, string>) : Promise<Record<string, unknown>> {
+        return $.get(Common.API_ENDPOINT, query);
+    }
+
+    /**
+     * Get the stop ID in the query string
+     */
+    public static getQueryStopId() : string | null {
+        return (new URLSearchParams(window.location.search)).get('stop');
+    }
+
+    /**
+     * Get the selected route IDs and stop positions in the query string
+     */
+    public static getQuerySelections() : [string, number|null][]{
+        return (new URLSearchParams(window.location.search)).getAll('selections').map(
+            item => {
+                const segments = item.split(':');
+                return [segments[0], segments.length >= 2 ? Number(segments[1]) : null];
+            }
+        );
+    }
+
+    /**
+     * Get if "one departure" mode is selected
+     */
+    public static getQueryOneDeparture() : boolean {
+        return Boolean((new URLSearchParams(window.location.search)).get('one_departure'));
+    }
+
+    /**
+     * Get the language used in the document
+     */
+    public static getLanguage() : Language {
+        return ($('html').attr('lang') ?? 'en') as Language;
+    }
+}
+
+declare global {
+    // noinspection JSUnusedGlobalSymbols
+    interface String {
+        toTitleCase(): string;
+    }
+}
+
+/**
+ * Convert string to title case
+ *
+ * FIXME: this is English only
+ */
+String.prototype.toTitleCase = function () {
+    return this.toLowerCase().replace(/((^|[^a-z0-9'])+)(.)/g,  (match, p1, p2, p3) => p1 + p3.toUpperCase());
+};