@wemap/osm 4.0.15 → 5.0.2

package/src/osrm/OsrmUtils.js

@@ -1,284 +0,0 @@
-/* eslint-disable max-statements */
-import {
-    Level, Coordinates, Edge, Node, Itinerary, Step, Network
-} from '@wemap/geo';
-import {
-    rad2deg, positiveMod, diffAngle, deg2rad
-} from '@wemap/maths';
-
-
-export function coordinatesToJson(coordinates) {
-    const output = [coordinates.lng, coordinates.lat];
-    if (coordinates.level) {
-        output.push(coordinates.level.toString());
-    }
-    return output;
-}
-
-export function jsonToCoordinates(json) {
-    const output = new Coordinates(json[1], json[0]);
-    if (json.length > 2) {
-        output.level = Level.fromString(json[2]);
-    }
-    return output;
-}
-
-export function nodesToJsonCoords(nodes) {
-    return nodes.map(node => coordinatesToJson(node.coords));
-}
-
-
-export function getModifierFromAngle(_angle) {
-
-    const angle = positiveMod(rad2deg(_angle), 360);
-
-    if (angle > 0 && angle < 60) {
-        return 'sharp right';
-    }
-    if (angle >= 60 && angle < 140) {
-        return 'right';
-    }
-    if (angle >= 140 && angle < 160) {
-        return 'slight right';
-    }
-    if (angle >= 160 && angle <= 200) {
-        return 'straight';
-    }
-    if (angle > 200 && angle <= 220) {
-        return 'slight left';
-    }
-    if (angle > 220 && angle <= 300) {
-        return 'left';
-    }
-    if (angle > 300 && angle < 360) {
-        return 'sharp left';
-    }
-    return 'u turn';
-}
-
-
-export function noRouteFoundJson(message) {
-    return {
-        'code': 'NoRoute',
-        message
-    };
-}
-
-/**
- * @param {Itinerary} itinerary
- * @returns {object}
- */
-export function itineraryToOsrmJson(itinerary) {
-
-    const itinerarySteps = itinerary.steps;
-    const osrmSteps = [];
-
-    const lastStepId = itinerarySteps.length - 1;
-    for (let i = 0; i <= lastStepId; i++) {
-
-        const {
-            nodes, length, nextEdge, nextBearing, previousBearing, angle, node,
-            duration, levelChange, subwayEntrance, subwayEntranceRef
-        } = itinerarySteps[i];
-
-        const name = (i === lastStepId ? node.name : nextEdge.name) || '';
-
-        let type = i === 0 ? 'depart' : 'turn';
-        type = i === lastStepId ? 'arrive' : type;
-
-        const bearingBefore = positiveMod(i === 0 ? 0 : previousBearing, 2 * Math.PI);
-        const bearingAfter = positiveMod(i === lastStepId ? 0 : nextBearing, 2 * Math.PI);
-
-        const osrmStep = {
-            geometry: {
-                type: 'LineString',
-                coordinates: nodesToJsonCoords(nodes)
-            },
-            distance: length,
-            duration,
-            name,
-            maneuver: {
-                bearing_before: rad2deg(bearingBefore),
-                bearing_after: rad2deg(bearingAfter),
-                location: coordinatesToJson(node.coords),
-                type
-            }
-        };
-
-        if (levelChange !== null) {
-            osrmStep.levelChange = levelChange;
-        }
-        if (subwayEntrance) {
-            osrmStep.name = node.name;
-            osrmStep.subwayEntrance = true;
-            if (subwayEntranceRef) {
-                osrmStep.subwayEntranceRef = subwayEntranceRef;
-            }
-        }
-
-        // The first modifier is not mandatory by OSRM.
-        // if (i !== 0) {
-        osrmStep.maneuver.modifier = getModifierFromAngle(angle);
-        // }
-
-        osrmSteps.push(osrmStep);
-    }
-
-    return {
-        'code': 'Ok',
-        'routes': [
-            {
-                'geometry': {
-                    'type': 'LineString',
-                    'coordinates': nodesToJsonCoords(itinerary.nodes)
-                },
-                'legs': [
-                    {
-                        'duration': itinerary.duration,
-                        'distance': itinerary.length,
-                        'steps': osrmSteps
-                    }
-                ],
-                'distance': itinerary.length,
-                'duration': itinerary.duration,
-                'weight_name': 'routability',
-                'weight': 0
-            }
-        ],
-        'waypoints': []
-    };
-}
-
-/**
- * @param {Itinerary} itinerary
- * @param {object} jsonSteps
- */
-function _parseSteps(itinerary, jsonSteps) {
-
-    itinerary._steps = [];
-    itinerary._nextStepsIndexes = [];
-
-    let currentNodeIndex = 0;
-
-    for (let i = 0; i < jsonSteps.length; i++) {
-        const jsonStep = jsonSteps[i];
-
-        const step = new Step();
-        step.number = i + 1;
-        step.firstStep = i === 0;
-        step.lastStep = i === jsonSteps.length - 1;
-
-
-        /**
-         * Add nodes and edges to step
-         */
-        step.nodes = [];
-        step.edges = [];
-
-        let previousNode;
-        let { coordinates } = jsonStep.geometry;
-
-        // The OSRM last step is twice the last node. So, remove the second.
-        if (step.lastStep) {
-            coordinates = [coordinates[0]];
-        }
-
-        for (const coords of coordinates) {
-
-            const node = itinerary.nodes[currentNodeIndex];
-            step.nodes.push(node);
-
-            const isFirstNode = coordinates[0] === coords;
-            const isLastNode = coordinates[coordinates.length - 1] === coords;
-            if (isFirstNode) {
-                itinerary._nextStepsIndexes.push(i);
-            } else if (!isLastNode) {
-                itinerary._nextStepsIndexes.push(i + 1);
-            }
-
-            if (previousNode) {
-                const edge = Network.getEdgeByNodes(previousNode.edges, previousNode, node);
-                step.edges.push(edge);
-
-                if (jsonStep.name) {
-                    edge.name = jsonStep.name;
-                }
-            }
-
-            previousNode = node;
-            currentNodeIndex++;
-        }
-
-
-        const firstStepNode = step.nodes[0];
-        if (jsonStep.subwayEntrance === true) {
-            firstStepNode.subwayEntrance = true;
-            step.subwayEntrance = true;
-            if (jsonStep.subwayEntranceRef) {
-                firstStepNode.subwayEntranceRef = jsonStep.subwayEntranceRef;
-                step.subwayEntranceRef = jsonStep.subwayEntranceRef;
-            }
-        }
-
-        /**
-         * Add common fields
-         */
-        step.previousBearing = step.firstStep
-            ? itinerary.start.bearingTo(itinerary.nodes[0].coords)
-            : deg2rad(jsonStep.maneuver.bearing_before);
-        step.nextBearing = step.lastStep
-            ? previousNode.coords.bearingTo(itinerary.end)
-            : deg2rad(jsonStep.maneuver.bearing_after);
-        step.angle = diffAngle(step.previousBearing, step.nextBearing + Math.PI);
-        step.name = jsonStep.name;
-        step.levelChange = jsonStep.levelChange ? jsonStep.levelChange : null;
-
-        itinerary._steps.push(step);
-
-        currentNodeIndex--;
-    }
-}
-
-/**
- * Generate Itinerary from OSRM JSON, start and end.
- * @param {object} json JSON file provided by OSRM.
- * @param {Coordinates} start itinerary start
- * @param {Coordinates} end itinerary end
- */
-export function createItineraryFromJson(json, start, end) {
-    const itinerary = new Itinerary();
-
-    itinerary.start = start;
-    itinerary.end = end;
-
-    const {
-        legs, geometry
-    } = json.routes[0];
-
-    /**
-     * Create nodes and edges from geometry
-     */
-    let previousNode;
-    const { coordinates } = geometry;
-    for (let i = 0; i < coordinates.length; i++) {
-        const node = new Node(jsonToCoordinates(coordinates[i]));
-        itinerary.nodes.push(node);
-
-        if (previousNode) {
-            const edge = new Edge(previousNode, node);
-            edge.level = Level.union(previousNode.coords.level, node.coords.level);
-            itinerary.edges.push(edge);
-        }
-
-        previousNode = node;
-    }
-
-    if (legs && legs[0]) {
-        const { steps } = legs[0];
-        _parseSteps(itinerary, steps);
-    }
-
-    return itinerary;
-}
-
-

