mobility-toolbox-js 2.0.0 → 2.0.1-beta.13

package/api/tralis/TralisAPI.test.js

@@ -1,75 +0,0 @@
-import { TralisAPI, TralisModes } from '..';
-
-describe('TralisAPI', () => {
-  let tralisAPI;
-  let get;
-
-  beforeEach(() => {
-    get = jest.fn((params, cb) => {
-      cb({ content: 'content' });
-    });
-    tralisAPI = new TralisAPI();
-    tralisAPI.conn = {
-      get,
-    };
-  });
-
-  describe('#getFullTrajectory() calls fullTrajectory channel', () => {
-    test('without parameters', (done) => {
-      tralisAPI.getFullTrajectory().then(() => {
-        expect(get.mock.calls.length).toBe(1);
-        expect(get.mock.calls[0][0]).toEqual({
-          channel: 'full_trajectory',
-        });
-        done();
-      });
-    });
-
-    [null, TralisModes.TOPOGRAPHIC].forEach((mode) => {
-      describe(`using mode ${mode}`, () => {
-        test('using id', (done) => {
-          tralisAPI.getFullTrajectory('foo', mode).then(() => {
-            expect(get.mock.calls.length).toBe(1);
-            expect(get.mock.calls[0][0]).toEqual({
-              channel: 'full_trajectory_foo',
-            });
-            done();
-          });
-        });
-
-        test('using id and generalizationLevel param', (done) => {
-          tralisAPI.getFullTrajectory('foo', mode, 5).then(() => {
-            expect(get.mock.calls.length).toBe(1);
-            expect(get.mock.calls[0][0]).toEqual({
-              channel: 'full_trajectory_foo_gen5',
-            });
-            done();
-          });
-        });
-      });
-    });
-
-    describe('using schematic mode ', () => {
-      test('using id', (done) => {
-        tralisAPI.getFullTrajectory('foo', TralisModes.SCHEMATIC).then(() => {
-          expect(get.mock.calls.length).toBe(1);
-          expect(get.mock.calls[0][0]).toEqual({
-            channel: 'full_trajectory_schematic_foo',
-          });
-          done();
-        });
-      });
-      test("doesn't use generalizationLevel param", (done) => {
-        tralisAPI
-          .getFullTrajectory('foo', TralisModes.SCHEMATIC, 10)
-          .then(() => {
-            expect(get.mock.calls.length).toBe(1);
-            expect(get.mock.calls[0][0]).toEqual({
-              channel: 'full_trajectory_schematic_foo',
-            });
-            done();
-          });
-      });
-    });
-  });
-});

package/api/tralis/WebSocketConnector.js

