@skippr/live-agent-sdk 0.82.0 → 0.84.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 +2 -2
- package/dist/esm/lib-exports.js +593 -356
- package/dist/skippr-sdk.css +1 -1
- package/dist/skippr-sdk.js +138 -138
- package/dist/types/capture/pausedScreenTrack.d.ts +2 -0
- package/dist/types/components/LiveAgent.d.ts +0 -1
- package/dist/types/components/ShadowHost.d.ts +2 -1
- package/dist/types/context/LiveAgentContext.d.ts +7 -0
- package/dist/types/hooks/useAuth.d.ts +1 -0
- package/dist/types/hooks/useAvailableModules.d.ts +2 -1
- package/dist/types/hooks/useElapsedSeconds.d.ts +1 -1
- package/dist/types/hooks/useIsSessionHeld.d.ts +1 -0
- package/dist/types/hooks/useOnceTrue.d.ts +1 -0
- package/dist/types/hooks/useSessionHold.d.ts +3 -1
- package/dist/types/lib/brandForeground.d.ts +2 -0
- package/dist/types/lib-exports.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -209,7 +209,6 @@ Self-contained widget component. Renders a floating button that opens a sidebar
|
|
|
209
209
|
| `agentId` | `string` | — | Pin the widget to a specific module (pass that module's id). Omit to let the user pick from all your active modules at runtime. |
|
|
210
210
|
| `getUserToken` | `() => Promise<string>` | — | Async callback returning a freshly signed JWT for secret mode. The SDK calls it to bootstrap, again proactively before the bearer expires, and once more on a `401` to re-bootstrap. |
|
|
211
211
|
| `userToken` | `string` | — | Static signed JWT for secret mode (testing). Exchanged for a bearer token but can't be refreshed once expired. `getUserToken` takes precedence when both are set. |
|
|
212
|
-
| `position` | `'left' \| 'right'` | `'right'` | Side of the screen for the widget |
|
|
213
212
|
| `variant` | `'floating' \| 'sidebar'` | `'floating'` | Widget display mode |
|
|
214
213
|
| `minimizable` | `boolean` | `true` | Whether the widget can be minimized |
|
|
215
214
|
| `defaultOpen` | `boolean` | `false` | Whether the panel starts open |
|
|
@@ -283,6 +282,7 @@ All hooks must be called within `<LiveAgent>`.
|
|
|
283
282
|
| `useMediaControls()` | `{ isMuted, isScreenSharing, toggleMute, toggleScreenShare }` | Mic and screen share state and toggles |
|
|
284
283
|
| `useAgentVoiceState()` | `{ state, isSpeaking, isListening }` | Agent voice activity state — `state` is the full agent state (`'listening' \| 'thinking' \| 'speaking' \| ...`) |
|
|
285
284
|
| `useIsLocalSpeaking()` | `boolean` | Whether the local user is currently speaking |
|
|
285
|
+
| `useIsSessionHeld()` | `boolean` | `true` while the user has paused the live session; `false` when active or when there is no session. |
|
|
286
286
|
| `useElapsedSeconds(isRunning)` | `number` | Drift-safe elapsed seconds since the flag flipped to `true` |
|
|
287
287
|
|
|
288
288
|
### Utilities
|
|
@@ -297,7 +297,7 @@ Available on `window.Skippr` when using the script tag bundle.
|
|
|
297
297
|
|
|
298
298
|
| Method | Description |
|
|
299
299
|
|--------|-------------|
|
|
300
|
-
| `Skippr.initialize(config)` | Mount the widget. Accepts `appKey` (required), `agentId` (optional — omit for picker), `getUserToken`, `userToken`, `
|
|
300
|
+
| `Skippr.initialize(config)` | Mount the widget. Accepts `appKey` (required), `agentId` (optional — omit for picker), `getUserToken`, `userToken`, `variant`, `minimizable`, `captureMode`. |
|
|
301
301
|
| `Skippr.logout()` | Revoke the current session server-side, clear stored auth tokens, and show the login form (direct auth mode) |
|
|
302
302
|
| `Skippr.destroy()` | Remove the widget from the page and clear auth tokens |
|
|
303
303
|
|