mobility-toolbox-js 2.0.0-beta.32 → 2.0.0-beta.33

package/api/RealtimeAPI.d.ts

@@ -0,0 +1,268 @@
+/**
+ * Enum for Realtime modes.
+ */
+export type RealtimeModes = RealtimeMode;
+export namespace RealtimeModes {
+    const RAW: string;
+    const TOPOGRAPHIC: string;
+    const SCHEMATIC: string;
+}
+export default RealtimeAPI;
+/**
+ * Enum for Realtime modes.
+ */
+export type RealtimeMode = string;
+/**
+ * This class provides convenience methods to access to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
+ *
+ * @example
+ * import { RealtimeAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new RealtimeAPI({
+ *   url: "yourUrl",
+ *   apiKey: "yourApiKey"
+ * });
+ *
+ * @example
+ * import { RealtimeAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new RealtimeAPI("yourUrl");
+ */
+declare class RealtimeAPI {
+    /**
+     * Constructor
+     *
+     * @param {Object|string} options A string representing the url of the service or an object containing the url and the apiKey.
+     * @param {string} options.url Url to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
+     * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {string} [options.prefix=''] Service prefix to specify tenant.
+     * @param {string} [options.projection] The epsg code of the projection for features. Default to EPSG:3857.
+     * @param {number[4]} [options.bbox=[minX, minY, maxX, maxY, zoom, tenant] The bounding box to receive data from.
+     */
+    constructor(options?: any | string);
+    /** @ignore */
+    subscribedStationUic: number;
+    /** @ignore */
+    departureUpdateTimeout: number;
+    /** @ignore */
+    maxDepartureAge: number;
+    /** @ignore */
+    extraGeoms: {};
+    /** @ignore */
+    prefix: any;
+    /**
+     * Callback when the websocket is opened and ready.
+     * It applies the bbox and the projection.
+     */
+    onOpen(): void;
+    defineProperties(options: any): void;
+    open(): void;
+    /**
+     * Close the websocket connection without reconnection.
+     */
+    close(): void;
+    /**
+     * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
+     */
+    reset(): void;
+    /** @ignore */
+    pingInterval: NodeJS.Timer;
+    /**
+     * Callback when the websocket is closed by the server.
+     * It auto reconnects after a timeout.
+     */
+    onClose(): void;
+    /** @ignore */
+    reconnectTimeout: number;
+    /**
+     * Subscribe to a channel.
+     *
+     * @param {string} channel Name of the websocket channel to subscribe.
+     * @param {function} onSuccess Callback when the subscription succeeds.
+     * @param {function} onError Callback when the subscription fails.
+     * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
+     * @private
+     */
+    private subscribe;
+    /**
+     * Unsubscribe both modes of a channel.
+     *
+     * @param {string} channel Name of the websocket channel to unsubscribe.
+     * @param {string} suffix Suffix to add to the channel name.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @private
+     */
+    private unsubscribe;
+    /**
+     * Filter departures and return an array.
+     *
+     * @param {Object} depObject The object containing departures by id.
+     * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
+     * @return {Array<departure>} Return departures array.
+     * @private
+     */
+    private filterDepartures;
+    /**
+     * Subscribe to departures channel of a given station.
+     *
+     * @param {number} stationId UIC of the station.
+     * @param {Boolean} sortByMinArrivalTime Sort by minimum arrival time
+     * @param {function(departures:Departure[])} onMessage Function called on each message of the channel.
+     */
+    subscribeDepartures(stationId: number, sortByMinArrivalTime: boolean, onMessage: (arg0: departures, arg1: Departure[]) => any): void;
+    /**
+     * Unsubscribe from current departures channel.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDepartures(cb: Function): void;
+    /**
+     * Subscribe to the disruptions channel for tenant.
+     *
+     * @param {function} onMessage Function called on each message of the channel.
+     */
+    subscribeDisruptions(onMessage: Function): void;
+    /**
+     * Unsubscribe disruptions.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDisruptions(cb: Function): void;
+    /**
+     * Return a station with a given uic number and a mode.
+     *
+     * @param {number} uic UIC of the station.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<Station>} A station.
+     */
+    getStation(uic: number, mode: RealtimeMode): Promise<Station>;
+    /**
+     * Update the model's station list for a given mode and a bbox.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @return {Promise<Array<Station>>} An array of stations.
+     */
+    getStations(mode: RealtimeMode): Promise<Array<Station>>;
+    /** @ignore */
+    stationUpdateTimeout: number;
+    /**
+     * Subscribe to stations channel.
+     * One message pro station.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {function(station: Station)} onMessage Function called on each message of the channel.
+     */
+    subscribeStations(mode: RealtimeMode, onMessage: (arg0: station, arg1: Station) => any): void;
+    /**
+     * Unsubscribe to stations channel.
+     * @param {function} cb The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
+     */
+    unsubscribeStations(cb: Function): void;
+    /**
+     * Subscribe to extra_geoms channel.
+     *
+     * @param {function(extraGeoms: GeosJSONFeature[])} onMessage Function called on each message of the channel.
+     */
+    subscribeExtraGeoms(onMessage: (arg0: extraGeoms, arg1: GeosJSONFeature[]) => any): void;
+    /**
+     * Unsubscribe to extra_geoms channel.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeExtraGeoms(cb: Function): void;
+    /**
+     * Subscribe to trajectory channel.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {function(trajectory: RealtimeTrajectory)} onMessage Function called on each message of the channel.
+     * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
+     */
+    subscribeTrajectory(mode: RealtimeMode, onMessage: (arg0: trajectory, arg1: RealtimeTrajectory) => any, quiet?: boolean): void;
+    /**
+     * Unsubscribe to trajectory channels.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeTrajectory(cb: Function): void;
+    /**
+     * Subscribe to deleted_vhicles channel.
+     *
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {function(response: { content: Vehicle })} onMessage Function called on each message of the channel.
+     * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
+     */
+    subscribeDeletedVehicles(mode: RealtimeMode, onMessage: (arg0: response, arg1: {
+        content: Vehicle;
+    }) => any, quiet?: boolean): void;
+    /**
+     * Unsubscribe to deleted_vhicles channels.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeDeletedVehicles(cb: Function): void;
+    /**
+     * Get a full trajectory of a vehicule .
+     *
+     * @param {string} id A vehicle id.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
+     * @return {Promise<FullTrajectory>} Return a full trajectory.
+     */
+    getFullTrajectory(id: string, mode: RealtimeMode, generalizationLevel: string): Promise<FullTrajectory>;
+    /**
+     * Get full trajectories of a vehicules .
+     *
+     * @param {string[]} ids List of vehicles ids.
+     * @param {RealtimeMode} mode Realtime mode.
+     * @param {string} generalizationLevel The generalization level to request. Can be one of '', 'gen5', 'gen10', 'gen30', 'gen100'.
+     * @return {Promise<Array<FullTrajectory>>} Return an array of full trajectories.
+     */
+    getFullTrajectories(ids: string[], mode: RealtimeMode, generalizationLevel: string): Promise<Array<FullTrajectory>>;
+    /**
+     * Subscribe to full_trajectory channel of a given vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @param {RealtimeMode} mode Realtime mode.
+     */
+    subscribeFullTrajectory(id: string, mode: RealtimeMode): void;
+    /**
+     * Unsubscribe from full_trajectory channel
+     *
+     * @param {string} id A vehicle id.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeFullTrajectory(id: string, cb: Function): void;
+    /**
+     * Get the list of stops for this vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @return {Promise<StopSequence>} Returns a stop sequence object.
+     */
+    getStopSequence(id: string): Promise<StopSequence>;
+    /**
+     * Get a list of stops for a list of vehicles.
+     *
+     * @param {string[]} ids List of vehicles ids.
+     * @return {Promise<Array<StopSequence>>} Return an array of stop sequences.
+     */
+    getStopSequences(ids: string[]): Promise<Array<StopSequence>>;
+    /**
+     * Subscribe to stopsequence channel of a given vehicle.
+     *
+     * @param {string} id A vehicle id.
+     * @param {function(stopSequence: StopSequence)} onMessage Function called on each message of the channel.
+     */
+    subscribeStopSequence(id: string, onMessage: (arg0: stopSequence, arg1: StopSequence) => any): void;
+    /**
+     * Unsubscribe from stopsequence channel
+     *
+     * @param {string} id A vehicle id.
+     * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     */
+    unsubscribeStopSequence(id: string, cb: Function): void;
+    /**
+     * Subscribe to healthcheck channel.
+     * @param {function} onMessage Callback when the subscribe to healthcheck channel succeeds.
+     */
+    subscribeHealthCheck(onMessage: Function): void;
+    /**
+     * Unsubscribe to healthcheck channel.
+     */
+    unsubscribeHealthCheck(): void;
+}
+//# sourceMappingURL=RealtimeAPI.d.ts.map

