@yaklabs-ai/plugin-protocol 0.55.4 → 0.55.6

package/README.md

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

package/THIRD-PARTY-INVENTORY.json

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

package/dist/index.d.ts

@@ -4138,6 +4138,9 @@ export declare function isKayPluginCompatibilityRefusal(code: string): code is K
 /** Whether `name` can name a declared event: the shape above, and not the journal's own family. */
 export declare function isPluginProductEventName(name: string): boolean;
 
+/** Whether a custom entry type is a plugin state entry's. */
+export declare function isPluginStateEntryCustomType(customType: string): boolean;
+
 /** Whether only plugins the release carries may hold `claim` ({@link PRIVATE_PLUGIN_CAPABILITY_SLUGS}). */
 export declare function isPrivateCapabilityClaim(claim: PluginCapabilityClaimV1): boolean;
 
@@ -4968,8 +4971,19 @@ export declare const KAY_PLUGIN_PROTOCOL_VERSION: "kay.plugin.v1";
  * of the installed, enabled plugins, with the plugin's id and display name and whether the person
  * has connected it. No account, identity or scope. Built-ins hold the claim; any other plugin needs
  * a grant. Additive; plugins calling it declare ^0.55.4.
+ *
+ * 0.55.5 adds `app.sessions.readState()` and `writeState()` under the new `sessions.state` claim:
+ * a plugin keeps its own state entries in a session's transcript, stored as `plugin-state:<pluginId>:<name>`,
+ * and each write names the newest entry it was computed from, so a write from a stale base is
+ * answered with the newest one instead of landing (compaction plan, phase 2). Additive; plugins
+ * calling them declare ^0.55.5.
+ *
+ * 0.55.6 adds the `contributes.resetText { entry }` manifest field under the new private
+ * `compaction.reset-text` claim, and the `ResetTextEntry` shape the declared state entry holds: the
+ * working state a reset may use in place of the summary (compaction plan, phase 2). Additive; a
+ * plugin declaring it declares ^0.55.6.
  */
-export declare const KAY_PLUGIN_SDK_VERSION: "0.55.4";
+export declare const KAY_PLUGIN_SDK_VERSION: "0.55.6";
 
 export declare const KAY_PLUGIN_TARGET_NAMES: readonly ["kay.agent", "kay.app", "kay.ui"];
 
