@codingame/monaco-vscode-chat-service-override 28.4.1 → 29.1.0

package/vscode/src/vs/platform/agentHost/common/state/protocol/actions.d.ts

@@ -0,0 +1,488 @@
+import { ToolCallConfirmationReason, ToolCallCancellationReason, type URI, type StringOrMarkdown, type IAgentInfo, type IErrorInfo, type IUserMessage, type IResponsePart, type IToolCallResult, type IToolDefinition, type ISessionActiveClient, type IUsageInfo, type IPermissionRequest } from "./state.js";
+/**
+ * Discriminant values for all state actions.
+ *
+ * @category Actions
+ */
+export declare enum ActionType {
+    RootAgentsChanged = "root/agentsChanged",
+    RootActiveSessionsChanged = "root/activeSessionsChanged",
+    SessionReady = "session/ready",
+    SessionCreationFailed = "session/creationFailed",
+    SessionTurnStarted = "session/turnStarted",
+    SessionDelta = "session/delta",
+    SessionResponsePart = "session/responsePart",
+    SessionToolCallStart = "session/toolCallStart",
+    SessionToolCallDelta = "session/toolCallDelta",
+    SessionToolCallReady = "session/toolCallReady",
+    SessionToolCallConfirmed = "session/toolCallConfirmed",
+    SessionToolCallComplete = "session/toolCallComplete",
+    SessionToolCallResultConfirmed = "session/toolCallResultConfirmed",
+    SessionPermissionRequest = "session/permissionRequest",
+    SessionPermissionResolved = "session/permissionResolved",
+    SessionTurnComplete = "session/turnComplete",
+    SessionTurnCancelled = "session/turnCancelled",
+    SessionError = "session/error",
+    SessionTitleChanged = "session/titleChanged",
+    SessionUsage = "session/usage",
+    SessionReasoning = "session/reasoning",
+    SessionModelChanged = "session/modelChanged",
+    SessionServerToolsChanged = "session/serverToolsChanged",
+    SessionActiveClientChanged = "session/activeClientChanged",
+    SessionActiveClientToolsChanged = "session/activeClientToolsChanged"
+}
+/**
+ * Identifies the client that originally dispatched an action.
+ */
+export interface IActionOrigin {
+    clientId: string;
+    clientSeq: number;
+}
+/**
+ * Every action is wrapped in an `ActionEnvelope`.
+ */
+export interface IActionEnvelope {
+    readonly action: IStateAction;
+    readonly serverSeq: number;
+    readonly origin: IActionOrigin | undefined;
+    readonly rejectionReason?: string;
+}
+/**
+ * Base interface for all tool-call-scoped actions, carrying the common
+ * session, turn, and tool call identifiers.
+ *
+ * @category Session Actions
+ */
+interface IToolCallActionBase {
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Tool call identifier */
+    toolCallId: 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>;
+}
+/**
+ * Fired when available agent backends or their models change.
+ *
+ * @category Root Actions
+ * @version 1
+ */
+export interface IRootAgentsChangedAction {
+    type: ActionType.RootAgentsChanged;
+    /** Updated agent list */
+    agents: IAgentInfo[];
+}
+/**
+ * Fired when the number of active sessions changes.
+ *
+ * @category Root Actions
+ * @version 1
+ */
+export interface IRootActiveSessionsChangedAction {
+    type: ActionType.RootActiveSessionsChanged;
+    /** Current count of active sessions */
+    activeSessions: number;
+}
+/**
+ * Session backend initialized successfully.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionReadyAction {
+    type: ActionType.SessionReady;
+    /** Session URI */
+    session: URI;
+}
+/**
+ * Session backend failed to initialize.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionCreationFailedAction {
+    type: ActionType.SessionCreationFailed;
+    /** Session URI */
+    session: URI;
+    /** Error details */
+    error: IErrorInfo;
+}
+/**
+ * User sent a message; server starts agent processing.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionTurnStartedAction {
+    type: ActionType.SessionTurnStarted;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** User's message */
+    userMessage: IUserMessage;
+}
+/**
+ * Streaming text chunk from the assistant.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionDeltaAction {
+    type: ActionType.SessionDelta;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Text chunk */
+    content: string;
+}
+/**
+ * Structured content appended to the response.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionResponsePartAction {
+    type: ActionType.SessionResponsePart;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Response part (markdown or content ref) */
+    part: IResponsePart;
+}
+/**
+ * A tool call begins — parameters are streaming from the LM.
+ *
+ * For client-provided tools, the server sets `toolClientId` to identify the
+ * owning client. That client is responsible for executing the tool once it
+ * reaches the `running` state and dispatching `session/toolCallComplete`.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionToolCallStartAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallStart;
+    /** 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.
+     */
+    toolClientId?: string;
+}
+/**
+ * Streaming partial parameters for a tool call.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionToolCallDeltaAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallDelta;
+    /** Partial parameter content to append */
+    content: string;
+    /** Updated progress message */
+    invocationMessage?: StringOrMarkdown;
+}
+/**
+ * Tool call parameters are complete. Transitions to `pending-confirmation`
+ * or directly to `running` if `confirmed` is set.
+ *
+ * For client-provided tools, the server typically sets `confirmed` to
+ * `'not-needed'` so the tool transitions directly to `running`, where the
+ * owning client can begin execution immediately.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionToolCallReadyAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallReady;
+    /** Message describing what the tool will do */
+    invocationMessage: StringOrMarkdown;
+    /** Raw tool input */
+    toolInput?: string;
+    /** If set, the tool was auto-confirmed and transitions directly to `running` */
+    confirmed?: ToolCallConfirmationReason;
+}
+/**
+ * Client approves a pending tool call. The tool transitions to `running`.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionToolCallApprovedAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallConfirmed;
+    /** The tool call was approved */
+    approved: true;
+    /** How the tool was confirmed */
+    confirmed: ToolCallConfirmationReason;
+}
+/**
+ * Client denies a pending tool call. The tool transitions to `cancelled`.
+ *
+ * For client-provided tools, the owning client MUST dispatch this if it does
+ * not recognize the tool or cannot execute it.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionToolCallDeniedAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallConfirmed;
+    /** The tool call was denied */
+    approved: false;
+    /** Why the tool was cancelled */
+    reason: ToolCallCancellationReason.Denied | ToolCallCancellationReason.Skipped;
+    /** What the user suggested doing instead */
+    userSuggestion?: IUserMessage;
+    /** Optional explanation for the denial */
+    reasonMessage?: StringOrMarkdown;
+}
+/**
+ * Client confirms or denies a pending tool call.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export type ISessionToolCallConfirmedAction = ISessionToolCallApprovedAction | ISessionToolCallDeniedAction;
+/**
+ * Tool execution finished. Transitions to `completed` or `pending-result-confirmation`
+ * if `requiresResultConfirmation` is `true`.
+ *
+ * For client-provided tools (where `toolClientId` is set on the tool call state),
+ * the owning client dispatches this action with the execution result. The server
+ * SHOULD reject this action if the dispatching client does not match `toolClientId`.
+ *
+ * Servers waiting on a client tool call MAY time out after a reasonable duration
+ * if the implementing client disconnects or becomes unresponsive, and dispatch
+ * this action with `result.success = false` and an appropriate error.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionToolCallCompleteAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallComplete;
+    /** Execution result */
+    result: IToolCallResult;
+    /** If true, the result requires client approval before finalizing */
+    requiresResultConfirmation?: boolean;
+}
+/**
+ * Client approves or denies a tool's result.
+ *
+ * If `approved` is `false`, the tool transitions to `cancelled` with reason `result-denied`.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionToolCallResultConfirmedAction extends IToolCallActionBase {
+    type: ActionType.SessionToolCallResultConfirmed;
+    /** Whether the result was approved */
+    approved: boolean;
+}
+/**
+ * Permission needed from the user to proceed.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionPermissionRequestAction {
+    type: ActionType.SessionPermissionRequest;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Permission request details */
+    request: IPermissionRequest;
+}
+/**
+ * Permission granted or denied.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionPermissionResolvedAction {
+    type: ActionType.SessionPermissionResolved;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Permission request ID */
+    requestId: string;
+    /** Whether permission was granted */
+    approved: boolean;
+}
+/**
+ * Turn finished — the assistant is idle.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionTurnCompleteAction {
+    type: ActionType.SessionTurnComplete;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+}
+/**
+ * Turn was aborted; server stops processing.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionTurnCancelledAction {
+    type: ActionType.SessionTurnCancelled;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+}
+/**
+ * Error during turn processing.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionErrorAction {
+    type: ActionType.SessionError;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Error details */
+    error: IErrorInfo;
+}
+/**
+ * Session title updated (typically auto-generated from conversation).
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionTitleChangedAction {
+    type: ActionType.SessionTitleChanged;
+    /** Session URI */
+    session: URI;
+    /** New title */
+    title: string;
+}
+/**
+ * Token usage report for a turn.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionUsageAction {
+    type: ActionType.SessionUsage;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Token usage data */
+    usage: IUsageInfo;
+}
+/**
+ * Reasoning/thinking text from the model.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionReasoningAction {
+    type: ActionType.SessionReasoning;
+    /** Session URI */
+    session: URI;
+    /** Turn identifier */
+    turnId: string;
+    /** Reasoning text chunk */
+    content: string;
+}
+/**
+ * Model changed for this session.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionModelChangedAction {
+    type: ActionType.SessionModelChanged;
+    /** Session URI */
+    session: URI;
+    /** New model ID */
+    model: string;
+}
+/**
+ * Server tools for this session have changed.
+ *
+ * Full-replacement semantics: the `tools` array replaces the previous `serverTools` entirely.
+ *
+ * @category Session Actions
+ * @version 1
+ */
+export interface ISessionServerToolsChangedAction {
+    type: ActionType.SessionServerToolsChanged;
+    /** Session URI */
+    session: URI;
+    /** Updated server tools list (full replacement) */
+    tools: IToolDefinition[];
+}
+/**
+ * The active client for this session has changed.
+ *
+ * A client dispatches this action with its own `ISessionActiveClient` to claim
+ * the active role, or with `null` to release it. The server SHOULD reject if
+ * another client is already active. The server SHOULD automatically dispatch
+ * this action with `activeClient: null` when the active client disconnects.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionActiveClientChangedAction {
+    type: ActionType.SessionActiveClientChanged;
+    /** Session URI */
+    session: URI;
+    /** The new active client, or `null` to unset */
+    activeClient: ISessionActiveClient | null;
+}
+/**
+ * The active client's tool list has changed.
+ *
+ * Full-replacement semantics: the `tools` array replaces the active client's
+ * previous tools entirely. The server SHOULD reject if the dispatching client
+ * is not the current active client.
+ *
+ * @category Session Actions
+ * @version 1
+ * @clientDispatchable
+ */
+export interface ISessionActiveClientToolsChangedAction {
+    type: ActionType.SessionActiveClientToolsChanged;
+    /** Session URI */
+    session: URI;
+    /** Updated client tools list (full replacement) */
+    tools: IToolDefinition[];
+}
+/**
+ * Discriminated union of all state actions.
+ */
+export type IStateAction = IRootAgentsChangedAction | IRootActiveSessionsChangedAction | ISessionReadyAction | ISessionCreationFailedAction | ISessionTurnStartedAction | ISessionDeltaAction | ISessionResponsePartAction | ISessionToolCallStartAction | ISessionToolCallDeltaAction | ISessionToolCallReadyAction | ISessionToolCallConfirmedAction | ISessionToolCallCompleteAction | ISessionToolCallResultConfirmedAction | ISessionPermissionRequestAction | ISessionPermissionResolvedAction | ISessionTurnCompleteAction | ISessionTurnCancelledAction | ISessionErrorAction | ISessionTitleChangedAction | ISessionUsageAction | ISessionReasoningAction | ISessionModelChangedAction | ISessionServerToolsChangedAction | ISessionActiveClientChangedAction | ISessionActiveClientToolsChangedAction;
+export {};