@osmix/pbf 0.0.5 → 0.0.7

package/dist/src/blocks-to-pbf.js

@@ -1,110 +0,0 @@
-/**
- * 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 { writeHeaderBlock, writePrimitiveBlock } from "./proto/osmformat";
-import { MAX_BLOB_SIZE_BYTES, MAX_HEADER_SIZE_BYTES, RECOMMENDED_BLOB_SIZE_BYTES, RECOMMENDED_HEADER_SIZE_BYTES, } from "./spec";
-import { concatUint8, uint32BE, webCompress } from "./utils";
-/**
- * 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.
- * @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, compress = webCompress) {
-    const contentPbf = new Pbf();
-    let type;
-    if ("primitivegroup" in block) {
-        type = "OSMData";
-        writePrimitiveBlock(block, contentPbf);
-    }
-    else {
-        type = "OSMHeader";
-        writeHeaderBlock(block, contentPbf);
-    }
-    const contentData = contentPbf.finish();
-    const raw_size = contentData.length;
-    const compressedBuffer = await compress(contentData);
-    const blobPbf = new Pbf();
-    writeBlob({
-        raw_size,
-        zlib_data: compressedBuffer,
-    }, blobPbf);
-    const blob = blobPbf.finish();
-    const blobHeaderPbf = new Pbf();
-    writeBlobHeader({
-        type,
-        datasize: blob.length,
-    }, blobHeaderPbf);
-    const blobHeader = blobHeaderPbf.finish();
-    const blobHeaderSize = uint32BE(blobHeader.byteLength);
-    // Check the BlobHeader and Blob sizes, log error if over the recommended size, throw error if over the maximum size
-    if (blobHeader.byteLength > RECOMMENDED_HEADER_SIZE_BYTES) {
-        const sizeKiB = (blobHeader.byteLength / 1024).toFixed(2);
-        if (blobHeader.byteLength > MAX_HEADER_SIZE_BYTES) {
-            throw new Error(`BlobHeader is ${sizeKiB} KiB, the maximum size is 64KiB`);
-        }
-        console.warn(`BlobHeader is ${sizeKiB} KiB, the recommended size is 32KiB`);
-    }
-    if (blob.byteLength > RECOMMENDED_BLOB_SIZE_BYTES) {
-        const sizeMiB = (blob.byteLength / 1024 / 1024).toFixed(2);
-        if (blob.byteLength > MAX_BLOB_SIZE_BYTES) {
-            throw new Error(`Blob is ${sizeMiB} MiB, the maximum size is 32MiB`);
-        }
-        console.warn(`Blob is ${sizeMiB} MiB, the recommended size is 16MiB`);
-    }
-    return concatUint8(blobHeaderSize, blobHeader, blob);
-}
-/**
- * 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 {
-    headerEnqueued = false;
-    constructor() {
-        super({
-            transform: async (block, controller) => {
-                if ("primitivegroup" in block && !this.headerEnqueued) {
-                    throw Error("Header first in ReadableStream of blocks.");
-                }
-                this.headerEnqueued = true;
-                controller.enqueue(await osmBlockToPbfBlobBytes(block));
-            },
-        });
-    }
-}
-//# sourceMappingURL=blocks-to-pbf.js.map

package/dist/src/blocks-to-pbf.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blocks-to-pbf.js","sourceRoot":"","sources":["../../src/blocks-to-pbf.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAE/D,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACzE,OAAO,EACN,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,6BAA6B,GAC7B,MAAM,QAAQ,CAAA;AACf,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE5D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC3C,KAAsC,EACtC,WAEwC,WAAW;IAEnD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAA;IAC5B,IAAI,IAA6B,CAAA;IACjC,IAAI,gBAAgB,IAAI,KAAK,EAAE,CAAC;QAC/B,IAAI,GAAG,SAAS,CAAA;QAChB,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IACvC,CAAC;SAAM,CAAC;QACP,IAAI,GAAG,WAAW,CAAA;QAClB,gBAAgB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IACpC,CAAC;IACD,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,EAA6B,CAAA;IAClE,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAA;IACnC,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAA;IAEpD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IACzB,SAAS,CACR;QACC,QAAQ;QACR,SAAS,EAAE,gBAAgB;KAC3B,EACD,OAAO,CACP,CAAA;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,CAAA;IAE7B,MAAM,aAAa,GAAG,IAAI,GAAG,EAAE,CAAA;IAC/B,eAAe,CACd;QACC,IAAI;QACJ,QAAQ,EAAE,IAAI,CAAC,MAAM;KACrB,EACD,aAAa,CACb,CAAA;IACD,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,EAAE,CAAA;IACzC,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IAEtD,oHAAoH;IACpH,IAAI,UAAU,CAAC,UAAU,GAAG,6BAA6B,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,CAAC,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QACzD,IAAI,UAAU,CAAC,UAAU,GAAG,qBAAqB,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,iBAAiB,OAAO,iCAAiC,CAAC,CAAA;QAC3E,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,iBAAiB,OAAO,qCAAqC,CAAC,CAAA;IAC5E,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,GAAG,2BAA2B,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC1D,IAAI,IAAI,CAAC,UAAU,GAAG,mBAAmB,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,iCAAiC,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,qCAAqC,CAAC,CAAA;IACtE,CAAC;IAED,OAAO,WAAW,CAAC,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;AACrD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,kCAAmC,SAAQ,eAGvD;IACA,cAAc,GAAG,KAAK,CAAA;IACtB;QACC,KAAK,CAAC;YACL,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBACtC,IAAI,gBAAgB,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;oBACvD,MAAM,KAAK,CAAC,2CAA2C,CAAC,CAAA;gBACzD,CAAC;gBACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;gBAC1B,UAAU,CAAC,OAAO,CAAC,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAA;YACxD,CAAC;SACD,CAAC,CAAA;IACH,CAAC;CACD"}

package/dist/src/index.d.ts

@@ -1,37 +0,0 @@
-/**
- * @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";
-export * from "./pbf-to-blocks";
-export * from "./proto/fileformat";
-export * from "./proto/osmformat";
-export * from "./spec";
-export * from "./utils";
-//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}

package/dist/src/index.js

@@ -1,37 +0,0 @@
-/**
- * @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";
-export * from "./pbf-to-blocks";
-export * from "./proto/fileformat";
-export * from "./proto/osmformat";
-export * from "./spec";
-export * from "./utils";
-//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}

package/dist/src/pbf-to-blobs.d.ts

@@ -1,26 +0,0 @@
-/**
- * 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 declare function createOsmPbfBlobGenerator(): (chunk: Uint8Array) => Generator<Uint8Array<ArrayBuffer>, void, unknown>;
-//# sourceMappingURL=pbf-to-blobs.d.ts.map

package/dist/src/pbf-to-blobs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pbf-to-blobs.d.ts","sourceRoot":"","sources":["../../src/pbf-to-blobs.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,yBAAyB,KAWb,OAAO,UAAU,uDAiC5C"}

package/dist/src/pbf-to-blobs.js

@@ -1,70 +0,0 @@
-import Pbf from "pbf";
-import { HEADER_LENGTH_BYTES } from "./pbf-to-blocks";
-import { readBlob, readBlobHeader, } from "./proto/fileformat";
-/**
- * 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 = new Pbf(new Uint8Array(0));
-    let state = "header-length";
-    let bytesNeeded = HEADER_LENGTH_BYTES;
-    let blobHeader = null;
-    /**
-     * 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) {
-        const currentBuffer = pbf.buf.slice(pbf.pos);
-        const tmpBuffer = new Uint8Array(currentBuffer.buffer.byteLength + chunk.byteLength);
-        tmpBuffer.set(currentBuffer.subarray(0));
-        tmpBuffer.set(new Uint8Array(chunk), currentBuffer.byteLength);
-        pbf = new Pbf(tmpBuffer);
-        while (pbf.pos + bytesNeeded <= pbf.length) {
-            if (state === "header-length") {
-                const dataView = new DataView(pbf.buf.buffer);
-                bytesNeeded = dataView.getInt32(pbf.pos, false); // network byte order
-                pbf.pos += HEADER_LENGTH_BYTES;
-                state = "header";
-            }
-            else if (state === "header") {
-                blobHeader = readBlobHeader(pbf, pbf.pos + bytesNeeded);
-                bytesNeeded = blobHeader.datasize;
-                state = "blob";
-            }
-            else if (state === "blob") {
-                if (blobHeader == null)
-                    throw Error("Blob header has not been read");
-                const blob = readBlob(pbf, pbf.pos + bytesNeeded);
-                if (blob.zlib_data === undefined || blob.zlib_data.length === 0)
-                    throw Error("Blob has no zlib data. Format is unsupported.");
-                yield blob.zlib_data;
-                state = "header-length";
-                bytesNeeded = HEADER_LENGTH_BYTES;
-                blobHeader = null;
-            }
-        }
-    };
-}
-//# sourceMappingURL=pbf-to-blobs.js.map

package/dist/src/pbf-to-blobs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pbf-to-blobs.js","sourceRoot":"","sources":["../../src/pbf-to-blobs.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAEN,QAAQ,EACR,cAAc,GACd,MAAM,oBAAoB,CAAA;AAE3B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,yBAAyB;IACxC,IAAI,GAAG,GAAQ,IAAI,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;IACzC,IAAI,KAAK,GAAwC,eAAe,CAAA;IAChE,IAAI,WAAW,GAAW,mBAAmB,CAAA;IAC7C,IAAI,UAAU,GAA4B,IAAI,CAAA;IAE9C;;;;OAIG;IACH,OAAO,QAAQ,CAAC,CAAC,SAAS,CAAC,KAAiB;QAC3C,MAAM,aAAa,GAAe,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACxD,MAAM,SAAS,GAAG,IAAI,UAAU,CAC/B,aAAa,CAAC,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAClD,CAAA;QACD,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACxC,SAAS,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;QAC9D,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;QAExB,OAAO,GAAG,CAAC,GAAG,GAAG,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YAC5C,IAAI,KAAK,KAAK,eAAe,EAAE,CAAC;gBAC/B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAC7C,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA,CAAC,qBAAqB;gBACrE,GAAG,CAAC,GAAG,IAAI,mBAAmB,CAAA;gBAC9B,KAAK,GAAG,QAAQ,CAAA;YACjB,CAAC;iBAAM,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/B,UAAU,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,WAAW,CAAC,CAAA;gBACvD,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAA;gBACjC,KAAK,GAAG,MAAM,CAAA;YACf,CAAC;iBAAM,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC7B,IAAI,UAAU,IAAI,IAAI;oBAAE,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAA;gBACpE,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,WAAW,CAAC,CAAA;gBACjD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;oBAC9D,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAA;gBAE7D,MAAM,IAAI,CAAC,SAAoC,CAAA;gBAE/C,KAAK,GAAG,eAAe,CAAA;gBACvB,WAAW,GAAG,mBAAmB,CAAA;gBACjC,UAAU,GAAG,IAAI,CAAA;YAClB,CAAC;QACF,CAAC;IACF,CAAC,CAAA;AACF,CAAC"}

package/dist/src/pbf-to-blocks.d.ts

@@ -1,63 +0,0 @@
-import { type OsmPbfBlock, type OsmPbfHeaderBlock } from "./proto/osmformat";
-import { type AsyncGeneratorValue } from "./utils";
-/** Number of bytes used to encode the BlobHeader length prefix (big-endian uint32). */
-export declare const HEADER_LENGTH_BYTES = 4;
-/**
- * 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 declare function readOsmPbf(data: AsyncGeneratorValue<Uint8Array<ArrayBufferLike>>): Promise<{
-    header: OsmPbfHeaderBlock;
-    blocks: AsyncGenerator<OsmPbfBlock>;
-}>;
-/**
- * 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 declare class OsmPbfBytesToBlocksTransformStream extends TransformStream<Uint8Array<ArrayBufferLike>, OsmPbfHeaderBlock | OsmPbfBlock> {
-    generateBlobsFromChunk: (chunk: Uint8Array) => Generator<Uint8Array<ArrayBuffer>, void, unknown>;
-    header: OsmPbfHeaderBlock | null;
-    constructor(decompress?: (data: Uint8Array<ArrayBuffer>) => Promise<Uint8Array<ArrayBuffer>>);
-}
-//# sourceMappingURL=pbf-to-blocks.d.ts.map

package/dist/src/pbf-to-blocks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pbf-to-blocks.d.ts","sourceRoot":"","sources":["../../src/pbf-to-blocks.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,KAAK,WAAW,EAChB,KAAK,iBAAiB,EAGtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACN,KAAK,mBAAmB,EAGxB,MAAM,SAAS,CAAA;AAEhB,uFAAuF;AACvF,eAAO,MAAM,mBAAmB,IAAI,CAAA;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,UAAU,CAC/B,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;;YAkBnC,cAAc,CAAC,WAAW,CAAC;GAE9C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,kCAAmC,SAAQ,eAAe,CACtE,UAAU,CAAC,eAAe,CAAC,EAC3B,iBAAiB,GAAG,WAAW,CAC/B;IACA,sBAAsB,2EAA8B;IACpD,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAO;gBAEtC,UAAU,GAAE,CACX,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,KACzB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAiB;CAiBtD"}

package/dist/src/pbf-to-blocks.js

@@ -1,96 +0,0 @@
-import Pbf from "pbf";
-import { osmPbfBlobsToBlocksGenerator } from "./blobs-to-blocks";
-import { createOsmPbfBlobGenerator } from "./pbf-to-blobs";
-import { readHeaderBlock, readPrimitiveBlock, } from "./proto/osmformat";
-import { toAsyncGenerator, webDecompress, } from "./utils";
-/** Number of bytes used to encode the BlobHeader length prefix (big-endian uint32). */
-export const HEADER_LENGTH_BYTES = 4;
-/**
- * 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) {
-    const generateBlobsFromChunk = createOsmPbfBlobGenerator();
-    const blocks = osmPbfBlobsToBlocksGenerator((async function* () {
-        for await (const chunk of toAsyncGenerator(data)) {
-            for await (const blob of generateBlobsFromChunk(chunk)) {
-                yield blob;
-            }
-        }
-    })());
-    const header = (await blocks.next()).value;
-    if (header == null || !("required_features" in header)) {
-        throw Error("OSM PBF header block not found");
-    }
-    return {
-        header,
-        blocks: 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 {
-    generateBlobsFromChunk = createOsmPbfBlobGenerator();
-    header = null;
-    constructor(decompress = webDecompress) {
-        super({
-            transform: async (bytesChunk, controller) => {
-                for await (const rawBlobs of this.generateBlobsFromChunk(bytesChunk)) {
-                    const decompressed = await decompress(rawBlobs);
-                    const pbf = new Pbf(decompressed);
-                    if (this.header == null) {
-                        this.header = readHeaderBlock(pbf);
-                        controller.enqueue(this.header);
-                    }
-                    else {
-                        controller.enqueue(readPrimitiveBlock(pbf));
-                    }
-                }
-            },
-        });
-    }
-}
-//# sourceMappingURL=pbf-to-blocks.js.map

package/dist/src/pbf-to-blocks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pbf-to-blocks.js","sourceRoot":"","sources":["../../src/pbf-to-blocks.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAGN,eAAe,EACf,kBAAkB,GAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAEN,gBAAgB,EAChB,aAAa,GACb,MAAM,SAAS,CAAA;AAEhB,uFAAuF;AACvF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAA;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,IAAsD;IAEtD,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAA;IAC1D,MAAM,MAAM,GAAG,4BAA4B,CAC1C,CAAC,KAAK,SAAS,CAAC;QACf,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxD,MAAM,IAAI,CAAA;YACX,CAAC;QACF,CAAC;IACF,CAAC,CAAC,EAAE,CACJ,CAAA;IACD,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAA;IAC1C,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,CAAC,mBAAmB,IAAI,MAAM,CAAC,EAAE,CAAC;QACxD,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAA;IAC9C,CAAC;IACD,OAAO;QACN,MAAM;QACN,MAAM,EAAE,MAAqC;KAC7C,CAAA;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,kCAAmC,SAAQ,eAGvD;IACA,sBAAsB,GAAG,yBAAyB,EAAE,CAAA;IACpD,MAAM,GAA6B,IAAI,CAAA;IACvC,YACC,aAEwC,aAAa;QAErD,KAAK,CAAC;YACL,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;gBAC3C,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;oBACtE,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAA;oBAC/C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAA;oBACjC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;wBACzB,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;wBAClC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oBAChC,CAAC;yBAAM,CAAC;wBACP,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;oBAC5C,CAAC;gBACF,CAAC;YACF,CAAC;SACD,CAAC,CAAA;IACH,CAAC;CACD"}

package/dist/src/proto/fileformat.d.ts

@@ -1,27 +0,0 @@
-import type Pbf from "pbf";
-export type OsmPbfBlob = {
-    raw_size?: number;
-    raw?: Uint8Array;
-    zlib_data?: Uint8Array;
-};
-export type OsmPbfBlobHeader = {
-    type: "OSMHeader" | "OSMData";
-    datasize: number;
-};
-/**
- * Reads an `OsmPbfBlob` message from the current position in the Pbf reader.
- */
-export declare function readBlob(pbf: Pbf, end?: number): OsmPbfBlob;
-/**
- * Writes an `OsmPbfBlob` message to the provided Pbf writer.
- */
-export declare function writeBlob(obj: OsmPbfBlob, pbf: Pbf): void;
-/**
- * Reads an `OsmPbfBlobHeader` from the current position in the Pbf reader.
- */
-export declare function readBlobHeader(pbf: Pbf, end?: number): OsmPbfBlobHeader;
-/**
- * Writes an `OsmPbfBlobHeader` message to the provided Pbf writer.
- */
-export declare function writeBlobHeader(obj: OsmPbfBlobHeader, pbf: Pbf): void;
-//# sourceMappingURL=fileformat.d.ts.map

