mobility-toolbox-js 3.0.0-beta.1 → 3.0.0-beta.11

package/api/RoutingAPI.d.ts

@@ -0,0 +1,37 @@
+import HttpAPI from './HttpAPI';
+import { RoutingParameters, RoutingResponse } from '../types';
+export type RoutingAPIOptions = {
+    url?: string;
+    apiKey?: string;
+};
+/**
+ * This class provides convenience methods to use to the [geOps Routing API](https://developer.geops.io/apis/routing).
+ *
+ * @example
+ * import { RoutingAPI } from 'mobility-toolbox-js';
+ *
+ * const api = new RoutingAPI({
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * @public
+ */
+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?: RoutingAPIOptions);
+    /**
+     * 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;

package/api/RoutingAPI.js

@@ -1,6 +1,6 @@
 import HttpAPI from './HttpAPI';
 /**
- * Access to the [geOps Routing API](https://developer.geops.io/apis/routing).
+ * This class provides convenience methods to use to the [geOps Routing API](https://developer.geops.io/apis/routing).
  *
  * @example
  * import { RoutingAPI } from 'mobility-toolbox-js';

package/api/StopsAPI.d.ts

@@ -0,0 +1,44 @@
+import HttpAPI from './HttpAPI';
+import { StopsParameters, StopsResponse } from '../types';
+export type StopsAPIOptions = {
+    url?: string;
+    apiKey?: string;
+};
+/**
+ * This class provides convenience methods to use to the [geOps Stops API](https://developer.geops.io/apis/stops/).
+ *
+ * @example
+ * import { StopsAPI } from 'mobility-toolbox-js/api';
+ *
+ * const api = new StopsAPI({
+ *   apiKey: [yourApiKey],
+ *   // url: 'https://api.geops.io/stops/v1/',
+ * });
+ *
+ * const stops = await api.search({ q:"Bern" });
+ *
+ * console.log('Log stops:', JSON.stringify(stops));
+ *
+ * @public
+ */
+declare class StopsAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {Object} options Options.
+     * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] Url of the [geOps stops API](https://developer.geops.io/apis/stops/).
+     * @public
+     */
+    constructor(options?: StopsAPIOptions);
+    /**
+     * Search fo stops.
+     *
+     * @param {StopsAPIParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @param {FetchOptions} config Options for the fetch request.
+     * @returns {Promise<StopsAPIResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326). See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @public
+     */
+    search(params: StopsParameters, config: RequestInit): Promise<StopsResponse>;
+}
+export default StopsAPI;

package/api/StopsAPI.js

