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

package/.esdoc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  source: './build',
+  destination: './apidoc',
+  includes: ['\\.(js)$', 'typedefs\\.js$'],
+  excludes: ['setupTests\\.*', '^iife', '^mbt\\.*', '\\.test\\.js$', 'doc/'],
+  plugins: [
+    {
+      name: 'esdoc-standard-plugin',
+    },
+    { name: 'esdoc-ecmascript-proposal-plugin', option: { all: true } },
+    {
+      name: 'esdoc-publish-html-plugin',
+    },
+    { name: './esdoc/plugins/dynamic-property-plugin/Plugin.js' },
+    { name: './esdoc/plugins/externals-plugin/Plugin.js' },
+    { name: './esdoc/plugins/optional-chaining-plugin/Plugin.js' },
+  ],
+};

package/.eslintignore

@@ -0,0 +1 @@
+build/*

package/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    'cypress/globals': true,
+    node: true,
+    browser: true,
+    es6: true,
+    jest: true,
+  },
+  parser: '@typescript-eslint/parser',
+  extends: ['airbnb', 'airbnb-typescript', 'prettier'],
+  plugins: ['@typescript-eslint', 'cypress', 'prettier'],
+  parserOptions: {
+    project: './tsconfig.json',
+  },
+  rules: {
+    'arrow-body-style': 0,
+    'react/jsx-filename-extension': [
+      1,
+      {
+        extensions: ['.js', '.jsx'],
+      },
+    ],
+    'prettier/prettier': 'error',
+  },
+};

package/.fixpackrc

@@ -0,0 +1,20 @@
+{
+  "sortToTop": [
+    "name", 
+    "license",
+    "description",
+    "version",
+    "author",
+    "homepage",
+    "main", 
+    "module", 
+    "files",
+    "exports", 
+    "proxy",
+    "dependencies",
+    "peerDependencies", 
+    "devDependencies", 
+    "resolutions",
+    "scripts"
+  ]
+}

package/.github/workflows/build.yml

@@ -0,0 +1,16 @@
+name: Build
+
+on: ['push']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+      - run: yarn install --frozen-lockfile
+      - run: yarn build

package/.github/workflows/conventional-pr-title.yml

@@ -0,0 +1,16 @@
+name: Check PR title
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: aslafy-z/conventional-pr-title-action@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/cypress.yml

@@ -0,0 +1,101 @@
+name: Cypress
+
+on: [push]
+
+jobs:
+  chrome:
+    runs-on: ubuntu-latest
+    container:
+      image: cypress/browsers:node-20.9.0-chrome-118.0.5993.88-1-ff-118.0.2-edge-118.0.2088.46-1
+      options: --user 1001
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - run: yarn install --frozen-lockfile
+      - run: yarn cypress info
+      - run: node --version
+      - run: node -p 'os.cpus()'
+      - run: yarn cy:test:chrome
+  edge:
+    runs-on: ubuntu-latest
+    container:
+      image: cypress/browsers:node-20.9.0-chrome-118.0.5993.88-1-ff-118.0.2-edge-118.0.2088.46-1
+      options: --user 1001
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - run: yarn install --frozen-lockfile
+      - run: yarn cypress info
+      - run: node --version
+      - run: node -p 'os.cpus()'
+      - run: yarn cy:test:edge
+
+  # chrome:
+  #   runs-on: ubuntu-latest
+  #   container:
+  #     image: cypress/browsers:node16.14.2-slim-chrome100-ff99-edge
+  #     options: --user 1001 # very important  otherwise there is a permission error
+  #   needs: install
+  #   strategy:
+  #     # when one test fails, DO NOT cancel the other
+  #     # containers, because this will kill Cypress processes
+  #     # leaving the Dashboard hanging ...
+  #     # https://github.com/cypress-io/github-action/issues/48
+  #     fail-fast: false
+  #     matrix:
+  #       # run copies of the current job in parallel
+  #       containers: [1]
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+
+  #     - name: Download the build folders
+  #       uses: actions/download-artifact@v3
+  #       with:
+  #         name: build
+  #         path: .next
+
+  #     # Install NPM dependencies, cache them correctly
+  #     # and run all Cypress tests
+  #     - name: Test Chrome
+  #       uses: cypress-io/github-action@v4
+  #       with:
+  #         # Specify Browser since container image is compile with Firefox
+  #         browser: chrome
+  #         start: yarn start
+  #         wait-on: 'http://localhost:3000'
+
+  # edge:
+  #   runs-on: ubuntu-latest
+  #   container:
+  #     image: cypress/browsers:node16.14.2-slim-chrome100-ff99-edge
+  #     options: --user 1001 # very important  otherwise there is a permission error
+  #   needs: install
+  #   strategy:
+  #     # when one test fails, DO NOT cancel the other
+  #     # containers, because this will kill Cypress processes
+  #     # leaving the Dashboard hanging ...
+  #     # https://github.com/cypress-io/github-action/issues/48
+  #     fail-fast: false
+  #     matrix:
+  #       # run copies of the current job in parallel
+  #       containers: [1]
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+
+  #     - name: Download the build folders
+  #       uses: actions/download-artifact@v3
+  #       with:
+  #         name: build
+  #         path: .next
+
+  #     # Install NPM dependencies, cache them correctly
+  #     # and run all Cypress tests
+  #     - name: Test Edge
+  #       uses: cypress-io/github-action@v4
+  #       with:
+  #         # Specify Browser since container image is compile with Firefox
+  #         browser: edge
+  #         start: yarn start
+  #         wait-on: 'http://localhost:3000'

package/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Lint / Unit tests
+
+on: ['push']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+      - run: yarn install --frozen-lockfile
+      - run: yarn lint
+      - run: yarn test

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

package/.husky/post-checkout

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/post-merge

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/post-rebase

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+CI=true npx lint-staged   

package/.lintstagedrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  '(src|__mocks__)/**/*.js': [
+    'eslint --fix',
+    'prettier --write',
+    'git add',
+    'yarn test --bail --passWithNoTests --findRelatedTests',
+  ],
+  'package.json': ['fixpack', 'git add'],
+  'src/**/*.{css,scss}': ['stylelint --fix --allow-empty-input'],
+};

package/.nvmrc

@@ -0,0 +1 @@
+20

package/.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  trailingComma: 'all',
+  singleQuote: true,
+  arrowParens: 'always',
+};

package/.stylelintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['stylelint-scss'],
+  extends: ['stylelint-config-standard', 'stylelint-config-recommended-scss'],
+};

package/CHANGELOG.md

@@ -0,0 +1,132 @@
+# 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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,248 @@
+# 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.