@wemap/routers 6.0.0 → 6.0.1

package/package.json

@@ -11,7 +11,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "6.0.0",
+    "version": "6.0.1",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -31,5 +31,5 @@
         "@wemap/maths": "^6.0.0",
         "@wemap/osm": "^6.0.0"
     },
-    "gitHead": "a377d6fd98b48ce0e083ece1c695642947c456cc"
+    "gitHead": "e1440c56752edb5c31f46a61f49ab0ff1270176b"
 }

package/src/cityway/CitywayUtils.js

@@ -160,7 +160,7 @@ export function createRouterResponseFromJson(json) {
                     leg.steps.push(step);
                 }
 
-            } else if (leg.mode === 'BUS' || leg.mode === 'TRAMWAY' || leg.mode === 'FUNICULAR') {
+            } else if (leg.mode === 'BUS' || leg.mode === 'TRAMWAY' || leg.mode === 'FUNICULAR' || leg.mode === 'TRAIN') {
 
                 leg.from = {
                     name: jsonLeg.Departure.StopPlace.Name,

package/src/cityway/CitywayUtils.spec.js

@@ -34,6 +34,7 @@ describe('CitywayUtils - createRouterResponseFromJson', () => {
         const itinerary1 = routerResponse.itineraries[0];
         expect(itinerary1.distance).to.be.closeTo(6887, 1);
         expect(itinerary1.duration).equal(2379);
+        expect(itinerary1.mode).equal('PT');
         // Do not work because of the input time format
         // expect(itinerary1.startTime).equal(1620659156000);
         // expect(itinerary1.endTime).equal(1620661535000);
@@ -69,6 +70,7 @@ describe('CitywayUtils - createRouterResponseFromJson', () => {
         verifyRouterResponseData(routerResponse);
 
         expect(routerResponse.itineraries.length).equal(1);
+        expect(routerResponse.itineraries[0].mode).equal('WALK');
     });
 
     it('RouterResponse - 3', () => {
@@ -79,6 +81,7 @@ describe('CitywayUtils - createRouterResponseFromJson', () => {
         const routerResponse = createRouterResponseFromJson(json);
         verifyRouterResponseData(routerResponse);
 
+        expect(routerResponse.itineraries[0].mode).equal('PT');
         expect(routerResponse.itineraries[0].legs[1].mode).equal('FUNICULAR');
     });
 
@@ -90,6 +93,7 @@ describe('CitywayUtils - createRouterResponseFromJson', () => {
         const routerResponse = createRouterResponseFromJson(json);
         verifyRouterResponseData(routerResponse);
 
+        expect(routerResponse.itineraries[0].mode).equal('BIKE');
         expect(routerResponse.itineraries[0].legs[0].mode).equal('BICYCLE');
     });
 
@@ -101,6 +105,7 @@ describe('CitywayUtils - createRouterResponseFromJson', () => {
         const routerResponse = createRouterResponseFromJson(json);
         verifyRouterResponseData(routerResponse);
 
+        expect(routerResponse.itineraries[1].mode).equal('PT');
         expect(routerResponse.itineraries[1].legs[1].mode).equal('TRAM');
         expect(routerResponse.itineraries[1].legs[1].transportInfo.name).equal('B');
     });

package/src/deutsche-bahn/DeutscheBahnRouterUtils.spec.js

@@ -40,6 +40,7 @@ describe('OtpUtils - createRouterResponseFromJson', () => {
         expect(itinerary1.coords.length).equal(77);
         expect(itinerary1.distance).almost.equal(129.673);
         expect(itinerary1.duration).almost.equal(93.365);
+        expect(itinerary1.mode).equal('WALK');
 
         const itinerary1leg1 = itinerary1.legs[0];
         expect(itinerary1leg1.distance).almost.equal(129.673);

package/src/model/Itinerary.js

@@ -26,6 +26,9 @@ class Itinerary {
     /** @type {!number} */
     duration;
 
+    /** @type {!string} can be WALK, BIKE, CAR, PT */
+    _mode;
+
     /** @type {?number} */
     startTime = null;
 
@@ -64,6 +67,37 @@ class Itinerary {
         return this.legs.map(leg => leg.steps).flat();
     }
 
+    set mode(_) {
+        throw new Error('Itinerary.mode cannot be set. They are calculated from Itinerary.legs.');
+    }
+
+    get mode() {
+        if (!this._mode) {
+            let isPublicTransport;
+            let isBicycle;
+            let isDriving;
+
+            this.legs.forEach((leg) => {
+                isPublicTransport = isPublicTransport || ['BUS', 'FUNICULAR', 'TRAM', 'TRAIN'].includes(leg.mode);
+                isBicycle = isBicycle || ['BIKE', 'BICYCLE'].includes(leg.mode);
+                isDriving = isDriving || leg.mode === 'CAR';
+            });
+
+            if (isPublicTransport) {
+                this._mode = 'PT';
+            } else if (isDriving) {
+                this._mode = 'CAR';
+            } else if (isBicycle) {
+                this._mode = 'BIKE';
+            } else {
+                this._mode = 'WALK';
+            }
+        }
+
+        return this._mode;
+
+    }
+
     /**
      * @returns {Network}
      */
@@ -163,6 +197,7 @@ class Itinerary {
             to: this.to.toCompressedJson(),
             distance: this.distance,
             duration: this.duration,
+            mode: this.mode,
             legs: this.legs.map(leg => leg.toJson())
         };
         if (this.startTime !== null) {

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

@@ -90,6 +90,7 @@ export function verifyLegData(leg) {
 export function verifyItineraryData(itinerary) {
 
     expect(itinerary).instanceOf(Itinerary);
+    expect(itinerary.mode).be.a('string');
     expect(itinerary.from).instanceOf(Coordinates);
     expect(itinerary.to).instanceOf(Coordinates);
     expect(itinerary.coords).be.an('array');

package/src/osrm/OsrmUtils.spec.js

@@ -413,6 +413,7 @@ describe('OsrmUtils - createRouterResponseFromJson', () => {
         expect(itinerary1.endTime).is.null;
         expect(itinerary1.legs.length).equal(1);
         expect(itinerary1.coords.length).equal(19);
+        expect(itinerary1.mode).equal('WALK');
 
         const itinerary1leg1 = itinerary1.legs[0];
         expect(itinerary1leg1.startTime).is.null;

package/src/otp/OtpUtils.spec.js

@@ -39,6 +39,7 @@ describe('OtpUtils - createRouterResponseFromJson', () => {
         expect(itinerary1.startTime).equal(1614607210000);
         expect(itinerary1.endTime).equal(1614608416000);
         expect(itinerary1.legs.length).equal(3);
+        expect(itinerary1.mode).equal('PT');
 
         const itinerary1leg1 = itinerary1.legs[0];
         expect(itinerary1leg1.startTime).equal(1614607210000);
@@ -78,6 +79,8 @@ describe('OtpUtils - createRouterResponseFromJson', () => {
         const itinerary1 = routerResponse.itineraries[0];
         expect(itinerary1.legs.length).equal(5);
 
+        expect(itinerary1.mode).equal('PT');
+
         expect(itinerary1.legs[0].mode).equal('WALK');
 
         expect(itinerary1.legs[1].mode).equal('TRAM');