mobility-toolbox-js 2.3.10 → 2.3.11

package/CHANGELOG.md

@@ -1,132 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### [2.3.9](https://github.com/geops/mobility-toolbox-js/compare/v2.3.8...v2.3.9) (2024-02-27)
-
-
-### Bug Fixes
-
-* calculate the correct gen level when we highlight a trajectory ([#208](https://github.com/geops/mobility-toolbox-js/issues/208)) ([3d06bb7](https://github.com/geops/mobility-toolbox-js/commit/3d06bb71846572bdec185d4a66a5b5fd500d55c6))
-
-### [2.3.8](https://github.com/geops/mobility-toolbox-js/compare/v2.3.7...v2.3.8) (2024-01-18)
-
-
-### Bug Fixes
-
-* debounce calls to setBbox ([#206](https://github.com/geops/mobility-toolbox-js/issues/206)) ([b50feca](https://github.com/geops/mobility-toolbox-js/commit/b50feca53134856409ac79252e244ea97749435f))
-
-### [2.3.7](https://github.com/geops/mobility-toolbox-js/compare/v2.3.6...v2.3.7) (2023-12-06)
-
-
-### Bug Fixes
-
-* add a getText method in style options ([707d5e7](https://github.com/geops/mobility-toolbox-js/commit/707d5e728c8fe1925d676ae41d3dc0e196588f5d))
-
-### [2.3.6](https://github.com/geops/mobility-toolbox-js/compare/v2.3.5...v2.3.6) (2023-12-06)
-
-
-### Bug Fixes
-
-* add a getText method in style options ([92b4e93](https://github.com/geops/mobility-toolbox-js/commit/92b4e93597e4909e4aa996822fe01ee0ae9adbe2))
-
-### [2.3.5](https://github.com/geops/mobility-toolbox-js/compare/v2.3.4...v2.3.5) (2023-11-17)
-
-
-### Bug Fixes
-
-* simplify setBbox function ([8f99991](https://github.com/geops/mobility-toolbox-js/commit/8f99991df3f99c64b3776cd8c18dff0820c4a638))
-* use floored value for the zoom ([7961de0](https://github.com/geops/mobility-toolbox-js/commit/7961de0d3e660d67658205aef5e6578ea79b440b))
-
-### [2.3.4](https://github.com/geops/mobility-toolbox-js/compare/v2.3.3...v2.3.4) (2023-11-17)
-
-
-### Bug Fixes
-
-* do not set generalizationLevelByZoom by default ([69b59ba](https://github.com/geops/mobility-toolbox-js/commit/69b59ba204529eb90cf1bd99a5bedd95705f821f))
-* simplify getMotsByZoom behavior ([1fc259f](https://github.com/geops/mobility-toolbox-js/commit/1fc259f29bf3da276a158aa2c063e7609ca6a6f9))
-* simplify getMotsByZoom behavior ([87e52ec](https://github.com/geops/mobility-toolbox-js/commit/87e52ec26e9d7204b563a39602fa3c0aa1a90530))
-
-### [2.3.3](https://github.com/geops/mobility-toolbox-js/compare/v2.3.2...v2.3.3) (2023-11-17)
-
-
-### Bug Fixes
-
-* add text parameter to getXXXFont functions ([83cec9b](https://github.com/geops/mobility-toolbox-js/commit/83cec9b3b9a58aad76a3944257cf83dc80710b89))
-* send floor/ceil values to the websocket ([50b8b0a](https://github.com/geops/mobility-toolbox-js/commit/50b8b0aaad28f9cc63ab1c7f460d2662262bcfe6))
-* update full trajectory layer when interacting and animating ([97a9ad8](https://github.com/geops/mobility-toolbox-js/commit/97a9ad86d03d4ca8f760df3269840537746cd403))
-
-### [2.3.2](https://github.com/geops/mobility-toolbox-js/compare/v2.3.1...v2.3.2) (2023-11-14)
-
-
-### Bug Fixes
-
-* add getXXXFont function to realtime style options ([310be23](https://github.com/geops/mobility-toolbox-js/commit/310be2350e96eb815d080f1a00eaafcb8d79e1e6))
-
-### [2.3.1](https://github.com/geops/mobility-toolbox-js/compare/v2.3.0...v2.3.1) (2023-11-03)
-
-
-### Bug Fixes
-
-* display delay in seconds when needed ([d3284f9](https://github.com/geops/mobility-toolbox-js/commit/d3284f988223fbb2e39542d84d875d75fa400cc7))
-
-## [2.3.0](https://github.com/geops/mobility-toolbox-js/compare/v2.2.1...v2.3.0) (2023-10-26)
-
-
-### Features
-
-* use realtime api v2 by default ([#194](https://github.com/geops/mobility-toolbox-js/issues/194)) ([fb5e950](https://github.com/geops/mobility-toolbox-js/commit/fb5e9509b17ee383278fe1af7d2e56c76633f3dc))
-
-### [2.2.1](https://github.com/geops/mobility-toolbox-js/compare/v2.2.0...v2.2.1) (2023-10-25)
-
-
-### Bug Fixes
-
-* add new bboxParamters property ([ee56316](https://github.com/geops/mobility-toolbox-js/commit/ee5631604dbfee009c0e8c5208b5cedb51616796))
-
-## [2.2.0](https://github.com/geops/mobility-toolbox-js/compare/v2.1.1...v2.2.0) (2023-10-13)
-
-
-### Features
-
-* add new get an gettrajectory method in realtimeapi ([#195](https://github.com/geops/mobility-toolbox-js/issues/195)) ([0461fde](https://github.com/geops/mobility-toolbox-js/commit/0461fdebe8f36e0680eb5d802546ec91306da843))
-
-### [2.1.1](https://github.com/geops/mobility-toolbox-js/compare/v2.1.0...v2.1.1) (2023-10-06)
-
-
-### Bug Fixes
-
-* add trajectory to the list even if they are filtered out ([f0d034c](https://github.com/geops/mobility-toolbox-js/commit/f0d034c6cd815dde6a27c65ff85330df7720521b))
-
-## [2.1.0](https://github.com/geops/mobility-toolbox-js/compare/v1.7.5...v2.1.0) (2022-06-20)
-
-This version contains lot of breaking change, to make things simpler to use and to remove all application specific stuff.
-We suggest to have a look at the [v2 migration guide](./MIGRATION-V2.md).
-
-### Breaking changes
-
-* all classes, api and utilities functions are available through a unique import (depending on which mapping library you use): `'mobility-toolbox-js/ol'` or `'mobility-toolbox-js/mapbox'`
-  
-* rename `TralisAPI` to `RealtimeAPI`
-* rename `TralisModes` to `RealtimeModes`
-* rename `TralisLayer` to `RealtimeLayer`
-* remove `TrajservLayer` class
-  
-* remove `Map` classes. Use new `attachToMap()` and `detachFromMap()` function to add your layers/controls to a map
-* remove all application specific properties from layers classes.`isQueryable`, `isBaseLayer`, `isAlwaysExpanded`, `isReactSpatialLayer`, `isTrackerLayer`, use `options.properties` in the constructor instead
-  
-* replace `MapboxLayer.createStyleUrl()` by an utility function `getUrlWithParams`
-  
-* pass `Mapboxgl.Map` options through a `mapOptions` object in the constructor instead of layers\'s property
-* pass `RealtimeLayer` style properties through a `styleOptions` object in the constructor instead of layers\'s properties
-* pass `RealtimeLayer` filters through the  `filter` property instead of specific layers\'s properties
-* harmonize backend responses
-
-### Features
-
-* use TypeScript
-* use Maplibre
-* use NextJS for website in `doc/` folder
-* all classes, api and functions are available through a unique import (depending on what mapping library you use): `'mobility-toolbox-js/ol'` or `'mobility-toolbox-js/mapbox'`
-* add a full single-file build for an easy use in raw html page or [codepen.io](https://codepen.io)
-* use standard-version for automatic versioning and changelog ([#167](https://github.com/geops/mobility-toolbox-js/issues/167)) ([045ad0b](https://github.com/geops/mobility-toolbox-js/commit/045ad0b533aaa56d84b90178de8e6aa18c2cbd89))

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 geOps
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/MIGRATION-V2.md

@@ -1,248 +0,0 @@
-# Migration v2
-
-The version contains a lot of breaking changes, to make things simpler to use and to remove all application specific stuff.
-
-Here is an exhaustive list of what you have to change in your application code.
-
-## exports
-
-* all classes, api and utilities functions are available through a unique import (depending on what mapping library you use): `'mobility-toolbox-js/ol'` or `'mobility-toolbox-js/mapbox'`
-
-## in Map classes
-
-* remove all `Map` classes. Use the Mapbox or Openlayers Map directly then use `attachToMap()` and `detachFromMap()` functions.
-  
-```js
-  // Before:
-  const map = new Map();
-  map.addLayer(myLayer);
-  map.addControl(myControl);
-  map.removeLayer(myLayer);
-  map.removeControl(myControl);
-
-  // After
-  const map = new Openlayers.Map();
-  myLayer.attachToMap(map);
-  myControl.attachToMap(map);
-  myLayer.detachFromMap();
-  myControl.detachFromMap();
-```
-
-## in all Layer classes
-
-* add `group` property.
-  
-```js
-  // Before:
-  const layer = new layer({ properties: { radioGroup: 'my group' }});
-
-  // After
-  const layer = new layer({ group: 'my group' });
-```
-
-* remove `TrajservLayer`, use `RealtimeLayer` instead
-
-* remove `addChild()`,`removeChild()`, `hasVisibleChildren()`, `getVisibleChildren()` convenience methods, use `children` array directly instead
-* remove `setVisible()` method, use layer\'s property instead
-  
-```js
-  // Before:
-  layer.setVisible(true);
-
-  // After
-  layer.visible = true;
-```
-
-* remove `isBaseLayer` property
-  
-```js
-  // Before:
-  const layer = new Layer({ isBaseLayer: true});
-  const isBaseLayer = layer.isBaseLayer;
-
-  // After
-  const layer = new Layer({ properties: { isBaseLayer: true }});
-  const isBaseLayer = layer.get('isBaseLayer');
-```
-
-* remove `isQueryable` property
-  
-```js
-  // Before:
-  const layer = new Layer({ isQueryable: true});
-  const isQueryable = layer.isQueryable;
-
-  // After
-  const layer = new Layer({ properties: { isQueryable: true }});
-  const isQueryable = layer.get('isQueryable');
-```
-
-* remove `isAlwaysExpanded` property
-  
-```js
-  // Before:
-  const layer = new Layer({ isAlwaysExpanded: true});
-  const isAlwaysExpanded = layer.isAlwaysExpanded;
-
-  // After
-  const layer = new Layer({ properties: { isAlwaysExpanded: true }});
-  const isAlwaysExpanded = layer.get('isAlwaysExpanded');
-```
-
-* remove `isReactSpatialLayer` property
-  
-* replace `init()` by `attachToMap()`
-  
-```js
-  // Before:
-  layer.init(map)
-
-  // After
-  layer.attachToMap(map)
-```
-
-* replace `terminate()` by `detachFromMap()`
-  
-```js
-  // Before:
-  layer.terminate()
-
-  // After
-  layer.detachFromMap()
-```
-
-## in MapboxLayer and MaplibreLayer classes
-
-* remove `options.preserveDrawingBuffer`, use `options.mapOptions` in the constructor
-  
-```js
-  // Before:
-  const layer = new MapoxLayer({ preserveDrawingBuffer: true});
-
-  // After
-  const layer = new Layer({ mapOptions: { preserveDrawingBuffer: true}});
-```
-
-* replace `createStyleUrl()` by an utility function `getUrlWithParams()`
-  
-```js
-  // Before:
-  const layer = new MapoxLayer();
-  const url  = layer.createStyleUrl();
-
-  // After
-  import {  getUrlWithParams } from 'mobility-toolbox-js/common';
-  const layer = new MapoxLayer();
-  const url = getUrlWithParams(layer.url, { [layer.apiKeyName]: layer.apiKey }).toString();
-```
-
-## in TralisLayer classes
-
-* rename `TralisLayer` to `RealtimeLayer`
-* remove `isTrackerLayer` property
-* remove properties : `publishedLineName`, `tripNumber`, `operator`, `regexPublishedLineName`. Use utility function `createRealtimeFilters()` instead.
-  
-```js
-  // Before:
-  const layer = new TralisLayer({
-    publishedLineName: 'foo',
-    tripNumber: 2,
-    operator: 'bar',
-    regexPublishedLineName: /.*/,
-  });
-
-  // After
-  import {  createRealtimeFilters } from 'mobility-toolbox-js/common';
-  
-  const layer = new RealtimeLayer({
-    filter: createRealtimeFilters('foo','2','bar', /.*/),
-  });
-```
-
-* remove all automatic filter through permalink using `publishedlinename`, `tripnumber`, `operator`
-
-```js
-  // After
-  import {  createRealtimeFilters } from 'mobility-toolbox-js/common';
-  const params = new URLSearchParans(window.location.search);
-  const layer = new RealtimeLayer({
-    filter: createRealtimeFilters(
-      params.get('publishedlinename'),
-      params.get('tripnumber'),
-      params.get('operator'),
-    ),
-  });
-```
-
-* remove style properties `delayOutlineColor`, `delayDisplay`, `iconScale`. Use `options.styleOptions` in the constructor to proivde these valeu to the rendering.
-  
-```js
-  // Before
-  const layer = new RealtimeLayer({
-    delayOutlineColor:'#000',
-    delayDisplay: 300000,
-    iconScale: 0.5,
-  });
-
-  // After
-  const layer = new RealtimeLayer({
-    styleOptions: {
-      delayOutlineColor:'#000',
-      delayDisplay: 300000,
-      iconScale: 0.5,
-    }
-  });
-```
-
-* remove `getVehiclesAtCoordinate()`, use `getFeatureAtCoordinate()`instead
-
-* remove `useDelayStyle` property, use `style`, `sort` and `fullTrajectoryStyle` instead
-  
-```js
-  // Before
-  import { TralisLayer } from 'mobility-toolbox-js/ol';
-  const layer = new TralisLayer({
-    useDelayStyle: true,
-  });
-
-  // After
-  import {
-    RealtimeLayer,
-    fullTrajectoryDelayStyle,
-    realtimeDelayStyle,
-    sortByDelay,
-  } from 'mobility-toolbox-js/ol';
-  const layer = new RealtimeLayer({
-    style: realtimeDelayStyle,
-    sort: sortByDelay,
-    fullTrajectoryStyle: fullTrajectoryDelayStyle,
-  });
-```
-
-## in api classes
-
-* rename `TralisAPI` to `RealtimeAPI`
-* rename `TralisModes` to `RealtimeModes`
-  
-## in StopsAPI class
-
-* `search()` method returns a GeoJSON feature collection instead of an array of GeoJSON feature
-
-```js
-  // Before
-  const api = new StopsAPI({ ... });
-  api.search().then((arrayOfFeatures) => {
-    const feature = arrayOfFeatures[0];
-  });
-
-  // After
-  const api = new StopsAPI({ ... });
-  api.search().then((featureCollection) => {
-    const feature = featureCollection.features[0];
-  });
-```
-
-## in RealtimeAPI class
-
-* `subscribeXXX()` methods have all the same signature and returns now the complete websocket message. Check the [doc](https://mobility-toolbox-js.geops.io/doc/class/build/api/RealtimeAPI%20js~RealtimeAPI) for more informations.
-* some `getXXX()` methods have a different signature. Check the [doc](https://mobility-toolbox-js.geops.io/doc/class/build/api/RealtimeAPI%20js~RealtimeAPI) for more informations.

package/README.md

@@ -1,42 +0,0 @@
-# mobility-toolbox-js
-
-Toolbox for JavaScript applications in the domains of mobility and logistics.
-The tools in this library have been inspired by many projects realized for public transport agencies, mobility providers and logistics companies.
-
-[![npm](https://img.shields.io/npm/v/mobility-toolbox-js.svg?style=flat-square)](https://www.npmjs.com/package/mobility-toolbox-js)
-[![Build](https://github.com/geops/mobility-toolbox-js/workflows/Build/badge.svg)](https://github.com/geops/mobility-toolbox-js/actions?query=workflow%3ABuild)
-[![Lint / Unit tests](https://github.com/geops/mobility-toolbox-js/workflows/Lint%20/%20Unit%20tests/badge.svg)](https://github.com/geops/mobility-toolbox-js/actions?query=workflow%3ALint%20/%20Unit%20tests)
-![Vercel](https://vercelbadge.vercel.app/api/geops/mobility-toolbox-js)
-
-## Documentation and examples
-
-Visit https://mobility-toolbox-js.vercel.app/
-
-## Demos
-
-* Display [real-time vehicle positions and prognosis data](https://mobility.portal.geops.io) on a map.
-* Search for [stops and stations](https://maps.trafimage.ch) all over the world.
-* Get [precise geographic courses](https://routing-demo.geops.io/) for all modes of transport.
-* Generate beautiful [schematic](https://mobility.portal.geops.io/world.geops.networkplans) or [topographic](https://mobility.portal.geops.io) maps for public transport, mobility and logistics.
-
-## Install
-
-Install the library and the peer dependencies:
-
-```bash
-yarn add mobility-toolbox-js ol maplibre-gl
-```
-
-## Development
-
-```bash
-yarn install
-yarn dev
-```
-
-## Deploy
-
-This library website is deployed automatically using [Vercel](https://vercel.com/geops).
-For Vercel we have to add the nextjs and raw-loader modules in the dev dependencies of the main package.json.
-But those 2 librairies are not needed to build the library.
-

package/__mocks__/mapbox-gl.js

@@ -1,81 +0,0 @@
-const callbacks = {};
-
-/* eslint-disable class-methods-use-this */
-class Map {
-  constructor(options) {
-    this.options = options;
-  }
-
-  addLayer() {}
-
-  addSource() {}
-
-  isStyleLoaded() {}
-
-  getLayer() {}
-
-  getBounds() {
-    return {
-      toArray: () => [
-        [1, 2],
-        [1, 2],
-      ],
-    };
-  }
-
-  getCanvas() {
-    return {
-      height: '100px',
-      width: '100px',
-      setAttribute: () => {},
-      removeAttribute: () => {},
-    };
-  }
-
-  getCenter() {
-    return { lng: 0, lat: 0 };
-  }
-
-  getZoom() {}
-
-  getBearing() {
-    return 0;
-  }
-
-  once() {}
-
-  on(type, func) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    callbacks[type].push(func);
-  }
-
-  off(type, func) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    const index = callbacks[type].indexOf(func);
-    if (index > -1) {
-      callbacks[type].splice(index, 1);
-    }
-  }
-
-  fire(type, evt) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    callbacks[type].forEach((callback) => callback(evt));
-  }
-
-  loaded() {}
-
-  remove() {}
-
-  unproject() {
-    return { lng: 0, lat: 0 };
-  }
-}
-module.exports = {
-  Map,
-};

package/__mocks__/maplibre-gl.js

@@ -1,81 +0,0 @@
-const callbacks = {};
-
-/* eslint-disable class-methods-use-this */
-class Map {
-  constructor(options) {
-    this.options = options;
-  }
-
-  addLayer() {}
-
-  addSource() {}
-
-  isStyleLoaded() {}
-
-  getLayer() {}
-
-  getBounds() {
-    return {
-      toArray: () => [
-        [1, 2],
-        [1, 2],
-      ],
-    };
-  }
-
-  getCanvas() {
-    return {
-      height: '100px',
-      width: '100px',
-      setAttribute: () => {},
-      removeAttribute: () => {},
-    };
-  }
-
-  getCenter() {
-    return { lng: 0, lat: 0 };
-  }
-
-  getZoom() {}
-
-  getBearing() {
-    return 0;
-  }
-
-  once() {}
-
-  on(type, func) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    callbacks[type].push(func);
-  }
-
-  off(type, func) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    const index = callbacks[type].indexOf(func);
-    if (index > -1) {
-      callbacks[type].splice(index, 1);
-    }
-  }
-
-  fire(type, evt) {
-    if (!callbacks[type]) {
-      callbacks[type] = [];
-    }
-    callbacks[type].forEach((callback) => callback(evt));
-  }
-
-  loaded() {}
-
-  remove() {}
-
-  unproject() {
-    return { lng: 0, lat: 0 };
-  }
-}
-module.exports = {
-  Map,
-};

package/babel.config.js

@@ -1,9 +0,0 @@
-const config = {
-  presets: [
-    ['@babel/preset-env', {targets: {node: 'current'}}],
-   '@babel/preset-typescript',
-  ],
-};
-
-
-module.exports = config;

package/commitlint.config.js

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };

package/cypress/e2e/examples/api.cy.js

@@ -1,7 +0,0 @@
-describe('Api', () => {
-  it('loads api page', () => {
-    cy.visit('/doc');
-    cy.get('img[alt=Logo').should('be.ok');
-    cy.get('iframe').should('be.ok');
-  });
-});

package/cypress/e2e/examples/examples.cy.js

@@ -1,7 +0,0 @@
-describe('Examples', () => {
-  it('loads a map in the simple map example', () => {
-    cy.visit('/examples');
-    cy.get('img[alt=Logo').should('be.ok');
-    cy.get('canvas').should('be.ok');
-  });
-});

package/cypress/e2e/examples/navigation.cy.js

@@ -1,29 +0,0 @@
-// / <reference types="cypress" />
-
-context('Navigation', () => {
-  beforeEach(() => {
-    cy.visit('');
-    cy.get('header').contains('API').click();
-    cy.get('header').contains('Examples').click();
-  });
-
-  it("cy.go() - go back or forward in the browser's history", () => {
-    // https://on.cypress.io/go
-
-    cy.location('pathname').should('include', 'examples');
-
-    cy.go('back');
-    cy.location('pathname').should('include', 'doc');
-
-    cy.go('forward');
-    cy.location('pathname').should('include', 'examples');
-
-    // clicking back
-    cy.go(-1);
-    cy.location('pathname').should('include', 'doc');
-
-    // clicking forward
-    cy.go(1);
-    cy.location('pathname').should('include', 'examples');
-  });
-});

package/cypress/fixtures/example.json

@@ -1,5 +0,0 @@
-{
-  "name": "Using fixtures to represent data",
-  "email": "hello@cypress.io",
-  "body": "Fixtures are a great way to mock data for responses to routes"
-}