@superdurable/dex-agents 0.1.0 → 0.3.0

package/dist/src/agent-session-values.d.ts

@@ -5,14 +5,108 @@
  * - `running_model`: `RunModel` makes the turn's next model call.
  * - `running_tools`: the requested tool calls run in parallel Steps, some possibly waiting for
  *   approval, and `ResumeTurn` waits for their results.
+ * - `compacting_context`: `CompactContext` summarizes earlier messages before the turn's next model
+ *   call. Only a session with {@link AgentSessionOptions.compaction} reaches it.
+ * - `failed`: the session ended and takes no more messages. Its Flow closed failed, and
+ *   {@link AgentState.lastTurnError} holds the reason.
  */
-export type AgentSessionStatus = "waiting_for_user_message" | "running_model" | "running_tools";
+export type AgentSessionStatus = "waiting_for_user_message" | "running_model" | "running_tools" | "compacting_context" | "failed";
+/**
+ * Kind of a turn, stored in {@link AgentState.interactionMode} when the turn starts, for the runner to choose
+ * the tools it offers. Plan mode needs {@link AgentSessionOptions.planModeEnabled}; without it every turn is
+ * `chat`.
+ *
+ * - `chat`: an ordinary turn. The runner offers every tool.
+ * - `planning`: a turn that only plans. A message of the turn has `planMode`, or a `draft` plan waits for
+ *   review. The runner offers only `write_todos`, and `RunModel` rejects any other call.
+ * - `executing`: a turn that `execute_plan` started. The runner offers every tool.
+ */
+export type InteractionMode = "chat" | "planning" | "executing";
+/**
+ * Where an {@link AgentPlan} stands.
+ *
+ * - `draft`: a planning turn wrote the plan, and it waits for `execute_plan`.
+ * - `active`: the plan runs, or `write_todos` wrote it outside a planning turn with a task not completed.
+ * - `completed`: every task is completed.
+ * - `cleared`: `write_todos` replaced the plan with no tasks.
+ */
+export type PlanStatus = "draft" | "active" | "completed" | "cleared";
+/** Where one task of an {@link AgentPlan} stands: `pending`, `in_progress`, or `completed`. */
+export type PlanTaskStatus = "pending" | "in_progress" | "completed";
+/** One task of an {@link AgentPlan}. */
+export interface AgentPlanTask {
+    /** What the task does, as the model wrote it; never blank. Wire field: `content`. */
+    readonly content: string;
+    /** Where the task stands. Wire field: `status`. */
+    readonly status: PlanTaskStatus;
+}
+/**
+ * The session's plan, stored in the `AgentPlan` Attribute: a short task list the model replaces as a whole.
+ *
+ * `write_todos` replaces it with the next revision, and `execute_plan` names the revision the user approves.
+ * Compaction never summarizes it.
+ */
+export interface AgentPlan {
+    /**
+     * Revision of the plan, starting at 1. Every `write_todos` call that succeeds adds 1, an empty list
+     * included. Wire field: `revision`.
+     */
+    readonly revision: number;
+    /** Where the plan stands. Wire field: `status`. */
+    readonly status: PlanStatus;
+    /** Every task in order; empty when `cleared`. Wire field: `tasks`. */
+    readonly tasks: readonly AgentPlanTask[];
+    /** RFC 3339 time of the last change. Wire field: `updated_at`. */
+    readonly updatedAt: string;
+}
+/**
+ * Input of the `execute_plan` RPC.
+ *
+ * @example
+ * ```ts
+ * const snapshot = await client.invokeRPC(flow.getAgentSnapshot, sessionId);
+ * if (snapshot.plan?.status === "draft") {
+ *   await client.invokeRPC(flow.executePlan, sessionId, { revision: snapshot.plan.revision });
+ * }
+ * ```
+ */
+export interface ExecutePlanRequest {
+    /**
+     * {@link AgentPlan.revision} the user reviewed. A stale revision is refused, so the session never runs a
+     * plan the user did not see. Wire field: `revision`.
+     */
+    readonly revision: number;
+}
+/**
+ * One approved plan execution, published to the `PlanExecutions` ChannelMap instance named by the revision
+ * and held in the `PendingPlanExecution` Attribute until `AwaitUserMessage` starts its `executing` turn.
+ */
+export interface PlanExecutionRequest {
+    /** The approved {@link AgentPlan.revision}. Wire field: `revision`. */
+    readonly revision: number;
+}
+/**
+ * A session's settings: one JSON object that the application chooses, such as `{ model: "gpt-5-mini" }`.
+ *
+ * Set them in {@link AgentSessionStartInput.sessionSettings} and replace them with the
+ * `update_session_settings` RPC. A runner reads the settings of the running turn from
+ * `AgentTurnContext.sessionSettings`; a Stepwise agent maps them to a model client with
+ * `AgentDefinition.resolveModel`. Keys keep their spelling on the wire; nothing is converted to snake_case.
+ *
+ * Settings are stored in the session and returned by `get_agent_snapshot`, so never put a secret in them. Put a
+ * reference, such as a credential name, that the Worker resolves. Their compact JSON text must fit in
+ * `MAX_SESSION_SETTINGS_BYTES`; see `validateSessionSettings`.
+ */
+export type SessionSettings = Readonly<Record<string, unknown>>;
 /**
  * Input of the `StartAgentSession` Step, passed to `Client.startFlow`.
  *
  * @example
  * ```ts
- * await client.startFlow(flow, "session-42", { initialMessage: "Summarize my inbox" });
+ * await client.startFlow(flow, "session-42", {
+ *   initialMessage: "Summarize my inbox",
+ *   sessionSettings: { model: "gpt-5-mini" },
+ * });
  * ```
  */
 export interface AgentSessionStartInput {
@@ -21,6 +115,15 @@ export interface AgentSessionStartInput {
      * Blank text is treated as `null`. Wire field: `initial_message`.
      */
     readonly initialMessage: string | null;
+    /**
+     * The session's {@link SessionSettings}, which every turn's `AgentTurnContext.sessionSettings` carries until
+     * `update_session_settings` replaces them. Absent or `null` starts without settings. Settings that the session
+     * refuses, because they are not a JSON object or are too large, fail the session at once with no retry; check
+     * them first with `validateSessionSettings`. Never put a secret in them: `get_agent_snapshot` and the browser
+     * snapshot JSON return them. Start sessions with settings only after every Worker of the Flow type runs
+     * dex-agents 0.2.0, because a 0.1.0 Worker drops them. Wire field: `session_settings`.
+     */
+    readonly sessionSettings?: SessionSettings | null;
 }
 /** Small durable summary of an agent session, stored in the `AgentState` Attribute. */
 export interface AgentState {
@@ -32,8 +135,28 @@ export interface AgentState {
     readonly activeTurnId: string | null;
     /** Sequence assigned to the next stored message; starts at 1. Wire field: `next_message_sequence`. */
     readonly nextMessageSequence: number;
-    /** Error text of the most recent failed turn, or `null`. Wire field: `last_turn_error`. */
+    /**
+     * Error text of the most recent failed turn, or `null`. With status `failed`, the reason the session ended.
+     * Wire field: `last_turn_error`.
+     */
     readonly lastTurnError: string | null;
+    /**
+     * Kind of the active turn, or of the last turn between turns; the session sets it when a turn starts.
+     * Wire field: `interaction_mode`, `chat` by default.
+     *
+     * Like every field plans added, a decoded value omits it at its default, so a value of a session that
+     * uses no plans has its 0.1.0 shape, and code that compares whole values keeps working; the wire always
+     * carries it. Treat `undefined` as `chat`.
+     */
+    readonly interactionMode?: InteractionMode;
+    /**
+     * Whether `steer_user_message` and `cancel_turn` may end the active turn. A Worker that applies them sets it
+     * when a turn starts and clears it when the turn ends. An earlier Worker drops it whenever it writes
+     * `AgentState`, so the RPCs refuse a turn that such a Worker started or advanced. Wire field:
+     * `accepts_turn_control`. The decoder sets it only when it is `true`, so `undefined` means `false` and an idle
+     * state keeps its 0.1.0 shape.
+     */
+    readonly acceptsTurnControl?: boolean;
 }
 /** Author of one stored agent message. */
 export type AgentMessageRole = "user" | "assistant" | "tool";
@@ -79,16 +202,75 @@ export interface AgentMessage extends FrameworkMessage {
  */
 export type ToolEffect = "read" | "idempotent_write" | "non_idempotent_write" | "unclassified";
 /**
- * Status of one deferred tool call record.
+ * Status of one deferred tool call record, as a runner sees it.
  *
  * `awaiting_approval` and `approved` are open. The other statuses are final: the session
  * never runs a call whose record is final, and the runner reports the result to the model.
- * `failed` means the tool threw {@link ToolExecutionError}, or a `read` call ended without a result after
- * its attempts ran out. `outcome_unknown` means a write's tool Step ended without a result, through a
- * Worker crash, a timeout, or another error after its attempts ran out.
+ * `failed` means the tool threw {@link ToolExecutionError}, a `read` call ended without a result after
+ * its attempts ran out, or the tool did not run (its error starts with {@link toolCallNotRunErrorPrefix}).
+ * `outcome_unknown` means a write's tool Step ended without a result, through a Worker crash, a timeout,
+ * or another error after its attempts ran out.
+ *
+ * The set of final statuses never grows, so an exhaustive mapping of final statuses stays complete.
+ * A stored record can also hold an {@link AgentToolCallWaitingStatus}; runners never see one.
  */
 export type AgentToolCallStatus = "awaiting_approval" | "approved" | "rejected" | "succeeded" | "failed" | "outcome_unknown";
-/** Durable record of one deferred tool call, stored in `AgentToolCalls` under its tool call ID. */
+/**
+ * Non-final status of a stored record while a session Step waits on the call's behalf.
+ *
+ * - `awaiting_answer`: `AwaitQuestionAnswer` waits for `answer_question`. The call is an `ask_user`
+ *   call, or a tool call whose tool returned {@link ToolInputRequested}.
+ * - `waiting_for_timer`: `AwaitTimer` waits until {@link AgentToolCallRecord.waitUntil} for a
+ *   `durable_wait` call.
+ * - `waiting_for_task`: the tool returned {@link ToolTaskStarted}, and `PollToolTask` polls the task in
+ *   {@link AgentToolCallRecord.taskId} every {@link AgentToolCallRecord.taskPollIntervalSeconds}.
+ *
+ * These statuses appear in {@link AgentSnapshot.toolCalls} and in records read with
+ * `Client.getAttributes`. A runner never receives a record with one of them: `RunModel` runs only after
+ * every record of the turn is final, and a tool Step runs only an `approved` record.
+ */
+export type AgentToolCallWaitingStatus = "awaiting_answer" | "waiting_for_timer" | "waiting_for_task";
+/** Status of a stored tool call record: an {@link AgentToolCallStatus} or an {@link AgentToolCallWaitingStatus}. */
+export type AgentToolCallRecordStatus = AgentToolCallStatus | AgentToolCallWaitingStatus;
+/**
+ * How a question that a tool or its task asked was resolved.
+ *
+ * - `answered`: the user answered with `answer_question`.
+ * - `declined`: the user declined with `resolve_interrupt` and `approved` `false`.
+ * - `deadline_passed`: `interruptDeadlineMs` passed first.
+ *
+ * A tool's own question is only ever answered: a decline or a passed deadline ends the call with
+ * `rejected`. A question that a started task asked through {@link AgentFrameworkRunner.pollToolTask}
+ * goes back to the task in every case, so the task, not the session, decides what a decline means.
+ */
+export type QuestionResolution = "answered" | "declined" | "deadline_passed";
+/**
+ * How one question that a tool asked by returning {@link ToolInputRequested} was resolved.
+ *
+ * `AwaitQuestionAnswer` appends one to the call's `inputAnswers` when the user answers. The tool then
+ * runs again and receives every answer in {@link DeferredToolExecution.inputAnswers}. For a question that
+ * a started task asked, it also appends one when the user declines or the deadline passes, and
+ * `PollToolTask` hands it to the task as {@link ToolTaskPoll.pendingAnswer}.
+ */
+export interface QuestionAnswer {
+    /** Interrupt ID of the resolved question, `<toolCallId>-input-<n>`. Wire field: `interrupt_id`. */
+    readonly interruptId: string;
+    /** Question text the tool asked. Wire field: `question`. */
+    readonly question: string;
+    /**
+     * The user's answer, exactly as sent to `answer_question`. For a declined question, the user's rejection
+     * message or {@link defaultQuestionDeclinedToolResult}; for a passed deadline, {@link questionDeadlinePassed}.
+     * Wire field: `answer`.
+     */
+    readonly answer: string;
+    /**
+     * How the question was resolved; `answered` when absent, the only resolution of a tool's own question.
+     * Answers the session reads always carry it; it is optional so that code that builds answers by hand keeps
+     * compiling. Wire field: `resolution`.
+     */
+    readonly resolution?: QuestionResolution;
+}
+/** Durable record of one deferred tool call, as a runner sees it; stored in `AgentToolCalls` under its tool call ID. */
 export interface AgentToolCall {
     /** Framework tool call ID; non-empty and slash-free. Wire field: `tool_call_id`. */
     readonly toolCallId: string;
@@ -108,7 +290,8 @@ export interface AgentToolCall {
     readonly output: string | null;
     /**
      * The `ToolExecutionError` message, or the failed Step's recovery detail, after `failed` or
-     * `outcome_unknown`; otherwise `null`. Wire field: `error`.
+     * `outcome_unknown`; otherwise `null`. Wire field: `error`. A tool Step that failed before the tool
+     * ran records `failed` with {@link toolCallNotRunErrorPrefix}, `": "`, and the recovery detail.
      */
     readonly error: string | null;
     /** Rejection text after `rejected`, otherwise `null`. Wire field: `rejection_message`. */
@@ -118,30 +301,195 @@ export interface AgentToolCall {
      * It extends the planned contract, as in the Python core. Wire field: `deferral_order`.
      */
     readonly deferralOrder: number;
+    /**
+     * {@link DeferredToolCall.toolSourceReference}: opaque text the tool's source stored with the call,
+     * absent when it stored none. Wire field: `tool_source_reference`, `null` when absent.
+     */
+    readonly toolSourceReference?: string;
+    /**
+     * W3C `traceparent` of the activation root that the call's `execute_tool` spans join; absent when
+     * none recorded. The session sets it when `RunModel` defers the call and again when an approval
+     * starts a new activation, so parallel activations never swap tool spans. Wire field:
+     * `trace_context`, `null` when absent.
+     */
+    readonly traceContext?: string;
+    /**
+     * RFC 3339 time at which a `durable_wait` call's Timer ends, otherwise `null`. Wire field: `wait_until`.
+     *
+     * Records the session reads always carry this field. It is optional only so that code that builds
+     * records by hand, such as a unit test, keeps compiling.
+     */
+    readonly waitUntil?: string | null;
+    /**
+     * Opaque text from the tool's last {@link ToolInputRequested}, returned to the tool when it runs
+     * again after the answer. For a call waiting for a task, the continuation of the task's last question
+     * until the next poll, and then what the last {@link ToolTaskPending} returned. `null` when there is none.
+     * Wire field: `input_continuation`. Optional for the same reason as {@link waitUntil}.
+     */
+    readonly inputContinuation?: string | null;
+    /**
+     * Answers to the questions the tool asked through {@link ToolInputRequested}, oldest first; empty
+     * for other calls. Wire field: `input_answers`. Optional for the same reason as {@link waitUntil}.
+     */
+    readonly inputAnswers?: readonly QuestionAnswer[];
+    /**
+     * Question text of the tool's pending {@link ToolInputRequested} while the record is
+     * `awaiting_answer`, otherwise `null`. It is `null` for an `ask_user` call, whose question is in
+     * {@link arguments}. `AwaitQuestionAnswer` raises the question interrupt from it under the
+     * `PendingInterrupts` lock. Wire field: `input_question`. Optional for the same reason as
+     * {@link waitUntil}.
+     */
+    readonly inputQuestion?: string | null;
+    /**
+     * Choices of that pending {@link ToolInputRequested}; empty for a free-text question or when no tool
+     * question is pending. Wire field: `input_choices`. Optional for the same reason as {@link waitUntil}.
+     */
+    readonly inputChoices?: readonly string[];
+    /**
+     * Whether that pending {@link ToolInputRequested} accepts free text; `true` when no tool question is
+     * pending. Wire field: `input_allows_free_text`. Optional for the same reason as {@link waitUntil}.
+     */
+    readonly inputAllowsFreeText?: boolean;
+    /**
+     * Why steering or `cancel_turn` abandoned the call before it started, on a `rejected` record;
+     * otherwise `null`. Wire field: `cancellation_reason`. Optional for the same reason as
+     * {@link waitUntil}.
+     */
+    readonly cancellationReason?: ToolCallCancellationReason | null;
+    /**
+     * The remote task ID from the tool's {@link ToolTaskStarted}, or `null` for a call that started no
+     * task. It stays on the record after the task finishes. Wire field: `task_id`. Optional for the same
+     * reason as {@link waitUntil}.
+     */
+    readonly taskId?: string | null;
+    /**
+     * Whole seconds `PollToolTask` waits before the next poll, at least 1, from {@link ToolTaskStarted} or
+     * the last {@link ToolTaskPending}; `null` for a call that started no task. Wire field:
+     * `task_poll_interval_seconds`. Optional for the same reason as {@link waitUntil}.
+     */
+    readonly taskPollIntervalSeconds?: number | null;
+    /**
+     * Whether the last entry of {@link inputAnswers}, the resolution of the task's last question, has not
+     * reached the task yet. `AwaitQuestionAnswer` sets it, `PollToolTask` then polls at once and hands that
+     * entry to the runner, and the poll's commit clears it. Wire field: `task_answer_pending`. Optional for
+     * the same reason as {@link waitUntil}.
+     */
+    readonly taskAnswerPending?: boolean;
 }
-/** One pending approval request, stored in the `PendingInterrupts` Attribute. */
+/**
+ * Why steering or cancellation abandoned a tool call before it started.
+ *
+ * - `steered`: `steer_user_message` superseded the turn.
+ * - `turn_cancelled`: `cancel_turn` stopped the turn.
+ *
+ * A `rejected` record carries one in {@link AgentToolCall.cancellationReason}; its `rejectionMessage` is
+ * {@link toolCallCancelledBySteeringResult} or {@link toolCallCancelledByTurnCancellationResult}.
+ */
+export type ToolCallCancellationReason = "steered" | "turn_cancelled";
+/**
+ * A stored tool call record, as `get_agent_snapshot` and `Client.getAttributes` return it.
+ *
+ * It is an {@link AgentToolCall} whose status may also be an {@link AgentToolCallWaitingStatus}, and
+ * whose fields added in 0.2.0 are always present.
+ */
+export interface AgentToolCallRecord extends Omit<AgentToolCall, "status" | "waitUntil" | "inputContinuation" | "inputAnswers" | "inputQuestion" | "inputChoices" | "inputAllowsFreeText" | "cancellationReason" | "taskId" | "taskPollIntervalSeconds" | "taskAnswerPending"> {
+    /** Current status. Wire field: `status`. */
+    readonly status: AgentToolCallRecordStatus;
+    /** See {@link AgentToolCall.waitUntil}. Wire field: `wait_until`. */
+    readonly waitUntil: string | null;
+    /** See {@link AgentToolCall.inputContinuation}. Wire field: `input_continuation`. */
+    readonly inputContinuation: string | null;
+    /** See {@link AgentToolCall.inputAnswers}. Wire field: `input_answers`. */
+    readonly inputAnswers: readonly QuestionAnswer[];
+    /** See {@link AgentToolCall.inputQuestion}. Wire field: `input_question`. */
+    readonly inputQuestion: string | null;
+    /** See {@link AgentToolCall.inputChoices}. Wire field: `input_choices`. */
+    readonly inputChoices: readonly string[];
+    /** See {@link AgentToolCall.inputAllowsFreeText}. Wire field: `input_allows_free_text`. */
+    readonly inputAllowsFreeText: boolean;
+    /**
+     * See {@link AgentToolCall.cancellationReason}. Wire field: `cancellation_reason`. Records the session reads
+     * always carry it; it is optional so that code that builds records by hand keeps compiling.
+     */
+    readonly cancellationReason?: ToolCallCancellationReason | null;
+    /**
+     * See {@link AgentToolCall.taskId}. Wire field: `task_id`. Records the session reads always carry it; it is
+     * optional so that code that builds records by hand keeps compiling, and a missing value means `null`.
+     */
+    readonly taskId?: string | null;
+    /**
+     * See {@link AgentToolCall.taskPollIntervalSeconds}. Wire field: `task_poll_interval_seconds`. Optional for
+     * the same reason as {@link taskId}; a missing value means `null`.
+     */
+    readonly taskPollIntervalSeconds?: number | null;
+    /**
+     * See {@link AgentToolCall.taskAnswerPending}. Wire field: `task_answer_pending`. Optional for the same
+     * reason as {@link taskId}; a missing value means `false`.
+     */
+    readonly taskAnswerPending?: boolean;
+}
+/**
+ * Kind of one {@link AgentInterrupt}.
+ *
+ * - `tool_approval`: a tool call waits for approval. Answer it with `resolve_interrupt`.
+ * - `question`: the model, through `ask_user`, or a tool, through {@link ToolInputRequested}, asked the
+ *   user a question. Answer it with `answer_question`, or decline it with `resolve_interrupt` and
+ *   `approved` `false`.
+ */
+export type AgentInterruptKind = "tool_approval" | "question";
+/** One pending approval or question, stored in the `PendingInterrupts` Attribute. */
 export interface AgentInterrupt {
-    /** Interrupt ID; equals the tool call ID for tool approvals. Wire field: `interrupt_id`. */
+    /**
+     * Interrupt ID passed to `resolve_interrupt` or `answer_question`. It equals the tool call ID for a
+     * tool approval and an `ask_user` question, and is `<toolCallId>-input-<n>` for the `n`-th question a
+     * tool asked through {@link ToolInputRequested}. Wire field: `interrupt_id`.
+     */
     readonly interruptId: string;
     /** Interrupt kind. Wire field: `kind`. */
-    readonly kind: "tool_approval";
-    /** Tool call awaiting approval. Wire field: `tool_call_id`. */
+    readonly kind: AgentInterruptKind;
+    /** Tool call that waits. Wire field: `tool_call_id`. */
     readonly toolCallId: string;
-    /** Tool name. Wire field: `tool_name`. */
+    /** Tool name; `ask_user` for an `ask_user` question. Wire field: `tool_name`. */
     readonly toolName: string;
     /** Tool arguments as JSON text. Wire field: `arguments`. */
     readonly arguments: string;
     /** RFC 3339 time at which the interrupt was raised. Wire field: `created_at`. */
     readonly createdAt: string;
-    /** RFC 3339 approval deadline, or `null` for no deadline. Wire field: `deadline`. */
+    /**
+     * RFC 3339 deadline, or `null` for no deadline. After it, the session rejects the call with
+     * {@link approvalDeadlinePassed} or {@link questionDeadlinePassed}. Wire field: `deadline`.
+     */
     readonly deadline: string | null;
+    /**
+     * Question text of a `question` interrupt, otherwise `null`. Wire field: `question`.
+     *
+     * Interrupts the session reads always carry this field and the two below. They are optional only so
+     * that code written against 0.1.0, which builds interrupts by hand, keeps compiling; treat `undefined`
+     * as `null`, an empty list, and `true`.
+     */
+    readonly question?: string | null;
+    /** Answers to offer for a `question` interrupt; empty for a free-text question. Wire field: `choices`. */
+    readonly choices?: readonly string[];
+    /**
+     * Whether `answer_question` accepts an answer that is not one of {@link choices}. Always `true` when
+     * `choices` is empty and for a tool approval. Wire field: `allows_free_text`.
+     */
+    readonly allowsFreeText?: boolean;
 }
 /** Resolution of one interrupt, published to the `InterruptResolutions` ChannelMap. */
 export interface AgentInterruptResolution {
-    /** Whether the tool call may run. Wire field: `approved`. */
+    /**
+     * Whether the tool call may run, or, for a question, whether the user answered it. Wire field:
+     * `approved`.
+     */
     readonly approved: boolean;
-    /** Text shown to the model when rejected, or `null`. Wire field: `rejection_message`. */
+    /** Text shown to the model when rejected or declined, or `null`. Wire field: `rejection_message`. */
     readonly rejectionMessage: string | null;
+    /**
+     * The answer to a `question` interrupt, otherwise `null`. Wire field: `answer`. Resolutions the
+     * session reads always carry it; it is optional so that 0.1.0 code keeps compiling.
+     */
+    readonly answer?: string | null;
 }
 /**
  * Model usage counters, stored cumulatively in the `AgentUsage` Attribute.
@@ -170,10 +518,120 @@ export interface ToolCallCompleted {
     /** Tool call whose record is final. Wire field: `tool_call_id`. */
     readonly toolCallId: string;
 }
-/** One user message, the input of the `send_user_message` RPC and the `QueuedUserMessages` Channel value. */
+/**
+ * One user message, the input of the `send_user_message` RPC and the value of the `QueuedUserMessages` and
+ * `SteeredUserMessages` Channels.
+ */
 export interface AgentUserMessage {
     /** Message text. Blank text is rejected. Wire field: `text`. */
     readonly text: string;
+    /**
+     * Whether the message starts a `planning` turn, which drafts a plan for review instead of doing the work.
+     * `send_user_message` rejects it unless {@link AgentSessionOptions.planModeEnabled} is set. Wire field:
+     * `plan_mode`, `false` by default; a decoded message omits it when `false`, and `null` reads as `false`.
+     */
+    readonly planMode?: boolean;
+}
+/**
+ * One user message that waits in `QueuedUserMessages` or `SteeredUserMessages`, as `get_agent_snapshot` lists it,
+ * so a UI can delete or steer a queued message by its ID.
+ */
+export interface PendingUserMessage {
+    /** Channel message ID that Dex assigned when the message was published. Wire field: `message_id`. */
+    readonly messageId: string;
+    /** The user message. Wire field: `message`. */
+    readonly message: AgentUserMessage;
+}
+/**
+ * Input of the `steer_user_message` RPC. Set exactly one field: `messageId` moves a queued message, and `text`
+ * sends a new one.
+ *
+ * @example
+ * ```ts
+ * await client.invokeRPC(flow.steerUserMessage, sessionId, { messageId: null, text: "Use staging instead" });
+ * const [queued] = (await client.invokeRPC(flow.getAgentSnapshot, sessionId)).queuedMessages ?? [];
+ * if (queued !== undefined) {
+ *   await client.invokeRPC(flow.steerUserMessage, sessionId, { messageId: queued.messageId, text: null });
+ * }
+ * ```
+ */
+export interface SteerUserMessageRequest {
+    /** {@link PendingUserMessage.messageId} of a queued message, or `null`. Wire field: `message_id`. */
+    readonly messageId: string | null;
+    /** Text of a new steered message, or `null`. Wire field: `text`. */
+    readonly text: string | null;
+}
+/** Input of the `delete_queued_message` RPC. */
+export interface DeleteQueuedMessageRequest {
+    /** {@link PendingUserMessage.messageId} of a queued message. Wire field: `message_id`. */
+    readonly messageId: string;
+}
+/** Input of the `cancel_turn` RPC. */
+export interface CancelTurnRequest {
+    /**
+     * The turn to stop, or `null` for whichever turn is active. A turn ID that is not the active turn makes the
+     * RPC return `false`. Wire field: `turn_id`.
+     */
+    readonly turnId: string | null;
+}
+/**
+ * Input of the `update_session_settings` RPC, which replaces the session's settings from the next turn on.
+ *
+ * @example
+ * ```ts
+ * await client.invokeRpc(flow.updateSessionSettings, "session-42", { sessionSettings: { model: "gpt-5" } });
+ * ```
+ */
+export interface UpdateSessionSettingsRequest {
+    /**
+     * The complete new {@link SessionSettings}. They replace the old settings; nothing is merged, and `{}` clears
+     * them. Never put a secret in them. `null`, which a missing field also decodes to, makes the RPC return
+     * `false` and change nothing. Wire field: `session_settings`.
+     */
+    readonly sessionSettings: SessionSettings | null;
+}
+/**
+ * The settings one turn started with, stored in the `TurnSessionSettings` Attribute.
+ *
+ * The Step that starts a turn writes it in the commit that starts the turn. The session reads it only while
+ * {@link turnId} is `AgentState.activeTurnId`, so a copy an earlier turn left, such as when a Worker without
+ * session settings started the current turn, reads as no settings.
+ */
+export interface TurnSessionSettings {
+    /** Turn ID of the turn that started with these settings. Wire field: `turn_id`. */
+    readonly turnId: string;
+    /** The settings, a non-empty JSON object. Wire field: `session_settings`. */
+    readonly sessionSettings: SessionSettings;
+}
+/** Name of the RPC that published one {@link TurnControlRequest}. */
+export type TurnControlKind = "steer" | "cancel_turn";
+/**
+ * Wake-up of a waiting session Step, published to the internal `TurnControlRequests` Channel by
+ * `steer_user_message` and `cancel_turn`. The session decides from `SteeredUserMessages` and
+ * `TurnCancellationRequest`, not from this message.
+ */
+export interface TurnControlRequest {
+    /** The RPC that published it. Wire field: `kind`. */
+    readonly kind: TurnControlKind;
+}
+/**
+ * The latest `cancel_turn` request, stored in the `TurnCancellationRequest` Attribute. A turn is cancelled while
+ * `turnId` equals `AgentState.activeTurnId`. Turn IDs never repeat, so a request for an earlier turn never matches.
+ */
+export interface TurnCancellationRequest {
+    /** The turn to stop. Wire field: `turn_id`. */
+    readonly turnId: string;
+    /** RFC 3339 time of the request. Wire field: `requested_at`. */
+    readonly requestedAt: string;
+}
+/**
+ * Wake-up of the Step that waits on one tool call, published by `ResumeTurn` to the internal
+ * `ToolCallCancellations` ChannelMap instance named by the tool call ID. The waiting Step decides from the
+ * session's flags, not from this message.
+ */
+export interface ToolCallCancellation {
+    /** Why the turn ends. Wire field: `reason`. */
+    readonly reason: ToolCallCancellationReason;
 }
 /**
  * Standard type of one {@link AgentEvent}. Adapters may write other types with an adapter prefix.
@@ -182,18 +640,37 @@ export interface AgentUserMessage {
  * - `turn_started`: `{"sequence"}`, the sequence of the user message that started the turn.
  * - `turn_completed`: `{"message_count"}`, the number of messages the turn appended.
  * - `turn_failed`: `{"error"}`.
+ * - `turn_steered`: `{"steered_message_count","message_count"}`, when steering ended the turn before its final
+ *   answer: the steered messages that start the next turn, and the messages the ended turn appended. Treat it
+ *   like `turn_completed`.
+ * - `turn_cancelled`: `{"message_count"}`, when `cancel_turn` ended the turn before its final answer. Treat it
+ *   like `turn_completed`.
  * - `text_delta` and `reasoning_delta`: `{"text"}`.
  * - `tool_call_started`: `{"tool_call_id","tool_name"}`.
  * - `tool_call_finished`: `{"tool_call_id","tool_name","status"}`, when a record becomes final,
  *   including a rejection.
  * - `tool_call_deferred`: `{"tool_call_id","tool_name","effect","requires_approval"}`, when the model
- *   asks for a call, which then runs in its own Step.
- * - `interrupt_raised`: `{"interrupt_id","tool_call_id","tool_name","deadline"}`.
- * - `interrupt_resolved`: `{"interrupt_id","approved","rejection_message"}`.
+ *   asks for a call, which then runs in its own Step or, for a built-in tool, waits in the session.
+ * - `interrupt_raised`: `{"interrupt_id","kind","tool_call_id","tool_name","deadline","question",
+ *   "choices","allows_free_text"}`. For a tool approval, `question` is `null`, `choices` is empty, and
+ *   `allows_free_text` is `true`.
+ * - `interrupt_resolved`: `{"interrupt_id","kind","approved","answered","rejection_message",
+ *   "cancellation_reason"}`. `answered` is `true` only for an answered question. `cancellation_reason`
+ *   is `"steered"` or `"turn_cancelled"` when steering or `cancel_turn` abandoned the call, otherwise `null`.
+ * - `timer_started`: `{"tool_call_id","wait_until","reason"}`, when a `durable_wait` call starts its Timer.
+ * - `plan_updated`: `{"revision","status","task_count"}`, when `write_todos` replaced the plan or an
+ *   approval marked a draft `active`.
+ * - `plan_execution_started`: `{"revision"}`, after the `turn_started` of an `executing` turn.
+ * - `tool_task_started`: `{"tool_call_id","tool_name","task_id"}`, when a tool starts remote work that
+ *   `PollToolTask` polls.
  * - `usage_recorded`: `{"recorded","session"}`: one model call's and the cumulative usage, each with
  *   {@link AgentUsage} wire fields.
+ * - `compaction_started`: `{"through_sequence"}`, when `CompactContext` starts summarizing the messages
+ *   through that sequence. A retried attempt writes it again.
+ * - `compaction_finished`: `{"generation","through_sequence"}`, when `CompactContext` wrote a
+ *   {@link ContextSummary}.
  */
-export type AgentEventType = "turn_started" | "turn_completed" | "turn_failed" | "text_delta" | "reasoning_delta" | "tool_call_started" | "tool_call_finished" | "tool_call_deferred" | "interrupt_raised" | "interrupt_resolved" | "usage_recorded";
+export type AgentEventType = "turn_started" | "turn_completed" | "turn_failed" | "turn_steered" | "turn_cancelled" | "text_delta" | "reasoning_delta" | "tool_call_started" | "tool_call_finished" | "tool_call_deferred" | "interrupt_raised" | "interrupt_resolved" | "timer_started" | "plan_updated" | "plan_execution_started" | "tool_task_started" | "usage_recorded" | "compaction_started" | "compaction_finished";
 /** One best-effort live event, written to the `AgentEvents` Stream. */
 export interface AgentEvent {
     /** An {@link AgentEventType} or an adapter-specific type such as `"vercel_ai.step"`. Wire field: `type`. */
@@ -209,8 +686,8 @@ export interface AgentEvent {
      * Group live text by `(turnId, stepExecutionId, attempt)`. Within one `stepExecutionId`, keep only the
      * events of the highest `attempt` seen and drop the partial text of lower attempts. Different
      * `stepExecutionId` values of one turn are its model calls and tool Steps, and each keeps its
-     * own events. After `turn_completed` or `turn_failed`, replace the turn's live text with the stored
-     * messages.
+     * own events. After `turn_completed`, `turn_failed`, `turn_steered`, or `turn_cancelled`, replace the
+     * turn's live text with the stored messages.
      */
     readonly stepExecutionId: string;
     /** Event payload as JSON text. Wire field: `payload`. */
@@ -225,6 +702,134 @@ export interface ResolveInterruptInput {
     /** Text shown to the model when rejected, or `null`. Wire field: `rejection_message`. */
     readonly rejectionMessage: string | null;
 }
+/**
+ * Input of the `answer_question` RPC.
+ *
+ * @example
+ * ```ts
+ * const question = snapshot.pendingInterrupts.find((interrupt) => interrupt.kind === "question");
+ * if (question !== undefined) {
+ *   await client.invokeRPC(flow.answerQuestion, sessionId, {
+ *     interruptId: question.interruptId, answer: question.choices[0] ?? "yes" });
+ * }
+ * ```
+ */
+export interface AnswerQuestionRequest {
+    /** {@link AgentInterrupt.interruptId} of a pending `question` interrupt. Wire field: `interrupt_id`. */
+    readonly interruptId: string;
+    /**
+     * The answer. It must not be blank. When the interrupt has `choices` and `allowsFreeText` is `false`,
+     * it must equal one of the choices exactly. Wire field: `answer`.
+     */
+    readonly answer: string;
+}
+/**
+ * The summary that replaces a session's earlier messages in the model input, stored in the
+ * `ContextSummary` Attribute.
+ *
+ * Only `CompactContext` writes it, in a session with {@link AgentSessionOptions.compaction}. Each new
+ * summary folds in the previous one, so it always covers the messages from {@link firstSequence}
+ * through {@link lastSequence}. The summarized messages stay stored, and `list_agent_messages` and
+ * `get_agent_snapshot` return them, until retention deletes whole archive chunks of them; see
+ * `AgentSessionOptions.retainedMessageLimit`. Only the model input changes.
+ *
+ * @example
+ * ```ts
+ * const snapshot = await client.invokeRPC(flow.getAgentSnapshot, sessionId);
+ * const summarizedThrough = snapshot.contextSummary?.lastSequence ?? 0;
+ * ```
+ */
+export interface ContextSummary {
+    /** Count of summaries the session has written, starting at 1. Wire field: `generation`. */
+    readonly generation: number;
+    /** Sequence of the first summarized message; always 1. Wire field: `first_sequence`. */
+    readonly firstSequence: number;
+    /**
+     * Sequence of the last summarized message. A runner with the compaction capability receives only the
+     * messages after it. Wire field: `last_sequence`.
+     */
+    readonly lastSequence: number;
+    /** Summary text from the runner's `summarizeContext`. Wire field: `text`. */
+    readonly text: string;
+    /** RFC 3339 time at which `CompactContext` wrote the summary. Wire field: `created_at`. */
+    readonly createdAt: string;
+}
+/**
+ * One immutable archive chunk of the `AgentMessageChunks` AttributeMap.
+ *
+ * When the `AgentMessages` window grows past `AgentSessionOptions.messageWindowSize`, its oldest messages
+ * move into chunks of at most `messageChunkSize` messages and `messageChunkMaxBytes` bytes, each keyed by
+ * `messageSequenceKey` of its first sequence. A chunk is never rewritten. Retention deletes a whole chunk.
+ */
+export interface AgentMessageChunk {
+    /**
+     * The chunk's messages with consecutive sequences, oldest first: the range its
+     * {@link AgentMessageChunkRange} names. Wire field: `messages`.
+     */
+    readonly messages: readonly AgentMessage[];
+}
+/** The sequences one `AgentMessageChunks` instance holds, as {@link AgentMessageIndex.chunks} lists it. */
+export interface AgentMessageChunkRange {
+    /** Sequence of the chunk's first message; the instance key is `messageSequenceKey` of it. Wire field: `first_sequence`. */
+    readonly firstSequence: number;
+    /** Sequence of the chunk's last message. Wire field: `last_sequence`. */
+    readonly lastSequence: number;
+}
+/**
+ * Where a session's messages are stored, held in the `AgentMessageIndex` Attribute.
+ *
+ * Messages from {@link windowFirstSequence} on are in the `AgentMessages` window, one instance per message.
+ * Earlier ones, from {@link firstSequence}, are in the `AgentMessageChunks` instances that {@link chunks}
+ * lists. A chunk holds at most `messageChunkSize` messages and at most `messageChunkMaxBytes` bytes, except
+ * that a larger message gets a chunk of its own. A session that a 0.1.0 Worker wrote has no index: every
+ * message is in `AgentMessages` until the session's writes on this version move them, a few chunks per
+ * commit.
+ *
+ * @example
+ * ```ts
+ * const [index] = await client.getAttributes(sessionId, flow.agentMessageIndex);
+ * const oldestStored = index?.firstSequence ?? 1;
+ * const chunk = index?.chunks.find((range) => range.firstSequence <= 7 && 7 <= range.lastSequence);
+ * ```
+ */
+export interface AgentMessageIndex {
+    /**
+     * Every kept chunk, oldest first, without overlaps. The archived ones, before `windowFirstSequence`, are
+     * contiguous from `firstSequence`. A chunk at or after `windowFirstSequence` holds one message that was too
+     * large for the window, stored straight into its own chunk. Wire field: `chunks`.
+     */
+    readonly chunks: readonly AgentMessageChunkRange[];
+    /**
+     * Sequence of the oldest stored message: the first archived chunk's first sequence, or `windowFirstSequence`
+     * when no archived chunk is kept. Retention deleted every earlier message. Wire field: `first_sequence`.
+     */
+    readonly firstSequence: number;
+    /** Sequence of the first message in the `AgentMessages` window. Wire field: `window_first_sequence`. */
+    readonly windowFirstSequence: number;
+}
+/**
+ * Where the replies of a turn start: the value of the `TurnReplySequence` Attribute.
+ *
+ * The Step that starts a turn writes it, so the turn's `turn_completed`, `turn_steered`, and `turn_cancelled`
+ * events count the turn's messages after its user messages without reading them. A value for another turn,
+ * such as one a 0.1.0 Worker started, is ignored.
+ */
+export interface TurnReplySequence {
+    /** `"turn-<n>"` of the turn. Wire field: `turn_id`. */
+    readonly turnId: string;
+    /** First sequence after the user messages that started the turn. Wire field: `sequence`. */
+    readonly sequence: number;
+}
+/**
+ * Input of the `CompactContext` Step: the last message to summarize.
+ *
+ * `RunModel` moves to `CompactContext` with it when the next model input would cross the compaction
+ * threshold.
+ */
+export interface CompactContextInput {
+    /** Sequence of the last message to summarize, after the current summary's. Wire field: `through_sequence`. */
+    readonly throughSequence: number;
+}
 /** Output of the `get_agent_snapshot` RPC, enough for a UI to rebuild its view. */
 export interface AgentSnapshot {
     /** Current session state, or `null` before `StartAgentSession` committed. Wire field: `state`. */
@@ -234,11 +839,36 @@ export interface AgentSnapshot {
     /** Interrupts that `resolve_interrupt` still accepts. Wire field: `pending_interrupts`. */
     readonly pendingInterrupts: readonly AgentInterrupt[];
     /** Deferred tool call records of the active turn, in deferral order. Wire field: `tool_calls`. */
-    readonly toolCalls: readonly AgentToolCall[];
+    readonly toolCalls: readonly AgentToolCallRecord[];
     /** Cumulative usage. Wire field: `usage`. */
     readonly usage: AgentUsage;
     /** User messages queued and not yet consumed. Wire field: `queued_message_count`. */
     readonly queuedMessageCount: number;
+    /**
+     * The {@link AgentPlan}, or absent before `write_todos` first succeeded. Wire field: `plan`, `null` while
+     * there is none; a decoded snapshot omits it then, like the other fields plans added.
+     */
+    readonly plan?: AgentPlan | null;
+    /**
+     * Those queued messages with their Channel message IDs, oldest first; pass an ID to `delete_queued_message` or
+     * `steer_user_message`. Wire field: `queued_messages`. Snapshots the session returns always carry it and the
+     * field below; they are optional so that 0.1.0 code that builds snapshots keeps compiling.
+     */
+    readonly queuedMessages?: readonly PendingUserMessage[];
+    /** Steered messages the session has not applied yet, oldest first. Wire field: `steered_messages`. */
+    readonly steeredMessages?: readonly PendingUserMessage[];
+    /**
+     * The current {@link ContextSummary}, or `null` when the session never compacted; {@link messages}
+     * still holds the summarized messages. Wire field: `context_summary`. The RPC always sets it; it is
+     * optional so that 0.1.0 code that builds a snapshot keeps compiling.
+     */
+    readonly contextSummary?: ContextSummary | null;
+    /**
+     * The `SessionSettings` Attribute: the settings the next turn starts with, or `null` when the session has
+     * none. The active turn may still run with the settings it started with. Wire field: `session_settings`. The
+     * RPC always sets it; it is optional so that 0.1.0 code that builds a snapshot keeps compiling.
+     */
+    readonly sessionSettings?: SessionSettings | null;
 }
 /** Input of the `list_agent_messages` RPC. */
 export interface ListAgentMessagesInput {
@@ -256,6 +886,12 @@ export interface AgentMessagesPage {
      * Wire field: `next_before_sequence`.
      */
     readonly nextBeforeSequence: number | null;
+    /**
+     * The oldest stored sequence when retention deleted every earlier message, or `null` when none was deleted.
+     * A page whose `nextBeforeSequence` is `null` reaches the start of the conversation only when this is
+     * `null` too. Absent in a page a 0.1.0 Worker returned. Wire field: `deleted_before_sequence`.
+     */
+    readonly deletedBeforeSequence?: number | null;
 }
 /**
  * Returns usage with every counter at zero.
@@ -281,9 +917,9 @@ export declare function addAgentUsage(left: AgentUsage, right: AgentUsage): Agen
  *
  * @param status - Status to classify.
  * @returns `true` for `rejected`, `succeeded`, `failed`, and `outcome_unknown`; `false` for
- * `awaiting_approval` and `approved`.
+ * `awaiting_approval`, `approved`, and every {@link AgentToolCallWaitingStatus}.
  */
-export declare function isFinalToolCallStatus(status: AgentToolCallStatus): boolean;
+export declare function isFinalToolCallStatus(status: AgentToolCallRecordStatus): boolean;
 /** Tool result text the model sees for an `outcome_unknown` call; the same text as the Python core. */
 export declare const outcomeUnknownToolResult: string;
 /** First line of the note `RecordTurnFailure` stores after a failed turn ran tools. */
@@ -294,6 +930,34 @@ export declare const turnFailureNoteFooter = "Do not repeat these tool calls unl
 export declare const defaultRejectionToolResult = "The user rejected this tool call.";
 /** Rejection message recorded when an approval deadline passes. */
 export declare const approvalDeadlinePassed = "approval deadline passed";
+/** Rejection message recorded when a question's deadline passes. */
+export declare const questionDeadlinePassed = "question deadline passed";
+/** Tool result text the model sees when the user declines a question without a message, or with an empty one. */
+export declare const defaultQuestionDeclinedToolResult = "The user declined to answer.";
+/** First line of the note `ApplyTurnControl` stores after a steered turn ran tools. */
+export declare const turnSteeredNoteHeader = "[Dex] The user steered the conversation after these tool calls ran:";
+/** First line of the note `ApplyTurnControl` stores after a cancelled turn ran tools. */
+export declare const turnCancelledNoteHeader = "[Dex] The user stopped the previous turn after these tool calls ran:";
+/** Model-visible result of a tool call that steering abandoned before it started; the same text as the Python core. */
+export declare const toolCallCancelledBySteeringResult = "{\"status\":\"cancelled\",\"reason\":\"superseded_by_steered_user_message\"}";
+/** Model-visible result of a tool call that `cancel_turn` abandoned before it started. */
+export declare const toolCallCancelledByTurnCancellationResult = "{\"status\":\"cancelled\",\"reason\":\"turn_cancelled_by_user\"}";
+/**
+ * Error recorded when a tool returns {@link ToolTaskStarted} to a runner without
+ * {@link AgentFrameworkRunner.pollToolTask}. The Python core names its method `poll_tool_task`.
+ */
+export declare const missingToolTaskPoller = "the tool started a task, but the runner does not implement pollToolTask";
+/** Error recorded when a {@link ToolTaskStarted} has a blank `taskId`; the same text as the Python core. */
+export declare const blankToolTaskId = "the tool started a task without a task ID";
+/** Error recorded when a task's poll interval is not a number; the same text as the Python core. */
+export declare const invalidToolTaskPollInterval = "the tool task's poll interval is not a number";
+/** Error of an `outcome_unknown` record whose task `cancel_turn` abandoned; the same text as the Python core. */
+export declare const toolTaskAbandonedError = "the turn was cancelled while the tool's task was running; the task may have taken effect";
+/**
+ * Start of the `error` of a `failed` record whose tool Step certainly never ran the tool; the same text as the
+ * Python core.
+ */
+export declare const toolCallNotRunErrorPrefix = "the tool did not run, so it is safe to call again";
 /**
  * Returns the note text that tells the model what a failed turn already did.
  *
@@ -313,7 +977,9 @@ export declare const approvalDeadlinePassed = "approval deadline passed";
  * joined with newlines.
  * @throws {TypeError} When a record is not final.
  */
-export declare function buildTurnFailureNote(toolCalls: readonly AgentToolCall[]): string;
+export declare function buildTurnFailureNote(toolCalls: readonly (AgentToolCall | AgentToolCallRecord)[]): string;
+/** Returns a note in the turn-failure note's line format with another first line. */
+export declare function buildToolCallNote(header: string, toolCalls: readonly (AgentToolCall | AgentToolCallRecord)[]): string;
 /**
  * Returns the tool result text a runner shows the model for a final tool call record.
  *
@@ -332,6 +998,6 @@ export declare function buildTurnFailureNote(toolCalls: readonly AgentToolCall[]
  * @returns The output for `succeeded`; `The tool call failed: <error>` for `failed`; the rejection
  * message, or {@link defaultRejectionToolResult}, for `rejected`; {@link outcomeUnknownToolResult}
  * for `outcome_unknown`.
- * @throws {TypeError} When the record status is `awaiting_approval` or `approved`.
+ * @throws {TypeError} When the record status is not final.
  */
-export declare function describeToolCallOutcome(toolCall: AgentToolCall): string;
+export declare function describeToolCallOutcome(toolCall: AgentToolCall | AgentToolCallRecord): string;