mobility-toolbox-js 3.0.0-beta.32 → 3.0.0-beta.34

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

@@ -6,29 +6,31 @@ import { Geometry, LineString, Point } from 'ol/geom';
 import { Modify } from 'ol/interaction';
 import { ModifyEvent } from 'ol/interaction/Modify';
 import VectorLayer from 'ol/layer/Vector';
+import VectorSource from 'ol/source/Vector';
 import { RoutingAPI } from '../../api';
 import type { Map, MapBrowserEvent } from 'ol';
 import type { Coordinate } from 'ol/coordinate';
 import type { StyleLike } from 'ol/style/Style';
 import type { RoutingGraph, RoutingMot, RoutingParameters, RoutingViaPoint } from '../../types';
-export type RoutingControlOptions = Options & {
+export type RoutingControlOptions = {
     active?: boolean;
     apiKey?: string;
+    apiParams?: RoutingParameters;
     graphs?: RoutingGraph[];
     modify?: boolean;
     mot?: string;
     onRouteError?: () => void;
-    routingApiParams?: RoutingParameters;
-    routingLayer?: VectorLayer<Feature>;
+    routingLayer?: VectorLayer<VectorSource>;
     snapToClosestStation?: boolean;
     stopsApiKey?: string;
     stopsApiUrl?: string;
     style?: StyleLike;
     useRawViaPoints?: boolean;
-};
+} & 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';
@@ -40,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[];
@@ -76,14 +72,29 @@ declare class RoutingControl extends Control {
     modifyInteraction?: Modify;
     onMapClickKey?: EventsKey;
     onRouteError: (error?: Error, control?: RoutingControl) => void;
-    routingApiParams?: RoutingParameters;
-    routingLayer?: VectorLayer<Feature>;
+    routingLayer?: VectorLayer<VectorSource>;
     segments: Feature<LineString>[];
     snapToClosestStation: boolean;
     stopsApiKey?: string;
     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.
@@ -108,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

@@ -18,27 +18,22 @@ import { RoutingAPI } from '../../api';
 // @47.37811,8.53935 a station at position 47.37811, 8.53935
 // @47.37811,8.53935$4 track 4 in a station at position 47.37811, 8.53935
 // zürich hb@47.37811,8.53935$8 track 8 in station "Zürich HB" at position 47.37811, 8.53935
-/** @private */
 const REGEX_VIA_POINT = /^([^@$!\n]*)(@?([\d.]+),([\d.]+))?(\$?([a-zA-Z0-9]{0,2}))$/;
 // Examples for a single hop:
 //
 // 47.37811,8.53935 a position 47.37811, 8.53935
-/** @private */
 const REGEX_VIA_POINT_COORD = /^([\d.]+),([\d.]+)$/;
 // Examples for a single hop:
 //
 // !8596126 a station with id 8596126
 // !8596126$4 a station with id 8596126
-/** @private */
 const REGEX_VIA_POINT_STATION_ID = /^!([^$]*)(\$?([a-zA-Z0-9]{0,2}))$/;
-/** @private */
 const STOP_FETCH_ABORT_CONTROLLER_KEY = 'stop-fetch';
-/** @private */
 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);
@@ -47,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';
@@ -59,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 = {};
@@ -95,36 +100,23 @@ class RoutingControl extends Control {
         }
         /** True if the control is requesting the backend. */
         this.loading = false;
-        /** @private */
         this.active = options.active || true;
-        /** @private */
         this.graphs = options.graphs || [['osm', 0, 99]];
-        /** @private */
         this.mot = options.mot || 'bus';
-        /** @private */
         this.modify = options.modify !== false;
-        /** @private */
-        this.routingApiParams = options.routingApiParams;
-        /** @private */
+        this.apiParams = options.apiParams;
         this.useRawViaPoints = options.useRawViaPoints || false;
-        /** @private */
         this.snapToClosestStation = options.snapToClosestStation || false;
-        /** @private */
         this.apiKey = options.apiKey;
-        /** @private */
         this.stopsApiKey = options.stopsApiKey || this.apiKey;
-        /** @private */
         this.stopsApiUrl = options.stopsApiUrl || 'https://api.geops.io/stops/v1/';
-        /** @private */
         this.api = new RoutingAPI(Object.assign({}, options));
-        /** @private */
         this.routingLayer =
             options.routingLayer ||
                 new VectorLayer({
                     source: new VectorSource(),
                     style: options.style,
                 });
