mobility-toolbox-js 3.0.0-beta.8 → 3.0.0-beta.9

package/maplibre/layers/RealtimeLayer.d.ts

@@ -0,0 +1,160 @@
+import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
+import Layer, { LayerOptions } from './Layer';
+import type { AnyMapGlMap, ViewState } from '../../types';
+import type { RealtimeTrajectory } from '../../api/typedefs';
+export type RealtimeLayerOptions = LayerOptions & RealtimeLayerMixinOptions;
+declare const RealtimeLayer_base: {
+    new (options: RealtimeLayerMixinOptions): {
+        [x: string]: any;
+        debug: boolean;
+        trajectories?: {
+            [key: string]: GeoJSONFeature;
+        } | undefined;
+        canvas?: import("../../types").AnyCanvas | undefined;
+        mode: import("../../types").RealtimeMode;
+        api: import("../../api/RealtimeAPI").default;
+        tenant: string;
+        bboxParameters?: {
+            [index: string]: string | number | boolean | string[] | number[] | boolean[];
+        } | undefined;
+        time?: Date | undefined;
+        live?: boolean | undefined;
+        speed?: number | undefined;
+        filter?: Function | undefined;
+        sort?: Function | undefined;
+        style?: import("../../types").RealtimeStyleFunction | undefined;
+        styleOptions?: import("../../types").RealtimeStyleOptions | undefined;
+        pixelRatio?: number | undefined;
+        minZoomInterpolation: number;
+        isUpdateBboxOnMoveEnd: boolean;
+        hoverVehicleId?: string | undefined;
+        selectedVehicleId?: string | undefined;
+        renderState?: import("../../types").RealtimeRenderState | undefined;
+        useRequestAnimationFrame?: boolean | undefined;
+        useDebounce?: boolean | undefined;
+        useThrottle?: boolean | undefined;
+        mots?: import("../../types").RealtimeMot[] | undefined;
+        motsByZoom: import("../../types").RealtimeMot[][];
+        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
+        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
+        renderTimeIntervalByZoom: number[];
+        format: import("ol/format/GeoJSON").default<typeof import("ol/Feature").default>;
+        requestId?: number | undefined;
+        updateTimeInterval?: number | undefined;
+        updateTimeDelay?: number | undefined;
+        visibilityRef: import("ol/events").EventsKey;
+        selectedVehicle: GeoJSONFeature;
+        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
+        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
+        getRenderTimeIntervalByZoom: (zoom: number) => number;
+        throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean | undefined) => void;
+        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean | undefined) => void;
+        onStart?: ((realtimeLayer: any) => void) | undefined;
+        onStop?: ((realtimeLayer: any) => void) | undefined;
+        defineProperties(options: RealtimeLayerMixinOptions): void;
+        attachToMap(map: any): void;
+        detachFromMap(): void;
+        start(): void;
+        startUpdateTime(): void;
+        stop(): void;
+        stopUpdateTime(): void;
+        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
+        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[];
+        getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
+        getTrajectoryInfos(id: string): Promise<{
+            stopSequence: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<GeoJSONFeature[]>;
+            fullTrajectory: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<GeoJSONFeature[]>;
+        }>;
+        purgeOutOfDateTrajectories(): void;
+        purgeTrajectory(trajectory: GeoJSONFeature, extent: [number, number, number, number], zoom: number): boolean;
+        addTrajectory(trajectory: GeoJSONFeature): void;
+        removeTrajectory(trajectoryOrId: any): void;
+        onZoomEnd(): void;
+        onDocumentVisibilityChange(): void;
+        onTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<GeoJSONFeature>): void;
+        onDeleteTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<string>): void;
+        highlightVehicle(id: string): void;
+        selectVehicle(id: string): void;
+    };
+} & typeof Layer;
+/**
+ * Responsible for loading and display data from a geOps realtime API.
+ *
+ * @example
+ * import { RealtimeLayer } from 'mobility-toolbox-js/Maplibre';
+ *
+ * const layer = new RealtimeLayer({
+ *   apiKey: "yourApiKey"
+ *   // url: "wss://api.geops.io/tracker-ws/v1/",
+ * });
+ *
+ *
+ * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ *
+ * @implements {maplibregl.CustomLayer}
+ * @extends {maplibregl.Evented}
+ * @public
+ */
+declare class RealtimeLayer extends RealtimeLayer_base {
+    /**
+     * Constructor.
+     *
+     * @param {RealtimeLayerOptions} options
+     * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
+     * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps realtime API url.
+     *
+     */
+    constructor(options?: {});
+    /**
+     * Add sources, layers and listeners to the map.
+     */
+    onAdd(map: AnyMapGlMap, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
+    /**
+     * Remove source, layers and listeners from the map.
+     */
+    onRemove(map: AnyMapGlMap, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
+    onLoad(): void;
+    /**
+     * Start updating vehicles position.
+     *
+     * @public
+     */
+    start(): void;
+    /**
+     * Stop updating vehicles position.
+     *
+     * @public
+     */
+    stop(): void;
+    /**
+     * Render the trajectories using current map's size, resolution and rotation.
+     * @param {boolean} noInterpolate if true, renders the vehicles without interpolating theirs positions.
+     * @private
+     */
+    renderTrajectories(noInterpolate?: boolean): void;
+    /**
+     * Return the delay in ms before the next rendering.
+     */
+    getRefreshTimeInMs(): number;
+    /**
+     * Remove the trajectory form the list if necessary.
+     */
+    purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
+    /**
+     * Send the current bbox to the websocket
+     */
+    setBbox(extent?: [number, number, number, number], zoom?: number): void;
+    renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
+    /**
+     * Callback on 'move' event.
+     */
+    onMove(): void;
+    /**
+     * Callback on 'moveend' event.
+     */
+    onMoveEnd(): void;
+}
+export default RealtimeLayer;

package/maplibre/layers/index.d.ts

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

package/maplibre/utils/getMercatorResolution.d.ts

@@ -0,0 +1,7 @@
+import { AnyMapGlMap } from '../../types';
+/**
+ * Get the current resolution of a Maplibre map.
+ * @param {maplibregl.Map} map A map object.
+ */
+declare const getMercatorResolution: (map: AnyMapGlMap) => number;
+export default getMercatorResolution;

package/maplibre/utils/getSourceCoordinates.d.ts

@@ -0,0 +1,7 @@
+import { AnyMapGlMap } from '../../types';
+/**
+ * Get the canvas source coordinates of the current map's extent.
+ * @param {maplibregl.Map} map A map object.
+ */
+export declare const getSourceCoordinates: (map: AnyMapGlMap, pixelRatio?: number) => number[][];
+export default getSourceCoordinates;

package/maplibre/utils/index.d.ts

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

package/mbt.js

@@ -45447,8 +45447,9 @@ uniform ${i3} ${s3} u_${a3};
 
   // src/ol/mixins/PropertiesLayerMixin.ts
   function PropertiesLayerMixin(Base) {
-    return class extends Base {
-      constructor(options) {
+    return class PropertiesLayer extends Base {
+      constructor(...args) {
+        const options = args[0];
         super(options);
         this.options = {};
         this.olListenersKeys = [];
@@ -45532,6 +45533,7 @@ uniform ${i3} ${s3} u_${a3};
       set visible(newValue) {
         this.setVisible(newValue);
       }
+      // @ts-expect-error - this is a mixin
       setMapInternal(map) {
         super.setMapInternal(map);
         if (map) {
@@ -45583,10 +45585,10 @@ uniform ${i3} ${s3} u_${a3};
 
   // src/ol/mixins/MobilityLayerMixin.ts
   function MobilityLayerMixin(Base) {
-    return class extends PropertiesLayerMixin_default(Base) {
-      constructor(options = {}) {
-        super(options);
-      }
+    return class MobilityLayer extends PropertiesLayerMixin_default(Base) {
+      // constructor(options: MobilityLayerOptions = {}) {
+      //   super(options);
+      // }
     };
   }
   var MobilityLayerMixin_default = MobilityLayerMixin;
@@ -45634,6 +45636,7 @@ uniform ${i3} ${s3} u_${a3};
         style: "travic_v2",
         url: "https://maps.geops.io",
         ...options || {},
+        // @ts-expect-error mapOptions must be saved by the mixin in this.options
         mapOptions: {
           interactive: false,
           trackResize: false,
@@ -46072,7 +46075,7 @@ uniform ${i3} ${s3} u_${a3};
         }
       }
       this.olListenersKeys.push(
-        // @ts-expect-error 'load' is a custom event form mobility-toolbox-js
+        // @ts-expect-error 'load' is a custom event
         this.maplibreLayer.on("load", this.onLoad.bind(this)),
         this.on("change:visible", (evt) => {
           this.applyLayoutVisibility(evt);
@@ -47230,7 +47233,7 @@ uniform ${i3} ${s3} u_${a3};
         this.container.style.position = "absolute";
         this.container.style.width = "100%";
         this.container.style.height = "100%";
-        if (canvas2) {
+        if (canvas2 instanceof HTMLCanvasElement) {
           canvas2.style.position = "absolute";
           canvas2.style.top = "0";
           canvas2.style.left = "0";
@@ -47254,17 +47257,20 @@ uniform ${i3} ${s3} u_${a3};
             canvas2?.height
           );
         } else {
-          const pixelCenterRendered = this.getLayer().getMapInternal()?.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?.getPixelFromCoordinate(renderedCenter);
+          const pixelCenter = 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;
@@ -47305,7 +47311,7 @@ uniform ${i3} ${s3} u_${a3};
       }
       const layer = this.getLayer();
       const map = layer.getMapInternal();
-      const resolution = map.getView().getResolution();
+      const resolution = map?.getView()?.getResolution() || 1;
       const nb = 10;
       const ext = buffer(
         [...coordinate, ...coordinate],
@@ -47392,6 +47398,7 @@ uniform ${i3} ${s3} u_${a3};
         this.olListenersKeys.push(
           ...this.map.on(
             ["moveend", "change:target"],
+            // @ts-expect-error - bad ol definitions
             (evt) => {
               const view = (evt.map || evt.target).getView();
               if (view.getAnimating() || view.getInteracting()) {
@@ -47472,8 +47479,9 @@ uniform ${i3} ${s3} u_${a3};
       isRendered = blockRendering ? false : super.renderTrajectoriesInternal(viewState, noInterpolate);
       if (isRendered) {
         this.renderedViewState = { ...viewState };
-        if (this.getRenderer().container) {
-          this.getRenderer().container.style.transform = "";
+        const { container } = this.getRenderer();
+        if (container) {
+          container.style.transform = "";
         }
       }
       return isRendered;
@@ -47565,7 +47573,7 @@ uniform ${i3} ${s3} u_${a3};
       return super.purgeTrajectory(
         trajectory,
         extent || this.map.getView().calculateExtent(),
-        zoom || this.map.getView().getZoom()
+        zoom || this.map.getView().getZoom() || 0
       );
     }
     /**
@@ -47576,7 +47584,7 @@ uniform ${i3} ${s3} u_${a3};
     setBbox(extent, zoom) {
       super.setBbox(
         extent || this.map.getView().calculateExtent(),
-        zoom || this.map.getView().getZoom()
+        zoom || this.map.getView().getZoom() || 0
       );
     }
     /**