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

package/esdoc/plugins/dynamic-property-plugin/Plugin.js

@@ -1,50 +0,0 @@
-/**
- * This plugin a adds new tag `@classproperty`.
- */
-const path = require('path');
-const cheerio = require('cheerio');
-const ParamParser = require('esdoc/out/src/Parser/ParamParser').default;
-const DocBuilder = require('esdoc-publish-html-plugin/out/src/Builder/DocBuilder')
-  .default;
-
-const newTagName = '@classproperty';
-
-class Plugin {
-  // eslint-disable-next-line class-methods-use-this
-  onHandleDocs(evt) {
-    evt.data.docs
-      .filter((doc) => {
-        return (
-          doc.kind === 'class' &&
-          doc.unknown &&
-          doc.unknown.filter((item) => item.tagName === newTagName).length
-        );
-      })
-      .forEach((doc) => {
-        doc.unknown.forEach((item) => {
-          if (item.tagName === newTagName) {
-            const matched = item.tagValue.match(
-              /^\{(.*?)\} ([\w0-9_]+) -?(.*)$/m,
-            );
-            const type = matched[1];
-            const name = matched[2];
-            const desc = matched[3].trim();
-            // console.log(item, type, name, desc, doc.longname);
-            evt.data.docs.push({
-              kind: 'member',
-              name,
-              memberof: doc.longname,
-              static: false,
-              longname: `${doc.longname}#${name}`,
-              access: 'public',
-              description: desc,
-              lineNumber: doc.lineNumber,
-              type: { types: [...type.split('|')] },
-            });
-          }
-        });
-      });
-  }
-}
-
-module.exports = new Plugin();

package/esdoc/plugins/externals-plugin/Plugin.js

@@ -1,45 +0,0 @@
-/**
- * This plugin creates custom buildin externals definitions so they don't appear in the sidebar of the doc.
- * This plugin is inspired by esdoc-external-webapi-plugin, see https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-external-webapi-plugin
- */
-const fs = require('fs-extra');
-const path = require('path');
-
-class Plugin {
-  onHandleConfig(evt) {
-    this.config = evt.data.config;
-    this.options = evt.data.option || {};
-    if (!('enable' in this.options)) this.options.enable = true;
-
-    if (!this.options.enable) return;
-
-    const srcPath = path.resolve(__dirname, 'externals.js');
-    const outPath = path.resolve(this.config.source, '.externals.js');
-
-    fs.copySync(srcPath, outPath);
-  }
-
-  onHandleDocs(evt) {
-    const { enable } = this.options;
-    const { source } = this.config;
-    if (!enable) return;
-
-    const outPath = path.resolve(source, '.externals.js');
-    fs.removeSync(outPath);
-
-    const name = `${path.basename(path.resolve(source))}/.externals.js`;
-
-    evt.data.docs.forEach((doc) => {
-      if (doc.kind === 'external' && doc.memberof === name)
-        // eslint-disable-next-line no-param-reassign
-        doc.builtinExternal = true;
-    });
-
-    const docIndex = evt.data.docs.findIndex(
-      (doc) => doc.kind === 'file' && doc.name === name,
-    );
-    evt.data.docs.splice(docIndex, 1);
-  }
-}
-
-module.exports = new Plugin();

package/esdoc/plugins/externals-plugin/externals.js

