mobility-toolbox-js 3.0.0-beta.2 → 3.0.0-beta.21

package/ol/controls/RoutingControl.js

@@ -1,15 +1,15 @@
 import { Feature } from 'ol';
+import Control from 'ol/control/Control';
+import { click } from 'ol/events/condition';
+import BaseEvent from 'ol/events/Event';
+import { buffer } from 'ol/extent';
+import { GeoJSON } from 'ol/format';
 import { LineString, Point } from 'ol/geom';
 import { Modify } from 'ol/interaction';
+import VectorLayer from 'ol/layer/Vector';
 import { unByKey } from 'ol/Observable';
-import { click } from 'ol/events/condition';
-import { GeoJSON } from 'ol/format';
-import { buffer } from 'ol/extent';
 import { fromLonLat, toLonLat } from 'ol/proj';
-import BaseEvent from 'ol/events/Event';
-import VectorLayer from 'ol/layer/Vector';
 import VectorSource from 'ol/source/Vector';
-import Control from 'ol/control/Control';
 import { RoutingAPI } from '../../api';
 // Examples for a single hop:
 // basel sbb a station named "basel sbb"
@@ -38,7 +38,7 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
     const coords = [];
     segmentArray.forEach((seg) => {
         var _a;
-        // @ts-ignore
+        // @ts-expect-error
         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 +47,7 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
     return coords;
 };
 /**
- * Display a route of a specified mean of transport.
+ * 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';
@@ -79,41 +79,20 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
  * @public
  */
 class RoutingControl extends Control {
-    get active() {
-        return this.get('active');
-    }
-    set active(newValue) {
-        this.set('active', newValue);
-    }
-    get loading() {
-        return this.get('loading');
-    }
-    set loading(newValue) {
-        this.set('loading', newValue);
-    }
-    get modify() {
-        return this.get('modify');
-    }
-    set modify(newValue) {
-        this.set('modify', newValue);
-    }
-    get mot() {
-        return this.get('mot');
-    }
-    set mot(newValue) {
-        this.set('mot', newValue);
-    }
     constructor(options = {}) {
         super(options);
-        this.viaPoints = [];
-        this.graphs = [];
-        this.useRawViaPoints = false;
-        this.snapToClosestStation = false;
-        this.cacheStationData = {};
         this.abortControllers = {};
-        this.segments = [];
+        this.cacheStationData = {};
         this.format = new GeoJSON({ featureProjection: 'EPSG:3857' });
+        this.graphs = [];
         this.initialRouteDrag = {};
+        this.segments = [];
+        this.snapToClosestStation = false;
+        this.useRawViaPoints = false;
+        this.viaPoints = [];
+        if (!this.element) {
+            this.createDefaultElement();
+        }
         /** True if the control is requesting the backend. */
         this.loading = false;
         /** @private */
@@ -186,17 +165,60 @@ class RoutingControl extends Control {
         ]);
     }
     /**
-     * Activet7deactivate the control when activ eproperty changes
+     * Aborts viapoint and route requests
      * @private
      */
-    onActiveChange() {
-        if (this.get('active')) {
-            this.activate();
+    abortRequests() {
+        var _a;
+        // Abort Routing API requests
+        this.graphs.forEach((graph) => {
+            const graphName = graph[0];
+            if (this.abortControllers[graphName]) {
+                this.abortControllers[graphName].abort();
+            }
+            this.abortControllers[graphName] = new AbortController();
+        });
+        // Abort Stops API requests
+        (_a = this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY]) === null || _a === void 0 ? void 0 : _a.abort();
+        this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY] =
+            new AbortController();
+        this.loading = false;
+    }
+    activate() {
+        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) {
+                map.removeInteraction(this.modifyInteraction);
+            }
+            // Add modify interaction, RoutingLayer and listeners
+            // this.routingLayer?.attachToMap(this.getMap());
+            if (this.modifyInteraction) {
+                map.addInteraction(this.modifyInteraction);
+            }
+            (_a = this.modifyInteraction) === null || _a === void 0 ? void 0 : _a.setActive(this.modify);
+            this.addListeners();
         }
