@yaklabs-ai/plugin-protocol 0.33.0 → 0.35.0

package/dist/index.js

@@ -9,6 +9,21 @@ var KAY_APP_DATA_SNAPSHOT_MAX_BYTES = 16 * 1024 * 1024;
 var KAY_APP_DATA_CHANGE_MAX_BYTES = 256 * 1024;
 var KAY_APP_DATA_READ_REQUEST_MAX_BYTES = 64 * 1024;
 var KAY_APP_DATA_READ_RESULT_MAX_BYTES = 16 * 1024 * 1024;
+function appDataSourceDeclaration(source) {
+  return {
+    sourceId: source.localId,
+    scope: source.scope,
+    snapshotVersion: source.snapshot.version,
+    changeVersion: source.change.version,
+    ...source.read === void 0 ? {} : {
+      read: {
+        requestVersion: source.read.request.version,
+        resultVersion: source.read.result.version
+      }
+    },
+    ...source.store === void 0 ? {} : { store: source.store }
+  };
+}
 
 // packages/plugin-protocol/dist/ui-icon-paths.js
 function declaredUiIconPaths(manifest) {
@@ -238,7 +253,7 @@ var JsonSchema = z4.record(z4.string(), JsonValue);
 var KAY_PLUGIN_MANIFEST_SIZE_CAP_BYTES = 1024 * 1024;
 var KAY_PLUGIN_PROTOCOL_VERSION = "kay.plugin.v1";
 var KAY_PLUGIN_PROTOCOL_PACKAGE_NAME = "@bonsai/plugin-protocol";
-var KAY_PLUGIN_SDK_VERSION = "0.33.0";
+var KAY_PLUGIN_SDK_VERSION = "0.35.0";
 var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
   "0.26.3",
   "0.27.1",
@@ -246,7 +261,9 @@ var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
   "0.29.0",
   "0.30.0",
   "0.31.0",
-  "0.32.0"
+  "0.32.0",
+  "0.33.0",
+  "0.34.0"
 ];
 var KAY_PLUGIN_TARGET_NAMES = [
   "kay.agent",
@@ -2832,20 +2849,7 @@ function createPluginEventsSchemas(canonical) {
 var { PluginEventLocalId, PluginEventUri, PluginEventTimestamp, PluginEventRelated, PluginEventPublishSource, PluginEventSource, PluginEventId, PluginEventPublishInput, PluginEventEnvelope } = createPluginEventsSchemas(false);
 var canonicalPluginEventSchemas = createPluginEventsSchemas(true);
 
-// packages/plugin-protocol/dist/declared-commands.js
-function declarationsOfKind(plugins, kind) {
-  return plugins.flatMap((plugin) => (plugin.contributes[kind] ?? []).map((declaration) => ({
-    plugin,
-    declaration
-  })));
-}
-function declaredCommandId(pluginId, localId) {
-  return `${pluginId}/${localId}`;
-}
-var WHERE_KEY_TYPES = {
-  "account.signedIn": "boolean",
-  "app.channel": "string"
-};
+// packages/plugin-protocol/dist/where-expression.js
 var TOKEN = /\s*(?:(\|\||&&|==|!=|!|\(|\))|'([^']*)'|"([^"]*)"|([A-Za-z][A-Za-z0-9]*(?:\.[A-Za-z][A-Za-z0-9]*)*))/y;
 function tokenize(source) {
   const tokens = [];
@@ -2866,10 +2870,7 @@ function tokenize(source) {
   }
   return tokens;
 }
-function isKey(text) {
-  return Object.hasOwn(WHERE_KEY_TYPES, text);
-}
-function parseTokens(tokens) {
+function parseTokens(tokens, keyTypes) {
   let position = 0;
   const takeOperator = (text) => {
     const token = tokens[position];
@@ -2910,22 +2911,23 @@ function parseTokens(tokens) {
     }
     if (token.kind !== "word")
       throw new Error(`unexpected '${token.text}'`);
-    if (!isKey(token.text)) {
-      throw new Error(`unknown key '${token.text}'; the keys are ${Object.keys(WHERE_KEY_TYPES).join(", ")}`);
+    if (keyTypes !== void 0 && !Object.hasOwn(keyTypes, token.text)) {
+      throw new Error(`unknown key '${token.text}'; the keys are ${Object.keys(keyTypes).join(", ")}`);
     }
     return parseKeyAtom(token.text);
   };
   const parseKeyAtom = (key) => {
+    const keyType = keyTypes?.[key];
     const negated = takeOperator("!=");
     if (!negated && !takeOperator("==")) {
-      if (WHERE_KEY_TYPES[key] !== "boolean") {
+      if (keyType === "string") {
         throw new Error(`'${key}' must be compared, with == or !=`);
       }
       return { kind: "key", key };
     }
     const value = parseLiteral();
-    if (typeof value !== WHERE_KEY_TYPES[key]) {
-      throw new Error(`'${key}' compares to a ${WHERE_KEY_TYPES[key]}`);
+    if (keyType !== void 0 && typeof value !== keyType) {
+      throw new Error(`'${key}' compares to a ${keyType}`);
     }
     return { kind: "equals", key, value, negated };
   };
@@ -2946,49 +2948,82 @@ function parseTokens(tokens) {
     throw new Error(`unexpected '${extra.text}'`);
   return where;
 }
-function parseCommandWhere(source) {
+function parseWhere(source, keyTypes) {
   try {
-    return { ok: true, where: parseTokens(tokenize(source)) };
+    return { ok: true, where: parseTokens(tokenize(source), keyTypes) };
   } catch (error) {
     return { ok: false, message: error.message };
   }
 }
-function resolve(where, values) {
+function resolve(where, read) {
   switch (where.kind) {
     case "literal":
       return where.value;
     case "key": {
-      const value = values[where.key];
-      return value === void 0 ? void 0 : value === true;
+      const value = read(where.key);
+      return value === void 0 ? void 0 : Boolean(value);
     }
     case "equals": {
-      const value = values[where.key];
+      const value = read(where.key);
       if (value === void 0)
         return void 0;
       return value === where.value !== where.negated;
     }
     case "not": {
-      const operand = resolve(where.operand, values);
+      const operand = resolve(where.operand, read);
       return operand === void 0 ? void 0 : !operand;
     }
     case "and": {
-      const left = resolve(where.left, values);
-      const right = resolve(where.right, values);
+      const left = resolve(where.left, read);
+      const right = resolve(where.right, read);
       if (left === false || right === false)
         return false;
       return left === void 0 || right === void 0 ? void 0 : true;
     }
     case "or": {
-      const left = resolve(where.left, values);
-      const right = resolve(where.right, values);
+      const left = resolve(where.left, read);
+      const right = resolve(where.right, read);
       if (left === true || right === true)
         return true;
       return left === void 0 || right === void 0 ? void 0 : false;
     }
   }
 }
+function evaluateWhere(where, read) {
+  return resolve(where, read) === true;
+}
+function rowMatchesWhere(where, row) {
+  return evaluateWhere(where, (path) => {
+    let value = row;
+    for (const part of path.split(".")) {
+      if (typeof value !== "object" || value === null || !Object.hasOwn(value, part)) {
+        return null;
+      }
+      value = value[part];
+    }
+    return value ?? null;
+  });
+}
+
+// packages/plugin-protocol/dist/declared-commands.js
+function declarationsOfKind(plugins, kind) {
+  return plugins.flatMap((plugin) => (plugin.contributes[kind] ?? []).map((declaration) => ({
+    plugin,
+    declaration
+  })));
+}
+function declaredCommandId(pluginId, localId) {
+  return `${pluginId}/${localId}`;
+}
+var WHERE_KEY_TYPES = {
+  "account.signedIn": "boolean",
+  "app.channel": "string"
+};
+function parseCommandWhere(source) {
+  return parseWhere(source, WHERE_KEY_TYPES);
+}
 function evaluateCommandWhere(where, values) {
-  return resolve(where, values) === true;
+  return evaluateWhere(where, (key) => values[key]);
 }
 
 // packages/plugin-protocol/dist/contributions.js
@@ -3721,6 +3756,25 @@ function createContributionsSchemas(canonical) {
       }
     }
   });
+  const UiRailBadge = z12.strictObject({
+    source: LocalContributionId2,
+    where: NonEmptyString3.optional(),
+    label: z12.strictObject({
+      one: NonEmptyString3.optional(),
+      other: NonEmptyString3
+    })
+  }).superRefine((badge, ctx) => {
+    if (badge.where === void 0)
+      return;
+    const parsed = parseWhere(badge.where);
+    if (!parsed.ok) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["where"],
+        message: `rail badge has an invalid where: ${parsed.message}`
+      });
+    }
+  });
   const UiRailEntryContribution2 = z12.strictObject({
     id: LocalContributionId2,
     title: NonEmptyString3,
@@ -3729,7 +3783,9 @@ function createContributionsSchemas(canonical) {
     homeLocation: NonEmptyString3.optional(),
     shortcut: NonEmptyString3.optional(),
     order: z12.number().finite().optional(),
-    section: z12.enum(["primary", "plugins"]).optional()
+    section: z12.enum(["primary", "plugins"]).optional(),
+    badge: UiRailBadge.optional(),
+    panel: z12.strictObject({ body: LocalContributionId2 }).optional()
   });
   const UiAppFields = z12.strictObject({
     localId: LocalContributionId2,
@@ -4547,6 +4603,34 @@ function createManifestSchemas(canonical) {
       }
       materializedAppDataSources.add(materializer.source);
     }
+    const declaredRowsStores = new Set(manifest.targets?.kay?.app?.contributes?.dataSources?.filter((source) => source.store?.shape === "rows").map((source) => source.localId) ?? []);
+    for (const [index, entry] of (manifest.targets?.kay?.ui?.contributes?.railEntries ?? []).entries()) {
+      if (entry.badge === void 0)
+        continue;
+      const path = [
+        "targets",
+        "kay",
+        "ui",
+        "contributes",
+        "railEntries",
+        index,
+        "badge"
+      ];
+      if (!declaredRowsStores.has(entry.badge.source)) {
+        ctx.addIssue({
+          code: "custom",
+          path: [...path, "source"],
+          message: `rail entry ${entry.id} counts ${entry.badge.source}, which is not one of this plugin's data sources with a rows store`
+        });
+      }
+      if (manifest.targets?.kay?.ui?.entrypoint === void 0) {
+        ctx.addIssue({
+          code: "custom",
+          path,
+          message: `rail entry ${entry.id} declares a badge, so its plugin needs a kay.ui entrypoint: the window starts a plugin's data sources when it loads that code`
+        });
+      }
+    }
     for (const source of declaredAppDataSources) {
       if (materializedAppDataSources.has(source) || declaredAppDataStores.has(source))
         continue;
@@ -4576,6 +4660,26 @@ function createManifestSchemas(canonical) {
         });
       }
     }
+    for (const [index, entry] of (manifest.targets?.kay?.ui?.contributes?.railEntries ?? []).entries()) {
+      const body = entry.panel?.body;
+      const app = manifest.targets?.kay?.ui?.contributes?.apps?.find((candidate) => candidate.localId === body);
+      if (app !== void 0 && app.contextOnly !== true) {
+        ctx.addIssue({
+          code: "custom",
+          path: [
+            "targets",
+            "kay",
+            "ui",
+            "contributes",
+            "railEntries",
+            index,
+            "panel",
+            "body"
+          ],
+          message: `Rail entry ${entry.id} panel body ${app.localId} must be a contextOnly ui app`
+        });
+      }
+    }
     const subscribedUiEvents = new Set(manifest.targets?.kay?.ui?.contributes?.eventSubscriptions?.map((subscription) => subscription.event) ?? []);
     const invokedUiEndpoints = new Set(manifest.permissions?.byTarget["kay.ui"]?.endpoints?.filter((grant) => grant.operations.includes("invoke")).map((grant) => grant.endpoint) ?? []);
     const uriModuleIds = new Set([
@@ -7099,6 +7203,7 @@ export {
   WhiteboardTypeStorage,
   WhiteboardValue,
   WorkflowContribution,
+  appDataSourceDeclaration,
   approvalKindSchema,
   boundPluginDiagnosticMessage,
   captureArtifactProvenance,
@@ -7113,6 +7218,7 @@ export {
   dedupeClaims,
   deriveDirectoryPluginToolName,
   evaluateCommandWhere,
+  evaluateWhere,
   finalizeArtifactProvenanceEnvelope,
   findSkillSuggestionCitations,
   hasClaim,
@@ -7140,6 +7246,7 @@ export {
   parseKayUiBundleIndexV1,
   parseResolvedPluginContractV1,
   parseSemver,
+  parseWhere,
   pluginIconShape,
   precedingPersonMessages,
   readKayPluginDeclaredCompatibility,
@@ -7152,6 +7259,7 @@ export {
   resolveSessionAncestry,
   retiredCompatibilityKeysIn,
   retiredPermissionAsksIn,
+  rowMatchesWhere,
   safeResolveKayPluginContractV1,
   sameClaim,
   satisfiesSemverRange,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaklabs-ai/plugin-protocol",
-  "version": "0.33.0",
+  "version": "0.35.0",
   "description": "The Kay plugin manifest schema (`kay.plugin.v1`) — parse and validate a kay-plugin.json.",
   "author": "YakLabs",
   "type": "module",