@@ -1,96 +0,0 @@
-/**
- * @external {ol/Observable~Observable} https://openlayers.org/en/latest/apidoc/module-ol_Observable-Observable.html
- */
-/**
- * @external {ol/Map~Map} https://openlayers.org/en/latest/apidoc/module-ol_Map-Map.html
- */
-/**
- * @external {ol/coordinate~Coordinate} https://openlayers.org/en/latest/apidoc/module-ol_coordinate.html#~Coordinate
- */
-/**
- * @external {ol/layer/Layer~Layer} https://openlayers.org/en/latest/apidoc/module-ol_layer_Layer-Layer.html
- */
-/**
- * @external {ol/Feature~Feature} https://openlayers.org/en/latest/apidoc/module-ol_Feature-Feature.html
- */
-/**
- * @external {ol/geom/Point~Point} https://openlayers.org/en/latest/apidoc/module-ol_geom_Point-Point.html
- */
-/**
- * @external {ol/geom/LineString~LineString} https://openlayers.org/en/latest/apidoc/module-ol_geom_LineString-LineString.html
- */
-/**
- * @external {ol/geom/MultiLineString~MultiLineString} https://openlayers.org/en/latest/apidoc/module-ol_geom_MultiLineString-MultiLineString.html
- */
-/**
- * @external {ol/format/GeoJSON} https://openlayers.org/en/latest/apidoc/module-ol_format_GeoJSON-GeoJSON.html
- */
-/**
- * @external {ol/MapEvent~MapEvent} https://openlayers.org/en/latest/apidoc/module-ol_MapEvent-MapEvent.html
- */
-/**
- * @external {ol/events~EventsKey} https://openlayers.org/en/latest/apidoc/module-ol_events.html#~EventsKey
- */
-/**
- * @external {ol/Object~BaseObject} https://openlayers.org/en/latest/apidoc/module-ol_Object-BaseObject.html
- */
-/**
- * @external {mapboxgl.Map} https://docs.mapbox.com/mapbox-gl-js/api/map/
- */
-/**
- * @external {mapboxgl.Layer} https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/
- */
-/**
- * @external {mapboxgl.map.event:mousemove} https://docs.mapbox.com/mapbox-gl-js/api/map/#map.event:mousemove
- */
-/**
- * @external {mapboxgl.map.event:zoomend} https://docs.mapbox.com/mapbox-gl-js/api/map/#map.event:zoomend
- */
-/**
- * @external {mapboxgl.MapMouseEvent} https://docs.mapbox.com/mapbox-gl-js/api/events/#mapmouseevent
- */
-/**
- * @external {mapboxgl.styleLayer} https://docs.mapbox.com/help/glossary/layer/
- */
-/**
- * @external {mapboxgl.filter} https://docs.mapbox.com/help/glossary/filter/
- */
-/**
- * @external {mapboxgl.IControl} https://docs.mapbox.com/mapbox-gl-js/api/markers/#icontrol
- */
-/**
- * @external {mapboxgl.position} https://docs.mapbox.com/mapbox-gl-js/api/map/#map#addcontrol
- */
-/**
- * @external {AbortController} https://developer.mozilla.org/fr/docs/Web/API/AbortController
- */
-/**
- * @external {GeoJSONPoint} https://tools.ietf.org/html/rfc7946#section-3.1.2
- */
-/**
- * @external {GeoJSONFeature} https://tools.ietf.org/html/rfc7946#section-3.2
- */
-/**
- * @external {Canvas} https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API
- */
-/**
- * @external {CanvasRenderingContext2D} https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D
- */
-/**
- * @external {GetTrajectoriesParams} https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectories
- */
-/**
- * @external {GetTrajectoryByIdParams} https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectorybyid
- */
-/**
- * @external {TrajservTrajectory} https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#model-single_trajectory
- */
-/**
- * @external {GetTrajectoryStationsParams} https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajstations
- */
-/**
- * @external {StopsSearchParams} https://developer.geops.io/apis/5dcbd702a256d90001cf1361/#/default/get_
- */
-/**
- * @external {HTMLElement} https://developer.mozilla.org/fr/docs/Web/API/HTMLElement
- */

package/global-setup.js

@@ -1,3 +0,0 @@
-module.exports = async () => {
-  process.env.TZ = 'UTC';
-};

package/indexweb.html

@@ -1,49 +0,0 @@
-<html>
-  <head>
-    <title>Parcel Sandbox</title>
-    <meta charset="UTF-8" />
-    <link
-      rel="stylesheet"
-      href="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.14.1/css/ol.css"
-      type="text/css"
-    />
-    <script src="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.14.1/build/ol.js"></script>
-    <script src="./build/mbt.js"></script>
-  </head>
-
-  <body>
-    <div id="app">
-      <div id="map" style="width: 600px; height: 600px"></div>
-    </div>
-
-    <script>
-      const map = new ol.Map({
-        target: 'map',
-        view: new ol.View({
-          center: [831634, 5933959],
-          zoom: 13,
-        }),
-        controls: [],
-      });
-
-      const layer = new mbt.ol.MaplibreLayer({
-        url: 'https://maps.geops.io/styles/travic_v2/style.json',
-        apiKey: '5cc87b12d7c5370001c1d6554840ecb89d2743d2b0aad0588b8ba7eb',
-      });
-      layer.init(map);
-
-      const tracker = new mbt.ol.TralisLayer({
-        url: 'wss://api.geops.io/tracker-ws/v1/',
-        apiKey: '5cc87b12d7c5370001c1d6554840ecb89d2743d2b0aad0588b8ba7eb',
-      });
-      tracker.init(map);
-
-      tracker.onClick(([feature]) => {
-        if (feature) {
-          // eslint-disable-next-line no-console
-          console.log(feature.getProperties());
-        }
-      });
-    </script>
-  </body>
-</html>

package/jest.config.js

@@ -1,5 +0,0 @@
-const neutrino = require('neutrino');
-
-process.env.NODE_ENV = process.env.NODE_ENV || 'test';
-
-module.exports = neutrino().jest();

package/pull_request_template.md

