mobility-toolbox-js 2.0.0-beta.3 → 2.0.0-beta.33

package/api/tralis/WebSocketConnector.test.js

@@ -1,356 +0,0 @@
-import WS from 'jest-websocket-mock';
-import Connector from './WebSocketConnector';
-
-describe('WebSocketConnector', () => {
-  describe('#constructor', () => {
-    let server;
-    let server2;
-
-    beforeEach(() => {
-      server = new WS(`ws://foo:1234`);
-      server2 = new WS(`ws://foo:12345`);
-    });
-
-    afterEach(() => {
-      server.close();
-      server2.close();
-      WS.clean();
-    });
-
-    describe('#constructor', () => {
-      test("doesn't connect.", async () => {
-        const client = new Connector();
-        expect(client.websocket).toBe();
-        expect(client.closed).toBe(false);
-        expect(client.closing).toBe(false);
-        expect(client.connecting).toBe(false);
-        expect(client.open).toBe(false);
-      });
-    });
-
-    describe('#close', () => {
-      test('should close the websocket and clear some property', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        const subsc2 = {
-          params: 'foo',
-          cb: () => {},
-          errorCb: () => {},
-          quiet: false,
-        };
-        client.subscriptions = [subsc2];
-        client.messagesOnOpen = ['GET foo'];
-        client.connect(`ws://foo:1234`);
-        client.websocket.addEventListener = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        client.websocket.close = jest.fn();
-        await server.connected;
-        expect(client.websocket).toBeDefined();
-        expect(client.messagesOnOpen).toEqual(['GET foo']);
-        client.close();
-        expect(client.messagesOnOpen).toEqual([]);
-        expect(client.websocket).toBeNull();
-      });
-    });
-
-    describe('#connect', () => {
-      test('create a new WebSocket.', async () => {
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        client.send('hello');
-        await expect(server).toReceiveMessage('hello');
-        expect(server).toHaveReceivedMessages(['hello']);
-      });
-
-      test('close previous connection.', async () => {
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        expect(client.websocket).toBeDefined();
-        const old = client.websocket;
-        expect(old.readyState).toBe(WebSocket.OPEN);
-        client.connect(`ws://foo:12345`);
-        expect(old.readyState).toBe(WebSocket.CLOSING);
-        expect(client.websocket.readyState).toBe(WebSocket.CONNECTING);
-      });
-
-      test('call onOpen function', async () => {
-        const onOpen = jest.fn();
-        const client = new Connector();
-        client.subscribe = jest.fn();
-        client.connect(`ws://foo:1234`, onOpen);
-        await server.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(onOpen).toHaveBeenCalledTimes(1);
-      });
-
-      test('subscribe previous subscriptions on open (quiet or not)', async () => {
-        const client = new Connector();
-        client.subscribe = jest.fn();
-        client.send = jest.fn();
-        const subsc = {
-          params: 'foo',
-          cb: () => {},
-          errorCb: () => {},
-          quiet: true,
-        };
-        const subsc2 = {
-          params: 'foo',
-          cb: () => {},
-          errorCb: () => {},
-          quiet: false,
-        };
-        client.subscriptions = [subsc, subsc2];
-
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(client.subscribe).toHaveBeenCalledTimes(2);
-        client.subscribe.mockReset();
-
-        client.connect(`ws://foo:12345`);
-        await server2.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(client.subscribe).toHaveBeenCalledTimes(2);
-        expect(client.subscribe).toHaveBeenCalledWith(
-          subsc.params,
-          subsc.cb,
-          subsc.errorCb,
-          subsc.quiet,
-        );
-      });
-
-      test('send GET and SUB for not quiet previous subscriptions', async () => {
-        const client = new Connector();
-        client.send = jest.fn();
-        const subsc = {
-          params: { channel: 'foo' },
-          cb: () => {},
-          errorCb: () => {},
-          quiet: false,
-        };
-        client.subscriptions = [subsc];
-
-        client.connect(`ws://foo:1234`);
-        client.websocket.addEventListener = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        await server.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(client.send).toHaveBeenCalledTimes(2);
-        expect(client.send.mock.calls[0]).toEqual(['GET foo']);
-        expect(client.send.mock.calls[1]).toEqual(['SUB foo']);
-        client.send.mockReset();
-
-        client.connect(`ws://foo:12345`);
-        client.websocket.addEventListener = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        await server2.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        // not quiet subscriptions will send GET and SUB requests.
-        expect(client.send).toHaveBeenCalledTimes(2);
-        expect(client.send.mock.calls[0]).toEqual(['GET foo']);
-        expect(client.send.mock.calls[1]).toEqual(['SUB foo']);
-      });
-
-      test('doesn\t send GET and SUB for quiet previous subscriptions', async () => {
-        const client = new Connector();
-        client.send = jest.fn();
-        const subsc = {
-          params: { channel: 'foo' },
-          cb: () => {},
-          errorCb: () => {},
-          quiet: true,
-        };
-        client.subscriptions = [subsc];
-
-        client.connect(`ws://foo:1234`);
-        client.websocket.addEventListener = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        await server.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(client.send).toHaveBeenCalledTimes(0);
-        client.send.mockReset();
-
-        client.connect(`ws://foo:12345`);
-        client.websocket.addEventListener = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        await server2.connected;
-        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        // not quiet subscriptions will send GET and SUB requests.
-        expect(client.send).toHaveBeenCalledTimes(0);
-      });
-    });
-
-    describe('#subscribe', () => {
-      test('adds subscription to subscriptions array', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        const params = { channel: 'bar', args: ['baz'], id: 'id' };
-        const cb = jest.fn();
-        const errorCb = jest.fn();
-        client.subscribe(params, cb, errorCb);
-        expect(client.subscriptions.length).toBe(1);
-        expect(client.subscriptions[0].params).toBe(params);
-        expect(client.subscriptions[0].cb).toBe(cb);
-        expect(client.subscriptions[0].errorCb).toBe(errorCb);
-        expect(client.subscriptions[0].quiet).toBe(false);
-
-        const obj = { source: 'bar baz', client_reference: 'id' };
-        server.send(JSON.stringify(obj));
-
-        expect(cb).toHaveBeenCalledTimes(1);
-        expect(cb).toHaveBeenCalledWith(obj);
-      });
-
-      test("doesn't duplicate subscriptions", async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        const params = { channel: 'bar', args: ['baz'], id: 'id' };
-        const cb = jest.fn();
-        const errorCb = jest.fn();
-        client.subscribe(params, cb, errorCb, true);
-        client.subscribe(params, cb, errorCb, true);
-        expect(client.subscriptions.length).toBe(1);
-
-        const obj = { source: 'bar baz', client_reference: 'id' };
-        server.send(JSON.stringify(obj));
-
-        expect(cb).toHaveBeenCalledTimes(1);
-        expect(cb).toHaveBeenCalledWith(obj);
-      });
-
-      test('send GET and SUB requests.', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        client.send = jest.fn();
-        const params = { channel: 'bar', args: ['baz'], id: 'id' };
-        const cb = jest.fn();
-        const errorCb = jest.fn();
-        client.subscribe(params, cb, errorCb);
-        expect(client.send).toHaveBeenCalledTimes(2);
-        expect(client.send).toHaveBeenCalledWith('GET bar baz id');
-        expect(client.send).toHaveBeenCalledWith('SUB bar baz id');
-        client.send.mockRestore();
-      });
-
-      test('should register callback without sending GET and SUB requests (quiet=true).', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        const params = { channel: 'bar', args: ['baz'], id: 'id' };
-        const cb = jest.fn();
-        const errorCb = jest.fn();
-        client.send = jest.fn();
-        client.subscribe(params, cb, errorCb, true);
-        expect(client.subscriptions.length).toBe(1);
-        expect(client.subscriptions[0].params).toBe(params);
-        expect(client.subscriptions[0].cb).toBe(cb);
-        expect(client.subscriptions[0].errorCb).toBe(errorCb);
-        expect(client.subscriptions[0].quiet).toBe(true);
-        expect(client.send).toBeCalledTimes(0);
-        client.send.mockRestore();
-      });
-    });
-
-    describe('#unsubscribe', () => {
-      test('should only unsubscribe the subscription using the good cb', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        const params = { channel: 'foo', id: 'id' };
-        const cb = jest.fn();
-        const cb2 = jest.fn();
-        client.subscribe(params, cb);
-        client.subscribe(params, cb2);
-        expect(client.subscriptions.length).toBe(2);
-        expect(client.subscriptions[0].params).toBe(params);
-        expect(client.subscriptions[0].cb).toBe(cb);
-        expect(client.subscriptions[1].params).toBe(params);
-        expect(client.subscriptions[1].cb).toBe(cb2);
-
-        client.unsubscribe('foo', cb);
-        expect(client.subscriptions.length).toBe(1);
-
-        expect(cb).toHaveBeenCalledTimes(0);
-        expect(cb2).toHaveBeenCalledTimes(0);
-        const obj = { source: 'foo', client_reference: 'id' };
-        server.send(JSON.stringify(obj));
-
-        expect(cb2).toHaveBeenCalledTimes(1);
-        expect(cb).toHaveBeenCalledTimes(0);
-      });
-
-      test('should unsubscribe all subscriptions related to a channel', () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        client.websocket.removeEventListener = jest.fn();
-        client.websocket.addEventListener = jest.fn();
-        const params = { channel: 'foo' };
-        const params2 = { channel: 'bar' };
-        const cb = jest.fn();
-        const cb2 = jest.fn();
-        client.subscribe(params, cb);
-        client.subscribe(params, cb);
-        client.subscribe(params, cb);
-        client.subscribe(params, cb2);
-        client.subscribe(params2, cb2);
-        expect(client.subscriptions.length).toBe(3);
-        expect(client.websocket.removeEventListener).toBeCalledTimes(2);
-        expect(
-          client.websocket.addEventListener.mock.calls.filter(
-            (c) => c[0] === 'message',
-          ).length,
-        ).toBe(5);
-
-        client.unsubscribe('foo');
-        expect(client.subscriptions.length).toBe(1);
-        expect(client.subscriptions[0].params).toBe(params2);
-        expect(client.subscriptions[0].cb).toBe(cb2);
-      });
-
-      test('send DEL when there is no more unquiet subscriptions on the channel', async () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        await server.connected;
-        client.send = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        client.websocket.addEventListener = jest.fn();
-        const params = { channel: 'foo' };
-        const cb = jest.fn();
-        client.subscribe(params, cb);
-        expect(client.send).toHaveBeenCalledWith('GET foo');
-        expect(client.send).toHaveBeenCalledWith('SUB foo');
-
-        client.unsubscribe('foo');
-        expect(client.send).toHaveBeenCalledWith('DEL foo');
-      });
-
-      test("doesn't send DEL when we unsubscribe a quiet channel", () => {
-        // eslint-disable-next-line no-unused-vars
-        const client = new Connector();
-        client.connect(`ws://foo:1234`);
-        client.send = jest.fn();
-        client.websocket.removeEventListener = jest.fn();
-        client.websocket.addEventListener = jest.fn();
-        const params = { channel: 'foo' };
-        const cb = jest.fn();
-        client.subscribe(params, cb, null, true);
-        expect(cb).toHaveBeenCalledTimes(0);
-
-        client.unsubscribe('foo');
-        expect(cb).toHaveBeenCalledTimes(0);
-        client.send.mockRestore();
-      });
-    });
-  });
-});

