@osmix/shared 0.0.1 → 0.0.6

package/dist/test/utils.test.js

@@ -0,0 +1,76 @@
+import { describe, expect, it } from "bun:test";
+import { entityPropertiesEqual, getEntityType, isMultipolygonRelation, isNode, isNodeEqual, isRelation, isRelationEqual, isWay, isWayEqual, } from "../src/utils";
+describe("utils", () => {
+    const node = {
+        id: 1,
+        lat: 10,
+        lon: 20,
+        tags: { name: "node" },
+    };
+    const way = {
+        id: 2,
+        refs: [1, 2, 3],
+        tags: { highway: "residential" },
+    };
+    const members = [
+        {
+            type: "node",
+            ref: 1,
+        },
+    ];
+    const relation = {
+        id: 3,
+        members,
+        tags: { type: "multipolygon" },
+    };
+    it("narrows entity types", () => {
+        expect(isNode(node)).toBe(true);
+        expect(isWay(way)).toBe(true);
+        expect(isRelation(relation)).toBe(true);
+    });
+    it("compares entity equality", () => {
+        expect(isNodeEqual(node, { ...node })).toBe(true);
+        expect(isWayEqual(way, { ...way })).toBe(true);
+        expect(isRelationEqual(relation, { ...relation })).toBe(true);
+    });
+    it("detects property differences", () => {
+        expect(entityPropertiesEqual(node, { ...node, tags: { name: "changed" } })).toBe(false);
+        expect(entityPropertiesEqual(way, { ...way, refs: [1, 2, 4] })).toBe(false);
+        expect(entityPropertiesEqual(relation, {
+            ...relation,
+            members: [{ type: "node", ref: 2 }],
+        })).toBe(false);
+    });
+    it("provides entity type", () => {
+        expect(getEntityType(node)).toBe("node");
+        expect(getEntityType(way)).toBe("way");
+        expect(getEntityType(relation)).toBe("relation");
+    });
+    describe("isMultipolygonRelation", () => {
+        it("identifies multipolygon relations", () => {
+            const relation = {
+                id: 1,
+                tags: { type: "multipolygon" },
+                members: [],
+            };
+            expect(isMultipolygonRelation(relation)).toBe(true);
+        });
+        it("rejects non-multipolygon relations", () => {
+            const relation = {
+                id: 1,
+                tags: { type: "route" },
+                members: [],
+            };
+            expect(isMultipolygonRelation(relation)).toBe(false);
+        });
+        it("rejects relations without type tag", () => {
+            const relation = {
+                id: 1,
+                tags: { name: "test" },
+                members: [],
+            };
+            expect(isMultipolygonRelation(relation)).toBe(false);
+        });
+    });
+});
+//# sourceMappingURL=utils.test.js.map

package/dist/test/utils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../../test/utils.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAA;AAO/C,OAAO,EACN,qBAAqB,EACrB,aAAa,EACb,sBAAsB,EACtB,MAAM,EACN,WAAW,EACX,UAAU,EACV,eAAe,EACf,KAAK,EACL,UAAU,GACV,MAAM,cAAc,CAAA;AAErB,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACtB,MAAM,IAAI,GAAY;QACrB,EAAE,EAAE,CAAC;QACL,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;QACP,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;KACtB,CAAA;IACD,MAAM,GAAG,GAAW;QACnB,EAAE,EAAE,CAAC;QACL,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;KAChC,CAAA;IACD,MAAM,OAAO,GAAwB;QACpC;YACC,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACN;KACD,CAAA;IACD,MAAM,QAAQ,GAAgB;QAC7B,EAAE,EAAE,CAAC;QACL,OAAO;QACP,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;KAC9B,CAAA;IAED,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC/B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7B,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACvC,MAAM,CACL,qBAAqB,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CACnE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACb,MAAM,CAAC,qBAAqB,CAAC,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3E,MAAM,CACL,qBAAqB,CAAC,QAAQ,EAAE;YAC/B,GAAG,QAAQ;YACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;SACnC,CAAC,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACd,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC/B,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACxC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACtC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC5C,MAAM,QAAQ,GAAgB;gBAC7B,EAAE,EAAE,CAAC;gBACL,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;gBAC9B,OAAO,EAAE,EAAE;aACX,CAAA;YACD,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC7C,MAAM,QAAQ,GAAgB;gBAC7B,EAAE,EAAE,CAAC;gBACL,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;gBACvB,OAAO,EAAE,EAAE;aACX,CAAA;YACD,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC7C,MAAM,QAAQ,GAAgB;gBAC7B,EAAE,EAAE,CAAC;gBACL,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACtB,OAAO,EAAE,EAAE;aACX,CAAA;YACD,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/test/way-is-area.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=way-is-area.test.d.ts.map

package/dist/test/way-is-area.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"way-is-area.test.d.ts","sourceRoot":"","sources":["../../test/way-is-area.test.ts"],"names":[],"mappings":""}

