mobility-toolbox-js 2.0.0-beta.6 → 2.0.0-beta.62

package/src/ol/layers/TralisLayer.js

@@ -1,359 +0,0 @@
-import GeoJSON from 'ol/format/GeoJSON';
-import { Layer as OLLayer, Group, Vector as VectorLayer } from 'ol/layer';
-import Source from 'ol/source/Source';
-import { composeCssTransform } from 'ol/transform';
-import { Vector as VectorSource } from 'ol/source';
-import Layer from './Layer';
-import mixin from '../../common/mixins/TralisLayerMixin';
-import { fullTrajectoryStyle } from '../styles';
-
-const format = new GeoJSON();
-
-/**
- * Responsible for loading and display data from a Tralis service.
- *
- * @example
- * import { TralisLayer } from 'mobility-toolbox-js/ol';
- *
- * const layer = new TralisLayer({
- *   url: [yourUrl],
- *   apiKey: [yourApiKey],
- * });
- *
- *
- * @see <a href="/api/class/src/api/tralis/TralisAPI%20js~TralisAPI%20html">TralisAPI</a>
- *
- * @extends {Layer}
- * @implements {TralisLayerInterface}
- */
-class TralisLayer extends mixin(Layer) {
-  /**
-   * Constructor.
-   *
-   * @param {Object} options
-   * @private
-   */
-  constructor(options = {}) {
-    // We use a group to be able to add custom vector layer in extended class.
-    // For example TrajservLayer use a vectorLayer to display the complete trajectory.
-    super({
-      ...options,
-    });
-
-    /** @ignore */
-    this.olLayer =
-      options.olLayer ||
-      new Group({
-        layers: [
-          new VectorLayer({
-            source: new VectorSource({ features: [] }),
-            style: options.fullTrajectoryStyle || fullTrajectoryStyle,
-          }),
-          new OLLayer({
-            source: new Source({}),
-            render: (frameState) => {
-              if (!this.tracker || !this.tracker.canvas) {
-                return null;
-              }
-
-              if (!this.container) {
-                this.container = document.createElement('div');
-                this.container.style.position = 'absolute';
-                this.container.style.width = '100%';
-                this.container.style.height = '100%';
-                this.transformContainer = document.createElement('div');
-                this.transformContainer.style.position = 'absolute';
-                this.transformContainer.style.width = '100%';
-                this.transformContainer.style.height = '100%';
-                this.container.appendChild(this.transformContainer);
-                this.tracker.canvas.style.position = 'absolute';
-                this.tracker.canvas.style.top = '0';
-                this.tracker.canvas.style.left = '0';
-                this.tracker.canvas.style.transformOrigin = 'top left';
-                this.transformContainer.appendChild(this.tracker.canvas);
-              }
-
-              if (this.renderedViewState) {
-                const { center, resolution, rotation } = frameState.viewState;
-                const {
-                  center: renderedCenter,
-                  resolution: renderedResolution,
-                  rotation: renderedRotation,
-                } = this.renderedViewState;
-
-                if (renderedResolution / resolution >= 3) {
-                  // Avoid having really big points when zooming fast.
-                  const { canvas } = this.tracker;
-                  const context = canvas.getContext('2d');
-                  context.clearRect(0, 0, canvas.width, canvas.height);
-                } else {
-                  const pixelCenterRendered =
-                    this.map.getPixelFromCoordinate(renderedCenter);
-                  const pixelCenter = this.map.getPixelFromCoordinate(center);
-                  this.transformContainer.style.transform = composeCssTransform(
-                    pixelCenterRendered[0] - pixelCenter[0],
-                    pixelCenterRendered[1] - pixelCenter[1],
-                    renderedResolution / resolution,
-                    renderedResolution / resolution,
-                    rotation - renderedRotation,
-                    0,
-                    0,
-                  );
-                }
-              }
-              return this.container;
-            },
-          }),
-        ],
-      });
-
-    // We store the layer used to highlight the full Trajectory
-    this.vectorLayer = this.olLayer.getLayers().item(0);
-
-    // Options the last render run did happen. If something changes
-    // we have to render again
-    /** @ignore */
-    this.renderState = {
-      center: [0, 0],
-      zoom: null,
-      rotation: 0,
-    };
-  }
-
-  init(map) {
-    super.init(map);
-    if (this.map) {
-      this.olListenersKeys.push(
-        this.map.on(['moveend', 'change:target'], (evt) => {
-          const view = this.map.getView();
-          if (view.getAnimating() || view.getInteracting()) {
-            return;
-          }
-          const zoom = view.getZoom();
-
-          // Update the interval between render updates
-          if (this.currentZoom !== zoom) {
-            this.onZoomEnd(evt);
-          }
-          this.currentZoom = zoom;
-
-          this.onMoveEnd(evt);
-        }),
-      );
-    }
-  }
-
-  /**
-   * Destroy the container of the tracker.
-   */
-  terminate() {
-    super.terminate();
-    this.container = null;
-  }
-
-  /**
-   * Detect in the canvas if there is data to query at a specific coordinate.
-   * @param {ol/coordinate~Coordinate}  coordinate The coordinate to test
-   * @returns
-   */
-  hasFeatureInfoAtCoordinate(coordinate) {
-    if (this.map && this.tracker && this.tracker.canvas) {
-      const context = this.tracker.canvas.getContext('2d');
-      const pixel = this.map.getPixelFromCoordinate(coordinate);
-      return !!context.getImageData(
-        pixel[0] * this.pixelRatio,
-        pixel[1] * this.pixelRatio,
-        1,
-        1,
-      ).data[3];
-    }
-    return false;
-  }
-
-  /**
-   * 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 view = this.map.getView();
-    super.renderTrajectories(
-      {
-        size: this.map.getSize(),
-        center: this.map.getView().getCenter(),
-        extent: view.calculateExtent(),
-        resolution: view.getResolution(),
-        rotation: view.getRotation(),
-        zoom: view.getZoom(),
-        pixelRatio: this.pixelRatio,
-      },
-      noInterpolate,
-    );
-  }
-
-  /**
-   * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
-   * @private
-   * @override
-   */
-  renderTrajectoriesInternal(viewState, noInterpolate) {
-    let isRendered = false;
-
-    const blockRendering =
-      this.map.getView().getAnimating() || this.map.getView().getInteracting();
-
-    // Don't render the map when the map is animating or interacting.
-    isRendered = blockRendering
-      ? false
-      : super.renderTrajectoriesInternal(viewState, noInterpolate);
-
-    // We update the current render state.
-    if (isRendered) {
-      this.renderedViewState = { ...viewState };
-
-      if (this.transformContainer) {
-        this.transformContainer.style.transform = '';
-      }
-    }
-  }
-
-  /**
-   * Return the delay in ms before the next rendering.
-   */
-  getRefreshTimeInMs() {
-    return super.getRefreshTimeInMs(this.map.getView().getZoom());
-  }
-
-  getFeatureInfoAtCoordinate(coordinate, options = {}) {
-    const resolution = this.map.getView().getResolution();
-    return super.getFeatureInfoAtCoordinate(coordinate, {
-      resolution,
-      ...options,
-    });
-  }
-
-  /**
-   * On move end we update the websocket with the new bbox.
-   *
-   * @param {ol/MapEvent~MapEvent} evt Moveend event
-   * @private
-   * @override
-   */
-  onMoveEnd() {
-    if (this.visible && this.isUpdateBboxOnMoveEnd) {
-      this.setBbox();
-    }
-
-    if (
-      this.visible &&
-      this.isUpdateBboxOnMoveEnd &&
-      this.isClickActive &&
-      this.selectedVehicleId
-    ) {
-      this.highlightTrajectory(this.selectedVehicleId);
-    }
-  }
-
-  /**
-   * Function called on moveend event only when the zoom has changed.
-   *
-   * @param {ol/MapEvent~MapEvent} evt Moveend event.
-   * @private
-   * @override
-   */
-  // eslint-disable-next-line no-unused-vars
-  onZoomEnd(evt) {
-    super.onZoomEnd(evt);
-  }
-
-  /**
-   * Update the cursor style when hovering a vehicle.
-   *
-   * @private
-   * @override
-   */
-  onFeatureHover(features, layer, coordinate) {
-    super.onFeatureHover(features, layer, coordinate);
-    this.map.getTargetElement().style.cursor = features.length
-      ? 'pointer'
-      : 'auto';
-  }
-
-  /**
-   * Display the complete trajectory of the vehicle.
-   *
-   * @private
-   * @override
-   */
-  onFeatureClick(features, layer, coordinate) {
-    super.onFeatureClick(features, layer, coordinate);
-    if (!features.length && this.vectorLayer) {
-      this.vectorLayer.getSource().clear();
-    }
-    if (this.selectedVehicleId) {
-      this.highlightTrajectory(this.selectedVehicleId);
-    }
-  }
-
-  /**
-   * Remove the trajectory form the list if necessary.
-   *
-   * @private
-   */
-  purgeTrajectory(trajectory, extent, zoom) {
-    return super.purgeTrajectory(
-      trajectory,
-      extent || this.map.getView().calculateExtent(),
-      zoom || this.map.getView().getZoom(),
-    );
-  }
-
-  /**
-   * Send the current bbox to the websocket
-   *
-   * @private
-   */
-  setBbox(extent, zoom) {
-    let newExtent = extent;
-    let newZoom = zoom;
-    if (!newExtent && this.isUpdateBboxOnMoveEnd) {
-      newExtent = extent || this.map.getView().calculateExtent();
-      newZoom = Math.floor(this.map.getView().getZoom());
-    }
-    super.setBbox(newExtent, newZoom);
-  }
-
-  /**
-   * Highlight the trajectory of journey.
-   * @private
-   */
-  highlightTrajectory(id) {
-    this.api
-      .getFullTrajectory(id, this.mode, this.generalizationLevel)
-      .then((fullTrajectory) => {
-        const vectorSource = this.vectorLayer.getSource();
-        vectorSource.clear();
-
-        if (
-          !fullTrajectory ||
-          !fullTrajectory.features ||
-          !fullTrajectory.features.length
-        ) {
-          return;
-        }
-        const features = format.readFeatures(fullTrajectory);
-        this.vectorLayer.getSource().addFeatures(features);
-      });
-  }
-
-  /**
-   * Create a copy of the TralisLayer.
-   * @param {Object} newOptions Options to override
-   * @return {TralisLayer} A TralisLayer
-   */
-  clone(newOptions) {
-    return new TralisLayer({ ...this.options, ...newOptions });
-  }
-}
-
-export default TralisLayer;

