@wemap/osm 3.2.15 → 3.2.17

package/index.js

@@ -1,13 +1,19 @@
+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
 };

package/package.json

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

package/src/model/OsmElement.js

@@ -1,11 +1,18 @@
 class OsmElement {
 
-    id = null;
+    /** @type {number|null} */
+    id;
+
+    /** @type {object} */
     tags;
 
-    constructor(id, tags = {}) {
+    /**
+     * @param {number} id
+     * @param {object} tags
+     */
+    constructor(id, tags) {
         this.id = id;
-        this.tags = tags;
+        this.tags = tags || {};
     }
 }
 

package/src/model/OsmModel.js

@@ -1,23 +1,52 @@
+import OsmNode from './OsmNode.js';
+import OsmWay from './OsmWay.js';
+
 class OsmModel {
 
+    /** @type {OsmNode[]} */
+    nodes;
+
+    /** @type {OsmWay[]} */
+    ways;
+
+    /**
+     * @param {OsmNode[]|undefined} nodes
+     * @param {OsmWay[]|undefined} ways
+     */
     constructor(nodes, ways) {
         this.nodes = nodes || [];
         this.ways = ways || [];
     }
 
+    /**
+     * @param {number} id
+     * @returns {OsmNode|null}
+     */
     getNodeById(id) {
         return this.nodes.find(node => node.id === id) || null;
     }
 
+    /**
+     * @param {string} name
+     * @returns {OsmNode|null}
+     */
     getNodeByName(name) {
         return this.nodes.find(node => node.tags.name === name) || null;
     }
 
 
+    /**
+     * @param {number} id
+     * @returns {OsmWay|null}
+     */
     getWayById(id) {
         return this.ways.find(way => way.id === id) || null;
     }
 
+    /**
+     * @param {string} name
+     * @returns {OsmWay|null}
+     */
     getWayByName(name) {
         return this.ways.find(way => way.tags.name === name) || null;
     }

package/src/model/OsmNode.js

@@ -1,19 +1,36 @@
+import { Coordinates } from '@wemap/geo';
+
 import OsmElement from './OsmElement.js';
+import OsmWay from './OsmWay.js';
 
 class OsmNode extends OsmElement {
 
+    /** @type {Coordinates} */
     coords = null;
+
+    /** @type {OsmWay[]} */
     ways = [];
 
+    /**
+     * @param {number} id
+     * @param {Coordinates} coords
+     * @param {object} tags
+     */
     constructor(id, coords, tags) {
         super(id, tags);
         this.coords = coords;
     }
 
+    /**
+     * @returns {boolean}
+     */
     get isElevator() {
         return this.tags.highway === 'elevator';
     }
 
+    /**
+     * @returns {boolean}
+     */
     get isConveying() {
         return this.isElevator;
     }

package/src/model/OsmParser.js

@@ -11,6 +11,10 @@ import OsmWay from './OsmWay.js';
 
 class OsmParser {
 
+    /**
+     * @param {string} osmXmlString
+     * @returns {OsmModel}
+     */
     static parseOsmXmlString(osmXmlString) {
 
         const model = new OsmModel();
@@ -28,7 +32,7 @@ class OsmParser {
                     buffer = null;
                     break;
                 }
-                const osmNode = this.parseNode(node.attributes);
+                const osmNode = this._parseNode(node.attributes);
                 buffer = osmNode;
                 model.nodes.push(osmNode);
                 break;
@@ -38,7 +42,7 @@ class OsmParser {
                     buffer = null;
                     break;
                 }
-                const osmWay = this.parseWay(node.attributes);
+                const osmWay = this._parseWay(node.attributes);
                 buffer = osmWay;
                 model.ways.push(osmWay);
                 break;
@@ -83,13 +87,13 @@ class OsmParser {
     }
 
 
-    static parseNode(attr) {
+    static _parseNode(attr) {
         return new OsmNode(
             Number(attr.id),
             new Coordinates(Number(attr.lat), Number(attr.lon)));
     }
 
-    static parseWay(attr) {
+    static _parseWay(attr) {
         return new OsmWay(Number(attr.id));
     }
 }

package/src/model/OsmWay.js

@@ -1,29 +1,59 @@
+import { Level } from '@wemap/geo';
+
 import OsmElement from './OsmElement.js';
+import OsmNode from './OsmNode.js';
 
 class OsmWay extends OsmElement {
 
+    /** @type {OsmNode[]} */
     nodes = [];
+
+    /** @type {Level} */
     level = null;
 
+    /**
+     * @param {number} id
+     * @param {object} tags
+     */
     constructor(id, tags) {
         super(id, tags);
     }
 
+    /**
+     * @returns {boolean}
+     */
     get areStairs() {
         return this.tags.highway === 'steps';
     }
 
+    /**
+     * @returns {boolean}
+     */
     get isConveying() {
         return this.tags.hasOwnProperty('conveying');
     }
 
+    /**
+     * @returns {boolean}
+     */
     get isEscalator() {
         return this.areStairs && this.isConveying;
     }
 
+    /**
+     * @returns {boolean}
+     */
     get isMovingWalkway() {
         return !this.areStairs && this.isConveying;
     }
+
+    /**
+     * @returns {boolean}
+     */
+    get isArea() {
+        // That is not the real definition for OSM
+        return this.nodes[0] === this.nodes[this.nodes.length - 1];
+    }
 }
 
 export default OsmWay;

package/src/network/OsmNetwork.js

@@ -3,6 +3,8 @@ import {
     Edge, Node, Network
 } from '@wemap/graph';
 
+import OsmModel from '../model/OsmModel.js';
+
 const HIGHWAYS_PEDESTRIANS = ['footway', 'steps', 'pedestrian', 'living_street', 'path', 'track', 'sidewalk'];
 const DEFAULT_WAY_SELECTOR = way => HIGHWAYS_PEDESTRIANS.includes(way.tags.highway) || way.tags.footway === 'sidewalk';
 
@@ -11,6 +13,11 @@ const DEFAULT_WAY_SELECTOR = way => HIGHWAYS_PEDESTRIANS.includes(way.tags.highw
  */
 class OsmNetwork extends Network {
 
+    /**
+     * @param {OsmModel} osmModel
+     * @param {function} _waySelectionFilter
+     * @returns {OsmNetwork}
+     */
     static fromOsmModel(osmModel, _waySelectionFilter) {
 
         const waySelectionFilter = _waySelectionFilter || DEFAULT_WAY_SELECTOR;
@@ -48,7 +55,7 @@ class OsmNetwork extends Network {
         networkModel.nodes.forEach(node => {
             if (node.data.tags.highway === 'elevator') {
                 // We have to clone this node for each connected edge
-                OsmNetwork.createNodesAndEdgesFromElevator(networkModel, node);
+                OsmNetwork._createNodesAndEdgesFromElevator(networkModel, node);
             }
         });
 
@@ -57,7 +64,7 @@ class OsmNetwork extends Network {
         return networkModel;
     }
 
-    static createNodesAndEdgesFromElevator(networkModel, node) {
+    static _createNodesAndEdgesFromElevator(networkModel, node) {
 
         const createdNodes = [];
         const isLevelAlreadyCreated = level => createdNodes.some(
@@ -110,18 +117,33 @@ class OsmNetwork extends Network {
         );
     }
 
+    /**
+     * @param {number} id
+     * @returns {Node}
+     */
     getNodeById(id) {
         return this.nodes.find(node => node.data.id === id);
     }
 
+    /**
+     * @param {name} name
+     * @returns {Node}
+     */
     getNodeByName(name) {
         return this.nodes.find(node => node.data.tags.name === name);
     }
 
+    /**
+     * @param {number} id
+     * @returns {Edge[]}
+     */
     getEdgesById(id) {
         return this.edges.filter(edge => edge.data.id === id);
     }
 
+    /**
+     * @returns {string}
+     */
     toDetailedString() {
         return super.toDetailedString(
             node => node.data.tags.name,

package/src/network/OsmRouter.js

@@ -1,11 +1,17 @@
+import { Coordinates } from '@wemap/geo';
 import {
-    GraphRouter, Utils
+    Edge, GraphRouter, Node, Utils
 } from '@wemap/graph';
 
 const DEFAULT_OPTIONS = { useStairs: true };
 
 class OsmRouter extends GraphRouter {
 
+    /**
+     * @param {Node|Coordinates} start
+     * @param {Node|Coordinates} end
+     * @param {object} _options
+     */
     getShortestPath(start, end, _options) {
 
         const options = Object.assign({}, DEFAULT_OPTIONS, _options);
@@ -18,8 +24,11 @@ class OsmRouter extends GraphRouter {
         );
     }
 
+    /**
+     * @param {Edge} edge
+     * @returns {boolean}
+     */
     static edgeSelectionFilter = edge => {
-
         return !edge.data || !edge.data.tags
             || (
                 edge.data.tags.stairs !== 'yes'
@@ -27,6 +36,10 @@ class OsmRouter extends GraphRouter {
             );
     }
 
+    /**
+     * @param {Edge} edge
+     * @returns {boolean}
+     */
     static edgeWeightFn = edge => {
         if (edge.data.tags.highway === 'elevator') {
             return 30;
@@ -34,6 +47,11 @@ class OsmRouter extends GraphRouter {
         return Utils.getDurationFromLength(edge.length);
     };
 
+    /**
+     * @param {Edge} edge
+     * @param {boolean} reversed
+     * @returns {boolean}
+     */
     static acceptOneWayFn = (edge, reversed) => {
         const {
             oneway, highway, conveying

package/src/osrm/OsrmUtils.js

@@ -15,6 +15,10 @@ import OsmWay from '../model/OsmWay.js';
 
 class OsrmUtils {
 
+    /**
+     * @param {Itinerary} itinerary
+     * @returns {object}
+     */
     static itineraryToOsrmJson(itinerary) {
 
         const itinerarySteps = itinerary.steps;
@@ -114,7 +118,7 @@ class OsrmUtils {
 
     /**
      * Generate Itinerary from OSRM JSON, start and end.
-     * @param {Object} json JSON file provided by OSRM.
+     * @param {object} json JSON file provided by OSRM.
      * @param {Coordinates} start itinerary start
      * @param {Coordinates} end itinerary end
      */
@@ -148,13 +152,13 @@ class OsrmUtils {
 
         if (legs && legs[0]) {
             const { steps } = legs[0];
-            OsrmUtils.parseSteps(itinerary, steps);
+            OsrmUtils._parseSteps(itinerary, steps);
         }
 
         return itinerary;
     }
 
-    static parseSteps(itinerary, jsonSteps) {
+    static _parseSteps(itinerary, jsonSteps) {
 
         itinerary._steps = [];
         itinerary._nextStepsIndexes = [];