@codingame/monaco-vscode-api 3.2.3 → 4.0.0

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

@@ -21,21 +21,21 @@ declare module 'vscode' {
 		readonly prompt: string;
 
 		/**
-		 * The name of the chat participant and contributing extension to which this request was directed.
+		 * The id of the chat participant and contributing extension to which this request was directed.
 		 */
-		readonly participant: { readonly extensionId: string; readonly name: string };
+		readonly participant: string;
 
 		/**
 		 * The name of the {@link ChatCommand command} that was selected for this request.
 		 */
-		readonly command: string | undefined;
+		readonly command?: string;
 
 		/**
 		 * The variables that were referenced in this message.
 		 */
 		readonly variables: ChatResolvedVariable[];
 
-		private constructor(prompt: string, command: string | undefined, variables: ChatResolvedVariable[], participant: { extensionId: string; name: string });
+		private constructor(prompt: string, command: string | undefined, variables: ChatResolvedVariable[], participant: string);
 	}
 
 	/**
@@ -54,16 +54,16 @@ declare module 'vscode' {
 		readonly result: ChatResult;
 
 		/**
-		 * The name of the chat participant and contributing extension that this response came from.
+		 * The id of the chat participant and contributing extension that this response came from.
 		 */
-		readonly participant: { readonly extensionId: string; readonly name: string };
+		readonly participant: string;
 
 		/**
 		 * The name of the command that this response came from.
 		 */
 		readonly command?: string;
 
