@wemap/routers 8.1.0 → 8.2.1

package/package.json

@@ -11,7 +11,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "8.1.0",
+    "version": "8.2.1",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -34,5 +34,5 @@
         "@wemap/maths": "^8.1.0",
         "@wemap/osm": "^8.1.0"
     },
-    "gitHead": "cadc0d73f0b0b5730c09b67836c31fbdb4fe94a3"
+    "gitHead": "6f0d3c90242a914f3daf7fcee165a4283c459fef"
 }

package/src/ItineraryInfoManager.spec.js

@@ -19,7 +19,9 @@ 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 = OtpRemoteRouter.createRouterResponseFromJson(json);
+const from = new Coordinates(45.187291, 5.723455);
+const to = new Coordinates(45.163729, 5.74085);
+const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json, from, to);
 
 let position, itineraryInfo;
 

package/src/remote/cityway/CitywayRemoteRouter.js

@@ -100,7 +100,7 @@ class CitywayRemoteRouter extends RemoteRouter {
         const jsonResponse = await res.json().catch(() => {
             throw new RemoteRouterServerUnreachable(this.rname, url);
         });
-        return this.createRouterResponseFromJson(jsonResponse);
+        return this.createRouterResponseFromJson(jsonResponse, waypoints[0], waypoints[1]);
     }
 
 
@@ -132,18 +132,21 @@ class CitywayRemoteRouter extends RemoteRouter {
     /**
      * Generate multi itineraries from Cityway JSON
      * @param {object} json JSON file provided by Cityway.
-     * @returns {?RouterResponse}
+     * @param {Coordinates} from
+     * @param {Coordinates} to
+     * @returns {!RouterResponse}
      * @example https://preprod.api.lia2.cityway.fr/journeyplanner/api/opt/PlanTrips/json?DepartureLatitude=49.51509388236216&DepartureLongitude=0.09341749619366316&ArrivalLatitude=49.5067090188444&ArrivalLongitude=0.1694842115417831&DepartureType=COORDINATES&ArrivalType=COORDINATES
      */
-    createRouterResponseFromJson(json) {
-
-        if (json.StatusCode !== 200 || !json.Data || !json.Data.length) {
-            return null;
-        }
+    createRouterResponseFromJson(json, from, to) {
 
         const routerResponse = new RouterResponse();
         routerResponse.routerName = this.rname;
+        routerResponse.from = from;
+        routerResponse.to = to;
 
+        if (json.StatusCode !== 200 || !json.Data || !json.Data.length) {
+            return routerResponse;
+        }
 
         // Do not know if it the best approach, but it works...
         const allJsonTrips = json.Data.reduce((acc, dataObj) => {
@@ -302,9 +305,6 @@ class CitywayRemoteRouter extends RemoteRouter {
             generateStepsMetadata(itinerary);
         }
 
-        routerResponse.from = routerResponse.itineraries[0].from;
-        routerResponse.to = routerResponse.itineraries[routerResponse.itineraries.length - 1].to;
-
         return routerResponse;
     }
 

package/src/remote/cityway/CitywayRemoteRouter.spec.js

@@ -24,7 +24,9 @@ describe('CitywayRemoteRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json);
+        const from = new Coordinates(49.515093882362159, 0.093417496193663158);
+        const to = new Coordinates(49.5067090188444, 0.16948421154178309);
+        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json, from, to);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.routerName).equal('cityway');
@@ -62,12 +64,14 @@ describe('CitywayRemoteRouter - createRouterResponseFromJson', () => {
         expect(itinerary1leg2.transportInfo.directionName).equal('Graville');
     });
 
+    const fakeCoords = new Coordinates(0, 0);
+
     it('RouterResponse - 2', () => {
         const filePath = path.resolve(assetsPath, 'itinerary-lehavre-cityway-2.json');
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json);
+        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json, fakeCoords, fakeCoords);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.itineraries.length).equal(1);
@@ -79,7 +83,7 @@ describe('CitywayRemoteRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json);
+        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json, fakeCoords, fakeCoords);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.itineraries[0].mode).equal('PT');
@@ -91,7 +95,7 @@ describe('CitywayRemoteRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json);
+        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json, fakeCoords, fakeCoords);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.itineraries[0].mode).equal('BIKE');
@@ -103,7 +107,7 @@ describe('CitywayRemoteRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json);
+        const routerResponse = CitywayRemoteRouter.createRouterResponseFromJson(json, fakeCoords, fakeCoords);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.itineraries[1].mode).equal('PT');

