mobility-toolbox-js 2.3.9-beta.1 → 2.3.10

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

@@ -0,0 +1,50 @@
+/**
+ * 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

@@ -0,0 +1,45 @@
+/**
+ * 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

@@ -0,0 +1,93 @@
+/**
+ * @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 {HTMLElement} https://developer.mozilla.org/fr/docs/Web/API/HTMLElement
+ */

package/esdoc/plugins/optional-chaining-plugin/Plugin.js

@@ -0,0 +1,8 @@
+module.exports = {
+  onHandleCode(event) {
+    // THis is a hack until esdoc supports it.
+    // remove any optional chaining use from the incoming doc
+    // eslint-disable-next-line no-param-reassign
+    event.data.code = event.data.code.replace(/\?\./g, '.');
+  },
+};

package/global-setup.js

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

package/jest.config.js

@@ -0,0 +1,24 @@
+// Sync object
+/** @type {import('@jest/types').Config.InitialOptions} */
+// const config = {
+//   transform: {
+//     '^.+\\.(js|ts)x?$': 'esbuild-jest',
+//   },
+//   testEnvironment: 'jsdom',
+//   transformIgnorePatterns: ['<rootDir>/node_modules/'],
+// };
+// jest.config.js
+// Add any custom config to be passed to Jest
+const config = {
+  // Add more setup options before each test is run
+  // setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+  // if using TypeScript with a baseUrl set to the root directory then you need the below for alias' to work
+  moduleDirectories: ['node_modules', '<rootDir>/'],
+  testEnvironment: 'jsdom',
+  transformIgnorePatterns: [],
+  testMatch: ['<rootDir>/src/**/?(*.)+(spec|test).(j|t)s'],
+  setupFilesAfterEnv: ['<rootDir>/src/setupTests.js'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};
+
+module.exports = config;

package/package.json

@@ -2,7 +2,7 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "2.3.9-beta.1",
+  "version": "2.3.10",
   "homepage": "https://mobility-toolbox-js.geops.io/",
   "module": "index.js",
   "exports": {
@@ -25,10 +25,10 @@
     "ol": "7 - 8"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.23.9",
-    "@babel/preset-typescript": "^7.23.3",
-    "@commitlint/cli": "19.0.0",
-    "@commitlint/config-conventional": "19.0.0",
+    "@babel/preset-env": "^7.24.3",
+    "@babel/preset-typescript": "^7.24.1",
+    "@commitlint/cli": "19.2.1",
+    "@commitlint/config-conventional": "19.1.0",
     "@types/geojson": "7946.0.14",
     "@types/lodash.debounce": "4.0.9",
     "@types/lodash.throttle": "4.1.9",
@@ -36,10 +36,10 @@
     "@types/offscreencanvas": "2019.7.3",
     "@types/topojson": "3.2.6",
     "@types/uuid": "9.0.8",
-    "@typescript-eslint/eslint-plugin": "7.1.0",
-    "@typescript-eslint/parser": "7.1.0",
-    "cypress": "13.6.6",
-    "esbuild": "0.20.1",
+    "@typescript-eslint/eslint-plugin": "7.4.0",
+    "@typescript-eslint/parser": "7.4.0",
+    "cypress": "13.7.1",
+    "esbuild": "0.20.2",
     "esdoc": "1.1.0",
     "esdoc-ecmascript-proposal-plugin": "1.0.0",
     "esdoc-publish-html-plugin": "1.1.2",
@@ -47,13 +47,13 @@
     "esdoc-typescript-plugin": "1.0.1",
     "eslint": "8.57.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-config-airbnb-typescript": "17.1.0",
+    "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-cypress": "2.15.1",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jsx-a11y": "6.8.0",
     "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-react": "7.33.2",
+    "eslint-plugin-react": "7.34.1",
     "fixpack": "4.0.0",
     "husky": "9.0.11",
     "is-ci": "3.0.1",
@@ -66,22 +66,22 @@
     "jest-websocket-mock": "2.5.0",
     "lint-staged": "15.2.2",
     "mapbox-gl": "1.13.2",
-    "maplibre-gl": "4.0.2",
+    "maplibre-gl": "4.1.2",
     "mock-socket": "9.3.1",
-    "next": "14.1.0",
+    "next": "14.1.4",
     "next-transpile-modules": "10.0.1",
-    "ol": "9.0.0",
-    "openapi-typescript": "6.7.4",
+    "ol": "9.1.0",
+    "openapi-typescript": "6.7.5",
     "prettier": "3.2.5",
     "raw-loader": "4.0.2",
     "sort-json": "2.0.1",
     "standard-version": "9.5.0",
     "start-server-and-test": "2.0.3",
-    "stylelint": "16.2.1",
+    "stylelint": "16.3.1",
     "stylelint-config-recommended-scss": "14.0.0",
     "stylelint-config-standard": "36.0.0",
-    "stylelint-scss": "6.1.0",
-    "typescript": "5.3.3"
+    "stylelint-scss": "6.2.1",
+    "typescript": "5.4.3"
   },
   "scripts": {
     "apidoc": "esdoc && cp apidoc/index.json doc/src/components/Esdoc",
@@ -107,7 +107,7 @@
     "lib:dev": "REACT_APP_LIB_MODE=1  webpack --mode development",
     "link2": "cmdToAdd=$(node ./scripts/read-pkg-json.js add) && $cmdToAdd && yarn build && cmdToRemove=$(node ./scripts/read-pkg-json.js remove) && $cmdToRemove && cd build && yarn link",
     "lint": "eslint src/**/*.js src/**/*.ts && stylelint src/**/*.css src/**/*.scss --allow-empty-input",
-    "prepare": "is-ci || husky install",
+    "prepare": "is-ci || husky",
     "publish:beta": "HUSKY=0 yarn release -- --prerelease beta --skip.changelog  && yarn run build && cd build && HUSKY=0 yarn publish --tag beta && git push origin HEAD && git push --tags ",
     "publish:beta:dryrun": "yarn release -- --prerelease beta --dry-run --skip.changelog",
     "publish:public": "yarn release  && yarn run build && cd build && HUSKY=0 yarn publish && git push origin HEAD && git push --tags ",

package/pull_request_template.md

@@ -0,0 +1,17 @@
+# 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/scripts/read-pkg-json.js

@@ -0,0 +1,22 @@
+/* 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/RealtimeAPI.test.js

@@ -0,0 +1,144 @@
+import { RealtimeAPI, RealtimeModes } from '.';
+
+describe('RealtimeAPI', () => {
+  let api;
+  let get;
+
+  describe('using version 1', () => {
+    beforeEach(() => {
+      get = jest.fn((params, cb) => {
+        cb({ content: 'content' });
+      });
+      api = new RealtimeAPI({ version: '1' });
+      api.wsApi = {
+        get,
+      };
+    });
+
+    describe('#getFullTrajectory() calls fullTrajectory channel', () => {
+      test('without parameters', (done) => {
+        api.getFullTrajectory().then(() => {
+          expect(get.mock.calls.length).toBe(1);
+          expect(get.mock.calls[0][0]).toEqual({
+            channel: 'full_trajectory',
+          });
+          done();
+        });
+      });
+
+      [null, RealtimeModes.TOPOGRAPHIC].forEach((mode) => {
+        describe(`using mode ${mode}`, () => {
+          test('using id', (done) => {
+            api.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) => {
+            api.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) => {
+          api.getFullTrajectory('foo', RealtimeModes.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) => {
+          api.getFullTrajectory('foo', RealtimeModes.SCHEMATIC, 10).then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_schematic_foo',
+            });
+            done();
+          });
+        });
+      });
+    });
+  });
+
+  describe('using default verion (2)', () => {
+    beforeEach(() => {
+      get = jest.fn((params, cb) => {
+        cb({ content: 'content' });
+      });
+      api = new RealtimeAPI();
+      api.wsApi = {
+        get,
+      };
+    });
+
+    describe('#getFullTrajectory() calls fullTrajectory channel', () => {
+      test('without parameters', (done) => {
+        api.getFullTrajectory().then(() => {
+          expect(get.mock.calls.length).toBe(1);
+          expect(get.mock.calls[0][0]).toEqual({
+            channel: 'full_trajectory',
+          });
+          done();
+        });
+      });
+
+      [null, RealtimeModes.TOPOGRAPHIC].forEach((mode) => {
+        describe(`using mode ${mode}`, () => {
+          test('using id', (done) => {
+            api.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) => {
+            api.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) => {
+          api.getFullTrajectory('foo', RealtimeModes.SCHEMATIC).then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_foo',
+            });
+            done();
+          });
+        });
+        test("doesn't use generalizationLevel param", (done) => {
+          api.getFullTrajectory('foo', RealtimeModes.SCHEMATIC, 10).then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_foo',
+            });
+            done();
+          });
+        });
+      });
+    });
+  });
+});