@yaklabs-ai/plugin-protocol 0.31.0 → 0.32.0

package/README.md

@@ -11,7 +11,7 @@ flow.
 ```json
 {
   "dependencies": {
-    "@bonsai/plugin-protocol": "npm:@yaklabs-ai/plugin-protocol@^0.31.0"
+    "@bonsai/plugin-protocol": "npm:@yaklabs-ai/plugin-protocol@^0.32.0"
   }
 }
 ```

package/THIRD-PARTY-INVENTORY.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "package": "@yaklabs-ai/plugin-protocol",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "target": "npm",
   "firstPartyLicense": "MIT",
   "bundled": [],

package/dist/index.d.ts

@@ -106,6 +106,13 @@ export declare const AppDataSourceContribution: z.ZodObject<{
             schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
         }, z.core.$strict>;
     }, z.core.$strict>>;
+    store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        shape: z.ZodLiteral<"rows">;
+        rowsField: z.ZodString;
+        key: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        shape: z.ZodLiteral<"value">;
+    }, z.core.$strict>], "shape">>;
 }, z.core.$strict>;
 
 export declare type AppDataSourceContribution = z.infer<typeof AppDataSourceContribution>;
@@ -2365,6 +2372,13 @@ declare const canonicalContributionSchemas: {
                 schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
             }, z.core.$strict>;
         }, z.core.$strict>>;
+        store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            shape: z.ZodLiteral<"rows">;
+            rowsField: z.ZodString;
+            key: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>, z.ZodObject<{
+            shape: z.ZodLiteral<"value">;
+        }, z.core.$strict>], "shape">>;
     }, z.core.$strict>;
     WhiteboardTypeStorage: z.ZodDiscriminatedUnion<[z.ZodObject<{
         kind: z.ZodLiteral<"json">;
@@ -3991,8 +4005,12 @@ export declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
  * `contributes` names each entry's title, page, shortcut and icon file. It replaces `activityRail` on a
  * UI app, which is stripped from a manifest that still carries it, so that manifest loses only the
  * rail button. A plugin that declares a rail entry declares ^0.31.0.
+ *
+ * 0.32.0 lets an app-data source declare its window store as data (#15891). `store` under
+ * `contributes.dataSources` replaces a `kay.ui` data materializer, and a change too big for a live
+ * update becomes a re-read of the snapshot. A plugin that declares a store declares ^0.32.0.
  */
-export declare const KAY_PLUGIN_SDK_VERSION: "0.31.0";
+export declare const KAY_PLUGIN_SDK_VERSION: "0.32.0";
 
 export declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
 
@@ -4491,6 +4509,13 @@ export declare const KayAppTargetManifest: z.ZodObject<{
                     schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
                 }, z.core.$strict>;
             }, z.core.$strict>>;
+            store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                shape: z.ZodLiteral<"rows">;
+                rowsField: z.ZodString;
+                key: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                shape: z.ZodLiteral<"value">;
+            }, z.core.$strict>], "shape">>;
         }, z.core.$strict>>>;
         whiteboardTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
             localId: z.ZodString;
@@ -5255,6 +5280,13 @@ export declare const KayPluginManifestV1: z.ZodObject<{
                                 schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
                             }, z.core.$strict>;
                         }, z.core.$strict>>;
+                        store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                            shape: z.ZodLiteral<"rows">;
+                            rowsField: z.ZodString;
+                            key: z.ZodArray<z.ZodString>;
+                        }, z.core.$strict>, z.ZodObject<{
+                            shape: z.ZodLiteral<"value">;
+                        }, z.core.$strict>], "shape">>;
                     }, z.core.$strict>>>;
                     whiteboardTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
                         localId: z.ZodString;
@@ -10639,6 +10671,13 @@ export declare const ResolvedKayAppDataSource: z.ZodObject<{
             schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
         }, z.core.$strict>;
     }, z.core.$strict>>;
+    store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        shape: z.ZodLiteral<"rows">;
+        rowsField: z.ZodString;
+        key: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        shape: z.ZodLiteral<"value">;
+    }, z.core.$strict>], "shape">>;
 }, z.core.$strict>;
 
 export declare type ResolvedKayAppDataSource = z.infer<typeof ResolvedKayAppDataSource>;
@@ -11911,6 +11950,13 @@ export declare const ResolvedPluginContractV1: z.ZodObject<{
                 schema: z.ZodRecord<z.ZodString, z.ZodType<authoringCommonSchemas.JsonValue, unknown, z.core.$ZodTypeInternals<authoringCommonSchemas.JsonValue, unknown>>>;
             }, z.core.$strict>;
         }, z.core.$strict>>;
+        store: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            shape: z.ZodLiteral<"rows">;
+            rowsField: z.ZodString;
+            key: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>, z.ZodObject<{
+            shape: z.ZodLiteral<"value">;
+        }, z.core.$strict>], "shape">>;
     }, z.core.$strict>>>;
     kayAppWhiteboardTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
         localId: z.ZodString;

package/dist/index.js

@@ -230,13 +230,14 @@ 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.31.0";
+var KAY_PLUGIN_SDK_VERSION = "0.32.0";
 var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
   "0.26.3",
   "0.27.1",
   "0.28.0",
   "0.29.0",
