mobility-toolbox-js 2.0.1-beta.13 → 2.1.0

package/types/stops.d.ts

@@ -0,0 +1,143 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface Paths {
+  '/': {
+    /** Returns a stop (or multiple) as GeoJSON FeatureCollection */
+    get: {
+      parameters: {
+        query: {
+          /** Control how many matches will be returned */
+          limit?: number;
+          /** Anything you'd like to search for */
+          q: string;
+          /**
+           * comma seperated list, order chooses which agency will be preferred
+           * as ident_source (for id and code fields)
+           */
+          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';
+          /**
+           * 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';
+          /**
+           * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
+           * this position higher
+           */
+          ref_location?: string;
+        };
+      };
+      responses: {
+        /** stop(s) */
+        200: {
+          schema: {
+            /** @enum {string} */
+            type?: 'FeatureCollection';
+            features?: {
+              /** @enum {string} */
+              type?: 'Feature';
+              properties?: {
+                /** @description internal ID */
+                uid?: string;
+                /**
+                 * @description name of the stop
+                 * @example Bern
+                 */
+                name?: string;
+                /**
+                 * @description 2 letter country code where the station is located
+                 * @example CH
+                 */
+                country_code?: string;
+                /**
+                 * @description how well the result matches your query, 0
+                 * means best
+                 */
+                rank?: number;
+                /**
+                 * @description array of translations of the stopname
+                 * @default []
+                 */
+                translated_names?: {
+                  value?: string;
+                  /** @enum {string} */
+                  language?: 'de' | 'en' | 'fr' | 'it';
+                }[];
+                /** @description Means of transport that are available at this station */
+                mot?: {
+                  bus?: boolean;
+                  ferry?: boolean;
+                  gondola?: boolean;
+                  tram?: boolean;
+                  rail?: boolean;
+                  funicular?: boolean;
+                  cable_car?: boolean;
+                  subway?: boolean;
+                };
+                /**
+                 * @description source agency for id and code (see below)
+                 * @example sbb
+                 */
+                ident_source?: string;
+                /**
+                 * @description uic number
+                 * @example 8507000
+                 */
+                id?: string;
+                /**
+                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
+                 *
+                 * @example BN
+                 */
+                code?: string;
+                /** @description ifopt identifier, if available */
+                ifopt?: string;
+              };
+              /** @description the coordinates of the stop */
+              geometry?: {
+                /** @enum {string} */
+                type?: 'Point';
+                /**
+                 * @example [
+                 *   7.439119,
+                 *   46.94882
+                 * ]
+                 */
+                coordinates?: number[];
+              };
+            }[];
+          };
+        };
+        /** limit parameter too high */
+        400: {
+          schema: {
+            /** @enum {string} */
+            error?: '400 Bad Request: Limit has to be an integer between 1 and 500';
+          };
+        };
+      };
+    };
+  };
+}
+
+export interface Operations {}
+
+export interface External {}

package/README.md

@@ -1,23 +0,0 @@
-# mobility-toolbox-js
-
-Toolbox for JavaScript applications in the domains of mobility and logistics.
-The tools in this library have been inspired by many projects realized for public transport agencies, mobility providers and logistics companies.
-
-[![npm](https://img.shields.io/npm/v/mobility-toolbox-js.svg?style=flat-square)](https://www.npmjs.com/package/mobility-toolbox-js)
-[![Build](https://github.com/geops/mobility-toolbox-js/workflows/Build/badge.svg)](https://github.com/geops/mobility-toolbox-js/actions?query=workflow%3ABuild)
-[![Netlify Status](https://api.netlify.com/api/v1/badges/b368ab18-9dbf-416c-91f6-a82076b02c10/deploy-status)](https://app.netlify.com/sites/mobility-toolbox-js/deploys)
-
-## Main Features
-
-* Display [real-time vehicle positions and prognosis data](http://tracker.geops.ch/) on a map.
-* Search for [stops and stations](https://maps2.trafimage.ch) all over the world.
-* Get [precise geographic courses](https://geops.github.io/geops-routing-demo/) for all modes of transport.
-* Generate beautiful maps for public transport, mobility and logistics
-
-## Documentation and examples
-
-Visit https://master--mobility-toolbox-js.netlify.app/
-
-## Version 1.x.x
-
-The master branch is now open for the version 2 development. The version 1 is still available in [1.x.x](https://github.com/geops/mobility-toolbox-js/tree/1.x.x) branch.

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/api/TralisAPI.js

@@ -1,359 +0,0 @@
-import WebSocketAPI from "../common/api/WebSocketAPI";
-import {
-  getModeSuffix,
-  cleanStopTime,
-  compareDepartures
-} from "./TralisAPIUtils";
-export const TralisModes = {
-  RAW: "raw",
-  TOPOGRAPHIC: "topographic",
-  SCHEMATIC: "schematic"
-};
-class TralisAPI {
-  constructor(options = {}) {
-    this.defineProperties(options);
-    this.subscribedStationUic = null;
-    this.departureUpdateTimeout = null;
-    this.maxDepartureAge = 30;
-    this.extraGeoms = {};
-    this.prefix = options.prefix || "";
-    this.onOpen = this.onOpen.bind(this);
-  }
-  defineProperties(options) {
-    let opt = options;
-    if (typeof options === "string") {
-      opt = { url: options };
-    }
-    const { apiKey } = opt;
-    let { url, projection, bbox, buffer = [100, 100] } = opt;
-    const wsApi = new WebSocketAPI();
-    if (apiKey) {
-      url = `${url || "wss://api.geops.io/tracker-ws/v1/"}?key=${apiKey}`;
-    }
-    Object.defineProperties(this, {
-      url: {
-        get: () => url,
-        set: (newUrl) => {
-          url = newUrl;
-          this.open();
-        }
-      },
-      projection: {
-        get: () => projection,
-        set: (newProjection) => {
-          if (newProjection !== projection) {
-            projection = newProjection;
-            if (this.wsApi) {
-              this.wsApi.send(`PROJECTION ${projection}`);
-            }
-          }
-        }
-      },
-      bbox: {
-        get: () => bbox,
-        set: (newBbox) => {
-          if (JSON.stringify(newBbox) !== JSON.stringify(bbox)) {
-            bbox = newBbox;
-            if (this.wsApi) {
-              this.wsApi.send(`BBOX ${bbox.join(" ")}`);
-            }
-          }
-        }
-      },
-      buffer: {
-        get: () => buffer,
-        set: (newBuffer) => {
-          if (JSON.stringify(newBuffer) !== JSON.stringify(buffer)) {
-            buffer = newBuffer;
-            if (this.wsApi) {
-              this.wsApi.send(`BUFFER ${buffer.join(" ")}`);
-            }
-          }
-        }
-      },
-      wsApi: {
-        value: wsApi,
-        writable: true
-      },
-      pingIntervalMs: {
-        value: options.pingIntervalMs || 1e4,
-        writable: true
-      },
-      reconnectTimeoutMs: {
-        value: options.pingIntervalMs || 100,
-        writable: true
-      }
-    });
-  }
-  open() {
-    this.close();
-    this.wsApi.connect(this.url, this.onOpen);
-    this.wsApi.websocket.onclose = () => {
-      this.onClose();
-    };
-  }
-  close() {
-    this.wsApi.close();
-  }
-  reset() {
-    this.wsApi.send("RESET");
-  }
-  onOpen() {
-    if (this.projection) {
-      this.wsApi.send(`PROJECTION ${this.projection}`);
-    }
-    if (this.bbox) {
-      this.wsApi.send(`BBOX ${this.bbox.join(" ")}`);
-    }
-    if (this.buffer) {
-      this.wsApi.send(`BUFFER ${this.buffer.join(" ")}`);
-    }
-    if (this.pingIntervalMs) {
-      window.clearInterval(this.pingInterval);
-      this.pingInterval = setInterval(() => {
-        this.wsApi.send("PING");
-      }, this.pingIntervalMs);
-    }
-  }
-  onClose() {
-    window.clearTimeout(this.pingInterval);
-    window.clearTimeout(this.reconnectTimeout);
-    if (this.reconnectTimeoutMs) {
-      this.reconnectTimeout = window.setTimeout(() => this.open(), this.reconnectTimeoutMs);
-    }
-  }
-  subscribe(channel, onSuccess, onError, quiet = false) {
-    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);
-  }
-  filterDepartures(depObject, sortByMinArrivalTime = false) {
-    const departures = Object.keys(depObject).map((k) => depObject[k]);
-    departures.sort((a, b) => compareDepartures(a, b, sortByMinArrivalTime));
-    let future = new Date();
-    future.setMinutes(future.getMinutes() + this.maxDepartureAge);
-    future = future.getTime();
-    let past = new Date();
-    past.setMinutes(past.getMinutes() - this.maxDepartureAge);
-    past = past.getTime();
-    const departureArray = [];
-    const platformsBoarding = [];
-    let previousDeparture = null;
-    for (let i = departures.length - 1; i >= 0; i -= 1) {
-      const d = departures[i];
-      const t = new Date(d.time).getTime();
-      if (t > past && t < future) {
-        if (d.state === "BOARDING") {
-          if (platformsBoarding.indexOf(d.platform) === -1) {
-            platformsBoarding.push(d.platform);
-          } else {
-            d.state = "HIDDEN";
-          }
-        }
-        if (previousDeparture && d.to[0] === previousDeparture.to[0] && Math.abs(t - previousDeparture.time) < 1e3 && d.line.name === previousDeparture.line.name) {
-          d.state = "HIDDEN";
-        }
-        if (/(STOP_CANCELLED|JOURNEY_CANCELLED)/.test(d.state)) {
-          d.cancelled = true;
-        }
-        previousDeparture = d;
-        previousDeparture.time = t;
-        departureArray.unshift(d);
-      }
-    }
-    return departureArray;
-  }
-  subscribeDepartures(stationId, sortByMinArrivalTime, onMessage) {
-    window.clearTimeout(this.departureUpdateTimeout);
-    this.unsubscribeDepartures();
-    this.subscribedStationUic = stationId;
-    const channel = stationId ? `timetable_${stationId}` : null;
-    const departureObject = {};
-    this.subscribe(channel, (data) => {
-      if (data.source === channel) {
-        const content = data.content || {};
-        const tDiff = new Date(content.timestamp).getTime() - Date.now();
-        content.timediff = tDiff;
-        departureObject[content.call_id] = content;
-        window.clearTimeout(this.departureUpdateTimeout);
-        this.departureUpdateTimeout = window.setTimeout(() => {
-          const departures = this.filterDepartures(departureObject, sortByMinArrivalTime || false);
-          onMessage(departures);
-        }, 100);
-      }
-    }, () => {
-      onMessage([]);
-    });
-  }
-  unsubscribeDepartures(cb) {
-    if (this.subscribedStationUic) {
-      this.unsubscribe(`timetable_${this.subscribedStationUic}`, "", cb);
-      this.subscribedStationUic = null;
-    }
-  }
-  subscribeDisruptions(onMessage) {
-    this.subscribe(`${this.prefix}newsticker`, (data) => {
-      onMessage(data.content);
-    });
-  }
-  unsubscribeDisruptions(cb) {
-    this.unsubscribe(`${this.prefix}newsticker`, "", cb);
-  }
-  getStation(uic, mode) {
-    const params = {
-      channel: `station${getModeSuffix(mode, TralisModes)}`,
-      args: uic
-    };
-    return new Promise((resolve, reject) => {
-      this.wsApi.get(params, (data) => {
-        if (data.content) {
-          resolve(data.content);
-        } else {
-          reject();
-        }
-      });
-    });
-  }
-  getStations(mode) {
-    const stations = [];
-    const params = {
-      channel: `station${getModeSuffix(mode, TralisModes)}`
-    };
-    window.clearTimeout(this.stationUpdateTimeout);
-    return new Promise((resolve, reject) => {
-      this.wsApi.get(params, (data) => {
-        if (data.content) {
-          stations.push(data.content);
-          window.clearTimeout(this.stationUpdateTimeout);
-          this.stationUpdateTimeout = window.setTimeout(() => {
-            resolve(stations);
-          }, 50);
-        } else {
-          reject(data.content);
-        }
-      });
-    });
-  }
-  subscribeStations(mode, onMessage) {
-    this.unsubscribeStations();
-    this.subscribe(`station${getModeSuffix(mode, TralisModes)}`, (data) => {
-      if (data.content) {
-        onMessage(data.content);
-      }
-    });
-  }
-  unsubscribeStations(cb) {
-    window.clearTimeout(this.stationUpdateTimeout);
-    this.unsubscribe("station", "", cb);
-  }
-  subscribeExtraGeoms(onMessage) {
-    this.subscribe("extra_geoms", (data) => {
-      const extraGeom = data.content;
-      if (extraGeom) {
-        const { ref } = extraGeom.properties;
-        if (extraGeom.type === "Feature") {
-          this.extraGeoms[ref] = extraGeom;
-        } else {
-          delete this.extraGeoms[ref];
-        }
-        onMessage(Object.keys(this.extraGeoms).map((key) => this.extraGeoms[key]));
-      }
-    });
-  }
-  unsubscribeExtraGeoms(cb) {
-    this.unsubscribe("extra_geoms", "", cb);
-  }
-  subscribeTrajectory(mode, onMessage, quiet = false) {
-    this.unsubscribeTrajectory(onMessage);
-    this.subscribe(`trajectory${getModeSuffix(mode, TralisModes)}`, 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);
-  }
-  unsubscribeDeletedVehicles(cb) {
-    this.unsubscribe("deleted_vehicles", "", cb);
-  }
-  getFullTrajectory(id, mode, generalizationLevel) {
-    const channel = [`full_trajectory${getModeSuffix(mode, TralisModes)}`];
-    if (id) {
-      channel.push(id);
-    }
-    if ((!mode || mode === TralisModes.TOPOGRAPHIC) && generalizationLevel) {
-      channel.push(`gen${generalizationLevel}`);
-    }
-    const params = {
-      channel: channel.join("_")
-    };
-    return new Promise((resolve) => {
-      this.wsApi.get(params, (data) => {
-        if (data.content) {
-          resolve(data.content);
-        }
-      });
-    });
-  }
-  getFullTrajectories(ids, mode, generalizationLevel) {
-    const promises = ids.map((id) => this.getFullTrajectory(id, mode, generalizationLevel));
-    return Promise.all(promises);
-  }
-  subscribeFullTrajectory(id, mode) {
-    this.unsubscribeFullTrajectory(id);
-    this.subscribe(`full_trajectory${getModeSuffix(mode, TralisModes)}_${id}`, (data) => {
-      console.log("subscribe full_trajectory", data);
-    }, (err) => {
-      console.log("subscribe full_trajectory error", err);
-    });
-  }
-  unsubscribeFullTrajectory(id, cb) {
-    this.unsubscribe("full_trajectory", `_${id}`, cb);
-  }
-  getStopSequence(id) {
-    const params = {
-      channel: `stopsequence_${id}`
-    };
-    return new Promise((resolve, reject) => {
-      this.wsApi.get(params, (data) => {
-        if (data.content && data.content.length) {
-          const content = data.content.map((stopSequence) => cleanStopTime(stopSequence));
-          resolve(content);
-        }
-        resolve([]);
-      }, (err) => {
-        reject(err);
-      });
-    });
-  }
-  getStopSequences(ids) {
-    const promises = ids.map((id) => this.getStopSequence(id));
-    return Promise.all(promises);
-  }
-  subscribeStopSequence(id, onMessage) {
-    window.clearTimeout(this.fullTrajectoryUpdateTimeout);
-    this.unsubscribeStopSequence(id);
-    this.subscribe(`stopsequence_${id}`, (data) => {
-      if (data.content && data.content.length) {
-        const content = data.content.map((stopSequence) => cleanStopTime(stopSequence));
-        onMessage(content);
-      }
-    }, (err) => {
-      console.log("subscribe stopsequence error", err);
-    });
-  }
-  unsubscribeStopSequence(id, cb) {
-    this.unsubscribe(`stopsequence`, `_${id}`, cb);
-  }
-  subscribeHealthCheck(onMessage) {
-    this.unsubscribeHealthCheck();
-    this.subscribe("healthcheck", onMessage);
-  }
-  unsubscribeHealthCheck() {
-    this.unsubscribe("healthcheck");
-  }
-}
-export default TralisAPI;

package/api/TralisAPI.test.js

@@ -1,67 +0,0 @@
-import { TralisAPI, TralisModes } from ".";
-describe("TralisAPI", () => {
-  let tralisAPI;
-  let get;
-  beforeEach(() => {
-    get = jest.fn((params, cb) => {
-      cb({ content: "content" });
-    });
-    tralisAPI = new TralisAPI();
-    tralisAPI.wsApi = {
-      get
-    };
-  });
-  describe("#getFullTrajectory() calls fullTrajectory channel", () => {
-    test("without parameters", (done) => {
-      tralisAPI.getFullTrajectory().then(() => {
-        expect(get.mock.calls.length).toBe(1);
-        expect(get.mock.calls[0][0]).toEqual({
-          channel: "full_trajectory"
-        });
-        done();
-      });
-    });
-    [null, TralisModes.TOPOGRAPHIC].forEach((mode) => {
-      describe(`using mode ${mode}`, () => {
-        test("using id", (done) => {
-          tralisAPI.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) => {
-          tralisAPI.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) => {
-        tralisAPI.getFullTrajectory("foo", TralisModes.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) => {
-        tralisAPI.getFullTrajectory("foo", TralisModes.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/TralisAPIUtils.js

@@ -1,43 +0,0 @@
-export const getModeSuffix = (mode, modes) => mode === modes.SCHEMATIC ? "_schematic" : "";
-export 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;
-  if (aTop || bTop) {
-    if (aTop !== bTop) {
-      return aTop ? -1 : 1;
-    }
-    if (a.state !== b.state) {
-      return topStates.indexOf(a.state) - topStates.indexOf(b.state);
-    }
-  }
-  let aDuration = null;
-  let bDuration = null;
-  const now = Date.now();
-  if (sortByMinArrivalTime) {
-    aDuration = new Date(a.min_arrival_time || a.time).getTime() - now;
-    bDuration = new Date(b.min_arrival_time || b.time).getTime() - now;
-  } else {
-    aDuration = new Date(a.time).getTime() - now;
-    bDuration = new Date(b.time).getTime() - now;
-  }
-  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;
-};