@capybara-hq/plugin-sdk 0.1.0-rc.2 → 0.1.0-rc.4

package/dist/web.d.ts

@@ -12,10 +12,16 @@ export interface WebSearchResult {
     /** ISO 8601 date or datetime, when known. */
     publishedAt?: string;
 }
-/** A web search provider (`web-search@1`). The kernel passes the org's decrypted `orgConfig`. */
+/**
+ * A web search provider (`web-search@1`). The kernel passes the org's decrypted `orgConfig` and the
+ * extension's effective deployment config for the org (`config`).
+ */
 export interface WebSearchProvider {
-    /** False when this org's config lacks what the provider needs. */
-    configured?(orgConfig: unknown): boolean;
+    /**
+     * False when this org's config lacks what the provider needs. `config` is the effective
+     * deployment config for the org (see `search`'s `config`).
+     */
+    configured?(orgConfig: unknown, config?: unknown): boolean;
     search(args: {
         query: string;
         /** Hints only: the kernel filters the results again. */
@@ -23,6 +29,14 @@ export interface WebSearchProvider {
         blockedDomains?: string[];
         maxResults: number;
         orgConfig: unknown;
+        /**
+         * The extension's effective deployment config for this org: the platform's deployment config
+         * with the org's copy applied to the overridable fields (`orgAccess(…, "override")`), or the
+         * platform's config (equal to `ctx.config`) while the org follows it. Use it, not `ctx.config`,
+         * for work done for this org. Optional in the type so older extensions compile; the kernel
+         * always passes it.
+         */
+        config?: unknown;
         signal: AbortSignal;
     }): Promise<{
         results: WebSearchResult[];
@@ -48,12 +62,23 @@ export interface WebFetchPage {
  * to (an IPv6 address in brackets, as in a URL).
  */
 export interface WebFetchProvider {
-    /** False when this org's config lacks what the provider needs. */
-    configured?(orgConfig: unknown): boolean;
+    /**
+     * False when this org's config lacks what the provider needs. `config` is the effective
+     * deployment config for the org (see `fetch`'s `config`).
+     */
+    configured?(orgConfig: unknown, config?: unknown): boolean;
     fetch(args: {
         /** Already validated and upgraded by the kernel. */
         url: string;
         orgConfig: unknown;
+        /**
+         * The extension's effective deployment config for this org: the platform's deployment config
+         * with the org's copy applied to the overridable fields (`orgAccess(…, "override")`), or the
+         * platform's config (equal to `ctx.config`) while the org follows it. Use it, not `ctx.config`,
+         * for work done for this org. Optional in the type so older extensions compile; the kernel
+         * always passes it.
+         */
+        config?: unknown;
         signal: AbortSignal;
     }): Promise<WebFetchPage>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capybara-hq/plugin-sdk",
-  "version": "0.1.0-rc.2",
+  "version": "0.1.0-rc.4",
   "description": "Capybara plugin SDK: the types and pure functions plugins are written against",
   "license": "Apache-2.0",
   "repository": {
@@ -17,11 +17,13 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
     "schemas",
+    "agent-docs",
     "README.md",
     "NOTICE"
   ],

package/schemas/marketplace.v1.schema.json

@@ -68,6 +68,25 @@
               "en"
             ]
           },
+          "displayName": {
+            "type": "object",
+            "properties": {
+              "zh": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 100
+              },
+              "en": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 100
+              }
+            },
+            "required": [
+              "zh",
+              "en"
+            ]
+          },
           "version": {
             "type": "string",
             "maxLength": 256,
@@ -110,6 +129,23 @@
             "maxLength": 2000,
             "pattern": "^https:\\/\\/\\S+$"
           },
+          "deprecated": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "reason": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 280
+                  }
+                }
+              }
+            ]
+          },
           "source": {
             "anyOf": [
               {

package/schemas/plugin.v1.schema.json

@@ -28,10 +28,35 @@
       "pattern": "\\S"
     },
     "description": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 1024,
-      "pattern": "\\S"
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "pattern": "\\S"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "en": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024,
+              "pattern": "\\S"
+            },
+            "zh": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024,
+              "pattern": "\\S"
+            }
+          },
+          "required": [
+            "en"
+          ],
+          "additionalProperties": false
+        }
+      ]
     },
     "displayName": {
       "type": "object",