@codingame/monaco-vscode-api 23.2.2 → 24.1.0

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

@@ -10,28 +10,61 @@ declare module 'vscode' {
 
 	export namespace chat {
 
-		// TODO@alexr00 API:
-		// selector is confusing
-		export function registerChatContextProvider(selector: DocumentSelector, id: string, provider: ChatContextProvider): Disposable;
+		/**
+		 * Register a chat context provider. Chat context can be provided:
+		 * - For a resource. Make sure to pass a selector that matches the resource you want to provide context for.
+		 *   Providers registered without a selector will not be called for resource-based context.
+		 * - Explicitly. These context items are shown as options when the user explicitly attaches context.
+		 *
+		 * To ensure your extension is activated when chat context is requested, make sure to include the `onChatContextProvider:<id>` activation event in your `package.json`.
+		 *
+		 * @param selector Optional document selector to filter which resources the provider is called for. If omitted, the provider will only be called for explicit context requests.
+		 * @param id Unique identifier for the provider.
+		 * @param provider The chat context provider.
+		 */
+		export function registerChatContextProvider(selector: DocumentSelector | undefined, id: string, provider: ChatContextProvider): Disposable;
 
 	}
 
 	export interface ChatContextItem {
+		/**
+		 * Icon for the context item.
+		 */
 		icon: ThemeIcon;
+		/**
+		 * Human readable label for the context item.
+		 */
 		label: string;
+		/**
+		 * An optional description of the context item, e.g. to describe the item to the language model.
+		 */
 		modelDescription?: string;
+		/**
+		 * The value of the context item. Can be omitted when returned from one of the `provide` methods if the provider supports `resolveChatContext`.
+		 */
 		value?: string;
 	}
 
 	export interface ChatContextProvider<T extends ChatContextItem = ChatContextItem> {
 
+		/**
+		 * An optional event that should be fired when the workspace chat context has changed.
+		 */
+		onDidChangeWorkspaceChatContext?: Event<void>;
+
+		/**
+		 * Provide a list of chat context items to be included as workspace context for all chat sessions.
+		 *
+		 * @param token A cancellation token.
+		 */
+		provideWorkspaceChatContext?(token: CancellationToken): ProviderResult<T[]>;
+
 		/**
 		 * Provide a list of chat context items that a user can choose from. These context items are shown as options when the user explicitly attaches context.
 		 * Chat context items can be provided without a `value`, as the `value` can be resolved later using `resolveChatContext`.
 		 * `resolveChatContext` is only called for items that do not have a `value`.
 		 *
-		 * @param options
-		 * @param token
+		 * @param token A cancellation token.
 		 */
 		provideChatContextExplicit?(token: CancellationToken): ProviderResult<T[]>;
 
@@ -40,17 +73,18 @@ declare module 'vscode' {
 		 * Chat context items can be provided without a `value`, as the `value` can be resolved later using `resolveChatContext`.
 		 * `resolveChatContext` is only called for items that do not have a `value`.
 		 *
-		 * @param resource
-		 * @param options
-		 * @param token
+		 * Currently only called when the resource is a webview.
+		 *
+		 * @param options Options include the resource for which to provide context.
+		 * @param token A cancellation token.
 		 */
 		provideChatContextForResource?(options: { resource: Uri }, token: CancellationToken): ProviderResult<T | undefined>;
 
 		/**
 		 * If a chat context item is provided without a `value`, from either of the `provide` methods, this method is called to resolve the `value` for the item.
 		 *
-		 * @param context
-		 * @param token
+		 * @param context The context item to resolve.
+		 * @param token A cancellation token.
 		 */
 		resolveChatContext(context: T, token: CancellationToken): ProviderResult<ChatContextItem>;
 	}

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

@@ -32,7 +32,8 @@ declare module 'vscode' {
 	export class ChatResponseCodeblockUriPart {
 		isEdit?: boolean;
 		value: Uri;
-		constructor(value: Uri, isEdit?: boolean);
+		undoStopId?: string;
+		constructor(value: Uri, isEdit?: boolean, undoStopId?: string);
 	}
 
 	/**
@@ -104,6 +105,7 @@ declare module 'vscode' {
 		isComplete?: boolean;
 		toolSpecificData?: ChatTerminalToolInvocationData;
 		fromSubAgent?: boolean;
+		presentation?: 'hidden' | 'hiddenAfterComplete' | undefined;
 
 		constructor(toolName: string, toolCallId: string, isError?: boolean);
 	}
@@ -170,7 +172,7 @@ declare module 'vscode' {
 	export class ChatResponseExternalEditPart {
 		uris: Uri[];
 		callback: () => Thenable<unknown>;
-		applied: Thenable<void>;
+		applied: Thenable<string>;
 		constructor(uris: Uri[], callback: () => Thenable<unknown>);
 	}
 
@@ -314,7 +316,7 @@ declare module 'vscode' {
 		 * tracked as agent edits. This can be used to track edits made from
 		 * external tools that don't generate simple {@link textEdit textEdits}.
 		 */
-		externalEdit<T>(target: Uri | Uri[], callback: () => Thenable<T>): Thenable<T>;
+		externalEdit(target: Uri | Uri[], callback: () => Thenable<unknown>): Thenable<string>;
 
 		markdownWithVulnerabilities(value: string | MarkdownString, vulnerabilities: ChatVulnerability[]): void;
 		codeblockUri(uri: Uri, isEdit?: boolean): void;

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

@@ -30,12 +30,17 @@ declare module 'vscode' {
 	}
 
 	export class ChatRequestEditorData {
+
+		readonly editor: TextEditor;
+
 		//TODO@API should be the editor
 		document: TextDocument;
 		selection: Selection;
+
+		/** @deprecated */
 		wholeRange: Range;
 
-		constructor(document: TextDocument, selection: Selection, wholeRange: Range);
+		constructor(editor: TextEditor, document: TextDocument, selection: Selection, wholeRange: Range);
 	}
 
 	export class ChatRequestNotebookData {
@@ -148,6 +153,11 @@ declare module 'vscode' {
 	}
 
 	export class ChatResponseTurn2 {
+		/**
+		 * The id of the chat response. Used to identity an interaction with any of the chat surfaces.
+		 */
+		readonly id?: string;
+
 		/**
 		 * The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
 		 */
@@ -248,6 +258,8 @@ declare module 'vscode' {
 		toolResultMessage?: string | MarkdownString;
 		toolResultDetails?: Array<Uri | Location>;
 		toolMetadata?: unknown;
+		/** Whether there was an error calling the tool. The tool may still have partially succeeded. */
+		hasError?: boolean;
 	}
 
 	// #region Chat participant detection
@@ -307,4 +319,65 @@ declare module 'vscode' {
 	}
 
 	// #endregion
+
+	// #region CustomAgentsProvider
+
+	/**
+	 * Represents a custom agent resource file (e.g., .agent.md or .prompt.md) available for a repository.
+	 */
+	export interface CustomAgentResource {
+		/**
+		 * The unique identifier/name of the custom agent resource.
+		 */
+		readonly name: string;
+
+		/**
+		 * A description of what the custom agent resource does.
+		 */
+		readonly description: string;
+
+		/**
+		 * The URI to the agent or prompt resource file.
+		 */
+		readonly uri: Uri;
+
+		/**
+		 * Indicates whether the custom agent resource is editable. Defaults to false.
+		 */
+		readonly isEditable?: boolean;
+	}
+
+	/**
+	 * Options for querying custom agents.
+	 */
+	export interface CustomAgentQueryOptions { }
+
+	/**
+	 * A provider that supplies custom agent resources (from .agent.md and .prompt.md files) for repositories.
+	 */
+	export interface CustomAgentsProvider {
+		/**
+		 * An optional event to signal that custom agents have changed.
+		 */
+		readonly onDidChangeCustomAgents?: Event<void>;
+
+		/**
+		 * Provide the list of custom agent resources available for a given repository.
+		 * @param options Optional query parameters.
+		 * @param token A cancellation token.
+		 * @returns An array of custom agent resources or a promise that resolves to such.
+		 */
+		provideCustomAgents(options: CustomAgentQueryOptions, token: CancellationToken): ProviderResult<CustomAgentResource[]>;
+	}
+
+	export namespace chat {
+		/**
+		 * Register a provider for custom agents.
+		 * @param provider The custom agents provider.
+		 * @returns A disposable that unregisters the provider when disposed.
+		 */
+		export function registerCustomAgentsProvider(provider: CustomAgentsProvider): Disposable;
+	}
+
+	// #endregion
 }

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

@@ -18,6 +18,6 @@ declare module 'vscode' {
 		 */
 		readonly diagnostics: [Uri, Diagnostic[]][];
 
-		protected constructor(diagnostics: [Uri, Diagnostic[]][]);
+		constructor(diagnostics: [Uri, Diagnostic[]][]);
 	}
 }

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

@@ -122,7 +122,12 @@ declare module 'vscode' {
 		/**
 		 * Statistics about the chat session.
 		 */
-		statistics?: {
+		changes?: readonly ChatSessionChangedFile[] | {
+			/**
+			 * Number of files edited during the session.
+			 */
+			files: number;
+
 			/**
 			 * Number of insertions made during the session.
 			 */
@@ -135,6 +140,30 @@ declare module 'vscode' {
 		};
 	}
 
+	export class ChatSessionChangedFile {
+		/**
+		 * URI of the file.
+		 */
+		modifiedUri: Uri;
+
+		/**
+		 * File opened when the user takes the 'compare' action.
+		 */
+		originalUri?: Uri;
+
+		/**
+		 * Number of insertions made during the session.
+		 */
+		insertions: number;
+
+		/**
+		 * Number of deletions made during the session.
+		 */
+		deletions: number;
+
+		constructor(modifiedUri: Uri, insertions: number, deletions: number, originalUri?: Uri);
+	}
+
 	export interface ChatSession {
 		/**
 		 * The full history of the session
@@ -147,11 +176,13 @@ declare module 'vscode' {
 
 		/**
 		 * Options configured for this session as key-value pairs.
-		 * Keys correspond to option group IDs (e.g., 'models', 'subagents')
-		 * and values are the selected option item IDs.
+		 * Keys correspond to option group IDs (e.g., 'models', 'subagents').
+		 * Values can be either:
+		 * - A string (the option item ID) for backwards compatibility
+		 * - A ChatSessionProviderOptionItem object to include metadata like locked state
 		 * TODO: Strongly type the keys
 		 */
-		readonly options?: Record<string, string>;
+		readonly options?: Record<string, string | ChatSessionProviderOptionItem>;
 
 		/**
 		 * Callback invoked by the editor for a currently running response. This allows the session to push items for the
@@ -172,10 +203,39 @@ declare module 'vscode' {
 		readonly requestHandler: ChatRequestHandler | undefined;
 	}
 
+	/**
+	 * Event fired when chat session options change.
+	 */
+	export interface ChatSessionOptionChangeEvent {
+		/**
+		 * Identifier of the chat session being updated.
+		 */
+		readonly resource: Uri;
+		/**
+		 * Collection of option identifiers and their new values. Only the options that changed are included.
+		 */
+		readonly updates: ReadonlyArray<{
+			/**
+			 * Identifier of the option that changed (for example `model`).
+			 */
+			readonly optionId: string;
+
+			/**
+			 * The new value assigned to the option. When `undefined`, the option is cleared.
+			 */
+			readonly value: string | ChatSessionProviderOptionItem;
+		}>;
+	}
+
 	/**
 	 * Provides the content for a chat session rendered using the native chat UI.
 	 */
 	export interface ChatSessionContentProvider {
+		/**
+		 * Event that the provider can fire to signal that the options for a chat session have changed.
+		 */
+		readonly onDidChangeChatSessionOptions?: Event<ChatSessionOptionChangeEvent>;
+
 		/**
 		 * Provides the chat session content for a given uri.
 		 *
@@ -240,10 +300,6 @@ declare module 'vscode' {
 
 	export interface ChatContext {
 		readonly chatSessionContext?: ChatSessionContext;
-		readonly chatSummary?: {
-			readonly prompt?: string;
-			readonly history?: string;
-		};
 	}
 
 	export interface ChatSessionContext {
@@ -271,6 +327,23 @@ declare module 'vscode' {
 		 * Human-readable name displayed in the UI.
 		 */
 		readonly name: string;
+
+		/**
+		 * Optional description shown in tooltips.
+		 */
+		readonly description?: string;
+
+		/**
+		 * When true, this option is locked and cannot be changed by the user.
+		 * The option will still be visible in the UI but will be disabled.
+		 * Use this when an option is set but cannot be hot-swapped (e.g., model already initialized).
+		 */
+		readonly locked?: boolean;
+
+		/**
+		 * An icon for the option item shown in UI.
+		 */
+		readonly icon?: ThemeIcon;
 	}
 
 	/**

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

@@ -13,15 +13,6 @@ declare module 'vscode' {
 		message: MarkdownString;
 	}
 
-	export interface ChatRequesterInformation {
-		name: string;
-
-		/**
-		 * A full URI for the icon of the request.
-		 */
-		icon?: Uri;
-	}
-
 	export interface ChatTitleProvider {
 		/**
 		 * TODO@API Should this take a ChatResult like the followup provider, or just take a new ChatContext that includes the current message as history?
@@ -47,6 +38,5 @@ declare module 'vscode' {
 		additionalWelcomeMessage?: string | MarkdownString;
 		titleProvider?: ChatTitleProvider;
 		summarizer?: ChatSummarizer;
-		requester?: ChatRequesterInformation;
 	}
 }

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

@@ -76,7 +76,12 @@ declare module 'vscode' {
 	export interface FileSearchProvider2 {
 		/**
 		 * Provide the set of files that match a certain file path pattern.
-		 * @param pattern The search pattern to match against file paths.
+		 *
+		 * @param pattern The search pattern to match against file paths. The `pattern` should be interpreted in a
+		 * *relaxed way* as the editor will apply its own highlighting and scoring on the results. A good rule of
+		 * thumb is to match case-insensitive and to simply check that the characters of `pattern` appear in their
+		 * order in a candidate file path. Don't use prefix, substring, or similar strict matching. When `pattern`
+		 * is empty, all files in the folder should be returned.
 		 * @param options A set of options to consider while searching files.
 		 * @param token A cancellation token.
 		 */

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

@@ -47,7 +47,7 @@ declare module 'vscode' {
 		showInlineEditMenu?: boolean;
 
 		/**
-		 * If set, specifies where insertText, filterText and range apply to.
+		 * If set, specifies where insertText, filterText, range, jumpToPosition apply to.
 		*/
 		uri?: Uri;
 
@@ -66,6 +66,10 @@ declare module 'vscode' {
 		completeBracketPairs?: boolean;
 
 		warning?: InlineCompletionWarning;
+
+		supportsRename?: boolean;
+
+		jumpToPosition?: Position;
 	}
 
 
@@ -73,7 +77,6 @@ declare module 'vscode' {
 		range: Range;
 		kind: InlineCompletionDisplayLocationKind;
 		label: string;
-		jumpToEdit?: boolean;
 	}
 
 	export enum InlineCompletionDisplayLocationKind {
@@ -134,6 +137,12 @@ declare module 'vscode' {
 
 		readonly onDidChange?: Event<void>;
 
+		readonly modelInfo?: InlineCompletionModelInfo;
+		readonly onDidChangeModelInfo?: Event<void>;
+		// eslint-disable-next-line local/vscode-dts-provider-naming
+		setCurrentModelId?(modelId: string): Thenable<void>;
+
+
 		// #region Deprecated methods
 
 		/**
@@ -154,6 +163,16 @@ declare module 'vscode' {
 		// #endregion
 	}
 
+	export interface InlineCompletionModelInfo {
+		readonly models: InlineCompletionModel[];
+		readonly currentModelId: string;
+	}
+
+	export interface InlineCompletionModel {
+		readonly id: string;
+		readonly name: string;
+	}
+
 	export enum InlineCompletionEndOfLifeReasonKind {
 		Accepted = 0,
 		Rejected = 1,

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

@@ -84,6 +84,15 @@ declare module 'vscode' {
 
 	export class McpHttpServerDefinition2 extends McpHttpServerDefinition {
 		metadata?: McpServerMetadata;
-		constructor(label: string, uri: Uri, headers?: Record<string, string>, version?: string, metadata?: McpServerMetadata);
+
+		/**
+		 * Authentication information to use to get a session for the initial MCP server connection.
+		 */
+		authentication?: {
+			providerId: string;
+			scopes: string[];
+		};
+
+		constructor(label: string, uri: Uri, headers?: Record<string, string>, version?: string, metadata?: McpServerMetadata, authentication?: { providerId: string; scopes: string[] });
 	}
 }

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

@@ -7,35 +7,42 @@ declare module 'vscode' {
 
 	// https://github.com/microsoft/vscode/issues/175662
 
+	/**
+	 * Specifies the location where a {@link QuickInputButton} should be rendered.
+	 */
 	export enum QuickInputButtonLocation {
 		/**
-		 * In the title bar.
+		 * The button is rendered in the title bar.
 		 */
 		Title = 1,
 
 		/**
-		 * To the right of the input box.
+		 * The button is rendered inline to the right of the input box.
 		 */
 		Inline = 2,
 
 		/**
-		 * At the far end inside the input box.
+		 * The button is rendered at the far end inside the input box.
 		 */
 		Input = 3
 	}
 
 	export interface QuickInputButton {
 		/**
-		 * Where the button should be rendered. The default is {@link QuickInputButtonLocation.Title}.
-		 * @note This property is ignored if the button was added to a QuickPickItem.
+		 * The location where the button should be rendered.
+		 *
+		 * Defaults to {@link QuickInputButtonLocation.Title}.
+		 *
+		 * **Note:** This property is ignored if the button was added to a {@link QuickPickItem}.
 		 */
 		location?: QuickInputButtonLocation;
 
 		/**
-		 * When present, indicates that the button is a toggle that can be checked.
-		 * @note This property is currently only applicable to buttons with location {@link QuickInputButtonLocation.Input}.
-		 * It must be set for such buttons and the state will be updated when the button is toggled.
-		 * It cannot be set for buttons with other location value currently.
+		 * When present, indicates that the button is a toggle button that can be checked or unchecked.
+		 *
+		 * **Note:** This property is currently only applicable to buttons with {@link QuickInputButtonLocation.Input} location.
+		 * It must be set for such buttons, and the state will be updated when the button is toggled.
+		 * It cannot be set for buttons with other location values.
 		 */
 		readonly toggle?: { checked: boolean };
 	}

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

@@ -9,12 +9,13 @@ declare module 'vscode' {
 
 	export interface QuickPickItem {
 		/**
-		 * The {@link Uri} of the resource representing this item.
+		 * A {@link Uri} representing the resource associated with this item.
 		 *
-		 * Will be used to derive the {@link label}, when it is not provided (falsy or empty).
-		 * Will be used to derive the {@link description}, when it is not provided (falsy or empty).
-		 * Will be used to derive the icon from current file icon theme, when {@link iconPath} has either
-		 * {@link ThemeIcon.File} or {@link ThemeIcon.Folder} value.
+		 * When set, this property is used to automatically derive several item properties if they are not explicitly provided:
+		 * - **Label**: Derived from the resource's file name when {@link QuickPickItem.label label} is not provided or is empty.
+		 * - **Description**: Derived from the resource's path when {@link QuickPickItem.description description} is not provided or is empty.
+		 * - **Icon**: Derived from the current file icon theme when {@link QuickPickItem.iconPath iconPath} is set to
+		 *   {@link ThemeIcon.File} or {@link ThemeIcon.Folder}.
 		 */
 		resourceUri?: Uri;
 	}

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

@@ -9,7 +9,10 @@ declare module 'vscode' {
 
 	export interface QuickPickItem {
 		/**
-		 * A tooltip that is rendered when hovering over the item.
+		 * An optional tooltip that is displayed when hovering over this item.
+		 *
+		 * When specified, this tooltip takes precedence over the default hover behavior which shows
+		 * the {@link QuickPickItem.description description}.
 		 */
 		tooltip?: string | MarkdownString;
 	}

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

@@ -9,16 +9,18 @@ declare module 'vscode' {
 
 	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
 		/**
-		 * An optional prompt text providing some ask or explanation to the user.
-		 * Shown below the input box and above the quick pick items.
+		 * Optional text that provides instructions or context to the user.
+		 *
+		 * The prompt is displayed below the input box and above the list of items.
 		 */
 		prompt: string | undefined;
 	}
 
 	export interface QuickPickOptions {
 		/**
-		 * An optional prompt text providing some ask or explanation to the user.
-		 * Shown below the input box and above the quick pick items.
+		 * Optional text that provides instructions or context to the user.
+		 *
+		 * The prompt is displayed below the input box and above the list of items.
 		 */
 		prompt?: string;
 	}

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

@@ -9,7 +9,12 @@ declare module 'vscode' {
 
 	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
 		/**
-		 * An optional flag to sort the final results by index of first query match in label. Defaults to true.
+		 * Controls whether items should be sorted based on the match position in their labels when filtering.
+		 *
+		 * When `true`, items are sorted by the position of the first match in the label, with items that
+		 * match earlier in the label appearing first. When `false`, items maintain their original order.
+		 *
+		 * Defaults to `true`.
 		 */
 		// @API is a bug that we need this API at all. why do we change the sort order
 		// when extensions give us a (sorted) array of items?

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

@@ -21,6 +21,7 @@ declare module 'vscode' {
 		readonly id: string;
 		readonly name: string;
 		readonly icon?: IconPath;
+		readonly supportsFolders?: boolean;
 	}
 
 	export interface SourceControlArtifact {
@@ -28,5 +29,7 @@ declare module 'vscode' {
 		readonly name: string;
 		readonly description?: string;
 		readonly icon?: IconPath;
+		readonly timestamp?: number;
+		readonly command?: Command;
 	}
 }

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

@@ -61,7 +61,7 @@ declare module 'vscode' {
 		readonly timestamp?: number;
 		readonly statistics?: SourceControlHistoryItemStatistics;
 		readonly references?: SourceControlHistoryItemRef[];
-		readonly tooltip?: string | MarkdownString | undefined;
+		readonly tooltip?: MarkdownString | Array<MarkdownString> | undefined;
 	}
 
 	export interface SourceControlHistoryItemRef {

package/vscode/src/vs/base/browser/webWorkerFactory.d.ts

@@ -1,14 +0,0 @@
-import { URI } from "../common/uri.js";
-import { IWebWorkerClient } from "../common/worker/webWorker.js";
-export declare function createBlobWorker(blobUrl: string, options?: WorkerOptions): Worker;
-export interface IWebWorkerDescriptor {
-    readonly esmModuleLocation: URI | undefined;
-    readonly label: string | undefined;
-}
-export declare class WebWorkerDescriptor implements IWebWorkerDescriptor {
-    readonly esmModuleLocation: URI;
-    readonly label: string | undefined;
-    constructor(esmModuleLocation: URI, label: string | undefined);
-}
-export declare function createWebWorker<T extends object>(esmModuleLocation: URI, label: string | undefined): IWebWorkerClient<T>;
-export declare function createWebWorker<T extends object>(workerDescriptor: IWebWorkerDescriptor | Worker | Promise<Worker>): IWebWorkerClient<T>;