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

package/ol/mixins/PropertiesLayerMixin.d.ts

@@ -0,0 +1,135 @@
+import { Map } from 'ol';
+import { EventsKey } from 'ol/events';
+import { Layer } from 'ol/layer';
+import type { Options } from 'ol/layer/Layer';
+import type { Layerable } from './MobilityLayerMixin';
+export type PropertiesLayerMixinOptions = {
+    children?: any[];
+    copyrights?: string[];
+    disabled?: boolean;
+    group?: string;
+    hitTolerance?: number;
+    key?: string;
+    map?: Map;
+    name?: string;
+    properties?: Record<string, any>;
+    visible?: boolean;
+} & Options & Record<string, any>;
+/**
+ * This mixin adds some properties to access ol custom properties easily.
+ */
+declare function PropertiesLayerMixin<TBase extends Layerable>(Base: TBase): {
+    new (...args: any[]): {
+        olEventsKeys: EventsKey[];
+        options?: PropertiesLayerMixinOptions;
+        /**
+         * Initialize the layer with the map passed in parameters.
+         *
+         * @param {ol/Map~Map} map A map.
+         */
+        attachToMap(map: Map): void;
+        /**
+         * Terminate what was initialized in init function. Remove layer, events...
+         */
+        detachFromMap(): void;
+        /**
+         * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
+         * @deprecated
+         */
+        flat(): any[];
+        /** @private */
+        onChildrenChange(oldValue: Layer[]): void;
+        setMapInternal(map: Map): void;
+        /** @deprecated */
+        children: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
+        /** @deprecated */
+        get copyrights(): string;
+        /** @deprecated */
+        set copyrights(newCopyrights: string | string[]);
+        /** @deprecated */
+        disabled: boolean;
+        /** @deprecated */
+        /** @deprecated */
+        readonly group: string;
+        /** @deprecated */
+        readonly hitTolerance: number;
+        readonly key: string;
+        readonly map: Map;
+        /** @deprecated */
+        readonly name: string;
+        /** @deprecated */
+        olLayer: Layer;
+        /** @deprecated */
+        parent: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
+        /** @deprecated */
+        visible: boolean;
+        on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").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;
+        getSource: () => import("ol/source").Source | null;
+        getRenderSource: () => import("ol/source").Source | null;
+        getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<Array<import("ol/Feature").FeatureLike>>;
+        getData: (pixel: import("ol/pixel").Pixel) => Uint8ClampedArray | Uint8Array | Float32Array | DataView | null;
+        isVisible: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => boolean;
+        getAttributions: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => Array<string>;
+        unrender: () => void;
+        getDeclutter: () => string;
+        renderDeclutter: (frameState: import("ol/Map").FrameState, layerState: import("ol/layer/Layer").State) => void;
+        renderDeferred: (frameState: import("ol/Map").FrameState) => void;
+        getMapInternal: () => import("ol/Map").default | null;
+        setMap: (map: import("ol/Map").default | null) => void;
+        setSource: (source: import("ol/source").Source | null) => void;
+        getRenderer: () => import("ol/renderer/Layer").default<any> | null;
+        hasRenderer: () => boolean;
+        getBackground: () => import("ol/layer/Base").BackgroundColor | false;
+        getClassName: () => string;
+        getLayerState: (managed?: boolean | undefined) => import("ol/layer/Layer").State;
+        getLayersArray: (array?: import("ol/layer/Layer").default<import("ol/source").default, import("ol/renderer/Layer").default<any>>[] | undefined) => Array<import("ol/layer/Layer").default>;
+        getLayerStatesArray: (states?: import("ol/layer/Layer").State[] | undefined) => Array<import("ol/layer/Layer").State>;
+        getExtent: () => import("ol/extent").Extent | undefined;
+        getMaxResolution: () => number;
+        getMinResolution: () => number;
+        getMinZoom: () => number;
+        getMaxZoom: () => number;
+        getOpacity: () => number;
+        getSourceState: () => import("ol/source/Source").State;
+        getVisible: () => boolean;
+        getZIndex: () => number | undefined;
+        setBackground: (background?: import("ol/layer/Base").BackgroundColor | undefined) => void;
+        setExtent: (extent: import("ol/extent").Extent | undefined) => void;
+        setMaxResolution: (maxResolution: number) => void;
+        setMinResolution: (minResolution: number) => void;
+        setMaxZoom: (maxZoom: number) => void;
+        setMinZoom: (minZoom: number) => void;
+        setOpacity: (opacity: number) => void;
+        setVisible: (visible: boolean) => void;
+        setZIndex: (zindex: number) => void;
+        get: (key: string) => any;
+        getKeys: () => Array<string>;
+        getProperties: () => {
+            [x: string]: any;
+        };
+        getPropertiesInternal: () => {
+            [x: string]: any;
+        } | null;
+        hasProperties: () => boolean;
+        notify: (key: string, oldValue: any) => void;
+        addChangeListener: (key: string, listener: import("ol/events").Listener) => void;
+        removeChangeListener: (key: string, listener: import("ol/events").Listener) => void;
+        set: (key: string, value: any, silent?: boolean | undefined) => void;
+        setProperties: (values: {
+            [x: string]: any;
+        }, silent?: boolean | undefined) => void;
+        unset: (key: string, silent?: boolean | undefined) => void;
+        changed: () => void;
+        getRevision: () => number;
+        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
+        dispatchEvent: (event: import("ol/events/Event").default | string) => boolean | undefined;
+        getListeners: (type: string) => Array<import("ol/events").Listener> | undefined;
+        hasListener: (type?: string | undefined) => boolean;
+        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
+        dispose: () => void;
+    };
+} & TBase;
+export default PropertiesLayerMixin;

