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

package/api/trajserv/TrajservAPI.js

@@ -1,71 +0,0 @@
-import {
-  translateTrajCollResponse,
-  translateTrajStationsResp,
-} from './TrajservAPIUtils';
-import API from '../../common/api/api';
-
-/**
- * Access to the [Realtime service](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/).
- *
- * @example
- * import { TrajservAPI } from 'mobility-toolbox-js/api';
- *
- * const api = new TrajservAPI({
- *   url: 'https://api.geops.io/tracker/v1',
- *   apiKey: [yourApiKey]
- * });
- *
- */
-class TrajservAPI extends API {
-  /**
-   * Constructor
-   *
-   * @param {Object} options Options.
-   * @param {string} [options.url='https://api.geops.io/tracker/v1'] Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   */
-  constructor(options = {}) {
-    super({ url: 'https://api.geops.io/tracker/v1', ...options });
-  }
-
-  /**
-   * Fetch a trajectory by id.
-   *
-   * @param {GetTrajectoryByIdParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectorybyid).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<TrajservTrajectory>} A trajectory.
-   */
-  fetchTrajectoryById(params, abortController = {}) {
-    return this.fetch(`/trajectorybyid`, params, {
-      signal: abortController.signal,
-    });
-  }
-
-  /**
-   * Fetch trajectories.
-   *
-   * @param {GetTrajectoriesParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectory_collection).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<Array<Trajectory>>} A list of trajectories.
-   */
-  fetchTrajectories(params, abortController = {}) {
-    return this.fetch(`/trajectory_collection`, params, {
-      signal: abortController.signal,
-    }).then((data) => translateTrajCollResponse(data.features));
-  }
-
-  /**
-   * Fetch stations informations about a trajectory.
-   *
-   * @param {GetTrajectoryStationsParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajstations).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<Array<TrajectoryStation>>} A list of stations.
-   */
-  fetchTrajectoryStations(params, abortController = {}) {
-    return this.fetch(`/trajstations`, params, {
-      signal: abortController.signal,
-    }).then((data) => translateTrajStationsResp(data));
-  }
-}
-
-export default TrajservAPI;

package/api/trajserv/TrajservAPI.test.js