package/api/RealtimeAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RealtimeAPI.d.ts","sourceRoot":"","sources":["../../src/api/RealtimeAPI.js"],"names":[],"mappings":";;;4BAYU,YAAY;;;;;;;;;;2BAJT,MAAM;AAYnB;;;;;;;;;;;;;;;GAeG;AACH;IACE;;;;;;;;;OASG;IACH,sBAPW,MAAO,MAAM,EA2BvB;IAjBC,cAAc;IACd,6BAAgC;IAEhC,cAAc;IACd,+BAAkC;IAElC,cAAc;IACd,wBAAyB;IAEzB,cAAc;IACd,eAAoB;IAEpB,cAAc;IACd,YAAkC;IAsHpC;;;OAGG;IACH,eAuBC;IA3ID,qCAoFC;IAED,aASC;IAED;;OAEG;IACH,cAEC;IAED;;OAEG;IAEH,cAEC;IAwBG,cAAc;IACd,2BAEuB;IAI3B;;;OAGG;IACH,gBAWC;IANG,cAAc;IACd,yBAGC;IAIL;;;;;;;;OAQG;IACH,kBAEC;IAED;;;;;;;OAOG;IACH,oBAcC;IAED;;;;;;;OAOG;IACH,yBAsDC;IAED;;;;;;OAMG;IACH,+BAJW,MAAM,qEAEc,SAAS,EAAE,gBA+BzC;IAED;;;OAGG;IACH,0CAKC;IAED;;;;OAIG;IACH,gDAIC;IAED;;;OAGG;IACH,2CAEC;IAED;;;;;;OAMG;IACH,gBAJW,MAAM,QACN,YAAY,GACX,QAAQ,OAAO,CAAC,CAiB3B;IAED;;;;;OAKG;IACH,kBAHW,YAAY,GACX,QAAQ,MAAM,OAAO,CAAC,CAAC,CAsBlC;IATO,cAAc;IACd,6BAEM;IAQd;;;;;;OAMG;IACH,wBAHW,YAAY,mCACM,OAAO,gBASnC;IAED;;;OAGG;IACH,wCAGC;IAED;;;;OAIG;IACH,wDAFgC,iBAAiB,gBAoBhD;IAED;;;OAGG;IACH,0CAEC;IAED;;;;;;OAMG;IACH,0BAJW,YAAY,sCACS,kBAAkB,kBACvC,OAAO,QAUjB;IAED;;;OAGG;IACH,0CAEC;IAED;;;;;;OAMG;IACH,+BAJW,YAAY,oCACO;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,kBACvC,OAAO,QAUjB;IAED;;;OAGG;IACH,+CAEC;IAED;;;;;;;OAOG;IACH,sBALW,MAAM,QACN,YAAY,uBACZ,MAAM,GACL,QAAQ,cAAc,CAAC,CAuBlC;IAED;;;;;;;OAOG;IACH,yBALW,MAAM,EAAE,QACR,YAAY,uBACZ,MAAM,GACL,QAAQ,MAAM,cAAc,CAAC,CAAC,CAOzC;IAED;;;;;OAKG;IACH,4BAHW,MAAM,QACN,YAAY,QAgBtB;IAED;;;;;OAKG;IACH,8BAHW,MAAM,sBAKhB;IAED;;;;;OAKG;IACH,oBAHW,MAAM,GACL,QAAQ,YAAY,CAAC,CAyBhC;IAED;;;;;OAKG;IACH,sBAHW,MAAM,EAAE,GACP,QAAQ,MAAM,YAAY,CAAC,CAAC,CAKvC;IAED;;;;;OAKG;IACH,0BAHW,MAAM,wCACiB,YAAY,gBAuB7C;IAED;;;;;OAKG;IACH,4BAHW,MAAM,sBAKhB;IAED;;;OAGG;IACH,gDAGC;IAED;;OAEG;IACH,+BAEC;CACF"}

