mobility-toolbox-js 2.0.0-beta.53 → 2.0.0-beta.54

package/api/RealtimeAPI.js

@@ -1,7 +1,6 @@
 import WebSocketAPI from '../common/api/WebSocketAPI';
-import cleanStopTime from '../common/utils/cleanStopTime';
+import debounceWebsocketMessages from '../common/utils/debounceWebsocketMessages';
 import getModeSuffix from '../common/utils/getRealtimeModeSuffix';
-import compareDepartures from '../common/utils/compareDepartures';
 /**
  * Enum for Realtime modes.
  * @readonly
@@ -46,14 +45,6 @@ class RealtimeAPI {
     constructor(options = {}) {
         this.defineProperties(options);
         /** @ignore */
-        this.subscribedStationUic = undefined;
-        /** @ignore */
-        this.departureUpdateTimeout = undefined;
-        /** @ignore */
-        this.maxDepartureAge = 30;
-        /** @ignore */
-        this.extraGeoms = {};
-        /** @ignore */
         this.prefix = options.prefix || '';
         /** @ignore */
         this.onOpen = this.onOpen.bind(this);
@@ -213,7 +204,7 @@ class RealtimeAPI {
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @private
      */
-    subscribe(channel, onSuccess, onError, quiet = false) {
+    subscribe(channel, onSuccess, onError = () => { }, quiet = false) {
         if (!channel || !onSuccess) {
             return;
         }
@@ -224,65 +215,14 @@ class RealtimeAPI {
      *
      * @param {string} channel Name of the websocket channel to unsubscribe.
      * @param {string} suffix Suffix to add to the channel name.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @private
      */
-    unsubscribe(channel, suffix = '', cb) {
-        this.wsApi.unsubscribe(`${channel}${getModeSuffix(RealtimeModes.SCHEMATIC, RealtimeModes)}${suffix}`, cb);
-        this.wsApi.unsubscribe(`${channel}${getModeSuffix(RealtimeModes.TOPOGRAPHIC, RealtimeModes)}${suffix || ''}`, cb);
-    }
-    /**
-     * Filter departures and return an array.
-     *
-     * @param {Object} depObject The object containing departures by id.
-     * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
-     * @return {Array<Departure>} Return departures array.
-     * @private
-     */
-    filterDepartures(depObject, sortByMinArrivalTime = false) {
-        const departures = Object.keys(depObject).map((k) => depObject[k]);
-        departures.sort((a, b) => compareDepartures(a, b, sortByMinArrivalTime));
-        const futureDate = new Date();
-        futureDate.setMinutes(futureDate.getMinutes() + this.maxDepartureAge);
-        const future = futureDate.getTime();
-        const pastDate = new Date();
-        pastDate.setMinutes(pastDate.getMinutes() - this.maxDepartureAge);
-        const past = pastDate.getTime();
-        const departureArray = [];
-        const platformsBoarding = [];
-        let previousDeparture = null;
-        for (let i = departures.length - 1; i >= 0; i -= 1) {
-            const departure = Object.assign({}, departures[i]);
-            const time = new Date(departure.time).getTime();
-            // Only show departures within the next 30 minutes
-            if (time > past && time < future) {
-                // If 2 trains are boarding at the same platform,
-                // remove the older one.
-                if (departure.state === 'BOARDING') {
-                    if (platformsBoarding.indexOf(departure.platform) === -1) {
-                        platformsBoarding.push(departure.platform);
-                    }
-                    else {
-                        departure.state = 'HIDDEN';
-                    }
-                }
-                // If two trains with the same line number and destinatin
-                // and a departure difference < 1 minute, hide the second one.
-                if (previousDeparture &&
-                    departure.to[0] === previousDeparture.to[0] &&
-                    Math.abs(time - previousDeparture.time) < 1000 &&
-                    departure.line.name === previousDeparture.line.name) {
-                    departure.state = 'HIDDEN';
-                }
-                if (/(STOP_CANCELLED|JOURNEY_CANCELLED)/.test(departure.state)) {
-                    departure.cancelled = true;
-                }
-                previousDeparture = departure;
-                previousDeparture.time = time;
-                departureArray.unshift(departure);
-            }
-        }
-        return departureArray;
+    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);
     }
     /**
      * Subscribe to departures channel of a given station.
@@ -290,67 +230,44 @@ class RealtimeAPI {
      * @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} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      */
-    subscribeDepartures(stationId, sortByMinArrivalTime, onMessage) {
-        window.clearTimeout(this.departureUpdateTimeout);
-        this.unsubscribeDepartures();
-        this.subscribedStationUic = stationId;
-        const channel = stationId ? `timetable_${stationId}` : null;
-        const departureObject = {};
-        if (!channel) {
-            return;
-        }
-        const onSuccess = (data) => {
-            if (data.source === channel) {
-                const content = data.content || {};
-                // TODO: These lines seems useless because content.timestamp never exists
-                // we should check if actually the case
-                const tDiff = new Date(content.timestamp).getTime() - Date.now();
-                departureObject[content.call_id] = Object.assign(Object.assign({}, content), { timediff: tDiff });
-                window.clearTimeout(this.departureUpdateTimeout);
-                this.departureUpdateTimeout = window.setTimeout(() => {
-                    const departures = this.filterDepartures(departureObject, sortByMinArrivalTime || false);
-                    onMessage(departures);
-                }, 100);
-            }
-        };
-        this.subscribe(channel, onSuccess, () => {
-            onMessage([]);
-        });
+    subscribeDepartures(stationId, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`timetable_${stationId}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe from current departures channel.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @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.
      */
-    unsubscribeDepartures(cb) {
-        if (this.subscribedStationUic) {
-            this.unsubscribe(`timetable_${this.subscribedStationUic}`, '', cb);
-            this.subscribedStationUic = undefined;
-        }
+    unsubscribeDepartures(id, onMessage) {
+        this.unsubscribe(`timetable_${id}`, '', onMessage);
     }
     /**
      * Subscribe to the disruptions channel for tenant.
      *
-     * @param {function(news: RealtimeNews)} onMessage Function called on each message of the channel.
+     * @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.
      */
-    subscribeDisruptions(onMessage) {
-        this.subscribe(`${this.prefix}newsticker`, (data) => {
-            onMessage(data.content);
-        });
+    subscribeDisruptions(onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`${this.prefix}newsticker`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe disruptions.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     *
+     * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeDisruptions(cb) {
-        this.unsubscribe(`${this.prefix}newsticker`, '', cb);
+    unsubscribeDisruptions(onMessage) {
+        this.unsubscribe(`${this.prefix}newsticker`, '', onMessage);
     }
     /**
      * 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<Station>} A station.
+     * @return {Promise<{data: { content: RealtimeStation }}>} A station.
      */
     getStation(uic, mode) {
         const params = {
@@ -358,42 +275,20 @@ class RealtimeAPI {
             args: uic,
         };
         return new Promise((resolve, reject) => {
-            this.wsApi.get(params, (data) => {
-                if (data.content) {
-                    resolve(data.content);
-                }
-                else {
-                    reject();
-                }
-            });
+            this.wsApi.get(params, resolve, reject);
         });
     }
     /**
-     * Update the model's station list for a given mode and a bbox.
-     *
+     * Get the list of ststions available for a specifc mode. The promise is resolved every 100ms
      * @param {RealtimeMode} mode Realtime mode.
-     * @return {Promise<Array<Station>>} An array of stations.
+     * @param {number} timeout = 100 Duration in ms between each promise resolve calls.
+     * @return {Promise<RealtimeStation[]>} An array of stations.
      */
-    getStations(mode) {
-        const stations = [];
-        const params = {
-            channel: `station${getModeSuffix(mode, RealtimeModes)}`,
-        };
-        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);
-                    /** @ignore */
-                    this.stationUpdateTimeout = window.setTimeout(() => {
-                        resolve(stations);
-                    }, 50);
-                }
-                else {
-                    reject(data.content);
-                }
-            });
+    getStations(mode, timeout = 100) {
+        return new Promise((resolve) => {
+            this.wsApi.get({
+                channel: `station${getModeSuffix(mode, RealtimeModes)}`,
+            }, debounceWebsocketMessages(resolve, undefined, timeout));
         });
     }
     /**
@@ -401,86 +296,74 @@ class RealtimeAPI {
      * One message pro station.
      *
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(station: Station)} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeStation })} 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.
      */
-    subscribeStations(mode, onMessage) {
-        this.unsubscribeStations();
-        this.subscribe(`station${getModeSuffix(mode, RealtimeModes)}`, (data) => {
-            if (data.content) {
-                onMessage(data.content);
-            }
-        });
+    subscribeStations(mode, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`station${getModeSuffix(mode, RealtimeModes)}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe to stations channel.
-     * @param {function} cb The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
+     * @param {function(data: { content: RealtimeStation })} onMessage The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
      */
-    unsubscribeStations(cb) {
-        window.clearTimeout(this.stationUpdateTimeout);
-        this.unsubscribe('station', '', cb);
+    unsubscribeStations(onMessage) {
+        this.unsubscribe('station', '', onMessage);
     }
     /**
      * Subscribe to extra_geoms channel.
      *
-     * @param {function(extraGeoms: GeosJSONFeature[])} onMessage Function called on each message of the channel.
+     * @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.
      */
-    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]));
-            }
-        });
+    subscribeExtraGeoms(onMessage, onError = () => { }, quiet = false) {
+        this.subscribe('extra_geoms', onMessage, onError, quiet);
     }
     /**
      * Unsubscribe to extra_geoms channel.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeExtraGeom })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeExtraGeoms(cb) {
-        this.unsubscribe('extra_geoms', '', cb);
+    unsubscribeExtraGeoms(onMessage) {
+        this.unsubscribe('extra_geoms', '', onMessage);
     }
     /**
      * Subscribe to trajectory channel.
      *
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(trajectory: RealtimeTrajectory)} 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.
+     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} 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.
      */