-  "0.30.0"
+  "0.30.0",
+  "0.31.0"
 ];
 var KAY_PLUGIN_TARGET_NAMES = [
   "kay.agent",
@@ -3095,6 +3096,14 @@ function createContributionsSchemas(canonical) {
     knownResources: true,
     describesOperations: true
   });
+  const AppDataSourceStore = z12.discriminatedUnion("shape", [
+    z12.strictObject({
+      shape: z12.literal("rows"),
+      rowsField: NonEmptyString3,
+      key: z12.array(NonEmptyString3).min(1)
+    }),
+    z12.strictObject({ shape: z12.literal("value") })
+  ]);
   const AppDataSourceContribution2 = z12.strictObject({
     localId: LocalContributionId2,
     scope: z12.enum(["runtime", "account", "session"]),
@@ -3115,7 +3124,8 @@ function createContributionsSchemas(canonical) {
         })
       ]).optional()
     }),
-    read: AppDataSourceRead.optional()
+    read: AppDataSourceRead.optional(),
+    store: AppDataSourceStore.optional()
   }).superRefine((source, ctx) => {
     if (source.read !== void 0 && source.scope !== "session") {
       ctx.addIssue({
@@ -3124,6 +3134,23 @@ function createContributionsSchemas(canonical) {
         message: "App-data read operations require session scope."
       });
     }
+    if (source.store === void 0)
+      return;
+    if (source.scope === "session") {
+      ctx.addIssue({
+        code: "custom",
+        path: ["store"],
+        message: "A declared app-data store requires runtime or account scope."
+      });
+    }
+    const replaces = source.change.semantics?.kind === "snapshot-replacement";
+    if (replaces !== (source.store.shape === "value")) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["store"],
+        message: "A value store requires snapshot-replacement changes, and a rows store forbids them."
+      });
+    }
   });
   const WhiteboardTypeStorage2 = z12.discriminatedUnion("kind", [
     z12.strictObject({ kind: z12.literal("json") }),
@@ -4291,6 +4318,7 @@ function createManifestSchemas(canonical) {
     }
     reportDuplicateLocalIds(ctx, ["targets", "kay", "app", "contributes", "notificationRules"], manifest.targets?.kay?.app?.contributes?.notificationRules, "notification rule");
     const declaredAppDataSources = new Set(manifest.targets?.kay?.app?.contributes?.dataSources?.map((source) => source.localId) ?? []);
+    const declaredAppDataStores = new Set(manifest.targets?.kay?.app?.contributes?.dataSources?.filter((source) => source.store !== void 0).map((source) => source.localId) ?? []);
     const materializedAppDataSources = /* @__PURE__ */ new Set();
     for (const [index, materializer] of (manifest.targets?.kay?.ui?.contributes?.dataMaterializers ?? []).entries()) {
       if (!declaredAppDataSources.has(materializer.source)) {
@@ -4323,15 +4351,30 @@ function createManifestSchemas(canonical) {
           message: `app-data source ${materializer.source} has more than one materializer`
         });
       }
+      if (declaredAppDataStores.has(materializer.source)) {
+        ctx.addIssue({
+          code: "custom",
+          path: [
+            "targets",
+            "kay",
+            "ui",
+            "contributes",
+            "dataMaterializers",
+            index,
+            "source"
+          ],
+          message: `app-data source ${materializer.source} declares a store and a materializer`
+        });
+      }
       materializedAppDataSources.add(materializer.source);
     }
     for (const source of declaredAppDataSources) {
-      if (materializedAppDataSources.has(source))
+      if (materializedAppDataSources.has(source) || declaredAppDataStores.has(source))
         continue;
       ctx.addIssue({
         code: "custom",
         path: ["targets", "kay", "app", "contributes", "dataSources"],
-        message: `app-data source ${source} has no same-plugin UI materializer`
+        message: `app-data source ${source} has no declared store and no same-plugin UI materializer`
       });
     }
     reportDuplicateLocalIds(ctx, ["targets", "kay", "app", "contributes", "whiteboardTypes"], manifest.targets?.kay?.app?.contributes?.whiteboardTypes, "Whiteboard type");
@@ -5128,7 +5171,15 @@ function createResolvedContractSchemas(canonical) {
         })
       ]).optional()
     }),
-    read: AppDataSourceRead.optional()
+    read: AppDataSourceRead.optional(),
+    store: z14.discriminatedUnion("shape", [
+      z14.strictObject({
+        shape: z14.literal("rows"),
+        rowsField: z14.string().min(1),
+        key: z14.array(z14.string().min(1)).min(1)
+      }),
+      z14.strictObject({ shape: z14.literal("value") })
+    ]).optional()
   }).superRefine((source, ctx) => {
     if (source.read !== void 0 && source.scope !== "session") {
       ctx.addIssue({
@@ -5769,7 +5820,8 @@ function resolveKayPluginContractV1(manifest) {
     scope: source.scope,
     snapshot: source.snapshot,
     change: source.change,
-    ...source.read === void 0 ? {} : { read: source.read }
+    ...source.read === void 0 ? {} : { read: source.read },
+    ...source.store === void 0 ? {} : { store: source.store }
   }));
   const kayAppApprovalTypes = manifest.targets?.kay?.app?.contributes?.approvalTypes?.map(({ uriModule, ...type }) => {
     const authService = manifest.targets?.kay?.agent?.contributes?.uriModules?.find((candidate) => candidate.localId === uriModule)?.authService;

package/package.json

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