package/api/tralis/typedefs.js

@@ -1,81 +0,0 @@
-/**
- * @typedef {Object} Departure
- * @property {number} time Timestamp in ms.
- * @property {boolean} no_stop_between
- * @property {number} train_number
- * @property {string[]} to
- * @property {number} ris_aimed_time Timestamp in ms.
- * @property {number} updated_at Timestamp in ms.
- * @property {boolean} new_to
- * @property {number} min_arrival_time Timestamp in ms.
- * @property {string[]} next_stoppoints List of next stops. Like value in at_station_ds100.
- * @property {number} ris_estimated_time Timestamp in ms.
- * @property {NetworkLine} line
- * @property {boolean} has_fzo if true this departure has realtime data.
- * @property {number} train_id
- * @property {string} platform
- * @property {?*} state
- * @property {number} fzo_estimated_time Timestamp in ms.
- * @property {?*} formation
- * @property {?*} no_stop_till
- * @property {number} train_type
- * @property {number} call_id
- * @property {string} created_at Timestamp in ms.
- * @property {string} at_station_ds100
- * @property {number} timediff Timestamp in ms.
- *
- */
-
-/**
- * @typedef {GeoJSONFeature} Station
- * @property {StationProperties} properties Returns the station's properties.
- * @property {GeoJSONPoint} geometry Returns a point.
- */
-
-/**
- * @typedef {Object} StationProperties
- * @property {Transfer[]} transfers
- * @property {boolean} elevatorOutOfOrder
- * @property {number} uic
- * @property {string} name
- * @property {NetworkLine[]} networkLines
- * @property {boolean} hasElevator
- * @property {boolean} hasZOB
- * @property {boolean} hasAccessibility
- * @property {string} type
- */
-
-/**
- * @typedef {Object} NetworkLine
- * @property {number} id Identifier of the line.
- * @property {string} color Color of the line (CSS color string).
- * @property {string} stroke Stroke color of the line (CSS color string).
- * @property {string} name Name of the line.
- * @property {string} text_color  Text color of the line  (CSS color string).
- */
-
-/**
- * @typedef {Object} Transfer
- * @property {string} mot Mode of transportation (ex: U-Bahn).
- * @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
- */
-
-/**
- * @typedef {GeoJSONFeature} StopSequence
- */
-
-/**
- * @typedef {GeoJSONFeature} TralisTrajectory
- */
-
-/**
- * @typedef {GeoJSONFeature} FullTrajectory
- */
-
-/**
- * @typedef {GeoJSONFeature} Vehicle
- */
-
-/**
- * @typedef {GeoJSONFeature} ExtraGeom
- */

