mobility-toolbox-js 2.0.0-beta.45 → 2.0.0-beta.47

package/api/StopsAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StopsAPI.d.ts","sourceRoot":"","sources":["../../src/api/StopsAPI.js"],"names":[],"mappings":";AAEA;;;;;;;;;;;GAWG;AACH;IACE;;;;;;OAMG;IACH;QAH4B,GAAG;QACJ,MAAM,EAAtB,MAAM;OAIhB;IAED;;;;;;OAMG;IACH,oDAHW,eAAe,GACd,iCAAiC,CAM5C;CACF"}
+{"version":3,"file":"StopsAPI.d.ts","sourceRoot":"","sources":["../../src/api/StopsAPI.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE1D,oBAAY,eAAe,GAAG;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,cAAM,QAAS,SAAQ,OAAO;IAC5B;;;;;;OAMG;gBACS,OAAO,GAAE,eAAoB;IAIzC;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;CAG7E;AAED,eAAe,QAAQ,CAAC"}

package/api/StopsAPI.js

@@ -15,7 +15,7 @@ class StopsAPI extends HttpAPI {
     /**
      * Constructor
      *
-     * @param {Object} options Options.
+     * @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/).
      */
@@ -23,16 +23,14 @@ class StopsAPI extends HttpAPI {
         super(Object.assign({ url: 'https://api.geops.io/stops/v1/' }, options));
     }
     /**
-     * Search.
+     * Search fo stops.
      *
-     * @param {StopsSearchParams} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
-     * @param {AbortController} abortController Abort controller used to cancel the request.
-     * @return {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     * @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, abortController = {}) {
-        return this.fetch('', params, {
-            signal: abortController.signal,
-        });
+    search(params, config) {
+        return this.fetch('', params, config);
     }
 }
 export default StopsAPI;

package/api/typedefs.d.ts

@@ -1,4 +1,5 @@
-type Departure = {
+export default dummy;
+export type Departure = {
     /**
      * Timestamp in ms.
      */
@@ -53,8 +54,8 @@ type Departure = {
      */
     timediff: number;
 };
-type Station = GeoJSONFeature;
-type StationProperties = {
+export type Station = GeoJSONFeature;
+export type StationProperties = {
     transfers: Transfer[];
     elevatorOutOfOrder: boolean;
     uic: number;
@@ -65,7 +66,7 @@ type StationProperties = {
     hasAccessibility: boolean;
     type: string;
 };
-type NetworkLine = {
+export type NetworkLine = {
     /**
      * Identifier of the line.
      */
@@ -87,7 +88,7 @@ type NetworkLine = {
      */
     text_color: string;
 };
-type Transfer = {
+export type Transfer = {
     /**
      * Mode of transportation (ex: U-Bahn).
      */
@@ -97,9 +98,82 @@ type Transfer = {
      */
     lines: string[];
 };
-type StopSequence = GeoJSONFeature;
-type RealtimeTrajectory = GeoJSONFeature;
-type FullTrajectory = GeoJSONFeature;
-type Vehicle = GeoJSONFeature;
-type ExtraGeom = GeoJSONFeature;
+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 +1 @@
-{"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"}
+{"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/api/typedefs.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @typedef {Object} Departure
  * @property {number} time Timestamp in ms.
@@ -71,3 +70,6 @@
 /**
  * @typedef {GeoJSONFeature} ExtraGeom
  */
+// These lines is to block TypeScript to add "use strict;" in the outputed file.
+const dummy = () => { };
+export default dummy;

package/common/api/WebSocketAPI.d.ts

@@ -1,59 +1,116 @@
-export default WebSocketAPI;
+import { Feature } from 'geojson';
+import { RealtimeDeparture, RealtimeNews, RealtimeStation, RealtimeExtraGeom, RealtimeTrajectory, RealtimeTrajectoryResponse, RealtimeStopSequence, RealtimeFullTrajectory } from '../../types';
+export declare type WebSocketAPIParameters = {
+    channel?: string;
+    args?: string | number;
+    id?: string | number;
+};
+export declare type WebSocketAPIMessageEventData = {
+    timestamp: number;
+    source: string;
+    content: string | Feature | RealtimeTrajectoryResponse[] | RealtimeDeparture | RealtimeNews[] | RealtimeStation | RealtimeExtraGeom | RealtimeTrajectory | RealtimeStopSequence[] | RealtimeFullTrajectory;
+    client_reference: string | number | null;
+};
+export declare type WebSocketAPIBufferMessageEventData = Omit<WebSocketAPIMessageEventData, 'content'> & {
+    source: 'buffer';
+    content: Array<WebSocketAPIMessageEventData>;
+};
+export declare 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 WebSocketAPIDataCallback {
+    (data: WebSocketAPIMessageEventData): void;
+}
+export declare type WebSocketAPISubscription = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIDataCallback;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    quiet: boolean;
+};
+export declare type WebSocketAPISubscribed = {
+    [index: string]: boolean;
+};
+export declare type WebSocketAPIRequest = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIDataCallback;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    requestString: String;
+};
 /**
- * Class used to facilitate connection to a WebSocket and
- * also to manage properly messages send to the WebSocket.
+ * 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 {Object} params Request parameters.
+     * @param {WebSocketParameters} params Request parameters.
      * @param {string} params.channel Channel name
      * @param {string} [params.args] Request arguments
-     * @param {Number} [params.id] Request identifier
+     * @param {Number|string} [params.id] Request identifier
      * @return {string} request string
      * @private
      */
-    private static getRequestString;
-    defineProperties(): void;
+    static getRequestString(method: string, params?: WebSocketAPIParameters): string;
     /**
      * (Re)connect the websocket.
      *
-     * @param {strin} url Websocket url.
+     * @param {string} url Websocket url.
      * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
      * @private
      */
-    private connect;
-    /** @ignore */
-    websocket: WebSocket | null | undefined;
+    connect(url: string, onOpen?: () => void): void;
     /**
      * Close the websocket definitively.
      *
      * @private
      */
-    private close;
-    messagesOnOpen: any[] | undefined;
+    close(): void;
     /**
      * Sends a message to the websocket.
      *
      * @param {message} message Message to send.
      * @private
      */
-    private send;
-    addEvents(onMessage: any, onError: any): void;
-    removeEvents(onMessage: any, onError: any): void;
+    send(message: string): void;
+    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
     /**
      * Listen to websocket messages.
      *
-     * @param {Object} params Parameters for the websocket get request
+     * @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
      */
-    private listen;
+    listen(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, errorCb?: EventListener): {
+        onMessageCb: WebSocketAPIMessageEventListener;
+        onErrorCb?: EventListener;
+    };
     /**
      * Unlisten websocket messages.
      *
@@ -61,7 +118,7 @@ declare class WebSocketAPI {
      * @param {function} cb Callback used when listen.
      * @private
      */
-    private unlisten;
+    unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback): 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.
@@ -71,8 +128,7 @@ declare class WebSocketAPI {
      * @param {function} onError Callback on error and close event
      * @private
      */
-    private get;
-    requests: any[] | undefined;
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, errorCb?: EventListener): void;
     /**
      * Subscribe to a given channel.
      *
@@ -82,18 +138,18 @@ declare class WebSocketAPI {
      * @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
      * @private
      */
-    private subscribe;
+    subscribe(params: WebSocketAPIParameters, cb: WebSocketAPIDataCallback, 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
      */
-    private unsubscribe;
-    subscriptions: any;
+    unsubscribe(source: string, cb?: WebSocketAPIDataCallback): 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 +1 @@
-{"version":3,"file":"WebSocketAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/WebSocketAPI.js"],"names":[],"mappings":";AAAA;;;;GAIG;AACH;IAiEE;;;;;;;;;;OAUG;IACH,gCAKC;IA5ED,yBA0DC;IAoBD;;;;;;OAMG;IACH,gBAiBC;IAZC,cAAc;IACd,wCAAmC;IAarC;;;;OAIG;IACH,cAOC;IAFG,kCAAwB;IAI5B;;;;;OAKG;IACH,aAsBC;IAED,8CASC;IAED,iDASC;IAED;;;;;;;;OAQG;IACH,eAgCC;IAED;;;;;;OAMG;IACH,iBAQC;IAED;;;;;;;;OAQG;IACH,YA4CC;IAlBG,4BAAkB;IAoBtB;;;;;;;;OAQG;IACH,kBAqBC;IAED;;;;;OAKG;IACH,oBAwBC;IAfC,mBAEC;IAeH;;OAEG;IACH,uCAYC;CACF"}
+{"version":3,"file":"WebSocketAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/WebSocketAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB,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,GAAG;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EACH,MAAM,GACN,OAAO,GACP,0BAA0B,EAAE,GAC5B,iBAAiB,GACjB,YAAY,EAAE,GACd,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,EAAE,GACtB,sBAAsB,CAAC;IAC3B,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,oBAAY,kCAAkC,GAAG,IAAI,CACnD,4BAA4B,EAC5B,SAAS,CACV,GAAG;IACF,MAAM,EAAE,QAAQ,CAAC;IACjB,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;CAC9C,CAAC;AAEF,oBAAY,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,wBAAwB;IACvC,CAAC,IAAI,EAAE,4BAA4B,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG;IAC7C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,wBAAwB,CAAC;IAC7B,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,wBAAwB,CAAC;IAC7B,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;IAmBtC;;;;OAIG;IACH,KAAK;IASL;;;;;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,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa,GACtB;QACD,WAAW,EAAE,gCAAgC,CAAC;QAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;KAC3B;IA4CD;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,EAAE,EAAE,EAAE,wBAAwB;IAUrE;;;;;;;;OAQG;IACH,GAAG,CACD,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa;IAiDzB;;;;;;;;OAQG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,wBAAwB,EAC5B,OAAO,CAAC,EAAE,aAAa,EACvB,KAAK,UAAQ;IAwBf;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,wBAAwB;IA0BzD;;OAEG;IACH,8BAA8B;CAa/B;AAED,eAAe,YAAY,CAAC"}

package/common/api/WebSocketAPI.js

@@ -1,6 +1,6 @@
 /**
- * Class used to facilitate connection to a WebSocket and
- * also to manage properly messages send to the WebSocket.
+ * 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.
  */
 class WebSocketAPI {
@@ -35,7 +35,7 @@ class WebSocketAPI {
             },
             /**
              * Array of subscriptions.
-             * @type {Array<subscription>}
+             * @type {Array<WebSocketSubscription>}
              * @private
              */
             subscriptions: {
@@ -44,7 +44,7 @@ class WebSocketAPI {
             },
             /**
              * List of channels subscribed.
-             * @type {Array<subscription>}
+             * @type {WebSocketSubscribed}
              * @private
              */
             subscribed: {
@@ -57,14 +57,14 @@ class WebSocketAPI {
      * Get the websocket request string.
      *
      * @param {string} method Request mehtod {GET, SUB}.
-     * @param {Object} params Request parameters.
+     * @param {WebSocketParameters} params Request parameters.
      * @param {string} params.channel Channel name
      * @param {string} [params.args] Request arguments
-     * @param {Number} [params.id] Request identifier
+     * @param {Number|string} [params.id] Request identifier
      * @return {string} request string
      * @private
      */
-    static getRequestString(method, params) {
+    static getRequestString(method, params = {}) {
         let reqStr = `${method} ${params.channel}`;
         reqStr += params.args ? ` ${params.args}` : '';
         reqStr += params.id ? ` ${params.id}` : '';
@@ -73,7 +73,7 @@ class WebSocketAPI {
     /**
      * (Re)connect the websocket.
      *
-     * @param {strin} url Websocket url.
+     * @param {string} url Websocket url.
      * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
      * @private
      */
@@ -103,7 +103,7 @@ class WebSocketAPI {
         if (this.websocket) {
             this.websocket.onclose = null;
             this.websocket.close();
-            this.websocket = null;
+            this.websocket = undefined;
             this.messagesOnOpen = [];
         }
     }
@@ -118,7 +118,8 @@ class WebSocketAPI {
             return;
         }
         const send = () => {
-            this.websocket.send(message);
+            var _a;
+            (_a = this.websocket) === null || _a === void 0 ? void 0 : _a.send(message);
         };
         if (!this.open) {
             // This 'if' avoid sending 2 identical BBOX message on open,
@@ -158,7 +159,7 @@ class WebSocketAPI {
     /**
      * Listen to websocket messages.
      *
-     * @param {Object} params Parameters for the websocket get request
+     * @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
@@ -166,21 +167,29 @@ class WebSocketAPI {
      */
     listen(params, cb, errorCb) {
         // Remove the previous identical callback
-        this.unlisten(params, cb, errorCb);
+        this.unlisten(params, cb);
         // We wrap the message callback to be sure we only propagate the message if it is for the right channel.
         const onMessage = (evt) => {
-            let data = {};
+            let data;
             try {
                 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;
             }
             let source = params.channel;
             source += params.args ? ` ${params.args}` : '';
             // Buffer channel message return a list of other channels to propagate to proper callbacks.
-            const contents = data.source === 'buffer' ? data.content : [data];
+            let contents;
+            if (data.source === 'buffer') {
+                contents = data
+                    .content;
+            }
+            else {
+                contents = [data];
+            }
             contents.forEach((content) => {
                 // Because of backend optimization, the last content is null.
                 if ((content === null || content === void 0 ? void 0 : content.source) === source &&
@@ -219,14 +228,17 @@ 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) => (...args) => {
+        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), once(errorCb));
+        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 = [];

package/common/controls/{Control.d.ts → ControlCommon.d.ts}

@@ -1,4 +1,11 @@
-export default Control;
+import BaseObject from 'ol/Object';
+import { AnyMap } from '../../types';
+export declare type ControlCommonOptions = {
+    active?: Boolean;
+    element?: HTMLElement;
+    target?: HTMLElement;
+    render?: () => void;
+};
 /**
  * A class representing a control to display on map.
  *
@@ -10,7 +17,11 @@ export default Control;
  * @classproperty {HTMLElement} element - The HTML element used to render the control.
  * @classproperty {HTMLElement} target - The HTML element where to render the element property. Default is the map's element. Read only.
  */
-declare class Control extends BaseObject {
+declare class ControlCommon extends BaseObject {
+    active: Boolean;
+    map?: AnyMap;
+    target?: HTMLElement;
+    element?: HTMLElement;
     /**
      * Constructor
      *
@@ -20,27 +31,18 @@ declare class Control extends BaseObject {
      * @param {HTMLElement} [options.target] The HTML element where to render the element property. Default is the map's element.
      * @param {function} [options.render] Render function called whenever the control needs to be rerendered.
      */
-    constructor(options?: {
-        active?: boolean | undefined;
-        element?: HTMLElement | undefined;
-        target?: HTMLElement | undefined;
-        render?: Function | undefined;
-    } | undefined);
-    /**
-     * @ignore
-     */
-    active: boolean;
+    constructor(options?: ControlCommonOptions);
     /**
      * Define control's properties.
      *
      * @private
+     * @ignore
      */
-    private defineProperties;
+    defineProperties(options: ControlCommonOptions): void;
     /**
      * Attach the control to the map. Add events, html element ...
      */
-    attachToMap(map: any): void;
-    map: any;
+    attachToMap(map: AnyMap): void;
     /**
      * Detach the control From the map. Remove events, html element ..
      */
@@ -61,14 +63,14 @@ declare class Control extends BaseObject {
      *
      * @private
      */
-    private render;
+    render(options?: any): void;
     /**
      * The default element to display if this.element is not defined.
      * To be defined in inherited classes.
      *
      * @private
      */
-    private createDefaultElement;
+    createDefaultElement(): void;
 }
-import BaseObject from "ol/Object";
-//# sourceMappingURL=Control.d.ts.map
+export default ControlCommon;
+//# sourceMappingURL=ControlCommon.d.ts.map

package/common/controls/ControlCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ControlCommon.d.ts","sourceRoot":"","sources":["../../../src/common/controls/ControlCommon.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,oBAAY,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,cAAM,aAAc,SAAQ,UAAU;IACpC,MAAM,EAAE,OAAO,CAAC;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;;;;;;;OAQG;gBACS,OAAO,GAAE,oBAAyB;IAe9C;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,oBAAoB;IAuE9C;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB;;OAEG;IACH,aAAa;IAIb;;;OAGG;IACH,QAAQ;IAIR;;;OAGG;IAEH,UAAU;IAKV;;;;;OAKG;IAEH,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG;IAKpB;;;;;OAKG;IAEH,oBAAoB;CAIrB;AAED,eAAe,aAAa,CAAC"}

package/common/controls/{Control.js → ControlCommon.js}

@@ -10,7 +10,7 @@ import BaseObject from 'ol/Object';
  * @classproperty {HTMLElement} element - The HTML element used to render the control.
  * @classproperty {HTMLElement} target - The HTML element where to render the element property. Default is the map's element. Read only.
  */
-class Control extends BaseObject {
+class ControlCommon extends BaseObject {
     /**
      * Constructor
      *
@@ -33,6 +33,7 @@ class Control extends BaseObject {
      * Define control's properties.
      *
      * @private
+     * @ignore
      */
     defineProperties(options) {
         const { target, element, render } = Object.assign({}, options);
@@ -63,8 +64,10 @@ class Control extends BaseObject {
                     if (this.map) {
                         // Add new node
                         const targett = this.target ||
-                            (this.map.getTargetElement && this.map.getTargetElement()) ||
-                            (this.map.getContainer && this.map.getContainer());
+                            (this.map.getTargetElement &&
+                                this.map.getTargetElement()) ||
+                            (this.map.getContainer &&
+                                this.map.getContainer());
                         if (!this.element) {
                             this.createDefaultElement();
                         }
@@ -103,7 +106,7 @@ class Control extends BaseObject {
      * Detach the control From the map. Remove events, html element ..
      */
     detachFromMap() {
-        this.map = null;
+        this.map = undefined;
     }
     /**
      * Add listeners then renders the control.
@@ -117,14 +120,21 @@ class Control extends BaseObject {
      * To be defined in inherited classes.
      */
     // eslint-disable-next-line class-methods-use-this
-    deactivate() { }
+    deactivate() {
+        // eslint-disable-next-line no-console
+        console.error('This function must be implemented in subclasses');
+    }
     /**
      * The default render function. It renders content in the HTML element.
      * To be defined in inherited classes.
      *
      * @private
      */
-    render() { }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    render(options) {
+        // eslint-disable-next-line no-console
+        console.error('This function must be implemented in subclasses');
+    }
     /**
      * The default element to display if this.element is not defined.
      * To be defined in inherited classes.
@@ -132,6 +142,9 @@ class Control extends BaseObject {
      * @private
      */
     // eslint-disable-next-line class-methods-use-this
-    createDefaultElement() { }
+    createDefaultElement() {
+        // eslint-disable-next-line no-console
+        console.error('This function must be implemented in subclasses');
+    }
 }
-export default Control;
+export default ControlCommon;

package/common/controls/CopyrightControlCommon.d.ts

@@ -0,0 +1,13 @@
+import ControlCommon from './ControlCommon';
+/**
+ * A class representing a copyright control to display on map.
+ * This class only draw an html element, with an empty string in it.
+ * Use subclasses to use it in an ol or mapbox map.
+ */
+declare class CopyrightControlCommon extends ControlCommon {
+    render(): void;
+    createDefaultElement(): void;
+    getCopyrights(): string[];
+}
+export default CopyrightControlCommon;
+//# sourceMappingURL=CopyrightControlCommon.d.ts.map

package/common/controls/CopyrightControlCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CopyrightControlCommon.d.ts","sourceRoot":"","sources":["../../../src/common/controls/CopyrightControlCommon.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,cAAM,sBAAuB,SAAQ,aAAa;IAChD,MAAM;IASN,oBAAoB;IAYpB,aAAa;CAQd;AAED,eAAe,sBAAsB,CAAC"}