@wemap/osm 3.2.17 → 4.0.0

package/assets/bureaux-wemap-montpellier-network.osm

@@ -81,6 +81,7 @@
     <nd ref='-440474' />
     <tag k='highway' v='footway' />
     <tag k='level' v='2' />
+    <tag k='name' v='w2' />
   </way>
   <way id='-440500' action='modify' visible='true'>
     <nd ref='-440464' />
@@ -91,6 +92,7 @@
     <nd ref='-440480' />
     <tag k='highway' v='footway' />
     <tag k='level' v='2' />
+    <tag k='name' v='w3' />
   </way>
   <way id='-440501' action='modify' visible='true'>
     <nd ref='-440472' />
@@ -102,6 +104,7 @@
     <nd ref='-440478' />
     <tag k='highway' v='footway' />
     <tag k='level' v='2' />
+    <tag k='name' v='w1' />
   </way>
   <way id='-440502' action='modify' visible='true'>
     <nd ref='-440486' />
@@ -110,12 +113,14 @@
     <nd ref='-440492' />
     <tag k='highway' v='steps' />
     <tag k='level' v='1;2' />
+    <tag k='name' v='w6' />
   </way>
   <way id='-440503' action='modify' visible='true'>
     <nd ref='-440484' />
     <nd ref='-440486' />
     <tag k='highway' v='footway' />
     <tag k='level' v='2' />
+    <tag k='name' v='w5' />
   </way>
   <way id='-440504' action='modify' visible='true'>
     <nd ref='-440492' />
@@ -124,29 +129,34 @@
     <nd ref='-440496' />
     <tag k='highway' v='footway' />
     <tag k='level' v='1' />
+    <tag k='name' v='w7' />
   </way>
   <way id='-440505' action='modify' visible='true'>
     <nd ref='-440494' />
     <nd ref='-440498' />
     <tag k='highway' v='footway' />
     <tag k='level' v='1' />
+    <tag k='name' v='w9' />
   </way>
   <way id='-441188' action='modify' visible='true'>
     <nd ref='-441184' />
     <nd ref='-441187' />
     <tag k='highway' v='footway' />
     <tag k='level' v='2' />
+    <tag k='name' v='w4' />
   </way>
   <way id='-441214' action='modify' visible='true'>
     <nd ref='-441210' />
     <nd ref='-441187' />
     <tag k='highway' v='footway' />
     <tag k='level' v='1' />
+    <tag k='name' v='w8' />
   </way>
   <way id='-441263' action='modify' visible='true'>
     <nd ref='-441187' />
     <nd ref='-441262' />
     <tag k='highway' v='footway' />
     <tag k='level' v='0' />
+    <tag k='name' v='w10' />
   </way>
 </osm>

package/assets/network-elevator.osm

@@ -1,47 +1,47 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<osm>
-  <node id='1' lat='43.60933232537' lon='3.88424831515'>
+<osm version='0.6'>
+  <node id='-1' lat='43.60933232537' lon='3.88424831515' version='1'>
     <tag k='highway' v='elevator' />
     <tag k='level' v='1;3' />
-    <tag k='name' v='p2' />
+    <tag k='name' v='px' />
   </node>
-  <node id='2' lat='43.60932786117' lon='3.88427765877'>
+  <node id='1' lat='43.60932786117' lon='3.88427765877' version='1'>
     <tag k='name' v='p1' />
   </node>
-  <node id='3' lat='43.60932786111' lon='3.8842776591'>
-    <tag k='name' v='p3' />
+  <node id='2' lat='43.60932786111' lon='3.8842776591' version='1'>
+    <tag k='name' v='p2' />
   </node>
-  <node id='4' lat='43.60932198746' lon='3.8843159771'>
-    <tag k='name' v='p4' />
+  <node id='3' lat='43.60932198746' lon='3.8843159771' version='1'>
+    <tag k='name' v='p3-1' />
   </node>
-  <node id='5' lat='43.60932198746' lon='3.8843159771'>
-    <tag k='name' v='p5' />
+  <node id='4' lat='43.60932198746' lon='3.8843159771' version='1'>
+    <tag k='name' v='p3-2' />
   </node>