package/dist/src/proto/fileformat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileformat.d.ts","sourceRoot":"","sources":["../../../src/proto/fileformat.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAA;AAE1B,MAAM,MAAM,UAAU,GAAG;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,SAAS,CAAC,EAAE,UAAU,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAQ3D;AAYD;;GAEG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,QAIlD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAMvE;AAQD;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,QAG9D"}

package/dist/src/proto/fileformat.js

@@ -1,57 +0,0 @@
-/**
- * Reads an `OsmPbfBlob` message from the current position in the Pbf reader.
- */
-export function readBlob(pbf, end) {
-    return pbf.readFields(readBlobField, {
-        raw_size: 0,
-    }, end);
-}
-/**
- * Dispatches individual Blob fields based on their protobuf tag.
- */
-function readBlobField(tag, obj, pbf) {
-    if (tag === 2)
-        obj.raw_size = pbf.readVarint(true);
-    else if (tag === 1) {
-        obj.raw = pbf.readBytes();
-    }
-    else if (tag === 3) {
-        obj.zlib_data = pbf.readBytes();
-    }
-}
-/**
- * Writes an `OsmPbfBlob` message to the provided Pbf writer.
- */
-export function writeBlob(obj, pbf) {
-    if (obj.raw_size)
-        pbf.writeVarintField(2, obj.raw_size);
-    if (obj.raw != null)
-        pbf.writeBytesField(1, obj.raw);
-    if (obj.zlib_data != null)
-        pbf.writeBytesField(3, obj.zlib_data);
-}
-/**
- * Reads an `OsmPbfBlobHeader` from the current position in the Pbf reader.
- */
-export function readBlobHeader(pbf, end) {
-    return pbf.readFields(readBlobHeaderField, { type: "OSMData", datasize: 0 }, end);
-}
-/**
- * Dispatches individual BlobHeader fields based on their protobuf tag.
- */
-function readBlobHeaderField(tag, obj, pbf) {
-    if (tag === 1)
-        obj.type = pbf.readString();
-    else if (tag === 3)
-        obj.datasize = pbf.readVarint(true);
-}
-/**
- * Writes an `OsmPbfBlobHeader` message to the provided Pbf writer.
- */
-export function writeBlobHeader(obj, pbf) {
-    if (obj.type)
-        pbf.writeStringField(1, obj.type);
-    if (obj.datasize)
-        pbf.writeVarintField(3, obj.datasize);
-}
-//# sourceMappingURL=fileformat.js.map

