@officialunofficial/kit-wasm 0.0.0-init → 0.7.1

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 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 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 "page" as the copyright notice for easier identification within
+      third-party archives.
+
+   Copyright 2024-present Official Unofficial, Inc.
+
+   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/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Official Unofficial, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,148 @@
-# @officialunofficial/kit-wasm
+# kit-wasm
 
-Placeholder. Releases come from https://github.com/officialunofficial/kit.
+WebAssembly bindings for kit — a content-addressed VCS for creative work. The package exposes the pure byte-format and crypto paths from `kit-core` and `kit-attest` so they can run anywhere a modern JS runtime can: browsers, Cloudflare Workers, Bun, Deno, Node.
+
+No filesystem or network access is performed inside the wasm module. It is a stateless library of object encoders, hashers, signers, verifiers, FastCDC chunkers, delta encoders, and Bao streaming primitives.
+
+## Install
+
+The package is on npm, not on crates.io:
+
+```sh
+npm install @officialunofficial/kit-wasm
+```
+
+The package uses the `bundler` target of `wasm-bindgen`. It works with esbuild,
+Wrangler, Vite, webpack and Rollup, which load the `.wasm` file for you. The
+version of the package equals the version of the kit release.
+
+Each release publishes the package from the release workflow with npm trusted
+publishing. The version on npm carries a provenance attestation. Check it with
+`npm audit signatures`.
+
+## Build from source
+
+The build needs the `wasm-bindgen` command-line tool. Its version must equal
+the `wasm-bindgen` version in `rust/Cargo.lock`. A different version fails with
+a schema mismatch.
+
+```sh
+version=$(cd rust && cargo pkgid -p wasm-bindgen | sed 's/.*[#@]//')
+cargo install --locked wasm-bindgen-cli --version "$version"
+
+bash scripts/wasm-package.sh pkg
+```
+
+The script builds the crate for `wasm32-unknown-unknown`, runs `wasm-bindgen`
+with the `bundler` target, and writes `package.json` into the output
+directory, which must be missing or empty. It is the same script that the
+release workflow runs.
+
+For a direct `<script type="module">`, run `wasm-bindgen --target web` on
+`rust/target/wasm32-unknown-unknown/release/kit_wasm.wasm`. That target exports
+the classic `await init()` default.
+
+The Rust project archived `wasm-pack` with the rustwasm organization, so this
+crate does not use it.
+
+## Usage
+
+The `bundler` build starts the wasm module when you import it. There is no
+`init` export to await. Import the functions you need:
+
+```ts
+import { blake3_hex, commit_verify, attest_build, attest_verify } from "@officialunofficial/kit-wasm";
+
+const id = blake3_hex(new TextEncoder().encode("hello"));
+console.log(id); // 64-character lowercase hex
+```
+
+## Exported functions
+
+Content-addressing and objects:
+- `blake3_hex(bytes) -> string` &mdash; BLAKE3 of arbitrary bytes as 64-char hex.
+- `blob_encode(bytes) -> { bytes, hash_hex }` &mdash; canonical blob object.
+- `tree_encode(entries_json) -> { bytes, hash_hex }` &mdash; canonical tree object.
+- `commit_encode_and_sign(...)` &mdash; encode and sign a commit object.
+- `commit_verify(commit_bytes) -> bool` &mdash; verify a signed commit.
+
+Signing primitives:
+- `keypair_from_seed(seed_hex)` / `keypair_generate()` &mdash; Ed25519 keys.
+- `sign_bytes_commit_domain(seed_hex, bytes) -> sig_hex`.
+- `verify_bytes_commit_domain(pubkey_hex, bytes, sig_hex) -> bool`.
+
+Attestations (in-toto/DSSE-style envelopes):
+- `attest_keypair(seed_hex, algo)` &mdash; ed25519, secp256k1, or p256.
+- `attest_build(...)` &mdash; build and sign an envelope.
+- `attest_verify(envelope_json, pubkey_hex, algo) -> bool`.
+
+Chunking, delta, and streaming:
+- `chunk_boundaries(bytes)` &mdash; FastCDC chunk boundary report.
+- `chunked_blob_encode(bytes)` &mdash; chunked-blob object construction.
+- `chunked_blob_decode(bytes) -> json` &mdash; `{ total_size, chunk_size, chunks }` from a canonical `ChunkedBlob` (16 MiB cap).
+- `delta_encode(base, target)` &mdash; produce a delta summary.
+- `bao_encode(bytes)` &mdash; Bao outboard over **raw** file bytes (for streaming demos).
+- `bao_slice(...)` / `bao_verify_slice(...)` &mdash; verified streaming of those raw bytes.
+- `blob_bao_encode(content)` &mdash; Bao outboard over **canonical blob bytes**; `hash_hex` equals the blob id.
+- `blob_bao_slice(outboard, content, content_offset, len)` &mdash; content offsets; the +10 canonical shift is inside.
+- `blob_bao_verify_slice(blob_id_hex, slice, content_offset, len)` &mdash; delegates to `kit_core::verify::verify_blob_slice`.
+
+Disclosure and closure verification:
+- `verify_disclosure(commit_id_hex, bundle) -> json` &mdash; path, leaf, signer, payload summary **without** bytes, plus `step_inner_roots` (hex array) and `chunk_inner_root` (hex or `null`). Bundles are capped at 64 MiB (`MAX_BUNDLE_BYTES`).
+- `disclosure_payload_bytes(commit_id_hex, bundle) -> bytes` &mdash; verified payload bytes; re-verifies. Call `verify_disclosure` first; treat a failure of either as a failure.
+- `verify_disclosure_span(commit_id_hex, container) -> VerifiedSpan` &mdash; verify a KDSP v1 multi-chunk span once against a trusted commit. Its `json` getter returns authenticated path, leaf, signer, signature validity, offset, span and chunk indices, byte length and BLAKE3; its `bytes` getter returns the authenticated range bytes. The container is capped at 64 MiB. Errors begin with the `span_*` reject reason, except a malformed `commit_id_hex`, which begins with `invalid_input:` (it is not a SPEC-DISCLOSURE §8.2 condition).
+- `verify_closure_packs(root_hex, mode, packs, pack_lengths_json) -> json` &mdash; `mode` is `"snapshot"` or `"history"`. `packs` is the concatenation of each pack; `pack_lengths_json` is a JSON array of those lengths (for example `"[1024,2048]"`). Concatenated packs are capped independently of a disclosure bundle, at 1 GiB (`MAX_CLOSURE_INPUT_BYTES`, matching the native store's per-object cap) &mdash; a closure is every object reachable from a commit, a realistically much larger shape than a handful of proofs. The result includes `unreferenced_checked: true` because the pack index can enumerate every supplied object.
+- `verify_closure_manifest(expected_root_hex, manifest, packs, pack_lengths_json) -> json` &mdash; same pack framing; the manifest is a locator, never a trust anchor. Both closure exports return `unreferenced_checked` alongside `root`, `mode`, `verified`, `complete`, `missing`, `corrupt`, and `unreferenced`.
+- `verify_tree_entry(tree_id_hex, entry_json, position, proof) -> bool` &mdash; `entry_json` is `{ "name" | "name_hex", "mode", "object_hash" }`. Returns `false` when the proof does not fold to the id; throws on malformed input.
+- `verify_chunk(chunked_id_hex, chunk_id_hex, position, proof) -> bool` &mdash; same accept/reject split. Position 0 is never a chunk.
+- `wrap_object_id(kind, inner_root_hex) -> hex` &mdash; `kind` is `"tree"` or `"chunked_blob"`. Apply after a commonware BMT verifier checked the inner root.
+
+### Verifying a commit hash
+
+A verified disclosure proves the bytes belong to that commit id; `signature_valid` proves the embedded signer produced the commit; binding that signer to a person or org is application policy.
+
+```ts
+import {
+  verify_disclosure,
+  verify_closure_manifest,
+} from "@officialunofficial/kit-wasm";
+
+const commitId = "…64-char hex…"; // the id you already trust
+const disclosed = JSON.parse(verify_disclosure(commitId, bundle));
+// disclosed.payload has kind/bytes_len/bytes_blake3, not the bytes
+
+const packs = [pack0, pack1];
+const concat = new Uint8Array(packs.reduce((n, p) => n + p.byteLength, 0));
+let off = 0;
+for (const p of packs) {
+  concat.set(p, off);
+  off += p.byteLength;
+}
+const report = JSON.parse(
+  verify_closure_manifest(
+    commitId,
+    manifest,
+    concat,
+    JSON.stringify(packs.map((p) => p.byteLength)),
+  ),
+);
+if (!report.complete) throw new Error("closure is missing or corrupt");
+```
+
+The exact JS surface is generated by `wasm-bindgen`; refer to the
+TypeScript declarations shipped in the package for full signatures.
+
+## Versioning
+
+The crate shares the workspace version. The wasm module wraps the same Rust
+crates as the native `kit` CLI, so objects built here have the same bytes as
+objects built by the CLI.
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE-APACHE))
+- MIT license ([LICENSE-MIT](./LICENSE-MIT))
+
+at your option.