@vscode/chat-lib 0.0.1 → 0.0.2

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

@@ -1,276 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-// version: 10
-
-declare module 'vscode' {
-
-	/**
-	 * The location at which the chat is happening.
-	 */
-	export enum ChatLocation {
-		/**
-		 * The chat panel
-		 */
-		Panel = 1,
-		/**
-		 * Terminal inline chat
-		 */
-		Terminal = 2,
-		/**
-		 * Notebook inline chat
-		 */
-		Notebook = 3,
-		/**
-		 * Code editor inline chat
-		 */
-		Editor = 4,
-	}
-
-	export class ChatRequestEditorData {
-		//TODO@API should be the editor
-		document: TextDocument;
-		selection: Selection;
-		wholeRange: Range;
-
-		constructor(document: TextDocument, selection: Selection, wholeRange: Range);
-	}
-
-	export class ChatRequestNotebookData {
-		//TODO@API should be the editor
-		readonly cell: TextDocument;
-
-		constructor(cell: TextDocument);
-	}
-
-	export interface ChatRequest {
-		/**
-		 * The id of the chat request. Used to identity an interaction with any of the chat surfaces.
-		 */
-		readonly id: string;
-		/**
-		 * The attempt number of the request. The first request has attempt number 0.
-		 */
-		readonly attempt: number;
-
-		/**
-		 * If automatic command detection is enabled.
-		 */
-		readonly enableCommandDetection: boolean;
-
-		/**
-		 * If the chat participant or command was automatically assigned.
-		 */
-		readonly isParticipantDetected: boolean;
-
-		/**
-		 * The location at which the chat is happening. This will always be one of the supported values
-		 *
-		 * @deprecated
-		 */
-		readonly location: ChatLocation;
-
-		/**
-		 * Information that is specific to the location at which chat is happening, e.g within a document, notebook,
-		 * or terminal. Will be `undefined` for the chat panel.
-		 */
-		readonly location2: ChatRequestEditorData | ChatRequestNotebookData | undefined;
-
-		/**
-		 * Events for edited files in this session collected since the last request.
-		 */
-		readonly editedFileEvents?: ChatRequestEditedFileEvent[];
-	}
-
-	export enum ChatRequestEditedFileEventKind {
-		Keep = 1,
-		Undo = 2,
-		UserModification = 3,
-	}
-
-	export interface ChatRequestEditedFileEvent {
-		readonly uri: Uri;
-		readonly eventKind: ChatRequestEditedFileEventKind;
-	}
-
-	/**
-	 * ChatRequestTurn + private additions. Note- at runtime this is the SAME as ChatRequestTurn and instanceof is safe.
-	 */
-	export class ChatRequestTurn2 {
-		/**
-		 * The prompt as entered by the user.
-		 *
-		 * Information about references used in this request is stored in {@link ChatRequestTurn.references}.
-		 *
-		 * *Note* that the {@link ChatParticipant.name name} of the participant and the {@link ChatCommand.name command}
-		 * are not part of the prompt.
-		 */
-		readonly prompt: string;
-
-		/**
-		 * The id of the chat participant to which this request was directed.
-		 */
-		readonly participant: string;
-
-		/**
-		 * The name of the {@link ChatCommand command} that was selected for this request.
-		 */
-		readonly command?: string;
-
-		/**
-		 * The references that were used in this message.
-		 */
-		readonly references: ChatPromptReference[];
-
-		/**
-		 * The list of tools were attached to this request.
-		 */
-		readonly toolReferences: readonly ChatLanguageModelToolReference[];
-
-		/**
-		 * Events for edited files in this session collected between the previous request and this one.
-		 */
-		readonly editedFileEvents?: ChatRequestEditedFileEvent[];
-
-		/**
-		 * @hidden
-		 */
-		constructor(prompt: string, command: string | undefined, references: ChatPromptReference[], participant: string, toolReferences: ChatLanguageModelToolReference[], editedFileEvents: ChatRequestEditedFileEvent[] | undefined);
-	}
-
-	export class ChatResponseTurn2 {
-		/**
-		 * The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
-		 */
-		readonly response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart | ExtendedChatResponsePart | ChatToolInvocationPart>;
-
-		/**
-		 * The result that was received from the chat participant.
-		 */
-		readonly result: ChatResult;
-
-		/**
-		 * The id of the chat participant that this response came from.
-		 */
-		readonly participant: string;
-
-		/**
-		 * The name of the command that this response came from.
-		 */
-		readonly command?: string;
-
-		constructor(response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart | ExtendedChatResponsePart>, result: ChatResult, participant: string);
-	}
-
-	export interface ChatParticipant {
-		supportIssueReporting?: boolean;
-	}
-
-	export enum ChatErrorLevel {
-		Info = 0,
-		Warning = 1,
-		Error = 2,
-	}
-
-	export interface ChatErrorDetails {
-		/**
-		 * If set to true, the message content is completely hidden. Only ChatErrorDetails#message will be shown.
-		 */
-		responseIsRedacted?: boolean;
-
-		isQuotaExceeded?: boolean;
-
-		level?: ChatErrorLevel;
-
-		code?: string;
-	}
-
-	export namespace chat {
-		export function createDynamicChatParticipant(id: string, dynamicProps: DynamicChatParticipantProps, handler: ChatExtendedRequestHandler): ChatParticipant;
-	}
-
-	/**
-	 * These don't get set on the ChatParticipant after creation, like other props, because they are typically defined in package.json and we want them at the time of creation.
-	 */
-	export interface DynamicChatParticipantProps {
-		name: string;
-		publisherName: string;
-		description?: string;
-		fullName?: string;
-	}
-
-	export namespace lm {
-		export function registerIgnoredFileProvider(provider: LanguageModelIgnoredFileProvider): Disposable;
-	}
-
-	export interface LanguageModelIgnoredFileProvider {
-		provideFileIgnored(uri: Uri, token: CancellationToken): ProviderResult<boolean>;
-	}
-
-	export interface LanguageModelToolInvocationOptions<T> {
-		chatRequestId?: string;
-		chatSessionId?: string;
-		chatInteractionId?: string;
-		terminalCommand?: string;
-	}
-
-	export interface LanguageModelToolInvocationPrepareOptions<T> {
-		/**
-		 * The input that the tool is being invoked with.
-		 */
-		input: T;
-		chatRequestId?: string;
-		chatSessionId?: string;
-		chatInteractionId?: string;
-	}
-
-	export interface PreparedToolInvocation {
-		pastTenseMessage?: string | MarkdownString;
-		presentation?: 'hidden' | undefined;
-	}
-
-	export class ExtendedLanguageModelToolResult extends LanguageModelToolResult {
-		toolResultMessage?: string | MarkdownString;
-		toolResultDetails?: Array<Uri | Location>;
-	}
-
-	// #region Chat participant detection
-
-	export interface ChatParticipantMetadata {
-		participant: string;
-		command?: string;
-		disambiguation: { category: string; description: string; examples: string[] }[];
-	}
-
-	export interface ChatParticipantDetectionResult {
-		participant: string;
-		command?: string;
-	}
-
-	export interface ChatParticipantDetectionProvider {
-		provideParticipantDetection(chatRequest: ChatRequest, context: ChatContext, options: { participants?: ChatParticipantMetadata[]; location: ChatLocation }, token: CancellationToken): ProviderResult<ChatParticipantDetectionResult>;
-	}
-
-	export namespace chat {
-		export function registerChatParticipantDetectionProvider(participantDetectionProvider: ChatParticipantDetectionProvider): Disposable;
-
-		export const onDidDisposeChatSession: Event<string>;
-	}
-
-	// #endregion
-
-	// #region ChatErrorDetailsWithConfirmation
-
-	export interface ChatErrorDetails {
-		confirmationButtons?: ChatErrorDetailsConfirmationButton[];
-	}
-
-	export interface ChatErrorDetailsConfirmationButton {
-		data: any;
-		label: string;
-	}
-
-	// #endregion
-}

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

