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

package/mbt.js

@@ -17856,8 +17856,10 @@ uniform ${i3} ${s3} u_${a3};
   var ol_exports = {};
   __export(ol_exports, {
     CopyrightControl: () => CopyrightControl_default,
+    Layer: () => Layer_default4,
     MaplibreLayer: () => MaplibreLayer_default,
     MaplibreStyleLayer: () => MaplibreStyleLayer_default,
+    MobilityLayerMixin: () => MobilityLayerMixin_default,
     RealtimeAPI: () => RealtimeAPI_default,
     RealtimeLayer: () => RealtimeLayer_default,
     RealtimeModes: () => RealtimeModes,
@@ -17949,19 +17951,21 @@ uniform ${i3} ${s3} u_${a3};
     /**
      * 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({ 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);
@@ -17983,11 +17987,11 @@ uniform ${i3} ${s3} u_${a3};
       super({ 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) {
@@ -18207,8 +18211,8 @@ uniform ${i3} ${s3} u_${a3};
      * 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) {
@@ -18563,8 +18567,7 @@ uniform ${i3} ${s3} u_${a3};
      * 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
@@ -18575,16 +18578,17 @@ uniform ${i3} ${s3} u_${a3};
     }
     /**
      * 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.
@@ -18596,8 +18600,8 @@ uniform ${i3} ${s3} u_${a3};
     }
     /**
      * 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) {
@@ -18680,7 +18684,7 @@ uniform ${i3} ${s3} u_${a3};
     /**
      * 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
@@ -18694,7 +18698,7 @@ uniform ${i3} ${s3} u_${a3};
      * 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
@@ -18710,7 +18714,7 @@ uniform ${i3} ${s3} u_${a3};
     }
     /**
      * 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) {
@@ -18746,7 +18750,7 @@ uniform ${i3} ${s3} u_${a3};
      * @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) {
@@ -18768,7 +18772,7 @@ uniform ${i3} ${s3} u_${a3};
      *
      * @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
@@ -18781,11 +18785,18 @@ uniform ${i3} ${s3} u_${a3};
       }
       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) {
@@ -18795,7 +18806,7 @@ uniform ${i3} ${s3} u_${a3};
      * 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) {
@@ -18805,7 +18816,7 @@ uniform ${i3} ${s3} u_${a3};
      * 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
@@ -18818,7 +18829,7 @@ uniform ${i3} ${s3} u_${a3};
      * 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) {
@@ -24410,7 +24421,9 @@ uniform ${i3} ${s3} u_${a3};
   var getVehiclePosition = (now, trajectory, noInterpolate) => {
     const {
       time_intervals: timeIntervals,
+      // @ts-expect-error olGeometry is added by the RealtimeLayer
       olGeometry,
+      // @ts-expect-error coordinate is added by the RealtimeLayer
       coordinate
     } = trajectory.properties;
     let { type, coordinates: coordinates2 } = trajectory.geometry;
@@ -44171,7 +44184,7 @@ uniform ${i3} ${s3} u_${a3};
     /**
      * 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).
      */
@@ -44520,10 +44533,10 @@ uniform ${i3} ${s3} u_${a3};
      *
      * @param {MaplibreLayerOptions} options
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
-     * @param {string} [options.apiKeyName="key"] The geOps Maps api key name.
+     * @param {string} [options.apiKeyName="key"] The geOps Maps API key name.
      * @param {maplibregl.MapOptions} [options.mapOptions={ interactive: false, trackResize: false, attributionControl: false }] Maplibre map options.
-     * @param {string} [options.style="travic_v2"] The geOps Maps api style.
-     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps api url.
+     * @param {string} [options.style="travic_v2"] The geOps Maps API style.
+     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps API url.
      */
     constructor(options) {
       super({
@@ -45664,7 +45677,8 @@ uniform ${i3} ${s3} u_${a3};
         }
         const vehicles = [];
         for (let i = 0; i < trajectories.length; i += 1) {
-          if (trajectories[i].properties.coordinate && containsCoordinate(ext, trajectories[i].properties.coordinate)) {
+          const { coordinate: trajcoord } = trajectories[i].properties;
+          if (trajcoord && containsCoordinate(ext, trajcoord)) {
             vehicles.push(trajectories[i]);
           }
           if (vehicles.length === nb) {
@@ -45673,7 +45687,7 @@ uniform ${i3} ${s3} u_${a3};
         }
         return Promise.resolve({
           layer: this,
-          features: vehicles,
+          features: vehicles.map((vehicle) => this.format.readFeature(vehicle)),
           coordinate
         });
       }
@@ -45681,7 +45695,7 @@ uniform ${i3} ${s3} u_${a3};
        * Request the stopSequence and the fullTrajectory informations for a vehicle.
        *
        * @param {string} id The vehicle identifier (the  train_id property).
-       * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
+       * @return {Promise<{stopSequence: RealtimeStopSequence, fullTrajectory: RealtimeFullTrajectory>} A promise that will be resolved with the trajectory informations.
        */
       getTrajectoryInfos(id) {
         const promises = [
@@ -45708,9 +45722,9 @@ uniform ${i3} ${s3} u_${a3};
       purgeOutOfDateTrajectories() {
         Object.entries(this.trajectories || {}).forEach(([key, trajectory]) => {
           const timeIntervals = trajectory?.properties?.time_intervals;
-          if (this.time && timeIntervals.length) {
+          if (this.time && timeIntervals?.length) {
             const lastTimeInterval = timeIntervals[timeIntervals.length - 1][0];
-            if (lastTimeInterval < this.time) {
+            if (lastTimeInterval < this.time.getTime()) {
               this.removeTrajectory(key);
             }
           }
@@ -45745,7 +45759,10 @@ uniform ${i3} ${s3} u_${a3};
         if (!this.trajectories) {
           this.trajectories = {};
         }
-        this.trajectories[trajectory.properties.train_id] = trajectory;
+        const id = trajectory.properties.train_id;
+        if (id !== void 0) {
+          this.trajectories[id] = trajectory;
+        }
         this.renderTrajectories();
       }
       removeTrajectory(trajectoryOrId) {
@@ -45755,7 +45772,7 @@ uniform ${i3} ${s3} u_${a3};
         } else {
           id = trajectoryOrId;
         }
-        if (this.trajectories) {
+        if (id !== void 0 && this.trajectories) {
           delete this.trajectories[id];
         }
       }
@@ -46125,7 +46142,11 @@ uniform ${i3} ${s3} u_${a3};
       const vehicles = [];
       for (let i = 0; i < trajectories.length; i += 1) {
         const trajectory = trajectories[i];
-        if (trajectory.properties.coordinate && containsCoordinate(ext, trajectory.properties.coordinate)) {
+        if (
+          // @ts-expect-error coordinate is added by the RealtimeLayer
+          trajectory.properties.coordinate && // @ts-expect-error coordinate is added by the RealtimeLayer
+          containsCoordinate(ext, trajectory.properties.coordinate)
+        ) {
           vehicles.push(trajectories[i]);
         }
         if (vehicles.length === nb) {
@@ -46429,6 +46450,21 @@ uniform ${i3} ${s3} u_${a3};
   };
   var RealtimeLayer_default = RealtimeLayer;
 
+  // src/ol/layers/Layer.ts
+  var Layer2 = class _Layer extends MobilityLayerMixin_default(Layer_default) {
+    constructor(options) {
+      super(options);
+      console.warn("Layer is deprecated. Use an OpenLayers Layer instead.");
+    }
+    clone(newOptions) {
+      return new _Layer({
+        ...this.options || {},
+        ...newOptions || {}
+      });
+    }
+  };
+  var Layer_default4 = Layer2;
+
   // src/ol/utils/getFeatureInfoAtCoordinate.ts
   var format3 = new GeoJSON_default();
   var getFeaturesFromWMS = (source, options, abortController) => {
@@ -46517,7 +46553,7 @@ uniform ${i3} ${s3} u_${a3};
   var maplibre_exports = {};
   __export(maplibre_exports, {
     CopyrightControl: () => CopyrightControl_default2,
-    Layer: () => Layer_default4,
+    Layer: () => Layer_default5,
     RealtimeAPI: () => RealtimeAPI_default,
     RealtimeLayer: () => RealtimeLayer_default2,
     RealtimeModes: () => RealtimeModes,
@@ -46653,7 +46689,7 @@ uniform ${i3} ${s3} u_${a3};
 
   // src/maplibre/layers/Layer.ts
   var import_maplibre_gl2 = __toESM(require_maplibre_gl());
-  var Layer2 = class extends import_maplibre_gl2.Evented {
+  var Layer3 = class extends import_maplibre_gl2.Evented {
     constructor(options = {}) {
       super();
       this.options = {};
@@ -46673,7 +46709,7 @@ uniform ${i3} ${s3} u_${a3};
     render(gl) {
     }
   };
-  var Layer_default4 = Layer2;
+  var Layer_default5 = Layer3;
 
   // node_modules/@turf/helpers/dist/es/index.js
   var earthRadius = 63710088e-1;
@@ -47205,19 +47241,26 @@ uniform ${i3} ${s3} u_${a3};
   var toMercatorExtent_default = toMercatorExtent;
 
   // src/maplibre/layers/RealtimeLayer.ts
-  var RealtimeLayer2 = class extends RealtimeLayerMixin_default(Layer_default4) {
+  var RealtimeLayer2 = class extends RealtimeLayerMixin_default(Layer_default5) {
     /**
      * Constructor.
      *
      * @param {RealtimeLayerOptions} options
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {FilterFunction} options.filter Filter out a train. This function must be fast, it is executed for every trajectory on every render frame.
+     * @param {getMotsByZoomFunction} options.getMotsByZoom Returns for each zoom level the list of MOTs to display. It filters trains on backend side.
+     * @param {number} [options.minZoomInterpolation=8] Minimal zoom level where to start to interpolate train positions.
+     * @param {RealtimeMode} [options.mode='topographic'] The realtime mode to use.
+     * @param {SortFunction} options.sort Sort trains. This function must be fast, it is executed on every render frame.
+     * @param {RealtimeStyleFunction} options.style Function to style the trajectories.
+     * @param {RealtimeTenant} options.tenant Filter trains by its tenant. It filters trains on backend side.
      * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps Realtime API url.
-     *
      */
     constructor(options = {}) {
       const canvas2 = document.createElement("canvas");
       super({
         canvas: canvas2,
+        id: "realtime",
         ...options
       });
       this.source = {