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

package/api/typedefs.d.ts

@@ -0,0 +1,178 @@
+export default dummy;
+export type Departure = {
+    /**
+     * Timestamp in ms.
+     */
+    time: number;
+    no_stop_between: boolean;
+    train_number: number;
+    to: string[];
+    /**
+     * Timestamp in ms.
+     */
+    ris_aimed_time: number;
+    /**
+     * Timestamp in ms.
+     */
+    updated_at: number;
+    new_to: boolean;
+    /**
+     * Timestamp in ms.
+     */
+    min_arrival_time: number;
+    /**
+     * List of next stops. Like value in at_station_ds100.
+     */
+    next_stoppoints: string[];
+    /**
+     * Timestamp in ms.
+     */
+    ris_estimated_time: number;
+    line: NetworkLine;
+    /**
+     * if true this departure has realtime data.
+     */
+    has_fzo: boolean;
+    train_id: number;
+    platform: string;
+    state: any | null;
+    /**
+     * Timestamp in ms.
+     */
+    fzo_estimated_time: number;
+    formation: any | null;
+    no_stop_till: any | null;
+    train_type: number;
+    call_id: number;
+    /**
+     * Timestamp in ms.
+     */
+    created_at: string;
+    at_station_ds100: string;
+    /**
+     * Timestamp in ms.
+     */
+    timediff: number;
+};
+export type Station = GeoJSONFeature;
+export type StationProperties = {
+    transfers: Transfer[];
+    elevatorOutOfOrder: boolean;
+    uic: number;
+    name: string;
+    networkLines: NetworkLine[];
+    hasElevator: boolean;
+    hasZOB: boolean;
+    hasAccessibility: boolean;
+    type: string;
+};
+export type NetworkLine = {
+    /**
+     * Identifier of the line.
+     */
+    id: number;
+    /**
+     * Color of the line (CSS color string).
+     */
+    color: string;
+    /**
+     * Stroke color of the line (CSS color string).
+     */
+    stroke: string;
+    /**
+     * Name of the line.
+     */
+    name: string;
+    /**
+     * Text color of the line  (CSS color string).
+     */
+    text_color: string;
+};
+export type Transfer = {
+    /**
+     * Mode of transportation (ex: U-Bahn).
+     */
+    mot: string;
+    /**
+     * Array of lines name (ex: ["U4", "U5"]).
+     */
+    lines: string[];
+};
+export type StopSequence = GeoJSONFeature;
+export type RealtimeTrajectory = GeoJSONFeature;
+export type FullTrajectory = GeoJSONFeature;
+export type Vehicle = GeoJSONFeature;
+export type ExtraGeom = GeoJSONFeature;
+/**
+ * @typedef {Object} Departure
+ * @property {number} time Timestamp in ms.
+ * @property {boolean} no_stop_between
+ * @property {number} train_number
+ * @property {string[]} to
+ * @property {number} ris_aimed_time Timestamp in ms.
+ * @property {number} updated_at Timestamp in ms.
+ * @property {boolean} new_to
+ * @property {number} min_arrival_time Timestamp in ms.
+ * @property {string[]} next_stoppoints List of next stops. Like value in at_station_ds100.
+ * @property {number} ris_estimated_time Timestamp in ms.
+ * @property {NetworkLine} line
+ * @property {boolean} has_fzo if true this departure has realtime data.
+ * @property {number} train_id
+ * @property {string} platform
+ * @property {?*} state
+ * @property {number} fzo_estimated_time Timestamp in ms.
+ * @property {?*} formation
+ * @property {?*} no_stop_till
+ * @property {number} train_type
+ * @property {number} call_id
+ * @property {string} created_at Timestamp in ms.
+ * @property {string} at_station_ds100
+ * @property {number} timediff Timestamp in ms.
+ *
+ */
+/**
+ * @typedef {GeoJSONFeature} Station
+ * @property {StationProperties} properties Returns the station's properties.
+ * @property {GeoJSONPoint} geometry Returns a point.
+ */
+/**
+ * @typedef {Object} StationProperties
+ * @property {Transfer[]} transfers
+ * @property {boolean} elevatorOutOfOrder
+ * @property {number} uic
+ * @property {string} name
+ * @property {NetworkLine[]} networkLines
+ * @property {boolean} hasElevator
+ * @property {boolean} hasZOB
+ * @property {boolean} hasAccessibility
+ * @property {string} type
+ */
+/**
+ * @typedef {Object} NetworkLine
+ * @property {number} id Identifier of the line.
+ * @property {string} color Color of the line (CSS color string).
+ * @property {string} stroke Stroke color of the line (CSS color string).
+ * @property {string} name Name of the line.
+ * @property {string} text_color  Text color of the line  (CSS color string).
+ */
+/**
+ * @typedef {Object} Transfer
+ * @property {string} mot Mode of transportation (ex: U-Bahn).
+ * @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
+ */
+/**
+ * @typedef {GeoJSONFeature} StopSequence
+ */
+/**
+ * @typedef {GeoJSONFeature} RealtimeTrajectory
+ */
+/**
+ * @typedef {GeoJSONFeature} FullTrajectory
+ */
+/**
+ * @typedef {GeoJSONFeature} Vehicle
+ */
+/**
+ * @typedef {GeoJSONFeature} ExtraGeom
+ */
+declare function dummy(): void;

