@get-bb/plugin-sdk 0.4.34 → 0.4.40

package/dist/testing/index.js

@@ -6,7 +6,6 @@ import { join } from "node:path";
 import Database from "better-sqlite3";
 import { CronExpressionParser } from "cron-parser";
 import { Hono } from "hono";
-import { z as z4 } from "zod";
 
 // ../domain/src/plugin-interaction-limits.ts
 var PLUGIN_INTERACTION_MAX_TITLE_LENGTH = 160;
@@ -290,7 +289,7 @@ var PLUGIN_HTTP_METHODS = /* @__PURE__ */ new Set([
   "HEAD",
   "OPTIONS"
 ]);
-var RPC_METHOD_PATTERN = /^[a-zA-Z0-9_-]+$/;
+var RPC_METHOD_PATTERN = /^[a-zA-Z0-9_-]+(?:\.[a-zA-Z0-9_-]+)*$/;
 var BACKGROUND_NAME_PATTERN = /^[a-zA-Z0-9_-]+$/;
 var CLI_COMMAND_NAME_PATTERN = /^[a-z0-9-]+$/;
 var AGENT_TOOL_NAME_PATTERN = /^[a-zA-Z0-9_-]+$/;
@@ -307,12 +306,22 @@ var settingsBaseFields = {
   label: z3.string().min(1),
   description: z3.string().min(1).optional()
 };
+var stringSettingSchemaSchema = z3.custom(
+  (value) => isStandardSchema(value)
+);
+var booleanSettingSchemaSchema = z3.custom(
+  (value) => isStandardSchema(value)
+);
+var numberSettingSchemaSchema = z3.custom(
+  (value) => isStandardSchema(value)
+);
 var settingDescriptorSchema = z3.discriminatedUnion("type", [
   z3.object({
     type: z3.literal("string"),
     ...settingsBaseFields,
     secret: z3.literal(true).optional(),
     experimental_multiline: z3.boolean().optional(),
+    experimental_schema: stringSettingSchemaSchema.optional(),
     default: z3.string().optional()
   }).strict().refine(
     (descriptor) => !(descriptor.secret === true && descriptor.experimental_multiline === true),
@@ -324,17 +333,26 @@ var settingDescriptorSchema = z3.discriminatedUnion("type", [
   z3.object({
     type: z3.literal("boolean"),
     ...settingsBaseFields,
+    experimental_schema: booleanSettingSchemaSchema.optional(),
     default: z3.boolean().optional()
   }).strict(),
+  z3.object({
+    type: z3.literal("number"),
+    ...settingsBaseFields,
+    experimental_schema: numberSettingSchemaSchema.optional(),
+    default: z3.number().finite().optional()
+  }).strict(),
   z3.object({
     type: z3.literal("select"),
     ...settingsBaseFields,
     options: z3.array(z3.string().min(1)).min(1),
+    experimental_schema: stringSettingSchemaSchema.optional(),
     default: z3.string().optional()
   }).strict(),
   z3.object({
     type: z3.literal("project"),
     ...settingsBaseFields,
+    experimental_schema: stringSettingSchemaSchema.optional(),
     default: z3.string().optional()
   }).strict()
 ]);
@@ -363,11 +381,39 @@ function registerSettingDescriptors(target, added) {
         `default for setting "${key}" must be one of its options`
       );
     }
+    if (descriptor.default !== void 0) {
+      const errors = validateSettingsUpdate(
+        { [key]: descriptor },
+        { [key]: descriptor.default }
+      );
+      if (errors.length > 0) {
+        throw new Error(`invalid default for setting "${key}": ${errors[0]}`);
+      }
+    }
     validated[key] = descriptor;
   }
   Object.assign(target, validated);
   return validated;
 }
