osm2geojson-lite 1.0.3 → 1.1.0

package/README.md

@@ -1,18 +1,15 @@
 osm2geojson-lite
 ============
 
+[![NPM Version](https://img.shields.io/npm/v/osm2geojson-lite)](https://www.npmjs.com/package/osm2geojson-lite) [![Codecov](https://img.shields.io/codecov/c/github/tibetty/osm2geojson-lite/master.svg)](https://codecov.io/gh/tibetty/osm2geojson-lite/)
+
+
 A lightweight (not as lightweight as xml2geojson though) yet faster convertor for [OSM](http://openstreetmap.org) [data](http://wiki.openstreetmap.org/wiki/OSM_XML) whatever in XML or JSON formats to [GeoJSON](http://www.geojson.org/) - much faster (the more complex the data source is, the more performance advantages it posesses) than osmtogeojson in most situations - implemented in pure JavaScript without any 3rd party dependency.
 
 History
 -----
 An internal function inside [query-geo-boundary](https://www.npmjs.com/package/query-geo-boundary) → stripped out to handle OSM XML only [xml2geojson-lite](https://www.npmjs.com/package/xml2geojson-lite) → this library that supports both OSM XML and OSM/Overpass JSON
 
-Changelog:
------
-* Late 2018: this repository was created and the initial version was pushed to github - almost around specific usages for myself.
-* 2019-2025: quite a few contributors had fixed quite a few bugs and also contributed some good ideas - thanks for their efforts!
-* 2025-03-03: fixed a few bugs around non-*Polygon features processing and convert it to a pure TypeScript project (codes published to [NPM](https://npmjs.org/) have become TSC compiled from now on).
-
 Usage
 -----
 
@@ -25,7 +22,7 @@ Installation:
 Usage:
 
 ```js
-    const osm2geojson = require('osm2geojson-lite');
+    import osm2geojson from 'osm2geojson-lite';
     let geojson = osm2geojson(osm, opts);
 ```
 
@@ -46,9 +43,9 @@ Converts OSM data (XML/JSON) to GeoJSON.
 
 * `osm`: the OSM XML data in String, or OSM/Overpass JSON as object or in String
 * `opts?`: optional, the options object, right now supports below properties/fields:
-    - `completeFeature/allFeatures`:  the default value is `false`. When it's set to `true`, the returned geojson will include all elements that meet the specified conditions in `FeatureCollection` format; otherwise, only the bare geometry of the first `relation` element will be returned.
-    - `renderTagged`: the default value is `false`. When it's set to `true`, the returned geojson will include all elements with tags (i.e., tagged) until `suppressWay` changes its behavior a bit; otherwise only the unreferenced ones get returned.
-    - `suppressWay/excludeWay`: the default value is `true`. When it's set to `true`, the returned `FeatureCollection` will exclude all referenced `way`s even though they are tagged; otherwise the features of those `way`s will be included in the resulted result as well.
+    - `completeFeature`:  the default value is `false`. When it's set to `true`, the returned geojson will include all elements that meet the specified conditions in `FeatureCollection` format; otherwise, only the bare geometry of the first `relation` element will be returned.
+    - `renderTagged`: the default value is `false`. When it's set to `true`, the returned geojson will include all elements with tags (i.e., tagged) until `excludeWay` changes its behavior a bit; otherwise only the unreferenced ones get returned.
+    - `excludeWay`: the default value is `true`. When it's set to `true`, the returned `FeatureCollection` will exclude all referenced `way`s even though they are tagged; otherwise the features of those `way`s will be included in the resulted result as well.
 
 
 Performance
@@ -58,9 +55,8 @@ Performance
 3. For each script, run as many as times seperately and then calculate the average cost time (ACT for short)
 4. The # listed in the table below are coarse lowest values of dividing the ACT of `osmtogeojson` by the one of this library
 ```
-$ cd bench
-$ node o2gl-bench.js
-$ node otg-bench.js
+$ cd test
+$ npm run bench
 ```
 1. XML
    
@@ -79,7 +75,7 @@ Correctness
 ---
 You can copy the converted results to [geojsonlint](http://geojsonlint.com) for the correctness validation.  Up until now, `osm2geojson-lite` behaves pretty well with all the samples (also quite representative) in the `data` subfolers under `test` and `bench` directories, which also outperforms `osmtogeojson`. 
 
-The client side example shipped along with this package, `test/index.html` ~~will automatically call `geojsonlint` validation service directly after each conversion, you can wait for a while to see the validation result after click the conversion button.~~ - because the CORS limitation, the direct post to geojsonlint was blocked, so I added a "copy to clipboard" button for you to ease the validation.
+The client side example shipped along with this package, `test/index.html` - due to CORS limitation, the direct post to geojsonlint is blocked, so there's a "copy to clipboard" button for you to ease the validation.
 
 Node.JS version
 ---
@@ -91,10 +87,10 @@ Dependencies
 
 License
 ---
-Copyleft
+MIT
 
 Collaborators
 ---
-* tibetty
-* HarelM
+* [tibetty](https://github.com/tibetty/)
+* [HarelM](https://github.com/HarelM)
 

package/package.json

@@ -25,7 +25,7 @@
   "bugs": {
     "url": "https://github.com/tibetty/osm2geojson-lite/issues"
   },
-  "bundleDependencies": false,
+  "bundleDependencies": [],
   "deprecated": false,
   "description": "a lightweight yet faster osm (either in xml or in json formats) to geojson convertor - 4x faster than xmldom + osmtogeojson in most situations - implemented in pure JavaScript without any 3rd party dependency",
   "homepage": "https://github.com/tibetty/osm2geojson-lite#readme",
@@ -53,20 +53,25 @@
     "url": "git+https://github.com/tibetty/osm2geojson-lite.git"
   },
   "scripts": {
-    "build": "npm install && make",
-    "test": "make test"
+    "build-node": "tsc --declaration && cp src/polytags.json dist/node",
+    "build-web": "mkdir -p dist/web && browserify -s osm2geojson dist/node/index.js | uglifyjs -c -m -o dist/web/osm2geojson-lite.js",
+    "build": "npm run build-node && npm run build-web",
+    "test": "vitest test/e2e.test.ts --coverage"
   },
   "optionalDependencies": {
     "@types/geojson": "^7946.0.16"
   },
-  "version": "1.0.3",
+  "version": "1.1.0",
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^3.1.3",
     "browserify": "^17.0.1",
-    "uglify-js": "^3.19.3"
+    "typescript": "^5.8.3",
+    "uglify-js": "^3.19.3",
+    "vitest": "^3.1.3"
   },
   "files": [
     "dist/**/*.js",

package/dist/node/index.d.ts

@@ -1,12 +0,0 @@
-import { FeatureCollection, GeometryObject } from 'geojson';
-interface IOptions {
-    completeFeature?: boolean;
-    allFeatures?: boolean;
-    renderTagged?: boolean;
-    excludeWay?: boolean;
-    suppressWay?: boolean;
-}
-declare function osm2geojson(osm: string | {
-    [k: string]: any;
-}, opts?: IOptions): FeatureCollection<GeometryObject>;
-export = osm2geojson;

package/dist/node/index.js

@@ -1,199 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const osmobjs_1 = require("./osmobjs");
-const utils_1 = require("./utils");
-const xmlparser_1 = __importDefault(require("./xmlparser"));
-function osm2geojson(osm, opts) {
-    let completeFeature = false;
-    let renderTagged = false;
-    let excludeWay = true;
-    const parseOpts = (os) => {
-        if (os) {
-            completeFeature = os.completeFeature || os.allFeatures ? true : false;
-            renderTagged = os.renderTagged ? true : false;
-            const wayOpt = os.suppressWay || os.excludeWay;
-            if (wayOpt !== undefined && !wayOpt) {
-                excludeWay = false;
-            }
-        }
-    };
-    if (opts) {
-        parseOpts(opts);
-    }
-    const detectFormat = (o) => {
-        if (o.elements) {
-            return 'json';
-        }
-        if (o.indexOf('<osm') >= 0) {
-            return 'xml';
-        }
-        if (o.trim().startsWith('{')) {
-            return 'json-raw';
-        }
-        return 'invalid';
-    };
-    let format = detectFormat(osm);
-    const refElements = new utils_1.RefElements();
-    let featureArray = [];
-    const analyzeFeaturesFromJson = (o) => {
-        for (const elem of osm.elements) {
-            switch (elem.type) {
-                case 'node':
-                    const node = new osmobjs_1.Node(elem.id, refElements);
-                    if (elem.tags) {
-                        node.addTags(elem.tags);
-                    }
-                    node.addProps((0, utils_1.purgeProps)(elem, ['id', 'type', 'tags', 'lat', 'lon']));
-                    node.setLatLng(elem);
-                    break;
-                case 'way':
-                    const way = new osmobjs_1.Way(elem.id, refElements);
-                    if (elem.tags) {
-                        way.addTags(elem.tags);
-                    }
-                    way.addProps((0, utils_1.purgeProps)(elem, ['id', 'type', 'tags', 'nodes', 'geometry']));
-                    if (elem.geometry) {
-                        way.setLatLngArray(elem.geometry);
-                    }
-                    else if (elem.nodes) {
-                        for (const n of elem.nodes) {
-                            way.addNodeRef(n);
-                        }
-                    }
-                    break;
-                case 'relation':
-                    const relation = new osmobjs_1.Relation(elem.id, refElements);
-                    if (elem.bounds) {
-                        relation.setBounds([parseFloat(elem.bounds.minlon), parseFloat(elem.bounds.minlat), parseFloat(elem.bounds.maxlon), parseFloat(elem.bounds.maxlat)]);
-                    }
-                    if (elem.tags) {
-                        relation.addTags(elem.tags);
-                    }
-                    relation.addProps((0, utils_1.purgeProps)(elem, ['id', 'type', 'tags', 'bounds', 'members']));
-                    if (elem.members) {
-                        for (const member of elem.members) {
-                            relation.addMember(member);
-                        }
-                    }
-                default:
-                    break;
-            }
-        }
-    };
-    const analyzeFeaturesFromXml = (o) => {
-        const xmlParser = new xmlparser_1.default({ progressive: true });
-        xmlParser.on('</osm.node>', (node) => {
-            const nd = new osmobjs_1.Node(node.id, refElements);
-            for (const [k, v] of Object.entries(node)) {
-                if (!k.startsWith('$') && ['id', 'lon', 'lat'].indexOf(k) < 0) {
-                    nd.addProp(k, v);
-                }
-            }
-            nd.setLatLng(node);
-            if (node.$innerNodes) {
-                for (const ind of node.$innerNodes) {
-                    if (ind.$tag === 'tag') {
-                        nd.addTag(ind.k, ind.v);
-                    }
-                }
-            }
-        });
-        xmlParser.on('</osm.way>', (node) => {
-            const way = new osmobjs_1.Way(node.id, refElements);
-            for (const [k, v] of Object.entries(node)) {
-                if (!k.startsWith('$') && ['id'].indexOf(k) < 0) {
-                    way.addProp(k, v);
-                }
-            }
-            if (node.$innerNodes) {
-                for (const ind of node.$innerNodes) {
-                    if (ind.$tag === 'nd') {
-                        if (ind.lon && ind.lat) {
-                            way.addLatLng(ind);
-                        }
-                        else if (ind.ref) {
-                            way.addNodeRef(ind.ref);
-                        }
-                    }
-                    else if (ind.$tag === 'tag') {
-                        way.addTag(ind.k, ind.v);
-                    }
-                }
-            }
-        });
-        xmlParser.on('<osm.relation>', (node) => new osmobjs_1.Relation(node.id, refElements));
-        xmlParser.on('</osm.relation.member>', (node, parent) => {
-            const relation = refElements.get(`relation/${parent === null || parent === void 0 ? void 0 : parent.id}`);
-            const member = {
-                type: node.type,
-                role: node.role ? node.role : '',
-                ref: node.ref,
-            };
-            if (node.lat && node.lon) {
-                member.lat = node.lat, member.lon = node.lon, member.tags = {};
-                for (const [k, v] of Object.entries(node)) {
-                    if (!k.startsWith('$') && ['type', 'lat', 'lon'].indexOf(k) < 0) {
-                        member[k] = v;
-                    }
-                }
-            }
-            if (node.$innerNodes) {
-                const geometry = [];
-                const nodes = [];
-                for (const ind of node.$innerNodes) {
-                    if (ind.lat && ind.lon) {
-                        geometry.push(ind);
-                    }
-                    else if (ind.ref) {
-                        nodes.push(ind.ref);
-                    }
-                }
-                if (geometry.length > 0) {
-                    member.geometry = geometry;
-                }
-                else if (nodes.length > 0) {
-                    member.nodes = nodes;
-                }
-            }
-            relation.addMember(member);
-        });
-        xmlParser.on('</osm.relation.bounds>', (node, parent) => {
-            refElements.get(`relation/${parent === null || parent === void 0 ? void 0 : parent.id}`).setBounds([parseFloat(node.minlon), parseFloat(node.minlat), parseFloat(node.maxlon), parseFloat(node.maxlat)]);
-        });
-        xmlParser.on('</osm.relation.tag>', (node, parent) => {
-            refElements.get(`relation/${parent === null || parent === void 0 ? void 0 : parent.id}`).addTag(node.k, node.v);
-        });
-        xmlParser.parse(o);
-    };
-    if (format === 'json-raw') {
-        osm = JSON.parse(osm);
-        if (osm.elements) {
-            format = 'json';
-        }
-        else {
-            format = 'invalid';
-        }
-    }
-    if (format === 'json') {
-        analyzeFeaturesFromJson(osm);
-    }
-    else if (format === 'xml') {
-        analyzeFeaturesFromXml(osm);
-    }
-    refElements.bindAll();
-    for (const v of refElements.values()) {
-        if (v.refCount <= 0 || (v.hasTag && renderTagged && !(v instanceof osmobjs_1.Way && excludeWay))) {
-            const features = v.toFeatureArray();
-            // return the first geometry of the first relation element
-            if (v instanceof osmobjs_1.Relation && !completeFeature && features.length > 0) {
-                return features[0].geometry;
-            }
-            featureArray = featureArray.concat(features);
-        }
-    }
-    return { type: 'FeatureCollection', features: featureArray };
-}
-;
-module.exports = osm2geojson;

package/dist/node/osmobjs.d.ts

@@ -1,73 +0,0 @@
-import { Feature } from 'geojson';
-import { RefElements } from './utils';
-declare class OsmObject {
-    refCount: number;
-    protected refElems: RefElements;
-    private type;
-    private id;
-    private tags;
-    private props;
-    private hasTag;
-    constructor(type: string, id: string, refElems: RefElements);
-    addTags(tags: {
-        [k: string]: string;
-    }): void;
-    addTag(k: string, v: string): void;
-    addProp(k: string, v: any): void;
-    addProps(props: {
-        [k: string]: string;
-    }): void;
-    getCompositeId(): string;
-    getProps(): {
-        [k: string]: string;
-    };
-    toFeatureArray(): Array<Feature<any, any>>;
-}
-export declare class Node extends OsmObject {
-    private latLng;
-    constructor(id: string, refElems: RefElements);
-    setLatLng(latLng: {
-        lat: string;
-        lon: string;
-    }): void;
-    toFeatureArray(): Array<Feature<any, any>>;
-    getLatLng(): {
-        lat: string;
-        lon: string;
-    } | null;
-}
-export declare class Way extends OsmObject {
-    private latLngArray;
-    private isPolygon;
-    constructor(id: string, refElems: RefElements);
-    addLatLng(latLng: {
-        lat: string;
-        lon: string;
-    }): void;
-    setLatLngArray(latLngArray: Array<{
-        lat: string;
-        lon: string;
-        [k: string]: any;
-    }>): void;
-    addNodeRef(ref: string): void;
-    addTags(tags: {
-        [k: string]: string;
-    }): void;
-    addTag(k: string, v: string): void;
-    toCoordsArray(): string[][];
-    toFeatureArray(): Array<Feature<any, any>>;
-    private analyzeTag;
-}
-export declare class Relation extends OsmObject {
-    private relations;
-    private nodes;
-    private bounds;
-    [k: string]: any;
-    constructor(id: string, refElems: RefElements);
-    setBounds(bounds: any[]): void;
-    addMember(member: {
-        [k: string]: any;
-    }): void;
-    toFeatureArray(): Array<Feature<any, any>>;
-}
-export {};