@github/copilot-language-server 1.285.0 → 1.287.0

package/dist/api/types.d.ts

@@ -1,4 +1,11 @@
-import {CancellationToken, Disposable, DocumentSelector, DocumentUri, Position} from 'vscode-languageserver-protocol';
+import {
+    CancellationToken,
+    Disposable,
+    DocumentSelector,
+    DocumentUri,
+    Position,
+    TextEdit,
+} from 'vscode-languageserver-protocol';
 
 /**
  * The ContextProvider API allows extensions to provide additional context items that
@@ -62,10 +69,16 @@ export type UsageStatus = ResolutionStatus | 'partial_content_excluded' | 'none_
 
 export type ContextItemUsageDetails = {
     id: string;
-    usage: UsageStatus;
-    expectedTokens?: number;
-    actualTokens?: number;
-};
+    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;
@@ -77,8 +90,12 @@ 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.
@@ -128,6 +145,13 @@ interface ContextItem {
      * 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.
@@ -145,3 +169,5 @@ export interface CodeSnippet extends ContextItem {
 }
 
 export type SupportedContextItem = Trait | CodeSnippet;
+export type SupportedContextItemType = 'Trait' | 'CodeSnippet';
+export type ContextItemOrigin = 'request' | 'update';