mobility-toolbox-js 2.0.0 → 2.1.0

package/package.json

@@ -2,216 +2,137 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "2.0.0",
-  "main": "index.js",
-  "module": "module.js",
+  "version": "2.1.0",
+  "homepage": "https://mobility-toolbox-js.geops.io/",
+  "module": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./api": "./api/index.js",
+    "./mapbox": "./mapbox/index.js",
+    "./ol": "./ol/index.js",
+    "./types": "./types/index.d.ts"
+  },
   "dependencies": {
-    "@geops/geops-ui": "0.1.13",
-    "@material-ui/core": "4.12.3",
-    "@material-ui/icons": "4.11.2",
-    "@material-ui/styles": "4.11.4",
-    "@turf/helpers": "^6.5.0",
-    "@turf/transform-rotate": "^6.5.0",
-    "codesandbox": "2.2.3",
+    "@turf/helpers": "6.5.0",
+    "@turf/transform-rotate": "6.5.0",
     "lodash.debounce": "4.0.8",
     "lodash.throttle": "4.1.1",
-    "path": "^0.12.7",
-    "prop-types": "15.8.1",
-    "query-string": "7.1.0",
-    "react": "18",
-    "react-app-polyfill": "^1.0.6",
-    "react-dom": "18",
-    "react-icons": "4.3.1",
-    "react-markdown": "8.0.0",
-    "react-router-dom": "6",
-    "react-scrollchor": "7.0.1",
-    "react-syntax-highlighter": "15.4.5",
-    "taffydb": "^2.7.3",
-    "turf": "^3.0.14",
-    "typeface-lato": "^0.0.75",
-    "uuid": "8.3.2"
+    "uuid": "9.0.0"
   },
   "peerDependencies": {
-    "mapbox-gl": "^1",
-    "maplibre-gl": "^1",
-    "ol": "^6"
+    "mapbox-gl": "1.13.2",
+    "maplibre-gl": "2.4.0",
+    "ol": "7.3.0"
   },
   "devDependencies": {
-    "@babel/core": "7.16.12",
-    "@babel/eslint-parser": "7.16.5",
-    "@babel/plugin-transform-runtime": "7.16.10",
-    "@babel/preset-env": "^7.16.11",
-    "@babel/preset-react": "7.16.7",
-    "@commitlint/cli": "17.0.2",
-    "@commitlint/config-conventional": "17.0.2",
-    "@neutrinojs/copy": "9.5.0",
-    "@neutrinojs/jest": "^9.5.0",
-    "@neutrinojs/library": "9.5.0",
-    "@neutrinojs/react": "9.5.0",
-    "autoprefixer": "9.7.6",
-    "cypress": "9.4.1",
-    "deepmerge": "4.2.2",
+    "@commitlint/cli": "17.6.1",
+    "@commitlint/config-conventional": "17.6.1",
+    "@types/geojson": "7946.0.10",
+    "@types/lodash.debounce": "4.0.7",
+    "@types/lodash.throttle": "4.1.7",
+    "@types/mapbox-gl": "2.7.10",
+    "@types/offscreencanvas": "2019.7.0",
+    "@types/topojson": "3.2.3",
+    "@types/uuid": "9.0.1",
+    "@typescript-eslint/eslint-plugin": "5.59.0",
+    "@typescript-eslint/parser": "5.59.0",
+    "cypress": "12.10.0",
+    "esbuild": "0.17.17",
+    "esbuild-jest": "0.5.0",
     "esdoc": "1.1.0",
     "esdoc-ecmascript-proposal-plugin": "1.0.0",
     "esdoc-publish-html-plugin": "1.1.2",
     "esdoc-standard-plugin": "1.0.0",
-    "eslint": "8.8.0",
+    "esdoc-typescript-plugin": "1.0.1",
+    "eslint": "8.38.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-import-resolver-webpack": "0.13.2",
-    "eslint-plugin-cypress": "2.12.1",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-react": "7.28.0",
-    "eslint-plugin-react-hooks": "4.3.0",
-    "fixpack": "3.0.6",
-    "husky": "8.0.1",
-    "jest": "26.6.3",
-    "jest-canvas-mock": "2.3.1",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-cypress": "2.13.2",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-react": "7.32.2",
+    "fixpack": "4.0.0",
+    "husky": "8.0.3",
+    "is-ci": "3.0.1",
+    "jest": "29.5.0",
+    "jest-canvas-mock": "2.5.0",
+    "jest-environment-jsdom": "29.5.0",
     "jest-fetch-mock": "3.0.3",
     "jest-serializer-html": "7.1.0",
-    "jest-websocket-mock": "2.3.0",
-    "lint-staged": "12.3.3",
+    "jest-transformer-svg": "2.0.1",
+    "jest-websocket-mock": "2.4.0",
+    "lint-staged": "13.2.1",
     "mapbox-gl": "1.13.2",
-    "maplibre-gl": "2.1.9",
-    "mock-socket": "9.1.2",
-    "neutrino": "9.5.0",
-    "ol": "6.12.0",
-    "postcss": "8.3.3",
-    "postcss-loader": "3.0.0",
-    "prettier": "2.5.1",
-    "sass": "1.52.2",
-    "sass-loader": "8.0.2",
-    "sort-json": "2.0.0",
+    "maplibre-gl": "2.4.0",
+    "mock-socket": "9.2.1",
+    "next": "12.1.6",
+    "next-transpile-modules": "10.0.0",
+    "ol": "7.3.0",
+    "openapi-typescript": "6.2.1",
+    "prettier": "2.8.7",
+    "raw-loader": "4.0.2",
+    "sort-json": "2.0.1",
     "standard-version": "9.5.0",
-    "start-server-and-test": "1.14.0",
-    "stylelint": "14.3.0",
-    "stylelint-config-recommended-scss": "5.0.2",
-    "stylelint-config-standard": "24.0.0",
-    "stylelint-scss": "4.1.0",
-    "webpack": "4.43.0",
-    "webpack-cli": "3.3.11",
-    "webpack-dev-server": "3.11.0",
-    "worker-loader": "3.0.8"
+    "start-server-and-test": "2.0.0",
+    "stylelint": "15.5.0",
+    "stylelint-config-recommended-scss": "10.0.0",
+    "stylelint-config-standard": "33.0.0",
+    "stylelint-scss": "4.6.0",
+    "typescript": "5.0.4"
   },
   "scripts": {
-    "apidoc": "esdoc",
-    "build": "yarn lib",
+    "apidoc": "esdoc && cp apidoc/index.json doc/src/components/Esdoc",
+    "build": "yarn build:tsc && yarn esbuild:iife",
+    "build:tsc": "rm -rf build && yarn tsc && cp package.json build/ && cp -R src/types build/ && find build -type f -name '*.test.*' -delete",
     "coverage": "yarn test  --watchAll=false  --coverage --coverageDirectory=coverage",
     "cy:open": "cypress open",
-    "cy:run": "cypress run",
-    "cy:test": "start-server-and-test start http://localhost:5000 'cypress run'",
-    "doc": "yarn apidoc && cp apidoc/index.json src/doc/components/Esdoc/ && webpack --mode production",
-    "doc:dev": "yarn apidoc && webpack --mode development",
-    "format": "prettier --write 'src/**/*.js' && eslint 'src/**/*.js' --fix && stylelint 'src/**/*.css' 'src/**/*.scss' --fix",
+    "cy:test": "start-server-and-test dev http://localhost:3000 'cypress run --browser chrome'",
+    "cy:test:chrome": "yarn build && start-server-and-test start http://localhost:3000 'cypress run --browser chrome'",
+    "cy:test:edge": "yarn build && start-server-and-test start http://localhost:3000 'cypress run --browser edge'",
+    "cy:test:firefox": "yarn build && start-server-and-test start http://localhost:3000 'cypress run --browser firefox'",
+    "dev": "rm -rf .next && rm -rf doc/.next && yarn doc && yarn dev:examples",
+    "dev:examples": "rm -rf .next && rm -rf doc/.next && yarn build && cd build && yarn link && cd ../doc && yarn link mobility-toolbox-js && yarn dev",
+    "doc": "yarn build && yarn apidoc && cd doc && rm -rf .next && rm -rf node_modules/mobility-toolbox-js && yarn install --force && yarn build",
+    "esbuild": "yarn esbuild:all && yarn esbuild:iife",
+    "esbuild:all": "esbuild src/index.js src/**/*.js src/**/*.ts src/**/**/*.js src/**/**/*.ts --target=chrome100 --outdir=build/ --loader:.js=jsx",
+    "esbuild:iife": "yarn esbuild:iife:unminify && yarn esbuild:iife:minify",
+    "esbuild:iife:base": "esbuild src/iife.js --bundle --sourcemap --target=chrome100",
+    "esbuild:iife:minify": "yarn esbuild:iife:base --minify --outfile=build/mbt.min.js",
+    "esbuild:iife:unminify": "yarn esbuild:iife:base --outfile=build/mbt.js",
+    "format": "prettier --write 'src/**/*.js' && eslint 'src/**/*.js' --fix && stylelint 'src/**/*.css' 'src/**/*.scss' --fix --allow-empty-input",
     "lib": "REACT_APP_LIB_MODE=1  webpack --mode production",
     "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' && stylelint 'src/**/*.css' 'src/**/*.scss'",
-    "publish:beta": "HUSKY=0 yarn release -- --prerelease beta --skip.changelog && git push origin HEAD && yarn run build && cd build && git push --tags && HUSKY=0 yarn publish --tag beta",
+    "lint": "eslint src/**/*.js src/**/*.ts && stylelint src/**/*.css src/**/*.scss --allow-empty-input",
+    "prepare": "is-ci || husky install",
+    "publish:beta": "HUSKY=0 yarn release -- --prerelease beta --skip.changelog && git push origin HEAD && yarn run build && cd build && HUSKY=0 yarn publish --tag beta && git push --tags ",
     "publish:beta:dryrun": "yarn release -- --prerelease beta --dry-run --skip.changelog",
-    "publish:public": "yarn release && git push origin HEAD && yarn run build && cd build && git push --tags && yarn publish",
+    "publish:public": "yarn release --skip.changelog && git push origin HEAD && yarn run build && cd build && HUSKY=0 yarn publish && git push --tags ",
     "publish:public:dryrun": "yarn release --dry-run",
     "release": "standard-version",
-    "start": "yarn doc && webpack-dev-server --mode development --open",
-    "start:examples": "webpack-dev-server --mode development --open",
-    "test": "REACT_APP_LIB_MODE=1 jest",
-    "test:watch": "yarn test --watchAll"
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version",
-      "last 1 ie version"
-    ]
-  },
-  "eslintConfig": {
-    "env": {
-      "cypress/globals": true,
-      "node": true,
-      "browser": true,
-      "es6": true,
-      "jest": true
-    },
-    "parser": "@babel/eslint-parser",
-    "extends": [
-      "airbnb",
-      "airbnb/hooks",
-      "prettier"
-    ],
-    "plugins": [
-      "cypress",
-      "prettier"
-    ],
-    "rules": {
-      "arrow-body-style": 0,
-      "react/jsx-filename-extension": [
-        1,
-        {
-          "extensions": [
-            ".js",
-            ".jsx"
-          ]
-        }
-      ],
-      "prettier/prettier": "error"
-    },
-    "settings": {
-      "import/resolver": "webpack",
-      "react": {
-        "version": "detect"
-      }
-    }
-  },
-  "exports": {
-    ".": "./index.js",
-    "./module": "./module.js",
-    "./api": "./api/index.js",
-    "./common/trackerConfig": "./common/trackerConfig.js",
-    "./utils": "./common/utils/index.js",
-    "./mapbox": "./mapbox/index.js",
-    "./ol": "./ol/index.js"
+    "start": "yarn doc && cd doc && yarn start",
+    "start:examples": "cd doc && yarn build && yarn start",
+    "test": "TZ='UTC' jest ",
+    "test:watch": "yarn test --watchAll",
+    "tsc": "tsc",
+    "types:backend": "openapi-typescript https://developer.geops.io/swagger/routing.json --output src/types/routing.d.ts && openapi-typescript  https://developer.geops.io/swagger/stops.json --output src/types/stops.d.ts"
   },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not op_mini all",
