@wemap/routers 11.2.4 → 11.3.1

package/index.ts

@@ -12,6 +12,7 @@ export type { RoutingMode } from './src/model/RoutingMode.js';
 /* Wemap Router */
 export { default as OsmGraph, type OsmVertex, type OsmEdge, type OsmVertexData, type OsmEdgeData } from './src/wemap-osm/OsmGraph.js';
 export { default as OsmRouter, type OsmItinerary } from './src/wemap-osm/OsmRouter.js';
+export {type OsmRouterOptions } from './src/wemap-osm/OsmRouterOptions.js';
 
 export { default as WemapMultiRouter } from './src/wemap-multi/WemapMultiRouter.js';
 export { default as CustomNetworkMap } from './src/wemap-multi/CustomNetworkMap.js';

package/package.json

@@ -12,7 +12,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "11.2.4",
+    "version": "11.3.1",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -34,10 +34,10 @@
         "@turf/convex": "^6.5.0",
         "@turf/helpers": "^6.5.0",
         "@types/mapbox__polyline": "^1.0.2",
-        "@wemap/geo": "^11.0.2",
+        "@wemap/geo": "^11.3.1",
         "@wemap/logger": "^11.0.1",
         "@wemap/maths": "^11.0.1",
-        "@wemap/osm": "^11.0.2",
+        "@wemap/osm": "^11.3.1",
         "@wemap/salesman.js": "^2.1.0"
     },
     "devDependencies": {
@@ -52,5 +52,5 @@
         },
         "./helpers/*": "./helpers/*"
     },
-    "gitHead": "07aa72961281f31b4c71d97e2afab2e512e76332"
+    "gitHead": "d2e603fe3846cfb5b2944ca35c06e74bce6fd6d2"
 }

package/src/model/LevelChange.spec.ts

