@vscode/chat-lib 0.0.1

package/src/_internal/extension/vscode.proposed.commentReveal.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/167253
+
+	/**
+	 * Options to reveal a comment thread in an editor.
+	 */
+	export interface CommentThreadRevealOptions {
+		/**
+		 * By default, the comment thread will be focused. Set `preserveFocus` to `true` to maintain the original focus.
+		 */
+		preserveFocus?: boolean;
+
+		/**
+		 * Focus the comment thread reply editor, if the thread supports replying.
+		 */
+		focusReply?: boolean;
+	}
+
+	export interface CommentThread {
+		/**
+		 * Reveal the comment thread in an editor.
+		 */
+		reveal(options?: CommentThreadRevealOptions): Thenable<void>;
+	}
+
+}

package/src/_internal/extension/vscode.proposed.contribCommentThreadAdditionalMenu.d.ts

@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// empty placeholder for comment thread additional menus
+
+// https://github.com/microsoft/vscode/issues/163281

package/src/_internal/extension/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/src/_internal/extension/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/src/_internal/extension/vscode.proposed.dataChannels.d.ts

@@ -0,0 +1,19 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 namespace env {
+		export function getDataChannel<T>(channelId: string): DataChannel<T>;
+	}
+
+	export interface DataChannel<T = unknown> {
+		onDidReceiveData: Event<DataChannelEvent<T>>;
+	}
+
+	export interface DataChannelEvent<T> {
+		data: T;
+	}
+}

package/src/_internal/extension/vscode.proposed.defaultChatParticipant.d.ts

@@ -0,0 +1,52 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// version: 4
+
+declare module 'vscode' {
+
+	export interface ChatWelcomeMessageContent {
+		icon: ThemeIcon;
+		title: string;
+		message: MarkdownString;
+	}
+
+	export interface ChatRequesterInformation {
+		name: string;
+
+		/**
+		 * A full URI for the icon of the request.
+		 */
+		icon?: Uri;
+	}
+
+	export interface ChatTitleProvider {
+		/**
+		 * TODO@API Should this take a ChatResult like the followup provider, or just take a new ChatContext that includes the current message as history?
+		 */
+		provideChatTitle(context: ChatContext, token: CancellationToken): ProviderResult<string>;
+	}
+
+	export interface ChatSummarizer {
+		provideChatSummary(context: ChatContext, token: CancellationToken): ProviderResult<string>;
+	}
+
+	export interface ChatParticipant {
+		/**
+		 * A string that will be added before the listing of chat participants in `/help`.
+		 */
+		helpTextPrefix?: string | MarkdownString;
+
+		/**
+		 * A string that will be appended after the listing of chat participants in `/help`.
+		 */
+		helpTextPostfix?: string | MarkdownString;
+
+		additionalWelcomeMessage?: string | MarkdownString;
+		titleProvider?: ChatTitleProvider;
+		summarizer?: ChatSummarizer;
+		requester?: ChatRequesterInformation;
+	}
+}

package/src/_internal/extension/vscode.proposed.documentFiltersExclusive.d.ts

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// todo@jrieken add issue reference
+
+	export interface DocumentFilter {
+		readonly exclusive?: boolean;
+	}
+}

package/src/_internal/extension/vscode.proposed.embeddings.d.ts

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// https://github.com/microsoft/vscode/issues/212083
+
+	export interface Embedding {
+		readonly values: number[];
+	}
+
+	// TODO@API strictly not the right namespace...
+	export namespace lm {
+
+		export const embeddingModels: string[];
+
+		export const onDidChangeEmbeddingModels: Event<void>;
+
+		export function computeEmbeddings(embeddingsModel: string, input: string, token?: CancellationToken): Thenable<Embedding>;
+
+		export function computeEmbeddings(embeddingsModel: string, input: string[], token?: CancellationToken): Thenable<Embedding[]>;
+	}
+
+	export interface EmbeddingsProvider {
+		provideEmbeddings(input: string[], token: CancellationToken): ProviderResult<Embedding[]>;
+	}
+
+	export namespace lm {
+		export function registerEmbeddingsProvider(embeddingsModel: string, provider: EmbeddingsProvider): Disposable;
+	}
+}