@@ -5816,6 +5830,9 @@ export declare const KayAppTargetManifest: z.ZodObject<{
             displayName: z.ZodOptional<z.ZodString>;
             description: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
+        resetText: z.ZodOptional<z.ZodObject<{
+            entry: z.ZodString;
+        }, z.core.$strict>>;
         mcpServers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
             url: z.ZodString;
             auth: z.ZodOptional<z.ZodEnum<{
@@ -6785,6 +6802,9 @@ export declare const KayPluginManifestV1: z.ZodObject<{
                         displayName: z.ZodOptional<z.ZodString>;
                         description: z.ZodOptional<z.ZodString>;
                     }, z.core.$strict>>>;
+                    resetText: z.ZodOptional<z.ZodObject<{
+                        entry: z.ZodString;
+                    }, z.core.$strict>>;
                     mcpServers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
                         url: z.ZodString;
                         auth: z.ZodOptional<z.ZodEnum<{
@@ -8791,7 +8811,7 @@ export declare function parseSemver(value: string): ParsedSemver | undefined;
 export declare function parseWhere(source: string, keyTypes?: WhereKeyTypes): WhereParseResult;
 
 /** Every capability slug {@link PluginCapabilityClaimV1} can express, for exhaustive table checks. */
-export declare const PLUGIN_CAPABILITY_SLUGS: readonly ["sessions.run", "network.connect", "web-session.request", "web-session.download", "process.spawn", "sessions.read", "signals.read", "uri.call", "endpoints.invoke", "skills.read", "skills.write", "skills.share", "plugins.set-enabled", "plugins.read", "sessions.assign-project", "artifacts.resolve-file", "process.run", "sessions.annotate", "sessions.compact", "soul.write", "tools.describe", "workspace.command", "sessions.create", "sessions.update", "models.complete", "systemOne.use", "automations.write", "automations.run", "workflows.define", "workflows.signals", "session-events.subscribe", "agents.run", "dynamic-context.register", "app-data.register", "app-data.read", "knowledge-source.register", "artifacts.read", "session-artifacts.read", "session-artifacts.create", "account.assert", "account.update", "agents.permissions", "tool-interception.register", "interaction.surface", "config.declare-section", "auth.own-service", "auth.shared-identity", "cli.bind", "mcp.host-server", "prompt.resident", "skills.declared-source", "family-folder.root", "whiteboard.discover", "whiteboard.read", "whiteboard.create", "whiteboard.update", "whiteboard.remove", "model-selection.register", "system-prompt.register"];
+export declare const PLUGIN_CAPABILITY_SLUGS: readonly ["sessions.run", "network.connect", "web-session.request", "web-session.download", "process.spawn", "sessions.read", "signals.read", "uri.call", "endpoints.invoke", "skills.read", "skills.write", "skills.share", "plugins.set-enabled", "plugins.read", "sessions.assign-project", "artifacts.resolve-file", "process.run", "sessions.annotate", "sessions.compact", "sessions.state", "compaction.reset-text", "soul.write", "tools.describe", "workspace.command", "sessions.create", "sessions.update", "models.complete", "systemOne.use", "automations.write", "automations.run", "workflows.define", "workflows.signals", "session-events.subscribe", "agents.run", "dynamic-context.register", "app-data.register", "app-data.read", "knowledge-source.register", "artifacts.read", "session-artifacts.read", "session-artifacts.create", "account.assert", "account.update", "agents.permissions", "tool-interception.register", "interaction.surface", "config.declare-section", "auth.own-service", "auth.shared-identity", "cli.bind", "mcp.host-server", "prompt.resident", "skills.declared-source", "family-folder.root", "whiteboard.discover", "whiteboard.read", "whiteboard.create", "whiteboard.update", "whiteboard.remove", "model-selection.register", "system-prompt.register"];
 
 /** Diagnostic messages carry plugin-controlled text (parse errors, module errors); bound it so a
  *  hostile or accidental multi-megabyte error can never blow up a log line or a render surface. */
@@ -8846,6 +8866,25 @@ export declare const PLUGIN_SIGNAL_SNIPPET_MAX = 500;
 
 export declare const PLUGIN_SIGNAL_TITLE_MAX = 300;
 
+/**
+ * The most one entry may hold, as serialized UTF-8 JSON: 256 KiB, a quarter of what one
+ * `session/readCustomEntries` read returns, so the newest entry is always read back whole.
+ */
+export declare const PLUGIN_STATE_ENTRY_MAX_BYTES: number;
+
+/** The deepest nesting of arrays and objects one entry may hold. */
+export declare const PLUGIN_STATE_ENTRY_MAX_DEPTH = 64;
+
+/** A plugin's own entry name: a local contribution id (lowercase letters, digits, dashes), at most 64 characters. */
+export declare const PLUGIN_STATE_ENTRY_NAME_PATTERN: RegExp;
+
+/**
+ * The prefix of every plugin state entry's custom type. Its own namespace, apart from herd's
+ * `ext:<extensionId>:` for an extension's own entries, so the host can tell a plugin's state
+ * from every other entry: it is no activity, and a snapshot carries only its newest entry.
+ */
+export declare const PLUGIN_STATE_ENTRY_TYPE_PREFIX = "plugin-state:";
+
 export declare const PluginAgentDefinitionPermissionRule: z.ZodObject<{
     effect: z.ZodEnum<{
         allow: "allow";
@@ -9529,6 +9568,14 @@ export declare const PluginCapabilityClaimInputV1: z.ZodCustom<{
     target: "kay.app";
     slug: "sessions.compact";
     envelope: Record<string, never>;
+} | {
+    target: "kay.app";
+    slug: "sessions.state";
+    envelope: Record<string, never>;
+} | {
+    target: "kay.app";
+    slug: "compaction.reset-text";
+    envelope: Record<string, never>;
 } | {
     target: "kay.app";
     slug: "soul.write";
@@ -9823,6 +9870,14 @@ export declare const PluginCapabilityClaimInputV1: z.ZodCustom<{
     target: "kay.app";
     slug: "sessions.compact";
     envelope: Record<string, never>;
+} | {
+    target: "kay.app";
+    slug: "sessions.state";
+    envelope: Record<string, never>;
+} | {
+    target: "kay.app";
+    slug: "compaction.reset-text";
+    envelope: Record<string, never>;
 } | {
     target: "kay.app";
     slug: "soul.write";
@@ -10127,6 +10182,14 @@ export declare const PluginCapabilityClaimV1: z.ZodDiscriminatedUnion<[z.ZodObje
     target: z.ZodLiteral<"kay.app">;
     slug: z.ZodLiteral<"sessions.compact">;
     envelope: z.ZodObject<{}, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    target: z.ZodLiteral<"kay.app">;
+    slug: z.ZodLiteral<"sessions.state">;
+    envelope: z.ZodObject<{}, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    target: z.ZodLiteral<"kay.app">;
+    slug: z.ZodLiteral<"compaction.reset-text">;
+    envelope: z.ZodObject<{}, z.core.$strict>;
 }, z.core.$strict>, z.ZodObject<{
     target: z.ZodLiteral<"kay.app">;
     slug: z.ZodLiteral<"soul.write">;
@@ -10477,6 +10540,14 @@ export declare const PluginCapabilityDecisionV1: z.ZodDiscriminatedUnion<[z.ZodO
         target: z.ZodLiteral<"kay.app">;
         slug: z.ZodLiteral<"sessions.compact">;
         envelope: z.ZodObject<{}, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        target: z.ZodLiteral<"kay.app">;
+        slug: z.ZodLiteral<"sessions.state">;
+        envelope: z.ZodObject<{}, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        target: z.ZodLiteral<"kay.app">;
+        slug: z.ZodLiteral<"compaction.reset-text">;
+        envelope: z.ZodObject<{}, z.core.$strict>;
     }, z.core.$strict>, z.ZodObject<{
         target: z.ZodLiteral<"kay.app">;
         slug: z.ZodLiteral<"soul.write">;
@@ -10826,6 +10897,14 @@ export declare const PluginCapabilityDecisionV1: z.ZodDiscriminatedUnion<[z.ZodO
             target: z.ZodLiteral<"kay.app">;
             slug: z.ZodLiteral<"sessions.compact">;
             envelope: z.ZodObject<{}, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            target: z.ZodLiteral<"kay.app">;
+            slug: z.ZodLiteral<"sessions.state">;
+            envelope: z.ZodObject<{}, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            target: z.ZodLiteral<"kay.app">;
+            slug: z.ZodLiteral<"compaction.reset-text">;
+            envelope: z.ZodObject<{}, z.core.$strict>;
         }, z.core.$strict>, z.ZodObject<{
             target: z.ZodLiteral<"kay.app">;
             slug: z.ZodLiteral<"soul.write">;
@@ -11209,6 +11288,14 @@ export declare const PluginCapabilityRefusalV1: z.ZodObject<{
         target: z.ZodLiteral<"kay.app">;
         slug: z.ZodLiteral<"sessions.compact">;
         envelope: z.ZodObject<{}, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        target: z.ZodLiteral<"kay.app">;
+        slug: z.ZodLiteral<"sessions.state">;
+        envelope: z.ZodObject<{}, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        target: z.ZodLiteral<"kay.app">;
+        slug: z.ZodLiteral<"compaction.reset-text">;
+        envelope: z.ZodObject<{}, z.core.$strict>;
     }, z.core.$strict>, z.ZodObject<{
         target: z.ZodLiteral<"kay.app">;
         slug: z.ZodLiteral<"soul.write">;
@@ -12695,6 +12782,14 @@ export declare const PluginSourceClass: z.ZodEnum<{
 
 export declare type PluginSourceClass = z.infer<typeof PluginSourceClass>;
 
+/**
+ * The custom entry type a plugin's entry `name` is stored under: `plugin-state:<pluginId>:<name>`.
+ * A plugin id holds no `:`, and the name grammar holds no `.`, `:` or `_`, so no kernel or daemon
+ * type (`herd.permission_rules`, `session_steward`, ...) and no other plugin's entry can be
+ * reached. Returns `undefined` for a name outside the grammar.
+ */
+export declare function pluginStateEntryCustomType(pluginId: string, name: string): string | undefined;
+
 export declare const PluginStorageManifest: z.ZodObject<{
     sqlite: z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
@@ -13137,6 +13232,30 @@ export declare const RENAMED_PLUGIN_CAPABILITY_SLUGS: {
  */
 export declare const RESERVED_DIRECTORY_PLUGIN_ID_PREFIXES: readonly ["herd.", "kay."];
 
+/**
+ * The longest text an entry may hold, in characters: herd's 6,000 estimated tokens at its three
+ * characters per token for ASCII. Herd also counts the tokens, so denser text is refused sooner.
+ */
+export declare const RESET_TEXT_MAX_CHARS = 18000;
+
+/** The `contributes.resetText` declaration: which of the plugin's state entries holds it. */
+export declare const ResetTextContribution: z.ZodObject<{
+    entry: z.ZodString;
+}, z.core.$strict>;
+
+export declare type ResetTextContribution = z.infer<typeof ResetTextContribution>;
+
+export declare const ResetTextEntry: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    coveredThrough: z.ZodObject<{
+        sessionId: z.ZodString;
+        entryId: z.ZodString;
+    }, z.core.$strict>;
+    text: z.ZodString;
+}, z.core.$strict>;
+
+export declare type ResetTextEntry = z.infer<typeof ResetTextEntry>;
+
 /**
  * Resolves the runtime selection key for a provider-shaped contribution - the
  * value an *adapter binding* names to make one implementation live.