@wemap/routers 12.7.3 → 12.7.5

package/index.ts

@@ -6,7 +6,7 @@ export { default as Leg, type LegJson, type DestinationJson, type TransportInfo
 export type { Step, MinStepInfo, StepJson } from './src/model/Step.js';
 export type { LevelChange } from './src/model/LevelChange.js';
 export type { StepExtra } from './src/model/StepExtra.js';
-export { type TransitMode } from './src/model/TransitMode.js';
+export { type TransitMode, areTransitAndTravelModeConsistent } from './src/model/TransitMode.js';
 export { type TravelMode, type TravelModePreference } from './src/model/TravelMode.js';
 
 /** Graph */

package/package.json

@@ -12,7 +12,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "12.7.3",
+    "version": "12.7.5",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -52,5 +52,5 @@
         },
         "./helpers/*": "./helpers/*"
     },
-    "gitHead": "67ad72998468c84862793eb326649b6923b0f6ec"
+    "gitHead": "b35505c8f8fbcd73aa7203c315fdc2fbaca129e1"
 }

package/src/graph/Graph.ts

@@ -72,7 +72,20 @@ class Graph {
 
         const useMultiLevelSegments = !('useMultiLevelSegments' in options) || options.useMultiLevelSegments;
 
-        let bestProjection: GraphProjection | null = null;
+        let bestProjection: GraphProjection<U> | null = null;
+
+        // (for as any) See. https://www.totaltypescript.com/any-considered-harmful#returning-conditional-types-from-generic-functions
+        const adaptProjectionCoords = (projCoords: Coordinates): U => {
+            if (!(origin instanceof UserPosition)) return projCoords as any;
+            const p = origin.clone();
+            p.lat = projCoords.lat;
+            p.lng = projCoords.lng;
+            p.level = projCoords.level;
+            p.alt = projCoords.alt;
+            p.heightFromFloor = projCoords.heightFromFloor;
+            p.heightFromGround = projCoords.heightFromGround;
+            return p as any;
+        }
 
         this.edges.forEach(edge => {
 
@@ -92,7 +105,7 @@ class Graph {
             if (useMaxDistance && distanceToSegment > maxDistance) return;
 
             if (distanceToSegment < (bestProjection?.distanceFromNearestElement ?? Number.MAX_VALUE)) {
-                bestProjection = new GraphProjection(origin, distanceToSegment, segmentProjection, edge);
+                bestProjection = new GraphProjection(origin, distanceToSegment, adaptProjectionCoords(segmentProjection), edge);
             }
         });
 
@@ -117,14 +130,14 @@ class Graph {
 
             // If distance below epsilon consider it as best projection
             if (distanceToVertex < GeoConstants.EPS_MM) {
-                bestProjection = new GraphProjection(origin, 0, vertexCoords, vertex);
+                bestProjection = new GraphProjection(origin, 0, adaptProjectionCoords(vertexCoords), vertex);
                 return;
             }
 
             if (useMaxDistance && distanceToVertex > maxDistance) return;
 
             if (distanceToVertex < (bestProjection?.distanceFromNearestElement ?? Number.MAX_VALUE)) {
-                bestProjection = new GraphProjection(origin, distanceToVertex, vertexCoords, vertex);
+                bestProjection = new GraphProjection(origin, distanceToVertex, adaptProjectionCoords(vertexCoords), vertex);
             }
         });
 

package/src/model/Itinerary.ts

@@ -93,30 +93,32 @@ export default class Itinerary {
     }
 
     set transitMode(_) {
-        throw new Error('Itinerary.mode cannot be set. They are calculated from Itinerary.legs.');
+        throw new Error('Itinerary.transitMode cannot be set. They are calculated from Itinerary.legs.');
     }
 
+    // Transit mode will return MULTI if there are several transit modes except WALK
+    // Else it will return the only transit mode
+    // fallback to WALK if no transit mode
     get transitMode() {
         if (!this._transitMode) {
-            let isPublicTransport = false;
-            let isBicycle = false;
-            let isDriving = false;
+            const legTransitModes = new Set(this.legs.map(leg => leg.transitMode));
 
-            this.legs.forEach((leg) => {
-                isPublicTransport = isPublicTransport || isTransitModePublicTransport(leg.transitMode);
-                isBicycle = isBicycle || leg.transitMode === 'BIKE';
-                isDriving = isDriving || leg.transitMode === 'CAR';
-            });
+            // Remove WALK from transit modes
+            legTransitModes.delete('WALK');
 
-            if (isPublicTransport) {
+            if (legTransitModes.size > 1) {
                 this._transitMode = 'MULTI';
-            } else if (isDriving) {
-                this._transitMode = 'CAR';
-            } else if (isBicycle) {
-                this._transitMode = 'BIKE';
-            } else {
-                this._transitMode = 'WALK';
+
+                return this._transitMode;
             }
+
+            if (legTransitModes.size === 1) {
+                this._transitMode = legTransitModes.values().next().value as TransitMode;
+
+                return this._transitMode;
+            }
+
+            this._transitMode = 'WALK';
         }
 
         return this._transitMode;

package/src/model/TransitMode.spec.ts

@@ -0,0 +1,31 @@
+import chai from 'chai';
+
+import { isTransitModePublicTransport, areTransitAndTravelModeConsistent } from './TransitMode.js';
+
+const { expect } = chai;
+
+describe('TransitMode', () => {
+
+    it('transit and travel mode consistent', () => {
+        expect(areTransitAndTravelModeConsistent('AIRPLANE', 'TRANSIT')).is.true;
+        expect(areTransitAndTravelModeConsistent('BOAT', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('BUS', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('FERRY', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('FUNICULAR', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('METRO', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('TRAIN', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('TRAM', 'TRANSIT' )).is.true;
+        expect(areTransitAndTravelModeConsistent('MULTI', 'TRANSIT' )).is.true;
+
+        expect(areTransitAndTravelModeConsistent('BIKE', 'TRANSIT')).is.false;
+        expect(areTransitAndTravelModeConsistent('CAR', 'TRANSIT')).is.false;
+        expect(areTransitAndTravelModeConsistent('MOTO', 'TRANSIT')).is.false;
+        expect(areTransitAndTravelModeConsistent('TAXI', 'TRANSIT')).is.false;
+        expect(areTransitAndTravelModeConsistent('WALK', 'TRANSIT')).is.false;
+
+        expect(areTransitAndTravelModeConsistent('WALK', 'WALK')).is.true;
+        expect(areTransitAndTravelModeConsistent('BIKE', 'BIKE')).is.true;
+        expect(areTransitAndTravelModeConsistent('CAR', 'CAR')).is.true;
+    });
+
+});

package/src/model/TransitMode.ts

@@ -1,13 +1,19 @@
+import { TravelMode } from "./TravelMode";
+
 export type TransitMode = 'AIRPLANE' | 'BOAT' | 'BIKE' | 'BUS' | 'CAR' |
     'FERRY' | 'FUNICULAR' | 'METRO' | 'MOTO' | 'TRAIN' | 'TAXI' |
     'TRAM' | 'WALK' | 'MULTI' | 'UNKNOWN';
 
 export type PublicTransport = 'AIRPLANE' | 'BOAT' | 'BUS' |
-    'FERRY' | 'FUNICULAR' | 'METRO' | 'TRAIN' | 'TRAM';
+    'FERRY' | 'FUNICULAR' | 'METRO' | 'MULTI' | 'TRAIN' | 'TRAM';
 
-export function isTransitModePublicTransport(routingMode: TransitMode): routingMode is PublicTransport {
+export function isTransitModePublicTransport(transitMode: TransitMode): transitMode is PublicTransport {
     return [
         'AIRPLANE', 'BOAT', 'BUS', 'FERRY',
-        'FUNICULAR', 'METRO', 'TRAIN', 'TRAM'
-    ].includes(routingMode);
+        'FUNICULAR', 'METRO', 'MULTI', 'TRAIN', 'TRAM'
+    ].includes(transitMode);
+}
+
+export function areTransitAndTravelModeConsistent(transitMode: TransitMode, travelMode: TravelMode): boolean {
+    return transitMode === travelMode || (isTransitModePublicTransport(transitMode) && travelMode === 'TRANSIT');
 }

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

@@ -8,7 +8,7 @@ import { Coordinates } from '@wemap/geo';
 
 import CitywayRemoteRouter from './CitywayRemoteRouter.js';
 import { verifyStepsCoherence } from '../../model/Itinerary.spec.js';
-
+import { areTransitAndTravelModeConsistent } from '../../model/TransitMode.js';
 
 const { expect } = chai;
 
@@ -33,12 +33,14 @@ describe('CitywayRemoteRouter - parseResponse', () => {
         expect(itinerary1.destination.equals(new Coordinates(49.5067090188444, 0.16948421154178309))).true;
         expect(itinerary1.distance).to.be.closeTo(6887, 1);
         expect(itinerary1.duration).equal(2379);
-        expect(itinerary1.transitMode).equal('MULTI');
+        expect(itinerary1.transitMode).equal('BUS');
         // Do not work because of the input time format
         expect(itinerary1.startTime).equal(1620659156000);
         expect(itinerary1.endTime).equal(1620661535000);
         expect(itinerary1.legs.length).equal(5);
 
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'TRANSIT')).is.true;
+
         const itinerary1leg1 = itinerary1.legs[0];
         // Do not work because of the input time format
         expect(itinerary1leg1.startTime).equal(1620659156000);
@@ -70,6 +72,8 @@ describe('CitywayRemoteRouter - parseResponse', () => {
 
         expect(itineraries.length).equal(1);
         expect(itineraries[0].transitMode).equal('WALK');
+        expect(areTransitAndTravelModeConsistent(itineraries[0].transitMode, 'WALK')).is.true;
+
     });
 
     it('Itineraries - 3', () => {
@@ -80,8 +84,10 @@ describe('CitywayRemoteRouter - parseResponse', () => {
         const itineraries = CitywayRemoteRouter.parseResponse(json);
         itineraries.forEach(verifyStepsCoherence);
 
-        expect(itineraries[0].transitMode).equal('MULTI');
+        expect(itineraries[0].transitMode).equal('FUNICULAR');
         expect(itineraries[0].legs[1].transitMode).equal('FUNICULAR');
+        expect(areTransitAndTravelModeConsistent(itineraries[0].transitMode, 'TRANSIT')).is.true;
+
     });
 
     it('Itineraries - 4', () => {
@@ -94,6 +100,7 @@ describe('CitywayRemoteRouter - parseResponse', () => {
 
         expect(itineraries[0].transitMode).equal('BIKE');
         expect(itineraries[0].legs[0].transitMode).equal('BIKE');
+        expect(areTransitAndTravelModeConsistent(itineraries[0].transitMode, 'BIKE')).is.true;
     });
 
     it('Itineraries - 5', () => {
@@ -104,7 +111,9 @@ describe('CitywayRemoteRouter - parseResponse', () => {
         const itineraries = CitywayRemoteRouter.parseResponse(json);
         itineraries.forEach(verifyStepsCoherence);
 
-        expect(itineraries[1].transitMode).equal('MULTI');
+        expect(itineraries[1].transitMode).equal('TRAM');
+        expect(areTransitAndTravelModeConsistent(itineraries[1].transitMode, 'TRANSIT')).is.true;
+
         expect(itineraries[1].legs[1].transitMode).equal('TRAM');
         expect(itineraries[1].legs[1].transportInfo?.name).equal('B');
     });

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

@@ -8,6 +8,7 @@ import { Coordinates } from '@wemap/geo';
 
 import IdfmRemoteRouter from './IdfmRemoteRouter.js';
 import { verifyStepsCoherence } from '../../model/Itinerary.spec.js';
+import { areTransitAndTravelModeConsistent } from '../../model/TransitMode.js';
 
 const { expect } = chai;
 
@@ -32,12 +33,14 @@ describe('IdfmRouter - parseResponse', () => {
         expect(itinerary1.destination.equals(new Coordinates(48.877877, 2.351929))).true;
         expect(itinerary1.distance).to.be.closeTo(5264, 1);
         expect(itinerary1.duration).equal(1842);
-        expect(itinerary1.transitMode).equal('MULTI');
+        expect(itinerary1.transitMode).equal('METRO');
         // Do not work because of the input time format
         expect(itinerary1.startTime).equal(1637596640000);
         expect(itinerary1.endTime).equal(1637598482000);
         expect(itinerary1.legs.length).equal(3);
 
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'TRANSIT')).is.true;
+
         const itinerary1leg1 = itinerary1.legs[0];
         // Do not work because of the input time format
         expect(itinerary1leg1.startTime).equal(1637596640000);
@@ -59,4 +62,29 @@ describe('IdfmRouter - parseResponse', () => {
         expect(itinerary1leg2.transportInfo?.directionName).equal('Nation (Paris)');
     
     });
+
+    it('Itineraries - 2', () => {
+
+        const filePath = path.resolve(assetsPath, 'itinerary-paris-idfm-2.json');
+        const fileString = fs.readFileSync(filePath, 'utf8');
+        const json = JSON.parse(fileString);
+
+        const itineraries = IdfmRemoteRouter.parseResponse(json);
+        itineraries.forEach(verifyStepsCoherence);
+
+        expect(itineraries.length).equal(9);
+
+        const itinerary1 = itineraries[0];
+        expect(itinerary1.origin.equals(new Coordinates(48.836123, 2.341896))).true;
+        expect(itinerary1.destination.equals(new Coordinates(48.867999, 2.32563))).true;
+        expect(itinerary1.distance).to.be.closeTo(5765, 1);
+        expect(itinerary1.duration).equal(1977);
+        expect(itinerary1.transitMode).equal('MULTI');
+        // Do not work because of the input time format
+        expect(itinerary1.startTime).equal(1712073372000);
+        expect(itinerary1.endTime).equal(1712075349000);
+        expect(itinerary1.legs.length).equal(4);
+
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'TRANSIT')).is.true;
+    });
 });

package/src/remote/idfm/IdfmRemoteRouter.ts

@@ -7,7 +7,7 @@ import Leg, { TransportInfo } from '../../model/Leg.js';
 import { dateWithTimeZone } from '../RemoteRouterUtils.js';
 import StepsBuilder from '../../model/StepsBuilder.js';
 import RemoteRouter from '../RemoteRouter.js';
-import { type TransitMode } from '../../model/TransitMode.js';
+import { areTransitAndTravelModeConsistent, type TransitMode } from '../../model/TransitMode.js';
 import { type MinStepInfo } from '../../model/Step.js';
 import { RouterRequest } from '../../model/RouterRequest.js';
 import { RemoteRoutingError } from '../../RoutingError.js';
@@ -185,7 +185,7 @@ class IdfmRemoteRouter extends RemoteRouter {
 
         const itineraries = this.parseResponse(jsonResponse);
 
-        const sameModeFound = itineraries.some((itinerary) => itinerary.transitMode === routerRequest.travelMode);
+        const sameModeFound = itineraries.some((itinerary) => areTransitAndTravelModeConsistent(itinerary.transitMode, routerRequest.travelMode));
 
         if (!sameModeFound) {
             throw RemoteRoutingError.notFound(

package/src/remote/osrm/OsrmRemoteRouter.spec.ts

@@ -9,6 +9,7 @@ import { Coordinates } from '@wemap/geo';
 
 import OsrmRemoteRouter from './OsrmRemoteRouter.js';
 import { verifyStepsCoherence } from '../../model/Itinerary.spec.js';
+import { areTransitAndTravelModeConsistent } from '../../model/TransitMode.js';
 
 
 const { expect } = chai;
@@ -43,6 +44,7 @@ describe('OsrmRemoteRouter - parseResponse', () => {
         expect(itinerary1.legs.length).equal(1);
         expect(itinerary1.coords.length).equal(19);
         expect(itinerary1.transitMode).equal('WALK');
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'WALK')).is.true;
 
         const itinerary1leg1 = itinerary1.legs[0];
         expect(itinerary1leg1.startTime).is.null;
@@ -76,6 +78,7 @@ describe('OsrmRemoteRouter - parseResponse', () => {
         expect(itineraries[0].transitMode).equal('WALK');
         expect(itineraries[0].origin.equals(origin)).true;
         expect(itineraries[0].destination.equals(destination)).true;
+        expect(areTransitAndTravelModeConsistent(itineraries[0].transitMode, 'WALK')).is.true;
 
         const steps = itineraries[0].steps;
         expect(steps.length).equal(2);
@@ -99,6 +102,7 @@ describe('OsrmRemoteRouter - parseResponse', () => {
         expect(itineraries[0].transitMode).equal('CAR');
         expect(itineraries[0].origin.equals(origin)).true;
         expect(itineraries[0].destination.equals(destination)).true;
+        expect(areTransitAndTravelModeConsistent(itineraries[0].transitMode, 'CAR')).is.true;
 
         const steps = itineraries[0].steps;
         expect(steps.length).equal(2);

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

@@ -9,6 +9,7 @@ import { Coordinates } from '@wemap/geo';
 
 import OtpRemoteRouter from './OtpRemoteRouter.js';
 import { verifyStepsCoherence } from '../../model/Itinerary.spec.js';
+import { areTransitAndTravelModeConsistent } from '../../model/TransitMode.js';
 
 
 const { expect } = chai;
@@ -38,7 +39,8 @@ describe('OtpRouter - createRouterResponseFromJson', () => {
         expect(itinerary1.startTime).equal(1614607210000);
         expect(itinerary1.endTime).equal(1614608416000);
         expect(itinerary1.legs.length).equal(3);
-        expect(itinerary1.transitMode).equal('MULTI');
+        expect(itinerary1.transitMode).equal('BUS');
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'TRANSIT')).is.true;
 
         const itinerary1leg1 = itinerary1.legs[0];
         expect(itinerary1leg1.startTime).equal(1614607210000);
@@ -78,7 +80,8 @@ describe('OtpRouter - createRouterResponseFromJson', () => {
         expect(itinerary1.destination.equals(new Coordinates(45.18544, 5.73123))).true;
         expect(itinerary1.legs.length).equal(5);
 
-        expect(itinerary1.transitMode).equal('MULTI');
+        expect(itinerary1.transitMode).equal('TRAM');
+        expect(areTransitAndTravelModeConsistent(itinerary1.transitMode, 'TRANSIT')).is.true;
 
         expect(itinerary1.legs[0].transitMode).equal('WALK');