mobility-toolbox-js 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -7,14 +7,17 @@ The tools in this library have been inspired by many projects realized for publi
 [![Build](https://github.com/geops/mobility-toolbox-js/workflows/Build/badge.svg)](https://github.com/geops/mobility-toolbox-js/actions?query=workflow%3ABuild)
 [![Netlify Status](https://api.netlify.com/api/v1/badges/b368ab18-9dbf-416c-91f6-a82076b02c10/deploy-status)](https://app.netlify.com/sites/mobility-toolbox-js/deploys)
 
-## Version 1.x.x
-The master branch is now open for the version 2 development. The version 1 is now available in 1.x.x branch.
-
 ## Main Features
+
 * Display [real-time vehicle positions and prognosis data](http://tracker.geops.ch/) on a map.
 * Search for [stops and stations](https://maps2.trafimage.ch) all over the world.
 * Get [precise geographic courses](https://geops.github.io/geops-routing-demo/) for all modes of transport.
 * Generate beautiful maps for public transport, mobility and logistics
 
 ## Documentation and examples
-Visit https://mobility-toolbox-js.geops.io
+
+Visit https://master--mobility-toolbox-js.netlify.app/
+
+## Version 1.x.x
+
+The master branch is now open for the version 2 development. The version 1 is still available in [1.x.x](https://github.com/geops/mobility-toolbox-js/tree/1.x.x) branch.

package/api/index.js

@@ -1,4 +1,3 @@
 // eslint-disable-next-line import/prefer-default-export
 export { default as StopsAPI } from './stops/StopsAPI';
-export { default as TrajservAPI } from './trajserv/TrajservAPI';
 export { default as TralisAPI, TralisModes } from './tralis/TralisAPI';

package/api/tralis/TralisAPI.js

@@ -81,7 +81,7 @@ class TralisAPI {
     const conn = new WebSocketConnector();
 
     if (apiKey) {
-      url = `${url || 'wss://tralis-tracker-api.geops.io/ws'}?key=${apiKey}`;
+      url = `${url || 'wss://api.geops.io/tracker-ws/v1/'}?key=${apiKey}`;
     }
 
     Object.defineProperties(this, {

package/common/controls/Control.js

@@ -74,7 +74,10 @@ class Control extends BaseObject {
 
           if (this.map) {
             // Add new node
-            const targett = this.target || this.map.getContainer();
+            const targett =
+              this.target ||
+              (this.map.getTargetElement && this.map.getTargetElement()) ||
+              (this.map.getContainer && this.map.getContainer());
 
             if (!this.element) {
               this.createDefaultElement();

package/common/layers/Layer.js

@@ -16,7 +16,7 @@ import { v4 as uuid } from 'uuid';
  * @classproperty {boolean} isQueryable - Define if the layer can be queried. If false, it will set isHoverActive and isClickActive to false. Read-only.
  * @classproperty {boolean} isClickActive - If true feature information will be queried on user click event. See inherited layers for more informations. Read-only.
  * @classproperty {boolean} isHoverActive - If true feature information will be queried on pointer move event. See inherited layers for more informations. Read-only.
- * @classproperty {boolean} isReactSpatialLayer - Custom property for duck typing since `instanceof` is not working when the instance was created on different bundles. Read-only.
+ * @classproperty {boolean} isMobilityLayer - Custom property for duck typing since `instanceof` is not working when the instance was created on different bundles. Read-only.
  * @classproperty {Layer[]} children - List of children.
  * @classproperty {boolean} visible - Define if the layer is visible or not.
  * @classproperty {number} hitTolerance - Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features.
@@ -109,12 +109,15 @@ export default class Layer extends Observable {
       },
       isQueryable: {
         value: !!isQueryable,
+        writable: true,
       },
       isClickActive: {
         value: !!isQueryable && !!isClickActive,
+        writable: true,
       },
       isHoverActive: {
         value: !!isQueryable && !!isHoverActive,
+        writable: true,
       },
       hitTolerance: {
         value: hitTolerance || 5,
@@ -122,7 +125,7 @@ export default class Layer extends Observable {
       },
       // Custom property for duck typing since `instanceof` is not working
       // when the instance was created on different bundles.
-      isReactSpatialLayer: {
+      isMobilityLayer: {
         value: true,
       },
       children: {
@@ -197,11 +200,13 @@ export default class Layer extends Observable {
    * @param {string} value Value.
    */
   set(name, value) {
-    this.properties[name] = value;
-    this.dispatchEvent({
-      type: `change:${name}`,
-      target: this,
-    });
+    if (value !== this.properties[name]) {
+      this.properties[name] = value;
+      this.dispatchEvent({
+        type: `change:${name}`,
+        target: this,
+      });
+    }
   }
 
   /**
@@ -250,48 +255,7 @@ export default class Layer extends Observable {
    * @deprecated
    */
   hasVisibleChildren() {
-    return !!this.hasChildren(true);
-  }
-
-  /**
-   * Checks whether the layer has any child layers with visible equal to the input parameter
-   *
-   * @param {boolean} visible The state to check the childlayers against
-   * @return {boolean} True if the layer has children with the given visibility
-   */
-  hasChildren(visible) {
-    return !!this.children.find((child) => child.visible === visible);
-  }
-
-  /**
-   * Add a child layer
-   *
-   * @param {Layer} layer Add a child layer
-   */
-  addChild(layer) {
-    this.children.unshift(layer);
-    this.dispatchEvent({
-      type: `change:children`,
-      target: this,
-    });
-  }
-
-  /**
-   * Removes a child layer by layer name
-   *
-   * @param {string} name Layer's name
-   */
-  removeChild(name) {
-    for (let i = 0; i < this.children.length; i += 1) {
-      if (this.children[i].name === name) {
-        this.children.splice(i, 1);
-        break;
-      }
-    }
-    this.dispatchEvent({
-      type: `change:children`,
-      target: this,
-    });
+    return !!this.children.find((child) => child.visible === true);
   }
 
   /**
@@ -310,6 +274,11 @@ export default class Layer extends Observable {
       this.key,
     );
 
+    // No response so we modify the properties accordingly, to avoid spaming the console.
+    this.isQueryable = false;
+    // this.isClickActive = false;
+    // this.isHoverActive = false;
+
     // This layer returns no feature info.
     // The function is implemented by inheriting layers.
     return Promise.resolve({

package/common/layers/Layer.test.js

@@ -27,7 +27,7 @@ describe('Layer', () => {
     expect(layer.isClickActive).toBe(true);
     expect(layer.isHoverActive).toBe(true);
     expect(layer.hitTolerance).toBe(5);
-    expect(layer.isReactSpatialLayer).toBe(true);
+    expect(layer.isMobilityLayer).toBe(true);
     expect(layer.copyrights).toBe();
     expect(layer.visible).toBe(true);
     expect(layer.properties).toEqual({});
@@ -115,19 +115,6 @@ describe('Layer', () => {
     });
     expect(layer.getVisibleChildren().length).toBe(1);
     expect(layer.hasVisibleChildren()).toBe(true);
-    expect(layer.hasChildren(false)).toBe(true);
-
-    layer.addChild(
-      new Layer({
-        name: 'bla',
-      }),
-    );
-
-    expect(layer.getVisibleChildren().length).toBe(2);
-
-    layer.removeChild('bla');
-
-    expect(layer.getVisibleChildren().length).toBe(1);
   });
 
   test('should set onClick using constructor.', () => {
@@ -292,97 +279,6 @@ describe('Layer', () => {
     });
   });
 
-  describe('#hasVisibleChildren()', () => {
-    test('should return true for visible children.', () => {
-      const layerVisible = { visible: true };
-      const layerVisible2 = { visible: true };
-      const layerHidden = { visible: false };
-      const layer = new Layer({
-        name: 'Layer',
-        visible: false,
-        olLayer,
-        children: [layerVisible, layerHidden, layerVisible2],
-      });
-      expect(layer.hasChildren(true)).toEqual(true);
-    });
-
-    test('should return true  with hidden children.', () => {
-      const layerVisible = { visible: true };
-      const layerVisible2 = { visible: true };
-      const layerHidden = { visible: false };
-      const layer = new Layer({
-        name: 'Layer',
-        visible: false,
-        olLayer,
-        children: [layerVisible, layerHidden, layerVisible2],
-      });
-      expect(layer.hasChildren(false)).toEqual(true);
-    });
-
-    test('should return false with hidden children.', () => {
-      const layerVisible = { visible: true };
-      const layerVisible2 = { visible: true };
-      const layer = new Layer({
-        name: 'Layer',
-        visible: false,
-        olLayer,
-        children: [layerVisible, layerVisible2],
-      });
-      expect(layer.hasChildren(false)).toEqual(false);
-    });
-  });
-
-  describe('#addChild()', () => {
-    test('add a child.', () => {
-      const layerVisible = { visible: true };
-      const layerHidden = { visible: false };
-      const layer = new Layer({
-        name: 'Layer',
-        visible: false,
-        olLayer,
-      });
-      const spy = jest.spyOn(layer, 'dispatchEvent');
-      expect(layer.children).toEqual([]);
-      layer.addChild(layerVisible);
-      expect(layer.children).toEqual([layerVisible]);
-      expect(spy).toHaveBeenCalledTimes(1);
-      expect(spy).toHaveBeenCalledWith({
-        type: 'change:children',
-        target: layer,
-      });
-      spy.mockReset();
-      layer.addChild(layerHidden);
-      expect(layer.children).toEqual([layerHidden, layerVisible]);
-      expect(spy).toHaveBeenCalledTimes(1);
-      expect(spy).toHaveBeenCalledWith({
-        type: 'change:children',
-        target: layer,
-      });
-    });
-  });
-
-  describe('#removeChild()', () => {
-    test('removes a child using the name', () => {
-      const layerVisible = { name: 'foo', visible: true };
-      const layerHidden = { name: 'bar', visible: false };
-      const layer = new Layer({
-        name: 'Layer',
-        visible: false,
-        olLayer,
-        children: [layerVisible, layerHidden],
-      });
-      const spy = jest.spyOn(layer, 'dispatchEvent');
-      expect(layer.children).toEqual([layerVisible, layerHidden]);
-      layer.removeChild('foo');
-      expect(layer.children).toEqual([layerHidden]);
-      expect(spy).toHaveBeenCalledTimes(1);
-      expect(spy).toHaveBeenCalledWith({
-        type: 'change:children',
-        target: layer,
-      });
-    });
-  });
-
   describe('#getFeatureInfoAtCoordinate()', () => {
     test('return an empty fetaureInfo object and display an error message', (done) => {
       // eslint-disable-next-line no-console
@@ -575,7 +471,7 @@ describe('Layer', () => {
   });
 
   describe('#unHover()', () => {
-    test.only('removes function from clickCallbacks array', () => {
+    test('removes function from clickCallbacks array', () => {
       const layer = new Layer({
         name: 'Layer',
         olLayer,

package/common/mixins/SearchMixin.js

@@ -125,7 +125,7 @@ const SearchMixin = (Base) =>
         display: 'none',
         position: 'absolute',
         right: '0',
-        padding: '10px',
+        padding: '0 10px',
         fontSize: '200%',
         cursor: 'pointer',
       });