mobility-toolbox-js 2.0.0-beta.24 → 2.0.0-beta.27

package/api/{TralisAPI.js → RealtimeAPI.js}

@@ -1,15 +1,13 @@
 import WebSocketAPI from "../common/api/WebSocketAPI";
-import {
-  getModeSuffix,
-  cleanStopTime,
-  compareDepartures
-} from "./TralisAPIUtils";
-export const TralisModes = {
+import cleanStopTime from "../common/utils/cleanStopTime";
+import getModeSuffix from "../common/utils/getRealtimeModeSuffix";
+import compareDepartures from "../common/utils/compareDepartures";
+export const RealtimeModes = {
   RAW: "raw",
   TOPOGRAPHIC: "topographic",
   SCHEMATIC: "schematic"
 };
-class TralisAPI {
+class RealtimeAPI {
   constructor(options = {}) {
     this.defineProperties(options);
     this.subscribedStationUic = null;
@@ -126,8 +124,8 @@ class TralisAPI {
     this.wsApi.subscribe({ channel }, onSuccess, onError, quiet);
   }
   unsubscribe(channel, suffix, cb) {
-    this.wsApi.unsubscribe(`${channel}${getModeSuffix(TralisModes.SCHEMATIC, TralisModes)}${suffix}`, cb);
-    this.wsApi.unsubscribe(`${channel}${getModeSuffix(TralisModes.TOPOGRAPHIC, TralisModes)}${suffix || ""}`, cb);
+    this.wsApi.unsubscribe(`${channel}${getModeSuffix(RealtimeModes.SCHEMATIC, RealtimeModes)}${suffix}`, cb);
+    this.wsApi.unsubscribe(`${channel}${getModeSuffix(RealtimeModes.TOPOGRAPHIC, RealtimeModes)}${suffix || ""}`, cb);
   }
   filterDepartures(depObject, sortByMinArrivalTime = false) {
     const departures = Object.keys(depObject).map((k) => depObject[k]);
@@ -203,7 +201,7 @@ class TralisAPI {
   }
   getStation(uic, mode) {
     const params = {
-      channel: `station${getModeSuffix(mode, TralisModes)}`,
+      channel: `station${getModeSuffix(mode, RealtimeModes)}`,
       args: uic
     };
     return new Promise((resolve, reject) => {
@@ -219,7 +217,7 @@ class TralisAPI {
   getStations(mode) {
     const stations = [];
     const params = {
-      channel: `station${getModeSuffix(mode, TralisModes)}`
+      channel: `station${getModeSuffix(mode, RealtimeModes)}`
     };
     window.clearTimeout(this.stationUpdateTimeout);
     return new Promise((resolve, reject) => {
@@ -238,7 +236,7 @@ class TralisAPI {
   }
   subscribeStations(mode, onMessage) {
     this.unsubscribeStations();
-    this.subscribe(`station${getModeSuffix(mode, TralisModes)}`, (data) => {
+    this.subscribe(`station${getModeSuffix(mode, RealtimeModes)}`, (data) => {
       if (data.content) {
         onMessage(data.content);
       }
@@ -267,24 +265,24 @@ class TralisAPI {
   }
   subscribeTrajectory(mode, onMessage, quiet = false) {
     this.unsubscribeTrajectory(onMessage);
-    this.subscribe(`trajectory${getModeSuffix(mode, TralisModes)}`, onMessage, null, quiet);
+    this.subscribe(`trajectory${getModeSuffix(mode, RealtimeModes)}`, onMessage, null, quiet);
   }
   unsubscribeTrajectory(cb) {
     this.unsubscribe(`trajectory`, "", cb);
   }
   subscribeDeletedVehicles(mode, onMessage, quiet = false) {
     this.unsubscribeDeletedVehicles(onMessage);
-    this.subscribe(`deleted_vehicles${getModeSuffix(mode, TralisModes)}`, onMessage, null, quiet);
+    this.subscribe(`deleted_vehicles${getModeSuffix(mode, RealtimeModes)}`, onMessage, null, quiet);
   }
   unsubscribeDeletedVehicles(cb) {
     this.unsubscribe("deleted_vehicles", "", cb);
   }
   getFullTrajectory(id, mode, generalizationLevel) {
-    const channel = [`full_trajectory${getModeSuffix(mode, TralisModes)}`];
+    const channel = [`full_trajectory${getModeSuffix(mode, RealtimeModes)}`];
     if (id) {
       channel.push(id);
     }
-    if ((!mode || mode === TralisModes.TOPOGRAPHIC) && generalizationLevel) {
+    if ((!mode || mode === RealtimeModes.TOPOGRAPHIC) && generalizationLevel) {
       channel.push(`gen${generalizationLevel}`);
     }
     const params = {
@@ -304,7 +302,7 @@ class TralisAPI {
   }
   subscribeFullTrajectory(id, mode) {
     this.unsubscribeFullTrajectory(id);
-    this.subscribe(`full_trajectory${getModeSuffix(mode, TralisModes)}_${id}`, (data) => {
+    this.subscribe(`full_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`, (data) => {
       console.log("subscribe full_trajectory", data);
     }, (err) => {
       console.log("subscribe full_trajectory error", err);
@@ -356,4 +354,4 @@ class TralisAPI {
     this.unsubscribe("healthcheck");
   }
 }
-export default TralisAPI;
+export default RealtimeAPI;

package/api/{TralisAPI.test.js → RealtimeAPI.test.js}

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

package/api/index.js

@@ -1,3 +1,3 @@
 export { default as RoutingAPI } from "./RoutingAPI";
 export { default as StopsAPI } from "./StopsAPI";
-export { default as TralisAPI, TralisModes } from "./TralisAPI";
+export { default as RealtimeAPI, RealtimeModes } from "./RealtimeAPI";

package/common/mixins/{TralisLayerMixin.js → RealtimeLayerMixin.js}

@@ -4,11 +4,11 @@ import GeoJSON from "ol/format/GeoJSON";
 import debounce from "lodash.debounce";
 import throttle from "lodash.throttle";
 import { fromLonLat } from "ol/proj";
-import trackerDefaultStyle from "../styles/trackerDefaultStyle";
-import { TralisAPI, TralisModes } from "../../api";
+import realtimeDefaultStyle from "../styles/realtimeDefaultStyle";
+import { RealtimeAPI, RealtimeModes } from "../../api";
 import renderTrajectories from "../utils/renderTrajectories";
 import * as trackerConfig from "../utils/trackerConfig";
-export class TralisLayerInterface {
+export class RealtimeLayerInterface {
   constructor(options = {}) {
   }
   attachToMap(map) {
@@ -26,15 +26,15 @@ export class TralisLayerInterface {
   getTrajectoryInfos(id, mode) {
   }
 }
-const TralisLayerMixin = (Base) => class extends Base {
+const RealtimeLayerMixin = (Base) => class extends Base {
   constructor(options = {}) {
     super({
       hitTolerance: 10,
       ...options
     });
     this.debug = options.debug;
-    this.mode = options.mode || TralisModes.TOPOGRAPHIC;
-    this.api = options.api || new TralisAPI(options);
+    this.mode = options.mode || RealtimeModes.TOPOGRAPHIC;
+    this.api = options.api || new RealtimeAPI(options);
     this.tenant = options.tenant || "";
     this.minZoomNonTrain = options.minZoomNonTrain || 9;
     this.minZoomInterpolation = options.minZoomInterpolation || 8;
@@ -117,7 +117,7 @@ const TralisLayerMixin = (Base) => class extends Base {
         value: canvas || document.createElement("canvas")
       },
       style: {
-        value: style || trackerDefaultStyle
+        value: style || realtimeDefaultStyle
       },
       styleOptions: {
         value: { ...trackerConfig, ...styleOptions || {} }
@@ -389,7 +389,7 @@ const TralisLayerMixin = (Base) => class extends Base {
     if (this.purgeTrajectory(trajectory)) {
       return;
     }
-    if (this.debug && this.mode === TralisModes.TOPOGRAPHIC && rawCoordinates) {
+    if (this.debug && this.mode === RealtimeModes.TOPOGRAPHIC && rawCoordinates) {
       trajectory.properties.olGeometry = {
         type: "Point",
         coordinates: fromLonLat(rawCoordinates, this.map.getView().getProjection())
@@ -430,4 +430,4 @@ const TralisLayerMixin = (Base) => class extends Base {
     }
   }
 };
-export default TralisLayerMixin;
+export default RealtimeLayerMixin;

package/common/mixins/{SearchMixin.js → StopFinderMixin.js}

@@ -1,11 +1,11 @@
 import { StopsAPI } from "../../api";
-export class SearchInterface {
+export class StopFinderInterface {
   constructor(options = {}) {
   }
   search(query, abortController) {
   }
 }
-const SearchMixin = (Base) => class extends Base {
+const StopFinderMixin = (Base) => class extends Base {
   constructor(options = {}) {
     super(options);
     const { apiParams, apiKey, url } = options;
@@ -107,4 +107,4 @@ const SearchMixin = (Base) => class extends Base {
     this.clearElt.style.display = "none";
   }
 };
-export default SearchMixin;
+export default StopFinderMixin;

package/common/styles/index.js

@@ -1,4 +1,4 @@
-export { default as trackerDefaultStyle } from "./trackerDefaultStyle";
-export { default as trackerDelayStyle } from "./trackerDelayStyle";
-export { default as trackerSimpleStyle } from "./trackerSimpleStyle";
-export * from "./trackerDefaultStyle";
+export { default as realtimeDefaultStyle } from "./realtimeDefaultStyle";
+export { default as realtimeDelayStyle } from "./realtimeDelayStyle";
+export { default as realtimeSimpleStyle } from "./realtimeSimpleStyle";
+export * from "./realtimeDefaultStyle";

package/common/styles/{trackerDefaultStyle.js → realtimeDefaultStyle.js}

@@ -91,8 +91,8 @@ export const getTextCanvas = (text, origin, textSize, fillColor, strokeColor, ha
   }
   return cacheText[key];
 };
-const styleCache = {};
-const style = (trajectory, viewState, options) => {
+const cache = {};
+const realtimeDefaultStyle = (trajectory, viewState, options) => {
   const {
     hoverVehicleId,
     selectedVehicleId,
@@ -150,9 +150,9 @@ const style = (trajectory, viewState, options) => {
   if (mustDrawText) {
     key += `${name}${textColor}`;
   }
-  if (!styleCache[key]) {
+  if (!cache[key]) {
     if (radius === 0) {
-      styleCache[key] = null;
+      cache[key] = null;
       return null;
     }
     const margin = 1 * pixelRatio;
@@ -194,9 +194,9 @@ const style = (trajectory, viewState, options) => {
         const text = getTextCanvas(name, origin, textSize, textColor2, circleFillColor, hasStroke2, pixelRatio);
         ctx.drawImage(text, 0, 0);
       }
-      styleCache[key] = canvas;
+      cache[key] = canvas;
     }
   }
-  return styleCache[key];
+  return cache[key];
 };
-export default style;
+export default realtimeDefaultStyle;

package/common/styles/realtimeDelayStyle.js

@@ -0,0 +1,8 @@
+import realtimeDefaultStyle from "./realtimeDefaultStyle";
+const realtimeDelayStyle = (trajectory, viewState, options) => {
+  return realtimeDefaultStyle(trajectory, viewState, {
+    ...options,
+    useDelayStyle: true
+  });
+};
+export default realtimeDelayStyle;

package/common/styles/{trackerSimpleStyle.js → realtimeSimpleStyle.js}

@@ -1,5 +1,5 @@
 let canvas;
-const style = () => {
+const realtimeSimpleStyle = () => {
   if (!canvas) {
     document.createElement("canvas");
     canvas.width = 15;
@@ -15,4 +15,4 @@ const style = () => {
   }
   return canvas;
 };
-export default style;
+export default realtimeSimpleStyle;

package/common/utils/cleanStopTime.js

@@ -0,0 +1,19 @@
+const cleanStopTime = (content) => {
+  if (!content) {
+    return;
+  }
+  content.stations.forEach((station) => {
+    station.arrivalTimeWithDelay = station.arrivalTime;
+    if (station.departureTime) {
+      station.departureTimeWithDelay = station.departureTime;
+    }
+    if (station.arrivalDelay) {
+      station.arrivalTime -= station.arrivalDelay;
+      if (station.departureTime) {
+        station.departureTime -= station.arrivalDelay;
+      }
+    }
+  });
+  return content;
+};
+export default cleanStopTime;

package/{api/TralisAPIUtils.js → common/utils/compareDepartures.js}

@@ -1,5 +1,4 @@
-export const getModeSuffix = (mode, modes) => mode === modes.SCHEMATIC ? "_schematic" : "";
-export const compareDepartures = (a, b, sortByMinArrivalTime = false) => {
+const compareDepartures = (a, b, sortByMinArrivalTime = false) => {
   const topStates = ["HIDDEN", "LEAVING", "BOARDING"];
   const aTop = a.has_fzo && topStates.indexOf(a.state) > -1;
   const bTop = b.has_fzo && topStates.indexOf(b.state) > -1;
@@ -23,21 +22,4 @@ export const compareDepartures = (a, b, sortByMinArrivalTime = false) => {
   }
   return aDuration - bDuration;
 };
-export const cleanStopTime = (content) => {
-  if (!content) {
-    return;
-  }
-  content.stations.forEach((station) => {
-    station.arrivalTimeWithDelay = station.arrivalTime;
-    if (station.departureTime) {
-      station.departureTimeWithDelay = station.departureTime;
-    }
-    if (station.arrivalDelay) {
-      station.arrivalTime -= station.arrivalDelay;
-      if (station.departureTime) {
-        station.departureTime -= station.arrivalDelay;
-      }
-    }
-  });
-  return content;
-};
+export default compareDepartures;

package/common/utils/getRealtimeModeSuffix.js

@@ -0,0 +1,2 @@
+const getModeSuffix = (mode, modes) => mode === modes.SCHEMATIC ? "_schematic" : "";
+export default getModeSuffix;

package/mapbox/layers/{TralisLayer.js → RealtimeLayer.js}

@@ -3,10 +3,10 @@ import { unByKey } from "ol/Observable";
 import { getWidth, getHeight } from "ol/extent";
 import transformRotate from "@turf/transform-rotate";
 import { point } from "@turf/helpers";
-import mixin from "../../common/mixins/TralisLayerMixin";
+import mixin from "../../common/mixins/RealtimeLayerMixin";
 import Layer from "./Layer";
 import { getSourceCoordinates, getMercatorResolution } from "../utils";
-class TralisLayer extends mixin(Layer) {
+class RealtimeLayer extends mixin(Layer) {
   constructor(options = {}) {
     super({
       ...options
@@ -97,6 +97,9 @@ class TralisLayer extends mixin(Layer) {
     });
   }
   renderTrajectories(noInterpolate) {
+    if (!this.map) {
+      return;
+    }
     const { width, height } = this.map.getCanvas();
     const center = this.map.getCenter();
     const leftBottom = this.map.unproject({
@@ -173,4 +176,4 @@ class TralisLayer extends mixin(Layer) {
     this.map.getCanvasContainer().style.cursor = features.length ? "pointer" : "auto";
   }
 }
-export default TralisLayer;
+export default RealtimeLayer;

package/mapbox/layers/RealtimeLayer.test.js

@@ -0,0 +1,10 @@
+import RealtimeLayer from "./RealtimeLayer";
+let layer;
+describe("RealtimeLayer", () => {
+  beforeEach(() => {
+    layer = new RealtimeLayer();
+  });
+  test("should be instanced.", () => {
+    expect(layer).toBeInstanceOf(RealtimeLayer);
+  });
+});

package/mapbox/layers/index.js

@@ -1,2 +1,2 @@
 export { default as Layer } from "./Layer";
-export { default as TralisLayer } from "./TralisLayer";
+export { default as RealtimeLayer } from "./RealtimeLayer";