package/src/_internal/extension/vscode.proposed.extensionsAny.d.ts

@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// https://github.com/microsoft/vscode/issues/145307 @alexdima
+
+	export interface Extension<T> {
+
+		/**
+		 * `true` when the extension is associated to another extension host.
+		 *
+		 * *Note* that an extension from another extension host cannot export
+		 * API, e.g {@link Extension.exports its exports} are always `undefined`.
+		 */
+		readonly isFromDifferentExtensionHost: boolean;
+	}
+
+	export namespace extensions {
+
+		/**
+		 * Get an extension by its full identifier in the form of: `publisher.name`.
+		 *
+		 * @param extensionId An extension identifier.
+		 * @param includeDifferentExtensionHosts Include extensions from different extension host
+		 * @return An extension or `undefined`.
+		 */
+		export function getExtension<T = any>(extensionId: string, includeDifferentExtensionHosts: boolean): Extension<T> | undefined;
+
+		/**
+		 * All extensions across all extension hosts.
+		 *
+		 * @see {@link Extension.isFromDifferentExtensionHost}
+		 */
+		export const allAcrossExtensionHosts: readonly Extension<void>[];
+
+	}
+}

package/src/_internal/extension/vscode.proposed.findFiles2.d.ts

@@ -0,0 +1,125 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// version: 2
+
+declare module 'vscode' {
+
+	export interface FindFiles2Options {
+		/**
+		 * An array of {@link GlobPattern GlobPattern} that defines files to exclude.
+		 * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern.baseUri} if applicable.
+		 *
+		 * If more than one value is used, the values are combined with a logical AND.
+		 * For example, consider the following code:
+		 *
+		 * ```ts
+		 * const ab = findFiles(['**​/*.js'], {exclude: ['*.ts', '*.js']});
+		 * const a = findFiles(['**​/*.js'], {exclude: ['*.ts']});
+		 * const b = findFiles(['**​/*.js'], {exclude: ['*.js']});
+		 * ```
+		 *
+		 * In this, `ab` will be the intersection of results from `a` and `b`.
+		 */
+		exclude?: GlobPattern[];
+
+		/**
+		 * Which settings to follow when searching for files. Defaults to {@link ExcludeSettingOptions.searchAndFilesExclude}.
+		 */
+		useExcludeSettings?: ExcludeSettingOptions;
+
+		/**
+		 * The maximum number of results to search for. Defaults to 20000 results.
+		 */
+		maxResults?: number;
+
+		/**
+		 * Which file locations have ignore (`.gitignore` or `.ignore`) files to follow.
+		 *
+		 * When any of these fields are `undefined`, the value will either be assumed (e.g. if only one is valid),
+		 * or it will follow settings based on the corresponding `search.use*IgnoreFiles` setting.
+		 *
+		 * Will log an error if an invalid combination is set.
+		 *
+		 * Although `.ignore` files are uncommon, they can be leveraged if there are patterns
+		 * that should not be known to git, but should be known to the search providers.
+		 * They should be in the same locations where `.gitignore` files are found, and they follow the same format.
+		 */
+		useIgnoreFiles?: {
+			/**
+			 * Use ignore files at the current workspace root.
+			 * May default to `search.useIgnoreFiles` setting if not set.
+			 */
+			local?: boolean;
+			/**
+			 * Use ignore files at the parent directory. When set to `true`, {@link FindFiles2Options.useIgnoreFiles.local} must also be `true`.
+			 * May default to `search.useParentIgnoreFiles` setting if not set.
+			 */
+			parent?: boolean;
+			/**
+			 * Use global ignore files. When set to `true`, {@link FindFiles2Options.useIgnoreFiles.local} must also be `true`.
+			 * May default to `search.useGlobalIgnoreFiles` setting if not set.
+			 */
+			global?: boolean;
+		};
+
+		/**
+		 * Whether symlinks should be followed while searching.
+		 * Defaults to the value for `search.followSymlinks` in settings.
+		 * For more info, see the setting description for `search.followSymlinks`.
+		 */
+		followSymlinks?: boolean;
+	}
+
+	/**
+	 * Options for following search.exclude and files.exclude settings.
+	 */
+	export enum ExcludeSettingOptions {
+		/**
+		 * Don't use any exclude settings.
+		 */
+		None = 1,
+		/**
+		 * Use the `files.exclude` setting
+		 */
+		FilesExclude = 2,
+		/**
+		 * Use the `files.exclude` and `search.exclude` settings
+		 */
+		SearchAndFilesExclude = 3
+	}
+
+	export namespace workspace {
+		/**
+		 * WARNING: VERY EXPERIMENTAL.
+		 *
+		 * Find files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
+		 *
+		 * @example
+		 * findFiles(['**​/*.js'], {exclude: ['**​/out/**'], useIgnoreFiles: true, maxResults: 10})
+		 *
+		 * @param filePattern An array of {@link GlobPattern GlobPattern} that defines the files to search for.
+		 * The glob patterns will be matched against the file paths of files relative to their workspace or {@link baseUri GlobPattern.baseUri} if applicable.
+		 * Use a {@link RelativePattern RelativePatten} to restrict the search results to a {@link WorkspaceFolder workspace folder}.
+		 *
+		 * If more than one value is used, the values are combined with a logical OR.
+		 *
+		 * For example, consider the following code:
+		 *
+		 * ```ts
+		 * const ab = findFiles(['*.ts', '*.js']);
+		 * const a = findFiles(['**​/*.ts']);
+		 * const b = findFiles(['**​/*.js']);
+		 * ```
+		 *
+		 * In this, `ab` will be the union of results from `a` and `b`.
+		 * @param options A set of {@link FindFiles2Options FindFiles2Options} that defines where and how to search (e.g. exclude settings).
+		 * @param token A token that can be used to signal cancellation to the underlying search engine.
+		 * @returns A thenable that resolves to an array of resource identifiers. Will return no results if no
+		 * {@link workspace.workspaceFolders workspace folders} are opened.
+		 */
+		export function findFiles2(filePattern: GlobPattern[], options?: FindFiles2Options, token?: CancellationToken): Thenable<Uri[]>;
+	}
+}

