@wemap/routers 11.0.0-alpha.0 → 11.0.0-alpha.10

package/package.json

@@ -4,7 +4,7 @@
         "Thibaud Michel <thibaud@getwemap.com>"
     ],
     "description": "Wemap Routers utils package",
-    "module": "dist/index.js",
+    "main": "dist/index.js",
     "types": "index.ts",
     "repository": {
         "type": "git",
@@ -12,7 +12,7 @@
         "directory": "packages/routers"
     },
     "name": "@wemap/routers",
-    "version": "11.0.0-alpha.0",
+    "version": "11.0.0-alpha.10",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -33,16 +33,22 @@
         "@turf/boolean-point-in-polygon": "^6.5.0",
         "@turf/convex": "^6.5.0",
         "@turf/helpers": "^6.5.0",
-        "@wemap/geo": "^11.0.0-alpha.0",
-        "@wemap/logger": "^11.0.0-alpha.0",
-        "@wemap/maths": "^11.0.0-alpha.0",
-        "@wemap/osm": "^11.0.0-alpha.0"
+        "@types/mapbox__polyline": "^1.0.2",
+        "@wemap/geo": "^11.0.0-alpha.10",
+        "@wemap/logger": "^11.0.0-alpha.4",
+        "@wemap/maths": "^11.0.0-alpha.10",
+        "@wemap/osm": "^11.0.0-alpha.10"
     },
     "devDependencies": {
         "@types/fetch-mock": "^7.3.5",
-        "@types/mapbox__polyline": "^1.0.2",
         "fetch-mock": "^9.11.0",
         "geojson": "^0.5.0"
     },
-    "gitHead": "516aaa5323ac9c469cbc75b484b8cae14d1d8d12"
+    "exports": {
+        ".": {
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        }
+    },
+    "gitHead": "ae6bf2f3ae6e6e49242a03c38b4295f77d5b3ba4"
 }

package/src/ItineraryInfoManager.ts

@@ -1,4 +1,4 @@
-import { Coordinates, GraphEdge, GraphNode, GraphProjection, MapMatching, UserPosition } from '@wemap/geo';
+import { Coordinates, GraphEdge, GraphNode, GraphProjection, MapMatching } from '@wemap/geo';
 
 import Itinerary from './model/Itinerary.js';
 import Leg from './model/Leg.js';
@@ -7,7 +7,7 @@ import { Step } from './model/Step.js';
 export type ItineraryInfo<U extends Coordinates = Coordinates> = {
     nextStep: Step | null;
     previousStep: Step | null;
-    projection: GraphProjection<unknown, U>;
+    projection: GraphProjection<unknown, unknown, U>;
     leg: Leg;
     traveledDistance: number;
     remainingDistance: number;

package/src/model/Itinerary.spec.ts

@@ -68,11 +68,14 @@ export const verifyStepsCoherence = (itinerary: Itinerary) => {
         expect(step.previousBearing).equals(coordsBeforeStep.bearingTo(step.coords));
         expect(step.nextBearing).equals(step.coords.bearingTo(coordsAfterStep));
         expect(step.angle).almost.equals(diffAngle(step.previousBearing, step.nextBearing + Math.PI));
-        expect(step.previousStep).equals(stepId !== 0 ? steps[stepId - 1] : null);
-        expect(step.nextStep).equals(stepId !== steps.length - 1 ? steps[stepId + 1] : null);
         expect(step.firstStep).equals(stepId === 0);
         expect(step.lastStep).equals(stepId === steps.length - 1);
     });