-    subscribeTrajectory(mode, onMessage, quiet = false) {
+    subscribeTrajectory(mode, onMessage, onError = () => { }, quiet = false) {
         this.unsubscribeTrajectory(onMessage);
-        this.subscribe(`trajectory${getModeSuffix(mode, RealtimeModes)}`, onMessage, undefined, quiet);
+        this.subscribe(`trajectory${getModeSuffix(mode, RealtimeModes)}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe to trajectory channels.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeTrajectory(cb) {
-        this.unsubscribe(`trajectory`, '', cb);
+    unsubscribeTrajectory(onMessage) {
+        this.unsubscribe(`trajectory`, '', onMessage);
     }
     /**
      * Subscribe to deleted_vhicles channel.
      *
      * @param {RealtimeMode} mode Realtime 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.
+     * @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.
      */
-    subscribeDeletedVehicles(mode, onMessage, quiet = false) {
+    subscribeDeletedVehicles(mode, onMessage, onError = () => { }, quiet = false) {
         this.unsubscribeDeletedVehicles(onMessage);
-        this.subscribe(`deleted_vehicles${getModeSuffix(mode, RealtimeModes)}`, onMessage, undefined, quiet);
+        this.subscribe(`deleted_vehicles${getModeSuffix(mode, RealtimeModes)}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe to deleted_vhicles channels.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeDeletedVehicles(cb) {
-        this.unsubscribe('deleted_vehicles', '', cb);
+    unsubscribeDeletedVehicles(onMessage) {
+        this.unsubscribe('deleted_vehicles', '', onMessage);
     }
     /**
      * Get a full trajectory of a vehicule .
@@ -488,7 +371,7 @@ class RealtimeAPI {
      * @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<FullTrajectory>} Return a full trajectory.
+     * @return {Promise<{ data: { content: FullTrajectory } }>} Return a full trajectory.
      */
     getFullTrajectory(id, mode, generalizationLevel) {
         const channel = [`full_trajectory${getModeSuffix(mode, RealtimeModes)}`];
@@ -501,129 +384,79 @@ class RealtimeAPI {
         const params = {
             channel: channel.join('_'),
         };
-        return new Promise((resolve) => {
-            this.wsApi.get(params, (data) => {
-                if (data.content) {
-                    resolve(data.content);
-                }
-            });
+        return new Promise((resolve, reject) => {
+            this.wsApi.get(params, resolve, reject);
         });
     }
-    /**
-     * Get full trajectories of a vehicules .
-     *
-     * @param {string[]} ids List of vehicles ids.
-     * @param {RealtimeMode} mode Realtime mode.
-     * @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, generalizationLevel) {
-        const promises = ids.map((id) => this.getFullTrajectory(id, mode, generalizationLevel));
-        return Promise.all(promises);
-    }
     /**
      * 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.
      */
-    subscribeFullTrajectory(id, mode) {
-        // window.clearTimeout(this.fullTrajectoryUpdateTimeout);
-        this.unsubscribeFullTrajectory(id);
-        this.subscribe(`full_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`, (data) => {
-            // eslint-disable-next-line no-console
-            console.log('subscribe full_trajectory', data);
-        }, (err) => {
-            // eslint-disable-next-line no-console
-            console.log('subscribe full_trajectory error', err);
-        });
+    subscribeFullTrajectory(id, mode, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`full_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe from full_trajectory channel
      *
      * @param {string} id A vehicle id.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeFullTrajectory(id, cb) {
-        this.unsubscribe('full_trajectory', `_${id}`, cb);
+    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<StopSequence>} Returns a stop sequence object.
+     * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
      */
     getStopSequence(id) {
-        const params = {
-            channel: `stopsequence_${id}`,
-        };
         return new Promise((resolve, reject) => {
-            this.wsApi.get(params, (data) => {
-                const content = data.content;
-                if (content && content.length) {
-                    const stopSequences = content.map((stopSequence) => cleanStopTime(stopSequence));
-                    // Remove the delay from arrivalTime and departureTime
-                    resolve(stopSequences);
-                }
-                resolve([]);
-            }, (err) => {
-                reject(err);
-            });
+            this.wsApi.get({
+                channel: `stopsequence_${id}`,
+            }, resolve, reject);
         });
     }
-    /**
-     * Get a list of stops for a list of vehicles.
-     *
-     * @param {string[]} ids List of vehicles ids.
-     * @return {Promise<Array<StopSequence>>} Return an array of stop sequences.
-     */
-    getStopSequences(ids) {
-        const promises = ids.map((id) => this.getStopSequence(id));
-        return Promise.all(promises);
-    }
     /**
      * Subscribe to stopsequence channel of a given vehicle.
      *
      * @param {string} id A vehicle id.
-     * @param {function(stopSequence: StopSequence)} onMessage Function called on each message of the channel.
+     * @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.
      */
-    subscribeStopSequence(id, onMessage) {
-        window.clearTimeout(this.fullTrajectoryUpdateTimeout);
-        this.unsubscribeStopSequence(id);
-        this.subscribe(`stopsequence_${id}`, (data) => {
-            const content = data.content;
-            if (content && content.length) {
-                const stopSequences = content.map((stopSequence) => cleanStopTime(stopSequence));
-                // Remove the delay from arrivalTime and departureTime
-                onMessage(stopSequences);
-            }
-        }, (err) => {
-            // eslint-disable-next-line no-console
-            console.log('subscribe stopsequence error', err);
-        });
+    subscribeStopSequence(id, onMessage, onError = () => { }, quiet = false) {
+        this.subscribe(`stopsequence_${id}`, onMessage, onError, quiet);
     }
     /**
      * Unsubscribe from stopsequence channel
      *
      * @param {string} id A vehicle id.
-     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: StopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      */
-    unsubscribeStopSequence(id, cb) {
-        this.unsubscribe(`stopsequence`, `_${id}`, cb);
+    unsubscribeStopSequence(id, onMessage) {
+        this.unsubscribe(`stopsequence`, `_${id}`, onMessage);
     }
     /**
      * Subscribe to healthcheck channel.
-     * @param {function} onMessage Callback when the subscribe to healthcheck channel succeeds.
+     * @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) {
-        this.unsubscribeHealthCheck();
-        this.subscribe('healthcheck', onMessage);
+    subscribeHealthCheck(onMessage, onError = () => { }, quiet = false) {
+        this.subscribe('healthcheck', onMessage, onError, quiet);
     }
     /**
      * 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() {
-        this.unsubscribe('healthcheck');
+    unsubscribeHealthCheck(onMessage) {
+        this.unsubscribe('healthcheck', '', onMessage);
     }
 }
 export default RealtimeAPI;

package/common/api/WebSocketAPI.d.ts

@@ -1,19 +1,17 @@
-import { Feature } from 'geojson';
-import { RealtimeDeparture, RealtimeNews, RealtimeStation, RealtimeExtraGeom, RealtimeTrajectory, RealtimeTrajectoryResponse, RealtimeStopSequence, RealtimeFullTrajectory } from '../../types';
+import { RealtimeTrajectoryResponse } from '../../types';
 export declare type WebSocketAPIParameters = {
     channel?: string;
     args?: string | number;
     id?: string | number;
 };
-export declare type WebSocketAPIMessageEventData = {
+export declare type WebSocketAPIMessageEventData<T> = {
     timestamp: number;
     source: string;
-    content: string | Feature | RealtimeTrajectoryResponse[] | RealtimeDeparture | RealtimeNews[] | RealtimeStation | RealtimeExtraGeom | RealtimeTrajectory | RealtimeStopSequence[] | RealtimeFullTrajectory;
+    content: T;
     client_reference: string | number | null;
 };
-export declare type WebSocketAPIBufferMessageEventData = Omit<WebSocketAPIMessageEventData, 'content'> & {
+export declare type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]> & {
     source: 'buffer';
-    content: Array<WebSocketAPIMessageEventData>;
 };
 export declare type WebSocketAPIMessageEvent = Event & {
     data: string;
@@ -24,12 +22,12 @@ export interface WebSocketAPIMessageEventListener {
 /**
  * This type represents a function that has been call with each feature returned by the websocket.
  */
-export interface WebSocketAPIDataCallback {
-    (data: WebSocketAPIMessageEventData): void;
+export interface WebSocketAPIMessageCallback<T> {
+    (data: WebSocketAPIMessageEventData<T>): void;
 }
 export declare type WebSocketAPISubscription = {
     params: WebSocketAPIParameters;
-    cb: WebSocketAPIDataCallback;
+    cb: WebSocketAPIMessageCallback<any>;
     errorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
     onErrorCb?: EventListener;
@@ -40,7 +38,7 @@ export declare type WebSocketAPISubscribed = {
 };
 export declare type WebSocketAPIRequest = {
     params: WebSocketAPIParameters;
-    cb: WebSocketAPIDataCallback;
+    cb: WebSocketAPIMessageCallback<any>;
     errorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
     onErrorCb?: EventListener;
@@ -107,7 +105,7 @@ declare class WebSocketAPI {
      * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
      * @private
      */
-    listen(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, errorCb?: EventListener): {
+    listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
         onMessageCb: WebSocketAPIMessageEventListener;
         onErrorCb?: EventListener;
     };
@@ -118,7 +116,7 @@ declare class WebSocketAPI {
      * @param {function} cb Callback used when listen.
      * @private
      */
-    unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback): void;
+    unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>): void;
     /**
      * Sends a get request to the websocket.
      * The callback is called only once, when the response is received or when the call returns an error.
@@ -128,7 +126,7 @@ declare class WebSocketAPI {
      * @param {function} onError Callback on error and close event
      * @private
      */
-    get(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, errorCb?: EventListener): void;
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
     /**
      * Subscribe to a given channel.
      *
@@ -138,14 +136,14 @@ declare class WebSocketAPI {
      * @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
      * @private
      */
-    subscribe(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, errorCb?: EventListener, quiet?: boolean): void;
+    subscribe(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener, quiet?: boolean): void;
     /**
      * Unsubscribe from a channel.
      * @param {string} source source to unsubscribe from
      * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @private
      */
-    unsubscribe(source: string, cb?: WebSocketAPIDataCallback): void;
+    unsubscribe(source: string, cb?: WebSocketAPIMessageCallback<any>): void;
     /**
      * After an auto reconnection we need to re-subscribe to the channels.
      */

package/common/api/WebSocketAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebSocketAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/WebSocketAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,4BAA4B,GAAG;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EACH,MAAM,GACN,OAAO,GACP,0BAA0B,EAAE,GAC5B,iBAAiB,GACjB,YAAY,EAAE,GACd,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,EAAE,GACtB,sBAAsB,CAAC;IAC3B,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,oBAAY,kCAAkC,GAAG,IAAI,CACnD,4BAA4B,EAC5B,SAAS,CACV,GAAG;IACF,MAAM,EAAE,QAAQ,CAAC;IACjB,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;CAC9C,CAAC;AAEF,oBAAY,wBAAwB,GAAG,KAAK,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,4BAA4B,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG;IAC7C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,wBAAwB,CAAC;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,mBAAmB,GAAG;IACxC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,wBAAwB,CAAC;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AACF;;;;GAIG;AACH,cAAM,YAAY;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,cAAc,EAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,aAAa,EAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEhD,UAAU,EAAG,sBAAsB,CAAC;IAEpC,QAAQ,EAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;;IAMtC,gBAAgB;IA4DhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,sBAA2B;IAO3E;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,aAAW;IAmBtC;;;;OAIG;IACH,KAAK;IASL;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM;IAwBpB,SAAS,CACP,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB,YAAY,CACV,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;OAQG;IACH,MAAM,CACJ,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa,GACtB;QACD,WAAW,EAAE,gCAAgC,CAAC;QAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;KAC3B;IA4CD;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,EAAE,EAAE,EAAE,wBAAwB;IAUrE;;;;;;;;OAQG;IACH,GAAG,CACD,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa;IAiDzB;;;;;;;;OAQG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa,EACvB,KAAK,UAAQ;IAwBf;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,wBAAwB;IA0BzD;;OAEG;IACH,8BAA8B;CAa/B;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"WebSocketAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/WebSocketAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,4BAA4B,CAAC,CAAC,IAAI;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IAYX,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,oBAAY,kCAAkC,GAAG,4BAA4B,CAC3E,0BAA0B,EAAE,CAC7B,GAAG;IACF,MAAM,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,oBAAY,wBAAwB,GAAG,KAAK,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,CAAC;IAC5C,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG;IAC7C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,mBAAmB,GAAG;IACxC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AACF;;;;GAIG;AACH,cAAM,YAAY;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,cAAc,EAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,aAAa,EAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEhD,UAAU,EAAG,sBAAsB,CAAC;IAEpC,QAAQ,EAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;;IAMtC,gBAAgB;IA4DhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,sBAA2B;IAO3E;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,aAAW;IAmBtC;;;;OAIG;IACH,KAAK;IASL;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM;IAwBpB,SAAS,CACP,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB,YAAY,CACV,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;OAQG;IACH,MAAM,CACJ,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,GACtB;QACD,WAAW,EAAE,gCAAgC,CAAC;QAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;KAC3B;IA4CD;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC;IAWtC;;;;;;;;OAQG;IACH,GAAG,CACD,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa;IAiDzB;;;;;;;;OAQG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,EACvB,KAAK,UAAQ;IAwBf;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,2BAA2B,CAAC,GAAG,CAAC;IA0BjE;;OAEG;IACH,8BAA8B;CAa/B;AAED,eAAe,YAAY,CAAC"}