mobility-toolbox-js 2.0.0-beta.30 → 2.0.0-beta.34

package/ol/styles/fullTrajectoryStyle.js

@@ -1,42 +1,46 @@
-import { Style, Fill, Stroke, Circle } from "ol/style";
-const borderStyle = new Style({
-  zIndex: 2,
-  image: new Circle({
-    radius: 5,
-    fill: new Fill({
-      color: "#000000"
-    })
-  }),
-  stroke: new Stroke({
-    color: "#000000",
-    width: 6
-  })
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var style_1 = require("ol/style");
+/** @private */
+var borderStyle = new style_1.Style({
+    zIndex: 2,
+    image: new style_1.Circle({
+        radius: 5,
+        fill: new style_1.Fill({
+            color: '#000000',
+        }),
+    }),
+    stroke: new style_1.Stroke({
+        color: '#000000',
+        width: 6,
+    }),
 });
-const fullTrajectorystyle = (feature, resolution, options) => {
-  let lineColor = "#ffffff";
-  const type = feature.get("type");
-  let stroke = feature.get("stroke");
-  if (stroke && stroke[0] !== "#") {
-    stroke = `#${stroke}`;
-  }
-  lineColor = stroke || options?.getBgColor(type);
-  lineColor = /#ffffff/i.test(lineColor) ? "#ff0000" : lineColor;
-  const style = [
-    borderStyle,
-    new Style({
-      zIndex: 3,
-      image: new Circle({
-        radius: 4,
-        fill: new Fill({
-          color: lineColor
-        })
-      }),
-      stroke: new Stroke({
-        color: lineColor,
-        width: 4
-      })
-    })
-  ];
-  return style;
+var fullTrajectorystyle = function (feature, resolution, options) {
+    var lineColor = '#ffffff'; // white
+    var type = feature.get('type');
+    var stroke = feature.get('stroke');
+    if (stroke && stroke[0] !== '#') {
+        stroke = "#".concat(stroke);
+    }
+    lineColor = stroke || (options === null || options === void 0 ? void 0 : options.getBgColor(type));
+    // Don't allow white lines, use red instead.
+    lineColor = /#ffffff/i.test(lineColor) ? '#ff0000' : lineColor;
+    var style = [
+        borderStyle,
+        new style_1.Style({
+            zIndex: 3,
+            image: new style_1.Circle({
+                radius: 4,
+                fill: new style_1.Fill({
+                    color: lineColor,
+                }),
+            }),
+            stroke: new style_1.Stroke({
+                color: lineColor,
+                width: 4,
+            }),
+        }),
+    ];
+    return style;
 };
-export default fullTrajectorystyle;
+exports.default = fullTrajectorystyle;

package/ol/styles/index.d.ts

@@ -0,0 +1,3 @@
+export { default as fullTrajectoryStyle } from "./fullTrajectoryStyle";
+export { default as fullTrajectoryDelayStyle } from "./fullTrajectoryDelayStyle";
+//# sourceMappingURL=index.d.ts.map

package/ol/styles/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ol/styles/index.js"],"names":[],"mappings":""}

package/ol/styles/index.js

@@ -1,2 +1,7 @@
-export { default as fullTrajectoryStyle } from "./fullTrajectoryStyle";
-export { default as fullTrajectoryDelayStyle } from "./fullTrajectoryDelayStyle";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fullTrajectoryDelayStyle = exports.fullTrajectoryStyle = void 0;
+var fullTrajectoryStyle_1 = require("./fullTrajectoryStyle");
+Object.defineProperty(exports, "fullTrajectoryStyle", { enumerable: true, get: function () { return fullTrajectoryStyle_1.default; } });
+var fullTrajectoryDelayStyle_1 = require("./fullTrajectoryDelayStyle");
+Object.defineProperty(exports, "fullTrajectoryDelayStyle", { enumerable: true, get: function () { return fullTrajectoryDelayStyle_1.default; } });

package/package.json

@@ -2,7 +2,7 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "2.0.0-beta.30",
+  "version": "2.0.0-beta.34",
   "main": "index.js",
   "exports": {
     ".": "./index.js",
@@ -33,7 +33,12 @@
     "@babel/preset-react": "7.16.7",
     "@commitlint/cli": "17.0.2",
     "@commitlint/config-conventional": "17.0.2",
+    "@types/arcgis-js-api": "^4.24.0",
+    "@types/arcgis-rest-api": "^10.4.5",
     "@types/geojson": "^7946.0.8",
+    "@types/topojson": "^3.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
     "autoprefixer": "9.7.6",
     "cypress": "9.4.1",
     "deepmerge": "4.2.2",
@@ -43,8 +48,10 @@
     "esdoc-ecmascript-proposal-plugin": "1.0.0",
     "esdoc-publish-html-plugin": "1.1.2",
     "esdoc-standard-plugin": "1.0.0",
+    "esdoc-typescript-plugin": "^1.0.1",
     "eslint": "8.8.0",
     "eslint-config-airbnb": "19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-cypress": "2.12.1",
     "eslint-plugin-import": "2.25.4",
@@ -76,11 +83,12 @@
     "stylelint": "14.3.0",
     "stylelint-config-recommended-scss": "5.0.2",
     "stylelint-config-standard": "24.0.0",
-    "stylelint-scss": "4.1.0"
+    "stylelint-scss": "4.1.0",
+    "typescript": "^4.7.4"
   },
   "scripts": {
     "apidoc": "esdoc && cp apidoc/index.json doc/src/components/Esdoc",
-    "build": "rm -rf build && yarn esbuild && cp README.md build/ && cp package.json build/ && cp -R src/types build/",
+    "build": "rm -rf build && yarn tsc && yarn esbuild:iife && cp README.md build/ && cp package.json build/ && cp -R src/types build/",
     "coverage": "yarn test  --watchAll=false  --coverage --coverageDirectory=coverage",
     "cy:open": "cypress open",
     "cy:test": "start-server-and-test dev http://localhost:3000 'cypress run --browser chrome'",
@@ -91,7 +99,7 @@
     "dev:examples": "cd doc && yarn dev",
     "doc": "yarn apidoc && cd doc && yarn install --frozen-lockfile && yarn build",
     "esbuild": "yarn esbuild:all && yarn esbuild:iife",
-    "esbuild:all": "esbuild src/index.js src/**/*.js src/**/**/*.js --target=chrome100 --outdir=build/ --loader:.js=jsx",
+    "esbuild:all": "esbuild src/index.js src/**/*.js src/**/*.ts src/**/**/*.js src/**/**/*.ts --target=chrome100 --outdir=build/ --loader:.js=jsx",
     "esbuild:iife": "yarn esbuild:iife:unminify && yarn esbuild:iife:minify",
     "esbuild:iife:base": "esbuild src/iife.js --bundle --sourcemap --target=chrome100",
     "esbuild:iife:minify": "yarn esbuild:iife:base --minify --outfile=build/mbt.min.js",
@@ -100,7 +108,7 @@
     "lib": "REACT_APP_LIB_MODE=1  webpack --mode production",
     "lib:dev": "REACT_APP_LIB_MODE=1  webpack --mode development",
     "link2": "cmdToAdd=$(node ./scripts/read-pkg-json.js add) && $cmdToAdd && yarn build && cmdToRemove=$(node ./scripts/read-pkg-json.js remove) && $cmdToRemove && cd build && yarn link",
-    "lint": "eslint 'src/**/*.js' && stylelint 'src/**/*.css' 'src/**/*.scss' --allow-empty-input",
+    "lint": "eslint src/**/*.js src/**/*.ts && stylelint src/**/*.css src/**/*.scss --allow-empty-input",
     "publish:beta": "HUSKY=0 yarn release -- --prerelease beta --skip.changelog && git push origin HEAD && yarn run build && cd build && HUSKY=0 yarn publish --tag beta && git push --tags ",
     "publish:beta:dryrun": "yarn release -- --prerelease beta --dry-run --skip.changelog",
     "publish:public:dryrun": "yarn release --dry-run",
@@ -109,6 +117,7 @@
     "start:examples": "cd doc && yarn build && yarn start",
     "test": "TZ='UTC' jest",
     "test:watch": "yarn test --watchAll",
+    "tsc": "tsc",
     "types:backend": "openapi-typescript https://developer.geops.io/swagger/routing.json --output types/routing.d.ts && openapi-typescript  https://developer.geops.io/swagger/stops.json --output types/stops.d.ts"
   },
   "browserslist": {
@@ -124,37 +133,6 @@
       "last 1 ie version"
     ]
   },
-  "eslintConfig": {
-    "env": {
-      "cypress/globals": true,
-      "node": true,
-      "browser": true,
-      "es6": true,
-      "jest": true
-    },
-    "parser": "@babel/eslint-parser",
-    "extends": [
-      "airbnb",
-      "prettier"
-    ],
-    "plugins": [
-      "cypress",
-      "prettier"
-    ],
-    "rules": {
-      "arrow-body-style": 0,
-      "react/jsx-filename-extension": [
-        1,
-        {
-          "extensions": [
-            ".js",
-            ".jsx"
-          ]
-        }
-      ],
-      "prettier/prettier": "error"
-    }
-  },
   "keywords": [
     "mobility",
     "toolbox"

package/setupTests.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=setupTests.d.ts.map

package/setupTests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupTests.d.ts","sourceRoot":"","sources":["../src/setupTests.js"],"names":[],"mappings":""}

package/setupTests.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable import/no-extraneous-dependencies */
+require("jest-canvas-mock");
+var fetchTrajectoryById_json_1 = require("../data/fetchTrajectoryById.json");
+var fetchTrajectories_json_1 = require("../data/fetchTrajectories.json");
+var fetchTrajectoryStations_json_1 = require("../data/fetchTrajectoryStations.json");
+var stopsSearch_json_1 = require("../data/stopsSearch.json");
+var fetchRoute_json_1 = require("../data/fetchRoute.json");
+global.fetchTrajectoryByIdResponse = fetchTrajectoryById_json_1.default;
+global.fetchTrajectoriesResponse = fetchTrajectories_json_1.default;
+global.fetchTrajectoryStationsResponse = fetchTrajectoryStations_json_1.default;
+global.stopsSearchResponse = stopsSearch_json_1.default;
+global.fetchRouteResponse = fetchRoute_json_1.default;
+global.URL.createObjectURL = jest.fn(function () { return 'fooblob'; });

package/types/index.d.ts

@@ -1,9 +1,10 @@
-import { paths as routing } from './routing';
-import { paths as stops } from './stops';
+import { Paths as Routing } from './routing';
+import { Paths as Stops } from './stops';
+
 export * from './realtime';
 
-export type RoutingParameters = routing['/']['get']['parameters']['query'];
-export type RoutingResponse = routing['/']['get']['responses']['200']['schema'];
+export type RoutingParameters = Routing['/']['get']['parameters']['query'];
+export type RoutingResponse = Routing['/']['get']['responses']['200']['schema'];
 
-export type StopsParameters = stops['/']['get']['parameters']['query'];
-export type StopsResponse = stops['/']['get']['responses']['200']['schema'];
+export type StopsParameters = Stops['/']['get']['parameters']['query'];
+export type StopsResponse = Stops['/']['get']['responses']['200']['schema'];

package/types/routing.d.ts

@@ -3,8 +3,8 @@
  * Do not make direct changes to the file.
  */
 
-export interface paths {
-  "/": {
+export interface Paths {
+  '/': {
     /** Returns a route as GeoJSON */
     get: {
       parameters: {
@@ -54,31 +54,31 @@ export interface paths {
           via: string;
           /** Mode of transport */
           mot:
-            | "rail"
-            | "bus"
-            | "coach"
-            | "foot"
-            | "tram"
-            | "subway"
-            | "gondola"
-            | "funicular"
-            | "ferry"
-            | "car";
+            | 'rail'
+            | 'bus'
+            | 'coach'
+            | 'foot'
+            | 'tram'
+            | 'subway'
+            | 'gondola'
+            | 'funicular'
+            | 'ferry'
+            | 'car';
           /** Only for mot=rail. Default is a detailed network based on OpenStreetMap. gen1 to gen4 provide rail networks with increasing levels of generalization */
-          graph?: "gen1" | "gen2" | "gen3" | "gen4";
+          graph?: 'gen1' | 'gen2' | 'gen3' | 'gen4';
           /** A line name that should be preferred */
           line?: string;
           /** Name of origin of the preferred line */
-          "line-from"?: string;
+          'line-from'?: string;
           /** Name of destination of the preferred line */
-          "line-to"?: string;
+          'line-to'?: string;
           /** Douglas-Peucker distance parameter for simplification. Default 0.5 in Mercator units */
           simplify?: number;
           /**
            * Maximum allowed ratio of hops to skip if not found. Only non-start
            * and non-end hops are counted in ratio numerator and denominator.
            */
-          "max-skip-hop-ratio"?: number;
+          'max-skip-hop-ratio'?: number;
           /**
            * Whether to include intermediate hops (stations/stops) found on the
            * route to the response. "true", "on", "yes", "y", "1" will enable
@@ -91,24 +91,24 @@ export interface paths {
            * errors. "true", "on", "yes", "y", "1" will enable the
            * fallback. Default: enabled
            */
-          "beeline-fallback"?: string;
+          'beeline-fallback'?: string;
           /**
            * Search radius for candidate edges during snapping of coordinates
            * (see "Note on coordinates" at the top) Default: -1.0
            */
-          "coord-radius"?: number;
+          'coord-radius'?: number;
           /**
            * Distance punishment factor for edge snapping of coordinates (see
            * "Note on coordinates" at the top). Large: prefer close edge. Small:
            * prefer short total route. Negative value: like worst edge
            * category. Default: -1.0
            */
-          "coord-punish"?: number;
+          'coord-punish'?: number;
           /**
            * Whether to output OSM way ids in Feature properties.
            * "true", "on", "yes", "y", "1" will enable output. Default: disabled
            */
-          "way-ids"?: string;
+          'way-ids'?: string;
         };
       };
       responses: {
@@ -131,7 +131,7 @@ export interface paths {
                  */
                 coordinates?: number[][];
                 /** @enum {string} */
-                type?: "LineString";
+                type?: 'LineString';
               };
               properties?: {
                 lines?: {
@@ -172,7 +172,7 @@ export interface paths {
                 longitude?: number;
               };
               /** @enum {string} */
-              type?: "Feature";
+              type?: 'Feature';
             };
             properties?: {
               lines?: {
@@ -193,7 +193,7 @@ export interface paths {
               skippedVias?: string[];
             };
             /** @enum {string} */
-            type?: "FeatureCollection";
+            type?: 'FeatureCollection';
           };
         };
       };
@@ -201,6 +201,6 @@ export interface paths {
   };
 }
 
-export interface operations {}
+export interface Operations {}
 
-export interface external {}
+export interface External {}

package/types/stops.d.ts

@@ -3,8 +3,8 @@
  * Do not make direct changes to the file.
  */
 
-export interface paths {
-  "/": {
+export interface Paths {
+  '/': {
     /** Returns a stop (or multiple) as GeoJSON FeatureCollection */
     get: {
       parameters: {
@@ -17,27 +17,27 @@ export interface paths {
            * comma seperated list, order chooses which agency will be preferred
            * as ident_source (for id and code fields)
            */
-          prefagencies?: "sbb" | "db";
+          prefagencies?: 'sbb' | 'db';
           /**
            * comma seperated list of mot's which should be available
            * at the stop
            */
           mots?:
-            | "bus"
-            | "ferry"
-            | "gondola"
-            | "tram"
-            | "rail"
-            | "funicular"
-            | "cable_car"
-            | "subway";
+            | 'bus'
+            | 'ferry'
+            | 'gondola'
+            | 'tram'
+            | 'rail'
+            | 'funicular'
+            | 'cable_car'
+            | 'subway';
           /**
            * left,bottom,right,up coordinates in WGS84 wherein the
            * station should lie
            */
           bbox?: string;
           /** which field to look up, default: all of them */
-          field?: "id" | "name" | "coords";
+          field?: 'id' | 'name' | 'coords';
           /**
            * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
            * this position higher
@@ -50,10 +50,10 @@ export interface paths {
         200: {
           schema: {
             /** @enum {string} */
-            type?: "FeatureCollection";
+            type?: 'FeatureCollection';
             features?: {
               /** @enum {string} */
-              type?: "Feature";
+              type?: 'Feature';
               properties?: {
                 /** @description internal ID */
                 uid?: string;
@@ -79,7 +79,7 @@ export interface paths {
                 translated_names?: {
                   value?: string;
                   /** @enum {string} */
-                  language?: "de" | "en" | "fr" | "it";
+                  language?: 'de' | 'en' | 'fr' | 'it';
                 }[];
                 /** @description Means of transport that are available at this station */
                 mot?: {
@@ -114,7 +114,7 @@ export interface paths {
               /** @description the coordinates of the stop */
               geometry?: {
                 /** @enum {string} */
-                type?: "Point";
+                type?: 'Point';
                 /**
                  * @example [
                  *   7.439119,
@@ -130,7 +130,7 @@ export interface paths {
         400: {
           schema: {
             /** @enum {string} */
-            error?: "400 Bad Request: Limit has to be an integer between 1 and 500";
+            error?: '400 Bad Request: Limit has to be an integer between 1 and 500';
           };
         };
       };
@@ -138,6 +138,6 @@ export interface paths {
   };
 }
 
-export interface operations {}
+export interface Operations {}
 
-export interface external {}
+export interface External {}

package/api/RealtimeAPI.test.js

@@ -1,67 +0,0 @@
-import { RealtimeAPI, RealtimeModes } from ".";
-describe("RealtimeAPI", () => {
-  let api;
-  let get;
-  beforeEach(() => {
-    get = jest.fn((params, cb) => {
-      cb({ content: "content" });
-    });
-    api = new RealtimeAPI();
-    api.wsApi = {
-      get
-    };
-  });
-  describe("#getFullTrajectory() calls fullTrajectory channel", () => {
-    test("without parameters", (done) => {
-      api.getFullTrajectory().then(() => {
-        expect(get.mock.calls.length).toBe(1);
-        expect(get.mock.calls[0][0]).toEqual({
-          channel: "full_trajectory"
-        });
-        done();
-      });
-    });
-    [null, RealtimeModes.TOPOGRAPHIC].forEach((mode) => {
-      describe(`using mode ${mode}`, () => {
-        test("using id", (done) => {
-          api.getFullTrajectory("foo", mode).then(() => {
-            expect(get.mock.calls.length).toBe(1);
-            expect(get.mock.calls[0][0]).toEqual({
-              channel: "full_trajectory_foo"
-            });
-            done();
-          });
-        });
-        test("using id and generalizationLevel param", (done) => {
-          api.getFullTrajectory("foo", mode, 5).then(() => {
-            expect(get.mock.calls.length).toBe(1);
-            expect(get.mock.calls[0][0]).toEqual({
-              channel: "full_trajectory_foo_gen5"
-            });
-            done();
-          });
-        });
-      });
-    });
-    describe("using schematic mode ", () => {
-      test("using id", (done) => {
-        api.getFullTrajectory("foo", RealtimeModes.SCHEMATIC).then(() => {
-          expect(get.mock.calls.length).toBe(1);
-          expect(get.mock.calls[0][0]).toEqual({
-            channel: "full_trajectory_schematic_foo"
-          });
-          done();
-        });
-      });
-      test("doesn't use generalizationLevel param", (done) => {
-        api.getFullTrajectory("foo", RealtimeModes.SCHEMATIC, 10).then(() => {
-          expect(get.mock.calls.length).toBe(1);
-          expect(get.mock.calls[0][0]).toEqual({
-            channel: "full_trajectory_schematic_foo"
-          });
-          done();
-        });
-      });
-    });
-  });
-});

package/api/RoutingAPI.test.js

@@ -1,25 +0,0 @@
-import fetch from "jest-fetch-mock";
-import RoutingAPI from "./RoutingAPI";
-let api;
-describe("RoutingAPI", () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-    api = new RoutingAPI({ apiKey: "apiKey" });
-  });
-  describe("#route", () => {
-    test("should success", (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.fetchRouteResponse));
-      return api.route({
-        mot: "bus",
-        via: "47.3739194713294,8.538274823394632|47.37595378493421,8.537490375951839"
-      }).then((featureCollection) => {
-        expect(fetch.mock.calls[0][0]).toEqual("https://api.geops.io/routing/v1/?key=apiKey&mot=bus&via=47.3739194713294%2C8.538274823394632%7C47.37595378493421%2C8.537490375951839");
-        expect(featureCollection.features[0].geometry.type).toEqual("LineString");
-        expect(featureCollection.features[0].properties.lines).toBeDefined();
-        expect(featureCollection.features[0].properties.station_to).toBeDefined();
-        done();
-      });
-    });
-  });
-});

package/api/StopsAPI.test.js

@@ -1,22 +0,0 @@
-import fetch from "jest-fetch-mock";
-import StopsAPI from "./StopsAPI";
-let api;
-describe("StopsAPI", () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-    api = new StopsAPI({ apiKey: "apiKey" });
-  });
-  describe("#search", () => {
-    test("should success", (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.stopsSearchResponse));
-      return api.search({
-        q: "Bern"
-      }).then((featureCollection) => {
-        expect(fetch.mock.calls[0][0]).toEqual("https://api.geops.io/stops/v1/?key=apiKey&q=Bern");
-        expect(featureCollection.features[0].properties.name).toEqual("Bern");
-        done();
-      });
-    });
-  });
-});

package/common/api/HttpAPI.test.js

@@ -1,50 +0,0 @@
-import fetch from "jest-fetch-mock";
-import API from "./HttpAPI";
-let api;
-describe("HttpAPI", () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-    api = new API({ url: "https://foo.ch", apiKey: "apiKey" });
-  });
-  describe("#fetch", () => {
-    test("should success", () => {
-      fetch.mockResponseOnce(JSON.stringify({ foo: "bar" }));
-      return api.fetch("/path", {
-        q: "Bern",
-        fooUndefined: void 0,
-        fooNull: null,
-        fooEmpty: ""
-      }).then((response) => {
-        expect(fetch.mock.calls[0][0]).toEqual("https://foo.ch/path?key=apiKey&q=Bern&fooEmpty=");
-        expect(response).toEqual({ foo: "bar" });
-      });
-    });
-    describe("should display error message", () => {
-      test("reject error", (done) => {
-        fetch.mockRejectOnce(new Error("Fake error message"));
-        return api.fetch().catch((err) => {
-          expect(err.name).toEqual("Error");
-          expect(err.message).toEqual("Fake error message");
-          done();
-        });
-      });
-      test("if the response is invalid json", (done) => {
-        fetch.mockResponseOnce("invalid json");
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual("FetchError");
-          expect(err.message).toEqual("invalid json response body at  reason: Unexpected token i in JSON at position 0");
-          done();
-        });
-      });
-      test("if the response contains an error message", (done) => {
-        fetch.mockResponseOnce('{"error":"foo2"}');
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual("Error");
-          expect(err.message).toEqual("foo2");
-          done();
-        });
-      });
-    });
-  });
-});