@codingame/monaco-vscode-api 2.2.1 → 3.0.0

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

@@ -0,0 +1,288 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export interface ChatParticipant {
+		onDidPerformAction: Event<ChatUserActionEvent>;
+		supportIssueReporting?: boolean;
+	}
+
+	export interface ChatErrorDetails {
+		/**
+		 * If set to true, the message content is completely hidden. Only ChatErrorDetails#message will be shown.
+		 */
+		responseIsRedacted?: boolean;
+	}
+
+	/** @deprecated */
+	export interface ChatMarkdownContent {
+		markdownContent: MarkdownString;
+	}
+
+	// TODO@API fit this into the stream
+	export interface ChatDetectedParticipant {
+		participant: string;
+		command?: ChatCommand;
+	}
+
+	// TODO@API fit this into the stream
+	export interface ChatVulnerability {
+		title: string;
+		description: string;
+		// id: string; // Later we will need to be able to link these across multiple content chunks.
+	}
+
+	// TODO@API fit this into the stream
+	export interface ChatContent {
+		vulnerabilities?: ChatVulnerability[];
+	}
+
+	/**
+	 * @deprecated use ChatResponseStream instead
+	 */
+	export type ChatContentProgress =
+		| ChatContent
+		| ChatInlineContentReference
+		| ChatCommandButton;
+
+	/**
+	 * @deprecated use ChatResponseStream instead
+	 */
+	export type ChatMetadataProgress =
+		| ChatUsedContext
+		| ChatContentReference
+		| ChatProgressMessage;
+
+	/**
+	 * @deprecated use ChatResponseStream instead
+	 */
+	export type ChatProgress = ChatContentProgress | ChatMetadataProgress;
+
+	/** @deprecated */
+	export interface ChatProgressMessage {
+		message: string;
+	}
+
+	/** @deprecated */
+
+	export interface ChatContentReference {
+		/**
+		 * The resource that was referenced.
+		 */
+		reference: Uri | Location;
+	}
+
+	/**
+	 * A reference to a piece of content that will be rendered inline with the markdown content.
+	 */
+	export interface ChatInlineContentReference {
+		/**
+		 * The resource being referenced.
+		 */
+		inlineReference: Uri | Location;
+
+		/**
+		 * An alternate title for the resource.
+		 */
+		title?: string;
+	}
+
+	/**
+	 * Displays a {@link Command command} as a button in the chat response.
+	 */
+	export interface ChatCommandButton {
+		command: Command;
+	}
+
+	/**
+	 * A piece of the chat response's content. Will be merged with other progress pieces as needed, and rendered as markdown.
+	 */
+	export interface ChatContent {
+		/**
+		 * The content as a string of markdown source.
+		 */
+		content: string;
+	}
+
+	export interface ChatDocumentContext {
+		uri: Uri;
+		version: number;
+		ranges: Range[];
+	}
+
+	// TODO@API fit this into the stream
+	export interface ChatUsedContext {
+		documents: ChatDocumentContext[];
+	}
+
+	export interface ChatResponseStream {
+		/**
+		 * @deprecated use above methods instread
+		 */
+		report(value: ChatProgress): void;
+	}
+
+	/** @deprecated */
+	export type ChatExtendedProgress = ChatProgress
+		| ChatMarkdownContent
+		| ChatDetectedParticipant;
+
+	export type ChatExtendedResponseStream = ChatResponseStream & {
+		/**
+		 * @deprecated
+		 */
+		report(value: ChatExtendedProgress): void;
+	};
+
+	export interface ChatParticipant {
+		/**
+		 * Provide a set of variables that can only be used with this participant.
+		 */
+		participantVariableProvider?: { provider: ChatParticipantCompletionItemProvider; triggerCharacters: string[] };
+	}
+
+	export interface ChatParticipantCompletionItemProvider {
+		provideCompletionItems(query: string, token: CancellationToken): ProviderResult<ChatCompletionItem[]>;
+	}
+
+	export class ChatCompletionItem {
+		label: string | CompletionItemLabel;
+		values: ChatVariableValue[];
+		insertText?: string;
+		detail?: string;
+		documentation?: string | MarkdownString;
+
+		constructor(label: string | CompletionItemLabel, values: ChatVariableValue[]);
+	}
+
+	export type ChatExtendedRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatExtendedResponseStream, token: CancellationToken) => ProviderResult<ChatResult>;
+
+	export namespace chat {
+		/**
+		 * Create a chat participant with the extended progress type
+		 */
+		export function createChatParticipant(name: string, handler: ChatExtendedRequestHandler): ChatParticipant;
+	}
+
+	/*
+	 * User action events
+	 */
+
+	export enum ChatCopyKind {
+		// Keyboard shortcut or context menu
+		Action = 1,
+		Toolbar = 2
+	}
+
+	export interface ChatCopyAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'copy';
+		codeBlockIndex: number;
+		copyKind: ChatCopyKind;
+		copiedCharacters: number;
+		totalCharacters: number;
+		copiedText: string;
+	}
+
+	export interface ChatInsertAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'insert';
+		codeBlockIndex: number;
+		totalCharacters: number;
+		newFile?: boolean;
+	}
+
+	export interface ChatTerminalAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'runInTerminal';
+		codeBlockIndex: number;
+		languageId?: string;
+	}
+
+	export interface ChatCommandAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'command';
+		commandButton: ChatCommandButton;
+	}
+
+	export interface ChatFollowupAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'followUp';
+		followup: ChatFollowup;
+	}
+
+	export interface ChatBugReportAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'bug';
+	}
+
+	export interface ChatUserActionEvent {
+		readonly result: ChatResult;
+		readonly action: ChatCopyAction | ChatInsertAction | ChatTerminalAction | ChatCommandAction | ChatFollowupAction | ChatBugReportAction;
+	}
+
+	export interface ChatVariableValue {
+		/**
+		 * An optional type tag for extensions to communicate the kind of the variable. An extension might use it to interpret the shape of `value`.
+		 */
+		kind?: string;
+	}
+
+	export interface ChatCommand {
+		readonly isSticky2?: {
+			/**
+			 * Indicates that the command should be automatically repopulated.
+			 */
+			isSticky: true;
+
+			/**
+			 * This can be set to a string to use a different placeholder message in the input box when the command has been repopulated.
+			 */
+			placeholder?: string;
+		};
+	}
+
+	export interface ChatVariableResolverResponseStream {
+		/**
+		 * Push a progress part to this stream. Short-hand for
+		 * `push(new ChatResponseProgressPart(value))`.
+		 *
+		 * @param value
+		 * @returns This stream.
+		 */
+		progress(value: string): ChatVariableResolverResponseStream;
+
+		/**
+		 * Push a reference to this stream. Short-hand for
+		 * `push(new ChatResponseReferencePart(value))`.
+		 *
+		 * *Note* that the reference is not rendered inline with the response.
+		 *
+		 * @param value A uri or location
+		 * @returns This stream.
+		 */
+		reference(value: Uri | Location): ChatVariableResolverResponseStream;
+
+		/**
+		 * Pushes a part to this stream.
+		 *
+		 * @param part A response part, rendered or metadata
+		 */
+		push(part: ChatVariableResolverResponsePart): ChatVariableResolverResponseStream;
+	}
+
+	export type ChatVariableResolverResponsePart = ChatResponseProgressPart | ChatResponseReferencePart;
+
+	export interface ChatVariableResolver {
+		/**
+		 * A callback to resolve the value of a chat variable.
+		 * @param name The name of the variable.
+		 * @param context Contextual information about this chat request.
+		 * @param token A cancellation token.
+		 */
+		resolve2?(name: string, context: ChatVariableContext, stream: ChatVariableResolverResponseStream, token: CancellationToken): ProviderResult<ChatVariableValue[]>;
+	}
+}

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

