@codingame/monaco-vscode-api 26.2.1 → 27.0.0

package/vscode-dts/vscode.proposed.chatParticipantAdditions.d.ts

@@ -3,6 +3,8 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+// version: 3
+
 declare module 'vscode' {
 
 	export interface ChatParticipant {
@@ -221,6 +223,16 @@ declare module 'vscode' {
 		};
 		language: string;
 
+		/**
+		 * Overrides for how the command is presented in the UI.
+		 * For example, when a `cd <dir> && <command>` prefix is detected,
+		 * the presentation can show only the actual command.
+		 */
+		presentationOverrides?: {
+			commandLine: string;
+			language?: string;
+		};
+
 		/**
 		 * Terminal command output. Displayed when the terminal is no longer available.
 		 */
@@ -264,6 +276,66 @@ declare module 'vscode' {
 		output: McpToolInvocationContentData[];
 	}
 
+	export enum ChatTodoStatus {
+		NotStarted = 1,
+		InProgress = 2,
+		Completed = 3
+	}
+
+	export interface ChatTodoToolInvocationData {
+		todoList: Array<{
+			id: number;
+			title: string;
+			status: ChatTodoStatus;
+		}>;
+	}
+
+	/**
+	 * Generic tool result data that displays input and output in collapsible sections.
+	 */
+	export interface ChatSimpleToolResultData {
+		/**
+		 * The input to display.
+		 */
+		input: string;
+		/**
+		 * The output to display.
+		 */
+		output: string;
+	}
+
+
+	export interface ChatToolResourcesInvocationData {
+		/**
+		 * Array of file URIs or locations to display as a collapsible list
+		 */
+		values: Array<Uri | Location>;
+	}
+
+	export class ChatSubagentToolInvocationData {
+		/**
+		 * A description of the subagent's purpose or task.
+		 */
+		description?: string;
+
+		/**
+		 * The name of the subagent being invoked.
+		 */
+		agentName?: string;
+
+		/**
+		 * The prompt given to the subagent.
+		 */
+		prompt?: string;
+
+		/**
+		 * The result text from the subagent after completion.
+		 */
+		result?: string;
+
+		constructor(description?: string, agentName?: string, prompt?: string, result?: string);
+	}
+
 	export class ChatToolInvocationPart {
 		toolName: string;
 		toolCallId: string;
@@ -273,11 +345,16 @@ declare module 'vscode' {
 		pastTenseMessage?: string | MarkdownString;
 		isConfirmed?: boolean;
 		isComplete?: boolean;
-		toolSpecificData?: ChatTerminalToolInvocationData | ChatMcpToolInvocationData;
+		toolSpecificData?: ChatTerminalToolInvocationData | ChatMcpToolInvocationData | ChatTodoToolInvocationData | ChatSimpleToolResultData | ChatToolResourcesInvocationData | ChatSubagentToolInvocationData;
 		subAgentInvocationId?: string;
 		presentation?: 'hidden' | 'hiddenAfterComplete' | undefined;
 
-		constructor(toolName: string, toolCallId: string, isError?: boolean);
+		/**
+		 * If this flag is set, this will be treated as an update to any previous tool call with the same id.
+		 */
+		enablePartialUpdate?: boolean;
+
+		constructor(toolName: string, toolCallId: string, errorMessage?: string);
 	}
 
 	/**
@@ -474,12 +551,16 @@ declare module 'vscode' {
 	}
 
 	export class ChatResponsePullRequestPart {
-		readonly uri: Uri;
+		/**
+		 * @deprecated use `command` instead
+		 */
+		readonly uri?: Uri;
+		readonly command: Command;
 		readonly linkTag: string;
 		readonly title: string;
 		readonly description: string;
 		readonly author: string;
-		constructor(uri: Uri, title: string, description: string, author: string, linkTag: string);
+		constructor(uriOrCommand: Uri | Command, title: string, description: string, author: string, linkTag: string);
 	}
 
 	export interface ChatResponseStream {
@@ -577,6 +658,13 @@ declare module 'vscode' {
 		push(part: ExtendedChatResponsePart): void;
 
 		clearToPreviousToolInvocation(reason: ChatResponseClearToPreviousToolInvocationReason): void;
+
+		/**
+		 * Report token usage information for this request.
+		 * This is typically called when the underlying language model provides usage statistics.
+		 * @param usage Token usage information including prompt and completion tokens
+		 */
+		usage(usage: ChatResultUsage): void;
 	}
 
 	export enum ChatResponseReferencePartStatusKind {
@@ -768,12 +856,6 @@ declare module 'vscode' {
 		 * An optional detail string that will be rendered at the end of the response in certain UI contexts.
 		 */
 		details?: string;
-
-		/**
-		 * Token usage information for this request, if available.
-		 * This is typically provided by the underlying language model.
-		 */
-		readonly usage?: ChatResultUsage;
 	}
 
 	export namespace chat {
@@ -948,8 +1030,6 @@ declare module 'vscode' {
 		readonly rawInput?: unknown;
 
 		readonly chatRequestId?: string;
-		/** @deprecated Use {@link chatSessionResource} instead */
-		readonly chatSessionId?: string;
 		readonly chatSessionResource?: Uri;
 		readonly chatInteractionId?: string;
 	}

package/vscode-dts/vscode.proposed.chatParticipantPrivate.d.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-// version: 13
+// version: 14
 
 declare module 'vscode' {
 
@@ -111,6 +111,11 @@ declare module 'vscode' {
 		 */
 		readonly subAgentName?: string;
 
+		/**
+		 * The request ID of the parent request that invoked this subagent.
+		 */
+		readonly parentRequestId?: string;
+
 		/**
 		 * Whether any hooks are enabled for this request.
 		 */
@@ -132,6 +137,10 @@ declare module 'vscode' {
 	 * ChatRequestTurn + private additions. Note- at runtime this is the SAME as ChatRequestTurn and instanceof is safe.
 	 */
 	export class ChatRequestTurn2 {
+		/**
+		 * The id of the chat request. Used to identity an interaction with any of the chat surfaces.
+		 */
+		readonly id?: string;
 		/**
 		 * The prompt as entered by the user.
 		 *
@@ -167,10 +176,15 @@ declare module 'vscode' {
 		 */
 		readonly editedFileEvents?: ChatRequestEditedFileEvent[];
 
+		/**
+		 * The identifier of the language model that was used for this request, if known.
+		 */
+		readonly modelId?: string;
+
 		/**
 		 * @hidden
 		 */
-		constructor(prompt: string, command: string | undefined, references: ChatPromptReference[], participant: string, toolReferences: ChatLanguageModelToolReference[], editedFileEvents: ChatRequestEditedFileEvent[] | undefined);
+		constructor(prompt: string, command: string | undefined, references: ChatPromptReference[], participant: string, toolReferences: ChatLanguageModelToolReference[], editedFileEvents: ChatRequestEditedFileEvent[] | undefined, id: string | undefined, modelId: string | undefined);
 	}
 
 	export class ChatResponseTurn2 {
@@ -253,8 +267,6 @@ declare module 'vscode' {
 
 	export interface LanguageModelToolInvocationOptions<T> {
 		chatRequestId?: string;
-		/** @deprecated Use {@link chatSessionResource} instead */
-		chatSessionId?: string;
 		chatSessionResource?: Uri;
 		chatInteractionId?: string;
 		terminalCommand?: string;
@@ -280,8 +292,6 @@ declare module 'vscode' {
 		 */
 		input: T;
 		chatRequestId?: string;
-		/** @deprecated Use {@link chatSessionResource} instead */
-		chatSessionId?: string;
 		chatSessionResource?: Uri;
 		chatInteractionId?: string;
 		/**
@@ -326,6 +336,19 @@ declare module 'vscode' {
 		export const onDidDisposeChatSession: Event<string>;
 	}
 
+	export namespace window {
+		/**
+		 * The resource URI of the currently active chat panel session,
+		 * or `undefined` if there is no active chat panel session.
+		 */
+		export const activeChatPanelSessionResource: Uri | undefined;
+
+		/**
+		 * An event that fires when the active chat panel session resource changes.
+		 */
+		export const onDidChangeActiveChatPanelSessionResource: Event<Uri | undefined>;
+	}
+
 	// #endregion
 
 	// #region ChatErrorDetailsWithConfirmation

package/vscode-dts/vscode.proposed.chatProvider.d.ts

@@ -38,6 +38,11 @@ declare module 'vscode' {
 		 */
 		readonly multiplier?: string;
 
+		/**
+		 * A numeric form of the `multiplier` label
+		 */
+		readonly multiplierNumeric?: number;
+
 		/**
 		 * Whether or not this will be selected by default in the model picker
 		 * NOT BEING FINALIZED
@@ -60,6 +65,15 @@ declare module 'vscode' {
 		readonly category?: { label: string; order: number };
 
 		readonly statusIcon?: ThemeIcon;
+
+		/**
+		 * When set, this model is only shown in the model picker for the specified chat session type.
+		 * Models with this property are excluded from the general model picker and only appear
+		 * when the user is in a session matching this type.
+		 *
+		 * The value must match a `type` declared in a `chatSessions` extension contribution.
+		 */
+		readonly targetChatSessionType?: string;
 	}
 
 	export interface LanguageModelChatCapabilities {

package/vscode-dts/vscode.proposed.chatSessionsProvider.d.ts

@@ -23,13 +23,20 @@ declare module 'vscode' {
 		/**
 		 * The chat session is currently in progress.
 		 */
-		InProgress = 2
+		InProgress = 2,
+
+		/**
+		 * The chat session needs user input (e.g. an unresolved confirmation).
+		 */
+		NeedsInput = 3
 	}
 
 	export namespace chat {
 		/**
 		 * Registers a new {@link ChatSessionItemProvider chat session item provider}.
 		 *
+		 * @deprecated Use {@linkcode createChatSessionItemController} instead.
+		 *
 		 * To use this, also make sure to also add `chatSessions` contribution in the `package.json`.
 		 *
 		 * @param chatSessionType The type of chat session the provider is for.
@@ -41,12 +48,21 @@ declare module 'vscode' {
 
 		/**
 		 * Creates a new {@link ChatSessionItemController chat session item controller} with the given unique identifier.
+		 *
+		 * To use this, also make sure to also add `chatSessions` contribution in the `package.json`.
+		 *
+		 * @param chatSessionType The type of chat session the provider is for.
+		 * @param refreshHandler The controller's {@link ChatSessionItemController.refreshHandler refresh handler}.
+		 *
+		 * @returns A new controller instance that can be used to manage chat session items for the given chat session type.
 		 */
-		export function createChatSessionItemController(id: string, refreshHandler: (token: CancellationToken) => Thenable<void>): ChatSessionItemController;
+		export function createChatSessionItemController(chatSessionType: string, refreshHandler: ChatSessionItemControllerRefreshHandler): ChatSessionItemController;
 	}
 
 	/**
 	 * Provides a list of information about chat sessions.
+	 *
+	 * @deprecated Use {@linkcode ChatSessionItemController} instead.
 	 */
 	export interface ChatSessionItemProvider {
 		/**
@@ -72,7 +88,21 @@ declare module 'vscode' {
 	}
 
 	/**
-	 * Provides a list of information about chat sessions.
+	 * Extension callback invoked to refresh the collection of chat session items for a {@linkcode ChatSessionItemController}.
+	 */
+	export type ChatSessionItemControllerRefreshHandler = (token: CancellationToken) => Thenable<void>;
+
+	export interface ChatSessionItemControllerNewItemHandlerContext {
+		readonly request: ChatRequest;
+	}
+
+	/**
+	 * Extension callback invoked when a new chat session is started.
+	 */
+	export type ChatSessionItemControllerNewItemHandler = (context: ChatSessionItemControllerNewItemHandlerContext, token: CancellationToken) => Thenable<ChatSessionItem>;
+
+	/**
+	 * Manages chat sessions for a specific chat session type
 	 */
 	export interface ChatSessionItemController {
 		readonly id: string;
@@ -88,7 +118,7 @@ declare module 'vscode' {
 		readonly items: ChatSessionItemCollection;
 
 		/**
-		 * Creates a new managed chat session item that be added to the collection.
+		 * Creates a new managed chat session item that can be added to the collection.
 		 */
 		createChatSessionItem(resource: Uri, label: string): ChatSessionItem;
 
@@ -97,7 +127,16 @@ declare module 'vscode' {
 		 *
 		 * This is also called on first load to get the initial set of items.
 		 */
-		refreshHandler: (token: CancellationToken) => Thenable<void>;
+		readonly refreshHandler: ChatSessionItemControllerRefreshHandler;
+
+		/**
+		 * Invoked when a new chat session is started.
+		 *
+		 * This allows the controller to initialize the chat session item with information from the initial request.
+		 *
+		 * The returned chat session is added to the collection and shown in the UI.
+		 */
+		newChatSessionItemHandler?: ChatSessionItemControllerNewItemHandler;
 
 		/**
 		 * Fired when an item's archived state changes.
@@ -116,7 +155,8 @@ declare module 'vscode' {
 
 		/**
 		 * Replaces the items stored by the collection.
-		 * @param items Items to store.
+		 *
+		 * @param items Items to store. If two items have the same resource URI, the last one will be used.
 		 */
 		replace(items: readonly ChatSessionItem[]): void;
 
@@ -131,31 +171,42 @@ declare module 'vscode' {
 		/**
 		 * Adds the chat session item to the collection. If an item with the same resource URI already
 		 * exists, it'll be replaced.
+		 *
 		 * @param item Item to add.
 		 */
 		add(item: ChatSessionItem): void;
 
 		/**
 		 * Removes a single chat session item from the collection.
+		 *
 		 * @param resource Item resource to delete.
 		 */
 		delete(resource: Uri): void;
 
 		/**
 		 * Efficiently gets a chat session item by resource, if it exists, in the collection.
+		 *
 		 * @param resource Item resource to get.
+		 *
 		 * @returns The found item or undefined if it does not exist.
 		 */
 		get(resource: Uri): ChatSessionItem | undefined;
 	}
 
+	/**
+	 * A chat session show in the UI.
+	 *
+	 * This should be created by calling a {@link ChatSessionItemController.createChatSessionItem createChatSessionItem}
+	 * method on the controller. The item can then be added to the controller's {@link ChatSessionItemController.items items collection}
+	 * to show it in the UI.
+	 */
 	export interface ChatSessionItem {
 		/**
 		 * The resource associated with the chat session.
 		 *
 		 * This is uniquely identifies the chat session and is used to open the chat session.
 		 */
-		resource: Uri;
+		readonly resource: Uri;
 
 		/**
 		 * Human readable name of the session shown in the UI
@@ -199,33 +250,33 @@ declare module 'vscode' {
 			/**
 			 * Timestamp when the session was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
 			 */
-			created: number;
+			readonly created: number;
 
 			/**
 			 * Timestamp when the most recent request started in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
 			 *
 			 * Should be undefined if no requests have been made yet.
 			 */
-			lastRequestStarted?: number;
+			readonly lastRequestStarted?: number;
 
 			/**
 			 * Timestamp when the most recent request completed in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
 			 *
 			 * Should be undefined if the most recent request is still in progress or if no requests have been made yet.
 			 */
-			lastRequestEnded?: number;
+			readonly lastRequestEnded?: number;
 
 			/**
 			 * Session start timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
 			 * @deprecated Use `created` and `lastRequestStarted` instead.
 			 */
-			startTime?: number;
+			readonly startTime?: number;
 
 			/**
 			 * Session end timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
 			 * @deprecated Use `lastRequestEnded` instead.
 			 */
-			endTime?: number;
+			readonly endTime?: number;
 		};
 
 		/**
@@ -295,6 +346,15 @@ declare module 'vscode' {
 	}
 
 	export interface ChatSession {
+		/**
+		 * An optional title for the chat session.
+		 *
+		 * When provided, this title is used as the display name for the session
+		 * (e.g. in the editor tab). When not provided, the title defaults to
+		 * the first user message in the session history.
+		 */
+		readonly title?: string;
+
 		/**
 		 * The full history of the session
 		 *
@@ -330,6 +390,7 @@ declare module 'vscode' {
 		 */
 		// TODO: Should we introduce our own type for `ChatRequestHandler` since not all field apply to chat sessions?
 		// TODO: Revisit this to align with code.
+		// TODO: pass in options?
 		readonly requestHandler: ChatRequestHandler | undefined;
 	}
 
@@ -395,9 +456,8 @@ declare module 'vscode' {
 
 		/**
 		 * Called as soon as you register (call me once)
-		 * @param token
 		 */
-		provideChatSessionProviderOptions?(token: CancellationToken): Thenable<ChatSessionProviderOptions | ChatSessionProviderOptions>;
+		provideChatSessionProviderOptions?(token: CancellationToken): Thenable<ChatSessionProviderOptions>;
 	}
 
 	export interface ChatSessionOptionUpdate {
@@ -430,7 +490,15 @@ declare module 'vscode' {
 
 	export interface ChatSessionContext {
 		readonly chatSessionItem: ChatSessionItem; // Maps to URI of chat session editor (could be 'untitled-1', etc..)
+
+		/** @deprecated This will be removed along with the concept of `untitled-` sessions.  */
 		readonly isUntitled: boolean;
+
+		/**
+		 * The initial option selections for the session, provided with the first request.
+		 * Contains the options the user selected (or defaults) before the session was created.
+		 */
+		readonly initialSessionOptions?: ReadonlyArray<{ optionId: string; value: string | ChatSessionProviderOptionItem }>;
 	}
 
 	export interface ChatSessionCapabilities {
@@ -546,6 +614,13 @@ declare module 'vscode' {
 		 * Provider-defined option groups (0-2 groups supported).
 		 * Examples: models picker, sub-agents picker, etc.
 		 */
-		optionGroups?: ChatSessionProviderOptionGroup[];
+		readonly optionGroups?: readonly ChatSessionProviderOptionGroup[];
+
+		/**
+		 * The set of default options used for new chat sessions, provided as key-value pairs.
+		 *
+		 * Keys correspond to option group IDs (e.g., 'models', 'subagents').
+		 */
+		readonly newSessionOptions?: Record<string, string | ChatSessionProviderOptionItem>;
 	}
 }

package/vscode-dts/vscode.proposed.d.ts

@@ -11,6 +11,7 @@ import "./vscode.proposed.authSession.d.ts"
 import "./vscode.proposed.authenticationChallenges.d.ts"
 import "./vscode.proposed.canonicalUriProvider.d.ts"
 import "./vscode.proposed.chatContextProvider.d.ts"
+import "./vscode.proposed.chatDebug.d.ts"
 import "./vscode.proposed.chatHooks.d.ts"
 import "./vscode.proposed.chatOutputRenderer.d.ts"
 import "./vscode.proposed.chatParticipantAdditions.d.ts"
@@ -71,7 +72,8 @@ import "./vscode.proposed.editSessionIdentityProvider.d.ts"
 import "./vscode.proposed.editorHoverVerbosityLevel.d.ts"
 import "./vscode.proposed.editorInsets.d.ts"
 import "./vscode.proposed.embeddings.d.ts"
-import "./vscode.proposed.envIsAppPortable.d.ts"
+import "./vscode.proposed.envIsConnectionMetered.d.ts"
+import "./vscode.proposed.environmentPower.d.ts"
 import "./vscode.proposed.extensionAffinity.d.ts"
 import "./vscode.proposed.extensionRuntime.d.ts"
 import "./vscode.proposed.extensionsAny.d.ts"
@@ -141,6 +143,7 @@ import "./vscode.proposed.terminalExecuteCommandEvent.d.ts"
 import "./vscode.proposed.terminalQuickFixProvider.d.ts"
 import "./vscode.proposed.terminalSelection.d.ts"
 import "./vscode.proposed.terminalShellEnv.d.ts"
+import "./vscode.proposed.terminalTitle.d.ts"
 import "./vscode.proposed.testObserver.d.ts"
 import "./vscode.proposed.testRelatedCode.d.ts"
 import "./vscode.proposed.textDocumentChangeReason.d.ts"

package/vscode-dts/{vscode.proposed.envIsAppPortable.d.ts → vscode.proposed.envIsConnectionMetered.d.ts}

@@ -6,15 +6,15 @@
 declare module 'vscode' {
 
 	export namespace env {
+		/**
+		 * Whether the current network connection is metered (such as mobile data or tethering).
+		 * Always returns `false` if the `network.meteredConnection` setting is set to `off`.
+		 */
+		export const isMeteredConnection: boolean;
 
 		/**
-		 * Indicates whether the application is running in portable mode.
-		 *
-		 * Portable mode is enabled when the application is run from a folder that contains
-		 * a `data` directory, allowing for self-contained installations.
-		 *
-		 * Learn more about [Portable Mode](https://code.visualstudio.com/docs/editor/portable).
+		 * Event that fires when the metered connection status changes.
 		 */
-		export const isAppPortable: boolean;
+		export const onDidChangeMeteredConnection: Event<boolean>;
 	}
 }