@automerge/sedimentree 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -7,23 +7,23 @@ export interface SedimentreeStorage {
     loadAllSedimentreeIds(): Promise<SedimentreeId[]>;
 
     // Compound storage for commits (signed data + blob stored together)
-    saveCommit(sedimentreeId: SedimentreeId, digest: Digest, signedCommit: SignedLooseCommit, blob: Uint8Array): Promise<void>;
-    loadCommit(sedimentreeId: SedimentreeId, digest: Digest): Promise<CommitWithBlob | null>;
-    listCommitDigests(sedimentreeId: SedimentreeId): Promise<Digest[]>;
+    saveCommit(sedimentreeId: SedimentreeId, commitId: CommitId, signedCommit: SignedLooseCommit, blob: Uint8Array): Promise<void>;
+    loadCommit(sedimentreeId: SedimentreeId, commitId: CommitId): Promise<CommitWithBlob | null>;
+    listCommitIds(sedimentreeId: SedimentreeId): Promise<CommitId[]>;
     loadAllCommits(sedimentreeId: SedimentreeId): Promise<CommitWithBlob[]>;
-    deleteCommit(sedimentreeId: SedimentreeId, digest: Digest): Promise<void>;
+    deleteCommit(sedimentreeId: SedimentreeId, commitId: CommitId): Promise<void>;
     deleteAllCommits(sedimentreeId: SedimentreeId): Promise<void>;
 
     // Compound storage for fragments (signed data + blob stored together)
-    saveFragment(sedimentreeId: SedimentreeId, digest: Digest, signedFragment: SignedFragment, blob: Uint8Array): Promise<void>;
-    loadFragment(sedimentreeId: SedimentreeId, digest: Digest): Promise<FragmentWithBlob | null>;
-    listFragmentDigests(sedimentreeId: SedimentreeId): Promise<Digest[]>;
+    saveFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId, signedFragment: SignedFragment, blob: Uint8Array): Promise<void>;
+    loadFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId): Promise<FragmentWithBlob | null>;
+    listFragmentIds(sedimentreeId: SedimentreeId): Promise<CommitId[]>;
     loadAllFragments(sedimentreeId: SedimentreeId): Promise<FragmentWithBlob[]>;
-    deleteFragment(sedimentreeId: SedimentreeId, digest: Digest): Promise<void>;
+    deleteFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId): Promise<void>;
     deleteAllFragments(sedimentreeId: SedimentreeId): Promise<void>;
 
     // Batch save: write all commits + fragments in a single storage transaction.
-    saveBatchAll(sedimentreeId: SedimentreeId, commits: Array<{digest: Digest, signedCommit: SignedLooseCommit, blob: Uint8Array}>, fragments: Array<{digest: Digest, signedFragment: SignedFragment, blob: Uint8Array}>): Promise<number>;
+    saveBatchAll(sedimentreeId: SedimentreeId, commits: Array<{commitId: CommitId, signedCommit: SignedLooseCommit, blob: Uint8Array}>, fragments: Array<{fragmentHead: CommitId, signedFragment: SignedFragment, blob: Uint8Array}>): Promise<number>;
 }
 
 
@@ -55,6 +55,63 @@ export class BlobMeta {
     readonly sizeBytes: bigint;
 }
 
+/**
+ * A user-supplied opaque identifier for a loose commit.
+ *
+ * Unlike [`Digest`](crate::digest::WasmDigest), which is a content hash
+ * computed by the system, `CommitId` is provided by the caller at construction
+ * time. This is the identity used for DAG traversal, fragment boundaries,
+ * and sync.
+ */
+export class CommitId {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`WasmCommitId`].
+     */
+    __wasm_refgen_toWasmCommitId(): CommitId;
+    /**
+     * Creates a new commit identifier from its Base58 string representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the string cannot be decoded or is not 32 bytes.
+     */
+    static fromBase58(s: string): CommitId;
+    /**
+     * Creates a new commit identifier from its byte representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the byte slice is not exactly 32 bytes.
+     */
+    static fromBytes(bytes: Uint8Array): CommitId;
+    /**
+     * Creates a new commit identifier from its hexadecimal string representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the string is not valid hex or not 32 bytes.
+     */
+    static fromHexString(s: string): CommitId;
+    /**
+     * Creates a new commit identifier from its byte representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the byte slice is not exactly 32 bytes.
+     */
+    constructor(bytes: Uint8Array);
+    /**
+     * Returns the byte representation of the commit identifier.
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Returns the hexadecimal string representation.
+     */
+    toHexString(): string;
+}
+
 /**
  * A commit stored with its associated blob.
  */