-  <way id='101'>
+  <way id='101' version='1'>
+    <nd ref='-1' />
     <nd ref='1' />
-    <nd ref='2' />
-    <tag k='highway' v='footway'>
+    <tag k='highway' v='footway' />
     <tag k='level' v='1' />
     <tag k='name' v='w1' />
   </way>
-  <way id='102'>
-    <nd ref='1' />
-    <nd ref='3' />
-    <tag k='highway' v='footway'>
+  <way id='102' version='1'>
+    <nd ref='-1' />
+    <nd ref='2' />
+    <tag k='highway' v='footway' />
     <tag k='level' v='2' />
     <tag k='name' v='w2' />
   </way>
-  <way id='103'>
-    <nd ref='1' />
-    <nd ref='4' />
-    <tag k='highway' v='footway'>
+  <way id='103' version='1'>
+    <nd ref='-1' />
+    <nd ref='3' />
+    <tag k='highway' v='footway' />
     <tag k='level' v='3' />
-    <tag k='name' v='w3' />
+    <tag k='name' v='w3-1' />
   </way>
-  <way id='104'>
-    <nd ref='1' />
-    <nd ref='5' />
-    <tag k='highway' v='footway'>
+  <way id='104' version='1'>
+    <nd ref='-1' />
+    <nd ref='4' />
+    <tag k='highway' v='footway' />
     <tag k='level' v='3' />
     <tag k='name' v='w3-2' />
   </way>

package/index.js

@@ -1,19 +1,7 @@
-import OsmElement from './src/model/OsmElement.js';
-import OsmModel from './src/model/OsmModel.js';
-import OsmNetwork from './src/network/OsmNetwork.js';
-import OsmNode from './src/model/OsmNode.js';
-import OsmParser from './src/model/OsmParser.js';
-import OsmRouter from './src/network/OsmRouter.js';
-import OsmWay from './src/model/OsmWay.js';
-import OsrmUtils from './src/osrm/OsrmUtils.js';
-
-export {
-    OsmElement,
-    OsmModel,
-    OsmNetwork,
-    OsmNode,
-    OsmParser,
-    OsmRouter,
-    OsmWay,
-    OsrmUtils
-};
+export { default as OsmElement } from './src/model/OsmElement.js';
+export { default as OsmModel } from './src/model/OsmModel.js';
+export { default as OsmNetworkUtils } from './src/network/OsmNetworkUtils.js';
+export { default as OsmNode } from './src/model/OsmNode.js';
+export { default as OsmParser } from './src/model/OsmParser.js';
+export { default as OsmWay } from './src/model/OsmWay.js';
+export * as OsrmUtils from './src/osrm/OsrmUtils.js';

package/package.json

@@ -11,7 +11,7 @@
         "directory": "packages/osm"
     },
     "name": "@wemap/osm",
-    "version": "3.2.17",
+    "version": "4.0.0",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -25,11 +25,10 @@
     ],
     "license": "ISC",
     "dependencies": {
-        "@wemap/geo": "^3.2.17",
-        "@wemap/graph": "^3.2.17",
-        "@wemap/logger": "^3.2.17",
-        "@wemap/maths": "^3.2.17",
+        "@wemap/geo": "^4.0.0",
+        "@wemap/logger": "^4.0.0",
+        "@wemap/maths": "^4.0.0",
         "sax": "^1.2.4"
     },
-    "gitHead": "8b5e0144472bfaa8e07ac24cb227294c83a7541a"
+    "gitHead": "8b72858590fc2ff33fbea4f090de8cd353a7445f"
 }

package/src/model/OsmModel.js

@@ -50,6 +50,7 @@ class OsmModel {
     getWayByName(name) {
         return this.ways.find(way => way.tags.name === name) || null;
     }
+
 }
 
 export default OsmModel;

package/src/model/OsmWay.js

