@codingame/monaco-vscode-api 1.83.16 → 1.85.0-next.0

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

@@ -0,0 +1,80 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 ChatAgentUserActionEvent {
+		readonly result: ChatAgentResult2;
+		readonly action: InteractiveSessionCopyAction | InteractiveSessionInsertAction | InteractiveSessionTerminalAction | InteractiveSessionCommandAction | InteractiveSessionFollowupAction | InteractiveSessionBugReportAction;
+	}
+
+	export interface ChatAgent2 {
+		onDidPerformAction: Event<ChatAgentUserActionEvent>;
+		supportIssueReporting?: boolean;
+	}
+
+	export interface ChatAgentErrorDetails {
+		/**
+		 * If set to true, the message content is completely hidden. Only ChatAgentErrorDetails#message will be shown.
+		 */
+		responseIsRedacted?: boolean;
+	}
+
+	/**
+	 * This is temporary until inline references are fully supported and adopted
+	 */
+	export interface ChatAgentMarkdownContent {
+		markdownContent: MarkdownString;
+	}
+
+	export interface ChatAgentDetectedAgent {
+		agentName: string;
+		command?: ChatAgentSlashCommand;
+	}
+
+	export interface ChatAgentVulnerability {
+		title: string;
+		description: string;
+		// id: string; // Later we will need to be able to link these across multiple content chunks.
+	}
+
+	export interface ChatAgentContent {
+		vulnerabilities?: ChatAgentVulnerability[];
+	}
+
+	export type ChatAgentExtendedProgress = ChatAgentProgress
+		| ChatAgentMarkdownContent
+		| ChatAgentDetectedAgent;
+
+	export interface ChatAgent2 {
+		/**
+		 * Provide a set of variables that can only be used with this agent.
+		 */
+		agentVariableProvider?: { provider: ChatAgentCompletionItemProvider; triggerCharacters: string[] };
+	}
+
+	export interface ChatAgentCompletionItemProvider {
+		provideCompletionItems(query: string, token: CancellationToken): ProviderResult<ChatAgentCompletionItem[]>;
+	}
+
+	export class ChatAgentCompletionItem {
+		label: string | CompletionItemLabel;
+		values: ChatVariableValue[];
+		insertText?: string;
+		detail?: string;
+		documentation?: string | MarkdownString;
+
+		constructor(label: string | CompletionItemLabel, values: ChatVariableValue[]);
+	}
+
+	export type ChatAgentExtendedHandler = (request: ChatAgentRequest, context: ChatAgentContext, progress: Progress<ChatAgentExtendedProgress>, token: CancellationToken) => ProviderResult<ChatAgentResult2>;
+
+	export namespace chat {
+		/**
+		 * Create a chat agent with the extended progress type
+		 */
+		export function createChatAgent(name: string, handler: ChatAgentExtendedHandler): ChatAgent2;
+	}
+}

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

@@ -18,7 +18,11 @@ declare module 'vscode' {
 	}
 
 	export interface ChatResponseProviderMetadata {
-		// TODO: add way to compute token count
+		/**
+		 * The name of the model that is used for this chat access. It is expected that the model name can
+		 * be used to lookup properties like token limits and ChatML support
+		 */
+		// TODO@API rename to model
 		name: string;
 	}
 

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

