@canonmsg/agent-sdk 5.1.1 → 5.1.3

package/README.md

@@ -47,7 +47,7 @@ No additional dependencies required — the SDK uses native `fetch` and `Readabl
 | `runtimeControls` | `RuntimeControlHandlers` | `undefined` | Optional interrupt / stop-clear handlers for Canon working-state controls |
 | `runtimeControlSurface` | `'agent' \| 'host'` | `'agent'` | Runtime publishing surface. Use `host` when this SDK agent owns live runtime controls. |
 | `runtimePrimitives` | `RuntimePrimitiveHandlers` | `undefined` | Optional typed primitive command handlers for descriptor-backed runtime commands |
-| `sessionState` | `boolean` | `false` | Publish RTDB session-state for the conversations this agent is active in |
+| `sessionState` | `boolean` | `false` | Publish runtime-applied state to the canonical agent-session snapshot |
 
 ### Optional runtime controls
 

package/dist/types.d.ts

@@ -107,6 +107,8 @@ export interface RuntimeCardResult {
     cardId: string;
     actionId?: string;
     values?: Record<string, unknown>;
+    /** Canon-authenticated human who submitted this card response. */
+    respondedBy?: string;
 }
 export interface MessageHandlerContext {
     messages: CanonMessage[];
@@ -268,7 +270,7 @@ export interface CanonAgentOptions {
     /** Optional typed runtime primitive handlers. Enables descriptor-backed command controls when provided. */
     runtimePrimitives?: RuntimePrimitiveHandlers;
     /**
-     * Enable RTDB session-state reporting. Off by default.
+     * Enable canonical agent-session state reporting. Off by default.
      * Turn-state reporting is automatic while handlers run.
      */
     sessionState?: boolean;
@@ -311,7 +313,12 @@ export type ReachOutResult = {
     reason: string;
 };
 export interface ReachOutOptions {
-    /** Optional first message to send when admission is `allowed`. */
+    /**
+     * Optional first message; sent now when allowed or parked for exact delivery
+     * after approval when it is visible text <= 4 KiB. Attachments and hidden
+     * session setup cannot be parked; a setup-requiring coding target returns
+     * `setup_required` before a contact request is created.
+     */
     text?: string;
     /** Optional contact-request note. Defaults to `text` when admission is `request-required`. */
     requestMessage?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canonmsg/agent-sdk",
-  "version": "5.1.1",
+  "version": "5.1.3",
   "description": "Canon Agent SDK — build AI agents that participate in Canon conversations",
   "type": "module",
   "main": "dist/index.js",
@@ -28,7 +28,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@canonmsg/core": "^4.2.2"
+    "@canonmsg/core": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"