@@ -1,24 +1,29 @@
 import HttpAPI from './HttpAPI';
 /**
- * Access to the [geOps Stops api](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+ * This class provides convenience methods to use to the [geOps Stops API](https://developer.geops.io/apis/stops/).
  *
  * @example
  * import { StopsAPI } from 'mobility-toolbox-js/api';
  *
  * const api = new StopsAPI({
- *   url: 'https://api.geops.io/stops/v1/',
- *   apiKey: [yourApiKey]
+ *   apiKey: [yourApiKey],
+ *   // url: 'https://api.geops.io/stops/v1/',
  * });
  *
+ * const stops = await api.search({ q:"Bern" });
+ *
+ * console.log('Log stops:', JSON.stringify(stops));
+ *
  * @public
  */
 class StopsAPI extends HttpAPI {
     /**
      * Constructor
      *
-     * @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/).
+     * @param {Object} options Options.
+     * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] Url of the [geOps stops API](https://developer.geops.io/apis/stops/).
+     * @public
      */
     constructor(options = {}) {
         super(Object.assign({ url: 'https://api.geops.io/stops/v1/' }, options));
@@ -26,9 +31,10 @@ class StopsAPI extends HttpAPI {
     /**
      * Search fo stops.
      *
-     * @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).
+     * @param {StopsAPIParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @param {FetchOptions} config Options for the fetch request.
+     * @returns {Promise<StopsAPIResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326). See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @public
      */
     search(params, config) {
         return this.fetch('', params, config);

package/api/WebSocketAPI.d.ts

@@ -0,0 +1,153 @@
+import { RealtimeTrajectoryResponse } from '../types';
+export declare type WebSocketAPIParameters = {
+    channel?: string;
+    args?: string | number;
+    id?: string | number;
+};
+export declare type WebSocketAPIMessageEventData<T> = {
+    timestamp: number;
+    source: string;
+    content: T;
+    client_reference: string | number | null;
+};
+export type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]> & {
+    source: 'buffer';
+};
+export 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 WebSocketAPIMessageCallback<T> {
+    (data: WebSocketAPIMessageEventData<T>): void;
+}
+export declare type WebSocketAPISubscription = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIMessageCallback<any>;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    quiet: boolean;
+};
+export declare type WebSocketAPISubscribed = {
+    [index: string]: boolean;
+};
+export declare type WebSocketAPIRequest = {
+    params: WebSocketAPIParameters;
+    cb: WebSocketAPIMessageCallback<any>;
+    errorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    onErrorCb?: EventListener;
+    requestString: String;
+};
+/**
+ * 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.
+ * @private
+ */
+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 {WebSocketParameters} params Request parameters.
+     * @param {string} params.channel Channel name
+     * @param {string} [params.args] Request arguments
+     * @param {Number|string} [params.id] Request identifier
+     * @return {string} request string
+     * @private
+     */
+    static getRequestString(method: string, params?: WebSocketAPIParameters): string;
+    /**
+     * (Re)connect the websocket.
+     *
+     * @param {string} url Websocket url.
+     * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
+     * @private
+     */
+    connect(url: string, onOpen?: () => void): void;
+    /**
+     * Close the websocket definitively.
+     *
+     * @private
+     */
+    close(): void;
+    /**
+     * Sends a message to the websocket.
+     *
+     * @param {message} message Message to send.
+     * @private
+     */
+    send(message: string): void;
+    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    /**
+     * Listen to websocket messages.
+     *
+     * @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
+     */
+    listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
+        onMessageCb: WebSocketAPIMessageEventListener;
+        onErrorCb?: EventListener;
+    };
+    /**
+     * Unlisten websocket messages.
+     *
+     * @param {Object} params Parameters for the websocket get request.
+     * @param {function} cb Callback used when listen.
+     * @private
+     */
+    unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>): 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.
+     *
+     * @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
+     * @private
+     */
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
+    /**
+     * 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
+     */
+    subscribe(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, 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
+     */
+    unsubscribe(source: string, cb?: WebSocketAPIMessageCallback<any>): void;
+    /**
+     * After an auto reconnection we need to re-subscribe to the channels.
+     */
+    subscribePreviousSubscriptions(): void;
+}
+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/typedefs.d.ts

@@ -0,0 +1,178 @@
+export default dummy;
+export 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;
+};
+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[];
+};
+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;

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 = StopsAPIOptions & {
+    element: HTMLElement;
+    placeholder?: string;
+    apiParams: StopsParameters;
+    onSuggestionClick?: (suggestion: Feature, evt: MouseEvent) => void;
+};
+/**
+ * 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 {
+    apiParams: StopsParameters;
+    placeholder: string;
+    api: StopsAPI;
+    abortController?: AbortController;
+    suggestionsElt?: HTMLElement;
+    inputElt?: HTMLInputElement;
+    clearElt?: HTMLDivElement;
+    options?: StopFinderControlCommonOptions;
+    /**
+     * 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/tracker/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);
+    render(featureCollection?: FeatureCollection): void;
+    createElement({ element }: StopFinderControlCommonOptions): void;
+    /**
+     * Clear the search field and close the control.
+     */
+    clear(): void;
+    /**
+     * Launch a search.
+     *
+     * @param {String} query 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;

package/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./utils";
+export * from "./styles";