@@ -1,171 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import TrajservAPI from './TrajservAPI';
-
-let api;
-
-describe('TrajservAPI', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new TrajservAPI({ apiKey: 'apiKey' });
-  });
-
-  describe('#fetchTrajectoryById', () => {
-    test('should success', () => {
-      fetch.mockResponseOnce(
-        JSON.stringify(global.fetchTrajectoryByIdResponse),
-      );
-
-      return api
-        .fetchTrajectoryById({
-          a: '1',
-          bbox: '917830.8141233932,5949421.787168904,926771.7516620635,5953300.375201735',
-          btime: '5:54:7.880',
-          cd: '1',
-          date: '20200701',
-          etime: '5:54:24.582',
-          fl: '1',
-          id: '16617:3',
-          nm: '1',
-          rid: '1',
-          s: '0',
-          time: '5:54:8.103',
-          z: '15.248670953423606',
-        })
-        .then((response) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/tracker/v1/trajectorybyid?a=1&bbox=917830.8141233932%2C5949421.787168904%2C926771.7516620635%2C5953300.375201735&btime=5%3A54%3A7.880&cd=1&date=20200701&etime=5%3A54%3A24.582&fl=1&id=16617%3A3&key=apiKey&nm=1&rid=1&s=0&time=5%3A54%3A8.103&z=15.248670953423606',
-          );
-
-          // Correct search result
-          expect(response.rid).toEqual('21120.000011.101:1');
-        });
-    });
-
-    test('should trigger error message', () => {
-      // Mock console statement
-      const consoleOutput = [];
-      // eslint-disable-next-line no-console
-      console.warn = (message, err) =>
-        consoleOutput.push([message, err.toString()]);
-
-      fetch.mockResponseOnce('invalid json');
-
-      return api
-        .fetchTrajectoryById({
-          attr_det: '1',
-          bbox: '922972.5439121567,5951167.694705085,923812.5648796591,5951532.096677226',
-          btime: '5:18:31.766',
-          etime: '5:18:41.967',
-          date: '20200701',
-          rid: '1',
-          a: '1',
-          cd: '1',
-          nm: '1',
-          fl: '1',
-          s: '0',
-          z: '18.66059982835272',
-        })
-        .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',
-          );
-        });
-    });
-  });
-
-  describe('#fetchTrajectories', () => {
-    test('should success', () => {
-      fetch.mockResponseOnce(JSON.stringify(global.fetchTrajectoriesResponse));
-
-      return api
-        .fetchTrajectories({
-          attr_det: '1',
-          bbox: '922972.5439121567,5951167.694705085,923812.5648796591,5951532.096677226',
-          btime: '5:18:31.766',
-          etime: '5:18:41.967',
-          date: '20200701',
-          rid: '1',
-          a: '1',
-          cd: '1',
-          nm: '1',
-          fl: '1',
-          s: '0',
-          z: '18.66059982835272',
-        })
-        .then((features) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/tracker/v1/trajectory_collection?a=1&attr_det=1&bbox=922972.5439121567%2C5951167.694705085%2C923812.5648796591%2C5951532.096677226&btime=5%3A18%3A31.766&cd=1&date=20200701&etime=5%3A18%3A41.967&fl=1&key=apiKey&nm=1&rid=1&s=0&z=18.66059982835272',
-          );
-
-          // Correct search result
-          expect(features[0].id).toEqual(4150092);
-        });
-    });
-
-    test('should display error message if the transformation fails', () => {
-      fetch.mockResponseOnce(JSON.stringify({ foo: 'bar' }));
-
-      return api
-        .fetchTrajectories({
-          attr_det: '1',
-          bbox: '922972.5439121567,5951167.694705085,923812.5648796591,5951532.096677226',
-          btime: '5:18:31.766',
-          etime: '5:18:41.967',
-          date: '20200701',
-          rid: '1',
-          a: '1',
-          cd: '1',
-          nm: '1',
-          fl: '1',
-          s: '0',
-          z: '18.66059982835272',
-        })
-        .catch((err) => {
-          expect(err.name).toEqual('TypeError');
-          expect(err.message).toEqual(
-            "Cannot read property 'length' of undefined",
-          );
-        });
-    });
-  });
-
-  describe('#fetchTrajectoryStations', () => {
-    test('should success', () => {
-      fetch.mockResponseOnce(
-        JSON.stringify(global.fetchTrajectoryStationsResponse),
-      );
-
-      return api
-        .fetchTrajectoryStations({
-          a: '1',
-          bbox: '1059098.4179109985,5917420.543096403,1063534.5137495932,5919344.9260996',
-          btime: '6:17:22.722',
-          cd: '1',
-          date: '20200701',
-          etime: '6:17:33.526',
-          fl: '1',
-          id: '1714251',
-          key: 'apiKey',
-          nm: '1',
-          rid: '1',
-          s: '0',
-          time: '6:17:23.34',
-          z: '16.259806538265146',
-        })
-        .then((response) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/tracker/v1/trajstations?a=1&bbox=1059098.4179109985%2C5917420.543096403%2C1063534.5137495932%2C5919344.9260996&btime=6%3A17%3A22.722&cd=1&date=20200701&etime=6%3A17%3A33.526&fl=1&id=1714251&key=apiKey&nm=1&rid=1&s=0&time=6%3A17%3A23.34&z=16.259806538265146',
-          );
-
-          // Correct search result
-          expect(response.routeIdentifier).toEqual('01716.000072.001:1716');
-        });
-    });
-  });
-});

package/api/trajserv/TrajservAPIUtils.js

