mobility-toolbox-js 3.0.0-beta.1 → 3.0.0-beta.11

package/ol/mixins/PropertiesLayerMixin.js

@@ -1,12 +1,10 @@
-import BaseEvent from 'ol/events/Event';
 import { getUid } from 'ol';
 import getLayersAsFlatArray from '../../common/utils/getLayersAsFlatArray';
 /**
- * This mixin adds some properties to access some ol properties easily ansd also
- * the management of a hierarchy of layers using children, parent and group property.
+ * This mixin adds some properties to access ol custom properties easily.
  */
 function PropertiesLayerMixin(Base) {
-    return class extends Base {
+    return class PropertiesLayer extends Base {
         get children() {
             return this.get('children') || [];
         }
@@ -71,8 +69,9 @@ function PropertiesLayerMixin(Base) {
         set visible(newValue) {
             this.setVisible(newValue);
         }
-        constructor(options) {
+        constructor(...args) {
             var _a;
+            const options = args[0];
             super(options);
             this.options = {};
             this.olListenersKeys = [];
@@ -87,29 +86,11 @@ function PropertiesLayerMixin(Base) {
                 if (evt.key === 'children') {
                     this.onChildrenChange(evt.oldValue);
                 }
-            }), 
-            // Manage group visiblity
-            this.on('change:visible', () => {
-                this.onVisibleChange();
-            }), 
-            // Listen for group visiblity change
-            // if a layer from a group is newly visible we hide the others.
-            // @ts-ignore
-            this.on(`change:visible:group`, (evt) => {
-                // We hide layer of the same group
-                if (this.group === evt.target.group &&
-                    this !== evt.target &&
-                    this.visible) {
-                    this.visible = false;
-                    // Propagate event to parent
-                }
-                else if (this.children) {
-                    this.children.forEach((child) => child.dispatchEvent(evt));
-                }
             }));
             this.options = options;
             this.children = options.children || []; // Trigger the on children change event
         }
+        // @ts-expect-error - this is a mixin
         setMapInternal(map) {
             super.setMapInternal(map);
             if (map) {
@@ -129,46 +110,6 @@ function PropertiesLayerMixin(Base) {
                 child.set('parent', this);
             });
         }
-        /** @private */
-        onVisibleChange() {
-            const parent = this.get('parent');
-            const children = this.get('children') || [];
-            if (this.getVisible()) {
-                const group = this.get('group');
-                // We make the parent visible
-                if (parent) {
-                    parent.setVisible(true);
-                }
-                // If children doesn't contain any visible layers, we display all children.
-                if (children && !children.some((child) => child.getVisible())) {
-                    children.forEach((child) => {
-                        child.setVisible(true);
-                    });
-                }
-                // Warn the same group that a new layer is visible
-                if (parent && group) {
-                    // We search for the higher parent then it will dispatch to all the tree.
-                    let higherParent = parent;
-                    while (higherParent.get('parent')) {
-                        higherParent = higherParent.get('parent');
-                    }
-                    const evt = new BaseEvent(`change:visible:group`);
-                    evt.target = this;
-                    higherParent.dispatchEvent(evt);
-                }
-            }
-            else {
-                // We hide all the children
-                children.forEach((child) => {
-                    child.setVisible(false);
-                });
-                // If the parent has no more visible child we also hide it.
-                if ((parent === null || parent === void 0 ? void 0 : parent.getVisible()) &&
-                    !(parent === null || parent === void 0 ? void 0 : parent.get('children').find((child) => child.getVisible()))) {
-                    parent.setVisible(false);
-                }
-            }
-        }
         /**
          * Initialize the layer with the map passed in parameters.
          *
@@ -189,7 +130,7 @@ function PropertiesLayerMixin(Base) {
                 this.map.removeLayer(child);
             });
             // @ts-ignore
-            (super.detachFromMap || (() => { }))(map);
+            (super.detachFromMap || (() => { }))();
         }
         /**
          * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.

package/ol/renderers/MaplibreLayerRenderer.d.ts

@@ -0,0 +1,20 @@
+import { FrameState } from 'ol/Map';
+import LayerRenderer from 'ol/renderer/Layer';
+import { Coordinate } from 'ol/coordinate';
+import { FeatureCallback } from 'ol/renderer/vector';
+import { Feature } from 'ol';
+import { Geometry } from 'ol/geom';
+import { Pixel } from 'ol/pixel';
+import type MaplibreLayer from '../layers/MaplibreLayer';
+/**
+ * This class is a renderer for Maplibre Layer to be able to use the native ol
+ * functionnalities like map.getFeaturesAtPixel or map.hasFeatureAtPixel.
+ * @private
+ */
+export default class MaplibreLayerRenderer extends LayerRenderer<MaplibreLayer> {
+    getFeaturesAtCoordinate(coordinate: Coordinate | undefined, hitTolerance?: number): Feature<Geometry>[];
+    prepareFrame(): boolean;
+    renderFrame(frameState: FrameState): HTMLElement | null;
+    getFeatures(pixel: Pixel): Promise<Feature<Geometry>[]>;
+    forEachFeatureAtCoordinate<Feature>(coordinate: Coordinate, frameState: FrameState, hitTolerance: number, callback: FeatureCallback<Feature>): Feature | undefined;
+}

package/ol/renderers/MaplibreStyleLayerRenderer.d.ts

@@ -0,0 +1,20 @@
+import { FrameState } from 'ol/Map';
+import LayerRenderer from 'ol/renderer/Layer';
+import { Coordinate } from 'ol/coordinate';
+import { FeatureCallback } from 'ol/renderer/vector';
+import { Feature } from 'ol';
+import { Geometry } from 'ol/geom';
+import { Pixel } from 'ol/pixel';
+import type { MaplibreStyleLayer } from '../layers';
+/**
+ * This class is a renderer for Maplibre Layer to be able to use the native ol
+ * functionnalities like map.getFeaturesAtPixel or map.hasFeatureAtPixel.
+ * @private
+ */
+export default class MaplibreStyleLayerRenderer extends LayerRenderer<MaplibreStyleLayer> {
+    getFeaturesAtCoordinate(coordinate: Coordinate | undefined, hitTolerance?: number): Feature<Geometry>[];
+    prepareFrame(): boolean;
+    renderFrame(): null;
+    getFeatures(pixel: Pixel): Promise<Feature<Geometry>[]>;
+    forEachFeatureAtCoordinate<Feature>(coordinate: Coordinate, frameState: FrameState, hitTolerance: number, callback: FeatureCallback<Feature>): Feature | undefined;
+}

package/ol/renderers/RealtimeLayerRenderer.d.ts

@@ -0,0 +1,22 @@
+import { FrameState } from 'ol/Map';
+import { Coordinate } from 'ol/coordinate';
+import { FeatureCallback } from 'ol/renderer/vector';
+import { Feature } from 'ol';
+import { Geometry } from 'ol/geom';
+import { Pixel } from 'ol/pixel';
+import CanvasLayerRenderer from 'ol/renderer/canvas/Layer';
+import type RealtimeLayer from '../layers/RealtimeLayer';
+/**
+ * This class is a renderer for Maplibre Layer to be able to use the native ol
+ * functionnalities like map.getFeaturesAtPixel or map.hasFeatureAtPixel.
+ * @private
+ */
+export default class RealtimeLayerRenderer extends CanvasLayerRenderer<RealtimeLayer> {
+    private canvas;
+    prepareFrame(): boolean;
+    renderFrame(frameState: FrameState): HTMLElement;
+    getData(pixel: Pixel): Uint8ClampedArray | null;
+    getFeatures(pixel: Pixel): Promise<Feature<Geometry>[]>;
+    forEachFeatureAtCoordinate<Feature>(coordinate: Coordinate, frameState: FrameState, hitTolerance: number, callback: FeatureCallback<Feature>): Feature | undefined;
+    getFeaturesAtCoordinate(coordinate: Coordinate | undefined, hitTolerance?: number): Feature<Geometry>[];
+}

package/ol/renderers/RealtimeLayerRenderer.js

@@ -16,7 +16,6 @@ export default class RealtimeLayerRenderer extends CanvasLayerRenderer {
         return true;
     }
     renderFrame(frameState) {
-        var _a;
         const { canvas, renderedViewState } = this.getLayer();
         if (!this.container) {
             this.container = document.createElement('div');
@@ -24,7 +23,7 @@ export default class RealtimeLayerRenderer extends CanvasLayerRenderer {
             this.container.style.position = 'absolute';
             this.container.style.width = '100%';
             this.container.style.height = '100%';
-            if (canvas) {
+            if (canvas instanceof HTMLCanvasElement) {
                 canvas.style.position = 'absolute';
                 canvas.style.top = '0';
                 canvas.style.left = '0';
@@ -41,12 +40,12 @@ export default class RealtimeLayerRenderer extends CanvasLayerRenderer {
                 context === null || context === void 0 ? void 0 : context.clearRect(0, 0, canvas === null || canvas === void 0 ? void 0 : canvas.width, canvas === null || canvas === void 0 ? void 0 : canvas.height);
             }
             else {
-                const pixelCenterRendered = (_a = this.getLayer()
-                    .getMapInternal()) === null || _a === void 0 ? void 0 : _a.getPixelFromCoordinate(renderedCenter);
-                const pixelCenter = this.getLayer()
-                    .getMapInternal()
-                    .getPixelFromCoordinate(center);
-                this.container.style.transform = composeCssTransform(pixelCenterRendered[0] - pixelCenter[0], pixelCenterRendered[1] - pixelCenter[1], renderedResolution / resolution, renderedResolution / resolution, rotation - renderedRotation, 0, 0);
+                const map = this.getLayer().getMapInternal();
+                const pixelCenterRendered = map === null || map === void 0 ? void 0 : map.getPixelFromCoordinate(renderedCenter);
+                const pixelCenter = map === null || map === void 0 ? void 0 : map.getPixelFromCoordinate(center);
+                if (pixelCenterRendered && pixelCenter) {
+                    this.container.style.transform = composeCssTransform(pixelCenterRendered[0] - pixelCenter[0], pixelCenterRendered[1] - pixelCenter[1], renderedResolution / resolution, renderedResolution / resolution, rotation - renderedRotation, 0, 0);
+                }
             }
         }
         return this.container;
@@ -83,12 +82,13 @@ export default class RealtimeLayerRenderer extends CanvasLayerRenderer {
         return features === null || features === void 0 ? void 0 : features[0];
     }
     getFeaturesAtCoordinate(coordinate, hitTolerance = 5) {
+        var _a;
         if (!coordinate) {
             return [];
         }
         const layer = this.getLayer();
         const map = layer.getMapInternal();
-        const resolution = map.getView().getResolution();
+        const resolution = ((_a = map === null || map === void 0 ? void 0 : map.getView()) === null || _a === void 0 ? void 0 : _a.getResolution()) || 1;
         const nb = 10;
         const ext = buffer([...coordinate, ...coordinate], hitTolerance * resolution);
         let features = [];

package/ol/styles/fullTrajectoryDelayStyle.d.ts

@@ -0,0 +1,6 @@
+import { Style } from 'ol/style';
+/**
+ * @private
+ */
+declare const fullTrajectoryDelaystyle: () => Style[];
+export default fullTrajectoryDelaystyle;

package/ol/styles/fullTrajectoryStyle.d.ts

@@ -0,0 +1,5 @@
+import type { FeatureLike } from 'ol/Feature';
+import { Style } from 'ol/style';
+/** @private */
+declare const fullTrajectorystyle: (feature: FeatureLike, resolution: number, options: any) => Style[];
+export default fullTrajectorystyle;

package/ol/styles/index.d.ts

@@ -0,0 +1,3 @@
+export { default as fullTrajectoryStyle } from "./fullTrajectoryStyle";
+export { default as fullTrajectoryDelayStyle } from "./fullTrajectoryDelayStyle";
+export { default as routingStyle } from "./routingStyle";

package/ol/styles/routingStyle.d.ts

@@ -0,0 +1,4 @@
+import { StyleFunction } from 'ol/style/Style';
+/** @private */
+declare const routingStyle: StyleFunction;
+export default routingStyle;

package/ol/utils/getFeatureInfoAtCoordinate.d.ts

@@ -0,0 +1,8 @@
+import type { Coordinate } from 'ol/coordinate';
+import type { Layer } from 'ol/layer';
+import { LayerGetFeatureInfoResponse } from '../../types';
+/**
+ * @private
+ */
+declare const getFeatureInfoAtCoordinate: (coordinate: Coordinate, layers: Layer[], hitTolerance?: number) => Promise<LayerGetFeatureInfoResponse[]>;
+export default getFeatureInfoAtCoordinate;

package/ol/utils/getFeatureInfoAtCoordinate.js

@@ -36,7 +36,7 @@ let abortControllers = {};
 /**
  * @private
  */
-const getFeatureInfoAtCoordinate = (coordinate, layers, hitTolerance = 5) => __awaiter(void 0, void 0, void 0, function* () {
+const getFeatureInfoAtCoordinate = (coordinate_1, layers_1, ...args_1) => __awaiter(void 0, [coordinate_1, layers_1, ...args_1], void 0, function* (coordinate, layers, hitTolerance = 5) {
     // Kill all previous requests
     Object.values(abortControllers).forEach((abortController) => {
         abortController === null || abortController === void 0 ? void 0 : abortController.abort();
@@ -63,7 +63,7 @@ const getFeatureInfoAtCoordinate = (coordinate, layers, hitTolerance = 5) => __a
         const source = layer === null || layer === void 0 ? void 0 : layer.getSource();
         // @ts-ignore
         if (source === null || source === void 0 ? void 0 : source.getFeatureInfoUrl) {
-            const id = getUid(this);
+            const id = getUid(layer);
             // Abort and recreates one controller per layer
             (_c = abortControllers[id]) === null || _c === void 0 ? void 0 : _c.abort();
             abortControllers[id] = new AbortController();

package/ol/utils/index.d.ts

@@ -0,0 +1 @@
+export { default as getFeatureInfoAtCoordinate } from "./getFeatureInfoAtCoordinate";

package/package.json

@@ -2,9 +2,8 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.11",
   "homepage": "https://mobility-toolbox-js.geops.io/",
-  "module": "index.js",
   "exports": {
     ".": "./index.js",
     "./api": "./api/index.js",
@@ -24,10 +23,10 @@
     "ol": ">=7"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.24.0",
-    "@babel/preset-typescript": "^7.23.3",
-    "@commitlint/cli": "19.0.3",
-    "@commitlint/config-conventional": "19.0.3",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-conventional": "19.2.2",
     "@types/geojson": "7946.0.14",
     "@types/lodash.debounce": "4.0.9",
     "@types/lodash.throttle": "4.1.9",
@@ -35,10 +34,10 @@
     "@types/offscreencanvas": "2019.7.3",
     "@types/topojson": "3.2.6",
     "@types/uuid": "9.0.8",
-    "@typescript-eslint/eslint-plugin": "7.1.0",
-    "@typescript-eslint/parser": "7.1.0",
-    "cypress": "13.6.6",
-    "esbuild": "0.20.1",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
+    "cypress": "13.8.1",
+    "esbuild": "0.21.1",
     "esdoc": "1.1.0",
     "esdoc-ecmascript-proposal-plugin": "1.0.0",
     "esdoc-publish-html-plugin": "1.1.2",
@@ -46,13 +45,13 @@
     "esdoc-typescript-plugin": "1.0.1",
     "eslint": "8.57.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-config-airbnb-typescript": "17.1.0",
+    "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-cypress": "2.15.1",
+    "eslint-plugin-cypress": "3.2.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jsx-a11y": "6.8.0",
     "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-react": "7.33.2",
+    "eslint-plugin-react": "7.34.1",
     "fixpack": "4.0.0",
     "husky": "9.0.11",
     "is-ci": "3.0.1",
@@ -64,23 +63,22 @@
     "jest-transformer-svg": "2.0.2",
     "jest-websocket-mock": "2.5.0",
     "lint-staged": "15.2.2",
-    "maplibre-gl": "4.0.2",
+    "maplibre-gl": "4.2.0",
     "mock-socket": "9.3.1",
-    "next": "14.1.0",
+    "next": "14.2.3",
     "next-transpile-modules": "10.0.1",
-    "ol": "9.0.0",
-    "openapi-typescript": "6.7.4",
+    "ol": "9.1.0",
+    "openapi-typescript": "6.7.5",
     "prettier": "3.2.5",
     "raw-loader": "4.0.2",
     "sort-json": "2.0.1",
     "standard-version": "9.5.0",
     "start-server-and-test": "2.0.3",
-    "stylelint": "16.2.1",
+    "stylelint": "16.5.0",
     "stylelint-config-recommended-scss": "14.0.0",
     "stylelint-config-standard": "36.0.0",
-    "stylelint-scss": "6.1.0",
-    "typedoc": "^0.25.9",
-    "typescript": "5.3.3"
+    "stylelint-scss": "6.3.0",
+    "typescript": "5.4.5"
   },
   "scripts": {
     "apidoc": "esdoc && cp apidoc/index.json doc/src/components/Esdoc",

package/setupTests.d.ts

@@ -0,0 +1 @@
+export {};

package/ol/layers/MapGlLayer.js

@@ -1,142 +0,0 @@
-import Source from 'ol/source/Source';
-import BaseEvent from 'ol/events/Event';
-import Layer from 'ol/layer/Layer';
-import debounce from 'lodash.debounce';
-import { getUrlWithParams, getMapGlCopyrights } from '../../common/utils';
-import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
-/**
- * Common class for Maplibre and Maplibre and potential other fork from Maplibre.
- * It's used to share code between Maplibre and Maplibre layers without importing both libs.
- * @private
- */
-class MapGlLayer extends MobilityLayerMixin(Layer) {
-    get apiKey() {
-        return this.get('apiKey');
-    }
-    set apiKey(newValue) {
-        this.set('apiKey', newValue);
-    }
-    get apiKeyName() {
-        return this.get('apiKeyName');
-    }
-    set apiKeyName(newValue) {
-        this.set('apiKeyName', newValue);
-    }
-    get style() {
-        return this.get('style');
-    }
-    set style(newValue) {
-        this.set('style', newValue);
-    }
-    get url() {
-        return this.get('url');
-    }
-    set url(newValue) {
-        this.set('url', newValue);
-    }
-    get queryRenderedFeaturesOptions() {
-        return this.get('queryRenderedFeaturesOptions');
-    }
-    set queryRenderedFeaturesOptions(newValue) {
-        this.set('queryRenderedFeaturesOptions', newValue);
-    }
-    constructor(options) {
-        super(Object.assign(Object.assign({ source: new Source({
-                attributions: () => {
-                    return (this.mbMap && getMapGlCopyrights(this.mbMap)) || [];
-                },
-            }), apiKeyName: 'key', style: 'travic_v2', url: 'https://maps.geops.io' }, (options || {})), { mapOptions: Object.assign({ interactive: false, trackResize: false, attributionControl: false }, ((options === null || options === void 0 ? void 0 : options.mapOptions) || {})), queryRenderedFeaturesOptions: Object.assign({}, ((options === null || options === void 0 ? void 0 : options.queryRenderedFeaturesOptions) || {})) }));
-    }
-    /**
-     * Initialize the layer and listen to feature clicks.
-     * @param {ol/Map~Map} map
-     */
-    attachToMap(map) {
-        super.attachToMap(map);
-        this.loadMbMap();
-        const updateMbMapDebounced = debounce(this.updateMbMap.bind(this), 150);
-        this.olListenersKeys.push(this.on('propertychange', (evt) => {
-            if (/(apiKey|apiKeyName|url|style|)/.test(evt.key)) {
-                updateMbMapDebounced();
-            }
-        }));
-    }
-    /**
-     * Terminate what was initialized in init function. Remove layer, events...
-     */
-    detachFromMap() {
-        if (this.mbMap) {
-            // Some asynchrone repaints are triggered even if the mbMap has been removed,
-            // to avoid display of errors we set an empty function.
-            this.mbMap.triggerRepaint = () => { };
-            this.mbMap.remove();
-            this.mbMap = undefined;
-        }
-        this.loaded = false;
-        super.detachFromMap();
-    }
-    /**
-     * Create the Maplibre map.
-     * @private
-     */
-    loadMbMap() {
-        var _a, _b, _c;
-        this.loaded = false;
-        this.olListenersKeys.push(
-        // @ts-ignore
-        (_a = this.map) === null || _a === void 0 ? void 0 : _a.on('change:target', this.loadMbMap.bind(this)));
-        if (!((_b = this.map) === null || _b === void 0 ? void 0 : _b.getTargetElement())) {
-            return;
-        }
-        if (!this.visible) {
-            // On next change of visibility we load the map
-            this.olListenersKeys.push(
-            // @ts-ignore
-            this.once('change:visible', this.loadMbMap.bind(this)));
-            return;
-        }
-        const container = document.createElement('div');
-        container.style.position = 'absolute';
-        container.style.width = '100%';
-        container.style.height = '100%';
-        /**
-         * A Maplibre map
-         * @type {maplibregl.Map}
-         */
-        this.mbMap = this.createMap(Object.assign({ style: this.getStyle() || { version: '8', sources: {}, layers: [] }, container }, (((_c = this.options) === null || _c === void 0 ? void 0 : _c.mapOptions) || {})));
-        this.mbMap.on('sourcedata', () => {
-            var _a;
-            (_a = this.getSource()) === null || _a === void 0 ? void 0 : _a.refresh(); // Refresh attribution
-        });
-        this.mbMap.once('load', () => {
-            this.loaded = true;
-            this.dispatchEvent(new BaseEvent('load'));
-        });
-    }
-    getStyle() {
-        // If the style is a complete style object, use it directly.
-        if (this.style &&
-            typeof this.style === 'object' &&
-            this.style.name &&
-            this.style.version) {
-            return this.style;
-        }
-        // If the url set is already a complete style url, use it directly.
-        if (this.url.includes('style.json')) {
-            return this.url;
-        }
-        /// Otherwise build the complete style url.
-        return getUrlWithParams(`${this.url}/styles/${this.style}/style.json`, {
-            [this.apiKeyName]: this.apiKey,
-        }).toString();
-    }
-    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
-    createMap(options) {
-        throw new Error('createMap must be implemented in child class');
-    }
-    updateMbMap() {
-        var _a;
-        (_a = this.mbMap) === null || _a === void 0 ? void 0 : _a.setStyle(this.getStyle(), { diff: false });
-    }
-}
-export default MapGlLayer;