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

package/ol/controls/RoutingControl.d.ts

@@ -31,7 +31,7 @@ export type AbotControllersByGraph = {
     [key: string]: AbortController;
 };
 /**
- * This control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
+ * This OpenLayers control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
  *
  * @example
  * import { Map } from 'ol';

package/ol/controls/RoutingControl.js

@@ -47,7 +47,7 @@ const getFlatCoordinatesFromSegments = (segmentArray) => {
     return coords;
 };
 /**
- * This control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
+ * This OpenLayers control allows the user to add and modifiy via points to a map and request a route from the [geOps Routing API](https://developer.geops.io/apis/routing/).
  *
  * @example
  * import { Map } from 'ol';

package/ol/index.d.ts

@@ -2,5 +2,6 @@ export * from "../api";
 export * from "../common";
 export * from "./controls";
 export * from "./layers";
+export * from "./mixins";
 export * from "./styles";
 export * from "./utils";

package/ol/index.js

@@ -2,5 +2,6 @@ export * from '../api';
 export * from '../common';
 export * from './controls';
 export * from './layers';
+export * from './mixins';
 export * from './styles';
 export * from './utils';

package/ol/layers/Layer.d.ts

@@ -0,0 +1,101 @@
+import OLLayer from 'ol/layer/Layer';
+import { MobilityLayerOptions } from '../mixins/MobilityLayerMixin';
+declare const Layer_base: {
+    new (...args: any[]): {
+        options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions | undefined;
+        olListenersKeys: import("ol/events").EventsKey[];
+        children: OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
+        get copyrights(): string;
+        set copyrights(newCopyrights: string | string[]);
+        disabled: boolean;
+        readonly group: string;
+        readonly hitTolerance: boolean;
+        readonly key: string;
+        readonly map: import("ol").Map;
+        readonly name: string;
+        olLayer: OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
+        parent: OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
+        visible: boolean;
+        setMapInternal: ((map: import("ol").Map) => void) & ((map: import("ol").Map | null) => void);
+        onChildrenChange(oldValue: OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[]): void;
+        attachToMap(map: import("ol").Map): void;
+        detachFromMap(): void;
+        flat(): any[];
+        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
+        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
+        on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
+        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
+        once: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
+        un: import("ol/layer/Layer").LayerOnSignature<void>;
+        getSource: () => import("ol/source").Source | null;
+        getRenderSource: () => import("ol/source").Source | null;
+        getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<import("ol/Feature").FeatureLike[]>;
+        getData: (pixel: import("ol/pixel").Pixel) => Float32Array | Uint8ClampedArray | Uint8Array | DataView | null;
+        isVisible: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => boolean;
+        getAttributions: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => 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 | null;
+        setMap: (map: import("ol").Map | null) => void;
+        setSource: (source: import("ol/source").Source | null) => void;
+        getRenderer: () => import("ol/renderer/Layer").default<any> | null;
+        hasRenderer: () => boolean;
+        getBackground: () => false | import("ol/layer/Base").BackgroundColor;
+        getClassName: () => string;
+        getLayerState: (managed?: boolean | undefined) => import("ol/layer/Layer").State;
+        getLayersArray: (array?: OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[] | undefined) => OLLayer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
+        getLayerStatesArray: (states?: import("ol/layer/Layer").State[] | undefined) => 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: () => 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;
+        dispatchEvent: (event: string | import("ol/events/Event").default) => boolean | undefined;
+        getListeners: (type: string) => import("ol/events").Listener[] | undefined;
+        hasListener: (type?: string | undefined) => boolean;
+        dispose: () => void;
+    };
+} & typeof OLLayer;
+/**
+ * An OpenLayers layer here only for backward compatibility v2.
+ * @deprecated
+ */
+declare class Layer extends Layer_base {
+    constructor(options: MobilityLayerOptions);
+    clone(newOptions: MobilityLayerOptions): Layer;
+}
+export default Layer;

package/ol/layers/Layer.js

@@ -0,0 +1,17 @@
+import OLLayer from 'ol/layer/Layer';
+import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
+/**
+ * An OpenLayers layer here only for backward compatibility v2.
+ * @deprecated
+ */
+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.');
+    }
+    clone(newOptions) {
+        return new Layer(Object.assign(Object.assign({}, (this.options || {})), (newOptions || {})));
+    }
+}
+export default Layer;

package/ol/layers/MaplibreLayer.d.ts