package/api/RoutingAPI.d.ts

@@ -0,0 +1,33 @@
+import HttpAPI, { HttpApiOptions } from '../common/api/HttpAPI';
+import { RoutingParameters, RoutingResponse } from '../../types';
+/**
+ * Access to the [geOps Routing service](https://developer.geops.io/apis/routing).
+ *
+ * @example
+ * import { RoutingAPI } from 'mobility-toolbox-js';
+ *
+ * const api = new RoutingAPI({
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ */
+declare class RoutingAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {RoutingAPIOptions} options Options.
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+     */
+    constructor(options: HttpApiOptions);
+    /**
+     * Route.
+     *
+     * @param {RoutingParameters} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
+     * @param {RequestInit} config Options for the fetch request.
+     * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    route(params: RoutingParameters, config: RequestInit): Promise<RoutingResponse>;
+}
+export default RoutingAPI;
+//# sourceMappingURL=RoutingAPI.d.ts.map

package/api/RoutingAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoutingAPI.d.ts","sourceRoot":"","sources":["../../src/api/RoutingAPI.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,cAAM,UAAW,SAAQ,OAAO;IAC9B;;;;;;OAMG;gBACS,OAAO,EAAE,cAAc;IAOnC;;;;;;OAMG;IACH,KAAK,CACH,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,eAAe,CAAC;CAG5B;AAED,eAAe,UAAU,CAAC"}

package/api/StopsAPI.d.ts

@@ -0,0 +1,36 @@
+export default StopsAPI;
+/**
+ * Access to the [Stops service](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+ *
+ * @example
+ * import { StopsAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new StopsAPI({
+ *   url: 'https://api.geops.io/stops/v1/',
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ */
+declare class StopsAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {Object} 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/).
+     */
+    constructor(options?: {
+        url?: string;
+        apiKey: string;
+    });
+    /**
+     * Search.
+     *
+     * @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).
+     */
+    search(params: StopsSearchParams, abortController?: AbortController): Promise<GeoJSONFeatureCollection>;
+}
+import HttpAPI from "../common/api/HttpAPI";
+//# sourceMappingURL=StopsAPI.d.ts.map

