@osm-editor-kit/osm-data 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,18 @@
+# `@osm-editor-kit/osm-data`
+
+**Status:** First npm **alpha** (`0.1.0-alpha.0`). Publish with `bun run packages:release -- --publish-only` after `npm login`.
+
+## What it does
+
+Download OSM JSON from a URL (Overpass or API) and parse it into indexed in-memory stores for ways, relations, tagged nodes, node coordinates, and ways-in-relation lookup. Exports shared TypeScript types and merges multiple fetches with version-aware updates.
+
+## Usage
+
+```ts
+import { downloadOsmData, parseOsmResp, mergeParsedOsm } from '@osm-editor-kit/osm-data'
+
+const parsed = await downloadOsmData(overpassUrl)
+const combined = mergeParsedOsm(parsed, parseOsmResp(rawOsmResp))
+```
+
+Fetch/parse/index only — not an OSM editor or tag writer.

package/dist/data-client.d.ts

@@ -0,0 +1,10 @@
+import { type RawOsmData } from './types/osm-data';
+import { type ParsedOsmData } from './types/osm-data-storage';
+export declare function emptyParsedOsmData(): ParsedOsmData;
+export declare function mergeParsedOsm(existing: ParsedOsmData, incoming: ParsedOsmData): ParsedOsmData;
+/**
+ * Download and parse OSM data from a URL.
+ * @throws {Error} Throws error when HTTP request fails (eg. HTTP 429 when too many requests)
+ */
+export declare function downloadOsmData(url: string): Promise<ParsedOsmData>;
+export declare function parseOsmResp(osmResp: RawOsmData): ParsedOsmData;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { downloadOsmData, emptyParsedOsmData, mergeParsedOsm, parseOsmResp } from './data-client';
+export type { LatLngLiteral, MapBounds } from './types/geo';
+export type { OsmElement, OsmNode, OsmObject, OsmRelation, OsmTags, OsmWay, RawOsmData, } from './types/osm-data';
+export type { ParsedOsmData, WaysInRelation } from './types/osm-data-storage';

package/dist/index.js

@@ -0,0 +1,75 @@
+import axios from 'axios';
+
+// src/data-client.ts
+function emptyParsedOsmData() {
+  return {
+    relations: {},
+    ways: {},
+    nodes: {},
+    nodeCoords: {},
+    waysInRelation: {}
+  };
+}
+function mergeParsedOsm(existing, incoming) {
+  const merged = {
+    relations: { ...existing.relations },
+    ways: { ...existing.ways },
+    nodes: { ...existing.nodes },
+    nodeCoords: { ...existing.nodeCoords },
+    waysInRelation: { ...existing.waysInRelation }
+  };
+  Object.assign(merged.nodes, incoming.nodes);
+  Object.assign(merged.nodeCoords, incoming.nodeCoords);
+  Object.assign(merged.waysInRelation, incoming.waysInRelation);
+  for (const wayId in incoming.ways) {
+    const incomingWay = incoming.ways[wayId];
+    const existingWay = merged.ways[wayId];
+    if (existingWay && existingWay.version >= incomingWay.version) continue;
+    merged.ways[wayId] = incomingWay;
+  }
+  for (const relationId in incoming.relations) {
+    const incomingRelation = incoming.relations[relationId];
+    const existingRelation = merged.relations[relationId];
+    if (existingRelation && existingRelation.version >= incomingRelation.version) continue;
+    merged.relations[relationId] = incomingRelation;
+  }
+  return merged;
+}
+async function downloadOsmData(url) {
+  const osmResp = await downloadContent(url);
+  return parseOsmResp(osmResp);
+}
+async function downloadContent(url) {
+  const resp = await axios.get(url, {
+    headers: {
+      Accept: "application/json"
+    }
+  });
+  return resp.data;
+}
+function parseOsmResp(osmResp) {
+  const newData = emptyParsedOsmData();
+  for (const el of osmResp.elements) {
+    switch (el.type) {
+      case "node":
+        newData.nodeCoords[el.id] = [el.lat, el.lon];
+        if (el.tags) newData.nodes[el.id] = el;
+        break;
+      case "way":
+        newData.ways[el.id] = el;
+        break;
+      case "relation":
+        newData.relations[el.id] = el;
+        for (const member of el.members) {
+          if (member.type === "way" && newData.ways[member.ref])
+            newData.waysInRelation[member.ref] = true;
+        }
+        break;
+      default:
+        throw new Error("Not supported osm type " + el.type);
+    }
+  }
+  return newData;
+}
+
+export { downloadOsmData, emptyParsedOsmData, mergeParsedOsm, parseOsmResp };

package/dist/types/geo.d.ts

@@ -0,0 +1,10 @@
+export interface MapBounds {
+    south: number;
+    west: number;
+    north: number;
+    east: number;
+}
+export interface LatLngLiteral {
+    lat: number;
+    lng: number;
+}

package/dist/types/osm-data-storage.d.ts

@@ -0,0 +1,17 @@
+import { type OsmNode, type OsmRelation, type OsmWay } from './osm-data';
+export type WaysInRelation = Record<number, boolean>;
+export interface ParsedOsmData {
+    relations: {
+        [relationId: number]: OsmRelation;
+    };
+    ways: {
+        [wayId: number]: OsmWay;
+    };
+    nodes: {
+        [nodeId: number]: OsmNode;
+    };
+    nodeCoords: {
+        [nodeId: number]: [number, number];
+    };
+    waysInRelation: WaysInRelation;
+}

package/dist/types/osm-data.d.ts

@@ -0,0 +1,36 @@
+export type OsmTags = Record<string, string>;
+type OsmType = 'node' | 'way' | 'relation';
+export interface OsmObject {
+    id: number;
+    type: OsmType;
+    uid?: number;
+    user?: string;
+    /** ISO8601 string */
+    timestamp?: string;
+    version: number;
+    changeset: number;
+    tags: OsmTags;
+}
+interface RelationMember {
+    type: OsmType;
+    ref: number;
+    role: string;
+}
+export interface OsmRelation extends OsmObject {
+    type: 'relation';
+    members: RelationMember[];
+}
+export interface OsmNode extends OsmObject {
+    type: 'node';
+    lat: number;
+    lon: number;
+}
+export interface OsmWay extends OsmObject {
+    type: 'way';
+    nodes: number[];
+}
+export type OsmElement = OsmNode | OsmWay | OsmRelation;
+export interface RawOsmData {
+    elements: OsmElement[];
+}
+export {};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@osm-editor-kit/osm-data",
+  "version": "0.1.0-alpha.0",
+  "description": "Download, parse, and merge OSM API/Overpass responses into an indexed in-memory store.",
+  "license": "MIT",
+  "author": "Tobias Jordans",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/osmberlin/street-space-editor.git",
+    "directory": "packages/osm-data"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha"
+  },
+  "scripts": {
+    "build": "tsup && rm -f .tsbuildinfo && tsc -p tsconfig.build.json",
+    "type-check": "tsc --noEmit",
+    "test-run": "bun test src/test",
+    "prepublishOnly": "bun run build && bun ../../scripts/package-exports-for-publish.ts",
+    "postpublish": "bun ../../scripts/package-exports-restore.ts",
+    "prepack": "bun ../../scripts/package-exports-for-publish.ts",
+    "postpack": "bun ../../scripts/package-exports-restore.ts"
+  },
+  "dependencies": {
+    "axios": "^1.11.0"
+  },
+  "devDependencies": {
+    "bun-types": "^1.2.20",
+    "tsup": "^8.5.1",
+    "typescript": "^7.0.0"
+  },
+  "publishExports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  }
+}