@skippr/live-agent-sdk 0.1.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/LICENSE +7 -0
- package/README.md +95 -0
- package/dist/esm/lib-exports.js +710 -0
- package/dist/skippr-sdk.css +2 -0
- package/dist/skippr-sdk.js +275 -0
- package/dist/types/components/ChatHeader.d.ts +5 -0
- package/dist/types/components/ChatMessage.d.ts +6 -0
- package/dist/types/components/LiveAgent.d.ts +9 -0
- package/dist/types/components/MeetingControls.d.ts +5 -0
- package/dist/types/components/MessageList.d.ts +7 -0
- package/dist/types/components/QuickActions.d.ts +7 -0
- package/dist/types/components/SessionAgenda.d.ts +8 -0
- package/dist/types/components/Sidebar.d.ts +1 -0
- package/dist/types/components/SidebarTrigger.d.ts +1 -0
- package/dist/types/components/TypingIndicator.d.ts +1 -0
- package/dist/types/components/ui/button.d.ts +9 -0
- package/dist/types/context/LiveAgentContext.d.ts +19 -0
- package/dist/types/hooks/useAgentState.d.ts +1 -0
- package/dist/types/hooks/useLiveAgent.d.ts +2 -0
- package/dist/types/hooks/usePhaseUpdates.d.ts +8 -0
- package/dist/types/hooks/useQuestionUpdates.d.ts +11 -0
- package/dist/types/hooks/useSession.d.ts +17 -0
- package/dist/types/hooks/useTranscriptMessages.d.ts +6 -0
- package/dist/types/lib/constants.d.ts +1 -0
- package/dist/types/lib/format.d.ts +1 -0
- package/dist/types/lib/utils.d.ts +2 -0
- package/dist/types/lib-exports.d.ts +2 -0
- package/dist/types/types.d.ts +5 -0
- package/package.json +66 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright (c) 2026 Skippr Inc. All rights reserved.
|
|
2
|
+
|
|
3
|
+
This software is proprietary and confidential. No part of this software may be
|
|
4
|
+
reproduced, distributed, or transmitted in any form or by any means without the
|
|
5
|
+
prior written permission of Skippr Inc.
|
|
6
|
+
|
|
7
|
+
For inquiries, contact: contact@skippr.com
|
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# @skippr/live-agent-sdk
|
|
2
|
+
|
|
3
|
+
[](https://skippr.ai) [](https://www.npmjs.com/package/@skippr/live-agent-sdk)
|
|
4
|
+
|
|
5
|
+
A live agent with visual and voice skills, embedded into your app with a single React component.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @skippr/live-agent-sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { LiveAgent } from '@skippr/live-agent-sdk';
|
|
17
|
+
import '@skippr/live-agent-sdk/styles';
|
|
18
|
+
|
|
19
|
+
function App() {
|
|
20
|
+
return <LiveAgent organizationId="your_org_id" agentId="your_agent_id" />;
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Custom Components
|
|
25
|
+
|
|
26
|
+
Any component rendered inside `<LiveAgent>` can use the `useLiveAgent` hook to access session state and controls:
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
import { LiveAgent, useLiveAgent } from '@skippr/live-agent-sdk';
|
|
30
|
+
|
|
31
|
+
function ConnectionStatus() {
|
|
32
|
+
const { isConnected } = useLiveAgent();
|
|
33
|
+
|
|
34
|
+
if (isConnected) return <p>Agent connected</p>;
|
|
35
|
+
return <p>Agent disconnected</p>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function App() {
|
|
39
|
+
return (
|
|
40
|
+
<LiveAgent organizationId="your_org_id" agentId="your_agent_id">
|
|
41
|
+
<ConnectionStatus />
|
|
42
|
+
</LiveAgent>
|
|
43
|
+
);
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## API Reference
|
|
48
|
+
|
|
49
|
+
### `<LiveAgent>`
|
|
50
|
+
|
|
51
|
+
Self-contained widget component. Renders a floating button that opens a sidebar panel for real-time agent interaction.
|
|
52
|
+
|
|
53
|
+
#### Props
|
|
54
|
+
|
|
55
|
+
| Prop | Type | Default | Description |
|
|
56
|
+
|------|------|---------|-------------|
|
|
57
|
+
| `organizationId` | `string` | *required* | Organization ID provided by Skippr |
|
|
58
|
+
| `agentId` | `string` | *required* | Agent ID provided by Skippr |
|
|
59
|
+
| `defaultOpen` | `boolean` | `false` | Whether the panel starts open |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### `useLiveAgent()`
|
|
64
|
+
|
|
65
|
+
Hook for accessing session state and panel controls. Must be called within `<LiveAgent>`.
|
|
66
|
+
|
|
67
|
+
#### State
|
|
68
|
+
|
|
69
|
+
| Field | Type | Description |
|
|
70
|
+
|-------|------|-------------|
|
|
71
|
+
| `isConnected` | `boolean` | Whether the agent is connected |
|
|
72
|
+
| `isPanelOpen` | `boolean` | Whether the panel is currently open |
|
|
73
|
+
| `isStarting` | `boolean` | Whether a session is being created |
|
|
74
|
+
| `error` | `string` | Error message, if any |
|
|
75
|
+
|
|
76
|
+
#### Methods
|
|
77
|
+
|
|
78
|
+
| Method | Type | Description |
|
|
79
|
+
|--------|------|-------------|
|
|
80
|
+
| `startSession` | `() => Promise<void>` | Start a new agent session |
|
|
81
|
+
| `disconnect` | `() => Promise<void>` | End the current session |
|
|
82
|
+
| `openPanel` | `() => void` | Open the panel |
|
|
83
|
+
| `closePanel` | `() => void` | Close the panel |
|
|
84
|
+
| `togglePanel` | `() => void` | Toggle the panel open/closed |
|
|
85
|
+
|
|
86
|
+
## Support
|
|
87
|
+
|
|
88
|
+
For questions, technical support, or feedback:
|
|
89
|
+
|
|
90
|
+
* **Email**: contact@skippr.ai
|
|
91
|
+
* **Website**: [https://skippr.ai](https://skippr.ai)
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
© 2026 Skippr
|