@osmix/geojson 0.0.15 → 0.0.17

package/src/types.ts

@@ -3,17 +3,17 @@
  * @module
  */
 
-import type { OsmEntityType, OsmInfoParsed, OsmTags } from "@osmix/shared/types"
+import type { OsmEntityType, OsmInfoParsed, OsmTags } from "@osmix/types";
 import type {
-	Feature,
-	GeometryCollection,
-	LineString,
-	MultiLineString,
-	MultiPoint,
-	MultiPolygon,
-	Point,
-	Polygon,
-} from "geojson"
+  Feature,
+  GeometryCollection,
+  LineString,
+  MultiLineString,
+  MultiPoint,
+  MultiPolygon,
+  Point,
+  Polygon,
+} from "geojson";
 
 /**
  * GeoJSON Feature properties for OSM entities.
@@ -22,15 +22,15 @@ import type {
  * All OSM tags are spread into the properties object.
  */
 export type OsmGeoJSONProperties = {
-	/** OSM entity ID. */
-	id: number
-	/** Entity type: "node", "way", or "relation". */
-	type: OsmEntityType
-	/** OSM tags (key-value pairs). */
-	tags?: OsmTags
-	/** Entity metadata (version, timestamp, user, etc.). */
-	info?: OsmInfoParsed
-}
+  /** OSM entity ID. */
+  id: number;
+  /** Entity type: "node", "way", or "relation". */
+  type: OsmEntityType;
+  /** OSM tags (key-value pairs). */
+  tags?: OsmTags;
+  /** Entity metadata (version, timestamp, user, etc.). */
+  info?: OsmInfoParsed;
+};
 
 /**
  * GeoJSON Feature with OSM-specific properties.
@@ -41,15 +41,15 @@ export type OsmGeoJSONProperties = {
  * - Relations → MultiPolygon, MultiLineString, MultiPoint, or GeometryCollection
  */
 export type OsmGeoJSONFeature<
-	T extends
-		| Point
-		| LineString
-		| Polygon
-		| MultiPolygon
-		| MultiLineString
-		| MultiPoint
-		| GeometryCollection,
-> = Feature<T, OsmGeoJSONProperties>
+  T extends
+    | Point
+    | LineString
+    | Polygon
+    | MultiPolygon
+    | MultiLineString
+    | MultiPoint
+    | GeometryCollection,
+> = Feature<T, OsmGeoJSONProperties>;
 
 /**
  * GeoJSON FeatureCollection types that can be imported into an Osm index.
@@ -58,8 +58,8 @@ export type OsmGeoJSONFeature<
  * Other geometry types are not supported for import.
  */
 export type ImportableGeoJSON = GeoJSON.FeatureCollection<
-	GeoJSON.Point | GeoJSON.LineString | GeoJSON.Polygon | GeoJSON.MultiPolygon
->
+  GeoJSON.Point | GeoJSON.LineString | GeoJSON.Polygon | GeoJSON.MultiPolygon
+>;
 
 /**
  * Input types accepted by `fromGeoJSON`.
@@ -70,8 +70,4 @@ export type ImportableGeoJSON = GeoJSON.FeatureCollection<
  * - `string` - JSON string
  * - `ImportableGeoJSON` - Already-parsed FeatureCollection
  */
-export type ReadOsmDataTypes =
-	| ArrayBufferLike
-	| ReadableStream
-	| string
-	| ImportableGeoJSON
+export type ReadOsmDataTypes = ArrayBufferLike | ReadableStream | string | ImportableGeoJSON;

package/src/utils.ts

@@ -3,7 +3,9 @@
  * @module
  */
 
-import type { ImportableGeoJSON, ReadOsmDataTypes } from "./types.ts"
+import { isSharedArrayBuffer } from "@osmix/shared/backing-buffers";
+
+import type { ImportableGeoJSON, ReadOsmDataTypes } from "./types.ts";
 
 /**
  * Parse GeoJSON from various input formats.
@@ -28,31 +30,29 @@ import type { ImportableGeoJSON, ReadOsmDataTypes } from "./types.ts"
  * const geojson = await readDataAsGeoJSON(response.body!)
  * ```
  */
