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

package/common/typedefs.d.ts

@@ -0,0 +1,212 @@
+export default dummy;
+export type FilterFunction = Function;
+export type SortFunction = Function;
+export type ViewState = {
+    /**
+     * A time in ms.
+     */
+    time: number | undefined;
+    /**
+     * A center in mercator coordinate.
+     */
+    center: number[2] | undefined;
+    /**
+     * An Extent in mercator coordinates.
+     */
+    extent: any;
+    /**
+     * A size ([width, height]).
+     */
+    size: any;
+    /**
+     * A rotation in radians.
+     */
+    rotation: number;
+    /**
+     * A resolution.
+     */
+    resolution: number;
+    /**
+     * A zoom level.
+     */
+    zoom: number;
+    /**
+     * A pixel ratio.
+     */
+    pixelRatio: number | undefined;
+};
+export type FeatureInfo = {
+    /**
+     * A layer.
+     */
+    layer: Layer;
+    /**
+     * An array of features.
+     */
+    features: Feature[];
+    /**
+     * The coordinate where to find the featue.
+     */
+    coordinate: any;
+};
+export type MaplibreLayerOptions = {
+    /**
+     * Access key for [geOps apis](https://developer.geops.io/).
+     */
+    apiKey: string;
+    /**
+     * geOps Maps api key name.
+     */
+    apiKeyName: string;
+    /**
+     * Maplibre map options.
+     */
+    mapOptions: maplibregl.MapOptions;
+    /**
+     * geOps Maps api style.
+     */
+    style: string;
+    /**
+     * geOps Maps api url.
+     */
+    url: string;
+};
+export type ControlCommonOptions = {
+    /**
+     * Whether the control is active or not.
+     */
+    active?: boolean | undefined;
+    /**
+     * The HTML element used to render the control.
+     */
+    element: HTMLElement;
+    /**
+     * The HTML element where to render the element property. Default is the map's element.
+     */
+    target: HTMLElement;
+    /**
+     * Render function called whenever the control needs to be rerendered.
+     */
+    render: Function;
+};
+export type LayerCommonOptions = {
+    /**
+     * Identifier of the layer. Must be unique.
+     */
+    key: string;
+    /**
+     * Name of the layer.
+     */
+    name: string;
+    /**
+     * Group of the layer.
+     */
+    group: string;
+    /**
+     * List of copyrights.
+     */
+    copyrights: string[];
+    /**
+     * List of children layers.
+     */
+    children: Layer[];
+    /**
+     * Define if the layer is currently display on the map.
+     */
+    visible: boolean;
+    /**
+     * Define if the layer is currently display on the map but can't be seen (extent, zoom ,data restrictions).
+     */
+    disabled: boolean;
+    /**
+     * Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features.
+     */
+    hittolerance: number;
+    /**
+     * - Custom properties.
+     */
+    properties: Object;
+    /**
+     * - The map used to display the layer.
+     */
+    map: AnyMap;
+};
+export type VehiclePosition = {
+    /**
+     * Coordinate of the vehicle position in Mercator .
+     */
+    coord: any;
+    /**
+     * An angle in radians representing the direction (from the true north) towards which the vehicle is facing.
+     */
+    rotation: number;
+};
+/**
+ * /Map~Map|maplibregl.Map} AnyMap
+ */
+type dummy = ol;
+/**
+ * @typedef {function} FilterFunction
+ * @param {Vehicle} vehicle Vehicle to filter.
+ * @returns boolean
+ */
+/**
+ * @typedef {function} SortFunction
+ * @param {any} a Object a to compare.
+ * @param {any} b Object b to compare.
+ * @returns number
+ */
+/**
+ * @typedef {Object} ViewState
+ * @property {number|undefined} time A time in ms.
+ * @property {number[2]|undefined} center A center in mercator coordinate.
+ * @property {number[4]} extent An Extent in mercator coordinates.
+ * @property {number[2]} size A size ([width, height]).
+ * @property {number} rotation A rotation in radians.
+ * @property {number} resolution A resolution.
+ * @property {number} zoom A zoom level.
+ * @property {number|undefined} pixelRatio A pixel ratio.
+ */
+/**
+ * @typedef {Object} FeatureInfo
+ * @property {Layer} layer A layer.
+ * @property {Feature[]} features  An array of features.
+ * @property {number[2]} coordinate The coordinate where to find the featue.
+ */
+/**
+ * @typedef {ol/Map~Map|maplibregl.Map} AnyMap
+ */
+/**
+ * @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 {string} style geOps Maps api style.
+ * @property {string} url geOps Maps api url.
+ */
+/**
+ * @typedef {Object} ControlCommonOptions
+ * @property {boolean} [active = true] Whether the control is active or not.
+ * @property {HTMLElement} element The HTML element used to render the control.
+ * @property {HTMLElement} target The HTML element where to render the element property. Default is the map's element.
+ * @property {function} render Render function called whenever the control needs to be rerendered.
+ */
+/**
+ * @typedef {Object} LayerCommonOptions
+ * @property {string!} key Identifier of the layer. Must be unique.
+ * @property {string!} name  Name of the layer.
+ * @property {string!} group Group of the layer.
+ * @property {string[]!} copyrights List of copyrights.
+ * @property {Layer[]!} children List of children layers.
+ * @property {boolean!} visible  Define if the layer is currently display on the map.
+ * @property {boolean!} disabled Define if the layer is currently display on the map but can't be seen (extent, zoom ,data restrictions).
+ * @property {number!} hittolerance Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features.
+ * @property {Object!} properties - Custom properties.
+ * @property {AnyMap!} map - The map used to display the layer.
+ */
+/**
+ * @typedef {Object} VehiclePosition
+ * @property {number[2]} coord Coordinate of the vehicle position in Mercator .
+ * @property {number!} rotation  An angle in radians representing the direction (from the true north) towards which the vehicle is facing.
+ */
+declare function dummy(): void;

