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

package/api/WebSocketAPI.js

@@ -8,52 +8,6 @@ class WebSocketAPI {
     constructor() {
         this.defineProperties();
     }
-    defineProperties() {
-        Object.defineProperties(this, {
-            closed: {
-                get: () => !!(!this.websocket ||
-                    this.websocket.readyState === this.websocket.CLOSED),
-            },
-            closing: {
-                get: () => !!(this.websocket &&
-                    this.websocket.readyState === this.websocket.CLOSING),
-            },
-            connecting: {
-                get: () => !!(this.websocket &&
-                    this.websocket.readyState === this.websocket.CONNECTING),
-            },
-            open: {
-                get: () => !!(this.websocket && this.websocket.readyState === this.websocket.OPEN),
-            },
-            /**
-             * Array of message to send on open.
-             * @type {Array<string>}
-             * @private
-             */
-            messagesOnOpen: {
-                value: [],
-                writable: true,
-            },
-            /**
-             * Array of subscriptions.
-             * @type {Array<WebSocketSubscription>}
-             * @private
-             */
-            subscriptions: {
-                value: [],
-                writable: true,
-            },
-            /**
-             * List of channels subscribed.
-             * @type {WebSocketSubscribed}
-             * @private
-             */
-            subscribed: {
-                value: {},
-                writable: true,
-            },
-        });
-    }
     /**
      * Get the websocket request string.
      *
@@ -71,6 +25,27 @@ class WebSocketAPI {
         reqStr += params.id ? ` ${params.id}` : '';
         return reqStr.trim();
     }
+    addEvents(onMessage, onError) {
+        if (this.websocket) {
+            this.websocket.addEventListener('message', onMessage);
+            if (onError) {
+                this.websocket.addEventListener('error', onError);
+                this.websocket.addEventListener('close', onError);
+            }
+        }
+    }
+    /**
+     * Close the websocket definitively.
+     *
+     * @private
+     */
+    close() {
+        if (this.websocket && (this.open || this.connecting)) {
+            this.websocket.onclose = () => { };
+            this.websocket.close();
+            this.messagesOnOpen = [];
+        }
+    }
     /**
      * (Re)connect the websocket.
      *
@@ -96,7 +71,6 @@ class WebSocketAPI {
                 this.websocket.close();
             }
         }
-        /** @private */
         this.websocket = new WebSocket(url);
         if (!this.open) {
             this.websocket.addEventListener('open', () => {
@@ -109,65 +83,94 @@ class WebSocketAPI {
             this.subscribePreviousSubscriptions();
         }
     }
-    /**
-     * Close the websocket definitively.
-     *
-     * @private
-     */
-    close() {
-        if (this.websocket && (this.open || this.connecting)) {
-            this.websocket.onclose = () => { };
-            this.websocket.close();
-            this.messagesOnOpen = [];
-        }
+    defineProperties() {
+        Object.defineProperties(this, {
+            closed: {
+                get: () => !!(!this.websocket ||
+                    this.websocket.readyState === this.websocket.CLOSED),
+            },
+            closing: {
+                get: () => !!(this.websocket &&
+                    this.websocket.readyState === this.websocket.CLOSING),
+            },
+            connecting: {
+                get: () => !!(this.websocket &&
+                    this.websocket.readyState === this.websocket.CONNECTING),
+            },
+            /**
+             * Array of message to send on open.
+             * @type {Array<string>}
+             * @private
+             */
+            messagesOnOpen: {
+                value: [],
+                writable: true,
+            },
+            open: {
+                get: () => !!(this.websocket && this.websocket.readyState === this.websocket.OPEN),
+            },
+            /**
+             * List of channels subscribed.
+             * @type {WebSocketSubscribed}
+             * @private
+             */
+            subscribed: {
+                value: {},
+                writable: true,
+            },
+            /**
+             * Array of subscriptions.
+             * @type {Array<WebSocketSubscription>}
+             * @private
+             */
+            subscriptions: {
+                value: [],
+                writable: true,
+            },
+        });
     }
     /**
-     * Sends a message to the websocket.
+     * 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 {message} message Message to send.
+     * @param {Object} params Parameters for the websocket get request
+     * @param {function} cb callback on message event
+     * @param {function} errorCb Callback on error and close event
      * @private
      */
-    send(message) {
-        if (!this.websocket || this.closed || this.closing) {
-            return;
-        }
-        const send = () => {
-            var _a;
-            (_a = this.websocket) === null || _a === void 0 ? void 0 : _a.send(message);
+    get(params, cb, errorCb) {
+        const requestString = WebSocketAPI.getRequestString('GET', params);
+        this.send(requestString);
+        // We wrap the callbacks to make sure they are called only once.
+        const once = (callback) => 
+        // @ts-expect-error : Spread error
+        (...args) => {
+            // @ts-expect-error : Spread error
+            callback(...args);
+            const index = this.requests.findIndex((request) => requestString === request.requestString && cb === request.cb);
+            const { onErrorCb, onMessageCb } = this.requests[index];
+            this.removeEvents(onMessageCb, onErrorCb);
+            this.requests.splice(index, 1);
         };
-        if (!this.open) {
-            // This 'if' avoid sending 2 identical BBOX message on open,
-            if (!this.messagesOnOpen.includes(message)) {
-                this.messagesOnOpen.push(message);
-                this.websocket.addEventListener('open', () => {
-                    this.messagesOnOpen = [];
-                    send();
-                });
-                this.websocket.addEventListener('close', () => {
-                    this.messagesOnOpen = [];
-                });
-            }
-        }
-        else if (!this.messagesOnOpen.includes(message)) {
-            send();
+        const { onErrorCb, onMessageCb } = this.listen(params, once(cb), errorCb && once(errorCb));
+        // Store requests and callbacks to be able to remove them.
+        if (!this.requests) {
+            this.requests = [];
         }
-    }
-    addEvents(onMessage, onError) {
-        if (this.websocket) {
-            this.websocket.addEventListener('message', onMessage);
-            if (onError) {
-                this.websocket.addEventListener('error', onError);
-                this.websocket.addEventListener('close', onError);
-            }
+        const index = this.requests.findIndex((request) => requestString === request.requestString && cb === request.cb);
+        const newReq = {
+            cb,
+            errorCb,
+            onErrorCb,
+            onMessageCb,
+            params,
+            requestString,
+        };
+        if (index > -1) {
+            this.requests[index] = newReq;
         }
-    }
-    removeEvents(onMessage, onError) {
-        if (this.websocket) {
-            this.websocket.removeEventListener('message', onMessage);
-            if (onError) {
-                this.websocket.removeEventListener('error', onError);
-                this.websocket.removeEventListener('close', onError);
-            }
+        else {
+            this.requests.push(newReq);
         }
     }
     /**
@@ -213,64 +216,46 @@ class WebSocketAPI {
             });
         };
         this.addEvents(onMessage, errorCb);
-        return { onMessageCb: onMessage, onErrorCb: errorCb };
+        return { onErrorCb: errorCb, onMessageCb: onMessage };
     }
-    /**
-     * Unlisten websocket messages.
-     *
-     * @param {Object} params Parameters for the websocket get request.
-     * @param {function} cb Callback used when listen.
-     * @private
-     */
-    unlisten(params, cb) {
-        [...(this.subscriptions || []), ...(this.requests || [])]
-            .filter((s) => s.params.channel === params.channel && (!cb || s.cb === cb))
-            .forEach(({ onMessageCb, onErrorCb }) => {
-            this.removeEvents(onMessageCb, onErrorCb);
-        });
+    removeEvents(onMessage, onError) {
+        if (this.websocket) {
+            this.websocket.removeEventListener('message', onMessage);
+            if (onError) {
+                this.websocket.removeEventListener('error', onError);
+                this.websocket.removeEventListener('close', onError);
+            }
+        }
     }
     /**
-     * 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.
+     * Sends a message to the websocket.
      *
-     * @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
+     * @param {message} message Message to send.
      * @private
      */
-    get(params, cb, errorCb) {
-        const requestString = WebSocketAPI.getRequestString('GET', params);
-        this.send(requestString);
-        // We wrap the callbacks to make sure they are called only once.
-        const once = (callback) => 
-        // @ts-ignore: Spread error
-        (...args) => {
-            // @ts-ignore: Spread error
-            callback(...args);
-            const index = this.requests.findIndex((request) => requestString === request.requestString && cb === request.cb);
-            const { onMessageCb, onErrorCb } = this.requests[index];
-            this.removeEvents(onMessageCb, onErrorCb);
-            this.requests.splice(index, 1);
-        };
-        const { onMessageCb, onErrorCb } = this.listen(params, once(cb), errorCb && once(errorCb));
-        // Store requests and callbacks to be able to remove them.
-        if (!this.requests) {
-            this.requests = [];
+    send(message) {
+        if (!this.websocket || this.closed || this.closing) {
+            return;
         }
-        const index = this.requests.findIndex((request) => requestString === request.requestString && cb === request.cb);
-        const newReq = {
-            params,
-            requestString,
-            cb,
-            errorCb,
-            onMessageCb,
-            onErrorCb,
+        const send = () => {
+            var _a;
+            (_a = this.websocket) === null || _a === void 0 ? void 0 : _a.send(message);
         };
-        if (index > -1) {
-            this.requests[index] = newReq;
+        if (!this.open) {
+            // This 'if' avoid sending 2 identical BBOX message on open,
+            if (!this.messagesOnOpen.includes(message)) {
+                this.messagesOnOpen.push(message);
+                this.websocket.addEventListener('open', () => {
+                    this.messagesOnOpen = [];
+                    send();
+                });
+                this.websocket.addEventListener('close', () => {
+                    this.messagesOnOpen = [];
+                });
+            }
         }
-        else {
-            this.requests.push(newReq);
+        else if (!this.messagesOnOpen.includes(message)) {
+            send();
         }
     }
     /**
@@ -283,10 +268,10 @@ class WebSocketAPI {
      * @private
      */
     subscribe(params, cb, errorCb, quiet = false) {
-        const { onMessageCb, onErrorCb } = this.listen(params, cb, errorCb);
+        const { onErrorCb, onMessageCb } = this.listen(params, cb, errorCb);
         const reqStr = WebSocketAPI.getRequestString('', params);
         const index = this.subscriptions.findIndex((subcr) => params.channel === subcr.params.channel && cb === subcr.cb);
-        const newSubscr = { params, cb, errorCb, onMessageCb, onErrorCb, quiet };
+        const newSubscr = { cb, errorCb, onErrorCb, onMessageCb, params, quiet };
         if (index > -1) {
             this.subscriptions[index] = newSubscr;
         }
@@ -301,6 +286,35 @@ class WebSocketAPI {
             this.subscribed[reqStr] = true;
         }
     }
+    /**
+     * After an auto reconnection we need to re-subscribe to the channels.
+     */
+    subscribePreviousSubscriptions() {
+        // Before to subscribe previous subscriptions we make sure they
+        // are all defined as unsubscribed, because this code is asynchrone
+        // and a subscription could have been added in between.
+        Object.keys(this.subscribed).forEach((key) => {
+            this.subscribed[key] = false;
+        });
+        // Subscribe all previous subscriptions.
+        [...this.subscriptions].forEach((s) => {
+            this.subscribe(s.params, s.cb, s.errorCb, s.quiet);
+        });
+    }
+    /**
+     * Unlisten websocket messages.
+     *
+     * @param {Object} params Parameters for the websocket get request.
+     * @param {function} cb Callback used when listen.
+     * @private
+     */
+    unlisten(params, cb) {
+        [...(this.subscriptions || []), ...(this.requests || [])]
+            .filter((s) => s.params.channel === params.channel && (!cb || s.cb === cb))
+            .forEach(({ onErrorCb, onMessageCb }) => {
+            this.removeEvents(onMessageCb, onErrorCb);
+        });
+    }
     /**
      * Unsubscribe from a channel.
      * @param {string} source source to unsubscribe from
@@ -309,7 +323,7 @@ class WebSocketAPI {
      */
     unsubscribe(source, cb) {
         const toRemove = this.subscriptions.filter((s) => s.params.channel === source && (!cb || s.cb === cb));
-        toRemove.forEach(({ onMessageCb, onErrorCb }) => {
+        toRemove.forEach(({ onErrorCb, onMessageCb }) => {
             this.removeEvents(onMessageCb, onErrorCb);
         });
         this.subscriptions = this.subscriptions.filter((s) => s.params.channel !== source || (cb && s.cb !== cb));
@@ -323,20 +337,5 @@ class WebSocketAPI {
             this.subscribed[source] = false;
         }
     }
-    /**
-     * After an auto reconnection we need to re-subscribe to the channels.
-     */
-    subscribePreviousSubscriptions() {
-        // Before to subscribe previous subscriptions we make sure they
-        // are all defined as unsubscribed, because this code is asynchrone
-        // and a subscription could have been added in between.
-        Object.keys(this.subscribed).forEach((key) => {
-            this.subscribed[key] = false;
-        });
-        // Subscribe all previous subscriptions.
-        [...this.subscriptions].forEach((s) => {
-            this.subscribe(s.params, s.cb, s.errorCb, s.quiet);
-        });
-    }
 }
 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";

package/api/index.js

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

package/api/typedefs.d.ts

@@ -0,0 +1,76 @@
+export default dummy;
+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[];
+};
+/**
+ * @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"]).
+ */
+declare function dummy(): void;

package/api/typedefs.js

@@ -1,30 +1,30 @@
-/**
- * @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 {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.
@@ -55,21 +55,6 @@
  * @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
- */
 // These lines is to block TypeScript to add "use strict;" in the outputed file.
 const dummy = () => { };
 export default dummy;

package/common/controls/StopFinderControlCommon.d.ts

@@ -0,0 +1,53 @@
+import { Feature, FeatureCollection } from 'geojson';
+import { StopsAPI } from '../../api';
+import { StopsAPIOptions } from '../../api/StopsAPI';
+import { StopsParameters } from '../../types';
+export type StopFinderControlCommonOptions = {
+    apiParams: StopsParameters;
+    element: HTMLElement;
+    onSuggestionClick?: (suggestion: Feature, evt: MouseEvent) => void;
+    placeholder?: string;
+} & StopsAPIOptions;
+/**
+ * A class representing a stop finder control to display on map.
+ * This class only draw the html elements.
+ * The geographic logic must be implemented by subclasses.
+ *
+ * @private
+ */
+declare class StopFinderControlCommon {
+    abortController?: AbortController;
+    api: StopsAPI;
+    apiParams: StopsParameters;
+    clearElt?: HTMLDivElement;
+    inputElt?: HTMLInputElement;
+    options?: StopFinderControlCommonOptions;
+    placeholder: string;
+    suggestionsElt?: HTMLElement;
+    /**
+     * Constructor.
+     *
+     * @param {Object} options Options
+     * @param {HTMLElement} options.element HTML element where to attach input and suggestions.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/). See StopsAPI.
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] Stops service url. See StopsAPI.
+     * @param {string} [options.placeholder='Search for a stop...'] Input field placeholder.
+     * @param {StopsSearchParams} [options.apiParams={ limit: 20 }] Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+     */
+    constructor(options: StopFinderControlCommonOptions);
+    /**
+     * Clear the search field and close the control.
+     */
+    clear(): void;
+    createElement({ element }: StopFinderControlCommonOptions): void;
+    render(featureCollection?: FeatureCollection): void;
+    /**
+     * Launch a search.
+     *
+     * @param {String} q The query to search for.
+     * @param {AbortController} abortController Abort controller used to cancel the request.
+     * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    search(q: string, abortController: AbortController): Promise<void>;
+}
+export default StopFinderControlCommon;