package/dist/src/proto/fileformat.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileformat.js","sourceRoot":"","sources":["../../../src/proto/fileformat.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAQ,EAAE,GAAY;IAC9C,OAAO,GAAG,CAAC,UAAU,CACpB,aAAa,EACb;QACC,QAAQ,EAAE,CAAC;KACX,EACD,GAAG,CACH,CAAA;AACF,CAAC;AACD;;GAEG;AACH,SAAS,aAAa,CAAC,GAAW,EAAE,GAAe,EAAE,GAAQ;IAC5D,IAAI,GAAG,KAAK,CAAC;QAAE,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;SAC7C,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACpB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,SAAS,EAAE,CAAA;IAC1B,CAAC;SAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACtB,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,EAAE,CAAA;IAChC,CAAC;AACF,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,GAAe,EAAE,GAAQ;IAClD,IAAI,GAAG,CAAC,QAAQ;QAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACvD,IAAI,GAAG,CAAC,GAAG,IAAI,IAAI;QAAE,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;IACpD,IAAI,GAAG,CAAC,SAAS,IAAI,IAAI;QAAE,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,GAAQ,EAAE,GAAY;IACpD,OAAO,GAAG,CAAC,UAAU,CACpB,mBAAmB,EACnB,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,EAChC,GAAG,CACH,CAAA;AACF,CAAC;AACD;;GAEG;AACH,SAAS,mBAAmB,CAAC,GAAW,EAAE,GAAqB,EAAE,GAAQ;IACxE,IAAI,GAAG,KAAK,CAAC;QAAE,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,UAAU,EAA8B,CAAA;SACjE,IAAI,GAAG,KAAK,CAAC;QAAE,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;AACxD,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,GAAqB,EAAE,GAAQ;IAC9D,IAAI,GAAG,CAAC,IAAI;QAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/C,IAAI,GAAG,CAAC,QAAQ;QAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;AACxD,CAAC"}

