@wemap/routers 6.2.2 → 7.0.0

package/index.js

@@ -13,14 +13,22 @@ export { default as WemapRouter } from './src/wemap/WemapRouter.js';
 export { default as WemapRouterOptions } from './src/wemap/WemapRouterOptions.js';
 export * as WemapRouterUtils from './src/wemap/WemapRouterUtils.js';
 export * as WemapNetworkUtils from './src/wemap/WemapNetworkUtils.js';
+export { default as WemapMetaRouter } from './src/wemap-meta/WemapMetaRouter.js';
+export { default as WemapMetaRouterOptions } from './src/wemap-meta/WemapMetaRouterOptions.js';
+export { default as WemapMetaRouterIOMap } from './src/wemap-meta/IOMap.js';
 
 /* Other Routers */
-export * as OsrmUtils from './src/osrm/OsrmUtils.js';
-export * as OtpUtils from './src/otp/OtpUtils.js';
-export * as CitywayUtils from './src/cityway/CitywayUtils.js';
-export * as DeutscheBahnRouterUtils from './src/deutsche-bahn/DeutscheBahnRouterUtils.js';
-export * as IdfmUtils from './src/idfm/IdfmUtils.js';
+export { default as OsrmRemoteRouter } from './src/remote/osrm/OsrmRemoteRouter.js';
+export { default as OtpRemoteRouter } from './src/remote/otp/OtpRemoteRouter.js';
+export { default as CitywayRemoteRouter } from './src/remote/cityway/CitywayRemoteRouter.js';
+export { default as DeutscheBahnRemoteRouter } from './src/remote/deutsche-bahn/DeutscheBahnRemoteRouter.js';
+export { default as IdfmRemoteRouter } from './src/remote/idfm/IdfmRemoteRouter.js';
+export { default as WemapMetaRemoteRouter } from './src/remote/wemap-meta/WemapMetaRemoteRouter.js';
+export { default as WemapMetaRemoteRouterOptions } from './src/remote/wemap-meta/WemapMetaRemoteRouterOptions.js';
+export { default as WemapMetaRemoteRouterPayload } from './src/remote/wemap-meta/WemapMetaRemoteRouterPayload.js';
+
 
 /* Others */
 export { default as ItineraryInfoManager } from './src/ItineraryInfoManager.js';
 export * from './src/Utils.js';
+export { default as Constants } from './src/Constants.js';

package/package.json

@@ -11,7 +11,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "6.2.2",
+    "version": "7.0.0",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -26,10 +26,13 @@
     "license": "ISC",
     "dependencies": {
         "@mapbox/polyline": "^1.1.1",
-        "@wemap/geo": "^6.2.2",
-        "@wemap/logger": "^6.0.0",
-        "@wemap/maths": "^6.0.0",
-        "@wemap/osm": "^6.2.2"
+        "@turf/boolean-point-in-polygon": "^6.5.0",
+        "@turf/convex": "^6.5.0",
+        "@turf/helpers": "^6.5.0",
+        "@wemap/geo": "^7.0.0",
+        "@wemap/logger": "^7.0.0",
+        "@wemap/maths": "^7.0.0",
+        "@wemap/osm": "^7.0.0"
     },
-    "gitHead": "ee717a21b2f01820472df0112da9373044f267f9"
+    "gitHead": "cfd70d1f998599c53689c1b1996a517247f04dce"
 }

package/src/Constants.js

@@ -9,10 +9,13 @@ Constants.ROUTING_MODE = {
     FERRY: 'FERRY',
     FUNICULAR: 'FUNICULAR',
     METRO: 'METRO',
+    MOTO: 'MOTO',
     TRAIN: 'TRAIN',
     TAXI: 'TAXI',
     TRAM: 'TRAM',
-    WALK: 'WALK'
+    WALK: 'WALK',
+    MULTI: 'MULTI',
+    UNKNOWN: 'UNKNOWN'
 };
 
 Constants.PUBLIC_TRANSPORT = [
@@ -23,7 +26,6 @@ Constants.PUBLIC_TRANSPORT = [
     Constants.ROUTING_MODE.FUNICULAR,
     Constants.ROUTING_MODE.METRO,
     Constants.ROUTING_MODE.TRAIN,
-    Constants.ROUTING_MODE.TAXI,
     Constants.ROUTING_MODE.TRAM
 ];
 

package/src/ItineraryInfoManager.spec.js

@@ -6,7 +6,7 @@ import { fileURLToPath } from 'url';
 
 import { Coordinates, GraphEdge, GraphNode } from '@wemap/geo';
 
-import { createRouterResponseFromJson } from './otp/OtpUtils.js';
+import OtpRemoteRouter from './remote/otp/OtpRemoteRouter.js';
 import ItineraryInfoManager from './ItineraryInfoManager.js';
 
 
@@ -19,7 +19,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const filePath = path.resolve(__dirname, '../assets/itinerary-grenoble-otp-1.json');
 const fileString = fs.readFileSync(filePath, 'utf8');
 const json = JSON.parse(fileString);
-const routerResponse = createRouterResponseFromJson(json);
+const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json);
 
 let position, itineraryInfo;
 

