mobility-toolbox-js 3.0.0-beta.9 → 3.0.1-beta.0

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/typedefs.d.ts

@@ -1,6 +1,7 @@
 export default dummy;
 export type FilterFunction = Function;
 export type SortFunction = Function;
+export type getMotsByZoomFunction = Function;
 export type ViewState = {
     /**
      * A time in ms.
@@ -13,11 +14,11 @@ export type ViewState = {
     /**
      * An Extent in mercator coordinates.
      */
-    extent: any;
+    extent: number[4];
     /**
      * A size ([width, height]).
      */
-    size: any;
+    size: number[2];
     /**
      * A rotation in radians.
      */
@@ -47,7 +48,7 @@ export type FeatureInfo = {
     /**
      * The coordinate where to find the featue.
      */
-    coordinate: any;
+    coordinate: number[2];
 };
 export type MaplibreLayerOptions = {
     /**
@@ -61,7 +62,7 @@ export type MaplibreLayerOptions = {
     /**
      * Maplibre map options.
      */
-    mapOptions: maplibregl.MapOptions;
+    mapLibreOptions: maplibregl.MapOptions;
     /**
      * geOps Maps api style.
      */
@@ -135,7 +136,7 @@ export type VehiclePosition = {
     /**
      * Coordinate of the vehicle position in Mercator .
      */
-    coord: any;
+    coord: number[2];
     /**
      * An angle in radians representing the direction (from the true north) towards which the vehicle is facing.
      */
@@ -156,6 +157,12 @@ type dummy = ol;
  * @param {any} b Object b to compare.
  * @returns number
  */
+/**
+ * @typedef {function} getMotsByZoomFunction
+ * @param {number} zoom Curent zoom level.
+ * @param {RealtimeMot[][]} motsByZoom Default array of mots by zoom.
+ * @returns number
+ */
 /**
  * @typedef {Object} ViewState
  * @property {number|undefined} time A time in ms.
@@ -180,7 +187,7 @@ type dummy = ol;
  * @typedef {Object} MaplibreLayerOptions
  * @property {string} apiKey Access key for [geOps apis](https://developer.geops.io/).
  * @property {string} apiKeyName geOps Maps api key name.
- * @property {maplibregl.MapOptions} options.mapOptions Maplibre map options.
+ * @property {maplibregl.MapOptions} options.mapLibreOptions Maplibre map options.
  * @property {string} style geOps Maps api style.
  * @property {string} url geOps Maps api url.
  */

package/common/typedefs.js

@@ -9,6 +9,12 @@
  * @param {any} b Object b to compare.
  * @returns number
  */
+/**
+ * @typedef {function} getMotsByZoomFunction
+ * @param {number} zoom Curent zoom level.
+ * @param {RealtimeMot[][]} motsByZoom Default array of mots by zoom.
+ * @returns number
+ */
 /**
  * @typedef {Object} ViewState
  * @property {number|undefined} time A time in ms.
@@ -33,7 +39,7 @@
  * @typedef {Object} MaplibreLayerOptions
  * @property {string} apiKey Access key for [geOps apis](https://developer.geops.io/).
  * @property {string} apiKeyName geOps Maps api key name.
- * @property {maplibregl.MapOptions} options.mapOptions Maplibre map options.
+ * @property {maplibregl.MapOptions} options.mapLibreOptions Maplibre map options.
  * @property {string} style geOps Maps api style.
  * @property {string} url geOps Maps api url.
  */

package/common/utils/compareDepartures.d.ts

@@ -1,8 +1,8 @@
 import { RealtimeDeparture } from '../../types';
 /**
  * Compare two given departures for sort alogithm,
- * @param {Departure} a First departure.
- * @param {Departure} b Second departure.
+ * @param {RealtimeDeparture} a First departure.
+ * @param {RealtimeDeparture} b Second departure.
  * @param {boolean} [sortByMinArrivalTime=false] Sort departures by arrival time.
  * @private
  */

package/common/utils/compareDepartures.js

@@ -1,7 +1,7 @@
 /**
  * Compare two given departures for sort alogithm,
- * @param {Departure} a First departure.
- * @param {Departure} b Second departure.
+ * @param {RealtimeDeparture} a First departure.
+ * @param {RealtimeDeparture} b Second departure.
  * @param {boolean} [sortByMinArrivalTime=false] Sort departures by arrival time.
  * @private
  */

package/common/utils/debounceWebsocketMessages.d.ts

@@ -7,5 +7,5 @@ import type { WebSocketAPIMessageCallback } from '../../api/WebSocketAPI';
  * @param {number} [timeout = 100] debounce timeout in ms
  * @private
  */
-declare const debounceWebsocketMessages: (onUpdate: (objects: any[]) => void, getObjectId?: ((object: any) => string) | undefined, timeout?: number) => WebSocketAPIMessageCallback<any>;
+declare const debounceWebsocketMessages: (onUpdate: (objects: any[]) => void, getObjectId?: (object: any) => string, timeout?: number) => WebSocketAPIMessageCallback<any>;
 export default debounceWebsocketMessages;

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/getRealtimeModeSuffix.d.ts

@@ -3,6 +3,7 @@ import type { RealtimeModesType } from '../../api/RealtimeAPI';
 /**
  * Get the websocket channel suffix, depending on the current mode.
  * @param {String} mode Mode 'topographic' ou 'schematic'.
+ * @param {String[]} modes List of modes
  * @private
  */
 declare const getModeSuffix: (mode: RealtimeMode, modes: RealtimeModesType) => string;

package/common/utils/getRealtimeModeSuffix.js

@@ -1,6 +1,7 @@
 /**
  * Get the websocket channel suffix, depending on the current mode.
  * @param {String} mode Mode 'topographic' ou 'schematic'.
+ * @param {String[]} modes List of modes
  * @private
  */
 const getModeSuffix = (mode, modes) => mode === modes.SCHEMATIC ? '_schematic' : '';

package/common/utils/getVehiclePosition.d.ts

@@ -1,8 +1,9 @@
 import { Coordinate } from 'ol/coordinate';
-export type VehiclePosition = {
+import { RealtimeTrajectory } from '../../types';
+export interface VehiclePosition {
     coord: Coordinate;
-    rotation: number;
-};
+    rotation?: number;
+}
 /**
  * Interpolate or not the vehicle position from a trajectory at a specific date.
  *
@@ -12,5 +13,5 @@ export type VehiclePosition = {
  * @returns {VehiclePosition}
  * @private
  */
-declare const getVehiclePosition: (now: number, trajectory: GeoJSONFeature, noInterpolate: boolean) => VehiclePosition;
+declare const getVehiclePosition: (now: number, trajectory: RealtimeTrajectory, noInterpolate: boolean) => VehiclePosition;
 export default getVehiclePosition;

package/common/utils/getVehiclePosition.js

@@ -9,14 +9,20 @@ import { LineString } from 'ol/geom';
  * @private
  */
 const getVehiclePosition = (now, trajectory, noInterpolate) => {
-    const { time_intervals: timeIntervals, olGeometry, coordinate, } = trajectory.properties;
-    const { coordinates } = trajectory.geometry;
-    let { type } = 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;
+    // If an olGeometry exists we use it. It avoids to create one each time.
     if (olGeometry) {
         type = geometry.getType();
+        coordinates = geometry.getCoordinates();
     }
     if (noInterpolate && coordinate) {
         coord = coordinate;

package/common/utils/renderTrajectories.d.ts

@@ -1,7 +1,7 @@
 import { AnyCanvas, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTrajectories, ViewState } from '../../types';
 /**
  * Draw all the trajectories available in a canvas.
- * @param {HTMLCanvas|HTMLOffscreenCanvas} The canvas where to draw the trajectories.
+ * @param {HTMLCanvas|HTMLOffscreenCanvas} canvas The canvas where to draw the trajectories.
  * @param {ViewState} trajectories An array of trajectories.
  * @param {Function} style A function that returns a canvas representing a vehicle of a specific trajectory.
  * @param {ViewState} viewState The view state of the map.

package/common/utils/renderTrajectories.js

@@ -1,8 +1,8 @@
-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.
- * @param {HTMLCanvas|HTMLOffscreenCanvas} The canvas where to draw the trajectories.
+ * @param {HTMLCanvas|HTMLOffscreenCanvas} canvas The canvas where to draw the trajectories.
  * @param {ViewState} trajectories An array of trajectories.
  * @param {Function} style A function that returns a canvas representing a vehicle of a specific trajectory.
  * @param {ViewState} viewState The view state of the map.
@@ -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/sortAndFilterDepartures.d.ts

@@ -8,7 +8,7 @@ import type { RealtimeDepartureExtended } from '../../types';
  *
  * @param {Object} depObject The object containing departures by id.
  * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
- * @return {Array<Departure>} Return departures array.
+ * @return {RealtimeDeparture[]} Return departures array.
  * @private
  */
 declare const sortAndfilterDepartures: (depObject: RealtimeAPIDeparturesById, sortByMinArrivalTime?: boolean, maxDepartureAge?: number) => RealtimeDepartureExtended[];

package/common/utils/sortAndFilterDepartures.js

@@ -7,7 +7,7 @@ import compareDepartures from './compareDepartures';
  *
  * @param {Object} depObject The object containing departures by id.
  * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
- * @return {Array<Departure>} Return departures array.
+ * @return {RealtimeDeparture[]} Return departures array.
  * @private
  */
 const sortAndfilterDepartures = (depObject, sortByMinArrivalTime = false, maxDepartureAge = 30) => {

package/common/utils/sortByDelay.d.ts

@@ -1,3 +1,3 @@
-/** @private */
-declare const sortByDelay: (traj1: GeoJSONFeature, traj2: GeoJSONFeature) => number;
+import { RealtimeTrajectory } from '../../types';
+declare const sortByDelay: (traj1: RealtimeTrajectory, traj2: RealtimeTrajectory) => number;
 export default sortByDelay;

package/common/utils/sortByDelay.js

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

package/maplibre/layers/Layer.d.ts

@@ -11,7 +11,7 @@ export type LayerOptions = {
  *
  * const layer = new Layer({ id:'MyLayer' });
  *
- * @implements {maplibregl.CustomLayer}
+ * @implements {maplibregl.CustomLayerInterface}
  * @extends {maplibregl.Evented}
  * @private
  */

package/maplibre/layers/Layer.js

@@ -8,7 +8,7 @@ import { Evented } from 'maplibre-gl';
  *
  * const layer = new Layer({ id:'MyLayer' });
  *
- * @implements {maplibregl.CustomLayer}
+ * @implements {maplibregl.CustomLayerInterface}
  * @extends {maplibregl.Evented}
  * @private
  */

package/maplibre/layers/RealtimeLayer.d.ts

@@ -6,96 +6,111 @@ export type RealtimeLayerOptions = LayerOptions & RealtimeLayerMixinOptions;
 declare const RealtimeLayer_base: {
     new (options: RealtimeLayerMixinOptions): {
         [x: string]: any;
+        [x: symbol]: any;
+        api: import("..").RealtimeAPI;
+        bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
+        canvas?: import("../../types").AnyCanvas;
+        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
         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;
+        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;
-        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;
+        live?: boolean;
+        minZoomInterpolation: number;
+        mode: import("../../types").RealtimeMode;
+        mots?: import("../../types").RealtimeMot[];
         motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
-        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").default<typeof import("ol/Feature").default>;
-        requestId?: number | undefined;
-        updateTimeInterval?: number | undefined;
-        updateTimeDelay?: number | undefined;
+        requestId?: number;
+        selectedVehicle: import("../../types").RealtimeTrajectory;
+        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;
+        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;
-        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;
+        addTrajectory(trajectory: import("../../types").RealtimeTrajectory): void;
+        attachToMap(map: import("../../types").AnyMap): void;
         defineProperties(options: RealtimeLayerMixinOptions): void;
-        attachToMap(map: any): void;
         detachFromMap(): void;
+        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<{
+            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>;
+        }>;
+        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;
+        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;
-        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.
+ * A Maplibre layer able to display data from the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
- * import { RealtimeLayer } from 'mobility-toolbox-js/Maplibre';
+ * import { Map } from 'maplibre-gl';
+ * import { RealtimeLayer } from 'mobility-toolbox-js/maplibre';
  *
+ * // Define the map
+ * const map = new Map({ ... });
+ *
+ * // Define your layer map
  * const layer = new RealtimeLayer({
  *   apiKey: "yourApiKey"
  *   // url: "wss://api.geops.io/tracker-ws/v1/",
  * });
  *
+ * // Add the layer to your map *
+ * map.on('load', () => {
+ *   map.addLayer(layer);
+ * });
+ *
  *
  * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ * @see <a href="/example/mb-realtime>Live example</a>
  *
- * @implements {maplibregl.CustomLayer}
+ * @implements {maplibregl.CustomLayerInterface}
  * @extends {maplibregl.Evented}
+ * @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 {
@@ -104,8 +119,14 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      *
      * @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.
-     *
+     * @param {FilterFunction} options.filter Filter out a train. This function must be fast, it is executed for every trajectory on every render frame.
+     * @param {getMotsByZoomFunction} options.getMotsByZoom Returns for each zoom level the list of MOTs to display. It filters trains on backend side.
+     * @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 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.
      */
     constructor(options?: {});
     /**