@abloatai/ablo 0.26.0 → 0.28.0

package/dist/sync/SyncWebSocket.d.ts

@@ -1,50 +1,49 @@
 /**
- * SyncWebSocket - Manages WebSocket connection to Go sync engine
- *
- * Handles:
- * - WebSocket lifecycle (connect, reconnect, disconnect)
- * - Delta reception and processing
- * - Multi-tab support
- * - Automatic reconnection with exponential backoff
+ * Manages the WebSocket connection to the sync server. It owns the socket
+ * lifecycle (connect, reconnect, disconnect), receives and validates the
+ * incoming delta stream, sends commits and claims over the same socket, and
+ * reconnects automatically with exponential backoff. Consumers subscribe to its
+ * typed events (see {@link CoreSyncEventMap}) to react to deltas, presence, and
+ * connection changes.
  */
 import { EventEmitter } from 'events';
 import type { MutationOperation } from '../interfaces/index.js';
-import { type ClientSyncDelta } from '../schema/sync-delta-wire.js';
+import { type ClientSyncDelta } from '../wire/delta.js';
+import type { BootstrapReason } from '../wire/bootstrapReason.js';
 import type { ClaimError, ClaimRejection, StaleNotification, ReadDependency } from '../coordination/schema.js';
 import { type CommitAck } from './commitFrames.js';
 export type { CommitAck } from './commitFrames.js';
 import { type AuthTokenGetter } from '../auth/credentialSource.js';
 /**
- * The wire delta the client receives. Derived from the canonical
- * `clientSyncDeltaSchema` (`@abloatai/ablo/schema`) via `z.infer` so the
- * SDK and the sync-server share ONE contract instead of two hand-maintained
- * interfaces. The action vocabulary (`I`/`U`/`D`/`A`/`V`/`C`/`G`/`S`) and the
- * client-only extras (`metadata`, `clientMutationId`, deprecated flat
- * `createdBy`) live in that schema; see its doc for the full field reference.
+ * The wire delta the client receives. It is inferred from the canonical
+ * `clientSyncDeltaSchema` so the client and server share one contract rather
+ * than two hand-maintained definitions. The action vocabulary
+ * (`I`/`U`/`D`/`A`/`V`/`C`/`G`/`S`) and the client-only extras (`metadata`,
+ * `clientMutationId`, and the deprecated flat `createdBy`) live in that schema;
+ * see its own documentation for the full field reference.
  */
 export type SyncDelta = ClientSyncDelta;
 /**
- * Payload for legacy actionType 'G' deltas emitted by EmitGroupChange.
- * Carries both added and removed groups in one delta, forces full re-bootstrap.
+ * Payload for an older actionType `'G'` delta. It carries both the added and
+ * removed sync groups in one delta and forces a full re-bootstrap.
  */
 export interface SyncGroupChangePayload {
     removedGroups: string[];
     addedGroups: string[];
 }
 /**
- * Payload for incremental actionType 'G' deltas emitted by EmitGroupAdded.
- * Signals that the recipient has joined a single sync group; subsequent
- * 'C' (Covering) deltas will deliver the newly-visible entities. No
- * re-bootstrap required.
+ * Payload for an incremental actionType `'G'` delta. It signals that the
+ * recipient has joined a single sync group; the following `'C'` (covering)
+ * deltas deliver the newly visible entities. No re-bootstrap is required.
  */
 export interface GroupAddedPayload {
     group: string;
     userId: string;
 }
 /**
- * Payload for actionType 'S' deltas emitted by EmitGroupRemoved.
- * Signals that the recipient has lost access to a sync group. The client
- * purges affected local entities and updates its subscription metadata.
+ * Payload for an actionType `'S'` delta. It signals that the recipient has lost
+ * access to a sync group; the client purges the affected local entities and
+ * updates its subscription metadata.
  */
 export interface GroupRemovedPayload {
     group: string;
@@ -73,27 +72,25 @@ export interface SyncWebSocketOptions {
      */
     collaborationEvents?: string[];
     /**
-     * Participant kind to declare on the WS upgrade. Defaults to `'user'`
-     * (session-auth, web app). Agent runtimes (Node workers) pass
-     * `'agent'` so the server's `agentTokenProvider`
-     * routes them through capability-token verification instead of
-     * session auth. The server reads this as the `kind` query param.
+     * The participant kind declared on the WebSocket upgrade. Defaults to
+     * `'user'` (session auth, the web app). Agent runtimes pass `'agent'` so the
+     * server verifies them by capability token instead of session auth. The
+     * server reads this as the `kind` query parameter.
      */
     kind?: 'user' | 'agent' | 'system';
     /**
-     * The agent's bearer credential — a restricted (`rk_`) API key. When
-     * set, sent in the `ablo.bearer.<token>` WebSocket subprotocol so the
-     * credential stays out of URLs and proxy logs. Required for `kind: 'agent'`;
-     * ignored for `kind: 'user'`. (Field name predates the Biscuit→opaque-key
-     * migration.)
+     * The agent's bearer credential — a restricted (`rk_`) API key. When set, it
+     * is sent in the `ablo.bearer.<token>` WebSocket subprotocol so the credential
+     * stays out of URLs and proxy logs. Required for `kind: 'agent'` and ignored
+     * for `kind: 'user'`.
      */
     capabilityToken?: string;
     /**
-     * Shared credential getter. When provided, WebSocket URL auth reads this
-     * instead of a copied `capabilityToken`, so reconnects use refreshed tokens
-     * from the SDK's single auth source.
+     * Getter for the current credential. When provided, the WebSocket upgrade
+     * reads it instead of a copied `capabilityToken`, so reconnects always use
+     * the freshest token from the SDK's single credential source. Preferred over
+     * `getCapabilityToken`.
      */
-    /** Shared SDK auth getter. Preferred internal name. */
     getAuthToken?: AuthTokenGetter;
     /** @deprecated Use `getAuthToken`. Kept for direct low-level callers. */
     getCapabilityToken?: AuthTokenGetter;
@@ -104,7 +101,7 @@ export interface SyncWebSocketOptions {
  */
 export interface BootstrapHint {
     tables?: string[];
-    reason?: 'too_far_behind' | 'too_many_deltas' | 'missing_entities';
+    reason?: BootstrapReason;
     staleTables?: string[];
     totalDeltaCount?: number;
 }
@@ -116,14 +113,11 @@ export interface BootstrapDataEvent {
     cursor?: string;
 }
 /**
- * Presence update event payload — mirrors the wire frame's `payload`
- * field (apps/sync-server/src/hub/types.ts PresenceUpdateMessage).
- *
- * Every consumer (web entity-presence cache, PresenceStream,
- * agent-runtime presence reducer) reads its own subset; this type is
- * the union of what the server actually sends. Stripping fields at
- * this layer (the prior bug) silently broke rich-presence consumers
- * that needed `kind`, `activity`, `isAgent` to dispatch correctly.
+ * Payload of a presence-update event, mirroring the `payload` field of the wire
+ * frame. This type is the union of everything the server may send; each
+ * consumer reads its own subset. Forwarding the full shape, rather than
+ * stripping fields here, is deliberate — presence consumers rely on `kind`,
+ * `activity`, and `isAgent` to dispatch correctly.
  */
 export interface PresenceUpdateEvent {
     /** Server-stamped transition: 'enter' on join + roster snapshot,
@@ -151,16 +145,15 @@ export interface PresenceUpdateEvent {
      *  not self-declare — server is the source of truth. */
     isAgent?: boolean;
     /**
-     * Server-stamped canonical kind (`'user' | 'agent' | 'system'`). Additive:
-     * older servers omit it and readers fall back to the lossy `isAgent`
-     * boolean (which cannot express `'system'`). Typed `string` because it is
-     * raw wire input — normalize via `participantKindFromWire`.
+     * The canonical participant kind (`'user' | 'agent' | 'system'`), stamped by
+     * the server. Some servers omit it, in which case readers fall back to the
+     * lossy `isAgent` boolean, which cannot express `'system'`. Typed as `string`
+     * because it is raw wire input — normalize it via `participantKindFromWire`.
      */
     participantKind?: string;
     timestamp?: number;
-    /** Server stamps every presence frame with this participant's open
-     *  claims so peers see them without a separate channel. Wire
-     *  shape mirrors `apps/sync-server/src/hub/types.ts Claim`. */
+    /** Every presence frame carries this participant's open claims, stamped by
+     *  the server, so peers see them without a separate channel. */
     activeClaims?: {
         claimId: string;
         entityType: string;
@@ -178,10 +171,10 @@ export interface PresenceUpdateEvent {
         declaredAt: number;
         expiresAt: number;
         /**
-         * Lifecycle state. Additive — older servers omit it and the reader
-         * treats absence as `'active'`. Terminal states (`committed` /
-         * `expired` / `canceled`) ride one frame as the claim ends so peers
-         * learn *how* it resolved before it drops from the active set.
+         * The claim's lifecycle state. When absent, the reader treats it as
+         * `'active'`. A terminal state (`committed`, `expired`, or `canceled`) rides
+         * one final frame as the claim ends, so peers learn how it resolved before
+         * it drops from the active set.
          */
         status?: 'active' | 'committed' | 'expired' | 'canceled';
         error?: ClaimError;
@@ -256,14 +249,19 @@ export interface CoreSyncEventMap {
     claim_granted: [Record<string, unknown>];
     claim_lost: [Record<string, unknown>];
     /**
-     * Notify-instead-of-abort (non-coercion). A committed write guarded with
-     * `onStale: 'notify' collided with a concurrent change; rather than
-     * forcing an outcome, the engine returned the conflicting field's current
-     * value so the actor can solve it. The resolver is the intelligent actor —
-     * an agent reasoning over the change, or a human watching the row. The commit
-     * SUCCEEDED; held ops ('notify') weren't written and the actor re-issues once
-     * it has reconciled. (The claim is the prospective form of the same
-     * non-coercion; this is the in-flight form.)
+     * Reply to an outbound `claim_heartbeat` — the lease's fate: `held` with
+     * the extended `expiresAt`, `queued` with the current `position`, or
+     * `lost`. Correlated back to the awaiting caller by `claimId` in the
+     * claim stream.
+     */
+    claim_heartbeat_ack: [Record<string, unknown>];
+    /**
+     * A committed write guarded with `onStale: 'notify'` collided with a
+     * concurrent change. Rather than forcing an outcome, the engine returns the
+     * conflicting field's current value so the actor — an agent reasoning over the
+     * change, or a person watching the row — can reconcile it. The commit itself
+     * succeeded; the held operations were not written, and the actor re-issues
+     * them once it has reconciled.
      */
     'conflict:notified': [{
         clientTxId: string;
@@ -282,7 +280,7 @@ export type DefaultCollaborationEvents = Record<string, never>;
  * `Record<string, ...>` requires an implicit string index signature, which
  * TypeScript interfaces don't have. So a closed interface like Ablo's
  * `AbloCollaborationEvents` would fail to satisfy `Record<string, unknown[]>`,
- * even though every one of its values IS a tuple. This mapped form iterates
+ * even though every one of its values is a tuple. This mapped form iterates
  * over `keyof T` instead of demanding a string index, so it accepts both
  * closed interfaces and open Record types — while still enforcing
  * "every value is an array."
@@ -315,10 +313,10 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
     /** Periodic catchup interval — polls for missed deltas every 30s while connected */
     private catchupInterval;
     /**
-     * Application-level heartbeat — ping every 30s, force-close on a 10s
-     * silent watchdog. The full zombie-socket rationale lives with the
-     * timers in `sync/heartbeat.ts`; the transport closures below are the
-     * only socket access the controller gets.
+     * Application-level heartbeat: ping every 30 seconds and force-close after a
+     * 10-second silence. The {@link HeartbeatController} holds the timing and the
+     * zombie-socket rationale; the closures below are the only socket access it
+     * gets.
      */
     private readonly heartbeat;
     private isConnecting;
@@ -349,20 +347,19 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
     private lastForceCloseReason;
     private sessionErrorAt;
     /**
-     * Sync-position state (lastSyncId watermark, version vector, server
-     * cursor). The advance discipline stays documented at `sendAck` /
-     * `handleDelta`; the state itself lives in `sync/syncCursor.ts`.
+     * Sync-position state: the lastSyncId watermark, version vector, and server
+     * cursor. The advance discipline is documented at `sendAck` and `handleDelta`;
+     * the state itself lives in {@link SyncCursor}.
      */
     private readonly cursor;
     /** Registered collaboration event keys (colon format) for dispatch in onmessage */
     private collaborationEventTypes;
     /**
-     * Minimal session adapter handed to the frame dispatch table
-     * (`sync/wsFrameHandlers.ts`). Exposes ONLY the members the handlers
-     * touch; the closure members read live state so host-side reassignment
-     * (e.g. the `pendingSubscriptions` reset on close) can't strand the
-     * handlers on a stale reference. Built in the constructor, after the
-     * state it captures exists.
+     * A minimal session adapter handed to the inbound frame dispatch table
+     * ({@link dispatchWsFrame}). It exposes only the members the handlers touch;
+     * the closure members read live state so a reassignment here (for example the
+     * `pendingSubscriptions` reset on close) cannot strand a handler on a stale
+     * reference. Built in the constructor, after the state it captures exists.
      */
     private readonly frameSession;
     /**
@@ -373,10 +370,10 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     private pendingMutations;
     /**
-     * In-flight `claim` requests keyed by claimId. Resolved when the
-     * matching `claim_ack` arrives, or rejected on timeout/disconnect.
-     * Same shape as pendingMutations — Phoenix-style request/response
-     * over a multiplexed connection.
+     * In-flight `claim` requests keyed by claimId. Resolved when the matching
+     * `claim_ack` arrives, or rejected on timeout or disconnect — the same
+     * request/response pattern as `pendingMutations`, multiplexed over the one
+     * connection.
      */
     private pendingClaims;
     /**
@@ -411,28 +408,25 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     private setupEventHandlers;
     /**
-     * Validate + normalize a wire delta at the receive boundary — the ONE
-     * seam every inbound delta (`delta` frame, batch element, `sync_response`
-     * replay, legacy bare frame) passes through before it is emitted,
-     * persisted to IDB, or allowed to advance any watermark.
+     * Validates and normalizes a wire delta at the receive boundary — the single
+     * seam every inbound delta (a `delta` frame, a batch element, a `sync_response`
+     * replay, or the older bare frame) passes through before it is emitted,
+     * persisted, or allowed to advance any watermark.
      *
-     * Normalization (older/deployed servers stay compatible):
-     *  - `id`: the contract says `number`, but deployed servers have sent the
-     *    raw Postgres BIGINT serialization — a STRING — and every downstream
-     *    watermark gate (`typeof syncId === 'number'` in
-     *    `Database.processDeltaBatch`, the metadata-cursor update, numeric
-     *    `>=` thresholds in TransactionQueue) silently breaks on strings:
-     *    acks are withheld, the resume cursor never advances, and every
-     *    reconnect replays from 0. Coerce ONCE here.
-     *  - `transactionId` / `createdBy`: the SERVER projection sends these as
-     *    nullable (and `createdBy` as a nested ParticipantRef); the client
-     *    contract types them as optional strings and never reads them.
-     *    Normalize to absent instead of rejecting every real server delta.
+     * Normalization keeps already-deployed servers compatible:
+     *  - `id`: the contract says `number`, but some servers have sent the raw
+     *    Postgres BIGINT serialization — a string — and every downstream watermark
+     *    gate treats a string as invalid, so acks are withheld, the resume cursor
+     *    never advances, and every reconnect replays from zero. Coerce it once here.
+     *  - `transactionId` / `createdBy`: the server projection sends these as
+     *    nullable (and `createdBy` as a nested reference); the client contract
+     *    types them as optional strings and never reads them, so normalize them to
+     *    absent rather than reject every real server delta.
      *
-     * Validation: `clientSyncDeltaSchema.safeParse` — the canonical Zod wire
-     * contract. A frame that fails is DROPPED (returns `null`) with a
-     * debug-level log + observability breadcrumb; it is never applied. One
-     * parse per delta — callers must not re-parse.
+     * Validation runs `clientSyncDeltaSchema.safeParse`, the canonical wire
+     * contract. A frame that fails is dropped (returns `null`) with a debug log
+     * and an observability breadcrumb; it is never applied. There is one parse per
+     * delta — callers must not re-parse.
      */
     private normalizeWireDelta;
     /**
@@ -441,15 +435,13 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     private handleDelta;
     /**
-     * Send acknowledgment for received delta with version vector.
-     *
-     * This is the SOLE forward-mover of `this.cursor.lastSyncId` for live
-     * deltas. Called by `BaseSyncedStore.flushPendingDeltas` with the
-     * `persistedSyncId` watermark — i.e. only after the deltas have
-     * actually committed to IDB. Keeping the cursor advance here (rather
-     * than at receipt in `handleDelta`/`handleSyncResponse`) means the
-     * cursor never gets ahead of the persisted view, so reconnect/
-     * catch-up requests can't accidentally skip un-persisted deltas.
+     * Acknowledges received deltas up to the given syncId. This is the only place
+     * `this.cursor.lastSyncId` moves forward for live deltas. The store calls it
+     * with its persisted-syncId watermark — that is, only after the deltas have
+     * committed to local storage. Advancing the cursor here, rather than at
+     * receipt in `handleDelta` or `handleSyncResponse`, keeps the cursor from
+     * getting ahead of the persisted view, so reconnect and catch-up requests
+     * cannot skip un-persisted deltas.
      */
     private sendAck;
     /**
@@ -461,23 +453,15 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     send(message: any): void;
     /**
-     * Send a `commit` mutation request over the existing WebSocket and
-     * resolve when the server's `mutation_result` frame comes back with
-     * the same `clientTxId`. The wire-level frame is `{ type: 'commit',
-     * payload: { operations, clientTxId } }` — matching the
-     * `handleCommit` path on `apps/sync-server/src/hub/Hub.ts` (see the
-     * dispatch at Hub.ts:737).
-     *
-     * Historical naming note: this was originally `sendBatchAck` back when
-     * the Go sync-engine used a GraphQL `batchAck` mutation. The TS
-     * sync-server uses `type: 'commit'` over WebSocket exclusively. The
-     * method name now matches the wire protocol so the ack/commit naming
-     * confusion stops here.
+     * Sends a `commit` mutation request over the existing WebSocket and resolves
+     * when the server's `mutation_result` frame comes back with the same
+     * `clientTxId`. The wire frame is `{ type: 'commit', payload: { operations,
+     * clientTxId } }`.
      *
-     * Times out after 15s of silence from the server. The socket may close
-     * during an in-flight mutation (network flap, server restart); we do
-     * NOT auto-retry here — the caller's TransactionQueue owns retry +
-     * offline replay semantics and the SDK shouldn't duplicate that logic.
+     * Times out after 15 seconds of silence from the server. The socket may close
+     * during an in-flight mutation (a network flap, a server restart); this does
+     * not auto-retry — the caller's transaction queue owns retry and offline
+     * replay, and the SDK does not duplicate that logic.
      */
     sendCommit(operations: readonly MutationOperation[], clientTxId: string, timeoutMs?: number, causedByTaskId?: string | null, reads?: readonly ReadDependency[] | null): Promise<CommitAck>;
     /**
@@ -490,21 +474,14 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     sendCommitQueued(operations: readonly MutationOperation[], clientTxId: string, causedByTaskId?: string | null, reads?: readonly ReadDependency[] | null): void;
     /**
-     * Activate a participant claim on this connection. Multiplexed
-     * subscription pattern (Phoenix Channels / Pusher) — the same
-     * connection can hold N concurrent claims, each scoped to a
-     * different set of sync groups.
-     *
-     * Returns a promise that resolves with the server-canonicalized
-     * `syncGroups` and effective `ttlSeconds` once `claim_ack` arrives,
-     * or rejects with a typed error on `success: false` ack /
-     * timeout / disconnect.
+     * Activates a participant claim on this connection. One connection can hold
+     * several concurrent claims at once, each scoped to a different set of sync
+     * groups, so the SDK reuses the existing connection instead of opening a
+     * separate socket per scope.
      *
-     * Why this exists: the old scoped-participant path opened a separate
-     * WS per scope. With claims, the SDK reuses the existing session/agent
-     * connection — one TCP, N logical participants. See
-     * `apps/sync-server/docs/PARTICIPANT_CLAIMS.md` for the migration
-     * framing (Phase A.1).
+     * Returns a promise that resolves with the server-canonicalized `syncGroups`
+     * and effective `ttlSeconds` once `claim_ack` arrives, or rejects with a typed
+     * error on a failed ack, a timeout, or a disconnect.
      */
     sendClaim(claimId: string, syncGroups: readonly string[], options?: {
         capabilityToken?: string;
@@ -525,22 +502,21 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     sendRelease(claimId: string): void;
     /**
-     * Move this connection's READ interest — replace the connection-level
-     * sync groups mid-session as the user opens/closes entities. This is the
-     * area-of-interest (AOI) navigation primitive: the server fans out
-     * deltas only for groups currently in view, instead of the frozen set
-     * chosen at connect.
+     * Moves this connection's read interest — replaces the connection-level sync
+     * groups mid-session as the user opens and closes entities. This is the
+     * area-of-interest navigation primitive: the server fans out deltas only for
+     * the groups currently in view, rather than the fixed set chosen at connect.
      *
-     * Full-set replace semantics — pass the complete new group list, not a
-     * delta. Resolves with the server's effective set once `subscription_ack`
-     * arrives; rejects (typed) on a scope denial (a restricted `rk_` key
-     * requesting a group outside its allowlist), timeout, or disconnect. On
-     * success the new set is recorded as `options.syncGroups` so a later
-     * reconnect re-subscribes to current interest, not the connect-time set.
+     * This is a full-set replace: pass the complete new group list, not a delta.
+     * Resolves with the server's effective set once `subscription_ack` arrives;
+     * rejects (with a typed error) on a scope denial (a restricted `rk_` key
+     * requesting a group outside its allowlist), a timeout, or a disconnect. On
+     * success the new set is recorded as `options.syncGroups`, so a later reconnect
+     * re-subscribes to the current interest rather than the connect-time set.
      *
-     * Distinct from {@link sendClaim} (write-claim, per-op, TTL'd) — this is
-     * the read side and carries no capability token of its own; it's bounded
-     * by the connection credential's grant.
+     * Distinct from {@link sendClaim} (a write claim, per operation, with a TTL):
+     * this is the read side, carries no capability token of its own, and is
+     * bounded by the connection credential's grant.
      */
     updateSubscription(syncGroups: readonly string[], options?: {
         timeoutMs?: number;
@@ -548,9 +524,9 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
         syncGroups: string[];
     }>;
     /**
-     * Compatibility setter for direct SyncWebSocket users. The SDK-owned
-     * `Ablo()` path passes `getAuthToken`, so reconnect URL auth reads the
-     * shared credential source instead of this copied value.
+     * Sets a fixed credential for callers that construct the socket directly. The
+     * SDK instead supplies `getAuthToken`, so reconnects read the shared
+     * credential source rather than this copied value.
      */
     setCapabilityToken(token: string): void;
     getAuthToken(): string | undefined;
@@ -670,7 +646,7 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     getLastSyncId(): number;
     /**
-     * Linear-style incremental sync request
+     * Requests an incremental sync from the server, starting at the current cursor.
      */
     requestIncrementalSync(): Promise<void>;
     /**
@@ -689,13 +665,12 @@ export declare class SyncWebSocket<TCollaboration extends EventMap<TCollaboratio
      */
     private handleBootstrapResponse;
     /**
-     * Handle presence update from server. The wire frame's payload is
-     * forwarded as-is so every consumer (web entity cache,
-     * PresenceStream, agent runtime) reads from the same shape.
-     * Stripping fields here was a prior bug — it silently dropped
-     * `kind`, `activity`, `syncGroups`, `isAgent` for rich consumers.
+     * Handles a presence update from the server. The wire frame's payload is
+     * forwarded as-is, so every consumer reads the same shape; stripping fields
+     * here would drop `kind`, `activity`, `syncGroups`, and `isAgent` for
+     * consumers that need them.
      *
-     * Wire frame (apps/sync-server/src/hub/types.ts PresenceUpdateMessage):
+     * The wire frame is:
      *   { type: 'presence_update', payload: { kind, userId, status,
      *     syncGroups, activity, isAgent, timestamp, activeClaims } }
      */