@@ -1,62 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-// version: 3
-
-declare module 'vscode' {
-
-	/**
-	* The provider version of {@linkcode LanguageModelChatRequestOptions}
-	*/
-	export interface LanguageModelChatRequestHandleOptions {
-
-		/**
-		 * What extension initiated the request to the language model
-		 */
-		readonly requestInitiator: string;
-	}
-
-	/**
-	 * All the information representing a single language model contributed by a {@linkcode LanguageModelChatProvider}.
-	 */
-	export interface LanguageModelChatInformation {
-
-		/**
-		 * When present, this gates the use of `requestLanguageModelAccess` behind an authorization flow where
-		 * the user must approve of another extension accessing the models contributed by this extension.
-		 * Additionally, the extension can provide a label that will be shown in the UI.
-		 * A common example of a label is an account name that is signed in.
-		 *
-		 */
-		requiresAuthorization?: true | { label: string };
-
-		/**
-		 * Whether or not this will be selected by default in the model picker
-		 * NOT BEING FINALIZED
-		 */
-		readonly isDefault?: boolean;
-
-		/**
-		 * Whether or not the model will show up in the model picker immediately upon being made known via {@linkcode LanguageModelChatProvider.prepareLanguageModelChatInformation}.
-		 * NOT BEING FINALIZED
-		 */
-		readonly isUserSelectable?: boolean;
-
-		/**
-		 * Optional category to group models by in the model picker.
-		 * The lower the order, the higher the category appears in the list.
-		 * Has no effect if `isUserSelectable` is `false`.
-		 *
-		 * WONT BE FINALIZED
-		 */
-		readonly category?: { label: string; order: number };
-	}
-
-	export type LanguageModelResponsePart2 = LanguageModelResponsePart | LanguageModelDataPart | LanguageModelThinkingPart;
-
-	export interface LanguageModelChatProvider<T extends LanguageModelChatInformation = LanguageModelChatInformation> {
-		provideLanguageModelChatResponse(model: T, messages: readonly LanguageModelChatRequestMessage[], options: LanguageModelChatRequestHandleOptions, progress: Progress<LanguageModelResponsePart2>, token: CancellationToken): Thenable<void>;
-	}
-}

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