package/dist/test/way-is-area.test.js

@@ -0,0 +1,31 @@
+import { describe, expect, it } from "bun:test";
+import { wayIsArea } from "../src/way-is-area";
+describe("wayIsArea", () => {
+    it("returns false for open ways", () => {
+        const refs = [1, 2, 3];
+        expect(wayIsArea({ id: 0, refs, tags: { building: "yes" } })).toBe(false);
+    });
+    it("returns true for closed way without tags", () => {
+        const refs = [1, 2, 3, 1];
+        expect(wayIsArea({ id: 0, refs })).toBe(true);
+    });
+    it("honors explicit area override", () => {
+        const refs = [1, 2, 3, 1];
+        expect(wayIsArea({ id: 0, refs, tags: { area: "no", building: "yes" } })).toBe(false);
+        expect(wayIsArea({ id: 0, refs, tags: { area: "yes" } })).toBe(true);
+    });
+    it("treats implied tags as areas", () => {
+        const refs = [1, 2, 3, 1];
+        expect(wayIsArea({ id: 0, refs, tags: { building: "yes" } })).toBe(true);
+    });
+    it("considers included values", () => {
+        const refs = [1, 2, 3, 1];
+        expect(wayIsArea({ id: 0, refs, tags: { highway: "rest_area" } })).toBe(true);
+        expect(wayIsArea({ id: 0, refs, tags: { highway: "primary" } })).toBe(false);
+    });
+    it("rejects excluded values", () => {
+        const refs = [1, 2, 3, 1];
+        expect(wayIsArea({ id: 0, refs, tags: { natural: "coastline" } })).toBe(false);
+    });
+});
+//# sourceMappingURL=way-is-area.test.js.map