@@ -175,19 +232,19 @@ export class Fragment {
     /**
      * Create a new fragment from the given sedimentree ID, head, boundary, checkpoints, and blob metadata.
      */
-    constructor(sedimentree_id: SedimentreeId, head: Digest, boundary: Digest[], checkpoints: Digest[], blob_meta: BlobMeta);
+    constructor(sedimentree_id: SedimentreeId, head: CommitId, boundary: CommitId[], checkpoints: CommitId[], blob_meta: BlobMeta);
     /**
      * Get the blob metadata of the fragment.
      */
     readonly blobMeta: BlobMeta;
     /**
-     * Get the boundary digests of the fragment.
+     * Get the boundary commit identifiers of the fragment.
      */
-    readonly boundary: Digest[];
+    readonly boundary: CommitId[];
     /**
-     * Get the head digest of the fragment.
+     * Get the head commit identifier of the fragment.
      */
-    readonly head: Digest;
+    readonly head: CommitId;
 }
 
 /**
@@ -235,21 +292,25 @@ export class LooseCommit {
      */
     __wasm_refgen_toWasmLooseCommit(): LooseCommit;
     /**
-     * Create a new `LooseCommit` from the given sedimentree ID, parents, and blob metadata.
+     * Create a new `LooseCommit` from the given sedimentree ID, head, parents, and blob metadata.
      */
-    constructor(sedimentree_id: SedimentreeId, parents: Digest[], blob_meta: BlobMeta);
+    constructor(sedimentree_id: SedimentreeId, head: CommitId, parents: CommitId[], blob_meta: BlobMeta);
     /**
      * Get the blob metadata of the commit.
      */
     readonly blobMeta: BlobMeta;
     /**
-     * Get the digest of the commit.
+     * Get the commit's head identifier.
+     */
+    readonly commitId: CommitId;
+    /**
+     * Get the digest of the commit (content hash).
      */
     readonly digest: Digest;
     /**
-     * Get the parent digests of the commit.
+     * Get the parent commit identifiers.
      */