+    "not ie <= 11",
+    "not android < 5"
+  ],
   "keywords": [
     "mobility",
     "toolbox"
   ],
-  "lint-staged": {
-    "(src|__mocks__)/**/*.js": [
-      "eslint --fix",
-      "prettier --write",
-      "git add",
-      "yarn test --bail --findRelatedTests"
-    ],
-    "package.json": [
-      "fixpack --sortToTop name --sortToTop license --sortToTop description --sortToTop version --sortToTop author --sortToTop main --sortToTop module --sortToTop files --sortToTop proxy --sortToTop dependencies --sortToTop peerDependencies --sortToTop devDependencies --sortToTop resolutions --sortToTop scripts"
-    ],
-    "src/**/*.{css,scss}": [
-      "stylelint --fix"
-    ]
-  },
-  "prettier": {
-    "trailingComma": "all",
-    "singleQuote": true
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/geops/mobility-toolbox-js"
   },
-  "stylelint": {
-    "plugins": [
-      "stylelint-scss"
-    ],
-    "extends": [
-      "stylelint-config-standard",
-      "stylelint-config-recommended-scss"
-    ]
-  }
+  "sideEffects": false
 }

package/setupTests.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=setupTests.d.ts.map

package/setupTests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupTests.d.ts","sourceRoot":"","sources":["../src/setupTests.js"],"names":[],"mappings":""}