-		private constructor(response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart>, result: ChatResult, participant: { extensionId: string; name: string });
+		private constructor(response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart>, result: ChatResult, participant: string);
 	}
 
 	export interface ChatContext {
@@ -143,49 +143,6 @@ declare module 'vscode' {
 		readonly kind: ChatResultFeedbackKind;
 	}
 
-	export interface ChatCommand {
-		/**
-		 * A short name by which this command is referred to in the UI, e.g. `fix` or
-		 * `explain` for commands that fix an issue or explain code.
-		 *
-		 * **Note**: The name should be unique among the commands provided by this participant.
-		 */
-		readonly name: string;
-
-		/**
-		 * Human-readable description explaining what this command does.
-		 */
-		readonly description: string;
-
-		/**
-		 * When the user clicks this command in `/help`, this text will be submitted to this command
-		 */
-		readonly sampleRequest?: string;
-
-		/**
-		 * Whether executing the command puts the chat into a persistent mode, where the command is automatically added to the chat input for the next message.
-		 */
-		readonly isSticky?: boolean;
-	}
-
-	/**
-	 * A ChatCommandProvider returns {@link ChatCommands commands} that can be invoked on a chat participant using `/`. For example, `@participant /command`.
-	 * These can be used as shortcuts to let the user explicitly invoke different functionalities provided by the participant.
-	 */
-	export interface ChatCommandProvider {
-		/**
-		 * Returns a list of commands that its participant is capable of handling. A command
-		 * can be selected by the user and will then be passed to the {@link ChatRequestHandler handler}
-		 * via the {@link ChatRequest.command command} property.
-		 *
-		 *
-		 * @param token A cancellation token.
-		 * @returns A list of commands. The lack of a result can be signaled by returning `undefined`, `null`, or
-		 * an empty array.
-		 */
-		provideCommands(context: ChatContext, token: CancellationToken): ProviderResult<ChatCommand[]>;
-	}
-
 	/**
 	 * A followup question suggested by the participant.
 	 */
@@ -201,7 +158,7 @@ declare module 'vscode' {
 		label?: string;
 
 		/**
-		 * By default, the followup goes to the same participant/command. But this property can be set to invoke a different participant.
+		 * By default, the followup goes to the same participant/command. But this property can be set to invoke a different participant by ID.
 		 * Followups can only invoke a participant that was contributed by the same extension.
 		 */
 		participant?: string;
@@ -221,13 +178,13 @@ declare module 'vscode' {
 		 * @param result This instance has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
 		 * @param token A cancellation token.
 		 */
-		provideFollowups(result: ChatResult, token: CancellationToken): ProviderResult<ChatFollowup[]>;
+		provideFollowups(result: ChatResult, context: ChatContext, token: CancellationToken): ProviderResult<ChatFollowup[]>;
 	}
 
 	/**
 	 * A chat request handler is a callback that will be invoked when a request is made to a chat participant.
 	 */
-	export type ChatRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatResponseStream, token: CancellationToken) => ProviderResult<ChatResult>;
+	export type ChatRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatResponseStream, token: CancellationToken) => ProviderResult<ChatResult | void>;
 
 	/**
 	 * A chat participant can be invoked by the user in a chat session, using the `@` prefix. When it is invoked, it handles the chat request and is solely
@@ -235,14 +192,9 @@ declare module 'vscode' {
 	 */
 	export interface ChatParticipant {
 		/**
-		 * The short name by which this participant is referred to in the UI, e.g `workspace`.
-		 */
-		readonly name: string;
-
-		/**
-		 * A human-readable description explaining what this participant does.
+		 * A unique ID for this participant.
 		 */
-		description?: string;
+		readonly id: string;
 
 		/**
 		 * Icon for the participant shown in UI.
@@ -263,11 +215,6 @@ declare module 'vscode' {
 		 */
 		requestHandler: ChatRequestHandler;
 
-		/**
-		 * This provider will be called to retrieve the participant's commands.
-		 */
-		commandProvider?: ChatCommandProvider;
-
 		/**
 		 * This provider will be called once after each request to retrieve suggested followup questions.
 		 */
@@ -278,11 +225,6 @@ declare module 'vscode' {
 		 */
 		sampleRequest?: string;
 
-		/**
-		 * Whether invoking the participant puts the chat into a persistent mode, where the participant is automatically added to the chat input for the next message.
-		 */
-		isSticky?: boolean;
-
 		/**
 		 * An event that fires whenever feedback for a result is received, e.g. when a user up- or down-votes
 		 * a result.
@@ -316,17 +258,42 @@ declare module 'vscode' {
 		 * *Note* that the indices take the leading `#`-character into account which means they can
 		 * used to modify the prompt as-is.
 		 */
-		readonly range: [start: number, end: number];
+		readonly range?: [start: number, end: number];
 
 		// TODO@API decouple of resolve API, use `value: string | Uri | (maybe) unknown?`
+		/**
+		 * The values of the variable. Can be an empty array if the variable doesn't currently have a value.
+		 */
 		readonly values: ChatVariableValue[];
 	}
 
+	/**
+	 * The location at which the chat is happening.
+	 */
+	export enum ChatLocation {
+		/**
+		 * The chat panel
+		 */
+		Panel = 1,
+		/**
+		 * Terminal inline chat
+		 */
+		Terminal = 2,
+		/**
+		 * Notebook inline chat
+		 */
+		Notebook = 3,
+		/**
+		 * Code editor inline chat
+		 */
+		Editor = 4
+	}
+
 	export interface ChatRequest {
 		/**
 		 * The prompt as entered by the user.
 		 *
-		 * Information about variables used in this request are is stored in {@link ChatRequest.variables}.
+		 * Information about variables used in this request is stored in {@link ChatRequest.variables}.
 		 *
 		 * *Note* that the {@link ChatParticipant.name name} of the participant and the {@link ChatCommand.name command}
 		 * are not part of the prompt.
@@ -349,6 +316,11 @@ declare module 'vscode' {
 		 */
 		// TODO@API Q? are there implicit variables that are not part of the prompt?
 		readonly variables: readonly ChatResolvedVariable[];
+
+		/**
+		 * The location at which the chat is happening. This will always be one of the supported values
+		 */
+		readonly location: ChatLocation;
 	}
 
 	/**
@@ -415,7 +387,7 @@ declare module 'vscode' {
 		 * @param value A uri or location
 		 * @returns This stream.
 		 */
-		reference(value: Uri | Location): ChatResponseStream;
+		reference(value: Uri | Location | { variableName: string; value?: Uri | Location }): ChatResponseStream;
 
 		/**
 		 * Pushes a part to this stream.
@@ -453,8 +425,8 @@ declare module 'vscode' {
 	}
 
 	export class ChatResponseReferencePart {
-		value: Uri | Location;
-		constructor(value: Uri | Location);
+		value: Uri | Location | { variableName: string; value?: Uri | Location };
+		constructor(value: Uri | Location | { variableName: string; value?: Uri | Location });
 	}
 
 	export class ChatResponseCommandButtonPart {
@@ -473,12 +445,11 @@ declare module 'vscode' {
 		/**
 		 * Create a new {@link ChatParticipant chat participant} instance.
 		 *
-		 * @param name Short name by which the participant is referred to in the UI. The name must be unique for the extension
-		 * contributing the participant but can collide with names from other extensions.
+		 * @param id A unique identifier for the participant.
 		 * @param handler A request handler for the participant.
 		 * @returns A new chat participant
 		 */
-		export function createChatParticipant(name: string, handler: ChatRequestHandler): ChatParticipant;
+		export function createChatParticipant(id: string, handler: ChatRequestHandler): ChatParticipant;
 	}
 
 	/**

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

@@ -22,9 +22,18 @@ declare module 'vscode' {
 		markdownContent: MarkdownString;
 	}
 
+	/**
+	 * Now only used for the "intent detection" API below
+	 */
+	export interface ChatCommand {
+		readonly name: string;
+		readonly description: string;
+	}
+
 	// TODO@API fit this into the stream
 	export interface ChatDetectedParticipant {
 		participant: string;
+		// TODO@API validate this against statically-declared slash commands?
 		command?: ChatCommand;
 	}
 
