Interface CompanionView

Readonlyclient

confirmAction

• confirmAction(
      confirmId: string,
      approve: boolean,
      opts?: { signal?: AbortSignal },
  ): Promise<ConfirmActionResult>

  confirmAction that also removes the confirm from pendingConfirms (on approve AND deny — both resolve the card server-side).

  Parameters

  • confirmId: string
  • approve: boolean
  • Optionalopts: { signal?: AbortSignal }

  Returns Promise<ConfirmActionResult>

dispose

• dispose(): void

  Detach every client subscription. The view goes inert (snapshot frozen, listeners dropped); the client itself is NOT closed — it belongs to the host. Idempotent.

  Returns void

getSnapshot

• getSnapshot(): CompanionViewSnapshot

  Stable-reference snapshot (useSyncExternalStore contract).

  Returns CompanionViewSnapshot

sendText

• sendText(
      text: string,
      opts?: {
          awaitReply?: boolean;
          images?: string[];
          instructions?: string;
          replyTimeoutMs?: number;
          signal?: AbortSignal;
          stream?: boolean;
      },
  ): Promise<{ queued?: boolean; seq: number | null; turnId?: string }>

  sendText that also appends the user turn to the transcript.

  Parameters

  • text: string
  • Optionalopts: {
        awaitReply?: boolean;
        images?: string[];
        instructions?: string;
        replyTimeoutMs?: number;
        signal?: AbortSignal;
        stream?: boolean;
    }

  Returns Promise<{ queued?: boolean; seq: number | null; turnId?: string }>

subscribe

• subscribe(listener: () => void): () => void

  Subscribe to snapshot changes. Returns unsubscribe.

  Parameters

  • listener: () => void

  Returns () => void