@openctx/protocol - npm Package Compare versions

Comparing version 0.0.16 to 0.0.17

dist/openctx-protocol.schema.d.ts

@@ -5,3 +5,3 @@ import type { Annotation, Item } from '@openctx/schema';
  */
-export type Protocol = RequestMessage | ResponseMessage | ResponseError | ProviderSettings | MetaParams | MetaResult | Mention | MessageSelector | MentionSelector | AnnotationSelector | MentionsParams | MentionsResult | ItemsParams | ItemsResult | AnnotationsParams | AnnotationsResult;
+export type Protocol = RequestMessage | ResponseMessage | ResponseError | ProviderSettings | MetaParams | MetaResult | Mention | MessageSelector | AnnotationSelector | MentionsParams | MentionsResult | ItemsParams | ItemsResult | AnnotationsParams | AnnotationsResult;
 export type MetaParams = Record<string, never>;
@@ -54,5 +54,5 @@ export type MentionsResult = Mention[];
         /**
-         * The list of regex patterns for triggering mentions for the provider when users directly types a matching text, for example a url, allowing the user to bypass choosing the provider manually.
+         * Whether to automatically include the returned mention items as initial context for new messages.
          */
-        selectors?: MentionSelector[];
+        autoInclude?: boolean;
     };
@@ -99,11 +99,2 @@ /**
 /**
- * List of regex patterns matching the mention text for which the provider can return mentions.
- */
-export interface MentionSelector {
-    /**
-     * The regex pattern matching the mention text for which the provider can return mentions
-     */
-    pattern: string;
-}
-/**
  * Defines a scope in which a provider is called.
@@ -130,2 +121,10 @@ *
     query?: string;
+    /**
+     * URI of the active document.
+     */
+    uri?: string;
+    /**
+     * Name of the active codebase infered from .git.
+     */
+    codebase?: string;
 }
@@ -132,0 +131,0 @@ export interface ItemsParams {

package.json

 {
   "name": "@openctx/protocol",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "OpenCtx client/provider protocol",
@@ -20,3 +20,3 @@ "license": "Apache-2.0",
   "dependencies": {
-    "@openctx/schema": "0.0.12"
+    "@openctx/schema": "0.0.13"
   },
@@ -23,0 +23,0 @@ "devDependencies": {

src/openctx-protocol.schema.json

@@ -33,5 +33,2 @@ {
     {
-      "$ref": "#/definitions/MentionSelector"
-    },
-    {
       "$ref": "#/definitions/AnnotationSelector"
@@ -130,14 +127,2 @@ },
     },
-    "MentionSelector": {
-      "description": "List of regex patterns matching the mention text for which the provider can return mentions.",
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["pattern"],
-      "properties": {
-        "pattern": {
-          "description": "The regex pattern matching the mention text for which the provider can return mentions",
-          "type": "string"
-        }
-      }
-    },
     "AnnotationSelector": {
@@ -191,9 +176,5 @@ "description": "Defines a scope in which a provider is called.\n\nTo satisfy a selector, all of the selector's conditions must be met. For example, if both `path` and `content` are specified, the resource must satisfy both conditions.",
             },
-            "selectors": {
-              "description": "The list of regex patterns for triggering mentions for the provider when users directly types a matching text, for example a url, allowing the user to bypass choosing the provider manually.",
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/MentionSelector"
-              },
-              "tsType": "MentionSelector[]"
+            "autoInclude": {
+              "description": "Whether to automatically include the returned mention items as initial context for new messages.",
+              "type": "boolean"
             }
@@ -276,2 +257,10 @@ }
           "type": "string"
+        },
+        "uri": {
+          "description": "URI of the active document.",
+          "type": "string"
+        },
+        "codebase": {
+          "description": "Name of the active codebase infered from .git.",
+          "type": "string"
         }
@@ -278,0 +267,0 @@ }

src/openctx-protocol.schema.ts

@@ -14,3 +14,2 @@ import type { Annotation, Item } from '@openctx/schema'
     | MessageSelector
-    | MentionSelector
     | AnnotationSelector
@@ -71,5 +70,5 @@ | MentionsParams
         /**
-         * The list of regex patterns for triggering mentions for the provider when users directly types a matching text, for example a url, allowing the user to bypass choosing the provider manually.
+         * Whether to automatically include the returned mention items as initial context for new messages.
          */
-        selectors?: MentionSelector[]
+        autoInclude?: boolean
     }
@@ -116,11 +115,2 @@ /**
 /**
- * List of regex patterns matching the mention text for which the provider can return mentions.
- */
-export interface MentionSelector {
-    /**
-     * The regex pattern matching the mention text for which the provider can return mentions
-     */
-    pattern: string
-}
-/**
  * Defines a scope in which a provider is called.
@@ -147,2 +137,10 @@ *
     query?: string
+    /**
+     * URI of the active document.
+     */
+    uri?: string
+    /**
+     * Name of the active codebase infered from .git.
+     */
+    codebase?: string
 }
@@ -149,0 +147,0 @@ export interface ItemsParams {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

32126

decreased by-2.9%

Lines of code

607

decreased by-2.25%

Dependency changes

• + Added@openctx/schema@0.0.13(transitive)

• - Removed@openctx/schema@0.0.12(transitive)

• Updated@openctx/schema@0.0.13