@@ -5,32 +5,90 @@
 
 declare module 'vscode' {
 
-	export interface ChatResponseFragment {
-		index: number;
-		part: string;
+	export interface ChatResponseStream {
+
+		/**
+		 * The response stream.
+		 */
+		readonly response: AsyncIterable<string>;
+
+		/**
+		 * The variant of multiple responses. This is used to disambiguate between multiple
+		 * response streams when having asked for multiple response options
+		 */
+		readonly option: number;
+	}
+
+	export interface ChatRequest {
+
+		/**
+		 * The overall result of the request which represents failure or success
+		 * but _not_ the actual response or responses
+		 */
+		result: Thenable<any>;
+
+		/**
+		 * The _default response_ stream. This is the stream of the first response option
+		 * receiving data.
+		 *
+		 * Usually there is only one response option and this stream is more convienient to use
+		 * than the {@link onDidStartResponseStream `onDidStartResponseStream`} event.
+		 */
+		response: AsyncIterable<string>;
+
+		/**
+		 * An event that fires whenever a new response option is available. The response
+		 * itself is a stream of the actual response.
+		 *
+		 * *Note* that the first time this event fires, the {@link ChatResponseStream.response response stream}
+		 * is the same as the {@link response `default response stream`}.
+		 *
+		 * *Note* that unless requested there is only one response option, so this event will only fire
+		 * once.
+		 */
+		onDidStartResponseStream: Event<ChatResponseStream>;
+
+		/**
+		 * Cancel this request.
+		 */
+		// TODO@API remove this? We pass a token to makeRequest call already
+		cancel(): void;
 	}
 
 	/**
 	 * Represents access to using a chat provider (LLM). Access is granted and temporary, usually only valid
-	 * for the duration of an user interaction.
+	 * for the duration of an user interaction or specific time frame.
 	 */
 	export interface ChatAccess {
 
 		/**
-		 * Whether the access to chat has been revoked. This happens when the user interaction that allowed for
-		 * chat access is finished.
+		 * Whether the access to chat has been revoked. This happens when the condition that allowed for
+		 * chat access doesn't hold anymore, e.g a user interaction has ended.
 		 */
 		isRevoked: boolean;
 
 		/**
-		 * TODO: return an AsyncIterable instead of asking to pass Progress<...>?
+		 * The name of the model that is used for this chat access. It is expected that the model name can
+		 * be used to lookup properties like token limits and ChatML support
+		 */
+		model: string;
+
+		/**
+		 * Make a chat request.
+		 *
+		 * The actual response will be reported back via the `progress` callback. The promise returned by this function
+		 * returns a overall result which represents failure or success of the request.
+		 *
+		 * Chat can be asked for multiple response options. In that case the `progress` callback will be called multiple
+		 * time with different `ChatResponseStream` objects. Each object represents a different response option and the actual
+		 * response will be reported back via their `stream` property.
+		 *
+		 * *Note:* This will throw an error if access has been revoked.
 		 *
 		 * @param messages
 		 * @param options
-		 * @param progress
-		 * @param token
 		 */
-		makeRequest(messages: ChatMessage[], options: { [name: string]: any }, progress: Progress<ChatResponseFragment>, token: CancellationToken): Thenable<any>;
+		makeRequest(messages: ChatMessage[], options: { [name: string]: any }, token: CancellationToken): ChatRequest;
 	}
 
 	export namespace chat {

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

@@ -0,0 +1,21 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+	/**
+	 * 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);
+	}
+
+	export interface Tab {
+		readonly input: TabInputText | TabInputTextDiff | TabInputCustom | TabInputWebview | TabInputNotebook | TabInputNotebookDiff | TabInputTerminal | TabInputChat | unknown;
+	}
+}

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

@@ -17,7 +17,11 @@ declare module 'vscode' {
 
 	export interface ChatVariableValue {
 		level: ChatVariableLevel;
-		value: string;
+		/**
+		 * 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;
+		value: string | Uri | any;
 		description?: string;
 	}
 

package/vscode-dts/vscode.proposed.codeActionAI.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' {
+
+	export interface CodeAction {
+		/**
+		 * Marks this as an AI action.
+		 *
+		 * Ex: A quick fix should be marked AI if it invokes AI.
+		 */
+		isAI?: boolean;
+	}
+}

package/vscode-dts/vscode.proposed.contribSourceControlInputBoxMenu.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/inputBox`-menu contribution point
+// https://github.com/microsoft/vscode/issues/195474

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

@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// https://github.com/microsoft/vscode/issues/169724 @bpasero
+
+declare module 'vscode' {
+
+	export interface FileSystemWatcherOptions {
+
+		/**
+		 * Ignore when files have been created.
+		 */
+		readonly ignoreCreateEvents?: boolean;
+
+		/**
+		 * Ignore when files have been changed.
+		 */
+		readonly ignoreChangeEvents?: boolean;
+
+		/**
+		 * Ignore when files have been deleted.
+		 */
+		readonly ignoreDeleteEvents?: boolean;
+
+		/**
+		 * An optional set of glob patterns to exclude from watching.
+		 * Glob patterns are always matched relative to the watched folder.
+		 */
+		readonly excludes?: string[];
+	}
+
+	export namespace workspace {
+
+		/**
+		 * A variant of {@link workspace.createFileSystemWatcher} that optionally allows to specify
+		 * a set of glob patterns to exclude from watching.
+		 *
+		 * It provides the following advantages over the other {@link workspace.createFileSystemWatcher}
+		 * method:
+		 * - the configured excludes from `files.watcherExclude` setting are NOT applied
+		 * - requests for recursive file watchers inside the opened workspace are NOT ignored
+		 * - the watcher is ONLY notified for events from this request and not from any other watcher
+		 *
+		 * As such, this method is prefered in cases where you want full control over the watcher behavior
+		 * without being impacted by settings or other watchers that are installed.
+		 */
+		export function createFileSystemWatcher(pattern: RelativePattern, options?: FileSystemWatcherOptions): FileSystemWatcher;
+	}
+}

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

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 ChatAgent2 {
+		/**
+		 * When true, this agent is invoked by default when no other agent is being invoked
+		 */
+		isDefault?: boolean;
+
+		/**
+		 * When true, this agent 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 agents in `/help`.
+		 */
+		helpTextPrefix?: string | MarkdownString;
+
+		/**
+		 * A string that will be appended after the listing of chat agents in `/help`.
+		 */
+		helpTextPostfix?: string | MarkdownString;
+	}
+}

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

@@ -14,6 +14,18 @@ declare module 'vscode' {
 		handleIssueUrlRequest(): ProviderResult<Uri>;
 	}
 
+	export interface IssueDataProvider {
+		/**
+		 * Provide the data to be used in the issue reporter.
+		 */
+		provideIssueData(token: CancellationToken): ProviderResult<string>;
+
+		/**
+		 * Provide the template to be used in the description of issue reporter.
+		 */
+		provideIssueTemplate(token: CancellationToken): ProviderResult<string>;
+	}
+
 	export namespace env {
 		/**
 		 * Register an {@link IssueUriRequestHandler}. By registering an issue uri request handler,
@@ -27,5 +39,19 @@ declare module 'vscode' {
 		 * @param handler the issue uri request handler to register for this extension.
 		 */
 		export function registerIssueUriRequestHandler(handler: IssueUriRequestHandler): Disposable;
+
+		/**
+		 * Register an {@link IssueDataProvider}. By registering an issue data provider,
+		 * you can provide additional information to the built-in issue reporter.
+		 * The repo url must be provided by package.json's repository field.
+		 *
+		 * Examples:
+		 * - Provide additional information about the current workspace, current extension, current user, or OS
+		 * - Provide data in the form of a string to the secondary description/data text box of the issue reporter.
+		 * - Provide a template for the description of the issue reporter
+		 *
+		 * @param provider the issue data provider to register for this extension.
+		 */
+		export function registerIssueDataProvider(provider: IssueDataProvider): Disposable;
 	}
 }

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

@@ -20,6 +20,7 @@ declare module 'vscode' {
 	// todo@API make classes
 	export interface InteractiveEditorSession {
 		placeholder?: string;
+		input?: string;
 		slashCommands?: InteractiveEditorSlashCommand[];
 		wholeRange?: Range;
 		message?: string;
@@ -37,6 +38,7 @@ declare module 'vscode' {
 	// todo@API make classes
 	export interface InteractiveEditorResponse {
 		edits: TextEdit[] | WorkspaceEdit;
+		contents?: MarkdownString;
 		placeholder?: string;
 		wholeRange?: Range;
 	}
@@ -48,11 +50,20 @@ declare module 'vscode' {
 		wholeRange?: Range;
 	}
 
+	export interface InteractiveEditorProgressItem {
+		message?: string;
+		edits?: TextEdit[];
+		editsShouldBeInstant?: boolean;
+		slashCommand?: InteractiveEditorSlashCommand;
+		content?: string | MarkdownString;
+	}
+
 	export enum InteractiveEditorResponseFeedbackKind {
 		Unhelpful = 0,
 		Helpful = 1,
 		Undone = 2,
-		Accepted = 3
+		Accepted = 3,
+		Bug = 4
 	}
 
 	export interface TextDocumentContext {
@@ -61,7 +72,14 @@ declare module 'vscode' {
 	}
 
 	export interface InteractiveEditorSessionProviderMetadata {
-		label: string;
+		label?: string;
+		supportReportIssue?: boolean;
+	}
+
+	export interface InteractiveEditorReplyFollowup {
+		message: string;
+		tooltip?: string;
+		title?: string;
 	}
 
 	export interface InteractiveEditorSessionProvider<S extends InteractiveEditorSession = InteractiveEditorSession, R extends InteractiveEditorResponse | InteractiveEditorMessageResponse = InteractiveEditorResponse | InteractiveEditorMessageResponse> {
@@ -69,15 +87,14 @@ declare module 'vscode' {
 		// Create a session. The lifetime of this session is the duration of the editing session with the input mode widget.
 		prepareInteractiveEditorSession(context: TextDocumentContext, token: CancellationToken): ProviderResult<S>;
 
-		provideInteractiveEditorResponse(session: S, request: InteractiveEditorRequest, progress: Progress<{ message: string; edits: TextEdit[] }>, token: CancellationToken): ProviderResult<R>;
+		provideInteractiveEditorResponse(session: S, request: InteractiveEditorRequest, progress: Progress<InteractiveEditorProgressItem>, token: CancellationToken): ProviderResult<R>;
+
+		provideFollowups?(session: S, response: R, token: CancellationToken): ProviderResult<InteractiveEditorReplyFollowup[]>;
 
 		// eslint-disable-next-line local/vscode-dts-provider-naming
 		handleInteractiveEditorResponseFeedback?(session: S, response: R, kind: InteractiveEditorResponseFeedbackKind): void;
 	}
 
-
-	export interface InteractiveSessionState { }
-
 	export interface InteractiveSessionParticipantInformation {
 		name: string;
 
@@ -91,70 +108,8 @@ declare module 'vscode' {
 		requester: InteractiveSessionParticipantInformation;
 		responder: InteractiveSessionParticipantInformation;
 		inputPlaceholder?: string;
-
-		saveState?(): InteractiveSessionState;
-	}
-
-	export interface InteractiveSessionRequestArgs {
-		command: string;
-		args: any;
-	}
-
-	export interface InteractiveRequest {
-		session: InteractiveSession;
-		message: string | InteractiveSessionReplyFollowup;
-	}
-
-	export interface InteractiveResponseErrorDetails {
-		message: string;
-		responseIsIncomplete?: boolean;
-		responseIsFiltered?: boolean;
-	}
-
-	export interface InteractiveResponseForProgress {
-		errorDetails?: InteractiveResponseErrorDetails;
-	}
-
-	export interface InteractiveProgressContent {
-		content: string | MarkdownString;
-	}
-
-	export interface InteractiveProgressId {
-		responseId: string;
-	}
-
-	export interface InteractiveProgressTask {
-		placeholder: string;
-		resolvedContent: Thenable<InteractiveProgressContent | InteractiveProgressFileTree>;
-	}
-
-	export interface FileTreeData {
-		label: string;
-		uri: Uri;
-		children?: FileTreeData[];
-	}
-
-	export interface InteractiveProgressFileTree {
-		treeData: FileTreeData;
 	}
 
-	export interface DocumentContext {
-		uri: Uri;
-		version: number;
-		ranges: Range[];
-	}
-
-	export interface InteractiveProgressUsedContext {
-		documents: DocumentContext[];
-	}
-
-	export type InteractiveProgress =
-		| InteractiveProgressContent
-		| InteractiveProgressId
-		| InteractiveProgressTask
-		| InteractiveProgressFileTree
-		| InteractiveProgressUsedContext;
-
 	export interface InteractiveResponseCommand {
 		commandId: string;
 		args?: any[];
@@ -162,40 +117,18 @@ declare module 'vscode' {
 		when?: string;
 	}
 
-	export interface InteractiveSessionSlashCommand {
-		command: string;
-		kind: CompletionItemKind;
-		detail?: string;
-		shouldRepopulate?: boolean;
-		followupPlaceholder?: string;
-		executeImmediately?: boolean;
-		yieldTo?: ReadonlyArray<{ readonly command: string }>;
-	}
-
 	export interface InteractiveSessionReplyFollowup {
 		message: string;
 		tooltip?: string;
 		title?: string;
-
-		// Extensions can put any serializable data here, such as an ID/version
-		metadata?: any;
 	}
 
-	export type InteractiveSessionFollowup = InteractiveSessionReplyFollowup | InteractiveResponseCommand;
-
-	export type InteractiveWelcomeMessageContent = string | InteractiveSessionReplyFollowup[];
+	export type InteractiveWelcomeMessageContent = string | MarkdownString | InteractiveSessionReplyFollowup[];
 
 	export interface InteractiveSessionProvider<S extends InteractiveSession = InteractiveSession> {
 		provideWelcomeMessage?(token: CancellationToken): ProviderResult<InteractiveWelcomeMessageContent[]>;
-		provideFollowups?(session: S, token: CancellationToken): ProviderResult<(string | InteractiveSessionFollowup)[]>;
-		provideSlashCommands?(session: S, token: CancellationToken): ProviderResult<InteractiveSessionSlashCommand[]>;
-
-		prepareSession(initialState: InteractiveSessionState | undefined, token: CancellationToken): ProviderResult<S>;
-		resolveRequest(session: S, context: InteractiveSessionRequestArgs | string, token: CancellationToken): ProviderResult<InteractiveRequest>;
-		provideResponseWithProgress(request: InteractiveRequest, progress: Progress<InteractiveProgress>, token: CancellationToken): ProviderResult<InteractiveResponseForProgress>;
-
-		// eslint-disable-next-line local/vscode-dts-provider-naming
-		removeRequest(session: S, requestId: string): void;
+		provideSampleQuestions?(token: CancellationToken): ProviderResult<InteractiveSessionReplyFollowup[]>;
+		prepareSession(token: CancellationToken): ProviderResult<S>;
 	}
 
 	export interface InteractiveSessionDynamicRequest {
@@ -203,12 +136,6 @@ declare module 'vscode' {
 		 * The message that will be displayed in the UI
 		 */
 		message: string;
-
-		/**
-		 * Any extra metadata/context that will go to the provider.
-		 * NOTE not actually used yet.
-		 */
-		metadata?: any;
 	}
 
 	export namespace interactive {
@@ -216,7 +143,6 @@ declare module 'vscode' {
 		export const _version: 1 | number;
 
 		export function registerInteractiveSessionProvider(id: string, provider: InteractiveSessionProvider): Disposable;
-		export function addInteractiveRequest(context: InteractiveSessionRequestArgs): void;
 
 		export function sendInteractiveRequestToProvider(providerId: string, message: InteractiveSessionDynamicRequest): void;
 

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

@@ -6,14 +6,13 @@
 declare module 'vscode' {
 
 	export enum InteractiveSessionVoteDirection {
-		Up = 1,
-		Down = 2
+		Down = 0,
+		Up = 1
 	}
 
 	export interface InteractiveSessionVoteAction {
 		// eslint-disable-next-line local/vscode-dts-string-type-literals
 		kind: 'vote';
-		responseId: string;
 		direction: InteractiveSessionVoteDirection;
 	}
 
@@ -26,7 +25,6 @@ declare module 'vscode' {
 	export interface InteractiveSessionCopyAction {
 		// eslint-disable-next-line local/vscode-dts-string-type-literals
 		kind: 'copy';
-		responseId: string;
 		codeBlockIndex: number;
 		copyType: InteractiveSessionCopyKind;
 		copiedCharacters: number;
@@ -37,7 +35,6 @@ declare module 'vscode' {
 	export interface InteractiveSessionInsertAction {
 		// eslint-disable-next-line local/vscode-dts-string-type-literals
 		kind: 'insert';
-		responseId: string;
 		codeBlockIndex: number;
 		totalCharacters: number;
 		newFile?: boolean;
@@ -46,7 +43,6 @@ declare module 'vscode' {
 	export interface InteractiveSessionTerminalAction {
 		// eslint-disable-next-line local/vscode-dts-string-type-literals
 		kind: 'runInTerminal';
-		responseId: string;
 		codeBlockIndex: number;
 		languageId?: string;
 	}
@@ -57,7 +53,18 @@ declare module 'vscode' {
 		command: InteractiveResponseCommand;
 	}
 
-	export type InteractiveSessionUserAction = InteractiveSessionVoteAction | InteractiveSessionCopyAction | InteractiveSessionInsertAction | InteractiveSessionTerminalAction | InteractiveSessionCommandAction;
+	export interface InteractiveSessionFollowupAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'followUp';
+		followup: InteractiveSessionReplyFollowup;
+	}
+
+	export interface InteractiveSessionBugReportAction {
+		// eslint-disable-next-line local/vscode-dts-string-type-literals
+		kind: 'bug';
+	}
+
+	export type InteractiveSessionUserAction = InteractiveSessionVoteAction | InteractiveSessionCopyAction | InteractiveSessionInsertAction | InteractiveSessionTerminalAction | InteractiveSessionCommandAction | InteractiveSessionBugReportAction;
 
 	export interface InteractiveSessionUserActionEvent {
 		action: InteractiveSessionUserAction;

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

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 LanguageStatusItem {
+
+		text2: string | { value: string; shortValue: string };
+	}
+}