package/dist/test/way-is-area.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"way-is-area.test.js","sourceRoot":"","sources":["../../test/way-is-area.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACtC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACtB,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC1E,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACnD,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACxC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACzB,MAAM,CACL,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CACjE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACb,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACvC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACpC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CACtE,IAAI,CACJ,CAAA;QACD,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7E,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAClC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CACtE,KAAK,CACL,CAAA;IACF,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/package.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json.schemastore.org/package",
 	"name": "@osmix/shared",
 	"type": "module",
-	"version": "0.0.1",
+	"version": "0.0.6",
 	"description": "Shared utilities for Osmix",
 	"exports": {
 		"./*": "./src/*.ts",
@@ -37,16 +37,18 @@
 	"sideEffects": false,
 	"scripts": {
 		"build": "tsc",
-		"bench": "vitest bench",
-		"test": "vitest",
-		"typecheck": "tsc --noEmit"
+		"bench": "bun test --bench",
+		"prepublishOnly": "tsc",
+		"test": "bun test",
+		"typecheck": "tsgo --noEmit"
 	},
 	"devDependencies": {
-		"typescript": "catalog:",
-		"vitest": "catalog:"
+		"@types/bun": "catalog:",
+		"typescript": "catalog:"
 	},
 	"dependencies": {
-		"@mapbox/sphericalmercator": "catalog:",
+		"@mapbox/tilebelt": "^2.0.2",
+		"dequal": "catalog:",
 		"lineclip": "^2.0.0"
 	}
 }

package/src/assert.ts

@@ -1,5 +1,25 @@
 /**
- * Short utility for checking index access.
+ * Assertion utilities for defensive programming.
+ *
+ * Provides typed assertion helpers that throw errors when conditions are not met,
+ * commonly used for index bounds checking and null/undefined guards.
+ *
+ * @module
+ */
+
+/**
+ * Assert that a value is neither null nor undefined.
+ *
+ * @param value - The value to check.
+ * @param message - Optional error message if assertion fails.
+ * @throws Error if value is null or undefined.
+ *
+ * @example
+ * ```ts
+ * const item = array[index]
+ * assertValue(item, `No item at index ${index}`)
+ * // TypeScript now knows item is non-nullable
+ * ```
  */
 export function assertValue<T>(
 	value?: T,

package/src/bbox-intersects.ts

@@ -0,0 +1,30 @@
+/**
+ * Bounding box intersection and containment utilities.
+ *
+ * Provides functions for checking spatial relationships between
+ * geographic bounding boxes (west, south, east, north format).
+ *
+ * @module
+ */
+
+import type { GeoBbox2D } from "./types"
+
+/**
+ * Check if two bounding boxes intersect or contain each other.
+ * Handles both partial overlaps and complete containment.
+ */
+export function bboxContainsOrIntersects(bb1: GeoBbox2D, bb2: GeoBbox2D) {
+	const westIn =
+		(bb1[0] >= bb2[0] && bb1[0] <= bb2[2]) ||
+		(bb2[0] >= bb1[0] && bb2[0] <= bb1[2])
+	const eastIn =
+		(bb1[2] >= bb2[0] && bb1[2] <= bb2[2]) ||
+		(bb2[2] >= bb1[0] && bb2[2] <= bb1[2])
+	const northIn =
+		(bb1[1] >= bb2[1] && bb1[1] <= bb2[3]) ||
+		(bb2[1] >= bb1[1] && bb2[1] <= bb1[3])
+	const southIn =
+		(bb1[3] >= bb2[1] && bb1[3] <= bb2[3]) ||
+		(bb2[3] >= bb1[1] && bb2[3] <= bb1[3])
+	return (westIn || eastIn) && (northIn || southIn)
+}

package/src/bytes-to-stream.ts

@@ -1,3 +1,20 @@
+/**
+ * Byte array to stream conversion.
+ *
+ * Wraps a Uint8Array in a ReadableStream for use with streaming APIs.
+ *
+ * @module
+ */
+
+/**
+ * Create a ReadableStream from a Uint8Array.
+ *
+ * The stream will emit the entire byte array as a single chunk,
+ * then close immediately.
+ *
+ * @param bytes - The byte array to wrap.
+ * @returns A ReadableStream that emits the bytes.
+ */
 export function bytesToStream(bytes: Uint8Array<ArrayBuffer>) {
 	return new ReadableStream<Uint8Array<ArrayBuffer>>({
 		start(controller) {

package/src/coordinates.ts

@@ -0,0 +1,45 @@
+/**
+ * Coordinate precision utilities for OSM data.
+ *
+ * OSM stores coordinates as integer microdegrees (7 decimal places) for
+ * compact storage and consistent precision. This module provides conversions
+ * between floating-point degrees and integer microdegrees.
+ *
+ * @module
+ */
+
+import type { GeoBbox2D } from "./types"
+
+/**
+ * OSM coordinate scale: coordinates are stored as integer microdegrees.
+ * 1 microdegree = 1e-7 degrees = 0.0000001 degrees
+ */
+export const OSM_COORD_SCALE = 1e7
+
+/**
+ * Convert degrees to microdegrees (integer).
+ */
+export function toMicroDegrees(degrees: number): number {
+	return Math.round(degrees * OSM_COORD_SCALE)
+}
+
+/**
+ * Convert microdegrees (integer) to degrees (float).
+ */
+export function microToDegrees(microdegrees: number): number {
+	return microdegrees / OSM_COORD_SCALE
+}
+
+/**
+ * Convert a bounding box from degrees to microdegrees.
+ */
+export function bboxToMicroDegrees(
+	bbox: GeoBbox2D,
+): [minLon: number, minLat: number, maxLon: number, maxLat: number] {
+	return [
+		toMicroDegrees(bbox[0]),
+		toMicroDegrees(bbox[1]),
+		toMicroDegrees(bbox[2]),
+		toMicroDegrees(bbox[3]),
+	]
+}

package/src/haversine-distance.ts

@@ -1,5 +1,14 @@
 /**
- * Calculate the haversine distance between two LonLat points.
+ * Great-circle distance calculation using the Haversine formula.
+ *
+ * Computes the shortest distance between two points on a sphere,
+ * accounting for Earth's curvature. Accurate for most geographic distances.
+ *
+ * @module
+ */
+
+/**
+ * Calculate the great-circle distance between two geographic points.
  * @param p1 - The first point
  * @param p2 - The second point
  * @returns The haversine distance in meters

package/src/progress.ts

@@ -0,0 +1,55 @@
+/**
+ * Progress event helpers for long-running operations.
+ *
+ * Provides a standard interface for reporting progress from workers and
+ * async operations. Uses CustomEvent for cross-context communication.
+ *
+ * @module
+ */
+
+/**
+ * Progress payload containing a message and timestamp.
+ * Planned expansion to include percentage completion.
+ */
+export type Progress = {
+	msg: string
+	timestamp: number
+}
+
+/** CustomEvent carrying progress details. */
+export interface ProgressEvent extends CustomEvent<Progress> {}
+
+/**
+ * Create a Progress payload with current timestamp.
+ * @param msg - The progress message.
+ */
+export function progress(msg: string): Progress {
+	return {
+		msg,
+		timestamp: Date.now(),
+	}
+}
+
+/**
+ * Create a ProgressEvent with the given message.
+ * @param msg - The progress message.
+ */
+export function progressEvent(msg: string): ProgressEvent {
+	return new CustomEvent("progress", { detail: progress(msg) })
+}
+
+/**
+ * Extract the message string from a progress event.
+ * @param event - The event to extract from.
+ */
+export function progressEventMessage(event: Event): string {
+	return (event as ProgressEvent).detail.msg
+}
+
+/**
+ * Log a progress event's message to the console.
+ * @param progress - The progress event to log.
+ */
+export function logProgress(progress: ProgressEvent) {
+	console.log(progressEventMessage(progress))
+}