mobility-toolbox-js 3.0.0-beta.36 → 3.0.0-beta.38

package/README.md

@@ -10,7 +10,7 @@ The tools in this library have been inspired by many projects realized for publi
 
 ## Documentation and examples
 
-Visit https://mobility-toolbox-js.vercel.app/
+Visit https://mobility-toolbox-js.geops.io/
 
 ## Demos
 
@@ -24,7 +24,7 @@ Visit https://mobility-toolbox-js.vercel.app/
 Install the library and the peer dependencies:
 
 ```bash
-yarn add mobility-toolbox-js ol maplibre-gl
+yarn add ol maplibre-gl mobility-toolbox-js
 ```
 
 ## Development
@@ -34,9 +34,17 @@ yarn install
 yarn dev
 ```
 
+`yarn dev` starts a vite server using the `index.html` file at the root of the project.
+This html file loads the `dev.js` file. Use this file to develop the library.
+Each time you modifiy the library code you have to run `yarn build:tsc` to see the changes.
+
+## Development documentation
+
+The documentations website is located in the `doc/`  folder.
+It's a nextJS website that use the mobility-toolbox-js library built from the `build/` folder.
+
 ## Deploy
 
 This library website is deployed automatically using [Vercel](https://vercel.com/geops).
 For Vercel we have to add the nextjs and raw-loader modules in the dev dependencies of the main package.json.
 But those 2 librairies are not needed to build the library.
-

package/common/typedefs.d.ts

@@ -50,88 +50,6 @@ export type FeatureInfo = {
      */
     coordinate: number[2];
 };
-export type MaplibreLayerOptions = {
-    /**
-     * Access key for [geOps apis](https://developer.geops.io/).
-     */
-    apiKey: string;
-    /**
-     * geOps Maps api key name.
-     */
-    apiKeyName: string;
-    /**
-     * Maplibre map options.
-     */
-    mapLibreOptions: 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 .
@@ -142,10 +60,6 @@ export type VehiclePosition = {
      */
     rotation: number;
 };
-/**
- * /Map~Map|maplibregl.Map} AnyMap
- */
-type dummy = ol;
 /**
  * @typedef {function} FilterFunction
  * @param {Vehicle} vehicle Vehicle to filter.
@@ -180,37 +94,6 @@ type dummy = ol;
  * @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.mapLibreOptions 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 .

package/common/typedefs.js

@@ -32,37 +32,6 @@
  * @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.mapLibreOptions 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 .

package/common/utils/RealtimeEngine.d.ts

@@ -2,7 +2,7 @@ import { FeatureCollection } from 'geojson';
 import GeoJSON from 'ol/format/GeoJSON';
 import { RealtimeAPI } from '../../api';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
-import { AnyCanvas, AnyLayer, AnyRealtimeLayer, LayerGetFeatureInfoOptions, RealtimeGeneralizationLevel, RealtimeMode, RealtimeMot, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
+import { AnyCanvas, LayerGetFeatureInfoOptions, RealtimeGeneralizationLevel, RealtimeMode, RealtimeMot, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
 import { FilterFunction, SortFunction } from '../typedefs';
 import type { Coordinate } from 'ol/coordinate';
 export interface RealtimeEngineOptions {
@@ -26,8 +26,8 @@ export interface RealtimeEngineOptions {
     mode?: RealtimeMode;
     motsByZoom?: RealtimeMot[][];
     onRender?: (renderState: RealtimeRenderState, viewState: ViewState) => void;
-    onStart?: (realtimeLayer: AnyRealtimeLayer) => void;
-    onStop?: (realtimeLayer: AnyRealtimeLayer) => void;
+    onStart?: (realtimeEngine: RealtimeEngine) => void;
+    onStop?: (realtimeEngine: RealtimeEngine) => void;
     pingIntervalMs?: number;
     pixelRatio?: number;
     prefix?: string;
@@ -76,8 +76,8 @@ declare class RealtimeEngine {
     mots?: RealtimeMot[];
     motsByZoom: RealtimeMot[][];
     onRender?: (renderState: RealtimeRenderState, viewState: ViewState) => void;
-    onStart?: (realtimeLayer: AnyLayer) => void;
-    onStop?: (realtimeLayer: AnyLayer) => void;
+    onStart?: (realtimeLayer: RealtimeEngine) => void;
+    onStop?: (realtimeLayer: RealtimeEngine) => void;
     pixelRatio?: number;
     renderState?: RealtimeRenderState;
     renderTimeIntervalByZoom: number[];

package/common/utils/RealtimeEngine.js

@@ -196,7 +196,6 @@ class RealtimeEngine {
         }
         const vehicles = [];
         for (let i = 0; i < trajectories.length; i += 1) {
-            // @ts-expect-error  coordinate is added by the RealtimeLayer
             const { coordinate: trajcoord } = trajectories[i].properties;
             if (trajcoord && containsCoordinate(ext, trajcoord)) {
                 vehicles.push(trajectories[i]);

package/common/utils/getVehiclePosition.js

@@ -9,12 +9,9 @@ import { LineString } from 'ol/geom';
  * @private
  */
 const getVehiclePosition = (now, trajectory, noInterpolate) => {
-    const { 
-    // @ts-expect-error  coordinate is added by the RealtimeLayer
-    coordinate, 
+    const { coordinate, 
     // @ts-expect-error  olGeometry is added by the RealtimeLayer
     olGeometry, time_intervals: timeIntervals, } = trajectory.properties;
-    // @ts-expect-error
     let { coordinates, type } = trajectory.geometry;
     let geometry = olGeometry;
     let coord;