@yaklabs-ai/plugin-protocol 0.36.0 → 0.37.0

package/README.md

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

package/THIRD-PARTY-INVENTORY.json

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

package/dist/index.d.ts

@@ -1689,6 +1689,7 @@ declare namespace authoringContributionSchemas {
         KayUiAppHostCapability,
         UiAppCapabilities,
         UiRailEntryContribution,
+        UiToastPreviewContribution,
         UiPageContribution,
         UiAppContribution,
         ThemeContribution,
@@ -2799,6 +2800,11 @@ declare const canonicalContributionSchemas: {
             body: z.ZodString;
         }, z.core.$strict>>;
     }, z.core.$strict>;
+    UiToastPreviewContribution: z.ZodObject<{
+        rule: z.ZodString;
+        body: z.ZodString;
+        address: z.ZodString;
+    }, z.core.$strict>;
     UiPageContribution: z.ZodObject<{
         id: z.ZodString;
         title: z.ZodOptional<z.ZodString>;
@@ -4141,8 +4147,13 @@ export declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
  * under `kay.ui` `contributes` names each page's title, icon file, companion status and opened
  * event. A reference presentation that opens a page gains `scheme` and `addresses`, and may leave
  * out `uriModule` when another layer serves the address. A plugin using these declares ^0.36.0.
+ *
+ * 0.37.0 lets a notification rule's toast declare a preview (#15904). `toastPreviews` under `kay.ui`
+ * `contributes` names the `rule`, the `body` that fills the preview, either a `contextOnly` app in
+ * the plugin or a body the host ships, and the `address` it is about. Additive. A plugin that
+ * declares a preview declares ^0.37.0.
  */
-export declare const KAY_PLUGIN_SDK_VERSION: "0.36.0";
+export declare const KAY_PLUGIN_SDK_VERSION: "0.37.0";
 
 export declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
 
@@ -5784,6 +5795,11 @@ export declare const KayPluginManifestV1: z.ZodObject<{
                             body: z.ZodString;
                         }, z.core.$strict>>;
                     }, z.core.$strict>>>;
+                    toastPreviews: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                        rule: z.ZodString;
+                        body: z.ZodString;
+                        address: z.ZodString;
+                    }, z.core.$strict>>>;
                     pages: z.ZodOptional<z.ZodArray<z.ZodObject<{
                         id: z.ZodString;
                         title: z.ZodOptional<z.ZodString>;
@@ -6912,6 +6928,11 @@ export declare const KayUiTargetManifest: z.ZodObject<{
                 body: z.ZodString;
             }, z.core.$strict>>;
         }, z.core.$strict>>>;
+        toastPreviews: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            rule: z.ZodString;
+            body: z.ZodString;
+            address: z.ZodString;
+        }, z.core.$strict>>>;
         pages: z.ZodOptional<z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             title: z.ZodOptional<z.ZodString>;