-export async function readDataAsGeoJSON(
-	data: ReadOsmDataTypes,
-): Promise<ImportableGeoJSON> {
-	if (data == null) throw new Error("Data is null")
-	if (typeof data === "string") return JSON.parse(data) as ImportableGeoJSON
+export async function readDataAsGeoJSON(data: ReadOsmDataTypes): Promise<ImportableGeoJSON> {
+  if (data == null) throw new Error("Data is null");
+  if (typeof data === "string") return JSON.parse(data) as ImportableGeoJSON;
 
-	if (data instanceof ReadableStream) {
-		const reader = data.pipeThrough(new TextDecoderStream()).getReader()
-		let result = ""
-		while (true) {
-			const { done, value } = await reader.read()
-			if (done) break
-			if (value !== undefined) result += value
-		}
-		return JSON.parse(result) as ImportableGeoJSON
-	}
-	if (data instanceof ArrayBuffer || data instanceof SharedArrayBuffer) {
-		const decoder = new TextDecoder()
-		const text = decoder.decode(new Uint8Array(data))
-		return JSON.parse(text) as ImportableGeoJSON
-	}
-	if (typeof data === "object" && "type" in data && "features" in data) {
-		return data as ImportableGeoJSON
-	}
-	throw new Error(
-		"Invalid data type. Accepts string, ReadableStream, ArrayBufferLike, or GeoJSON FeatureCollection.",
-	)
+  if (data instanceof ReadableStream) {
+    const reader = data.pipeThrough(new TextDecoderStream()).getReader();
+    let result = "";
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      if (value !== undefined) result += value;
+    }
+    return JSON.parse(result) as ImportableGeoJSON;
+  }
+  if (data instanceof ArrayBuffer || isSharedArrayBuffer(data)) {
+    const decoder = new TextDecoder();
+    const text = decoder.decode(new Uint8Array(data));
+    return JSON.parse(text) as ImportableGeoJSON;
+  }
+  if (typeof data === "object" && "type" in data && "features" in data) {
+    return data as ImportableGeoJSON;
+  }
+  throw new Error(
+    "Invalid data type. Accepts string, ReadableStream, ArrayBufferLike, or GeoJSON FeatureCollection.",
+  );
 }

package/test/entity-to-feature.test.ts

