@skippr/live-agent-sdk 0.43.0 → 0.45.0

package/README.md

@@ -9,7 +9,7 @@ Embed product specialists that see, speak, and act in real time. Configure **mod
 - **Multi-module picker** — the widget fetches your active modules and lets the user pick which one to start (onboarding, demo, support, etc.), so a single embed covers every use case
 - **Real-time voice** — two-way audio with live transcription
 - **Capture modes** — `screenshare` (user shares screen) or `auto` (DOM capture)
-- **Agent controls** — opt-in capabilities like element highlighting, configured per module (auto mode only)
+- **Agent controls** — opt-in capabilities like element highlighting and on-screen actions, configured per module (auto mode only)
 - **Chat + transcript** — text messaging with voice transcripts merged into one thread
 - **Session agenda** — structured phases with progress tracking
 - **Flexible auth** — email OTP (direct auth) or backend-signed JWT (secret mode)
@@ -217,7 +217,7 @@ Self-contained widget component. Renders a floating button that opens a sidebar
 | `startSessionLabel` | `string` | `'Talk to Skippr'` | Label for the start-session button (only shown when `agentId` is pinned) |
 | `autoFocusChat` | `boolean` | `true` | Whether the chat input auto-focuses when opened |
 | `captureMode` | `'screenshare' \| 'auto'` | `'screenshare'` | How the agent sees the page — `'screenshare'` prompts the user to share, `'auto'` uses DOM capture (no permission prompt) |
-| `agentControls` | `{ highlight?: boolean }` | — | Opt-in agent capabilities (e.g. element highlighting). **Requires `captureMode: 'auto'`** and only applies when `agentId` is pinned. In picker mode, controls are configured per module in the dashboard. |
+| `agentControls` | `{ highlight?: boolean; actions?: boolean }` | — | Opt-in agent capabilities — `highlight` (element highlighting) and `actions` (on-screen actions). **Requires `captureMode: 'auto'`** and only applies when `agentId` is pinned. In picker mode, controls are configured per module in the dashboard. |
 
 ### `useLiveAgent()`
 
@@ -253,7 +253,7 @@ interface Module {
   description: string | null;
   type: string;
   priority: number;
-  controls: { highlight?: boolean };
+  controls: { highlight?: boolean; actions?: boolean };
 }
 ```
 
@@ -261,7 +261,7 @@ interface Module {
 
 | Method | Type | Description |
 |--------|------|-------------|
-| `startSession` | `(opts: { agentId: string; agentControls?: { highlight?: boolean } }) => Promise<void>` | Start a new agent session |
+| `startSession` | `(opts: { agentId: string; agentControls?: { highlight?: boolean; actions?: boolean } }) => Promise<void>` | Start a new agent session |
 | `pauseSession` | `() => Promise<void>` | Pause the active session and disconnect from LiveKit; resumable later |
 | `resumeSession` | `() => Promise<void>` | Resume the pinned agent's paused session, reconnecting to continue |
 | `disconnect` | `() => Promise<void>` | End the current session |
@@ -302,6 +302,12 @@ Available on `window.Skippr` when using the script tag bundle.
 | `Skippr.destroy()` | Remove the widget from the page and clear auth tokens |
 
 
+## On-screen actions
+
+When an agent has the `actions` control enabled (auto mode only), it can act on the page for the user, not just guide them. A small on-screen indicator shows each action as it happens.
+
+Actions are guardrailed: the SDK refuses to act on masked fields (passwords, secrets), sensitive iframes (Stripe, Plaid, captchas), or disabled controls. Use `data-skippr-private` (below) to put anything else off limits.
+
 ## Hiding elements from the agent
 
 To hide an element (and everything inside it) from the agent in `captureMode: 'auto'`, add the `data-skippr-private` attribute: