mobility-toolbox-js 1.6.1 → 1.6.4-beta.2

package/api/routing/RoutingAPI.js

@@ -32,7 +32,7 @@ class RoutingAPI extends API {
    *
    * @param {RoutingSearchParams} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+   * @return {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
    */
   route(params, abortController = new AbortController()) {
     return this.fetch('', params, {

package/api/stops/StopsAPI.js

@@ -29,7 +29,7 @@ class StopsAPI extends API {
    *
    * @param {StopsSearchParams} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
+   * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
    */
   search(params, abortController = {}) {
     return this.fetch('', params, {

package/api/trajserv/TrajservAPI.js

@@ -33,7 +33,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoryByIdParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectorybyid).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<TrajservTrajectory>} A trajectory.
+   * @return {Promise<TrajservTrajectory>} A trajectory.
    */
   fetchTrajectoryById(params, abortController = {}) {
     return this.fetch(`/trajectorybyid`, params, {
@@ -46,7 +46,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoriesParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectory_collection).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<Trajectory>>} A list of trajectories.
+   * @return {Promise<Array<Trajectory>>} A list of trajectories.
    */
   fetchTrajectories(params, abortController = {}) {
     return this.fetch(`/trajectory_collection`, params, {
@@ -61,7 +61,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoryStationsParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajstations).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<TrajectoryStation>>} A list of stations.
+   * @return {Promise<Array<TrajectoryStation>>} A list of stations.
    */
   fetchTrajectoryStations(params, abortController = {}) {
     return this.fetch(`/trajstations`, params, {

package/api/trajserv/TrajservAPIUtils.js

@@ -2,7 +2,7 @@ import { LineString } from 'ol/geom';
 
 /**
  * Translate the response date object into a readable object.
- * @returns {Date[]}
+ * @return {Date[]}
  * @ignore
  */
 const translateDates = (dates = []) => {
@@ -21,7 +21,7 @@ const translateDates = (dates = []) => {
 
 /**
  * Translate the trajstations response into a readable object.
- * @returns {Object} returns a readable object
+ * @return {Object} returns a readable object
  * @private
  */
 export const translateTrajStationsResp = (data) => {
@@ -125,7 +125,7 @@ export const translateTrajStationsResp = (data) => {
 
 /**
  * Translate the trajectory_collection response into a js usable object.
- * @returns {Array} returns an array of trajectories.
+ * @return {Array} returns an array of trajectories.
  * @ignore
  */
 export const translateTrajCollResponse = (features = []) => {

package/api/tralis/TralisAPI.js

@@ -21,7 +21,7 @@ export const TralisModes = {
 };
 
 /**
- * Access to Tralis service.
+ * This class provides convenience methods to access to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
  *
  * @example
  * import { TralisAPI } from 'mobility-toolbox-js/api';
@@ -41,30 +41,14 @@ class TralisAPI {
    * Constructor
    *
    * @param {Object|string} options A string representing the url of the service or an object containing the url and the apiKey.
-   * @param {string} options.url Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+   * @param {string} options.url Url to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
+   * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
    * @param {string} [options.prefix=''] Service prefix to specify tenant.
-   * @param {string} [options.projection] The epsg code of the projection for features.
-   * @param {number[4]} [options.bbox=[minX, minY, maxX, maxY] The bounding box to receive data from.
+   * @param {string} [options.projection] The epsg code of the projection for features. Default to EPSG:3857.
+   * @param {number[4]} [options.bbox=[minX, minY, maxX, maxY, zoom, tenant] The bounding box to receive data from.
    */
   constructor(options = {}) {
-    let wsUrl = null;
-
-    if (typeof options === 'string') {
-      wsUrl = options;
-    } else {
-      wsUrl = options.url;
-    }
-
-    if (options.apiKey) {
-      wsUrl = `${wsUrl}?key=${options.apiKey}`;
-    }
-
-    /** @ignore */
-    this.bbox = options.bbox;
-
-    /** @ignore */
-    this.projection = options.projection || 'EPSG:3857';
+    this.defineProperties(options);
 
     /** @ignore */
     this.subscribedStationUic = null;
@@ -80,38 +64,113 @@ class TralisAPI {
 
     /** @ignore */
     this.prefix = options.prefix || '';
+  }
 
-    this.isUpdateBboxOnMoveEnd = options.isUpdateBboxOnMoveEnd || false;
+  defineProperties(options) {
+    let opt = options;
 
-    /** @ignore */
-    this.conn = new WebSocketConnector(wsUrl);
+    if (typeof options === 'string') {
+      opt = { url: options };
+    }
+
+    const { apiKey } = opt;
+    let { url, projection, bbox } = opt;
+    const conn = new WebSocketConnector();
 
-    if (options.projection) {
-      this.setProjection(options.projection);
+    if (apiKey) {
+      url = `${url || 'wss://tralis-tracker-api.geops.io/ws'}?key=${apiKey}`;
     }
+
+    Object.defineProperties(this, {
+      url: {
+        get: () => {
+          return url;
+        },
+        set: (newUrl) => {
+          url = newUrl;
+          this.open();
+        },
+      },
+      projection: {
+        get: () => {
+          return projection;
+        },
+        set: (newProjection) => {
+          if (newProjection !== projection) {
+            projection = newProjection;
+            if (this.conn) {
+              this.conn.send(`PROJECTION ${projection}`);
+            }
+          }
+        },
+      },
+      bbox: {
+        get: () => {
+          return bbox;
+        },
+        set: (newBbox) => {
+          if (JSON.stringify(newBbox) !== JSON.stringify(bbox)) {
+            bbox = newBbox;
+            if (this.conn) {
+              this.conn.send(`BBOX ${bbox.join(' ')}`);
+            }
+          }
+        },
+      },
+      /**
+       * The websocket helper class to connect the websocket.
+       *
+       * @private
+       */
+      conn: {
+        value: conn,
+        writable: true,
+      },
+      /**
+       * Interval between PING request in ms.
+       * If equal to 0,  no PING request are sent.
+       * @type {number}
+       * @private
+       */
+      pingIntervalMs: {
+        value: options.pingIntervalMs || 10000,
+        writable: true,
+      },
+      /**
+       * Timeout in ms after an automatic reconnection when the websoscket has been closed by the server.
+       * @type {number}
+       */
+      reconnectTimeoutMs: {
+        value: options.pingIntervalMs || 100,
+        writable: true,
+      },
+    });
   }
 
-  /**
-   * Send the projection to use. Default to EPSG:3857.
-   *
-   * @param {string} epsgCode The EPSG code of the projection.
-   */
-  setProjection(epsgCode) {
-    this.conn.send(`PROJECTION ${epsgCode}`);
+  open() {
+    this.close();
+    this.conn.connect(this.url);
+
+    // Register BBOX and PROJECTION messages on open.
+    if (this.conn.connecting) {
+      this.conn.websocket.addEventListener('open', () => {
+        this.onOpen();
+      });
+    } else {
+      this.onOpen();
+    }
+
+    // Register reconnection on close.
+    this.conn.websocket.onclose = () => {
+      this.onClose();
+    };
   }
 
   /**
-   * Send the bbox to the service, if the first time it will also subscribe to trajectory and deleted_vehicles channels.
-   *
-   * @param {number[5]} bbox The bounding box and the zoom level to receive data from.
+   * Close the websocket connection without reconnection.
    */
-  setBbox(bbox) {
-    /**
-     * The BBOX for websocket responses
-     * @type {Array<number>}
-     */
-    this.bbox = bbox;
-    this.conn.send(`BBOX ${bbox.join(' ')}`);
+  close() {
+    this.conn.close();
   }
 
   /**
@@ -122,6 +181,47 @@ class TralisAPI {
     this.conn.send('RESET');
   }
 
+  /**
+   * Callback when the websocket is opened and ready.
+   * It applies the bbox and the projection.
+   */
+  onOpen() {
+    if (this.projection) {
+      this.conn.send(`PROJECTION ${this.projection}`);
+    }
+    if (this.bbox) {
+      this.conn.send(`BBOX ${this.bbox.join(' ')}`);
+    }
+
+    /**
+     * Keep websocket alive
+     */
+    if (this.pingIntervalMs) {
+      window.clearInterval(this.pingInterval);
+      /** @ignore */
+      this.pingInterval = setInterval(() => {
+        this.conn.send('PING');
+      }, this.pingIntervalMs);
+    }
+  }
+
+  /**
+   * Callback when the websocket is closed by the server.
+   * It auto reconnects after a timeout.
+   */
+  onClose() {
+    window.clearTimeout(this.pingInterval);
+    window.clearTimeout(this.reconnectTimeout);
+
+    if (this.reconnectTimeoutMs) {
+      /** @ignore */
+      this.reconnectTimeout = window.setTimeout(
+        () => this.open(),
+        this.reconnectTimeoutMs,
+      );
+    }
+  }
+
   /**
    * Subscribe to a channel.
    *
@@ -162,7 +262,7 @@ class TralisAPI {
    *
    * @param {Object} depObject The object containing departures by id.
    * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
-   * @returns {Array<departure>} Return departures array.
+   * @return {Array<departure>} Return departures array.
    * @private
    */
   filterDepartures(depObject, sortByMinArrivalTime = false) {
@@ -294,7 +394,7 @@ class TralisAPI {
    *
    * @param {number} uic UIC of the station.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<Station>} A station.
+   * @return {Promise<Station>} A station.
    */
   getStation(uic, mode) {
     const params = {
@@ -317,14 +417,10 @@ class TralisAPI {
    * Update the model's station list for a given mode and a bbox.
    *
    * @param {TralisMode} mode Tralis mode.
-   * @param {number[4]} bbox The extent where to request.
-   * @returns {Promise<Array<Station>>} An array of stations.
+   * @return {Promise<Array<Station>>} An array of stations.
    */
-  getStations(mode, bbox) {
+  getStations(mode) {
     const stations = [];
-    if (bbox) {
-      this.conn.setBbox(bbox);
-    }
     const params = {
       channel: `station${getModeSuffix(mode, TralisModes)}`,
     };
@@ -350,14 +446,10 @@ class TralisAPI {
    * One message pro station.
    *
    * @param {TralisMode} mode Tralis mode.
-   * @param {number[4]} bbox The extent where to request.
    * @param {function(station: Station)} onMessage Function called on each message of the channel.
    */
-  subscribeStations(mode, bbox, onMessage) {
+  subscribeStations(mode, onMessage) {
     this.unsubscribeStations();
-    if (bbox) {
-      this.conn.setBbox(bbox);
-    }
     this.subscribe(`station${getModeSuffix(mode, TralisModes)}`, (data) => {
       if (data.content) {
         onMessage(data.content);
@@ -412,14 +504,15 @@ class TralisAPI {
    *
    * @param {TralisMode} mode Tralis mode.
    * @param {function(trajectory: TralisTrajectory)} onMessage Function called on each message of the channel.
+   * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
    */
-  subscribeTrajectory(mode, onMessage) {
+  subscribeTrajectory(mode, onMessage, quiet = false) {
     this.unsubscribeTrajectory(onMessage);
     this.subscribe(
       `trajectory${getModeSuffix(mode, TralisModes)}`,
       onMessage,
       null,
-      this.isUpdateBboxOnMoveEnd,
+      quiet,
     );
   }
 
@@ -436,14 +529,15 @@ class TralisAPI {
    *
    * @param {TralisMode} mode Tralis mode.
    * @param {function(response: { content: Vehicle })} onMessage Function called on each message of the channel.
+   * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
    */
-  subscribeDeletedVehicles(mode, onMessage) {
+  subscribeDeletedVehicles(mode, onMessage, quiet = false) {
     this.unsubscribeDeletedVehicles(onMessage);
     this.subscribe(
       `deleted_vehicles${getModeSuffix(mode, TralisModes)}`,
       onMessage,
       null,
-      this.isUpdateBboxOnMoveEnd,
+      quiet,
     );
   }
 
@@ -460,11 +554,21 @@ class TralisAPI {
    *
    * @param {string} id A vehicle id.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<FullTrajectory>} Return a full trajectory.
+   * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
+   * @return {Promise<FullTrajectory>} Return a full trajectory.
    */
-  getFullTrajectory(id, mode) {
+  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: `full_trajectory${getModeSuffix(mode, TralisModes)}_${id}`,
+      channel: channel.join('_'),
     };
 
     return new Promise((resolve) => {
@@ -481,11 +585,12 @@ class TralisAPI {
    *
    * @param {string[]} ids List of vehicles ids.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<Array<FullTrajectory>>} Return an array of full trajectories.
+   * @param {string} generalizationLevel The generalization level to request. Can be one of '', 'gen5', 'gen10', 'gen30', 'gen100'.
+   * @return {Promise<Array<FullTrajectory>>} Return an array of full trajectories.
    */
-  getFullTrajectories(ids, mode) {
+  getFullTrajectories(ids, mode, generalizationLevel) {
     const promises = ids.map((id) => {
-      return this.getFullTrajectory(id, mode);
+      return this.getFullTrajectory(id, mode, generalizationLevel);
     });
     return Promise.all(promises);
   }
@@ -526,7 +631,7 @@ class TralisAPI {
    * Get the list of stops for this vehicle.
    *
    * @param {string} id A vehicle id.
-   * @returns {Promise<StopSequence>} Returns a stop sequence object.
+   * @return {Promise<StopSequence>} Returns a stop sequence object.
    */
   getStopSequence(id) {
     const params = {
@@ -557,7 +662,7 @@ class TralisAPI {
    * Get a list of stops for a list of vehicles.
    *
    * @param {string[]} ids List of vehicles ids.
-   * @returns {Promise<Array<StopSequence>>} Return an array of stop sequences.
+   * @return {Promise<Array<StopSequence>>} Return an array of stop sequences.
    */
   getStopSequences(ids) {
     const promises = ids.map((id) => {

package/api/tralis/TralisAPI.test.js

@@ -0,0 +1,75 @@
+import { TralisAPI, TralisModes } from '..';
+
+describe('TralisAPI', () => {
+  let tralisAPI;
+  let get;
+
+  beforeEach(() => {
+    get = jest.fn((params, cb) => {
+      cb({ content: 'content' });
+    });
+    tralisAPI = new TralisAPI();
+    tralisAPI.conn = {
+      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();
+          });
+      });
+    });
+  });
+});