mobility-toolbox-js 2.0.0-beta.30 → 2.0.0-beta.34

package/api/RealtimeAPI.d.ts

@@ -0,0 +1,268 @@
+/**
+ * Enum for Realtime modes.
+ */
+export type RealtimeModes = RealtimeMode;
+export namespace RealtimeModes {
+    const RAW: string;
+    const TOPOGRAPHIC: string;
+    const SCHEMATIC: string;
+}
+export default RealtimeAPI;
+/**
+ * Enum for Realtime modes.
+ */
+export type RealtimeMode = string;
+/**
+ * This class provides convenience methods to access to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
+ *
+ * @example
+ * import { RealtimeAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new RealtimeAPI({
+ *   url: "yourUrl",
+ *   apiKey: "yourApiKey"
+ * });
+ *
+ * @example
+ * import { RealtimeAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new RealtimeAPI("yourUrl");
+ */
+declare class RealtimeAPI {
+    /**
+     * 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 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. Default to EPSG:3857.
+     * @param {number[4]} [options.bbox=[minX, minY, maxX, maxY, zoom, tenant] The bounding box to receive data from.
+     */
+    constructor(options?: any | string);
+    /** @ignore */
+    subscribedStationUic: number;
+    /** @ignore */
+    departureUpdateTimeout: number;
+    /** @ignore */
+    maxDepartureAge: number;
+    /** @ignore */
+    extraGeoms: {};
+    /** @ignore */
+    prefix: any;
+    /**
+     * Callback when the websocket is opened and ready.
+     * It applies the bbox and the projection.
+     */
+    onOpen(): void;
+    defineProperties(options: any): void;
+    open(): void;
+    /**
+     * Close the websocket connection without reconnection.
+     */
+    close(): void;
+    /**
+     * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
+     */
+    reset(): void;
+    /** @ignore */
+    pingInterval: NodeJS.Timer;
+    /**
+     * Callback when the websocket is closed by the server.
+     * It auto reconnects after a timeout.
+     */
+    onClose(): void;
+    /** @ignore */
+    reconnectTimeout: number;
+    /**
+     * Subscribe to a channel.
+     *
+     * @param {string} channel Name of the websocket channel to subscribe.
+     * @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
+     */
+    private subscribe;
+    /**
+     * Unsubscribe both modes of a channel.
+     *
+     * @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.
+     * @private
+     */
+    private unsubscribe;
+    /**
+     * 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
+     */
+    private filterDepartures;
+    /**
+     * 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.
+     */
+    subscribeDepartures(stationId: number, sortByMinArrivalTime: boolean, onMessage: (arg0: departures, arg1: Departure[]) => any): void;
+    /**
+     * Unsubscribe from current departures channel.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDepartures(cb: Function): void;
+    /**
+     * Subscribe to the disruptions channel for tenant.
+     *
+     * @param {function} onMessage Function called on each message of the channel.
+     */
+    subscribeDisruptions(onMessage: Function): void;
+    /**
+     * Unsubscribe disruptions.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDisruptions(cb: Function): void;
+    /**
+     * 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.
+     */
+    getStation(uic: number, mode: RealtimeMode): Promise<Station>;
+    /**
+     * Update the model's station list for a given mode and a bbox.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<Array<Station>>} An array of stations.
+     */
+    getStations(mode: RealtimeMode): Promise<Array<Station>>;
+    /** @ignore */
+    stationUpdateTimeout: number;
+    /**
+     * Subscribe to stations channel.
+     * One message pro station.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {function(station: Station)} onMessage Function called on each message of the channel.
+     */
+    subscribeStations(mode: RealtimeMode, onMessage: (arg0: station, arg1: Station) => any): void;
+    /**
+     * Unsubscribe to stations channel.
+     * @param {function} cb The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
+     */
+    unsubscribeStations(cb: Function): void;
+    /**
+     * Subscribe to extra_geoms channel.
+     *
+     * @param {function(extraGeoms: GeosJSONFeature[])} onMessage Function called on each message of the channel.
+     */
+    subscribeExtraGeoms(onMessage: (arg0: extraGeoms, arg1: GeosJSONFeature[]) => any): void;
+    /**
+     * Unsubscribe to extra_geoms channel.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeExtraGeoms(cb: Function): void;
+    /**
+     * 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.
+     */
+    subscribeTrajectory(mode: RealtimeMode, onMessage: (arg0: trajectory, arg1: RealtimeTrajectory) => any, quiet?: boolean): void;
+    /**
+     * Unsubscribe to trajectory channels.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeTrajectory(cb: Function): void;
+    /**
+     * 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.
+     */
+    subscribeDeletedVehicles(mode: RealtimeMode, onMessage: (arg0: response, arg1: {
+        content: Vehicle;
+    }) => any, quiet?: boolean): void;
+    /**
+     * Unsubscribe to deleted_vhicles channels.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDeletedVehicles(cb: Function): void;
+    /**
+     * 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<FullTrajectory>} Return a full trajectory.
+     */
+    getFullTrajectory(id: string, mode: RealtimeMode, generalizationLevel: string): Promise<FullTrajectory>;
+    /**
+     * 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: string[], mode: RealtimeMode, generalizationLevel: string): Promise<Array<FullTrajectory>>;
+    /**
+     * Subscribe to full_trajectory channel of a given vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @param {RealtimeMode} mode Realtime mode.
+     */
+    subscribeFullTrajectory(id: string, mode: RealtimeMode): void;
+    /**
+     * 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.
+     */
+    unsubscribeFullTrajectory(id: string, cb: Function): void;
+    /**
+     * Get the list of stops for this vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @return {Promise<StopSequence>} Returns a stop sequence object.
+     */
+    getStopSequence(id: string): Promise<StopSequence>;
+    /**
+     * 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: string[]): Promise<Array<StopSequence>>;
+    /**
+     * 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.
+     */
+    subscribeStopSequence(id: string, onMessage: (arg0: stopSequence, arg1: StopSequence) => any): void;
+    /**
+     * 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.
+     */
+    unsubscribeStopSequence(id: string, cb: Function): void;
+    /**
+     * Subscribe to healthcheck channel.
+     * @param {function} onMessage Callback when the subscribe to healthcheck channel succeeds.
+     */
+    subscribeHealthCheck(onMessage: Function): void;
+    /**
+     * Unsubscribe to healthcheck channel.
+     */
+    unsubscribeHealthCheck(): void;
+}
+//# sourceMappingURL=RealtimeAPI.d.ts.map

