mobility-toolbox-js 3.0.0-beta.33 → 3.0.0-beta.35

package/ol/controls/CopyrightControl.d.ts

@@ -1,11 +1,11 @@
 import { MapEvent } from 'ol';
 import Control, { Options } from 'ol/control/Control';
-export type CopyrightControlOptions = Options & {
+export type CopyrightControlOptions = {
     className?: 'string';
     format?: (copyrights: string[]) => string;
-};
+} & Options;
 /**
- * Display layer's copyrights.
+ * Display layer's copyrights. Adding the possibility to format them as you wish.
  *
  * @example
  * import { Map } from 'ol';
@@ -19,12 +19,20 @@ export type CopyrightControlOptions = Options & {
  * map.addControl(control);
  *
  *
- * @see <a href="/example/ol-copyright">Openlayers copyright example</a>
+ * @see <a href="/example/ol-realtime>OpenLayers Realtime layer example</a>
+ *
+ * @extends {ol/control/Control~Control}
  *
- * @extends {ol/control/Control}
  */
 declare class CopyrightControl extends Control {
     format: (copyrights: string[]) => string;
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {Function} format Function used to format the list of copyrights available to a single string. By default join all the copyrights with a |.
+     * @public
+     */
     constructor(options?: CopyrightControlOptions);
     render({ frameState }: MapEvent): void;
 }

package/ol/controls/CopyrightControl.js

@@ -1,9 +1,9 @@
-import { inView } from 'ol/layer/Layer';
 import Control from 'ol/control/Control';
-import removeDuplicate from '../../common/utils/removeDuplicate';
+import { inView } from 'ol/layer/Layer';
 import createDefaultCopyrightElement from '../../common/utils/createDefaultCopyrightElt';
