breaking change: specify otherDocuments as a function instead of an a…

…rray
val-town · Apr 11, 2024 · 360aa79 · 360aa79
1 parent 7f7e849
commit 360aa79
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # codemirror-codeium
 
- [![npm](https://img.shields.io/npm/v/@valtown/codemirror-codeium)](https://www.npmjs.com/package/@valtown/codemirror-codeium)
+[![npm](https://img.shields.io/npm/v/@valtown/codemirror-codeium)](https://www.npmjs.com/package/@valtown/codemirror-codeium)
 
 ```mermaid
 flowchart TD

diff --git a/demo/index.ts b/demo/index.ts
@@ -22,7 +22,7 @@ increment('not a number');`,
       jsx: true,
     }),
     codeiumOtherDocumentsConfig.of({
-      otherDocuments: [
+      override: () => [
         {
           absolutePath: "https://esm.town/v/foo.ts",
           text: `export const foo = 10;

diff --git a/src/completionRequester.ts b/src/completionRequester.ts
@@ -61,9 +61,7 @@ export function completionRequester() {
 
   return EditorView.updateListener.of((update: ViewUpdate) => {
     const config = update.view.state.facet(codeiumConfig);
-    const { otherDocuments } = update.view.state.facet(
-      codeiumOtherDocumentsConfig,
-    );
+    const { override } = update.view.state.facet(codeiumOtherDocumentsConfig);
 
     if (!shouldRequestCompletion(update)) return;
 
@@ -86,6 +84,8 @@ export function completionRequester() {
       // Check if the position has changed
       if (pos !== lastPos) return;
 
+      const otherDocuments = await override();
+
       // Request completion from the server
       try {
         const completionResult = await getCodeiumCompletions({

diff --git a/src/config.ts b/src/config.ts
@@ -34,8 +34,10 @@ export const codeiumConfig = Facet.define<
   },
 });
 
+type OtherDocuments = PartialMessage<Document>[];
+
 export interface CodeiumOtherDocumentsConfig {
-  otherDocuments?: PartialMessage<Document>[];
+  override?: () => Promise<OtherDocuments> | OtherDocuments;
 }
 
 export const codeiumOtherDocumentsConfig = Facet.define<
@@ -46,7 +48,7 @@ export const codeiumOtherDocumentsConfig = Facet.define<
     return combineConfig<Required<CodeiumOtherDocumentsConfig>>(
       configs,
       {
-        otherDocuments: [],
+        override: () => [],
       },
       {},
     );