osm2geojson-lite 1.0.1 → 1.0.2

package/README.md

@@ -7,6 +7,12 @@ 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
 -----
 
@@ -55,26 +61,25 @@ Performance
 $ cd bench
 $ node o2gl-bench.js
 $ node otg-bench.js
-
+```
 1. XML
------------------------------------------------------
-|  zhucheng  |   hebei    |  tokyodo   |    usa     |
-+------------+------------+------------+------------+
-|  >2.5x     |  >4.0x     |  >3.0x     |  >3.0x     |
------------------------------------------------------
+   
+| zhucheng  | hebei    | tokyodo | usa  |
+|-----------|----------|---------|------|
+| >2.5x     | >4.0x    | >3.0x   | >3.0x|
+
 2. Overpass JSON
------------------------------------------------------
-|  zhucheng  |   hebei    |  tokyodo   |    usa     |
-+------------+------------+------------+------------+
-|  >2.5x     |  >11.0x    |  >7.0x     |  >5.0x     |
------------------------------------------------------
-```
+   
+| zhucheng  | hebei    | tokyodo | usa  |
+|-----------|----------|---------|------|
+| >2.5x     | >11.0x   | >7.0x   | >5.0x|
+
 
 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, `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.
+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.
 
 Node.JS version
 ---
@@ -86,4 +91,10 @@ Dependencies
 
 License
 ---
-Written in 2018 by tibetty <xihua.duan@gmail.com>
+Copyleft
+
+Collaborators
+---
+* tibetty
+* HarelM
+

package/package.json

@@ -45,8 +45,8 @@
     "multipolygon"
   ],
   "license": "ISC",
-  "main": "ts/release/index.js",
-  "types": "ts/release/index.d.ts",
+  "main": "dist/node/index.js",
+  "types": "dist/node/index.d.ts",
   "name": "osm2geojson-lite",
   "repository": {
     "type": "git",
@@ -59,7 +59,7 @@
   "optionalDependencies": {
     "@types/geojson": "^7946.0.16"
   },
-  "version": "1.0.1",
+  "version": "1.0.2",
   "directories": {
     "lib": "lib",
     "test": "test"
@@ -69,9 +69,7 @@
     "uglify-js": "^3.19.3"
   },
   "files": [
-    "ts/release/**/*.js",
-    "ts/release/**/*.d.ts",
-    "ts/release/**/*.json",
-    "dist/osm2geojson-lite.js"
+    "dist/**/*.js",
+    "dist/**/*.json"
   ]
 }

package/osm2geojson-lite

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-const osm2geojson = require('./lib/index.js');
-const fs = require('fs');
-
-const data = fs.readFileSync("/dev/stdin", "utf-8");
-const geojson = osm2geojson(data, {completeFeature: true, renderTagged: true});
-console.log(JSON.stringify(geojson));

package/ts/release/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/ts/release/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 {};

package/ts/release/utils.d.ts

@@ -1,60 +0,0 @@
-import { Way } from './osmobjs';
-export declare function purgeProps(obj: {
-    [k: string]: any;
-}, blacklist: string[]): {
-    [k: string]: any;
-};
-export declare function mergeProps(obj1: {
-    [k: string]: any;
-}, obj2: {
-    [k: string]: any;
-}): {
-    [k: string]: any;
-};
-export declare function addPropToFeature(f: {
-    [k: string]: any;
-}, k: string, v: any): void;
-export declare function addPropToFeatures(fs: Array<{
-    [k: string]: any;
-}>, k: string, v: any): void;
-export declare const first: <T>(a: T[]) => T;
-export declare const last: <T>(a: T[]) => T;
-export declare const coordsToKey: <T>(a: T[]) => string;
-export declare function addToMap<T>(m: {
-    [k: string]: T[];
-}, k: string, v: T): void;
-export declare function removeFromMap<T>(m: {
-    [k: string]: T[];
-}, k: string, v: T): void;
-export declare function getFirstFromMap<T>(m: {
-    [k: string]: T[];
-}, k: string): T | null;
-export declare const isRing: (a: number[][]) => boolean;
-export declare const ringDirection: (a: number[][], xIdx?: number, yIdx?: number) => string;
-export declare const ptInsidePolygon: (pt: number[], polygon: number[][], xIdx?: number, yIdx?: number) => boolean;
-export declare const strToFloat: (el: any[] | string) => any;
-export declare class LateBinder {
-    private container;
-    private valueFunc;
-    private ctx;
-    private args;
-    constructor(container: any[] | {
-        [k: string]: any;
-    }, valueFunc: (...args: any[]) => any, ctx: any, args: any[]);
-    bind(): void;
-}
-export declare class RefElements extends Map {
-    private binders;
-    constructor();
-    add(k: string, v: any): void;
-    addBinder(binder: LateBinder): void;
-    bindAll(): void;
-}
-export declare class WayCollection extends Array {
-    private firstMap;
-    private lastMap;
-    constructor();
-    addWay(way: Way): void;
-    toStrings(): number[][][];
-    toRings(direction: string): number[][][];
-}

package/ts/release/xmlparser.d.ts

@@ -1,32 +0,0 @@
-export default class {
-    private queryParent;
-    private progressive;
-    private parentMap;
-    private evtListeners;
-    constructor(opts: any);
-    parse(xml: string, parent?: any, dir?: string): any[];
-    getParent(node: any): any;
-    addListener(evt: string, func: (node: {
-        [k: string]: any;
-    }, parent?: {
-        [k: string]: any;
-    }) => void): void;
-    removeListener(evt: string, func: (node: {
-        [k: string]: any;
-    }, parent?: {
-        [k: string]: any;
-    }) => void): void;
-    on(evt: string, func: (node: {
-        [k: string]: any;
-    }, parent?: {
-        [k: string]: any;
-    }) => void): void;
-    off(evt: string, func: (node: {
-        [k: string]: any;
-    }, parent?: {
-        [k: string]: any;
-    }) => void): void;
-    private $addListener;
-    private $removeListener;
-    private emit;
-}