@wemap/osm 5.0.4 → 5.0.6

package/assets/itinerary-montpellier-osrm-3.json

@@ -0,0 +1 @@
+{"code":"Ok","routes":[{"geometry":{"coordinates":[[3.887244,43.605663],[3.887534,43.605579],[3.887765,43.605512],[3.887776,43.605508],[3.887849,43.605489]],"type":"LineString"},"legs":[{"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[112],"location":[3.887244,43.605663]},{"out":1,"location":[3.887534,43.605579],"bearings":[30,105,285],"entry":[true,true,false],"in":2}],"driving_side":"right","geometry":{"coordinates":[[3.887244,43.605663],[3.887534,43.605579],[3.887765,43.605512],[3.887776,43.605508],[3.887849,43.605489]],"type":"LineString"},"mode":"walking","duration":39.7,"maneuver":{"bearing_after":112,"location":[3.887244,43.605663],"bearing_before":0,"type":"depart"},"weight":39.7,"distance":52.4,"name":"Avenue du Pont Juvénal"},{"intersections":[{"in":0,"entry":[true],"bearings":[290],"location":[3.887849,43.605489]}],"driving_side":"right","geometry":{"coordinates":[[3.887849,43.605489],[3.887849,43.605489]],"type":"LineString"},"mode":"walking","duration":0,"maneuver":{"bearing_after":0,"type":"arrive","modifier":"right","bearing_before":110,"location":[3.887849,43.605489]},"weight":0,"distance":0,"name":"Avenue du Pont Juvénal"}],"distance":52.4,"duration":39.7,"summary":"Avenue du Pont Juvénal","weight":39.7}],"distance":52.4,"duration":39.7,"weight_name":"duration","weight":39.7}],"waypoints":[{"hint":"-y1UgREuVIG1AAAAbQEAAAAAAAAWAAAAtQAAAG0BAAAAAAAAFgAAAAIAAACMUDsAn16ZAoxQOwCfXpkCAAA_Eg61bn8=","name":"Avenue du Pont Juvénal","location":[3.887244,43.605663]},{"hint":"-S1UgRUuVIEtAAAALAAAAKsAAAAAAAAALQAAACwAAACrAAAAAAAAAAIAAADpUjsA8V2ZAsNSOwCjXZkCAwDfBg61bn8=","name":"Avenue du Pont Juvénal","location":[3.887849,43.605489]}]}

package/package.json

@@ -11,7 +11,7 @@
         "directory": "packages/osm"
     },
     "name": "@wemap/osm",
-    "version": "5.0.4",
+    "version": "5.0.6",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -31,5 +31,5 @@
         "@wemap/maths": "^5.0.0",
         "sax": "^1.2.4"
     },
-    "gitHead": "8793fda524d493f3b954d8b61d3d523a32b2f275"
+    "gitHead": "412142e60e70b1e18989c616c6c7d3b6f577ef2c"
 }

package/src/routers/Itinerary.js

@@ -1,6 +1,7 @@
 /* eslint-disable max-statements */
 import { Coordinates, Network } from '@wemap/geo';
 import Leg from './Leg.js';
+import Step from './Step.js';
 
 /**
  * Main attributes are:
@@ -53,6 +54,15 @@ class Itinerary {
         return this._coords;
     }
 
+    set steps(_) {
+        throw new Error('Itinerary.step cannot be set. They are calculated from Itinerary.legs.');
+    }
+
+    /** @type {!(Step[])} */
+    get steps() {
+        return this.legs.map(leg => leg.steps).flat();
+    }
+
     /**
      * @returns {Network}
      */

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

@@ -38,6 +38,7 @@ export function verifyStepData(step) {
     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) {

package/src/routers/Step.js

@@ -43,6 +43,9 @@ class Step {
     /** @type {?{?subwayEntrance: boolean, ?subwayEntranceRef: string}} */
     extras = {};
 
+    /** @type {!number} */
+    _idCoordsInLeg = null;
+
     /**
      * @returns {object}
      */
@@ -53,7 +56,8 @@ class Step {
             angle: this.angle,
             previousBearing: this.previousBearing,
             nextBearing: this.nextBearing,
-            distance: this.distance
+            distance: this.distance,
+            _idCoordsInLeg: this._idCoordsInLeg
         };
         if (this.firstStep) {
             output.firstStep = true;
@@ -88,6 +92,7 @@ class Step {
         step.previousBearing = json.previousBearing;
         step.nextBearing = json.nextBearing;
         step.distance = json.distance;
+        step._idCoordsInLeg = json._idCoordsInLeg;
         if (json.firstStep) {
             step.firstStep = json.firstStep;
         }

package/src/routers/Utils.js

@@ -1,10 +1,14 @@
+import { diffAngle } from '@wemap/maths';
+
 import Itinerary from './Itinerary.js';
 
 /**
  * @param {Itinerary} itinerary
  */
-export function generateStepsNumbers(itinerary) {
+export function generateStepsMetadata(itinerary) {
+
     let counter = 1;
+
     itinerary.legs.forEach((leg, legId) => {
         leg.steps.forEach((step, stepId) => {
 
@@ -17,6 +21,34 @@ export function generateStepsNumbers(itinerary) {
             }
 
             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/routers/info/ItineraryInfoManager.js

@@ -36,10 +36,7 @@ class ItineraryInfoManager {
     set itinerary(itinerary) {
 
         this._itinerary = itinerary;
-        this._steps = itinerary.legs.reduce((acc, { steps }) => {
-            acc.push(...steps);
-            return acc;
-        }, []);
+        this._steps = itinerary.steps;
         this._network = itinerary.toNetwork();
         this._mapMatching = new MapMatching(this._network);
 

package/src/routers/osrm/OsrmUtils.js

@@ -1,15 +1,13 @@
 /* eslint-disable max-statements */
 
 import { Level, Coordinates } from '@wemap/geo';
-import {
-    rad2deg, positiveMod, diffAngle, deg2rad
-} from '@wemap/maths';
+import { rad2deg, positiveMod } from '@wemap/maths';
 
 import Itinerary from '../Itinerary.js';
 import Leg from '../Leg.js';
 import RouterResponse from '../RouterResponse.js';
 import Step from '../Step.js';
-import { generateStepsNumbers } from '../Utils.js';
+import { generateStepsMetadata } from '../Utils.js';
 
 /**
  * @param {Coordinates} coordinates
@@ -151,11 +149,10 @@ export function itineraryToOsrmJson(itinerary) {
 
 /**
  * @param {object} jsonSteps
- * @param {Coordinates} itineraryStart
- * @param {Coordinates} itineraryEnd
+ * @param {Coordinates[]} legCoords
  * @returns {Step[]}
  */
-function parseJsonSteps(jsonSteps, itineraryStart, itineraryEnd) {
+function parseJsonSteps(jsonSteps, legCoords) {
 
     if (!jsonSteps) {
         return [];
@@ -166,14 +163,12 @@ function parseJsonSteps(jsonSteps, itineraryStart, itineraryEnd) {
         const step = new Step();
         step.coords = jsonToCoordinates(jsonStep.maneuver.location);
 
-        step.previousBearing = step.firstStep
-            ? itineraryStart.bearingTo(step.coords)
-            : deg2rad(jsonStep.maneuver.bearing_before);
-        step.nextBearing = step.lastStep
-            ? step.coords.bearingTo(itineraryEnd)
-            : deg2rad(jsonStep.maneuver.bearing_after);
+        const idStepCoordsInLeg = legCoords.findIndex(coords => step.coords.equalsTo(coords));
+        if (idStepCoordsInLeg < 0) {
+            throw new Error('Osrm Parser: Cannot find step coords in leg coordinates');
+        }
+        step._idCoordsInLeg = idStepCoordsInLeg;
 
-        step.angle = diffAngle(step.previousBearing, step.nextBearing + Math.PI);
         step.name = jsonStep.name;
         step.levelChange = jsonStep.levelChange ? jsonStep.levelChange : null;
 
@@ -240,17 +235,11 @@ export function createRouterResponseFromJson(json, from, to, routingMode = 'walk
             leg.distance = jsonLeg.distance;
             leg.duration = jsonLeg.duration;
 
-            leg.coords = jsonLeg.steps.reduce((acc, step) => {
-                acc.push(...step.geometry.coordinates.map(jsonToCoordinates));
-                return acc;
-            }, []);
-            // Remove duplicates
-            leg.coords = leg.coords.reduce((acc, val) => {
-                if (acc.length === 0 || !acc[acc.length - 1].equalsTo(val)) {
-                    acc.push(val);
-                }
-                return acc;
-            }, []);
+            leg.coords = jsonLeg.steps
+                .map(step => step.geometry.coordinates.map(jsonToCoordinates))
+                .flat()
+                // Remove duplicates
+                .filter((coords, idx, arr) => idx === 0 || !arr[idx - 1].equalsTo(coords));
 
             leg.from = {
                 name: null,
@@ -261,12 +250,14 @@ export function createRouterResponseFromJson(json, from, to, routingMode = 'walk
                 coords: leg.coords[leg.coords.length - 1]
             };
 
-            leg.steps = parseJsonSteps(jsonLeg.steps, from, to);
+            leg.steps = parseJsonSteps(jsonLeg.steps, leg.coords);
 
             itinerary.legs.push(leg);
         }
 
-        generateStepsNumbers(itinerary);
+        // All legs have to be parsed before computing steps metadata
+        generateStepsMetadata(itinerary);
+
     }
 
     return routerResponse;

package/src/routers/osrm/OsrmUtils.spec.js

@@ -1,5 +1,6 @@
 /* eslint-disable max-statements */
 import chai from 'chai';
+import chaiAlmost from 'chai-almost';
 import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
@@ -21,6 +22,8 @@ import {
 import { verifyRouterResponseData } from '../RouterResponse.type.spec.js';
 
 const { expect } = chai;
+chai.use(chaiAlmost(0.1));
+
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 
@@ -427,5 +430,28 @@ describe('OsrmUtils - createRouterResponseFromJson', () => {
 
     });
 
+
+    it('RouterResponse - 2', () => {
+
+        const filePath = path.resolve(__dirname, '../../../assets/itinerary-montpellier-osrm-3.json');
+        const fileString = fs.readFileSync(filePath, 'utf8');
+        const json = JSON.parse(fileString);
+
+        const from = new Coordinates(43.605663, 3.887244);
+        const to = new Coordinates(43.6054106, 3.8878106);
+        const routerResponse = createRouterResponseFromJson(json, from, to);
+        verifyRouterResponseData(routerResponse);
+
+        expect(routerResponse.routerName).equal('osrm');
+        expect(routerResponse.itineraries.length).equal(1);
+        expect(routerResponse.from.equalsTo(from)).true;
+        expect(routerResponse.to.equalsTo(to)).true;
+
+        const steps = routerResponse.itineraries[0].steps;
+        expect(steps.length).equal(2);
+        expect(steps[1].angle).almost.equal(1.575);
+
+    });
+
 });
 

package/src/routers/otp/OtpUtils.js

@@ -2,13 +2,12 @@
 import Polyline from '@mapbox/polyline';
 
 import { Coordinates } from '@wemap/geo';
-import { diffAngle } from '@wemap/maths';
 
 import Itinerary from '../Itinerary.js';
 import Leg from '../Leg.js';
 import RouterResponse from '../RouterResponse.js';
 import Step from '../Step.js';
-import { generateStepsNumbers } from '../Utils.js';
+import { generateStepsMetadata } from '../Utils.js';
 
 /**
  * @param {object} json
@@ -21,11 +20,9 @@ export function jsonToCoordinates(json) {
 /**
  * @param {object} jsonSteps
  * @param {Coordinates[]} legCoords
- * @param {Coordinates} itineraryStart
- * @param {Coordinates} itineraryEnd
  * @returns {Step[]}
  */
-function parseJsonSteps(jsonSteps, legCoords, itineraryStart) {
+function parseJsonSteps(jsonSteps, legCoords) {
 
     if (!jsonSteps) {
         return [];
@@ -44,15 +41,7 @@ function parseJsonSteps(jsonSteps, legCoords, itineraryStart) {
             throw new Error('OTP Parser: Cannot find closest step');
         }
         step.coords = legCoords[idStepCoordsInLeg];
-
-        step.previousBearing = idStepCoordsInLeg === 0
-            ? itineraryStart.bearingTo(step.coords)
-            : legCoords[idStepCoordsInLeg - 1].bearingTo(legCoords[idStepCoordsInLeg]);
-        step.nextBearing = idStepCoordsInLeg === legCoords.length - 1
-            ? 0
-            : legCoords[idStepCoordsInLeg].bearingTo(legCoords[idStepCoordsInLeg + 1]);
-
-        step.angle = diffAngle(step.previousBearing, step.nextBearing + Math.PI);
+        step._idCoordsInLeg = idStepCoordsInLeg;
 
         step.name = jsonStep.streetName;
         step.levelChange = null;
@@ -112,6 +101,8 @@ export function createRouterResponseFromJson(json) {
             };
             leg.coords = Polyline.decode(jsonLeg.legGeometry.points).map(([lat, lon]) => new Coordinates(lat, lon));
 
+            leg.steps = parseJsonSteps(jsonLeg.steps, leg.coords);
+
             if (leg.mode === 'BUS' || leg.mode === 'TRAM') {
                 leg.transportInfo = {
                     name: jsonLeg.route,
@@ -119,6 +110,14 @@ export function createRouterResponseFromJson(json) {
                     routeTextColor: jsonLeg.routeTextColor,
                     directionName: jsonLeg.headsign
                 };
+
+                const legStep = new Step();
+                legStep.coords = leg.coords[0];
+                legStep._idCoordsInLeg = 0;
+                legStep.name = jsonLeg.headsign;
+                legStep.levelChange = null;
+                legStep.distance = jsonLeg.distance;
+                leg.steps = [legStep];
             }
 
             // jsonLeg.distance is not reliable when compared to the array of leg coords.
@@ -130,32 +129,10 @@ export function createRouterResponseFromJson(json) {
                 return acc + arr[idx - 1].distanceTo(coords);
             }, 0);
 
-            let previousPoint;
-            if (itinerary.legs.length === 0) {
-                previousPoint = itinerary.from;
-            } else {
-                const lastLeg = itinerary.legs[itinerary.legs.length - 1];
-                previousPoint = lastLeg.coords[lastLeg.coords.length - 1];
-            }
-
-            leg.steps = parseJsonSteps(
-                jsonLeg.steps,
-                leg.coords,
-                previousPoint
-            );
-            // itinerary.coords.push(...leg.coords);
             itinerary.legs.push(leg);
 
         }
 
-        // Remove duplicates
-        // itinerary.coords = itinerary.coords.reduce((acc, val) => {
-        //     if (acc.length === 0 || !acc[acc.length - 1].equalsTo(val)) {
-        //         acc.push(val);
-        //     }
-        //     return acc;
-        // }, []);
-
         itinerary.distance = itinerary.coords.reduce((acc, coords, idx, arr) => {
             if (idx === 0) {
                 return acc;
@@ -163,7 +140,8 @@ export function createRouterResponseFromJson(json) {
             return acc + arr[idx - 1].distanceTo(coords);
         }, 0);
 
-        generateStepsNumbers(itinerary);
+        // All legs have to be parsed before computing steps metadata
+        generateStepsMetadata(itinerary);
     }
 
     return routerResponse;