package/src/ol/layers/TralisLayer.test.js

@@ -1,97 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import Map from 'ol/Map';
-import View from 'ol/View';
-import WS from 'jest-websocket-mock';
-import TralisLayer from './TralisLayer';
-
-// create a WS instance, listening on port 1234 on localhost
-let layer;
-let onClick;
-let olMap;
-let server;
-
-describe('TralisLayer', () => {
-  beforeEach(() => {
-    server = new WS('ws://localhost:1234');
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    onClick = jest.fn();
-    layer = new TralisLayer({
-      url: 'ws://localhost:1234',
-      apiKey: 'apiKey',
-      onClick,
-    });
-
-    olMap = new Map({
-      view: new View({
-        center: [831634, 5933959],
-        zoom: 9,
-      }),
-    });
-  });
-
-  afterEach(() => {
-    // ...or gracefully close the connection
-    server.close();
-
-    // The WS class also has a static "clean" method to gracefully close all open connections,
-    // particularly useful to reset the environment between test runs.
-    WS.clean();
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(TralisLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-
-    fetch.mockResponseOnce(JSON.stringify(global.fetchTrajectoriesResponse));
-
-    layer.init(olMap);
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-
-  test('should clone', () => {
-    const clone = layer.clone({ name: 'clone' });
-    expect(clone).not.toBe(layer);
-    expect(clone.name).toBe('clone');
-    expect(clone).toBeInstanceOf(TralisLayer);
-  });
-
-  test('should use the sort function.', () => {
-    const fn = () => true;
-    const laye = new TralisLayer({
-      url: 'ws://localhost:1234',
-      apiKey: 'apiKey',
-      sort: fn,
-    });
-    expect(laye).toBeInstanceOf(TralisLayer);
-    expect(laye.sort).toBe(fn);
-  });
-
-  test('should use filter function.', () => {
-    const fn = () => true;
-    const laye = new TralisLayer({
-      url: 'ws://localhost:1234',
-      apiKey: 'apiKey',
-      filter: fn, // reverse the array
-    });
-    expect(laye).toBeInstanceOf(TralisLayer);
-    expect(laye.filter).toBe(fn);
-  });
-
-  test('should override filter function if operator, tripNumber, regexPublishedLineName is set.', () => {
-    const fn = () => true;
-    const laye = new TralisLayer({
-      url: 'ws://localhost:1234',
-      apiKey: 'apiKey',
-      filter: fn, // reverse the array
-      publishedLineName: '.*',
-    });
-    expect(laye).toBeInstanceOf(TralisLayer);
-    expect(laye.filter).not.toBe(fn);
-  });
-});

package/src/ol/layers/VectorLayer.js

@@ -1,43 +0,0 @@
-import Layer from './Layer';
-
-/**
- * A class use to display vector data.
- *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
- * @extends {Layer}
- */
-class VectorLayer extends Layer {
-  /**
-   * Request feature information for a given coordinate.
-   * @param {ol/coordinate~Coordinate} coordinate the coordinate to request the information at.
-   * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
-   */
-  getFeatureInfoAtCoordinate(coordinate) {
-    let features = [];
-
-    if (this.map) {
-      const pixel = this.map.getPixelFromCoordinate(coordinate);
-      features = this.map.getFeaturesAtPixel(pixel, {
-        layerFilter: (l) => l === this.olLayer,
-        hitTolerance: this.hitTolerance,
-      });
-    }
-
-    return Promise.resolve({
-      features,
-      layer: this,
-      coordinate,
-    });
-  }
-
-  /**
-   * Create a copy of the VectorLayer.
-   * @param {Object} newOptions Options to override
-   * @return {VectorLayer} A VectorLayer
-   */
-  clone(newOptions) {
-    return new VectorLayer({ ...this.options, ...newOptions });
-  }
-}
-
-export default VectorLayer;

package/src/ol/layers/VectorLayer.test.js

@@ -1,98 +0,0 @@
-import OLVectorLayer from 'ol/layer/Vector';
-import VectorSource from 'ol/source/Vector';
-import View from 'ol/View';
-import Feature from 'ol/Feature';
-import Point from 'ol/geom/Point';
-import Map from 'ol/Map';
-import VectorLayer from './VectorLayer';
-
-const feature1 = new Feature({
-  attribute: 'bar',
-  geometry: new Point([500, 500]),
-});
-const olLayer = new OLVectorLayer({
-  source: new VectorSource({
-    features: [
-      feature1,
-      new Feature({
-        attribute: 'foo',
-        geometry: new Point([50, 50]),
-      }),
-    ],
-  }),
-});
-
-let layer;
-let map;
-let onClick;
-
-describe('VectorLayer', () => {
-  beforeEach(() => {
-    onClick = jest.fn();
-    layer = new VectorLayer({
-      name: 'Layer',
-      olLayer,
-      onClick,
-    });
-    map = new Map({
-      view: new View({ resolution: 5 }),
-      target: document.body,
-    });
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(VectorLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-    expect(layer.hitTolerance).toBe(5);
-  });
-
-  test('should add onClick callback.', () => {
-    const onClick2 = jest.fn();
-    layer.onClick(onClick2);
-    expect(layer.clickCallbacks[1]).toBe(onClick2);
-  });
-
-  test('should onClick throw error.', () => {
-    expect(() => {
-      layer.onClick('not of type function');
-    }).toThrow(Error);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-    layer.init();
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-
-  test('should call getFeatureInfoAtCoordinate on click then the callback', async () => {
-    const coordinate = [500, 500];
-    const px = [10, 10];
-    const features = [feature1];
-    const evt = { type: 'singleclick', map, coordinate };
-    const spy = jest.spyOn(layer, 'getFeatureInfoAtCoordinate');
-    const spy2 = jest.spyOn(map, 'getPixelFromCoordinate').mockReturnValue(px);
-    const spy3 = jest
-      .spyOn(map, 'getFeaturesAtPixel')
-      .mockReturnValue(features);
-    layer.init(map);
-    expect(onClick).toHaveBeenCalledTimes(0);
-    await map.dispatchEvent(evt);
-    expect(spy).toHaveBeenCalledTimes(1);
-    expect(spy).toHaveBeenCalledWith(coordinate);
-    expect(spy2).toHaveBeenCalledTimes(1);
-    expect(spy2).toHaveBeenCalledWith(coordinate);
-    expect(spy3).toHaveBeenCalledTimes(1);
-    expect(spy3.mock.calls[0][0]).toBe(px);
-    expect(spy3.mock.calls[0][1].layerFilter(layer.olLayer)).toBe(true);
-    expect(spy3.mock.calls[0][1].layerFilter({})).toBe(false);
-    expect(onClick).toHaveBeenCalledTimes(1);
-    expect(onClick).toHaveBeenCalledWith(features, layer, coordinate);
-  });
-
-  test('should clone', () => {
-    const clone = layer.clone({ name: 'clone' });
-    expect(clone).not.toBe(layer);
-    expect(clone.name).toBe('clone');
-    expect(clone).toBeInstanceOf(VectorLayer);
-  });
-});

package/src/ol/layers/WMSLayer.js

@@ -1,80 +0,0 @@
-import GeoJSON from 'ol/format/GeoJSON';
-import Layer from './Layer';
-
-/**
- * Class use to display a WMS layer.
- *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
- * @extends {Layer}
- */
-class WMSLayer extends Layer {
-  /**
-   * @override
-   */
-  constructor(options = {}) {
-    super(options);
-
-    /** @ignore */
-    this.abortController = new AbortController();
-    /** @ignore */
-    this.format = new GeoJSON();
-  }
-
-  /**
-   * Get features infos' Url.
-   * @param {ol/coordinate~Coordinate} coord
-   * @return {ol/layer/Layer~Layer}
-   */
-  getFeatureInfoUrl(coord) {
-    const projection = this.map.getView().getProjection();
-    const resolution = this.map.getView().getResolution();
-
-    if (this.olLayer.getSource().getFeatureInfoUrl) {
-      return this.olLayer
-        .getSource()
-        .getFeatureInfoUrl(coord, resolution, projection, {
-          info_format: 'application/json',
-          query_layers: this.olLayer.getSource().getParams().layers,
-        });
-    }
-    return false;
-  }
-
-  /**
-   * Request feature information for a given coordinate.
-   * @param {ol/coordinate~Coordinate} coordinate to request the information at.
-   * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
-   */
-  getFeatureInfoAtCoordinate(coordinate) {
-    this.abortController.abort();
-    this.abortController = new AbortController();
-    const { signal } = this.abortController;
-    return fetch(this.getFeatureInfoUrl(coordinate), { signal })
-      .then((resp) => resp.json())
-      .then((r) => r.features)
-      .then((data) => ({
-        layer: this,
-        coordinate,
-        features: data.map((d) => this.format.readFeature(d)),
-      }))
-      .catch(() =>
-        // resolve an empty feature array something fails
-        Promise.resolve({
-          features: [],
-          coordinate,
-          layer: this,
-        }),
-      );
-  }
-
-  /**
-   * Create a copy of the WMSLayer.
-   * @param {Object} newOptions Options to override
-   * @return {WMSLayer} A WMSLayer
-   */
-  clone(newOptions) {
-    return new WMSLayer({ ...this.options, ...newOptions });
-  }
-}
-
-export default WMSLayer;