package/src/_internal/extension/vscode.proposed.findTextInFiles.d.ts

@@ -0,0 +1,104 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// https://github.com/microsoft/vscode/issues/59924
+
+	/**
+	 * Options that can be set on a findTextInFiles search.
+	 */
+	export interface FindTextInFilesOptions {
+		/**
+		 * A {@link GlobPattern glob pattern} that defines the files to search for. The glob pattern
+		 * will be matched against the file paths of files relative to their workspace. Use a {@link RelativePattern relative pattern}
+		 * to restrict the search results to a {@link WorkspaceFolder workspace folder}.
+		 */
+		include?: GlobPattern;
+
+		/**
+		 * A {@link GlobPattern glob pattern} that defines files and folders to exclude. The glob pattern
+		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined`, default excludes will
+		 * apply.
+		 */
+		exclude?: GlobPattern;
+
+		/**
+		 * Whether to use the default and user-configured excludes. Defaults to true.
+		 */
+		useDefaultExcludes?: boolean;
+
+		/**
+		 * The maximum number of results to search for
+		 */
+		maxResults?: number;
+
+		/**
+		 * Whether external files that exclude files, like .gitignore, should be respected.
+		 * See the vscode setting `"search.useIgnoreFiles"`.
+		 */
+		useIgnoreFiles?: boolean;
+
+		/**
+		 * Whether global files that exclude files, like .gitignore, should be respected.
+		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
+		 */
+		useGlobalIgnoreFiles?: boolean;
+
+		/**
+		 * Whether files in parent directories that exclude files, like .gitignore, should be respected.
+		 * See the vscode setting `"search.useParentIgnoreFiles"`.
+		 */
+		useParentIgnoreFiles?: boolean;
+
+		/**
+		 * Whether symlinks should be followed while searching.
+		 * See the vscode setting `"search.followSymlinks"`.
+		 */
+		followSymlinks?: boolean;
+
+		/**
+		 * Interpret files using this encoding.
+		 * See the vscode setting `"files.encoding"`
+		 */
+		encoding?: string;
+
+		/**
+		 * Options to specify the size of the result text preview.
+		 */
+		previewOptions?: TextSearchPreviewOptions;
+
+		/**
+		 * Number of lines of context to include before each match.
+		 */
+		beforeContext?: number;
+
+		/**
+		 * Number of lines of context to include after each match.
+		 */
+		afterContext?: number;
+	}
+
+	export namespace workspace {
+		/**
+		 * Search text in files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
+		 * @param query The query parameters for the search - the search string, whether it's case-sensitive, or a regex, or matches whole words.
+		 * @param callback A callback, called for each result
+		 * @param token A token that can be used to signal cancellation to the underlying search engine.
+		 * @return A thenable that resolves when the search is complete.
+		 */
+		export function findTextInFiles(query: TextSearchQuery, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
+
+		/**
+		 * Search text in files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
+		 * @param query The query parameters for the search - the search string, whether it's case-sensitive, or a regex, or matches whole words.
+		 * @param options An optional set of query options. Include and exclude patterns, maxResults, etc.
+		 * @param callback A callback, called for each result
+		 * @param token A token that can be used to signal cancellation to the underlying search engine.
+		 * @return A thenable that resolves when the search is complete.
+		 */
+		export function findTextInFiles(query: TextSearchQuery, options: FindTextInFilesOptions, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
+	}
+}

package/src/_internal/extension/vscode.proposed.findTextInFiles2.d.ts

@@ -0,0 +1,144 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// https://github.com/microsoft/vscode/issues/59924
+
+	export interface FindTextInFilesOptions2 {
+		/**
+		 * An array of {@link GlobPattern} that defines the files to search for.
+		 * The glob patterns will be matched against the file paths of files relative to their workspace or {@link GlobPattern}'s `baseUri` if applicable.
+		 * Use a {@link RelativePattern} to restrict the search results to a {@link WorkspaceFolder workspace folder}.
+		 *
+		 * If more than one value is used, the values are combined with a logical OR.
+		 *
+		 * For example, consider the following code:
+		 *
+		 * ```ts
+		 * const ab = findTextInFiles2('foo', {include: ['*.ts', '*.js']});
+		 * const a = findTextInFiles2('foo', {include: ['*.ts']});
+		 * const b = findTextInFiles2('foo', {include: ['*.js']});
+		 * ```
+		 *
+		 * In this, `ab` will be the union of results from `a` and `b`.
+		 */
+		include?: GlobPattern[];
+
+		/**
+		 * An array of {@link GlobPattern} that defines files to exclude.
+		 * The glob patterns will be matched against the file paths of files relative to their workspace or {@link RelativePattern}'s `baseUri` if applicable.
+		 *
+		 * If more than one value is used, the values are combined with a logical AND.
+		 * For example, consider the following code:
+		 *
+		 * ```ts
+		 * const ab = findTextInFiles2('foo', {exclude: ['*.ts', '*.js']});
+		 * const a = findTextInFiles2('foo', {exclude: ['*.ts']});
+		 * const b = findTextInFiles2('foo', {exclude: ['*.js']});
+		 * ```
+		 *
+		 * In this, `ab` will be the intersection of results from `a` and `b`.
+		 */
+		exclude?: GlobPattern[];
+
+		/**
+		 * Which settings to follow when searching for files. Defaults to `ExcludeSettingOptions.searchAndFilesExclude`.
+		 */
+		useExcludeSettings?: ExcludeSettingOptions;
+
+		/**
+		 * The maximum number of results to search for. Defaults to 20000 results.
+		 */
+		maxResults?: number;
+
+		/**
+		 * Which file locations have ignore (`.gitignore` or `.ignore`) files to follow.
+		 *
+		 * When any of these fields are `undefined`, the value will either be assumed (e.g. if only one is valid),
+		 * or it will follow settings based on the corresponding `search.use*IgnoreFiles` setting.
+		 *
+		 * Will log an error if an invalid combination is set.
+		 *
+		 * Although `.ignore` files are uncommon, they can be leveraged if there are patterns
+		 * that should not be known to git, but should be known to the search providers.
+		 * They should be in the same locations where `.gitignore` files are found, and they follow the same format.
+		 */
+		useIgnoreFiles?: {
+			/**
+			 * Use ignore files at the current workspace root.
+			 * May default to `search.useIgnoreFiles` setting if not set.
+			 */
+			local?: boolean;
+			/**
+			 * Use ignore files at the parent directory. When set to `true`, `local` in {@link FindTextInFilesOptions2.useIgnoreFiles} must be `true`.
+			 * May default to `search.useParentIgnoreFiles` setting if not set.
+			 */
+			parent?: boolean;
+			/**
+			 * Use global ignore files. When set to `true`, `local` in {@link FindTextInFilesOptions2.useIgnoreFiles} must also be `true`.
+			 * May default to `search.useGlobalIgnoreFiles` setting if not set.
+			 */
+			global?: boolean;
+		};
+
+		/**
+		 * Whether symlinks should be followed while searching.
+		 * Defaults to the value for `search.followSymlinks` in settings.
+		 * For more info, see the setting description for `search.followSymlinks`.
+		 */
+		followSymlinks?: boolean;
+
+		/**
+		 * Interpret files using this encoding.
+		 * See the vscode setting `"files.encoding"`
+		 */
+		encoding?: string;
+
+		/**
+		 * Options to specify the size of the result text preview.
+		 */
+		previewOptions?: {
+			/**
+			 * The maximum number of lines in the preview of the match itself (not including surrounding context lines).
+			 * Only search providers that support multiline search will ever return more than one line in the match.
+			 */
+			numMatchLines?: number;
+
+			/**
+			 * The maximum number of characters included per line.
+			 */
+			charsPerLine?: number;
+		};
+
+		/**
+		 * Number of lines of context to include before and after each match.
+		 */
+		surroundingContext?: number;
+	}
+
+	export interface FindTextInFilesResponse {
+		/**
+		 * The results of the text search, in batches. To get completion information, wait on the `complete` property.
+		 */
+		results: AsyncIterable<TextSearchResult2>;
+		/**
+		 * The text search completion information. This resolves on completion.
+		 */
+		complete: Thenable<TextSearchComplete2>;
+	}
+
+	export namespace workspace {
+		/**
+		 * Search text in files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
+		 * @param query The query parameters for the search - the search string, whether it's case-sensitive, or a regex, or matches whole words.
+		 * @param options An optional set of query options.
+		 * @param callback A callback, called for each {@link TextSearchResult2 result}. This can be a direct match, or context that surrounds a match.
+		 * @param token A token that can be used to signal cancellation to the underlying search engine.
+		 * @return A thenable that resolves when the search is complete.
+		 */
+		export function findTextInFiles2(query: TextSearchQuery2, options?: FindTextInFilesOptions2, token?: CancellationToken): FindTextInFilesResponse;
+	}
+}