@structured-world/structured-zstd 0.0.30

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Structured World Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,93 @@
+# @structured-world/structured-zstd
+
+Pure-Rust [Zstandard](https://facebook.github.io/zstd/) (zstd) codec compiled
+to WebAssembly. Compress and decompress in the **browser, Node.js and Deno** —
+no native addons, no FFI, no build step for consumers.
+
+- **Automatic SIMD.** Ships two payloads — one built with the WebAssembly
+  `simd128` SIMD tier, one scalar — and picks the fast one at runtime via
+  engine feature detection. You import one package; the right `.wasm` loads.
+- **Pure ESM, strict TypeScript.** First-class types, tree-shakeable, `type:
+  module`.
+- **Interoperable.** Frames produced here decode in the native C `zstd`, and
+  frames from the C library decode here.
+
+## Install
+
+```sh
+npm install @structured-world/structured-zstd
+```
+
+## Usage
+
+```ts
+import { compress, decompress } from "@structured-world/structured-zstd";
+
+const data = new TextEncoder().encode("hello, zstd ".repeat(1000));
+
+// `level` follows the zstd scale: 1..=22 (higher = smaller/slower),
+// negatives (-7..=-1) for the ultra-fast tier. Defaults to 3.
+const framed = await compress(data, 19);
+const plain = await decompress(framed);
+
+console.assert(plain.length === data.length);
+```
+
+The codec initialises lazily on first call. To pre-warm it (e.g. before a
+latency-sensitive path), call `init()`:
+
+```ts
+import { init, compress } from "@structured-world/structured-zstd";
+
+await init(); // selects + instantiates the best payload up front
+const out = await compress(payload);
+```
+
+## API
+
+| Export | Signature | Notes |
+|--------|-----------|-------|
+| `compress` | `(data: Uint8Array, level?: number) => Promise<Uint8Array>` | `level` defaults to `3`. |
+| `decompress` | `(data: Uint8Array) => Promise<Uint8Array>` | Rejects on a malformed/incomplete frame. |
+| `compressUsingDict` | `(data: Uint8Array, dict: Uint8Array, level?: number) => Promise<Uint8Array>` | Dictionary compression (raw zstd dictionary, e.g. `zstd --train`). |
+| `decompressUsingDict` | `(data: Uint8Array, dict: Uint8Array) => Promise<Uint8Array>` | `dict` must match the one used to compress. |
+| `createDecompressStream` | `() => Promise<DecompressStream>` | Incremental streaming decoder (see below). |
+| `init` | `() => Promise<void>` | Optional pre-warm; idempotent. |
+
+```ts
+import { compressUsingDict, decompressUsingDict } from "@structured-world/structured-zstd";
+const framed = await compressUsingDict(record, dictionary, 19);
+const back = await decompressUsingDict(framed, dictionary);
+```
+
+### Streaming decompression
+
+Decode a frame incrementally without buffering all of it — feed compressed
+chunks (e.g. from a `fetch` body) and read output as it arrives:
+
+```ts
+import { createDecompressStream } from "@structured-world/structured-zstd";
+
+const stream = await createDecompressStream();
+const out: Uint8Array[] = [];
+for await (const chunk of response.body) out.push(stream.push(chunk));
+out.push(stream.finish()); // throws if the stream ended mid-frame
+stream.free();             // release the wasm handle
+```
+
+`push(chunk)` returns whatever output is available so far (possibly empty
+while a block is still incomplete); the decoder window is held wasm-side
+across chunks.
+
+## How the payload is selected
+
+WebAssembly has no runtime CPU detection, so SIMD selection is an engine
+**capability** probe ([`wasm-feature-detect`](https://www.npmjs.com/package/wasm-feature-detect)
+`simd()`): when the host supports wasm SIMD the `simd128` payload loads,
+otherwise the scalar one. In Node.js the `.wasm` bytes are read from disk; in
+the browser/Deno they are fetched relative to the module.
+
+## License
+
+[Apache-2.0](./LICENSE) © Structured World Foundation. Built from
+[`structured-zstd`](https://github.com/structured-world/structured-zstd).

package/index.d.ts

@@ -0,0 +1,68 @@
+/**
+ * `@structured-world/structured-zstd` — pure-Rust Zstandard codec compiled to
+ * WebAssembly, with automatic selection of the SIMD (`simd128`) or scalar
+ * payload based on the host engine's capabilities.
+ *
+ * Pure ESM, strict TypeScript. One async API for browser, Node.js and Deno:
+ *
+ * ```ts
+ * import { compress, decompress } from "@structured-world/structured-zstd";
+ * const framed = await compress(new TextEncoder().encode("hello"), 19);
+ * const plain = await decompress(framed);
+ * ```
+ *
+ * The codec is initialised lazily on first use; call {@link init} explicitly
+ * to pre-warm it (e.g. before a latency-sensitive path).
+ */
+/**
+ * Incremental streaming decompressor handle. Feed compressed chunks with
+ * {@link DecompressStream.push} and read decompressed output as it becomes
+ * available; call {@link DecompressStream.finish} at end of input. The decoder
+ * window is held on the wasm side across chunks, so a large frame never needs
+ * to be fully buffered. Call {@link DecompressStream.free} when done.
+ */
+export interface DecompressStream {
+    /** Feed compressed bytes; returns decompressed output available so far. */
+    push(chunk: Uint8Array): Uint8Array;
+    /** Signal end of input; returns the final bytes. Throws if incomplete. */
+    finish(): Uint8Array;
+    /** Release the underlying wasm handle. */
+    free(): void;
+}
+/**
+ * Initialise the codec (select + instantiate the best payload) ahead of time.
+ * Idempotent and concurrency-safe; resolves once the module is ready.
+ */
+export declare function init(): Promise<void>;
+/**
+ * Compress `data` into a Zstandard frame at `level` (zstd scale: `1..=22`,
+ * negatives for the ultra-fast tier; defaults to {@link DEFAULT_LEVEL}). The
+ * frame decodes in any compliant zstd decoder, including the native C library.
+ */
+export declare function compress(data: Uint8Array, level?: number): Promise<Uint8Array>;
+/**
+ * Decompress a complete Zstandard frame. Rejects if the input is not a valid,
+ * complete frame.
+ */
+export declare function decompress(data: Uint8Array): Promise<Uint8Array>;
+/**
+ * Compress `data` against a raw Zstandard `dict` (e.g. from `zstd --train`) at
+ * `level` (defaults to {@link DEFAULT_LEVEL}). Mirrors C
+ * `ZSTD_compress_usingDict` — small, similar payloads compress far better.
+ * Rejects if the dictionary is invalid.
+ */
+export declare function compressUsingDict(data: Uint8Array, dict: Uint8Array, level?: number): Promise<Uint8Array>;
+/**
+ * Decompress a dictionary-encoded frame. `dict` must be the same raw
+ * dictionary used to compress it. Mirrors C `ZSTD_decompress_usingDict`.
+ * Rejects on a malformed frame or dictionary mismatch.
+ */
+export declare function decompressUsingDict(data: Uint8Array, dict: Uint8Array): Promise<Uint8Array>;
+/**
+ * Create an incremental streaming decompressor. Push compressed chunks and
+ * read decompressed output as it arrives, then `finish()`; `free()` when done.
+ * Unlike the common npm wasm zstd packages, the frame need not be fully
+ * buffered — the decoder window lives on the wasm side across chunks.
+ */
+export declare function createDecompressStream(): Promise<DecompressStream>;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAkBH;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2EAA2E;IAC3E,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,CAAC;IACpC,0EAA0E;IAC1E,MAAM,IAAI,UAAU,CAAC;IACrB,0CAA0C;IAC1C,IAAI,IAAI,IAAI,CAAC;CACd;AA2CD;;;GAGG;AACH,wBAAsB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAG1C;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,UAAU,EAChB,KAAK,GAAE,MAAsB,GAC5B,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAGtE;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,UAAU,EAChB,KAAK,GAAE,MAAsB,GAC5B,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAGxE"}

package/index.js

@@ -0,0 +1,109 @@
+/**
+ * `@structured-world/structured-zstd` — pure-Rust Zstandard codec compiled to
+ * WebAssembly, with automatic selection of the SIMD (`simd128`) or scalar
+ * payload based on the host engine's capabilities.
+ *
+ * Pure ESM, strict TypeScript. One async API for browser, Node.js and Deno:
+ *
+ * ```ts
+ * import { compress, decompress } from "@structured-world/structured-zstd";
+ * const framed = await compress(new TextEncoder().encode("hello"), 19);
+ * const plain = await decompress(framed);
+ * ```
+ *
+ * The codec is initialised lazily on first use; call {@link init} explicitly
+ * to pre-warm it (e.g. before a latency-sensitive path).
+ */
+import { simd } from "wasm-feature-detect";
+/** Default compression level when the caller does not pass one. */
+const DEFAULT_LEVEL = 3;
+let loaded;
+let loading;
+/** True when running under Node.js (no `fetch` of `file://`, so load bytes). */
+function isNode() {
+    const g = globalThis;
+    return g.process?.versions?.node != null;
+}
+/** Read a payload's `.wasm` from disk (Node only), relative to this module. */
+async function readWasmBytes(dir) {
+    const url = new URL(`./${dir}/structured_zstd_wasm_bg.wasm`, import.meta.url);
+    const fs = await import(/* @vite-ignore */ "node:fs/promises");
+    return fs.readFile(url);
+}
+async function load() {
+    if (loaded !== undefined) {
+        return loaded;
+    }
+    const useSimd = await simd();
+    const dir = useSimd ? "simd" : "scalar";
+    const mod = (useSimd
+        ? await import("./simd/structured_zstd_wasm.js")
+        : await import("./scalar/structured_zstd_wasm.js"));
+    if (isNode()) {
+        // Node's global fetch rejects `file://`, so hand the init the raw bytes.
+        // wasm-bindgen's current init wants `{ module_or_path }` (passing the
+        // bytes positionally is deprecated and warns).
+        await mod.default({ module_or_path: await readWasmBytes(dir) });
+    }
+    else {
+        // Browser / Deno: the glue resolves its `.wasm` from its own module URL.
+        await mod.default();
+    }
+    loaded = mod;
+    return mod;
+}
+/**
+ * Initialise the codec (select + instantiate the best payload) ahead of time.
+ * Idempotent and concurrency-safe; resolves once the module is ready.
+ */
+export async function init() {
+    loading ??= load();
+    await loading;
+}
+/**
+ * Compress `data` into a Zstandard frame at `level` (zstd scale: `1..=22`,
+ * negatives for the ultra-fast tier; defaults to {@link DEFAULT_LEVEL}). The
+ * frame decodes in any compliant zstd decoder, including the native C library.
+ */
+export async function compress(data, level = DEFAULT_LEVEL) {
+    loading ??= load();
+    return (await loading).compress(data, level);
+}
+/**
+ * Decompress a complete Zstandard frame. Rejects if the input is not a valid,
+ * complete frame.
+ */
+export async function decompress(data) {
+    loading ??= load();
+    return (await loading).decompress(data);
+}
+/**
+ * Compress `data` against a raw Zstandard `dict` (e.g. from `zstd --train`) at
+ * `level` (defaults to {@link DEFAULT_LEVEL}). Mirrors C
+ * `ZSTD_compress_usingDict` — small, similar payloads compress far better.
+ * Rejects if the dictionary is invalid.
+ */
+export async function compressUsingDict(data, dict, level = DEFAULT_LEVEL) {
+    loading ??= load();
+    return (await loading).compressUsingDict(data, dict, level);
+}
+/**
+ * Decompress a dictionary-encoded frame. `dict` must be the same raw
+ * dictionary used to compress it. Mirrors C `ZSTD_decompress_usingDict`.
+ * Rejects on a malformed frame or dictionary mismatch.
+ */
+export async function decompressUsingDict(data, dict) {
+    loading ??= load();
+    return (await loading).decompressUsingDict(data, dict);
+}
+/**
+ * Create an incremental streaming decompressor. Push compressed chunks and
+ * read decompressed output as it arrives, then `finish()`; `free()` when done.
+ * Unlike the common npm wasm zstd packages, the frame need not be fully
+ * buffered — the decoder window lives on the wasm side across chunks.
+ */
+export async function createDecompressStream() {
+    loading ??= load();
+    return new (await loading).ZstdDecompressStream();
+}
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAgC3C,mEAAmE;AACnE,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,IAAI,MAA2B,CAAC;AAChC,IAAI,OAAqC,CAAC;AAE1C,gFAAgF;AAChF,SAAS,MAAM;IACb,MAAM,CAAC,GAAG,UAA4D,CAAC;IACvE,OAAO,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,IAAI,IAAI,CAAC;AAC3C,CAAC;AAED,+EAA+E;AAC/E,KAAK,UAAU,aAAa,CAAC,GAAsB;IACjD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,GAAG,+BAA+B,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;IAC/D,OAAO,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;IAC7B,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;IACxC,MAAM,GAAG,GAAG,CAAC,OAAO;QAClB,CAAC,CAAC,MAAM,MAAM,CAAC,gCAAgC,CAAC;QAChD,CAAC,CAAC,MAAM,MAAM,CAAC,kCAAkC,CAAC,CAAuB,CAAC;IAC5E,IAAI,MAAM,EAAE,EAAE,CAAC;QACb,yEAAyE;QACzE,sEAAsE;QACtE,+CAA+C;QAC/C,MAAM,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,yEAAyE;QACzE,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IACD,MAAM,GAAG,GAAG,CAAC;IACb,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI;IACxB,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,MAAM,OAAO,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,IAAgB,EAChB,QAAgB,aAAa;IAE7B,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAgB;IAC/C,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAgB,EAChB,IAAgB,EAChB,QAAgB,aAAa;IAE7B,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAAgB,EAChB,IAAgB;IAEhB,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB;IAC1C,OAAO,KAAK,IAAI,EAAE,CAAC;IACnB,OAAO,IAAI,CAAC,MAAM,OAAO,CAAC,CAAC,oBAAoB,EAAE,CAAC;AACpD,CAAC"}

package/index.ts

@@ -0,0 +1,159 @@
+/**
+ * `@structured-world/structured-zstd` — pure-Rust Zstandard codec compiled to
+ * WebAssembly, with automatic selection of the SIMD (`simd128`) or scalar
+ * payload based on the host engine's capabilities.
+ *
+ * Pure ESM, strict TypeScript. One async API for browser, Node.js and Deno:
+ *
+ * ```ts
+ * import { compress, decompress } from "@structured-world/structured-zstd";
+ * const framed = await compress(new TextEncoder().encode("hello"), 19);
+ * const plain = await decompress(framed);
+ * ```
+ *
+ * The codec is initialised lazily on first use; call {@link init} explicitly
+ * to pre-warm it (e.g. before a latency-sensitive path).
+ */
+
+import { simd } from "wasm-feature-detect";
+
+/** Shape of a wasm-pack `web`-target payload glue module (simd or scalar). */
+interface Payload {
+  /** Async wasm initialiser. Accepts wasm bytes / a URL, or nothing (browser). */
+  // Typed `unknown`: wasm-bindgen's `web` init accepts the broad `InitInput`
+  // (bytes / URL / Response / Module), and Node's `fs.readFile` returns
+  // `Buffer<ArrayBufferLike>`, wider than the DOM `BufferSource` in the .d.ts.
+  default: (moduleOrPath?: unknown) => Promise<unknown>;
+  compress: (data: Uint8Array, level: number) => Uint8Array;
+  decompress: (data: Uint8Array) => Uint8Array;
+  compressUsingDict: (data: Uint8Array, dict: Uint8Array, level: number) => Uint8Array;
+  decompressUsingDict: (data: Uint8Array, dict: Uint8Array) => Uint8Array;
+  ZstdDecompressStream: new () => DecompressStream;
+}
+
+/**
+ * Incremental streaming decompressor handle. Feed compressed chunks with
+ * {@link DecompressStream.push} and read decompressed output as it becomes
+ * available; call {@link DecompressStream.finish} at end of input. The decoder
+ * window is held on the wasm side across chunks, so a large frame never needs
+ * to be fully buffered. Call {@link DecompressStream.free} when done.
+ */
+export interface DecompressStream {
+  /** Feed compressed bytes; returns decompressed output available so far. */
+  push(chunk: Uint8Array): Uint8Array;
+  /** Signal end of input; returns the final bytes. Throws if incomplete. */
+  finish(): Uint8Array;
+  /** Release the underlying wasm handle. */
+  free(): void;
+}
+
+/** Default compression level when the caller does not pass one. */
+const DEFAULT_LEVEL = 3;
+
+let loaded: Payload | undefined;
+let loading: Promise<Payload> | undefined;
+
+/** True when running under Node.js (no `fetch` of `file://`, so load bytes). */
+function isNode(): boolean {
+  const g = globalThis as { process?: { versions?: { node?: string } } };
+  return g.process?.versions?.node != null;
+}
+
+/** Read a payload's `.wasm` from disk (Node only), relative to this module. */
+async function readWasmBytes(dir: "simd" | "scalar"): Promise<Uint8Array> {
+  const url = new URL(`./${dir}/structured_zstd_wasm_bg.wasm`, import.meta.url);
+  const fs = await import(/* @vite-ignore */ "node:fs/promises");
+  return fs.readFile(url);
+}
+
+async function load(): Promise<Payload> {
+  if (loaded !== undefined) {
+    return loaded;
+  }
+  const useSimd = await simd();
+  const dir = useSimd ? "simd" : "scalar";
+  const mod = (useSimd
+    ? await import("./simd/structured_zstd_wasm.js")
+    : await import("./scalar/structured_zstd_wasm.js")) as unknown as Payload;
+  if (isNode()) {
+    // Node's global fetch rejects `file://`, so hand the init the raw bytes.
+    // wasm-bindgen's current init wants `{ module_or_path }` (passing the
+    // bytes positionally is deprecated and warns).
+    await mod.default({ module_or_path: await readWasmBytes(dir) });
+  } else {
+    // Browser / Deno: the glue resolves its `.wasm` from its own module URL.
+    await mod.default();
+  }
+  loaded = mod;
+  return mod;
+}
+
+/**
+ * Initialise the codec (select + instantiate the best payload) ahead of time.
+ * Idempotent and concurrency-safe; resolves once the module is ready.
+ */
+export async function init(): Promise<void> {
+  loading ??= load();
+  await loading;
+}
+
+/**
+ * Compress `data` into a Zstandard frame at `level` (zstd scale: `1..=22`,
+ * negatives for the ultra-fast tier; defaults to {@link DEFAULT_LEVEL}). The
+ * frame decodes in any compliant zstd decoder, including the native C library.
+ */
+export async function compress(
+  data: Uint8Array,
+  level: number = DEFAULT_LEVEL,
+): Promise<Uint8Array> {
+  loading ??= load();
+  return (await loading).compress(data, level);
+}
+
+/**
+ * Decompress a complete Zstandard frame. Rejects if the input is not a valid,
+ * complete frame.
+ */
+export async function decompress(data: Uint8Array): Promise<Uint8Array> {
+  loading ??= load();
+  return (await loading).decompress(data);
+}
+
+/**
+ * Compress `data` against a raw Zstandard `dict` (e.g. from `zstd --train`) at
+ * `level` (defaults to {@link DEFAULT_LEVEL}). Mirrors C
+ * `ZSTD_compress_usingDict` — small, similar payloads compress far better.
+ * Rejects if the dictionary is invalid.
+ */
+export async function compressUsingDict(
+  data: Uint8Array,
+  dict: Uint8Array,
+  level: number = DEFAULT_LEVEL,
+): Promise<Uint8Array> {
+  loading ??= load();
+  return (await loading).compressUsingDict(data, dict, level);
+}
+
+/**
+ * Decompress a dictionary-encoded frame. `dict` must be the same raw
+ * dictionary used to compress it. Mirrors C `ZSTD_decompress_usingDict`.
+ * Rejects on a malformed frame or dictionary mismatch.
+ */
+export async function decompressUsingDict(
+  data: Uint8Array,
+  dict: Uint8Array,
+): Promise<Uint8Array> {
+  loading ??= load();
+  return (await loading).decompressUsingDict(data, dict);
+}
+
+/**
+ * Create an incremental streaming decompressor. Push compressed chunks and
+ * read decompressed output as it arrives, then `finish()`; `free()` when done.
+ * Unlike the common npm wasm zstd packages, the frame need not be fully
+ * buffered — the decoder window lives on the wasm side across chunks.
+ */
+export async function createDecompressStream(): Promise<DecompressStream> {
+  loading ??= load();
+  return new (await loading).ZstdDecompressStream();
+}