@codingame/monaco-vscode-api 2.2.2 → 3.0.0

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

@@ -0,0 +1,86 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 class InlineEdit {
+
+
+		/**
+		 * The new text for this edit.
+		 */
+		readonly text: string;
+
+		/**
+		 * An range that will be replaced by the text of the inline edit.
+		 * If change is only additive, this can be empty (same start and end position).
+		 */
+		readonly range: Range;
+
+		/**
+		 * An optional command that will be executed after applying the inline edit.
+		 */
+		accepted?: Command;
+
+		/**
+		 * An optional command that will be executed after rejecting the inline edit.
+		 */
+		rejected?: Command;
+
+		/**
+		 * Creates a new inline edit.
+		 *
+		 * @param text The new text for this edit.
+		 * @param replaceRange An range that will be replaced by the text of the inline edit.
+		 */
+		constructor(text: string, range: Range);
+	}
+
+	export interface InlineEditContext {
+		/**
+		 * Describes how the inline edit was triggered.
+		 */
+		triggerKind: InlineEditTriggerKind;
+	}
+
+	export enum InlineEditTriggerKind {
+		/**
+		 * Completion was triggered explicitly by a user gesture.
+		 * Return multiple completion items to enable cycling through them.
+		 */
+		Invoke = 0,
+
+		/**
+		 * Completion was triggered automatically while editing.
+		 * It is sufficient to return a single completion item in this case.
+		 */
+		Automatic = 1,
+	}
+
+	export interface InlineEditProvider {
+		/**
+		 * Provide inline edit for the given document.
+		 *
+		 * @param document The document for which the inline edit are computed.
+		 * @param context Additional context information about the request.
+		 * @param token A cancellation token.
+		 * @return An inline edit or a thenable that resolves to such. The lack of a result can be
+		 * signaled by returning `undefined` or `null`.
+		 */
+		provideInlineEdit(document: TextDocument, context: InlineEditContext, token: CancellationToken): ProviderResult<InlineEdit>;
+	}
+
+	export namespace languages {
+
+		/**
+		 * Register a provider that can handle inline edits.
+		 *
+		 * @param selector A selector that defines the documents this provider is applicable to.
+		 * @param provider A provider that can handle inline edits.
+		 * @return A {@link Disposable} that unregisters this provider when being disposed.
+		 */
+		export function registerInlineEditProvider(selector: DocumentSelector, provider: InlineEditProvider): Disposable;
+
+	}
+}

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

@@ -32,7 +32,12 @@ declare module 'vscode' {
 		selection: Selection;
 		wholeRange: Range;
 		attempt: number;
+
+		/**
+		 * @deprecated, use previewDocument
+		 */
 		live: boolean;
+		previewDocument: TextDocument;
 		withIntentDetection: boolean;
 	}
 
@@ -120,11 +125,9 @@ declare module 'vscode' {
 		inputPlaceholder?: string;
 	}
 
-	export type InteractiveWelcomeMessageContent = string | MarkdownString | ChatAgentReplyFollowup[];
+	export type InteractiveWelcomeMessageContent = string | MarkdownString | ChatFollowup[];
 
 	export interface InteractiveSessionProvider<S extends InteractiveSession = InteractiveSession> {
-		provideWelcomeMessage?(token: CancellationToken): ProviderResult<InteractiveWelcomeMessageContent[]>;
-		provideSampleQuestions?(token: CancellationToken): ProviderResult<ChatAgentReplyFollowup[]>;
 		prepareSession(token: CancellationToken): ProviderResult<S>;
 	}
 

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