package/api/StopsAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StopsAPI.d.ts","sourceRoot":"","sources":["../../src/api/StopsAPI.js"],"names":[],"mappings":";AAEA;;;;;;;;;;;GAWG;AACH;IACE;;;;;;OAMG;IACH;QAH4B,GAAG,GAApB,MAAM;QACU,MAAM,EAAtB,MAAM;OAIhB;IAED;;;;;;OAMG;IACH,oDAHW,eAAe,GACd,iCAAiC,CAM5C;CACF"}

package/api/index.d.ts

@@ -0,0 +1,5 @@
+declare module '.';
+export { default as RoutingAPI } from './RoutingAPI';
+export { default as StopsAPI } from './StopsAPI';
+export { default as RealtimeAPI, RealtimeModes } from './RealtimeAPI';
+//# sourceMappingURL=index.d.ts.map

package/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,GAAG,CAAC;AAEnB,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC"}

package/api/typedefs.d.ts

@@ -0,0 +1,105 @@
+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;
+};
+type Station = GeoJSONFeature;
+type StationProperties = {
+    transfers: Transfer[];
+    elevatorOutOfOrder: boolean;
+    uic: number;
+    name: string;
+    networkLines: NetworkLine[];
+    hasElevator: boolean;
+    hasZOB: boolean;
+    hasAccessibility: boolean;
+    type: string;
+};
+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;
+};
+type Transfer = {
+    /**
+     * Mode of transportation (ex: U-Bahn).
+     */
+    mot: string;
+    /**
+     * Array of lines name (ex: ["U4", "U5"]).
+     */
+    lines: string[];
+};
+type StopSequence = GeoJSONFeature;
+type RealtimeTrajectory = GeoJSONFeature;
+type FullTrajectory = GeoJSONFeature;
+type Vehicle = GeoJSONFeature;
+type ExtraGeom = GeoJSONFeature;
+//# sourceMappingURL=typedefs.d.ts.map

package/api/typedefs.d.ts.map

@@ -0,0 +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"}

package/common/api/HttpAPI.d.ts

@@ -0,0 +1,31 @@
+import BaseObject from 'ol/Object';
+export declare 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.
+     * @ignore
+     */
+    fetch(path: string, params: Object, config: RequestInit): Promise<any>;
+}
+export default HttpAPI;
+//# sourceMappingURL=HttpAPI.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HttpAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/HttpAPI.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,WAAW,CAAC;AAGnC,oBAAY,cAAc,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF;;;;;;;;;;;;;GAaG;AACH,cAAM,OAAQ,SAAQ,UAAU;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,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;CA6BvE;AAED,eAAe,OAAO,CAAC"}

package/common/api/WebSocketAPI.d.ts

