Class CavellController

constructor

• new CavellController(
      core: CopilotKitCoreReact,
      agent: HttpAgent,
      store: StoreApi,
      config: ControllerConfig,
  ): CavellController

  Parameters

  • core: CopilotKitCoreReact
  • agent: HttpAgent
  • store: StoreApi
  • config: ControllerConfig

  Returns CavellController

Readonlyagent

Readonlycore

Readonlystore

attach

• attach(): () => void

  Attach agent lifecycle subscriptions; returns the unsubscribe cleanup.

  Returns () => void

boot

• boot(): Promise<void>

  Resolve the initial destination (legacy boot gate semantics, useBootSequence).

  Returns Promise<void>

listSessions

• listSessions(page: number, pageSize?: number): Promise<SessionListPage>

  Fetch a history page, scoped by the init-time context (never the live conversation context).

  Parameters

  • page: number
  • pageSize: number = 30

  Returns Promise<SessionListPage>

newConversation

• newConversation(): void

  Returns void

openConversation

• openConversation(threadId: string): Promise<void>

  Open an existing conversation: an init run on the thread replays it (MESSAGES_SNAPSHOT).

  Parameters

  • threadId: string

  Returns Promise<void>

respondToApproval

• respondToApproval(
      approvalId: string,
      approved: boolean,
      modifications?: Record<string, unknown>,
  ): Promise<void>

  Resolve a pending approval (approval:* id) — resume envelope per ADR 0004 §4.

  Parameters

  • approvalId: string
  • approved: boolean
  • Optionalmodifications: Record<string, unknown>

  Returns Promise<void>

respondToInteraction

• respondToInteraction(
      interactionId: string,
      answers: QuestionAnswer[] | null,
  ): Promise<void>

  Resolve a pending ask:* interaction with answers, or dismiss it.

  Parameters

  • interactionId: string
  • answers: QuestionAnswer[] | null

  Returns Promise<void>

runToolCallback

• runToolCallback(callback: ToolCallback, event: ToolCallbackEvent): Promise<void>

  Invoke a callback handler isolated: a throw never breaks the run or the timeline.

  Parameters

  • callback: ToolCallback
  • event: ToolCallbackEvent

  Returns Promise<void>

send

• send(text: string): Promise<void>

  Parameters

  • text: string

  Returns Promise<void>

sendFeedback

• sendFeedback(payload: FeedbackPayload): void

  Parameters

  • payload: FeedbackPayload

  Returns void

sharedState

• sharedState(): CavellSharedState | undefined

  The agent's shared state, typed to the Cavell profile shape.

  Returns CavellSharedState | undefined

stop

• stop(): void

  Abort the SSE stream. Visual-only: the server run completes and persists (ADR 0005 D8).

  Returns void

toolSource

• toolSource(toolName: string): "server" | "frontend"

  Where a tool executes: registered on the core = frontend (host) tool, else the agent's.

  Parameters

  • toolName: string

  Returns "server" | "frontend"

updateConfig

• updateConfig(config: ControllerConfig): void

  Keep mutable config (headers/context/locale) fresh without recreating the controller.

  Parameters

  • config: ControllerConfig

  Returns void