@@ -1,338 +0,0 @@
-/**
- * Class used to facilitate connection to a WebSocket and
- * also to manage properly messages send to the WebSocket.
- * This class must not contain any specific implementation.
- *
- * @private
- */
-class WebSocketConnector {
-  constructor() {
-    this.defineProperties();
-  }
-
-  defineProperties() {
-    Object.defineProperties(this, {
-      closed: {
-        get: () =>
-          !!(
-            this.websocket &&
-            this.websocket.readyState === this.websocket.CLOSED
-          ),
-      },
-      closing: {
-        get: () =>
-          !!(
-            this.websocket &&
-            this.websocket.readyState === this.websocket.CLOSING
-          ),
-      },
-      connecting: {
-        get: () =>
-          !!(
-            this.websocket &&
-            this.websocket.readyState === this.websocket.CONNECTING
-          ),
-      },
-      open: {
-        get: () =>
-          !!(
-            this.websocket && this.websocket.readyState === this.websocket.OPEN
-          ),
-      },
-      /**
-       * Array of message to send on open.
-       * @type {Array<string>}
-       * @private
-       */
-      messagesOnOpen: {
-        value: [],
-        writable: true,
-      },
-      /**
-       * Array of subscriptions.
-       * @type {Array<subscription>}
-       * @private
-       */
-      subscriptions: {
-        value: [],
-        writable: true,
-      },
-
-      /**
-       * List of channels subscribed.
-       * @type {Array<subscription>}
-       * @private
-       */
-      subscribed: {
-        value: {},
-        writable: true,
-      },
-    });
-  }
-
-  /**
-   * Get the websocket request string.
-   *
-   * @param {string} method Request mehtod {GET, SUB}.
-   * @param {Object} params Request parameters.
-   * @param {string} params.channel Channel name
-   * @param {string} [params.args] Request arguments
-   * @param {Number} [params.id] Request identifier
-   * @return {string} request string
-   * @private
-   */
-  static getRequestString(method, params) {
-    let reqStr = `${method} ${params.channel}`;
-    reqStr += params.args ? ` ${params.args}` : '';
-    reqStr += params.id ? ` ${params.id}` : '';
-    return reqStr.trim();
-  }
-
-  /**
-   * (Re)connect the websocket.
-   *
-   * @param {strin} url Websocket url.
-   * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
-   * @private
-   */
-  connect(url, onOpen = () => {}) {
-    if (this.websocket && !this.closed) {
-      this.websocket.close();
-    }
-
-    /** @ignore */
-    this.websocket = new WebSocket(url);
-
-    if (!this.open) {
-      this.websocket.addEventListener('open', () => {
-        onOpen();
-        this.subscribePreviousSubscriptions();
-      });
-    } else {
-      onOpen();
-      this.subscribePreviousSubscriptions();
-    }
-  }
-
-  /**
-   * Close the websocket definitively.
-   *
-   * @private
-   */
-  close() {
-    if (this.websocket) {
-      this.websocket.onclose = null;
-      this.websocket.close();
-      this.websocket = null;
-      this.messagesOnOpen = [];
-    }
-  }
-
-  /**
-   * Sends a message to the websocket.
-   *
-   * @param {message} message Message to send.
-   * @private
-   */
-  send(message) {
-    if (!this.websocket) {
-      return;
-    }
-    const send = () => {
-      this.websocket.send(message);
-    };
-    if (!this.open) {
-      // This 'if' avoid sending 2 identical BBOX message on open,
-      if (!this.messagesOnOpen.includes(message)) {
-        this.messagesOnOpen.push(message);
-        this.websocket.addEventListener('open', () => {
-          this.messagesOnOpen = [];
-          send();
-        });
-        this.websocket.addEventListener('close', () => {
-          this.messagesOnOpen = [];
-        });
-      }
-    } else if (!this.messagesOnOpen.includes(message)) {
-      send();
-    }
-  }
-
-  /**
-   * Listen to websocket messages.
-   *
-   * @param {Object} params Parameters for the websocket get request
-   * @param {function} cb callback on listen
-   * @param {function} errorCb Callback on error
-   * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
-   * @private
-   */
-  listen(params, cb, errorCb) {
-    // Remove the previous identical callback
-    this.unlisten(params, cb);
-
-    const onMessage = (evt) => {
-      let data = {};
-      try {
-        data = JSON.parse(evt.data);
-      } catch (err) {
-        // eslint-disable-next-line no-console
-        console.error('WebSocket: unable to parse JSON data', err, evt.data);
-      }
-      let source = params.channel;
-      source += params.args ? ` ${params.args}` : '';
-
-      // Buffer channel message return a list of other channels to propagate to proper callbacks.
-      const contents = data.source === 'buffer' ? data.content : [data];
-      contents.forEach((content) => {
-        // Because of backend optimization, the last content is null.
-        if (
-          content?.source === source &&
-          (!params.id || params.id === data.client_reference)
-        ) {
-          cb(content);
-        }
-      });
-    };
-
-    if (this.websocket) {
-      this.websocket.addEventListener('message', onMessage);
-
-      if (errorCb) {
-        this.websocket.addEventListener('error', errorCb);
-        this.websocket.addEventListener('close', errorCb);
-      }
-    }
-
-    return { onMessageCb: onMessage, onErrorCb: errorCb };
-  }
-
-  /**
-   * Unlisten websocket messages.
-   *
-   * @param {Object} params Parameters for the websocket get request.
-   * @param {function} cb Callback used when listen.
-   * @private
-   */
-  unlisten(params, cb) {
-    if (!this.websocket) {
-      return;
-    }
-    this.subscriptions
-      .filter(
-        (s) => s.params.channel === params.channel && (!cb || s.cb === cb),
-      )
-      .forEach(({ onMessageCb, onErrorCb }) => {
-        if (this.websocket) {
-          this.websocket.removeEventListener('message', onMessageCb);
-          if (onErrorCb) {
-            this.websocket.removeEventListener('error', onErrorCb);
-            this.websocket.removeEventListener('close', onErrorCb);
-          }
-        }
-      });
-  }
-
-  /**
-   * Sends a get request to the websocket.
-   *
-   * @param {Object} params Parameters for the websocket get request
-   * @param {function} cb callback on listen
-   * @param {function} errorCb Callback on error
-   * @private
-   */
-  get(params, cb, errorCb) {
-    const reqStr = WebSocketConnector.getRequestString('GET', params);
-    this.send(reqStr);
-    this.listen(params, cb, errorCb);
-  }
-
-  /**
-   * Subscribe to a given channel.
-   *
-   * @param {Object} params Parameters for the websocket get request
-   * @param {function} cb callback on listen
-   * @param {function} errorCb Callback on error
-   * @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
-   * @private
-   */
-  subscribe(params, cb, errorCb, quiet = false) {
-    const { onMessageCb, onErrorCb } = this.listen(params, cb, errorCb);
-    const reqStr = WebSocketConnector.getRequestString('', params);
-
-    const index = this.subscriptions.findIndex(
-      (subcr) => params.channel === subcr.params.channel && cb === subcr.cb,
-    );
-    const newSubscr = { params, cb, errorCb, onMessageCb, onErrorCb, quiet };
-    if (index > -1) {
-      this.subscriptions[index] = newSubscr;
-    } else {
-      this.subscriptions.push(newSubscr);
-    }
-
-    if (!this.subscribed[reqStr]) {
-      if (!newSubscr.quiet) {
-        this.send(`GET ${reqStr}`);
-        this.send(`SUB ${reqStr}`);
-      }
-      this.subscribed[reqStr] = true;
-    }
-  }
-
-  /**
-   * Unsubscribe from a channel.
-   * @param {string} source source to unsubscribe from
-   * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-   * @private
-   */
-  unsubscribe(source, cb) {
-    const toRemove = this.subscriptions.filter(
-      (s) => s.params.channel === source && (!cb || s.cb === cb),
-    );
-
-    toRemove.forEach(({ onMessageCb, onErrorCb }) => {
-      if (this.websocket) {
-        this.websocket.removeEventListener('message', onMessageCb);
-        if (onErrorCb) {
-          this.websocket.removeEventListener('error', onErrorCb);
-          this.websocket.removeEventListener('close', onErrorCb);
-        }
-      }
-    });
-
-    this.subscriptions = this.subscriptions.filter(
-      (s) => s.params.channel !== source || (cb && s.cb !== cb),
-    );
-
-    // If there is no more subscriptions to this channel, and the removed subscriptions didn't register quietly,
-    // we DEL it.
-    if (
-      source &&
-      this.subscribed[source] &&
-      !this.subscriptions.find((s) => s.params.channel === source) &&
-      toRemove.find((subscr) => !subscr.quiet)
-    ) {
-      this.send(`DEL ${source}`);
-      this.subscribed[source] = false;
-    }
-  }
-
-  /**
-   * After an auto reconnection we need to re-subscribe to the channels.
-   */
-  subscribePreviousSubscriptions() {
-    // Before to subscribe previous subscriptions we make sure they
-    // are all defined as unsubscribed, because this code is asynchrone
-    // and a subscription could have been added in between.
-    Object.keys(this.subscribed).forEach((key) => {
-      this.subscribed[key] = false;
-    });
-
-    // Subscribe all previous subscriptions.
-    [...this.subscriptions].forEach((s) => {
-      this.subscribe(s.params, s.cb, s.errorCb, s.quiet);
-    });
-  }
-}
-
-export default WebSocketConnector;

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/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;

