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

package/common/utils/getMapGlCopyrights.d.ts

@@ -0,0 +1,17 @@
+export interface Source {
+    attribution: string;
+    options: {
+        attribution: string;
+    };
+}
+export interface SourceCache {
+    used: boolean;
+    getSource: () => Source;
+}
+/**
+ * Return the copyright a Maplibre map.
+ * @param {maplibregl.Map} map A Maplibre map
+ * @private
+ */
+declare const getMapGlCopyrights: (map: maplibregl.Map) => any[];
+export default getMapGlCopyrights;

package/common/utils/getRealtimeModeSuffix.d.ts

@@ -0,0 +1,9 @@
+import type { RealtimeMode } from '../../types';
+import type { RealtimeModesType } from '../../api/RealtimeAPI';
+/**
+ * Get the websocket channel suffix, depending on the current mode.
+ * @param {String} mode Mode 'topographic' ou 'schematic'.
+ * @private
+ */
+declare const getModeSuffix: (mode: RealtimeMode, modes: RealtimeModesType) => string;
+export default getModeSuffix;

package/common/utils/getUrlWithParams.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Return the styleUrl with apiKey parameters set.
+ * @param {string} url a url.
+ * @param {Object<String,String>} params a list of key/value pair to add to the url.
+ * @private
+ */
+declare const getUrlWithParams: (url: string, params: Object) => URL;
+export default getUrlWithParams;

package/common/utils/getVehiclePosition.d.ts

@@ -0,0 +1,16 @@
+import { Coordinate } from 'ol/coordinate';
+export type VehiclePosition = {
+    coord: Coordinate;
+    rotation: number;
+};
+/**
+ * Interpolate or not the vehicle position from a trajectory at a specific date.
+ *
+ * @param {number} now Current date to interpolate a position with. In ms.
+ * @param {RealtimeTrajectory} trajectory The trajectory to interpolate.
+ * @param {boolean} noInterpolate If true, the vehicle position is not interpolated on each render but only once.
+ * @returns {VehiclePosition}
+ * @private
+ */
+declare const getVehiclePosition: (now: number, trajectory: GeoJSONFeature, noInterpolate: boolean) => VehiclePosition;
+export default getVehiclePosition;

package/common/utils/index.d.ts

@@ -0,0 +1,16 @@
+export { default as getUrlWithParams } from "./getUrlWithParams";
+export { default as getMapGlCopyrights } from "./getMapGlCopyrights";
+export { default as removeDuplicate } from "./removeDuplicate";
+export { default as createRealtimeFilters } from "./createRealtimeFilters";
+export { default as getLayersAsFlatArray } from "./getLayersAsFlatArray";
+export * from "./timeUtils";
+export * from "./constants";
+export { default as sortByDelay } from "./sortByDelay";
+export { default as renderTrajectories } from "./renderTrajectories";
+export { default as debounceDeparturesMessages } from "./debounceDeparturesMessages";
+export { default as debounceWebsocketMessages } from "./debounceWebsocketMessages";
+export { default as sortAndFilterDepartures } from "./sortAndFilterDepartures";
+export { default as compareDepartures } from "./compareDepartures";
+export { default as createCanvas } from "./createCanvas";
+export { default as getVehiclePosition } from "./getVehiclePosition";
+export * as realtimeConfig from "./realtimeConfig";

package/common/utils/realtimeConfig.d.ts

