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

package/ol/controls/RoutingControl.d.ts

@@ -6,12 +6,13 @@ 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;
     graphs?: RoutingGraph[];
@@ -19,13 +20,13 @@ export type RoutingControlOptions = Options & {
     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/).
@@ -77,7 +78,7 @@ declare class RoutingControl extends Control {
     onMapClickKey?: EventsKey;
     onRouteError: (error?: Error, control?: RoutingControl) => void;
     routingApiParams?: RoutingParameters;
-    routingLayer?: VectorLayer<Feature>;
+    routingLayer?: VectorLayer<VectorSource>;
     segments: Feature<LineString>[];
     snapToClosestStation: boolean;
     stopsApiKey?: string;

package/ol/controls/RoutingControl.js

@@ -18,22 +18,17 @@ 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) => {
@@ -95,36 +90,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.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 +115,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 +166,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 +193,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);
     }
     /**
@@ -243,7 +218,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 +243,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
@@ -585,7 +559,6 @@ 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(),
             segmentIndex,

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/).
  *
@@ -28,9 +28,6 @@ export type StopFinderControlOptions = Options & StopFinderControlCommon & {
 declare class StopFinderControl extends Control {
     controller: StopFinderControlCommon;
     constructor(options: StopFinderControlOptions);
-    /**
-     * @private
-     */
     onSuggestionClick(suggestion: Feature): void;
     search(q: string, abortController: AbortController): Promise<void>;
 }

package/ol/controls/StopFinderControl.js

@@ -31,9 +31,6 @@ 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);

package/ol/layers/MaplibreLayer.d.ts

@@ -124,31 +124,33 @@ declare const MaplibreLayer_base: {
  * });
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
- * @classproperty {string} style - geOps Maps api style.
- * @extends {ol/layer/Layer~Layer}
+ * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+ * @extends {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 +159,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,20 @@ if (typeof window !== 'undefined' &&
  * });
  *
  * @classproperty {maplibregl.Map} mapLibreMap - The Maplibre map object. Readonly.
