mobility-toolbox-js 3.1.1 → 3.1.2

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/RealtimeAPI.d.ts

@@ -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/WebSocketAPI.d.ts

@@ -21,8 +21,8 @@ export type WebSocketAPIMessageEventListener = (evt: WebSocketAPIMessageEvent) =
  * 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 WebSocketAPISubscription<T> {
+    cb: WebSocketAPIMessageCallback<T>;
     errorCb?: EventListener;
     onErrorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
@@ -30,8 +30,8 @@ export declare interface WebSocketAPISubscription {
     quiet: boolean;
 }
 export type WebSocketAPISubscribed = Record<string, boolean>;
-export declare interface WebSocketAPIRequest {
-    cb: WebSocketAPIMessageCallback<any>;
+export declare interface WebSocketAPIRequest<T> {
+    cb: WebSocketAPIMessageCallback<T>;
     errorCb?: EventListener;
     onErrorCb?: EventListener;
     onMessageCb: WebSocketAPIMessageEventListener;
@@ -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

@@ -167,9 +167,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);
         }
     }
@@ -201,6 +203,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;
             }
@@ -273,9 +276,11 @@ class WebSocketAPI {
         const index = this.subscriptions.findIndex((subcr) => 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]) {

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]);
         }