@osmix/pbf 0.0.2 → 0.0.3

package/dist/test/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,MAAM,wBAAwB,CAAA;AAE/B,wBAAsB,gBAAgB,CACrC,GAAG,EAAE;IACJ,MAAM,EAAE,iBAAiB,CAAA;IACzB,MAAM,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;CACnC,EACD,GAAG,EAAE,UAAU;;;;;;;GAgBf;AAED,wBAAgB,sBAAsB;qBAUb,WAAW;;;;;;;;;EAuBnC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../test/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7D,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,MAAM,wBAAwB,CAAA;AAE/B,wBAAsB,gBAAgB,CACrC,GAAG,EAAE;IACJ,MAAM,EAAE,iBAAiB,CAAA;IACzB,MAAM,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;CACnC,EACD,GAAG,EAAE,UAAU;;;;;;;GAgBf;AAED,wBAAgB,sBAAsB;qBAUb,WAAW;;;;;;;;;EAuBnC"}

package/dist/test/utils.js

@@ -1,16 +1,16 @@
-import { assert } from "vitest";
+import { expect } from "bun:test";
 export async function testOsmPbfReader(osm, pbf) {
-    assert.deepEqual(osm.header.bbox, pbf.bbox);
+    expect(osm.header.bbox).toEqual(pbf.bbox);
     const { onGroup, count } = createOsmEntityCounter();
     for await (const block of osm.blocks)
         for (const group of block.primitivegroup)
             onGroup(group);
-    assert.equal(count.nodes, pbf.nodes);
-    assert.equal(count.ways, pbf.ways);
-    assert.equal(count.relations, pbf.relations);
-    assert.equal(count.node0, pbf.node0.id);
-    assert.equal(count.way0, pbf.way0);
-    assert.equal(count.relation0, pbf.relation0);
+    expect(count.nodes).toBe(pbf.nodes);
+    expect(count.ways).toBe(pbf.ways);
+    expect(count.relations).toBe(pbf.relations);
+    expect(count.node0).toBe(pbf.node0.id);
+    expect(count.way0).toBe(pbf.way0);
+    expect(count.relation0).toBe(pbf.relation0);
     return count;
 }
 export function createOsmEntityCounter() {

package/dist/test/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../test/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAO/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,GAGC,EACD,GAAe;IAEf,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAE3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,sBAAsB,EAAE,CAAA;IACnD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM;QACnC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc;YAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAEzD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;IACpC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAClC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IAC5C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACvC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAClC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IAE5C,OAAO,KAAK,CAAA;AACb,CAAC;AAED,MAAM,UAAU,sBAAsB;IACrC,MAAM,KAAK,GAAG;QACb,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC,CAAC;QACT,IAAI,EAAE,CAAC,CAAC;QACR,SAAS,EAAE,CAAC,CAAC;KACb,CAAA;IAED,MAAM,OAAO,GAAG,CAAC,KAAkB,EAAE,EAAE;QACtC,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACxD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAChC,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC9B,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACxC,CAAC;QAED,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAA;QACvC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAA;QACrC,CAAC;QACD,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAA;QACrC,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,CAAA;IAChD,CAAC,CAAA;IAED,OAAO;QACN,OAAO;QACP,KAAK;KACL,CAAA;AACF,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAQjC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,GAGC,EACD,GAAe;IAEf,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEzC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,sBAAsB,EAAE,CAAA;IACnD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM;QACnC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc;YAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAEzD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAC3C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAE3C,OAAO,KAAK,CAAA;AACb,CAAC;AAED,MAAM,UAAU,sBAAsB;IACrC,MAAM,KAAK,GAAG;QACb,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC,CAAC;QACT,IAAI,EAAE,CAAC,CAAC;QACR,SAAS,EAAE,CAAC,CAAC;KACb,CAAA;IAED,MAAM,OAAO,GAAG,CAAC,KAAkB,EAAE,EAAE;QACtC,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACxD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAChC,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC9B,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACxC,CAAC;QAED,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAA;QACvC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAA;QACrC,CAAC;QACD,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAA;QACrC,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,CAAA;IAChD,CAAC,CAAA;IAED,OAAO;QACN,OAAO;QACP,KAAK;KACL,CAAA;AACF,CAAC"}

package/dist/test/utils.test.js

@@ -1,12 +1,12 @@
-import { assert, describe, expect, it } from "vitest";
+import { describe, expect, it } from "bun:test";
 import { concatUint8, toAsyncGenerator, uint32BE, webCompress, webDecompress, } from "../src/utils";
 describe("utils", () => {
     it("wraps values into an async generator", async () => {
         const generator = toAsyncGenerator(3);
         const first = await generator.next();
-        assert.deepEqual(first, { value: 3, done: false });
+        expect(first).toEqual({ value: 3, done: false });
         const done = await generator.next();
-        assert.deepEqual(done, { value: undefined, done: true });
+        expect(done).toEqual({ value: undefined, done: true });
     });
     it("consumes readable streams", async () => {
         const stream = new ReadableStream({
@@ -19,7 +19,7 @@ describe("utils", () => {
         const values = [];
         for await (const value of toAsyncGenerator(stream))
             values.push(value);
-        assert.deepEqual(values, [1, 2]);
+        expect(values).toEqual([1, 2]);
     });
     it("throws on nullish inputs", async () => {
         const invalidInput = null;
@@ -28,17 +28,17 @@ describe("utils", () => {
     it("concatenates Uint8Array segments", () => {
         const a = Uint8Array.of(1, 2);
         const b = Uint8Array.of(3);
-        assert.deepEqual(concatUint8(a, b), Uint8Array.of(1, 2, 3));
+        expect(concatUint8(a, b)).toEqual(Uint8Array.of(1, 2, 3));
     });
     it("encodes big-endian 32-bit integers", () => {
-        assert.deepEqual(uint32BE(0x01020304), Uint8Array.of(1, 2, 3, 4));
+        expect(uint32BE(0x01020304)).toEqual(Uint8Array.of(1, 2, 3, 4));
     });
     it("compresses and decompresses data", async () => {
         const input = new TextEncoder().encode("osmix");
         const compressed = await webCompress(input);
-        assert.notDeepEqual(compressed, input);
+        expect(compressed).not.toEqual(input);
         const decompressed = await webDecompress(compressed);
-        assert.deepEqual(decompressed, input);
+        expect(decompressed).toEqual(input);
     });
 });
 //# sourceMappingURL=utils.test.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../../test/utils.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACrD,OAAO,EACN,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,aAAa,GACb,MAAM,cAAc,CAAA;AAErB,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QACpC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;QAClD,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAS;YACzC,KAAK,CAAC,UAAU;gBACf,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;gBACrB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;gBACrB,UAAU,CAAC,KAAK,EAAE,CAAA;YACnB,CAAC;SACD,CAAC,CAAA;QACF,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACtE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACjC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,YAAY,GAAG,IAAwB,CAAA;QAC7C,MAAM,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAClE,eAAe,CACf,CAAA;IACF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1B,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAA4B,CAAA;QAC1E,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,CAAA;QAC3C,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACtC,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAA;QACpD,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;IACtC,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}
+{"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;AAC/C,OAAO,EACN,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,aAAa,GACb,MAAM,cAAc,CAAA;AAErB,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QACpC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;QAChD,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAS;YACzC,KAAK,CAAC,UAAU;gBACf,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;gBACrB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;gBACrB,UAAU,CAAC,KAAK,EAAE,CAAA;YACnB,CAAC;SACD,CAAC,CAAA;QACF,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACtE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC/B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,YAAY,GAAG,IAAwB,CAAA;QAC7C,MAAM,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAClE,eAAe,CACf,CAAA;IACF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1B,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC1D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAA4B,CAAA;QAC1E,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,CAAA;QAC3C,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACrC,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAA;QACpD,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/test/write.test.js

@@ -1,6 +1,6 @@
+import { describe, expect, it } from "bun:test";
 import { unlink } from "node:fs/promises";
 import { getFixtureFile, getFixtureFileReadStream, getFixtureFileWriteStream, getFixturePath, PBFs, } from "@osmix/shared/test/fixtures";
-import { assert, describe, it } from "vitest";
 import { OsmBlocksToPbfBytesTransformStream, osmBlockToPbfBlobBytes, } from "../src/blocks-to-pbf";
 import { OsmPbfBytesToBlocksTransformStream, readOsmPbf, } from "../src/pbf-to-blocks";
 import { testOsmPbfReader } from "./utils";
@@ -36,14 +36,19 @@ describe("write", () => {
                 write(await osmBlockToPbfBlobBytes(block));
             }
             // Re-parse the new PBF and test
-            assert.exists(data.buffer);
-            // TODO: assert.equal(stream.buffer.byteLength, fileData.byteLength)
+            expect(data.buffer).toBeDefined();
+            // Note: We don't assert byte-level equality because the written PBF may have
+            // different compression, block ordering, or encoding than the original file.
+            // Semantic equivalence (verified by parsing and comparing entities) is more meaningful.
             const osm2 = await readOsmPbf(data);
-            assert.deepEqual(osm.header, osm2.header);
+            expect(osm.header).toEqual(osm2.header);
             const entities = await testOsmPbfReader(osm2, pbf);
-            assert.equal(entities.node0, node0);
-            assert.equal(entities.way0, way0);
-            assert.equal(entities.relation0, relation0);
+            if (node0 === null || way0 === null || relation0 === null) {
+                throw new Error("Expected node0, way0, and relation0 to be set");
+            }
+            expect(entities.node0).toBe(node0);
+            expect(entities.way0).toBe(way0);
+            expect(entities.relation0).toBe(relation0);
         });
         it("to file", async () => {
             const testFileName = `${name}-write-test.pbf`;
@@ -55,7 +60,7 @@ describe("write", () => {
                 .pipeTo(fileWriteStream);
             const testFileData = await getFixtureFile(pbf.url);
             const testOsm = await readOsmPbf(testFileData);
-            assert.deepEqual(testOsm.header.bbox, pbf.bbox);
+            expect(testOsm.header.bbox).toEqual(pbf.bbox);
             await testOsmPbfReader(testOsm, pbf);
             await unlink(getFixturePath(testFileName));
         });

package/dist/test/write.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"write.test.js","sourceRoot":"","sources":["../../test/write.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EACN,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,IAAI,GACJ,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EACN,kCAAkC,EAClC,sBAAsB,GACtB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACN,kCAAkC,EAClC,UAAU,GACV,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACtB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACvD,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC9C,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAA;YAEtC,IAAI,KAAK,GAAkB,IAAI,CAAA;YAC/B,IAAI,IAAI,GAAkB,IAAI,CAAA;YAC9B,IAAI,SAAS,GAAkB,IAAI,CAAA;YAEnC,mCAAmC;YACnC,IAAI,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;YAC5B,MAAM,KAAK,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACnC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;gBAC1D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACjB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC/B,IAAI,GAAG,OAAO,CAAA;YACf,CAAC,CAAA;YAED,KAAK,CAAC,MAAM,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;YAC/C,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACtC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;oBAC1C,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;wBACnD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;oBAC1B,CAAC;oBACD,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;wBACjD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;oBACxB,CAAC;oBACD,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;wBAC3D,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;oBAClC,CAAC;gBACF,CAAC;gBACD,KAAK,CAAC,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3C,CAAC;YAED,gCAAgC;YAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAC1B,oEAAoE;YACpE,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;YAEnC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;YACzC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAClD,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACnC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACjC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YACxB,MAAM,YAAY,GAAG,GAAG,IAAI,iBAAiB,CAAA;YAC7C,MAAM,UAAU,GAAG,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAEpD,MAAM,eAAe,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAA;YAC/D,MAAM,UAAU;iBACd,WAAW,CAAC,IAAI,kCAAkC,EAAE,CAAC;iBACrD,WAAW,CAAC,IAAI,kCAAkC,EAAE,CAAC;iBACrD,MAAM,CAAC,eAAe,CAAC,CAAA;YAEzB,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAClD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAA;YAE9C,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;YAC/C,MAAM,gBAAgB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;YAEpC,MAAM,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}
+{"version":3,"file":"write.test.js","sourceRoot":"","sources":["../../test/write.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EACN,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,IAAI,GACJ,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACN,kCAAkC,EAClC,sBAAsB,GACtB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACN,kCAAkC,EAClC,UAAU,GACV,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACtB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACvD,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC9C,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAA;YAEtC,IAAI,KAAK,GAAkB,IAAI,CAAA;YAC/B,IAAI,IAAI,GAAkB,IAAI,CAAA;YAC9B,IAAI,SAAS,GAAkB,IAAI,CAAA;YAEnC,mCAAmC;YACnC,IAAI,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;YAC5B,MAAM,KAAK,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACnC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;gBAC1D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACjB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC/B,IAAI,GAAG,OAAO,CAAA;YACf,CAAC,CAAA;YAED,KAAK,CAAC,MAAM,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;YAC/C,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACtC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;oBAC1C,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;wBACnD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;oBAC1B,CAAC;oBACD,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;wBACjD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;oBACxB,CAAC;oBACD,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;wBAC3D,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;oBAClC,CAAC;gBACF,CAAC;gBACD,KAAK,CAAC,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3C,CAAC;YAED,gCAAgC;YAChC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;YACjC,6EAA6E;YAC7E,6EAA6E;YAC7E,wFAAwF;YACxF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;YAEnC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACvC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAClD,IAAI,KAAK,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;YACjE,CAAC;YACD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YACxB,MAAM,YAAY,GAAG,GAAG,IAAI,iBAAiB,CAAA;YAC7C,MAAM,UAAU,GAAG,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAEpD,MAAM,eAAe,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAA;YAC/D,MAAM,UAAU;iBACd,WAAW,CAAC,IAAI,kCAAkC,EAAE,CAAC;iBACrD,WAAW,CAAC,IAAI,kCAAkC,EAAE,CAAC;iBACrD,MAAM,CAAC,eAAe,CAAC,CAAA;YAEzB,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAClD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAA;YAE9C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YAC7C,MAAM,gBAAgB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;YAEpC,MAAM,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/package.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json.schemastore.org/package",
 	"name": "@osmix/pbf",
 	"description": "A low level, modern, runtime agnostic OSM PBF parser and writer written in TypeScript.",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"main": "./src/index.ts",
 	"publishConfig": {
@@ -32,17 +32,16 @@
 	},
 	"sideEffects": false,
 	"scripts": {
-		"bench": "vitest bench",
+		"bench": "bun test --bench",
 		"build": "tsc",
 		"prepublishOnly": "tsc",
-		"test": "vitest",
-		"typecheck": "tsc --noEmit"
+		"test": "bun test",
+		"typecheck": "tsgo --noEmit"
 	},
 	"devDependencies": {
 		"@osmix/shared": "workspace:*",
-		"@types/node": "catalog:",
-		"typescript": "catalog:",
-		"vitest": "catalog:"
+		"@types/bun": "catalog:",
+		"typescript": "catalog:"
 	},
 	"dependencies": {
 		"pbf": "catalog:"

package/src/blobs-to-blocks.ts

@@ -1,10 +1,47 @@
+/**
+ * Blob-to-block conversion utilities.
+ *
+ * Handles decompression and protobuf decoding of raw OSM PBF blobs into
+ * typed header and primitive block structures.
+ *
+ * @module
+ */
+
 import Pbf from "pbf"
-import { readHeaderBlock, readPrimitiveBlock } from "./proto/osmformat"
+import {
+	type OsmPbfBlock,
+	type OsmPbfHeaderBlock,
+	readHeaderBlock,
+	readPrimitiveBlock,
+} from "./proto/osmformat"
 import { webDecompress } from "./utils"
 
 /**
- * Decompresses raw OSM PBF blobs and yields typed header and primitive blocks.
- * Expects the first blob to contain the file header and streams the rest as data blocks.
+ * Decompress and decode a stream of raw PBF blobs into typed blocks.
+ *
+ * This async generator handles the transition from compressed bytes to parsed
+ * protobuf structures. The first blob is always decoded as a header block;
+ * subsequent blobs are decoded as primitive blocks containing OSM entities.
+ *
+ * @param blobs - Async or sync generator yielding compressed blob payloads.
+ * @param decompress - Optional decompression function (defaults to Web Streams zlib).
+ * @yields Header block first, then primitive blocks.
+ *
+ * @example
+ * ```ts
+ * import { osmPbfBlobsToBlocksGenerator, createOsmPbfBlobGenerator } from "@osmix/pbf"
+ *
+ * const generateBlobs = createOsmPbfBlobGenerator()
+ * const blobsGen = (async function* () {
+ *   for await (const chunk of stream) {
+ *     yield* generateBlobs(chunk)
+ *   }
+ * })()
+ *
+ * for await (const block of osmPbfBlobsToBlocksGenerator(blobsGen)) {
+ *   // First iteration yields header, rest yield primitive blocks
+ * }
+ * ```
  */
 export async function* osmPbfBlobsToBlocksGenerator(
 	blobs:
@@ -16,13 +53,47 @@ export async function* osmPbfBlobsToBlocksGenerator(
 ) {
 	let headerRead = false
 	for await (const blob of blobs) {
-		const decompressedBlob = await decompress(blob)
-		const pbf = new Pbf(decompressedBlob)
 		if (!headerRead) {
 			headerRead = true
-			yield readHeaderBlock(pbf)
+			yield readOsmHeaderBlock(blob, decompress)
 		} else {
-			yield readPrimitiveBlock(pbf)
+			yield readOsmPrimitiveBlock(blob, decompress)
 		}
 	}
 }
+
+/**
+ * Decompress and parse a header block from a compressed blob.
+ *
+ * @param compressedBlob - Zlib-compressed protobuf header blob.
+ * @param decompress - Optional decompression function.
+ * @returns Parsed header block with required/optional features and bbox.
+ */
+export async function readOsmHeaderBlock(
+	compressedBlob: Uint8Array<ArrayBuffer>,
+	decompress: (
+		data: Uint8Array<ArrayBuffer>,
+	) => Promise<Uint8Array<ArrayBuffer>> = webDecompress,
+): Promise<OsmPbfHeaderBlock> {
+	const decompressedBlob = await decompress(compressedBlob)
+	const pbf = new Pbf(decompressedBlob)
+	return readHeaderBlock(pbf)
+}
+
+/**
+ * Decompress and parse a primitive block from a compressed blob.
+ *
+ * @param compressedBlob - Zlib-compressed protobuf primitive blob.
+ * @param decompress - Optional decompression function.
+ * @returns Parsed primitive block with string table and primitive groups.
+ */
+export async function readOsmPrimitiveBlock(
+	compressedBlob: Uint8Array<ArrayBuffer>,
+	decompress: (
+		data: Uint8Array<ArrayBuffer>,
+	) => Promise<Uint8Array<ArrayBuffer>> = webDecompress,
+): Promise<OsmPbfBlock> {
+	const decompressedBlob = await decompress(compressedBlob)
+	const pbf = new Pbf(decompressedBlob)
+	return readPrimitiveBlock(pbf)
+}

package/src/blocks-to-pbf.ts

@@ -1,3 +1,12 @@
+/**
+ * Block-to-PBF serialization utilities.
+ *
+ * Converts parsed OSM header and primitive blocks back into spec-compliant
+ * PBF byte sequences with proper framing, compression, and size validation.
+ *
+ * @module
+ */
+
 import Pbf from "pbf"
 import { writeBlob, writeBlobHeader } from "./proto/fileformat"
 import type { OsmPbfBlock, OsmPbfHeaderBlock } from "./proto/osmformat"
@@ -11,10 +20,26 @@ import {
 import { concatUint8, uint32BE, webCompress } from "./utils"
 
 /**
- * Serializes a header or primitive block into a spec-compliant compressed blob.
- * Automatically sets the blob type, compresses the payload, and enforces size guardrails.
+ * Serialize a header or primitive block into spec-compliant PBF bytes.
+ *
+ * Handles protobuf encoding, zlib compression, blob wrapping, and length prefixing.
+ * Validates output against OSM PBF specification size limits and logs warnings
+ * if recommended sizes are exceeded.
+ *
  * @param block - Parsed header or primitive block to encode.
- * @returns BlobHeader length prefix + Blob bytes as a single Uint8Array.
+ * @param compress - Optional compression function (defaults to Web Streams zlib).
+ * @returns Complete blob bytes: 4-byte length prefix + BlobHeader + Blob.
+ * @throws If blob exceeds maximum size limits (64 KiB header, 32 MiB data).
+ *
+ * @example
+ * ```ts
+ * import { osmBlockToPbfBlobBytes } from "@osmix/pbf"
+ *
+ * const headerBytes = await osmBlockToPbfBlobBytes({
+ *   required_features: ["OsmSchema-V0.6", "DenseNodes"],
+ *   optional_features: [],
+ * })
+ * ```
  */
 export async function osmBlockToPbfBlobBytes(
 	block: OsmPbfBlock | OsmPbfHeaderBlock,
@@ -76,8 +101,20 @@ export async function osmBlockToPbfBlobBytes(
 }
 
 /**
- * Web `TransformStream` that converts OSM header/data blocks into PBF byte chunks.
- * Throws if the header is not the first block and reuses `osmBlockToPbfBlobBytes` for encoding.
+ * Web `TransformStream` that encodes OSM blocks into PBF byte chunks.
+ *
+ * Accepts a stream of header and primitive blocks and outputs spec-compliant
+ * PBF bytes. The header block must be the first item in the stream.
+ *
+ * @throws If a primitive block is received before the header.
+ *
+ * @example
+ * ```ts
+ * import { OsmBlocksToPbfBytesTransformStream } from "@osmix/pbf"
+ *
+ * const pbfStream = blocksStream.pipeThrough(new OsmBlocksToPbfBytesTransformStream())
+ * await pbfStream.pipeTo(writableFile)
+ * ```
  */
 export class OsmBlocksToPbfBytesTransformStream extends TransformStream<
 	OsmPbfHeaderBlock | OsmPbfBlock,

package/src/index.ts

@@ -1,3 +1,32 @@
+/**
+ * @osmix/pbf - Low-level OSM PBF parsing and serialization.
+ *
+ * Provides streaming primitives for reading and writing OpenStreetMap PBF files
+ * using Web Streams and native compression APIs. Stays close to the official
+ * protobuf schema (`osmformat.proto`, `fileformat.proto`) while exposing
+ * predictable TypeScript types.
+ *
+ * Key capabilities:
+ * - **Parse**: Read headers and primitive blocks from `ArrayBuffer`, async iterables, or `ReadableStream`.
+ * - **Stream**: Use `TransformStream` helpers to process large files without buffering entirely in memory.
+ * - **Serialize**: Write header and primitive blocks back to spec-compliant blobs with size guardrails.
+ * - **Types**: Generated protobuf readers/writers and TypeScript interfaces for OSM data structures.
+ *
+ * @example
+ * ```ts
+ * import { readOsmPbf } from "@osmix/pbf"
+ *
+ * const { header, blocks } = await readOsmPbf(Bun.file('./monaco.pbf').stream())
+ * console.log(header.required_features)
+ *
+ * for await (const block of blocks) {
+ *   console.log(block.primitivegroup.length, "groups")
+ * }
+ * ```
+ *
+ * @module @osmix/pbf
+ */
+
 export * from "./blobs-to-blocks"
 export * from "./blocks-to-pbf"
 export * from "./pbf-to-blobs"

package/src/pbf-to-blobs.ts

@@ -7,9 +7,28 @@ import {
 } from "./proto/fileformat"
 
 /**
- * Creates a stateful parser that slices incoming bytes into compressed OSM PBF blobs.
- * Works with buffers, iterables, or streams and yields `Uint8Array` payloads ready to decompress.
- * The first blob represents the file header; subsequent blobs hold primitive data.
+ * Create a stateful parser that extracts compressed blobs from raw PBF bytes.
+ *
+ * OSM PBF files consist of length-prefixed blobs. This function returns a generator
+ * that accumulates incoming byte chunks and yields complete compressed blobs as they
+ * become available. The caller is responsible for decompression.
+ *
+ * The first yielded blob contains the file header; subsequent blobs contain primitive data.
+ *
+ * @returns A generator function that accepts byte chunks and yields compressed blob payloads.
+ *
+ * @example
+ * ```ts
+ * import { createOsmPbfBlobGenerator } from "@osmix/pbf"
+ *
+ * const generateBlobs = createOsmPbfBlobGenerator()
+ *
+ * for await (const chunk of stream) {
+ *   for (const compressedBlob of generateBlobs(chunk)) {
+ *     // Decompress and parse blob...
+ *   }
+ * }
+ * ```
  */
 export function createOsmPbfBlobGenerator() {
 	let pbf: Pbf = new Pbf(new Uint8Array(0))
@@ -19,6 +38,8 @@ export function createOsmPbfBlobGenerator() {
 
 	/**
 	 * Feed the parser with the next chunk of bytes and yield any complete compressed blobs.
+	 * @param chunk - Raw bytes from the PBF file.
+	 * @yields Compressed blob payloads (zlib-compressed protobuf data).
 	 */
 	return function* nextChunk(chunk: Uint8Array) {
 		const currentBuffer: Uint8Array = pbf.buf.slice(pbf.pos)

package/src/pbf-to-blocks.ts

@@ -13,11 +13,37 @@ import {
 	webDecompress,
 } from "./utils"
 
+/** Number of bytes used to encode the BlobHeader length prefix (big-endian uint32). */
 export const HEADER_LENGTH_BYTES = 4
 
 /**
- * Parses OSM PBF bytes from buffers, streams, or generators into header + block iterators.
- * Returns the decoded header and a lazy async generator of primitive blocks.
+ * Parse an OSM PBF file from various input sources.
+ *
+ * Accepts `ArrayBuffer`, `Uint8Array`, `ReadableStream<Uint8Array>`, or async generators.
+ * Returns the file header and a lazy async generator of primitive blocks for on-demand parsing.
+ *
+ * @param data - PBF bytes as buffer, stream, or async iterable.
+ * @returns Object with `header` (file metadata) and `blocks` (async generator of primitive blocks).
+ * @throws If the header block is missing or malformed.
+ *
+ * @example
+ * ```ts
+ * import { readOsmPbf } from "@osmix/pbf"
+ *
+ * // From a file stream
+ * const { header, blocks } = await readOsmPbf(Bun.file('./monaco.pbf').stream())
+ *
+ * // From a fetch response
+ * const response = await fetch('/data/monaco.pbf')
+ * const { header, blocks } = await readOsmPbf(response.body!)
+ *
+ * // Iterate blocks lazily
+ * for await (const block of blocks) {
+ *   for (const group of block.primitivegroup) {
+ *     console.log(group.dense?.id.length ?? 0, "dense nodes")
+ *   }
+ * }
+ * ```
  */
 export async function readOsmPbf(
 	data: AsyncGeneratorValue<Uint8Array<ArrayBufferLike>>,
@@ -43,8 +69,24 @@ export async function readOsmPbf(
 }
 
 /**
- * Web `TransformStream` that turns raw PBF byte chunks into OSM header/data blocks.
- * Assumes the first decoded blob carries the header and emits it before any primitive blocks.
+ * Web `TransformStream` that decodes raw PBF byte chunks into OSM header and data blocks.
+ *
+ * The first blob in an OSM PBF file is always the header block; subsequent blobs
+ * contain primitive data (nodes, ways, relations). This stream handles the framing,
+ * decompression, and protobuf decoding automatically.
+ *
+ * @example
+ * ```ts
+ * import { OsmPbfBytesToBlocksTransformStream } from "@osmix/pbf"
+ *
+ * const response = await fetch('/data/monaco.pbf')
+ * const blocksStream = response.body!
+ *   .pipeThrough(new OsmPbfBytesToBlocksTransformStream())
+ *
+ * const reader = blocksStream.getReader()
+ * const { value: header } = await reader.read() // First read yields header
+ * // Subsequent reads yield primitive blocks
+ * ```
  */
 export class OsmPbfBytesToBlocksTransformStream extends TransformStream<
 	Uint8Array<ArrayBufferLike>,

package/src/utils.ts

@@ -38,30 +38,12 @@ export async function* toAsyncGenerator<T>(
 	}
 }
 
-/**
- * Returns true when executing inside the Bun runtime.
- */
-export function isBun(): boolean {
-	return "Bun" in globalThis
-}
-
 /**
  * Web decompression stream
  */
 export async function webDecompress(
 	data: Uint8Array<ArrayBuffer>,
 ): Promise<Uint8Array<ArrayBuffer>> {
-	if (isBun()) {
-		// @ts-ignore Only used in Bun runtime.
-		const { inflate } = await import("node:zlib")
-		const result = await new Promise<Uint8Array>((resolve, reject) => {
-			inflate(data, (error: unknown, result: Uint8Array) => {
-				if (error) reject(error)
-				else resolve(new Uint8Array(result))
-			})
-		})
-		return result as unknown as Uint8Array<ArrayBuffer>
-	}
 	return transformBytes(data, new DecompressionStream("deflate"))
 }
 
@@ -71,17 +53,6 @@ export async function webDecompress(
 export async function webCompress(
 	data: Uint8Array<ArrayBuffer>,
 ): Promise<Uint8Array<ArrayBuffer>> {
-	if (isBun()) {
-		// @ts-ignore Only used in Bun runtime.
-		const { deflate } = await import("node:zlib")
-		const result = await new Promise<Uint8Array>((resolve, reject) => {
-			deflate(data, (error: unknown, result: Uint8Array) => {
-				if (error) reject(error)
-				else resolve(new Uint8Array(result))
-			})
-		})
-		return result as unknown as Uint8Array<ArrayBuffer>
-	}
 	return transformBytes(data, new CompressionStream("deflate"))
 }
 

package/test/blobs-to-blocks.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, it } from "vitest"
+import { describe, expect, it } from "bun:test"
 import { osmPbfBlobsToBlocksGenerator } from "../src/blobs-to-blocks"
 import { createOsmPbfBlobGenerator } from "../src/pbf-to-blobs"
 import {
@@ -25,32 +25,38 @@ describe("osmPbfBlobsToBlocksGenerator", () => {
 		)
 
 		const { value: headerBlock, done } = await generator.next()
-		assert.isFalse(done)
+		expect(done).toBe(false)
 		if (!isHeaderBlock(headerBlock)) {
-			assert.fail("Expected header block")
+			throw new Error("Expected header block")
 		}
-		assert.deepEqual(headerBlock.bbox, header.bbox)
-		assert.deepEqual(headerBlock.required_features, header.required_features)
-		assert.deepEqual(headerBlock.optional_features, header.optional_features)
+		expect(headerBlock.bbox).toEqual(header.bbox)
+		expect(headerBlock.required_features).toEqual(header.required_features)
+		expect(headerBlock.optional_features).toEqual(header.optional_features)
 
 		const { value: block, done: blockDone } = await generator.next()
-		assert.isFalse(blockDone)
+		expect(blockDone).toBe(false)
 		if (!isPrimitiveBlock(block)) {
-			assert.fail("Expected primitive block")
+			throw new Error("Expected primitive block")
 		}
-		assert.lengthOf(block.primitivegroup, primitiveBlock.primitivegroup.length)
+		expect(block.primitivegroup).toHaveLength(
+			primitiveBlock.primitivegroup.length,
+		)
 		const group = block.primitivegroup[0]
-		assert.exists(primitiveBlock.primitivegroup[0])
-		assert.exists(group?.dense)
-		assert.exists(group?.ways?.[0])
-		assert.lengthOf(group.ways, primitiveBlock.primitivegroup[0].ways.length)
-		assert.deepEqual(
-			group.ways[0].refs,
+		expect(primitiveBlock.primitivegroup[0]).toBeDefined()
+		expect(group?.dense).toBeDefined()
+		expect(group?.ways?.[0]).toBeDefined()
+		if (!group) throw new Error("group is undefined")
+		if (!primitiveBlock.primitivegroup[0])
+			throw new Error("primitiveBlock.primitivegroup[0] is undefined")
+		expect(group.ways).toHaveLength(
+			primitiveBlock.primitivegroup[0].ways.length,
+		)
+		expect(group.ways[0]?.refs).toEqual(
 			primitiveBlock.primitivegroup[0]?.ways?.[0]?.refs,
 		)
 
 		const final = await generator.next()
-		assert.isTrue(final.done)
+		expect(final.done).toBe(true)
 	})
 
 	it("accepts synchronous generators", async () => {
@@ -64,10 +70,10 @@ describe("osmPbfBlobsToBlocksGenerator", () => {
 		)
 
 		const header = await generator.next()
-		assert.isFalse(header.done)
+		expect(header.done).toBe(false)
 		const block = await generator.next()
-		assert.isFalse(block.done)
+		expect(block.done).toBe(false)
 		const final = await generator.next()
-		assert.isTrue(final.done)
+		expect(final.done).toBe(true)
 	})
 })