@@ -1,17 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  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 ChatPromptReference {
-		/**
-		 * When true, the user has indicated at the reference is informational only.
-		 * The model should avoid changing or suggesting changes to the reference.
-		 */
-		readonly isReadonly?: boolean;
-	}
-
-}

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

@@ -1,23 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  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 ChatPromptReference {
-		/**
-		 * The value of this reference. The `string | Uri | Location` types are used today, but this could expand in the future.
-		 */
-		readonly value: string | Uri | Location | DiagnosticCollection | unknown;
-	}
-
-	export class ChatReferenceDiagnostic {
-		/**
-		 * All attached diagnostics. An array of uri-diagnostics tuples or an empty array.
-		 */
-		readonly diagnostics: [Uri, Diagnostic[]][];
-
-		protected constructor(diagnostics: [Uri, Diagnostic[]][]);
-	}
-}

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

@@ -1,218 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  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 the status of a chat session.
-	 */
-	export enum ChatSessionStatus {
-		/**
-		 * The chat session failed to complete.
-		 */
-		Failed = 0,
-
-		/**
-		 * The chat session completed successfully.
-		 */
-		Completed = 1,
-
-		/**
-		 * The chat session is currently in progress.
-		 */
-		InProgress = 2
-	}
-
-	/**
-	 * Provides a list of information about chat sessions.
-	 */
-	export interface ChatSessionItemProvider {
-		/**
-		 * Event that the provider can fire to signal that chat sessions have changed.
-		 */
-		readonly onDidChangeChatSessionItems: Event<void>;
-
-		/**
-		 * Creates a new chat session.
-		 *
-		 * @param options Options for the new session including an optional initial prompt and history
-		 * @param token A cancellation token
-		 * @returns Metadata for the chat session
-		 */
-		provideNewChatSessionItem?(options: {
-			/**
-			 * The chat request that initiated the session creation
-			 */
-			readonly request: ChatRequest;
-
-			/**
-			 * Initial prompt to initiate the session
-			 */
-			readonly prompt?: string;
-
-			/**
-			 * History to initialize the session with
-			 */
-			readonly history?: ReadonlyArray<ChatRequestTurn | ChatResponseTurn>;
-
-			/**
-			 * Additional metadata to use for session creation
-			 */
-			metadata?: any;
-		}, token: CancellationToken): ProviderResult<ChatSessionItem>;
-
-		/**
-		 * Provides a list of chat sessions.
-		 */
-		// TODO: Do we need a flag to try auth if needed?
-		provideChatSessionItems(token: CancellationToken): ProviderResult<ChatSessionItem[]>;
-	}
-
-	export interface ChatSessionItem {
-		/**
-		 * Unique identifier for the chat session.
-		 */
-		id: string;
-
-		/**
-		 * Human readable name of the session shown in the UI
-		 */
-		label: string;
-
-		/**
-		 * An icon for the participant shown in UI.
-		 */
-		iconPath?: IconPath;
-
-		/**
-		 * An optional description that provides additional context about the chat session.
-		 */
-		description?: string | MarkdownString;
-
-		/**
-		 * An optional status indicating the current state of the session.
-		 */
-		status?: ChatSessionStatus;
-
-		/**
-		 * The tooltip text when you hover over this item.
-		 */
-		tooltip?: string | MarkdownString;
-
-		/**
-		 * The times at which session started and ended
-		 */
-		timing?: {
-			/**
-			 * Session start timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
-			 */
-			startTime: number;
-			/**
-			 * Session end timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
-			 */
-			endTime?: number;
-		};
-
-		/**
-		 * Statistics about the chat session.
-		 */
-		statistics?: {
-			/**
-			 * Number of insertions made during the session.
-			 */
-			insertions: number;
-
-			/**
-			 * Number of deletions made during the session.
-			 */
-			deletions: number;
-		};
-	}
-
-	export interface ChatSession {
-		/**
-		 * The full history of the session
-		 *
-		 * This should not include any currently active responses
-		 */
-		// TODO: Are these the right types to use?
-		// TODO: link request + response to encourage correct usage?
-		readonly history: ReadonlyArray<ChatRequestTurn | ChatResponseTurn2>;
-
-		/**
-		 * Callback invoked by the editor for a currently running response. This allows the session to push items for the
-		 * current response and stream these in as them come in. The current response will be considered complete once the
-		 * callback resolved.
-		 *
-		 * If not provided, the chat session is assumed to not currently be running.
-		 */
-		readonly activeResponseCallback?: (stream: ChatResponseStream, token: CancellationToken) => Thenable<void>;
-
-		/**
-		 * Handles new request for the session.
-		 *
-		 * If not set, then the session will be considered read-only and no requests can be made.
-		 */
-		// TODO: Should we introduce our own type for `ChatRequestHandler` since not all field apply to chat sessions?
-		// TODO: Revisit this to align with code.
-		readonly requestHandler: ChatRequestHandler | undefined;
-	}
-
-	export interface ChatSessionContentProvider {
-		/**
-		 * Resolves a chat session into a full `ChatSession` object.
-		 *
-		 * @param sessionId The id of the chat session to open.
-		 * @param token A cancellation token that can be used to cancel the operation.
-		 */
-		provideChatSessionContent(sessionId: string, token: CancellationToken): Thenable<ChatSession> | ChatSession;
-	}
-
-	export namespace chat {
-		/**
-		 * Registers a new {@link ChatSessionItemProvider chat session item provider}.
-		 *
-		 * To use this, also make sure to also add `chatSessions` contribution in the `package.json`.
-		 *
-		 * @param chatSessionType The type of chat session the provider is for.
-		 * @param provider The provider to register.
-		 *
-		 * @returns A disposable that unregisters the provider when disposed.
-		 */
-		export function registerChatSessionItemProvider(chatSessionType: string, provider: ChatSessionItemProvider): Disposable;
-
-		/**
-		 * Registers a new {@link ChatSessionContentProvider chat session content provider}.
-		 *
-		 * @param chatSessionType A unique identifier for the chat session type. This is used to differentiate between different chat session providers.
-		 * @param provider The provider to register.
-		 *
-		 * @returns A disposable that unregisters the provider when disposed.
-		 */
-		export function registerChatSessionContentProvider(chatSessionType: string, provider: ChatSessionContentProvider, capabilities?: ChatSessionCapabilities): Disposable;
-	}
-
-	export interface ChatSessionCapabilities {
-		/**
-		 * Whether sessions can be interrupted and resumed without side-effects.
-		 */
-		supportsInterruptions?: boolean;
-	}
-
-	export interface ChatSessionShowOptions {
-		/**
-		 * The editor view column to show the chat session in.
-		 *
-		 * If not provided, the chat session will be shown in the chat panel instead.
-		 */
-		readonly viewColumn?: ViewColumn;
-	}
-
-	export namespace window {
-		/**
-		 * Shows a chat session in the panel or editor.
-		 */
-		export function showChatSession(chatSessionType: string, sessionId: string, options: ChatSessionShowOptions): Thenable<void>;
-	}
-}

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