package/setupTests.js

@@ -0,0 +1,26 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import 'jest-canvas-mock';
+import fetchTrajectoryByIdResponse from '../data/fetchTrajectoryById.json';
+import fetchTrajectoriesResponse from '../data/fetchTrajectories.json';
+import fetchTrajectoryStationsResponse from '../data/fetchTrajectoryStations.json';
+import stopsSearchResponse from '../data/stopsSearch.json';
+import fetchRouteResponse from '../data/fetchRoute.json';
+global.fetchTrajectoryByIdResponse = fetchTrajectoryByIdResponse;
+global.fetchTrajectoriesResponse = fetchTrajectoriesResponse;
+global.fetchTrajectoryStationsResponse = fetchTrajectoryStationsResponse;
+global.stopsSearchResponse = stopsSearchResponse;
+global.fetchRouteResponse = fetchRouteResponse;
+global.URL.createObjectURL = jest.fn(() => 'fooblob');
+window.OffscreenCanvas = () => {
+    return document.createElement('canvas');
+};
+/* eslint-disable */
+class ResizeObserver {
+    constructor(onResize) {
+        ResizeObserver.onResize = onResize;
+    }
+    observe() { }
+    unobserve() { }
+    disconnect() { }
+}
+window.ResizeObserver = ResizeObserver;