package/common/utils/compareDepartures.d.ts

@@ -0,0 +1,10 @@
+import { RealtimeDeparture } from '../../types';
+/**
+ * Compare two given departures for sort alogithm,
+ * @param {Departure} a First departure.
+ * @param {Departure} b Second departure.
+ * @param {boolean} [sortByMinArrivalTime=false] Sort departures by arrival time.
+ * @private
+ */
+declare const compareDepartures: (a: RealtimeDeparture, b: RealtimeDeparture, sortByMinArrivalTime?: boolean) => number;
+export default compareDepartures;

package/common/utils/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const VECTOR_TILE_FEATURE_PROPERTY = "vectorTileFeature";
+declare const _default: {
+    VECTOR_TILE_FEATURE_PROPERTY: string;
+};
+export default _default;

package/common/utils/createCanvas.d.ts

@@ -0,0 +1,10 @@
+import { AnyCanvas } from '../../types';
+/**
+ * This function try to create a canvas element and return it.
+ * it uses document.createElement('canvas') if document is available
+ * or new OffscreenCanvas(width, height) if OffscreenCanvas is avalaible (for web worker)
+ * or it returns null if neither is available.
+ * @private
+ */
+declare const createCanvas: (width: number, height: number) => AnyCanvas | null;
+export default createCanvas;

package/common/utils/createDefaultCopyrightElt.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const createDefaultCopyrightElement: () => HTMLDivElement;
+export default createDefaultCopyrightElement;

package/common/utils/createDefaultStopFinderElt.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const createDefaultStopFinderElement: () => HTMLDivElement;
+export default createDefaultStopFinderElement;

package/common/utils/createRealtimeFilters.d.ts

@@ -0,0 +1,12 @@
+import { RealtimeTrajectory } from '../../types';
+/**
+ * Return a filter functions based on some parameters of a vehicle.
+ *
+ * @param {string|Array<string>} line - A list of vehicle's name to filter. Names can be separated by a comma. Ex: 'S1,S2,S3'
+ * @param {string|Array<string} route - A list of vehicle's route (contained in route_identifier property) to filter. Indentifiers can be separated by a comma. Ex: 'id1,id2,id3'
+ * @param {string|Array<string} operator  A list of vehicle's operator to filter. Operators can be separated by a comma. Ex: 'SBB,DB'
+ * @param {Regexp} regexLine - A regex aplly of vehcile's name.
+ * @private
+ */
+declare const createRealtimeFilters: (line: string | string[], route: string | string[], operator: string | string[], regexLine: string | string[]) => ((trajectory: RealtimeTrajectory) => boolean) | null;
+export default createRealtimeFilters;

package/common/utils/debounceDeparturesMessages.d.ts

@@ -0,0 +1,12 @@
+import type { RealtimeDeparture, RealtimeDepartureExtended } from '../../types';
+import type { WebSocketAPIMessageCallback } from '../../api/WebSocketAPI';
+/**
+ * This function returns a WebSocket api callback, and call the onDeparturesUpdate function with the list of current departures to display.
+ * @param {function(departures: RealtimeDeparture[])} onDeparturesUpdate callback when list of departures changes, called after 100 ms
+ * @param {boolean} [sortByMinArrivalTime = true] Sort departures by arrival time
+ * @param {number} [maxDepartureAge = 30] max departure age of departures in minutes
+ * @param {number} [timeout = 100] debounce timeout in ms
+ * @private
+ */
+declare const debounceDeparturesMessages: (onDeparturesUpdate: (departures: RealtimeDepartureExtended[]) => {}, sortByMinArrivalTime?: boolean, maxDepartureAge?: number, timeout?: number) => WebSocketAPIMessageCallback<RealtimeDeparture>;
+export default debounceDeparturesMessages;

package/common/utils/debounceWebsocketMessages.d.ts

@@ -0,0 +1,11 @@
+import type { WebSocketAPIMessageCallback } from '../../api/WebSocketAPI';
+/**
+ * This function returns a WebSocket api callback, and call the onUpdate function with the list of of subscribed objects changes.
+ *
+ * @param {function(objects: any[])} onUpdate callback when list of subscribed objects changes, called after 100 ms
+ * @param {function(object: any)} [getObjectId = true] function returning the id of an object
+ * @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>;
+export default debounceWebsocketMessages;

package/common/utils/getLayersAsFlatArray.d.ts

@@ -0,0 +1,3 @@
+/** @private */
+declare const getLayersAsFlatArray: (layersOrLayer: any | any[]) => any[];
+export default getLayersAsFlatArray;

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;