package/common/controls/StopFinderControlCommon.d.ts

@@ -0,0 +1,53 @@
+import { Feature, FeatureCollection } from 'geojson';
+import { StopsAPI } from '../../api';
+import { StopsAPIOptions } from '../../api/StopsAPI';
+import { StopsParameters } from '../../types';
+export type StopFinderControlCommonOptions = StopsAPIOptions & {
+    element: HTMLElement;
+    placeholder?: string;
+    apiParams: StopsParameters;
+    onSuggestionClick?: (suggestion: Feature, evt: MouseEvent) => void;
+};
+/**
+ * A class representing a stop finder control to display on map.
+ * This class only draw the html elements.
+ * The geographic logic must be implemented by subclasses.
+ *
+ * @private
+ */
+declare class StopFinderControlCommon {
+    apiParams: StopsParameters;
+    placeholder: string;
+    api: StopsAPI;
+    abortController?: AbortController;
+    suggestionsElt?: HTMLElement;
+    inputElt?: HTMLInputElement;
+    clearElt?: HTMLDivElement;
+    options?: StopFinderControlCommonOptions;
+    /**
+     * Constructor.
+     *
+     * @param {Object} options Options
+     * @param {HTMLElement} options.element HTML element where to attach input and suggestions.
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/). See StopsAPI.
+     * @param {string} [options.url='https://api.geops.io/tracker/v1'] Stops service url. See StopsAPI.
+     * @param {string} [options.placeholder='Search for a stop...'] Input field placeholder.
+     * @param {StopsSearchParams} [options.apiParams={ limit: 20 }] Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+     */
+    constructor(options: StopFinderControlCommonOptions);
+    render(featureCollection?: FeatureCollection): void;
+    createElement({ element }: StopFinderControlCommonOptions): void;
+    /**
+     * Clear the search field and close the control.
+     */
+    clear(): void;
+    /**
+     * Launch a search.
+     *
+     * @param {String} query The query to search for.
+     * @param {AbortController} abortController Abort controller used to cancel the request.
+     * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    search(q: string, abortController: AbortController): Promise<void>;
+}
+export default StopFinderControlCommon;

package/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./utils";
+export * from "./styles";

package/common/mixins/RealtimeLayerMixin.d.ts

@@ -0,0 +1,273 @@
+import GeoJSON from 'ol/format/GeoJSON';
+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 } from '../../types';
+import { RealtimeTrajectory } from '../../api/typedefs';
+import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
+import { FilterFunction, SortFunction } from '../typedefs';
+export type RealtimeLayerMixinOptions = Options & {
+    debug?: boolean;
+    mode?: RealtimeMode;
+    api?: RealtimeAPI;
+    tenant?: RealtimeTenant;
+    minZoomInterpolation?: number;
+    isUpdateBboxOnMoveEnd?: boolean;
+    motsByZoom?: RealtimeMot[][];
+    generalizationLevelByZoom?: RealtimeGeneralizationLevel[];
+    renderTimeIntervalByZoom?: number[];
+    style?: RealtimeStyleFunction;
+    speed?: number;
+    pixelRatio?: number;
+    hoverVehicleId?: RealtimeTrainId;
+    selectedVehicleId?: RealtimeTrainId;
+    filter?: FilterFunction;
+    sort?: SortFunction;
+    time?: number;
+    live?: boolean;
+    canvas?: HTMLCanvasElement;
+    styleOptions?: RealtimeStyleOptions;
+    useRequestAnimationFrame?: boolean;
+    useDebounce?: boolean;
+    useThrottle?: boolean;
+    getMotsByZoom?: (zoom: number, motsByZoom: RealtimeMot[][]) => RealtimeMot[];
+    getGeneralizationLevelByZoom?: (zoom: number, generalizationLevelByZoom: RealtimeGeneralizationLevel[]) => RealtimeGeneralizationLevel;
+    getRenderTimeIntervalByZoom?: (zoom: number, renderTimeIntervalByZoom: number[]) => number;
+    onStart?: (realtimeLayer: AnyRealtimeLayer) => void;
+    onStop?: (realtimeLayer: AnyRealtimeLayer) => void;
+    url?: string;
+    apiKey?: string;
+    prefix?: string;
+    bbox?: (number | string)[];
+    buffer?: number[];
+    pingIntervalMs?: number;
+    bboxParameters?: {
+        [index: string]: string | number | boolean | string[] | boolean[] | number[];
+    };
+};
+/**
+ * RealtimeLayerInterface.
+ * @private
+ */
+export declare class RealtimeLayerInterface {
+    /**
+     * Start the clock.
+     */
+    start(): void;
+    /**
+     * Stop the clock.
+     */
+    stop(): void;
+    /**
+     * Set the Realtime api's bbox.
+     *
+     * @param {Array<number>} extent  Extent to request, [minX, minY, maxX, maxY].
+     * @param {number} zoom  Zoom level to request. Must be an integer.
+     */
+    setBbox(extent: [number, number, number, number], zoom: number): void;
+    /**
+     * Render the trajectories
+     */
+    renderTrajectories(): void;
+    /**
+     * Request the stopSequence and the fullTrajectory informations for a vehicle.
+     *
+     * @param {string} id The vehicle identifier (the  train_id property).
+     * @param {RealtimeMode} mode The mode to request. If not defined, the layer´s mode propetrty will be used.
+     * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
+     */
+    getTrajectoryInfos(id: string, mode: RealtimeMode): void;
+}
+/**
+ * Mixin for RealtimeLayerInterface.
+ *
+ * @param {Class} Base A class to extend with {RealtimeLayerInterface} functionnalities.
+ * @return {Class}  A class that implements {RealtimeLayerInterface} class and extends Base;
+ * @private
+ */
+declare function RealtimeLayerMixin<T extends AnyLayerClass>(Base: T): {
+    new (options: RealtimeLayerMixinOptions): {
+        [x: string]: any;
+        debug: boolean;
+        trajectories?: {
+            [key: string]: GeoJSONFeature;
+        } | undefined;
+        canvas?: AnyCanvas | undefined;
+        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;
+        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;
+        motsByZoom: RealtimeMot[][];
+        generalizationLevel?: RealtimeGeneralizationLevel | undefined;
+        generalizationLevelByZoom: RealtimeGeneralizationLevel[];
+        renderTimeIntervalByZoom: number[];
+        format: GeoJSON;
+        requestId?: number | undefined;
+        updateTimeInterval?: number | undefined;
+        updateTimeDelay?: number | undefined;
+        visibilityRef: EventsKey;
+        selectedVehicle: GeoJSONFeature;
+        getMotsByZoom: (zoom: number) => RealtimeMot[];
+        getGeneralizationLevelByZoom: (zoom: number) => RealtimeGeneralizationLevel;
+        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;
+        /**
+         * Define layer's properties.
+         *
+         * @private
+         */
+        defineProperties(options: RealtimeLayerMixinOptions): void;
+        attachToMap(map: AnyMap): void;
+        detachFromMap(): void;
+        start(): void;
+        /**
+         * Start the clock.
+         * @private
+         */
+        startUpdateTime(): void;
+        stop(): void;
+        /**
+         * Stop the clock.
+         * @private
+         */
+        stopUpdateTime(): void;
+        /**
+         * Launch renderTrajectories. it avoids duplicating code in renderTrajectories method.
+         *
+         * @param {object} viewState The view state of the map.
+         * @param {number[2]} viewState.center Center coordinate of the map in mercator coordinate.
+         * @param {number[4]} viewState.extent Extent of the map in mercator coordinates.
+         * @param {number[2]} viewState.size Size ([width, height]) of the canvas to render.
+         * @param {number} [viewState.rotation = 0] Rotation of the map to render.
+         * @param {number} viewState.resolution Resolution of the map to render.
+         * @param {boolean} noInterpolate If true trajectories are not interpolated but
+         *   drawn at the last known coordinate. Use this for performance optimization
+         *   during map navigation.
+         * @private
+         */
+        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
+        /**
+         * Render the trajectories requesting an animation frame and cancelling the previous one.
+         * This function must be overrided by children to provide the correct parameters.
+         *
+         * @param {object} viewState The view state of the map.
+         * @param {number[2]} viewState.center Center coordinate of the map in mercator coordinate.
+         * @param {number[4]} viewState.extent Extent of the map in mercator coordinates.
+         * @param {number[2]} viewState.size Size ([width, height]) of the canvas to render.
+         * @param {number} [viewState.rotation = 0] Rotation of the map to render.
+         * @param {number} viewState.resolution Resolution of the map to render.
+         * @param {boolean} noInterpolate If true trajectories are not interpolated but
+         *   drawn at the last known coordinate. Use this for performance optimization
+         *   during map navigation.
+         * @private
+         */
+        renderTrajectories(viewState: ViewState | undefined, noInterpolate: boolean | undefined): void;
+        setBbox(extent: [number, number, number, number], zoom: number): void;
+        /**
+         * Get the duration before the next update depending on zoom level.
+         *
+         * @private
+         * @param {number} zoom
+         */
+        getRefreshTimeInMs(zoom?: number | undefined): number;
+        /**
+         * Get vehicle.
+         * @param {function} filterFc A function use to filter results.
+         * @return {Array<Object>} Array of vehicle.
+         */
+        getVehicle(filterFc: FilterFunction): GeoJSONFeature[];
+        /**
+         * Request feature information for a given coordinate.
+         *
+         * @param {ol/coordinate~Coordinate} coordinate Coordinate.
+         * @param {Object} options Options See child classes to see which options are supported.
+         * @param {number} [options.resolution=1] The resolution of the map.
+         * @param {number} [options.nb=Infinity] The max number of vehicles to return.
+         * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
+         */
+        getFeatureInfoAtCoordinate(coordinate: Coordinate, options: LayerGetFeatureInfoOptions): Promise<LayerGetFeatureInfoResponse>;
+        /**
+         * Request the stopSequence and the fullTrajectory informations for a vehicle.
+         *
+         * @param {string} id The vehicle identifier (the  train_id property).
+         * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
+         */
+        getTrajectoryInfos(id: RealtimeTrainId): Promise<{
+            stopSequence: WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
+            fullTrajectory: WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
+        }>;
+        /**
+         * Remove all trajectories that are in the past.
+         */
+        purgeOutOfDateTrajectories(): void;
+        /**
+         * Determine if the trajectory is useless and should be removed from the list or not.
+         * By default, this function exclude vehicles:
+         *  - that have their trajectory outside the current extent and
+         *  - that aren't in the MOT list.
+         *
+         * @param {RealtimeTrajectory} trajectory
+         * @param {Array<number>} extent
+         * @param {number} zoom
+         * @return {boolean} if the trajectory must be displayed or not.
+         * @private
+         */
+        purgeTrajectory(trajectory: GeoJSONFeature, extent: [number, number, number, number], zoom: number): boolean;
+        /**
+         * Add a trajectory.
+         * @param {RealtimeTrajectory} trajectory The trajectory to add.
+         * @private
+         */
+        addTrajectory(trajectory: GeoJSONFeature): void;
+        removeTrajectory(trajectoryOrId: RealtimeTrajectory | RealtimeTrainId): void;
+        /**
+         * On zoomend we adjust the time interval of the update of vehicles positions.
+         *
+         * @param evt Event that triggered the function.
+         * @private
+         */
+        onZoomEnd(): void;
+        onDocumentVisibilityChange(): void;
+        /**
+         * Callback on websocket's trajectory channel events.
+         * It adds a trajectory to the list.
+         *
+         * @private
+         */
+        onTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrajectory>): void;
+        /**
+         * Callback on websocket's deleted_vehicles channel events.
+         * It removes the trajectory from the list.
+         *
+         * @private
+         * @override
+         */
+        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrainId>): void;
+        highlightVehicle(id: RealtimeTrainId): void;
+        selectVehicle(id: RealtimeTrainId): void;
+    };
+} & T;
+export default RealtimeLayerMixin;