package/src/osrm/OsrmUtils.spec.js

@@ -1,384 +0,0 @@
-/* eslint-disable max-statements */
-import chai from 'chai';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import {
-    Level, Coordinates, Edge, GraphRouter
-} from '@wemap/geo';
-import { verifyCoherence } from '@wemap/geo/tests/CommonTest.js';
-
-import OsmParser from '../model/OsmParser.js';
-import OsmNetworkUtils from '../network/OsmNetworkUtils.js';
-import {
-    itineraryToOsrmJson,
-    jsonToCoordinates,
-    createItineraryFromJson,
-    getModifierFromAngle,
-    noRouteFoundJson
-} from './OsrmUtils.js';
-
-const { expect } = chai;
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-
-const load = fileName => {
-    const filePath = path.resolve(__dirname, '../../assets/' + fileName);
-    const osmXmlString = fs.readFileSync(filePath, 'utf8');
-    const model = OsmParser.parseOsmXmlString(osmXmlString);
-    const network = OsmNetworkUtils.createNetworkFromOsmModel(model);
-    const router = new GraphRouter(network);
-    return {
-        network,
-        router
-    };
-};
-
-let wemapIndoorItinerary, wemapIndoorJsonItinerary, wemapIndoorStart, wemapIndoorEnd;
-let wemapOutdoorItinerary, wemapOutdoorJsonItinerary, wemapOutdoorStart, wemapOutdoorEnd;
-
-describe('OsrmUtils - itineraryToOsrmJson', () => {
-
-    it('With levels (Bureaux Wemap)', () => {
-
-        const {
-            network, router
-        } = load('bureaux-wemap-montpellier-network.osm');
-
-        wemapIndoorStart = new Coordinates(43.6092754, 3.8842306, null, new Level(2));
-        wemapIndoorEnd = new Coordinates(43.6092602, 3.8842669, null, new Level(1));
-        const itinerary = router.getShortestPath(wemapIndoorStart, wemapIndoorEnd);
-        wemapIndoorItinerary = itinerary;
-
-        const osrmJson = itineraryToOsrmJson(itinerary);
-        wemapIndoorJsonItinerary = osrmJson;
-        const itinerarySteps = itinerary.steps;
-
-        const {
-            geometry, legs
-        } = osrmJson.routes[0];
-
-        /**
-         * Verify if JSON geometry corresponds to Itinerary points
-         */
-        const { coordinates } = geometry;
-        expect(coordinates.length).equal(11);
-        for (let i = 1; i < 11; i++) {
-            expect(
-                network.getNodeByName('p' + (i + 6)).coords.equalsTo(
-                    jsonToCoordinates(coordinates[i]))
-            ).true;
-        }
-
-        /**
-         * Verify location, type and modifier of each step
-         */
-        const { steps } = legs[0];
-        for (let i = 0; i < steps.length; i++) {
-            const {
-                location, type
-            } = steps[i].maneuver;
-            expect(itinerarySteps[i].node.coords.equalsTo(jsonToCoordinates(location))).true;
-
-            let expectedType;
-            switch (i) {
-            case 0:
-                expectedType = 'depart';
-                break;
-            case steps.length - 1:
-                expectedType = 'arrive';
-                break;
-            default:
-                expectedType = 'turn';
-            }
-            expect(type).equals(expectedType);
-        }
-
-        // The first modifier is not mandatory by OSRM.
-        expect(steps[0].maneuver.modifier).equals('left');
-        expect(steps[0].distance).be.closeTo(2.33, 0.01);
-        expect(steps[0].maneuver.bearing_after).be.closeTo(11.90, 0.01);
-
-        expect(steps[1].maneuver.modifier).equals('right');
-        expect(steps[1].distance).be.closeTo(1.76, 0.01);
-        expect(steps[1].maneuver.bearing_after).be.closeTo(56.90, 0.01);
-
-        expect(steps[2].maneuver.modifier).equals('left');
-        expect(steps[2].distance).be.closeTo(1.15, 0.01);
-        expect(steps[2].maneuver.bearing_after).be.closeTo(11.90, 0.01);
-
-        expect(steps[3].maneuver.modifier).equals('left');
-        expect(steps[3].distance).be.closeTo(5.95, 0.01);
-        expect(steps[3].maneuver.bearing_after).be.closeTo(281.93, 0.01);
-
-        expect(steps[4].maneuver.modifier).equals('right');
-        expect(steps[4].distance).be.closeTo(10.71, 0.01);
-        expect(steps[4].maneuver.bearing_after).be.closeTo(12.22, 0.01);
-        expect(steps[4].levelChange).is.not.null;
-        expect(steps[4].levelChange.direction).equals('down');
-        expect(steps[4].levelChange.difference).equals(-1);
-        expect(steps[4].levelChange.type).equals('stairs');
-
-        expect(steps[5].maneuver.modifier).equals('left');
-        expect(steps[5].distance).be.closeTo(4.23, 0.01);
-        expect(steps[5].maneuver.bearing_after).be.closeTo(102.00, 0.01);
-
-        expect(steps[6].maneuver.modifier).equals('right');
-        expect(steps[6].distance).be.closeTo(5.03, 0.01);
-        expect(steps[6].maneuver.bearing_after).be.closeTo(191.75, 0.01);
-
-        expect(steps[7].maneuver.modifier).equals('left');
-        expect(steps[7].distance).be.closeTo(0, 0.01);
-        expect(steps[7].maneuver.bearing_after).be.closeTo(0, 0.01);
-
-    });
-
-    it('Without levels', () => {
-
-        const {
-            network, router
-        } = load('network-simple.osm');
-
-        const start = network.getNodeByName('p1');
-        const end = network.getNodeByName('p3');
-
-        const itinerary = router.getShortestPath(start, end);
-
-        wemapOutdoorJsonItinerary = itineraryToOsrmJson(itinerary);
-
-        wemapOutdoorStart = start.coords;
-        wemapOutdoorEnd = end.coords;
-        wemapOutdoorItinerary = itinerary;
-    });
-
-    it('Itinerary with modifiers', () => {
-
-        const {
-            network, router
-        } = load('network-with-modifiers.osm');
-
-        const start = network.getNodeByName('start');
-        const end = network.getNodeByName('end');
-
-        const itinerary = router.getShortestPath(start, end);
-        expect(() => itineraryToOsrmJson(itinerary)).not.throw(Error);
-
-    });
-
-});
-
-
-describe('OsrmUtils - createItineraryFromJson', () => {
-
-
-    it('Without levels (Montpellier outdoor)', () => {
-
-        const filePath = path.resolve(__dirname, '../../assets/itinerary-montpellier-outdoor.json');
-        const fileString = fs.readFileSync(filePath, 'utf8');
-
-        const json = JSON.parse(fileString);
-
-        const start = new Coordinates(43.6007871, 3.8757218000000004);
-        const end = new Coordinates(43.598877, 3.873866);
-
-        const itinerary = createItineraryFromJson(json, start, end);
-
-        expect(json.routes[0].geometry.coordinates.length).equal(itinerary.nodes.length);
-        expect(itinerary.nodes.length).equal(itinerary.edges.length + 1);
-        expect(itinerary.nodes.length).equal(19);
-
-        const { steps } = itinerary;
-        expect(steps.length).equal(5);
-
-        let step;
-        step = steps[0];
-        expect(Coordinates.equalsTo(step.location, new Coordinates(43.600777, 3.875607))).true;
-        expect(getModifierFromAngle(step.angle)).equals('left');
-        expect(step.nodes.length).equals(6);
-        expect(step.edges.length).equals(5);
-        expect(step.firstStep).true;
-        expect(step.lastStep).false;
-        expect(step.name).equals('');
-
-        step = steps[1];
-        expect(Coordinates.equalsTo(step.location, new Coordinates(43.599881, 3.876396))).true;
-        expect(getModifierFromAngle(step.angle)).equals('right');
-        expect(step.nodes.length).equals(12);
-        expect(step.edges.length).equals(11);
-        expect(step.firstStep).false;
-        expect(step.lastStep).false;
-        expect(step.name).equals('Boulevard Vieussens');
-
-        step = steps[2];
-        expect(Coordinates.equalsTo(step.location, new Coordinates(43.599577, 3.874655))).true;
-        expect(getModifierFromAngle(step.angle)).equals('left');
-        expect(step.nodes.length).equals(2);
-        expect(step.edges.length).equals(1);
-        expect(step.firstStep).false;
-        expect(step.lastStep).false;
-        expect(step.name).equals('Impasse Bizeray');
-
-        step = steps[3];
-        expect(Coordinates.equalsTo(step.location, new Coordinates(43.599063, 3.874623))).true;
-        expect(getModifierFromAngle(step.angle)).equals('right');
-        expect(step.nodes.length).equals(2);
-        expect(step.edges.length).equals(1);
-        expect(step.firstStep).false;
-        expect(step.lastStep).false;
-        expect(step.name).equals('Rue du Docteur Louis Perrier');
-
-        step = steps[4];
-        expect(Coordinates.equalsTo(step.location, new Coordinates(43.59906, 3.873865))).true;
-        expect(getModifierFromAngle(step.angle)).equals('left');
-        expect(step.nodes.length).equals(1);
-        expect(step.edges.length).equals(0);
-        expect(step.firstStep).false;
-        expect(step.lastStep).true;
-        expect(step.name).equals('Rue du Docteur Louis Perrier');
-
-        expect(itinerary._nextStepsIndexes.length).equals(itinerary.nodes.length);
-        expect(itinerary._nextStepsIndexes[0]).equals(0);
-        for (let i = 1; i <= 5; i++) {
-            expect(itinerary._nextStepsIndexes[i]).equals(1);
-        }
-        for (let i = 6; i <= 16; i++) {
-            expect(itinerary._nextStepsIndexes[i]).equals(2);
-        }
-        expect(itinerary._nextStepsIndexes[17]).equals(3);
-        expect(itinerary._nextStepsIndexes[18]).equals(4);
-    });
-
-
-    it('Without levels (from itineraryToOsrmJson)', () => {
-
-        const itinerary = createItineraryFromJson(wemapOutdoorJsonItinerary,
-            wemapOutdoorStart, wemapOutdoorEnd);
-
-        expect(itinerary.nodes.length).equal(wemapOutdoorItinerary.nodes.length);
-        for (let i = 0; i < itinerary.nodes.length; i++) {
-            const itineraryNode = itinerary.nodes[i];
-            const wemapItineraryNode = wemapOutdoorItinerary.nodes[i];
-            expect(itineraryNode.coords.equalsTo(wemapItineraryNode.coords)).true;
-        }
-
-        expect(itinerary.edges.length).equal(wemapOutdoorItinerary.edges.length);
-        for (let i = 0; i < itinerary.edges.length; i++) {
-            const itineraryEdge = itinerary.edges[i];
-            const wemapItineraryEdge = wemapOutdoorItinerary.edges[i];
-            const firstNode = wemapItineraryEdge[wemapOutdoorItinerary._edgesDirectionReversed[i] ? 'node2' : 'node1'];
-            const secondNode = wemapItineraryEdge[wemapOutdoorItinerary._edgesDirectionReversed[i] ? 'node1' : 'node2'];
-            expect(itineraryEdge.node1.coords.equalsTo(firstNode.coords)).true;
-            expect(itineraryEdge.node2.coords.equalsTo(secondNode.coords)).true;
-            expect(Level.equalsTo(itineraryEdge.level, wemapItineraryEdge.level)).true;
-        }
-
-    });
-
-    it('Without steps (Montpellier outdoor)', () => {
-
-        const filePath = path.resolve(__dirname,
-            '../../assets/itinerary-montpellier-outdoor-without-steps.json');
-        const fileString = fs.readFileSync(filePath, 'utf8');
-
-        const json = JSON.parse(fileString);
-
-        const start = new Coordinates(43.6007871, 3.8757218000000004);
-        const end = new Coordinates(43.598877, 3.873866);
-
-        const itinerary = createItineraryFromJson(json, start, end);
-
-        expect(json.routes[0].geometry.coordinates.length).equal(itinerary.nodes.length);
-        expect(itinerary.nodes.length).equal(itinerary.edges.length + 1);
-        expect(itinerary.nodes.length).equal(19);
-
-        const { steps } = itinerary;
-        expect(steps.length).equal(7);
-    });
-
-
-    it('With levels (from itineraryToOsrmJson)', () => {
-
-        const itinerary = createItineraryFromJson(wemapIndoorJsonItinerary,
-            wemapIndoorStart, wemapIndoorEnd);
-
-        expect(itinerary.nodes.length).equal(wemapIndoorItinerary.nodes.length);
-        for (let i = 0; i < itinerary.nodes.length; i++) {
-            const itineraryNode = itinerary.nodes[i];
-            const wemapItineraryNode = wemapIndoorItinerary.nodes[i];
-            expect(itineraryNode.coords.equalsTo(wemapItineraryNode.coords)).true;
-        }
-
-        expect(itinerary.edges.length).equal(wemapIndoorItinerary.edges.length);
-        for (let i = 0; i < itinerary.edges.length; i++) {
-            const itineraryEdge = itinerary.edges[i];
-            const wemapItineraryEdge = wemapIndoorItinerary.edges[i];
-            const firstNode = wemapItineraryEdge[wemapIndoorItinerary._edgesDirectionReversed[i] ? 'node2' : 'node1'];
-            const secondNode = wemapItineraryEdge[wemapIndoorItinerary._edgesDirectionReversed[i] ? 'node1' : 'node2'];
-            expect(itineraryEdge.node1.coords.equalsTo(firstNode.coords)).true;
-            expect(itineraryEdge.node2.coords.equalsTo(secondNode.coords)).true;
-            expect(Level.equalsTo(itineraryEdge.level, wemapItineraryEdge.level)).true;
-        }
-
-    });
-
-    it('Errored (Montpellier outdoor)', () => {
-
-        const filePath = path.resolve(__dirname,
-            '../../assets/itinerary-with-duplicate-nodes.json');
-        const fileString = fs.readFileSync(filePath, 'utf8');
-
-        const json = JSON.parse(fileString);
-
-        const start = new Coordinates(44.810569099999995, 4.9503924999999995);
-        const end = new Coordinates(44.302673, 4.556377);
-
-        const itinerary = createItineraryFromJson(json, start, end);
-        itinerary.edges.forEach(edge => {
-            expect(edge).instanceOf(Edge);
-        });
-        itinerary.steps.forEach(step => {
-            step.edges.forEach(edge => {
-                expect(edge).instanceOf(Edge);
-            });
-        });
-    });
-
-});
-
-describe('OsrmUtils - itineraryToOsrmJson - createItineraryFromJson - way/node', () => {
-
-    it('With levels (Bureaux Wemap)', () => {
-
-        const { router } = load('bureaux-wemap-montpellier-network.osm');
-
-        const start = new Coordinates(43.6092754, 3.8842306, null, new Level(2));
-        const end = new Coordinates(43.60949854, 3.88452048, null, new Level(0));
-        const itinerary = router.getShortestPath(start, end);
-
-        const osrmJson = itineraryToOsrmJson(itinerary);
-        const jsonSteps = osrmJson.routes[0].legs[0].steps;
-
-        expect(jsonSteps[0].name).equals('w2');
-        expect(jsonSteps[4].name).equals('p19');
-        expect(jsonSteps[6].name).equals('p21');
-
-        const itineraryBis = createItineraryFromJson(osrmJson, start, end);
-        verifyCoherence(itineraryBis);
-
-        expect(itineraryBis.nodes.length).equals(itinerary.nodes.length);
-        expect(itineraryBis.edges.length).equals(itinerary.edges.length);
-        expect(itineraryBis.steps.length).equals(itinerary.steps.length);
-    });
-});
-
-describe('OsrmUtils - Output JSON', () => {
-
-    it('noRouteFoundJson', () => {
-        expect(noRouteFoundJson('foo')).deep.equals({
-            'code': 'NoRoute',
-            'message': 'foo'
-        });
-    });
-
-});