mobility-toolbox-js 3.0.0-beta.9 → 3.0.0

package/api/RoutingAPI.d.ts

@@ -1,36 +1,46 @@
-import HttpAPI from './HttpAPI';
 import { RoutingParameters, RoutingResponse } from '../types';
-export type RoutingAPIOptions = {
-    url?: string;
+import HttpAPI from './HttpAPI';
+export interface RoutingAPIOptions {
     apiKey?: string;
-};
+    url?: string;
+}
 /**
- * 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
  */
 declare 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?: RoutingAPIOptions);
     /**
-     * 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: RoutingParameters, config: RequestInit): Promise<RoutingResponse>;
 }

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

@@ -1,37 +1,43 @@
-import HttpAPI from './HttpAPI';
 import { StopsParameters, StopsResponse } from '../types';
-export type StopsAPIOptions = {
-    url?: string;
+import HttpAPI from './HttpAPI';
+export interface StopsAPIOptions {
     apiKey?: string;
-};
+    url?: string;
+}
 /**
- * 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
  */
 declare 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?: StopsAPIOptions);
     /**
-     * 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: StopsParameters, config: RequestInit): Promise<StopsResponse>;
 }

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));
+        super(Object.assign(Object.assign({}, options), { url: options.url || 'https://api.geops.io/stops/v1/' }));
     }
     /**
-     * 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

@@ -1,49 +1,43 @@
 import { RealtimeTrajectoryResponse } from '../types';
-export declare type WebSocketAPIParameters = {
+export declare interface WebSocketAPIParameters {
+    args?: number | string;
     channel?: string;
-    args?: string | number;
-    id?: string | number;
-};
-export declare type WebSocketAPIMessageEventData<T> = {
-    timestamp: number;
-    source: string;
+    id?: number | string;
+}
+export declare interface WebSocketAPIMessageEventData<T> {
+    client_reference: null | number | string;
     content: T;
-    client_reference: string | number | null;
-};
-export type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]> & {
+    source: string;
+    timestamp: number;
+}
+export type WebSocketAPIBufferMessageEventData = {
     source: 'buffer';
-};
-export type WebSocketAPIMessageEvent = Event & {
+} & WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]>;
+export type WebSocketAPIMessageEvent = {
     data: string;
-};
-export interface WebSocketAPIMessageEventListener {
-    (evt: WebSocketAPIMessageEvent): void;
-}
+} & Event;
+export type 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;
+export type WebSocketAPIMessageCallback<T> = (data: WebSocketAPIMessageEventData<T>) => void;
+export declare interface WebSocketAPISubscription {
     cb: WebSocketAPIMessageCallback<any>;
     errorCb?: EventListener;
-    onMessageCb: WebSocketAPIMessageEventListener;
     onErrorCb?: EventListener;
-    quiet: boolean;
-};
-export declare type WebSocketAPISubscribed = {
-    [index: string]: boolean;
-};
-export declare type WebSocketAPIRequest = {
+    onMessageCb: WebSocketAPIMessageEventListener;
     params: WebSocketAPIParameters;
+    quiet: boolean;
+}
+export type WebSocketAPISubscribed = Record<string, boolean>;
+export declare interface WebSocketAPIRequest {
     cb: WebSocketAPIMessageCallback<any>;
     errorCb?: EventListener;
-    onMessageCb: WebSocketAPIMessageEventListener;
     onErrorCb?: EventListener;
-    requestString: String;
-};
+    onMessageCb: WebSocketAPIMessageEventListener;
+    params: WebSocketAPIParameters;
+    requestString: string;
+}
 /**
  * Class used to facilitate connection to a WebSocketAPI and
  * also to manage properly messages send to the WebSocketAPI.
@@ -51,17 +45,16 @@ export declare type WebSocketAPIRequest = {
  * @private
  */
 declare class WebSocketAPI {
-    websocket?: WebSocket;
     closed?: boolean;
     closing?: boolean;
     connecting?: boolean;
+    messagesOnOpen: string[];
     open?: boolean;
-    messagesOnOpen: Array<string>;
-    subscriptions: Array<WebSocketAPISubscription>;
+    requests: WebSocketAPIRequest[];
     subscribed: WebSocketAPISubscribed;
-    requests: Array<WebSocketAPIRequest>;
+    subscriptions: WebSocketAPISubscription[];
+    websocket?: WebSocket;
     constructor();
-    defineProperties(): void;
     /**
      * Get the websocket request string.
      *
@@ -74,29 +67,32 @@ declare class WebSocketAPI {
      * @private
      */
     static getRequestString(method: string, params?: WebSocketAPIParameters): string;
+    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
     /**
-     * (Re)connect the websocket.
+     * Close the websocket definitively.
      *
-     * @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(): void;
     /**
-     * Close the websocket definitively.
+     * (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
      */
-    close(): void;
+    connect(url: string, onOpen?: () => void): void;
+    defineProperties(): void;
     /**
-     * Sends a message to the websocket.
+     * 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 {message} message Message to send.
+     * @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
      */
-    send(message: string): void;
-    addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
-    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
+    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
     /**
      * Listen to websocket messages.
      *
@@ -107,27 +103,17 @@ declare class WebSocketAPI {
      * @private
      */
     listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
-        onMessageCb: WebSocketAPIMessageEventListener;
         onErrorCb?: EventListener;
+        onMessageCb: WebSocketAPIMessageEventListener;
     };
+    removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): 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;
-    /**
-     * 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.
+     * Sends a message to the websocket.
      *
-     * @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
+     * @param {message} message Message to send.
      * @private
      */
-    get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
+    send(message: string): void;
     /**
      * Subscribe to a given channel.
      *
@@ -138,6 +124,18 @@ declare class WebSocketAPI {
      * @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
@@ -145,9 +143,5 @@ declare class WebSocketAPI {
      * @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;