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

package/mbt.js

@@ -19610,96 +19610,94 @@ uniform ${i3} ${s3} u_${a3};
     /**
      * Constructor
      *
-     * @param {RealtimeAPIOptions} options A string representing the url of the service or an object containing the url and the apiKey.
-     * @param {string} options.url Url to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
+     * @param {Object} options A string representing the url of the service or an object containing the url and the apiKey.
+     * @param {string} options.url Url to the [geOps realtime API](https://developer.geops.io/apis/realtime/).
      * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
-     * @param {number[5]} [options.bbox=[minX, minY, maxX, maxY, zoom, tenant]] The bounding box to receive data from.
+     * @param {string[]} options.bbox The bounding box to receive data from.
+     * @public
      */
     constructor(options = {}) {
       this.version = "2";
-      this.defineProperties(options);
-      this.onOpen = this.onOpen.bind(this);
-    }
-    defineProperties(options = {}) {
-      let opt = options || {};
+      let opt = options;
       if (typeof options === "string") {
         opt = { url: options };
       }
-      const { apiKey, version } = opt;
-      let { url, bbox, buffer: buffer2 = [100, 100] } = opt;
+      const { apiKey } = opt;
+      const { url } = opt;
       const wsApi = new WebSocketAPI_default();
-      if (!url) {
-        url = "wss://api.geops.io/tracker-ws/v1/";
+      let suffix = "";
+      if (apiKey && !url?.includes("key=")) {
+        suffix = `?key=${apiKey}`;
       }
-      if (apiKey) {
-        url = `${url}?key=${apiKey}`;
+      this._url = (url || "wss://api.geops.io/tracker-ws/v1/") + suffix;
+      this._buffer = opt.buffer || [100, 100];
+      this.version = opt.version || "2";
+      this.pingIntervalMs = opt.pingIntervalMs || 1e4;
+      this.reconnectTimeoutMs = opt.reconnectTimeoutMs || 100;
+      this.wsApi = wsApi;
+    }
+    get url() {
+      return this._url;
+    }
+    set url(newUrl) {
+      if (this._url !== newUrl) {
+        this._url = newUrl;
+        if (this.wsApi.open || this.wsApi.connecting) {
+          this.open();
+        }
+      }
+    }
+    /**
+     * The bounding box to receive data from.\
+     * Example: [minX, minY, maxX, maxY, zoom, mots , gen_level, tenant, ...]\
+     *  \
+     * Where:
+     * - **minX**: a string representation of an integer (not a float) representing the minimal X coordinate (in EPSG:3857) of a bounding box\
+     *  
+     * - **minY**: a string representation of an integer (not a float) representing the minimal Y coordinate (in EPSG:3857) of a bounding box\
+     *  
+     * - **maxX**: a string representation of an integer (not a float) representing the maximal X coordinate (in EPSG:3857) of a bounding box\
+     *  
+     * - **maxY**: a string representation of an integer (not a float) representing the maximal Y coordinate (in EPSG:3857) of a bounding box\
+     *  
+     * - **zoom**: a string representation of an integer representing the zoom level (from 4 to 22). When zoom < 8 only the trains are displayed for performance reasons.\
+     * &nbsp;
+     * - **mots**: A comma separated list of modes of transport. **Optional**.\
+     *         Example: "mots=rail,subway".\
+     * &nbsp;
+     * - **gen_level**: An integer representing the generalization level. **Optional**.\
+     *              Example: "gen_level=5"\
+     * &nbsp;
+     * - **tenant**: A string representing the tenant. **Optional**.\
+     *           Example: "tenant=sbb"\
+     * &nbsp;
+     * - ...: Any other values added to the bbox will be send to the server
+     *
+     * @type {string[]}
+     *
+     * @public
+     */
+    get bbox() {
+      return this._bbox;
+    }
+    set bbox(newBbox) {
+      if (JSON.stringify(newBbox) !== JSON.stringify(this._bbox)) {
+        this._bbox = newBbox;
+        if (this.wsApi && this._bbox) {
+          this.wsApi.send(`BBOX ${this._bbox.join(" ")}`);
+        }
       }
-      Object.defineProperties(this, {
-        url: {
-          get: () => url,
-          set: (newUrl) => {
-            if (url !== newUrl) {
-              url = newUrl;
-              if (this.wsApi.open || this.wsApi.connecting) {
-                this.open();
-              }
-            }
-          }
-        },
-        bbox: {
-          get: () => bbox,
-          set: (newBbox) => {
-            if (JSON.stringify(newBbox) !== JSON.stringify(bbox)) {
-              bbox = newBbox;
-              if (this.wsApi && bbox) {
-                this.wsApi.send(`BBOX ${bbox.join(" ")}`);
-              }
-            }
-          }
-        },
-        buffer: {
-          get: () => buffer2,
-          set: (newBuffer) => {
-            if (JSON.stringify(newBuffer) !== JSON.stringify(buffer2)) {
-              buffer2 = newBuffer;
-              if (this.wsApi) {
-                this.wsApi.send(`BUFFER ${buffer2.join(" ")}`);
-              }
-            }
-          }
-        },
-        version: {
-          value: version,
-          writable: true
-        },
-        /**
-         * The websocket helper class to connect the websocket.
-         *
-         * @private
-         */
-        wsApi: {
-          value: wsApi,
-          writable: true
-        },
-        /**
-         * Interval between PING request in ms.
-         * If equal to 0,  no PING request are sent.
-         * @type {number}
-         * @private
-         */
-        pingIntervalMs: {
-          value: options.pingIntervalMs || 1e4,
-          writable: true
-        },
-        /**
-         * Timeout in ms after an automatic reconnection when the websoscket has been closed by the server.
-         * @type {number}
-         */
-        reconnectTimeoutMs: {
-          value: options.pingIntervalMs || 100,
-          writable: true
+    }
+    get buffer() {
+      return this._buffer;
+    }
+    set buffer(newBuffer) {
+      if (JSON.stringify(newBuffer) !== JSON.stringify(this._buffer)) {
+        this._buffer = newBuffer;
+        if (this.wsApi && this._buffer) {
+          this.wsApi.send(`BUFFER ${this._buffer.join(" ")}`);
         }
-      });
+      }
     }
     /**
      * Open the websocket connection.
@@ -19707,7 +19705,7 @@ uniform ${i3} ${s3} u_${a3};
      * @public
      */
     open() {
-      this.wsApi.connect(this.url, this.onOpen);
+      this.wsApi.connect(this.url, this.onOpen.bind(this));
       if (this.wsApi.websocket) {
         this.wsApi.websocket.onclose = () => {
           this.onClose();
@@ -19725,7 +19723,6 @@ uniform ${i3} ${s3} u_${a3};
     /**
      * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
      */
-    // eslint-disable-next-line class-methods-use-this
     reset() {
       this.wsApi.send("RESET");
     }
@@ -20225,7 +20222,7 @@ uniform ${i3} ${s3} u_${a3};
     let flatLayers = [];
     layers.forEach((layer) => {
       flatLayers.push(layer);
-      const children = layer.children || layer.get("children") || {};
+      const children = layer.children || layer.get("children") || layer.getLayers?.()?.getArray();
       flatLayers = flatLayers.concat(getLayersAsFlatArray(children || []));
     });
     return flatLayers;
@@ -29162,6 +29159,9 @@ uniform ${i3} ${s3} u_${a3};
         element,
         ...options
       });
+      this.format = options.format || ((copyrights) => {
+        return copyrights?.join(" | ");
+      });
     }
     render({ frameState }) {
       if (!frameState) {
@@ -29171,14 +29171,23 @@ uniform ${i3} ${s3} u_${a3};
       let copyrights = [];
       frameState?.layerStatesArray.forEach((layerState) => {
         const { layer } = layerState;
-        if (frameState && inView(layerState, frameState.viewState) && layer && layer.getSource && layer.getSource() && layer.getSource().getAttributions()) {
-          copyrights = copyrights.concat(
-            layer.getSource().getAttributions()(frameState)
-          );
+        if (frameState && inView(layerState, frameState.viewState)) {
+          if (layer?.getSource()?.getAttributions()) {
+            copyrights = copyrights.concat(
+              layer.getSource().getAttributions()(frameState)
+            );
+          }
+          if (layer?.get("copyrights")) {
+            let copyProp = layer.get("copyrights");
+            copyProp = !Array.isArray(copyProp) ? [copyProp] : copyProp;
+            if (copyProp?.length) {
+              copyrights.push(...copyProp);
+            }
+          }
         }
       });
       const unique = removeDuplicate_default(copyrights) || [];
-      this.element.innerHTML = unique.join(" | ");
+      this.element.innerHTML = this.format(unique);
     }
   };
   var CopyrightControl_default = CopyrightControl;
@@ -44741,6 +44750,9 @@ uniform ${i3} ${s3} u_${a3};
       this.segments = [];
       this.format = new GeoJSON_default({ featureProjection: "EPSG:3857" });
       this.initialRouteDrag = {};
+      if (!this.element) {
+        this.createDefaultElement();
+      }
       this.loading = false;
       this.active = options.active || true;
       this.graphs = options.graphs || [["osm", 0, 99]];
@@ -45421,6 +45433,9 @@ uniform ${i3} ${s3} u_${a3};
       const coord = fromLonLat(suggestion.geometry.coordinates);
       this.getMap()?.getView().setCenter(coord);
     }
+    search(q, abortController) {
+      return this.controller.search(q, abortController);
+    }
   };
   var StopFinderControl_default = StopFinderControl;
 
@@ -45432,8 +45447,9 @@ uniform ${i3} ${s3} u_${a3};
 
   // src/ol/mixins/PropertiesLayerMixin.ts
   function PropertiesLayerMixin(Base) {
-    return class extends Base {
-      constructor(options) {
+    return class PropertiesLayer extends Base {
+      constructor(...args) {
+        const options = args[0];
         super(options);
         this.options = {};
         this.olListenersKeys = [];
@@ -45517,6 +45533,7 @@ uniform ${i3} ${s3} u_${a3};
       set visible(newValue) {
         this.setVisible(newValue);
       }
+      // @ts-expect-error - this is a mixin
       setMapInternal(map) {
         super.setMapInternal(map);
         if (map) {
@@ -45568,10 +45585,10 @@ uniform ${i3} ${s3} u_${a3};
 
   // src/ol/mixins/MobilityLayerMixin.ts
   function MobilityLayerMixin(Base) {
-    return class extends PropertiesLayerMixin_default(Base) {
-      constructor(options = {}) {
-        super(options);
-      }
+    return class MobilityLayer extends PropertiesLayerMixin_default(Base) {
+      // constructor(options: MobilityLayerOptions = {}) {
+      //   super(options);
+      // }
     };
   }
   var MobilityLayerMixin_default = MobilityLayerMixin;
@@ -45619,6 +45636,7 @@ uniform ${i3} ${s3} u_${a3};
         style: "travic_v2",
         url: "https://maps.geops.io",
         ...options || {},
+        // @ts-expect-error mapOptions must be saved by the mixin in this.options
         mapOptions: {
           interactive: false,
           trackResize: false,
@@ -46057,7 +46075,7 @@ uniform ${i3} ${s3} u_${a3};
         }
       }
       this.olListenersKeys.push(
-        // @ts-expect-error 'load' is a custom event form mobility-toolbox-js
+        // @ts-expect-error 'load' is a custom event
         this.maplibreLayer.on("load", this.onLoad.bind(this)),
         this.on("change:visible", (evt) => {
           this.applyLayoutVisibility(evt);
@@ -47215,7 +47233,7 @@ uniform ${i3} ${s3} u_${a3};
         this.container.style.position = "absolute";
         this.container.style.width = "100%";
         this.container.style.height = "100%";
-        if (canvas2) {
+        if (canvas2 instanceof HTMLCanvasElement) {
           canvas2.style.position = "absolute";
           canvas2.style.top = "0";
           canvas2.style.left = "0";
@@ -47239,17 +47257,20 @@ uniform ${i3} ${s3} u_${a3};
             canvas2?.height
           );
         } else {
-          const pixelCenterRendered = this.getLayer().getMapInternal()?.getPixelFromCoordinate(renderedCenter);
-          const pixelCenter = this.getLayer().getMapInternal().getPixelFromCoordinate(center);
-          this.container.style.transform = composeCssTransform(
-            pixelCenterRendered[0] - pixelCenter[0],
-            pixelCenterRendered[1] - pixelCenter[1],
-            renderedResolution / resolution,
-            renderedResolution / resolution,
-            rotation - renderedRotation,
-            0,
-            0
-          );
+          const map = this.getLayer().getMapInternal();
+          const pixelCenterRendered = map?.getPixelFromCoordinate(renderedCenter);
+          const pixelCenter = map?.getPixelFromCoordinate(center);
+          if (pixelCenterRendered && pixelCenter) {
+            this.container.style.transform = composeCssTransform(
+              pixelCenterRendered[0] - pixelCenter[0],
+              pixelCenterRendered[1] - pixelCenter[1],
+              renderedResolution / resolution,
+              renderedResolution / resolution,
+              rotation - renderedRotation,
+              0,
+              0
+            );
+          }
         }
       }
       return this.container;
@@ -47290,7 +47311,7 @@ uniform ${i3} ${s3} u_${a3};
       }
       const layer = this.getLayer();
       const map = layer.getMapInternal();
-      const resolution = map.getView().getResolution();
+      const resolution = map?.getView()?.getResolution() || 1;
       const nb = 10;
       const ext = buffer(
         [...coordinate, ...coordinate],
@@ -47327,7 +47348,7 @@ uniform ${i3} ${s3} u_${a3};
      * @param {RealtimeLayerOptions} options
      * @param {boolean} [options.allowRenderWhenAnimating=false] Allow rendering of the layer when the map is animating.
      * @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) {
@@ -47377,6 +47398,7 @@ uniform ${i3} ${s3} u_${a3};
         this.olListenersKeys.push(
           ...this.map.on(
             ["moveend", "change:target"],
+            // @ts-expect-error - bad ol definitions
             (evt) => {
               const view = (evt.map || evt.target).getView();
               if (view.getAnimating() || view.getInteracting()) {
@@ -47457,8 +47479,9 @@ uniform ${i3} ${s3} u_${a3};
       isRendered = blockRendering ? false : super.renderTrajectoriesInternal(viewState, noInterpolate);
       if (isRendered) {
         this.renderedViewState = { ...viewState };
-        if (this.getRenderer().container) {
-          this.getRenderer().container.style.transform = "";
+        const { container } = this.getRenderer();
+        if (container) {
+          container.style.transform = "";
         }
       }
       return isRendered;
@@ -47550,7 +47573,7 @@ uniform ${i3} ${s3} u_${a3};
       return super.purgeTrajectory(
         trajectory,
         extent || this.map.getView().calculateExtent(),
-        zoom || this.map.getView().getZoom()
+        zoom || this.map.getView().getZoom() || 0
       );
     }
     /**
@@ -47561,7 +47584,7 @@ uniform ${i3} ${s3} u_${a3};
     setBbox(extent, zoom) {
       super.setBbox(
         extent || this.map.getView().calculateExtent(),
-        zoom || this.map.getView().getZoom()
+        zoom || this.map.getView().getZoom() || 0
       );
     }
     /**
@@ -47639,7 +47662,7 @@ uniform ${i3} ${s3} u_${a3};
       }
       const source = layer?.getSource();
       if (source?.getFeatureInfoUrl) {
-        const id = getUid(void 0);
+        const id = getUid(layer);
         abortControllers[id]?.abort();
         abortControllers[id] = new AbortController();
         const resolution = map?.getView()?.getResolution();
@@ -48400,7 +48423,7 @@ uniform ${i3} ${s3} u_${a3};
      *
      * @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 = {}) {