@@ -149,10 +149,10 @@ declare class MaplibreLayer extends MaplibreLayer_base {
      *
      * @param {MaplibreLayerOptions} options
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
-     * @param {string} [options.apiKeyName="key"] The geOps Maps api key name.
+     * @param {string} [options.apiKeyName="key"] The geOps Maps API key name.
      * @param {maplibregl.MapOptions} [options.mapOptions={ interactive: false, trackResize: false, attributionControl: false }] Maplibre map options.
-     * @param {string} [options.style="travic_v2"] The geOps Maps api style.
-     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps api url.
+     * @param {string} [options.style="travic_v2"] The geOps Maps API style.
+     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps API url.
      */
     constructor(options: MaplibreLayerOptions);
     /**

package/ol/layers/MaplibreLayer.js

@@ -73,10 +73,10 @@ class MaplibreLayer extends MobilityLayerMixin(Layer) {
      *
      * @param {MaplibreLayerOptions} options
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
-     * @param {string} [options.apiKeyName="key"] The geOps Maps api key name.
+     * @param {string} [options.apiKeyName="key"] The geOps Maps API key name.
      * @param {maplibregl.MapOptions} [options.mapOptions={ interactive: false, trackResize: false, attributionControl: false }] Maplibre map options.
-     * @param {string} [options.style="travic_v2"] The geOps Maps api style.
-     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps api url.
+     * @param {string} [options.style="travic_v2"] The geOps Maps API style.
+     * @param {string} [options.url="https://maps.geops.io"] The geOps Maps API url.
      */
     constructor(options) {
         super(Object.assign(Object.assign({ source: new Source({

package/ol/layers/RealtimeLayer.d.ts

@@ -5,8 +5,7 @@ import { Map, MapEvent } from 'ol';
 import { ObjectEvent } from 'ol/Object';
 import Layer from 'ol/layer/Layer';
 import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
-import { RealtimeFullTrajectory, RealtimeTrainId, ViewState } from '../../types';
-import { RealtimeTrajectory } from '../../api/typedefs';
+import { RealtimeFullTrajectory, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
 import RealtimeLayerRenderer from '../renderers/RealtimeLayerRenderer';
 export type RealtimeLayerOptions = RealtimeLayerMixinOptions & {
@@ -18,7 +17,7 @@ declare const RealtimeLayer_base: {
         [x: string]: any;
         debug: boolean;
         trajectories?: {
-            [key: string]: GeoJSONFeature;
+            [key: string]: RealtimeTrajectory;
         } | undefined;
         canvas?: import("../../types").AnyCanvas | undefined;
         mode: import("../../types").RealtimeMode;
@@ -26,7 +25,7 @@ declare const RealtimeLayer_base: {
         tenant: string;
         bboxParameters?: {
             [index: string]: string | number | boolean | string[] | number[] | boolean[];
-        } | undefined;
+        } | undefined; /** @private */
         time?: Date | undefined;
         live?: boolean | undefined;
         speed?: number | undefined;
@@ -48,12 +47,16 @@ declare const RealtimeLayer_base: {
         generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
         generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
         renderTimeIntervalByZoom: number[];
+        /**
+         * Destroy the container of the tracker.
+         * @private
+         */
         format: GeoJSON<typeof Feature>;
         requestId?: number | undefined;
         updateTimeInterval?: number | undefined;
         updateTimeDelay?: number | undefined;
         visibilityRef: import("ol/events").EventsKey;
-        selectedVehicle: GeoJSONFeature;
+        selectedVehicle: RealtimeTrajectory;
         getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
         getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
         getRenderTimeIntervalByZoom: (zoom: number) => number;
@@ -72,19 +75,19 @@ declare const RealtimeLayer_base: {
         renderTrajectories(viewState: ViewState | undefined, noInterpolate: boolean | undefined): void;
         setBbox(extent: [number, number, number, number], zoom: number): void;
         getRefreshTimeInMs(zoom?: number | undefined): number;
-        getVehicle(filterFc: Function): GeoJSONFeature[];
+        getVehicle(filterFc: Function): RealtimeTrajectory[];
         getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
         getTrajectoryInfos(id: string): Promise<{
-            stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
-            fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
+            stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+            fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
         }>;
         purgeOutOfDateTrajectories(): void;
-        purgeTrajectory(trajectory: GeoJSONFeature, extent: [number, number, number, number], zoom: number): boolean;
-        addTrajectory(trajectory: GeoJSONFeature): void;
-        removeTrajectory(trajectoryOrId: any): void;
+        purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
+        addTrajectory(trajectory: RealtimeTrajectory): void;
+        removeTrajectory(trajectoryOrId: string | RealtimeTrajectory): void;
         onZoomEnd(): void;
         onDocumentVisibilityChange(): void;
-        onTrajectoryMessage(data: WebSocketAPIMessageEventData<GeoJSONFeature>): void;
+        onTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrajectory>): void;
         onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<string>): void;
         highlightVehicle(id: string): void;
         selectVehicle(id: string): void;

package/ol/layers/index.d.ts

@@ -1,3 +1,4 @@
 export { default as MaplibreLayer } from "./MaplibreLayer";
 export { default as MaplibreStyleLayer } from "./MaplibreStyleLayer";
 export { default as RealtimeLayer } from "./RealtimeLayer";
+export { default as Layer } from "./Layer";

package/ol/layers/index.js

@@ -1,3 +1,4 @@
 export { default as MaplibreLayer } from './MaplibreLayer';
 export { default as MaplibreStyleLayer } from './MaplibreStyleLayer';
 export { default as RealtimeLayer } from './RealtimeLayer';
+export { default as Layer } from './Layer';

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';

package/ol/renderers/RealtimeLayerRenderer.js

@@ -100,7 +100,10 @@ export default class RealtimeLayerRenderer extends CanvasLayerRenderer {
         const vehicles = [];
         for (let i = 0; i < trajectories.length; i += 1) {
             const trajectory = trajectories[i];
-            if (trajectory.properties.coordinate &&
+            if (
+            // @ts-expect-error coordinate is added by the RealtimeLayer
+            trajectory.properties.coordinate &&
+                // @ts-expect-error coordinate is added by the RealtimeLayer
                 containsCoordinate(ext, trajectory.properties.coordinate)) {
                 vehicles.push(trajectories[i]);
             }

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.11",
+  "version": "3.0.0-beta.13",
   "homepage": "https://mobility-toolbox-js.geops.io/",
   "exports": {
     ".": "./index.js",