mobility-toolbox-js 3.0.0-beta.9 → 3.0.1-beta.0

package/api/RealtimeAPI.js

@@ -1,8 +1,8 @@
 /* eslint-disable no-underscore-dangle */
-/* eslint-disable class-methods-use-this */
-import WebSocketAPI from './WebSocketAPI';
 import debounceWebsocketMessages from '../common/utils/debounceWebsocketMessages';
 import getModeSuffix from '../common/utils/getRealtimeModeSuffix';
+/* eslint-disable class-methods-use-this */
+import WebSocketAPI from './WebSocketAPI';
 /**
  * Enum for Realtime modes.
  * @readonly
@@ -11,14 +11,15 @@ import getModeSuffix from '../common/utils/getRealtimeModeSuffix';
  * @property {string} SCHEMATIC "schematic"
  * @property {string} TOPOGRAPHIC "topographic"
  * @enum {RealtimeMode}
+ * @public
  */
 export const RealtimeModes = {
     RAW: 'raw',
-    TOPOGRAPHIC: 'topographic',
     SCHEMATIC: 'schematic',
+    TOPOGRAPHIC: 'topographic',
 };
 /**
- * This class provides convenience methods to use to the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+ * This class provides convenience methods to use to the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
  * import { RealtimeAPI } from 'mobility-toolbox-js/api';
@@ -29,86 +30,27 @@ export const RealtimeModes = {
  *   // url: "wss://api.geops.io/tracker-ws/v1/",
  * });
  *
+ * // Open the websocket connection
  * api.open();
  *
+ * // Subscribe to channel
  * api.subscribeTrajectory('topographic', (data) => {
  *    console.log('Log trajectories:', JSON.stringify(data.content));
  * });
  *
+ * // Close the websocket connection
+ * // api.close();
+ *
  * @public
  */
 class RealtimeAPI {
-    get url() {
-        return this._url;
-    }
-    set url(newUrl) {
-        if (this._url !== newUrl) {
-            this._url = newUrl;
-            // Update the websocket only if the url has changed and the websocket is already open or is opening.
-            if (this.wsApi.open || this.wsApi.connecting) {
-                this.open();
-            }
-        }
-    }
-    /**
-     * The bounding box to receive data from.\
-     * Example: [minX, minY, maxX, maxY, zoom, mots , gen_level, tenant, ...]\
-     *  \
-     * Where:
-     * - **minX**: a string representation of an integer (not a float) representing the minimal X coordinate (in EPSG:3857) of a bounding box\
-     *  
-     * - **minY**: a string representation of an integer (not a float) representing the minimal Y coordinate (in EPSG:3857) of a bounding box\
-     *  
-     * - **maxX**: a string representation of an integer (not a float) representing the maximal X coordinate (in EPSG:3857) of a bounding box\
-     *  
-     * - **maxY**: a string representation of an integer (not a float) representing the maximal Y coordinate (in EPSG:3857) of a bounding box\
-     *  
-     * - **zoom**: a string representation of an integer representing the zoom level (from 4 to 22). When zoom < 8 only the trains are displayed for performance reasons.\
-     * &nbsp;
-     * - **mots**: A comma separated list of modes of transport. **Optional**.\
-     *         Example: "mots=rail,subway".\
-     * &nbsp;
-     * - **gen_level**: An integer representing the generalization level. **Optional**.\
-     *              Example: "gen_level=5"\
-     * &nbsp;
-     * - **tenant**: A string representing the tenant. **Optional**.\
-     *           Example: "tenant=sbb"\
-     * &nbsp;
-     * - ...: Any other values added to the bbox will be send to the server
-     *
-     * @type {string[]}
-     *
-     * @public
-     */
-    get bbox() {
-        return this._bbox;
-    }
-    set bbox(newBbox) {
-        if (JSON.stringify(newBbox) !== JSON.stringify(this._bbox)) {
-            this._bbox = newBbox;
-            if (this.wsApi && this._bbox) {
-                this.wsApi.send(`BBOX ${this._bbox.join(' ')}`);
-            }
-        }
-    }
-    get buffer() {
-        return this._buffer;
-    }
-    set buffer(newBuffer) {
-        if (JSON.stringify(newBuffer) !== JSON.stringify(this._buffer)) {
-            this._buffer = newBuffer;
-            if (this.wsApi && this._buffer) {
-                this.wsApi.send(`BUFFER ${this._buffer.join(' ')}`);
-            }
-        }
-    }
     /**
      * Constructor
      *
-     * @param {Object} options A string representing the url of the service or an object containing the url and the apiKey.
-     * @param {string} options.url Url to the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+     * @param {Object} options Options.
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
      * @param {string[]} options.bbox The bounding box to receive data from.
+     * @param {string} [options.url='wss://api.geops.io/tracker-ws/v1/'] Url of the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
      * @public
      */
     constructor(options = {}) {
@@ -126,6 +68,7 @@ class RealtimeAPI {
         }
         this._url = (url || 'wss://api.geops.io/tracker-ws/v1/') + suffix;
         this._buffer = opt.buffer || [100, 100];
+        this._bbox = opt.bbox;
         this.version = opt.version || '2';
         /**
          * Interval between PING request in ms.
@@ -144,32 +87,111 @@ class RealtimeAPI {
         this.wsApi = wsApi;
     }
     /**
-     * Open the websocket connection.
+     * Close the websocket connection without reconnection.
      *
      * @public
      */
-    open() {
-        this.wsApi.connect(this.url, this.onOpen.bind(this));
-        // Register reconnection on close.
-        if (this.wsApi.websocket) {
-            this.wsApi.websocket.onclose = () => {
-                this.onClose();
-            };
+    close() {
+        this.wsApi.close();
+    }
+    /**
+     * Send GET to a channel.
+     *
+     * @param {string | WebSocketAPIParameters} channelOrParams Name of the websocket channel to send GET or an object representing parameters to send
+     * @return {Promise<WebSocketAPIMessageEventData<?>>} A websocket response.
+     * @public
+     */
+    get(channelOrParams) {
+        let params = channelOrParams;
+        if (typeof channelOrParams === 'string') {
+            params = { channel: channelOrParams };
         }
+        return new Promise((resolve, reject) => {
+            this.wsApi.get(params, resolve, reject);
+        });
     }
     /**
-     * Close the websocket connection without reconnection.
+     * Get a full trajectory of a vehicule .
      *
+     * @param {string} id A vehicle id.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
+     * @return {Promise<{data: { content: RealtimeFullTrajectory }}>} Return a full trajectory.
      * @public
      */
-    close() {
-        this.wsApi.close();
+    getFullTrajectory(id, mode, generalizationLevel) {
+        let suffix = '';
+        if (this.version === '1') {
+            suffix = getModeSuffix(mode, RealtimeModes);
+        }
+        const channel = [`full_trajectory${suffix}`];
+        if (id) {
+            channel.push(id);
+        }
+        if ((!mode || mode === RealtimeModes.TOPOGRAPHIC) && generalizationLevel) {
+            channel.push(`gen${generalizationLevel}`);
+        }
+        return this.get(channel.join('_'));
     }
     /**
-     * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
+     * Return a station with a given uic number and a mode.
+     *
+     * @param {number} uic UIC of the station.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<{data: { content: RealtimeStation }}>} A station.
+     * @public
      */
-    reset() {
-        this.wsApi.send('RESET');
+    getStation(uic, mode) {
+        const params = {
+            args: uic,
+            channel: `station${getModeSuffix(mode, RealtimeModes)}`,
+        };
+        return this.get(params);
+    }
+    /**
+     * Get the list of ststions available for a specifc mode. The promise is resolved every 100ms
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {number} timeout = 100 Duration in ms between each promise resolve calls.
+     * @return {Promise<RealtimeStation[]>} An array of stations.
+     * @public
+     */
+    getStations(mode, timeout = 100) {
+        return new Promise((resolve) => {
+            this.get(`station${getModeSuffix(mode, RealtimeModes)}`).then(debounceWebsocketMessages(resolve, undefined, timeout));
+        });
+    }
+    /**
+     * Get the list of stops for this vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @return {Promise<{data: { content: RealtimeStopSequence[] }}>} Returns a stop sequence object.
+     * @public
+     */
+    getStopSequence(id) {
+        return this.get(`stopsequence_${id}`);
+    }
+    /**
+     * Return a partial trajectory with a given id and a mode.
+     *
+     * @param {number} id The identifier of a trajectory.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
+     * @public
+     */
+    getTrajectory(id, mode) {
+        return this.get(`partial_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`);
+    }
+    /**
+     * Callback when the websocket is closed by the server.
+     * It auto reconnects after a timeout.
+     * @private
+     */
+    onClose() {
+        window.clearTimeout(this.pingInterval);
+        window.clearTimeout(this.reconnectTimeout);
+        if (this.reconnectTimeoutMs) {
+            this.reconnectTimeout = window.setTimeout(() => this.open(), this.reconnectTimeoutMs);
+        }
     }
     /**
      * Callback when the websocket is opened and ready.
@@ -194,31 +216,24 @@ class RealtimeAPI {
         }
     }
     /**
-     * Callback when the websocket is closed by the server.
-     * It auto reconnects after a timeout.
-     * @private
+     * Open the websocket connection.
+     *
+     * @public
      */
-    onClose() {
-        window.clearTimeout(this.pingInterval);
-        window.clearTimeout(this.reconnectTimeout);
-        if (this.reconnectTimeoutMs) {
-            this.reconnectTimeout = window.setTimeout(() => this.open(), this.reconnectTimeoutMs);
+    open() {
+        this.wsApi.connect(this.url, this.onOpen.bind(this));
+        // Register reconnection on close.
+        if (this.wsApi.websocket) {
+            this.wsApi.websocket.onclose = () => {
+                this.onClose();
+            };
         }
     }
     /**
-     * Send GET to a channel.
-     *
-     * @param {string | WebSocketAPIParameters} channelOrParams Name of the websocket channel to send GET or an object representing parameters to send
-     * @return {Promise<WebSocketAPIMessageEventData<?>>} A websocket response.
+     * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
      */
-    get(channelOrParams) {
-        let params = channelOrParams;
-        if (typeof channelOrParams === 'string') {
-            params = { channel: channelOrParams };
-        }
-        return new Promise((resolve, reject) => {
-            this.wsApi.get(params, resolve, reject);
-        });
+    reset() {
+        this.wsApi.send('RESET');
     }
     /**
      * Subscribe to a channel.
@@ -227,7 +242,7 @@ class RealtimeAPI {
      * @param {function} onSuccess Callback when the subscription succeeds.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
-     * @private
+     * @public
      */
     subscribe(channel, onSuccess, onError = () => { }, quiet = false) {
         if (!channel || !onSuccess) {
@@ -236,87 +251,93 @@ class RealtimeAPI {
         this.wsApi.subscribe({ channel }, onSuccess, onError, quiet);
     }
     /**
-     * Unsubscribe both modes of a channel.
+     * Subscribe to deleted_vhicles channel.
      *
-     * @param {string} channel Name of the websocket channel to unsubscribe.
-     * @param {string} suffix Suffix to add to the channel name.
-     * @param {function} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     * @private
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @public
      */
-    unsubscribe(channel, suffix = '', onMessage) {
-        const suffixSchenatic = getModeSuffix(RealtimeModes.SCHEMATIC, RealtimeModes);
-        const suffixTopographic = getModeSuffix(RealtimeModes.TOPOGRAPHIC, RealtimeModes);
-        this.wsApi.unsubscribe(`${channel}${suffixSchenatic}${suffix || ''}`, onMessage);
-        this.wsApi.unsubscribe(`${channel}${suffixTopographic}${suffix || ''}`, onMessage);
+    subscribeDeletedVehicles(mode, onMessage, onError = () => { }, quiet = false) {
+        this.unsubscribeDeletedVehicles(onMessage);
+        let suffix = '';
+        if (this.version === '1') {
+            suffix = getModeSuffix(mode, RealtimeModes);
+        }
+        this.subscribe(`deleted_vehicles${suffix}`, onMessage, onError, quiet);
     }
     /**
      * Subscribe to departures channel of a given station.
      *
      * @param {number} stationId UIC of the station.
-     * @param {Boolean} sortByMinArrivalTime Sort by minimum arrival time
-     * @param {function(departures:Departure[])} onMessage Function called on each message of the channel.
+     * @param {function(departures: RealtimeDeparture[])} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
-     * @public
+     * @deprecated Use subscribeTimetable instead.
      */
     subscribeDepartures(stationId, onMessage, onError = () => { }, quiet = false) {
-        this.subscribe(`timetable_${stationId}`, onMessage, onError, quiet);
-    }
-    /**
-     * Unsubscribe from current departures channel.
-     * @param {RealtimeStationId} id Station's id
-     * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     * @public
-     */
-    unsubscribeDepartures(id, onMessage) {
-        this.unsubscribe(`timetable_${id}`, '', onMessage);
+        this.subscribeTimetable(stationId, onMessage, onError, quiet);
     }
     /**
      * Subscribe to the disruptions channel for tenant.
      *
+     * @param {RealtimeTenant} tenant Tenant's id
      * @param {function(data: { content: RealtimeNews[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
-     * @public
+     * @deprecated Use subscribeNewsticker instead.
      */
     subscribeDisruptions(tenant, onMessage, onError = () => { }, quiet = false) {
-        this.subscribe(`${tenant}_newsticker`, onMessage, onError, quiet);
+        this.subscribeNewsticker(tenant, onMessage, onError, quiet);
     }
     /**
-     * Unsubscribe disruptions.
+     * Subscribe to extra_geoms channel.
      *
-     * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     * @public
+     * @param {function(data: { content: RealtimeExtraGeom })} onMessage Function called on each message of the channel.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      */
-    unsubscribeDisruptions(tenant, onMessage) {
-        this.unsubscribe(`${tenant}_newsticker`, '', onMessage);
+    subscribeExtraGeoms(onMessage, onError = () => { }, quiet = false) {
+        this.subscribe('extra_geoms', onMessage, onError, quiet);
     }
     /**
-     * Return a station with a given uic number and a mode.
+     * Subscribe to full_trajectory channel of a given vehicle.
      *
-     * @param {number} uic UIC of the station.
+     * @param {string} id A vehicle id.
      * @param {RealtimeMode} mode Realtime mode.
-     * @return {Promise<{data: { content: RealtimeStation }}>} A station.
+     * @param {function(data:{content: RealtimeFullTrajectory})} onMessage Function called on each message of the channel.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    getStation(uic, mode) {
-        const params = {
-            channel: `station${getModeSuffix(mode, RealtimeModes)}`,
-            args: uic,
-        };
-        return this.get(params);
+    subscribeFullTrajectory(id, mode, onMessage, onError = () => { }, quiet = false) {
+        let suffix = '';
+        if (this.version === '1') {
+            suffix = getModeSuffix(mode, RealtimeModes);
+        }
+        this.subscribe(`full_trajectory${suffix}_${id}`, onMessage, onError, quiet);
     }
     /**
-     * Get the list of ststions available for a specifc mode. The promise is resolved every 100ms
-     * @param {RealtimeMode} mode Realtime mode.
-     * @param {number} timeout = 100 Duration in ms between each promise resolve calls.
-     * @return {Promise<RealtimeStation[]>} An array of stations.
+     * Subscribe to healthcheck channel.
+     * @param {function(data: { content: string })} onMessage Callback when the subscribe to healthcheck channel succeeds.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     */
+    subscribeHealthCheck(onMessage, onError = () => { }, quiet = false) {
+        this.subscribe('healthcheck', onMessage, onError, quiet);
+    }
+    /**
+     * Subscribe to the newsticker channel for tenant.
+     *
+     * @param {RealtimeTenant} tenant Tenant's id
+     * @param {function(data: { content: RealtimeNews[] })} onMessage Function called on each message of the channel.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    getStations(mode, timeout = 100) {
-        return new Promise((resolve) => {
-            this.get(`station${getModeSuffix(mode, RealtimeModes)}`).then(debounceWebsocketMessages(resolve, undefined, timeout));
-        });
+    subscribeNewsticker(tenant, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`${tenant}_newsticker`, onMessage, onError, quiet);
     }
     /**
      * Subscribe to stations channel.
@@ -332,46 +353,34 @@ class RealtimeAPI {
         this.subscribe(`station${getModeSuffix(mode, RealtimeModes)}`, onMessage, onError, quiet);
     }
     /**
-     * Unsubscribe to stations channel.
-     * @param {function(data: { content: RealtimeStation })} onMessage The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
-     * @public
-     */
-    unsubscribeStations(onMessage) {
-        this.unsubscribe('station', '', onMessage);
-    }
-    /**
-     * Subscribe to extra_geoms channel.
+     * Subscribe to stopsequence channel of a given vehicle.
      *
-     * @param {function(data: { content: RealtimeExtraGeom })} onMessage Function called on each message of the channel.
+     * @param {string} id A vehicle id.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @public
      */
-    subscribeExtraGeoms(onMessage, onError = () => { }, quiet = false) {
-        this.subscribe('extra_geoms', onMessage, onError, quiet);
-    }
-    /**
-     * Unsubscribe to extra_geoms channel.
-     * @param {function(data: { content: RealtimeExtraGeom })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     */
-    unsubscribeExtraGeoms(onMessage) {
-        this.unsubscribe('extra_geoms', '', onMessage);
+    subscribeStopSequence(id, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`stopsequence_${id}`, onMessage, onError, quiet);
     }
     /**
-     * Return a partial trajectory with a given id and a mode.
+     * Subscribe to timetable channel of a given station.
      *
-     * @param {number} trainId The identifier of a trajectory.
-     * @param {RealtimeMode} mode Realtime mode.
-     * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
+     * @param {number} stationId UIC of the station.
+     * @param {function(departures: RealtimeDeparture[])} onMessage Function called on each message of the channel.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    getTrajectory(id, mode) {
-        return this.get(`partial_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`);
+    subscribeTimetable(stationId, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`timetable_${stationId}`, onMessage, onError, quiet);
     }
     /**
      * Subscribe to trajectory channel.
      *
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -385,133 +394,183 @@ class RealtimeAPI {
         this.subscribe(`trajectory${suffix}`, onMessage, onError, quiet);
     }
     /**
-     * Unsubscribe to trajectory channels.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     * @public
-     */
-    unsubscribeTrajectory(onMessage) {
-        this.unsubscribe(`trajectory`, '', onMessage);
-    }
-    /**
-     * Subscribe to deleted_vhicles channel.
+     * Unsubscribe both modes of a channel.
      *
-     * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-     * @param {function} onError Callback when the subscription fails.
-     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @param {string} channel Name of the websocket channel to unsubscribe.
+     * @param {string} suffix Suffix to add to the channel name.
+     * @param {function} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @public
      */
-    subscribeDeletedVehicles(mode, onMessage, onError = () => { }, quiet = false) {
-        this.unsubscribeDeletedVehicles(onMessage);
-        let suffix = '';
-        if (this.version === '1') {
-            suffix = getModeSuffix(mode, RealtimeModes);
-        }
-        this.subscribe(`deleted_vehicles${suffix}`, onMessage, onError, quiet);
+    unsubscribe(channel, suffix = '', onMessage) {
+        const suffixSchenatic = getModeSuffix(RealtimeModes.SCHEMATIC, RealtimeModes);
+        const suffixTopographic = getModeSuffix(RealtimeModes.TOPOGRAPHIC, RealtimeModes);
+        this.wsApi.unsubscribe(`${channel}${suffixSchenatic}${suffix || ''}`, onMessage);
+        this.wsApi.unsubscribe(`${channel}${suffixTopographic}${suffix || ''}`, onMessage);
     }
     /**
      * Unsubscribe to deleted_vhicles channels.
      * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @public
      */
     unsubscribeDeletedVehicles(onMessage) {
         this.unsubscribe('deleted_vehicles', '', onMessage);
     }
     /**
-     * Get a full trajectory of a vehicule .
-     *
-     * @param {string} id A vehicle id.
-     * @param {RealtimeMode} mode Realtime mode.
-     * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
-     * @return {Promise<{ data: { content: RealtimeFullTrajectory } }>} Return a full trajectory.
-     * @public
+     * Unsubscribe from current departures channel.
+     * @param {number} stationId UIC of the station.
+     * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @deprecated Use RealtimeAPI.unsubscribeTimetabe instead.
      */
-    getFullTrajectory(id, mode, generalizationLevel) {
-        let suffix = '';
-        if (this.version === '1') {
-            suffix = getModeSuffix(mode, RealtimeModes);
-        }
-        const channel = [`full_trajectory${suffix}`];
-        if (id) {
-            channel.push(id);
-        }
-        if ((!mode || mode === RealtimeModes.TOPOGRAPHIC) && generalizationLevel) {
-            channel.push(`gen${generalizationLevel}`);
-        }
-        return this.get(channel.join('_'));
+    unsubscribeDepartures(stationId, onMessage) {
+        this.unsubscribeTimetabe(stationId, onMessage);
     }
     /**
-     * Subscribe to full_trajectory channel of a given vehicle.
-     *
-     * @param {string} id A vehicle id.
-     * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Function called on each message of the channel.
-     * @param {function} onError Callback when the subscription fails.
-     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
-     * @public
+     * Unsubscribe disruptions.
+     * @param {RealtimeTenant} tenant Tenant's id
+     * @param {Function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @deprecated Use unsubscribeNewsticker instead.
      */
-    subscribeFullTrajectory(id, mode, onMessage, onError = () => { }, quiet = false) {
-        let suffix = '';
-        if (this.version === '1') {
-            suffix = getModeSuffix(mode, RealtimeModes);
-        }
-        this.subscribe(`full_trajectory${suffix}_${id}`, onMessage, onError, quiet);
+    unsubscribeDisruptions(tenant, onMessage) {
+        this.unsubscribeNewsticker(tenant, onMessage);
+    }
+    /**
+     * Unsubscribe to extra_geoms channel.
+     * @param {function(data: { content: RealtimeExtraGeom })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeExtraGeoms(onMessage) {
+        this.unsubscribe('extra_geoms', '', onMessage);
     }
     /**
      * Unsubscribe from full_trajectory channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {onFullTrajectoryMessageCallback} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeFullTrajectory(id, onMessage) {
         this.unsubscribe('full_trajectory', `_${id}`, onMessage);
     }
     /**
-     * Get the list of stops for this vehicle.
-     *
-     * @param {string} id A vehicle id.
-     * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
+     * Unsubscribe to healthcheck channel.
+     * @param {function(data: { content: string })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeHealthCheck(onMessage) {
+        this.unsubscribe('healthcheck', '', onMessage);
+    }
+    /**
+     * Unsubscribe disruptions.
+     * @param {RealtimeTenant} tenant Tenant's id
+     * @param {Function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    getStopSequence(id) {
-        return this.get(`stopsequence_${id}`);
+    unsubscribeNewsticker(tenant, onMessage) {
+        this.unsubscribe(`${tenant}_newsticker`, '', onMessage);
     }
     /**
-     * Subscribe to stopsequence channel of a given vehicle.
-     *
-     * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Function called on each message of the channel.
-     * @param {function} onError Callback when the subscription fails.
-     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * Unsubscribe to stations channel.
+     * @param {function(data: { content: RealtimeStation })} onMessage The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
      * @public
      */
-    subscribeStopSequence(id, onMessage, onError = () => { }, quiet = false) {
-        this.subscribe(`stopsequence_${id}`, onMessage, onError, quiet);
+    unsubscribeStations(onMessage) {
+        this.unsubscribe('station', '', onMessage);
     }
     /**
      * Unsubscribe from stopsequence channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeStopSequence(id, onMessage) {
         this.unsubscribe(`stopsequence`, `_${id}`, onMessage);
     }
     /**
-     * Subscribe to healthcheck channel.
-     * @param {function(data: { content: string })} onMessage Callback when the subscribe to healthcheck channel succeeds.
-     * @param {function} onError Callback when the subscription fails.
-     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * Unsubscribe from current departures channel.
+     * @param {number} stationId UIC of the station.
+     * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @public
      */
-    subscribeHealthCheck(onMessage, onError = () => { }, quiet = false) {
-        this.subscribe('healthcheck', onMessage, onError, quiet);
+    unsubscribeTimetabe(stationId, onMessage) {
+        this.unsubscribe(`timetable_${stationId}`, '', onMessage);
     }
     /**
-     * Unsubscribe to healthcheck channel.
-     * @param {function(data: { content: string })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * Unsubscribe to trajectory channels.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @public
      */
-    unsubscribeHealthCheck(onMessage) {
-        this.unsubscribe('healthcheck', '', onMessage);
+    unsubscribeTrajectory(onMessage) {
+        this.unsubscribe(`trajectory`, '', onMessage);
+    }
+    /**
+     * This callback type is called `requestCallback` and is displayed as a global symbol.
+     *
+     * @callback onFullTrajectoryMessageCallback
+     * @param {number} responseCode
+     * @param {string} responseMessage
+     */
+    /**
+     * The bounding box to receive data from.\
+     * Example: [minX, minY, maxX, maxY, zoom, mots , gen_level, tenant, ...]\
+     * &nbsp;\
+     * Where:
+     * - **minX**: a string representation of an integer (not a float) representing the minimal X coordinate (in EPSG:3857) of a bounding box\
+     * &nbsp;
+     * - **minY**: a string representation of an integer (not a float) representing the minimal Y coordinate (in EPSG:3857) of a bounding box\
+     * &nbsp;
+     * - **maxX**: a string representation of an integer (not a float) representing the maximal X coordinate (in EPSG:3857) of a bounding box\
+     * &nbsp;
+     * - **maxY**: a string representation of an integer (not a float) representing the maximal Y coordinate (in EPSG:3857) of a bounding box\
+     * &nbsp;
+     * - **zoom**: a string representation of an integer representing the zoom level (from 4 to 22). When zoom < 8 only the trains are displayed for performance reasons.\
+     * &nbsp;
+     * - **mots**: A comma separated list of modes of transport. **Optional**.\
+     *         Example: "mots=rail,subway".\
+     * &nbsp;
+     * - **gen_level**: An integer representing the generalization level. **Optional**.\
+     *              Example: "gen_level=5"\
+     * &nbsp;
+     * - **tenant**: A string representing the tenant. **Optional**.\
+     *           Example: "tenant=sbb"\
+     * &nbsp;
+     * - ...: Any other values added to the bbox will be send to the server
+     *
+     * @type {string[]}
+     *
+     * @public
+     */
+    get bbox() {
+        return this._bbox;
+    }
+    set bbox(newBbox) {
+        if (JSON.stringify(newBbox) !== JSON.stringify(this._bbox)) {
+            this._bbox = newBbox;
+            if (this.wsApi && this._bbox) {
+                this.wsApi.send(`BBOX ${this._bbox.join(' ')}`);
+            }
+        }
+    }
+    get buffer() {
+        return this._buffer;
+    }
+    set buffer(newBuffer) {
+        if (JSON.stringify(newBuffer) !== JSON.stringify(this._buffer)) {
+            this._buffer = newBuffer;
+            if (this.wsApi && this._buffer) {
+                this.wsApi.send(`BUFFER ${this._buffer.join(' ')}`);
+            }
+        }
+    }
+    get url() {
+        return this._url;
+    }
+    set url(newUrl) {
+        if (this._url !== newUrl) {
+            this._url = newUrl;
+            // Update the websocket only if the url has changed and the websocket is already open or is opening.
+            if (this.wsApi.open || this.wsApi.connecting) {
+                this.open();
+            }
+        }
     }
 }
 export default RealtimeAPI;