mobility-toolbox-js 3.0.0-beta.16 → 3.0.0-beta.18

package/api/HttpAPI.js

@@ -36,7 +36,6 @@ class HttpAPI {
             // Clean requets parameters, removing undefined and null values.
             const searchParams = params || {};
             const url = getUrlWithParams(`${this.url}${path || ''}`, Object.assign({ key: this.apiKey }, searchParams));
-            fetch;
             const response = yield fetch(url.toString(), config);
             const data = yield response.json();
             if (data.error) {

package/common/mixins/RealtimeLayerMixin.d.ts

@@ -3,7 +3,7 @@ import { EventsKey } from 'ol/events';
 import { Coordinate } from 'ol/coordinate';
 import { Options } from 'ol/layer/Layer';
 import { RealtimeAPI } from '../../api';
-import { AnyCanvas, AnyLayerClass, AnyMap, AnyRealtimeLayer, LayerGetFeatureInfoOptions, RealtimeGeneralizationLevel, RealtimeMode, RealtimeMot, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, ViewState, AnyLayer, LayerGetFeatureInfoResponse, RealtimeTrajectory } from '../../types';
+import { AnyCanvas, AnyMap, AnyRealtimeLayer, LayerGetFeatureInfoOptions, RealtimeGeneralizationLevel, RealtimeMode, RealtimeMot, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, ViewState, AnyLayer, LayerGetFeatureInfoResponse, RealtimeTrajectory, AnyLayerable } from '../../types';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
 import { FilterFunction, SortFunction } from '../typedefs';
 export type RealtimeLayerMixinOptions = Options & {
@@ -85,45 +85,46 @@ export declare class RealtimeLayerInterface {
  * @return {Class}  A class that implements {RealtimeLayerInterface} class and extends Base;
  * @private
  */
-declare function RealtimeLayerMixin<T extends AnyLayerClass>(Base: T): {
+declare function RealtimeLayerMixin<T extends AnyLayerable>(Base: T): {
     new (options: RealtimeLayerMixinOptions): {
         [x: string]: any;
+        [x: symbol]: any;
         debug: boolean;
         trajectories?: {
-            [key: string]: RealtimeTrajectory;
-        } | undefined;
-        canvas?: AnyCanvas | undefined;
+            [key: RealtimeTrainId]: RealtimeTrajectory;
+        };
+        canvas?: AnyCanvas;
         mode: RealtimeMode;
         api: RealtimeAPI;
         tenant: RealtimeTenant;
         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?: RealtimeStyleFunction | undefined;
-        styleOptions?: RealtimeStyleOptions | undefined;
-        pixelRatio?: number | undefined;
+            [index: string]: string | number | boolean | string[] | boolean[] | number[];
+        };
+        time?: Date;
+        live?: boolean;
+        speed?: number;
+        filter?: FilterFunction;
+        sort?: SortFunction;
+        style?: RealtimeStyleFunction;
+        styleOptions?: RealtimeStyleOptions;
+        pixelRatio?: number;
         minZoomInterpolation: number;
         isUpdateBboxOnMoveEnd: boolean;
-        hoverVehicleId?: string | undefined;
-        selectedVehicleId?: string | undefined;
-        renderState?: RealtimeRenderState | undefined;
-        useRequestAnimationFrame?: boolean | undefined;
-        useDebounce?: boolean | undefined;
-        useThrottle?: boolean | undefined;
-        mots?: RealtimeMot[] | undefined;
+        hoverVehicleId?: RealtimeTrainId;
+        selectedVehicleId?: RealtimeTrainId;
+        renderState?: RealtimeRenderState;
+        useRequestAnimationFrame?: boolean;
+        useDebounce?: boolean;
+        useThrottle?: boolean;
+        mots?: RealtimeMot[];
         motsByZoom: RealtimeMot[][];
-        generalizationLevel?: RealtimeGeneralizationLevel | undefined;
+        generalizationLevel?: RealtimeGeneralizationLevel;
         generalizationLevelByZoom: RealtimeGeneralizationLevel[];
         renderTimeIntervalByZoom: number[];
         format: GeoJSON;
-        requestId?: number | undefined;
-        updateTimeInterval?: number | undefined;
-        updateTimeDelay?: number | undefined;
+        requestId?: number;
+        updateTimeInterval?: number;
+        updateTimeDelay?: number;
         visibilityRef: EventsKey;
         selectedVehicle: RealtimeTrajectory;
         getMotsByZoom: (zoom: number) => RealtimeMot[];
@@ -131,8 +132,8 @@ declare function RealtimeLayerMixin<T extends AnyLayerClass>(Base: T): {
         getRenderTimeIntervalByZoom: (zoom: number) => number;
         throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
         debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        onStart?: ((realtimeLayer: AnyLayer) => void) | undefined;
-        onStop?: ((realtimeLayer: AnyLayer) => void) | undefined;
+        onStart?: (realtimeLayer: AnyLayer) => void;
+        onStop?: (realtimeLayer: AnyLayer) => void;
         /**
          * Define layer's properties.
          *

package/common/mixins/RealtimeLayerMixin.js

@@ -473,9 +473,9 @@ function RealtimeLayerMixin(Base) {
                 zoomFloor,
             ];
             /* @private */
-            const generalizationLevel = this.getGeneralizationLevelByZoom(zoomFloor);
+            this.generalizationLevel = this.getGeneralizationLevelByZoom(zoomFloor);
             if (this.generalizationLevel) {
-                bbox.push(`gen=${generalizationLevel}`);
+                bbox.push(`gen=${this.generalizationLevel}`);
             }
             /* @private */
             this.mots = this.getMotsByZoom(zoomFloor);

package/common/typedefs.d.ts

@@ -14,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.
      */
@@ -48,7 +48,7 @@ export type FeatureInfo = {
     /**
      * The coordinate where to find the featue.
      */
-    coordinate: any;
+    coordinate: number[2];
 };
 export type MaplibreLayerOptions = {
     /**
@@ -136,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.
      */

package/maplibre/layers/RealtimeLayer.d.ts

@@ -2,62 +2,59 @@ 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 | undefined;
+        canvas?: import("../../types").AnyCanvas;
         mode: import("../../types").RealtimeMode;
         api: import("..").RealtimeAPI;
-        tenant: string;
+        tenant: import("../../types").RealtimeTenant;
         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;
+        time?: Date;
+        live?: boolean;
+        speed?: number;
+        filter?: FilterFunction;
+        sort?: SortFunction;
+        style?: import("../../types").RealtimeStyleFunction;
+        styleOptions?: import("../../types").RealtimeStyleOptions;
+        pixelRatio?: number;
         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;
+        hoverVehicleId?: import("../../types").RealtimeTrainId;
+        selectedVehicleId?: import("../../types").RealtimeTrainId;
+        renderState?: import("../../types").RealtimeRenderState;
+        useRequestAnimationFrame?: boolean;
+        useDebounce?: boolean;
+        useThrottle?: boolean;
+        mots?: import("../../types").RealtimeMot[];
         motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
+        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel;
         generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
         renderTimeIntervalByZoom: number[];
-        format: import("ol/format").GeoJSON<typeof import("ol").Feature>;
-        requestId?: number | undefined;
-        updateTimeInterval?: number | undefined;
-        updateTimeDelay?: number | undefined;
+        format: import("ol/format").GeoJSON;
+        requestId?: number;
+        updateTimeInterval?: number;
+        updateTimeDelay?: number;
         visibilityRef: import("ol/events").EventsKey;
-        /**
-         * Render the trajectories using current map's size, resolution and rotation.
-         * @param {boolean} noInterpolate if true, renders the vehicles without interpolating theirs positions.
-         * @private
-         */
         selectedVehicle: import("../../types").RealtimeTrajectory;
         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;
+        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;
-        attachToMap(map: any): void;
+        attachToMap(map: import("../../types").AnyMap): void;
         detachFromMap(): void;
         start(): void;
         startUpdateTime(): void;
@@ -67,22 +64,22 @@ 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): import("../../types").RealtimeTrajectory[];
+        getVehicle(filterFc: FilterFunction): import("../../types").RealtimeTrajectory[];
         getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
-        getTrajectoryInfos(id: string): Promise<{
+        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[]>;
         }>;
         purgeOutOfDateTrajectories(): void;
         purgeTrajectory(trajectory: import("../../types").RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
         addTrajectory(trajectory: import("../../types").RealtimeTrajectory): void;
-        removeTrajectory(trajectoryOrId: string | import("../../types").RealtimeTrajectory): void;
+        removeTrajectory(trajectoryOrId: import("../../types").RealtimeTrajectory | import("../../types").RealtimeTrainId): void;
         onZoomEnd(): void;
         onDocumentVisibilityChange(): void;
         onTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeTrajectory>): void;
-        onDeleteTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<string>): void;
-        highlightVehicle(id: string): void;
-        selectVehicle(id: string): void;
+        onDeleteTrajectoryMessage(data: import("../../api/WebSocketAPI").WebSocketAPIMessageEventData<import("../../types").RealtimeTrainId>): void;
+        highlightVehicle(id: import("../../types").RealtimeTrainId): void;
+        selectVehicle(id: import("../../types").RealtimeTrainId): void;
     };
 } & typeof Layer;
 /**