mobility-toolbox-js 2.0.0-beta.3 → 2.0.0-beta.9

package/.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-react"
+  ]
+}

package/.esdoc.json

@@ -0,0 +1,17 @@
+{
+  "source": "./src",
+  "destination": "./apidoc",
+  "includes": ["\\.js$"],
+  "excludes": ["\\.test\\.js$", "doc/", "(u|U)tils"],
+  "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" }
+  ]
+}

package/.eslintignore

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

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

@@ -0,0 +1,21 @@
+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@v2.2.0
+        with:
+          success-state: Title follows the specification.
+          failure-state: Title does not follow the specification.
+          context-name: conventional-pr-title
+          preset: conventional-changelog-angular@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/cypress.yml

@@ -0,0 +1,29 @@
+name: Cypress
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run and record Cypress tests
+        run: yarn run cy:test

package/.github/workflows/nodejs.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: yarn install, build, and test
+        run: |
+          echo '[]' > src/doc/components/Esdoc/index.json
+          npm install -g yarn
+          yarn install
+          yarn lint
+          yarn test
+          yarn build
+        env:
+          CI: true

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/.neutrinorc.js

@@ -0,0 +1,176 @@
+const react = require('@neutrinojs/react');
+const library = require('@neutrinojs/library');
+const copy = require('@neutrinojs/copy');
+const jest = require('@neutrinojs/jest');
+const styles = require('@neutrinojs/style-loader');
+const merge = require('deepmerge');
+const path = require('path');
+
+const webpackDevServer = (neutrino) => {
+  neutrino.config.watchOptions({
+    ignored: /node_modules/,
+  });
+};
+
+if (process.env.REACT_APP_LIB_MODE) {
+  module.exports = {
+    options: {
+      root: __dirname,
+      mains: {
+        index: './index.js',
+      },
+    },
+    use: [
+      (neutrino) => {
+        neutrino.config.output
+          .globalObject('this') // will prevent `window`
+          .end()
+          .module.rule('worker')
+          .test(neutrino.regexFromExtensions(['worker.js']))
+          .use('worker')
+          .loader(require.resolve('worker-loader'))
+          .options({
+            // See: https://github.com/webpack-contrib/worker-loader#options
+          });
+      },
+      library({
+        name: 'mobility-toolbox-js',
+        targets: {
+          browsers: [
+            'last 2 Chrome versions',
+            'last 2 Firefox versions',
+            'last 2 Edge versions',
+            'last 2 Opera versions',
+            'last 2 Safari versions',
+            'last 2 iOS versions',
+            'ie 11',
+          ],
+        },
+      }),
+      jest({
+        testRegex: 'src/.*.test.js$',
+        coveragePathIgnorePatterns: ['src/doc/'],
+        coverageReporters: ['text', 'html'],
+        snapshotSerializers: ['jest-serializer-html'],
+        setupFilesAfterEnv: ['<rootDir>/src/setupTests.js'],
+        globalSetup: './global-setup.js',
+        transformIgnorePatterns: [
+          '/node_modules/(?!(ol|ol-mapbox-style|geotiff)/).*/',
+        ],
+      }),
+      (neutrino) => {
+        if (process.env.NODE_ENV === 'test') {
+          neutrino.config.module
+            .rule('compile')
+            .use('babel')
+            .tap((options) =>
+              merge(options, {
+                env: {
+                  test: {
+                    plugins: ['@babel/plugin-transform-runtime'], // async/await
+                  },
+                },
+              }),
+            );
+        }
+      },
+      copy({
+        patterns: [
+          {
+            from: path.join(__dirname, 'README.md'),
+            to: path.join(__dirname, 'build/README.md'),
+          },
+          {
+            from: path.join(__dirname, 'src/api'),
+            to: path.join(__dirname, 'build/api'),
+          },
+          {
+            from: path.join(__dirname, 'src/common'),
+            to: path.join(__dirname, 'build/common'),
+          },
+          {
+            from: path.join(__dirname, 'src/ol'),
+            to: path.join(__dirname, 'build/ol'),
+          },
+          {
+            from: path.join(__dirname, 'src/mapbox'),
+            to: path.join(__dirname, 'build/mapbox'),
+          },
+          {
+            from: path.join(__dirname, 'package.json'),
+            to: path.join(__dirname, 'build/package.json'),
+          },
+          {
+            from: path.join(__dirname, 'src/index.js'),
+            to: path.join(__dirname, 'build/module.js'),
+          },
+        ],
+      }),
+    ],
+  };
+} else {
+  module.exports = {
+    options: {
+      root: __dirname,
+      mains: {
+        index: 'doc/index.js',
+      },
+    },
+    use: [
+      react({
+        html: {
+          title: 'mobility-toolbox-js',
+          favicon: 'src/doc/img/favico.ico',
+        },
+        targets: {
+          browsers: [
+            'last 2 Chrome versions',
+            'last 2 Firefox versions',
+            'last 2 Edge versions',
+            'last 2 Opera versions',
+            'last 2 Safari versions',
+            'last 2 iOS versions',
+            'ie 11',
+          ],
+        },
+        style: {
+          // Override the default file extension of `.css` if needed
+          test: /\.(css|sass|scss)$/,
+          modulesTest: /\.module\.(css|sass|scss)$/,
+          loaders: [
+            // Define loaders as objects. Note: loaders must be specified in reverse order.
+            // ie: for the loaders below the actual execution order would be:
+            // input file -> sass-loader -> postcss-loader -> css-loader -> style-loader/mini-css-extract-plugin
+            {
+              loader: 'postcss-loader',
+              options: {
+                plugins: [require('autoprefixer')],
+              },
+            },
+            {
+              loader: 'sass-loader',
+              useId: 'sass',
+            },
+          ],
+        },
+      }),
+      webpackDevServer,
+      copy({
+        patterns: [
+          {
+            from: path.join(__dirname, 'README.md'),
+            to: path.join(__dirname, 'build/README.md'),
+          },
+          {
+            from: path.join(__dirname, 'src/doc/examples'),
+            to: path.join(__dirname, 'build/examples'),
+          },
+          {
+            from: path.join(__dirname, 'src/doc/_redirects'),
+            to: path.join(__dirname, 'build/'),
+          },
+        ],
+      }),
+    ],
+  };
+}