@@ -0,0 +1,64 @@
+import { AnyCanvasContext, RealtimeMot } from '../../types';
+/**
+ * @private
+ */
+export declare const MOTS_ONLY_RAIL: RealtimeMot[];
+/**
+ * @private
+ */
+export declare const MOTS_WITH_CABLE: RealtimeMot[];
+/**
+ * @private
+ */
+export declare const MOTS_WITHOUT_CABLE: RealtimeMot[];
+/**
+ * @private
+ */
+export declare const MOTS_ALL: RealtimeMot[];
+/**
+ * Trajserv value: 'Tram',  'Subway / Metro / S-Bahn',  'Train', 'Bus', 'Ferry', 'Cable Car', 'Gondola', 'Funicular', 'Long distance bus', 'Rail',
+ * New endpoint use Rail instead of Train.
+ * New tracker values:  null, "tram", "subway", "rail", "bus", "ferry", "cablecar", "gondola", "funicular", "coach".
+ *
+ * @private
+ */
+export declare const types: RegExp[];
+/**
+ * @private
+ */
+export declare const bgColors: string[];
+/**
+ * @private
+ */
+export declare const textColors: string[];
+/**
+ * @private
+ */
+export declare const getTypeIndex: (type: RealtimeMot) => number;
+/**
+ * @private
+ */
+export declare const getRadius: (type: RealtimeMot, zoom: number) => number;
+/**
+ * @private
+ */
+export declare const getBgColor: (type: RealtimeMot) => string;
+/**
+ * @private
+ */
+export declare const getTextColor: (type: RealtimeMot) => string;
+/**
+ * @private
+ */
+export declare const getTextSize: (ctx: AnyCanvasContext, markerSize: number, text: string, fontSize: number, getTextFont: (fontSize: number, text?: string) => string) => number;
+/**
+ * @private
+ * @param {number} delayInMs Delay in milliseconds.
+ * @param {boolean} cancelled true if the journey is cancelled.
+ * @param {boolean} isDelayText true if the color is used for delay text of the symbol.
+ */
+export declare const getDelayColor: (delayInMs: number | null, cancelled?: boolean, isDelayText?: boolean) => string;
+/**
+ * @private
+ */
+export declare const getDelayText: (delayInMs: number, cancelled: boolean) => string;

package/common/utils/removeDuplicate.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This function remove duplicates lower case string value of an array.
+ * It removes also null, undefined or non string values.
+ *
+ * @param {array} array Array of values.
+ * @private
+ */
+declare const removeDuplicate: (array: any[]) => any[];
+export default removeDuplicate;

package/common/utils/renderTrajectories.d.ts

