mobility-toolbox-js 3.0.0-beta.10 → 3.0.0-beta.11

package/api/RealtimeAPI.d.ts

@@ -40,7 +40,7 @@ export declare const RealtimeModes: {
     SCHEMATIC: RealtimeMode;
 };
 /**
- * This class provides convenience methods to use to the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+ * This class provides convenience methods to use to the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
  * import { RealtimeAPI } from 'mobility-toolbox-js/api';
@@ -116,7 +116,7 @@ declare class RealtimeAPI {
      * @param {Object} options Options.
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
      * @param {string[]} options.bbox The bounding box to receive data from.
-     * @param {string} [options.url='wss://api.geops.io/tracker-ws/v1/'] Url of the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+     * @param {string} [options.url='wss://api.geops.io/tracker-ws/v1/'] Url of the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
      * @public
      */
     constructor(options?: RealtimeAPIOptions);

package/api/RealtimeAPI.js

@@ -19,7 +19,7 @@ export const RealtimeModes = {
     SCHEMATIC: 'schematic',
 };
 /**
- * This class provides convenience methods to use to the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+ * This class provides convenience methods to use to the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
  * import { RealtimeAPI } from 'mobility-toolbox-js/api';
@@ -114,7 +114,7 @@ class RealtimeAPI {
      * @param {Object} options Options.
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
      * @param {string[]} options.bbox The bounding box to receive data from.
-     * @param {string} [options.url='wss://api.geops.io/tracker-ws/v1/'] Url of the [geOps realtime API](https://developer.geops.io/apis/realtime/).
+     * @param {string} [options.url='wss://api.geops.io/tracker-ws/v1/'] Url of the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
      * @public
      */
     constructor(options = {}) {

package/api/RoutingAPI.d.ts

@@ -5,7 +5,7 @@ export type RoutingAPIOptions = {
     apiKey?: string;
 };
 /**
- * Access to the [geOps Routing API](https://developer.geops.io/apis/routing).
+ * This class provides convenience methods to use to the [geOps Routing API](https://developer.geops.io/apis/routing).
  *
  * @example
  * import { RoutingAPI } from 'mobility-toolbox-js';

package/api/RoutingAPI.js

@@ -1,6 +1,6 @@
 import HttpAPI from './HttpAPI';
 /**
- * Access to the [geOps Routing API](https://developer.geops.io/apis/routing).
+ * This class provides convenience methods to use to the [geOps Routing API](https://developer.geops.io/apis/routing).
  *
  * @example
  * import { RoutingAPI } from 'mobility-toolbox-js';

package/api/StopsAPI.d.ts

@@ -5,7 +5,7 @@ export type StopsAPIOptions = {
     apiKey?: string;
 };
 /**
- * This class provides convenience methods to use to the [geOps Stops api](https://developer.geops.io/apis/stops/).
+ * This class provides convenience methods to use to the [geOps Stops API](https://developer.geops.io/apis/stops/).
  *
  * @example
  * import { StopsAPI } from 'mobility-toolbox-js/api';

package/api/StopsAPI.js

@@ -1,6 +1,6 @@
 import HttpAPI from './HttpAPI';
 /**
- * This class provides convenience methods to use to the [geOps Stops api](https://developer.geops.io/apis/stops/).
+ * This class provides convenience methods to use to the [geOps Stops API](https://developer.geops.io/apis/stops/).
  *
  * @example
  * import { StopsAPI } from 'mobility-toolbox-js/api';

package/common/utils/debounceWebsocketMessages.d.ts

@@ -7,5 +7,5 @@ import type { WebSocketAPIMessageCallback } from '../../api/WebSocketAPI';
  * @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>;
+declare const debounceWebsocketMessages: (onUpdate: (objects: any[]) => void, getObjectId?: (object: any) => string, timeout?: number) => WebSocketAPIMessageCallback<any>;
 export default debounceWebsocketMessages;

package/common/utils/getVehiclePosition.js

@@ -10,13 +10,14 @@ import { LineString } from 'ol/geom';
  */
 const getVehiclePosition = (now, trajectory, noInterpolate) => {
     const { time_intervals: timeIntervals, olGeometry, coordinate, } = trajectory.properties;
-    const { coordinates } = trajectory.geometry;
-    let { type } = trajectory.geometry;
+    let { type, coordinates } = trajectory.geometry;
     let geometry = olGeometry;
     let coord;
     let rotation;
+    // If an olGeometry exists we use it. It avoids to create one each time.
     if (olGeometry) {
         type = geometry.getType();
+        coordinates = geometry.getCoordinates();
     }
     if (noInterpolate && coordinate) {
         coord = coordinate;

package/maplibre/layers/RealtimeLayer.d.ts

@@ -81,10 +81,10 @@ declare const RealtimeLayer_base: {
     };
 } & typeof Layer;
 /**
- * Responsible for loading and display data from a geOps realtime API.
+ * A Maplibre layer able to display data from the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
- * import { RealtimeLayer } from 'mobility-toolbox-js/Maplibre';
+ * import { RealtimeLayer } from 'mobility-toolbox-js/maplibre';
  *
  * const layer = new RealtimeLayer({
  *   apiKey: "yourApiKey"
@@ -104,7 +104,7 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      *
      * @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/RealtimeLayer.js

@@ -8,10 +8,10 @@ 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.
+ * A Maplibre layer able to display data from the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
- * import { RealtimeLayer } from 'mobility-toolbox-js/Maplibre';
+ * import { RealtimeLayer } from 'mobility-toolbox-js/maplibre';
  *
  * const layer = new RealtimeLayer({
  *   apiKey: "yourApiKey"
@@ -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 = {}) {