-        /** @private */
         this.onRouteError =
             options.onRouteError ||
                 ((error) => {
@@ -133,13 +125,9 @@ class RoutingControl extends Control {
                     // eslint-disable-next-line no-console
                     console.error(error);
                 });
-        /** @private */
         this.onMapClick = this.onMapClick.bind(this);
-        /** @private */
         this.onModifyEnd = this.onModifyEnd.bind(this);
-        /** @private */
         this.onModifyStart = this.onModifyStart.bind(this);
-        /** @private */
         this.createModifyInteraction();
         this.on('propertychange', (evt) => {
             if (evt.key === 'active') {
@@ -188,11 +176,9 @@ class RoutingControl extends Control {
         var _a;
         const map = this.getMap();
         if (map) {
-            /** @private */
             this.format = new GeoJSON({
                 featureProjection: map.getView().getProjection(),
             });
-            /** @private */
             this.graphsResolutions = RoutingControl.getGraphsResolutions(this.graphs, map);
             // Clean the modifyInteraction if present
             if (this.modifyInteraction) {
@@ -217,7 +203,6 @@ class RoutingControl extends Control {
             return;
         }
         this.removeListeners();
-        /** @private */
         this.onMapClickKey = (_a = this.getMap()) === null || _a === void 0 ? void 0 : _a.on('singleclick', this.onMapClick);
     }
     /**
@@ -226,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
@@ -243,7 +228,6 @@ class RoutingControl extends Control {
      * @private
      */
     createDefaultElement() {
-        /** @private */
         this.element = document.createElement('button');
         this.element.id = 'ol-toggle-routing';
         this.element.innerHTML = 'Toggle Route Control';
@@ -269,9 +253,9 @@ class RoutingControl extends Control {
             // hitDetection: this.routingLayer, // Create a bug, the first point is always selected even if the mous eis far away
             deleteCondition: (e) => {
                 var _a;
-                const feats = (_a = e.target) === null || _a === void 0 ? void 0 : _a.getFeaturesAtPixel(e.pixel, {
+                const feats = ((_a = e.target) === null || _a === void 0 ? void 0 : _a.getFeaturesAtPixel(e.pixel, {
                     hitTolerance: 5,
-                } || []);
+                })) || [];
                 const viaPoint = feats.find((feat) => { var _a; return ((_a = feat.getGeometry()) === null || _a === void 0 ? void 0 : _a.getType()) === 'Point' && feat.get('index'); });
                 if (click(e) && viaPoint) {
                     // Remove node & viaPoint if an existing viaPoint was clicked
@@ -332,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) {
@@ -341,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);
@@ -575,7 +561,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); });
         }
@@ -585,9 +571,8 @@ class RoutingControl extends Control {
             .filter((feat) => { var _a; return ((_a = feat.getGeometry()) === null || _a === void 0 ? void 0 : _a.getType()) === 'Point'; }) ||
             [])[0];
         // Write object with modify info
-        /** @private */
         this.initialRouteDrag = {
-            oldRoute: route && route.clone(),
+            oldRoute: route === null || route === void 0 ? void 0 : route.clone(),
             segmentIndex,
             viaPoint,
         };

package/ol/controls/StopFinderControl.d.ts

@@ -1,9 +1,9 @@
 import { Feature } from 'geojson';
 import Control, { Options } from 'ol/control/Control';
 import StopFinderControlCommon from '../../common/controls/StopFinderControlCommon';
-export type StopFinderControlOptions = Options & StopFinderControlCommon & {
+export type StopFinderControlOptions = {
     className?: string;
-};
+} & Options & StopFinderControlCommon;
 /**
  * This OpenLayers control allows to search stations from the [geOps Stops API](https://developer.geops.io/apis/stops/).
  *
@@ -23,15 +23,34 @@ export type StopFinderControlOptions = Options & StopFinderControlCommon & {
  *
  *
  * @see <a href="/example/ol-search">Openlayers search example</a>
+ *
+ * @extends {ol/control/Control~Control}
+ *
  * @public
  */
 declare class StopFinderControl extends Control {
     controller: StopFinderControlCommon;
-    constructor(options: StopFinderControlOptions);
     /**
-     * @private
+     * 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';
@@ -31,14 +45,19 @@ class StopFinderControl extends Control {
         super(opt);
         this.controller = new StopFinderControlCommon(Object.assign({ onSuggestionClick: this.onSuggestionClick.bind(this) }, opt));
     }
-    /**
-     * @private
-     */
     onSuggestionClick(suggestion) {
         var _a;
         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

@@ -124,31 +124,38 @@ declare const MaplibreLayer_base: {
  * });
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
- * @classproperty {string} style - geOps Maps api style.
+ * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+ *
+ *
+ * @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 {
     /**
      * Constructor.
      *
-     * @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 {maplibregl.MapOptions} [options.mapLibreOptions={ 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 {Object} options
+     * @param {string} options.apiKey Accesss key for [geOps APIs](https://developer.geops.io/).
+     * @param {string} [options.apiKeyName="key"] The [geOps Maps API](https://developer.geops.io/apis/maps) key name.
+     * @param {maplibregl.MapOptions} [options.mapLibreOptions={ interactive: false, trackResize: false, attributionControl: false }] MapLibre map options.
+     * @param {string} [options.style="travic_v2"] The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+     * @param {string} [options.url="https://maps.geops.io"] The [geOps Maps API](https://developer.geops.io/apis/maps) url.
      */
     constructor(options: MaplibreLayerOptions);
     /**
      * Initialize the layer and listen to feature clicks.
-     * @param {ol/Map~Map} map
+     * @param {ol/Map~Map} map An OpenLayers map.
      */
     attachToMap(map: OlMap): void;
     /**
      * Create a copy of the MaplibreLayer.
-     * @param {MaplibreLayerOptions} newOptions Options to override
+     *
+     * @param {Object} newOptions Options to override. See constructor.
      * @return {MaplibreLayer} A MaplibreLayer layer
+     * @public
      */
     clone(newOptions: MaplibreLayerOptions): MaplibreLayer;
     getStyle(): string;
@@ -157,7 +164,13 @@ declare class MaplibreLayer extends MaplibreLayer_base {
     get apiKey(): string;
     set apiKeyName(newValue: string);
     get apiKeyName(): string;
+    /**
+     * @deprecated Use layer.mapLibreMap.
+     */
     get maplibreMap(): maplibregl.Map | undefined;
+    /**
+     * @deprecated Use layer.mapLibreMap.
+     */
     get mbMap(): maplibregl.Map | undefined;
     get style(): string;
     set style(newValue: string);

package/ol/layers/MaplibreLayer.js

@@ -37,20 +37,25 @@ if (typeof window !== 'undefined' &&
  * });
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
- * @classproperty {string} style - geOps Maps api style.
+ * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+ *
+ *
+ * @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) {
     /**
      * Constructor.
      *
-     * @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 {maplibregl.MapOptions} [options.mapLibreOptions={ 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 {Object} options
+     * @param {string} options.apiKey Accesss key for [geOps APIs](https://developer.geops.io/).
+     * @param {string} [options.apiKeyName="key"] The [geOps Maps API](https://developer.geops.io/apis/maps) key name.
+     * @param {maplibregl.MapOptions} [options.mapLibreOptions={ interactive: false, trackResize: false, attributionControl: false }] MapLibre map options.
+     * @param {string} [options.style="travic_v2"] The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+     * @param {string} [options.url="https://maps.geops.io"] The [geOps Maps API](https://developer.geops.io/apis/maps) url.
      */
     constructor(options) {
         var _a;
@@ -69,7 +74,7 @@ class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
     }
     /**
      * Initialize the layer and listen to feature clicks.
-     * @param {ol/Map~Map} map
+     * @param {ol/Map~Map} map An OpenLayers map.
      */
     attachToMap(map) {
         super.attachToMap(map);
@@ -91,8 +96,10 @@ class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
     // }
     /**
      * Create a copy of the MaplibreLayer.
-     * @param {MaplibreLayerOptions} newOptions Options to override
+     *
+     * @param {Object} newOptions Options to override. See constructor.
      * @return {MaplibreLayer} A MaplibreLayer layer
+     * @public
      */
     clone(newOptions) {
         return new MaplibreLayer(Object.assign(Object.assign({}, (this.options || {})), (newOptions || {})));
@@ -134,10 +141,16 @@ class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
     get apiKeyName() {
         return this.get('apiKeyName');
     }
+    /**
+     * @deprecated Use layer.mapLibreMap.
+     */
     get maplibreMap() {
         deprecated('MaplibreLayer.maplibreMap is deprecated. Use layer.mapLibreMap.');
         return this.mapLibreMap;
     }
+    /**
+     * @deprecated Use layer.mapLibreMap.
+     */
     get mbMap() {
         deprecated('MaplibreLayer.mbMap is deprecated. Use layer.maplibreMap.');
         return this.maplibreMap;