@@ -1,191 +0,0 @@
-import { LineString } from 'ol/geom';
-
-/**
- * Translate the response date object into a readable object.
- * @return {Date[]}
- * @ignore
- */
-const translateDates = (dates = []) => {
-  const newDates = [];
-
-  for (let i = 0; i < dates.length; i += 1) {
-    const { d: day, m: month, y: year } = dates[i];
-    newDates.push({
-      day,
-      month,
-      year,
-    });
-  }
-  return newDates;
-};
-
-/**
- * Translate the trajstations response into a readable object.
- * @return {Object} returns a readable object
- * @private
- */
-export const translateTrajStationsResp = (data) => {
-  const newData = { ...data };
-
-  // MAke sure all property exists.
-  ['a', 'f', 'tt'].forEach((prop) => {
-    if (!newData[prop]) {
-      newData[prop] = {};
-    }
-  });
-
-  const {
-    id,
-    hs: destination,
-    t: vehicleType,
-    ln: longName,
-    sn: shortName,
-    wa: wheelchairAccessible,
-    ba: bicyclesAllowed,
-    rt: realTime,
-    fid: feedsId,
-    rid: routeIdentifier,
-    c: bgColor,
-    tc: datacolor,
-    a: { n: operator, u: operatorUrl, tz: operatorTimeZone },
-    f: { n: publisher, u: publisherUrl, tz: publisherTimeZone },
-    tt: {
-      n: dateNotOperatingDays,
-      p: dateAdditionalOperatingDays,
-      t: operatingPeriod,
-    },
-    sts: dataStations,
-  } = newData;
-
-  const notOperatingDays = translateDates(dateNotOperatingDays);
-  const additionalOperatingDays = translateDates(dateAdditionalOperatingDays);
-  const backgroundColor = bgColor && `#${bgColor}`;
-  const color = datacolor && `#${datacolor}`;
-
-  const stations = [];
-  for (let i = 0; i < (dataStations || []).length; i += 1) {
-    const {
-      sid: stationId,
-      n: stationName,
-      p: coordinates,
-      at: arrivalTime,
-      dt: departureTime,
-      ap: arrivalDate,
-      dp: departureDate,
-      ad: arrivalDelay,
-      dd: departureDelay,
-      dot: noDropOff,
-      put: noPickUp,
-      c: cancelled,
-      wa: stWheelchairAccessible,
-    } = dataStations[i];
-
-    stations.push({
-      stationId,
-      stationName,
-      coordinates,
-      arrivalTime: arrivalTime !== -1 ? arrivalDate * 1000 : null,
-      departureTime: departureTime !== -1 ? departureDate * 1000 : null,
-      arrivalDelay,
-      departureDelay,
-      noDropOff: !!noDropOff,
-      noPickUp: !!noPickUp,
-      cancelled: !!cancelled,
-      wheelchairAccessible: !!stWheelchairAccessible,
-    });
-  }
-
-  return {
-    id,
-    destination,
-    backgroundColor,
-    color,
-    vehicleType,
-    routeIdentifier,
-    longName,
-    shortName,
-    stations,
-    wheelchairAccessible: !!wheelchairAccessible,
-    bicyclesAllowed: !!bicyclesAllowed,
-    realTime,
-    feedsId,
-    operatingInformations: {
-      operatingPeriod,
-      notOperatingDays,
-      additionalOperatingDays,
-    },
-    operator,
-    operatorUrl,
-    operatorTimeZone,
-    publisher,
-    publisherUrl,
-    publisherTimeZone,
-  };
-};
-
-/**
- * Translate the trajectory_collection response into a js usable object.
- * @return {Array} returns an array of trajectories.
- * @ignore
- */
-export const translateTrajCollResponse = (features = []) => {
-  const trajectories = [];
-  for (let i = 0; i < features.length; i += 1) {
-    const traj = features[i];
-    const geometry = new LineString(traj.geometry.coordinates);
-    const {
-      ID: id,
-      ProductIdentifier: type,
-      PublishedLineName: name,
-      RouteIdentifier: routeIdentifier,
-      DirectionText: directionText,
-      Operator: operator,
-      OperatorURL: operatorUrl,
-      Publisher: publisher,
-      PublisherURL: publisherUrl,
-      License: license,
-      LicenseUrl: licenseUrl,
-      LicenseNote: licenseNote,
-      Color: color,
-      JourneyIdentifier: journeyIdentifier,
-      RealtimeAvailable: realtimeAvailable,
-      OperatorProvidesRealtime: operatorProvidesRealtime,
-      DayOfOperation: dayOfOperation,
-      Delay: delay,
-      TimeIntervals: timeIntervals,
-      TextColor: textColor,
-      Cancelled: cancelled,
-    } = traj.properties;
-
-    trajectories.push({
-      id,
-      type,
-      name,
-      routeIdentifier,
-      directionText,
-      operator,
-      operatorUrl,
-      publisher,
-      publisherUrl,
-      license,
-      licenseUrl,
-      licenseNote,
-      journeyIdentifier,
-      realtimeAvailable,
-      operatorProvidesRealtime,
-      dayOfOperation,
-      delay,
-      timeIntervals,
-      color: color && `#${color}`,
-      textColor: textColor && `#${textColor}`,
-      geometry,
-      cancelled,
-    });
-  }
-  return trajectories;
-};
-
-export default {
-  translateTrajCollResponse,
-  translateTrajStationsResp,
-};

package/api/trajserv/TrajservAPIUtils.test.js

@@ -1,40 +0,0 @@
-import { translateTrajStationsResp } from './TrajservAPIUtils';
-
-describe('TrajservAPIUtils', () => {
-  describe('#translateTrajStationsResp', () => {
-    test("should success even if data doesn't have all properties set", () => {
-      const empty = {
-        backgroundColor: undefined,
-        bicyclesAllowed: false,
-        color: undefined,
-        destination: undefined,
-        feedsId: undefined,
-        id: undefined,
-        longName: undefined,
-        operatingInformations: {
-          additionalOperatingDays: [],
-          notOperatingDays: [],
-          operatingPeriod: undefined,
-        },
-        operator: undefined,
-        operatorTimeZone: undefined,
-        operatorUrl: undefined,
-        publisher: undefined,
-        publisherTimeZone: undefined,
-        publisherUrl: undefined,
-        realTime: undefined,
-        routeIdentifier: undefined,
-        shortName: undefined,
-        stations: [],
-        vehicleType: undefined,
-        wheelchairAccessible: false,
-      };
-      let a = translateTrajStationsResp({});
-      expect(a).toEqual(empty);
-      a = translateTrajStationsResp(null);
-      expect(a).toEqual(empty);
-      a = translateTrajStationsResp(undefined);
-      expect(a).toEqual(empty);
-    });
-  });
-});