package/common/styles/index.d.ts

@@ -0,0 +1,4 @@
+export { default as realtimeDefaultStyle } from "./realtimeDefaultStyle";
+export { default as realtimeDelayStyle } from "./realtimeDelayStyle";
+export { default as realtimeSimpleStyle } from "./realtimeSimpleStyle";
+export * from "./realtimeDefaultStyle";

package/common/styles/realtimeDefaultStyle.d.ts

@@ -0,0 +1,36 @@
+import type { RealtimeStyleFunction } from '../../types';
+/**
+ * Draw circle delay background
+ *
+ * @private
+ */
+export declare const getDelayBgCanvas: (origin: number, radius: number, color: string) => import("../../types").AnyCanvas | null;
+/**
+ * Draw delay text
+ *
+ * @private
+ */
+export declare const getDelayTextCanvas: (text: string, fontSize: number, font: string, delayColor: string, delayOutlineColor?: string, pixelRatio?: number) => import("../../types").AnyCanvas | null;
+/**
+ * Draw colored circle with black border
+ *
+ * @private
+ */
+export declare const getCircleCanvas: (origin: number, radius: number, color: string, hasStroke: boolean, hasDash: boolean, pixelRatio: number) => import("../../types").AnyCanvas | null;
+/**
+ * Draw text in the circle
+ *
+ * @private
+ */
+export declare const getTextCanvas: (text: string, origin: number, textSize: number, fillColor: string, strokeColor: string, hasStroke: boolean, pixelRatio: number, getTextFont: (fontSize: number, text?: string) => string) => import("../../types").AnyCanvas | null;
+/**
+ * A tracker style that take in account the delay.
+ *
+ * @param {RealtimeTrajectory} trajectory The trajectory to render.
+ * @param {ViewState} viewState The view state of the map.
+ * @param {RealtimeStyleOptions} options Some options to change the rendering
+ * @return a canvas
+ * @private
+ */
+declare const realtimeDefaultStyle: RealtimeStyleFunction;
+export default realtimeDefaultStyle;