@@ -1,17 +0,0 @@
-# How to
-
-<!--  Please provide a test link and quick description how to see the change -->
-
-# Others
-
-<!-- Thanks for the PR! Feel free to add or remove items if there are not necessary. -->
-
-- [ ] It's not a hack or at least an unauthorized hack :).
-- [ ] The images added are optimized.
-- [ ] Everything in ticket description has been fixed.
-- [ ] The author of the MR has made its own review before assigning the reviewer.
-- [ ] The title means something for a human being and follows the [conventional commits](https://www.conventionalcommits.org/) specification.
-- [ ] The title contains [WIP] if it's necessary.
-- [ ] Labels applied. if it's a release? a hotfix?
-- [ ] The new class' members & methods are well documented
-- [ ] Tests added.

package/renovate.json

@@ -1,4 +0,0 @@
-{
-  "extends": ["config:js-lib", "schedule:monthly"],
-  "assignees": ["@friedjoff"]
-}

package/scripts/read-pkg-json.js

@@ -1,22 +0,0 @@
-/* eslint-disable no-console */
-const pjson = require('../package.json');
-
-const { peerDependencies } = pjson;
-
-const packageKeys = Object.keys(peerDependencies);
-
-const arg = process.argv[2];
-
-if (arg === 'add') {
-  console.log(
-    `yarn add ${packageKeys
-      .map((p) => `${p}@${peerDependencies[p]}`)
-      .join(' ')}`,
-  );
-} else if (arg === 'remove') {
-  console.log(
-    `rm -rf ${packageKeys.map((p) => `node_modules/${p}`).join(' ')}`,
-  );
-} else {
-  console.log('echo "wrong argument."');
-}

package/src/api/index.js

@@ -1,3 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export { default as StopsAPI } from './stops/StopsAPI';
-export { default as TralisAPI, TralisModes } from './tralis/TralisAPI';

package/src/api/routing/RoutingAPI.js

@@ -1,44 +0,0 @@
-import API from '../../common/api/api';
-
-/**
- * Access to the [Routing service](https://developer.geops.io/apis/routing).
- *
- * @example
- * import { RoutingAPI } from 'mobility-toolbox-js/api';
- *
- * const api = new RoutingAPI({
- *   apiKey: [yourApiKey]
- * });
- *
- */
-class RoutingAPI extends API {
-  /**
-   * Constructor
-   *
-   * @param {Object} options Options.
-   * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   * @param {string} options.mot Mean of transport on load.
-   */
-  constructor(options = {}) {
-    super({
-      ...options,
-      url: options.url || 'https://api.geops.io/routing/v1/',
-    });
-  }
-
-  /**
-   * Route.
-   *
-   * @param {RoutingSearchParams} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
-   */
-  route(params, abortController = new AbortController()) {
-    return this.fetch('', params, {
-      signal: abortController.signal,
-    });
-  }
-}
-
-export default RoutingAPI;

package/src/api/routing/RoutingAPI.test.js

@@ -1,41 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import RoutingAPI from './RoutingAPI';
-
-let api;
-
-describe('RoutingAPI', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new RoutingAPI({ apiKey: 'apiKey' });
-  });
-
-  describe('#route', () => {
-    test('should success', (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.fetchRouteResponse));
-
-      return api
-        .route({
-          mot: 'bus',
-          via: '47.3739194713294,8.538274823394632|47.37595378493421,8.537490375951839',
-        })
-        .then((featureCollection) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/routing/v1/?key=apiKey&mot=bus&via=47.3739194713294%2C8.538274823394632%7C47.37595378493421%2C8.537490375951839',
-          );
-
-          // Correct search result (for bus mot)
-          expect(featureCollection.features[0].geometry.type).toEqual(
-            'LineString',
-          );
-          expect(featureCollection.features[0].properties.lines).toBeDefined();
-          expect(
-            featureCollection.features[0].properties.station_to,
-          ).toBeDefined();
-          done();
-        });
-    });
-  });
-});

package/src/api/stops/StopsAPI.js

@@ -1,41 +0,0 @@
-import API from '../../common/api/api';
-
-/**
- * Access to the [Stops service](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
- *
- * @example
- * import { StopsAPI } from 'mobility-toolbox-js/api';
- *
- * const api = new StopsAPI({
- *   url: 'https://api.geops.io/stops/v1/',
- *   apiKey: [yourApiKey]
- * });
- *
- */
-class StopsAPI extends API {
-  /**
-   * Constructor
-   *
-   * @param {Object} options Options.
-   * @param {string} [options.url='https://api.geops.io/stops/v1/'] Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   */
-  constructor(options = {}) {
-    super({ url: 'https://api.geops.io/stops/v1/', ...options });
-  }
-
-  /**
-   * Search.
-   *
-   * @param {StopsSearchParams} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
-   */
-  search(params, abortController = {}) {
-    return this.fetch('', params, {
-      signal: abortController.signal,
-    }).then((featureCollection) => featureCollection.features);
-  }
-}
-
-export default StopsAPI;

package/src/api/stops/StopsAPI.test.js

@@ -1,34 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import StopsAPI from './StopsAPI';
-
-let api;
-
-describe('StopsAPI', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new StopsAPI({ apiKey: 'apiKey' });
-  });
-
-  describe('#search', () => {
-    test('should success', (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.stopsSearchResponse));
-
-      return api
-        .search({
-          q: 'Bern',
-        })
-        .then((features) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/stops/v1/?key=apiKey&q=Bern',
-          );
-
-          // Correct search result
-          expect(features[0].properties.name).toEqual('Bern');
-          done();
-        });
-    });
-  });
-});