@skippr/live-agent-sdk 0.28.0 → 0.30.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 +3 -1
- package/dist/esm/lib-exports.js +545 -272
- package/dist/skippr-sdk.css +1 -1
- package/dist/skippr-sdk.js +129 -129
- package/dist/types/components/HighlightOverlay.d.ts +1 -0
- package/dist/types/components/LiveAgent.d.ts +10 -4
- package/dist/types/context/LiveAgentContext.d.ts +4 -0
- package/dist/types/hooks/useSession.d.ts +3 -2
- package/dist/types/lib/constants.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,7 @@ Embed an autonomous product specialist that sees, speaks, and acts in real time
|
|
|
8
8
|
|
|
9
9
|
- **Real-time voice** — two-way audio with live transcription
|
|
10
10
|
- **Capture modes** — `screenshare` (user shares screen) or `auto` (DOM capture)
|
|
11
|
+
- **Agent controls** — opt-in capabilities like element highlighting (auto mode only)
|
|
11
12
|
- **Chat + transcript** — text messaging with voice transcripts merged into one thread
|
|
12
13
|
- **Session agenda** — structured phases with progress tracking
|
|
13
14
|
- **Flexible auth** — email OTP (direct auth) or backend-signed JWT (secret mode)
|
|
@@ -194,6 +195,7 @@ Self-contained widget component. Renders a floating button that opens a sidebar
|
|
|
194
195
|
| `startSessionLabel` | `string` | `'Talk to Skippr'` | Label for the start-session button |
|
|
195
196
|
| `autoFocusChat` | `boolean` | `true` | Whether the chat input auto-focuses when opened |
|
|
196
197
|
| `captureMode` | `'screenshare' \| 'auto'` | `'screenshare'` | How the agent sees the page - `'screenshare'` prompts the user to share, `'auto'` uses DOM capture (no permission prompt) |
|
|
198
|
+
| `agentControls` | `{ highlight?: boolean }` | — | Opt-in agent capabilities (e.g. element highlighting). **Requires `captureMode: 'auto'`.** |
|
|
197
199
|
| `showAgentStateBanner` | `boolean` | `true` | Whether to show the top-pinned status banner (talking / thinking / listening / observing) while connected |
|
|
198
200
|
|
|
199
201
|
### `useLiveAgent()`
|
|
@@ -249,7 +251,7 @@ Available on `window.Skippr` when using the script tag bundle.
|
|
|
249
251
|
|
|
250
252
|
| Method | Description |
|
|
251
253
|
|--------|-------------|
|
|
252
|
-
| `Skippr.initialize(config)` | Mount the widget. Accepts `agentId`, `appKey`, `userToken`, `position`, `variant`, `minimizable`. |
|
|
254
|
+
| `Skippr.initialize(config)` | Mount the widget. Accepts `agentId`, `appKey`, `userToken`, `position`, `variant`, `minimizable`, `captureMode`, `agentControls`. |
|
|
253
255
|
| `Skippr.logout()` | Clear stored auth token and show the login form (direct auth mode) |
|
|
254
256
|
| `Skippr.destroy()` | Remove the widget from the page and clear auth tokens |
|
|
255
257
|
|