@@ -158,13 +167,15 @@ declare module 'vscode' {
 		constructor(label: string | CompletionItemLabel, values: ChatVariableValue[]);
 	}
 
-	export type ChatExtendedRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatExtendedResponseStream, token: CancellationToken) => ProviderResult<ChatResult>;
+	export type ChatExtendedRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatExtendedResponseStream, token: CancellationToken) => ProviderResult<ChatResult | void>;
 
 	export namespace chat {
 		/**
 		 * Create a chat participant with the extended progress type
 		 */
-		export function createChatParticipant(name: string, handler: ChatExtendedRequestHandler): ChatParticipant;
+		export function createChatParticipant(id: string, handler: ChatExtendedRequestHandler): ChatParticipant;
+
+		export function createDynamicChatParticipant(id: string, name: string, description: string, handler: ChatExtendedRequestHandler): ChatParticipant;
 	}
 
 	/*
@@ -231,20 +242,6 @@ declare module 'vscode' {
 		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

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

@@ -16,7 +16,7 @@ declare module 'vscode' {
 	 * Represents a large language model that accepts ChatML messages and produces a streaming response
 	 */
 	export interface ChatResponseProvider {
-		provideLanguageModelResponse2(messages: LanguageModelMessage[], options: { [name: string]: any }, extensionId: string, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
+		provideLanguageModelResponse2(messages: LanguageModelChatMessage[], options: { [name: string]: any }, extensionId: string, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
 	}
 
 	export interface ChatResponseProviderMetadata {

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

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// @alexr00 https://github.com/microsoft/vscode/issues/207402
+
+	export enum CommentThreadApplicability {
+		Current = 0,
+		Outdated = 1
+	}
+
+	export interface CommentThread2 {
+		/* @api this is a bit weird for the extension now. The CommentThread is a managed object, which means it listens
+		 * to when it's properties are set, but not if it's properties are modified. This means that this will not work to update the resolved state
+		 *
+		 * thread.state.resolved = CommentThreadState.Resolved;
+		 *
+		 * but this will work
+		 *
+		 * thread.state = {
+		 *   resolved: CommentThreadState.Resolved
+		 *   applicability: thread.state.applicability
+		 * };
+		 *
+		 * Worth noting that we already have this problem for the `comments` property.
+		*/
+		state?: CommentThreadState | { resolved?: CommentThreadState; applicability?: CommentThreadApplicability };
+	}
+}

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

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// @alexr00 https://github.com/microsoft/vscode/issues/185551
+
+	/**
+	 * Commenting range provider for a {@link CommentController comment controller}.
+	 */
+	export interface CommentingRangeProvider {
+		readonly resourceHints?: { schemes: readonly string[] };
+	}
+}

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

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 `commentsView/commentThread/context` menu contribution point

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

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 `diffEditor/gutter/*` menus

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

@@ -7,17 +7,13 @@ declare module 'vscode' {
 
 	// See https://github.com/microsoft/vscode/issues/63943
 
-	export class ThreadFocus {
+	export class Thread {
 		/**
 		 * Create a ThreadFocus
 		 * @param session
 		 * @param threadId
-		 * @param frameId
 		 */
-		constructor(
-			session: DebugSession,
-			threadId?: number);
-
+		constructor(session: DebugSession, threadId: number);
 
 		/**
 		 * Debug session for thread.
@@ -25,23 +21,19 @@ declare module 'vscode' {
 		readonly session: DebugSession;
 
 		/**
-		 * Id of the associated thread (DAP id). May be undefined if thread has become unselected.
+		 * ID of the associated thread in the debug protocol.
 		 */
-		readonly threadId: number | undefined;
+		readonly threadId: number;
 	}
 
-	export class StackFrameFocus {
+	export class StackFrame {
 		/**
 		 * Create a StackFrameFocus
 		 * @param session
 		 * @param threadId
 		 * @param frameId
 		 */
-		constructor(
-			session: DebugSession,
-			threadId?: number,
-			frameId?: number);
-
+		constructor(session: DebugSession, threadId?: number, frameId?: number);
 
 		/**
 		 * Debug session for thread.
@@ -49,26 +41,26 @@ declare module 'vscode' {
 		readonly session: DebugSession;
 
 		/**
-		 * Id of the associated thread (DAP id). May be undefined if a frame is unselected.
+		 * Id of the associated thread in the debug protocol.
 		 */
-		readonly threadId: number | undefined;
+		readonly threadId: number;
 		/**
-		 * Id of the stack frame (DAP id). May be undefined if a frame is unselected.
+		 * Id of the stack frame in the debug protocol.
 		 */
-		readonly frameId: number | undefined;
+		readonly frameId: number;
 	}
 
 
 	export namespace debug {
 		/**
-		 * The currently focused thread or stack frame id, or `undefined` if this has not been set. (e.g. not in debug mode).
+		 * The currently focused thread or stack frame, or `undefined` if no
+		 * thread or stack is focused.
 		 */
-		export let stackFrameFocus: ThreadFocus | StackFrameFocus | undefined;
+		export const activeStackItem: Thread | StackFrame | undefined;
 
 		/**
-		 * An {@link Event} which fires when the {@link debug.stackFrameFocus} changes. Provides a sessionId. threadId is not undefined
-		 * when a thread of frame has gained focus. frameId is defined when a stackFrame has gained focus.
+		 * An event which fires when the {@link debug.activeStackItem} has changed.
 		 */
-		export const onDidChangeStackFrameFocus: Event<ThreadFocus | StackFrameFocus | undefined>;
+		export const onDidChangeActiveStackItem: Event<Thread | StackFrame | undefined>;
 	}
 }

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

@@ -12,6 +12,15 @@ declare module 'vscode' {
 		provideSampleQuestions?(token: CancellationToken): ProviderResult<ChatFollowup[]>;
 	}
 
+	export interface ChatRequesterInformation {
+		name: string;
+
+		/**
+		 * A full URI for the icon of the request.
+		 */
+		icon?: Uri;
+	}
+
 	export interface ChatParticipant {
 		/**
 		 * When true, this participant is invoked by default when no other participant is being invoked
@@ -45,5 +54,6 @@ declare module 'vscode' {
 		helpTextPostfix?: string | MarkdownString;
 
 		welcomeMessageProvider?: ChatWelcomeMessageProvider;
+		requester?: ChatRequesterInformation;
 	}
 }