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

package/mapbox/layers/TrackerLayer.js

@@ -1,282 +0,0 @@
-import { fromLonLat } from 'ol/proj';
-import { unByKey } from 'ol/Observable';
-import { getWidth, getHeight } from 'ol/extent';
-import transformRotate from '@turf/transform-rotate';
-import { point } from '@turf/helpers';
-import Layer from './Layer';
-import mixin from '../../common/mixins/TrackerLayerMixin';
-import { getSourceCoordinates, getMercatorResolution } from '../utils';
-/**
- * Responsible for loading tracker data.
- *
- * @classproperty {mapboxgl.Map} map - The map where the layer is displayed.
- * @extends {Layer}
- * @implements {TrackerLayerInterface}
- */
-class TrackerLayer extends mixin(Layer) {
-  constructor(options = {}) {
-    super({
-      ...options,
-    });
-
-    /** @ignore */
-    this.onMove = this.onMove.bind(this);
-
-    /** @ignore */
-    this.onMoveEnd = this.onMoveEnd.bind(this);
-
-    /** @ignore */
-    this.onZoomEnd = this.onZoomEnd.bind(this);
-
-    /** @ignore */
-    this.onVisibilityChange = this.onVisibilityChange.bind(this);
-  }
-
-  /**
-   * Initialize the layer.
-   *
-   * @param {mapboxgl.Map} map A [mapbox Map](https://docs.mapbox.com/mapbox-gl-js/api/map/).
-   * @param {string} beforeId Layer's id before which we want to add the new layer.
-   * @override
-   */
-  init(map, beforeId) {
-    if (!map) {
-      return;
-    }
-
-    const canvas = map.getCanvas();
-
-    super.init(map, {
-      width: canvas.width / this.pixelRatio,
-      height: canvas.height / this.pixelRatio,
-    });
-
-    const source = {
-      type: 'canvas',
-      canvas: this.tracker.canvas,
-      coordinates: getSourceCoordinates(map, this.pixelRatio),
-      // Set to true if the canvas source is animated. If the canvas is static, animate should be set to false to improve performance.
-      animate: true,
-      attribution: this.copyrights && this.copyrights.join(', '),
-    };
-
-    this.beforeId = beforeId;
-    this.layer = {
-      id: this.key,
-      type: 'raster',
-      source: this.key,
-      layout: {
-        visibility: this.visible ? 'visible' : 'none',
-      },
-      paint: {
-        'raster-opacity': 1,
-        'raster-fade-duration': 0,
-        'raster-resampling': 'nearest', // important otherwise it looks blurry
-      },
-    };
-    map.addSource(this.key, source);
-    map.addLayer(this.layer, this.beforeId);
-
-    this.listeners = [this.on('change:visible', this.onVisibilityChange)];
-  }
-
-  /**
-   * Remove listeners from the Mapbox Map.
-   */
-  terminate() {
-    if (this.map) {
-      this.listeners.forEach((listener) => {
-        unByKey(listener);
-      });
-      if (this.map.getLayer(this.key)) {
-        this.map.removeLayer(this.key);
-      }
-      if (this.map.getSource(this.key)) {
-        this.map.removeSource(this.key);
-      }
-    }
-    super.terminate();
-  }
-
-  /**
-   * Start updating vehicles position.
-   *
-   * @listens {mapboxgl.map.event:zoomend} Listen to zoom end event.
-   * @listens {mapboxgl.map.event:mousemove} Listen to mousemove end.
-   * @override
-   */
-  start() {
-    super.start();
-
-    this.map.on('move', this.onMove);
-    this.map.on('moveend', this.onMoveEnd);
-    this.map.on('zoomend', this.onZoomEnd);
-  }
-
-  /**
-   * Stop updating vehicles position, and unlisten events.
-   *
-   * @override
-   */
-  stop() {
-    super.stop();
-    if (this.map) {
-      this.map.off('move', this.onMove);
-      this.map.off('moveend', this.onMoveEnd);
-      this.map.off('zoomend', this.onZoomEnd);
-    }
-  }
-
-  /**
-   * Function triggered when the user click the map.
-   * @override
-   */
-  onUserClickCallback(evt) {
-    super.onUserClickCallback({
-      coordinate: fromLonLat(evt.lngLat.toArray()),
-      ...evt,
-    });
-  }
-
-  /**
-   * Function triggered when the user moves the cursor over the map.
-   * @override
-   */
-  onUserMoveCallback(evt) {
-    super.onUserMoveCallback({
-      coordinate: fromLonLat(evt.lngLat.toArray()),
-      ...evt,
-    });
-  }
-
-  /**
-   * Render the trajectories using current map's size, resolution and rotation.
-   * @param {boolean} noInterpolate if true, renders the vehicles without interpolating theirs positions.
-   * @overrides
-   */
-  renderTrajectories(noInterpolate) {
-    const { width, height } = this.map.getCanvas();
-    const center = this.map.getCenter();
-
-    // We use turf here to have good transform.
-    const leftBottom = this.map.unproject({
-      x: 0,
-      y: height / this.pixelRatio,
-    }); // southWest
-    const rightTop = this.map.unproject({ x: width / this.pixelRatio, y: 0 }); // north east
-
-    const coord0 = transformRotate(
-      point([leftBottom.lng, leftBottom.lat]),
-      -this.map.getBearing(),
-      {
-        pivot: [center.lng, center.lat],
-      },
-    ).geometry.coordinates;
-    const coord1 = transformRotate(
-      point([rightTop.lng, rightTop.lat]),
-      -this.map.getBearing(),
-      {
-        pivot: [center.lng, center.lat],
-      },
-    ).geometry.coordinates;
-
-    const bounds = [...fromLonLat(coord0), ...fromLonLat(coord1)];
-    const xResolution = getWidth(bounds) / (width / this.pixelRatio);
-    const yResolution = getHeight(bounds) / (height / this.pixelRatio);
-    const res = Math.max(xResolution, yResolution);
-
-    // Coordinate of trajectories are in mercator so we have to pass the proper resolution and center in mercator.
-    const viewState = {
-      size: [width / this.pixelRatio, height / this.pixelRatio],
-      center: fromLonLat([center.lng, center.lat]),
-      extent: bounds,
-      resolution: res,
-      zoom: this.map.getZoom(),
-      rotation: -(this.map.getBearing() * Math.PI) / 180,
-      pixelRatio: this.pixelRatio,
-    };
-
-    super.renderTrajectories(viewState, noInterpolate);
-  }
-
-  /**
-   * Return the delay in ms before the next rendering.
-   */
-  getRefreshTimeInMs() {
-    return super.getRefreshTimeInMs(this.map.getZoom());
-  }
-
-  /**
-   * Returns an array of vehicles located at the given coordinate.
-   *
-   * @param {Array<number>} coordinate
-   * @param {number} nb Number of vehicles to return;
-   * @return {Array<ol/Feature~Feature>} Array of vehicle.
-   * @override
-   */
-  getVehiclesAtCoordinate(coordinate, nb) {
-    const resolution = getMercatorResolution(this.map);
-    return super.getVehiclesAtCoordinate(coordinate, resolution, nb);
-  }
-
-  getFeatureInfoAtCoordinate(coordinate, options = {}) {
-    const resolution = getMercatorResolution(this.map);
-    return super.getFeatureInfoAtCoordinate(coordinate, {
-      resolution,
-      ...options,
-    });
-  }
-
-  onVisibilityChange() {
-    if (this.visible && !this.map.getLayer(this.key)) {
-      this.map.addLayer(this.layer, this.beforeId);
-    } else if (this.map.getLayer(this.key)) {
-      this.map.removeLayer(this.key);
-    }
-    // We can't use setLayoutProperty it triggers an error probably a bug in mapbox
-    // this.map.setLayoutProperty(
-    //   this.key,
-    //   'visibilty',
-    //   this.visible ? 'visible' : 'none',
-    // );
-  }
-
-  /**
-   * Callback on 'move' event.
-   *
-   * @private
-   */
-  onMove() {
-    const extent = getSourceCoordinates(this.map, this.pixelRatio);
-    const source = this.map.getSource(this.key);
-    if (source) {
-      source.setCoordinates(extent);
-    }
-    this.renderTrajectories();
-  }
-
-  /**
-   * Callback on 'moveend' event.
-   *
-   * @private
-   */
-  // eslint-disable-next-line class-methods-use-this
-  onMoveEnd() {
-    this.renderTrajectories();
-  }
-
-  /**
-   * Update the cursor style when hovering a vehicle.
-   *
-   * @private
-   * @override
-   */
-  onFeatureHover(features, layer, coordinate) {
-    super.onFeatureHover(features, layer, coordinate);
-    this.map.getCanvasContainer().style.cursor = features.length
-      ? 'pointer'
-      : 'auto';
-  }
-}
-
-export default TrackerLayer;

