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

package/types/routing.d.ts

@@ -9,6 +9,58 @@ export interface Paths {
     get: {
       parameters: {
         query: {
+          /**
+           * Whether to use beelines (line strings with 2 points) between
+           * mutually unreachable hops as a fallback for "Route not found"
+           * errors. "true", "on", "yes", "y", "1" will enable the
+           * fallback. Default: enabled
+           */
+          'beeline-fallback'?: string;
+          /**
+           * Distance punishment factor for edge snapping of coordinates (see
+           * "Note on coordinates" at the top). Large: prefer close edge. Small:
+           * prefer short total route. Negative value: like worst edge
+           * category. Default: -1.0
+           */
+          'coord-punish'?: number;
+          /**
+           * Search radius for candidate edges during snapping of coordinates
+           * (see "Note on coordinates" at the top) Default: -1.0
+           */
+          'coord-radius'?: number;
+          /** Only for mot=rail. Default is a detailed network based on OpenStreetMap. gen1 to gen4 provide rail networks with increasing levels of generalization */
+          graph?: 'gen1' | 'gen2' | 'gen3' | 'gen4';
+          /**
+           * Whether to include intermediate hops (stations/stops) found on the
+           * route to the response. "true", "on", "yes", "y", "1" will enable
+           * intermediate hops. Default: disabled
+           */
+          hops?: string;
+          /** A line name that should be preferred */
+          line?: string;
+          /** Name of origin of the preferred line */
+          'line-from'?: string;
+          /** Name of destination of the preferred line */
+          'line-to'?: string;
+          /**
+           * Maximum allowed ratio of hops to skip if not found. Only non-start
+           * and non-end hops are counted in ratio numerator and denominator.
+           */
+          'max-skip-hop-ratio'?: number;
+          /** Mode of transport */
+          mot:
+            | 'bus'
+            | 'car'
+            | 'coach'
+            | 'ferry'
+            | 'foot'
+            | 'funicular'
+            | 'gondola'
+            | 'rail'
+            | 'subway'
+            | 'tram';
+          /** Douglas-Peucker distance parameter for simplification. Default 0.5 in Mercator units */
+          simplify?: number;
           /**
            * A pipe separated list of hops. A hop describes a station with either
            *  - a name or abbreviation
@@ -52,58 +104,6 @@ export interface Paths {
            *  - `freiburg|basel%20sbb|bern` - from Freiburg (Breisgau) Hbf via Basel SBB to Bern
            */
           via: string;
-          /** Mode of transport */
-          mot:
-            | 'rail'
-            | 'bus'
-            | 'coach'
-            | 'foot'
-            | 'tram'
-            | 'subway'
-            | 'gondola'
-            | 'funicular'
-            | 'ferry'
-            | 'car';
-          /** Only for mot=rail. Default is a detailed network based on OpenStreetMap. gen1 to gen4 provide rail networks with increasing levels of generalization */
-          graph?: 'gen1' | 'gen2' | 'gen3' | 'gen4';
-          /** A line name that should be preferred */
-          line?: string;
-          /** Name of origin of the preferred line */
-          'line-from'?: string;
-          /** Name of destination of the preferred line */
-          'line-to'?: string;
-          /** Douglas-Peucker distance parameter for simplification. Default 0.5 in Mercator units */
-          simplify?: number;
-          /**
-           * Maximum allowed ratio of hops to skip if not found. Only non-start
-           * and non-end hops are counted in ratio numerator and denominator.
-           */
-          'max-skip-hop-ratio'?: number;
-          /**
-           * Whether to include intermediate hops (stations/stops) found on the
-           * route to the response. "true", "on", "yes", "y", "1" will enable
-           * intermediate hops. Default: disabled
-           */
-          hops?: string;
-          /**
-           * Whether to use beelines (line strings with 2 points) between
-           * mutually unreachable hops as a fallback for "Route not found"
-           * errors. "true", "on", "yes", "y", "1" will enable the
-           * fallback. Default: enabled
-           */
-          'beeline-fallback'?: string;
-          /**
-           * Search radius for candidate edges during snapping of coordinates
-           * (see "Note on coordinates" at the top) Default: -1.0
-           */
-          'coord-radius'?: number;
-          /**
-           * Distance punishment factor for edge snapping of coordinates (see
-           * "Note on coordinates" at the top). Large: prefer close edge. Small:
-           * prefer short total route. Negative value: like worst edge
-           * category. Default: -1.0
-           */
-          'coord-punish'?: number;
           /**
            * Whether to output OSM way ids in Feature properties.
            * "true", "on", "yes", "y", "1" will enable output. Default: disabled
@@ -147,14 +147,14 @@ export interface Paths {
                  * @example
                  */
                 id?: string;
-                /** @example Freiburg Littenweiler */
-                name?: string;
-                /** @example 1 */
-                platform?: string;
                 /** @description Latitude of the stop, in WGS84 */
                 latitude?: number;
                 /** @description Latitude of the stop, in WGS84 */
                 longitude?: number;
+                /** @example Freiburg Littenweiler */
+                name?: string;
+                /** @example 1 */
+                platform?: string;
               };
               station_to?: {
                 /**
@@ -162,14 +162,14 @@ export interface Paths {
                  * @example 8004158
                  */
                 id?: string;
-                /** @example Muenchen Pasing */
-                name?: string;
-                /** @example 4 */
-                platform?: string;
                 /** @description Latitude of the stop, in WGS84 */
                 latitude?: number;
                 /** @description Latitude of the stop, in WGS84 */
                 longitude?: number;
+                /** @example Muenchen Pasing */
+                name?: string;
+                /** @example 4 */
+                platform?: string;
               };
               /** @enum {string} */
               type?: 'Feature';

package/types/stops.d.ts

@@ -9,35 +9,35 @@ export interface Paths {
     get: {
       parameters: {
         query: {
-          /** Control how many matches will be returned */
-          limit?: number;
-          /** Anything you'd like to search for */
-          q: string;
           /**
-           * comma seperated list, order chooses which agency will be preferred
-           * as ident_source (for id and code fields)
+           * left,bottom,right,up coordinates in WGS84 wherein the
+           * station should lie
            */
-          prefagencies?: 'sbb' | 'db';
+          bbox?: string;
+          /** which field to look up, default: all of them */
+          field?: 'coords' | 'id' | 'name';
+          /** Control how many matches will be returned */
+          limit?: number;
           /**
            * comma seperated list of mot's which should be available
            * at the stop
            */
           mots?:
             | 'bus'
+            | 'cable_car'
             | 'ferry'
+            | 'funicular'
             | 'gondola'
-            | 'tram'
             | 'rail'
-            | 'funicular'
-            | 'cable_car'
-            | 'subway';
+            | 'subway'
+            | 'tram';
           /**
-           * left,bottom,right,up coordinates in WGS84 wherein the
-           * station should lie
+           * comma seperated list, order chooses which agency will be preferred
+           * as ident_source (for id and code fields)
            */
-          bbox?: string;
-          /** which field to look up, default: all of them */
-          field?: 'id' | 'name' | 'coords';
+          prefagencies?: 'db' | 'sbb';
+          /** Anything you'd like to search for */
+          q: string;
           /**
            * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
            * this position higher
@@ -49,81 +49,81 @@ export interface Paths {
         /** stop(s) */
         200: {
           schema: {
-            /** @enum {string} */
-            type?: 'FeatureCollection';
             features?: {
-              /** @enum {string} */
-              type?: 'Feature';
+              /** @description the coordinates of the stop */
+              geometry?: {
+                /**
+                 * @example [
+                 *   7.439119,
+                 *   46.94882
+                 * ]
+                 */
+                coordinates?: number[];
+                /** @enum {string} */
+                type?: 'Point';
+              };
               properties?: {
-                /** @description internal ID */
-                uid?: string;
                 /**
-                 * @description name of the stop
-                 * @example Bern
+                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
+                 *
+                 * @example BN
                  */
-                name?: string;
+                code?: string;
                 /**
                  * @description 2 letter country code where the station is located
                  * @example CH
                  */
                 country_code?: string;
                 /**
-                 * @description how well the result matches your query, 0
-                 * means best
+                 * @description uic number
+                 * @example 8507000
                  */
-                rank?: number;
+                id?: string;
                 /**
-                 * @description array of translations of the stopname
-                 * @default []
+                 * @description source agency for id and code (see below)
+                 * @example sbb
                  */
-                translated_names?: {
-                  value?: string;
-                  /** @enum {string} */
-                  language?: 'de' | 'en' | 'fr' | 'it';
-                }[];
+                ident_source?: string;
+                /** @description ifopt identifier, if available */
+                ifopt?: string;
                 /** @description Means of transport that are available at this station */
                 mot?: {
                   bus?: boolean;
+                  cable_car?: boolean;
                   ferry?: boolean;
+                  funicular?: boolean;
                   gondola?: boolean;
-                  tram?: boolean;
                   rail?: boolean;
-                  funicular?: boolean;
-                  cable_car?: boolean;
                   subway?: boolean;
+                  tram?: boolean;
                 };
                 /**
-                 * @description source agency for id and code (see below)
-                 * @example sbb
-                 */
-                ident_source?: string;
-                /**
-                 * @description uic number
-                 * @example 8507000
+                 * @description name of the stop
+                 * @example Bern
                  */
-                id?: string;
+                name?: string;
                 /**
-                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
-                 *
-                 * @example BN
+                 * @description how well the result matches your query, 0
+                 * means best
                  */
-                code?: string;
-                /** @description ifopt identifier, if available */
-                ifopt?: string;
-              };
-              /** @description the coordinates of the stop */
-              geometry?: {
-                /** @enum {string} */
-                type?: 'Point';
+                rank?: number;
                 /**
-                 * @example [
-                 *   7.439119,
-                 *   46.94882
-                 * ]
+                 * @description array of translations of the stopname
+                 * @default []
                  */
-                coordinates?: number[];
+                translated_names?: {
+                  /** @enum {string} */
+                  language?: 'de' | 'en' | 'fr' | 'it';
+                  value?: string;
+                }[];
+                /** @description internal ID */
+                uid?: string;
               };
+              /** @enum {string} */
+              type?: 'Feature';
             }[];
+            /** @enum {string} */
+            type?: 'FeatureCollection';
           };
         };
         /** limit parameter too high */

package/common/mixins/RealtimeLayerMixin.d.ts

@@ -1,273 +0,0 @@
-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;