mobility-toolbox-js 3.0.0-beta.36 → 3.0.0-beta.38

package/types/common.d.ts

@@ -4,9 +4,6 @@ import { ObjectEvent } from 'ol/Object';
 import { Pixel } from 'ol/pixel';
 
 import { RealtimeTrajectory } from '../api/typedefs';
-import CommonLayer, {
-  LayerCommonOptions,
-} from '../ol/mixins/PropertiesLayerMixin';
 
 import type {
   CopyrightControl as MbCopyrightControl,
@@ -86,12 +83,6 @@ export interface RealtimeRenderState {
   zoom?: number;
 }
 
-export type AnyMap = MapboxMap | MaplibreMap | OlMap;
-export type AnyLayer = MbLayer | OlLayer;
-export type AnyOlLayer = OlLayer;
-export type AnyMapboxLayer = MapboxLayer | MaplibreLayer;
-export type AnyRealtimeLayer = MbRealtimeLayer | OlRealtimeLayer;
-export type AnyCopyrightControl = MbCopyrightControl | OlCopyrightControl;
 export type AnyMapGlMap = maplibregl.Map;
 export type AnyMapGlMapOptions = maplibregl.MapOptions;
 export type AnyCanvas = HTMLCanvasElement | OffscreenCanvas;
@@ -100,19 +91,10 @@ export type AnyCanvasContext =
   | null
   | OffscreenCanvasRenderingContext2D
   | undefined;
-export type GConstructor<T extends CommonLayer> = new (options?: any) => T;
-export type CommonLayerClass = GConstructor<CommonLayer>;
-export type GConstructor2<T extends OlLayer> = new (options?: any) => T;
-export type OlLayerClass = GConstructor<AnyOlLayer>;
-export type AnyLayerClass = GConstructor<AnyLayer>;
 
-type GConstructor3<T = object> = new (...args: any[]) => T;
-export type AnyLayerable = GConstructor3<Omit<AnyLayer, keyof string>>;
+export type AnyRealtimeLayer = MbRealtimeLayer | OlRealtimeLayer;
+export type AnyCopyrightControl = MbCopyrightControl | OlCopyrightControl;
 
-export type AnyMapboxLayerClass = GConstructor<AnyMapboxLayer>;
-export type AnyRealtimeLayerClass = GConstructor<AnyRealtimeLayer>;
-export type AnyMapGlMapClass = GConstructor<AnyMapGlMap>;
-export type AnyCopyrightControlClass = GConstructor<AnyCopyrightControl>;
 
 export interface LayerGetFeatureInfoResponse {
   coordinate: Coordinate;
@@ -125,12 +107,6 @@ export interface LayerGetFeatureInfoOptions {
   hitTolerance: number = 5;
 }
 
-export type UserInteractionCallback = (
-  features: Feature[],
-  layer: LayerCommonOptions,
-  coordinate: Coordinate,
-  event: ObjectEvent,
-) => void;
 
 export type RoutingGraph = [RoutingParameters.graph, number, number];
 export type RoutingMot = RoutingParameters.mot;

package/types/realtime.d.ts

@@ -74,7 +74,12 @@ export type RealtimeChannelName =
 export interface RealtimeTrajectoryProperties {
   // Tralis and trafimage
   bounds: [number, number, number, number];
+
+  // Only after first rendering on a map
+  coordinate?: [number, number];
+
   delay: null | number;
+
   // Tralis
   event?: string;
   event_delay?: number;
@@ -139,7 +144,7 @@ export interface RealtimeStop {
   aimedDepartureTime: number;
   arrivalDelay?: number;
   arrivalTime: number;
-  cancelled: booblean;
+  cancelled: boolean;
   coordinate: number[];
   departureDelay: number;
   departureTime: number;

package/ol/mixins/MobilityLayerMixin.d.ts

@@ -1,96 +0,0 @@
-import { Layer } from 'ol/layer';
-import { PropertiesLayerMixinOptions } from './PropertiesLayerMixin';
-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[]): {
-        olEventsKeys: import("ol/events").EventsKey[];
-        options?: PropertiesLayerMixinOptions;
-        attachToMap(map: import("ol").Map): void;
-        detachFromMap(): void;
-        flat(): any[];
-        onChildrenChange(oldValue: Layer[]): void;
-        setMapInternal: ((map: import("ol").Map) => void) & ((map: import("ol").default | null) => void);
-        children: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
-        get copyrights(): string;
-        set copyrights(newCopyrights: string | string[]);
-        disabled: boolean;
-        readonly group: string;
-        hitTolerance: number;
-        readonly key: string;
-        readonly map: import("ol").Map;
-        readonly name: string;
-        olLayer: Layer;
-        parent: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
-        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").default | null;
-        setMap: (map: import("ol").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 MobilityLayerMixin;

package/ol/mixins/MobilityLayerMixin.js

@@ -1,6 +0,0 @@
-import PropertiesLayerMixin from './PropertiesLayerMixin';
-function MobilityLayerMixin(Base) {
-    return class MobilityLayer extends PropertiesLayerMixin(Base) {
-    };
-}
-export default MobilityLayerMixin;

package/ol/mixins/PropertiesLayerMixin.d.ts

@@ -1,134 +0,0 @@
-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[];
-        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 */
-        readonly group: string;
-        /** @deprecated */
-        hitTolerance: number;
-        readonly key: string;
-        readonly map: Map;
-        /** @deprecated */
-        readonly name: string;
-        /** @deprecated */
-        olLayer: Layer;
-        /** @deprecated */
-        /** @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,181 +0,0 @@
-// eslint-disable-next-line max-classes-per-file
-import debounce from 'lodash.debounce';
-import { unByKey } from 'ol/Observable';
-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 ol custom properties easily.
- */
-function PropertiesLayerMixin(Base) {
-    return class PropertiesLayer extends Base {
-        constructor(...args) {
-            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);
-            }
-            // 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() {
-            unByKey(this.olEventsKeys);
-            (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);
-        }
-        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) {
-            if (map) {
-                super.setMapInternal(map);
-                this.attachToMap(map);
-            }
-            else {
-                this.detachFromMap();
-                super.setMapInternal(map);
-            }
-        }
-        /** @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() {
-            deprecated('Layer.copyrights is deprecated. Get the attributions from the source object');
-            return this.get('copyrights');
-        }
-        /** @deprecated */
-        set copyrights(newCopyrights) {
-            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 */
-        get group() {
-            deprecated("Layer.group is deprecated. Use the Layer.get('group') method instead.");
-            return this.get('group');
-        }
-        /** @deprecated */
-        get hitTolerance() {
-            deprecated('Layer.hitTolerance is deprecated.Pass the hitTolerance when you request the features.');
-            return this.get('hitTolerance') || 5;
-        }
-        /** @deprecated */
-        set hitTolerance(newValue) {
-            deprecated('Layer.hitTolerance is deprecated.Pass the hitTolerance when you request the features.');
-            this.set('hitTolerance', newValue);
-        }
-        get key() {
-            return this.get('key') || this.get('name');
-        }
-        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() {
-            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) {
-            deprecated('Layer.olLayer is deprecated. mobility-toolbox-js/ol layers inherits now from ol/layer/Layer class. This setter has no effect.');
-        }
-        /** @deprecated */
-        // get olListenersKeys(): EventsKey[] {
-        //   return this.olEventsKeys;
-        // }
-        /** @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);
-        }
-    };
-}
-export default PropertiesLayerMixin;

package/ol/mixins/index.d.ts

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

package/ol/mixins/index.js

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