@@ -1,65 +1,62 @@
-import { describe, expect, it } from "bun:test"
-import type { OsmNode, OsmRelation, OsmWay } from "@osmix/shared/types"
-import {
-	nodeToFeature,
-	relationToFeature,
-	wayToFeature,
-} from "../src/entity-to-feature"
+import type { OsmNode, OsmRelation, OsmWay } from "@osmix/types";
+import { describe, expect, it } from "vitest";
+
+import { nodeToFeature, relationToFeature, wayToFeature } from "../src/entity-to-feature";
 
 describe("geojson helpers", () => {
-	const node0: OsmNode = { id: 1, lat: 0, lon: 0, tags: { amenity: "cafe" } }
-	const node1: OsmNode = { id: 2, lat: 1, lon: 1 }
-	const nodes: OsmNode[] = [node0, node1]
-	const nodeMap = new Map(nodes.map((n) => [n.id, n]))
-	const refToPosition = (id: number) => {
-		const node = nodeMap.get(id)
-		if (!node) throw new Error(`Node ${id} not found`)
-		return [node.lon, node.lat] as [number, number]
-	}
+  const node0: OsmNode = { id: 1, lat: 0, lon: 0, tags: { amenity: "cafe" } };
+  const node1: OsmNode = { id: 2, lat: 1, lon: 1 };
+  const nodes: OsmNode[] = [node0, node1];
+  const nodeMap = new Map(nodes.map((n) => [n.id, n]));
+  const refToPosition = (id: number) => {
+    const node = nodeMap.get(id);
+    if (!node) throw new Error(`Node ${id} not found`);
+    return [node.lon, node.lat] as [number, number];
+  };
 
-	it("converts node to GeoJSON Point", () => {
-		const feature = nodeToFeature(node0)
-		expect(feature.type).toBe("Feature")
-		expect(feature.geometry.type).toBe("Point")
-		expect(feature.geometry.coordinates).toEqual([node0.lon, node0.lat])
-		expect(feature.properties).toEqual({
-			id: node0.id,
-			type: "node",
-			...node0.tags,
-			...node0.info,
-		})
-	})
+  it("converts node to GeoJSON Point", () => {
+    const feature = nodeToFeature(node0);
+    expect(feature.type).toBe("Feature");
+    expect(feature.geometry.type).toBe("Point");
+    expect(feature.geometry.coordinates).toEqual([node0.lon, node0.lat]);
+    expect(feature.properties).toEqual({
+      id: node0.id,
+      type: "node",
+      ...node0.tags,
+      ...node0.info,
+    });
+  });
 
-	it("creates polygon for closed ways", () => {
-		const way: OsmWay = {
-			id: 10,
-			refs: [1, 2, 1],
-			tags: { area: "yes" },
-		}
-		const feature = wayToFeature(way, refToPosition)
-		expect(feature.geometry.type).toBe("Polygon")
-	})
+  it("creates polygon for closed ways", () => {
+    const way: OsmWay = {
+      id: 10,
+      refs: [1, 2, 1],
+      tags: { area: "yes" },
+    };
+    const feature = wayToFeature(way, refToPosition);
+    expect(feature.geometry.type).toBe("Polygon");
+  });
 
-	it("builds relation geometry collection", () => {
-		// Create a way that forms a closed ring
-		const way: OsmWay = {
-			id: 10,
-			refs: [1, 2, 1], // Closed way
-			tags: { area: "yes" },
-		}
-		const wayMap = new Map([[way.id, way]])
-		const getWay = (wayId: number) => wayMap.get(wayId) ?? null
+  it("builds relation geometry collection", () => {
+    // Create a way that forms a closed ring
+    const way: OsmWay = {
+      id: 10,
+      refs: [1, 2, 1], // Closed way
+      tags: { area: "yes" },
+    };
+    const wayMap = new Map([[way.id, way]]);
+    const getWay = (wayId: number) => wayMap.get(wayId) ?? null;
 
-		const relation: OsmRelation = {
-			id: 20,
-			members: [{ type: "way", ref: 10, role: "outer" }],
-			tags: { type: "multipolygon" },
-		}
-		const feature = relationToFeature(relation, refToPosition, getWay)
-		expect(feature.geometry.type).toBe("Polygon")
-		if (feature.geometry.type === "Polygon") {
-			expect(feature.geometry.coordinates?.[0]).toBeDefined()
-			expect(feature.geometry.coordinates[0]).toHaveLength(3) // Should have 3 coordinates (closed ring)
-		}
-	})
-})
+    const relation: OsmRelation = {
+      id: 20,
+      members: [{ type: "way", ref: 10, role: "outer" }],
+      tags: { type: "multipolygon" },
+    };
+    const feature = relationToFeature(relation, refToPosition, getWay);
+    expect(feature.geometry.type).toBe("Polygon");
+    if (feature.geometry.type === "Polygon") {
+      expect(feature.geometry.coordinates?.[0]).toBeDefined();
+      expect(feature.geometry.coordinates[0]).toHaveLength(3); // Should have 3 coordinates (closed ring)
+    }
+  });
+});

package/test/no-shared-array-buffer.test.ts

@@ -0,0 +1,31 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+describe("GeoJSON without SharedArrayBuffer", () => {
+  afterEach(() => {
+    vi.unstubAllGlobals();
+    vi.resetModules();
+  });
+
+  it("reads binary GeoJSON into ArrayBuffer-backed indexes", async () => {
+    vi.stubGlobal("SharedArrayBuffer", undefined);
+    vi.resetModules();
+
+    const { fromGeoJSON } = await import("../src/osm-from-geojson.ts");
+    const input = new TextEncoder().encode(
+      JSON.stringify({
+        type: "FeatureCollection",
+        features: [
+          {
+            type: "Feature",
+            geometry: { type: "Point", coordinates: [115.2167, -8.65] },
+            properties: { name: "Denpasar" },
+          },
+        ],
+      }),
+    ).buffer;
+
+    const osm = await fromGeoJSON(input);
+
+    expect(osm.nodes.getById(-1)?.tags?.["name"]).toBe("Denpasar");
+  });
+});