package/types/common.d.ts

@@ -0,0 +1,122 @@
+import { Feature } from 'ol';
+import { Coordinate } from 'ol/coordinate';
+import { ObjectEvent } from 'ol/Object';
+import { Pixel } from 'ol/pixel';
+import type { RealtimeMot, RealtimeTrainId } from './realtime';
+import type {
+  CopyrightControl as MbCopyrightControl,
+  RealtimeLayer as MbRealtimeLayer,
+  layer as MbLayer,
+} from '../mapbox';
+import type {
+  CopyrightControl as OlCopyrightControl,
+  MapboxLayer,
+  MaplibreLayer,
+  RealtimeLayer as OlRealtimeLayer,
+  layer as OlLayer,
+} from '../ol';
+import { RealtimeTrajectory } from '../api/typedefs';
+import CommonLayer, { LayerCommonOptions } from '../common/layers/LayerCommon';
+import type { RoutingParameters } from '.';
+
+export type StyleCache = { [key: string]: AnyCanvas };
+
+export type ViewState = {
+  time?: number;
+  center?: number[];
+  extent?: number[];
+  size?: number[];
+  rotation?: number;
+  resolution?: number;
+  zoom?: number;
+  pixelRatio?: number;
+};
+
+export type RealtimeStyleOptions = {
+  hoverVehicleId?: RealtimeTrainId;
+  selectedVehicleId?: RealtimeTrainId;
+  useDelayStyle?: boolean;
+  delayOutlineColor?: string;
+  delayDisplay?: number;
+  noInterpolate?: boolean;
+  filter?: FilterFunction;
+  getRadius?: (type: RealtimeMot, z: number) => number;
+  getBgColor?: (type: RealtimeMot) => string;
+  getDelayColor?: (
+    delay: number | null,
+    cancelled?: boolean,
+    isDelayText?: boolean,
+  ) => string;
+  getDelayText?: (delay: number | null, cancelled?: boolean) => string;
+  getTextColor?: (type: RealtimeMot) => string;
+  getTextSize?: (
+    ctx: AnyCanvasContext,
+    markerSize: number,
+    name: string,
+    fontSize: number,
+  ) => number;
+  getMaxRadiusForText?: () => number;
+  getMaxRadiusForStrokeAndDelay?: () => number;
+  getScreenPixel?: (pixel: Pixel, viewState: ViewState) => Pixel;
+};
+
+export type RealtimeTrajectories = {
+  [key: RealtimeTrainId]: RealtimeTrajectory;
+};
+
+export type RealtimeStyleFunction = (
+  trajectory: RealtimeTrajectory,
+  viewState: ViewState,
+  options: RealtimeStyleOptions,
+) => AnyCanvas | null;
+
+export type RealtimeRenderState = {
+  center?: Coordinate;
+  zoom?: number;
+  rotation?: number;
+  renderedTrajectories?: RealtimeTrajectory[];
+};
+
+export type AnyMap = OlMap | MaplibreMap | MapboxMap;
+export type AnyLayer = OlLayer | MbLayer;
+export type AnyOlLayer = OlLayer;
+export type AnyMapboxLayer = MapboxLayer | MaplibreLayer;
+export type AnyRealtimeLayer = MbRealtimeLayer | OlRealtimeLayer;
+export type AnyCopyrightControl = MbCopyrightControl | OlCopyrightControl;
+export type AnyMapboxMap = mapboxgl.Map | maplibregl.Map;
+export type AnyCanvas = HTMLCanvasElement | OffscreenCanvas;
+export type AnyCanvasContext =
+  | CanvasRenderingContext2D
+  | OffscreenCanvasRenderingContext2D;
+export type GConstructor<T extends CommonLayer> = new (options?: any) => T;
+export type CommonLayerClass = GConstructor<CommonLayer>;
+export type GConstructor2<T extends OlLayer> = new (options?: any) => T;
+export type OlLayerClass = GConstructor<AnyOlLayer>;
+export type AnyLayerClass = GConstructor<AnyLayer>;
+
+export type AnyMapboxLayerClass = GConstructor<AnyMapboxLayer>;
+export type AnyRealtimeLayerClass = GConstructor<AnyRealtimeLayer>;
+export type AnyMapboxMapClass = GConstructor<AnyMapboxMap>;
+export type AnyCopyrightControlClass = GConstructor<AnyCopyrightControl>;
+
+export type LayerGetFeatureInfoResponse = {
+  layer: Layer;
+  features: Feature[];
+  coordinate: Coordinate;
+};
+
+export type LayerGetFeatureInfoOptions = {
+  resolution: number;
+  nb?: number;
+};
+
+export type UserInteractionCallback = (
+  features: Feature[],
+  layer: LayerCommonOptions,
+  coordinate: Coordinate,
+  event: ObjectEvent,
+) => void;
+
+export type RoutingGraph = [RoutingParameters.graph, number, number];
+export type RoutingMot = RoutingParameters.mot;
+export type RoutingViaPoint = string | Coordinate;

package/types/index.d.ts

@@ -0,0 +1,11 @@
+import { Paths as Routing } from './routing';
+import { Paths as Stops } from './stops';
+
+export * from './realtime';
+export * from './common';
+
+export type RoutingParameters = Routing['/']['get']['parameters']['query'];
+export type RoutingResponse = Routing['/']['get']['responses']['200']['schema'];
+
+export type StopsParameters = Stops['/']['get']['parameters']['query'];
+export type StopsResponse = Stops['/']['get']['responses']['200']['schema'];