package/common/Tracker.js

@@ -1,197 +0,0 @@
-/* eslint-disable no-param-reassign */
-import { compose, apply, create } from 'ol/transform';
-import getVehiclePosition from './utils/getVehiclePosition';
-
-/**
- * Tracker. This class stores and allows to draw trajectories on a canvas.
- * @class
- * @param {Object} options
- * @private
- */
-export default class Tracker {
-  /**
-   * @private
-   */
-  constructor(options) {
-    /**
-     * Function use to style the features displayed.
-     * @type {function}
-     */
-    this.style = options.style;
-
-    // we draw directly on the canvas since openlayers is too slow.
-    /**
-     * HTML <canvas> element.
-     * @type {Canvas}
-     */
-    this.canvas = options.canvas || document.createElement('canvas');
-  }
-
-  /**
-   * Draw all the trajectories available to the canvas.
-   * @param {ViewState} trajectories An array of trajectories.
-   * @param {ViewState} viewState The view state of the map.
-   * @param {boolean} options.hoverVehicleId The id of the vehicle to highlight.
-   * @param {boolean} options.selectedVehicleId The id of the vehicle to select.
-   * @param {boolean} options.noInterpolate If true trajectories are not interpolated but
-   *   drawn at the last known coordinate. Use this for performance optimization
-   *   during map navigation.
-   * @private
-   */
-  renderTrajectories(trajectories, viewState, options) {
-    const {
-      time = Date.now(),
-      size = [],
-      center,
-      resolution,
-      rotation = 0,
-      pixelRatio,
-    } = viewState;
-    const {
-      noInterpolate = false,
-      hoverVehicleId,
-      selectedVehicleId,
-    } = options;
-
-    const { canvas } = this;
-    const context = canvas.getContext('2d');
-    context.clearRect(0, 0, canvas.width, canvas.height);
-
-    const [width, height] = size;
-    if (
-      width &&
-      height &&
-      (canvas.width !== width || canvas.height !== height)
-    ) {
-      [canvas.width, canvas.height] = [width * pixelRatio, height * pixelRatio];
-    }
-
-    const coordinateToPixelTransform = compose(
-      create(),
-      size[0] / 2,
-      size[1] / 2,
-      1 / resolution,
-      -1 / resolution,
-      -rotation,
-      -center[0],
-      -center[1],
-    );
-
-    // Offscreen canvas has not style attribute
-    if (canvas.style) {
-      canvas.style.width = `${canvas.width / pixelRatio}px`;
-      canvas.style.height = `${canvas.height / pixelRatio}px`;
-    }
-
-    let hoverVehicleImg;
-    let hoverVehiclePx;
-    let hoverVehicleWidth;
-    let hoverVehicleHeight;
-    let selectedVehicleImg;
-    let selectedVehiclePx;
-    let selectedVehicleWidth;
-    let selectedVehicleHeight;
-    let nbRendered = 0;
-
-    for (let i = trajectories.length - 1; i >= 0; i -= 1) {
-      const trajectory = trajectories[i];
-
-      // We simplify the trajectory object
-      const { train_id: id, timeOffset } = trajectory.properties;
-      // We set the rotation and the timeFraction of the trajectory (used by tralis).
-      // if rotation === null that seems there is no rotation available.
-      const { coord, rotation: rotationIcon } = getVehiclePosition(
-        time - (timeOffset || 0),
-        trajectory,
-        noInterpolate,
-      );
-
-      // We store  the current vehicle position to the trajectory.
-      trajectories[i].properties.coordinate = coord;
-      trajectories[i].properties.rotation = rotationIcon;
-
-      if (!coord) {
-        // eslint-disable-next-line no-continue
-        continue;
-      }
-
-      let px = apply(coordinateToPixelTransform, [...coord]);
-      if (!px) {
-        // eslint-disable-next-line no-continue
-        continue;
-      }
-
-      px = px.map((p) => p * pixelRatio);
-
-      if (
-        px[0] < 0 ||
-        px[0] > canvas.width ||
-        px[1] < 0 ||
-        px[1] > canvas.height
-      ) {
-        // eslint-disable-next-line no-continue
-        continue;
-      }
-
-      const vehicleImg = this.style(trajectory, viewState, options);
-      if (!vehicleImg) {
-        // eslint-disable-next-line no-continue
-        continue;
-      }
-
-      nbRendered += 1;
-
-      const imgWidth = vehicleImg.width;
-      const imgHeight = vehicleImg.height;
-
-      if (hoverVehicleId !== id && selectedVehicleId !== id) {
-        context.drawImage(
-          vehicleImg,
-          px[0] - imgWidth / 2,
-          px[1] - imgHeight / 2,
-          imgWidth,
-          imgHeight,
-        );
-      }
-
-      if (hoverVehicleId && hoverVehicleId === id) {
-        // Store the canvas to draw it at the end
-        hoverVehicleImg = vehicleImg;
-        hoverVehiclePx = px;
-        hoverVehicleWidth = imgWidth;
-        hoverVehicleHeight = imgHeight;
-      }
-
-      if (selectedVehicleId && selectedVehicleId === id) {
-        // Store the canvas to draw it at the end
-        selectedVehicleImg = vehicleImg;
-        selectedVehiclePx = px;
-        selectedVehicleWidth = imgWidth;
-        selectedVehicleHeight = imgHeight;
-      }
-    }
-
-    if (selectedVehicleImg) {
-      context.drawImage(
-        selectedVehicleImg,
-        selectedVehiclePx[0] - selectedVehicleWidth / 2,
-        selectedVehiclePx[1] - selectedVehicleHeight / 2,
-        selectedVehicleWidth,
-        selectedVehicleHeight,
-      );
-    }
-
-    if (hoverVehicleImg) {
-      context.drawImage(
-        hoverVehicleImg,
-        hoverVehiclePx[0] - hoverVehicleWidth / 2,
-        hoverVehiclePx[1] - hoverVehicleHeight / 2,
-        hoverVehicleWidth,
-        hoverVehicleHeight,
-      );
-    }
-    return {
-      nbTrajectoriesRendered: nbRendered,
-    };
-  }
-}

