mobility-toolbox-js 3.1.1 → 3.2.0-beta.0

package/api/HttpAPI.d.ts

@@ -15,6 +15,6 @@ declare class HttpAPI {
      *
      * @private
      */
-    fetch(path: string, params: object, config: RequestInit): Promise<any>;
+    fetch<T>(path: string, params: object, config: RequestInit): Promise<T>;
 }
 export default HttpAPI;

package/api/HttpAPI.js

@@ -28,7 +28,6 @@ class HttpAPI {
                 throw new Error(`No url defined for request to ${this.url}/${path}`);
             }
             if (!this.url && !this.apiKey && !this.url.includes('key=')) {
-                // eslint-disable-next-line no-console
                 throw new Error(`No apiKey defined for request to ${this.url}`);
             }
             // Clean requets parameters, removing undefined and null values.

package/api/RealtimeAPI.d.ts

@@ -1,5 +1,7 @@
-import WebSocketAPI, { WebSocketAPIMessageCallback, WebSocketAPIMessageEventData, WebSocketAPIParameters } from './WebSocketAPI';
 import type { RealtimeBbox, RealtimeDeparture, RealtimeExtraGeom, RealtimeFullTrajectory, RealtimeGeneralizationLevel, RealtimeMode, RealtimeNews, RealtimeStation, RealtimeStationId, RealtimeStopSequence, RealtimeTenant, RealtimeTrainId, RealtimeTrajectory, RealtimeVersion } from '../types';
+import WebSocketAPI, { WebSocketAPIMessageCallback, WebSocketAPIMessageEventData, WebSocketAPIParameters } from './WebSocketAPI';
+export type RealtimeAPIDeparturesById = Record<string, RealtimeDeparture>;
+export type RealtimeAPIExtraGeomsById = Record<string, RealtimeExtraGeom>;
 /**
  * @typedef RealtimeAPIOptions
  */
@@ -12,8 +14,6 @@ export interface RealtimeAPIOptions {
     url?: string;
     version?: RealtimeVersion;
 }
