@yaklabs-ai/plugin-protocol 0.55.1 → 0.55.3

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.
Files changed (5) hide show
  1. package/README.md +1 -1
  2. package/THIRD-PARTY-INVENTORY.json +1 -1
  3. package/dist/index.d.ts +42 -1
  4. package/dist/index.js +15 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -11,7 +11,7 @@ flow.
11
11
  ```json
12
12
  {
13
13
  "dependencies": {
14
- "@bonsai/plugin-protocol": "npm:@yaklabs-ai/plugin-protocol@^0.55.1"
14
+ "@bonsai/plugin-protocol": "npm:@yaklabs-ai/plugin-protocol@^0.55.3"
15
15
  }
16
16
  }
17
17
  ```
package/THIRD-PARTY-INVENTORY.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "package": "@yaklabs-ai/plugin-protocol",
4
- "version": "0.55.1",
4
+ "version": "0.55.3",
5
5
  "target": "npm",
6
6
  "firstPartyLicense": "MIT",
7
7
  "bundled": [
package/dist/index.d.ts CHANGED
@@ -438,6 +438,8 @@ export declare const AppUriModuleContribution: z.ZodObject<{
438
438
  search: z.ZodExactOptional<z.ZodString>;
439
439
  }, z.core.$strict>;
440
440
  normalizeTo: z.ZodExactOptional<z.ZodString>;
441
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
442
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
441
443
  route: z.ZodExactOptional<z.ZodString>;
442
444
  sourceUrl: z.ZodExactOptional<z.ZodString>;
443
445
  title: z.ZodExactOptional<z.ZodString>;
@@ -2067,6 +2069,8 @@ declare const canonicalContributionSchemas: {
2067
2069
  search: z.ZodExactOptional<z.ZodString>;
2068
2070
  }, z.core.$strict>;
2069
2071
  normalizeTo: z.ZodExactOptional<z.ZodString>;
2072
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
2073
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
2070
2074
  route: z.ZodExactOptional<z.ZodString>;
2071
2075
  sourceUrl: z.ZodExactOptional<z.ZodString>;
2072
2076
  title: z.ZodExactOptional<z.ZodString>;
@@ -2411,6 +2415,8 @@ declare const canonicalContributionSchemas: {
2411
2415
  search: z.ZodExactOptional<z.ZodString>;
2412
2416
  }, z.core.$strict>;
2413
2417
  normalizeTo: z.ZodExactOptional<z.ZodString>;
2418
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
2419
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
2414
2420
  route: z.ZodExactOptional<z.ZodString>;
2415
2421
  sourceUrl: z.ZodExactOptional<z.ZodString>;
2416
2422
  title: z.ZodExactOptional<z.ZodString>;
@@ -2608,6 +2614,8 @@ declare const canonicalContributionSchemas: {
2608
2614
  search: z.ZodExactOptional<z.ZodString>;
2609
2615
  }, z.core.$strict>;
2610
2616
  normalizeTo: z.ZodExactOptional<z.ZodString>;
2617
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
2618
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
2611
2619
  route: z.ZodExactOptional<z.ZodString>;
2612
2620
  sourceUrl: z.ZodExactOptional<z.ZodString>;
2613
2621
  title: z.ZodExactOptional<z.ZodString>;
@@ -4948,8 +4956,15 @@ export declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
4948
4956
  * 0.55.1 adds canonical path resources on declared tool permissions, asynchronous display-only
4949
4957
  * tool previews with cancellation, app-scoped availability snapshots and app-target output
4950
4958
  * artifact usage declarations. A plugin using these declares ^0.55.1.
4959
+ *
4960
+ * 0.55.2 adds opt-in query and connection-selector preservation during URI claim normalization.
4961
+ *
4962
+ * 0.55.3 lets a signal carry the item's own text. `PluginSignal` gains an optional `body`: plain
4963
+ * text, at most `PLUGIN_SIGNAL_BODY_MAX` (20,000) characters. Gmail puts a mail's text there, so
4964
+ * Flows can keep the messages a task came from. Additive: a plugin that publishes a body declares
4965
+ * ^0.55.3.
4951
4966
  */
4952
- export declare const KAY_PLUGIN_SDK_VERSION: "0.55.1";
4967
+ export declare const KAY_PLUGIN_SDK_VERSION: "0.55.3";
4953
4968
 
4954
4969
  export declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
4955
4970
 
@@ -5079,6 +5094,8 @@ export declare const KayAgentTargetManifest: z.ZodObject<{
5079
5094
  search: z.ZodExactOptional<z.ZodString>;
5080
5095
  }, z.core.$strict>;
5081
5096
  normalizeTo: z.ZodExactOptional<z.ZodString>;
5097
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
5098
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
5082
5099
  route: z.ZodExactOptional<z.ZodString>;
5083
5100
  sourceUrl: z.ZodExactOptional<z.ZodString>;
5084
5101
  title: z.ZodExactOptional<z.ZodString>;
@@ -5467,6 +5484,8 @@ export declare const KayAppTargetManifest: z.ZodObject<{
5467
5484
  search: z.ZodExactOptional<z.ZodString>;
5468
5485
  }, z.core.$strict>;
5469
5486
  normalizeTo: z.ZodExactOptional<z.ZodString>;
5487
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
5488
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
5470
5489
  route: z.ZodExactOptional<z.ZodString>;
5471
5490
  sourceUrl: z.ZodExactOptional<z.ZodString>;
5472
5491
  title: z.ZodExactOptional<z.ZodString>;
@@ -6047,6 +6066,8 @@ export declare const KayPluginManifestV1: z.ZodObject<{
6047
6066
  search: z.ZodExactOptional<z.ZodString>;
6048
6067
  }, z.core.$strict>;
6049
6068
  normalizeTo: z.ZodExactOptional<z.ZodString>;
6069
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
6070
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
6050
6071
  route: z.ZodExactOptional<z.ZodString>;
6051
6072
  sourceUrl: z.ZodExactOptional<z.ZodString>;
6052
6073
  title: z.ZodExactOptional<z.ZodString>;
@@ -6432,6 +6453,8 @@ export declare const KayPluginManifestV1: z.ZodObject<{
6432
6453
  search: z.ZodExactOptional<z.ZodString>;
6433
6454
  }, z.core.$strict>;
6434
6455
  normalizeTo: z.ZodExactOptional<z.ZodString>;
6456
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
6457
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
6435
6458
  route: z.ZodExactOptional<z.ZodString>;
6436
6459
  sourceUrl: z.ZodExactOptional<z.ZodString>;
6437
6460
  title: z.ZodExactOptional<z.ZodString>;
@@ -8798,6 +8821,12 @@ export declare const PLUGIN_SIGNAL_ATTACHMENT_TYPE_MAX = 127;
8798
8821
  /** At most this many entries in a signal's `attachments`; a source lists the first ones. */
8799
8822
  export declare const PLUGIN_SIGNAL_ATTACHMENTS_MAX = 10;
8800
8823
 
8824
+ /**
8825
+ * A signal's `body`, the item's own text, at most this many characters: a source cuts longer text
8826
+ * and marks the cut. Enough for a long email with its quoted history.
8827
+ */
8828
+ export declare const PLUGIN_SIGNAL_BODY_MAX = 20000;
8829
+
8801
8830
  /** The `kind` values of `PluginSignal` v1. `status` is system state that clears itself. */
8802
8831
  export declare const PLUGIN_SIGNAL_KINDS: readonly ["message", "request", "mention", "invite", "status"];
8803
8832
 
@@ -12524,6 +12553,7 @@ export declare const PluginSignal: z.ZodObject<{
12524
12553
  }>>;
12525
12554
  title: z.ZodOptional<z.ZodString>;
12526
12555
  snippet: z.ZodOptional<z.ZodString>;
12556
+ body: z.ZodOptional<z.ZodString>;
12527
12557
  actor: z.ZodOptional<z.ZodObject<{
12528
12558
  name: z.ZodOptional<z.ZodString>;
12529
12559
  uri: z.ZodString;
@@ -12574,6 +12604,7 @@ export declare const PluginSignalPublish: z.ZodObject<{
12574
12604
  }>>;
12575
12605
  title: z.ZodOptional<z.ZodString>;
12576
12606
  snippet: z.ZodOptional<z.ZodString>;
12607
+ body: z.ZodOptional<z.ZodString>;
12577
12608
  actor: z.ZodOptional<z.ZodObject<{
12578
12609
  name: z.ZodOptional<z.ZodString>;
12579
12610
  uri: z.ZodString;
@@ -13318,6 +13349,8 @@ export declare const ResolvedKayAgentUriModule: z.ZodObject<{
13318
13349
  search: z.ZodExactOptional<z.ZodString>;
13319
13350
  }, z.core.$strict>;
13320
13351
  normalizeTo: z.ZodExactOptional<z.ZodString>;
13352
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
13353
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
13321
13354
  route: z.ZodExactOptional<z.ZodString>;
13322
13355
  sourceUrl: z.ZodExactOptional<z.ZodString>;
13323
13356
  title: z.ZodExactOptional<z.ZodString>;
@@ -14830,6 +14863,8 @@ export declare const ResolvedPluginContractV1: z.ZodObject<{
14830
14863
  search: z.ZodExactOptional<z.ZodString>;
14831
14864
  }, z.core.$strict>;
14832
14865
  normalizeTo: z.ZodExactOptional<z.ZodString>;
14866
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
14867
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
14833
14868
  route: z.ZodExactOptional<z.ZodString>;
14834
14869
  sourceUrl: z.ZodExactOptional<z.ZodString>;
14835
14870
  title: z.ZodExactOptional<z.ZodString>;
@@ -15116,6 +15151,8 @@ export declare const ResolvedPluginContractV1: z.ZodObject<{
15116
15151
  search: z.ZodExactOptional<z.ZodString>;
15117
15152
  }, z.core.$strict>;
15118
15153
  normalizeTo: z.ZodExactOptional<z.ZodString>;
15154
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
15155
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
15119
15156
  route: z.ZodExactOptional<z.ZodString>;
15120
15157
  sourceUrl: z.ZodExactOptional<z.ZodString>;
15121
15158
  title: z.ZodExactOptional<z.ZodString>;
@@ -17912,6 +17949,8 @@ export declare const UriModuleContribution: z.ZodObject<{
17912
17949
  search: z.ZodExactOptional<z.ZodString>;
17913
17950
  }, z.core.$strict>;
17914
17951
  normalizeTo: z.ZodExactOptional<z.ZodString>;
17952
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
17953
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
17915
17954
  route: z.ZodExactOptional<z.ZodString>;
17916
17955
  sourceUrl: z.ZodExactOptional<z.ZodString>;
17917
17956
  title: z.ZodExactOptional<z.ZodString>;
@@ -18108,6 +18147,8 @@ declare const UriModuleFacts: z.ZodObject<{
18108
18147
  search: z.ZodExactOptional<z.ZodString>;
18109
18148
  }, z.core.$strict>;
18110
18149
  normalizeTo: z.ZodExactOptional<z.ZodString>;
18150
+ preserveQuery: z.ZodExactOptional<z.ZodLiteral<true>>;
18151
+ preserveConnection: z.ZodExactOptional<z.ZodLiteral<true>>;
18111
18152
  route: z.ZodExactOptional<z.ZodString>;
18112
18153
  sourceUrl: z.ZodExactOptional<z.ZodString>;
18113
18154
  title: z.ZodExactOptional<z.ZodString>;
package/dist/index.js CHANGED
@@ -260,8 +260,10 @@ var JsonSchema = z4.record(z4.string(), JsonValue);
260
260
  var KAY_PLUGIN_MANIFEST_SIZE_CAP_BYTES = 1024 * 1024;
261
261
  var KAY_PLUGIN_PROTOCOL_VERSION = "kay.plugin.v1";
262
262
  var KAY_PLUGIN_PROTOCOL_PACKAGE_NAME = "@bonsai/plugin-protocol";
263
- var KAY_PLUGIN_SDK_VERSION = "0.55.1";
263
+ var KAY_PLUGIN_SDK_VERSION = "0.55.3";
264
264
  var KAY_PLUGIN_COMPATIBLE_SDK_VERSIONS = [
265
+ "0.55.2",
266
+ "0.55.1",
265
267
  "0.55.0",
266
268
  "0.54.2",
267
269
  "0.54.1",
@@ -2952,6 +2954,7 @@ __export(plugin_events_exports, {
2952
2954
  PLUGIN_SIGNAL_ATTACHMENTS_MAX: () => PLUGIN_SIGNAL_ATTACHMENTS_MAX,
2953
2955
  PLUGIN_SIGNAL_ATTACHMENT_NAME_MAX: () => PLUGIN_SIGNAL_ATTACHMENT_NAME_MAX,
2954
2956
  PLUGIN_SIGNAL_ATTACHMENT_TYPE_MAX: () => PLUGIN_SIGNAL_ATTACHMENT_TYPE_MAX,
2957
+ PLUGIN_SIGNAL_BODY_MAX: () => PLUGIN_SIGNAL_BODY_MAX,
2955
2958
  PLUGIN_SIGNAL_KINDS: () => PLUGIN_SIGNAL_KINDS,
2956
2959
  PLUGIN_SIGNAL_LABELS_MAX: () => PLUGIN_SIGNAL_LABELS_MAX,
2957
2960
  PLUGIN_SIGNAL_LABEL_MAX: () => PLUGIN_SIGNAL_LABEL_MAX,
@@ -2985,6 +2988,7 @@ var PLUGIN_SIGNAL_KINDS = [
2985
2988
  ];
2986
2989
  var PLUGIN_SIGNAL_TITLE_MAX = 300;
2987
2990
  var PLUGIN_SIGNAL_SNIPPET_MAX = 500;
2991
+ var PLUGIN_SIGNAL_BODY_MAX = 2e4;
2988
2992
  var PLUGIN_SIGNAL_LABELS_MAX = 20;
2989
2993
  var PLUGIN_SIGNAL_LABEL_MAX = 64;
2990
2994
  var PLUGIN_SIGNAL_ATTACHMENTS_MAX = 10;
@@ -3054,6 +3058,13 @@ function createPluginEventsSchemas(canonical) {
3054
3058
  direction: z12.enum(["in", "out"]).optional(),
3055
3059
  title: z12.string().max(PLUGIN_SIGNAL_TITLE_MAX).optional(),
3056
3060
  snippet: z12.string().max(PLUGIN_SIGNAL_SNIPPET_MAX).optional(),
3061
+ /**
3062
+ * The item's own text as plain text (a mail's body with its quoted history, a chat
3063
+ * message, an invite's description), at most `PLUGIN_SIGNAL_BODY_MAX` characters. A
3064
+ * consumer may keep it as the record of what was said; a source that cannot read it leaves
3065
+ * it out.
3066
+ */
3067
+ body: z12.string().max(PLUGIN_SIGNAL_BODY_MAX).optional(),
3057
3068
  actor: z12.strictObject({
3058
3069
  name: z12.string().max(PLUGIN_SIGNAL_TITLE_MAX).optional(),
3059
3070
  uri: PluginEventUri2
@@ -3677,6 +3688,8 @@ function createContributionsSchemas(canonical) {
3677
3688
  kind: z14.literal("uriPattern"),
3678
3689
  pattern: UriPatternInit,
3679
3690
  normalizeTo: NonEmptyString3.exactOptional(),
3691
+ preserveQuery: z14.literal(true).exactOptional(),
3692
+ preserveConnection: z14.literal(true).exactOptional(),
3680
3693
  route: LocalContributionId2.exactOptional(),
3681
3694
  sourceUrl: NonEmptyString3.exactOptional(),
3682
3695
  title: NonEmptyString3.exactOptional(),
@@ -8607,6 +8620,7 @@ export {
8607
8620
  PLUGIN_SIGNAL_ATTACHMENTS_MAX,
8608
8621
  PLUGIN_SIGNAL_ATTACHMENT_NAME_MAX,
8609
8622
  PLUGIN_SIGNAL_ATTACHMENT_TYPE_MAX,
8623
+ PLUGIN_SIGNAL_BODY_MAX,
8610
8624
  PLUGIN_SIGNAL_KINDS,
8611
8625
  PLUGIN_SIGNAL_LABELS_MAX,
8612
8626
  PLUGIN_SIGNAL_LABEL_MAX,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yaklabs-ai/plugin-protocol",
3
- "version": "0.55.1",
3
+ "version": "0.55.3",
4
4
  "description": "The Kay plugin manifest schema (`kay.plugin.v1`) — parse and validate a kay-plugin.json.",
5
5
  "author": "YakLabs",
6
6
  "type": "module",