@openctx/protocol - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

dist/openctx-protocol.schema.d.ts

@@ -5,4 +5,5 @@ import type { Annotation, Item } from '@openctx/schema';
  */
-export type Protocol = RequestMessage | ResponseMessage | ResponseError | ProviderSettings | CapabilitiesParams | CapabilitiesResult | ItemsParams | ItemsResult | AnnotationsParams | AnnotationsResult;
+export type Protocol = RequestMessage | ResponseMessage | ResponseError | ProviderSettings | CapabilitiesParams | CapabilitiesResult | Mention | MentionsParams | MentionsResult | ItemsParams | ItemsResult | AnnotationsParams | AnnotationsResult;
 export type CapabilitiesParams = Record<string, never>;
+export type MentionsResult = Mention[];
 export type ItemsResult = Item[];
@@ -37,2 +38,12 @@ export type AnnotationsResult = Annotation[];
     selector?: Selector[];
+    meta: {
+        /**
+         * The name of the provider.
+         */
+        name: string;
+        /**
+         * A description of the provider.
+         */
+        description?: string;
+    };
 }
@@ -56,4 +67,20 @@ /**
 }
-export interface ItemsParams {
+/**
+ * A mention contains presentation information relevant to a resource.
+ */
+export interface Mention {
     /**
+     * A descriptive title.
+     */
+    title: string;
+    /**
+     * A URI for the mention item.
+     */
+    uri: string;
+    data?: {
+        [k: string]: unknown | undefined;
+    };
+}
+export interface MentionsParams {
+    /**
      * A search query that is interpreted by providers to filter the items in the result set.
@@ -63,2 +90,12 @@ */
 }
+export interface ItemsParams {
+    /**
+     * A message that is interpreted by providers to return relevant items.
+     */
+    message?: string;
+    /**
+     * A mention interpreted by providers to return items for the specified mention.
+     */
+    mention?: Mention;
+}
 export interface AnnotationsParams {
@@ -65,0 +102,0 @@ /**

package.json

 {
   "name": "@openctx/protocol",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "OpenCtx client/provider protocol",
@@ -20,3 +20,3 @@ "license": "Apache-2.0",
   "dependencies": {
-    "@openctx/schema": "0.0.6"
+    "@openctx/schema": "0.0.7"
   },
@@ -23,0 +23,0 @@ "devDependencies": {

src/index.ts

@@ -1,1 +0,1 @@
-export type * from './openctx-protocol.schema'
+export type * from './openctx-protocol.schema.js'

src/openctx-protocol.schema.json

@@ -27,2 +27,11 @@ {
     {
+      "$ref": "#/definitions/Mention"
+    },
+    {
+      "$ref": "#/definitions/MentionsParams"
+    },
+    {
+      "$ref": "#/definitions/MentionsResult"
+    },
+    {
       "$ref": "#/definitions/ItemsParams"
@@ -103,2 +112,3 @@ },
       "additionalProperties": false,
+      "required": ["meta"],
       "properties": {
@@ -124,2 +134,17 @@ "selector": {
           }
+        },
+        "meta": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["name"],
+          "properties": {
+            "name": {
+              "description": "The name of the provider.",
+              "type": "string"
+            },
+            "description": {
+              "description": "A description of the provider.",
+              "type": "string"
+            }
+          }
         }
@@ -133,5 +158,10 @@ }
       "properties": {
-        "query": {
-          "description": "A search query that is interpreted by providers to filter the items in the result set.",
+        "message": {
+          "description": "A message that is interpreted by providers to return relevant items.",
           "type": "string"
+        },
+        "mention": {
+          "type": "object",
+          "description": "A mention interpreted by providers to return items for the specified mention.",
+          "tsType": "Mention"
         }
@@ -147,2 +177,42 @@ }
     },
+    "Mention": {
+      "description": "A mention contains presentation information relevant to a resource.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["title", "uri"],
+      "properties": {
+        "title": {
+          "description": "A descriptive title.",
+          "type": "string"
+        },
+        "uri": {
+          "description": "A URI for the mention item.",
+          "type": "string",
+          "format": "uri"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": true,
+          "required": []
+        }
+      }
+    },
+    "MentionsParams": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "query": {
+          "description": "A search query that is interpreted by providers to filter the items in the result set.",
+          "type": "string"
+        }
+      }
+    },
+    "MentionsResult": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Mention"
+      },
+      "tsType": "Mention[]"
+    },
     "AnnotationsParams": {
@@ -149,0 +219,0 @@ "type": "object",

src/openctx-protocol.schema.ts

@@ -12,2 +12,5 @@ import type { Annotation, Item } from '@openctx/schema'
     | CapabilitiesResult
+    | Mention
+    | MentionsParams
+    | MentionsResult
     | ItemsParams
@@ -18,2 +21,3 @@ | ItemsResult
 export type CapabilitiesParams = Record<string, never>
+export type MentionsResult = Mention[]
 export type ItemsResult = Item[]
@@ -49,2 +53,12 @@ export type AnnotationsResult = Annotation[]
     selector?: Selector[]
+    meta: {
+        /**
+         * The name of the provider.
+         */
+        name: string
+        /**
+         * A description of the provider.
+         */
+        description?: string
+    }
 }
@@ -68,4 +82,20 @@ /**
 }
-export interface ItemsParams {
+/**
+ * A mention contains presentation information relevant to a resource.
+ */
+export interface Mention {
     /**
+     * A descriptive title.
+     */
+    title: string
+    /**
+     * A URI for the mention item.
+     */
+    uri: string
+    data?: {
+        [k: string]: unknown | undefined
+    }
+}
+export interface MentionsParams {
+    /**
      * A search query that is interpreted by providers to filter the items in the result set.
@@ -75,2 +105,12 @@ */
 }
+export interface ItemsParams {
+    /**
+     * A message that is interpreted by providers to return relevant items.
+     */
+    message?: string
+    /**
+     * A mention interpreted by providers to return items for the specified mention.
+     */
+    mention?: Mention
+}
 export interface AnnotationsParams {
@@ -77,0 +117,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

27492

increased by16.24%

Lines of code

464

increased by45.45%

Worsened metrics

Number of package files

11

decreased by-21.43%

Dependency changes

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

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

• Updated@openctx/schema@0.0.7