package/api/trajserv/typedefs.js

@@ -1,44 +0,0 @@
-/**
- * @typedef {Object} OperatingInformations
- * @property {string} operatingPeriod
- * @property {string} notOperatingDays
- * @property {string} additionalOperatingDays
- *
- */
-
-/**
- * @typedef {Object} TrajservTrajectory
- * @property {string} id
- * @property {string} type
- * @property {string} name
- * @property {string} color
- * @property {string} textColor
- * @property {string} delay
- * @property {string} operator
- * @property {string} journeyIdentifier
- * @property {string} routeIdentifier
- * @property {string} timeIntervals
- * @property {ol/geom/LineString~LineString} geometry  A LineString in [EPSG:4326](http://epsg.io/4326).
- * @property {string} cancelled
- */
-
-/**
- * @typedef {Object} TrajectoryStation
- * @property {string} id
- * @property {string} destination
- * @property {string} backgroundColor
- * @property {string} color
- * @property {string} vehicleType
- * @property {string} routeIdentifier
- * @property {string} longName
- * @property {string} shortName
- * @property {string} stations
- * @property {string} wheelchairAccessible
- * @property {string} bicyclesAllowed
- * @property {string} realTime
- * @property {string} feedsId
- * @property {OperatingInformations} operatingInformations
- * @property {string} operator
- * @property {string} operatorUrl
- * @property {string} operatorTimeZone
- */

package/common/mixins/MapMixin.js

@@ -1,103 +0,0 @@
-/* eslint-disable no-empty-function */
-/* eslint-disable no-useless-constructor */
-/* eslint-disable class-methods-use-this */
-// eslint-disable-next-line max-classes-per-file
-import Control from '../controls/Control';
-
-/**
- * Map interface.
- */
-export class MapInterface {
-  /**
-   * Constructor.
-   *
-   * @param {Object} options Map options
-   * @param {Array<Layer>} [options.layers] Custom layers of the map.
-   * @param {Array<Control>} [options.controls] Custom controls of the map.
-   */
-  // eslint-disable-next-line no-unused-vars
-  constructor(options = {}) {}
-
-  /**
-   * Returns the HTML element of the map.
-   * @return {HTMLElement}
-   */
-  getContainer() {}
-
-  /**
-   * Returns a list of mobility layers.
-   * @return {Layer[]}
-   */
-  getMobilityLayers() {}
-
-  /**
-   * Returns a list of mobility controls.
-   * @return {Control[]}
-   */
-  getMobilityControls() {}
-}
-
-/**
- * Mixin for MapInterface.
- * @ignore
- */
-const MapMixin = (Base) =>
-  class extends Base {
-    constructor(options = {}) {
-      super({ ...options, layers: [], controls: [] });
-      this.mobilityLayers = [];
-      this.mobilityControls = [];
-
-      // Add controls
-      (options.controls || []).forEach((control) => {
-        this.addControl(control);
-      });
-
-      // Add layers
-      (options.layers || []).forEach((layer) => {
-        this.addLayer(layer);
-      });
-    }
-
-    getMobilityLayers() {
-      return this.mobilityLayers;
-    }
-
-    getMobilityControls() {
-      return this.mobilityControls;
-    }
-
-    addMobilityControl(control) {
-      this.mobilityControls.push(control);
-      // eslint-disable-next-line no-param-reassign
-      control.map = this;
-    }
-
-    removeMobilityControl(control) {
-      // eslint-disable-next-line no-param-reassign
-      control.map = null;
-      this.mobilityControls = this.mobilityControls.filter(
-        (c) => c !== control,
-      );
-    }
-
-    /** Documentation in inherited classes */
-    addControl(control, position) {
-      if (control instanceof Control) {
-        this.addMobilityControl(control);
-      } else {
-        super.addControl(control, position);
-      }
-    }
-
-    /** Documentation in inherited classes */
-    removeControl(control) {
-      if (control instanceof Control) {
-        this.removeMobilityControl(control);
-      } else {
-        super.removeControl(control);
-      }
-    }
-  };
-
-export default MapMixin;