compress-utils 0.7.0

package/dist/core/resolve-default.js

@@ -0,0 +1,25 @@
+/**
+ * Default resolver: detects the runtime at module load and picks fetch
+ * vs. fs.readFile. Used as a fallback when the consumer doesn't honor
+ * the package.json `browser` / `node` / `deno` / `bun` export conditions.
+ *
+ * Modern bundlers and runtimes hit the conditional exports instead and
+ * never load this file. It's a belt-and-braces fallback.
+ */
+export const resolveWasm = async (url) => {
+    const hasFetch = typeof fetch === "function";
+    const isDeno = typeof Deno !== "undefined";
+    const isBun = typeof Bun !== "undefined";
+    const isNode = typeof process !== "undefined" && process.versions?.node !== undefined && !isDeno && !isBun;
+    // Node's fetch can't do file://. Everyone else's can (Deno + Bun
+    // natively; browsers only see http(s)). So Node is the only path
+    // that needs fs.readFile.
+    if (isNode && url.protocol === "file:") {
+        const { readFile } = await import("node:fs/promises");
+        return readFile(url);
+    }
+    if (hasFetch)
+        return fetch(url);
+    throw new Error("no wasm resolver available in this runtime");
+};
+//# sourceMappingURL=resolve-default.js.map

package/dist/core/resolve-default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-default.js","sourceRoot":"","sources":["../../src/core/resolve-default.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,MAAM,CAAC,MAAM,WAAW,GAAiB,KAAK,EAAE,GAAG,EAAE,EAAE;IACnD,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC;IAC7C,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,WAAW,CAAC;IAC3C,MAAM,KAAK,GAAG,OAAO,GAAG,KAAK,WAAW,CAAC;IACzC,MAAM,MAAM,GACR,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC;IAEhG,iEAAiE;IACjE,iEAAiE;IACjE,0BAA0B;IAC1B,IAAI,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACrC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,QAAQ;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAClE,CAAC,CAAC"}

package/dist/core/resolve-node.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Node resolver: read the wasm bytes from disk via `fs.readFile`, hand
+ * the loader an ArrayBuffer for the non-streaming `WebAssembly.instantiate`
+ * path.
+ *
+ * Why not `fetch`: Node's built-in fetch (undici) deliberately rejects
+ * the `file:` scheme with ERR_INVALID_URL_SCHEME. The streaming-compile
+ * benefit is also moot here — disk reads aren't latency-bound the way
+ * network fetches are.
+ */
+import type { WasmResolver } from "./dispatch.js";
+export declare const resolveWasm: WasmResolver;
+//# sourceMappingURL=resolve-node.d.ts.map

package/dist/core/resolve-node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-node.d.ts","sourceRoot":"","sources":["../../src/core/resolve-node.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,eAAO,MAAM,WAAW,EAAE,YAAqC,CAAC"}

package/dist/core/resolve-node.js

@@ -0,0 +1,13 @@
+/**
+ * Node resolver: read the wasm bytes from disk via `fs.readFile`, hand
+ * the loader an ArrayBuffer for the non-streaming `WebAssembly.instantiate`
+ * path.
+ *
+ * Why not `fetch`: Node's built-in fetch (undici) deliberately rejects
+ * the `file:` scheme with ERR_INVALID_URL_SCHEME. The streaming-compile
+ * benefit is also moot here — disk reads aren't latency-bound the way
+ * network fetches are.
+ */
+import { readFile } from "node:fs/promises";
+export const resolveWasm = (url) => readFile(url);
+//# sourceMappingURL=resolve-node.js.map

package/dist/core/resolve-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-node.js","sourceRoot":"","sources":["../../src/core/resolve-node.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,MAAM,CAAC,MAAM,WAAW,GAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC"}