@@ -19,6 +19,7 @@ const levelChange2: LevelChange = {
 const levelChange3: LevelChange = {
     direction: 'up',
     difference: 3,
+    // TODO: change to 'escalator'
     type: 'conveyor'
 };
 

package/src/model/LevelChange.ts

@@ -1,4 +1,5 @@
-export type LevelChangeType = 'elevator' | 'conveyor' | 'stairs';
+// TODO: remove conveying
+export type LevelChangeType = 'elevator' | 'escalator' | 'stairs' | 'moving walkway' | 'conveyor';
 
 export type LevelChange = {
     direction: 'up' | 'down';

package/src/wemap-multi/CustomNetworkMap.ts

@@ -5,7 +5,7 @@ import { Position, MultiPolygon } from '@turf/helpers';
 import { Coordinates, GeoGraphRouterOptions, Level, NoRouteFoundError } from '@wemap/geo';
 import { OsmParser } from '@wemap/osm';
 
-import OsmGraph, { OsmVertex } from '../wemap-osm/OsmGraph.js';
+import OsmGraph, { OsmEdgeData, OsmVertex, OsmVertexData } from '../wemap-osm/OsmGraph.js';
 import WemapOsmRouter from '../wemap-osm/OsmRouter.js';
 
 class CustomNetworkMap {
@@ -129,7 +129,7 @@ class CustomNetworkMap {
      * /!\ start is only used to sort the entry points (step 1).
      *
      */
-    getBestItineraryFromEntryPointsToEnd(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions) {
+    getBestItineraryFromEntryPointsToEnd(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData>) {
 
         const sortedEntryPoints = this.getOrderedEntryPointsSortedByDistance(start, end);
         for (const entryPoint of sortedEntryPoints) {
@@ -156,7 +156,7 @@ class CustomNetworkMap {
      * /!\ end is only used to sort the entry points (step 1).
      *
      */
-    getBestItineraryFromStartToEntryPoints(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions) {
+    getBestItineraryFromStartToEntryPoints(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData>) {
 
         const sortedEntryPoints = this.getOrderedEntryPointsSortedByDistance(start, end);
         for (const entryPoint of sortedEntryPoints) {
@@ -171,12 +171,12 @@ class CustomNetworkMap {
         );
     }
 
-    getItineraryInsideMap(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions) {
+    getItineraryInsideMap(start: Coordinates, end: Coordinates, options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData>) {
         // Call the Wemap router to get the shortest path
         return this.router.getItinerary(start, end, options);
     }
 
-    getTripInsideMap(waypoints: Coordinates[], options: GeoGraphRouterOptions) {
+    getTripInsideMap(waypoints: Coordinates[], options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData>) {
         // Call the Wemap router to get the shortest trip itinerary
         return this.router.getTripItinerary(waypoints, options);
     }

package/src/wemap-multi/WemapMultiRouter.ts

@@ -1,7 +1,7 @@
 /* eslint-disable complexity */
 /* eslint-disable max-statements */
 
-import { Coordinates, NoRouteFoundError, GeoGraphRouterOptions } from '@wemap/geo';
+import { Coordinates, NoRouteFoundError } from '@wemap/geo';
 import Logger from '@wemap/logger';
 
 import CustomNetworkMap from './CustomNetworkMap.js';
@@ -9,7 +9,7 @@ import { WemapMultiRouterOptions } from './WemapMultiRouterOptions.js';
 import RemoteRouterManager from '../remote/RemoteRouterManager.js';
 import { isRoutingError } from '../remote/RemoteRouterUtils.js';
 import RouterResponse from '../model/RouterResponse.js';
-import WemapOsmRouter, { GeoGraphTripRouterOptions } from '../wemap-osm/OsmRouter.js';
+import WemapOsmRouter from '../wemap-osm/OsmRouter.js';
 import Itinerary from '../model/Itinerary.js';
 import { RoutingMode } from '../model/RoutingMode.js';
 import WemapMultiRemoteRouter from '../remote/wemap-multi/WemapMultiRemoteRouter.js';
@@ -57,14 +57,11 @@ class WemapMultiRouter {
         return ioMapsToTest;
     }
 
-    private convertOptionsToWemapOsmOptions(options: WemapMultiRouterOptions | null) {
+    private convertOptionsToWemapOsmOptions(options: WemapMultiRouterOptions | null = null) {
         // Create WemapOsmRouterOptions from WemapMultiRouterOptions
-        const outputOptions : GeoGraphRouterOptions | GeoGraphTripRouterOptions
-            = !options || !('useStairs' in options) || options.useStairs
-            ? WemapOsmRouter.DEFAULT_OPTIONS
-            : WemapOsmRouter.WITHOUT_STAIRS_OPTIONS;
+        const outputOptions = WemapOsmRouter.buildOptions(options ? options : {});
 
-        if(typeof options?.tspTempCoeff !== 'undefined') {
+        if (typeof options?.tspTempCoeff !== 'undefined') {
             (outputOptions as any).tspTempCoeff = options.tspTempCoeff;
         }
         return outputOptions;

package/src/wemap-multi/WemapMultiRouterOptions.ts

@@ -1,15 +1,10 @@
 import { RemoteRouterName } from "../remote/RemoteRouterManager.js";
+import { OsmRouterOptions } from "../wemap-osm/OsmRouterOptions.js";
 
-export type WemapMultiRouterOptions = {
-
-    useStairs?: boolean;
+export type WemapMultiRouterOptions = OsmRouterOptions & {
 
     targetMaps?: string[] | null;
 
-    isTrip?: boolean;
-
-    tspTempCoeff?: number;
-
     /**
      * List of ordered remote routers (first of the list, first tested)
      * Algorithm will try the first router and if it fails continue

package/src/wemap-osm/OsmRouter.ts

@@ -11,39 +11,14 @@ import { getDurationFromLength } from '../Utils.js';
 import OsmGraph, { OsmEdge, OsmEdgeData, OsmVertex, OsmVertexData } from './OsmGraph.js';
 import Leg from '../model/Leg.js';
 import { MinStepInfo } from '../model/Step.js';
+import { OsmRouterOptions } from './OsmRouterOptions.js';
 
 
-const DEFAULT_OPTIONS = Object.assign({}, GeoGraphRouter.DEFAULT_OPTIONS, {
-    weightEdgeFn: (edge: OsmEdge) => {
-        if (edge.data.isElevator) {
-            return 90;
-        }
-        let duration = getDurationFromLength(edge.length, 4);
-        if (edge.data instanceof OsmWay && edge.data.areStairs) {
-            duration *= 3;
-        }
-        return duration;
-    },
-    acceptEdgeFn: (edge: GeoGraphEdge) => {
-        const accessTag = (edge as OsmEdge).data.tags.access;
-        return typeof accessTag === 'undefined' || accessTag === 'yes';
-    }
-});
-
-const WITHOUT_STAIRS_OPTIONS = Object.assign({}, DEFAULT_OPTIONS, {
-    acceptEdgeFn: (edge: GeoGraphEdge) => (edge as OsmEdge).data.tags.highway !== 'steps'
-});
-
 export type GeoGraphTripRouterOptions<VertexData = unknown, EdgeData = unknown> =
     GeoGraphRouterOptions<VertexData, EdgeData> & {
         tspTempCoeff?: number; // https://github.com/wemap/salesman.js/blob/master/salesman.js#L164
     };
 
-const DEFAULT_TRIP_OPTIONS = Object.assign({}, {
-    tspTempCoeff: 0.99
-}, GeoGraphRouter.DEFAULT_OPTIONS);
-
-
 const buildStepsRules = (graphItinerary: OsmItinerary): StepsGenerationRules => (
     currentCoords: Coordinates,
     nextCoords: Coordinates,
@@ -64,10 +39,14 @@ const buildStepsRules = (graphItinerary: OsmItinerary): StepsGenerationRules =>
     let levelChangeType: LevelChangeType | null = null;
     if (edge.data.isElevator) {
         levelChangeType = 'elevator';
-    } else if (edge.data.isConveying) {
+    } else if (edge.data instanceof OsmWay && edge.data.isConveying && edge.data.areStairs) {
+        // TODO: change to escalator
         levelChangeType = 'conveyor';
+        // levelChangeType = 'escalator';
     } else if (edge.data instanceof OsmWay && edge.data.areStairs) {
         levelChangeType = 'stairs';
+    } else if (edge.data instanceof OsmWay && edge.data.isConveying) {
+        levelChangeType = 'moving walkway';
     }
 
     // Handle stairs/elevator/conveyors without change in level coordinates
@@ -124,8 +103,9 @@ export class OsmItinerary extends GeoGraphItinerary<OsmVertexData, OsmEdgeData>
 
 class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
 
-    static DEFAULT_OPTIONS = DEFAULT_OPTIONS;
-    static WITHOUT_STAIRS_OPTIONS = WITHOUT_STAIRS_OPTIONS;
+    static DEFAULT_OPTIONS = WemapOsmRouter.buildOptions();
+    static WITHOUT_STAIRS_OPTIONS = WemapOsmRouter.buildOptions({ useStairs: false });
+    static DEFAULT_TRIP_OPTIONS = WemapOsmRouter.buildTripOptions();
 
     constructor(graph: OsmGraph) {
         super(graph);
@@ -138,7 +118,7 @@ class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
     getShortestPath(
         start: OsmVertex | Coordinates,
         end: OsmVertex | Coordinates,
-        options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData> = DEFAULT_OPTIONS
+        options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData> = WemapOsmRouter.DEFAULT_OPTIONS
     ) {
         return super.getShortestPath(start, end, options) as OsmItinerary;
     }
@@ -146,7 +126,7 @@ class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
     getItinerary(
         start: OsmVertex | Coordinates,
         end: OsmVertex | Coordinates,
-        options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData> = DEFAULT_OPTIONS
+        options: GeoGraphRouterOptions<OsmVertexData, OsmEdgeData> = WemapOsmRouter.DEFAULT_OPTIONS
     ) {
         const graphItinerary = this.getShortestPath(start, end, options);
 
@@ -177,7 +157,7 @@ class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
 
     getShortestTrip(
         waypoints: Coordinates[],
-        options: GeoGraphTripRouterOptions<OsmVertexData, OsmEdgeData> = DEFAULT_TRIP_OPTIONS
+        options: GeoGraphTripRouterOptions<OsmVertexData, OsmEdgeData> = WemapOsmRouter.DEFAULT_TRIP_OPTIONS
     ) {
         type CustomPoint = salesman.Point & { coords: Coordinates };
 
@@ -221,7 +201,7 @@ class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
 
     getTripItinerary(
         waypoints: Coordinates[],
-        options: GeoGraphTripRouterOptions<OsmVertexData, OsmEdgeData> = DEFAULT_TRIP_OPTIONS
+        options: GeoGraphTripRouterOptions<OsmVertexData, OsmEdgeData> = WemapOsmRouter.DEFAULT_TRIP_OPTIONS
     ) {
         const shortestTrip = this.getShortestTrip(waypoints, options);
         return new Itinerary({
@@ -230,6 +210,54 @@ class WemapOsmRouter extends GeoGraphRouter<OsmVertexData, OsmEdgeData> {
             legs: shortestTrip.map(graphItinerary => Leg.fromGraphItinerary(graphItinerary))
         });
     }
+
+    static buildOptions(options?: OsmRouterOptions): GeoGraphRouterOptions<OsmVertexData, OsmEdgeData> {
+
+        const weightEdgeFn = (edge: GeoGraphEdge<OsmVertexData, OsmEdgeData>) => {
+            if (edge.data?.isElevator) {
+                return 90;
+            }
+            let duration = getDurationFromLength(edge.length, 4);
+            if (edge.data instanceof OsmWay && edge.data.areStairs) {
+                duration *= 3;
+            }
+            return duration;
+        }
+
+        const acceptEdgeFn = (edge: GeoGraphEdge<OsmVertexData, OsmEdgeData>) => {
+
+            // Verify access
+            const accessTag = edge.data?.tags?.access;
+            if (typeof accessTag !== 'undefined' && accessTag !== 'yes') return false;
+
+            // Verify stairs
+            if (typeof options?.useStairs !== 'undefined' && !options?.useStairs
+                && edge.data instanceof OsmWay && edge.data.areStairs && !edge.data.isConveying) return false;
+
+            // Verify escalators
+            if (typeof options?.useEscalator !== 'undefined' && !options?.useEscalator
+                && edge.data instanceof OsmWay && edge.data.areStairs && edge.data.isConveying) return false;
+
+            // Verify elevator
+            if (typeof options?.useElevator !== 'undefined' && !options?.useElevator && edge.data?.isElevator) return false;
+
+            return true;
+        };
+
+        return {
+            weightEdgeFn,
+            acceptEdgeFn,
+            projectionMaxDistance: GeoGraphRouter.DEFAULT_OPTIONS.projectionMaxDistance
+        };
+    }
+
+    static buildTripOptions(options?: OsmRouterOptions): GeoGraphTripRouterOptions<OsmVertexData, OsmEdgeData> {
+        return Object.assign({},
+            WemapOsmRouter.buildOptions(options),
+            { tspTempCoeff: 0.99 }
+        );
+    }
+
 }
 
 export default WemapOsmRouter;

package/src/wemap-osm/OsmRouterOptions.ts

@@ -0,0 +1,12 @@
+export type OsmRouterOptions = {
+
+    useStairs?: boolean;
+
+    useEscalator?: boolean;
+
+    useElevator?: boolean;
+
+    isTrip?: boolean;
+
+    tspTempCoeff?: number;
+}