@@ -0,0 +1,184 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	/**
+	 * Represents a language model response.
+	 *
+	 * @see {@link LanguageModelAccess.makeChatRequest}
+	 */
+	export interface LanguageModelResponse {
+
+		/**
+		 * The overall result of the request which represents failure or success
+		 * but. The concrete value is not specified and depends on the selected language model.
+		 *
+		 * *Note* that the actual response represented by the {@link LanguageModelResponse.stream `stream`}-property
+		 */
+		result: Thenable<unknown>;
+
+		/**
+		 * An async iterable that is a stream of text chunks forming the overall response.
+		 */
+		stream: AsyncIterable<string>;
+	}
+
+	/**
+	 * A language model message that represents a system message.
+	 *
+	 * System messages provide instructions to the language model that define the context in
+	 * which user messages are interpreted.
+	 *
+	 * *Note* that a language model may choose to add additional system messages to the ones
+	 * provided by extensions.
+	 */
+	export class LanguageModelSystemMessage {
+
+		/**
+		 * The content of this message.
+		 */
+		content: string;
+
+		/**
+		 * Create a new system message.
+		 *
+		 * @param content The content of the message.
+		 */
+		constructor(content: string);
+	}
+
+	/**
+	 * A language model message that represents a user message.
+	 */
+	export class LanguageModelUserMessage {
+
+		/**
+		 * The content of this message.
+		 */
+		content: string;
+
+		/**
+		 * The optional name of a user for this message.
+		 */
+		name: string | undefined;
+
+		/**
+		 * Create a new user message.
+		 *
+		 * @param content The content of the message.
+		 * @param name The optional name of a user for the message.
+		 */
+		constructor(content: string, name?: string);
+	}
+
+	/**
+	 * A language model message that represents an assistant message, usually in response to a user message
+	 * or as a sample response/reply-pair.
+	 */
+	export class LanguageModelAssistantMessage {
+
+		/**
+		 * The content of this message.
+		 */
+		content: string;
+
+		/**
+		 * Create a new assistant message.
+		 *
+		 * @param content The content of the message.
+		 */
+		constructor(content: string);
+	}
+
+	export type LanguageModelMessage = LanguageModelSystemMessage | LanguageModelUserMessage | LanguageModelAssistantMessage;
+
+	/**
+	 * Represents access to using a language model. Access can be revoked at any time and extension
+	 * must check if the access is {@link LanguageModelAccess.isRevoked still valid} before using it.
+	 */
+	export interface LanguageModelAccess {
+
+		/**
+		 * Whether the access to the language model has been revoked.
+		 */
+		readonly isRevoked: boolean;
+
+		/**
+		 * An event that is fired when the access the language model has has been revoked or re-granted.
+		 */
+		// TODO@API NAME?
+		readonly onDidChangeAccess: Event<void>;
+
+		/**
+		 * The name of the model.
+		 *
+		 * It is expected that the model name can be used to lookup properties like token limits or what
+		 * `options` are available.
+		 */
+		readonly model: string;
+
+		/**
+		 * Make a request to the language model.
+		 *
+		 * *Note:* This will throw an error if access has been revoked.
+		 *
+		 * @param messages
+		 * @param options
+		 */
+		makeChatRequest(messages: LanguageModelMessage[], options: { [name: string]: any }, token: CancellationToken): LanguageModelResponse;
+	}
+
+	export interface LanguageModelAccessOptions {
+		/**
+		 * A human-readable message that explains why access to a language model is needed and what feature is enabled by it.
+		 */
+		justification?: string;
+	}
+
+	/**
+	 * An event describing the change in the set of available language models.
+	 */
+	export interface LanguageModelChangeEvent {
+		/**
+		 * Added language models.
+		 */
+		readonly added: readonly string[];
+		/**
+		 * Removed language models.
+		 */
+		readonly removed: readonly string[];
+	}
+
+	/**
+	 * Namespace for language model related functionality.
+	 */
+	export namespace lm {
+
+		/**
+		 * Request access to a language model.
+		 *
+		 * - *Note 1:* This function will throw an error when the user didn't grant access or when the
+		 * requested language model is not available.
+		 *
+		 * - *Note 2:* It is OK to hold on to the returned access object and use it later, but extensions
+		 * should check {@link LanguageModelAccess.isRevoked} before using it.
+		 *
+		 * @param id The id of the language model, see {@link languageModels} for valid values.
+		 * @returns A thenable that resolves to a language model access object, rejects if access wasn't granted
+		 */
+		export function requestLanguageModelAccess(id: string, options?: LanguageModelAccessOptions): Thenable<LanguageModelAccess>;
+
+		/**
+		 * 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>;
+	}
+}

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

@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/204345 @ulugbekna
+
+declare module 'vscode' {
+
+	export enum NewSymbolNameTag {
+		AIGenerated = 1
+	}
+
+	export class NewSymbolName {
+		readonly newSymbolName: string;
+		readonly tags?: readonly NewSymbolNameTag[];
+
+		constructor(newSymbolName: string, tags?: readonly NewSymbolNameTag[]);
+	}
+
+	export interface NewSymbolNamesProvider {
+		/**
+		 * Provide possible new names for the symbol at the given range.
+		 *
+		 * @param document The document in which the symbol is defined.
+		 * @param range The range that spans the symbol being renamed.
+		 * @param token A cancellation token.
+		 * @return A list of new symbol names.
+		 */
+		provideNewSymbolNames(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<NewSymbolName[]>;
+	}
+
+	export namespace languages {
+		export function registerNewSymbolNamesProvider(selector: DocumentSelector, provider: NewSymbolNamesProvider): Disposable;
+	}
+}

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

