@automerge/subduction 0.9.0 → 0.10.1

package/dist/index.d.ts

@@ -1,6 +1,35 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * Connection and storage authorization policy.
+ *
+ * Throwing (or returning a rejected promise) denies the operation.
+ * Resolving allows it.
+ */
+export interface Policy {
+    authorizeConnect(peerId: PeerId): Promise<void>;
+    authorizeFetch(peerId: PeerId, sedimentreeId: SedimentreeId): Promise<void>;
+    authorizePut(requestor: PeerId, author: PeerId, sedimentreeId: SedimentreeId): Promise<void>;
+    filterAuthorizedFetch(peerId: PeerId, ids: SedimentreeId[]): Promise<SedimentreeId[]>;
+}
+
+
+
+/**
+ * Ephemeral message authorization policy.
+ *
+ * Throwing (or returning a rejected promise) denies the operation.
+ * Resolving allows it.
+ */
+export interface EphemeralPolicy {
+    authorizeSubscribe(peerId: PeerId, topic: Topic): Promise<void>;
+    authorizePublish(peerId: PeerId, topic: Topic): Promise<void>;
+    filterAuthorizedSubscribers(topic: Topic, peers: PeerId[]): Promise<PeerId[]>;
+}
+
+
+
 export interface SedimentreeStorage {
     saveSedimentreeId(sedimentreeId: SedimentreeId): Promise<void>;
     deleteSedimentreeId(sedimentreeId: SedimentreeId): Promise<void>;
@@ -21,6 +50,9 @@ export interface SedimentreeStorage {
     loadAllFragments(sedimentreeId: SedimentreeId): Promise<FragmentWithBlob[]>;
     deleteFragment(sedimentreeId: SedimentreeId, digest: Digest): 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>;
 }
 
 
@@ -1141,6 +1173,10 @@ export class Subduction {
      *   When set, clients can connect without knowing the server's peer ID.
      * * `hash_metric_override` - Optional custom depth metric function
      * * `max_pending_blob_requests` - Optional maximum number of pending blob requests (default: 10,000)
+     * * `policy` - Optional connection/storage authorization policy.
+     *   Defaults to allow-all.
+     * * `ephemeral_policy` - Optional ephemeral message authorization policy.
+     *   Defaults to allow-all.
      *
      * # Panics
      *
@@ -1151,7 +1187,7 @@ export class Subduction {
      *
      * Returns [`WasmHydrationError`] if hydration fails.
      */
-    static hydrate(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: any | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null): Promise<Subduction>;
+    static hydrate(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: Policy | null, ephemeral_policy?: EphemeralPolicy | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null): Promise<Subduction>;
     /**
      * Link two local [`Subduction`](WasmSubduction) instances over a
      * [`MessageChannel`](web_sys::MessageChannel).
@@ -1176,23 +1212,28 @@ export class Subduction {
      *   When set, clients can connect without knowing the server's peer ID.
      * * `hash_metric_override` - Optional custom depth metric function
      * * `max_pending_blob_requests` - Optional maximum number of pending blob requests (default: 10,000)
-     * * `policy` - Optional JS object implementing authorization.
-     *   Must have `authorizeConnect(...)`, `authorizeFetch(...)`, `authorizePut(...)`,
-     *   `filterAuthorizedFetch(...)`. Defaults to allow-all.
+     * * `policy` - Optional connection/storage authorization policy.
+     *   Defaults to allow-all.
+     * * `ephemeral_policy` - Optional ephemeral message authorization policy.
+     *   Defaults to allow-all.
      *
      * # Panics
      *
      * Panics if `hash_metric_override` is `Some` but the underlying JS value
      * cannot be cast to a `Function`.
      */
-    constructor(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: any | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null);
+    constructor(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: Policy | null, ephemeral_policy?: EphemeralPolicy | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null);
     /**
-     * Publish an ephemeral message to all subscribers of a sedimentree.
+     * Publish an ephemeral message to all subscribers of a topic.
      *
      * The payload is opaque bytes — encoding is the caller's responsibility.
      * Messages are fire-and-forget; delivery is best-effort.
+     *
+     * # Panics
+     *
+     * Panics if the platform's random number generator fails.
      */
-    publishEphemeral(id: SedimentreeId, payload: Uint8Array): Promise<void>;
+    publishEphemeral(topic: Topic, payload: Uint8Array): Promise<void>;
     /**
      * Remove a Sedimentree and all associated data.
      *
@@ -1210,10 +1251,10 @@ export class Subduction {
      */
     sedimentreeIds(): Promise<SedimentreeId[]>;
     /**
-     * Subscribe to ephemeral messages for the given sedimentree IDs
+     * Subscribe to ephemeral messages for the given topics
      * from all connected peers.
      */
-    subscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
+    subscribeEphemeral(topics: Topic[]): Promise<void>;
     /**
      * Request batch sync for a given Sedimentree ID from all connected peers.
      *
@@ -1244,10 +1285,10 @@ export class Subduction {
      */
     syncWithPeer(to_ask: PeerId, id: SedimentreeId, subscribe: boolean, timeout_milliseconds?: bigint | null): Promise<PeerBatchSyncResult>;
     /**
-     * Unsubscribe from ephemeral messages for the given sedimentree IDs
+     * Unsubscribe from ephemeral messages for the given topics
      * from all connected peers.
      */
-    unsubscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
+    unsubscribeEphemeral(topics: Topic[]): Promise<void>;
     /**
      * Get the backing storage.
      */
@@ -1568,6 +1609,37 @@ export class SyncStats {
     readonly totalSent: number;
 }
 
+/**
+ * A Wasm wrapper around the ephemeral [`Topic`] type.
+ *
+ * Topics are opaque 32-byte identifiers for ephemeral pubsub channels.
+ * A [`SedimentreeId`] can be used as a topic, but topics are not
+ * limited to sedimentrees.
+ *
+ * [`SedimentreeId`]: sedimentree_core::id::SedimentreeId
+ */
+export class Topic {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create a topic from a 32-byte array.
+     *
+     * # Errors
+     *
+     * Returns an error if the provided byte array is not exactly 32 bytes.
+     */
+    static fromBytes(bytes: Uint8Array): Topic;
+    /**
+     * Returns the raw 32 bytes of this topic.
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Returns a shortened hex prefix representation (first 4 bytes + `…`).
+     */
+    toString(): string;
+}
+
 /**
  * An Ed25519 signer using the browser's `WebCrypto` API.
  *

package/dist/wasm_bindgen/bundler/snippets/subduction_wasm-ec51bcf335db35bd/inline0.js

@@ -0,0 +1,8 @@
+
+export function makeOpenEphemeralPolicy() {
+    return {
+        authorizeSubscribe() { return Promise.resolve(); },
+        authorizePublish() { return Promise.resolve(); },
+        filterAuthorizedSubscribers(_topic, peers) { return Promise.resolve(peers); },
+    };
+}

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

@@ -1,6 +1,35 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * Connection and storage authorization policy.
+ *
+ * Throwing (or returning a rejected promise) denies the operation.
+ * Resolving allows it.
+ */
+export interface Policy {
+    authorizeConnect(peerId: PeerId): Promise<void>;
+    authorizeFetch(peerId: PeerId, sedimentreeId: SedimentreeId): Promise<void>;
+    authorizePut(requestor: PeerId, author: PeerId, sedimentreeId: SedimentreeId): Promise<void>;
+    filterAuthorizedFetch(peerId: PeerId, ids: SedimentreeId[]): Promise<SedimentreeId[]>;
+}
+
+
+
+/**
+ * Ephemeral message authorization policy.
+ *
+ * Throwing (or returning a rejected promise) denies the operation.
+ * Resolving allows it.
+ */
+export interface EphemeralPolicy {
+    authorizeSubscribe(peerId: PeerId, topic: Topic): Promise<void>;
+    authorizePublish(peerId: PeerId, topic: Topic): Promise<void>;
+    filterAuthorizedSubscribers(topic: Topic, peers: PeerId[]): Promise<PeerId[]>;
+}
+
+
+
 export interface SedimentreeStorage {
     saveSedimentreeId(sedimentreeId: SedimentreeId): Promise<void>;
     deleteSedimentreeId(sedimentreeId: SedimentreeId): Promise<void>;
@@ -21,6 +50,9 @@ export interface SedimentreeStorage {
     loadAllFragments(sedimentreeId: SedimentreeId): Promise<FragmentWithBlob[]>;
     deleteFragment(sedimentreeId: SedimentreeId, digest: Digest): 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>;
 }
 
 
@@ -1141,6 +1173,10 @@ export class Subduction {
      *   When set, clients can connect without knowing the server's peer ID.
      * * `hash_metric_override` - Optional custom depth metric function
      * * `max_pending_blob_requests` - Optional maximum number of pending blob requests (default: 10,000)
+     * * `policy` - Optional connection/storage authorization policy.
+     *   Defaults to allow-all.
+     * * `ephemeral_policy` - Optional ephemeral message authorization policy.
+     *   Defaults to allow-all.
      *
      * # Panics
      *
@@ -1151,7 +1187,7 @@ export class Subduction {
      *
      * Returns [`WasmHydrationError`] if hydration fails.
      */
-    static hydrate(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: any | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null): Promise<Subduction>;
+    static hydrate(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: Policy | null, ephemeral_policy?: EphemeralPolicy | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null): Promise<Subduction>;
     /**
      * Link two local [`Subduction`](WasmSubduction) instances over a
      * [`MessageChannel`](web_sys::MessageChannel).
@@ -1176,23 +1212,28 @@ export class Subduction {
      *   When set, clients can connect without knowing the server's peer ID.
      * * `hash_metric_override` - Optional custom depth metric function
      * * `max_pending_blob_requests` - Optional maximum number of pending blob requests (default: 10,000)
-     * * `policy` - Optional JS object implementing authorization.
-     *   Must have `authorizeConnect(...)`, `authorizeFetch(...)`, `authorizePut(...)`,
-     *   `filterAuthorizedFetch(...)`. Defaults to allow-all.
+     * * `policy` - Optional connection/storage authorization policy.
+     *   Defaults to allow-all.
+     * * `ephemeral_policy` - Optional ephemeral message authorization policy.
+     *   Defaults to allow-all.
      *
      * # Panics
      *
      * Panics if `hash_metric_override` is `Some` but the underlying JS value
      * cannot be cast to a `Function`.
      */
-    constructor(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: any | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null);
+    constructor(signer: any, storage: SedimentreeStorage, service_name?: string | null, hash_metric_override?: (digest: Digest) => Depth | null, max_pending_blob_requests?: number | null, policy?: Policy | null, ephemeral_policy?: EphemeralPolicy | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null);
     /**
-     * Publish an ephemeral message to all subscribers of a sedimentree.
+     * Publish an ephemeral message to all subscribers of a topic.
      *
      * The payload is opaque bytes — encoding is the caller's responsibility.
      * Messages are fire-and-forget; delivery is best-effort.
+     *
+     * # Panics
+     *
+     * Panics if the platform's random number generator fails.
      */
-    publishEphemeral(id: SedimentreeId, payload: Uint8Array): Promise<void>;
+    publishEphemeral(topic: Topic, payload: Uint8Array): Promise<void>;
     /**
      * Remove a Sedimentree and all associated data.
      *
@@ -1210,10 +1251,10 @@ export class Subduction {
      */
     sedimentreeIds(): Promise<SedimentreeId[]>;
     /**
-     * Subscribe to ephemeral messages for the given sedimentree IDs
+     * Subscribe to ephemeral messages for the given topics
      * from all connected peers.
      */
-    subscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
+    subscribeEphemeral(topics: Topic[]): Promise<void>;
     /**
      * Request batch sync for a given Sedimentree ID from all connected peers.
      *
@@ -1244,10 +1285,10 @@ export class Subduction {
      */
     syncWithPeer(to_ask: PeerId, id: SedimentreeId, subscribe: boolean, timeout_milliseconds?: bigint | null): Promise<PeerBatchSyncResult>;
     /**
-     * Unsubscribe from ephemeral messages for the given sedimentree IDs
+     * Unsubscribe from ephemeral messages for the given topics
      * from all connected peers.
      */
-    unsubscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
+    unsubscribeEphemeral(topics: Topic[]): Promise<void>;
     /**
      * Get the backing storage.
      */
@@ -1568,6 +1609,37 @@ export class SyncStats {
     readonly totalSent: number;
 }
 
+/**
+ * A Wasm wrapper around the ephemeral [`Topic`] type.
+ *
+ * Topics are opaque 32-byte identifiers for ephemeral pubsub channels.
+ * A [`SedimentreeId`] can be used as a topic, but topics are not
+ * limited to sedimentrees.
+ *
+ * [`SedimentreeId`]: sedimentree_core::id::SedimentreeId
+ */
+export class Topic {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create a topic from a 32-byte array.
+     *
+     * # Errors
+     *
+     * Returns an error if the provided byte array is not exactly 32 bytes.
+     */
+    static fromBytes(bytes: Uint8Array): Topic;
+    /**
+     * Returns the raw 32 bytes of this topic.
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Returns a shortened hex prefix representation (first 4 bytes + `…`).
+     */
+    toString(): string;
+}
+
 /**
  * An Ed25519 signer using the browser's `WebCrypto` API.
  *

package/dist/wasm_bindgen/bundler/subduction_wasm.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./subduction_wasm_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    AuthenticatedLongPoll, AuthenticatedTransport, AuthenticatedWebSocket, BatchSyncRequest, BatchSyncResponse, BlobMeta, CallError, CommitWithBlob, Depth, Digest, Fragment, FragmentRequested, FragmentWithBlob, FragmentsArray, HashMetric, LooseCommit, MemorySigner, MemoryStorage, MessagePortTransport, Nonce, PeerBatchSyncResult, PeerId, PeerResultMap, RequestId, Sedimentree, SedimentreeId, SedimentreeIdsArray, SignedFragment, SignedLooseCommit, Subduction, SubductionHttpLongPoll, SubductionLongPoll, SubductionWebSocket, SyncMessage, SyncStats, WebCryptoSigner, makeMessagePortTransport, start
+    AuthenticatedLongPoll, AuthenticatedTransport, AuthenticatedWebSocket, BatchSyncRequest, BatchSyncResponse, BlobMeta, CallError, CommitWithBlob, Depth, Digest, Fragment, FragmentRequested, FragmentWithBlob, FragmentsArray, HashMetric, LooseCommit, MemorySigner, MemoryStorage, MessagePortTransport, Nonce, PeerBatchSyncResult, PeerId, PeerResultMap, RequestId, Sedimentree, SedimentreeId, SedimentreeIdsArray, SignedFragment, SignedLooseCommit, Subduction, SubductionHttpLongPoll, SubductionLongPoll, SubductionWebSocket, SyncMessage, SyncStats, Topic, WebCryptoSigner, makeMessagePortTransport, start
 } from "./subduction_wasm_bg.js";