@@ -0,0 +1,16 @@
+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 {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.
+ * @param {boolean} options.hoverVehicleId The id of the vehicle to highlight.
+ * @param {boolean} options.selectedVehicleId The id of the vehicle to select.
+ * @param {boolean} options.noInterpolate If true trajectories are not interpolated but
+ *   drawn at the last known coordinate. Use this for performance optimization
+ *   during map navigation.
+ * @private
+ */
+declare const renderTrajectories: (canvas: AnyCanvas, trajectories: RealtimeTrajectories, style: RealtimeStyleFunction, viewState: ViewState, options: RealtimeStyleOptions) => RealtimeRenderState;
+export default renderTrajectories;

package/common/utils/sortAndFilterDepartures.d.ts

@@ -0,0 +1,15 @@
+import { RealtimeAPIDeparturesById } from '../../api/RealtimeAPI';
+import type { RealtimeDepartureExtended } from '../../types';
+/**
+ * This function sort Departures by arrival time and filter out unwanted departures:
+ *  - when dparture time is in the past
+ *  - when departure are duplicated
+ *  - when departure is not in the next 30 min
+ *
+ * @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.
+ * @private
+ */
+declare const sortAndfilterDepartures: (depObject: RealtimeAPIDeparturesById, sortByMinArrivalTime?: boolean, maxDepartureAge?: number) => RealtimeDepartureExtended[];
+export default sortAndfilterDepartures;

package/common/utils/sortByDelay.d.ts

@@ -0,0 +1,3 @@
+/** @private */
+declare const sortByDelay: (traj1: GeoJSONFeature, traj2: GeoJSONFeature) => number;
+export default sortByDelay;

package/common/utils/timeUtils.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Get a Date object as UTC date string .
+ * ex: 2019 09 01
+ * @private
+ */
+export declare const getUTCDateString: (now?: Date) => string;
+/**
+ * Get the UTC time string of Date object.
+ * ex: 09:05:01.123
+ * @private
+ */
+export declare const getUTCTimeString: (date: Date) => string;
+/**
+ * Returns a string representation of a number, with a zero if the number is lower than 10.
+ * @private
+ */
+export declare const pad: (integer: number) => string;
+/**
+ * Returns a 'hh:mm' string from a time in ms.
+ * @param {Number} timeInMs Time in milliseconds.
+ * @private
+ */
+export declare const getHoursAndMinutes: (timeInMs: number) => string;

package/common/utils/toMercatorExtent.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const toMercatorExtent: (bounds: maplibregl.LngLatBounds) => import("ol/extent").Extent;
+export default toMercatorExtent;

package/iife.d.ts

@@ -0,0 +1,2 @@
+export default mbt;
+import mbt from './index';

package/index.d.ts

@@ -0,0 +1,9 @@
+export * as ol from "./ol";
+export * as maplibre from "./maplibre";
+declare namespace _default {
+    export { ol };
+    export { maplibre };
+}
+export default _default;
+import * as ol from './ol';
+import * as maplibre from './maplibre';

package/maplibre/controls/CopyrightControl.d.ts

@@ -0,0 +1,35 @@
+import { ControlPosition, IControl } from 'maplibre-gl';
+/**
+ * Display layer's copyrights.
+ *
+ * @example
+ * import { Map } from 'Maplibre-gl';
+ * import { CopyrightControl } from 'mobility-toolbox-js/Maplibre';
+ *
+ * const map = new Map({
+ *   container: 'map',
+ *   style: `https://maps.geops.io/styles/travic_v2/style.json?key=${window.apiKey}`,
+ * });
+ *
+ * const control = new CopyrightControl();
+ * map.addControl(control);
+ *
+ *
+ * @see <a href="/example/mb-copyright">Maplibre copyright example</a>
+ *
+ */
+declare class CopyrightControl implements IControl {
+    map?: maplibregl.Map;
+    container?: HTMLElement;
+    content?: string;
+    options?: {
+        customAttribution?: string | string[];
+        separator?: string;
+    };
+    constructor(options?: {});
+    onAdd(map: maplibregl.Map): HTMLElement;
+    onRemove(): HTMLElement | undefined;
+    getDefaultPosition(): ControlPosition;
+    render(): void;
+}
+export default CopyrightControl;

package/maplibre/controls/index.d.ts

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

package/maplibre/index.d.ts

@@ -0,0 +1,5 @@
+export * from "../api";
+export * from "../common";
+export * from "./controls";
+export * from "./layers";
+export * from "./utils";

package/maplibre/layers/Layer.d.ts

@@ -0,0 +1,28 @@
+import { CustomLayerInterface, Evented } from 'maplibre-gl';
+import type { AnyMapGlMap } from '../../types';
+export type LayerOptions = {
+    id?: string;
+};
+/**
+ * A class representing a layer to display on an Maplibre map.
+ *
+ * @example
+ * import { Layer } from 'mobility-toolbox-js/Maplibre';
+ *
+ * const layer = new Layer({ id:'MyLayer' });
+ *
+ * @implements {maplibregl.CustomLayer}
+ * @extends {maplibregl.Evented}
+ * @private
+ */
+declare class Layer extends Evented implements CustomLayerInterface {
+    id: string;
+    map: AnyMapGlMap | undefined;
+    options: LayerOptions;
+    type: 'custom';
+    constructor(options?: LayerOptions);
+    onAdd(map: AnyMapGlMap, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
+    onRemove(map: AnyMapGlMap, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
+    render(gl: WebGLRenderingContext | WebGL2RenderingContext): void;
+}
+export default Layer;

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/RealtimeLayer.js

@@ -8,7 +8,7 @@ import Layer from './Layer';
 import { getSourceCoordinates } from '../utils';
 import toMercatorExtent from '../../common/utils/toMercatorExtent';
 /**
- * Responsible for loading and display data from a geOps Realtime API.
+ * Responsible for loading and display data from a geOps realtime API.
  *
  * @example
  * import { RealtimeLayer } from 'mobility-toolbox-js/Maplibre';
@@ -31,7 +31,7 @@ class RealtimeLayer extends RealtimeLayerMixin(Layer) {
      *
      * @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 {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps realtime API url.
      *
      */
     constructor(options = {}) {

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";