@automerge/subduction 0.8.0-alpha.1 → 0.9.0

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

@@ -29,6 +29,7 @@ export interface Transport {
     sendBytes(bytes: Uint8Array): Promise<void>;
     recvBytes(): Promise<Uint8Array>;
     disconnect(): Promise<void>;
+    onDisconnect(callback: () => void): void;
 }
 
 
@@ -70,23 +71,30 @@ export class AuthenticatedLongPoll {
  * There are three ways to obtain an `AuthenticatedTransport`:
  *
  * 1. **Custom transport** — implement the `Transport` interface
- *    (`sendBytes`/`recvBytes`/`disconnect`) and call [`setup`](Self::setup):
+ *    (`sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`) and call
+ *    [`setup`](Self::setup):
  *
  *    ```js
- *    const auth = await AuthenticatedTransport.setup(myTransport, signer, peerId);
+ *    const auth = await AuthenticatedTransport.setup(myTransport, signer, peerId, (peerId) => {
+ *        console.log(`${peerId} disconnected`);
+ *    });
  *    ```
  *
  * 2. **From WebSocket** — authenticate via [`SubductionWebSocket`] then convert:
  *
  *    ```js
- *    const wsAuth = await SubductionWebSocket.tryConnect(url, signer, peerId, timeout);
+ *    const wsAuth = await SubductionWebSocket.tryConnect(url, signer, peerId, (peerId) => {
+ *        console.log(`${peerId} disconnected`);
+ *    });
  *    const auth = wsAuth.toTransport();
  *    ```
  *
  * 3. **From HTTP long-poll** — same pattern via [`SubductionLongPoll`]:
  *
  *    ```js
- *    const lpAuth = await SubductionLongPoll.tryConnect(url, signer, peerId, timeout);
+ *    const lpAuth = await SubductionLongPoll.tryConnect(url, signer, peerId, (peerId) => {
+ *        console.log(`${peerId} disconnected`);
+ *    });
  *    const auth = lpAuth.toTransport();
  *    ```
  */
@@ -102,7 +110,7 @@ export class AuthenticatedTransport {
      *
      * # Arguments
      *
-     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`
+     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`
      * * `signer` - The responder's signer for authentication
      * * `max_drift_seconds` - Maximum acceptable clock drift in seconds (default: 600)
      *
@@ -110,19 +118,19 @@ export class AuthenticatedTransport {
      *
      * Returns a [`HandshakeError`](WasmHandshakeError) if the handshake fails.
      */
-    static accept(transport: Transport, signer: any, max_drift_seconds?: number | null): Promise<AuthenticatedTransport>;
+    static accept(transport: Transport, signer: any, max_drift_seconds?: number | null, on_disconnect?: Function | null): Promise<AuthenticatedTransport>;
     /**
      * Run the Subduction handshake over a custom transport, producing an
      * authenticated transport.
      *
      * The `transport` object must implement the `Transport` interface
-     * (`sendBytes`/`recvBytes`/`disconnect`).
+     * (`sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`).
      * The same object is used for both the handshake phase and post-handshake
      * communication.
      *
      * # Arguments
      *
-     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`
+     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`
      * * `signer` - The client's signer for authentication
      * * `expected_peer_id` - The expected server peer ID (verified during handshake)
      *
@@ -130,7 +138,7 @@ export class AuthenticatedTransport {
      *
      * Returns a [`HandshakeError`](WasmHandshakeError) if the handshake fails.
      */
-    static setup(transport: Transport, signer: any, expected_peer_id: PeerId): Promise<AuthenticatedTransport>;
+    static setup(transport: Transport, signer: any, expected_peer_id: PeerId, on_disconnect?: Function | null): Promise<AuthenticatedTransport>;
     /**
      * Run the Subduction handshake over a custom transport using discovery
      * mode, producing an authenticated transport.
@@ -141,7 +149,7 @@ export class AuthenticatedTransport {
      *
      * # Arguments
      *
-     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`
+     * * `transport` - A `Transport` implementing `sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`
      * * `signer` - The client's signer for authentication
      * * `service_name` - Shared service name for discovery.
      *   Defaults to [`DEFAULT_LOCAL_SERVICE_NAME`] (`"subduction:local"`) if omitted.
@@ -150,7 +158,7 @@ export class AuthenticatedTransport {
      *
      * Returns a [`HandshakeError`](WasmHandshakeError) if the handshake fails.
      */
-    static setupDiscover(transport: Transport, signer: any, service_name?: string | null): Promise<AuthenticatedTransport>;
+    static setupDiscover(transport: Transport, signer: any, service_name?: string | null, on_disconnect?: Function | null): Promise<AuthenticatedTransport>;
     /**
      * The verified peer identity.
      */
@@ -639,13 +647,20 @@ export class MessagePortTransport {
     free(): void;
     [Symbol.dispose](): void;
     /**
-     * Disconnect (close the port).
+     * Disconnect (close the port) and fire the `onDisconnect` callback if registered.
      */
     disconnect(): Promise<any>;
     /**
      * Create a new connection wrapping the given `MessagePort`.
      */
     constructor(port: any);
+    /**
+     * Register a callback to be invoked when the transport disconnects.
+     *
+     * Part of the [`Transport`](super::JsTransport) interface contract.
+     * Typically called by internal wiring rather than directly by user code.
+     */
+    onDisconnect(callback: Function): void;
     /**
      * Receive raw bytes (for the handshake phase).
      */
@@ -1136,7 +1151,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): 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?: any | null, on_remote_heads?: Function | null, on_ephemeral?: Function | null): Promise<Subduction>;
     /**
      * Link two local [`Subduction`](WasmSubduction) instances over a
      * [`MessageChannel`](web_sys::MessageChannel).
@@ -1161,13 +1176,23 @@ 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.
      *
      * # 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);
+    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);
+    /**
+     * Publish an ephemeral message to all subscribers of a sedimentree.
+     *
+     * The payload is opaque bytes — encoding is the caller's responsibility.
+     * Messages are fire-and-forget; delivery is best-effort.
+     */
+    publishEphemeral(id: SedimentreeId, payload: Uint8Array): Promise<void>;
     /**
      * Remove a Sedimentree and all associated data.
      *
@@ -1184,6 +1209,11 @@ export class Subduction {
      * Get all known Sedimentree IDs
      */
     sedimentreeIds(): Promise<SedimentreeId[]>;
+    /**
+     * Subscribe to ephemeral messages for the given sedimentree IDs
+     * from all connected peers.
+     */
+    subscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
     /**
      * Request batch sync for a given Sedimentree ID from all connected peers.
      *
@@ -1213,6 +1243,11 @@ export class Subduction {
      * Returns a [`WasmIoError`] if storage or networking fail.
      */
     syncWithPeer(to_ask: PeerId, id: SedimentreeId, subscribe: boolean, timeout_milliseconds?: bigint | null): Promise<PeerBatchSyncResult>;
+    /**
+     * Unsubscribe from ephemeral messages for the given sedimentree IDs
+     * from all connected peers.
+     */
+    unsubscribeEphemeral(ids: SedimentreeId[]): Promise<void>;
     /**
      * Get the backing storage.
      */
@@ -1222,7 +1257,7 @@ export class Subduction {
 /**
  * JS-facing wrapper around [`HttpLongPollTransport`] that exposes the
  * byte-oriented [`Transport`](super::JsTransport) interface
- * (`sendBytes`/`recvBytes`/`disconnect`) so it can be used as a
+ * (`sendBytes`/`recvBytes`/`disconnect`/`onDisconnect`) so it can be used as a
  * duck-typed `JsTransport` from JavaScript.
  */
 export class SubductionHttpLongPoll {
@@ -1232,11 +1267,20 @@ export class SubductionHttpLongPoll {
     /**
      * Disconnect from the peer gracefully.
      *
+     * Fires the `onDisconnect` callback if one is registered.
+     *
      * # Errors
      *
      * Returns an error if the disconnect fails.
      */
     disconnect(): Promise<void>;
+    /**
+     * Register a callback to be invoked when the transport disconnects.
+     *
+     * Part of the [`Transport`](super::JsTransport) interface contract.
+     * Typically called by internal wiring rather than directly by user code.
+     */
+    onDisconnect(callback: Function): void;
     /**
      * Receive the next message frame as raw bytes.
      *
@@ -1272,13 +1316,13 @@ export class SubductionLongPoll {
      * * `base_url` - The server's HTTP base URL (e.g., `http://localhost:8080`)
      * * `signer` - The client's signer for authentication
      * * `expected_peer_id` - The expected server peer ID (verified during handshake)
-     * * `timeout_milliseconds` - Request timeout in milliseconds (default: 30000)
+     * * `on_disconnect` - Optional callback invoked with the peer's [`PeerId`] when the connection closes
      *
      * # Errors
      *
      * Returns [`LongPollTransportError`] if connection or handshake fails.
      */
-    static tryConnect(base_url: string, signer: any, expected_peer_id: PeerId): Promise<AuthenticatedLongPoll>;
+    static tryConnect(base_url: string, signer: any, expected_peer_id: PeerId, on_disconnect?: Function | null): Promise<AuthenticatedLongPoll>;
     /**
      * Connect to a server using discovery mode.
      *
@@ -1292,7 +1336,7 @@ export class SubductionLongPoll {
      *
      * Returns [`LongPollTransportError`] if connection or handshake fails.
      */
-    static tryDiscover(base_url: string, signer: any, service_name?: string | null): Promise<AuthenticatedLongPoll>;
+    static tryDiscover(base_url: string, signer: any, service_name?: string | null, on_disconnect?: Function | null): Promise<AuthenticatedLongPoll>;
 }
 
 /**
@@ -1311,6 +1355,16 @@ export class SubductionWebSocket {
      * Disconnect from the peer gracefully.
      */
     disconnect(): Promise<void>;
+    /**
+     * Register a callback to be invoked when the WebSocket closes.
+     *
+     * Part of the [`Transport`](super::JsTransport) interface contract.
+     * Typically called by internal wiring (factory methods like `tryConnect`
+     * and `tryDiscover`) rather than directly by user code.
+     *
+     * The callback is fired from the browser WebSocket's `onclose` handler.
+     */
+    onDisconnect(callback: Function): void;
     /**
      * Receive the next message frame as raw bytes.
      *
@@ -1338,13 +1392,13 @@ export class SubductionWebSocket {
      * * `ws` - An existing WebSocket (CONNECTING or OPEN)
      * * `signer` - The client's signer for authentication
      * * `expected_peer_id` - The expected server peer ID (verified during handshake)
-     * * `timeout_milliseconds` - Request timeout in milliseconds
+     * * `on_disconnect` - Optional callback invoked with the peer's [`PeerId`] when the connection closes
      *
      * # Errors
      *
      * Returns an error if the handshake fails (signature invalid, wrong peer, etc.)
      */
-    static setup(ws: WebSocket, signer: any, expected_peer_id: PeerId): Promise<AuthenticatedWebSocket>;
+    static setup(ws: WebSocket, signer: any, expected_peer_id: PeerId, on_disconnect?: Function | null): Promise<AuthenticatedWebSocket>;
     /**
      * Connect to a WebSocket server with mutual authentication via handshake.
      *
@@ -1353,13 +1407,15 @@ export class SubductionWebSocket {
      * * `address` - The WebSocket URL to connect to
      * * `signer` - The client's signer for authentication
      * * `expected_peer_id` - The expected server peer ID (verified during handshake)
+     * * `on_disconnect` - Optional callback invoked with the peer's [`PeerId`] when the connection closes
+     *
      * # Errors
      *
      * Returns an error if:
      * - The WebSocket connection could not be established
      * - The handshake fails (signature invalid, wrong server, clock drift, etc.)
      */
-    static tryConnect(address: URL, signer: any, expected_peer_id: PeerId): Promise<AuthenticatedWebSocket>;
+    static tryConnect(address: URL, signer: any, expected_peer_id: PeerId, on_disconnect?: Function | null): Promise<AuthenticatedWebSocket>;
     /**
      * Connect to a WebSocket server using discovery mode.
      *
@@ -1371,9 +1427,9 @@ export class SubductionWebSocket {
      *
      * * `address` - The WebSocket URL to connect to
      * * `signer` - The client's signer for authentication
-     * * `timeout_milliseconds` - Request timeout in milliseconds. Defaults to 30000 (30s).
      * * `service_name` - The service name for discovery (e.g., `localhost:8080`).
      *   If omitted, the host is extracted from the URL.
+     * * `on_disconnect` - Optional callback invoked with the peer's [`PeerId`] when the connection closes
      *
      * # Errors
      *
@@ -1381,7 +1437,7 @@ export class SubductionWebSocket {
      * - The WebSocket connection could not be established
      * - The handshake fails (signature invalid, clock drift, etc.)
      */
-    static tryDiscover(address: URL, signer: any, service_name?: string | null): Promise<AuthenticatedWebSocket>;
+    static tryDiscover(address: URL, signer: any, service_name?: string | null, on_disconnect?: Function | null): Promise<AuthenticatedWebSocket>;
 }
 
 /**
@@ -1492,9 +1548,16 @@ export class SyncStats {
      */
     readonly fragmentsSent: number;
     /**
-     * Returns true if no data was exchanged.
+     * Returns true if no commits or fragments were transferred.
+     *
+     * Note: `remoteHeads` may still be non-empty (heads metadata is not
+     * considered "data" for this check).
      */
     readonly isEmpty: boolean;
+    /**
+     * The remote peer's heads for this sedimentree.
+     */
+    readonly remoteHeads: Digest[];
     /**
      * Total items received (commits + fragments).
      */
@@ -1594,8 +1657,8 @@ export interface InitOutput {
     readonly webcryptosigner_verifyingKey: (a: number) => any;
     readonly webcryptosigner_peerId: (a: number) => number;
     readonly __wbg_subduction_free: (a: number, b: number) => void;
-    readonly subduction_new: (a: any, b: any, c: number, d: number, e: number, f: number) => number;
-    readonly subduction_hydrate: (a: any, b: any, c: number, d: number, e: number, f: number) => any;
+    readonly subduction_new: (a: any, b: any, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => number;
+    readonly subduction_hydrate: (a: any, b: any, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => any;
     readonly subduction_addSedimentree: (a: number, b: number, c: number, d: number, e: number) => any;
     readonly subduction_removeSedimentree: (a: number, b: number) => any;
     readonly subduction_connect: (a: number, b: any, c: number) => any;
@@ -1618,6 +1681,9 @@ export interface InitOutput {
     readonly subduction_syncWithAllPeers: (a: number, b: number, c: number, d: number, e: bigint) => any;
     readonly subduction_fullSyncWithPeer: (a: number, b: number, c: number, d: number, e: bigint) => any;
     readonly subduction_fullSyncWithAllPeers: (a: number, b: number, c: bigint) => any;
+    readonly subduction_publishEphemeral: (a: number, b: number, c: number, d: number) => any;
+    readonly subduction_subscribeEphemeral: (a: number, b: number, c: number) => any;
+    readonly subduction_unsubscribeEphemeral: (a: number, b: number, c: number) => any;
     readonly subduction_sedimentreeIds: (a: number) => any;
     readonly subduction_getCommits: (a: number, b: number) => any;
     readonly subduction_getFragments: (a: number, b: number) => any;
@@ -1641,17 +1707,24 @@ export interface InitOutput {
     readonly syncstats_totalReceived: (a: number) => number;
     readonly syncstats_totalSent: (a: number) => number;
     readonly syncstats_isEmpty: (a: number) => number;
+    readonly syncstats_remoteHeads: (a: number) => [number, number];
+    readonly __wbg_authenticatedtransport_free: (a: number, b: number) => void;
+    readonly authenticatedtransport_setup: (a: any, b: any, c: number, d: number) => any;
+    readonly authenticatedtransport_setupDiscover: (a: any, b: any, c: number, d: number, e: number) => any;
+    readonly authenticatedtransport_accept: (a: any, b: any, c: number, d: number) => any;
+    readonly authenticatedtransport_peerId: (a: number) => number;
     readonly __wbg_subductionhttplongpoll_free: (a: number, b: number) => void;
     readonly subductionhttplongpoll_sendBytes: (a: number, b: number, c: number) => any;
     readonly subductionhttplongpoll_recvBytes: (a: number) => any;
     readonly subductionhttplongpoll_disconnect: (a: number) => any;
+    readonly subductionhttplongpoll_onDisconnect: (a: number, b: any) => void;
     readonly __wbg_authenticatedlongpoll_free: (a: number, b: number) => void;
     readonly authenticatedlongpoll_peerId: (a: number) => number;
     readonly authenticatedlongpoll_sessionId: (a: number) => [number, number];
     readonly authenticatedlongpoll_toTransport: (a: number) => number;
     readonly __wbg_subductionlongpoll_free: (a: number, b: number) => void;
-    readonly subductionlongpoll_tryConnect: (a: number, b: number, c: any, d: number) => any;
-    readonly subductionlongpoll_tryDiscover: (a: number, b: number, c: any, d: number, e: number) => any;
+    readonly subductionlongpoll_tryConnect: (a: number, b: number, c: any, d: number, e: number) => any;
+    readonly subductionlongpoll_tryDiscover: (a: number, b: number, c: any, d: number, e: number, f: number) => any;
     readonly __wbg_syncmessage_free: (a: number, b: number) => void;
     readonly syncmessage_toBytes: (a: number) => [number, number];
     readonly syncmessage_fromBytes: (a: number, b: number) => [number, number, number];
@@ -1673,18 +1746,20 @@ export interface InitOutput {
     readonly messageporttransport_sendBytes: (a: number, b: number, c: number) => any;
     readonly messageporttransport_recvBytes: (a: number) => any;
     readonly messageporttransport_disconnect: (a: number) => any;
+    readonly messageporttransport_onDisconnect: (a: number, b: any) => void;
     readonly makeMessagePortTransport: (a: any) => number;
     readonly __wbg_nonce_free: (a: number, b: number) => void;
     readonly nonce_new: (a: number, b: number) => [number, number, number];
     readonly nonce_random: () => number;
     readonly nonce_bytes: (a: number) => [number, number];
     readonly __wbg_subductionwebsocket_free: (a: number, b: number) => void;
-    readonly subductionwebsocket_setup: (a: any, b: any, c: number) => any;
-    readonly subductionwebsocket_tryConnect: (a: any, b: any, c: number) => any;
-    readonly subductionwebsocket_tryDiscover: (a: any, b: any, c: number, d: number) => any;
+    readonly subductionwebsocket_setup: (a: any, b: any, c: number, d: number) => any;
+    readonly subductionwebsocket_tryConnect: (a: any, b: any, c: number, d: number) => any;
+    readonly subductionwebsocket_tryDiscover: (a: any, b: any, c: number, d: number, e: number) => any;
     readonly subductionwebsocket_sendBytes: (a: number, b: number, c: number) => any;
     readonly subductionwebsocket_recvBytes: (a: number) => any;
     readonly subductionwebsocket_disconnect: (a: number) => any;
+    readonly subductionwebsocket_onDisconnect: (a: number, b: any) => void;
     readonly __wbg_authenticatedwebsocket_free: (a: number, b: number) => void;
     readonly authenticatedwebsocket_peerId: (a: number) => number;
     readonly authenticatedwebsocket_toTransport: (a: number) => number;
@@ -1701,11 +1776,6 @@ export interface InitOutput {
     readonly batchsyncresponse_id: (a: number) => number;
     readonly batchsyncresponse_request_id: (a: number) => number;
     readonly batchsyncresponse___wasm_refgen_toWasmBatchSyncResponse: (a: number) => number;
-    readonly __wbg_authenticatedtransport_free: (a: number, b: number) => void;
-    readonly authenticatedtransport_setup: (a: any, b: any, c: number) => any;
-    readonly authenticatedtransport_setupDiscover: (a: any, b: any, c: number, d: number) => any;
-    readonly authenticatedtransport_accept: (a: any, b: any, c: number) => any;
-    readonly authenticatedtransport_peerId: (a: number) => number;
     readonly memorysigner_new: () => number;
     readonly messageporttransport_new: (a: any) => number;
     readonly __wbg_webcryptosigner_free: (a: number, b: number) => void;
@@ -1788,14 +1858,15 @@ export interface InitOutput {
     readonly sedimentreeid___wasm_refgen_toWasmSedimentreeId: (a: number) => number;
     readonly sedimentreeid_toBytes: (a: number) => [number, number];
     readonly fragmentwithblob_blob: (a: number) => any;
-    readonly __wasm_bindgen_func_elem_255: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_1476: (a: number, b: number, c: any) => [number, number];
-    readonly __wasm_bindgen_func_elem_1476_183: (a: number, b: number, c: any, d: any) => void;
-    readonly __wasm_bindgen_func_elem_1476_184: (a: number, b: number, c: any, d: any) => void;
-    readonly __wasm_bindgen_func_elem_552: (a: number, b: number, c: any) => void;
-    readonly __wasm_bindgen_func_elem_552_1: (a: number, b: number, c: any) => void;
-    readonly __wasm_bindgen_func_elem_552_2: (a: number, b: number, c: any) => void;
-    readonly __wasm_bindgen_func_elem_552_3: (a: number, b: number, c: any) => void;
+    readonly __wasm_bindgen_func_elem_274: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_1605: (a: number, b: number, c: any) => [number, number];
+    readonly __wasm_bindgen_func_elem_1605_191: (a: number, b: number, c: any, d: any) => void;
+    readonly __wasm_bindgen_func_elem_1605_192: (a: number, b: number, c: any, d: any) => void;
+    readonly __wasm_bindgen_func_elem_590: (a: number, b: number, c: any) => void;
+    readonly __wasm_bindgen_func_elem_590_1: (a: number, b: number, c: any) => void;
+    readonly __wasm_bindgen_func_elem_590_2: (a: number, b: number, c: any) => void;
+    readonly __wasm_bindgen_func_elem_590_3: (a: number, b: number, c: any) => void;
+    readonly __wasm_bindgen_func_elem_589: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;