@skippr/live-agent-sdk 0.26.0 → 0.28.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.
Files changed (19) hide show
  1. package/README.md +4 -3
  2. package/dist/esm/lib-exports.js +1149 -227
  3. package/dist/skippr-sdk.css +1 -1
  4. package/dist/skippr-sdk.js +153 -144
  5. package/dist/types/capture/a11yTree.d.ts +11 -0
  6. package/dist/types/capture/a11yUtils.d.ts +6 -0
  7. package/dist/types/capture/domEvents.d.ts +31 -0
  8. package/dist/types/capture/snapdom.d.ts +2 -0
  9. package/dist/types/components/AgentStateBanner.d.ts +1 -0
  10. package/dist/types/components/DomCapture.d.ts +1 -0
  11. package/dist/types/components/LiveAgent.d.ts +4 -2
  12. package/dist/types/components/MeetingControls.d.ts +2 -1
  13. package/dist/types/components/SessionAgenda.d.ts +2 -1
  14. package/dist/types/context/LiveAgentContext.d.ts +2 -0
  15. package/dist/types/hooks/useAgentVoiceState.d.ts +2 -3
  16. package/dist/types/hooks/useSession.d.ts +3 -1
  17. package/dist/types/lib/constants.d.ts +6 -0
  18. package/package.json +2 -1
  19. package/dist/types/components/ObservingBanner.d.ts +0 -1
package/README.md CHANGED
@@ -7,7 +7,7 @@ Embed an autonomous product specialist that sees, speaks, and acts in real time
7
7
  ## Key Features
8
8
 
9
9
  - **Real-time voice** — two-way audio with live transcription
10
- - **Screen sharing** — user shares their screen so the agent can see and guide
10
+ - **Capture modes** — `screenshare` (user shares screen) or `auto` (DOM capture)
11
11
  - **Chat + transcript** — text messaging with voice transcripts merged into one thread
12
12
  - **Session agenda** — structured phases with progress tracking
13
13
  - **Flexible auth** — email OTP (direct auth) or backend-signed JWT (secret mode)
@@ -193,7 +193,8 @@ Self-contained widget component. Renders a floating button that opens a sidebar
193
193
  | `welcomeMessage` | `string` | — | Message shown on the minimized bubble |
194
194
  | `startSessionLabel` | `string` | `'Talk to Skippr'` | Label for the start-session button |
195
195
  | `autoFocusChat` | `boolean` | `true` | Whether the chat input auto-focuses when opened |
196
- | `showObservingBanner` | `boolean` | `true` | Whether to show the "Skippr is observing this page" banner during screen share |
196
+ | `captureMode` | `'screenshare' \| 'auto'` | `'screenshare'` | How the agent sees the page - `'screenshare'` prompts the user to share, `'auto'` uses DOM capture (no permission prompt) |
197
+ | `showAgentStateBanner` | `boolean` | `true` | Whether to show the top-pinned status banner (talking / thinking / listening / observing) while connected |
197
198
 
198
199
  ### `useLiveAgent()`
199
200
 
@@ -232,7 +233,7 @@ All hooks must be called within `<LiveAgent>`.
232
233
  | Hook | Returns | Description |
233
234
  |------|---------|-------------|
234
235
  | `useMediaControls()` | `{ isMuted, isScreenSharing, toggleMute, toggleScreenShare }` | Mic and screen share state and toggles |
235
- | `useAgentVoiceState()` | `{ isSpeaking, isThinking }` | Agent voice activity state |
236
+ | `useAgentVoiceState()` | `{ state, isSpeaking, isListening }` | Agent voice activity state — `state` is the full agent state (`'listening' \| 'thinking' \| 'speaking' \| ...`) |
236
237
  | `useIsLocalSpeaking()` | `boolean` | Whether the local user is currently speaking |
237
238
  | `useElapsedSeconds(isRunning)` | `number` | Drift-safe elapsed seconds since the flag flipped to `true` |
238
239