@wemap/osm 11.0.0-alpha.0 → 11.0.0-alpha.12

package/index.ts

@@ -3,4 +3,13 @@ export { default as OsmModel } from './src/OsmModel.js';
 export { default as OsmNode } from './src/OsmNode.js';
 export { default as OsmParser } from './src/OsmParser.js';
 export { default as OsmWay } from './src/OsmWay.js';
-export * as OsmNetworkUtils from './src/OsmNetworkUtils.js';
+
+export { default as OsmGraphNode } from './src/graph/OsmGraphNode.js';
+export { default as OsmGraphEdge } from './src/graph/OsmGraphEdge.js';
+export { default as OsmGraphItinerary } from './src/graph/OsmGraphItinerary.js';
+export { default as OsmNetwork } from './src/graph/OsmNetwork.js';
+export { default as OsmGraphProjection } from './src/graph/OsmGraphProjection.js';
+export { default as OsmGraphRouter } from './src/graph/OsmGraphRouter.js';
+export { default as OsmGraphRouterOptions } from './src/graph/OsmGraphRouterOptions.js';
+export { default as OsmMapMatching } from './src/graph/OsmMapMatching.js';
+export * as OsmNetworkUtils from './src/graph/OsmNetworkUtils.js';

package/package.json

@@ -4,7 +4,7 @@
         "Thibaud Michel <thibaud@getwemap.com>"
     ],
     "description": "Wemap OSM utils package",
-    "module": "dist/index.js",
+    "main": "dist/index.js",
     "types": "index.ts",
     "repository": {
         "type": "git",
@@ -12,7 +12,7 @@
         "directory": "packages/osm"
     },
     "name": "@wemap/osm",
-    "version": "11.0.0-alpha.0",
+    "version": "11.0.0-alpha.12",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -29,9 +29,15 @@
     ],
     "license": "ISC",
     "dependencies": {
-        "@wemap/geo": "^11.0.0-alpha.0",
-        "@wemap/logger": "^11.0.0-alpha.0",
+        "@wemap/geo": "^11.0.0-alpha.12",
+        "@wemap/logger": "^11.0.0-alpha.4",
         "saxes": "^5.0.1"
     },
-    "gitHead": "516aaa5323ac9c469cbc75b484b8cae14d1d8d12"
+    "exports": {
+        ".": {
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        }
+    },
+    "gitHead": "42a1aece349e6db3151938ebc9b3d85daf9bb90d"
 }

package/src/OsmWay.ts

@@ -28,6 +28,10 @@ class OsmWay extends OsmElement {
         return !this.areStairs && this.isConveying;
     }
 