+function settingSchemaError(key, schema, value) {
+  if (schema === void 0) return null;
+  try {
+    const result = schema["~standard"].validate(value);
+    if (result instanceof Promise) {
+      return `schema for setting "${key}" must validate synchronously`;
+    }
+    if (result.issues !== void 0) {
+      return result.issues[0]?.message ?? `schema for setting "${key}" rejected the value`;
+    }
+    if (result.value !== value) {
+      return `schema for setting "${key}" must not transform its value`;
+    }
+    return null;
+  } catch (error) {
+    const detail = error instanceof Error ? error.message : String(error);
+    return `schema for setting "${key}" failed: ${detail}`;
+  }
+}
 function validateSettingsUpdate(descriptors, values) {
   const errors = [];
   for (const [key, value] of Object.entries(values)) {
@@ -380,6 +426,30 @@ function validateSettingsUpdate(descriptors, values) {
     if (descriptor.type === "boolean") {
       if (typeof value !== "boolean") {
         errors.push(`setting "${key}" expects a boolean`);
+        continue;
+      }
+      const validationError2 = settingSchemaError(
+        key,
+        descriptor.experimental_schema,
+        value
+      );
+      if (validationError2 !== null) {
+        errors.push(validationError2);
+      }
+      continue;
+    }
+    if (descriptor.type === "number") {
+      if (typeof value !== "number" || !Number.isFinite(value)) {
+        errors.push(`setting "${key}" expects a finite number`);
+        continue;
+      }
+      const validationError2 = settingSchemaError(
+        key,
+        descriptor.experimental_schema,
+        value
+      );
+      if (validationError2 !== null) {
+        errors.push(validationError2);
       }
       continue;
     }
@@ -391,6 +461,15 @@ function validateSettingsUpdate(descriptors, values) {
       errors.push(
         `setting "${key}" must be one of: ${descriptor.options.join(", ")}`
       );
+      continue;
+    }
+    const validationError = settingSchemaError(
+      key,
+      descriptor.experimental_schema,
+      value
+    );
+    if (validationError !== null) {
+      errors.push(validationError);
     }
   }
   return errors;
@@ -1294,6 +1373,12 @@ function readRpcMethodContract(method, value) {
 function isZodSchemaLike(value) {
   return typeof value === "object" && value !== null && typeof value.safeParse === "function";
 }
+function zodSchemaToJsonSchema(schema) {
+  if (typeof schema.toJSONSchema === "function") {
+    return schema.toJSONSchema({ io: "input" });
+  }
+  return z3.toJSONSchema(schema, { io: "input" });
+}
 var SINGLE_SCHEMA_KEYWORDS = [
   "additionalItems",
   "additionalProperties",
@@ -1705,7 +1790,14 @@ function readSettingsValues(descriptors, stored) {
   const values = {};
   for (const [key, descriptor] of Object.entries(descriptors)) {
     let value = stored.get(key);
-    const expected = descriptor.type === "boolean" ? "boolean" : "string";
+    if (descriptor.type === "number" && typeof value === "string") {
+      const legacyNumber = Number(value.trim());
+      value = value.trim().length > 0 && Number.isFinite(legacyNumber) ? legacyNumber : void 0;
+    }
+    if (descriptor.type === "number" && typeof value === "number" && !Number.isFinite(value)) {
+      value = void 0;
+    }
+    const expected = descriptor.type === "boolean" ? "boolean" : descriptor.type === "number" ? "number" : "string";
     if (typeof value !== expected) value = void 0;
     if (descriptor.type === "select" && typeof value === "string" && !descriptor.options.includes(value)) {
       value = void 0;
@@ -2119,20 +2211,57 @@ function createFakePluginHostInternal(options, sharedState) {
   const settingsDescriptors = {};
   const settingsListeners = [];
   const storedSettings = persistentState.storedSettings;
+  async function setSettingsValues(values) {
+    const errors = validateSettingsUpdate(settingsDescriptors, values);
+    if (errors.length > 0) {
+      throw new Error(errors.join("; "));
+    }
+    const prev = readSettingsValues(settingsDescriptors, storedSettings);
+    for (const [key, value] of Object.entries(values)) {
+      if (value === null) storedSettings.delete(key);
+      else if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+        storedSettings.set(key, value);
+      } else {
+        throw new Error(`setting "${key}" has an unsupported value`);
+      }
+    }
+    const next = readSettingsValues(settingsDescriptors, storedSettings);
+    if (JSON.stringify(next) === JSON.stringify(prev)) return;
+    for (const listener of settingsListeners) {
+      try {
+        listener(next, prev);
+      } catch (error) {
+        emitLog(
+          "warn",
+          `settings onChange listener failed: ${errorMessage(error)}`
+        );
+      }
+    }
+  }
   const settings = {
     define(descriptors) {
       assertLive();
-      registerSettingDescriptors(
+      const validated = registerSettingDescriptors(
         settingsDescriptors,
         descriptors
       );
       return {
         async get() {
           assertLive();
-          return readSettingsValues(
-            settingsDescriptors,
-            storedSettings
-          );
+          return readSettingsValues(validated, storedSettings);
+        },
+        async experimental_set(values) {
+          assertLive();
+          const rawValues = {};
+          for (const [key, value] of Object.entries(values)) {
+            rawValues[key] = value;
+          }
+          const errors = validateSettingsUpdate(validated, rawValues);
+          if (errors.length > 0) {
+            throw new Error(errors.join("; "));
+          }
+          await setSettingsValues(rawValues);
+          return readSettingsValues(validated, storedSettings);
         },
         onChange(listener) {
           assertLive();
@@ -2202,7 +2331,7 @@ function createFakePluginHostInternal(options, sharedState) {
       for (const [name, contractValue] of contractEntries) {
         if (!RPC_METHOD_PATTERN.test(name)) {
           throw new Error(
-            `invalid rpc method name "${name}" \u2014 use letters, digits, "-" and "_"`
+            `invalid rpc method name "${name}" \u2014 use dot-separated segments with letters, digits, "-" and "_"`
           );
         }
         const methodContract = readRpcMethodContract(name, contractValue);
@@ -2462,9 +2591,7 @@ function createFakePluginHostInternal(options, sharedState) {
       let parse;
       if (isZodSchemaLike(parameters)) {
         try {
-          inputSchema = z4.toJSONSchema(parameters, {
-            io: "input"
-          });
+          inputSchema = zodSchemaToJsonSchema(parameters);
         } catch (error) {
           throw new Error(
             `tool "${name}" parameters look like a zod schema but could not be converted to JSON Schema (${errorMessage(error)}) \u2014 use zod 4, or pass a plain JSON-schema object`
@@ -2554,9 +2681,14 @@ function createFakePluginHostInternal(options, sharedState) {
       );
     }
   };
+  const appUrl = options.appUrl ?? null;
   const loopbackBaseUrl = options.loopbackBaseUrl ?? "http://127.0.0.1:38886";
   const dataDir = options.dataDir ?? "/tmp/bb-fake-data-dir";
   const server = {
+    get experimental_appUrl() {
+      assertLive();
+      return appUrl;
+    },
     get loopbackBaseUrl() {
       assertLive();
       return loopbackBaseUrl;
@@ -2577,6 +2709,7 @@ function createFakePluginHostInternal(options, sharedState) {
     "thread.failed": [],
     "thread.archived": [],
     "thread.deleted": [],
+    "interaction.pending": [],
     "message.queued": [],
     "message.dispatched": [],
     "turn.failed": []
@@ -2916,6 +3049,7 @@ function createFakePluginHostInternal(options, sharedState) {
           "thread.failed": threadEventHandlers["thread.failed"].length,
           "thread.archived": threadEventHandlers["thread.archived"].length,
           "thread.deleted": threadEventHandlers["thread.deleted"].length,
+          "interaction.pending": threadEventHandlers["interaction.pending"].length,
           "message.queued": threadEventHandlers["message.queued"].length,
           "message.dispatched": threadEventHandlers["message.dispatched"].length,
           "turn.failed": threadEventHandlers["turn.failed"].length
@@ -2978,27 +3112,7 @@ function createFakePluginHostInternal(options, sharedState) {
       pending.resolve({ outcome: "cancelled", reason: "user" });
     },
     async setSettings(values) {
-      const errors = validateSettingsUpdate(settingsDescriptors, values);
-      if (errors.length > 0) {
-        throw new Error(errors.join("; "));
-      }
-      const prev = readSettingsValues(settingsDescriptors, storedSettings);
-      for (const [key, value] of Object.entries(values)) {
-        if (value === null) storedSettings.delete(key);
-        else storedSettings.set(key, value);
-      }
-      const next = readSettingsValues(settingsDescriptors, storedSettings);
-      if (JSON.stringify(next) === JSON.stringify(prev)) return;
-      for (const listener of settingsListeners) {
-        try {
-          listener(next, prev);
-        } catch (error) {
-          emitLog(
-            "warn",
-            `settings onChange listener failed: ${errorMessage(error)}`
-          );
-        }
-      }
+      await setSettingsValues(values);
     },
     async callRpc(method, input) {
       const record = rpcHandlers.get(method);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@get-bb/plugin-sdk",
-  "version": "0.4.34",
+  "version": "0.4.40",
   "homepage": "https://github.com/get-bb/bb#readme",
   "bugs": {
     "url": "https://github.com/get-bb/bb/issues"