+import removeDuplicate from '../../common/utils/removeDuplicate';
 /**
- * Display layer's copyrights.
+ * Display layer's copyrights. Adding the possibility to format them as you wish.
  *
  * @example
  * import { Map } from 'ol';
@@ -17,11 +17,19 @@ import createDefaultCopyrightElement from '../../common/utils/createDefaultCopyr
  * map.addControl(control);
  *
  *
- * @see <a href="/example/ol-copyright">Openlayers copyright example</a>
+ * @see <a href="/example/ol-realtime>OpenLayers Realtime layer example</a>
+ *
+ * @extends {ol/control/Control~Control}
  *
- * @extends {ol/control/Control}
  */
 class CopyrightControl extends Control {
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {Function} format Function used to format the list of copyrights available to a single string. By default join all the copyrights with a |.
+     * @public
+     */
     constructor(options = {}) {
         const element = createDefaultCopyrightElement();
         element.className = options.className || 'mbt-copyright';

package/ol/controls/RoutingControl.d.ts

@@ -15,11 +15,11 @@ import type { RoutingGraph, RoutingMot, RoutingParameters, RoutingViaPoint } fro
 export type RoutingControlOptions = {
     active?: boolean;
     apiKey?: string;
+    apiParams?: RoutingParameters;
     graphs?: RoutingGraph[];
     modify?: boolean;
     mot?: string;
     onRouteError?: () => void;
-    routingApiParams?: RoutingParameters;
     routingLayer?: VectorLayer<VectorSource>;
     snapToClosestStation?: boolean;
     stopsApiKey?: string;
@@ -29,7 +29,8 @@ export type RoutingControlOptions = {
 } & Options;
 export type AbotControllersByGraph = Record<string, AbortController>;
 /**
- * This OpenLayers control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
+ * This OpenLayers control allows the user to add and modifiy via points to
+ * a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
  *
  * @example
  * import { Map } from 'ol';
@@ -41,29 +42,23 @@ export type AbotControllersByGraph = Record<string, AbortController>;
  *
  * const control = new RoutingControl();
  *
- * control.attachToMap(map)
+ * map.addControl(control);
  *
- * @classproperty {string} apiKey - Key used for RoutingApi requests.
- * @classproperty {string} stopsApiKey - Key used for Stop lookup requests (defaults to apiKey).
- * @classproperty {string} stopsApiUrl - Url used for Stop lookup requests (defaults to https://api.geops.io/stops/v1/lookup/).
- * @classproperty {Array.<Array<graph="osm", minZoom=0, maxZoom=99>>} graphs - Array of routing graphs and min/max zoom levels. If you use the control in combination with the [geOps Maps API](https://developer.geops.io/apis/maps/), you may want to use the optimal level of generalizations: "[['gen4', 0, 8], ['gen3', 8, 9], ['gen2', 9, 11], ['gen1', 11, 13], ['osm', 13, 99]]"
  * @classproperty {string} mot - Mean of transport to be used for routing.
- * @classproperty {object} routingApiParams - object of additional parameters to pass to the routing api request.
- * @classproperty {object} snapToClosestStation - If true, the routing will snap the coordinate to the closest station. Default to false.
- * @classproperty {boolean} useRawViaPoints - Experimental property. Wen true, it allows the user to add via points using different kind of string. See "via" parameter defined by the [geOps Routing API](https://developer.geops.io/apis/routing/). Default to false, only array of coordinates and station's id are supported as via points.
  * @classproperty {VectorLayer} routingLayer - Layer for adding route features.
- * @classproperty {function} onRouteError - Callback on error.
  * @classproperty {boolean} loading - True if the control is requesting the backend.
+ *
  * @see <a href="/example/ol-routing">Openlayers routing example</a>
  *
- * @extends {Control}
- * @implements {RoutingInterface}
+ * @extends {ol/control/Control~Control}
+ *
  * @public
  */
 declare class RoutingControl extends Control {
     abortControllers: Record<string, AbortController>;
     api?: RoutingAPI;
     apiKey?: string;
+    apiParams?: RoutingParameters;
     cacheStationData: Record<string, Coordinate>;
     format: GeoJSON;
     graphs: RoutingGraph[];
@@ -77,7 +72,6 @@ declare class RoutingControl extends Control {
     modifyInteraction?: Modify;
     onMapClickKey?: EventsKey;
     onRouteError: (error?: Error, control?: RoutingControl) => void;
-    routingApiParams?: RoutingParameters;
     routingLayer?: VectorLayer<VectorSource>;
     segments: Feature<LineString>[];
     snapToClosestStation: boolean;
@@ -85,6 +79,22 @@ declare class RoutingControl extends Control {
     stopsApiUrl?: string;
     useRawViaPoints: boolean;
     viaPoints: RoutingViaPoint[];
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
+     * @param {Object} options.apiParams Request parameters. See [geOps Routing API documentation](https://developer.geops.io/apis/routing/).
+     * @param {Array.<Array<graph="osm", minZoom=0, maxZoom=99>>} [options.graphs=[['osm', 0, 99]]] - Array of routing graphs and min/max zoom levels. If you use the control in combination with the [geOps Maps API](https://developer.geops.io/apis/maps/), you may want to use the optimal level of generalizations: "[['gen4', 0, 8], ['gen3', 8, 9], ['gen2', 9, 11], ['gen1', 11, 13], ['osm', 13, 99]]".
+     * @param {string} [options.mot="bus"] Mean of transport to be used for routing.
+     * @param {function} options.onRouteError Callback on request errors.
+     * @param {VectorLayer} [options.routingLayer=new VectorLayer()] Vector layer for adding route features.
+     * @param {boolean} [options.snapToClosestStation=false] If true, the routing will snap the coordinate to the closest station. Default to false.
+     * @param {StyleLike} options.style Style of the default vector layer.
+     * @param {boolean} [options.useRawViaPoints=fale] Experimental property. If true, it allows the user to add via points using different kind of string. See "via" parameter defined by the [geOps Routing API](https://developer.geops.io/apis/routing/). Default to false, only array of coordinates and station's id are supported as via points.
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] [geOps Realtime API](https://developer.geops.io/apis/realtime/) url.
+     * @public
+     */
     constructor(options?: RoutingControlOptions);
     /**
      * Calculate at which resolutions corresponds each generalizations.
@@ -109,7 +119,7 @@ declare class RoutingControl extends Control {
      *   If an index is passed a viaPoint is added at the specified index.
      *   If an index is passed and overwrite x is > 0, x viaPoints at the specified
      *     index are replaced with a single new viaPoint.
-     * @param {number[]|string} coordinates Array of coordinates
+     * @param {string | Coordinate} coordinatesOrString Array of coordinates or a string representing a station
      * @param {number} [index=-1] Integer representing the index of the added viaPoint. If not specified, the viaPoint is added at the end of the array.
      * @param {number} [overwrite=0] Marks the number of viaPoints that are removed at the specified index on add.
      * @public

package/ol/controls/RoutingControl.js

@@ -33,7 +33,7 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
     const coords = [];
     segmentArray.forEach((seg) => {
         var _a;
-        // @ts-expect-error
+        // @ts-expect-error missing type
         const coordArr = (_a = seg.getGeometry()) === null || _a === void 0 ? void 0 : _a.getCoordinates();
         if (coordArr === null || coordArr === void 0 ? void 0 : coordArr.length) {
             coords.push(...coordArr);
@@ -42,7 +42,8 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
     return coords;
 };
 /**
- * This OpenLayers control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
+ * This OpenLayers control allows the user to add and modifiy via points to
+ * a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
  *
  * @example
  * import { Map } from 'ol';
@@ -54,26 +55,35 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
  *
  * const control = new RoutingControl();
  *
- * control.attachToMap(map)
+ * map.addControl(control);
  *
- * @classproperty {string} apiKey - Key used for RoutingApi requests.
- * @classproperty {string} stopsApiKey - Key used for Stop lookup requests (defaults to apiKey).
- * @classproperty {string} stopsApiUrl - Url used for Stop lookup requests (defaults to https://api.geops.io/stops/v1/lookup/).
- * @classproperty {Array.<Array<graph="osm", minZoom=0, maxZoom=99>>} graphs - Array of routing graphs and min/max zoom levels. If you use the control in combination with the [geOps Maps API](https://developer.geops.io/apis/maps/), you may want to use the optimal level of generalizations: "[['gen4', 0, 8], ['gen3', 8, 9], ['gen2', 9, 11], ['gen1', 11, 13], ['osm', 13, 99]]"
  * @classproperty {string} mot - Mean of transport to be used for routing.
- * @classproperty {object} routingApiParams - object of additional parameters to pass to the routing api request.
- * @classproperty {object} snapToClosestStation - If true, the routing will snap the coordinate to the closest station. Default to false.
- * @classproperty {boolean} useRawViaPoints - Experimental property. Wen true, it allows the user to add via points using different kind of string. See "via" parameter defined by the [geOps Routing API](https://developer.geops.io/apis/routing/). Default to false, only array of coordinates and station's id are supported as via points.
  * @classproperty {VectorLayer} routingLayer - Layer for adding route features.
- * @classproperty {function} onRouteError - Callback on error.
  * @classproperty {boolean} loading - True if the control is requesting the backend.
+ *
  * @see <a href="/example/ol-routing">Openlayers routing example</a>
  *
- * @extends {Control}
- * @implements {RoutingInterface}
+ * @extends {ol/control/Control~Control}
+ *
  * @public
  */
 class RoutingControl extends Control {
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
+     * @param {Object} options.apiParams Request parameters. See [geOps Routing API documentation](https://developer.geops.io/apis/routing/).
+     * @param {Array.<Array<graph="osm", minZoom=0, maxZoom=99>>} [options.graphs=[['osm', 0, 99]]] - Array of routing graphs and min/max zoom levels. If you use the control in combination with the [geOps Maps API](https://developer.geops.io/apis/maps/), you may want to use the optimal level of generalizations: "[['gen4', 0, 8], ['gen3', 8, 9], ['gen2', 9, 11], ['gen1', 11, 13], ['osm', 13, 99]]".
+     * @param {string} [options.mot="bus"] Mean of transport to be used for routing.
+     * @param {function} options.onRouteError Callback on request errors.
+     * @param {VectorLayer} [options.routingLayer=new VectorLayer()] Vector layer for adding route features.
+     * @param {boolean} [options.snapToClosestStation=false] If true, the routing will snap the coordinate to the closest station. Default to false.
+     * @param {StyleLike} options.style Style of the default vector layer.
+     * @param {boolean} [options.useRawViaPoints=fale] Experimental property. If true, it allows the user to add via points using different kind of string. See "via" parameter defined by the [geOps Routing API](https://developer.geops.io/apis/routing/). Default to false, only array of coordinates and station's id are supported as via points.
+     * @param {string} [options.url='https://api.geops.io/routing/v1/'] [geOps Realtime API](https://developer.geops.io/apis/realtime/) url.
+     * @public
+     */
     constructor(options = {}) {
         super(options);
         this.abortControllers = {};
@@ -94,7 +104,7 @@ class RoutingControl extends Control {
         this.graphs = options.graphs || [['osm', 0, 99]];
         this.mot = options.mot || 'bus';
         this.modify = options.modify !== false;
-        this.routingApiParams = options.routingApiParams;
+        this.apiParams = options.apiParams;
         this.useRawViaPoints = options.useRawViaPoints || false;
         this.snapToClosestStation = options.snapToClosestStation || false;
         this.apiKey = options.apiKey;
@@ -201,7 +211,7 @@ class RoutingControl extends Control {
      *   If an index is passed a viaPoint is added at the specified index.
      *   If an index is passed and overwrite x is > 0, x viaPoints at the specified
      *     index are replaced with a single new viaPoint.
-     * @param {number[]|string} coordinates Array of coordinates
+     * @param {string | Coordinate} coordinatesOrString Array of coordinates or a string representing a station
      * @param {number} [index=-1] Integer representing the index of the added viaPoint. If not specified, the viaPoint is added at the end of the array.
      * @param {number} [overwrite=0] Marks the number of viaPoints that are removed at the specified index on add.
      * @public
@@ -306,7 +316,9 @@ class RoutingControl extends Control {
         });
         this.loading = true;
         // Create point features for the viaPoints
-        this.viaPoints.forEach((viaPoint, idx) => this.drawViaPoint(viaPoint, idx, this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY]));
+        this.viaPoints.forEach((viaPoint, idx) => {
+            this.drawViaPoint(viaPoint, idx, this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY]);
+        });
         return Promise.all(this.graphs.map(([graph], index) => {
             const { signal } = this.abortControllers[graph];
             if (!this.api) {
@@ -315,7 +327,7 @@ class RoutingControl extends Control {
             return this.api
                 .route(Object.assign({ 'coord-punish': 1000.0, 'coord-radius': 100.0, 
                 // @ts-expect-error  missing property in swagger
-                elevation: false, graph, mot: this.mot, 'resolve-hops': false, via: `${formattedViaPoints.join('|')}` }, (this.routingApiParams || {})), { signal })
+                elevation: false, graph, mot: this.mot, 'resolve-hops': false, via: `${formattedViaPoints.join('|')}` }, (this.apiParams || {})), { signal })
                 .then((featureCollection) => {
                 var _a, _b, _c;
                 this.segments = this.format.readFeatures(featureCollection);
@@ -355,8 +367,7 @@ class RoutingControl extends Control {
                 this.loading = false;
             })
                 .catch((error) => {
-                var _a, _b;
-                if (/AbortError/.test(error.message)) {
+                if (/AbortError/.test(error.name)) {
                     // Ignore abort error
                     return;
                 }
@@ -364,7 +375,6 @@ class RoutingControl extends Control {
                 // Dispatch error event and execute error function
                 this.dispatchEvent(new BaseEvent('error'));
                 this.onRouteError(error, this);
-                (_b = (_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear();
                 this.loading = false;
             });
         }));
@@ -401,15 +411,19 @@ class RoutingControl extends Control {
             return fetch(`${this.stopsApiUrl}lookup/${stationId}?key=${this.stopsApiKey}`, { signal: abortController.signal })
                 .then((res) => res.json())
                 .then((stationData) => {
-                var _a, _b;
-                const { coordinates } = stationData.features[0].geometry;
+                var _a, _b, _c, _d;
+                const { coordinates } = ((_b = (_a = stationData === null || stationData === void 0 ? void 0 : stationData.features) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.geometry) || {};
+                if (!coordinates) {
+                    console.log('No coordinates found for station ' + stationId, stationData);
+                }
                 this.cacheStationData[viaPoint] = fromLonLat(coordinates);
                 pointFeature.set('viaPointTrack', track);
                 pointFeature.setGeometry(new Point(fromLonLat(coordinates)));
-                (_b = (_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.addFeature(pointFeature);
+                (_d = (_c = this.routingLayer) === null || _c === void 0 ? void 0 : _c.getSource()) === null || _d === void 0 ? void 0 : _d.addFeature(pointFeature);
                 return pointFeature;
             })
                 .catch((error) => {
+                var _a, _b;
                 if (/AbortError/.test(error.message)) {
                     // Ignore abort error
                     return;
@@ -417,6 +431,7 @@ class RoutingControl extends Control {
                 // Dispatch error event and execute error function
                 this.dispatchEvent(new BaseEvent('error'));
                 this.onRouteError(error, this);
+                (_b = (_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear();
                 this.loading = false;
             });
         }
@@ -549,7 +564,7 @@ class RoutingControl extends Control {
         if ((route === null || route === void 0 ? void 0 : route.getGeometry()) && evt.mapBrowserEvent.coordinate) {
             // We use a buff extent to fix floating issues , see https://github.com/openlayers/openlayers/issues/7130#issuecomment-535856422
             const closestExtent = buffer(new Point(
-            // @ts-expect-error
+            // @ts-expect-error bad def
             (_a = route.getGeometry()) === null || _a === void 0 ? void 0 : _a.getClosestPoint(evt.mapBrowserEvent.coordinate)).getExtent(), 0.001);
             segmentIndex = this.segments.findIndex((segment) => { var _a; return (_a = segment.getGeometry()) === null || _a === void 0 ? void 0 : _a.intersectsExtent(closestExtent); });
         }
@@ -560,7 +575,7 @@ class RoutingControl extends Control {
             [])[0];
         // Write object with modify info
         this.initialRouteDrag = {
-            oldRoute: route && route.clone(),
+            oldRoute: route === null || route === void 0 ? void 0 : route.clone(),
             segmentIndex,
             viaPoint,
         };

package/ol/controls/StopFinderControl.d.ts

@@ -23,12 +23,34 @@ export type StopFinderControlOptions = {
  *
  *
  * @see <a href="/example/ol-search">Openlayers search example</a>
+ *
+ * @extends {ol/control/Control~Control}
+ *
  * @public
  */
 declare class StopFinderControl extends Control {
     controller: StopFinderControlCommon;
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {HTMLElement} options.element HTML element where to attach input and suggestions.
+     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
+     * @param {StopsSearchParams} [options.apiParams={ limit: 20 }] Request parameters. See [geOps Stops API documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+     * @param {string} [options.placeholder='Search for a stop...'] Input field placeholder.
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] [geOps Stops API](https://developer.geops.io/apis/stops/) url.
+     * @public
+     */
     constructor(options: StopFinderControlOptions);
     onSuggestionClick(suggestion: Feature): void;
+    /**
+     * Search for stations using a query.
+     *
+     * @param {string} q Query used to search stops.
+     * @param {AbortController} abortController  Abort controller used to abort requests.
+     * @returns {Promise<Array<GeoJSONFeature>>}
+     * @public
+     */
     search(q: string, abortController: AbortController): Promise<void>;
 }
 export default StopFinderControl;

package/ol/controls/StopFinderControl.js

@@ -21,9 +21,23 @@ import createDefaultStopFinderElement from '../../common/utils/createDefaultStop
  *
  *
  * @see <a href="/example/ol-search">Openlayers search example</a>
+ *
+ * @extends {ol/control/Control~Control}
+ *
  * @public
  */
 class StopFinderControl extends Control {
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {HTMLElement} options.element HTML element where to attach input and suggestions.
+     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
+     * @param {StopsSearchParams} [options.apiParams={ limit: 20 }] Request parameters. See [geOps Stops API documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+     * @param {string} [options.placeholder='Search for a stop...'] Input field placeholder.
+     * @param {string} [options.url='https://api.geops.io/stops/v1/'] [geOps Stops API](https://developer.geops.io/apis/stops/) url.
+     * @public
+     */
     constructor(options) {
         const element = createDefaultStopFinderElement();
         element.className = (options === null || options === void 0 ? void 0 : options.className) || 'mbt-stop-finder';
@@ -36,6 +50,14 @@ class StopFinderControl extends Control {
         const coord = fromLonLat(suggestion.geometry.coordinates);
         (_a = this.getMap()) === null || _a === void 0 ? void 0 : _a.getView().setCenter(coord);
     }
+    /**
+     * Search for stations using a query.
+     *
+     * @param {string} q Query used to search stops.
+     * @param {AbortController} abortController  Abort controller used to abort requests.
+     * @returns {Promise<Array<GeoJSONFeature>>}
+     * @public
+     */
     search(q, abortController) {
         return this.controller.search(q, abortController);
     }

package/ol/layers/MaplibreLayer.d.ts

@@ -125,7 +125,12 @@ declare const MaplibreLayer_base: {
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
  * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
- * @extends {MapLibreLayer}
+ *
+ *
+ * @see <a href="/example/ol-maplibre-layer">OpenLayers Maplibre layer example</a>
+ *
+ * @extends {ol/layer/Layer~Layer}
+ * @extends {geoblocks/ol-maplibre-layer/MapLibreLayer}
  * @public
  */
 declare class MaplibreLayer extends MaplibreLayer_base {

package/ol/layers/MaplibreLayer.js

@@ -38,7 +38,12 @@ if (typeof window !== 'undefined' &&
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
  * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
- * @extends {MapLibreLayer}
+ *
+ *
+ * @see <a href="/example/ol-maplibre-layer">OpenLayers Maplibre layer example</a>
+ *
+ * @extends {ol/layer/Layer~Layer}
+ * @extends {geoblocks/ol-maplibre-layer/MapLibreLayer}
  * @public
  */
 class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {

package/ol/layers/MaplibreStyleLayer.d.ts

@@ -36,12 +36,7 @@ declare const MaplibreStyleLayer_base: {
         olLayer: Layer;
         parent: Layer<Source, import("ol/renderer/Layer").default<any>>;
         visible: boolean;
-        on: import("ol/layer/Layer").LayerOnSignature<import("ol/events" /**
-         * Request feature information for a given coordinate.
-         * @param {ol/coordinate~Coordinate} coordinate Coordinate to request the information at.
-         * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
-         * @deprecated Use getFeatureInfoAtCoordinate([layer], coordinate) from mobility-toolbox-ol package instead.
-         */).EventsKey>;
+        on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
         once: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
         un: import("ol/layer/Layer").LayerOnSignature<void>;
         render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
@@ -128,6 +123,7 @@ declare const MaplibreStyleLayer_base: {
  *   },
  * });
  *
+ * @see <a href="/example/ol-maplibre-style-layer">OpenLayers MaplibreStyle layer example</a>
  * @extends {ol/layer/Layer~Layer}
  * @public
  */
@@ -143,7 +139,7 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * @param {FilterFunction} [options.layersFilter] Filter function to decide which style layer to apply visiblity on. If not provided, the 'layers' property is used.
      * @param {MaplibreLayer} [options.maplibreLayer] The MaplibreLayer to use.
      * @param {FilterFunction} [options.queryRenderedLayersFilter] Filter function to decide which style layer are available for query.
-     * @param {maplibregl.SourceSpecification[]} [options.sources] The sources to add to the style on load.
+     * @param {{[id: string]:maplibregl.SourceSpecification}} [options.sources] The sources to add to the style on load.
      * @public
      */
     constructor(options?: MaplibreStyleLayerOptions);
@@ -196,10 +192,10 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      */
     select(features?: Feature[]): void;
     /**
-     * Set the feature state of the features.
+     * Set the [feature state](https://maplibre.org/maplibre-style-spec/expressions/#feature-state) of the features.
      *
      * @param {ol/Feature~Feature[]} features
-     * @param {maplibregl.FeatureState} state The feature state
+     * @param {{[key: string]: any}} state The feature state
      * @public
      */
     setFeatureState(features: Feature[], state: FeatureState): void;

package/ol/layers/MaplibreStyleLayer.js

@@ -30,6 +30,7 @@ if (typeof window !== 'undefined' &&
  *   },
  * });
  *
+ * @see <a href="/example/ol-maplibre-style-layer">OpenLayers MaplibreStyle layer example</a>
  * @extends {ol/layer/Layer~Layer}
  * @public
  */
@@ -43,7 +44,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * @param {FilterFunction} [options.layersFilter] Filter function to decide which style layer to apply visiblity on. If not provided, the 'layers' property is used.
      * @param {MaplibreLayer} [options.maplibreLayer] The MaplibreLayer to use.
      * @param {FilterFunction} [options.queryRenderedLayersFilter] Filter function to decide which style layer are available for query.
-     * @param {maplibregl.SourceSpecification[]} [options.sources] The sources to add to the style on load.
+     * @param {{[id: string]:maplibregl.SourceSpecification}} [options.sources] The sources to add to the style on load.
      * @public
      */
     constructor(options = {
@@ -245,6 +246,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         let layers = this.layers || [];
         if (this.layersFilter) {
             layers = mapLibreMap.getStyle().layers.filter(this.layersFilter);
+            console.log(layers);
         }
         if (this.queryRenderedLayersFilter) {
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -353,10 +355,10 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         this.setHoverState(this.selectedFeatures || [], true);
     }
     /**
-     * Set the feature state of the features.
+     * Set the [feature state](https://maplibre.org/maplibre-style-spec/expressions/#feature-state) of the features.
      *
      * @param {ol/Feature~Feature[]} features
-     * @param {maplibregl.FeatureState} state The feature state
+     * @param {{[key: string]: any}} state The feature state
      * @public
      */
     setFeatureState(features, state) {

package/ol/layers/RealtimeLayer.d.ts

@@ -8,6 +8,7 @@ import { Vector as VectorSource } from 'ol/source';
 import Source from 'ol/source/Source';
 import { State } from 'ol/View';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
+import { FilterFunction, SortFunction } from '../../common/typedefs';
 import RealtimeEngine, { RealtimeEngineOptions } from '../../common/utils/RealtimeEngine';
 import { RealtimeAPI } from '../../maplibre';
 import { RealtimeFullTrajectory, RealtimeMode, RealtimeRenderState, RealtimeTrainId, ViewState } from '../../types';
@@ -121,9 +122,12 @@ declare const RealtimeLayer_base: {
  *
  *
  * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ * @see <a href="/example/ol-realtime">OpenLayers Realtime layer example</a>
+ *
  *
  * @extends {ol/layer/Layer~Layer}
  *
+ *
  * @classproperty {boolean} allowRenderWhenAnimating - Allow rendering of the layer when the map is animating.
  * @public
  */
@@ -143,7 +147,7 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      * @param {boolean} [options.allowRenderWhenAnimating=false] Allow rendering of the layer when the map is animating.
      * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
      * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The [geOps Realtime API](https://developer.geops.io/apis/realtime/) url.
-     *
+     * @public
      */
     constructor(options: RealtimeLayerOptions);
     attachToMap(map: Map): void;
@@ -170,6 +174,7 @@ declare class RealtimeLayer extends RealtimeLayer_base {
         fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
         stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
     }>;
+    getVehicles(filterFunc: FilterFunction): import("../../types").RealtimeTrajectory[];
     getViewState(): {
         center?: undefined;
         extent?: undefined;
@@ -217,7 +222,8 @@ declare class RealtimeLayer extends RealtimeLayer_base {
     get api(): RealtimeAPI;
     set api(api: RealtimeAPI);
     get canvas(): import("../../types").AnyCanvas | undefined;
-    get filter(): Function | undefined;
+    get filter(): FilterFunction | undefined;
+    set filter(filter: FilterFunction);
     get hoverVehicleId(): RealtimeTrainId | undefined;
     set hoverVehicleId(id: RealtimeTrainId);
     get mode(): RealtimeMode;
@@ -225,7 +231,8 @@ declare class RealtimeLayer extends RealtimeLayer_base {
     get pixelRatio(): number | undefined;
     get selectedVehicleId(): RealtimeTrainId | undefined;
     set selectedVehicleId(id: RealtimeTrainId);
-    get sort(): Function | undefined;
+    get sort(): SortFunction | undefined;
+    set sort(sort: SortFunction);
     get trajectories(): Record<string, import("../../types").RealtimeTrajectory> | undefined;
 }
 export default RealtimeLayer;

package/ol/layers/RealtimeLayer.js

@@ -23,9 +23,12 @@ const format = new GeoJSON();
  *
  *
  * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ * @see <a href="/example/ol-realtime">OpenLayers Realtime layer example</a>
+ *
  *
  * @extends {ol/layer/Layer~Layer}
  *
+ *
  * @classproperty {boolean} allowRenderWhenAnimating - Allow rendering of the layer when the map is animating.
  * @public
  */
@@ -37,7 +40,7 @@ class RealtimeLayer extends MobilityLayerMixin(Layer) {
      * @param {boolean} [options.allowRenderWhenAnimating=false] Allow rendering of the layer when the map is animating.
      * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
      * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The [geOps Realtime API](https://developer.geops.io/apis/realtime/) url.
-     *
+     * @public
      */
     constructor(options) {
         // We use a group to be able to add custom vector layer in extended class.
@@ -142,6 +145,9 @@ class RealtimeLayer extends MobilityLayerMixin(Layer) {
             return response;
         });
     }
+    getVehicles(filterFunc) {
+        return this.engine.getVehicles(filterFunc);
+    }
     getViewState() {
         var _a;
         if (!((_a = this.map) === null || _a === void 0 ? void 0 : _a.getView())) {
@@ -264,6 +270,9 @@ class RealtimeLayer extends MobilityLayerMixin(Layer) {
     get filter() {
         return this.engine.filter;
     }
+    set filter(filter) {
+        this.engine.filter = filter;
+    }
     get hoverVehicleId() {
         return this.engine.hoverVehicleId;
     }
@@ -288,6 +297,9 @@ class RealtimeLayer extends MobilityLayerMixin(Layer) {
     get sort() {
         return this.engine.sort;
     }
+    set sort(sort) {
+        this.engine.sort = sort;
+    }
     get trajectories() {
         return this.engine.trajectories;
     }