feat: update to latest copilot LSP v1.294 (#418)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: github-actions[bot]

copilot/js/api/types.d.ts

@@ -0,0 +1,173 @@
+import {
+    CancellationToken,
+    Disposable,
+    DocumentSelector,
+    DocumentUri,
+    Position,
+    TextEdit,
+} from 'vscode-languageserver-protocol';
+
+/**
+ * The ContextProvider API allows extensions to provide additional context items that
+ * Copilot can use in its prompt. This file contains type definitions for the methods
+ * and the data structures used by the API.
+ *
+ * Note: providing context is not enough to ensure that the context will be used in the prompt.
+ *
+ * The API is exposed as an export of the Copilot extension. To use it, you can cast the
+ * exported object to the ContextProviderApiV1 interface.
+ *
+ * Example:
+ * ```
+ * const copilot = vscode.extensions.getExtension("github.copilot");
+ * const contextProviderAPI = copilot.exports.getContextProviderAPI("v1") as ContextProviderApiV1;
+ * ```
+ */
+export interface ContextProviderApiV1 {
+    registerContextProvider<T extends SupportedContextItem>(provider: ContextProvider<T>): Disposable;
+}
+
+/**
+ * Each extension can register a number of context providers, uniquely identified by their ID.
+ * In addition, each provider has to provide:
+ * - a DocumentSelector, to specify the file types for which the provider is active
+ * - a ContextResolver, a function that returns the context items for a given request
+ *
+ * Example:
+ * ```
+ * contextProviderAPI.registerContextProvider<Trait>({
+ *  id: "pythonProvider",
+ *  selector: [{ language: "python" }],
+ *  resolver: {
+ *      resolve: async (request, token) => {
+ *        return [{name: 'traitName', value: 'traitValue'}];
+ *      }
+ *  }
+ * });
+ * ```
+ */
+export interface ContextProvider<T extends SupportedContextItem> {
+    id: string;
+    selector: DocumentSelector;
+    resolver: ContextResolver<T>;
+}
+export interface ContextResolver<T extends SupportedContextItem> {
+    resolve(request: ResolveRequest, token: CancellationToken): Promise<T> | Promise<T[]> | AsyncIterable<T>;
+}
+
+/**
+ * The first argument of the resolve method is a ResolveRequest object, which informs
+ * the provider about:
+ * - the completionId, a unique identifier for the completion request
+ * - the documentContext, which contains information about the document for which the context is requested
+ * - the activeExperiments, a map of active experiments and their values
+ * - the timeBudget the provider has to provide context items
+ * - the previousUsageStatistics, which contains information about the last request to the provider
+ */
+export type ResolutionStatus = 'full' | 'partial' | 'none' | 'error';
+export type UsageStatus = ResolutionStatus | 'partial_content_excluded' | 'none_content_excluded';
+
+export type ContextItemUsageDetails = {
+    id: string;
+    type: SupportedContextItemType;
+    origin?: ContextItemOrigin;
+} & (
+    | {
+          usage: Extract<UsageStatus, 'full' | 'partial' | 'partial_content_excluded'>;
+          expectedTokens: number;
+          actualTokens: number;
+      }
+    | {usage: Extract<UsageStatus, 'none' | 'none_content_excluded' | 'error'>}
+);
+
+export type ContextUsageStatistics = {
+    usage: UsageStatus;
+    resolution: ResolutionStatus;
+    usageDetails?: ContextItemUsageDetails[];
+};
+
+export interface DocumentContext {
+    uri: DocumentUri;
+    languageId: string;
+    version: number;
+    /**
+     * @deprecated Use `position` instead.
+     */
+    offset: number;
+    position: Position;
+    proposedEdits?: TextEdit[];
+}
+export interface ResolveRequest {
+    // A unique ID to correlate the request with the completion request.
+    completionId: string;
+    documentContext: DocumentContext;
+
+    activeExperiments: Map<string, string | number | boolean | string[]>;
+
+    /**
+     * The number of milliseconds for the context provider to provide context items.
+     * After the time budget runs out, the request will be cancelled via the CancellationToken.
+     * Providers can use this value as a hint when computing context. Providers should expect the
+     * request to be cancelled once the time budget runs out.
+     */
+    timeBudget: number;
+
+    /**
+     * Various statistics about the last completion request. This can be used by the context provider
+     * to make decisions about what context to provide for the current call.
+     */
+    previousUsageStatistics?: ContextUsageStatistics;
+
+    /**
+     * Data from completionItem
+     *
+     * See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#completionItem
+     */
+    data?: unknown;
+}
+
+/**
+ * These are the data types that can be provided by a context provider. Any non-conforming
+ * context items will be filtered out.
+ */
+interface ContextItem {
+    /**
+     * Specifies the relative importance with respect to items of the same type.
+     * Cross-type comparisons is currently handled by the wishlist.
+     * Accepted values are integers in the range [0, 100], where 100 is the highest importance.
+     * Items with non-conforming importance values will be filtered out.
+     * Default value is 0.
+     */
+    importance?: number;
+
+    /**
+     * A unique ID for the context item, used to provide detailed statistics about
+     * the item's usage. If an ID is not provided, it will be generated randomly.
+     */
+    id?: string;
+
+    /**
+     * Specifies where the context item comes from, mostly relevant for LSP providers.
+     * - request: context is provided in the completion request
+     * - update: context is provided via context/update
+     */
+    origin?: ContextItemOrigin;
+}
+
+// A key-value pair used for short string snippets.
+export interface Trait extends ContextItem {
+    name: string;
+    value: string;
+}
+
+// Code snippet extracted from a file. The URI is used for content exclusion.
+export interface CodeSnippet extends ContextItem {
+    uri: string;
+    value: string;
+    // Additional URIs that contribute the same code snippet.
+    additionalUris?: string[];
+}
+
+export type SupportedContextItem = Trait | CodeSnippet;
+export type SupportedContextItemType = 'Trait' | 'CodeSnippet';
+export type ContextItemOrigin = 'request' | 'update';