package/api/RealtimeAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RealtimeAPI.d.ts","sourceRoot":"","sources":["../../src/api/RealtimeAPI.js"],"names":[],"mappings":";;;4BAYU,YAAY;;;;;;;;;;2BAJT,MAAM;AAYnB;;;;;;;;;;;;;;;GAeG;AACH;IACE;;;;;;;;;OASG;IACH,sBAPW,MAAO,MAAM,EA2BvB;IAjBC,cAAc;IACd,6BAAgC;IAEhC,cAAc;IACd,+BAAkC;IAElC,cAAc;IACd,wBAAyB;IAEzB,cAAc;IACd,eAAoB;IAEpB,cAAc;IACd,YAAkC;IAsHpC;;;OAGG;IACH,eAuBC;IA3ID,qCAoFC;IAED,aASC;IAED;;OAEG;IACH,cAEC;IAED;;OAEG;IAEH,cAEC;IAwBG,cAAc;IACd,2BAEuB;IAI3B;;;OAGG;IACH,gBAWC;IANG,cAAc;IACd,yBAGC;IAIL;;;;;;;;OAQG;IACH,kBAEC;IAED;;;;;;;OAOG;IACH,oBAcC;IAED;;;;;;;OAOG;IACH,yBAsDC;IAED;;;;;;OAMG;IACH,+BAJW,MAAM,qEAEc,SAAS,EAAE,gBA+BzC;IAED;;;OAGG;IACH,0CAKC;IAED;;;;OAIG;IACH,gDAIC;IAED;;;OAGG;IACH,2CAEC;IAED;;;;;;OAMG;IACH,gBAJW,MAAM,QACN,YAAY,GACX,QAAQ,OAAO,CAAC,CAiB3B;IAED;;;;;OAKG;IACH,kBAHW,YAAY,GACX,QAAQ,MAAM,OAAO,CAAC,CAAC,CAsBlC;IATO,cAAc;IACd,6BAEM;IAQd;;;;;;OAMG;IACH,wBAHW,YAAY,mCACM,OAAO,gBASnC;IAED;;;OAGG;IACH,wCAGC;IAED;;;;OAIG;IACH,wDAFgC,iBAAiB,gBAoBhD;IAED;;;OAGG;IACH,0CAEC;IAED;;;;;;OAMG;IACH,0BAJW,YAAY,sCACS,kBAAkB,kBACvC,OAAO,QAUjB;IAED;;;OAGG;IACH,0CAEC;IAED;;;;;;OAMG;IACH,+BAJW,YAAY,oCACO;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,kBACvC,OAAO,QAUjB;IAED;;;OAGG;IACH,+CAEC;IAED;;;;;;;OAOG;IACH,sBALW,MAAM,QACN,YAAY,uBACZ,MAAM,GACL,QAAQ,cAAc,CAAC,CAuBlC;IAED;;;;;;;OAOG;IACH,yBALW,MAAM,EAAE,QACR,YAAY,uBACZ,MAAM,GACL,QAAQ,MAAM,cAAc,CAAC,CAAC,CAOzC;IAED;;;;;OAKG;IACH,4BAHW,MAAM,QACN,YAAY,QAgBtB;IAED;;;;;OAKG;IACH,8BAHW,MAAM,sBAKhB;IAED;;;;;OAKG;IACH,oBAHW,MAAM,GACL,QAAQ,YAAY,CAAC,CAyBhC;IAED;;;;;OAKG;IACH,sBAHW,MAAM,EAAE,GACP,QAAQ,MAAM,YAAY,CAAC,CAAC,CAKvC;IAED;;;;;OAKG;IACH,0BAHW,MAAM,wCACiB,YAAY,gBAuB7C;IAED;;;;;OAKG;IACH,4BAHW,MAAM,sBAKhB;IAED;;;OAGG;IACH,gDAGC;IAED;;OAEG;IACH,+BAEC;CACF"}