@@ -1,61 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  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 ChatStatusItem {
-		/**
-		 * The identifier of this item.
-		 */
-		readonly id: string;
-
-		/**
-		 * The main name of the entry, like 'Indexing Status'
-		 */
-		title: string | { label: string; link: string };
-
-		/**
-		 * Optional additional description of the entry.
-		 *
-		 * This is rendered after the title. Supports Markdown style links (`[text](http://example.com)`) and rendering of
-		 * {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
-		 */
-		description: string;
-
-		/**
-		 * Optional additional details of the entry.
-		 *
-		 * This is rendered less prominently after the title. Supports Markdown style links (`[text](http://example.com)`) and rendering of
-		 * {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
-		 */
-		detail: string | undefined;
-
-		/**
-		 * Shows the entry in the chat status.
-		 */
-		show(): void;
-
-		/**
-		 * Hide the entry in the chat status.
-		 */
-		hide(): void;
-
-		/**
-		 * Dispose and free associated resources
-		 */
-		dispose(): void;
-	}
-
-	namespace window {
-		/**
-		 * Create a new chat status item.
-		 *
-		 * @param id The unique identifier of the status bar item.
-		 *
-		 * @returns A new chat status item.
-		 */
-		export function createChatStatusItem(id: string): ChatStatusItem;
-	}
-}

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

@@ -1,16 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  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;
-	}
-}