mobility-toolbox-js 3.0.0-beta.31 → 3.0.0-beta.33

package/ol/styles/routingStyle.js

@@ -1,24 +1,21 @@
 import { Circle, Fill, Stroke } from 'ol/style';
 import Style from 'ol/style/Style';
-/** @private */
 const circleStyle = new Circle({
-    radius: 6,
     fill: new Fill({
         color: [255, 0, 0, 1],
     }),
+    radius: 6,
     stroke: new Stroke({
         color: [0, 0, 0, 1],
         width: 1,
     }),
 });
-/** @private */
 const blackBorder = new Style({
     stroke: new Stroke({
         color: [0, 0, 0, 1],
         width: 5,
     }),
 });
-/** @private */
 const redLine = new Style({
     image: circleStyle,
     stroke: new Stroke({
@@ -26,16 +23,14 @@ const redLine = new Style({
         width: 3,
     }),
 });
-/** @private */
 const dashedRedLine = new Style({
     image: circleStyle,
     stroke: new Stroke({
         color: [255, 0, 0, 1],
-        width: 3,
         lineDash: [1, 10],
+        width: 3,
     }),
 });
-/** @private */
 const routingStyle = (feature, resolution) => {
     const minResolution = feature.get('minResolution');
     const maxResolution = feature.get('maxResolution');

package/package.json

@@ -2,7 +2,7 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "3.0.0-beta.31",
+  "version": "3.0.0-beta.33",
   "homepage": "https://mobility-toolbox-js.geops.io/",
   "exports": {
     ".": "./index.js",
@@ -12,9 +12,9 @@
     "./types": "./types/index.d.ts"
   },
   "dependencies": {
-    "@geoblocks/ol-maplibre-layer": "^1.0.0",
-    "@turf/helpers": "7.0.0",
-    "@turf/transform-rotate": "7.0.0",
+    "@geoblocks/ol-maplibre-layer": "^1.0.1",
+    "@turf/helpers": "7.1.0",
+    "@turf/transform-rotate": "7.1.0",
     "lodash.debounce": "4.0.8",
     "lodash.throttle": "4.1.1",
     "uuid": "10.0.0"
@@ -24,22 +24,23 @@
     "ol": ">=7"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
-    "@commitlint/cli": "19.3.0",
-    "@commitlint/config-conventional": "19.2.2",
-    "@geops/eslint-config-react": "^1.0.2",
+    "@commitlint/cli": "19.5.0",
+    "@commitlint/config-conventional": "19.5.0",
+    "@geops/eslint-config-react": "^1.1.1",
     "@types/geojson": "7946.0.14",
+    "@types/lodash": "^4.17.7",
     "@types/lodash.debounce": "4.0.9",
     "@types/lodash.throttle": "4.1.9",
-    "@types/mapbox-gl": "3.1.0",
+    "@types/mapbox-gl": "3.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "@types/topojson": "3.2.6",
     "@types/uuid": "10.0.0",
-    "@typescript-eslint/eslint-plugin": "7.14.1",
-    "@typescript-eslint/parser": "7.14.1",
-    "cypress": "13.12.0",
-    "esbuild": "0.21.5",
+    "@typescript-eslint/eslint-plugin": "8.5.0",
+    "@typescript-eslint/parser": "8.5.0",
+    "cypress": "13.14.2",
+    "esbuild": "0.23.1",
     "esdoc": "1.1.0",
     "esdoc-ecmascript-proposal-plugin": "1.0.0",
     "esdoc-publish-html-plugin": "1.1.2",
@@ -49,13 +50,13 @@
     "eslint-config-airbnb": "19.0.4",
     "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-cypress": "3.3.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsx-a11y": "6.9.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-react": "7.34.3",
+    "eslint-plugin-cypress": "3.5.0",
+    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-jsx-a11y": "6.10.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-react": "7.36.1",
     "fixpack": "4.0.0",
-    "husky": "9.0.11",
+    "husky": "9.1.6",
     "is-ci": "3.0.1",
     "jest": "29.7.0",
     "jest-canvas-mock": "2.5.2",
@@ -64,23 +65,23 @@
     "jest-serializer-html": "7.1.0",
     "jest-transformer-svg": "2.0.2",
     "jest-websocket-mock": "2.5.0",
-    "lint-staged": "15.2.7",
-    "maplibre-gl": "4.5.0",
+    "lint-staged": "15.2.10",
+    "maplibre-gl": "4.7.0",
     "mock-socket": "9.3.1",
-    "next": "14.2.4",
+    "next": "14.2.11",
     "next-transpile-modules": "10.0.1",
-    "ol": "9.2.4",
+    "ol": "10.1.0",
     "openapi-typescript": "6.7.5",
-    "prettier": "3.3.2",
+    "prettier": "3.3.3",
     "raw-loader": "4.0.2",
     "sort-json": "2.0.1",
     "standard-version": "9.5.0",
-    "start-server-and-test": "2.0.4",
-    "stylelint": "16.6.1",
-    "stylelint-config-recommended-scss": "14.0.0",
+    "start-server-and-test": "2.0.8",
+    "stylelint": "16.9.0",
+    "stylelint-config-recommended-scss": "14.1.0",
     "stylelint-config-standard": "36.0.1",
-    "stylelint-scss": "6.3.2",
-    "typescript": "5.5.2"
+    "stylelint-scss": "6.6.0",
+    "typescript": "5.6.2"
   },
   "scripts": {
     "apidoc": "esdoc && cp apidoc/index.json doc/src/components/Esdoc",
@@ -102,7 +103,7 @@
     "esbuild:iife:base": "esbuild src/iife.js --bundle --sourcemap --target=chrome100",
     "esbuild:iife:minify": "yarn esbuild:iife:base --minify --outfile=build/mbt.min.js",
     "esbuild:iife:unminify": "yarn esbuild:iife:base --outfile=build/mbt.js",
-    "format": "prettier --write 'src/**/*.js' && eslint src/**/*.js src/**/*.ts --fix && stylelint 'src/**/*.css' 'src/**/*.scss' --fix --allow-empty-input",
+    "format": "prettier --write 'src/**/*.js' 'src/**/*.test.js' && eslint src/**/*.js src/**/*.test.js src/**/*.ts --fix && stylelint 'src/**/*.css' 'src/**/*.scss' --fix --allow-empty-input",
     "lib": "REACT_APP_LIB_MODE=1  webpack --mode production",
     "lib:dev": "REACT_APP_LIB_MODE=1  webpack --mode development",
     "link2": "cmdToAdd=$(node ./scripts/read-pkg-json.js add) && $cmdToAdd && yarn build && cmdToRemove=$(node ./scripts/read-pkg-json.js remove) && $cmdToRemove && cd build && yarn link",

package/types/common.d.ts

@@ -36,6 +36,7 @@ export interface ViewState {
   size?: number[];
   time?: number;
   zoom?: number;
+  visible?:boolean;
 }
 
 export interface RealtimeStyleOptions {
@@ -121,7 +122,7 @@ export interface LayerGetFeatureInfoResponse {
 
 export interface LayerGetFeatureInfoOptions {
   nb?: number;
-  resolution: number;
+  hitTolerance: number = 5;
 }
 
 export type UserInteractionCallback = (

package/common/mixins/RealtimeLayerMixin.d.ts

@@ -1,267 +0,0 @@
-import { Coordinate } from 'ol/coordinate';
-import { EventsKey } from 'ol/events';
-import GeoJSON from 'ol/format/GeoJSON';
-import { Options } from 'ol/layer/Layer';
-import { RealtimeAPI } from '../../api';
-import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
-import { AnyCanvas, AnyLayer, AnyLayerable, AnyMap, AnyRealtimeLayer, LayerGetFeatureInfoOptions, LayerGetFeatureInfoResponse, RealtimeGeneralizationLevel, RealtimeMode, RealtimeMot, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
-import { FilterFunction, SortFunction } from '../typedefs';
-export type RealtimeLayerMixinOptions = {
-    api?: RealtimeAPI;
-    apiKey?: string;
-    bbox?: (number | string)[];
-    bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
-    buffer?: number[];
-    canvas?: HTMLCanvasElement;
-    debug?: boolean;
-    filter?: FilterFunction;
-    generalizationLevelByZoom?: RealtimeGeneralizationLevel[];
-    getGeneralizationLevelByZoom?: (zoom: number, generalizationLevelByZoom: RealtimeGeneralizationLevel[]) => RealtimeGeneralizationLevel;
-    getMotsByZoom?: (zoom: number, motsByZoom: RealtimeMot[][]) => RealtimeMot[];
-    getRenderTimeIntervalByZoom?: (zoom: number, renderTimeIntervalByZoom: number[]) => number;
-    hoverVehicleId?: RealtimeTrainId;
-    isUpdateBboxOnMoveEnd?: boolean;
-    live?: boolean;
-    minZoomInterpolation?: number;
-    mode?: RealtimeMode;
-    motsByZoom?: RealtimeMot[][];
-    onStart?: (realtimeLayer: AnyRealtimeLayer) => void;
-    onStop?: (realtimeLayer: AnyRealtimeLayer) => void;
-    pingIntervalMs?: number;
-    pixelRatio?: number;
-    prefix?: string;
-    renderTimeIntervalByZoom?: number[];
-    selectedVehicleId?: RealtimeTrainId;
-    sort?: SortFunction;
-    speed?: number;
-    style?: RealtimeStyleFunction;
-    styleOptions?: RealtimeStyleOptions;
-    tenant?: RealtimeTenant;
-    time?: number;
-    url?: string;
-    useDebounce?: boolean;
-    useRequestAnimationFrame?: boolean;
-    useThrottle?: boolean;
-} & Options;
-/**
- * RealtimeLayerInterface.
- * @private
- */
-export declare class RealtimeLayerInterface {
-    /**
-     * 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: RealtimeStopSequence, fullTrajectory: RealtimeFullTrajectory>} A promise that will be resolved with the trajectory informations.
-     */
-    getTrajectoryInfos(id: string, mode: RealtimeMode): void;
-    /**
-     * Render the trajectories
-     */
-    renderTrajectories(): 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;
-    /**
-     * Start the clock.
-     */
-    start(): void;
-    /**
-     * Stop the clock.
-     */
-    stop(): 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 AnyLayerable>(Base: T): {
-    new (options: RealtimeLayerMixinOptions): {
-        [x: string]: any;
-        [x: symbol]: any;
-        api: RealtimeAPI;
-        bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
-        canvas?: AnyCanvas;
-        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        debug: boolean;
-        filter?: FilterFunction;
-        format: GeoJSON;
-        generalizationLevel?: RealtimeGeneralizationLevel;
-        generalizationLevelByZoom: RealtimeGeneralizationLevel[];
-        getGeneralizationLevelByZoom: (zoom: number) => RealtimeGeneralizationLevel;
-        getMotsByZoom: (zoom: number) => RealtimeMot[];
-        getRenderTimeIntervalByZoom: (zoom: number) => number;
-        hoverVehicleId?: RealtimeTrainId;
-        isUpdateBboxOnMoveEnd: boolean;
-        live?: boolean;
-        minZoomInterpolation: number;
-        mode: RealtimeMode;
-        mots?: RealtimeMot[];
-        motsByZoom: RealtimeMot[][];
-        onStart?: (realtimeLayer: AnyLayer) => void;
-        onStop?: (realtimeLayer: AnyLayer) => void;
-        pixelRatio?: number;
-        renderState?: RealtimeRenderState;
-        renderTimeIntervalByZoom: number[];
-        requestId?: number;
-        selectedVehicle: RealtimeTrajectory;
-        selectedVehicleId?: RealtimeTrainId;
-        sort?: SortFunction;
-        speed?: number;
-        style?: RealtimeStyleFunction;
-        styleOptions?: RealtimeStyleOptions;
-        tenant: RealtimeTenant;
-        throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        time?: Date;
-        trajectories?: Record<RealtimeTrainId, RealtimeTrajectory>;
-        updateTimeDelay?: number;
-        updateTimeInterval?: number;
-        useDebounce?: boolean;
-        useRequestAnimationFrame?: boolean;
-        useThrottle?: boolean;
-        visibilityRef: EventsKey;
-        /**
-         * Add a trajectory.
-         * @param {RealtimeTrajectory} trajectory The trajectory to add.
-         * @private
-         */
-        addTrajectory(trajectory: RealtimeTrajectory): void;
-        attachToMap(map: AnyMap): void;
-        /**
-         * Define layer's properties.
-         *
-         * @private
-         */
-        defineProperties(options: RealtimeLayerMixinOptions): void;
-        detachFromMap(): void;
-        /**
-         * 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>;
-        /**
-         * Get the duration before the next update depending on zoom level.
-         *
-         * @private
-         * @param {number} zoom
-         */
-        getRefreshTimeInMs(zoom?: number | undefined): number;
-        /**
-         * Request the stopSequence and the fullTrajectory informations for a vehicle.
-         *
-         * @param {string} id The vehicle identifier (the  train_id property).
-         * @return {Promise<{stopSequence: RealtimeStopSequence, fullTrajectory: RealtimeFullTrajectory>} A promise that will be resolved with the trajectory informations.
-         */
-        getTrajectoryInfos(id: RealtimeTrainId): Promise<{
-            fullTrajectory: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory>;
-            stopSequence: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<import("../../types").RealtimeFullTrajectory>;
-        }>;
-        /**
-         * Get vehicle.
-         * @param {function} filterFc A function use to filter results.
-         * @return {Array<Object>} Array of vehicle.
-         */
-        getVehicle(filterFc: FilterFunction): RealtimeTrajectory[];
-        highlightVehicle(id: RealtimeTrainId): void;
-        /**
-         * Callback on websocket's deleted_vehicles channel events.
-         * It removes the trajectory from the list.
-         *
-         * @private
-         * @override
-         */
-        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrainId>): void;
-        onDocumentVisibilityChange(): void;
-        /**
-         * Callback on websocket's trajectory channel events.
-         * It adds a trajectory to the list.
-         *
-         * @private
-         */
-        onTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrajectory>): void;
-        /**
-         * On zoomend we adjust the time interval of the update of vehicles positions.
-         *
-         * @param evt Event that triggered the function.
-         * @private
-         */
-        onZoomEnd(): void;
-        /**
-         * 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: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
-        removeTrajectory(trajectoryOrId: RealtimeTrainId | RealtimeTrajectory): void;
-        /**
-         * 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: undefined | ViewState, noInterpolate: boolean | undefined): 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;
-        selectVehicle(id: RealtimeTrainId): void;
-        setBbox(extent: [number, number, number, number], zoom: number): void;
-        start(): void;
-        /**
-         * Start the clock.
-         * @private
-         */
-        startUpdateTime(): void;
-        stop(): void;
-        /**
-         * Stop the clock.
-         * @private
-         */
-        stopUpdateTime(): void;
-    };
-} & T;
-export default RealtimeLayerMixin;