+    get isElevator() {
+        return this.tags.highway === 'elevator';
+    }
+
     get isArea() {
         // That is not the real definition for OSM
         return this.nodes[0] === this.nodes[this.nodes.length - 1];

package/src/graph/OsmGraphEdge.ts

@@ -0,0 +1,5 @@
+import { GraphEdge } from "@wemap/geo";
+import OsmNode from "../OsmNode";
+import OsmWay from "../OsmWay";
+
+export default class OsmGraphNode extends GraphEdge<OsmNode | OsmWay, OsmNode>{ }

package/src/graph/OsmGraphItinerary.ts

@@ -0,0 +1,13 @@
+import { Coordinates, GraphItinerary, GraphNode } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmGraphItinerary extends GraphItinerary<N, E>{ 
+
+    static fromNetworkNodes<A = N, B = E>(
+        start: Coordinates, end: Coordinates,
+        networkNodes: GraphNode<A, B>[], edgesWeights: number[]
+    ) {
+        return super.fromNetworkNodes(start, end, networkNodes, edgesWeights) as GraphItinerary<A, B>;
+    }
+}

package/src/graph/OsmGraphNode.ts

@@ -0,0 +1,5 @@
+import { GraphNode } from "@wemap/geo";
+import OsmNode from "../OsmNode";
+import OsmWay from "../OsmWay";
+
+export default class OsmGraphNode extends GraphNode<OsmNode, OsmNode | OsmWay>{ }

package/src/graph/OsmGraphProjection.ts

@@ -0,0 +1,5 @@
+import { GraphProjection } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmGraphProjection extends GraphProjection<N, E>{ }

package/src/graph/OsmGraphRouter.ts

@@ -0,0 +1,5 @@
+import { GraphRouter } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmGraphRouter extends GraphRouter<N, E>{ }

package/src/graph/OsmGraphRouterOptions.ts

@@ -0,0 +1,5 @@
+import { GraphRouterOptions } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmGraphRouterOptions extends GraphRouterOptions<N, E>{ }

package/src/graph/OsmMapMatching.ts

@@ -0,0 +1,5 @@
+import { MapMatching } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmMapMatching extends MapMatching<N, E>{ }

package/src/graph/OsmNetwork.ts

@@ -0,0 +1,9 @@
+import { Coordinates, Network } from '@wemap/geo';
+
+import { N, E } from './OsmNetworkUtils.js';
+
+export default class OsmNetwork extends Network<N, E>{
+    static fromCoordinates<A = N, B = E>(segments: Coordinates[][]) {
+        return super.fromCoordinates<N, E>(segments) as Network<A, B>;
+    }
+}

package/src/{OsmNetworkUtils.spec.ts → graph/OsmNetworkUtils.spec.ts}

@@ -1,25 +1,20 @@
-/* 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 as verifyCoherenceImport } from '@wemap/geo/tests/CommonTest.js';
+import { verifyCoherence } from '../../../geo/tests/CommonTest.js';
 
-import OsmModel from './OsmModel.js';
-import OsmParser from './OsmParser.js';
+import OsmModel from '../OsmModel.js';
+import OsmParser from '../OsmParser.js';
+import OsmNetwork from './OsmNetwork.js';
 import { createNetworkFromOsmModel, getNodeByName, getEdgeByName } from './OsmNetworkUtils.js';
-import OsmElement from './OsmElement.js';
 
 const { expect } = chai;
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-// TODO: No idea on how to avoid this problem
-const verifyCoherence = verifyCoherenceImport as any as (<T>(network: Network<T>) => void);
-
 const loadFile = (fileName: string) => {
-    const filePath = path.resolve(__dirname, '../assets/' + fileName);
+    const filePath = path.resolve(__dirname, '../../assets/' + fileName);
     return fs.readFileSync(filePath, 'utf8');
 };
 
@@ -27,7 +22,7 @@ describe('OsmNetwork - simple', () => {
 
     let osmModel: OsmModel;
 
-    let network: Network<OsmElement>;
+    let network: OsmNetwork;
     const osmXmlString = loadFile('network-simple.osm');
 
     it('Network creation', () => {

package/src/{OsmNetworkUtils.ts → graph/OsmNetworkUtils.ts}

@@ -1,11 +1,15 @@
-import { Level, GraphEdge, GraphNode, Network } from '@wemap/geo';
-import OsmElement from './OsmElement';
-import OsmModel from './OsmModel';
-import OsmNode from './OsmNode';
-import OsmWay from './OsmWay';
+import { Level } from '@wemap/geo';
+import OsmGraphNode from './OsmGraphNode';
+import OsmGraphEdge from './OsmGraphEdge';
+import OsmModel from '../OsmModel';
+import OsmNode from '../OsmNode';
+import OsmWay from '../OsmWay';
+import OsmNetwork from './OsmNetwork';
 
+export type N = OsmNode;
+export type E = OsmNode | OsmWay;
 
-export const HIGHWAYS_PEDESTRIANS = ['footway', 'steps', 'pedestrian', 'living_street', 'path', 'track', 'sidewalk'];
+export const HIGHWAYS_PEDESTRIANS = ['footway', 'steps', 'pedestrian', 'living_street', 'path', 'track', 'sidewalk', 'elevator'];
 
 export const DEFAULT_WAY_SELECTOR = (way: OsmWay) => {
     return HIGHWAYS_PEDESTRIANS.includes(way.tags.highway)
@@ -14,15 +18,15 @@ export const DEFAULT_WAY_SELECTOR = (way: OsmWay) => {
         || way.tags.railway === 'platform';
 };
 
-export function getNodeByName(network: Network<OsmElement>, name: string) {
+export function getNodeByName(network: OsmNetwork, name: string) {
     return network.nodes.find(({ builtFrom }) => builtFrom?.tags.name === name);
 }
 
-export function getEdgeByName(network: Network<OsmElement>, name: string) {
+export function getEdgeByName(network: OsmNetwork, name: string) {
     return network.edges.find(({ builtFrom }) => builtFrom?.tags.name === name);
 }
 
-function manageOneWay(edge: GraphEdge<OsmElement>, way: OsmWay) {
+function manageOneWay(edge: OsmGraphEdge, way: OsmWay) {
 
     const { highway, oneway, conveying } = way.tags;
 
@@ -38,16 +42,16 @@ function manageOneWay(edge: GraphEdge<OsmElement>, way: OsmWay) {
 
 
 function createNodesAndEdgesFromElevator(
-    nodes: GraphNode<OsmElement>[],
-    edges: GraphEdge<OsmElement>[],
-    elevatorNode: GraphNode<OsmElement>
+    nodes: OsmGraphNode[],
+    edges: OsmGraphEdge[],
+    elevatorNode: OsmGraphNode
 ) {
 
-    const createdNodes: GraphNode<OsmElement>[] = [];
-    const getOrCreateLevelNode = (level: number | null, builtFrom: OsmElement | null) => {
+    const createdNodes: OsmGraphNode[] = [];
+    const getOrCreateLevelNode = (level: number | null, builtFrom: N | null) => {
         let levelNode = createdNodes.find(({ coords }) => Level.equals(level, coords.level));
         if (!levelNode) {
-            levelNode = new GraphNode(elevatorNode.coords.clone(), builtFrom);
+            levelNode = new OsmGraphNode(elevatorNode.coords.clone(), builtFrom);
             levelNode.coords.level = level;
             createdNodes.push(levelNode);
             nodes.push(levelNode);
@@ -85,7 +89,7 @@ function createNodesAndEdgesFromElevator(
             const minLevel = Math.min(createdNode1.coords.level as number, createdNode2.coords.level as number);
             const maxLevel = Math.max(createdNode1.coords.level as number, createdNode2.coords.level as number);
 
-            const newEdge = new GraphEdge(
+            const newEdge = new OsmGraphEdge(
                 createdNode1,
                 createdNode2,
                 [minLevel, maxLevel],
@@ -107,16 +111,16 @@ export function createNetworkFromOsmModel(
     waySelectionFilter = DEFAULT_WAY_SELECTOR
 ) {
 
-    const nodes: GraphNode<OsmElement>[] = [];
-    const edges: GraphEdge<OsmElement>[] = [];
+    const nodes: OsmGraphNode[] = [];
+    const edges: OsmGraphEdge[] = [];
 
-    const nodesCreated: { [key: number]: GraphNode<OsmElement> } = {};
-    const elevatorNodes: GraphNode<OsmElement>[] = [];
+    const nodesCreated: { [key: number]: OsmGraphNode } = {};
+    const elevatorNodes: OsmGraphNode[] = [];
 
     const getOrCreateNode = (osmNode: OsmNode) => {
         let node = nodesCreated[osmNode.id];
         if (!node) {
-            node = new GraphNode(osmNode.coords, osmNode);
+            node = new OsmGraphNode(osmNode.coords, osmNode);
             nodesCreated[osmNode.id] = node;
             nodes.push(node);
 
@@ -136,7 +140,7 @@ export function createNetworkFromOsmModel(
         for (let i = 1; i < way.nodes.length; i++) {
             const secondNode = getOrCreateNode(way.nodes[i]);
 
-            const edge = new GraphEdge<OsmElement>(firstNode, secondNode, way.level, way);
+            const edge = new OsmGraphEdge(firstNode, secondNode, way.level, way);
             manageOneWay(edge, way);
             edges.push(edge);
             firstNode = secondNode;
@@ -149,9 +153,9 @@ export function createNetworkFromOsmModel(
         createNodesAndEdgesFromElevator(nodes, edges, node);
     });
 
-    const networkModel = new Network(nodes, edges);
+    const networkModel = new OsmNetwork(nodes, edges);
 
-    GraphNode.generateNodesLevels(networkModel.nodes);
+    OsmGraphNode.generateNodesLevels(networkModel.nodes);
 
     return networkModel;
 }