mobility-toolbox-js 3.0.0-beta.8 → 3.0.0-beta.9

package/api/HttpAPI.d.ts

@@ -0,0 +1,31 @@
+export type HttpAPIOptions = {
+    url: string;
+    apiKey?: string;
+};
+/**
+ * Common class to access to a geOps api using http.
+ *
+ * @example
+ * import { API } from 'mobility-toolbox-js/api';
+ *
+ * const api = new HttpApi({
+ *   url: [yourUrl],
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * @classproperty {string} url Url of the service.
+ * @classproperty {string} apiKey Api key to access the service.
+ * @private
+ */
+declare class HttpAPI {
+    url: string;
+    apiKey?: string;
+    constructor(options: HttpAPIOptions);
+    /**
+     * Append the apiKey before sending the request.
+     *
+     * @private
+     */
+    fetch(path: string, params: Object, config: RequestInit): Promise<any>;
+}
+export default HttpAPI;

package/api/RealtimeAPI.d.ts

@@ -0,0 +1,359 @@
+import WebSocketAPI, { WebSocketAPIMessageCallback, WebSocketAPIMessageEventData, WebSocketAPIParameters } from './WebSocketAPI';
+import type { RealtimeMode, RealtimeDeparture, RealtimeNews, RealtimeStation, RealtimeExtraGeom, RealtimeTrainId, RealtimeGeneralizationLevel, RealtimeFullTrajectory, RealtimeTrajectoryResponse, RealtimeStationId, RealtimeVersion, RealtimeTrajectory, RealtimeTenant, RealtimeBbox } from '../types';
+import { StopSequence } from './typedefs';
+/**
+ * @typedef RealtimeAPIOptions
+ */
+export type RealtimeAPIOptions = {
+    url?: string;
+    apiKey?: string;
+    version?: RealtimeVersion;
+    bbox?: RealtimeBbox;
+    buffer?: number[];
+    pingIntervalMs?: number;
+    reconnectTimeoutMs?: number;
+};
+export declare type RealtimeAPIExtraGeomsById = {
+    [index: string]: RealtimeExtraGeom;
+};
+export type RealtimeAPIDeparturesById = {
+    [index: string]: RealtimeDeparture;
+};
+export type RealtimeModesType = {
+    RAW: RealtimeMode;
+    TOPOGRAPHIC: RealtimeMode;
+    SCHEMATIC: RealtimeMode;
+};
+/**
+ * Enum for Realtime modes.
+ * @readonly
+ * @typedef {string} RealtimeMode
+ * @property {string} RAW "raw"
+ * @property {string} SCHEMATIC "schematic"
+ * @property {string} TOPOGRAPHIC "topographic"
+ * @enum {RealtimeMode}
+ */
+export declare const RealtimeModes: {
+    RAW: RealtimeMode;
+    TOPOGRAPHIC: RealtimeMode;
+    SCHEMATIC: RealtimeMode;
+};
+/**
+ * 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';
+ *
+ * const api = new RealtimeAPI({
+ *   apiKey: "yourApiKey",
+ *   bbox: [782001, 5888803, 923410, 5923660, 11, "mots=rail"],
+ *   // url: "wss://api.geops.io/tracker-ws/v1/",
+ * });
+ *
+ * api.open();
+ *
+ * api.subscribeTrajectory('topographic', (data) => {
+ *    console.log('Log trajectories:', JSON.stringify(data.content));
+ * });
+ *
+ * @public
+ */
+declare class RealtimeAPI {
+    _url: string;
+    get url(): string;
+    set url(newUrl: string);
+    _bbox?: RealtimeBbox;
+    /**
+     * 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(): RealtimeBbox | undefined;
+    set bbox(newBbox: RealtimeBbox | undefined);
+    _buffer?: number[];
+    get buffer(): number[] | undefined;
+    set buffer(newBuffer: number[] | undefined);
+    version: RealtimeVersion;
+    wsApi: WebSocketAPI;
+    private pingInterval;
+    private pingIntervalMs;
+    private reconnectTimeout?;
+    private reconnectTimeoutMs?;
+    /**
+     * 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 {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {string[]} options.bbox The bounding box to receive data from.
+     * @public
+     */
+    constructor(options?: RealtimeAPIOptions);
+    /**
+     * Open the websocket connection.
+     *
+     * @public
+     */
+    open(): void;
+    /**
+     * Close the websocket connection without reconnection.
+     *
+     * @public
+     */
+    close(): void;
+    /**
+     * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
+     */
+    reset(): void;
+    /**
+     * Callback when the websocket is opened and ready.
+     * It applies the bbox and the projection.
+     * @private
+     */
+    onOpen(): void;
+    /**
+     * Callback when the websocket is closed by the server.
+     * It auto reconnects after a timeout.
+     * @private
+     */
+    onClose(): void;
+    /**
+     * 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.
+     */
+    get(channelOrParams: string | WebSocketAPIParameters): Promise<WebSocketAPIMessageEventData<any>>;
+    /**
+     * 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
+     */
+    subscribe(channel: string, onSuccess: WebSocketAPIMessageCallback<any>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @private
+     */
+    unsubscribe(channel: string, suffix?: string, onMessage?: WebSocketAPIMessageCallback<any>): void;
+    /**
+     * 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} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @public
+     */
+    subscribeDepartures(stationId: number, onMessage: WebSocketAPIMessageCallback<RealtimeDeparture>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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: RealtimeStationId, onMessage?: WebSocketAPIMessageCallback<RealtimeDeparture>): void;
+    /**
+     * Subscribe to the disruptions channel for tenant.
+     *
+     * @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
+     */
+    subscribeDisruptions(tenant: RealtimeTenant, onMessage: WebSocketAPIMessageCallback<RealtimeNews>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * Unsubscribe disruptions.
+     *
+     * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @public
+     */
+    unsubscribeDisruptions(tenant: RealtimeTenant, onMessage?: WebSocketAPIMessageCallback<RealtimeNews>): 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<{data: { content: RealtimeStation }}>} A station.
+     * @public
+     */
+    getStation(uic: RealtimeStationId, mode: RealtimeMode): Promise<WebSocketAPIMessageEventData<RealtimeStation>>;
+    /**
+     * 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: RealtimeMode, timeout?: number): Promise<RealtimeStation[]>;
+    /**
+     * Subscribe to stations channel.
+     * One message pro station.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @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.
+     * @public
+     */
+    subscribeStations(mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeStation>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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?: WebSocketAPIMessageCallback<RealtimeStation>): void;
+    /**
+     * Subscribe to extra_geoms 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: WebSocketAPIMessageCallback<RealtimeExtraGeom>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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: WebSocketAPIMessageCallback<RealtimeExtraGeom>): void;
+    /**
+     * Return a partial trajectory with a given id and a mode.
+     *
+     * @param {number} trainId The identifier of a trajectory.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
+     * @public
+     */
+    getTrajectory(id: RealtimeTrainId, mode: RealtimeMode): Promise<WebSocketAPIMessageEventData<RealtimeTrajectory>>;
+    /**
+     * 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} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @public
+     */
+    subscribeTrajectory(mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeTrajectoryResponse[] | RealtimeTrajectoryResponse>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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: WebSocketAPIMessageCallback<RealtimeTrajectoryResponse[]>): void;
+    /**
+     * Subscribe to deleted_vhicles 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.
+     */
+    subscribeDeletedVehicles(mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeTrainId>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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.
+     */
+    unsubscribeDeletedVehicles(onMessage: WebSocketAPIMessageCallback<RealtimeTrainId>): 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<{ data: { content: RealtimeFullTrajectory } }>} Return a full trajectory.
+     * @public
+     */
+    getFullTrajectory(id: RealtimeTrainId, mode: RealtimeMode, generalizationLevel: RealtimeGeneralizationLevel | undefined): Promise<WebSocketAPIMessageEventData<RealtimeFullTrajectory>>;
+    /**
+     * 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
+     */
+    subscribeFullTrajectory(id: RealtimeTrainId, mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeFullTrajectory>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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.
+     * @public
+     */
+    unsubscribeFullTrajectory(id: RealtimeTrainId, onMessage?: WebSocketAPIMessageCallback<RealtimeFullTrajectory>): void;
+    /**
+     * Get the list of stops for this vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
+     * @public
+     */
+    getStopSequence(id: RealtimeTrainId): Promise<WebSocketAPIMessageEventData<StopSequence[]>>;
+    /**
+     * 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.
+     * @public
+     */
+    subscribeStopSequence(id: RealtimeTrainId, onMessage: WebSocketAPIMessageCallback<StopSequence[]>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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.
+     * @public
+     */
+    unsubscribeStopSequence(id: RealtimeTrainId, onMessage?: WebSocketAPIMessageCallback<StopSequence[]>): void;
+    /**
+     * 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: WebSocketAPIMessageCallback<string>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * 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?: WebSocketAPIMessageCallback<string>): void;
+}
+export default RealtimeAPI;

package/api/RoutingAPI.d.ts

@@ -0,0 +1,37 @@
+import HttpAPI from './HttpAPI';
+import { RoutingParameters, RoutingResponse } from '../types';
+export type RoutingAPIOptions = {
+    url?: string;
+    apiKey?: string;
+};
+/**
+ * Access to the [geOps Routing API](https://developer.geops.io/apis/routing).
+ *
+ * @example
+ * import { RoutingAPI } from 'mobility-toolbox-js';
+ *
+ * const api = new RoutingAPI({
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * @public
+ */
+declare class RoutingAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {RoutingAPIOptions} options Options.
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+     */
+    constructor(options?: RoutingAPIOptions);
+    /**
+     * Route.
+     *
+     * @param {RoutingParameters} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
+     * @param {RequestInit} config Options for the fetch request.
+     * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    route(params: RoutingParameters, config: RequestInit): Promise<RoutingResponse>;
+}
+export default RoutingAPI;

package/api/StopsAPI.d.ts

@@ -0,0 +1,38 @@
+import HttpAPI from './HttpAPI';
+import { StopsParameters, StopsResponse } from '../types';
+export type StopsAPIOptions = {
+    url?: string;
+    apiKey?: string;
+};
+/**
+ * Access to the [geOps Stops api](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+ *
+ * @example
+ * import { StopsAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new StopsAPI({
+ *   url: 'https://api.geops.io/stops/v1/',
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * @public
+ */
+declare class StopsAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {StopsAPIOptions} options Options.
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] Service url.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+     */
+    constructor(options?: StopsAPIOptions);
+    /**
+     * Search fo stops.
+     *
+     * @param {StopsParameters} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/stops).
+     * @param {RequestInit} config Options for the fetch request.
+     * @return {Promise<StopsResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    search(params: StopsParameters, config: RequestInit): Promise<StopsResponse>;
+}
+export default StopsAPI;

package/api/WebSocketAPI.d.ts

@@ -0,0 +1,153 @@
+import { RealtimeTrajectoryResponse } from '../types';
+export declare type WebSocketAPIParameters = {
+    channel?: string;
+    args?: string | number;
+    id?: string | number;
+};
+export declare type WebSocketAPIMessageEventData<T> = {
+    timestamp: number;
+    source: string;
+    content: T;
+    client_reference: string | number | null;
+};
+export type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]> & {
+    source: 'buffer';
+};
+export type WebSocketAPIMessageEvent = Event & {
+    data: string;
+};
+export interface WebSocketAPIMessageEventListener {
+    (evt: WebSocketAPIMessageEvent): void;
+}
+/**
+ * This type represents a function that has been call with each feature returned by the websocket.
+ */
+export interface WebSocketAPIMessageCallback<T> {
+    (data: WebSocketAPIMessageEventData<T>): void;
+}
+export declare type WebSocketAPISubscription = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIMessageCallback<any>;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    quiet: boolean;
+};
+export declare type WebSocketAPISubscribed = {
+    [index: string]: boolean;
+};
+export declare type WebSocketAPIRequest = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIMessageCallback<any>;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    requestString: String;
+};
+/**
+ * Class used to facilitate connection to a WebSocketAPI and
+ * also to manage properly messages send to the WebSocketAPI.
+ * This class must not contain any specific implementation.
+ * @private
+ */
+declare class WebSocketAPI {
+    websocket?: WebSocket;
+    closed?: boolean;
+    closing?: boolean;
+    connecting?: boolean;
+    open?: boolean;
+    messagesOnOpen: Array<string>;
+    subscriptions: Array<WebSocketAPISubscription>;
+    subscribed: WebSocketAPISubscribed;
+    requests: Array<WebSocketAPIRequest>;
+    constructor();
+    defineProperties(): void;
+    /**
+     * Get the websocket request string.
+     *
+     * @param {string} method Request mehtod {GET, SUB}.
+     * @param {WebSocketParameters} params Request parameters.
+     * @param {string} params.channel Channel name
+     * @param {string} [params.args] Request arguments
+     * @param {Number|string} [params.id] Request identifier
+     * @return {string} request string
+     * @private
+     */
+    static getRequestString(method: string, params?: WebSocketAPIParameters): string;
+    /**
+     * (Re)connect the websocket.
+     *
+     * @param {string} url Websocket url.
+     * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
+     * @private
+     */
+    connect(url: string, onOpen?: () => void): void;
+    /**
+     * Close the websocket definitively.
+     *
+     * @private
+     */
+    close(): void;
+    /**
+     * Sends a message to the websocket.
+     *
+     * @param {message} message Message to send.
+     * @private
+     */
+    send(message: string): void;
+    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    /**
+     * Listen to websocket messages.
+     *
+     * @param {WebSocketParameters} params Parameters for the websocket get request
+     * @param {function} cb callback on listen
+     * @param {function} errorCb Callback on error
+     * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
+     * @private
+     */
+    listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
+        onMessageCb: WebSocketAPIMessageEventListener;
+        onErrorCb?: EventListener;
+    };
+    /**
+     * Unlisten websocket messages.
+     *
+     * @param {Object} params Parameters for the websocket get request.
+     * @param {function} cb Callback used when listen.
+     * @private
+     */
+    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.
+     *
+     * @param {Object} params Parameters for the websocket get request
+     * @param {function} onMessage callback on message event
+     * @param {function} onError Callback on error and close event
+     * @private
+     */
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
+    /**
+     * Subscribe to a given channel.
+     *
+     * @param {Object} params Parameters for the websocket get request
+     * @param {function} cb callback on listen
+     * @param {function} errorCb Callback on error
+     * @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
+     * @private
+     */
+    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?: WebSocketAPIMessageCallback<any>): void;
+    /**
+     * After an auto reconnection we need to re-subscribe to the channels.
+     */
+    subscribePreviousSubscriptions(): void;
+}
+export default WebSocketAPI;

package/api/index.d.ts

@@ -0,0 +1,3 @@
+export { default as RoutingAPI } from "./RoutingAPI";
+export { default as StopsAPI } from "./StopsAPI";
+export { default as RealtimeAPI, RealtimeModes } from "./RealtimeAPI";