- * @classproperty {string} style - geOps Maps api style.
- * @extends {ol/layer/Layer~Layer}
+ * @classproperty {string} style - The [geOps Maps API](https://developer.geops.io/apis/maps) style.
+ * @extends {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 +69,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 +91,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 +136,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;

package/ol/layers/MaplibreStyleLayer.d.ts

@@ -8,13 +8,13 @@ import { FilterFunction } from '../../common/typedefs';
 import { LayerGetFeatureInfoResponse } from '../../types';
 import MaplibreStyleLayerRenderer from '../renderers/MaplibreStyleLayerRenderer';
 import MaplibreLayer, { MaplibreLayerOptions } from './MaplibreLayer';
-export type MaplibreStyleLayerOptions = MaplibreLayerOptions & {
+export type MaplibreStyleLayerOptions = {
     beforeId?: string;
     layers?: maplibregl.AddLayerObject[];
     layersFilter?: FilterFunction;
     maplibreLayer?: MaplibreLayer;
     queryRenderedLayersFilter?: FilterFunction;
-};
+} & MaplibreLayerOptions;
 declare const MaplibreStyleLayer_base: {
     new (...args: any[]): {
         olEventsKeys: import("ol/events").EventsKey[];
@@ -36,7 +36,12 @@ 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").EventsKey>;
+        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>;
         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;
@@ -106,22 +111,25 @@ declare const MaplibreStyleLayer_base: {
     };
 } & typeof Layer;
 /**
- * Layer for visualizing a specific set of layer from a MapboxLayer.
+ * Layer that helps show/hide a specific subset of style layers of a [MaplibreLayer](./MaplibreLayer.js~MaplibreLayer.html).
  *
  * @example
- * import { MapboxLayer, MapboxStyleLayer } from 'mobility-toolbox-js/ol';
+ * import { MaplibreLayer, MaplibreStyleLayer } from 'mobility-toolbox-js/ol';
  *
- * const maplibreLayer = new MapboxLayer({
- *   url: 'https://maps.geops.io/styles/travic_v2/style.json?key=[yourApiKey]',
+ * const maplibreLayer = new MaplibreLayer({
+ *   apiKey: 'yourApiKey',
  * });
  *
- * const layer = new MapboxStyleLayer({
+ * const layer = new MaplibreStyleLayer({
  *   maplibreLayer: maplibreLayer,
- *   styleLayersFilter: () => {},
+ *   layersFilter: (layer) => {
+ *     // show/hide only style layers related to stations
+ *     return /station/.test(layer.id);
+ *   },
  * });
  *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
  * @extends {ol/layer/Layer~Layer}
+ * @public
  */
 declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
     highlightedFeatures: Feature[];
@@ -130,16 +138,16 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * Constructor.
      *
      * @param {Object} options
-     * @param {MapboxLayer} [options.maplibreLayer] The MaplibreLayer to use.
-     * @param {maplibregl.SourceSpecification[]} [options.sources] The source to add to the style on load.
+     * @param {string} [options.beforeId] The style layer id to use when the options.layers property is defined, unsused otherwise.
      * @param {maplibregl.AddLayerObject[]} [options.layers] The layers to add to the style on load.
      * @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.
+     * @public
      */
     constructor(options?: MaplibreStyleLayerOptions);
-    /** @private */
     addLayers(): void;
-    /** @private */
     addSources(): void;
     applyLayoutVisibility(evt?: ObjectEvent): void;
     /**
@@ -149,9 +157,11 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      */
     attachToMap(map: Map): void;
     /**
-     * Create a copy of the MapboxStyleLayer.
-     * @param {Object} newOptions Options to override.
-     * @return {MapboxStyleLayer} A MapboxStyleLayer.
+     * Create a copy of the MaplibreStyleLayer.
+     *
+     * @param {Object} newOptions Options to override. See constructor.
+     * @return {MapboxStyleLayer} A MaplibreStyleLayer.
+     * @public
      */
     clone(newOptions: MaplibreStyleLayerOptions): MaplibreStyleLayer;
     createRenderer(): MaplibreStyleLayerRenderer;
@@ -164,33 +174,32 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * 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.
      */
     getFeatureInfoAtCoordinate(coordinate: Coordinate): Promise<LayerGetFeatureInfoResponse>;
     /**
      * Highlight a list of features.
      * @param {Array<ol/Feature~Feature>} [features=[]] Features to highlight.
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     highlight(features?: Feature[]): void;
     /**
      * On Maplibre map load callback function. Add style layers and dynaimc filters.
-     * @private
      */
     onLoad(): void;
-    /** @private */
     removeLayers(): void;
-    /** @private */
     removeSources(): void;
     /**
      * Select a list of features.
      * @param {Array<ol/Feature~Feature>} [features=[]] Features to select.
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {selected: true|false}) instead.
      */
     select(features?: Feature[]): void;
     /**
      * Set the feature state of the features.
-     * @param {Array<ol/Feature~Feature>} features
-     * @param {{[key:string]:boolean}} state The feature state
+     *
+     * @param {ol/Feature~Feature[]} features
+     * @param {maplibregl.FeatureState} state The feature state
      * @public
      */
     setFeatureState(features: Feature[], state: FeatureState): void;
@@ -198,15 +207,18 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * Set if features are hovered or not.
      * @param {Array<ol/Feature~Feature>} features
      * @param {boolean} state Is the feature hovered
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     setHoverState(features: Feature[], state: boolean): void;
     get beforeId(): string;
-    set beforeId(newValue: string[]);
+    set beforeId(newValue: string | undefined);
     get layers(): maplibregl.AddLayerObject[];
     set layers(newValue: maplibregl.AddLayerObject[]);
     get layersFilter(): (layer: maplibregl.LayerSpecification) => boolean;
     set layersFilter(newValue: (layer: maplibregl.LayerSpecification) => boolean);
+    /**
+     * @deprecated Use MaplibreStyleLayer.maplibreLayer instead.
+     */
     get mapboxLayer(): MaplibreLayer | undefined;
     get maplibreLayer(): MaplibreLayer;
     set maplibreLayer(newValue: MaplibreLayer);
@@ -215,7 +227,7 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
     get sources(): Record<string, maplibregl.SourceSpecification>;
     set sources(newValue: Record<string, maplibregl.SourceSpecification>);
     /**
-     * @deprecated
+     * @deprecated Use MaplibreStyleLayer.layer instead.
      */
     get styleLayer(): maplibregl.AddLayerObject;
     /**