package/src/Utils.js

@@ -1,7 +1,3 @@
-import { diffAngle } from '@wemap/maths';
-
-import Itinerary from './model/Itinerary.js';
-
 /**
  * Get route duration
  * @param {Number} speed in km/h
@@ -10,76 +6,3 @@ import Itinerary from './model/Itinerary.js';
 export function getDurationFromLength(length, speed = 5) {
     return length / (speed * 1000 / 3600);
 }
-
-/**
- * Create and return a date with a given timezone
- * @param {number} year
- * @param {number} month
- * @param {number} day
- * @param {number} hours
- * @param {number} minutes
- * @param {number} seconds
- * @param {string} timeZone - timezone name (e.g. 'Europe/Paris')
- */
-export function dateWithTimeZone(year, month, day, hour, minute, second, timeZone = 'Europe/Paris') {
-    const date = new Date(Date.UTC(year, month, day, hour, minute, second));
-
-    const utcDate = new Date(date.toLocaleString('en-US', { timeZone: 'UTC' }));
-    const tzDate = new Date(date.toLocaleString('en-US', { timeZone: timeZone }));
-    const offset = utcDate.getTime() - tzDate.getTime();
-
-    date.setTime(date.getTime() + offset);
-
-    return date;
-}
-
-/**
- * @param {Itinerary} itinerary
- */
-export function generateStepsMetadata(itinerary) {
-
-    let counter = 1;
-
-    itinerary.legs.forEach((leg, legId) => {
-        leg.steps.forEach((step, stepId) => {
-
-            if (counter === 1) {
-                step.firstStep = true;
-            }
-            if (legId === itinerary.legs.length - 1
-                && stepId === leg.steps.length - 1) {
-                step.lastStep = true;
-            }
-
-            step.number = counter++;
-
-
-            /*
-             * Generate previousBearing, nextBearing and angle
-             */
-
-            let coordsBeforeStep;
-            if (step._idCoordsInLeg > 0) {
-                coordsBeforeStep = leg.coords[step._idCoordsInLeg - 1];
-            } else if (legId === 0) {
-                coordsBeforeStep = itinerary.from;
-            } else {
-                coordsBeforeStep = itinerary.legs[legId - 1].to.coords;
-            }
-
-            let coordsAfterStep;
-            if (step._idCoordsInLeg !== leg.coords.length - 1) {
-                coordsAfterStep = leg.coords[step._idCoordsInLeg + 1];
-            } else if (legId === itinerary.legs.length - 1) {
-                coordsAfterStep = itinerary.to;
-            } else {
-                coordsAfterStep = itinerary.legs[legId + 1].from.coords;
-            }
-
-            step.previousBearing = coordsBeforeStep.bearingTo(step.coords);
-            step.nextBearing = step.coords.bearingTo(coordsAfterStep);
-            step.angle = diffAngle(step.previousBearing, step.nextBearing + Math.PI);
-
-        });
-    });
-}

package/src/model/Itinerary.js