@@ -8,15 +8,17 @@ class OsmWay extends OsmElement {
     /** @type {OsmNode[]} */
     nodes = [];
 
-    /** @type {Level} */
+    /** @type {?Level} */
     level = null;
 
     /**
      * @param {number} id
      * @param {object} tags
+     * @param {?Level} level
      */
-    constructor(id, tags) {
+    constructor(id, tags, level) {
         super(id, tags);
+        this.level = level || null;
     }
 
     /**

package/src/network/OsmNetworkUtils.js

@@ -0,0 +1,159 @@
+import { Level, Edge, Node, Network } from '@wemap/geo';
+
+import OsmModel from '../model/OsmModel.js';
+import OsmNode from '../model/OsmNode.js';
+
+
+class OsmNetworkUtils {
+
+    static HIGHWAYS_PEDESTRIANS = ['footway', 'steps', 'pedestrian', 'living_street', 'path', 'track', 'sidewalk'];
+    static DEFAULT_WAY_SELECTOR = way => this.HIGHWAYS_PEDESTRIANS.includes(way.tags.highway) || way.tags.footway === 'sidewalk';
+
+    /**
+     * @param {OsmModel} osmModel
+     * @param {function} _waySelectionFilter
+     * @returns {Network}
+     */
+    static createNetworkFromOsmModel(osmModel, waySelectionFilter = this.DEFAULT_WAY_SELECTOR) {
+
+        const networkModel = new Network();
+
+        const nodesCreated = {};
+        const elevatorNodes = [];
+
+        /**
+     * @param {OsmNode} osmNode
+     */
+        const getOrCreateNode = osmNode => {
+            let node = nodesCreated[osmNode.id];
+            if (!node) {
+                node = new Node(osmNode.coords);
+                this._applyNodePropertiesFromTags(node, osmNode.tags);
+                nodesCreated[osmNode.id] = node;
+                networkModel.nodes.push(node);
+
+                if (osmNode.tags.highway === 'elevator') {
+                    elevatorNodes.push(node);
+                }
+            }
+            return node;
+        };
+
+        osmModel.ways.forEach(way => {
+            if (!waySelectionFilter(way)) {
+                return;
+            }
+
+            let firstNode = getOrCreateNode(way.nodes[0]);
+            for (let i = 1; i < way.nodes.length; i++) {
+                const secondNode = getOrCreateNode(way.nodes[i]);
+
+                const edge = new Edge(firstNode, secondNode);
+                edge.level = way.level;
+                this._applyEdgePropertiesFromTags(edge, way.tags);
+                networkModel.edges.push(edge);
+
+                firstNode = secondNode;
+            }
+
+        });
+
+        elevatorNodes.forEach(node => {
+            // We have to clone this node for each connected edge
+            this._createNodesAndEdgesFromElevator(networkModel, node);
+        });
+
+        Node.generateNodesLevels(networkModel.nodes);
+
+        return networkModel;
+    }
+
+
+    /**
+     * @param {node} node
+     * @param {object} tags
+     */
+    static _applyNodePropertiesFromTags(node, tags) {
+        node.name = tags.name || null;
+    }
+
+    /**
+     * @param {Edge} edge
+     * @param {object} tags
+     */
+    static _applyEdgePropertiesFromTags(edge, tags) {
+        const { highway, oneway, conveying, name } = tags;
+        edge.name = name || null;
+        edge.isStairs = highway === 'steps';
+        edge.isConveying = 'conveying' in tags;
+        edge.isOneway = Boolean((oneway === 'yes' || oneway === 'true' || oneway === '1')
+            || (conveying && highway && ['yes', 'forward', 'backward'].includes(conveying)));
+
+        if (conveying === 'backward') {
+            const tmpNode = edge.node1;
+            edge.node1 = edge.node2;
+            edge.node2 = tmpNode;
+        }
+
+    }
+
+    /**
+     * @param {Network} networkModel
+     * @param {Node} node
+     */
+    static _createNodesAndEdgesFromElevator(networkModel, node) {
+
+        /** @type {Node[]} */
+        const createdNodes = [];
+        const getOrCreateLevelNode = level => {
+            let levelNode = createdNodes.find(({ coords }) => Level.equalsTo(level, coords.level));
+            if (!levelNode) {
+                levelNode = node.clone();
+                levelNode.applyProperties(node.extractProperties());
+                levelNode.coords.level = level;
+                createdNodes.push(levelNode);
+                networkModel.nodes.push(levelNode);
+            }
+            return levelNode;
+        };
+
+        // Create nodes from node.edges
+        node.edges.forEach(edge => {
+            if (edge.level.isRange) {
+                throw new Error('Cannot handle this elevator edge due to ambiguity');
+            }
+
+            const levelNode = getOrCreateLevelNode(edge.level);
+            if (edge.node1 === node) {
+                edge.node1 = levelNode;
+            } else {
+                edge.node2 = levelNode;
+            }
+            levelNode.edges.push(edge);
+        });
+
+        // Create edges from createdNodes
+        for (let i = 0; i < createdNodes.length; i++) {
+            for (let j = i + 1; j < createdNodes.length; j++) {
+
+                const createdNode1 = createdNodes[i];
+                const createdNode2 = createdNodes[j];
+
+                const newEdge = new Edge(
+                    createdNode1,
+                    createdNode2,
+                    new Level(createdNode1.coords.level.val, createdNode2.coords.level.val)
+                );
+                newEdge.name = node.name;
+                newEdge.isElevator = true;
+                networkModel.edges.push(newEdge);
+            }
+        }
+
+        // Remove the historical elevator node from the network
+        networkModel.nodes = networkModel.nodes.filter(_node => _node !== node);
+    }
+
+}
+
+export default OsmNetworkUtils;

package/src/network/OsmNetworkUtils.spec.js

@@ -0,0 +1,130 @@
+/* eslint-disable max-statements */
+import chai from 'chai';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import { Network } from '@wemap/geo';
+import { verifyCoherence } from '@wemap/geo/tests/CommonTest.js';
+
+import OsmParser from '../model/OsmParser.js';
+import OsmModel from '../model/OsmModel.js';
+import OsmNetworkUtils from './OsmNetworkUtils.js';
+
+const { expect } = chai;
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+
+const loadFile = fileName => {
+    const filePath = path.resolve(__dirname, '../../assets/' + fileName);
+    return fs.readFileSync(filePath, 'utf8');
+};
+
+describe('OsmNetwork - simple', () => {
+
+    /** @type {OsmModel} */
+    let osmModel;
+
+    /** @type {Network} */
+    let network;
+    const osmXmlString = loadFile('network-simple.osm');
+
+    it('Network creation', () => {
+
+        osmModel = OsmParser.parseOsmXmlString(osmXmlString);
+        network = OsmNetworkUtils.createNetworkFromOsmModel(osmModel);
+
+        verifyCoherence(network);
+        expect(network.nodes.length).equals(3);
+        expect(network.edges.length).equals(2);
+    });
+
+
+    it('Network creation - waySelectionFilter', () => {
+
+        const selectionNetwork = OsmNetworkUtils.createNetworkFromOsmModel(osmModel, () => true);
+
+        verifyCoherence(selectionNetwork);
+        expect(selectionNetwork.nodes.length).equals(4);
+        expect(selectionNetwork.edges.length).equals(3);
+    });
+
+    it('Network creation - elevator', () => {
+
+        const elevatorModel = OsmParser.parseOsmXmlString(loadFile('network-elevator.osm'));
+        const elevatorNetwork = OsmNetworkUtils.createNetworkFromOsmModel(elevatorModel);
+
+        verifyCoherence(elevatorNetwork);
+        expect(elevatorNetwork.nodes.length).equals(7);
+        expect(elevatorNetwork.edges.length).equals(7);
+
+
+        const osmModel2 = OsmParser.parseOsmXmlString(`
+        <osm>
+            <node id='1' lat='43' lon='4'>
+                <tag k='highway' v='elevator' />
+                <tag k='level' v='0;1' />
+            </node>
+            <node id='2' lat='43' lon='3' />
+            <way id='3'>
+                <nd ref='1' />
+                <nd ref='2' />
+                <tag k='highway' v='footway' />
+                <tag k='level' v='0;1' />
+            </way>
+        </osm>
+        `);
+        expect(() => OsmNetworkUtils.fromOsmModel(osmModel2)).throw(Error);
+    });
+
+    it('getNodeByName', () => {
+        let node = network.getNodeByName('p1');
+        expect(node).not.undefined;
+        expect(node.name).equal('p1');
+
+        node = network.getNodeByName('p5');
+        expect(node).undefined;
+    });
+
+    it('toCompressedJson / fromCompressedJson', () => {
+
+        // const elevatorModel = OsmParser.parseOsmXmlString(loadFile('network-elevator.osm'));
+        // const elevatorNetwork = OsmNetworkUtils.fromOsmModel(elevatorModel);
+
+        // const json = elevatorNetwork.toCompressedJson();
+        // expect(() => JSON.stringify(json)).not.throw(Error);
+
+        // const elevatorNetworkBis = Network.fromCompressedJson(json);
+
+        // verifyCoherence(elevatorNetwork);
+        // expect(elevatorNetwork.edges.length).equal(elevatorNetworkBis.edges.length);
+        // expect(elevatorNetwork.nodes.length).equal(elevatorNetworkBis.nodes.length);
+        // elevatorNetwork.edges.forEach((edge, idx) => {
+        //     expect(edge.properties.id).equal(elevatorNetworkBis.edges[idx].properties.id);
+        //     expect(edge.properties.tags).deep.equal(elevatorNetworkBis.edges[idx].properties.tags);
+        // });
+
+    });
+});
+
+
+describe('OsmNetwork - with stairs', () => {
+
+    /** @type {OsmModel} */
+    let osmModel;
+
+    /** @type {Network} */
+    let network;
+    const osmXmlString = loadFile('bureaux-wemap-montpellier-network.osm');
+
+    it('Network creation', () => {
+
+        osmModel = OsmParser.parseOsmXmlString(osmXmlString);
+        network = OsmNetworkUtils.createNetworkFromOsmModel(osmModel);
+
+        verifyCoherence(network);
+
+        expect(network.getEdgeByName('w6').isStairs).true;
+    });
+
+});

package/src/network/OsmRouter.spec.js

@@ -5,13 +5,12 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 
 import {
-    Level, Coordinates
+    Level, Coordinates, Node, Network, GraphRouter, Itinerary
 } from '@wemap/geo';
-import { Node } from '@wemap/graph';
+import { verifyCoherence } from '@wemap/geo/tests/CommonTest.js';
 
 import OsmParser from '../model/OsmParser.js';
-import OsmRouter from './OsmRouter.js';
-import OsmNetwork from './OsmNetwork.js';
+import OsmNetworkUtils from './OsmNetworkUtils.js';
 
 const { expect } = chai;
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -20,20 +19,24 @@ const itineraryStart = new Coordinates(43.6092754, 3.8842306, null, new Level(2)
 const itineraryEnd = new Coordinates(43.6092602, 3.8842669, null, new Level(1));
 
 
+/**
+ * @param {string} fileName
+ * @returns {Network}
+ */
 const loadNetwork = fileName => {
     const filePath = path.resolve(__dirname, '../../assets/' + fileName);
     const osmXmlString = fs.readFileSync(filePath, 'utf8');
     const osmModel = OsmParser.parseOsmXmlString(osmXmlString);
-    return OsmNetwork.fromOsmModel(osmModel);
+    return OsmNetworkUtils.createNetworkFromOsmModel(osmModel);
 };
 
 const verifyNodesOrder = (nodes, names) => {
     expect(nodes.length).equals(names.length);
     for (let i = 0; i < names.length; i++) {
-        if (!nodes[i].data || !nodes[i].data.tags || !nodes[i].data.tags.name) {
+        if (!nodes[i].name) {
             expect(names[i]).is.null;
         } else {
-            expect(names[i]).equals(nodes[i].data.tags.name);
+            expect(names[i]).equals(nodes[i].name);
         }
     }
 };
@@ -44,7 +47,7 @@ const generateNodeNames = (start, end) =>
 describe('OsmRouter - Multi-level itinerary', () => {
 
     const networkModel = loadNetwork('bureaux-wemap-montpellier-network.osm');
-    const router = new OsmRouter(networkModel);
+    const router = new GraphRouter(networkModel);
 
     const itinerary = router.getShortestPath(itineraryStart, itineraryEnd);
 
@@ -58,7 +61,7 @@ describe('OsmRouter - Multi-level itinerary', () => {
 
     it('Router return shortest path', () => {
         expect(itinerary.nodes.length).equal(11);
-        verifyNodesOrder(itinerary.nodes, [null, ...generateNodeNames(7, 16)]);
+        verifyNodesOrder(itinerary.nodes, ['w2', ...generateNodeNames(7, 16)]);
     });
 
     it('Verify steps', () => {
@@ -66,7 +69,7 @@ describe('OsmRouter - Multi-level itinerary', () => {
         const steps = itinerary.steps;
         expect(steps.length).equal(8);
 
-        verifyNodesOrder(steps[0].nodes, [null, 'p7', 'p8']);
+        verifyNodesOrder(steps[0].nodes, ['w2', 'p7', 'p8']);
         verifyNodesOrder(steps[1].nodes, ['p8', 'p9']);
         verifyNodesOrder(steps[2].nodes, ['p9', 'p10']);
         verifyNodesOrder(steps[3].nodes, ['p10', 'p11']);
@@ -84,16 +87,24 @@ describe('OsmRouter - Multi-level itinerary', () => {
         const itinerary2 = router.getShortestPath(start, end);
 
         expect(itinerary2.nodes.length).equal(3);
-        expect(itinerary2.nodes[1].data.tags.name).equal('p6');
-        expect(itinerary2.nodes[2].data.tags.name).equal('p5');
+        expect(itinerary2.nodes[1].name).equal('p6');
+        expect(itinerary2.nodes[2].name).equal('p5');
     });
 
     it('do not use stairs', () => {
         const itineraryWithoutStairs = router.getShortestPath(itineraryStart, itineraryEnd, { useStairs: false });
         expect(itineraryWithoutStairs.nodes.length).equal(11);
-        expect(itineraryWithoutStairs.nodes[6].data.isElevator).is.true;
-        expect(itineraryWithoutStairs.nodes[7].data.isElevator).is.true;
-        expect(itineraryWithoutStairs.edges[6].data.isElevator).is.true;
+        expect(itineraryWithoutStairs.edges.some(edge => edge.isStairs)).false;
+    });
+
+    it('toCompressedJson / fromCompressedJson', () => {
+        const json = itinerary.toCompressedJson();
+        expect(() => JSON.stringify(json)).not.throw(Error);
+
+        const itineraryBis = Itinerary.fromCompressedJson(json);
+        verifyCoherence(itineraryBis);
+        expect(itineraryBis.nodes.length).equal(11);
+        verifyNodesOrder(itineraryBis.nodes, ['w2', ...generateNodeNames(7, 16)]);
     });
 
 });
@@ -101,7 +112,7 @@ describe('OsmRouter - Multi-level itinerary', () => {
 describe('OsmRouter - One Way itinerary', () => {
 
     const networkModel = loadNetwork('one-way.osm');
-    const router = new OsmRouter(networkModel);
+    const router = new GraphRouter(networkModel);
 
     it('do not use oneway', () => {
 
@@ -122,7 +133,7 @@ describe('OsmRouter - One Way itinerary', () => {
 describe('OsmRouter - Conveying', () => {
 
     const networkModel = loadNetwork('gare-de-lyon-extract.osm');
-    const router = new OsmRouter(networkModel);
+    const router = new GraphRouter(networkModel);
 
     it('do not use oneway conveying', () => {
 
@@ -143,7 +154,7 @@ describe('OsmRouter - Conveying', () => {
 describe('OsmRouter - Conveying - backward', () => {
 
     const networkModel = loadNetwork('network-conveying-backward.osm');
-    const router = new OsmRouter(networkModel);
+    const router = new GraphRouter(networkModel);
 
     it('do not use oneway conveying', () => {