@grackle-ai/ahp 0.131.0

package/dist/vendor/ahp/channels-session/state.d.ts

@@ -0,0 +1,1217 @@
+/**
+ * Session State Types — Per-session state, turns, messages, response parts,
+ * tool calls, and elicitation/input requests exposed on `ahp-session:` channels.
+ *
+ * @module channels-session/state
+ */
+import type { URI, StringOrMarkdown, Icon, ConfigPropertySchema, ContentRef, ErrorInfo, FileEdit, TextRange, TextSelection, UsageInfo } from '../common/state.js';
+import type { ChangesetSummary } from '../channels-changeset/state.js';
+import type { ModelSelection } from '../channels-root/state.js';
+/**
+ * Discriminant for pending message kinds.
+ *
+ * @category Pending Message Types
+ */
+export declare enum PendingMessageKind {
+    /** Injected into the current turn at a convenient point */
+    Steering = "steering",
+    /** Sent automatically as a new turn after the current turn finishes */
+    Queued = "queued"
+}
+/**
+ * A message queued for future delivery to the agent.
+ *
+ * Steering messages are injected into the current turn mid-flight.
+ * Queued messages are automatically started as new turns after the
+ * current turn naturally finishes.
+ *
+ * @category Pending Message Types
+ */
+export interface PendingMessage {
+    /** Unique identifier for this pending message */
+    id: string;
+    /** The message content */
+    userMessage: UserMessage;
+}
+/**
+ * Session initialization state.
+ *
+ * @category Session State
+ */
+export declare enum SessionLifecycle {
+    Creating = "creating",
+    Ready = "ready",
+    CreationFailed = "creationFailed"
+}
+/**
+ * Bitset of summary-level session status flags.
+ *
+ * Use bitwise checks instead of equality for non-terminal activity. For example,
+ * `status & SessionStatus.InProgress` matches both ordinary in-progress turns
+ * and turns that are paused waiting for input.
+ *
+ * @category Session State
+ */
+export declare enum SessionStatus {
+    /** Session is idle — no turn is active. */
+    Idle = 1,
+    /** Session ended with an error. */
+    Error = 2,
+    /** A turn is actively streaming. */
+    InProgress = 8,
+    /** A turn is in progress but blocked waiting for user input or tool confirmation. */
+    InputNeeded = 24,
+    /** The client has viewed this session since its last modification. */
+    IsRead = 32,
+    /** The session has been archived by the client. */
+    IsArchived = 64
+}
+/**
+ * Full state for a single session, loaded when a client subscribes to the session's URI.
+ *
+ * @category Session State
+ */
+export interface SessionState {
+    /** Lightweight session metadata */
+    summary: SessionSummary;
+    /** Session initialization state */
+    lifecycle: SessionLifecycle;
+    /** Error details if creation failed */
+    creationError?: ErrorInfo;
+    /** Tools provided by the server (agent host) for this session */
+    serverTools?: ToolDefinition[];
+    /** The client currently providing tools and interactive capabilities to this session */
+    activeClient?: SessionActiveClient;
+    /** Completed turns */
+    turns: Turn[];
+    /** Currently in-progress turn */
+    activeTurn?: ActiveTurn;
+    /** Message to inject into the current turn at a convenient point */
+    steeringMessage?: PendingMessage;
+    /** Messages to send automatically as new turns after the current turn finishes */
+    queuedMessages?: PendingMessage[];
+    /** Requests for user input that are currently blocking or informing session progress */
+    inputRequests?: SessionInputRequest[];
+    /** Session configuration schema and current values */
+    config?: SessionConfigState;
+    /**
+     * Server-provided customizations active in this session.
+     *
+     * Client-provided customizations are available on
+     * {@link SessionActiveClient.customizations | activeClient.customizations}.
+     */
+    customizations?: SessionCustomization[];
+    /**
+     * Additional provider-specific metadata for this session.
+     *
+     * Clients MAY look for well-known keys here to provide enhanced UI.
+     * For example, a `git` key may provide extra git metadata about the session's
+     * workingDirectory.
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * The client currently providing tools and interactive capabilities to a session.
+ *
+ * Only one client may be active per session at a time. The server SHOULD
+ * automatically unset the active client if that client disconnects.
+ *
+ * @category Session State
+ */
+export interface SessionActiveClient {
+    /** Client identifier (matches `clientId` from `initialize`) */
+    clientId: string;
+    /** Human-readable client name (e.g. `"VS Code"`) */
+    displayName?: string;
+    /** Tools this client provides to the session */
+    tools: ToolDefinition[];
+    /** Customizations this client contributes to the session */
+    customizations?: CustomizationRef[];
+}
+/**
+ * Server-owned project metadata for a session.
+ *
+ * @category Session State
+ */
+export interface ProjectInfo {
+    /** Project URI */
+    uri: URI;
+    /** Human-readable project name */
+    displayName: string;
+}
+/**
+ * @category Session State
+ */
+export interface SessionSummary {
+    /** Session URI */
+    resource: URI;
+    /** Agent provider ID */
+    provider: string;
+    /** Session title */
+    title: string;
+    /** Current session status */
+    status: SessionStatus;
+    /** Human-readable description of what the session is currently doing */
+    activity?: string;
+    /** Creation timestamp */
+    createdAt: number;
+    /** Last modification timestamp */
+    modifiedAt: number;
+    /** Server-owned project for this session */
+    project?: ProjectInfo;
+    /** Currently selected model */
+    model?: ModelSelection;
+    /**
+     * Currently selected custom agent.
+     *
+     * Absent (`undefined`) means no custom agent is selected for this session
+     * — the session uses the provider's default behavior.
+     */
+    agent?: AgentSelection;
+    /** The working directory URI for this session */
+    workingDirectory?: URI;
+    /**
+     * Catalogue of changesets the server can produce for this session. Each
+     * entry advertises a subscribable view of file changes (uncommitted,
+     * session-wide, per-turn, etc.) and the URI template the client expands
+     * before subscribing. See {@link ChangesetSummary} for the full shape and
+     * {@link /guide/changesets | Changesets} for an overview of the model.
+     */
+    changesets?: ChangesetSummary[];
+}
+/**
+ * A selected custom agent for a session.
+ *
+ * The `uri` identifies a specific custom agent (matching a
+ * {@link CustomizationAgentRef.uri | `CustomizationAgentRef.uri`} exposed
+ * via the session's effective customizations). Consumers resolve the
+ * agent's display name by looking up `uri` in
+ * {@link SessionCustomization.agents | `SessionCustomization.agents`}.
+ *
+ * A session with no `agent` selected uses the provider's default behavior.
+ *
+ * @category Session State
+ */
+export interface AgentSelection {
+    /** Stable agent URI (matches a {@link CustomizationAgentRef.uri}) */
+    uri: URI;
+}
+/**
+ * A session configuration property descriptor.
+ *
+ * Extends the generic {@link ConfigPropertySchema} with session-specific
+ * display extensions.
+ *
+ * @category Session Config Types
+ */
+export interface SessionConfigPropertySchema extends ConfigPropertySchema {
+    /**
+     * Display extension: when `true`, the full set of allowed values is too large
+     * to enumerate statically. The client SHOULD use `sessionConfigCompletions`
+     * to fetch matching values based on user input. Any values in `enum` are
+     * seed/recent values for initial display.
+     */
+    enumDynamic?: boolean;
+    /** When `true`, the user may change this property after session creation */
+    sessionMutable?: boolean;
+}
+/**
+ * A JSON Schema object describing available session configuration metadata.
+ *
+ * @category Session Config Types
+ */
+export interface SessionConfigSchema {
+    /** JSON Schema: always `'object'` */
+    type: 'object';
+    /** JSON Schema: property descriptors keyed by property id */
+    properties: Record<string, SessionConfigPropertySchema>;
+    /** JSON Schema: list of required property ids */
+    required?: string[];
+}
+/**
+ * Live session configuration metadata.
+ *
+ * The schema describes the available configuration properties and the values
+ * contain the current value for each resolved property.
+ *
+ * @category Session Config Types
+ */
+export interface SessionConfigState {
+    /** JSON Schema describing available configuration properties */
+    schema: SessionConfigSchema;
+    /** Current configuration values */
+    values: Record<string, unknown>;
+}
+/**
+ * How a client completed an input request.
+ *
+ * @category Session Input Types
+ */
+export declare enum SessionInputResponseKind {
+    Accept = "accept",
+    Decline = "decline",
+    Cancel = "cancel"
+}
+/**
+ * Question/input control kind.
+ *
+ * @category Session Input Types
+ */
+export declare enum SessionInputQuestionKind {
+    Text = "text",
+    Number = "number",
+    Integer = "integer",
+    Boolean = "boolean",
+    SingleSelect = "single-select",
+    MultiSelect = "multi-select"
+}
+/**
+ * A choice in a select-style question.
+ *
+ * @category Session Input Types
+ */
+export interface SessionInputOption {
+    /** Stable option identifier; for MCP enum values this is the enum string */
+    id: string;
+    /** Display label */
+    label: string;
+    /** Optional secondary text */
+    description?: string;
+    /** Whether this option is the recommended/default choice */
+    recommended?: boolean;
+}
+interface SessionInputQuestionBase {
+    /** Stable question identifier used as the key in `answers` */
+    id: string;
+    /** Short display title */
+    title?: string;
+    /** Prompt shown to the user */
+    message: string;
+    /** Whether the user must answer this question to accept the request */
+    required?: boolean;
+}
+/** Text question within a session input request. */
+export interface SessionInputTextQuestion extends SessionInputQuestionBase {
+    kind: SessionInputQuestionKind.Text;
+    /** Format hint for text questions, such as `email`, `uri`, `date`, or `date-time` */
+    format?: string;
+    /** Minimum string length */
+    min?: number;
+    /** Maximum string length */
+    max?: number;
+    /** Default text */
+    defaultValue?: string;
+}
+/** Numeric question within a session input request. */
+export interface SessionInputNumberQuestion extends SessionInputQuestionBase {
+    kind: SessionInputQuestionKind.Number | SessionInputQuestionKind.Integer;
+    /**
+     * Minimum value
+     * @format float
+     */
+    min?: number;
+    /**
+     * Maximum value
+     * @format float
+     */
+    max?: number;
+    /**
+     * Default numeric value
+     * @format float
+     */
+    defaultValue?: number;
+}
+/** Boolean question within a session input request. */
+export interface SessionInputBooleanQuestion extends SessionInputQuestionBase {
+    kind: SessionInputQuestionKind.Boolean;
+    /** Default boolean value */
+    defaultValue?: boolean;
+}
+/** Single-select question within a session input request. */
+export interface SessionInputSingleSelectQuestion extends SessionInputQuestionBase {
+    kind: SessionInputQuestionKind.SingleSelect;
+    /** Options the user may select from */
+    options: SessionInputOption[];
+    /** Whether the user may enter text instead of selecting an option */
+    allowFreeformInput?: boolean;
+}
+/** Multi-select question within a session input request. */
+export interface SessionInputMultiSelectQuestion extends SessionInputQuestionBase {
+    kind: SessionInputQuestionKind.MultiSelect;
+    /** Options the user may select from */
+    options: SessionInputOption[];
+    /** Whether the user may enter text in addition to selecting options */
+    allowFreeformInput?: boolean;
+    /** Minimum selected item count */
+    min?: number;
+    /** Maximum selected item count */
+    max?: number;
+}
+/**
+ * One question within a session input request.
+ *
+ * @category Session Input Types
+ */
+export type SessionInputQuestion = SessionInputTextQuestion | SessionInputNumberQuestion | SessionInputBooleanQuestion | SessionInputSingleSelectQuestion | SessionInputMultiSelectQuestion;
+/**
+ * A live request for user input.
+ *
+ * The server creates or replaces requests with `session/inputRequested`.
+ * Clients sync drafts with `session/inputAnswerChanged` and complete requests
+ * with `session/inputCompleted`.
+ *
+ * @category Session Input Types
+ */
+export interface SessionInputRequest {
+    /** Stable request identifier */
+    id: string;
+    /** Display message for the request as a whole */
+    message?: string;
+    /** URL the user should review or open, for URL-style elicitations */
+    url?: URI;
+    /** Ordered questions to ask the user */
+    questions?: SessionInputQuestion[];
+    /** Current draft or submitted answers, keyed by question ID */
+    answers?: Record<string, SessionInputAnswer>;
+}
+/**
+ * Answer value kind.
+ *
+ * @category Session Input Types
+ */
+export declare enum SessionInputAnswerValueKind {
+    Text = "text",
+    Number = "number",
+    Boolean = "boolean",
+    Selected = "selected",
+    SelectedMany = "selected-many"
+}
+/**
+ * Value captured for one answer.
+ *
+ * @category Session Input Types
+ */
+export interface SessionInputTextAnswerValue {
+    kind: SessionInputAnswerValueKind.Text;
+    value: string;
+}
+export interface SessionInputNumberAnswerValue {
+    kind: SessionInputAnswerValueKind.Number;
+    /** @format float */
+    value: number;
+}
+export interface SessionInputBooleanAnswerValue {
+    kind: SessionInputAnswerValueKind.Boolean;
+    value: boolean;
+}
+export interface SessionInputSelectedAnswerValue {
+    kind: SessionInputAnswerValueKind.Selected;
+    value: string;
+    /** Free-form text entered instead of selecting an option */
+    freeformValues?: string[];
+}
+export interface SessionInputSelectedManyAnswerValue {
+    kind: SessionInputAnswerValueKind.SelectedMany;
+    value: string[];
+    /** Free-form text entered in addition to selected options */
+    freeformValues?: string[];
+}
+export type SessionInputAnswerValue = SessionInputTextAnswerValue | SessionInputNumberAnswerValue | SessionInputBooleanAnswerValue | SessionInputSelectedAnswerValue | SessionInputSelectedManyAnswerValue;
+export interface SessionInputAnswered {
+    /** Answer state */
+    state: SessionInputAnswerState.Draft | SessionInputAnswerState.Submitted;
+    /** Answer value */
+    value: SessionInputAnswerValue;
+}
+export interface SessionInputSkipped {
+    /** Answer state */
+    state: SessionInputAnswerState.Skipped;
+    /** Free-form reason or value captured while skipping, if any */
+    freeformValues?: string[];
+}
+/**
+ * Answer lifecycle state.
+ *
+ * @category Session Input Types
+ */
+export declare enum SessionInputAnswerState {
+    Draft = "draft",
+    Submitted = "submitted",
+    Skipped = "skipped"
+}
+/**
+ * Draft, submitted, or skipped answer for one question.
+ *
+ * @category Session Input Types
+ */
+export type SessionInputAnswer = SessionInputAnswered | SessionInputSkipped;
+/**
+ * How a turn ended.
+ *
+ * @category Turn Types
+ */
+export declare enum TurnState {
+    Complete = "complete",
+    Cancelled = "cancelled",
+    Error = "error"
+}
+/**
+ * Discriminant for {@link MessageAttachment} variants.
+ *
+ * @category Turn Types
+ */
+export declare enum MessageAttachmentKind {
+    /** A simple, opaque attachment whose representation is described by the producer. */
+    Simple = "simple",
+    /** An attachment whose data is embedded inline as a base64 string. */
+    EmbeddedResource = "embeddedResource",
+    /** An attachment that references a resource by URI. */
+    Resource = "resource"
+}
+/**
+ * A completed request/response cycle.
+ *
+ * @category Turn Types
+ */
+export interface Turn {
+    /** Turn identifier */
+    id: string;
+    /** The user's input */
+    userMessage: UserMessage;
+    /**
+     * All response content in stream order: text, tool calls, reasoning, and content refs.
+     *
+     * Consumers should derive display text by concatenating markdown parts,
+     * and find tool calls by filtering for `ToolCall` parts.
+     */
+    responseParts: ResponsePart[];
+    /** Token usage info */
+    usage: UsageInfo | undefined;
+    /** How the turn ended */
+    state: TurnState;
+    /** Error details if state is `'error'` */
+    error?: ErrorInfo;
+}
+/**
+ * An in-progress turn — the assistant is actively streaming.
+ *
+ * @category Turn Types
+ */
+export interface ActiveTurn {
+    /** Turn identifier */
+    id: string;
+    /** The user's input */
+    userMessage: UserMessage;
+    /**
+     * All response content in stream order: text, tool calls, reasoning, and content refs.
+     *
+     * Tool call parts include `pendingPermissions` when permissions are awaiting user approval.
+     */
+    responseParts: ResponsePart[];
+    /** Token usage info */
+    usage: UsageInfo | undefined;
+}
+/**
+ * A user message and its associated attachments.
+ *
+ * Attachments MAY be referenced inside {@link UserMessage.text} via their
+ * {@link MessageAttachmentBase.range} field. Attachments without a range are
+ * still associated with the message but do not correspond to a specific span
+ * in the text.
+ *
+ * @category Turn Types
+ */
+export interface UserMessage {
+    /** Message text */
+    text: string;
+    /** File/selection attachments */
+    attachments?: MessageAttachment[];
+}
+/**
+ * Common fields shared by all {@link MessageAttachment} variants.
+ *
+ * @category Turn Types
+ */
+export interface MessageAttachmentBase {
+    /**
+     * A human-readable label for the attachment (e.g. the filename of a file
+     * attachment). Used for display in UI.
+     */
+    label: string;
+    /**
+     * If defined, the range in {@link UserMessage.text} that references this
+     * attachment. This is a text range, not a byte range.
+     */
+    range?: TextRange;
+    /**
+     * Advisory display hint for clients rendering this attachment. Recognized
+     * values include:
+     *
+     * - `'image'`: the attachment is an image
+     * - `'document'`: the attachment is a textual document
+     * - `'symbol'`: the attachment is a code symbol (e.g. a function or class)
+     * - `'directory'`: the attachment is a folder
+     * - `'selection'`: the attachment is a selection within a document
+     *
+     * Implementations MAY provide additional values; clients SHOULD fall back
+     * to a reasonable default when an unknown value is encountered.
+     */
+    displayKind?: string;
+    /**
+     * Additional implementation-defined metadata for the attachment.
+     *
+     * If the attachment was produced by the `completions` command, the client
+     * MUST preserve every property of `_meta` originally returned by the agent
+     * host when sending the user message containing the accepted completion.
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * A simple, opaque attachment whose model representation is described by
+ * the producer.
+ *
+ * @category Turn Types
+ */
+export interface SimpleMessageAttachment extends MessageAttachmentBase {
+    /** Discriminant */
+    type: MessageAttachmentKind.Simple;
+    /**
+     * Representation of the attachment as it should be shown to the model.
+     *
+     * If the attachment was produced by the client, this property MUST be
+     * defined so the agent host can correctly interpret the attachment. This
+     * property MAY be omitted when the attachment originated from a
+     * `completions` response.
+     */
+    modelRepresentation?: string;
+}
+/**
+ * An attachment whose data is embedded inline as a base64 string.
+ *
+ * Use this for small binary payloads (e.g. a pasted image) that should be
+ * delivered with the user message itself rather than fetched separately.
+ *
+ * @category Turn Types
+ */
+export interface MessageEmbeddedResourceAttachment extends MessageAttachmentBase {
+    /** Discriminant */
+    type: MessageAttachmentKind.EmbeddedResource;
+    /** Base64-encoded binary data */
+    data: string;
+    /** Content MIME type (e.g. `"image/png"`, `"application/pdf"`) */
+    contentType: string;
+    /**
+     * Optional selection within the attached textual resource.
+     *
+     * Only meaningful for textual resources.
+     */
+    selection?: TextSelection;
+}
+/**
+ * An attachment that references a resource by URI. The content is not
+ * delivered inline; consumers can fetch it via `resourceRead` when needed.
+ *
+ * @category Turn Types
+ */
+export interface MessageResourceAttachment extends MessageAttachmentBase, ContentRef {
+    /** Discriminant */
+    type: MessageAttachmentKind.Resource;
+    /**
+     * Optional selection within the referenced textual resource.
+     *
+     * Only meaningful for textual resources.
+     */
+    selection?: TextSelection;
+}
+/**
+ * An attachment associated with a {@link UserMessage}.
+ *
+ * @category Turn Types
+ */
+export type MessageAttachment = SimpleMessageAttachment | MessageEmbeddedResourceAttachment | MessageResourceAttachment;
+/**
+ * Discriminant for response part types.
+ *
+ * @category Response Parts
+ */
+export declare enum ResponsePartKind {
+    Markdown = "markdown",
+    ContentRef = "contentRef",
+    ToolCall = "toolCall",
+    Reasoning = "reasoning",
+    SystemNotification = "systemNotification"
+}
+/**
+ * @category Response Parts
+ */
+export interface MarkdownResponsePart {
+    /** Discriminant */
+    kind: ResponsePartKind.Markdown;
+    /** Part identifier, used by `session/delta` to target this part for content appends */
+    id: string;
+    /** Markdown content */
+    content: string;
+}
+/**
+ * A content part that's a reference to large content stored outside the state tree.
+ *
+ * @category Response Parts
+ */
+export interface ResourceReponsePart extends ContentRef {
+    /** Discriminant */
+    kind: ResponsePartKind.ContentRef;
+}
+/**
+ * A tool call represented as a response part.
+ *
+ * Tool calls are part of the response stream, interleaved with text and
+ * reasoning. The `toolCall.toolCallId` serves as the part identifier for
+ * actions that target this part.
+ *
+ * @category Response Parts
+ */
+export interface ToolCallResponsePart {
+    /** Discriminant */
+    kind: ResponsePartKind.ToolCall;
+    /** Full tool call lifecycle state */
+    toolCall: ToolCallState;
+}
+/**
+ * Reasoning/thinking content from the model.
+ *
+ * @category Response Parts
+ */
+export interface ReasoningResponsePart {
+    /** Discriminant */
+    kind: ResponsePartKind.Reasoning;
+    /** Part identifier, used by `session/reasoning` to target this part for content appends */
+    id: string;
+    /** Accumulated reasoning text */
+    content: string;
+}
+/**
+ * @category Response Parts
+ */
+export type ResponsePart = MarkdownResponsePart | ResourceReponsePart | ToolCallResponsePart | ReasoningResponsePart | SystemNotificationResponsePart;
+/**
+ * A system notification surfaced as part of the response stream.
+ *
+ * System notifications are messages authored by the agent harness
+ * that need to be visible to both the agent (for situational awareness) and
+ * the user (for transcript continuity). Examples include "background subagent
+ * X completed" or "task Y was cancelled".
+ *
+ * @category Response Parts
+ */
+export interface SystemNotificationResponsePart {
+    /** Discriminant */
+    kind: ResponsePartKind.SystemNotification;
+    /** The text of the system notification */
+    content: StringOrMarkdown;
+}
+/**
+ * Status of a tool call in the lifecycle state machine.
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallStatus {
+    Streaming = "streaming",
+    PendingConfirmation = "pending-confirmation",
+    Running = "running",
+    PendingResultConfirmation = "pending-result-confirmation",
+    Completed = "completed",
+    Cancelled = "cancelled"
+}
+/**
+ * How a tool call was confirmed for execution.
+ *
+ * - `NotNeeded` — No confirmation required (auto-approved)
+ * - `UserAction` — User explicitly approved
+ * - `Setting` — Approved by a persistent user setting
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallConfirmationReason {
+    NotNeeded = "not-needed",
+    UserAction = "user-action",
+    Setting = "setting"
+}
+/**
+ * Why a tool call was cancelled.
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallCancellationReason {
+    Denied = "denied",
+    Skipped = "skipped",
+    ResultDenied = "result-denied"
+}
+/**
+ * Whether a confirmation option represents an approval or denial action.
+ *
+ * @category Tool Call Types
+ */
+export declare enum ConfirmationOptionKind {
+    Approve = "approve",
+    Deny = "deny"
+}
+/**
+ * A confirmation option that the server offers for a tool call awaiting
+ * approval. Allows richer choices beyond simple approve/deny — for example,
+ * "Approve in this Session" or "Deny with reason."
+ *
+ * @category Tool Call Types
+ */
+export interface ConfirmationOption {
+    /** Unique identifier for the option, returned in the confirmed action */
+    id: string;
+    /** Human-readable label displayed to the user */
+    label: string;
+    /** Whether this option represents an approval or denial */
+    kind: ConfirmationOptionKind;
+    /**
+     * Logical group number for visual categorisation.
+     *
+     * Clients SHOULD display options in the order they are defined and MAY
+     * use differing group numbers to insert dividers between logical clusters
+     * of options.
+     */
+    group?: number;
+}
+/**
+ * Metadata common to all tool call states.
+ *
+ * @category Tool Call Types
+ * @remarks
+ * Fields like `toolName` carry agent-specific identifiers on the wire despite the
+ * agent-agnostic design principle. These exist for debugging and logging purposes.
+ * A future version may move these to a separate diagnostic channel or namespace them
+ * more clearly.
+ */
+interface ToolCallBase {
+    /** Unique tool call identifier */
+    toolCallId: string;
+    /** Internal tool name (for debugging/logging) */
+    toolName: string;
+    /** Human-readable tool name */
+    displayName: string;
+    /**
+     * If this tool is provided by a client, the `clientId` of the owning client.
+     * Absent for server-side tools.
+     *
+     * When set, the identified client is responsible for executing the tool and
+     * dispatching `session/toolCallComplete` with the result.
+     */
+    toolClientId?: string;
+    /**
+     * Additional provider-specific metadata for this tool call.
+     *
+     * Clients MAY look for well-known keys here to provide enhanced UI.
+     * For example, a `ptyTerminal` key with `{ input: string; output: string }`
+     * indicates the tool operated on a terminal (both `input` and `output` may
+     * contain escape sequences).
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * Properties available once tool call parameters are fully received.
+ *
+ * @category Tool Call Types
+ */
+interface ToolCallParameterFields {
+    /** Message describing what the tool will do */
+    invocationMessage: StringOrMarkdown;
+    /** Raw tool input */
+    toolInput?: string;
+}
+/**
+ * Tool execution result details, available after execution completes.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallResult {
+    /** Whether the tool succeeded */
+    success: boolean;
+    /** Past-tense description of what the tool did */
+    pastTenseMessage: StringOrMarkdown;
+    /**
+     * Unstructured result content blocks.
+     *
+     * This mirrors the `content` field of MCP `CallToolResult`.
+     */
+    content?: ToolResultContent[];
+    /**
+     * Optional structured result object.
+     *
+     * This mirrors the `structuredContent` field of MCP `CallToolResult`.
+     */
+    structuredContent?: Record<string, unknown>;
+    /** Error details if the tool failed */
+    error?: {
+        message: string;
+        code?: string;
+    };
+}
+/**
+ * LM is streaming the tool call parameters.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallStreamingState extends ToolCallBase {
+    status: ToolCallStatus.Streaming;
+    /** Partial parameters accumulated so far */
+    partialInput?: string;
+    /** Progress message shown while parameters are streaming */
+    invocationMessage?: StringOrMarkdown;
+}
+/**
+ * Parameters are complete, or a running tool requires re-confirmation
+ * (e.g. a mid-execution permission check).
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallPendingConfirmationState extends ToolCallBase, ToolCallParameterFields {
+    status: ToolCallStatus.PendingConfirmation;
+    /** Short title for the confirmation prompt (e.g. `"Run in terminal"`, `"Write file"`) */
+    confirmationTitle?: StringOrMarkdown;
+    /** File edits that this tool call will perform, for preview before confirmation */
+    edits?: {
+        items: FileEdit[];
+    };
+    /** Whether the agent host allows the client to edit the tool's input parameters before confirming */
+    editable?: boolean;
+    /**
+     * Options the server offers for this confirmation. When present, the client
+     * SHOULD render these instead of a plain approve/deny UI. Each option
+     * belongs to a {@link ConfirmationOptionGroup} so the client can still
+     * categorise the choices.
+     */
+    options?: ConfirmationOption[];
+}
+/**
+ * Tool is actively executing.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallRunningState extends ToolCallBase, ToolCallParameterFields {
+    status: ToolCallStatus.Running;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+    /** The confirmation option the user selected, if confirmation options were provided */
+    selectedOption?: ConfirmationOption;
+    /**
+     * Partial content produced while the tool is still executing.
+     *
+     * For example, a terminal content block lets clients subscribe to live
+     * output before the tool completes.
+     */
+    content?: ToolResultContent[];
+}
+/**
+ * Tool finished executing, waiting for client to approve the result.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallPendingResultConfirmationState extends ToolCallBase, ToolCallParameterFields, ToolCallResult {
+    status: ToolCallStatus.PendingResultConfirmation;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+    /** The confirmation option the user selected, if confirmation options were provided */
+    selectedOption?: ConfirmationOption;
+}
+/**
+ * Tool completed successfully or with an error.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallCompletedState extends ToolCallBase, ToolCallParameterFields, ToolCallResult {
+    status: ToolCallStatus.Completed;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+    /** The confirmation option the user selected, if confirmation options were provided */
+    selectedOption?: ConfirmationOption;
+}
+/**
+ * Tool call was cancelled before execution.
+ *
+ * @category Tool Call Types
+ */
+export interface ToolCallCancelledState extends ToolCallBase, ToolCallParameterFields {
+    status: ToolCallStatus.Cancelled;
+    /** Why the tool was cancelled */
+    reason: ToolCallCancellationReason;
+    /** Optional message explaining the cancellation */
+    reasonMessage?: StringOrMarkdown;
+    /** What the user suggested doing instead */
+    userSuggestion?: UserMessage;
+    /** The confirmation option the user selected, if confirmation options were provided */
+    selectedOption?: ConfirmationOption;
+}
+/**
+ * Discriminated union of all tool call lifecycle states.
+ *
+ * See the [state model guide](/guide/state-model.html#tool-call-lifecycle)
+ * for the full state machine diagram.
+ *
+ * @category Tool Call Types
+ */
+export type ToolCallState = ToolCallStreamingState | ToolCallPendingConfirmationState | ToolCallRunningState | ToolCallPendingResultConfirmationState | ToolCallCompletedState | ToolCallCancelledState;
+/**
+ * Describes a tool available in a session, provided by either the server or the active client.
+ *
+ * @category Tool Definition Types
+ */
+export interface ToolDefinition {
+    /** Unique tool identifier */
+    name: string;
+    /** Human-readable display name */
+    title?: string;
+    /** Description of what the tool does */
+    description?: string;
+    /**
+     * JSON Schema defining the expected input parameters.
+     *
+     * Optional because client-provided tools may not have formal schemas.
+     * Mirrors MCP `Tool.inputSchema`.
+     */
+    inputSchema?: {
+        type: 'object';
+        properties?: Record<string, object>;
+        required?: string[];
+    };
+    /**
+     * JSON Schema defining the structure of the tool's output.
+     *
+     * Mirrors MCP `Tool.outputSchema`.
+     */
+    outputSchema?: {
+        type: 'object';
+        properties?: Record<string, object>;
+        required?: string[];
+    };
+    /** Behavioral hints about the tool. All properties are advisory. */
+    annotations?: ToolAnnotations;
+    /**
+     * Additional provider-specific metadata.
+     *
+     * Mirrors the MCP `_meta` convention.
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * Behavioral hints about a tool. All properties are advisory and not
+ * guaranteed to faithfully describe tool behavior.
+ *
+ * Mirrors MCP `ToolAnnotations` from the Model Context Protocol specification.
+ *
+ * @category Tool Definition Types
+ */
+export interface ToolAnnotations {
+    /** Alternate human-readable title */
+    title?: string;
+    /** Tool does not modify its environment (default: false) */
+    readOnlyHint?: boolean;
+    /** Tool may perform destructive updates (default: true) */
+    destructiveHint?: boolean;
+    /** Repeated calls with the same arguments have no additional effect (default: false) */
+    idempotentHint?: boolean;
+    /** Tool may interact with external entities (default: true) */
+    openWorldHint?: boolean;
+}
+/**
+ * Discriminant for tool result content types.
+ *
+ * @category Tool Result Content
+ */
+export declare enum ToolResultContentType {
+    Text = "text",
+    EmbeddedResource = "embeddedResource",
+    Resource = "resource",
+    FileEdit = "fileEdit",
+    Terminal = "terminal",
+    Subagent = "subagent"
+}
+/**
+ * Text content in a tool result.
+ *
+ * Mirrors MCP `TextContent`.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultTextContent {
+    type: ToolResultContentType.Text;
+    /** The text content */
+    text: string;
+}
+/**
+ * Base64-encoded binary content embedded in a tool result.
+ *
+ * Mirrors MCP `EmbeddedResource` for inline binary data.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultEmbeddedResourceContent {
+    type: ToolResultContentType.EmbeddedResource;
+    /** Base64-encoded data */
+    data: string;
+    /** Content type (e.g. `"image/png"`, `"application/pdf"`) */
+    contentType: string;
+}
+/**
+ * A reference to a resource stored outside the tool result.
+ *
+ * Wraps {@link ContentRef} for lazy-loading large results.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultResourceContent extends ContentRef {
+    type: ToolResultContentType.Resource;
+}
+/**
+ * Describes a file modification performed by a tool.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultFileEditContent extends FileEdit {
+    type: ToolResultContentType.FileEdit;
+}
+/**
+ * A reference to a terminal whose output is relevant to this tool result.
+ *
+ * Clients can subscribe to the terminal's URI to stream its output in real
+ * time, providing live feedback while a tool is executing.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultTerminalContent {
+    type: ToolResultContentType.Terminal;
+    /** Terminal URI (subscribable for full terminal state) */
+    resource: URI;
+    /** Display title for the terminal content */
+    title: string;
+}
+/**
+ * A reference to a subagent session spawned by a tool.
+ *
+ * Clients can subscribe to the subagent's session URI to stream its
+ * progress in real time, including inner tool calls and responses.
+ *
+ * @category Tool Result Content
+ */
+export interface ToolResultSubagentContent {
+    type: ToolResultContentType.Subagent;
+    /** Subagent session URI (subscribable for full session state) */
+    resource: URI;
+    /** Display title for the subagent */
+    title: string;
+    /** Internal agent name */
+    agentName?: string;
+    /** Human-readable description of the subagent's task */
+    description?: string;
+}
+/**
+ * Content block in a tool result.
+ *
+ * Mirrors the content blocks in MCP `CallToolResult.content`, plus
+ * `ToolResultResourceContent` for lazy-loading large results,
+ * `ToolResultFileEditContent` for file edit diffs,
+ * `ToolResultTerminalContent` for live terminal output, and
+ * `ToolResultSubagentContent` for subagent sessions (AHP extensions).
+ *
+ * @category Tool Result Content
+ */
+export type ToolResultContent = ToolResultTextContent | ToolResultEmbeddedResourceContent | ToolResultResourceContent | ToolResultFileEditContent | ToolResultTerminalContent | ToolResultSubagentContent;
+/**
+ * A lightweight reference to a custom agent contributed by a customization.
+ *
+ * Custom agents have a single `name` (sourced from the agent file's YAML
+ * frontmatter, or derived from the file name); they do not have a separate
+ * display name.
+ *
+ * @category Customization Types
+ */
+export interface CustomizationAgentRef {
+    /** Stable agent URI */
+    uri: URI;
+    /** Agent name (from frontmatter `name`, or file-derived) */
+    name: string;
+    /** Optional short description for UI preview (from frontmatter `description`) */
+    description?: string;
+}
+/**
+ * A reference to an [Open Plugins](https://open-plugins.com/) plugin.
+ *
+ * This is intentionally thin — AHP specifies plugin identity and metadata
+ * but not implementation details, which are defined by the Open Plugins spec.
+ *
+ * @category Customization Types
+ */
+export interface CustomizationRef {
+    /** Plugin URI (e.g. an HTTPS URL or marketplace identifier) */
+    uri: URI;
+    /** Human-readable name */
+    displayName: string;
+    /** Description of what the plugin provides */
+    description?: string;
+    /** Icons for the plugin */
+    icons?: Icon[];
+    /**
+     * Opaque version token for this customization.
+     *
+     * Clients SHOULD include a nonce with every customization they provide.
+     * Consumers can compare nonces to detect whether a customization has
+     * changed since it was last seen, avoiding redundant reloads or copies.
+     */
+    nonce?: string;
+}
+/**
+ * Loading status for a server-managed customization.
+ *
+ * @category Customization Types
+ */
+export declare enum CustomizationStatus {
+    /** Plugin is being loaded */
+    Loading = "loading",
+    /** Plugin is fully operational */
+    Loaded = "loaded",
+    /** Plugin partially loaded but has warnings */
+    Degraded = "degraded",
+    /** Plugin was unable to load */
+    Error = "error"
+}
+/**
+ * A customization active in a session.
+ *
+ * @category Customization Types
+ */
+export interface SessionCustomization {
+    /** The plugin this customization refers to */
+    customization: CustomizationRef;
+    /** Whether this customization is currently enabled */
+    enabled: boolean;
+    /**
+     * The `clientId` of the client that contributed this customization.
+     * Absent for server-provided customizations.
+     */
+    clientId?: string;
+    /** Server-reported loading status */
+    status?: CustomizationStatus;
+    /**
+     * Human-readable status detail (e.g. error message or degradation warning).
+     */
+    statusMessage?: string;
+    /**
+     * Custom agents contributed by this customization, as resolved by the
+     * agent host after parsing the customization.
+     *
+     * Consumers MUST treat an absent field as "unknown" (e.g. the host has
+     * not finished parsing the customization yet). An empty array means the
+     * host parsed the customization and it contributes no agents.
+     *
+     * Clients are not authoritative here: only the agent host populates
+     * this field.
+     */
+    agents?: CustomizationAgentRef[];
+}
+export {};
+//# sourceMappingURL=state.d.ts.map