statewire 0.21.0 → 0.22.1

package/dist/host-internal.d.ts

@@ -1,96 +1,104 @@
-import { StatewireHost } from "./host.js";
-import { StatewireProtocol } from "./wire/protocol.js";
-import { WS_SUBPROTOCOL } from "./wire/version.js";
-import { StatewireSocketHost } from "./host/socket.js";
-import { clientIdFromUrl, textFrameOrClose } from "./host/adapter.js";
-//#region src/host-internal.d.ts
-declare namespace StatewireHostInternal {
-  type Socket = {
-    send: (data: string) => void;
-    close: (code?: number, reason?: string) => void;
-  };
-  type SocketConnection = {
-    readonly clientId: string;
-    message: (data: string) => void;
-    close: () => void;
-  };
-  type SocketConnectOptions = {
-    /** Upgrade headers take precedence over initialization headers. */
-    headers?: Record<string, string>;
-    /** The adapter restored this socket from an already-authorized session. */
-    authorized?: boolean;
-    authorizedAt?: number;
-    selection?: StatewireProtocol.Selection;
-    /** The restored session's captured auth value; it must satisfy the client record's principal binding. */
-    auth?: unknown;
-    /** Persist authorization (and the captured auth value) before the first snapshot is released. */
-    onAuthorized?: (auth: unknown, selection: StatewireProtocol.Selection, authorizedAt: number) => void;
-  };
-  type SocketHost = {
-    /** Null means refused: the socket was told (fin and/or close) and is dead. */
-    connect: (clientId: string, socket: Socket, options?: SocketConnectOptions) => SocketConnection | null;
-    stream: (request: Request) => Promise<Response>;
-    frames: (request: Request) => Promise<Response>;
-    finish: (fin: StatewireHost.Fin) => void;
-    dispose: () => void;
-  };
-  type Cmd = {
-    protocol: string;
-    seq: number;
-    type?: "applied" | "result" | "rejected" | "failed" | "crashed" | "expired";
-    code?: string;
-    message?: string;
-    payload?: unknown;
-    meta?: unknown;
-    /** Cumulative per lane: resending through this seq will never be needed. */
-    dur?: boolean;
-  };
-  type ClientRecord = {
-    id: string;
-    touched: number;
-    lanes: Readonly<Record<string, {
-      lastSeq: number;
-      results: readonly {
+import type { StatewireProtocol } from "./wire/protocol.js";
+import type { StatewireHost } from "./host.js";
+export { StatewireSocketHost } from "./host/socket.js";
+export { clientIdFromUrl, textFrameOrClose } from "./host/adapter.js";
+export { WS_SUBPROTOCOL } from "./wire/version.js";
+export declare namespace StatewireHostInternal {
+    type Socket = {
+        send: (data: string) => void;
+        close: (code?: number, reason?: string) => void;
+    };
+    type SocketConnection = {
+        readonly clientId: string;
+        message: (data: string) => void;
+        close: () => void;
+    };
+    type SocketConnectOptions = {
+        /** Upgrade headers take precedence over initialization headers. */
+        headers?: Record<string, string>;
+        /** The adapter restored this socket from an already-authorized session. */
+        authorized?: boolean;
+        authorizedAt?: number;
+        selection?: StatewireProtocol.Selection;
+        /** The restored session's captured auth value; it must satisfy the client record's principal binding. */
+        auth?: unknown;
+        /** Persist authorization (and the captured auth value) before the first snapshot is released. */
+        onAuthorized?: (auth: unknown, selection: StatewireProtocol.Selection, authorizedAt: number) => void;
+        /** Documents the attach had included before the adapter retained its socket; they ride the hello. */
+        included?: readonly IncludedDocument[];
+        /** Called with the attach's whole include set each time `include` or `exclude` changes it. */
+        onIncludedChange?: (included: readonly IncludedDocument[]) => void;
+    };
+    /** A durable document an attach included: `[protocol, key]`. */
+    type IncludedDocument = readonly [
+        protocol: string,
+        key: readonly string[] | null
+    ];
+    type SocketHost = {
+        /** Null means refused: the socket was told (fin and/or close) and is dead. */
+        connect: (clientId: string, socket: Socket, options?: SocketConnectOptions) => SocketConnection | null;
+        stream: (request: Request) => Promise<Response>;
+        frames: (request: Request) => Promise<Response>;
+        finish: (fin: StatewireHost.Fin) => void;
+        dispose: () => void;
+    };
+    type Cmd = {
+        protocol: string;
         seq: number;
-        ts: number;
-        cmd: Cmd;
-      }[];
-    }>>;
-    principal: unknown;
-  };
-  type SocketHostPersistence = {
-    clientRecords?: readonly ClientRecord[];
-    onClientRecordsChange?: (records: readonly ClientRecord[]) => void;
-  };
-  type SocketHostOptions<TAuth = unknown> = {
-    protocol?: StatewireProtocol.Definition;
-    /** Key of the host protocol's main document. */
-    key?: readonly string[];
-    wireVersion?: StatewireProtocol.Range;
-    /** Gates every attach; the awaited return value is the attach's auth, exposed to command handlers as `this.caller.auth`. The first attach binds the client id's record to this value; a later attach whose value is not structurally equal is refused (HTTP 403, socket close 1008). */
-    authorize?: (ctx: {
-      headers: Record<string, string>;
-    }) => TAuth | Promise<TAuth>;
-    /** Time allowed to complete WebSocket initialization and authorization. */
-    wsInitTimeoutMs?: number;
-    heartbeatIntervalMs?: number;
-    /** Maximum attach lifetime in milliseconds; defaults to 24 hours, null disables expiry. */
-    maxLeaseLifetimeMs?: number | null;
-    /** Maximum number of concurrently attached WebSocket and SSE streams. */
-    maxSubscribers?: number;
-    /** Maximum number of admitted commands still running across all clients. */
-    maxInflightCommands?: number;
-    /** Maximum number of queued SSE packets before a lagging stream is closed. */
-    streamQueueSize?: number;
-    /** LRU cap on stored client records; live or in-flight records are exempt. */
-    clientRecordLimit?: number;
-    /** Hang every attach up with `fin: idle` at the idle flag's rising edge. */
-    finOnIdle?: boolean;
-    /** Milliseconds to defer admission, or null to admit. */
-    pushback?: () => number | null;
-  };
-  type Fin = StatewireHost.Fin;
+        type?: "applied" | "result" | "rejected" | "failed" | "crashed" | "expired";
+        code?: string;
+        message?: string;
+        payload?: unknown;
+        meta?: unknown;
+        /** Cumulative per lane: resending through this seq will never be needed. */
+        dur?: boolean;
+    };
+    type ClientRecord = {
+        id: string;
+        touched: number;
+        lanes: Readonly<Record<string, {
+            lastSeq: number;
+            results: readonly {
+                seq: number;
+                ts: number;
+                cmd: Cmd;
+            }[];
+        }>>;
+        principal: unknown;
+    };
+    type SocketHostPersistence = {
+        clientRecords?: readonly ClientRecord[];
+        onClientRecordsChange?: (records: readonly ClientRecord[]) => void;
+        /** The adapter can evict the host while its WebSockets stay open: their leases arm no timer and are checked on every message, delivery and restore instead. */
+        hibernatable?: boolean;
+    };
+    type SocketHostOptions<TAuth = unknown> = {
+        protocol?: StatewireProtocol.Definition;
+        /** Key of the host protocol's main document. */
+        key?: readonly string[];
+        wireVersion?: StatewireProtocol.Range;
+        /** Gates every attach; the awaited return value is the attach's auth, exposed to command handlers as `this.caller.auth`. The first attach binds the client id's record to this value; a later attach whose value is not structurally equal is refused (HTTP 403, socket close 1008). */
+        authorize?: (ctx: {
+            headers: Record<string, string>;
+        }) => TAuth | Promise<TAuth>;
+        /** Time allowed to complete WebSocket initialization and authorization. */
+        wsInitTimeoutMs?: number;
+        heartbeatIntervalMs?: number;
+        /** Maximum attach lifetime in milliseconds; defaults to 24 hours, null disables expiry. */
+        maxLeaseLifetimeMs?: number | null;
+        /** Maximum number of concurrently attached WebSocket and SSE streams. */
+        maxSubscribers?: number;
+        /** Maximum number of admitted commands still running across all clients. */
+        maxInflightCommands?: number;
+        /** Maximum number of queued SSE packets before a lagging stream is closed. */
+        streamQueueSize?: number;
+        /** LRU cap on stored client records; live or in-flight records are exempt. */
+        clientRecordLimit?: number;
+        /** Hang every attach up with `fin: idle` at the idle flag's rising edge. */
+        finOnIdle?: boolean;
+        /** Milliseconds to defer admission, or null to admit. */
+        pushback?: () => number | null;
+    };
+    type Fin = StatewireHost.Fin;
 }
-//#endregion
-export { StatewireHostInternal, StatewireSocketHost, WS_SUBPROTOCOL, clientIdFromUrl, textFrameOrClose };
 //# sourceMappingURL=host-internal.d.ts.map

package/dist/host-internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"host-internal.d.ts","names":[],"sources":["../src/host-internal.ts"],"mappings":";;;;;;kBAMiB;OACH;IACV,OAAO;IACP,QAAQ,eAAe;;OAGb;aACD;IACT,UAAU;IACV;;OAGU;;IAEV,UAAU;;IAEV;IACA;IACA,YAAY,kBAAkB;;IAE9B;;IAEA,gBACE,eACA,WAAW,kBAAkB,WAC7B;;OAIQ;;IAEV,UACE,kBACA,QAAQ,QACR,UAAU,yBACP;IACL,SAAS,SAAS,YAAY,QAAQ;IACtC,SAAS,SAAS,YAAY,QAAQ;IACtC,SAAS,KAAK,cAAc;IAC5B;;OAGU;IACV;IACA;IACA;IACA;IACA;IACA;IACA;;IAEA;;OAGU;IACV;IACA;IACA,OAAO,SACL;MAGI;MACA;QAAoB;QAAa;QAAY,KAAK;;;IAIxD;;OAGU;IACV,yBAAyB;IACzB,yBAAyB,kBAAkB;;OAGjC,kBAAkB;IAC5B,WAAW,kBAAkB;;IAE7B;IACA,cAAc,kBAAkB;;IAEhC,aAAa;MACX,SAAS;UACL,QAAQ,QAAQ;;IAEtB;IACA;;IAEA;;IAEA;;IAEA;;IAEA;;IAEA;;IAEA;;IAEA;;OAGU,MAAM,cAAc"}
+{"version":3,"file":"host-internal.d.ts","sourceRoot":"","sources":["../src/host-internal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAwB;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAe;AAE5C,OAAO,EAAE,mBAAmB,EAAE,yBAAsB;AACpD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,0BAAuB;AACnE,OAAO,EAAE,cAAc,EAAE,0BAAuB;AAChD,yBAAiB,qBAAqB,CAAC;IACrC,KAAY,MAAM,GAAG;QACnB,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;QAC7B,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;KACjD,CAAC;IAEF,KAAY,gBAAgB,GAAG;QAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;QAChC,KAAK,EAAE,MAAM,IAAI,CAAC;KACnB,CAAC;IAEF,KAAY,oBAAoB,GAAG;QACjC,mEAAmE;QACnE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,2EAA2E;QAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;QACxC,yGAAyG;QACzG,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,iGAAiG;QACjG,YAAY,CAAC,EAAE,CACb,IAAI,EAAE,OAAO,EACb,SAAS,EAAE,iBAAiB,CAAC,SAAS,EACtC,YAAY,EAAE,MAAM,KACjB,IAAI,CAAC;QACV,qGAAqG;QACrG,QAAQ,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;QACvC,8FAA8F;QAC9F,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,KAAK,IAAI,CAAC;KACpE,CAAC;IAEF,gEAAgE;IAChE,KAAY,gBAAgB,GAAG,SAAS;QACtC,QAAQ,EAAE,MAAM;QAChB,GAAG,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;KAC9B,CAAC;IAEF,KAAY,UAAU,GAAG;QACvB,8EAA8E;QAC9E,OAAO,EAAE,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,oBAAoB,KAC3B,gBAAgB,GAAG,IAAI,CAAC;QAC7B,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,KAAK,IAAI,CAAC;QACzC,OAAO,EAAE,MAAM,IAAI,CAAC;KACrB,CAAC;IAEF,KAAY,GAAG,GAAG;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;QAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,4EAA4E;QAC5E,GAAG,CAAC,EAAE,OAAO,CAAC;KACf,CAAC;IAEF,KAAY,YAAY,GAAG;QACzB,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,QAAQ,CACb,MAAM,CACJ,MAAM,EACN;YACE,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,SAAS;gBAAE,GAAG,EAAE,MAAM,CAAC;gBAAC,EAAE,EAAE,MAAM,CAAC;gBAAC,GAAG,EAAE,GAAG,CAAA;aAAE,EAAE,CAAC;SAC3D,CACF,CACF,CAAC;QACF,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF,KAAY,qBAAqB,GAAG;QAClC,aAAa,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;QACxC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,KAAK,IAAI,CAAC;QACnE,+JAA+J;QAC/J,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF,KAAY,iBAAiB,CAAC,KAAK,GAAG,OAAO,IAAI;QAC/C,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;QACxC,gDAAgD;QAChD,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QACxB,WAAW,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC;QACtC,wRAAwR;QACxR,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE;YAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACjC,KAAK,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7B,2EAA2E;QAC3E,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,2FAA2F;QAC3F,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACnC,yEAAyE;QACzE,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,4EAA4E;QAC5E,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,8EAA8E;QAC9E,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,8EAA8E;QAC9E,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,4EAA4E;QAC5E,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,yDAAyD;QACzD,QAAQ,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;KAChC,CAAC;IAEF,KAAY,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC;CACrC"}

package/dist/host.d.ts

@@ -1,93 +1,92 @@
-import { StatewireReject } from "./host/engine.js";
-import { useStatewireWork } from "./host/work.js";
-import { append } from "./host/draft.js";
-import { getStateHost, useStatewireCommands, useStatewireState } from "./host/host.js";
-import { syncedDocument } from "./host/synced.js";
-import { Statewire } from "./types.js";
-//#region src/host.d.ts
-declare namespace StatewireHost {
-  type Work = {
-    readonly isIdle: boolean;
-    track: <T>(task: Promise<T>) => Promise<T>;
-    schedule: (callback: () => void) => void;
-  };
-  type StateCtl<TState = unknown> = {
-    /** Apply server-vocabulary ops (root replace = whole-state swap). */
-    apply: (ops: readonly Statewire.Op[]) => void;
-    /** The committed plain state — immutably replaced per op, so a captured value is a stable snapshot. */
-    snapshot: () => TState;
-  };
-  type Document = {
-    protocol: string;
-    key: readonly string[] | null;
-    main: boolean;
-    value: unknown;
-  };
-  type StateHost = Statewire.StateSource & {
-    /** Synchronous, per locally-recorded op; the host owns batching. */
-    setOnOp: (listener: ((op: Statewire.Op) => void) | null) => void;
-    /** Mount or replace the shared document `(protocol, key)`; keyed documents reach an attach only once it `include`s them. */
-    mount: (protocol: string, value: unknown, options?: {
-      key?: readonly string[];
-      main?: boolean;
-    }) => void;
-    unmount: (protocol: string, key?: readonly string[]) => void;
-    documents: () => ReadonlyMap<string, Document>;
-    setOnDocuments: (listener: (() => void) | null) => void;
-  };
-  /**
-   * Per-invocation handle bound as `this` of a command handler: `caller` is
-   * the submitting client, `attach` the admitting attach's document view
-   * (in-process dispatch has none — reading it throws), `applied()` states the
-   * broadcast state now contains the command's effects — the client drops its
-   * optimistic overlay — before the handler settles (idempotent, a no-op after
-   * settle). The command settles when the handler's returned promise does.
-   */
-  type CommandsOptions = {
-    context?: () => Statewire.Context;
-  };
-  type Ctx = {
-    readonly caller: Caller;
-    readonly context: Statewire.Context;
-    readonly attach: Attach;
-    readonly signal: AbortSignal;
-    readonly applied: () => void;
-  };
-  /**
-   * The submitting client (`this.caller` in a command handler). Holdable
-   * across a long run: `clientId` is the client's `Statewire-Client-Id`
-   * (in-process dispatch has none — reading it throws), `auth` is the value
-   * `authorize` returned for the attach that admitted the command (undefined
-   * for a void `authorize` and for in-process dispatch), `isConnected`
-   * reports whether the client has an active stream attachment.
-   */
-  type Caller = {
-    readonly clientId: string;
-    readonly auth: unknown;
-    readonly isConnected: boolean;
-  };
-  /** The admitting attach's view: its ephemeral documents plus the shared documents included for it. */
-  type Attach = {
-    readonly caller: Caller;
-    context: (protocol: string) => Statewire.Context;
-    document: (protocol: string, key?: readonly string[]) => unknown;
-    /** `protocol` must be ephemeral; the encoded value is bounded by `MAX_EPHEMERAL_DOCUMENT_BYTES`. */
-    mount: (protocol: string, value: unknown, key?: readonly string[], main?: boolean) => void;
-    unmount: (protocol: string, key?: readonly string[]) => void;
-    include: (protocol: string, key: readonly string[]) => void;
-    exclude: (protocol: string, key: readonly string[]) => void;
-  };
-  type HandledCommands<THandlers extends Statewire.Commands> = { [K in keyof THandlers]: (...args: Parameters<THandlers[K]>) => Awaited<ReturnType<THandlers[K]>>; };
-  type Fin = {
-    reason: "reconnect" | "error" | "protocol-error" | "forbidden" | "unauthorized" | "gone" | "idle" | (string & {});
-    message?: string;
-    code?: string;
-    status?: number;
-    retry?: number;
-    payload?: unknown;
-    meta?: unknown;
-  };
+import type { Statewire } from "./types.js";
+export { StatewireReject } from "./host/engine.js";
+export { useStatewireWork } from "./host/work.js";
+export { append } from "./host/draft.js";
+export { getStateHost, useStatewireState, useStatewireCommands, } from "./host/host.js";
+export { syncedDocument } from "./host/synced.js";
+export declare namespace StatewireHost {
+    type Work = {
+        readonly isIdle: boolean;
+        track: <T>(task: Promise<T>) => Promise<T>;
+        schedule: (callback: () => void) => void;
+    };
+    type StateCtl<TState = unknown> = {
+        /** Apply server-vocabulary ops (root replace = whole-state swap). */
+        apply: (ops: readonly Statewire.Op[]) => void;
+        /** The committed plain state — immutably replaced per op, so a captured value is a stable snapshot. */
+        snapshot: () => TState;
+    };
+    type Document = {
+        protocol: string;
+        key: readonly string[] | null;
+        main: boolean;
+        value: unknown;
+    };
+    type StateHost = Statewire.StateSource & {
+        /** Synchronous, per locally-recorded op; the host owns batching. */
+        setOnOp: (listener: ((op: Statewire.Op) => void) | null) => void;
+        /** Mount or replace the shared document `(protocol, key)`; keyed documents reach an attach only once it `include`s them. */
+        mount: (protocol: string, value: unknown, options?: {
+            key?: readonly string[];
+            main?: boolean;
+        }) => void;
+        unmount: (protocol: string, key?: readonly string[]) => void;
+        documents: () => ReadonlyMap<string, Document>;
+        setOnDocuments: (listener: (() => void) | null) => void;
+    };
+    /**
+     * Per-invocation handle bound as `this` of a command handler: `caller` is
+     * the submitting client, `attach` the admitting attach's document view
+     * (in-process dispatch has none — reading it throws), `applied()` states the
+     * broadcast state now contains the command's effects — the client drops its
+     * optimistic overlay — before the handler settles (idempotent, a no-op after
+     * settle). The command settles when the handler's returned promise does.
+     */
+    type CommandsOptions = {
+        context?: () => Statewire.Context;
+    };
+    type Ctx = {
+        readonly caller: Caller;
+        readonly context: Statewire.Context;
+        readonly attach: Attach;
+        readonly signal: AbortSignal;
+        readonly applied: () => void;
+    };
+    /**
+     * The submitting client (`this.caller` in a command handler). Holdable
+     * across a long run: `clientId` is the client's `Statewire-Client-Id`
+     * (in-process dispatch has none — reading it throws), `auth` is the value
+     * `authorize` returned for the attach that admitted the command (undefined
+     * for a void `authorize` and for in-process dispatch), `isConnected`
+     * reports whether the client has an active stream attachment.
+     */
+    type Caller = {
+        readonly clientId: string;
+        readonly auth: unknown;
+        readonly isConnected: boolean;
+    };
+    /** The admitting attach's view: its ephemeral documents plus the shared documents included for it. */
+    type Attach = {
+        readonly caller: Caller;
+        context: (protocol: string) => Statewire.Context;
+        document: (protocol: string, key?: readonly string[]) => unknown;
+        /** `protocol` must be ephemeral; the encoded value is bounded by `MAX_EPHEMERAL_DOCUMENT_BYTES`. */
+        mount: (protocol: string, value: unknown, key?: readonly string[], main?: boolean) => void;
+        unmount: (protocol: string, key?: readonly string[]) => void;
+        include: (protocol: string, key: readonly string[]) => void;
+        exclude: (protocol: string, key: readonly string[]) => void;
+    };
+    type HandledCommands<THandlers extends Statewire.Commands> = {
+        [K in keyof THandlers]: (...args: Parameters<THandlers[K]>) => Awaited<ReturnType<THandlers[K]>>;
+    };
+    type Fin = {
+        reason: "reconnect" | "error" | "protocol-error" | "forbidden" | "unauthorized" | "gone" | "idle" | (string & {});
+        message?: string;
+        code?: string;
+        status?: number;
+        retry?: number;
+        payload?: unknown;
+        meta?: unknown;
+    };
 }
-//#endregion
-export { StatewireHost, StatewireReject, append, getStateHost, syncedDocument, useStatewireCommands, useStatewireState, useStatewireWork };
 //# sourceMappingURL=host.d.ts.map

package/dist/host.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"host.d.ts","names":[],"sources":["../src/host.ts"],"mappings":";;;;;;;kBAYiB;OACH;aACD;IACT,QAAQ,GAAG,MAAM,QAAQ,OAAO,QAAQ;IACxC,WAAW;;OAGD,SAAS;;IAEnB,QAAQ,cAAc,UAAU;;IAEhC,gBAAgB;;OAGN;IACV;IACA;IACA;IACA;;OAGU,YAAY,UAAU;;IAEhC,UAAU,YAAY,IAAI,UAAU;;IAEpC,QACE,kBACA,gBACA;MAAY;MAAyB;;IAEvC,UAAU,kBAAkB;IAC5B,iBAAiB,oBAAoB;IACrC,iBAAiB;;;;;;;;;;OAWP;IAAoB,gBAAgB,UAAU;;OAE9C;aACD,QAAQ;aACR,SAAS,UAAU;aACnB,QAAQ;aACR,QAAQ;aACR;;;;;;;;;;OAWC;aACD;aACA;aACA;;;OAIC;aACD,QAAQ;IACjB,UAAU,qBAAqB,UAAU;IACzC,WAAW,kBAAkB;;IAE7B,QACE,kBACA,gBACA,yBACA;IAEF,UAAU,kBAAkB;IAC5B,UAAU,kBAAkB;IAC5B,UAAU,kBAAkB;;OAGlB,gBAAgB,kBAAkB,UAAU,eACrD,WAAW,gBACP,MAAM,WAAW,UAAU,QAC3B,QAAQ,WAAW,UAAU;OAGxB;IACV;IASA;IACA;IACA;IACA;IACA;IACA"}
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAgB;AAEzC,OAAO,EAAE,eAAe,EAAE,yBAAsB;AAChD,OAAO,EAAE,gBAAgB,EAAE,uBAAoB;AAC/C,OAAO,EAAE,MAAM,EAAE,wBAAqB;AACtC,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,GACrB,uBAAoB;AACrB,OAAO,EAAE,cAAc,EAAE,yBAAsB;AAE/C,yBAAiB,aAAa,CAAC;IAC7B,KAAY,IAAI,GAAG;QACjB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACzB,KAAK,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;KAC1C,CAAC;IAEF,KAAY,QAAQ,CAAC,MAAM,GAAG,OAAO,IAAI;QACvC,qEAAqE;QACrE,KAAK,EAAE,CAAC,GAAG,EAAE,SAAS,SAAS,CAAC,EAAE,EAAE,KAAK,IAAI,CAAC;QAC9C,uGAAuG;QACvG,QAAQ,EAAE,MAAM,MAAM,CAAC;KACxB,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;QAC9B,IAAI,EAAE,OAAO,CAAC;QACd,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC;IAEF,KAAY,SAAS,GAAG,SAAS,CAAC,WAAW,GAAG;QAC9C,oEAAoE;QACpE,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;QACjE,4HAA4H;QAC5H,KAAK,EAAE,CACL,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,KAClD,IAAI,CAAC;QACV,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;QAC7D,SAAS,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC/C,cAAc,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;KACzD,CAAC;IAEF;;;;;;;OAOG;IACH,KAAY,eAAe,GAAG;QAAE,OAAO,CAAC,EAAE,MAAM,SAAS,CAAC,OAAO,CAAA;KAAE,CAAC;IAEpE,KAAY,GAAG,GAAG;QAChB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;QACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;QAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;KAC9B,CAAC;IAEF;;;;;;;OAOG;IACH,KAAY,MAAM,GAAG;QACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QACvB,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;KAC/B,CAAC;IAEF,sGAAsG;IACtG,KAAY,MAAM,GAAG;QACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,SAAS,CAAC,OAAO,CAAC;QACjD,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,OAAO,CAAC;QACjE,oGAAoG;QACpG,KAAK,EAAE,CACL,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE,OAAO,KACX,IAAI,CAAC;QACV,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;QAC7D,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;QAC5D,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;KAC7D,CAAC;IAEF,KAAY,eAAe,CAAC,SAAS,SAAS,SAAS,CAAC,QAAQ,IAAI;SACjE,CAAC,IAAI,MAAM,SAAS,GAAG,CACtB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAC9B,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;KACvC,CAAC;IAEF,KAAY,GAAG,GAAG;QAChB,MAAM,EACF,WAAW,GACX,OAAO,GACP,gBAAgB,GAChB,WAAW,GACX,cAAc,GACd,MAAM,GACN,MAAM,GACN,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,CAAC;CACH"}

package/dist/index.d.ts

@@ -1,8 +1,11 @@
-import { StatewireDocuments } from "./wire/documents.js";
-import { DEFAULT_PROTOCOL, StatewireProtocol } from "./wire/protocol.js";
-import { StatewireDocument, decodeDocument, encodeDocument } from "./document.js";
-import { StatewireHttp } from "./transports/sse.js";
-import { StatewireClient, StatewireResource, useStatewire } from "./statewire.js";
-import { Statewire, StatewireSendError } from "./types.js";
-import { StatewireWebsocket } from "./transports/ws.js";
-export { DEFAULT_PROTOCOL, type Statewire, StatewireClient, type StatewireDocument, type StatewireDocuments, StatewireHttp, type StatewireProtocol, StatewireResource, StatewireSendError, StatewireWebsocket, decodeDocument, encodeDocument, useStatewire };
+export type { Statewire } from "./types.js";
+export { encodeDocument, decodeDocument } from "./document.js";
+export type { StatewireDocument } from "./document.js";
+export { StatewireClient, useStatewire, StatewireResource } from "./statewire.js";
+export { StatewireHttp } from "./transports/sse.js";
+export { StatewireWebsocket } from "./transports/ws.js";
+export { StatewireSendError } from "./types.js";
+export type { StatewireProtocol } from "./wire/protocol.js";
+export { DEFAULT_PROTOCOL } from "./wire/protocol.js";
+export type { StatewireDocuments } from "./wire/documents.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,mBAAgB;AACzC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,sBAAmB;AAC5D,YAAY,EAAE,iBAAiB,EAAE,sBAAmB;AACpD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,iBAAiB,EAAE,uBAAoB;AAC/E,OAAO,EAAE,aAAa,EAAE,4BAAyB;AACjD,OAAO,EAAE,kBAAkB,EAAE,2BAAwB;AACrD,OAAO,EAAE,kBAAkB,EAAE,mBAAgB;AAE7C,YAAY,EAAE,iBAAiB,EAAE,2BAAwB;AACzD,OAAO,EAAE,gBAAgB,EAAE,2BAAwB;AACnD,YAAY,EAAE,kBAAkB,EAAE,4BAAyB"}

package/dist/index.js

@@ -1,5 +1,5 @@
-import { decodeDocument, encodeDocument } from "./document.js";
 import { DEFAULT_PROTOCOL } from "./wire/protocol.js";
+import { decodeDocument, encodeDocument } from "./document.js";
 import { StatewireSendError } from "./types.js";
 import { StatewireClient, StatewireResource, useStatewire } from "./statewire.js";
 import { StatewireHttp } from "./transports/sse.js";