@codingame/monaco-vscode-api 4.5.2 → 5.0.0

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

@@ -7,6 +7,47 @@ declare module 'vscode' {
 
 	// https://github.com/microsoft/vscode/issues/30066/
 
+	/**
+	 * Identifies a {@linkcode DocumentDropEdit} or {@linkcode DocumentPasteEdit}
+	 */
+	class DocumentDropOrPasteEditKind {
+		static readonly Empty: DocumentDropOrPasteEditKind;
+
+		private constructor(value: string);
+
+		/**
+		 * The raw string value of the kind.
+		 */
+		readonly value: string;
+
+		/**
+		 * Create a new kind by appending additional scopes to the current kind.
+		 *
+		 * Does not modify the current kind.
+		 */
+		append(...parts: string[]): DocumentDropOrPasteEditKind;
+
+		/**
+		 * Checks if this kind intersects `other`.
+		 *
+		 * The kind `"text.plain"` for example intersects `text`, `"text.plain"` and `"text.plain.list"`,
+		 * but not `"unicorn"`, or `"textUnicorn.plain"`.
+		 *
+		 * @param other Kind to check.
+		 */
+		intersects(other: DocumentDropOrPasteEditKind): boolean;
+
+		/**
+		 * Checks if `other` is a sub-kind of this `DocumentDropOrPasteEditKind`.
+		 *
+		 * The kind `"text.plain"` for example contains `"text.plain"` and `"text.plain.list"`,
+		 * but not `"text"` or `"unicorn.text.plain"`.
+		 *
+		 * @param other Kind to check.
+		 */
+		contains(other: DocumentDropOrPasteEditKind): boolean;
+	}
+
 	/**
 	 * The reason why paste edits were requested.
 	 */
@@ -30,7 +71,7 @@ declare module 'vscode' {
 		/**
 		 * Requested kind of paste edits to return.
 		 */
-		readonly only: DocumentPasteEditKind | undefined;
+		readonly only: DocumentDropOrPasteEditKind | undefined;
 
 		/**
 		 * The reason why paste edits were requested.
@@ -44,18 +85,18 @@ declare module 'vscode' {
 	interface DocumentPasteEditProvider<T extends DocumentPasteEdit = DocumentPasteEdit> {
 
 		/**
-		 * Optional method invoked after the user copies text in a file.
+		 * Optional method invoked after the user copies from a {@link TextEditor text editor}.
 		 *
-		 * This allows the provider to attach copy metadata to the {@link DataTransfer}
-		 * which is then passed back to providers in {@linkcode provideDocumentPasteEdits}.
+		 * This allows the provider to attach metadata about the copied text to the {@link DataTransfer}. This data
+		 * transfer is then passed back to providers in {@linkcode provideDocumentPasteEdits}.
 		 *
-		 * Note that currently any changes to the {@linkcode DataTransfer} are isolated to the current editor session.
-		 * This means that added metadata cannot be seen by other applications.
+		 * Note that currently any changes to the {@linkcode DataTransfer} are isolated to the current editor window.
+		 * This means that any added metadata cannot be seen by other editor windows or by other applications.
 		 *
-		 * @param document Document where the copy took place.
+		 * @param document Text document where the copy took place.
 		 * @param ranges Ranges being copied in {@linkcode document}.
-		 * @param dataTransfer The data transfer associated with the copy. You can store additional values on this for later use in  {@linkcode provideDocumentPasteEdits}.
-		 * This object is only valid for the duration of this method.
+		 * @param dataTransfer The data transfer associated with the copy. You can store additional values on this for
+		 * later use in  {@linkcode provideDocumentPasteEdits}. This object is only valid for the duration of this method.
 		 * @param token A cancellation token.
 		 *
 		 * @return Optional thenable that resolves when all changes to the `dataTransfer` are complete.
@@ -63,17 +104,20 @@ declare module 'vscode' {
 		prepareDocumentPaste?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>;
 
 		/**
-		 * Invoked before the user pastes into a document.
+		 * Invoked before the user pastes into a {@link TextEditor text editor}.
 		 *
 		 * Returned edits can replace the standard pasting behavior.
 		 *
 		 * @param document Document being pasted into
 		 * @param ranges Range in the {@linkcode document} to paste into.
-		 * @param dataTransfer The {@link DataTransfer data transfer} associated with the paste. This object is only valid for the duration of the paste operation.
+		 * @param dataTransfer The {@link DataTransfer data transfer} associated with the paste. This object is only
+		 * valid for the duration of the paste operation.
 		 * @param context Additional context for the paste.
 		 * @param token A cancellation token.
 		 *
-		 * @return Set of potential {@link DocumentPasteEdit edits} that apply the paste. Return `undefined` to use standard pasting.
+		 * @return Set of potential {@link DocumentPasteEdit edits} that can apply the paste. Only a single returned
+		 * {@linkcode DocumentPasteEdit} is applied at a time. If multiple edits are returned from all providers, then
+		 * the first is automatically applied and a widget is shown that lets the user switch to the other edits.
 		 */
 		provideDocumentPasteEdits?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, context: DocumentPasteEditContext, token: CancellationToken): ProviderResult<T[]>;
 
@@ -81,7 +125,7 @@ declare module 'vscode' {
 		 * Optional method which fills in the {@linkcode DocumentPasteEdit.additionalEdit} before the edit is applied.
 		 *
 		 * This is called once per edit and should be used if generating the complete edit may take a long time.
-		 * Resolve can only be used to change {@link DocumentPasteEdit.additionalEdit}.
+		 * Resolve can only be used to change {@linkcode DocumentPasteEdit.additionalEdit}.
 		 *
 		 * @param pasteEdit The {@linkcode DocumentPasteEdit} to resolve.
 		 * @param token A cancellation token.
@@ -93,7 +137,7 @@ declare module 'vscode' {
 	}
 
 	/**
-	 * An edit applied on paste.
+	 * An edit the applies a paste operation.
 	 */
 	class DocumentPasteEdit {
 
@@ -103,14 +147,14 @@ declare module 'vscode' {
 		title: string;
 
 		/**
-		 * {@link DocumentPasteEditKind Kind} of the edit.
-		 *
-		 * Used to identify specific types of edits.
+		 * {@link DocumentDropOrPasteEditKind Kind} of the edit.
 		 */
-		kind: DocumentPasteEditKind;
+		kind: DocumentDropOrPasteEditKind;
 
 		/**
 		 * The text or snippet to insert at the pasted locations.
+		 *
+		 * If your edit requires more advanced insertion logic, set this to an empty string and provide an {@link DocumentPasteEdit.additionalEdit additional edit} instead.
 		 */
 		insertText: string | SnippetString;
 
@@ -120,47 +164,32 @@ declare module 'vscode' {
 		additionalEdit?: WorkspaceEdit;
 
 		/**
-		 * Controls the ordering of paste edits provided by multiple providers.
+		 * Controls ordering when multiple paste edits can potentially be applied.
 		 *
-		 * If this edit yields to another, it will be shown lower in the list of paste edit.
+		 * If this edit yields to another, it will be shown lower in the list of possible paste edits shown to the user.
 		 */
-		yieldTo?: readonly DocumentPasteEditKind[];
+		yieldTo?: readonly DocumentDropOrPasteEditKind[];
 
 		/**
 		 * Create a new paste edit.
 		 *
 		 * @param insertText The text or snippet to insert at the pasted locations.
 		 * @param title Human readable label that describes the edit.
-		 * @param kind {@link DocumentPasteEditKind Kind} of the edit.
+		 * @param kind {@link DocumentDropOrPasteEditKind Kind} of the edit.
 		 */
-		constructor(insertText: string | SnippetString, title: string, kind: DocumentPasteEditKind);
+		constructor(insertText: string | SnippetString, title: string, kind: DocumentDropOrPasteEditKind);
 	}
 
-
 	/**
-	 * TODO: Share with code action kind?
+	 * Provides additional metadata about how a {@linkcode DocumentPasteEditProvider} works.
 	 */
-	class DocumentPasteEditKind {
-		static readonly Empty: DocumentPasteEditKind;
-
-		// TODO: Add `Text` any others?
-
-		private constructor(value: string);
-
-		readonly value: string;
-
-		append(...parts: string[]): CodeActionKind;
-		intersects(other: CodeActionKind): boolean;
-		contains(other: CodeActionKind): boolean;
-	}
-
 	interface DocumentPasteProviderMetadata {
 		/**
-		 * List of {@link DocumentPasteEditKind kinds} that the provider may return in {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits}.
+		 * List of {@link DocumentDropOrPasteEditKind kinds} that the provider may return in {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits}.
 		 *
-		 * The provider will only be invoked when one of these kinds is being requested. For normal pasting, all providers will be invoked.
+		 * This is used to filter out providers when a specific {@link DocumentDropOrPasteEditKind kind} of edit is requested.
 		 */
-		readonly providedPasteEditKinds: readonly DocumentPasteEditKind[];
+		readonly providedPasteEditKinds: readonly DocumentDropOrPasteEditKind[];
 
 		/**
 		 * Mime types that {@linkcode DocumentPasteEditProvider.prepareDocumentPaste prepareDocumentPaste} may add on copy.
@@ -175,12 +204,79 @@ declare module 'vscode' {
 		 * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
 		 *
 		 * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@linkcode DataTransfer}.
-		 * Note that {@linkcode DataTransferFile} entries are only created when dropping content from outside the editor, such as
+		 * Note that {@linkcode DataTransferFile} entries are only created when pasting content from outside the editor, such as
 		 * from the operating system.
 		 */
 		readonly pasteMimeTypes?: readonly string[];
 	}
 
+	/**
+	 * TODO on finalization:
+	 * - Add ctor(insertText: string | SnippetString, title?: string, kind?: DocumentDropOrPasteEditKind); Can't be done as this is an extension to an existing class
+	 */
+
+	export interface DocumentDropEdit {
+		/**
+		 * Human readable label that describes the edit.
+		 */
+		title?: string;
+
+		/**
+		 * {@link DocumentDropOrPasteEditKind Kind} of the edit.
+		 */
+		kind: DocumentDropOrPasteEditKind;
+
+		/**
+		 * Controls the ordering or multiple edits. If this provider yield to edits, it will be shown lower in the list.
+		 */
+		yieldTo?: readonly DocumentDropOrPasteEditKind[];
+	}
+
+	export interface DocumentDropEditProvider<T extends DocumentDropEdit = DocumentDropEdit> {
+		// Overload that allows returning multiple edits
+		// Will be merged in on finalization
+		provideDocumentDropEdits(document: TextDocument, position: Position, dataTransfer: DataTransfer, token: CancellationToken): ProviderResult<DocumentDropEdit | DocumentDropEdit[]>;
+
+		/**
+		 * Optional method which fills in the {@linkcode DocumentDropEdit.additionalEdit} before the edit is applied.
+		 *
+		 * This is called once per edit and should be used if generating the complete edit may take a long time.
+		 * Resolve can only be used to change {@link DocumentDropEdit.additionalEdit}.
+		 *
+		 * @param pasteEdit The {@linkcode DocumentDropEdit} to resolve.
+		 * @param token A cancellation token.
+		 *
+		 * @returns The resolved edit or a thenable that resolves to such. It is OK to return the given
+		 * `edit`. If no result is returned, the given `edit` is used.
+		 */
+		resolveDocumentDropEdit?(edit: T, token: CancellationToken): ProviderResult<T>;
+	}
+
+	/**
+	 * Provides additional metadata about how a {@linkcode DocumentDropEditProvider} works.
+	 */
+	export interface DocumentDropEditProviderMetadata {
+		/**
+		 * List of {@link DocumentDropOrPasteEditKind kinds} that the provider may return in {@linkcode DocumentDropEditProvider.provideDocumentDropEdits provideDocumentDropEdits}.
+		 *
+		 * This is used to filter out providers when a specific {@link DocumentDropOrPasteEditKind kind} of edit is requested.
+		 */
+		readonly providedDropEditKinds?: readonly DocumentDropOrPasteEditKind[];
+
+		/**
+		 * List of {@link DataTransfer} mime types that the provider can handle.
+		 *
+		 * This can either be an exact mime type such as `image/png`, or a wildcard pattern such as `image/*`.
+		 *
+		 * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
+		 *
+		 * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@link DataTransfer}.
+		 * Note that {@link DataTransferFile} entries are only created when dropping content from outside the editor, such as
+		 * from the operating system.
+		 */
+		readonly dropMimeTypes: readonly string[];
+	}
+
 	namespace languages {
 		/**
 		 * Registers a new {@linkcode DocumentPasteEditProvider}.
@@ -192,5 +288,10 @@ declare module 'vscode' {
 		 * @returns A {@link Disposable} that unregisters this provider when disposed of.
 		 */
 		export function registerDocumentPasteEditProvider(selector: DocumentSelector, provider: DocumentPasteEditProvider, metadata: DocumentPasteProviderMetadata): Disposable;
+
+		/**
+		 * Overload which adds extra metadata. Will be removed on finalization.
+		 */
+		export function registerDocumentDropEditProvider(selector: DocumentSelector, provider: DocumentDropEditProvider, metadata?: DocumentDropEditProviderMetadata): Disposable;
 	}
 }

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

@@ -0,0 +1,76 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	/**
+	 * A hover represents additional information for a symbol or word. Hovers are
+	 * rendered in a tooltip-like widget.
+	 */
+	export class VerboseHover extends Hover {
+
+		/**
+		 * Can increase the verbosity of the hover
+		 */
+		canIncreaseVerbosity?: boolean;
+
+		/**
+		 * Can decrease the verbosity of the hover
+		 */
+		canDecreaseVerbosity?: boolean;
+
+		/**
+		 * Creates a new hover object.
+		 *
+		 * @param contents The contents of the hover.
+		 * @param range The range to which the hover applies.
+		 */
+		constructor(contents: MarkdownString | MarkedString | Array<MarkdownString | MarkedString>, range?: Range, canIncreaseVerbosity?: boolean, canDecreaseVerbosity?: boolean);
+	}
+
+	export interface HoverContext {
+
+		/**
+		 * Whether to increase or decrease the hover's verbosity
+		 */
+		readonly action?: HoverVerbosityAction;
+
+		/**
+		 * The previous hover sent for the same position
+		 */
+		readonly previousHover?: Hover;
+	}
+
+	export enum HoverVerbosityAction {
+		/**
+		 * Increase the hover verbosity
+		 */
+		Increase = 0,
+		/**
+		 * Decrease the hover verbosity
+		 */
+		Decrease = 1
+	}
+
+	/**
+	 * The hover provider class
+	 */
+	export interface HoverProvider {
+
+		/**
+		 * Provide a hover for the given position and document. Multiple hovers at the same
+		 * position will be merged by the editor. A hover can have a range which defaults
+		 * to the word range at the position when omitted.
+		 *
+		 * @param document The document in which the command was invoked.
+		 * @param position The position at which the command was invoked.
+		 * @param token A cancellation token.
+		 * @oaram context A hover context.
+		 * @returns A hover or a thenable that resolves to such. The lack of a result can be
+		 * signaled by returning `undefined` or `null`.
+		 */
+		provideHover(document: TextDocument, position: Position, token: CancellationToken, context?: HoverContext): ProviderResult<VerboseHover>;
+	}
+}

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

@@ -110,28 +110,12 @@ declare module 'vscode' {
 		handleInteractiveEditorResponseFeedback?(session: S, response: R, kind: InteractiveEditorResponseFeedbackKind): void;
 	}
 
-	export interface InteractiveSession {
-	}
-
-	export interface InteractiveSessionProvider<S extends InteractiveSession = InteractiveSession> {
-		prepareSession(token: CancellationToken): ProviderResult<S>;
-	}
-
-	export interface InteractiveSessionDynamicRequest {
-		/**
-		 * The message that will be displayed in the UI
-		 */
-		message: string;
-	}
-
 	export namespace interactive {
 		// current version of the proposal.
 		export const _version: 1 | number;
 
-		export function registerInteractiveSessionProvider(id: string, provider: InteractiveSessionProvider): Disposable;
-
 		export function registerInteractiveEditorSessionProvider(provider: InteractiveEditorSessionProvider, metadata?: InteractiveEditorSessionProviderMetadata): Disposable;
 
-		export function transferChatSession(session: InteractiveSession, toWorkspace: Uri): void;
+		export function transferActiveChat(toWorkspace: Uri): void;
 	}
 }

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

@@ -98,9 +98,38 @@ declare module 'vscode' {
 	 */
 	export type LanguageModelChatMessage = LanguageModelChatSystemMessage | LanguageModelChatUserMessage | LanguageModelChatAssistantMessage;
 
+	/**
+	 * Represents information about a registered language model.
+	 */
+	export interface LanguageModelInformation {
+		/**
+		 * The identifier of the language model.
+		 */
+		readonly id: string;
+
+		/**
+		 * The human-readable name of the language model.
+		 */
+		readonly name: string;
+
+		/**
+		 * The version of the language model.
+		 */
+		readonly version: string;
+
+		/**
+		 * The number of available tokens that can be used when sending requests
+		 * to the language model.
+		 *
+		 * @see {@link lm.sendChatRequest}
+		 */
+		readonly tokens: number;
+	}
+
 	/**
 	 * An event describing the change in the set of available language models.
 	 */
+	// TODO@API use LanguageModelInformation instead of string?
 	export interface LanguageModelChangeEvent {
 		/**
 		 * Added language models.
@@ -173,6 +202,24 @@ declare module 'vscode' {
 	 */
 	export namespace lm {
 
+		/**
+		 * The identifiers of all language models that are currently available.
+		 */
+		export const languageModels: readonly string[];
+
+		/**
+		 * An event that is fired when the set of available language models changes.
+		 */
+		export const onDidChangeLanguageModels: Event<LanguageModelChangeEvent>;
+
+		/**
+		 * Retrieve information about a language model.
+		 *
+		 * @param languageModel A language model identifier.
+		 * @returns A {@link LanguageModelInformation} instance or `undefined` if the language model does not exist.
+		 */
+		export function getLanguageModelInformation(languageModel: string): LanguageModelInformation | undefined;
+
 		/**
 		 * Make a chat request using a language model.
 		 *
@@ -198,14 +245,16 @@ declare module 'vscode' {
 		export function sendChatRequest(languageModel: string, messages: LanguageModelChatMessage[], options: LanguageModelChatRequestOptions, token: CancellationToken): Thenable<LanguageModelChatResponse>;
 
 		/**
-		 * The identifiers of all language models that are currently available.
-		 */
-		export const languageModels: readonly string[];
-
-		/**
-		 * An event that is fired when the set of available language models changes.
+		 * Uses the language model specific tokenzier and computes the length in token of a given message.
+		 *
+		 * *Note* that this function will throw when the language model does not exist.
+		 *
+		 * @param languageModel A language model identifier.
+		 * @param text A string or a message instance.
+		 * @param token Optional cancellation token.
+		 * @returns A thenable that resolves to the length of the message in tokens.
 		 */
-		export const onDidChangeLanguageModels: Event<LanguageModelChangeEvent>;
+		export function computeTokenLength(languageModel: string, text: string | LanguageModelChatMessage, token?: CancellationToken): Thenable<number>;
 	}
 
 	/**
@@ -228,10 +277,6 @@ declare module 'vscode' {
 		 * model does not exist or consent hasn't been asked for.
 		 */
 		canSendRequest(languageModelId: string): boolean | undefined;
-
-		// TODO@API SYNC or ASYNC?
-		// TODO@API future
-		// retrieveQuota(languageModelId: string): { remaining: number; resets: Date };
 	}
 
 	export interface ExtensionContext {

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

@@ -11,6 +11,11 @@ declare module 'vscode' {
 		AIGenerated = 1
 	}
 
+	export enum NewSymbolNameTriggerKind {
+		Invoke = 0,
+		Automatic = 1,
+	}
+
 	export class NewSymbolName {
 		readonly newSymbolName: string;
 		readonly tags?: readonly NewSymbolNameTag[];
@@ -19,6 +24,12 @@ declare module 'vscode' {
 	}
 
 	export interface NewSymbolNamesProvider {
+
+		/**
+		 * @default false
+		 */
+		readonly supportsAutomaticTriggerKind?: Thenable<boolean>;
+
 		/**
 		 * Provide possible new names for the symbol at the given range.
 		 *
@@ -27,7 +38,7 @@ declare module 'vscode' {
 		 * @param token A cancellation token.
 		 * @return A list of new symbol names.
 		 */
-		provideNewSymbolNames(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<NewSymbolName[]>;
+		provideNewSymbolNames(document: TextDocument, range: Range, triggerKind: NewSymbolNameTriggerKind, token: CancellationToken): ProviderResult<NewSymbolName[]>;
 	}
 
 	export namespace languages {

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

@@ -38,13 +38,13 @@ declare module 'vscode' {
 
 	export interface SourceControlHistoryItemGroup {
 		readonly id: string;
-		readonly label: string;
+		readonly name: string;
 		readonly base?: Omit<SourceControlRemoteHistoryItemGroup, 'base'>;
 	}
 
 	export interface SourceControlRemoteHistoryItemGroup {
 		readonly id: string;
-		readonly label: string;
+		readonly name: string;
 	}
 
 	export interface SourceControlHistoryItemStatistics {
@@ -56,8 +56,8 @@ declare module 'vscode' {
 	export interface SourceControlHistoryItem {
 		readonly id: string;
 		readonly parentIds: string[];
-		readonly label: string;
-		readonly description?: string;
+		readonly message: string;
+		readonly author?: string;
 		readonly icon?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
 		readonly timestamp?: number;
 		readonly statistics?: SourceControlHistoryItemStatistics;

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

@@ -15,7 +15,8 @@ declare module 'vscode' {
 		Started = 1,
 		Recognizing = 2,
 		Recognized = 3,
-		Stopped = 4
+		Stopped = 4,
+		Error = 5
 	}
 
 	export interface SpeechToTextEvent {