mobility-toolbox-js 2.3.9-beta.1 → 2.3.10

package/api/typedefs.d.ts

@@ -1,179 +0,0 @@
-export default dummy;
-export type Departure = {
-    /**
-     * Timestamp in ms.
-     */
-    time: number;
-    no_stop_between: boolean;
-    train_number: number;
-    to: string[];
-    /**
-     * Timestamp in ms.
-     */
-    ris_aimed_time: number;
-    /**
-     * Timestamp in ms.
-     */
-    updated_at: number;
-    new_to: boolean;
-    /**
-     * Timestamp in ms.
-     */
-    min_arrival_time: number;
-    /**
-     * List of next stops. Like value in at_station_ds100.
-     */
-    next_stoppoints: string[];
-    /**
-     * Timestamp in ms.
-     */
-    ris_estimated_time: number;
-    line: NetworkLine;
-    /**
-     * if true this departure has realtime data.
-     */
-    has_fzo: boolean;
-    train_id: number;
-    platform: string;
-    state: any | null;
-    /**
-     * Timestamp in ms.
-     */
-    fzo_estimated_time: number;
-    formation: any | null;
-    no_stop_till: any | null;
-    train_type: number;
-    call_id: number;
-    /**
-     * Timestamp in ms.
-     */
-    created_at: string;
-    at_station_ds100: string;
-    /**
-     * Timestamp in ms.
-     */
-    timediff: number;
-};
-export type Station = GeoJSONFeature;
-export type StationProperties = {
-    transfers: Transfer[];
-    elevatorOutOfOrder: boolean;
-    uic: number;
-    name: string;
-    networkLines: NetworkLine[];
-    hasElevator: boolean;
-    hasZOB: boolean;
-    hasAccessibility: boolean;
-    type: string;
-};
-export type NetworkLine = {
-    /**
-     * Identifier of the line.
-     */
-    id: number;
-    /**
-     * Color of the line (CSS color string).
-     */
-    color: string;
-    /**
-     * Stroke color of the line (CSS color string).
-     */
-    stroke: string;
-    /**
-     * Name of the line.
-     */
-    name: string;
-    /**
-     * Text color of the line  (CSS color string).
-     */
-    text_color: string;
-};
-export type Transfer = {
-    /**
-     * Mode of transportation (ex: U-Bahn).
-     */
-    mot: string;
-    /**
-     * Array of lines name (ex: ["U4", "U5"]).
-     */
-    lines: string[];
-};
-export type StopSequence = GeoJSONFeature;
-export type RealtimeTrajectory = GeoJSONFeature;
-export type FullTrajectory = GeoJSONFeature;
-export type Vehicle = GeoJSONFeature;
-export type ExtraGeom = GeoJSONFeature;
-/**
- * @typedef {Object} Departure
- * @property {number} time Timestamp in ms.
- * @property {boolean} no_stop_between
- * @property {number} train_number
- * @property {string[]} to
- * @property {number} ris_aimed_time Timestamp in ms.
- * @property {number} updated_at Timestamp in ms.
- * @property {boolean} new_to
- * @property {number} min_arrival_time Timestamp in ms.
- * @property {string[]} next_stoppoints List of next stops. Like value in at_station_ds100.
- * @property {number} ris_estimated_time Timestamp in ms.
- * @property {NetworkLine} line
- * @property {boolean} has_fzo if true this departure has realtime data.
- * @property {number} train_id
- * @property {string} platform
- * @property {?*} state
- * @property {number} fzo_estimated_time Timestamp in ms.
- * @property {?*} formation
- * @property {?*} no_stop_till
- * @property {number} train_type
- * @property {number} call_id
- * @property {string} created_at Timestamp in ms.
- * @property {string} at_station_ds100
- * @property {number} timediff Timestamp in ms.
- *
- */
-/**
- * @typedef {GeoJSONFeature} Station
- * @property {StationProperties} properties Returns the station's properties.
- * @property {GeoJSONPoint} geometry Returns a point.
- */
-/**
- * @typedef {Object} StationProperties
- * @property {Transfer[]} transfers
- * @property {boolean} elevatorOutOfOrder
- * @property {number} uic
- * @property {string} name
- * @property {NetworkLine[]} networkLines
- * @property {boolean} hasElevator
- * @property {boolean} hasZOB
- * @property {boolean} hasAccessibility
- * @property {string} type
- */
-/**
- * @typedef {Object} NetworkLine
- * @property {number} id Identifier of the line.
- * @property {string} color Color of the line (CSS color string).
- * @property {string} stroke Stroke color of the line (CSS color string).
- * @property {string} name Name of the line.
- * @property {string} text_color  Text color of the line  (CSS color string).
- */
-/**
- * @typedef {Object} Transfer
- * @property {string} mot Mode of transportation (ex: U-Bahn).
- * @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
- */
-/**
- * @typedef {GeoJSONFeature} StopSequence
- */
-/**
- * @typedef {GeoJSONFeature} RealtimeTrajectory
- */
-/**
- * @typedef {GeoJSONFeature} FullTrajectory
- */
-/**
- * @typedef {GeoJSONFeature} Vehicle
- */
-/**
- * @typedef {GeoJSONFeature} ExtraGeom
- */
-declare function dummy(): void;
-//# sourceMappingURL=typedefs.d.ts.map