@@ -14080,6 +14101,14 @@ export declare const UiSlotContribution: z.ZodObject<{
 
 export declare type UiSlotContribution = z.infer<typeof UiSlotContribution>;
 
+export declare const UiToastPreviewContribution: z.ZodObject<{
+    rule: z.ZodString;
+    body: z.ZodString;
+    address: z.ZodString;
+}, z.core.$strict>;
+
+export declare type UiToastPreviewContribution = z.infer<typeof UiToastPreviewContribution>;
+
 export declare const UriModuleContribution: z.ZodObject<{
     authService: z.ZodOptional<z.ZodString>;
     authScheme: z.ZodOptional<z.ZodString>;

package/dist/index.js

@@ -254,7 +254,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.36.0";
+var KAY_PLUGIN_SDK_VERSION = "0.37.0";
 var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
   "0.26.3",
   "0.27.1",
@@ -265,7 +265,8 @@ var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
   "0.32.0",
   "0.33.0",
   "0.34.0",
-  "0.35.0"
+  "0.35.0",
+  "0.36.0"
 ];
 var KAY_PLUGIN_TARGET_NAMES = [
   "kay.agent",
@@ -2762,6 +2763,7 @@ __export(contributions_exports, {
   UiPageContribution: () => UiPageContribution,
   UiRailEntryContribution: () => UiRailEntryContribution,
   UiSlotContribution: () => UiSlotContribution,
+  UiToastPreviewContribution: () => UiToastPreviewContribution,
   UriModuleContribution: () => UriModuleContribution,
   UriModuleFacts: () => UriModuleFacts,
   WhiteboardTypeContribution: () => WhiteboardTypeContribution,
@@ -3843,6 +3845,11 @@ function createContributionsSchemas(canonical) {
     badge: UiRailBadge.optional(),
     panel: z12.strictObject({ body: LocalContributionId2 }).optional()
   });
+  const UiToastPreviewContribution2 = z12.strictObject({
+    rule: LocalContributionId2,
+    body: LocalContributionId2,
+    address: NonEmptyString3
+  });
   const UiPageContribution2 = z12.strictObject({
     id: NonEmptyString3,
     title: NonEmptyString3.optional(),
@@ -3992,6 +3999,7 @@ function createContributionsSchemas(canonical) {
     KayUiAppHostCapability: KayUiAppHostCapability2,
     UiAppCapabilities: UiAppCapabilities2,
     UiRailEntryContribution: UiRailEntryContribution2,
+    UiToastPreviewContribution: UiToastPreviewContribution2,
     UiPageContribution: UiPageContribution2,
     UiAppContribution: UiAppContribution2,
     ThemeContribution: ThemeContribution2,
@@ -4000,7 +4008,7 @@ function createContributionsSchemas(canonical) {
     PluginContributionKind: PluginContributionKind2
   };
 }
-var { ApprovalCardForm, ApprovalCardStoredForm, ApprovalTypeContribution, UriModuleFacts, ToolContribution, ToolPermission, AgentToolContribution, ConverterContribution, UriModuleContribution, AppUriModuleContribution, AppDataSourceContribution, WhiteboardTypeStorage, WhiteboardTypeContribution, AppDataMaterializerContribution, ArtifactUriModuleContribution, CliBindingContribution, GitHostContribution, ResourceContribution, SkillContribution, PluginSkillSourceDeclaration, SearchProviderContribution, InteractionDriverContribution, EntityResolverContribution, AgentRenderContribution, EndpointContribution, WorkflowContribution, McpServerUrl, McpServerAuthMode, McpServerContribution, McpServerContributions, AppEventSubscription, ContextContributorContribution, PluginEventDefinitionContribution, PluginNotificationRuleContribution, UiEventSubscriptionContribution, DeviceDelegationContribution, SessionReaderContribution, UiCommandContribution, UiSlotContribution, SettingsPanelContribution, ResultRendererContribution, ReferenceOpenBehavior, ReferencePresentationVariant, ReferencePresentationVariants, ReferencePresentationUriPattern, ReferencePresentationUrlClaim, ReferencePresentationTooltip, ReferencePresentationAddress, ReferencePresentationContribution, RichViewContribution, KayUiAppHostCapability, UiAppCapabilities, UiRailEntryContribution, UiPageContribution, UiAppContribution, ThemeContribution, CommandHandler, CommandContribution, PluginContributionKind } = createContributionsSchemas(false);
+var { ApprovalCardForm, ApprovalCardStoredForm, ApprovalTypeContribution, UriModuleFacts, ToolContribution, ToolPermission, AgentToolContribution, ConverterContribution, UriModuleContribution, AppUriModuleContribution, AppDataSourceContribution, WhiteboardTypeStorage, WhiteboardTypeContribution, AppDataMaterializerContribution, ArtifactUriModuleContribution, CliBindingContribution, GitHostContribution, ResourceContribution, SkillContribution, PluginSkillSourceDeclaration, SearchProviderContribution, InteractionDriverContribution, EntityResolverContribution, AgentRenderContribution, EndpointContribution, WorkflowContribution, McpServerUrl, McpServerAuthMode, McpServerContribution, McpServerContributions, AppEventSubscription, ContextContributorContribution, PluginEventDefinitionContribution, PluginNotificationRuleContribution, UiEventSubscriptionContribution, DeviceDelegationContribution, SessionReaderContribution, UiCommandContribution, UiSlotContribution, SettingsPanelContribution, ResultRendererContribution, ReferenceOpenBehavior, ReferencePresentationVariant, ReferencePresentationVariants, ReferencePresentationUriPattern, ReferencePresentationUrlClaim, ReferencePresentationTooltip, ReferencePresentationAddress, ReferencePresentationContribution, RichViewContribution, KayUiAppHostCapability, UiAppCapabilities, UiRailEntryContribution, UiToastPreviewContribution, UiPageContribution, UiAppContribution, ThemeContribution, CommandHandler, CommandContribution, PluginContributionKind } = createContributionsSchemas(false);
 var canonicalContributionSchemas = createContributionsSchemas(true);
 
 // packages/plugin-protocol/dist/icon-shape.js
@@ -4074,7 +4082,7 @@ var KAY_UI_NATIVE_EVENT_SUBSCRIPTIONS = [
 var KAY_UI_NATIVE_EVENT_ALLOWLIST = new Set(KAY_UI_NATIVE_EVENT_SUBSCRIPTIONS);
 var RETIRED_COMPATIBILITY_KEYS = ["policy"];
 function createManifestSchemas(canonical) {
-  const { AgentRenderContribution: AgentRenderContribution2, ApprovalTypeContribution: ApprovalTypeContribution2, WorkflowContribution: WorkflowContribution2, AppDataMaterializerContribution: AppDataMaterializerContribution2, AppDataSourceContribution: AppDataSourceContribution2, AppUriModuleContribution: AppUriModuleContribution2, AppEventSubscription: AppEventSubscription2, ArtifactUriModuleContribution: ArtifactUriModuleContribution2, CliBindingContribution: CliBindingContribution2, CommandContribution: CommandContribution2, ContextContributorContribution: ContextContributorContribution2, ConverterContribution: ConverterContribution2, SessionReaderContribution: SessionReaderContribution2, DeviceDelegationContribution: DeviceDelegationContribution2, EndpointContribution: EndpointContribution2, EntityResolverContribution: EntityResolverContribution2, GitHostContribution: GitHostContribution2, McpServerContributions: McpServerContributions2, PluginEventDefinitionContribution: PluginEventDefinitionContribution2, PluginNotificationRuleContribution: PluginNotificationRuleContribution2, ResourceContribution: ResourceContribution2, ReferencePresentationContribution: ReferencePresentationContribution2, ResultRendererContribution: ResultRendererContribution2, RichViewContribution: RichViewContribution2, PluginSkillSourceDeclaration: PluginSkillSourceDeclaration2, InteractionDriverContribution: InteractionDriverContribution2, SearchProviderContribution: SearchProviderContribution2, SkillContribution: SkillContribution2, SettingsPanelContribution: SettingsPanelContribution2, ThemeContribution: ThemeContribution2, AgentToolContribution: AgentToolContribution2, ToolContribution: ToolContribution2, UiCommandContribution: UiCommandContribution2, UiAppContribution: UiAppContribution2, UiRailEntryContribution: UiRailEntryContribution2, UiPageContribution: UiPageContribution2, UiEventSubscriptionContribution: UiEventSubscriptionContribution2, UiSlotContribution: UiSlotContribution2, UriModuleContribution: UriModuleContribution2, WhiteboardTypeContribution: WhiteboardTypeContribution2 } = canonical ? canonicalContributionSchemas : contributions_exports;
+  const { AgentRenderContribution: AgentRenderContribution2, ApprovalTypeContribution: ApprovalTypeContribution2, WorkflowContribution: WorkflowContribution2, AppDataMaterializerContribution: AppDataMaterializerContribution2, AppDataSourceContribution: AppDataSourceContribution2, AppUriModuleContribution: AppUriModuleContribution2, AppEventSubscription: AppEventSubscription2, ArtifactUriModuleContribution: ArtifactUriModuleContribution2, CliBindingContribution: CliBindingContribution2, CommandContribution: CommandContribution2, ContextContributorContribution: ContextContributorContribution2, ConverterContribution: ConverterContribution2, SessionReaderContribution: SessionReaderContribution2, DeviceDelegationContribution: DeviceDelegationContribution2, EndpointContribution: EndpointContribution2, EntityResolverContribution: EntityResolverContribution2, GitHostContribution: GitHostContribution2, McpServerContributions: McpServerContributions2, PluginEventDefinitionContribution: PluginEventDefinitionContribution2, PluginNotificationRuleContribution: PluginNotificationRuleContribution2, ResourceContribution: ResourceContribution2, ReferencePresentationContribution: ReferencePresentationContribution2, ResultRendererContribution: ResultRendererContribution2, RichViewContribution: RichViewContribution2, PluginSkillSourceDeclaration: PluginSkillSourceDeclaration2, InteractionDriverContribution: InteractionDriverContribution2, SearchProviderContribution: SearchProviderContribution2, SkillContribution: SkillContribution2, SettingsPanelContribution: SettingsPanelContribution2, ThemeContribution: ThemeContribution2, AgentToolContribution: AgentToolContribution2, ToolContribution: ToolContribution2, UiCommandContribution: UiCommandContribution2, UiAppContribution: UiAppContribution2, UiRailEntryContribution: UiRailEntryContribution2, UiToastPreviewContribution: UiToastPreviewContribution2, UiPageContribution: UiPageContribution2, UiEventSubscriptionContribution: UiEventSubscriptionContribution2, UiSlotContribution: UiSlotContribution2, UriModuleContribution: UriModuleContribution2, WhiteboardTypeContribution: WhiteboardTypeContribution2 } = canonical ? canonicalContributionSchemas : contributions_exports;
   const { HttpsUrl: HttpsUrl2, LocalContributionId: LocalContributionId2, NonEmptyString: NonEmptyString3, PackageAssetPath: PackageAssetPath2, PluginId: PluginId2, PluginNamespace: PluginNamespace2, RegistrableDomain: RegistrableDomain2, SignedInStatusCode: SignedInStatusCode2, TargetEntrypoint: TargetEntrypoint2 } = canonical ? canonicalCommonSchemas : common_exports;
   const { PluginPermissionManifest: PluginPermissionManifest2 } = canonical ? canonicalPermissionSchemas : permissions_exports;
   const KayAgentTargetManifest2 = z13.strictObject({
@@ -4197,6 +4205,7 @@ function createManifestSchemas(canonical) {
       views: z13.array(RichViewContribution2).optional(),
       apps: z13.array(UiAppContribution2).optional(),
       railEntries: z13.array(UiRailEntryContribution2).optional(),
+      toastPreviews: z13.array(UiToastPreviewContribution2).optional(),
       pages: z13.array(UiPageContribution2).optional(),
       themes: z13.array(ThemeContribution2).optional(),
       eventSubscriptions: z13.array(UiEventSubscriptionContribution2).optional(),
@@ -4746,6 +4755,50 @@ function createManifestSchemas(canonical) {
         });
       }
     }
+    const notificationRuleIds = new Set(manifest.targets?.kay?.app?.contributes?.notificationRules?.map((rule) => rule.localId) ?? []);
+    const previewedRules = /* @__PURE__ */ new Set();
+    for (const [index, preview] of (manifest.targets?.kay?.ui?.contributes?.toastPreviews ?? []).entries()) {
+      const path = [
+        "targets",
+        "kay",
+        "ui",
+        "contributes",
+        "toastPreviews",
+        index
+      ];
+      if (!notificationRuleIds.has(preview.rule)) {
+        ctx.addIssue({
+          code: "custom",
+          path: [...path, "rule"],
+          message: `Toast preview references unknown notification rule ${preview.rule}`
+        });
+      }
+      if (previewedRules.has(preview.rule)) {
+        ctx.addIssue({
+          code: "custom",
+          path: [...path, "rule"],
+          message: `Notification rule ${preview.rule} has more than one toast preview`
+        });
+      }
+      previewedRules.add(preview.rule);
+      for (const [, name] of preview.address.matchAll(/\$\{([^}]*)\}/g)) {
+        if (name !== "navigateTarget" && name !== "revision") {
+          ctx.addIssue({
+            code: "custom",
+            path: [...path, "address"],
+            message: `Toast preview address can't fill \${${name}}: only \${navigateTarget} and \${revision}`
+          });
+        }
+      }
+      const app = manifest.targets?.kay?.ui?.contributes?.apps?.find((candidate) => candidate.localId === preview.body);
+      if (app !== void 0 && app.contextOnly !== true) {
+        ctx.addIssue({
+          code: "custom",
+          path: [...path, "body"],
+          message: `Toast preview 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([
@@ -7285,6 +7338,7 @@ export {
   UiPageContribution,
   UiRailEntryContribution,
   UiSlotContribution,
+  UiToastPreviewContribution,
   UriModuleContribution,
   UriScheme,
   WEB_SESSION_CSRF_SELECTOR_PATTERN,

package/package.json

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