-        else {
-            this.deactivate();
+    }
+    /**
+     * Add click listener to map.
+     * @private
+     */
+    addListeners() {
+        var _a;
+        if (!this.modify) {
+            return;
         }
-        this.render();
+        this.removeListeners();
+        /** @private */
+        this.onMapClickKey = (_a = this.getMap()) === null || _a === void 0 ? void 0 : _a.on('singleclick', this.onMapClick);
     }
     /**
      * Adds/Replaces a viaPoint to the viaPoints array and redraws route:
@@ -216,60 +238,66 @@ class RoutingControl extends Control {
         this.dispatchEvent(new BaseEvent('change:route'));
     }
     /**
-     * Removes a viaPoint at the passed array index and redraws route
-     * By default the last viaPoint is removed.
-     * @param {number} index Integer representing the index of the viaPoint to delete.
-     * @public
-     */
-    removeViaPoint(index = (this.viaPoints || []).length - 1) {
-        /* Remove viapoint and redraw route */
-        if (this.viaPoints.length && this.viaPoints[index]) {
-            this.viaPoints.splice(index, 1);
-        }
-        this.drawRoute();
-        this.dispatchEvent(new BaseEvent('change:route'));
-    }
-    /**
-     * Replaces the current viaPoints with a new coordinate array.
-     * @param {Array<Array<number>>} coordinateArray Array of nested coordinates
-     * @public
-     */
-    setViaPoints(coordinateArray) {
-        this.viaPoints = [...coordinateArray];
-        this.drawRoute();
-        this.dispatchEvent(new BaseEvent('change:route'));
-    }
-    /**
-     * Removes all viaPoints, clears the source and triggers a change event
-     * @public
+     * Define a default element.
+     *
+     * @private
      */