@@ -10,11 +10,13 @@ declare module 'vscode' {
 		part: string;
 	}
 
+	// @API extension ship a d.ts files for their options
+
 	/**
 	 * Represents a large language model that accepts ChatML messages and produces a streaming response
 	 */
 	export interface ChatResponseProvider {
-		provideChatResponse(messages: ChatMessage[], options: { [name: string]: any }, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
+		provideLanguageModelResponse2(messages: LanguageModelMessage[], options: { [name: string]: any }, extensionId: string, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
 	}
 
 	export interface ChatResponseProviderMetadata {
@@ -24,6 +26,13 @@ declare module 'vscode' {
 		 */
 		// TODO@API rename to model
 		name: string;
+
+		/**
+		 * When present, this gates the use of `requestLanguageModelAccess` behind an authorization flow where
+		 * the user must approve of another extension accessing the models contributed by this extension.
+		 * Additionally, the extension can provide a label that will be shown in the UI.
+		 */
+		auth?: true | { label: string };
 	}
 
 	export namespace chat {

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

@@ -0,0 +1,56 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export namespace chat {
+
+		/**
+		 * Register a variable which can be used in a chat request to any participant.
+		 * @param name The name of the variable, to be used in the chat input as `#name`.
+		 * @param description A description of the variable for the chat input suggest widget.
+		 * @param resolver Will be called to provide the chat variable's value when it is used.
+		 */
+		export function registerChatVariableResolver(name: string, description: string, resolver: ChatVariableResolver): Disposable;
+	}
+
+	export interface ChatVariableValue {
+		/**
+		 * The detail level of this chat variable value. If possible, variable resolvers should try to offer shorter values that will consume fewer tokens in an LLM prompt.
+		 */
+		level: ChatVariableLevel;
+
+		/**
+		 * The variable's value, which can be included in an LLM prompt as-is, or the chat participant may decide to read the value and do something else with it.
+		 */
+		value: string | Uri;
+
+		/**
+		 * A description of this value, which could be provided to the LLM as a hint.
+		 */
+		description?: string;
+	}
+
+	// TODO@API align with ChatRequest
+	export interface ChatVariableContext {
+		/**
+		 * The message entered by the user, which includes this variable.
+		 */
+		// TODO@API AS-IS, variables as types, agent/commands stripped
+		prompt: string;
+
+		// readonly variables: readonly ChatResolvedVariable[];
+	}
+
+	export interface ChatVariableResolver {
+		/**
+		 * A callback to resolve the value of a chat variable.
+		 * @param name The name of the variable.
+		 * @param context Contextual information about this chat request.
+		 * @param token A cancellation token.
+		 */
+		resolve(name: string, context: ChatVariableContext, token: CancellationToken): ProviderResult<ChatVariableValue[]>;
+	}
+}

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

@@ -7,10 +7,8 @@ declare module 'vscode' {
 
 	export interface CodeAction {
 		/**
-		 *
-		 * The range to which this Code Action applies to, which will be highlighted.
-		 *
-		 * Ex: A refactoring action will highlight the range of text that will be affected.
+		 * The ranges to which this Code Action applies to, which will be highlighted.
+		 * For example: A refactoring action will highlight the range of text that will be affected.
 		 */
 		ranges?: Range[];
 	}

package/vscode-dts/{vscode.proposed.chat.d.ts → vscode.proposed.contribIssueReporter.d.ts}

@@ -3,23 +3,5 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-declare module 'vscode' {
-
-	// ChatML
-	export enum ChatMessageRole {
-		System = 0,
-		User = 1,
-		Assistant = 2,
-		Function = 3,
-	}
-
-	// ChatML
-	export class ChatMessage {
-		role: ChatMessageRole;
-		content: string;
-		name?: string;
-
-		constructor(role: ChatMessageRole, content: string);
-	}
-
-}
+// empty placeholder declaration for the `issue reporter`-submenu contribution point
+// https://github.com/microsoft/vscode/issues/196863

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

@@ -4,5 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 // empty placeholder declaration for the `scm/incomingChanges`-menu contribution point
+// empty placeholder declaration for the `scm/incomingChanges/context`-menu contribution point
 // empty placeholder declaration for the `scm/outgoingChanges`-menu contribution point
+// empty placeholder declaration for the `scm/outgoingChanges/context`-menu contribution point
 // https://github.com/microsoft/vscode/issues/201997

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

@@ -0,0 +1,7 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// empty placeholder declaration for the `scm/sourceControl/title`-menu contribution point
+// https://github.com/microsoft/vscode/issues/203511

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

@@ -16,6 +16,79 @@ declare module 'vscode' {
 			id: string,
 			provider: DebugVisualizationProvider<T>
 		): Disposable;
+
+		/**
+		 * Registers a tree that can be referenced by {@link DebugVisualization.visualization}.
+		 * @param id
+		 * @param provider
+		 */
+		export function registerDebugVisualizationTreeProvider<T extends DebugTreeItem>(
+			id: string,
+			provider: DebugVisualizationTree<T>
+		): Disposable;
+	}
+
+	/**
+	 * An item from the {@link DebugVisualizationTree}
+	 */
+	export interface DebugTreeItem {
+		/**
+		 * A human-readable string describing this item.
+		 */
+		label: string;
+
+		/**
+		 * A human-readable string which is rendered less prominent.
+		 */
+		description?: string;
+
+		/**
+		 * {@link TreeItemCollapsibleState} of the tree item.
+		 */
+		collapsibleState?: TreeItemCollapsibleState;
+
+		/**
+		 * Context value of the tree item. This can be used to contribute item specific actions in the tree.
+		 * For example, a tree item is given a context value as `folder`. When contributing actions to `view/item/context`
+		 * using `menus` extension point, you can specify context value for key `viewItem` in `when` expression like `viewItem == folder`.
+		 * ```json
+		 * "contributes": {
+		 *   "menus": {
+		 *     "view/item/context": [
+		 *       {
+		 *         "command": "extension.deleteFolder",
+		 *         "when": "viewItem == folder"
+		 *       }
+		 *     ]
+		 *   }
+		 * }
+		 * ```
+		 * This will show action `extension.deleteFolder` only for items with `contextValue` is `folder`.
+		 */
+		contextValue?: string;
+
+		/**
+		 * Whether this item can be edited by the user.
+		 */
+		canEdit?: boolean;
+	}
+
+	/**
+	 * Provides a tree that can be referenced in debug visualizations.
+	 */
+	export interface DebugVisualizationTree<T extends DebugTreeItem = DebugTreeItem> {
+		/**
+		 * Gets the tree item for an element or the base context item.
+		 */
+		getTreeItem(context: DebugVisualizationContext): ProviderResult<T>;
+		/**
+		 * Gets children for the tree item or the best context item.
+		 */
+		getChildren(element: T): ProviderResult<T[]>;
+		/**
+		 * Handles the user editing an item.
+		 */
+		editItem?(item: T, value: string): ProviderResult<T>;
 	}
 
 	export class DebugVisualization {
@@ -32,12 +105,9 @@ declare module 'vscode' {
 		/**
 		 * Visualization to use for the variable. This may be either:
 		 * - A command to run when the visualization is selected for a variable.
-		 * - A {@link TreeDataProvider} which is used to display the data in-line
-		 *   where the variable is shown. If a single root item is returned from
-		 *   the data provider, it will replace the variable in its tree.
-		 *   Otherwise, the items will be shown as children of the variable.
+		 * - A reference to a previously-registered {@link DebugVisualizationTree}
 		 */
-		visualization?: Command | TreeDataProvider<unknown>;
+		visualization?: Command | { treeId: string };
 
 		/**
 		 * Creates a new debug visualization object.
@@ -80,7 +150,7 @@ declare module 'vscode' {
 		 * that came from user evaluations in the Debug Console.
 		 * @see https://microsoft.github.io/debug-adapter-protocol/specification#Types_Variable
 		 */
-		containerId?: string;
+		containerId?: number;
 		/**
 		 * The ID of the Debug Adapter Protocol StackFrame in which the variable was found,
 		 * for variables that came from scopes in a stack frame.

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

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export type ChatWelcomeMessageContent = string | MarkdownString;
+
+	export interface ChatWelcomeMessageProvider {
+		provideWelcomeMessage(token: CancellationToken): ProviderResult<ChatWelcomeMessageContent[]>;
+		provideSampleQuestions?(token: CancellationToken): ProviderResult<ChatFollowup[]>;
+	}
+
+	export interface ChatParticipant {
+		/**
+		 * When true, this participant is invoked by default when no other participant is being invoked
+		 */
+		isDefault?: boolean;
+
+		/**
+		 * The full name of this participant.
+		 */
+		fullName?: string;
+
+		/**
+		 * When true, this participant is invoked when the user submits their query using ctrl/cmd+enter
+		 * TODO@API name
+		 */
+		isSecondary?: boolean;
+
+		/**
+		 * A string that will be added before the listing of chat participants in `/help`.
+		 */
+		helpTextPrefix?: string | MarkdownString;
+
+		/**
+		 * A string that will be added before the listing of chat variables in `/help`.
+		 */
+		helpTextVariablesPrefix?: string | MarkdownString;
+
+		/**
+		 * A string that will be appended after the listing of chat participants in `/help`.
+		 */
+		helpTextPostfix?: string | MarkdownString;
+
+		welcomeMessageProvider?: ChatWelcomeMessageProvider;
+	}
+}

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

@@ -0,0 +1,89 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export interface FindFiles2Options {
+		// note: this is just FindTextInFilesOptions without select properties (include, previewOptions, beforeContext, afterContext)
+
+		/**
+		 * A {@link GlobPattern glob pattern} that defines files and folders to exclude. The glob pattern
+		 * will be matched against the file paths of resulting matches relative to their workspace.
+		 */
+		exclude?: GlobPattern;
+
+		/**
+		 * Whether to use the values for files.exclude. Defaults to true.
+		 */
+		useDefaultExcludes?: boolean;
+
+		/**
+		 * Whether to use the values for search.exclude. Defaults to true. Will not be followed if `useDefaultExcludes` is set to `false`.
+		 */
+		useDefaultSearchExcludes?: boolean;
+
+		/**
+		 * The maximum number of results to search for
+		 */
+		maxResults?: number;
+
+		/**
+		 * Whether external files that exclude files, like .gitignore, should be respected.
+		 * Defaults to the value for `search.useIgnoreFiles` in settings.
+		 * For more info, see the setting listed above.
+		 */
+		useIgnoreFiles?: boolean;
+
+		/**
+		 * Whether global files that exclude files, like .gitignore, should be respected.
+		 * Must set `useIgnoreFiles` to `true` to use this.
+		 * Defaults to the value for `search.useGlobalIgnoreFiles` in settings.
+		 * For more info, see the setting listed above.
+		 */
+		useGlobalIgnoreFiles?: boolean;
+
+		/**
+		 * Whether files in parent directories that exclude files, like .gitignore, should be respected.
+		 * Must set `useIgnoreFiles` to `true` to use this.
+		 * Defaults to the value for `search.useParentIgnoreFiles` in settings.
+		 * For more info, see the setting listed above.
+		 */
+		useParentIgnoreFiles?: boolean;
+
+		/**
+		 * Whether symlinks should be followed while searching.
+		 * Defaults to the value for `search.followSymlinks` in settings.
+		 * For more info, see the setting listed above.
+		 */
+		followSymlinks?: boolean;
+
+		/**
+		 * If set to true, the `filePattern` arg will be fuzzy-searched instead of glob-searched.
+		 * If `filePattern` is a {@link RelativePattern relative pattern}, then the fuzzy search will act on the `pattern` of the {@link RelativePattern RelativePattern}
+		 */
+		fuzzy?: boolean;
+	}
+
+	/**
+	 * Represents a session of a currently logged in user.
+	 */
+	export namespace workspace {
+		/**
+		 * Find files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
+		 *
+		 * @example
+		 * findFiles('**​/*.js', {exclude: '**​/out/**', useIgnoreFiles: true, maxResults: 10})
+		 *
+		 * @param filePattern A {@link GlobPattern glob pattern} that defines the files to search for. The glob pattern
+		 * will be matched against the file paths of resulting matches relative to their workspace. Use a {@link RelativePattern relative pattern}
+		 * to restrict the search results to a {@link WorkspaceFolder workspace folder}.
+		 * @param options A set of {@link FindFiles2Options FindFiles2Options} that defines where and how to search (e.g. exclude settings).
+		 * @param token A token that can be used to signal cancellation to the underlying search engine.
+		 * @returns A thenable that resolves to an array of resource identifiers. Will return no results if no
+		 * {@link workspace.workspaceFolders workspace folders} are opened.
+		 */
+		export function findFiles2(filePattern: GlobPattern, options?: FindFiles2Options, token?: CancellationToken): Thenable<Uri[]>;
+	}
+}