@@ -74,9 +74,9 @@ class Itinerary {
 
     get mode() {
         if (!this._mode) {
-            let isPublicTransport;
-            let isBicycle;
-            let isDriving;
+            let isPublicTransport = false;
+            let isBicycle = false;
+            let isDriving = false;
 
             this.legs.forEach((leg) => {
                 isPublicTransport = isPublicTransport || Constants.PUBLIC_TRANSPORT.includes(leg.mode);
@@ -189,6 +189,42 @@ class Itinerary {
         return itinerary;
     }
 
+
+    /**
+     * @param {Itinerary} obj1
+     * @param {Itinerary} obj2
+     * @returns {Boolean}
+     */
+    static equalsTo(obj1, obj2) {
+        const intermediate = obj1.from.equalsTo(obj2.from)
+            && obj1.to.equalsTo(obj2.to)
+            && obj1.distance === obj2.distance
+            && obj1.duration === obj2.duration
+            && obj1.startTime === obj2.startTime
+            && obj1.endTime === obj2.endTime
+            && obj1.legs.length === obj2.legs.length;
+
+        if (!intermediate) {
+            return false;
+        }
+
+        for (let i = 0; i < obj1.legs.length; i++) {
+            if (!obj1.legs[i].equalsTo(obj2.legs[i])) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * @param {Itinerary} obj
+     * @returns {Boolean}
+     */
+    equalsTo(obj) {
+        return Itinerary.equalsTo(this, obj);
+    }
+
     /**
      * @returns {object}
      */
@@ -221,10 +257,10 @@ class Itinerary {
         itinerary.distance = json.distance;
         itinerary.duration = json.duration;
         itinerary.legs = json.legs.map(Leg.fromJson);
-        if (json.startTime) {
+        if (typeof json.startTime === 'number') {
             itinerary.startTime = json.startTime;
         }
-        if (json.endTime) {
+        if (typeof json.endTime === 'number') {
             itinerary.endTime = json.endTime;
         }
         return itinerary;

package/src/model/Itinerary.spec.js

@@ -0,0 +1,91 @@
+/* eslint-disable max-statements */
+import chai from 'chai';
+
+import { Coordinates } from '@wemap/geo';
+
+import Itinerary from './Itinerary.js';
+import checkItineraryType from './Itinerary.type.spec.js';
+import { leg1, leg2, leg3, leg4 } from './Leg.spec.js';
+
+const { expect } = chai;
+
+const itinerary1 = new Itinerary();
+itinerary1.from = new Coordinates(0, 0);
+itinerary1.to = new Coordinates(1, 0);
+itinerary1.distance = 10;
+itinerary1.duration = 20;
+itinerary1.legs = [leg1];
+
+const itinerary2 = new Itinerary();
+itinerary2.from = new Coordinates(0, 0);
+itinerary2.to = new Coordinates(1, 0);
+itinerary2.distance = 100;
+itinerary2.duration = 200;
+itinerary2.startTime = 0;
+itinerary2.endTime = 10;
+itinerary2.legs = [leg1, leg2];
+
+const itinerary3 = new Itinerary();
+itinerary3.from = new Coordinates(0, 0);
+itinerary3.to = new Coordinates(2, 0);
+itinerary3.distance = 1000;
+itinerary3.duration = 2000;
+itinerary3.legs = [leg1, leg2, leg3, leg4];
+
+const itinerary4 = new Itinerary();
+itinerary4.from = new Coordinates(1, 0);
+itinerary4.to = new Coordinates(4, 0);
+itinerary4.distance = 10000;
+itinerary4.duration = 20000;
+itinerary4.legs = [leg1];
+
+const itinerary5 = new Itinerary();
+Object.assign(itinerary5, itinerary4);
+
+describe('Itinerary', () => {
+
+    it('checkTypes', () => {
+        checkItineraryType(itinerary1);
+        checkItineraryType(itinerary2);
+        checkItineraryType(itinerary3);
+        checkItineraryType(itinerary4);
+    });
+
+    it('equals', () => {
+        expect(itinerary1.equalsTo(itinerary1)).is.true;
+        expect(itinerary2.equalsTo(itinerary2)).is.true;
+        expect(itinerary3.equalsTo(itinerary3)).is.true;
+        expect(itinerary4.equalsTo(itinerary4)).is.true;
+        expect(itinerary4.equalsTo(itinerary5)).is.true;
+        expect(itinerary1.equalsTo(itinerary2)).is.false;
+        expect(itinerary1.equalsTo(itinerary3)).is.false;
+        expect(itinerary1.equalsTo(itinerary4)).is.false;
+    });
+
+    it('from / to JSON', () => {
+
+        const itinerary1Json = itinerary1.toJson();
+        expect(itinerary1Json).be.an('object');
+        const itinerary1Bis = Itinerary.fromJson(itinerary1Json);
+        expect(itinerary1.equalsTo(itinerary1Bis)).is.true;
+
+        const itinerary2Json = itinerary2.toJson();
+        expect(itinerary2Json).be.an('object');
+        const itinerary2Bis = Itinerary.fromJson(itinerary2Json);
+        expect(itinerary2.equalsTo(itinerary2Bis)).is.true;
+
+        const itinerary3Json = itinerary3.toJson();
+        expect(itinerary3Json).be.an('object');
+        const itinerary3Bis = Itinerary.fromJson(itinerary3Json);
+        expect(itinerary3.equalsTo(itinerary3Bis)).is.true;
+
+        const itinerary4Json = itinerary4.toJson();
+        expect(itinerary4Json).be.an('object');
+        const itinerary4Bis = Itinerary.fromJson(itinerary4Json);
+        expect(itinerary4.equalsTo(itinerary4Bis)).is.true;
+
+    });
+
+});
+
+export { itinerary1, itinerary2, itinerary3, itinerary4 };

package/src/model/Itinerary.type.spec.js

@@ -2,92 +2,17 @@ import chai from 'chai';
 
 import { Coordinates } from '@wemap/geo';
 
-import LevelChange from './LevelChange.js';
-import Leg from './Leg.js';
+import checkLegType from './Leg.type.spec.js';
 import Itinerary from './Itinerary.js';
-import Step from './Step.js';
 
 const { expect } = chai;
 
-
 const isNullOrNumber = val => val === null || typeof val === 'number';
-const isNullOrString = val => val === null || typeof val === 'string';
-const isNullOrObject = val => val === null || typeof val === 'object';
-const isNullOrArray = val => val === null || Array.isArray(val);
-const isNullOrLevelChange = val => val === null || val instanceof LevelChange;
-
-const isUndefinedOrBoolean = val => typeof val === 'undefined' || typeof val === 'boolean';
-const isUndefinedOrString = val => typeof val === 'undefined' || typeof val === 'string';
-
-const stepExtraProperties = ['subwayEntrance', 'subwayEntranceRef'];
-
-/**
- * @param {Step} step
- */
-export function verifyStepData(step) {
-
-    expect(step).instanceOf(Step);
-    expect(step.firstStep).be.a('boolean');
-    expect(step.lastStep).be.a('boolean');
-    expect(step.number).be.a('number');
-    expect(step.coords).instanceOf(Coordinates);
-    expect(step.angle).be.a('number');
-    expect(step.previousBearing).be.a('number');
-    expect(step.nextBearing).be.a('number');
-    expect(step.distance).be.a('number');
-    expect(step.duration).satisfies(isNullOrNumber);
-    expect(step.name).satisfies(isNullOrString);
-    expect(step.levelChange).satisfies(isNullOrLevelChange);
-    expect(step._idCoordsInLeg).be.a('number');
-
-    expect(step.extras).satisfies(isNullOrObject);
-    if (step.extras !== null) {
-        for (const key of Object.keys(step.extras)) {
-            expect(stepExtraProperties).includes(key);
-        }
-        expect(step.extras.subwayEntrance).satisfies(isUndefinedOrBoolean);
-        expect(step.extras.subwayEntranceRef).satisfies(isUndefinedOrString);
-    }
-}
-
-/**
- * @param {Leg} routerResponse
- */
-export function verifyLegData(leg) {
-
-    expect(leg).instanceOf(Leg);
-    expect(leg.mode).be.a('string');
-    expect(leg.distance).be.a('number');
-    expect(leg.duration).be.a('number');
-    expect(leg.startTime).satisfies(isNullOrNumber);
-    expect(leg.endTime).satisfies(isNullOrNumber);
-    expect(leg.from).be.an('object');
-    expect(leg.from.name).satisfies(isNullOrString);
-    expect(leg.from.coords).instanceOf(Coordinates);
-    expect(leg.to).be.an('object');
-    expect(leg.to.name).satisfies(isNullOrString);
-    expect(leg.to.coords).instanceOf(Coordinates);
-    expect(leg.coords).be.an('array');
-    leg.coords.forEach(coords => expect(coords).instanceOf(Coordinates));
-
-    expect(leg.transportInfo).satisfies(isNullOrObject);
-    if (leg.transportInfo !== null) {
-        expect(leg.transportInfo.name).be.a('string');
-        expect(leg.transportInfo.routeColor).satisfies(isNullOrString);
-        expect(leg.transportInfo.routeTextColor).satisfies(isNullOrString);
-        expect(leg.transportInfo.directionName).satisfies(isNullOrString);
-    }
-    expect(leg.steps).satisfies(isNullOrArray);
-    if (leg.steps !== null) {
-        leg.steps.forEach(verifyStepData);
-    }
-}
-
 
 /**
  * @param {Itinerary} itinerary
  */
-export function verifyItineraryData(itinerary) {
+export default function checkItineraryType(itinerary) {
 
     expect(itinerary).instanceOf(Itinerary);
     expect(itinerary.mode).be.a('string');
@@ -102,5 +27,5 @@ export function verifyItineraryData(itinerary) {
     expect(itinerary.startTime).satisfies(isNullOrNumber);
     expect(itinerary.endTime).satisfies(isNullOrNumber);
     expect(itinerary.legs).be.an('array');
-    itinerary.legs.forEach(verifyLegData);
+    itinerary.legs.forEach(checkLegType);
 }

package/src/model/Leg.js

@@ -46,6 +46,72 @@ class Leg {
         return Network.fromCoordinates([this.coords]);
     }
 
+
+    /**
+     * @param {Leg} obj1
+     * @param {Leg} obj2
+     * @returns {Boolean}
+     */
+    // eslint-disable-next-line complexity
+    static equalsTo(obj1, obj2) {
+        const intermediate = obj1.mode === obj2.mode
+            && obj1.distance === obj2.distance
+            && obj1.duration === obj2.duration
+            && obj1.startTime === obj2.startTime
+            && obj1.endTime === obj2.endTime
+            && obj1.from.name === obj2.from.name
+            && obj1.from.coords.equalsTo(obj2.from.coords)
+            && obj1.to.name === obj2.to.name
+            && obj1.to.coords.equalsTo(obj2.to.coords)
+            && obj1.coords.length === obj2.coords.length
+            && (
+                obj1.steps === obj2.steps
+                || obj1.steps.length === obj2.steps.length
+            );
+
+        if (!intermediate) {
+            return false;
+        }
+
+        let i;
+        for (i = 0; i < obj1.coords.length; i++) {
+            if (!obj1.coords[i].equalsTo(obj2.coords[i])) {
+                return false;
+            }
+        }
+        if (obj1.steps) {
+            for (i = 0; i < obj1.steps.length; i++) {
+                if (!obj1.steps[i].equalsTo(obj2.steps[i])) {
+                    return false;
+                }
+            }
+        }
+
+        if (obj1.transportInfo !== obj2.transportInfo) {
+            if (obj1.transportInfo === null) {
+                return false;
+            }
+            if (
+                obj1.transportInfo.name !== obj2.transportInfo.name
+                || obj1.transportInfo.routeColor !== obj2.transportInfo.routeColor
+                || obj1.transportInfo.routeTextColor !== obj2.transportInfo.routeTextColor
+                || obj1.transportInfo.directionName !== obj2.transportInfo.directionName
+            ) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * @param {Leg} obj
+     * @returns {Boolean}
+     */
+    equalsTo(obj) {
+        return Leg.equalsTo(this, obj);
+    }
+
     /**
      * @returns {object}
      */
@@ -58,18 +124,18 @@ class Leg {
             duration: this.duration,
             coords: this.coords.map(coords => coords.toCompressedJson())
         };
-        if (this.from.name) {
-            output.from.name = this.from.name;
-        }
-        if (this.to.name) {
-            output.to.name = this.to.name;
-        }
         if (this.startTime !== null) {
             output.startTime = this.startTime;
         }
         if (this.endTime !== null) {
             output.endTime = this.endTime;
         }
+        if (this.from.name !== null) {
+            output.from.name = this.from.name;
+        }
+        if (this.to.name !== null) {
+            output.to.name = this.to.name;
+        }
         if (this.transportInfo !== null) {
             output.transportInfo = this.transportInfo;
         }
@@ -87,27 +153,31 @@ class Leg {
     static fromJson(json) {
         const leg = new Leg();
         leg.mode = json.mode;
-        leg.from = { coords: Coordinates.fromCompressedJson(json.from.coords) };
-        leg.to = { coords: Coordinates.fromCompressedJson(json.to.coords) };
         leg.distance = json.distance;
         leg.duration = json.duration;
-        leg.coords = json.coords.map(Coordinates.fromCompressedJson);
-        if (json.from.name) {
-            leg.from.name = json.from.name;
-        }
-        if (json.to.name) {
-            leg.to.name = json.to.name;
-        }
-        if (json.startTime) {
+
+        if (typeof json.startTime === 'number') {
             leg.startTime = json.startTime;
         }
-        if (json.endTime) {
+        if (typeof json.endTime === 'number') {
             leg.endTime = json.endTime;
         }
-        if (json.transportInfo) {
+
+        leg.from = {
+            coords: Coordinates.fromCompressedJson(json.from.coords),
+            name: typeof json.from.name === 'string' ? json.from.name : null
+        };
+        leg.to = {
+            coords: Coordinates.fromCompressedJson(json.to.coords),
+            name: typeof json.to.name === 'string' ? json.to.name : null
+        };
+
+        leg.coords = json.coords.map(Coordinates.fromCompressedJson);
+
+        if (typeof json.transportInfo === 'object') {
             leg.transportInfo = json.transportInfo;
         }
-        if (json.steps) {
+        if (typeof json.steps === 'object') {
             leg.steps = json.steps.map(Step.fromJson);
         }
         return leg;