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

package/ol/layers/Layer.d.ts

@@ -92,7 +92,7 @@ declare const Layer_base: {
 } & typeof OLLayer;
 /**
  * An OpenLayers layer here only for backward compatibility v2.
- * @deprecated
+ * @deprecated Use an OpenLayers Layer instead.
  */
 declare class Layer extends Layer_base {
     constructor(options: MobilityLayerOptions);

package/ol/layers/Layer.js

@@ -1,14 +1,22 @@
+import debounce from 'lodash.debounce';
 import OLLayer from 'ol/layer/Layer';
 import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
+let deprecated = () => { };
+if (typeof window !== 'undefined' &&
+    new URLSearchParams(window.location.search).get('deprecated')) {
+    deprecated = debounce((message) => {
+        // eslint-disable-next-line no-console
+        console.warn(message);
+    }, 1000);
+}
 /**
  * An OpenLayers layer here only for backward compatibility v2.
- * @deprecated
+ * @deprecated Use an OpenLayers Layer instead.
  */
 class Layer extends MobilityLayerMixin(OLLayer) {
     constructor(options) {
         super(options);
-        // eslint-disable-next-line no-console
-        console.warn('Layer is deprecated. Use an OpenLayers Layer instead.');
+        deprecated('Layer is deprecated. Use an OpenLayers Layer instead.');
     }
     clone(newOptions) {
         return new Layer(Object.assign(Object.assign({}, (this.options || {})), (newOptions || {})));

package/ol/layers/MaplibreLayer.d.ts

@@ -1,14 +1,14 @@
-import OlMap from 'ol/Map';
 import { MapLibreLayer } from '@geoblocks/ol-maplibre-layer';
-import type { MapLibreLayerOptions, MapLibreOptions } from '@geoblocks/ol-maplibre-layer/lib/types/MapLibreLayer';
+import OlMap from 'ol/Map';
 import { MobilityLayerOptions } from '../mixins/MobilityLayerMixin';
-export type MaplibreLayerOptions = MobilityLayerOptions & MapLibreLayerOptions & {
+import type { MapLibreLayerOptions, MapLibreOptions } from '@geoblocks/ol-maplibre-layer/lib/types/MapLibreLayer';
+export type MaplibreLayerOptions = {
     apiKey?: string;
     apiKeyName?: string;
-    style?: null | string | maplibregl.StyleSpecification;
-    url?: string;
     mapLibreOptions?: MapLibreOptions;
-};
+    style?: maplibregl.StyleSpecification | null | string;
+    url?: string;
+} & MapLibreLayerOptions & MobilityLayerOptions;
 declare const MaplibreLayer_base: {
     new (...args: any[]): {
         olEventsKeys: import("ol/events").EventsKey[];
@@ -126,12 +126,6 @@ declare const MaplibreLayer_base: {
  * @public
  */
 declare class MaplibreLayer extends MaplibreLayer_base {
-    get mbMap(): maplibregl.Map | undefined;
-    get maplibreMap(): maplibregl.Map | undefined;
-    get style(): string;
-    set style(newValue: string);
-    get url(): string;
-    set url(newValue: string);
     /**
      * Constructor.
      *
@@ -148,13 +142,19 @@ declare class MaplibreLayer extends MaplibreLayer_base {
      * @param {ol/Map~Map} map
      */
     attachToMap(map: OlMap): void;
-    getStyle(): string;
-    updateMaplibreMap(): void;
     /**
      * Create a copy of the MaplibreLayer.
      * @param {MaplibreLayerOptions} newOptions Options to override
      * @return {MaplibreLayer} A MaplibreLayer layer
      */
     clone(newOptions: MaplibreLayerOptions): MaplibreLayer;
+    getStyle(): string;
+    updateMaplibreMap(): void;
+    get maplibreMap(): maplibregl.Map | undefined;
+    get mbMap(): maplibregl.Map | undefined;
+    get style(): string;
+    set style(newValue: string);
+    get url(): string;
+    set url(newValue: string);
 }
 export default MaplibreLayer;

package/ol/layers/MaplibreLayer.js

@@ -1,5 +1,5 @@
-import debounce from 'lodash.debounce';
 import { MapLibreLayer } from '@geoblocks/ol-maplibre-layer';
+import debounce from 'lodash.debounce';
 import { getUrlWithParams } from '../../common/utils';
 import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
 const buildStyleUrl = (url, style, apiKey, apiKeyName) => {
@@ -7,6 +7,14 @@ const buildStyleUrl = (url, style, apiKey, apiKeyName) => {
         [apiKeyName]: apiKey,
     }).toString();
 };
+let deprecated = () => { };
+if (typeof window !== 'undefined' &&
+    new URLSearchParams(window.location.search).get('deprecated')) {
+    deprecated = debounce((message) => {
+        // eslint-disable-next-line no-console
+        console.warn(message);
+    }, 1000);
+}
 /**
  * An OpenLayers layer able to display data from the [geOps Maps API](https://developer.geops.io/apis/maps).
  *
@@ -34,36 +42,6 @@ const buildStyleUrl = (url, style, apiKey, apiKeyName) => {
  * @public
  */
 class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
-    get mbMap() {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreLayer.mbMap is deprecated. Use layer.maplibreMap.');
-        return this.maplibreMap;
-    }
-    get maplibreMap() {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreLayer.maplibreMap is deprecated. Use layer.mapLibreMap.');
-        return this.mapLibreMap;
-    }
-    // get queryRenderedFeaturesOptions(): maplibregl.QueryRenderedFeaturesOptions {
-    //   return this.get('queryRenderedFeaturesOptions');
-    // }
-    // set queryRenderedFeaturesOptions(
-    //   newValue: maplibregl.QueryRenderedFeaturesOptions,
-    // ) {
-    //   this.set('queryRenderedFeaturesOptions', 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);
-    }
     /**
      * Constructor.
      *
@@ -97,6 +75,22 @@ class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
             }
         }));
     }
+    // get queryRenderedFeaturesOptions(): maplibregl.QueryRenderedFeaturesOptions {
+    //   return this.get('queryRenderedFeaturesOptions');
+    // }
+    // set queryRenderedFeaturesOptions(
+    //   newValue: maplibregl.QueryRenderedFeaturesOptions,
+    // ) {
+    //   this.set('queryRenderedFeaturesOptions', newValue);
+    // }
+    /**
+     * Create a copy of the MaplibreLayer.
+     * @param {MaplibreLayerOptions} newOptions Options to override
+     * @return {MaplibreLayer} A MaplibreLayer layer
+     */
+    clone(newOptions) {
+        return new MaplibreLayer(Object.assign(Object.assign({}, (this.options || {})), (newOptions || {})));
+    }
     getStyle() {
         // If the style is a complete style object, use it directly.
         if (this.style &&
@@ -122,13 +116,25 @@ class MaplibreLayer extends MobilityLayerMixin(MapLibreLayer) {
             console.error('Error while updating MaplibreMap', e);
         }
     }
-    /**
-     * Create a copy of the MaplibreLayer.
-     * @param {MaplibreLayerOptions} newOptions Options to override
-     * @return {MaplibreLayer} A MaplibreLayer layer
-     */
-    clone(newOptions) {
-        return new MaplibreLayer(Object.assign(Object.assign({}, (this.options || {})), (newOptions || {})));
+    get maplibreMap() {
+        deprecated('MaplibreLayer.maplibreMap is deprecated. Use layer.mapLibreMap.');
+        return this.mapLibreMap;
+    }
+    get mbMap() {
+        deprecated('MaplibreLayer.mbMap is deprecated. Use layer.maplibreMap.');
+        return this.maplibreMap;
+    }
+    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);
     }
 }
 export default MaplibreLayer;

package/ol/layers/MaplibreStyleLayer.d.ts

@@ -23,12 +23,7 @@ declare const MaplibreStyleLayer_base: {
         detachFromMap(): void;
         flat(): any[];
         onChildrenChange(oldValue: Layer[]): void;
-        setMapInternal: ((map: Map) => void) & ((map: import("ol/Map" /**
-         * Set if features are hovered or not.
-         * @param {Array<ol/Feature~Feature>} features
-         * @param {boolean} state Is the feature hovered
-         * @private
-         */).default | null) => void);
+        setMapInternal: ((map: Map) => void) & ((map: import("ol/Map").default | null) => void);
         children: Layer<Source, import("ol/renderer/Layer").default<any>>[];
         get copyrights(): string;
         set copyrights(newCopyrights: string | string[]);

package/ol/layers/MaplibreStyleLayer.js

@@ -1,8 +1,17 @@
+import debounce from 'lodash.debounce';
 import { Layer } from 'ol/layer';
 import { Source } from 'ol/source';
 import { VECTOR_TILE_FEATURE_PROPERTY } from '../../common';
 import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
 import MaplibreStyleLayerRenderer from '../renderers/MaplibreStyleLayerRenderer';
+let deprecated = () => { };
+if (typeof window !== 'undefined' &&
+    new URLSearchParams(window.location.search).get('deprecated')) {
+    deprecated = debounce((...messages) => {
+        // eslint-disable-next-line no-console
+        console.warn(...messages);
+    }, 1000);
+}
 /**
  * Layer for visualizing a specific set of layer from a MapboxLayer.
  *
@@ -37,8 +46,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     }) {
         /** Manage renamed property for backward compatibility with v2  */
         if (options.mapboxLayer) {
-            // eslint-disable-next-line no-console
-            console.warn('options.mapboxLayer is deprecated. Use options.maplibreLayer instead.');
+            deprecated('options.mapboxLayer is deprecated. Use options.maplibreLayer instead.');
             // eslint-disable-next-line no-param-reassign
             options.maplibreLayer = options.mapboxLayer;
             // eslint-disable-next-line no-param-reassign
@@ -196,8 +204,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      */
     getFeatureInfoAtCoordinate(coordinate) {
         var _a;
-        // eslint-disable-next-line no-console
-        console.warn(`Deprecated. getFeatureInfoAtCoordinate([layer], coordinate) from ol package instead.`);
+        deprecated(`Deprecated. getFeatureInfoAtCoordinate([layer], coordinate) from ol package instead.`);
         if (!((_a = this.maplibreLayer) === null || _a === void 0 ? void 0 : _a.mapLibreMap)) {
             return Promise.resolve({ coordinate, features: [], layer: this });
         }
@@ -248,8 +255,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      */
     highlight(features = []) {
         var _a;
-        // eslint-disable-next-line no-console
-        console.warn(`Deprecated. Use layer.setFeatureState(features, {highlighted: true}) instead.`);
+        deprecated(`Deprecated. Use layer.setFeatureState(features, {highlighted: true}) instead.`);
         // Filter out selected features
         const filtered = ((_a = this.highlightedFeatures) === null || _a === void 0 ? void 0 : _a.filter((feature) => !(this.selectedFeatures || [])
             .map((feat) => feat.getId())
@@ -316,8 +322,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * @private
      */
     select(features = []) {
-        // eslint-disable-next-line no-console
-        console.warn(`Deprecated. Use layer.setFeatureState(features, {selected: true}) instead.`);
+        deprecated(`Deprecated. Use layer.setFeatureState(features, {selected: true}) instead.`);
         this.setHoverState(this.selectedFeatures || [], false);
         this.selectedFeatures = features;
         this.setHoverState(this.selectedFeatures || [], true);
@@ -338,8 +343,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
             const { source, sourceLayer } = feature.get(VECTOR_TILE_FEATURE_PROPERTY) || {};
             if ((!source && !sourceLayer) || !feature.getId()) {
                 if (!feature.getId()) {
-                    // eslint-disable-next-line no-console
-                    console.warn("No feature's id found. To use the feature state functionnality, tiles must be generated with --generate-ids. See https://github.com/Maplibre/tippecanoe#adding-calculated-attributes.", feature.getId(), feature.getProperties());
+                    deprecated("No feature's id found. To use the feature state functionnality, tiles must be generated with --generate-ids. See https://github.com/Maplibre/tippecanoe#adding-calculated-attributes.", feature.getProperties());
                 }
                 return;
             }
@@ -357,8 +361,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * @private
      */
     setHoverState(features, state) {
-        // eslint-disable-next-line no-console
-        console.warn(`Deprecated. Use layer.setFeatureState(features, {hover: ${state}}) instead.`);
+        deprecated(`Deprecated. Use layer.setFeatureState(features, {hover: ${state}}) instead.`);
         this.setFeatureState(features, { hover: state });
     }
     get beforeId() {
@@ -380,8 +383,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         this.set('layersFilter', newValue);
     }
     get mapboxLayer() {
-        // eslint-disable-next-line no-console
-        console.warn('Deprecated. Use maplibreLayer instead.');
+        deprecated('Deprecated. Use maplibreLayer instead.');
         return this.get('maplibreLayer');
     }
     get maplibreLayer() {
@@ -422,16 +424,14 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * @deprecated
      */
     get styleLayer() {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreStyleLayer.styleLayer is deprecated. Use MaplibreStyleLayer.layer instead.');
+        deprecated('MaplibreStyleLayer.styleLayer is deprecated. Use MaplibreStyleLayer.layer instead.');
         return this.layers[0];
     }
     /**
      * @deprecated
      */
     set styleLayer(newValue) {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreStyleLayer.styleLayer is deprecated. Use MaplibreStyleLayer.layer instead.');
+        deprecated('MaplibreStyleLayer.styleLayer is deprecated. Use MaplibreStyleLayer.layer instead.');
         this.layers = [newValue];
     }
     /**
@@ -441,16 +441,14 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * @deprecated
      */
     get styleLayers() {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreStyleLayer.styleLayers is deprecated. Use MaplibreStyleLayer.layers instead.');
+        deprecated('MaplibreStyleLayer.styleLayers is deprecated. Use MaplibreStyleLayer.layers instead.');
         return this.layers;
     }
     /**
      * @deprecated
      */
     set styleLayers(newValue) {
-        // eslint-disable-next-line no-console
-        console.warn('MaplibreStyleLayer.styleLayers is deprecated. Use MaplibreStyleLayer.layers instead.');
+        deprecated('MaplibreStyleLayer.styleLayers is deprecated. Use MaplibreStyleLayer.layers instead.');
         this.layers = newValue;
     }
 }

package/ol/layers/VectorLayer.d.ts

@@ -1,7 +1,7 @@
 import { Coordinate } from 'ol/coordinate';
 import { LayerGetFeatureInfoResponse } from '../../types';
-import Layer from './Layer';
 import { MobilityLayerOptions } from '../mixins/MobilityLayerMixin';
+import Layer from './Layer';
 /**
  * @deprecated
  */
@@ -9,10 +9,10 @@ declare class VectorLayer extends Layer {
     /**
      * @deprecated
      */
-    getFeatureInfoAtCoordinate(coordinate: Coordinate): Promise<LayerGetFeatureInfoResponse>;
+    clone(newOptions: MobilityLayerOptions): VectorLayer;
     /**
      * @deprecated
      */
-    clone(newOptions: MobilityLayerOptions): VectorLayer;
+    getFeatureInfoAtCoordinate(coordinate: Coordinate): Promise<LayerGetFeatureInfoResponse>;
 }
 export default VectorLayer;

package/ol/layers/VectorLayer.js

@@ -3,6 +3,12 @@ import Layer from './Layer';
  * @deprecated
  */
 class VectorLayer extends Layer {
+    /**
+     * @deprecated
+     */
+    clone(newOptions) {
+        return new VectorLayer(Object.assign(Object.assign({}, this.options), newOptions));
+    }
     /**
      * @deprecated
      */
@@ -11,21 +17,15 @@ class VectorLayer extends Layer {
         if (this.map) {
             const pixel = this.map.getPixelFromCoordinate(coordinate);
             features = this.map.getFeaturesAtPixel(pixel, {
-                layerFilter: (l) => l === this.olLayer,
                 hitTolerance: this.hitTolerance || 5,
+                layerFilter: (l) => l === this.olLayer,
             });
         }
         return Promise.resolve({
+            coordinate,
             features,
             layer: this,
-            coordinate,
         });
     }
-    /**
-     * @deprecated
-     */
-    clone(newOptions) {
-        return new VectorLayer(Object.assign(Object.assign({}, this.options), newOptions));
-    }
 }
 export default VectorLayer;

package/ol/mixins/MobilityLayerMixin.d.ts

@@ -1,9 +1,7 @@
 import { Layer } from 'ol/layer';
 import { PropertiesLayerMixinOptions } from './PropertiesLayerMixin';
-export type MobilityLayerOptions = PropertiesLayerMixinOptions & {
-    [x: string]: any;
-};
-type GConstructor<T = {}> = new (...args: any[]) => T;
+export type MobilityLayerOptions = PropertiesLayerMixinOptions & Record<string, any>;
+type GConstructor<T = object> = new (...args: any[]) => T;
 export type Layerable = GConstructor<Omit<Layer, keyof string>>;
 declare function MobilityLayerMixin<TBase extends Layerable>(Base: TBase): {
     new (...args: any[]): {

package/ol/mixins/PropertiesLayerMixin.js

@@ -2,10 +2,14 @@
 import debounce from 'lodash.debounce';
 import { getUid } from 'ol';
 import getLayersAsFlatArray from '../../common/utils/getLayersAsFlatArray';
-const deprecated = debounce((message) => {
-    // eslint-disable-next-line no-console
-    console.warn(message);
-}, 1000);
+let deprecated = () => { };
+if (typeof window !== 'undefined' &&
+    new URLSearchParams(window.location.search).get('deprecated')) {
+    deprecated = debounce((message) => {
+        // eslint-disable-next-line no-console
+        console.warn(message);
+    }, 1000);
+}
 /**
  * This mixin adds some properties to access ol custom properties easily.
  */
@@ -37,7 +41,7 @@ function PropertiesLayerMixin(Base) {
          * @param {ol/Map~Map} map A map.
          */
         attachToMap(map) {
-            // @ts-expect-error
+            // @ts-expect-error attachToMap not necessarily exists
             (super.attachToMap || (() => { }))(map);
             (this.get('children') || []).forEach((child) => {
                 map.addLayer(child);
@@ -50,7 +54,7 @@ function PropertiesLayerMixin(Base) {
             (this.get('children') || []).forEach((child) => {
                 this.map.removeLayer(child);
             });
-            // @ts-expect-error
+            // @ts-expect-error detachToMap not necessarily exists
             (super.detachFromMap || (() => { }))();
         }
         /**

package/package.json

@@ -2,7 +2,7 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "3.0.0-beta.20",
+  "version": "3.0.0-beta.21",
   "homepage": "https://mobility-toolbox-js.geops.io/",
   "exports": {
     ".": "./index.js",