-export type RealtimeAPIExtraGeomsById = Record<string, RealtimeExtraGeom>;
-export type RealtimeAPIDeparturesById = Record<string, RealtimeDeparture>;
 export interface RealtimeModesType {
     RAW: RealtimeMode;
     SCHEMATIC: RealtimeMode;
@@ -135,7 +135,7 @@ declare class RealtimeAPI {
      * @return {Promise<WebSocketAPIMessageEventData<?>>} A websocket response.
      * @public
      */
-    get(channelOrParams: string | WebSocketAPIParameters): Promise<WebSocketAPIMessageEventData<any>>;
+    get<T>(channelOrParams: string | WebSocketAPIParameters): Promise<WebSocketAPIMessageEventData<T>>;
     /**
      * Get a full trajectory of a vehicule .
      *
@@ -211,7 +211,7 @@ declare class RealtimeAPI {
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    subscribe(channel: string, onSuccess: WebSocketAPIMessageCallback<any>, onError?: EventListener, quiet?: boolean): void;
+    subscribe<T>(channel: string, onSuccess: WebSocketAPIMessageCallback<T>, onError?: EventListener, quiet?: boolean): void;
     /**
      * Subscribe to deleted_vhicles channel.
      *
@@ -327,7 +327,7 @@ declare class RealtimeAPI {
      * @param {function} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    unsubscribe(channel: string, suffix?: string, onMessage?: WebSocketAPIMessageCallback<any>): void;
+    unsubscribe<T>(channel: string, suffix?: string, onMessage?: WebSocketAPIMessageCallback<T>): 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.

package/api/RealtimeAPI.js

@@ -1,7 +1,5 @@
-/* eslint-disable no-underscore-dangle */
 import debounceWebsocketMessages from '../common/utils/debounceWebsocketMessages';
 import getModeSuffix from '../common/utils/getRealtimeModeSuffix';
-/* eslint-disable class-methods-use-this */
 import WebSocketAPI from './WebSocketAPI';
 /**
  * Enum for Realtime modes.
@@ -261,7 +259,9 @@ class RealtimeAPI {
         window.clearTimeout(this.pingInterval);
         window.clearTimeout(this.reconnectTimeout);
         if (this.reconnectTimeoutMs) {
-            this.reconnectTimeout = window.setTimeout(() => this.open(), this.reconnectTimeoutMs);
+            this.reconnectTimeout = window.setTimeout(() => {
+                return this.open();
+            }, this.reconnectTimeoutMs);
         }
     }
     /**

package/api/WebSocketAPI.d.ts

@@ -1,43 +1,43 @@
 import { RealtimeTrajectoryResponse } from '../types';
-export declare interface WebSocketAPIParameters {
-    args?: number | string;
-    channel?: string;
-    id?: number | string;
-}
 export declare interface WebSocketAPIMessageEventData<T> {
     client_reference: null | number | string;
     content: T;
     source: string;
     timestamp: number;
 }
-export type WebSocketAPIBufferMessageEventData = {
-    source: 'buffer';
-} & WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]>;
-export type WebSocketAPIMessageEvent = {
-    data: string;
-} & Event;
-export type WebSocketAPIMessageEventListener = (evt: WebSocketAPIMessageEvent) => void;
-/**
- * This type represents a function that has been call with each feature returned by the websocket.
- */
-export type WebSocketAPIMessageCallback<T> = (data: WebSocketAPIMessageEventData<T>) => void;
-export declare interface WebSocketAPISubscription {
-    cb: WebSocketAPIMessageCallback<any>;
+export declare interface WebSocketAPIParameters {
+    args?: number | string;
+    channel?: string;
+    id?: number | string;
+}
+export declare interface WebSocketAPIRequest<T> {
+    cb: WebSocketAPIMessageCallback<T>;
     errorCb?: EventListener;
     onErrorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
     params: WebSocketAPIParameters;
-    quiet: boolean;
+    requestString: string;
 }
-export type WebSocketAPISubscribed = Record<string, boolean>;
-export declare interface WebSocketAPIRequest {
-    cb: WebSocketAPIMessageCallback<any>;
+export declare interface WebSocketAPISubscription<T> {
+    cb: WebSocketAPIMessageCallback<T>;
     errorCb?: EventListener;
     onErrorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
     params: WebSocketAPIParameters;
-    requestString: string;
+    quiet: boolean;
 }
+export type WebSocketAPIBufferMessageEventData = {
+    source: 'buffer';
+} & WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]>;
+/**
+ * This type represents a function that has been call with each feature returned by the websocket.
+ */
+export type WebSocketAPIMessageCallback<T> = (data: WebSocketAPIMessageEventData<T>) => void;
+export type WebSocketAPIMessageEvent = {
+    data: string;
+} & Event;
+export type WebSocketAPIMessageEventListener = (evt: WebSocketAPIMessageEvent) => void;
+export type WebSocketAPISubscribed = Record<string, boolean>;
 /**
  * Class used to facilitate connection to a WebSocketAPI and
  * also to manage properly messages send to the WebSocketAPI.
@@ -50,9 +50,9 @@ declare class WebSocketAPI {
     connecting?: boolean;
     messagesOnOpen: string[];
     open?: boolean;
-    requests: WebSocketAPIRequest[];
+    requests: WebSocketAPIRequest<unknown>[];
     subscribed: WebSocketAPISubscribed;
-    subscriptions: WebSocketAPISubscription[];
+    subscriptions: WebSocketAPISubscription<unknown>[];
     websocket?: WebSocket;
     constructor();
     /**
@@ -92,7 +92,7 @@ declare class WebSocketAPI {
      * @param {function} errorCb Callback on error and close event
      * @private
      */
-    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
+    get<T>(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<T>, errorCb?: EventListener): void;
     /**
      * Listen to websocket messages.
      *
@@ -102,7 +102,7 @@ declare class WebSocketAPI {
      * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
      * @private
      */
-    listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
+    listen<T>(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<T>, errorCb?: EventListener): {
         onErrorCb?: EventListener;
         onMessageCb: WebSocketAPIMessageEventListener;
     };
@@ -123,7 +123,7 @@ 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: WebSocketAPIMessageCallback<any>, errorCb?: EventListener, quiet?: boolean): void;
+    subscribe<T>(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<T>, errorCb?: EventListener, quiet?: boolean): void;
     /**
      * After an auto reconnection we need to re-subscribe to the channels.
      */
@@ -135,13 +135,13 @@ declare class WebSocketAPI {
      * @param {function} cb Callback used when listen.
      * @private
      */
-    unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>): void;
+    unlisten<T>(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<T>): 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;
+    unsubscribe<T>(source: string, cb?: WebSocketAPIMessageCallback<T>): void;
 }
 export default WebSocketAPI;

package/api/WebSocketAPI.js

@@ -86,16 +86,22 @@ class WebSocketAPI {
     defineProperties() {
         Object.defineProperties(this, {
             closed: {
-                get: () => !!(!this.websocket ||
-                    this.websocket.readyState === this.websocket.CLOSED),
+                get: () => {
+                    return !!(!this.websocket ||
+                        this.websocket.readyState === this.websocket.CLOSED);
+                },
             },
             closing: {
-                get: () => !!(this.websocket &&
-                    this.websocket.readyState === this.websocket.CLOSING),
+                get: () => {
+                    return !!(this.websocket &&
+                        this.websocket.readyState === this.websocket.CLOSING);
+                },
             },
             connecting: {
-                get: () => !!(this.websocket &&
-                    this.websocket.readyState === this.websocket.CONNECTING),
+                get: () => {
+                    return !!(this.websocket &&
+                        this.websocket.readyState === this.websocket.CONNECTING);
+                },
             },
             /**
              * Array of message to send on open.
@@ -107,7 +113,9 @@ class WebSocketAPI {
                 writable: true,
             },
             open: {
-                get: () => !!(this.websocket && this.websocket.readyState === this.websocket.OPEN),
+                get: () => {
+                    return !!(this.websocket && this.websocket.readyState === this.websocket.OPEN);
+                },
             },
             /**
              * List of channels subscribed.
@@ -142,22 +150,27 @@ class WebSocketAPI {
         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) => {
+        const once = (callback) => {
             // @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);
+            return (...args) => {
+                // @ts-expect-error : Spread error
+                callback(...args);
+                const index = this.requests.findIndex((request) => {
+                    return requestString === request.requestString && cb === request.cb;
+                });
+                const { onErrorCb, onMessageCb } = this.requests[index];
+                this.removeEvents(onMessageCb, onErrorCb);
+                this.requests.splice(index, 1);
+            };
         };
         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 = [];
         }
-        const index = this.requests.findIndex((request) => requestString === request.requestString && cb === request.cb);
+        const index = this.requests.findIndex((request) => {
+            return requestString === request.requestString && cb === request.cb;
+        });
         const newReq = {
             cb,
             errorCb,
@@ -167,9 +180,11 @@ class WebSocketAPI {
             requestString,
         };
         if (index > -1) {
+            // @ts-expect-error - We know that the requests is an array of WebSocketAPIRequest
             this.requests[index] = newReq;
         }
         else {
+            // @ts-expect-error - We know that the requests is an array of WebSocketAPIRequest
             this.requests.push(newReq);
         }
     }
@@ -192,7 +207,6 @@ class WebSocketAPI {
                 data = JSON.parse(evt.data);
             }
             catch (err) {
-                // eslint-disable-next-line no-console
                 console.error('WebSocket: unable to parse JSON data', err, evt.data);
                 return;
             }
@@ -201,6 +215,7 @@ class WebSocketAPI {
             // Buffer channel message return a list of other channels to propagate to proper callbacks.
             let contents;
             if (data.source === 'buffer') {
+                // @ts-expect-error - We know that the data is a WebSocketAPIBufferMessageEventData
                 contents = data
                     .content;
             }
@@ -270,12 +285,16 @@ class WebSocketAPI {
     subscribe(params, cb, errorCb, quiet = false) {
         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 index = this.subscriptions.findIndex((subcr) => {
+            return params.channel === subcr.params.channel && cb === subcr.cb;
+        });
         const newSubscr = { cb, errorCb, onErrorCb, onMessageCb, params, quiet };
         if (index > -1) {
+            // @ts-expect-error - We know that the subscriptions is an array of WebSocketAPISubscription
             this.subscriptions[index] = newSubscr;
         }
         else {
+            // @ts-expect-error - We know that the subscriptions is an array of WebSocketAPISubscription
             this.subscriptions.push(newSubscr);
         }
         if (!this.subscribed[reqStr]) {
@@ -310,7 +329,9 @@ class WebSocketAPI {
      */
     unlisten(params, cb) {
         [...(this.subscriptions || []), ...(this.requests || [])]
-            .filter((s) => s.params.channel === params.channel && (!cb || s.cb === cb))
+            .filter((s) => {
+            return s.params.channel === params.channel && (!cb || s.cb === cb);
+        })
             .forEach(({ onErrorCb, onMessageCb }) => {
             this.removeEvents(onMessageCb, onErrorCb);
         });
@@ -322,17 +343,25 @@ class WebSocketAPI {
      * @private
      */
     unsubscribe(source, cb) {
-        const toRemove = this.subscriptions.filter((s) => s.params.channel === source && (!cb || s.cb === cb));
+        const toRemove = this.subscriptions.filter((s) => {
+            return s.params.channel === source && (!cb || s.cb === cb);
+        });
         toRemove.forEach(({ onErrorCb, onMessageCb }) => {
             this.removeEvents(onMessageCb, onErrorCb);
         });
-        this.subscriptions = this.subscriptions.filter((s) => s.params.channel !== source || (cb && s.cb !== cb));
+        this.subscriptions = this.subscriptions.filter((s) => {
+            return s.params.channel !== source || (cb && s.cb !== cb);
+        });
         // If there is no more subscriptions to this channel, and the removed subscriptions didn't register quietly,
         // we DEL it.
         if (source &&
             this.subscribed[source] &&
-            !this.subscriptions.find((s) => s.params.channel === source) &&
-            toRemove.find((subscr) => !subscr.quiet)) {
+            !this.subscriptions.find((s) => {
+                return s.params.channel === source;
+            }) &&
+            toRemove.find((subscr) => {
+                return !subscr.quiet;
+            })) {
             this.send(`DEL ${source}`);
             this.subscribed[source] = false;
         }

package/common/utils/debounceWebsocketMessages.js

@@ -11,7 +11,7 @@ const debounceWebsocketMessages = (onUpdate, getObjectId, timeout = 100) => {
     const objectsById = {};
     const objects = [];
     return (data) => {
-        const { source, content } = data;
+        const { content, source } = data;
         if (updateTimeout[source]) {
             window.clearTimeout(updateTimeout[source]);
         }