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

package/common/styles/realtimeDefaultStyle.js

@@ -141,11 +141,11 @@ const cache = {};
  * @private
  */
 const realtimeDefaultStyle = (trajectory, viewState, options) => {
-    const { hoverVehicleId, selectedVehicleId, useDelayStyle, delayOutlineColor = '#000', delayDisplay = 300000, getRadius = () => 0, getBgColor = () => '#000', getDelayColor = () => '#000', getDelayText = () => null, getDelayFont = (fontSize) => `bold ${fontSize}px arial, sans-serif`, getText = (text) => text, getTextFont = (fontSize) => `bold ${fontSize}px arial, sans-serif`, getTextColor = () => '#000', getTextSize = () => 14, getMaxRadiusForText = () => 10, getMaxRadiusForStrokeAndDelay = () => 7, } = options;
-    const { zoom, pixelRatio = 1 } = viewState;
+    const { delayDisplay = 300000, delayOutlineColor = '#000', getBgColor = () => '#000', getDelayColor = () => '#000', getDelayFont = (fontSize) => `bold ${fontSize}px arial, sans-serif`, getDelayText = () => null, getMaxRadiusForStrokeAndDelay = () => 7, getMaxRadiusForText = () => 10, getRadius = () => 0, getText = (text) => text, getTextColor = () => '#000', getTextFont = (fontSize) => `bold ${fontSize}px arial, sans-serif`, getTextSize = () => 14, hoverVehicleId, selectedVehicleId, useDelayStyle, } = options;
+    const { pixelRatio = 1, zoom } = viewState;
     let { type } = trajectory.properties;
-    const { train_id: id, line, delay, state, operator_provides_realtime_journey: operatorProvidesRealtime, } = trajectory.properties;
-    let { name, text_color: textColor, color } = line || {};
+    const { delay, line, operator_provides_realtime_journey: operatorProvidesRealtime, state, train_id: id, } = trajectory.properties;
+    let { color, name, text_color: textColor } = line || {};
     name = getText(name);
     const cancelled = state === 'JOURNEY_CANCELLED';
     if (!type) {
@@ -157,10 +157,10 @@ const realtimeDefaultStyle = (trajectory, viewState, options) => {
     if (!textColor) {
         textColor = '#000000';
     }
-    if (color && color[0] !== '#') {
+    if (color && !color.startsWith('#')) {
         color = `#${color}`;
     }
-    if (textColor[0] !== '#') {
+    if (!textColor.startsWith('#')) {
         textColor = `#${textColor}`;
     }
     const z = Math.min(Math.floor(zoom || 1), 16);

package/common/styles/realtimeHeadingStyle.js

@@ -67,9 +67,8 @@ const getBufferArrowCanvas = (canvas, fillColor, rotation) => {
  * @private
  */
 const realtimeHeadingStyle = (trajectory, viewState, options) => {
-    var _a, _b;
-    // @ts-ignore
-    const { rotation, type, line } = trajectory.properties;
+    // @ts-expect-error improve types
+    const { line, rotation, type } = trajectory.properties;
     const { color } = line || {};
     const canvas = realtimeDefaultStyle(trajectory, viewState, options);
     if (canvas && rotation !== null) {
@@ -78,8 +77,9 @@ const realtimeHeadingStyle = (trajectory, viewState, options) => {
         if (bufferArrow) {
             const bufferSize = (bufferArrow.width - canvas.width) / 2;
             const vehicleWithArrow = createCanvas(bufferArrow.width, bufferArrow.height);
-            (_a = vehicleWithArrow === null || vehicleWithArrow === void 0 ? void 0 : vehicleWithArrow.getContext('2d')) === null || _a === void 0 ? void 0 : _a.drawImage(bufferArrow, 0, 0, bufferArrow.width, bufferArrow.height);
-            (_b = vehicleWithArrow === null || vehicleWithArrow === void 0 ? void 0 : vehicleWithArrow.getContext('2d')) === null || _b === void 0 ? void 0 : _b.drawImage(canvas, bufferSize, bufferSize, canvas.width, canvas.height);
+            const context = vehicleWithArrow === null || vehicleWithArrow === void 0 ? void 0 : vehicleWithArrow.getContext('2d');
+            context === null || context === void 0 ? void 0 : context.drawImage(bufferArrow, 0, 0, bufferArrow.width, bufferArrow.height);
+            context === null || context === void 0 ? void 0 : context.drawImage(canvas, bufferSize, bufferSize, canvas.width, canvas.height);
             return vehicleWithArrow;
         }
     }

package/common/utils/getMapGlCopyrights.d.ts

@@ -5,8 +5,8 @@ export interface Source {
     };
 }
 export interface SourceCache {
-    used: boolean;
     getSource: () => Source;
+    used: boolean;
 }
 /**
  * Return the copyright a Maplibre map.

package/common/utils/getMapGlCopyrights.js

@@ -8,7 +8,6 @@ const getMapGlCopyrights = (map) => {
     if (!map) {
         return [];
     }
-    // @ts-ignore
     const { style } = map;
     if (!style) {
         return [];
@@ -16,10 +15,11 @@ const getMapGlCopyrights = (map) => {
     const { sourceCaches } = style;
     let copyrights = [];
     Object.values(sourceCaches).forEach((value) => {
+        var _a;
         if (value.used) {
             const source = value.getSource();
-            const attribution = // @ts-ignore
-             source.attribution || (source.options && source.options.attribution);
+            // @ts-expect-error improve types
+            const attribution = source.attribution || ((_a = source.options) === null || _a === void 0 ? void 0 : _a.attribution);
             if (attribution) {
                 copyrights = copyrights.concat(attribution.replace(/&copy;/g, '©').split(/(<a.*?<\/a>)/));
             }

package/common/utils/getVehiclePosition.d.ts

@@ -1,9 +1,9 @@
 import { Coordinate } from 'ol/coordinate';
 import { RealtimeTrajectory } from '../../types';
-export type VehiclePosition = {
+export interface VehiclePosition {
     coord: Coordinate;
     rotation?: number;
-};
+}
 /**
  * Interpolate or not the vehicle position from a trajectory at a specific date.
  *

package/common/utils/getVehiclePosition.js

@@ -9,13 +9,13 @@ import { LineString } from 'ol/geom';
  * @private
  */
 const getVehiclePosition = (now, trajectory, noInterpolate) => {
-    const { time_intervals: timeIntervals, 
-    // @ts-expect-error olGeometry is added by the RealtimeLayer
-    olGeometry, 
-    // @ts-expect-error coordinate is added by the RealtimeLayer
-    coordinate, } = trajectory.properties;
-    // @ts-ignore
-    let { type, coordinates } = trajectory.geometry;
+    const { 
+    // @ts-expect-error  coordinate is added by the RealtimeLayer
+    coordinate, 
+    // @ts-expect-error  olGeometry is added by the RealtimeLayer
+    olGeometry, time_intervals: timeIntervals, } = trajectory.properties;
+    // @ts-expect-error
+    let { coordinates, type } = trajectory.geometry;
     let geometry = olGeometry;
     let coord;
     let rotation;

package/common/utils/renderTrajectories.js

@@ -1,4 +1,4 @@
-import { compose, apply, create } from 'ol/transform';
+import { apply, compose, create } from 'ol/transform';
 import getVehiclePosition from './getVehiclePosition';
 /**
  * Draw all the trajectories available in a canvas.
@@ -17,13 +17,13 @@ const renderTrajectories = (canvas, trajectories, style, viewState, options) =>
     if (!canvas) {
         return { renderedTrajectories: [] };
     }
-    const { time = Date.now(), size = [], center, resolution, rotation = 0, pixelRatio = 1, } = viewState;
+    const { center, pixelRatio = 1, resolution, rotation = 0, size = [], time = Date.now(), } = viewState;
     if (!resolution || !center) {
         return { renderedTrajectories: [] };
     }
-    const { noInterpolate = false, hoverVehicleId, selectedVehicleId, filter, getScreenPixel = (pixel, viewStat) => (viewStat.zoom || 0) < 12
+    const { filter, getScreenPixel = (pixel, viewStat) => (viewStat.zoom || 0) < 12
         ? pixel.map((coord) => Math.floor(coord))
-        : pixel, } = options;
+        : pixel, hoverVehicleId, noInterpolate = false, selectedVehicleId, } = options;
     const context = canvas.getContext('2d');
     context === null || context === void 0 ? void 0 : context.clearRect(0, 0, canvas.width, canvas.height);
     const [width, height] = size;
@@ -49,7 +49,7 @@ const renderTrajectories = (canvas, trajectories, style, viewState, options) =>
             continue;
         }
         // We simplify the trajectory object
-        const { train_id: id, timeOffset } = trajectory.properties;
+        const { timeOffset, train_id: id } = trajectory.properties;
         // We set the rotation and the timeFraction of the trajectory (used by tralis).
         // if rotation === null that seems there is no rotation available.
         const { coord, rotation: rotationIcon } = getVehiclePosition(time - (timeOffset || 0), trajectory, noInterpolate);

package/common/utils/sortByDelay.js

@@ -9,17 +9,17 @@ const sortByDelay = (traj1, traj2) => {
     }
     // We put cancelled train inbetween green and yellow trains
     // >=180000ms corresponds to yellow train
-    // @ts-ignore
+    // @ts-expect-error
     if (props1.cancelled && !props2.cancelled) {
-        // @ts-ignore
+        // @ts-expect-error
         return props2.delay < 180000 ? -1 : 1;
     }
-    // @ts-ignore
+    // @ts-expect-error
     if (props2.cancelled && !props1.cancelled) {
-        // @ts-ignore
+        // @ts-expect-error
         return props1.delay < 180000 ? 1 : -1;
     }
-    // @ts-ignore
+    // @ts-expect-error
     return props2.delay - props1.delay;
 };
 export default sortByDelay;

package/maplibre/layers/RealtimeLayer.d.ts

@@ -2,84 +2,79 @@ import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixi
 import Layer, { LayerOptions } from './Layer';
 import type { AnyMapGlMap, ViewState } from '../../types';
 import type { RealtimeTrajectory } from '../../api/typedefs';
-import { FilterFunction, SortFunction } from '../../common/typedefs';
 export type RealtimeLayerOptions = LayerOptions & RealtimeLayerMixinOptions;
 declare const RealtimeLayer_base: {
     new (options: RealtimeLayerMixinOptions): {
         [x: string]: any;
         [x: symbol]: any;
-        debug: boolean;
-        trajectories?: {
-            [key: string]: import("../../types").RealtimeTrajectory;
-        } | undefined;
-        canvas?: import("../../types").AnyCanvas;
-        mode: import("../../types").RealtimeMode;
         api: import("..").RealtimeAPI;
-        tenant: import("../../types").RealtimeTenant;
-        bboxParameters?: {
-            [index: string]: string | number | boolean | string[] | number[] | boolean[];
-        } | undefined;
-        time?: Date;
+        bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
+        canvas?: import("../../types").AnyCanvas;
+        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
+        debug: boolean;
+        filter?: import("../../common/typedefs").FilterFunction;
+        format: import("ol/format").GeoJSON;
+        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel;
+        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
+        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
+        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
+        getRenderTimeIntervalByZoom: (zoom: number) => number;
+        hoverVehicleId?: import("../../types").RealtimeTrainId;
+        isUpdateBboxOnMoveEnd: boolean;
         live?: boolean;
-        speed?: number;
-        filter?: FilterFunction;
-        sort?: SortFunction;
-        style?: import("../../types").RealtimeStyleFunction;
-        styleOptions?: import("../../types").RealtimeStyleOptions;
-        pixelRatio?: number;
         minZoomInterpolation: number;
-        isUpdateBboxOnMoveEnd: boolean;
-        hoverVehicleId?: import("../../types").RealtimeTrainId;
-        selectedVehicleId?: import("../../types").RealtimeTrainId;
-        renderState?: import("../../types").RealtimeRenderState;
-        useRequestAnimationFrame?: boolean;
-        useDebounce?: boolean;
-        useThrottle?: boolean;
+        mode: import("../../types").RealtimeMode;
         mots?: import("../../types").RealtimeMot[];
         motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel;
-        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
+        onStart?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
+        onStop?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
+        pixelRatio?: number;
+        renderState?: import("../../types").RealtimeRenderState;
         renderTimeIntervalByZoom: number[];
-        format: import("ol/format").GeoJSON;
         requestId?: number;
-        updateTimeInterval?: number;
-        updateTimeDelay?: number;
-        visibilityRef: import("ol/events").EventsKey;
         selectedVehicle: import("../../types").RealtimeTrajectory;
-        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
-        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
-        getRenderTimeIntervalByZoom: (zoom: number) => number;
+        selectedVehicleId?: import("../../types").RealtimeTrainId;
+        sort?: import("../../common/typedefs").SortFunction;
+        speed?: number;
+        style?: import("../../types").RealtimeStyleFunction;
+        styleOptions?: import("../../types").RealtimeStyleOptions;
+        tenant: import("../../types").RealtimeTenant;
         throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        onStart?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        onStop?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        defineProperties(options: RealtimeLayerMixinOptions): void;
+        time?: Date;
+        trajectories?: Record<import("../../types").RealtimeTrainId, import("../../types").RealtimeTrajectory>;
+        updateTimeDelay?: number;
+        updateTimeInterval?: number;
+        useDebounce?: boolean;
+        useRequestAnimationFrame?: boolean;
+        useThrottle?: boolean;
+        visibilityRef: import("ol/events").EventsKey;
+        addTrajectory(trajectory: import("../../types").RealtimeTrajectory): void;
         attachToMap(map: import("../../types").AnyMap): void;
+        defineProperties(options: RealtimeLayerMixinOptions): 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: FilterFunction): import("../../types").RealtimeTrajectory[];
         getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
+        getRefreshTimeInMs(zoom?: number | undefined): number;
         getTrajectoryInfos(id: import("../../types").RealtimeTrainId): Promise<{
-            stopSequence: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
-            fullTrajectory: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+            fullTrajectory: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory>;
+            stopSequence: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory>;
         }>;
-        purgeOutOfDateTrajectories(): void;
-        purgeTrajectory(trajectory: import("../../types").RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
-        addTrajectory(trajectory: import("../../types").RealtimeTrajectory): void;
-        removeTrajectory(trajectoryOrId: import("../../types").RealtimeTrajectory | import("../../types").RealtimeTrainId): void;
-        onZoomEnd(): void;
+        getVehicle(filterFc: import("../../common/typedefs").FilterFunction): import("../../types").RealtimeTrajectory[];
+        highlightVehicle(id: import("../../types").RealtimeTrainId): void;
+        onDeleteTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeTrainId>): void;
         onDocumentVisibilityChange(): void;
         onTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeTrajectory>): void;
-        onDeleteTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeTrainId>): void;
-        highlightVehicle(id: import("../../types").RealtimeTrainId): void;
+        onZoomEnd(): void;
+        purgeOutOfDateTrajectories(): void;
+        purgeTrajectory(trajectory: import("../../types").RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
+        removeTrajectory(trajectoryOrId: import("../../types").RealtimeTrainId | import("../../types").RealtimeTrajectory): void;
+        renderTrajectories(viewState: undefined | ViewState, noInterpolate: boolean | undefined): void;
+        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
         selectVehicle(id: import("../../types").RealtimeTrainId): void;
+        setBbox(extent: [number, number, number, number], zoom: number): void;
+        start(): void;
+        startUpdateTime(): void;
+        stop(): void;
+        stopUpdateTime(): void;
     };
 } & typeof Layer;
 /**
@@ -109,13 +104,13 @@ declare const RealtimeLayer_base: {
  *
  * @implements {maplibregl.CustomLayerInterface}
  * @extends {maplibregl.Evented}
- * @classproperty {function} filter
- * @classproperty {RealtimeMode} mode
- * @classproperty {RealtimeMot[]} mots
- * @classproperty {RealtimeTenant} tenant
- * @classproperty {function} sort
- * @classproperty {function} style
- 
+ * @classproperty {function} filter - Filter out a train. This function must be fast, it is executed for every trajectory on every render frame.
+ * @classproperty {RealtimeMode} mode - The realtime mode to use.
+ * @classproperty {RealtimeMot[]} mots - Filter trains by its mode of transportation. It filters trains on backend side.
+ * @classproperty {RealtimeTenant} tenant - Filter trains by its tenant. It filters trains on backend side.
+ * @classproperty {function} sort - Sort trains. This function must be fast, it is executed on every render frame.
+ * @classproperty {function} style - Function to style the vehicles.
+ s
  * @public
  */
 declare class RealtimeLayer extends RealtimeLayer_base {
@@ -129,7 +124,7 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      * @param {number} [options.minZoomInterpolation=8] Minimal zoom level where to start to interpolate train positions.
      * @param {RealtimeMode} [options.mode='topographic'] The realtime mode to use.
      * @param {SortFunction} options.sort Sort trains. This function must be fast, it is executed on every render frame.
-     * @param {RealtimeStyleFunction} options.style Function to style the trajectories.
+     * @param {RealtimeStyleFunction} options.style Function to style the vehicles.
      * @param {RealtimeTenant} options.tenant Filter trains by its tenant. It filters trains on backend side.
      * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps Realtime API url.
      */

package/maplibre/layers/RealtimeLayer.js

@@ -34,13 +34,13 @@ import toMercatorExtent from '../../common/utils/toMercatorExtent';
  *
  * @implements {maplibregl.CustomLayerInterface}
  * @extends {maplibregl.Evented}
- * @classproperty {function} filter
- * @classproperty {RealtimeMode} mode
- * @classproperty {RealtimeMot[]} mots
- * @classproperty {RealtimeTenant} tenant
- * @classproperty {function} sort
- * @classproperty {function} style
- 
+ * @classproperty {function} filter - Filter out a train. This function must be fast, it is executed for every trajectory on every render frame.
+ * @classproperty {RealtimeMode} mode - The realtime mode to use.
+ * @classproperty {RealtimeMot[]} mots - Filter trains by its mode of transportation. It filters trains on backend side.
+ * @classproperty {RealtimeTenant} tenant - Filter trains by its tenant. It filters trains on backend side.
+ * @classproperty {function} sort - Sort trains. This function must be fast, it is executed on every render frame.
+ * @classproperty {function} style - Function to style the vehicles.
+ s
  * @public
  */
 class RealtimeLayer extends RealtimeLayerMixin(Layer) {
@@ -54,7 +54,7 @@ class RealtimeLayer extends RealtimeLayerMixin(Layer) {
      * @param {number} [options.minZoomInterpolation=8] Minimal zoom level where to start to interpolate train positions.
      * @param {RealtimeMode} [options.mode='topographic'] The realtime mode to use.
      * @param {SortFunction} options.sort Sort trains. This function must be fast, it is executed on every render frame.
-     * @param {RealtimeStyleFunction} options.style Function to style the trajectories.
+     * @param {RealtimeStyleFunction} options.style Function to style the vehicles.
      * @param {RealtimeTenant} options.tenant Filter trains by its tenant. It filters trains on backend side.
      * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps Realtime API url.
      */

package/maplibre/utils/getSourceCoordinates.js

@@ -4,17 +4,17 @@
  */
 export const getSourceCoordinates = (map, pixelRatio = 1) => {
     // Requesting getBounds is not enough when we rotate the map, so we request manually each corner.
-    const { width, height } = map.getCanvas();
-    // @ts-ignore
+    const { height, width } = map.getCanvas();
+    // @ts-expect-error
     const leftTop = map.unproject({ x: 0, y: 0 });
-    // @ts-ignore
+    // @ts-expect-error
     const leftBottom = map.unproject({ x: 0, y: height / pixelRatio }); // southWest
-    // @ts-ignore
+    // @ts-expect-error
     const rightBottom = map.unproject({
         x: width / pixelRatio,
         y: height / pixelRatio,
     });
-    // @ts-ignore
+    // @ts-expect-error
     const rightTop = map.unproject({ x: width / pixelRatio, y: 0 }); // north east
     return [
         [leftTop.lng, leftTop.lat],