@yaklabs-ai/plugin-sdk 0.42.1 → 0.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -13,7 +13,7 @@ it under the name your plugin code actually imports:
13
13
  ```json
14
14
  {
15
15
  "dependencies": {
16
- "@bonsai/plugin-sdk": "npm:@yaklabs-ai/plugin-sdk@^0.42.1"
16
+ "@bonsai/plugin-sdk": "npm:@yaklabs-ai/plugin-sdk@^0.43.0"
17
17
  }
18
18
  }
19
19
  ```
@@ -62,7 +62,7 @@ Every tool the entrypoint registers is declared in the manifest too:
62
62
  "description": "Greets people by name.",
63
63
  "version": "0.1.0",
64
64
  "namespace": "widgets",
65
- "compatibility": { "sdk": "^0.42.1" },
65
+ "compatibility": { "sdk": "^0.43.0" },
66
66
  "targets": {
67
67
  "kay": {
68
68
  "agent": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "package": "@yaklabs-ai/plugin-sdk",
4
- "version": "0.42.1",
4
+ "version": "0.43.0",
5
5
  "target": "npm",
6
6
  "firstPartyLicense": "MIT",
7
7
  "bundled": [
@@ -2424,8 +2424,11 @@ declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
2424
2424
  *
2425
2425
  * 0.42.1 adds current-session tool lifetimes and invocation-bound artifact reads/new outputs,
2426
2426
  * plus described-tool execution, guidance and permission resource metadata.
2427
+ *
2428
+ * 0.43.0 adds product events (#15769). `productEvents` in a plugin's `kay.app` target declares them,
2429
+ * and `app.productEvents.send` sends them. Additive: a plugin that declares one declares ^0.43.0.
2427
2430
  */
2428
- declare const KAY_PLUGIN_SDK_VERSION: "0.42.1";
2431
+ declare const KAY_PLUGIN_SDK_VERSION: "0.43.0";
2429
2432
 
2430
2433
  declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
2431
2434
 
@@ -2478,8 +2478,11 @@ declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
2478
2478
  *
2479
2479
  * 0.42.1 adds current-session tool lifetimes and invocation-bound artifact reads/new outputs,
2480
2480
  * plus described-tool execution, guidance and permission resource metadata.
2481
+ *
2482
+ * 0.43.0 adds product events (#15769). `productEvents` in a plugin's `kay.app` target declares them,
2483
+ * and `app.productEvents.send` sends them. Additive: a plugin that declares one declares ^0.43.0.
2481
2484
  */
2482
- declare const KAY_PLUGIN_SDK_VERSION: "0.42.1";
2485
+ declare const KAY_PLUGIN_SDK_VERSION: "0.43.0";
2483
2486
 
2484
2487
  declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
2485
2488
 
@@ -2753,8 +2753,11 @@ declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
2753
2753
  *
2754
2754
  * 0.42.1 adds current-session tool lifetimes and invocation-bound artifact reads/new outputs,
2755
2755
  * plus described-tool execution, guidance and permission resource metadata.
2756
+ *
2757
+ * 0.43.0 adds product events (#15769). `productEvents` in a plugin's `kay.app` target declares them,
2758
+ * and `app.productEvents.send` sends them. Additive: a plugin that declares one declares ^0.43.0.
2756
2759
  */
2757
- declare const KAY_PLUGIN_SDK_VERSION: "0.42.1";
2760
+ declare const KAY_PLUGIN_SDK_VERSION: "0.43.0";
2758
2761
 
2759
2762
  declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
2760
2763
 
package/dist/kay-app.d.ts CHANGED
@@ -501,6 +501,15 @@ declare function BigInt_3(options?: TNumberOptions): TBigInt;
501
501
 
502
502
  declare const BigIntPattern = "-?(?:0|[1-9][0-9]*)n";
503
503
 
504
+ export declare interface BonsaiProductEvents {
505
+ /**
506
+ * Sends one event this plugin declares in its manifest, or a catalog event it names there. A
507
+ * field the declaration does not name is not sent. An event it does not declare, or a value that
508
+ * does not fit, is dropped with a diagnostic in the daemon's log. Returns nothing and never throws.
509
+ */
510
+ send(name: string, input?: PluginProductEventSend): void;
511
+ }
512
+
504
513
  /** Creates a Boolean type. */
505
514
  declare function Boolean_2(options?: TSchemaOptions): TBoolean;
506
515
 
@@ -2729,8 +2738,11 @@ declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
2729
2738
  *
2730
2739
  * 0.42.1 adds current-session tool lifetimes and invocation-bound artifact reads/new outputs,
2731
2740
  * plus described-tool execution, guidance and permission resource metadata.
2741
+ *
2742
+ * 0.43.0 adds product events (#15769). `productEvents` in a plugin's `kay.app` target declares them,
2743
+ * and `app.productEvents.send` sends them. Additive: a plugin that declares one declares ^0.43.0.
2732
2744
  */
2733
- declare const KAY_PLUGIN_SDK_VERSION: "0.42.1";
2745
+ declare const KAY_PLUGIN_SDK_VERSION: "0.43.0";
2734
2746
 
2735
2747
  declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
2736
2748
 
@@ -5355,6 +5367,8 @@ export declare interface KayAppPluginApi {
5355
5367
  readonly endpoints: KayAppEndpoints;
5356
5368
  /** Publish one event declared by this plugin's `kay.app` manifest target. */
5357
5369
  readonly events: KayAppPluginEvents;
5370
+ /** Sends the product events this plugin declares in its manifest. */
5371
+ readonly productEvents: BonsaiProductEvents;
5358
5372
  /** The fine per-tool, app-wide event stream. */
5359
5373
  readonly toolEvents: KayAppToolEvents;
5360
5374
  /** Register an app-scoped URI module, active-by-default in every session. */
@@ -9831,6 +9845,16 @@ declare const PluginNamespace: z.ZodString;
9831
9845
 
9832
9846
  declare type PluginNamespace = z.infer<typeof PluginNamespace>;
9833
9847
 
9848
+ /** What a send of a product event carries, from a plugin's code or its page. */
9849
+ export declare interface PluginProductEventSend {
9850
+ /** Declared fields of either class. A field the declaration does not name is not sent. */
9851
+ readonly properties?: Readonly<Record<string, string | number | boolean>>;
9852
+ /** The session it is about, when there is one. Exported, so it must be a session id. */
9853
+ readonly sessionId?: string;
9854
+ /** The address it is about. Stays on the device. */
9855
+ readonly subjectUri?: string;
9856
+ }
9857
+
9834
9858
  export declare const PluginSignal: z.ZodObject<{
9835
9859
  kind: z.ZodEnum<{
9836
9860
  message: "message";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yaklabs-ai/plugin-sdk",
3
- "version": "0.42.1",
3
+ "version": "0.43.0",
4
4
  "description": "The Kay plugin SDK — types and helpers for authoring a Kay directory plugin.",
5
5
  "author": "YakLabs",
6
6
  "type": "module",