@@ -39,8 +39,14 @@ declare module 'vscode' {
 		*/
 		value: string;
 
+		/** The code that represents how the variable would be accessed in the runtime environment */
+		expression?: string;
+
 		/** The type of the variable's value */
 		type?: string;
+
+		/** The language of the variable's value */
+		language?: string;
 	}
 
 }

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

@@ -11,6 +11,9 @@ declare module 'vscode' {
 		/**
 		 * An optional flag to sort the final results by index of first query match in label. Defaults to true.
 		 */
+		// @API is a bug that we need this API at all. why do we change the sort order
+		// when extensions give us a (sorted) array of items?
+		// @API sortByLabel isn't a great name
 		sortByLabel: boolean;
 	}
 }

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

@@ -7,6 +7,10 @@ declare module 'vscode' {
 
 	// todo@bpasero work in progress speech API
 
+	export interface SpeechToTextOptions {
+		readonly language?: string;
+	}
+
 	export enum SpeechToTextStatus {
 		Started = 1,
 		Recognizing = 2,
@@ -38,7 +42,7 @@ declare module 'vscode' {
 	}
 
 	export interface SpeechProvider {
-		provideSpeechToTextSession(token: CancellationToken): SpeechToTextSession;
+		provideSpeechToTextSession(token: CancellationToken, options?: SpeechToTextOptions): SpeechToTextSession;
 		provideKeywordRecognitionSession(token: CancellationToken): KeywordRecognitionSession;
 	}
 

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

@@ -26,6 +26,9 @@ declare module 'vscode' {
 		 * @param token A cancellation token.
 		 * @return Coverage metadata for all files involved in the test.
 		 */
+		// @API - pass something into the provide method:
+		// (1) have TestController#coverageProvider: TestCoverageProvider
+		// (2) pass TestRun into this method
 		provideFileCoverage(token: CancellationToken): ProviderResult<T[]>;
 
 		/**
@@ -44,7 +47,7 @@ declare module 'vscode' {
 
 	/**
 	 * A class that contains information about a covered resource. A count can
-	 * be give for lines, branches, and functions in a file.
+	 * be give for lines, branches, and declarations in a file.
 	 */
 	export class CoveredCount {
 		/**
@@ -84,9 +87,10 @@ declare module 'vscode' {
 		branchCoverage?: CoveredCount;
 
 		/**
-		 * Function coverage information.
+		 * Declaration coverage information. Depending on the reporter and
+		 * language, this may be types such as functions, methods, or namespaces.
 		 */
-		functionCoverage?: CoveredCount;
+		declarationCoverage?: CoveredCount;
 
 		/**
 		 * Detailed, per-statement coverage. If this is undefined, the editor will
@@ -108,13 +112,13 @@ declare module 'vscode' {
 		 * does not provide statement coverage information, this can instead be
 		 * used to represent line coverage.
 		 * @param branchCoverage Branch coverage information
-		 * @param functionCoverage Function coverage information
+		 * @param declarationCoverage Declaration coverage information
 		 */
 		constructor(
 			uri: Uri,
 			statementCoverage: CoveredCount,
 			branchCoverage?: CoveredCount,
-			functionCoverage?: CoveredCount,
+			declarationCoverage?: CoveredCount,
 		);
 	}
 
@@ -123,10 +127,11 @@ declare module 'vscode' {
 	 */
 	export class StatementCoverage {
 		/**
-		 * The number of times this statement was executed. If zero, the
-		 * statement will be marked as un-covered.
+		 * The number of times this statement was executed, or a boolean indicating
+		 * whether it was executed if the exact count is unknown. If zero or false,
+		 * the statement will be marked as un-covered.
 		 */
-		executionCount: number;
+		executed: number | boolean;
 
 		/**
 		 * Statement location.
@@ -141,12 +146,13 @@ declare module 'vscode' {
 
 		/**
 		 * @param location The statement position.
-		 * @param executionCount The number of times this statement was
-		 * executed. If zero, the statement will be marked as un-covered.
+		 * @param executed The number of times this statement was executed, or a
+		 * boolean indicating  whether it was executed if the exact count is
+		 * unknown. If zero or false, the statement will be marked as un-covered.
 		 * @param branches Coverage from branches of this line.  If it's not a
 		 * conditional, this should be omitted.
 		 */
-		constructor(executionCount: number, location: Position | Range, branches?: BranchCoverage[]);
+		constructor(executed: number | boolean, location: Position | Range, branches?: BranchCoverage[]);
 	}
 
 	/**
@@ -154,10 +160,11 @@ declare module 'vscode' {
 	 */
 	export class BranchCoverage {
 		/**
-		 * The number of times this branch was executed. If zero, the
-		 * branch will be marked as un-covered.
+		 * The number of times this branch was executed, or a boolean indicating
+		 * whether it was executed if the exact count is unknown. If zero or false,
+		 * the branch will be marked as un-covered.
 		 */
-		executionCount: number;
+		executed: number | boolean;
 
 		/**
 		 * Branch location.
@@ -171,39 +178,45 @@ declare module 'vscode' {
 		label?: string;
 
 		/**
-		 * @param executionCount The number of times this branch was executed.
+		 * @param executed The number of times this branch was executed, or a
+		 * boolean indicating  whether it was executed if the exact count is
+		 * unknown. If zero or false, the branch will be marked as un-covered.
 		 * @param location The branch position.
 		 */
-		constructor(executionCount: number, location?: Position | Range, label?: string);
+		constructor(executed: number | boolean, location?: Position | Range, label?: string);
 	}
 
 	/**
-	 * Contains coverage information for a function or method.
+	 * Contains coverage information for a declaration. Depending on the reporter
+	 * and language, this may be types such as functions, methods, or namespaces.
 	 */
-	export class FunctionCoverage {
+	export class DeclarationCoverage {
 		/**
-		 * Name of the function or method.
+		 * Name of the declaration.
 		 */
 		name: string;
 
 		/**
-		 * The number of times this function was executed. If zero, the
-		 * function will be marked as un-covered.
+		 * The number of times this declaration was executed, or a boolean
+		 * indicating whether it was executed if the exact count is unknown. If
+		 * zero or false, the declaration will be marked as un-covered.
 		 */
-		executionCount: number;
+		executed: number | boolean;
 
 		/**
-		 * Function location.
+		 * Declaration location.
 		 */
 		location: Position | Range;
 
 		/**
-		 * @param executionCount The number of times this function was executed.
-		 * @param location The function position.
+		 * @param executed The number of times this declaration was executed, or a
+		 * boolean indicating  whether it was executed if the exact count is
+		 * unknown. If zero or false, the declaration will be marked as un-covered.
+		 * @param location The declaration position.
 		 */
-		constructor(name: string, executionCount: number, location: Position | Range);
+		constructor(name: string, executed: number | boolean, location: Position | Range);
 	}
 
-	export type DetailedCoverage = StatementCoverage | FunctionCoverage;
+	export type DetailedCoverage = StatementCoverage | DeclarationCoverage;
 
 }

package/vscode/src/vs/platform/audioCues/browser/audioCueService.d.ts

@@ -1,98 +0,0 @@
-import { ServiceIdentifier } from '../../instantiation/common/instantiation.js';
-import { IDisposable } from '../../../base/common/lifecycle.js';
-import { Event } from '../../../base/common/event.js';
-
-declare const IAudioCueService: ServiceIdentifier<IAudioCueService>;
-interface IAudioCueService {
-    readonly _serviceBrand: undefined;
-    playAudioCue(cue: AudioCue, options?: IAudioCueOptions): Promise<void>;
-    playAudioCues(cues: (AudioCue | {
-        cue: AudioCue;
-        source: string;
-    })[]): Promise<void>;
-    isCueEnabled(cue: AudioCue): boolean;
-    isAlertEnabled(cue: AudioCue): boolean;
-    onEnabledChanged(cue: AudioCue): Event<void>;
-    onAlertEnabledChanged(cue: AudioCue): Event<void>;
-    playSound(cue: Sound, allowManyInParallel?: boolean): Promise<void>;
-    playAudioCueLoop(cue: AudioCue, milliseconds: number): IDisposable;
-}
-interface IAudioCueOptions {
-    allowManyInParallel?: boolean;
-    source?: string;
-    /**
-     * For actions like save or format, depending on the
-     * configured value, we will only
-     * play the sound if the user triggered the action.
-     */
-    userGesture?: boolean;
-}
-/**
- * Corresponds to the audio files in ./media.
-*/
-declare class Sound {
-    readonly fileName: string;
-    private static register;
-    static readonly error: Sound;
-    static readonly warning: Sound;
-    static readonly foldedArea: Sound;
-    static readonly break: Sound;
-    static readonly quickFixes: Sound;
-    static readonly taskCompleted: Sound;
-    static readonly taskFailed: Sound;
-    static readonly terminalBell: Sound;
-    static readonly diffLineInserted: Sound;
-    static readonly diffLineDeleted: Sound;
-    static readonly diffLineModified: Sound;
-    static readonly chatRequestSent: Sound;
-    static readonly chatResponsePending: Sound;
-    static readonly chatResponseReceived1: Sound;
-    static readonly chatResponseReceived2: Sound;
-    static readonly chatResponseReceived3: Sound;
-    static readonly chatResponseReceived4: Sound;
-    static readonly clear: Sound;
-    static readonly save: Sound;
-    static readonly format: Sound;
-    private constructor();
-}
-declare class SoundSource {
-    readonly randomOneOf: Sound[];
-    constructor(randomOneOf: Sound[]);
-    getSound(deterministic?: boolean): Sound;
-}
-declare class AudioCue {
-    readonly sound: SoundSource;
-    readonly name: string;
-    readonly settingsKey: string;
-    readonly alertSettingsKey?: string | undefined;
-    readonly alertMessage?: string | undefined;
-    private static _audioCues;
-    private static register;
-    static get allAudioCues(): AudioCue[];
-    static readonly error: AudioCue;
-    static readonly warning: AudioCue;
-    static readonly foldedArea: AudioCue;
-    static readonly break: AudioCue;
-    static readonly inlineSuggestion: AudioCue;
-    static readonly terminalQuickFix: AudioCue;
-    static readonly onDebugBreak: AudioCue;
-    static readonly noInlayHints: AudioCue;
-    static readonly taskCompleted: AudioCue;
-    static readonly taskFailed: AudioCue;
-    static readonly terminalCommandFailed: AudioCue;
-    static readonly terminalBell: AudioCue;
-    static readonly notebookCellCompleted: AudioCue;
-    static readonly notebookCellFailed: AudioCue;
-    static readonly diffLineInserted: AudioCue;
-    static readonly diffLineDeleted: AudioCue;
-    static readonly diffLineModified: AudioCue;
-    static readonly chatRequestSent: AudioCue;
-    static readonly chatResponseReceived: AudioCue;
-    static readonly chatResponsePending: AudioCue;
-    static readonly clear: AudioCue;
-    static readonly save: AudioCue;
-    static readonly format: AudioCue;
-    private constructor();
-}
-
-export { AudioCue, type IAudioCueOptions, IAudioCueService, Sound, SoundSource };