package/common/api/api.js

@@ -1,64 +0,0 @@
-import qs from 'query-string';
-import BaseObject from 'ol/Object';
-
-/**
- * Common class to access to a geOps api.
- *
- * @example
- * import { API } from 'mobility-toolbox-js/api';
- *
- * const api = new API({
- *   url: [yourUrl],
- *   apiKey: [yourApiKey]
- * });
- *
- * @classproperty {string} url Url of the service.
- * @classproperty {string} apiKey Api key to access the service.
- */
-class API extends BaseObject {
-  constructor(options = {}) {
-    super();
-    /** @ignore */
-    this.url = options.url;
-
-    /** @ignore */
-    this.apiKey = options.apiKey;
-  }
-
-  /**
-   * Append the apiKey before sending the request.
-   * @ignore
-   */
-  fetch(path, params, config) {
-    // Clean requets parameters, removing undefined and null values.
-    const urlParams = { ...(params || {}), key: this.apiKey };
-    const clone = { ...urlParams };
-    Object.keys(urlParams).forEach(
-      (key) =>
-        (clone[key] === undefined || clone[key] === null) && delete clone[key],
-    );
-    if (!this.apiKey) {
-      // eslint-disable-next-line no-console
-      return Promise.reject(
-        new Error(`No apiKey defined for request to ${this.url}`),
-      );
-    }
-    return fetch(
-      `${this.url}${path || ''}?${qs.stringify(clone)}`,
-      config,
-    ).then((response) => {
-      try {
-        return response.json().then((data) => {
-          if (data.error) {
-            throw new Error(data.error);
-          }
-          return data;
-        });
-      } catch (err) {
-        return Promise.reject(new Error(err));
-      }
-    });
-  }
-}
-
-export default API;