mobility-toolbox-js 2.0.0 → 2.1.0

package/ol/controls/CopyrightControl.d.ts

@@ -0,0 +1,31 @@
+import { MapEvent } from 'ol';
+import type { FrameState } from 'ol/Map';
+import CopyrightControlCommon from '../../common/controls/CopyrightControlCommon';
+/**
+ * Display layer's copyrights.
+ *
+ * @example
+ * import { Map } from 'ol';
+ * import { CopyrightControl } from 'mobility-toolbox-js/ol';
+ *
+ * const map = new Map({
+ *   target: 'map',
+ * });
+ * const control = new CopyrightControl();
+ * control.attachToMap(map)
+ *
+ *
+ * @see <a href="/example/ol-copyright">Openlayers copyright example</a>
+ *
+ * @extends {CopyrightControlCommon}
+ */
+declare class CopyrightControl extends CopyrightControlCommon {
+    frameState?: FrameState;
+    constructor(options: any);
+    getCopyrights(): any[];
+    activate(): void;
+    deactivate(): void;
+    onPostRender(evt: MapEvent): void;
+}
+export default CopyrightControl;
+//# sourceMappingURL=CopyrightControl.d.ts.map

package/ol/controls/CopyrightControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CopyrightControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/CopyrightControl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAE9B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,sBAAsB,MAAM,8CAA8C,CAAC;AAGlF;;;;;;;;;;;;;;;;;GAiBG;AACH,cAAM,gBAAiB,SAAQ,sBAAsB;IACnD,UAAU,CAAC,EAAE,UAAU,CAAC;gBAEZ,OAAO,EAAE,GAAG;IAKxB,aAAa;IAyBb,QAAQ;IAOR,UAAU;IAMV,YAAY,CAAC,GAAG,EAAE,QAAQ;CAS3B;AAED,eAAe,gBAAgB,CAAC"}

package/ol/controls/CopyrightControl.js

@@ -1,8 +1,6 @@
 import { inView } from 'ol/layer/Layer';
-import Control from '../../common/controls/Control';
-import mixin from '../../common/mixins/CopyrightMixin';
+import CopyrightControlCommon from '../../common/controls/CopyrightControlCommon';
 import removeDuplicate from '../../common/utils/removeDuplicate';
-
 /**
  * Display layer's copyrights.
  *
@@ -14,67 +12,57 @@ import removeDuplicate from '../../common/utils/removeDuplicate';
  *   target: 'map',
  * });
  * const control = new CopyrightControl();
- * control.map = map
+ * control.attachToMap(map)
  *
  *
  * @see <a href="/example/ol-copyright">Openlayers copyright example</a>
  *
- * @extends {Control}
- * @implements {CopyrightInterface}
+ * @extends {CopyrightControlCommon}
  */