package/api/typedefs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedefs.d.ts","sourceRoot":"","sources":["../../src/api/typedefs.js"],"names":[],"mappings":";;;;;UAEc,MAAM;qBACN,OAAO;kBACP,MAAM;QACN,MAAM,EAAE;;;;oBACR,MAAM;;;;gBACN,MAAM;YACN,OAAO;;;;sBACP,MAAM;;;;qBACN,MAAM,EAAE;;;;wBACR,MAAM;UACN,WAAW;;;;aACX,OAAO;cACP,MAAM;cACN,MAAM;;;;;wBAEN,MAAM;;;gBAGN,MAAM;aACN,MAAM;;;;gBACN,MAAM;sBACN,MAAM;;;;cACN,MAAM;;;;eAYN,QAAQ,EAAE;wBACV,OAAO;SACP,MAAM;UACN,MAAM;kBACN,WAAW,EAAE;iBACb,OAAO;YACP,OAAO;sBACP,OAAO;UACP,MAAM;;;;;;QAKN,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;gBACN,MAAM;;;;;;SAKN,MAAM;;;;WACN,MAAM,EAAE;;;;;;;AA3DtB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAGH,+BAAsB"}

package/common/api/HttpAPI.d.ts

@@ -1,31 +0,0 @@
-import BaseObject from 'ol/Object';
-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.
- */
-declare class HttpAPI extends BaseObject {
-    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;
-//# sourceMappingURL=HttpAPI.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"HttpAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/HttpAPI.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,WAAW,CAAC;AAGnC,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF;;;;;;;;;;;;;GAaG;AACH,cAAM,OAAQ,SAAQ,UAAU;IAC9B,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEJ,OAAO,EAAE,cAAc;IASnC;;;OAGG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;CAmCvE;AAED,eAAe,OAAO,CAAC"}

package/common/api/HttpAPI.js

@@ -1,57 +0,0 @@
-import BaseObject from 'ol/Object';
-import getUrlWithParams from '../utils/getUrlWithParams';
-/**
- * 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.
- */
-class HttpAPI extends BaseObject {
-    constructor(options) {
-        super();
-        /** @private */
-        this.url = options.url;
-        /** @private */
-        this.apiKey = options.apiKey;
-    }
-    /**
-     * Append the apiKey before sending the request.
-     * @private
-     */
-    fetch(path, params, config) {
-        if (!this.url) {
-            // eslint-disable-next-line no-console
-            return Promise.reject(new Error(`No url defined for request to ${this.url}/${path}`));
-        }
-        if (!this.url && !this.apiKey && !/key=/.test(this.url)) {
-            // eslint-disable-next-line no-console
-            return Promise.reject(new Error(`No apiKey defined for request to ${this.url}`));
-        }
-        // Clean requets parameters, removing undefined and null values.
-        const searchParams = params || {};
-        const url = getUrlWithParams(`${this.url}${path || ''}`, Object.assign({ key: this.apiKey }, searchParams));
-        // We use toString  because of TYpeScript bug that only accept a string in fetch method.
-        return fetch(url.toString(), config).then((response) => {
-            try {
-                return response.json().then((data) => {
-                    if (data.error) {
-                        throw new Error(data.error);
-                    }
-                    return data;
-                });
-            }
-            catch (err) {
-                return Promise.reject(new Error(err));
-            }
-        });
-    }
-}
-export default HttpAPI;

package/common/api/WebSocketAPI.d.ts

@@ -1,153 +0,0 @@
-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.
- */
-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;
-//# sourceMappingURL=WebSocketAPI.d.ts.map

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

@@ -1 +0,0 @@
-{"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,MAAM,MAAM,kCAAkC,GAAG,4BAA4B,CAC3E,0BAA0B,EAAE,CAC7B,GAAG;IACF,MAAM,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,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;IAkCtC;;;;OAIG;IACH,KAAK;IAQL;;;;;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"}