package/.nvmrc

@@ -0,0 +1 @@
+14

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 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.0.0](https://github.com/geops/mobility-toolbox-js/compare/v1.7.5...v2.0.0) (2022-06-20)
+
+
+### Features
+
+* 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/README.md

@@ -8,13 +8,16 @@ The tools in this library have been inspired by many projects realized for publi
 [![Netlify Status](https://api.netlify.com/api/v1/badges/b368ab18-9dbf-416c-91f6-a82076b02c10/deploy-status)](https://app.netlify.com/sites/mobility-toolbox-js/deploys)
 
 ## Main Features
+
 * Display [real-time vehicle positions and prognosis data](http://tracker.geops.ch/) on a map.
 * Search for [stops and stations](https://maps2.trafimage.ch) all over the world.
 * Get [precise geographic courses](https://geops.github.io/geops-routing-demo/) for all modes of transport.
 * Generate beautiful maps for public transport, mobility and logistics
 
 ## Documentation and examples
-Visit https://mobility-toolbox-js.geops.io
+
+Visit https://master--mobility-toolbox-js.netlify.app/
 
 ## Version 1.x.x
+
 The master branch is now open for the version 2 development. The version 1 is still available in [1.x.x](https://github.com/geops/mobility-toolbox-js/tree/1.x.x) branch.

package/__mocks__/mapbox-gl.js

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

@@ -0,0 +1,81 @@
+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/commitlint.config.js

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

package/cypress/fixtures/example.json

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

package/cypress/integration/examples/api.spec.js

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

package/cypress/integration/examples/examples.spec.js

@@ -0,0 +1,7 @@
+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/integration/examples/navigation.spec.js

@@ -0,0 +1,29 @@
+// / <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', 'api');
+
+    cy.go('forward');
+    cy.location('pathname').should('include', 'examples');
+
+    // clicking back
+    cy.go(-1);
+    cy.location('pathname').should('include', 'api');
+
+    // clicking forward
+    cy.go(1);
+    cy.location('pathname').should('include', 'examples');
+  });
+});

package/cypress/plugins/index.js

@@ -0,0 +1,21 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

package/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

package/cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package/cypress.json

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:5000",
+  "video": false
+}