@github/copilot-language-server 1.248.0 → 1.249.0

package/dist/api/types.d.ts

@@ -0,0 +1,74 @@
+import {CancellationToken, Disposable, DocumentSelector, DocumentUri} from 'vscode-languageserver-protocol';
+
+// Properties common to all context items
+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 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 interface ContextProviderApiV1 {
+    registerContextProvider<T extends SupportedContextItem>(provider: ContextProvider<T>): Disposable;
+}
+
+export interface ContextProvider<T extends SupportedContextItem> {
+    id: string;
+    selector: DocumentSelector;
+    resolver: ContextResolver<T>;
+}
+
+interface ContextResolver<T extends SupportedContextItem> {
+    resolve(context: CompletionContext, token: CancellationToken): Promise<T> | Promise<T[]> | AsyncIterable<T>;
+}
+
+export interface DocumentContext {
+    uri: DocumentUri;
+    languageId: string;
+    version: number;
+    offset: number;
+}
+
+export type Status = 'full' | 'partial' | 'none';
+
+export type ContextUsageStatistics = {
+    usage: Status;
+    resolution: Status;
+};
+
+export interface CompletionContext {
+    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 and the CLS will stop
+    // iterating additional context items.
+    // 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;
+}