Add query selector config

sourcegraph · Jul 26, 2024 · 6b967c9 · 6b967c9
1 parent f588cc3
commit 6b967c9
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/lib/protocol/src/openctx-protocol.schema.json b/lib/protocol/src/openctx-protocol.schema.json
@@ -104,6 +104,18 @@
         }
       }
     },
+    "QuerySelector": {
+      "description": "List of regex patterns matching the query for which the provider can return context items.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["pattern"],
+      "properties": {
+        "pattern": {
+          "description": "The regex pattern matching the query for which the provider can return context items",
+          "type": "string"
+        }
+      }
+    },
     "MetaParams": {
       "type": "object",
       "additionalProperties": false,
@@ -147,6 +159,21 @@
           "description": "The name of the provider.",
           "type": "string"
         },
+        "items": {
+          "description": "Configuration for providing context items.",
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "querySelectors": {
+              "description": "The list of regex patterns for matching with a query for which the provider can return context items",
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/QuerySelector"
+              },
+              "tsType": "QuerySelector[]"
+            }
+          }
+        },
         "mentions": {
           "description": "Configuration for the mentions feature.",
           "type": "object",

diff --git a/lib/protocol/src/openctx-protocol.schema.ts b/lib/protocol/src/openctx-protocol.schema.ts
@@ -48,6 +48,15 @@ export interface MetaResult {
      * The name of the provider.
      */
     name: string
+    /**
+     * Configuration for providing context items.
+     */
+    items?: {
+        /**
+         * The list of regex patterns for matching with a query for which the provider can return context items
+         */
+        querySelectors?: QuerySelector[]
+    }
     /**
      * Configuration for the mentions feature.
      */