package/mapbox/layers/TrackerLayer.test.js

@@ -1,68 +0,0 @@
-import maplibre from 'maplibre-gl';
-import { toLonLat } from 'ol/proj';
-import TrackerLayer from './TrackerLayer';
-
-let layer;
-let onClick;
-
-describe('TrackerLayer', () => {
-  beforeEach(() => {
-    onClick = jest.fn();
-    layer = new TrackerLayer({
-      onClick,
-    });
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(TrackerLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-
-    const mapElement = document.createElement('div');
-    const { style } = mapElement;
-    style.position = 'absolute';
-    style.left = '0px';
-    style.top = '0px';
-    style.width = '400px';
-    style.height = '400px';
-    mapElement.setAttribute('id', 'map');
-    document.body.appendChild(mapElement);
-
-    layer.init(
-      new maplibre.Map({
-        container: document.getElementById('map'),
-        style: `path/to/style`,
-        center: toLonLat([831634, 5933959]),
-        zoom: 9,
-      }),
-    );
-
-    expect(spy).toHaveBeenCalledTimes(1);
-    document.body.removeChild(mapElement);
-  });
-
-  test('#onClick', () => {
-    const f = () => {};
-    layer.onClick(f);
-    expect(layer.clickCallbacks[1]).toBe(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-    layer.onClick(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test('#unClick', () => {
-    const foo = () => {};
-    const bar = () => {};
-    layer.onClick(foo);
-    layer.onClick(bar);
-    expect(layer.clickCallbacks[1]).toBe(foo);
-    expect(layer.clickCallbacks[2]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(3);
-    layer.unClick(foo);
-    expect(layer.clickCallbacks[1]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-});

package/mapbox/layers/TrajservLayer.js

@@ -1,114 +0,0 @@
-import { fromLonLat } from 'ol/proj';
-import { buffer, getWidth } from 'ol/extent';
-import { unByKey } from 'ol/Observable';
-import TrackerLayer from './TrackerLayer';
-import mixin from '../../common/mixins/TrajservLayerMixin';
-
-/**
- * Responsible for loading and display data from a Trajserv service.
- *
- * @example
- * import { TrajservLayer } from 'mobility-toolbox-js/mapbox';
- *
- * const layer = new TrajservLayer({
- *   url: 'https://api.geops.io/tracker/v1',
- *   apiKey: [yourApiKey],
- * });
- *
- * @see <a href="/api/class/src/api/trajserv/TrajservAPI%20js~TrajservAPI%20html">TrajservAPI</a>
- * @see <a href="/example/mapbox-tracker">Mapbox tracker example</a>
- *
- * @extends {TrackerLayer}
- * @implements {TrajservLayerInterface}
- * @deprecated
- */
-class TrajservLayer extends mixin(TrackerLayer) {
-  constructor(options = {}) {
-    super({ ...options });
-    this.onMove = this.onMove.bind(this);
-    this.onMoveEnd = this.onMoveEnd.bind(this);
-    this.onVisibilityChange = this.onVisibilityChange.bind(this);
-  }
-
-  /**
-   * Remove the mapbox layer and the mapbox source.
-   *
-   * @override
-   */
-  terminate() {
-    if (this.map) {
-      this.listeners.forEach((listener) => {
-        unByKey(listener);
-      });
-      this.map.removeLayer(this.key);
-      this.map.removeSource(this.key);
-    }
-    super.terminate();
-  }
-
-  start() {
-    if (!this.map) {
-      return;
-    }
-    super.start();
-    this.map.on('move', this.onMove);
-    this.map.on('moveend', this.onMoveEnd);
-  }
-
-  stop() {
-    if (this.map) {
-      this.map.off('move', this.onMove);
-      this.map.off('moveend', this.onMoveEnd);
-    }
-    super.stop();
-  }
-
-  /**
-   * Callback on 'moveend' event.
-   * @private
-   */
-  onMoveEnd() {
-    this.updateTrajectories();
-    if (this.selectedVehicleId && this.journeyId) {
-      this.highlightTrajectory();
-    }
-  }
-
-  /**
-   * Returns the URL parameters.
-   * @param {Object} extraParams Extra parameters
-   * @return {Object}
-   * @private
-   */
-  getParams(extraParams = {}) {
-    const bounds = this.map.getBounds().toArray();
-    const southWest = fromLonLat(bounds[0]);
-    const northEast = fromLonLat(bounds[1]);
-    const ext = [...southWest, ...northEast];
-    const bbox = buffer(ext, getWidth(ext) / 10).join(',');
-    const zoom = this.map.getZoom();
-
-    return super.getParams({
-      ...extraParams,
-      bbox,
-      s: zoom < 10 ? 1 : 0,
-      z: zoom,
-    });
-  }
-
-  /**
-   * Draw the trajectory as a line with points for each stop.
-   *
-   * @param {Array} stationsCoords Array of station coordinates in EPSG:4326.
-   * @param {Array<ol/coordinate~Coordinate>} lineCoords A list of coordinates in EPSG:3857.
-   * @param {string} color The color of the line.
-   * @private
-   */
-  // eslint-disable-next-line no-unused-vars,class-methods-use-this
-  drawFullTrajectory(stationsCoords, lineCoords, color) {
-    // eslint-disable-next-line no-console
-    console.log('to be implemented');
-  }
-}
-
-export default TrajservLayer;

package/mapbox/layers/TrajservLayer.test.js

@@ -1,90 +0,0 @@
-import maplibre from 'maplibre-gl';
-import fetch from 'jest-fetch-mock';
-import { toLonLat } from 'ol/proj';
-import TrajservLayer from './TrajservLayer';
-
-let layer;
-let onClick;
-
-describe('TrajservLayer', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    onClick = jest.fn();
-    layer = new TrajservLayer({
-      apiKey: 'foo',
-      onClick,
-    });
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(TrajservLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-
-    fetch.mockResponseOnce(JSON.stringify(global.fetchTrajectoriesResponse));
-
-    const mapElement = document.createElement('div');
-    const { style } = mapElement;
-    style.position = 'absolute';
-    style.left = '0px';
-    style.top = '0px';
-    style.width = '400px';
-    style.height = '400px';
-    mapElement.setAttribute('id', 'map');
-    document.body.appendChild(mapElement);
-
-    layer.init(
-      new maplibre.Map({
-        container: document.getElementById('map'),
-        style: `path/to/style`,
-        center: toLonLat([831634, 5933959]),
-        zoom: 9,
-      }),
-    );
-
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-
-  test('#onClick', () => {
-    const f = () => {};
-    layer.onClick(f);
-    expect(layer.clickCallbacks[1]).toBe(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-    layer.onClick(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test('#unClick', () => {
-    const foo = () => {};
-    const bar = () => {};
-    layer.onClick(foo);
-    layer.onClick(bar);
-    expect(layer.clickCallbacks[1]).toBe(foo);
-    expect(layer.clickCallbacks[2]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(3);
-    layer.unClick(foo);
-    expect(layer.clickCallbacks[1]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test('should create a default api with default url.', () => {
-    expect(layer).toBeInstanceOf(TrajservLayer);
-    expect(layer.api.url).toBe('https://api.geops.io/tracker/v1');
-    expect(layer.api.apiKey).toBe('foo');
-  });
-
-  test('should create an api with custom url and apiKey.', () => {
-    const layr = new TrajservLayer({
-      url: 'https:foo.ch',
-      apiKey: 'bar',
-    });
-    expect(layr).toBeInstanceOf(TrajservLayer);
-    expect(layr.api.url).toBe('https:foo.ch');
-    expect(layr.api.apiKey).toBe('bar');
-  });
-});

package/ol/Map.js

@@ -1,109 +0,0 @@
-import OLMap from 'ol/Map';
-import { defaults as defaultControls } from 'ol/control';
-import Layer from './layers/Layer';
-import mixin from '../common/mixins/MapMixin';
-import CopyrightControl from './controls/CopyrightControl';
-
-/**
- * An OpenLayers map for handling mobility layers and controls.
- *
- * @example
- * import { Map } from 'mobility-toolbox-js/ol';
- *
- * const map = new Map({
- *   target: 'map',
- *   view: new View({
- *     center: [0, 0],
- *     zoom: 1,
- *  }),
- * });
- *
- * @see <a href="/example/ol-map">Map example</a>
- *
- * @extends {ol/Map~Map}
- */
-class Map extends mixin(OLMap) {
-  /**
-   * Constructor.
-   *
-   * @param {Object} options See [ol/Map~Map](https://openlayers.org/en/latest/apidoc/module-ol_Map-Map.html) options documentation.
-   * @param {Array<Layer|ol/layer/Layer~Layer>} [options.layers] Array of layers.
-   */
-  constructor(options = {}) {
-    super({
-      controls: [
-        ...defaultControls({ attribution: false }).getArray(),
-        new CopyrightControl(),
-      ],
-      ...options,
-    });
-  }
-
-  /**
-   * Get the HTML element containing the map.
-   *
-   * @return {HTMLElement} The HTML element of the container.
-   */
-  getContainer() {
-    return this.getTargetElement();
-  }
-
-  /**
-   * Adds a layer to the map.
-   * @param {Layer|ol/layer/Layer~Layer} layer The layer to add.
-   */
-  addLayer(layer) {
-    if (layer instanceof Layer) {
-      // layer is an mobility layer
-      layer.init(this);
-      this.mobilityLayers.push(layer);
-
-      if (layer.olLayer) {
-        super.addLayer(layer.olLayer);
-      }
-
-      this.dispatchEvent({
-        type: 'change:mobilityLayers',
-        target: this,
-      });
-    } else {
-      // layer is an OpenLayer layer
-      super.addLayer(layer);
-    }
-  }
-
-  /**
-   * Removes a given layer from the map.
-   * @param {Layer|ol/layer/Layer~Layer} layer The layer to remove.
-   */
-  removeLayer(layer) {
-    if (layer instanceof Layer) {
-      layer.terminate();
-      this.mobilityLayers = this.mobilityLayers.filter((l) => l !== layer);
-      if (layer.olLayer) {
-        super.removeLayer(layer);
-      }
-    } else {
-      // layer is an OpenLayer layer
-      super.removeLayer(layer);
-    }
-  }
-
-  /**
-   * Adds a given control to the map.
-   * @param {Control|ol/control/Control~Control} control The control to add.
-   */
-  addControl(control) {
-    super.addControl(control);
-  }
-
-  /**
-   * Removes a given control to the map.
-   * @param {Control|ol/control/Control~Control} control The control to remove.
-   */
-  removeControl(control) {
-    super.removeControl(control);
-  }
-}
-
-export default Map;

package/ol/Map.test.js

@@ -1,34 +0,0 @@
-import VectorLayer from 'ol/layer/Vector';
-import VectorSource from 'ol/source/Vector';
-import Map from './Map';
-import Layer from './layers/Layer';
-
-const olLayer = new VectorLayer({ source: new VectorSource() });
-
-describe('Map', () => {
-  let map;
-
-  beforeEach(() => {
-    map = new Map({ target: document.body });
-  });
-
-  test('should init layer on add.', () => {
-    const layer = new Layer({ name: 'Layer', olLayer });
-    const spy = jest.spyOn(layer, 'init');
-    map.addLayer(layer);
-    expect(spy).toHaveBeenCalledTimes(1);
-    expect(map.getLayers().getLength()).toBe(1);
-  });
-
-  test('should terminate layer on remove.', () => {
-    const layer = new Layer({ name: 'Layer', olLayer });
-    const spy = jest.spyOn(layer, 'terminate');
-    map.addLayer(layer);
-    expect(map.getLayers().getLength()).toBe(1);
-    expect(spy).toHaveBeenCalledTimes(1);
-    map.removeLayer(layer);
-    expect(spy).toHaveBeenCalledTimes(2);
-    expect(layer.visible).toBe(true);
-    expect(map.getLayers().getLength()).toBe(1);
-  });
-});