@codingame/monaco-vscode-api 4.5.2 → 5.0.0

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

@@ -9,7 +9,6 @@ declare module 'vscode' {
 	 * Represents a user request in chat history.
 	 */
 	export class ChatRequestTurn {
-
 		/**
 		 * The prompt as entered by the user.
 		 *
@@ -21,7 +20,7 @@ declare module 'vscode' {
 		readonly prompt: string;
 
 		/**
-		 * The id of the chat participant and contributing extension to which this request was directed.
+		 * The id of the chat participant to which this request was directed.
 		 */
 		readonly participant: string;
 
@@ -32,6 +31,7 @@ declare module 'vscode' {
 
 		/**
 		 * The variables that were referenced in this message.
+		 * TODO@API ensure that this will be compatible with future changes to chat variables.
 		 */
 		readonly variables: ChatResolvedVariable[];
 
@@ -42,9 +42,8 @@ declare module 'vscode' {
 	 * Represents a chat participant's response in chat history.
 	 */
 	export class ChatResponseTurn {
-
 		/**
-		* The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
+		 * The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
 		 */
 		readonly response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart>;
 
@@ -54,7 +53,7 @@ declare module 'vscode' {
 		readonly result: ChatResult;
 
 		/**
-		 * The id of the chat participant and contributing extension that this response came from.
+		 * The id of the chat participant that this response came from.
 		 */
 		readonly participant: string;
 
@@ -132,8 +131,8 @@ declare module 'vscode' {
 	 */
 	export interface ChatResultFeedback {
 		/**
-		 * The ChatResult that the user is providing feedback for.
-		 * This instance has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
+		 * The ChatResult for which the user is providing feedback.
+		 * This object has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
 		 */
 		readonly result: ChatResult;
 
@@ -175,7 +174,7 @@ declare module 'vscode' {
 	export interface ChatFollowupProvider {
 		/**
 		 * Provide followups for the given result.
-		 * @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 result This object 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, context: ChatContext, token: CancellationToken): ProviderResult<ChatFollowup[]>;
@@ -197,7 +196,7 @@ declare module 'vscode' {
 		readonly id: string;
 
 		/**
-		 * Icon for the participant shown in UI.
+		 * An icon for the participant shown in UI.
 		 */
 		iconPath?: Uri | {
 			/**
@@ -210,6 +209,11 @@ declare module 'vscode' {
 			dark: Uri;
 		} | ThemeIcon;
 
+		/**
+		 * When the user clicks this participant in `/help`, this text will be submitted to this participant.
+		 */
+		sampleRequest?: string;
+
 		/**
 		 * The handler for requests to this participant.
 		 */
@@ -220,11 +224,6 @@ declare module 'vscode' {
 		 */
 		followupProvider?: ChatFollowupProvider;
 
-		/**
-		 * When the user clicks this participant in `/help`, this text will be submitted to this participant.
-		 */
-		sampleRequest?: string;
-
 		/**
 		 * An event that fires whenever feedback for a result is received, e.g. when a user up- or down-votes
 		 * a result.
@@ -267,28 +266,6 @@ declare module 'vscode' {
 		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.
@@ -305,6 +282,7 @@ declare module 'vscode' {
 		 */
 		readonly command: string | undefined;
 
+
 		/**
 		 * The list of variables and their values that are referenced in the prompt.
 		 *
@@ -314,13 +292,7 @@ declare module 'vscode' {
 		 * in the prompt. That means the last variable in the prompt is the first in this list. This simplifies
 		 * string-manipulation of the prompt.
 		 */
-		// 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;
 	}
 
 	/**
@@ -334,7 +306,7 @@ declare module 'vscode' {
 		 * `push(new ChatResponseMarkdownPart(value))`.
 		 *
 		 * @see {@link ChatResponseStream.push}
-		 * @param value A markdown string or a string that should be interpreted as markdown.
+		 * @param value A markdown string or a string that should be interpreted as markdown. The boolean form of {@link MarkdownString.isTrusted} is NOT supported.
 		 * @returns This stream.
 		 */
 		markdown(value: string | MarkdownString): ChatResponseStream;
@@ -385,9 +357,10 @@ declare module 'vscode' {
 		 * *Note* that the reference is not rendered inline with the response.
 		 *
 		 * @param value A uri or location
+		 * @param iconPath Icon for the reference shown in UI
 		 * @returns This stream.
 		 */
-		reference(value: Uri | Location | { variableName: string; value?: Uri | Location }): ChatResponseStream;
+		reference(value: Uri | Location | { variableName: string; value?: Uri | Location }, iconPath?: ThemeIcon): ChatResponseStream;
 
 		/**
 		 * Pushes a part to this stream.
@@ -399,6 +372,10 @@ declare module 'vscode' {
 
 	export class ChatResponseMarkdownPart {
 		value: MarkdownString;
+
+		/**
+		 * @param value Note: The boolean form of {@link MarkdownString.isTrusted} is NOT supported.
+		 */
 		constructor(value: string | MarkdownString);
 	}
 
@@ -426,7 +403,8 @@ declare module 'vscode' {
 
 	export class ChatResponseReferencePart {
 		value: Uri | Location | { variableName: string; value?: Uri | Location };
-		constructor(value: Uri | Location | { variableName: string; value?: Uri | Location });
+		iconPath?: ThemeIcon;
+		constructor(value: Uri | Location | { variableName: string; value?: Uri | Location }, iconPath?: ThemeIcon);
 	}
 
 	export class ChatResponseCommandButtonPart {

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

@@ -5,6 +5,45 @@
 
 declare module 'vscode' {
 
+	/**
+	 * 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 attempt number of the request. The first request has attempt number 0.
+		 */
+		readonly attempt: number;
+
+		/**
+		 * If automatic command detection is enabled.
+		 */
+		readonly enableCommandDetection: boolean;
+
+		/**
+		 * The location at which the chat is happening. This will always be one of the supported values
+		 */
+		readonly location: ChatLocation;
+	}
+
 	export interface ChatParticipant {
 		onDidPerformAction: Event<ChatUserActionEvent>;
 		supportIssueReporting?: boolean;
@@ -17,11 +56,6 @@ declare module 'vscode' {
 		responseIsRedacted?: boolean;
 	}
 
-	/** @deprecated */
-	export interface ChatMarkdownContent {
-		markdownContent: MarkdownString;
-	}
-
 	/**
 	 * Now only used for the "intent detection" API below
 	 */
@@ -30,73 +64,23 @@ declare module 'vscode' {
 		readonly description: string;
 	}
 
-	// TODO@API fit this into the stream
-	export interface ChatDetectedParticipant {
+	export class ChatResponseDetectedParticipantPart {
 		participant: string;
 		// TODO@API validate this against statically-declared slash commands?
 		command?: ChatCommand;
+		constructor(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;
+	export class ChatResponseMarkdownWithVulnerabilitiesPart {
+		value: MarkdownString;
+		vulnerabilities: ChatVulnerability[];
+		constructor(value: string | MarkdownString, vulnerabilities: ChatVulnerability[]);
 	}
 
 	/**
@@ -106,45 +90,29 @@ declare module 'vscode' {
 		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 class ChatResponseTextEditPart {
+		uri: Uri;
+		edits: TextEdit[];
+		constructor(uri: Uri, edits: TextEdit | TextEdit[]);
 	}
 
 	export interface ChatResponseStream {
-		/**
-		 * @deprecated use above methods instread
-		 */
-		report(value: ChatProgress): void;
+		textEdit(target: Uri, edits: TextEdit | TextEdit[]): ChatResponseStream;
+		markdownWithVulnerabilities(value: string | MarkdownString, vulnerabilities: ChatVulnerability[]): ChatResponseStream;
+		detectedParticipant(participant: string, command?: ChatCommand): ChatResponseStream;
+		push(part: ChatResponsePart | ChatResponseTextEditPart | ChatResponseDetectedParticipantPart): ChatResponseStream;
 	}
 
-	/** @deprecated */
-	export type ChatExtendedProgress = ChatProgress
-		| ChatMarkdownContent
-		| ChatDetectedParticipant;
-
-	export type ChatExtendedResponseStream = ChatResponseStream & {
-		/**
-		 * @deprecated
-		 */
-		report(value: ChatExtendedProgress): void;
-	};
+	// TODO@API fit this into the stream
+	export interface ChatUsedContext {
+		documents: ChatDocumentContext[];
+	}
 
 	export interface ChatParticipant {
 		/**
@@ -163,11 +131,12 @@ declare module 'vscode' {
 		insertText?: string;
 		detail?: string;
 		documentation?: string | MarkdownString;
+		command?: Command;
 
 		constructor(label: string | CompletionItemLabel, values: ChatVariableValue[]);
 	}
 
-	export type ChatExtendedRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatExtendedResponseStream, token: CancellationToken) => ProviderResult<ChatResult | void>;
+	export type ChatExtendedRequestHandler = (request: ChatRequest, context: ChatContext, response: ChatResponseStream, token: CancellationToken) => ProviderResult<ChatResult | void>;
 
 	export namespace chat {
 		/**
@@ -230,9 +199,14 @@ declare module 'vscode' {
 		kind: 'bug';
 	}
 
+	export interface ChatEditorAction {
+		kind: 'editor';
+		accepted: boolean;
+	}
+
 	export interface ChatUserActionEvent {
 		readonly result: ChatResult;
-		readonly action: ChatCopyAction | ChatInsertAction | ChatTerminalAction | ChatCommandAction | ChatFollowupAction | ChatBugReportAction;
+		readonly action: ChatCopyAction | ChatInsertAction | ChatTerminalAction | ChatCommandAction | ChatFollowupAction | ChatBugReportAction | ChatEditorAction;
 	}
 
 	export interface ChatVariableValue {

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

@@ -16,7 +16,12 @@ declare module 'vscode' {
 	 * Represents a large language model that accepts ChatML messages and produces a streaming response
 	 */
 	export interface ChatResponseProvider {
+
+		onDidReceiveLanguageModelResponse2?: Event<{ readonly extensionId: string; readonly participant?: string; readonly tokenCount?: number }>;
+
 		provideLanguageModelResponse2(messages: LanguageModelChatMessage[], options: { [name: string]: any }, extensionId: string, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
+
+		provideTokenCount(text: string | LanguageModelChatMessage, token: CancellationToken): Thenable<number>;
 	}
 
 	export interface ChatResponseProviderMetadata {
@@ -27,6 +32,10 @@ declare module 'vscode' {
 		// TODO@API rename to model
 		name: string;
 
+		version: string;
+
+		tokens: number;
+
 		/**
 		 * 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.

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

@@ -8,11 +8,7 @@ declare module 'vscode' {
 	 * The tab represents an interactive window.
 	 */
 	export class TabInputChat {
-		/**
-		 * The uri of the history notebook in the interactive window.
-		 */
-		readonly providerId: string;
-		constructor(providerId: string);
+		constructor();
 	}
 
 	export interface Tab {

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

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 `accessibilityHelpContent`-property of the `views`-contribution
+
+// https://github.com/microsoft/vscode/issues/209855 @meganrogge
+
+/**
+ * View contributions can include an `accessibilityHelpContent` property that provides help content for screen readers
+ * when the accessibility help dialog is invoked by the user with focus in the view.
+ *
+ * The content is provided as a markdown string and can contain commands that will be resolved along with their keybindings.
+ */

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

@@ -7,7 +7,7 @@ declare module 'vscode' {
 
 	// See https://github.com/microsoft/vscode/issues/63943
 
-	export class Thread {
+	export class DebugThread {
 		/**
 		 * Create a ThreadFocus
 		 * @param session
@@ -26,7 +26,7 @@ declare module 'vscode' {
 		readonly threadId: number;
 	}
 
-	export class StackFrame {
+	export class DebugStackFrame {
 		/**
 		 * Create a StackFrameFocus
 		 * @param session
@@ -56,11 +56,11 @@ declare module 'vscode' {
 		 * The currently focused thread or stack frame, or `undefined` if no
 		 * thread or stack is focused.
 		 */
-		export const activeStackItem: Thread | StackFrame | undefined;
+		export const activeStackItem: DebugThread | DebugStackFrame | undefined;
 
 		/**
 		 * An event which fires when the {@link debug.activeStackItem} has changed.
 		 */
-		export const onDidChangeActiveStackItem: Event<Thread | StackFrame | undefined>;
+		export const onDidChangeActiveStackItem: Event<DebugThread | DebugStackFrame | undefined>;
 	}
 }

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

@@ -8,8 +8,8 @@ declare module 'vscode' {
 	export type ChatWelcomeMessageContent = string | MarkdownString;
 
 	export interface ChatWelcomeMessageProvider {
-		provideWelcomeMessage(token: CancellationToken): ProviderResult<ChatWelcomeMessageContent[]>;
-		provideSampleQuestions?(token: CancellationToken): ProviderResult<ChatFollowup[]>;
+		provideWelcomeMessage(location: ChatLocation, token: CancellationToken): ProviderResult<ChatWelcomeMessageContent[]>;
+		provideSampleQuestions?(location: ChatLocation, token: CancellationToken): ProviderResult<ChatFollowup[]>;
 	}
 
 	export interface ChatRequesterInformation {