package/dist/src/proto/osmformat.d.ts

@@ -1,92 +0,0 @@
-import type Pbf from "pbf";
-export type OsmPbfHeaderBBox = {
-    left: number;
-    right: number;
-    top: number;
-    bottom: number;
-};
-export type OsmPbfHeaderBlock = {
-    bbox?: OsmPbfHeaderBBox;
-    required_features: string[];
-    optional_features: string[];
-    writingprogram?: string;
-    source?: string;
-    osmosis_replication_timestamp?: number;
-    osmosis_replication_sequence_number?: number;
-    osmosis_replication_base_url?: string;
-};
-export interface OsmPbfBlockSettings {
-    granularity?: number;
-    lat_offset?: number;
-    lon_offset?: number;
-    date_granularity?: number;
-}
-export interface OsmPbfBlock extends OsmPbfBlockSettings {
-    stringtable: OsmPbfStringTable;
-    primitivegroup: OsmPbfGroup[];
-}
-export type OsmPbfGroup = {
-    nodes: OsmPbfNode[];
-    dense?: OsmPbfDenseNodes;
-    ways: OsmPbfWay[];
-    relations: OsmPbfRelation[];
-};
-export type OsmPbfStringTable = Uint8Array[];
-export interface OsmPbfInfo {
-    version?: number;
-    timestamp?: number;
-    changeset?: number;
-    uid?: number;
-    user_sid?: number;
-    visible?: boolean;
-}
-export type OsmPbfDenseInfo = {
-    version: number[];
-    timestamp: number[];
-    changeset: number[];
-    uid: number[];
-    user_sid: number[];
-    visible: boolean[];
-};
-export interface OsmPbfPrimitive {
-    id: number;
-    keys: number[];
-    vals: number[];
-    info?: OsmPbfInfo;
-}
-export interface OsmPbfNode extends OsmPbfPrimitive {
-    lat: number;
-    lon: number;
-}
-export type OsmPbfDenseNodes = {
-    id: number[];
-    denseinfo?: OsmPbfDenseInfo;
-    lat: number[];
-    lon: number[];
-    keys_vals: number[];
-};
-export interface OsmPbfWay extends OsmPbfPrimitive {
-    refs: number[];
-}
-export interface OsmPbfRelation extends OsmPbfPrimitive {
-    roles_sid: number[];
-    memids: number[];
-    types: number[];
-}
-/**
- * Reads an `OsmPbfHeaderBlock` message from the provided Pbf reader.
- */
-export declare function readHeaderBlock(pbf: Pbf, end?: number): OsmPbfHeaderBlock;
-/**
- * Serializes an `OsmPbfHeaderBlock` message into the Pbf writer.
- */
-export declare function writeHeaderBlock(obj: OsmPbfHeaderBlock, pbf: Pbf): void;
-/**
- * Reads a primitive block containing string tables and primitive groups.
- */
-export declare function readPrimitiveBlock(pbf: Pbf, end?: number): OsmPbfBlock;
-/**
- * Serializes a primitive block including its string table and primitive groups.
- */
-export declare function writePrimitiveBlock(obj: OsmPbfBlock, pbf: Pbf): void;
-//# sourceMappingURL=osmformat.d.ts.map