package/common/styles/realtimeDelayStyle.d.ts

@@ -0,0 +1,12 @@
+import type { RealtimeStyleFunction } from '../../types';
+/**
+ * A tracker style that display the delay as backgroundColor.
+ *
+ * @param {*} trajectory The trajectory to render.
+ * @param {*} viewState The view state of the map.
+ * @param {*} options Some options to change the rendering
+ * @return a canvas
+ * @private
+ */
+declare const realtimeDelayStyle: RealtimeStyleFunction;
+export default realtimeDelayStyle;

package/common/styles/realtimeHeadingStyle.d.ts

@@ -0,0 +1,12 @@
+import type { RealtimeStyleFunction } from '../../types';
+/**
+ * A tracker style that take in account the delay.
+ *
+ * @param {RealtimeTrajectory} trajectory The trajectory to render.
+ * @param {ViewState} viewState The view state of the map.
+ * @param {RealtimeStyleOptions} options Some options to change the rendering
+ * @return a canvas
+ * @private
+ */
+declare const realtimeHeadingStyle: RealtimeStyleFunction;
+export default realtimeHeadingStyle;

package/common/styles/realtimeSimpleStyle.d.ts

@@ -0,0 +1,4 @@
+import type { RealtimeStyleFunction } from '../../types';
+/** @private */
+declare const realtimeSimpleStyle: RealtimeStyleFunction;
+export default realtimeSimpleStyle;