mobility-toolbox-js 3.0.0-beta.2 → 3.0.0-beta.21

package/api/RoutingAPI.d.ts

@@ -0,0 +1,47 @@
+import { RoutingParameters, RoutingResponse } from '../types';
+import HttpAPI from './HttpAPI';
+export interface RoutingAPIOptions {
+    apiKey?: string;
+    url?: 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],
+ *   // url: 'https://api.geops.io/routing/v1/',
+ * });
+ *
+ * const route = await api.route({
+ *   via: "freiburg|basel%20sbb|bern",
+ *   mot: "rail"
+ * });
+ *
+ * console.log('Log route:', JSON.stringify(route));
+ *
+ * @public
+ */
+declare class RoutingAPI extends HttpAPI {
+    /**
+     * Constructor
+     *
+     * @param {Object} options Options.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
+     * @public
+     */
+    constructor(options?: RoutingAPIOptions);
+    /**
+     * Calculate a route.
+     *
+     * @param {RoutingParameters} params Request parameters. See [geOps Routing API](https://developer.geops.io/apis/routing/).
+     * @param {FetchOptions} config Options for the fetch request.
+     * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     * @public
+     */
+    route(params: RoutingParameters, config: RequestInit): Promise<RoutingResponse>;
+}
+export default RoutingAPI;

package/api/RoutingAPI.js

@@ -1,33 +1,43 @@
 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';
  *
  * const api = new RoutingAPI({
- *   apiKey: [yourApiKey]
+ *   apiKey: [yourApiKey],
+ *   // url: 'https://api.geops.io/routing/v1/',
  * });
  *
+ * const route = await api.route({
+ *   via: "freiburg|basel%20sbb|bern",
+ *   mot: "rail"
+ * });
+ *
+ * console.log('Log route:', JSON.stringify(route));
+ *
  * @public
  */
 class RoutingAPI extends HttpAPI {
     /**
      * Constructor
      *
-     * @param {RoutingAPIOptions} options Options.
-     * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
+     * @param {Object} options Options.
      * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
+     * @public
      */
     constructor(options = {}) {
         super(Object.assign({ url: 'https://api.geops.io/routing/v1/' }, options));
     }
     /**
-     * Route.
+     * Calculate a route.
      *
-     * @param {RoutingParameters} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
-     * @param {RequestInit} config Options for the fetch request.
+     * @param {RoutingParameters} params Request parameters. See [geOps Routing API](https://developer.geops.io/apis/routing/).
+     * @param {FetchOptions} config Options for the fetch request.
      * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+     * @public
      */
     route(params, config) {
         return this.fetch('', params, config);

package/api/StopsAPI.d.ts

@@ -0,0 +1,44 @@
+import { StopsParameters, StopsResponse } from '../types';
+import HttpAPI from './HttpAPI';
+export interface StopsAPIOptions {
+    apiKey?: string;
+    url?: 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 for stops.
+     *
+     * @param {StopsParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @param {FetchOptions} config Options for the fetch request.
+     * @returns {Promise<StopsResponse>} 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,34 +1,40 @@
 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));
     }
     /**
-     * Search fo stops.
+     * Search for 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 {StopsParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @param {FetchOptions} config Options for the fetch request.
+     * @returns {Promise<StopsResponse>} 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,147 @@
+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>;
+    errorCb?: EventListener;
+    onErrorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    params: WebSocketAPIParameters;
+    quiet: boolean;
+}
+export type WebSocketAPISubscribed = Record<string, boolean>;
+export declare interface WebSocketAPIRequest {
+    cb: WebSocketAPIMessageCallback<any>;
+    errorCb?: EventListener;
+    onErrorCb?: EventListener;
+    onMessageCb: WebSocketAPIMessageEventListener;
+    params: WebSocketAPIParameters;
+    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 {
+    closed?: boolean;
+    closing?: boolean;
+    connecting?: boolean;
+    messagesOnOpen: string[];
+    open?: boolean;
+    requests: WebSocketAPIRequest[];
+    subscribed: WebSocketAPISubscribed;
+    subscriptions: WebSocketAPISubscription[];
+    websocket?: WebSocket;
+    constructor();
+    /**
+     * 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;
+    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    /**
+     * Close the websocket definitively.
+     *
+     * @private
+     */
+    close(): void;
+    /**
+     * (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;
+    defineProperties(): 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} cb callback on message event
+     * @param {function} errorCb Callback on error and close event
+     * @private
+     */
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: 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): {
+        onErrorCb?: EventListener;
+        onMessageCb: WebSocketAPIMessageEventListener;
+    };
+    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    /**
+     * Sends a message to the websocket.
+     *
+     * @param {message} message Message to send.
+     * @private
+     */
+    send(message: string): 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;
+    /**
+     * After an auto reconnection we need to re-subscribe to the channels.
+     */
+    subscribePreviousSubscriptions(): void;
+    /**
+     * 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;
+    /**
+     * 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;
+}
+export default WebSocketAPI;