-class CopyrightControl extends mixin(Control) {
-  constructor(options) {
-    super(options);
-    this.onPostRender = this.onPostRender.bind(this);
-  }
-
-  getCopyrights() {
-    if (!this.frameState) {
-      return [];
+class CopyrightControl extends CopyrightControlCommon {
+    constructor(options) {
+        super(options);
+        this.onPostRender = this.onPostRender.bind(this);
     }
-    let copyrights = [];
-
-    // This code loop comes mainly from ol.
-    this.frameState.layerStatesArray.forEach((layerState) => {
-      const { layer } = layerState;
-      if (
-        inView(layerState, this.frameState.viewState) &&
-        layer &&
-        layer.getSource &&
-        layer.getSource() &&
-        layer.getSource().getAttributions()
-      ) {
-        copyrights = copyrights.concat(
-          layer.getSource().getAttributions()(this.frameState),
-        );
-      }
-    });
-    return removeDuplicate(copyrights);
-  }
-
-  activate() {
-    super.activate();
-    if (this.map) {
-      this.map.on('postrender', this.onPostRender);
+    getCopyrights() {
+        var _a;
+        if (!this.frameState) {
+            return [];
+        }
+        let copyrights = [];
+        // This code loop comes mainly from ol.
+        (_a = this.frameState) === null || _a === void 0 ? void 0 : _a.layerStatesArray.forEach((layerState) => {
+            const { layer } = layerState;
+            if (this.frameState &&
+                inView(layerState, this.frameState.viewState) &&
+                layer &&
+                layer.getSource &&
+                layer.getSource() &&
+                layer.getSource().getAttributions()) {
+                copyrights = copyrights.concat(layer.getSource().getAttributions()(this.frameState));
+            }
+        });
+        return removeDuplicate(copyrights);
     }
-  }
-
-  deactivate() {
-    if (this.map) {
-      this.map.un('postrender', this.onPostRender);
+    activate() {
+        super.activate();
+        if (this.map) {
+            this.map.on('postrender', this.onPostRender);
+        }
     }
-    super.deactivate();
-  }
-
-  onPostRender(evt) {
-    if (this.map && this.element) {
-      /**
-       * @ignore
-       */
-      this.frameState = evt.frameState;
-      this.render();
+    deactivate() {
+        if (this.map) {
+            this.map.un('postrender', this.onPostRender);
+        }
+    }
+    onPostRender(evt) {
+        if (this.map && this.element) {
+            /**
+             * @ignore
+             */
+            this.frameState = evt.frameState || undefined;
+            this.render();
+        }
     }
-  }
 }
-
 export default CopyrightControl;

package/ol/controls/RoutingControl.d.ts

@@ -0,0 +1,193 @@
+import { Feature } from 'ol';
+import type { Map, MapBrowserEvent } from 'ol';
+import { Geometry, LineString, Point } from 'ol/geom';
+import { Modify } from 'ol/interaction';
+import { GeoJSON } from 'ol/format';
+import type { Coordinate } from 'ol/coordinate';
+import type { StyleLike } from 'ol/style/Style';
+import { EventsKey } from 'ol/events';
+import { ModifyEvent } from 'ol/interaction/Modify';
+import { RoutingAPI } from '../../api';
+import ControlCommon from '../../common/controls/ControlCommon';
+import type { ControlCommonOptions } from '../../common/controls/ControlCommon';
+import RoutingLayer from '../layers/RoutingLayer';
+import type { RoutingGraph, RoutingMot, RoutingParameters, RoutingViaPoint } from '../../types';
+export type RoutingControlOptions = ControlCommonOptions & {
+    apiKey?: string;
+    stopsApiKey?: string;
+    stopsApiUrl?: string;
+    routingLayer?: RoutingLayer;
+    graphs?: RoutingGraph[];
+    mot?: string;
+    modify?: boolean;
+    routingApiParams?: RoutingParameters;
+    useRawViaPoints?: boolean;
+    snapToClosestStation?: boolean;
+    style?: StyleLike;
+    onRouteError?: () => void;
+};
+export type AbotControllersByGraph = {
+    [key: string]: AbortController;
+};
+/**
+ * Display a route of a specified mean of transport.
+ *
+ * @example
+ * import { Map } from 'ol';
+ * import { RoutingControl } from 'mobility-toolbox-js/ol';
+ *
+ * const map = new Map({
+ *   target: 'map'
+ * });
+ *
+ * const control = new RoutingControl();
+ *
+ * control.attachToMap(map)
+ *
+ * @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 {RoutingLayer|Layer} 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}
+ */
+declare class RoutingControl extends ControlCommon {
+    map?: Map;
+    viaPoints: RoutingViaPoint[];
+    routingLayer?: RoutingLayer;
+    loading: boolean;
+    graphs: RoutingGraph[];
+    mot?: RoutingMot;
+    modify: boolean;
+    routingApiParams?: RoutingParameters;
+    useRawViaPoints: boolean;
+    snapToClosestStation: boolean;
+    cacheStationData: {
+        [key: string]: Coordinate;
+    };
+    abortControllers: {
+        [key: string]: AbortController;
+    };
+    apiKey?: string;
+    stopsApiKey?: string;
+    segments: Feature<LineString>[];
+    stopsApiUrl?: string;
+    api?: RoutingAPI;
+    format: GeoJSON;
+    graphsResolutions?: [number, number][];
+    onRouteError: (error?: Error, control?: RoutingControl) => void;
+    onMapClickKey?: EventsKey;
+    modifyInteraction?: Modify;
+    initialRouteDrag?: {
+        viaPoint?: Feature<Point>;
+        oldRoute?: Feature<LineString>;
+        segmentIndex?: number;
+    };
+    constructor(options?: RoutingControlOptions);
+    /**
+     * Calculate at which resolutions corresponds each generalizations.
+     *
+     * @private
+     */
+    static getGraphsResolutions(graphs: RoutingGraph[], map: Map): [number, number][];
+    /**
+     * Adds/Replaces a viaPoint to the viaPoints array and redraws route:
+     *   Adds a viaPoint at end of array by default.
+     *   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 {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.
+     */
+    addViaPoint(coordinatesOrString: RoutingViaPoint, index?: number, overwrite?: number): void;
+    /**
+     * 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.
+     */
+    removeViaPoint(index?: number): void;
+    /**
+     * Replaces the current viaPoints with a new coordinate array.
+     * @param {Array<Array<number>>} coordinateArray Array of nested coordinates
+     */
+    setViaPoints(coordinateArray: Coordinate[]): void;
+    /**
+     * Removes all viaPoints, clears the source and triggers a change event
+     */
+    reset(): void;
+    /**
+     * Aborts viapoint and route requests
+     * @private
+     */
+    abortRequests(): void;
+    /**
+     * Draws route on map using an array of coordinates:
+     *   If a single coordinate is passed a single point feature is added to map.
+     *   If two or more coordinates are passed a request to the RoutingAPI fetches
+     *       the route using the passed coordinates and the current mot.
+     * @private
+     */
+    drawRoute(): Promise<void | Feature<Geometry>> | Promise<Feature<Geometry> | null> | Promise<(void | never[])[]> | null;
+    /**
+     * Draw a via point. This function can parse all the possibilitiies
+     *
+     * @private
+     */
+    drawViaPoint(viaPoint: RoutingViaPoint, idx: number, abortController: AbortController): Promise<void | Feature<Geometry>> | Promise<Feature<Geometry> | null>;
+    /**
+     * Used on click on map while control is active:
+     *   By default adds a viaPoint to the end of array.
+     *   If an existing viaPoint is clicked removes the clicked viaPoint.
+     * @private
+     */
+    onMapClick(evt: MapBrowserEvent<MouseEvent>): void;
+    /**
+     * Used on start of the modify interaction. Stores relevant data
+     * in this.initialRouteDrag object
+     * @private
+     */
+    onModifyStart(evt: ModifyEvent): void;
+    /**
+     * 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: ModifyEvent): void | Promise<never>;
+    /**
+     * Define a default element.
+     *
+     * @private
+     */
+    createDefaultElement(): void;
+    /**
+     * Create the interaction used to modify vertexes of features.
+     * @private
+     */
+    createModifyInteraction(): void;
+    /**
+     * Add click listener to map.
+     * @private
+     */
+    addListeners(): void;
+    /**
+     * Remove click listener from map.
+     * @private
+     */
+    removeListeners(): void;
+    activate(): void;
+    deactivate(): void;
+    render(): void;
+}
+export default RoutingControl;
+//# sourceMappingURL=RoutingControl.d.ts.map

package/ol/controls/RoutingControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoutingControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/RoutingControl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,aAAa,MAAM,qCAAqC,CAAC;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IAExB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAErC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAChC,CAAC;AA4CF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,cAAM,cAAe,SAAQ,aAAa;IACxC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,SAAS,EAAE,eAAe,EAAE,CAAM;IAElC,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,OAAO,EAAE,OAAO,CAAS;IAEzB,MAAM,EAAE,YAAY,EAAE,CAAM;IAE5B,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAQ;IAEvB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAS;IAEjC,oBAAoB,EAAE,OAAO,CAAS;IAEtC,gBAAgB,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;KAC3B,CAAM;IAEP,gBAAgB,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;KAChC,CAAM;IAEP,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAM;IAErC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAmD;IAElE,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAEvC,YAAY,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEhE,aAAa,CAAC,EAAE,SAAS,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAM;gBAEK,OAAO,GAAE,qBAA0B;IA+F/C;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CACzB,MAAM,EAAE,YAAY,EAAE,EACtB,GAAG,EAAE,GAAG,GACP,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;IAQrB;;;;;;;;;OASG;IACH,WAAW,CACT,mBAAmB,EAAE,eAAe,EACpC,KAAK,GAAE,MAAW,EAClB,SAAS,GAAE,MAAU;IAYvB;;;;OAIG;IACH,cAAc,CAAC,KAAK,SAAoC;IASxD;;;OAGG;IACH,YAAY,CAAC,eAAe,EAAE,UAAU,EAAE;IAM1C;;OAEG;IACH,KAAK;IAQL;;;OAGG;IACH,aAAa;IAkBb;;;;;;OAMG;IACH,SAAS;IA4IT;;;;OAIG;IACH,YAAY,CACV,QAAQ,EAAE,eAAe,EACzB,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,eAAe;IAqHlC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,eAAe,CAAC,UAAU,CAAC;IAmB3C;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,WAAW;IAwC9B;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,WAAW;IAuB5B;;;;OAIG;IACH,oBAAoB;IAcpB;;;OAGG;IACH,uBAAuB;IA+BvB;;;OAGG;IACH,YAAY;IASZ;;;OAGG;IACH,eAAe;IAMf,QAAQ;IA6BR,UAAU;IAYV,MAAM;CACP;AAED,eAAe,cAAc,CAAC"}