@@ -0,0 +1,95 @@
+export default WebSocketAPI;
+/**
+ * Class used to facilitate connection to a WebSocket and
+ * also to manage properly messages send to the WebSocket.
+ * This class must not contain any specific implementation.
+ */
+declare class WebSocketAPI {
+    /**
+     * Get the websocket request string.
+     *
+     * @param {string} method Request mehtod {GET, SUB}.
+     * @param {Object} params Request parameters.
+     * @param {string} params.channel Channel name
+     * @param {string} [params.args] Request arguments
+     * @param {Number} [params.id] Request identifier
+     * @return {string} request string
+     * @private
+     */
+    private static getRequestString;
+    defineProperties(): void;
+    /**
+     * (Re)connect the websocket.
+     *
+     * @param {strin} 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;
+    /**
+     * Close the websocket definitively.
+     *
+     * @private
+     */
+    private close;
+    messagesOnOpen: any[];
+    /**
+     * Sends a message to the websocket.
+     *
+     * @param {message} message Message to send.
+     * @private
+     */
+    private send;
+    /**
+     * Listen to websocket messages.
+     *
+     * @param {Object} 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;
+    /**
+     * Unlisten websocket messages.
+     *
+     * @param {Object} params Parameters for the websocket get request.
+     * @param {function} cb Callback used when listen.
+     * @private
+     */
+    private unlisten;
+    /**
+     * Sends a get request to the websocket.
+     *
+     * @param {Object} params Parameters for the websocket get request
+     * @param {function} cb callback on listen
+     * @param {function} errorCb Callback on error
+     * @private
+     */
+    private get;
+    /**
+     * 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
+     */
+    private subscribe;
+    /**
+     * 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;
+    /**
+     * After an auto reconnection we need to re-subscribe to the channels.
+     */
+    subscribePreviousSubscriptions(): void;
+}
+//# sourceMappingURL=WebSocketAPI.d.ts.map

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

@@ -0,0 +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,qBAAmC;IAarC;;;;OAIG;IACH,cAOC;IAFG,sBAAwB;IAI5B;;;;;OAKG;IACH,aAsBC;IAED;;;;;;;;OAQG;IACH,eAsCC;IAED;;;;;;OAMG;IACH,iBAiBC;IAED;;;;;;;OAOG;IACH,YAIC;IAED;;;;;;;;OAQG;IACH,kBAqBC;IAED;;;;;OAKG;IACH,oBA8BC;IAfC,mBAEC;IAeH;;OAEG;IACH,uCAYC;CACF"}

package/common/controls/Control.d.ts

@@ -0,0 +1,74 @@
+export default Control;
+/**
+ * A class representing a control to display on map.
+ *
+ * @example
+ * const control = new Control();
+ *
+ * @classproperty {ol/Map~Map|mapboxgl.Map} map - The map which the control refers to.
+ * @classproperty {boolean} active - Active the 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 {
+    /**
+     * Constructor
+     *
+     * @param {Object} [options] Control options.
+     * @param {boolean} [options.active = true] Whether the control is active or not.
+     * @param {HTMLElement} [options.element] The HTML element used to render the control.
+     * @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;
+        element?: HTMLElement;
+        target?: HTMLElement;
+        render?: Function;
+    });
+    /**
+     * @ignore
+     */
+    active: boolean;
+    /**
+     * Define control's properties.
+     *
+     * @private
+     */
+    private defineProperties;
+    /**
+     * Attach the control to the map. Add events, html element ...
+     */
+    attachToMap(map: any): void;
+    map: any;
+    /**
+     * Detach the control From the map. Remove events, html element ..
+     */
+    detachFromMap(): void;
+    /**
+     * Add listeners then renders the control.
+     * To be defined in inherited classes.
+     */
+    activate(): void;
+    /**
+     * Remove listeners added by activate() function then renders the control.
+     * To be defined in inherited classes.
+     */
+    deactivate(): void;
+    /**
+     * The default render function. It renders content in the HTML element.
+     * To be defined in inherited classes.
+     *
+     * @private
+     */
+    private render;
+    /**
+     * The default element to display if this.element is not defined.
+     * To be defined in inherited classes.
+     *
+     * @private
+     */
+    private createDefaultElement;
+}
+import BaseObject from "ol/Object";
+//# sourceMappingURL=Control.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Control.d.ts","sourceRoot":"","sources":["../../../src/common/controls/Control.js"],"names":[],"mappings":";AAEA;;;;;;;;;;GAUG;AACH;IACE;;;;;;;;OAQG;IACH;QAL6B,MAAM,GAAxB,OAAO;QACe,OAAO,GAA7B,WAAW;QACW,MAAM,GAA5B,WAAW;QACQ,MAAM;OAenC;IAJC;;OAEG;IACH,gBAAoB;IAGtB;;;;OAIG;IACH,yBAmEC;IAED;;OAEG;IACH,4BAEC;IADC,SAAc;IAGhB;;OAEG;IACH,sBAEC;IAED;;;OAGG;IACH,iBAEC;IAED;;;OAGG;IAEH,mBAAe;IAEf;;;;;OAKG;IACH,eAAW;IAEX;;;;;OAKG;IAEH,6BAAyB;CAC1B"}