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

package/api/RealtimeAPI.d.ts

@@ -1,6 +1,5 @@
 import WebSocketAPI, { WebSocketAPIMessageCallback, WebSocketAPIMessageEventData, WebSocketAPIParameters } from './WebSocketAPI';
-import type { RealtimeMode, RealtimeDeparture, RealtimeNews, RealtimeStation, RealtimeExtraGeom, RealtimeTrainId, RealtimeGeneralizationLevel, RealtimeFullTrajectory, RealtimeTrajectoryResponse, RealtimeStationId, RealtimeVersion, RealtimeTrajectory, RealtimeTenant, RealtimeBbox } from '../types';
-import { StopSequence } from './typedefs';
+import type { RealtimeMode, RealtimeDeparture, RealtimeNews, RealtimeStation, RealtimeExtraGeom, RealtimeTrainId, RealtimeGeneralizationLevel, RealtimeFullTrajectory, RealtimeStationId, RealtimeVersion, RealtimeTrajectory, RealtimeTenant, RealtimeBbox, RealtimeStopSequence } from '../types';
 /**
  * @typedef RealtimeAPIOptions
  */
@@ -178,8 +177,7 @@ declare class RealtimeAPI {
      * 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.
+     * @param {function(departures: RealtimeDeparture[])} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -187,14 +185,15 @@ declare class RealtimeAPI {
     subscribeDepartures(stationId: number, onMessage: WebSocketAPIMessageCallback<RealtimeDeparture>, onError?: EventListener, quiet?: boolean): void;
     /**
      * Unsubscribe from current departures channel.
-     * @param {RealtimeStationId} id Station's id
+     * @param {number} stationId UIC of the station.
      * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    unsubscribeDepartures(id: RealtimeStationId, onMessage?: WebSocketAPIMessageCallback<RealtimeDeparture>): void;
+    unsubscribeDepartures(stationId: RealtimeStationId, onMessage?: WebSocketAPIMessageCallback<RealtimeDeparture>): void;
     /**
      * Subscribe to the disruptions channel for tenant.
      *
+     * @param {RealtimeTenant} tenant Tenant's id
      * @param {function(data: { content: RealtimeNews[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
@@ -203,8 +202,8 @@ declare class RealtimeAPI {
     subscribeDisruptions(tenant: RealtimeTenant, onMessage: WebSocketAPIMessageCallback<RealtimeNews>, onError?: EventListener, quiet?: boolean): void;
     /**
      * Unsubscribe disruptions.
-     *
-     * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {RealtimeTenant} tenant Tenant's id
+     * @param {Function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeDisruptions(tenant: RealtimeTenant, onMessage?: WebSocketAPIMessageCallback<RealtimeNews>): void;
@@ -258,7 +257,7 @@ declare class RealtimeAPI {
     /**
      * Return a partial trajectory with a given id and a mode.
      *
-     * @param {number} trainId The identifier of a trajectory.
+     * @param {number} id The identifier of a trajectory.
      * @param {RealtimeMode} mode Realtime mode.
      * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
      * @public
@@ -268,18 +267,18 @@ declare class RealtimeAPI {
      * Subscribe to trajectory channel.
      *
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    subscribeTrajectory(mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeTrajectoryResponse[] | RealtimeTrajectoryResponse>, onError?: EventListener, quiet?: boolean): void;
+    subscribeTrajectory(mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeTrajectory>, onError?: EventListener, quiet?: boolean): void;
     /**
      * Unsubscribe to trajectory channels.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    unsubscribeTrajectory(onMessage: WebSocketAPIMessageCallback<RealtimeTrajectoryResponse[]>): void;
+    unsubscribeTrajectory(onMessage: WebSocketAPIMessageCallback<RealtimeTrajectory>): void;
     /**
      * Subscribe to deleted_vhicles channel.
      *
@@ -300,7 +299,7 @@ declare class RealtimeAPI {
      * @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<{ data: { content: RealtimeFullTrajectory } }>} Return a full trajectory.
+     * @return {Promise<{data: { content: RealtimeFullTrajectory }}>} Return a full trajectory.
      * @public
      */
     getFullTrajectory(id: RealtimeTrainId, mode: RealtimeMode, generalizationLevel: RealtimeGeneralizationLevel | undefined): Promise<WebSocketAPIMessageEventData<RealtimeFullTrajectory>>;
@@ -309,17 +308,24 @@ declare class RealtimeAPI {
      *
      * @param {string} id A vehicle id.
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Function called on each message of the channel.
+     * @param {function(data:{content: RealtimeFullTrajectory})} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
     subscribeFullTrajectory(id: RealtimeTrainId, mode: RealtimeMode, onMessage: WebSocketAPIMessageCallback<RealtimeFullTrajectory>, onError?: EventListener, quiet?: boolean): void;
+    /**
+     * This callback type is called `requestCallback` and is displayed as a global symbol.
+     *
+     * @callback onFullTrajectoryMessageCallback
+     * @param {number} responseCode
+     * @param {string} responseMessage
+     */
     /**
      * Unsubscribe from full_trajectory channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {onFullTrajectoryMessageCallback} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeFullTrajectory(id: RealtimeTrainId, onMessage?: WebSocketAPIMessageCallback<RealtimeFullTrajectory>): void;
@@ -327,28 +333,28 @@ declare class RealtimeAPI {
      * Get the list of stops for this vehicle.
      *
      * @param {string} id A vehicle id.
-     * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
+     * @return {Promise<{data: { content: RealtimeStopSequence[] }}>} Returns a stop sequence object.
      * @public
      */
-    getStopSequence(id: RealtimeTrainId): Promise<WebSocketAPIMessageEventData<StopSequence[]>>;
+    getStopSequence(id: RealtimeTrainId): Promise<WebSocketAPIMessageEventData<RealtimeStopSequence[]>>;
     /**
      * Subscribe to stopsequence channel of a given vehicle.
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
      */
-    subscribeStopSequence(id: RealtimeTrainId, onMessage: WebSocketAPIMessageCallback<StopSequence[]>, onError?: EventListener, quiet?: boolean): void;
+    subscribeStopSequence(id: RealtimeTrainId, onMessage: WebSocketAPIMessageCallback<RealtimeStopSequence[]>, onError?: EventListener, quiet?: boolean): void;
     /**
      * Unsubscribe from stopsequence channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    unsubscribeStopSequence(id: RealtimeTrainId, onMessage?: WebSocketAPIMessageCallback<StopSequence[]>): void;
+    unsubscribeStopSequence(id: RealtimeTrainId, onMessage?: WebSocketAPIMessageCallback<RealtimeStopSequence[]>): void;
     /**
      * Subscribe to healthcheck channel.
      * @param {function(data: { content: string })} onMessage Callback when the subscribe to healthcheck channel succeeds.

package/api/RealtimeAPI.js

@@ -259,8 +259,7 @@ class RealtimeAPI {
      * 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.
+     * @param {function(departures: RealtimeDeparture[])} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -270,16 +269,17 @@ class RealtimeAPI {
     }
     /**
      * Unsubscribe from current departures channel.
-     * @param {RealtimeStationId} id Station's id
+     * @param {number} stationId UIC of the station.
      * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
-    unsubscribeDepartures(id, onMessage) {
-        this.unsubscribe(`timetable_${id}`, '', onMessage);
+    unsubscribeDepartures(stationId, onMessage) {
+        this.unsubscribe(`timetable_${stationId}`, '', onMessage);
     }
     /**
      * Subscribe to the disruptions channel for tenant.
      *
+     * @param {RealtimeTenant} tenant Tenant's id
      * @param {function(data: { content: RealtimeNews[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
@@ -290,8 +290,8 @@ class RealtimeAPI {
     }
     /**
      * Unsubscribe disruptions.
-     *
-     * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {RealtimeTenant} tenant Tenant's id
+     * @param {Function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeDisruptions(tenant, onMessage) {
@@ -365,7 +365,7 @@ class RealtimeAPI {
     /**
      * Return a partial trajectory with a given id and a mode.
      *
-     * @param {number} trainId The identifier of a trajectory.
+     * @param {number} id The identifier of a trajectory.
      * @param {RealtimeMode} mode Realtime mode.
      * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
      * @public
@@ -377,7 +377,7 @@ class RealtimeAPI {
      * Subscribe to trajectory channel.
      *
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -392,7 +392,7 @@ class RealtimeAPI {
     }
     /**
      * Unsubscribe to trajectory channels.
-     * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeTrajectory(onMessage) {
@@ -427,7 +427,7 @@ class RealtimeAPI {
      * @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<{ data: { content: RealtimeFullTrajectory } }>} Return a full trajectory.
+     * @return {Promise<{data: { content: RealtimeFullTrajectory }}>} Return a full trajectory.
      * @public
      */
     getFullTrajectory(id, mode, generalizationLevel) {
@@ -449,7 +449,7 @@ class RealtimeAPI {
      *
      * @param {string} id A vehicle id.
      * @param {RealtimeMode} mode Realtime mode.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Function called on each message of the channel.
+     * @param {function(data:{content: RealtimeFullTrajectory})} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -461,11 +461,18 @@ class RealtimeAPI {
         }
         this.subscribe(`full_trajectory${suffix}_${id}`, onMessage, onError, quiet);
     }
+    /**
+     * This callback type is called `requestCallback` and is displayed as a global symbol.
+     *
+     * @callback onFullTrajectoryMessageCallback
+     * @param {number} responseCode
+     * @param {string} responseMessage
+     */
     /**
      * Unsubscribe from full_trajectory channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {onFullTrajectoryMessageCallback} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeFullTrajectory(id, onMessage) {
@@ -475,7 +482,7 @@ class RealtimeAPI {
      * Get the list of stops for this vehicle.
      *
      * @param {string} id A vehicle id.
-     * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
+     * @return {Promise<{data: { content: RealtimeStopSequence[] }}>} Returns a stop sequence object.
      * @public
      */
     getStopSequence(id) {
@@ -485,7 +492,7 @@ class RealtimeAPI {
      * Subscribe to stopsequence channel of a given vehicle.
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Function called on each message of the channel.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Function called on each message of the channel.
      * @param {function} onError Callback when the subscription fails.
      * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
      * @public
@@ -497,7 +504,7 @@ class RealtimeAPI {
      * Unsubscribe from stopsequence channel
      *
      * @param {string} id A vehicle id.
-     * @param {function(data: { content: StopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
+     * @param {function(data: { content: RealtimeStopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
      * @public
      */
     unsubscribeStopSequence(id, onMessage) {

package/api/RoutingAPI.d.ts

@@ -11,26 +11,36 @@ export type RoutingAPIOptions = {
  * 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

@@ -6,28 +6,38 @@ import HttpAPI from './HttpAPI';
  * 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

@@ -32,11 +32,11 @@ declare class StopsAPI extends HttpAPI {
      */
     constructor(options?: StopsAPIOptions);
     /**
-     * Search fo stops.
+     * Search for stops.
      *
-     * @param {StopsAPIParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/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<StopsAPIResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326). See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @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

@@ -29,11 +29,11 @@ class StopsAPI extends HttpAPI {
         super(Object.assign({ url: 'https://api.geops.io/stops/v1/' }, options));
     }
     /**
-     * Search fo stops.
+     * Search for stops.
      *
-     * @param {StopsAPIParameters} params Request parameters. See [Stops API documentation](https://developer.geops.io/apis/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<StopsAPIResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326). See [Stops API documentation](https://developer.geops.io/apis/stops).
+     * @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) {

package/api/WebSocketAPI.d.ts

@@ -123,8 +123,8 @@ declare class WebSocketAPI {
      * 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
+     * @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;

package/api/WebSocketAPI.js

@@ -234,8 +234,8 @@ class WebSocketAPI {
      * 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
+     * @param {function} cb callback on message event
+     * @param {function} errorCb Callback on error and close event
      * @private
      */
     get(params, cb, errorCb) {

package/api/typedefs.d.ts

@@ -1,59 +1,4 @@
 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[];
@@ -98,38 +43,6 @@ export type Transfer = {
      */
     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.
@@ -160,19 +73,4 @@ export type ExtraGeom = GeoJSONFeature;
  * @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/api/typedefs.js

@@ -1,30 +1,30 @@
-/**
- * @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 {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.
@@ -55,21 +55,6 @@
  * @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
- */
 // These lines is to block TypeScript to add "use strict;" in the outputed file.
 const dummy = () => { };
 export default dummy;

package/common/controls/StopFinderControlCommon.d.ts

@@ -44,7 +44,7 @@ declare class StopFinderControlCommon {
     /**
      * Launch a search.
      *
-     * @param {String} query The query to search for.
+     * @param {String} q 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).
      */

package/common/controls/StopFinderControlCommon.js

@@ -103,7 +103,7 @@ class StopFinderControlCommon {
     /**
      * Launch a search.
      *
-     * @param {String} query The query to search for.
+     * @param {String} q 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).
      */