package/dist/core/types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Public types. The Algorithm enum is internal — users see string names
+ * via CompressError.algorithm. Each subpath knows its own algorithm,
+ * so users never need to pass one.
+ */
+/** @internal */
+export declare const enum Algorithm {
+    Zstd = 0,
+    Brotli = 1,
+    Zlib = 2,
+    Bz2 = 3,
+    Lz4 = 4,
+    Xz = 5,
+    Lzma = 6
+}
+/** @internal */
+export declare const enum Status {
+    Ok = 0,
+    InvalidArg = 1,
+    InvalidLevel = 2,
+    BufTooSmall = 3,
+    SizeUnknown = 4,
+    UnsupportedAlgo = 5,
+    Compression = 6,
+    Decompression = 7,
+    Truncated = 8,
+    SizeLimit = 9,
+    StreamFinished = 10,
+    StreamState = 11,
+    Oom = 12,
+    Internal = 13
+}
+/** Canonical lower-case algorithm names. */
+export type AlgorithmName = "zstd" | "brotli" | "zlib" | "bz2" | "lz4" | "xz";
+/** Thrown for any non-Ok status. Carries the raw status code and algo name. */
+export declare class CompressError extends Error {
+    /** Underlying C status code. Stable across versions; see compress_utils.h. */
+    readonly code: number;
+    readonly algorithm: AlgorithmName;
+    constructor(code: number, algorithm: AlgorithmName, message: string);
+}
+export interface CompressOptions {
+    /** 1..10. 1 = fastest, 10 = smallest. Default 5. */
+    level?: number;
+}
+export interface DecompressOptions {
+    /**
+     * Decompressed size in bytes if known by the caller. Skips the
+     * size-hint probe and any internal streaming fallback — a small
+     * win for hot paths where the size is tracked out-of-band.
+     */
+    expectedSize?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/core/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,gBAAgB;AAChB,0BAAkB,SAAS;IACvB,IAAI,IAAI;IACR,MAAM,IAAI;IACV,IAAI,IAAI;IACR,GAAG,IAAI;IACP,GAAG,IAAI;IACP,EAAE,IAAI;IACN,IAAI,IAAI;CACX;AAED,gBAAgB;AAChB,0BAAkB,MAAM;IACpB,EAAE,IAAI;IACN,UAAU,IAAI;IACd,YAAY,IAAI;IAChB,WAAW,IAAI;IACf,WAAW,IAAI;IACf,eAAe,IAAI;IACnB,WAAW,IAAI;IACf,aAAa,IAAI;IACjB,SAAS,IAAI;IACb,SAAS,IAAI;IACb,cAAc,KAAK;IACnB,WAAW,KAAK;IAChB,GAAG,KAAK;IACR,QAAQ,KAAK;CAChB;AAED,4CAA4C;AAC5C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAE9E,+EAA+E;AAC/E,qBAAa,aAAc,SAAQ,KAAK;IACpC,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;gBAEtB,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM;CAMtE;AAED,MAAM,WAAW,eAAe;IAC5B,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAC9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/core/types.js

@@ -0,0 +1,47 @@
+/**
+ * Public types. The Algorithm enum is internal — users see string names
+ * via CompressError.algorithm. Each subpath knows its own algorithm,
+ * so users never need to pass one.
+ */
+/** @internal */
+export var Algorithm;
+(function (Algorithm) {
+    Algorithm[Algorithm["Zstd"] = 0] = "Zstd";
+    Algorithm[Algorithm["Brotli"] = 1] = "Brotli";
+    Algorithm[Algorithm["Zlib"] = 2] = "Zlib";
+    Algorithm[Algorithm["Bz2"] = 3] = "Bz2";
+    Algorithm[Algorithm["Lz4"] = 4] = "Lz4";
+    Algorithm[Algorithm["Xz"] = 5] = "Xz";
+    Algorithm[Algorithm["Lzma"] = 6] = "Lzma";
+})(Algorithm || (Algorithm = {}));
+/** @internal */
+export var Status;
+(function (Status) {
+    Status[Status["Ok"] = 0] = "Ok";
+    Status[Status["InvalidArg"] = 1] = "InvalidArg";
+    Status[Status["InvalidLevel"] = 2] = "InvalidLevel";
+    Status[Status["BufTooSmall"] = 3] = "BufTooSmall";
+    Status[Status["SizeUnknown"] = 4] = "SizeUnknown";
+    Status[Status["UnsupportedAlgo"] = 5] = "UnsupportedAlgo";
+    Status[Status["Compression"] = 6] = "Compression";
+    Status[Status["Decompression"] = 7] = "Decompression";
+    Status[Status["Truncated"] = 8] = "Truncated";
+    Status[Status["SizeLimit"] = 9] = "SizeLimit";
+    Status[Status["StreamFinished"] = 10] = "StreamFinished";
+    Status[Status["StreamState"] = 11] = "StreamState";
+    Status[Status["Oom"] = 12] = "Oom";
+    Status[Status["Internal"] = 13] = "Internal";
+})(Status || (Status = {}));
+/** Thrown for any non-Ok status. Carries the raw status code and algo name. */
+export class CompressError extends Error {
+    /** Underlying C status code. Stable across versions; see compress_utils.h. */
+    code;
+    algorithm;
+    constructor(code, algorithm, message) {
+        super(message);
+        this.name = "CompressError";
+        this.code = code;
+        this.algorithm = algorithm;
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,gBAAgB;AAChB,MAAM,CAAN,IAAkB,SAQjB;AARD,WAAkB,SAAS;IACvB,yCAAQ,CAAA;IACR,6CAAU,CAAA;IACV,yCAAQ,CAAA;IACR,uCAAO,CAAA;IACP,uCAAO,CAAA;IACP,qCAAM,CAAA;IACN,yCAAQ,CAAA;AACZ,CAAC,EARiB,SAAS,KAAT,SAAS,QAQ1B;AAED,gBAAgB;AAChB,MAAM,CAAN,IAAkB,MAejB;AAfD,WAAkB,MAAM;IACpB,+BAAM,CAAA;IACN,+CAAc,CAAA;IACd,mDAAgB,CAAA;IAChB,iDAAe,CAAA;IACf,iDAAe,CAAA;IACf,yDAAmB,CAAA;IACnB,iDAAe,CAAA;IACf,qDAAiB,CAAA;IACjB,6CAAa,CAAA;IACb,6CAAa,CAAA;IACb,wDAAmB,CAAA;IACnB,kDAAgB,CAAA;IAChB,kCAAQ,CAAA;IACR,4CAAa,CAAA;AACjB,CAAC,EAfiB,MAAM,KAAN,MAAM,QAevB;AAKD,+EAA+E;AAC/E,MAAM,OAAO,aAAc,SAAQ,KAAK;IACpC,8EAA8E;IACrE,IAAI,CAAS;IACb,SAAS,CAAgB;IAElC,YAAY,IAAY,EAAE,SAAwB,EAAE,OAAe;QAC/D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "compress-utils",
+  "version": "0.7.0",
+  "description": "WASM compression bindings for zstd, brotli, zlib, bz2, lz4, xz — tree-shakeable per-algorithm imports.",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dupontcyborg/compress-utils.git",
+    "directory": "bindings/wasm"
+  },
+  "homepage": "https://github.com/dupontcyborg/compress-utils#readme",
+  "bugs": {
+    "url": "https://github.com/dupontcyborg/compress-utils/issues"
+  },
+  "author": "Nicolas Dupont <nico@dupont.live> (https://nico.codes)",
+  "license": "MIT",
+  "keywords": [
+    "compression",
+    "decompression",
+    "wasm",
+    "webassembly",
+    "zstd",
+    "brotli",
+    "zlib",
+    "gzip",
+    "bzip2",
+    "lz4",
+    "xz",
+    "lzma"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "exports": {
+    "./zstd": "./dist/algorithms/zstd/index.js",
+    "./brotli": "./dist/algorithms/brotli/index.js",
+    "./zlib": "./dist/algorithms/zlib/index.js",
+    "./bz2": "./dist/algorithms/bz2/index.js",
+    "./lz4": "./dist/algorithms/lz4/index.js",
+    "./xz": "./dist/algorithms/xz/index.js"
+  },
+  "imports": {
+    "#resolver": {
+      "types": "./src/core/resolve-default.ts",
+      "browser": "./dist/core/resolve-browser.js",
+      "deno": "./dist/core/resolve-browser.js",
+      "bun": "./dist/core/resolve-browser.js",
+      "node": "./dist/core/resolve-node.js",
+      "default": "./dist/core/resolve-default.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build:wasm": "cmake -S ../.. -B ../../build-wasm -DBUILD_WASM_BINDINGS=ON -DBUILD_PYTHON_BINDINGS=OFF -DBUILD_CPP_BINDINGS=OFF -DENABLE_TESTS=OFF -DCMAKE_BUILD_TYPE=Release && cmake --build ../../build-wasm --target compress_utils_wasm -j",
+    "build:ts": "tsc -p tsconfig.json",
+    "build": "npm run build:wasm && npm run build:ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:browser": "playwright test",
+    "test:deno": "deno run --allow-read --allow-env tests-runtime/deno-smoke.ts",
+    "test:bun": "bun test --bun tests/",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "biome format --write .",
+    "check": "biome check ."
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.4.15",
+    "@playwright/test": "^1.60.0",
+    "@types/node": "^25.8.0",
+    "esbuild": "^0.28.0",
+    "typescript": "^5.5.0",
+    "vitest": "^4.1.6"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}