+    itinerary.legs.forEach(leg => {
+        const legSteps = leg.getSteps(steps);
+        expect(legSteps.length).not.equals(0);
+        legSteps.forEach(step => expect(step).is.not.undefined);
+    });
 }
 
 describe('Itinerary', () => {
@@ -89,11 +92,11 @@ describe('Itinerary', () => {
     });
 
     it('steps coherence', () => {
-        // verifyStepsCoherence(itinerary1);
+        verifyStepsCoherence(itinerary1);
         verifyStepsCoherence(itinerary2);
-        // verifyStepsCoherence(itinerary3);
-        // verifyStepsCoherence(itinerary4);
-        // verifyStepsCoherence(itinerary5);
+        verifyStepsCoherence(itinerary3);
+        verifyStepsCoherence(itinerary4);
+        verifyStepsCoherence(itinerary5);
     });
 
     it('from / to JSON', () => {

package/src/model/Itinerary.ts

@@ -143,11 +143,6 @@ export default class Itinerary {
             }
         });
 
-        for (let i = 0; i < steps.length; i++) {
-            steps[i].previousStep = i !== 0 ? steps[i - 1] : null;
-            steps[i].nextStep = i !== steps.length - 1 ? steps[i + 1] : null;
-        }
-
         return steps;
     }
 
@@ -196,8 +191,8 @@ export default class Itinerary {
         // return this.legs.reduce((dist, leg) => dist + leg.distance, 0);
     }
 
-    toNetwork<T = unknown>() {
-        return Network.fromCoordinates<T>([this.coords]);
+    toNetwork<N = unknown, E = unknown>() {
+        return Network.fromCoordinates<N, E>([this.coords]);
     }
 
     static fromItineraries(...itineraries: Itinerary[]) {

package/src/model/Leg.spec.ts

@@ -40,18 +40,18 @@ const leg3 = new Leg({
 });
 
 const leg4 = new Leg({
-    from: { coords: new Coordinates(3, 0) },
+    from: { coords: new Coordinates(0, 0) },
     to: { coords: new Coordinates(4, 0) },
-    coords: [new Coordinates(3, 0), new Coordinates(4, 0)],
+    coords: [new Coordinates(0, 0), new Coordinates(4, 0)],
     mode: 'BOAT',
     duration: 2000,
     stepsInfo: [step1, step2, step3, step4]
 });
 
 const leg5 = new Leg({
-    from: { coords: new Coordinates(3, 0) },
+    from: { coords: new Coordinates(0, 0) },
     to: { coords: new Coordinates(4, 0) },
-    coords: [new Coordinates(3, 0), new Coordinates(4, 0)],
+    coords: [new Coordinates(0, 0), new Coordinates(4, 0)],
     mode: 'BOAT',
     duration: 2000,
     stepsInfo: [step1, step2, step3, step4]

package/src/model/Leg.ts

@@ -6,6 +6,7 @@ import { getDurationFromLength } from '../Utils.js';
 import generateSteps, { StepsGenerationRules } from './generateSteps.js';
 import { RoutingMode, isRoutingModePublicTransport } from './RoutingMode.js';
 
+import { Step } from './Step.js'
 import StepInfo, { StepInfoJson } from './StepInfo.js';
 
 export type Destination = {
@@ -101,8 +102,8 @@ export default class Leg {
         return isRoutingModePublicTransport(this.mode);
     }
 
-    toNetwork<T>() {
-        return Network.fromCoordinates<T>([this.coords]);
+    toNetwork<N, E>() {
+        return Network.fromCoordinates<N, E>([this.coords]);
     }
 
     static equals(obj1: Leg, obj2: Leg) {
@@ -224,4 +225,12 @@ export default class Leg {
             step.coords.level = Level.multiplyBy(step.coords.level, levelFactor);
         });
     }
+
+    /**
+     * Get leg steps from itinerary steps
+     * Steps cannot be retrieved directly from stepsInfo due to nextBearing/previousBearing 
+     */
+    getSteps(itinerarySteps: Step[]) {
+        return this.stepsInfo.map(stepInfo => itinerarySteps.find(_step => _step.coords.equals(stepInfo.coords)));
+    }
 }

package/src/model/Step.ts

@@ -20,8 +20,4 @@ export type Step = {
 
     readonly levelChange: LevelChange | null;
     readonly extras: StepExtra | null;
-
-    // Cannot be readonly by construction
-    previousStep: Step | null;
-    nextStep: Step | null;
 }

package/src/remote/cityway/CitywayRemoteRouter.ts

@@ -382,7 +382,8 @@ class CitywayRemoteRouter extends RemoteRouter {
                     coords: legCoords,
                     from: legFrom,
                     to: legTo,
-                    transportInfo
+                    transportInfo,
+                    stepsInfo
                 });
 
                 legs.push(leg);

package/src/remote/idfm/IdfmRemoteRouter.ts

@@ -300,10 +300,10 @@ class IdfmRemoteRouter extends RemoteRouter {
                 coords[_idCoordsInLeg] = newCoords;
             }
 
-            outputSteps.push({
+            outputSteps.push(new StepInfo({
                 ...step,
                 coords: newCoords
-            } as StepInfo);
+            }));
 
             previousStep = step;
         }

package/src/wemap-multi/CustomNetworkMap.ts

@@ -2,8 +2,8 @@ import pointInPolygon from '@turf/boolean-point-in-polygon';
 import convexHullFn from '@turf/convex';
 import { Feature, Polygon, polygon as turfPolygon, Position } from '@turf/helpers';
 
-import { Coordinates, GraphNode, Network, NoRouteFoundError } from '@wemap/geo';
-import { OsmParser, OsmNetworkUtils, OsmElement } from '@wemap/osm';
+import { Coordinates, NoRouteFoundError } from '@wemap/geo';
+import { OsmParser, OsmNetworkUtils, OsmNetwork, OsmGraphNode } from '@wemap/osm';
 
 import WemapOsmRouter from '../wemap-osm/WemapOsmRouter.js';
 import WemapOsmRouterOptions from '../wemap-osm/WemapOsmRouterOptions.js';
@@ -11,15 +11,15 @@ import WemapOsmRouterOptions from '../wemap-osm/WemapOsmRouterOptions.js';
 class CustomNetworkMap {
 
     name: string | null;
-    network: Network<OsmElement>;
+    network: OsmNetwork;
     router: WemapOsmRouter;
     bounds: Feature<Polygon>;
-    entryPoints: GraphNode<OsmElement>[];
+    entryPoints: OsmGraphNode[];
     disabledWays = new Set<number>();
 
     constructor(
-        network: Network<OsmElement>,
-        entryPoints: GraphNode<OsmElement>[],
+        network: OsmNetwork,
+        entryPoints: OsmGraphNode[],
         bounds: Coordinates[] | null = null,
         name: string | null = null) {
 
@@ -56,7 +56,7 @@ class CustomNetworkMap {
 
         const entryPoints = osmModel.nodes
             .filter(({ tags }) => tags && tags['wemap:routing-io'])
-            .map(osmNode => network.getNodeByCoords(osmNode.coords) as GraphNode<OsmElement>);
+            .map(osmNode => network.getNodeByCoords(osmNode.coords) as OsmGraphNode);
         if (entryPoints.some(el => el === null)
             || new Set(entryPoints).size !== entryPoints.length
         ) {

package/src/wemap-osm/WemapOsmRouter.spec.ts

@@ -4,8 +4,8 @@ import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
 
-import { Coordinates, GraphNode, GraphItinerary } from '@wemap/geo';
-import { OsmElement, OsmParser, OsmNetworkUtils } from '@wemap/osm';
+import { Coordinates, GraphItinerary } from '@wemap/geo';
+import { OsmElement, OsmParser, OsmNetworkUtils, OsmGraphNode } from '@wemap/osm';
 
 import WemapOsmRouter from './WemapOsmRouter.js';
 import WemapOsmRouterOptions from './WemapOsmRouterOptions.js';
@@ -44,18 +44,18 @@ describe('WemapOsmRouter - Multi-level itinerary', () => {
     const graphItinerary = router.getShortestPath(itineraryStart, itineraryEnd);
     const itinerary = router.getItinerary(itineraryStart, itineraryEnd);
 
-    const p: GraphNode<OsmElement>[] = [];
+    const p: OsmGraphNode[] = [];
 
     it('Search for nodes', () => {
         for (let i = 1; i <= 16; i++) {
-            p[i] = getNodeByName(networkModel, 'p' + i) as GraphNode<OsmElement>;
-            expect(p[i]).instanceOf(GraphNode);
+            p[i] = getNodeByName(networkModel, 'p' + i) as OsmGraphNode;
+            expect(p[i]).instanceOf(OsmGraphNode);
         }
     });
 
     it('Router return shortest path', () => {
         expect(getNodesNames(graphItinerary)).deep.equals(
-            ['w2', ...generateNodeNames(7, 16)]
+            [null, ...generateNodeNames(7, 16)]
         );
     });
 
@@ -115,7 +115,7 @@ describe('WemapOsmRouter - Multi-level itinerary', () => {
         const end = new Coordinates(43.60917216742, 3.8842355275, null, 2);
         const itinerary2 = router.getShortestPath(start, end);
 
-        expect(getNodesNames(itinerary2)).deep.equals(['w1', 'p6', 'p5']);
+        expect(getNodesNames(itinerary2)).deep.equals([null, 'p6', 'p5']);
     });
 
     it('do not use stairs', () => {
@@ -191,8 +191,8 @@ describe('WemapOsmRouter - Conveying - backward', () => {
 
     it('do not use oneway conveying', () => {
 
-        const start = getNodeByName(networkModel, 'p6') as GraphNode<OsmElement>;
-        const end = getNodeByName(networkModel, 'p13') as GraphNode<OsmElement>;
+        const start = getNodeByName(networkModel, 'p6') as OsmGraphNode;
+        const end = getNodeByName(networkModel, 'p13') as OsmGraphNode;
 
         const itinerary = router.getShortestPath(start, end);
         expect(itinerary).is.not.undefined;

package/src/wemap-osm/WemapOsmRouter.ts

@@ -1,5 +1,5 @@
-import { Coordinates, GraphItinerary, GraphNode, GraphRouter, GraphUtils, Network } from '@wemap/geo';
-import { OsmElement, OsmNode, OsmWay } from '@wemap/osm';
+import { Coordinates, GraphUtils } from '@wemap/geo';
+import { OsmGraphItinerary, OsmGraphNode, OsmGraphRouter, OsmNetwork, OsmNode, OsmWay } from '@wemap/osm';
 
 import { StepsGenerationRules } from '../model/generateSteps.js';
 import Itinerary from '../model/Itinerary.js';
@@ -7,7 +7,7 @@ import { LevelChangeType } from '../model/LevelChange.js';
 import WemapOsmRouterOptions from './WemapOsmRouterOptions.js';
 
 
-const buildStepsRules = (graphItinerary: GraphItinerary<OsmElement>): StepsGenerationRules => (
+const buildStepsRules = (graphItinerary: OsmGraphItinerary): StepsGenerationRules => (
     currentCoords: Coordinates,
     nextCoords: Coordinates
 ) => {
@@ -24,11 +24,11 @@ const buildStepsRules = (graphItinerary: GraphItinerary<OsmElement>): StepsGener
     const isGate = node ? (node.builtFrom?.tags.barrier === 'gate' || node.builtFrom?.tags.aeroway === 'gate') : false;
 
     let levelChangeType: LevelChangeType | null = null;
-    if (edge.builtFrom instanceof OsmNode && edge.builtFrom.isElevator) {
+    if (edge.builtFrom?.isElevator) {
         levelChangeType = 'elevator';
     } else if (
-        edge.builtFrom instanceof OsmNode
-        || edge.builtFrom instanceof OsmWay && edge.builtFrom.isConveying
+        (edge.builtFrom instanceof OsmNode || edge.builtFrom instanceof OsmWay)
+        && edge.builtFrom.isConveying
     ) {
         levelChangeType = 'conveyor';
     } else if (edge.builtFrom instanceof OsmWay && edge.builtFrom.areStairs) {
@@ -48,9 +48,9 @@ const buildStepsRules = (graphItinerary: GraphItinerary<OsmElement>): StepsGener
     };
 };
 
-class WemapOsmRouter extends GraphRouter<OsmElement> {
+class WemapOsmRouter extends OsmGraphRouter {
 
-    constructor(network: Network<OsmElement>) {
+    constructor(network: OsmNetwork) {
         super(network);
     }
 
@@ -59,16 +59,16 @@ class WemapOsmRouter extends GraphRouter<OsmElement> {
     }
 
     getShortestPath(
-        start: GraphNode<OsmElement> | Coordinates,
-        end: GraphNode<OsmElement> | Coordinates,
+        start: OsmGraphNode | Coordinates,
+        end: OsmGraphNode | Coordinates,
         options = new WemapOsmRouterOptions()
     ) {
         return super.getShortestPath(start, end, options);
     }
 
     getItinerary(
-        start: GraphNode<OsmElement> | Coordinates,
-        end: GraphNode<OsmElement> | Coordinates,
+        start: OsmGraphNode | Coordinates,
+        end: OsmGraphNode | Coordinates,
         options = new WemapOsmRouterOptions()
     ) {
         const graphItinerary = this.getShortestPath(start, end, options);

package/src/wemap-osm/WemapOsmRouterOptions.ts

@@ -1,19 +1,19 @@
-import { GraphEdge, GraphRouterOptions } from '@wemap/geo';
-import { OsmElement, OsmNode } from '@wemap/osm';
+import { GraphEdge } from '@wemap/geo';
+import { OsmNode, OsmGraphRouterOptions, OsmGraphEdge } from '@wemap/osm';
 
 import { getDurationFromLength } from '../Utils.js';
 
-class WemapOsmRouterOptions extends GraphRouterOptions<OsmElement> {
+class WemapOsmRouterOptions extends OsmGraphRouterOptions {
 
     static DEFAULT = new WemapOsmRouterOptions();
 
     static get WITHOUT_STAIRS() {
         const options = new WemapOsmRouterOptions();
-        options.acceptEdgeFn = (edge: GraphEdge<OsmElement>) => edge.builtFrom?.tags.highway !== 'steps';
+        options.acceptEdgeFn = (edge: OsmGraphEdge) => edge.builtFrom?.tags.highway !== 'steps';
         return options;
     }
 
-    weightEdgeFn = (edge: GraphEdge<OsmElement>) =>
+    weightEdgeFn = (edge: GraphEdge) =>
         edge.builtFrom instanceof OsmNode && edge.builtFrom.isElevator
         ? 30
         : getDurationFromLength(edge.length);