package/src/remote/deutsche-bahn/DeutscheBahnRemoteRouter.js

@@ -64,24 +64,22 @@ class DeutscheBahnRemoteRouter extends RemoteRouter {
     /**
      * Generate multi itineraries from the DB JSON
      * @param {object} json JSON file provided by the DB.
-     * @param {Coordinates} from itinerary start
-     * @param {Coordinates} to itinerary end
-     * @returns {?RouterResponse}
+     * @param {Coordinates} from
+     * @param {Coordinates} to
+     * @returns {!RouterResponse}
      */
     createRouterResponseFromJson(json, from, to) {
 
-        const { segments: jsonSegments } = json;
-
-        if (!jsonSegments) {
-            return null;
-        }
-
         const routerResponse = new RouterResponse();
         routerResponse.routerName = this.rname;
-
         routerResponse.from = from;
         routerResponse.to = to;
 
+        const { segments: jsonSegments } = json;
+        if (!jsonSegments) {
+            return routerResponse;
+        }
+
         /** @type {GraphEdge<OsmElement>[]} */
         const edges = [];
 

package/src/remote/idfm/IdfmRemoteRouter.js

@@ -127,7 +127,7 @@ class IdfmRemoteRouter extends RemoteRouter {
             return routerResponse;
         }
 
-        return this.createRouterResponseFromJson(jsonResponse);
+        return this.createRouterResponseFromJson(jsonResponse, waypoints[0], waypoints[1]);
     }
 
     /**
@@ -327,19 +327,20 @@ class IdfmRemoteRouter extends RemoteRouter {
     /**
      * Generate multi itineraries from OTP JSON
      * @param {object} json JSON file provided by OTP.
-     * @returns {?RouterResponse}
+     * @param {Coordinates} from
+     * @param {Coordinates} to
+     * @returns {!RouterResponse}
      */
-    createRouterResponseFromJson(json) {
-
-        if (!json || !json.journeys) {
-            return null;
-        }
+    createRouterResponseFromJson(json, from, to) {
 
         const routerResponse = new RouterResponse();
         routerResponse.routerName = this.rname;
+        routerResponse.from = from;
+        routerResponse.to = to;
 
-        routerResponse.from = this.getSectionCoords(json.journeys[0].sections[0]).from;
-        routerResponse.to = this.getSectionCoords(last(json.journeys[0].sections)).to;
+        if (!json || !json.journeys) {
+            return routerResponse;
+        }
 
         const timeZone = json.context.timezone;
 
@@ -350,8 +351,8 @@ class IdfmRemoteRouter extends RemoteRouter {
             itinerary.duration = jsonItinerary.duration;
             itinerary.startTime = this.dateStringToTimestamp(jsonItinerary.departure_date_time, timeZone);
             itinerary.endTime = this.dateStringToTimestamp(jsonItinerary.arrival_date_time, timeZone);
-            itinerary.from = routerResponse.from;
-            itinerary.to = routerResponse.to;
+            itinerary.from = this.getSectionCoords(jsonItinerary.sections[0]).from;
+            itinerary.to = this.getSectionCoords(last(jsonItinerary.sections)).to;
             itinerary.distance = 0;
 
             routerResponse.itineraries.push(itinerary);
@@ -364,7 +365,7 @@ class IdfmRemoteRouter extends RemoteRouter {
 
                 const leg = new Leg();
                 let existingCoords = [];
-                const { from, to } = this.getSectionCoords(jsonSection);
+                const { from: fromSection, to: toSection } = this.getSectionCoords(jsonSection);
 
                 leg.distance = 0;
                 leg.mode = routingModeCorrespondance.get(jsonSection.mode);
@@ -374,12 +375,12 @@ class IdfmRemoteRouter extends RemoteRouter {
 
                 leg.from = {
                     name: jsonSection.from.name,
-                    coords: from
+                    coords: fromSection
                 };
 
                 leg.to = {
                     name: jsonSection.to.name,
-                    coords: to
+                    coords: toSection
                 };
 
                 // A section can have multiple same coordinates, we need to remove them

package/src/remote/idfm/IdfmRemoteRouter.spec.js

@@ -24,15 +24,17 @@ describe('IdfmRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = IdfmRemoteRouter.createRouterResponseFromJson(json);
+        const from = new Coordinates(48.875877, 2.301357);
+        const to = new Coordinates(48.877877, 2.351929);
+        const routerResponse = IdfmRemoteRouter.createRouterResponseFromJson(json, from, to);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.routerName).equal('idfm');
         expect(routerResponse.itineraries.length).equal(5);
-        expect(routerResponse.from.equalsTo(new Coordinates(48.875877, 2.301357))).true;
-        expect(routerResponse.to.equalsTo(new Coordinates(48.877877, 2.351929))).true;
 
         const itinerary1 = routerResponse.itineraries[0];
+        expect(itinerary1.from.equalsTo(new Coordinates(48.875877, 2.301357))).true;
+        expect(itinerary1.to.equalsTo(new Coordinates(48.877877, 2.351929))).true;
         expect(itinerary1.distance).to.be.closeTo(1242, 1);
         expect(itinerary1.duration).equal(1842);
         expect(itinerary1.mode).equal('PT');

package/src/remote/osrm/OsrmRemoteRouter.js

@@ -53,7 +53,9 @@ class OsrmRemoteRouter extends RemoteRouter {
             throw new RemoteRouterServerUnreachable(this.rname, url);
         });
 
-        return this.createRouterResponseFromJson(jsonResponse, waypoints[0], waypoints[1]);
+        const from = waypoints[0];
+        const to = waypoints[waypoints.length - 1];
+        return this.createRouterResponseFromJson(jsonResponse, from, to);
     }
 
     /**
@@ -265,10 +267,15 @@ class OsrmRemoteRouter extends RemoteRouter {
      * @returns {?RouterResponse}
      */
     createRouterResponseFromJson(json, from, to, routingMode = 'walking') {
-        const { routes: jsonRoutes } = json;
 
+        const routerResponse = new RouterResponse();
+        routerResponse.routerName = this.rname;
+        routerResponse.from = from;
+        routerResponse.to = to;
+
+        const { routes: jsonRoutes } = json;
         if (!jsonRoutes) {
-            return null;
+            return routerResponse;
         }
 
         const routingModeCorrespondance = new Map();
@@ -277,12 +284,6 @@ class OsrmRemoteRouter extends RemoteRouter {
         routingModeCorrespondance.set('bicycle', 'BIKE');
         const mode = routingModeCorrespondance.get(routingMode) || null;
 
-        const routerResponse = new RouterResponse();
-        routerResponse.routerName = this.rname;
-
-        routerResponse.from = from;
-        routerResponse.to = to;
-
         for (const jsonItinerary of jsonRoutes) {
 
             const itinerary = new Itinerary();

package/src/remote/otp/OtpRemoteRouter.js

@@ -50,7 +50,7 @@ class OtpRemoteRouter extends RemoteRouter {
         const jsonResponse = await res.json().catch(() => {
             throw new RemoteRouterServerUnreachable(this.rname, url);
         });
-        return this.createRouterResponseFromJson(jsonResponse);
+        return this.createRouterResponseFromJson(jsonResponse, waypoints[0], waypoints[1]);
     }
 
     /**
@@ -127,21 +127,24 @@ class OtpRemoteRouter extends RemoteRouter {
     /**
      * Generate multi itineraries from OTP JSON
      * @param {object} json JSON file provided by OTP.
-     * @returns {?RouterResponse}
+     * @param {Coordinates} from
+     * @param {Coordinates} to
+     * @returns {!RouterResponse}
      */
-    createRouterResponseFromJson(json) {
+    createRouterResponseFromJson(json, from, to) {
 
-        const { plan: jsonPlan } = json;
+        const routerResponse = new RouterResponse();
+        routerResponse.routerName = this.rname;
+        routerResponse.from = from;
+        routerResponse.to = to;
 
+        const { plan: jsonPlan } = json;
         if (!jsonPlan) {
-            return null;
+            return routerResponse;
         }
 
-        const routerResponse = new RouterResponse();
-        routerResponse.routerName = this.rname;
-
-        routerResponse.from = this.jsonToCoordinates(jsonPlan.from);
-        routerResponse.to = this.jsonToCoordinates(jsonPlan.to);
+        const itinerariesFrom = this.jsonToCoordinates(jsonPlan.from);
+        const itinerariesTo = this.jsonToCoordinates(jsonPlan.to);
 
         for (const jsonItinerary of jsonPlan.itineraries) {
 
@@ -150,8 +153,8 @@ class OtpRemoteRouter extends RemoteRouter {
             itinerary.duration = jsonItinerary.duration;
             itinerary.startTime = jsonItinerary.startTime;
             itinerary.endTime = jsonItinerary.endTime;
-            itinerary.from = routerResponse.from;
-            itinerary.to = routerResponse.to;
+            itinerary.from = itinerariesFrom;
+            itinerary.to = itinerariesTo;
 
             routerResponse.itineraries.push(itinerary);
 

package/src/remote/otp/OtpRemoteRouter.spec.js

@@ -26,15 +26,17 @@ describe('OtpRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json);
+        const from = new Coordinates(45.187291, 5.723455);
+        const to = new Coordinates(45.163729, 5.74085);
+        const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json, from, to);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.routerName).equal('otp');
         expect(routerResponse.itineraries.length).equal(2);
-        expect(routerResponse.from.equalsTo(new Coordinates(45.187291, 5.723455))).true;
-        expect(routerResponse.to.equalsTo(new Coordinates(45.163729, 5.74085))).true;
 
         const itinerary1 = routerResponse.itineraries[0];
+        expect(itinerary1.from.equalsTo(new Coordinates(45.187291, 5.723455))).true;
+        expect(itinerary1.to.equalsTo(new Coordinates(45.163729, 5.74085))).true;
         expect(itinerary1.coords.length).equal(162);
         expect(itinerary1.duration).equal(1206);
         expect(itinerary1.startTime).equal(1614607210000);
@@ -70,14 +72,16 @@ describe('OtpRouter - createRouterResponseFromJson', () => {
         const fileString = fs.readFileSync(filePath, 'utf8');
         const json = JSON.parse(fileString);
 
-        const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json);
+        const from = new Coordinates(45.192514856662456, 5.731452541397871);
+        const to = new Coordinates(45.18544, 5.73123);
+        const routerResponse = OtpRemoteRouter.createRouterResponseFromJson(json, from, to);
         checkRouterResponseType(routerResponse);
 
         expect(routerResponse.itineraries.length).equal(2);
-        expect(routerResponse.from.equalsTo(new Coordinates(45.192514856662456, 5.731452541397871))).true;
-        expect(routerResponse.to.equalsTo(new Coordinates(45.18544, 5.73123))).true;
 
         const itinerary1 = routerResponse.itineraries[0];
+        expect(itinerary1.from.equalsTo(new Coordinates(45.192514856662456, 5.731452541397871))).true;
+        expect(itinerary1.to.equalsTo(new Coordinates(45.18544, 5.73123))).true;
         expect(itinerary1.legs.length).equal(5);
 
         expect(itinerary1.mode).equal('PT');