-    readonly parents: Digest[];
+    readonly parents: CommitId[];
 }
 
 /**
@@ -269,25 +330,25 @@ export class MemoryStorage {
      */
     deleteAllFragments(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * Delete a commit by digest.
+     * Delete a single commit by its ID.
      */
-    deleteCommit(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    deleteCommit(sedimentree_id: SedimentreeId, commit_id: CommitId): Promise<any>;
     /**
-     * Delete a fragment by digest.
+     * Delete a fragment by its identifier.
      */
-    deleteFragment(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    deleteFragment(sedimentree_id: SedimentreeId, fragment_head: CommitId): Promise<any>;
     /**
      * Delete a sedimentree ID.
      */
     deleteSedimentreeId(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * List all commit digests for a sedimentree.
+     * List all commit IDs for a sedimentree.
      */
-    listCommitDigests(sedimentree_id: SedimentreeId): Promise<any>;
+    listCommitIds(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * List all fragment digests for a sedimentree.
+     * List all fragment IDs for a sedimentree.
      */
-    listFragmentDigests(sedimentree_id: SedimentreeId): Promise<any>;
+    listFragmentIds(sedimentree_id: SedimentreeId): Promise<any>;
     /**
      * Load all commits for a sedimentree, returning `CommitWithBlob[]`.
      */
@@ -301,25 +362,38 @@ export class MemoryStorage {
      */
     loadAllSedimentreeIds(): Promise<any>;
     /**
-     * Load a commit by digest, returning `CommitWithBlob` or null.
+     * Load a single commit by its ID, returning `CommitWithBlob` or null.
      */
-    loadCommit(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    loadCommit(sedimentree_id: SedimentreeId, commit_id: CommitId): Promise<any>;
     /**
-     * Load a fragment by digest, returning `FragmentWithBlob` or null.
+     * Load a fragment by its identifier, returning `FragmentWithBlob` or null.
      */
-    loadFragment(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    loadFragment(sedimentree_id: SedimentreeId, fragment_head: CommitId): Promise<any>;
     /**
      * Create a new in-memory storage instance.
      */
     constructor();
+    /**
+     * Save commits and fragments in a single batch.
+     */
+    saveBatchAll(sedimentree_id: SedimentreeId, commits: Array<any>, fragments: Array<any>): Promise<any>;
     /**
      * Save a commit with its blob.
+     *
+     * The `commit_id` parameter must match the `head()` embedded in
+     * the signed commit payload. Returns an error if they differ.
+     *
+     * # Errors
+     *
+     * Returns a JS error if:
+     * - The signed payload cannot be decoded
+     * - The `commit_id` does not match the embedded `head()`
      */
-    saveCommit(sedimentree_id: SedimentreeId, _digest: Digest, signed_commit: SignedLooseCommit, blob: Uint8Array): Promise<any>;
+    saveCommit(sedimentree_id: SedimentreeId, commit_id: CommitId, signed_commit: SignedLooseCommit, blob: Uint8Array): Promise<any>;
     /**
      * Save a fragment with its blob.
      */
-    saveFragment(sedimentree_id: SedimentreeId, _digest: Digest, signed_fragment: SignedFragment, blob: Uint8Array): Promise<any>;
+    saveFragment(sedimentree_id: SedimentreeId, _fragment_head: CommitId, signed_fragment: SignedFragment, blob: Uint8Array): Promise<any>;
     /**
      * Save a sedimentree ID.
      */

package/dist/wasm_bindgen/bundler/sedimentree_wasm.d.ts

@@ -7,23 +7,23 @@ export interface SedimentreeStorage {
     loadAllSedimentreeIds(): Promise<SedimentreeId[]>;
 
     // Compound storage for commits (signed data + blob stored together)
-    saveCommit(sedimentreeId: SedimentreeId, digest: Digest, signedCommit: SignedLooseCommit, blob: Uint8Array): Promise<void>;
-    loadCommit(sedimentreeId: SedimentreeId, digest: Digest): Promise<CommitWithBlob | null>;
-    listCommitDigests(sedimentreeId: SedimentreeId): Promise<Digest[]>;
+    saveCommit(sedimentreeId: SedimentreeId, commitId: CommitId, signedCommit: SignedLooseCommit, blob: Uint8Array): Promise<void>;
+    loadCommit(sedimentreeId: SedimentreeId, commitId: CommitId): Promise<CommitWithBlob | null>;
+    listCommitIds(sedimentreeId: SedimentreeId): Promise<CommitId[]>;
     loadAllCommits(sedimentreeId: SedimentreeId): Promise<CommitWithBlob[]>;
-    deleteCommit(sedimentreeId: SedimentreeId, digest: Digest): Promise<void>;
+    deleteCommit(sedimentreeId: SedimentreeId, commitId: CommitId): Promise<void>;
     deleteAllCommits(sedimentreeId: SedimentreeId): Promise<void>;
 
     // Compound storage for fragments (signed data + blob stored together)
-    saveFragment(sedimentreeId: SedimentreeId, digest: Digest, signedFragment: SignedFragment, blob: Uint8Array): Promise<void>;
-    loadFragment(sedimentreeId: SedimentreeId, digest: Digest): Promise<FragmentWithBlob | null>;
-    listFragmentDigests(sedimentreeId: SedimentreeId): Promise<Digest[]>;
+    saveFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId, signedFragment: SignedFragment, blob: Uint8Array): Promise<void>;
+    loadFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId): Promise<FragmentWithBlob | null>;
+    listFragmentIds(sedimentreeId: SedimentreeId): Promise<CommitId[]>;
     loadAllFragments(sedimentreeId: SedimentreeId): Promise<FragmentWithBlob[]>;
-    deleteFragment(sedimentreeId: SedimentreeId, digest: Digest): Promise<void>;
+    deleteFragment(sedimentreeId: SedimentreeId, fragmentHead: CommitId): Promise<void>;
     deleteAllFragments(sedimentreeId: SedimentreeId): Promise<void>;
 
     // Batch save: write all commits + fragments in a single storage transaction.
-    saveBatchAll(sedimentreeId: SedimentreeId, commits: Array<{digest: Digest, signedCommit: SignedLooseCommit, blob: Uint8Array}>, fragments: Array<{digest: Digest, signedFragment: SignedFragment, blob: Uint8Array}>): Promise<number>;
+    saveBatchAll(sedimentreeId: SedimentreeId, commits: Array<{commitId: CommitId, signedCommit: SignedLooseCommit, blob: Uint8Array}>, fragments: Array<{fragmentHead: CommitId, signedFragment: SignedFragment, blob: Uint8Array}>): Promise<number>;
 }
 
 
@@ -55,6 +55,63 @@ export class BlobMeta {
     readonly sizeBytes: bigint;
 }
 
+/**
+ * A user-supplied opaque identifier for a loose commit.
+ *
+ * Unlike [`Digest`](crate::digest::WasmDigest), which is a content hash
+ * computed by the system, `CommitId` is provided by the caller at construction
+ * time. This is the identity used for DAG traversal, fragment boundaries,
+ * and sync.
+ */
+export class CommitId {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`WasmCommitId`].
+     */
+    __wasm_refgen_toWasmCommitId(): CommitId;
+    /**
+     * Creates a new commit identifier from its Base58 string representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the string cannot be decoded or is not 32 bytes.
+     */
+    static fromBase58(s: string): CommitId;
+    /**
+     * Creates a new commit identifier from its byte representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the byte slice is not exactly 32 bytes.
+     */
+    static fromBytes(bytes: Uint8Array): CommitId;
+    /**
+     * Creates a new commit identifier from its hexadecimal string representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the string is not valid hex or not 32 bytes.
+     */
+    static fromHexString(s: string): CommitId;
+    /**
+     * Creates a new commit identifier from its byte representation.
+     *
+     * # Errors
+     *
+     * Returns an error if the byte slice is not exactly 32 bytes.
+     */
+    constructor(bytes: Uint8Array);
+    /**
+     * Returns the byte representation of the commit identifier.
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Returns the hexadecimal string representation.
+     */
+    toHexString(): string;
+}
+
 /**
  * A commit stored with its associated blob.
  */
@@ -175,19 +232,19 @@ export class Fragment {
     /**
      * Create a new fragment from the given sedimentree ID, head, boundary, checkpoints, and blob metadata.
      */
-    constructor(sedimentree_id: SedimentreeId, head: Digest, boundary: Digest[], checkpoints: Digest[], blob_meta: BlobMeta);
+    constructor(sedimentree_id: SedimentreeId, head: CommitId, boundary: CommitId[], checkpoints: CommitId[], blob_meta: BlobMeta);
     /**
      * Get the blob metadata of the fragment.
      */
     readonly blobMeta: BlobMeta;
     /**
-     * Get the boundary digests of the fragment.
+     * Get the boundary commit identifiers of the fragment.
      */
-    readonly boundary: Digest[];
+    readonly boundary: CommitId[];
     /**
-     * Get the head digest of the fragment.
+     * Get the head commit identifier of the fragment.
      */
-    readonly head: Digest;
+    readonly head: CommitId;
 }
 
 /**
@@ -235,21 +292,25 @@ export class LooseCommit {
      */
     __wasm_refgen_toWasmLooseCommit(): LooseCommit;
     /**
-     * Create a new `LooseCommit` from the given sedimentree ID, parents, and blob metadata.
+     * Create a new `LooseCommit` from the given sedimentree ID, head, parents, and blob metadata.
      */
-    constructor(sedimentree_id: SedimentreeId, parents: Digest[], blob_meta: BlobMeta);
+    constructor(sedimentree_id: SedimentreeId, head: CommitId, parents: CommitId[], blob_meta: BlobMeta);
     /**
      * Get the blob metadata of the commit.
      */
     readonly blobMeta: BlobMeta;
     /**
-     * Get the digest of the commit.
+     * Get the commit's head identifier.
+     */
+    readonly commitId: CommitId;
+    /**
+     * Get the digest of the commit (content hash).
      */
     readonly digest: Digest;
     /**
-     * Get the parent digests of the commit.
+     * Get the parent commit identifiers.
      */
-    readonly parents: Digest[];
+    readonly parents: CommitId[];
 }
 
 /**
@@ -269,25 +330,25 @@ export class MemoryStorage {
      */
     deleteAllFragments(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * Delete a commit by digest.
+     * Delete a single commit by its ID.
      */
-    deleteCommit(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    deleteCommit(sedimentree_id: SedimentreeId, commit_id: CommitId): Promise<any>;
     /**
-     * Delete a fragment by digest.
+     * Delete a fragment by its identifier.
      */
-    deleteFragment(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    deleteFragment(sedimentree_id: SedimentreeId, fragment_head: CommitId): Promise<any>;
     /**
      * Delete a sedimentree ID.
      */
     deleteSedimentreeId(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * List all commit digests for a sedimentree.
+     * List all commit IDs for a sedimentree.
      */
-    listCommitDigests(sedimentree_id: SedimentreeId): Promise<any>;
+    listCommitIds(sedimentree_id: SedimentreeId): Promise<any>;
     /**
-     * List all fragment digests for a sedimentree.
+     * List all fragment IDs for a sedimentree.
      */
-    listFragmentDigests(sedimentree_id: SedimentreeId): Promise<any>;
+    listFragmentIds(sedimentree_id: SedimentreeId): Promise<any>;
     /**
      * Load all commits for a sedimentree, returning `CommitWithBlob[]`.
      */
@@ -301,25 +362,38 @@ export class MemoryStorage {
      */
     loadAllSedimentreeIds(): Promise<any>;
     /**
-     * Load a commit by digest, returning `CommitWithBlob` or null.
+     * Load a single commit by its ID, returning `CommitWithBlob` or null.
      */
-    loadCommit(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    loadCommit(sedimentree_id: SedimentreeId, commit_id: CommitId): Promise<any>;
     /**
-     * Load a fragment by digest, returning `FragmentWithBlob` or null.
+     * Load a fragment by its identifier, returning `FragmentWithBlob` or null.
      */
-    loadFragment(sedimentree_id: SedimentreeId, digest: Digest): Promise<any>;
+    loadFragment(sedimentree_id: SedimentreeId, fragment_head: CommitId): Promise<any>;
     /**
      * Create a new in-memory storage instance.
      */
     constructor();
+    /**
+     * Save commits and fragments in a single batch.
+     */
+    saveBatchAll(sedimentree_id: SedimentreeId, commits: Array<any>, fragments: Array<any>): Promise<any>;
     /**
      * Save a commit with its blob.
+     *
+     * The `commit_id` parameter must match the `head()` embedded in
+     * the signed commit payload. Returns an error if they differ.
+     *
+     * # Errors
+     *
+     * Returns a JS error if:
+     * - The signed payload cannot be decoded
+     * - The `commit_id` does not match the embedded `head()`
      */
-    saveCommit(sedimentree_id: SedimentreeId, _digest: Digest, signed_commit: SignedLooseCommit, blob: Uint8Array): Promise<any>;
+    saveCommit(sedimentree_id: SedimentreeId, commit_id: CommitId, signed_commit: SignedLooseCommit, blob: Uint8Array): Promise<any>;
     /**
      * Save a fragment with its blob.
      */
-    saveFragment(sedimentree_id: SedimentreeId, _digest: Digest, signed_fragment: SignedFragment, blob: Uint8Array): Promise<any>;
+    saveFragment(sedimentree_id: SedimentreeId, _fragment_head: CommitId, signed_fragment: SignedFragment, blob: Uint8Array): Promise<any>;
     /**
      * Save a sedimentree ID.
      */

package/dist/wasm_bindgen/bundler/sedimentree_wasm.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./sedimentree_wasm_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    BlobMeta, CommitWithBlob, Depth, Digest, Fragment, FragmentWithBlob, FragmentsArray, LooseCommit, MemoryStorage, Sedimentree, SedimentreeId, SedimentreeIdsArray, SignedFragment, SignedLooseCommit
+    BlobMeta, CommitId, CommitWithBlob, Depth, Digest, Fragment, FragmentWithBlob, FragmentsArray, LooseCommit, MemoryStorage, Sedimentree, SedimentreeId, SedimentreeIdsArray, SignedFragment, SignedLooseCommit
 } from "./sedimentree_wasm_bg.js";