package/ol/mixins/PropertiesLayerMixin.js

@@ -1,43 +1,132 @@
-import BaseEvent from 'ol/events/Event';
+// eslint-disable-next-line max-classes-per-file
+import debounce from 'lodash.debounce';
 import { getUid } from 'ol';
 import getLayersAsFlatArray from '../../common/utils/getLayersAsFlatArray';
+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 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 {
+        constructor(...args) {
+            var _a;
+            const options = args[0];
+            super(options);
+            this.olEventsKeys = [];
+            this.options = {};
+            if (options.properties) {
+                deprecated("Deprecated. Don't use properties options. Pass the values directly in options object.");
+                this.setProperties(options.properties);
+            }
+            (_a = this.olEventsKeys) === null || _a === void 0 ? void 0 : _a.push(
+            // Update parent property
+            this.on('propertychange', (evt) => {
+                if (evt.key === 'children') {
+                    this.onChildrenChange(evt.oldValue);
+                }
+            }));
+            this.options = options;
+            this.set('children', options.children || []); // Trigger the on children change event
+        }
+        /**
+         * Initialize the layer with the map passed in parameters.
+         *
+         * @param {ol/Map~Map} map A map.
+         */
+        attachToMap(map) {
+            // @ts-expect-error attachToMap not necessarily exists
+            (super.attachToMap || (() => { }))(map);
+            (this.get('children') || []).forEach((child) => {
+                map.addLayer(child);
+            });
+        }
+        /**
+         * Terminate what was initialized in init function. Remove layer, events...
+         */
+        detachFromMap() {
+            (this.get('children') || []).forEach((child) => {
+                this.map.removeLayer(child);
+            });
+            // @ts-expect-error detachToMap not necessarily exists
+            (super.detachFromMap || (() => { }))();
+        }
+        /**
+         * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
+         * @deprecated
+         */
+        flat() {
+            deprecated('Layer.flat is deprecated. Use getLayersAsFlatArray utils method instead.');
+            return getLayersAsFlatArray(this);
+        }
+        /** @private */
+        onChildrenChange(oldValue) {
+            // Set the parent property
+            (oldValue || []).forEach((child) => {
+                child.set('parent', undefined);
+            });
+            (this.get('children') || []).forEach((child) => {
+                child.set('parent', this);
+            });
+        }
+        // @ts-expect-error  - this is a mixin
+        setMapInternal(map) {
+            super.setMapInternal(map);
+            if (map) {
+                this.attachToMap(map);
+            }
+            else {
+                this.detachFromMap();
+            }
+        }
+        /** @deprecated */
         get children() {
+            deprecated("Layer.children is deprecated. Use the Layer.get('children') method instead.");
             return this.get('children') || [];
         }
+        /** @deprecated */
         set children(newValue) {
+            deprecated("Layer.children is deprecated. Use the Layer.set('children', children) method instead.");
             this.set('children', newValue || []);
         }
+        /** @deprecated */
         get copyrights() {
-            // eslint-disable-next-line no-console
-            console.warn('Deprecated. Use the source object to get the attributions');
+            deprecated('Layer.copyrights is deprecated. Get the attributions from the source object');
             return this.get('copyrights');
         }
+        /** @deprecated */
         set copyrights(newCopyrights) {
-            // eslint-disable-next-line no-console
-            console.warn('Deprecated. Use the source object to set the attributions');
+            deprecated('Layer.copyrights is deprecated. Set the attributions to the source object.');
             const arrValue = newCopyrights && !Array.isArray(newCopyrights)
                 ? [newCopyrights]
                 : newCopyrights;
             this.set('copyrights', arrValue || []);
         }
+        /** @deprecated */
         get disabled() {
+            deprecated("Layer.disabled is deprecated. Use the Layer.get('disabled') method instead.");
             return this.get('disabled');
         }
+        /** @deprecated */
         set disabled(newValue) {
+            deprecated("Layer.disabled is deprecated. Use the Layer.set('disabled', newValue) method instead.");
             this.set('disabled', newValue);
         }
+        /** @deprecated */
+        /** @deprecated */
         get group() {
+            deprecated("Layer.group is deprecated. Use the Layer.get('group') method instead.");
             return this.get('group');
         }
+        /** @deprecated */
         get hitTolerance() {
-            // eslint-disable-next-line no-console
-            console.warn('Deprecated. Pass the pixelTolerance when you request the features.');
+            deprecated('Layer.hitTolerance is deprecated.Pass the hitTolerance when you request the features.');
             return this.get('hitTolerance') || 5;
         }
         get key() {
@@ -46,157 +135,40 @@ function PropertiesLayerMixin(Base) {
         get map() {
             return this.getMapInternal();
         }
+        /** @deprecated */
         get name() {
+            deprecated("Layer.name is deprecated. Use the Layer.get('name') method instead.");
             return this.get('name');
         }
+        /** @deprecated */
         get olLayer() {
-            // eslint-disable-next-line no-console
-            console.warn("Deprecated property: mobility-toolbox-js/ol layers inherits now from ol/layer/Layer class. This getter is only a redirect to the current 'this' object.");
+            deprecated("Layer.olLayer is deprecated. mobility-toolbox-js/ol layers inherits now from ol/layer/Layer class. This getter is only a redirect to the current 'this' object.");
             return this;
         }
         // eslint-disable-next-line class-methods-use-this
         set olLayer(newValue) {
-            // eslint-disable-next-line no-console
-            console.log('Deprecated property: mobility-toolbox-js/ol layers inherits now from ol/layer/Layer class. This setter has no effect.');
+            deprecated('Layer.olLayer is deprecated. mobility-toolbox-js/ol layers inherits now from ol/layer/Layer class. This setter has no effect.');
         }
+        /** @deprecated */
         get parent() {
+            deprecated("Layer.parent is deprecated. Use the Layer.get('parent') method instead.");
             return this.get('parent');
         }
+        /** @deprecated */
         set parent(newValue) {
+            deprecated("Layer.parent is deprecated. Use the Layer.set('parent', parent) method instead.");
             this.set('parent', newValue);
         }
+        /** @deprecated */
         get visible() {
+            deprecated('Layer.visible is deprecated. Use the Layer.getVisible() method instead.');
             return this.getVisible();
         }
+        /** @deprecated */
         set visible(newValue) {
+            deprecated('Layer.visible is deprecated. Use the Layer.setVisible(newValue) method instead.');
             this.setVisible(newValue);
         }
-        constructor(options) {
-            var _a;
-            super(options);
-            this.options = {};
-            this.olListenersKeys = [];
-            if (options.properties) {
-                // eslint-disable-next-line no-console
-                console.warn("Deprecated. Don't use properties options. Pass the values directly in options object.");
-                this.setProperties(options.properties);
-            }
-            (_a = this.olListenersKeys) === null || _a === void 0 ? void 0 : _a.push(
-            // Update parent property
-            this.on('propertychange', (evt) => {
-                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
-        }
-        setMapInternal(map) {
-            super.setMapInternal(map);
-            if (map) {
-                this.attachToMap(map);
-            }
-            else {
-                this.detachFromMap();
-            }
-        }
-        /** @private */
-        onChildrenChange(oldValue) {
-            // Set the parent property
-            (oldValue || []).forEach((child) => {
-                child.set('parent', undefined);
-            });
-            (this.children || []).forEach((child) => {
-                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.
-         *
-         * @param {ol/Map~Map} map A map.
-         */
-        attachToMap(map) {
-            // @ts-ignore
-            (super.attachToMap || (() => { }))(map);
-            (this.get('children') || []).forEach((child) => {
-                map.addLayer(child);
-            });
-        }
-        /**
-         * Terminate what was initialized in init function. Remove layer, events...
-         */
-        detachFromMap() {
-            (this.get('children') || []).forEach((child) => {
-                this.map.removeLayer(child);
-            });
-            // @ts-ignore
-            (super.detachFromMap || (() => { }))(map);
-        }
-        /**
-         * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
-         */
-        flat() {
-            return getLayersAsFlatArray(this);
-        }
     };
 }
 export default PropertiesLayerMixin;

package/ol/mixins/index.d.ts

@@ -0,0 +1 @@
+export { default as MobilityLayerMixin } from './MobilityLayerMixin';

package/ol/mixins/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export { default as MobilityLayerMixin } from './MobilityLayerMixin';