package/common/api/api.test.js

@@ -1,68 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import API from './api';
-
-let api;
-
-describe('API', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new API({ url: 'https://foo.ch', apiKey: 'apiKey' });
-  });
-
-  describe('#fetch', () => {
-    test('should success', () => {
-      fetch.mockResponseOnce(JSON.stringify({ foo: 'bar' }));
-
-      return api
-        .fetch('/path', {
-          q: 'Bern',
-          fooUndefined: undefined,
-          fooNull: null,
-          fooEmpty: '',
-        })
-        .then((response) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://foo.ch/path?fooEmpty=&key=apiKey&q=Bern',
-          );
-
-          // Correct search result
-          expect(response).toEqual({ foo: 'bar' });
-        });
-    });
-
-    describe('should display error message', () => {
-      test('reject error', (done) => {
-        fetch.mockRejectOnce(new Error('Fake error message'));
-        return api.fetch().catch((err) => {
-          expect(err.name).toEqual('Error');
-          expect(err.message).toEqual('Fake error message');
-          done();
-        });
-      });
-
-      test('if the response is invalid json', (done) => {
-        fetch.mockResponseOnce('invalid json');
-
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual('FetchError');
-          expect(err.message).toEqual(
-            'invalid json response body at  reason: Unexpected token i in JSON at position 0',
-          );
-          done();
-        });
-      });
-
-      test('if the response contains an error message', (done) => {
-        fetch.mockResponseOnce('{"error":"foo2"}');
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual('Error');
-          expect(err.message).toEqual('foo2');
-          done();
-        });
-      });
-    });
-  });
-});