-    reset() {
-        var _a, _b;
-        // Clear viaPoints and source
-        this.abortRequests();
-        this.viaPoints = [];
-        (_b = (_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear();
-        this.dispatchEvent(new BaseEvent('change:route'));
+    createDefaultElement() {
+        /** @private */
+        this.element = document.createElement('button');
+        this.element.id = 'ol-toggle-routing';
+        this.element.innerHTML = 'Toggle Route Control';
+        this.element.onclick = () => this.active ? this.deactivate() : this.activate();
+        Object.assign(this.element.style, {
+            position: 'absolute',
+            right: '10px',
+            top: '10px',
+        });
     }
     /**
-     * Aborts viapoint and route requests
+     * Create the interaction used to modify vertexes of features.
      * @private
      */
-    abortRequests() {
+    createModifyInteraction() {
         var _a;
-        // Abort Routing API requests
-        this.graphs.forEach((graph) => {
-            const graphName = graph[0];
-            if (this.abortControllers[graphName]) {
-                this.abortControllers[graphName].abort();
-            }
-            this.abortControllers[graphName] = new AbortController();
+        /**
+         * @type {ol.interaction.Modify}
+         * @private
+         */
+        // Define and add modify interaction
+        this.modifyInteraction = new Modify({
+            // 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, {
+                    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
+                    this.removeViaPoint(viaPoint.get('index'));
+                    return true;
+                }
+                return false;
+            },
+            pixelTolerance: 6,
+            source: ((_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) || undefined,
         });
-        // Abort Stops API requests
-        (_a = this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY]) === null || _a === void 0 ? void 0 : _a.abort();
-        this.abortControllers[STOP_FETCH_ABORT_CONTROLLER_KEY] =
-            new AbortController();
-        this.loading = false;
+        this.modifyInteraction.on('modifystart', this.onModifyStart);
+        this.modifyInteraction.on('modifyend', this.onModifyEnd);
+        this.modifyInteraction.setActive(false);
+    }
+    deactivate() {
+        const map = this.getMap();
+        if (map) {
+            // Remove modify interaction, RoutingLayer, listeners and viaPoints
+            // this.routingLayer?.detachFromMap();
+            if (this.modifyInteraction) {
+                map.removeInteraction(this.modifyInteraction);
+            }
+            this.removeListeners();
+            this.reset();
+        }
     }
     /**
      * Draws route on map using an array of coordinates:
@@ -311,9 +339,9 @@ class RoutingControl extends Control {
                 return Promise.resolve([]);
             }
             return this.api
-                .route(Object.assign({ graph, via: `${formattedViaPoints.join('|')}`, mot: this.mot, 
-                // @ts-ignore missing property in swagger
-                'resolve-hops': false, elevation: false, 'coord-radius': 100.0, 'coord-punish': 1000.0 }, (this.routingApiParams || {})), { signal })
+                .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 })
                 .then((featureCollection) => {
                 var _a, _b, _c;
                 this.segments = this.format.readFeatures(featureCollection);
@@ -471,6 +499,19 @@ class RoutingControl extends Control {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Activet7deactivate the control when activ eproperty changes
+     * @private
+     */
+    onActiveChange() {
+        if (this.get('active')) {
+            this.activate();
+        }
+        else {
+            this.deactivate();
+        }
+        this.render();
+    }
     /**
      * Used on click on map while control is active:
      *   By default adds a viaPoint to the end of array.
@@ -479,8 +520,8 @@ class RoutingControl extends Control {
      */
     onMapClick(evt) {
         const feats = evt.target.getFeaturesAtPixel(evt.pixel, {
-            layerFilter: (layer) => layer === this.routingLayer,
             hitTolerance: 5,
+            layerFilter: (layer) => layer === this.routingLayer,
         });
         const viaPoint = feats.find((feat) => {
             var _a;
@@ -494,6 +535,30 @@ class RoutingControl extends Control {
         }
         this.addViaPoint(evt.coordinate);
     }
+    /**
+     * Used on end of the modify interaction. Resolves feature modification:
+     *   Line drag creates new viaPoint at the final coordinate of drag.
+     *   Point drag replaces old viaPoint.
+     * @private
+     */
+    onModifyEnd(evt) {
+        const coord = evt.mapBrowserEvent.coordinate;
+        const { oldRoute, segmentIndex, viaPoint } = this.initialRouteDrag || {};
+        // If viaPoint is being relocated overwrite the old viaPoint
+        if (viaPoint) {
+            return this.addViaPoint(coord, viaPoint.get('viaPointIdx'), 1);
+        }
+        // In case there is no route overwrite first coordinate
+        if (!oldRoute) {
+            return this.addViaPoint(coord, 0, 1);
+        }
+        // We can't add a via point because we haven't found which segment has been modified.
+        if (segmentIndex === -1) {
+            return Promise.reject(new Error('No segment found'));
+        }
+        // Insert new viaPoint at the  modified segment index + 1
+        return this.addViaPoint(coord, (segmentIndex || 0) + 1);
+    }
     /**
      * Used on start of the modify interaction. Stores relevant data
      * in this.initialRouteDrag object
@@ -507,10 +572,10 @@ class RoutingControl extends Control {
             .getArray()
             .find((feat) => { var _a; return ((_a = feat.getGeometry()) === null || _a === void 0 ? void 0 : _a.getType()) === 'LineString'; });
         // Find the segment index that is being modified
-        if (route && route.getGeometry() && evt.mapBrowserEvent.coordinate) {
+        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-ignore
+            // @ts-expect-error
             (_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); });
         }
@@ -522,106 +587,46 @@ class RoutingControl extends Control {
         // Write object with modify info
         /** @private */
         this.initialRouteDrag = {
-            viaPoint,
             oldRoute: route && route.clone(),
             segmentIndex,
+            viaPoint,
         };
     }
     /**
-     * Used on end of the modify interaction. Resolves feature modification:
-     *   Line drag creates new viaPoint at the final coordinate of drag.
-     *   Point drag replaces old viaPoint.
+     * Remove click listener from map.
      * @private
      */
-    onModifyEnd(evt) {
-        const coord = evt.mapBrowserEvent.coordinate;
-        const { oldRoute, viaPoint, segmentIndex } = this.initialRouteDrag || {};
-        // If viaPoint is being relocated overwrite the old viaPoint
-        if (viaPoint) {
-            return this.addViaPoint(coord, viaPoint.get('viaPointIdx'), 1);
-        }
-        // In case there is no route overwrite first coordinate
-        if (!oldRoute) {
-            return this.addViaPoint(coord, 0, 1);
-        }
-        // We can't add a via point because we haven't found which segment has been modified.
-        if (segmentIndex === -1) {
-            return Promise.reject(new Error('No segment found'));
+    removeListeners() {
+        if (this.onMapClickKey) {
+            unByKey(this.onMapClickKey);
         }
-        // Insert new viaPoint at the  modified segment index + 1
-        return this.addViaPoint(coord, (segmentIndex || 0) + 1);
-    }
-    /**
-     * Define a default element.
-     *
-     * @private
-     */
-    createDefaultElement() {
-        /** @private */
-        this.element = document.createElement('button');
-        this.element.id = 'ol-toggle-routing';
-        this.element.innerHTML = 'Toggle Route Control';
-        this.element.onclick = () => this.active ? this.deactivate() : this.activate();
-        Object.assign(this.element.style, {
-            position: 'absolute',
-            right: '10px',
-            top: '10px',
-        });
     }
     /**
-     * Create the interaction used to modify vertexes of features.
-     * @private
-     */
-    createModifyInteraction() {
-        var _a;
-        /**
-         * @type {ol.interaction.Modify}
-         * @private
-         */
-        // Define and add modify interaction
-        this.modifyInteraction = new Modify({
-            source: ((_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) || undefined,
-            pixelTolerance: 6,
-            // 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, {
-                    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
-                    this.removeViaPoint(viaPoint.get('index'));
-                    return true;
-                }
-                return false;
-            },
-        });
-        this.modifyInteraction.on('modifystart', this.onModifyStart);
-        this.modifyInteraction.on('modifyend', this.onModifyEnd);
-        this.modifyInteraction.setActive(false);
-    }
-    /**
-     * Add click listener to map.
-     * @private
+     * Removes a viaPoint at the passed array index and redraws route
+     * By default the last viaPoint is removed.
+     * @param {number} index Integer representing the index of the viaPoint to delete.
+     * @public
      */
-    addListeners() {
-        var _a;
-        if (!this.modify) {
-            return;
+    removeViaPoint(index = (this.viaPoints || []).length - 1) {
+        /* Remove viapoint and redraw route */
+        if (this.viaPoints.length && this.viaPoints[index]) {
+            this.viaPoints.splice(index, 1);
         }
-        this.removeListeners();
-        /** @private */
-        this.onMapClickKey = (_a = this.getMap()) === null || _a === void 0 ? void 0 : _a.on('singleclick', this.onMapClick);
+        this.drawRoute();
+        this.dispatchEvent(new BaseEvent('change:route'));
     }
+    render() { }
     /**
-     * Remove click listener from map.
-     * @private
+     * Removes all viaPoints, clears the source and triggers a change event
+     * @public
      */
-    removeListeners() {
-        if (this.onMapClickKey) {
-            unByKey(this.onMapClickKey);
-        }
+    reset() {
+        var _a, _b;
+        // Clear viaPoints and source
+        this.abortRequests();
+        this.viaPoints = [];
+        (_b = (_a = this.routingLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear();
+        this.dispatchEvent(new BaseEvent('change:route'));
     }
     setMap(map) {
         super.setMap(map);
@@ -632,43 +637,39 @@ class RoutingControl extends Control {
             this.active = false;
         }
     }
-    activate() {
-        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) {
-                map.removeInteraction(this.modifyInteraction);
-            }
-            // Add modify interaction, RoutingLayer and listeners
-            // @ts-ignore
-            // this.routingLayer?.attachToMap(this.getMap());
-            if (this.modifyInteraction) {
-                map.addInteraction(this.modifyInteraction);
-            }
-            (_a = this.modifyInteraction) === null || _a === void 0 ? void 0 : _a.setActive(this.modify);
-            this.addListeners();
-        }
+    /**
+     * Replaces the current viaPoints with a new coordinate array.
+     * @param {Array<Array<number>>} coordinateArray Array of nested coordinates
+     * @public
+     */
+    setViaPoints(coordinateArray) {
+        this.viaPoints = [...coordinateArray];
+        this.drawRoute();
+        this.dispatchEvent(new BaseEvent('change:route'));
     }
-    deactivate() {
-        const map = this.getMap();
-        if (map) {
-            // Remove modify interaction, RoutingLayer, listeners and viaPoints
-            // @ts-ignore
-            // this.routingLayer?.detachFromMap();
-            if (this.modifyInteraction) {
-                map.removeInteraction(this.modifyInteraction);
-            }
-            this.removeListeners();
-            this.reset();
-        }
+    get active() {
+        return this.get('active');
+    }
+    set active(newValue) {
+        this.set('active', newValue);
+    }
+    get loading() {
+        return this.get('loading');
+    }
+    set loading(newValue) {
+        this.set('loading', newValue);
+    }
+    get modify() {
+        return this.get('modify');
+    }
+    set modify(newValue) {
+        this.set('modify', newValue);
+    }
+    get mot() {
+        return this.get('mot');
+    }
+    set mot(newValue) {
+        this.set('mot', newValue);
     }
-    render() { }
 }
 export default RoutingControl;

package/ol/controls/StopFinderControl.d.ts

@@ -0,0 +1,37 @@
+import { Feature } from 'geojson';
+import Control, { Options } from 'ol/control/Control';
+import StopFinderControlCommon from '../../common/controls/StopFinderControlCommon';
+export type StopFinderControlOptions = Options & StopFinderControlCommon & {
+    className?: string;
+};
+/**
+ * This OpenLayers control allows to search stations from the [geOps Stops API](https://developer.geops.io/apis/stops/).
+ *
+ * @example
+ * import { Map } from 'ol';
+ * import { StopFinderControl } from 'mobility-toolbox-js/ol';
+ *
+ * const map = new Map({
+ *   target: 'map',
+ * });
+ *
+ * const control = new StopFinderControl({
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * map.addControl(control);
+ *
+ *
+ * @see <a href="/example/ol-search">Openlayers search example</a>
+ * @public
+ */
+declare class StopFinderControl extends Control {
+    controller: StopFinderControlCommon;
+    constructor(options: StopFinderControlOptions);
+    /**
+     * @private
+     */
+    onSuggestionClick(suggestion: Feature): void;
+    search(q: string, abortController: AbortController): Promise<void>;
+}
+export default StopFinderControl;

package/ol/controls/StopFinderControl.js

@@ -3,7 +3,7 @@ import Control from 'ol/control/Control';
 import StopFinderControlCommon from '../../common/controls/StopFinderControlCommon';
 import createDefaultStopFinderElement from '../../common/utils/createDefaultStopFinderElt';
 /**
- * Search stations.
+ * This OpenLayers control allows to search stations from the [geOps Stops API](https://developer.geops.io/apis/stops/).
  *
  * @example
  * import { Map } from 'ol';
@@ -39,5 +39,8 @@ class StopFinderControl extends Control {
         const coord = fromLonLat(suggestion.geometry.coordinates);
         (_a = this.getMap()) === null || _a === void 0 ? void 0 : _a.getView().setCenter(coord);
     }
+    search(q, abortController) {
+        return this.controller.search(q, abortController);
+    }
 }
 export default StopFinderControl;

package/ol/controls/index.d.ts

@@ -0,0 +1,3 @@
+export { default as CopyrightControl } from "./CopyrightControl";
+export { default as RoutingControl } from "./RoutingControl";
+export { default as StopFinderControl } from "./StopFinderControl";

package/ol/index.d.ts

@@ -0,0 +1,7 @@
+export * from "../api";
+export * from "../common";
+export * from "./controls";
+export * from "./layers";
+export * from "./mixins";
+export * from "./styles";
+export * from "./utils";

package/ol/index.js

@@ -2,5 +2,6 @@ export * from '../api';
 export * from '../common';
 export * from './controls';
 export * from './layers';
+export * from './mixins';
 export * from './styles';
 export * from './utils';