@erdoai/types 0.1.1 → 0.1.2
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 +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @erdoai/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types for Erdo SDK packages.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @erdoai/types
|
|
9
|
+
# or
|
|
10
|
+
yarn add @erdoai/types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type {
|
|
17
|
+
ContentItem,
|
|
18
|
+
SSEEvent,
|
|
19
|
+
InvokeResult,
|
|
20
|
+
InvokeParams,
|
|
21
|
+
UIContentType,
|
|
22
|
+
} from '@erdoai/types';
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Types
|
|
26
|
+
|
|
27
|
+
### Core Types
|
|
28
|
+
|
|
29
|
+
- **`ContentItem`** - Typed content with `content_type` and optional `ui_content_type`
|
|
30
|
+
- **`SSEEvent`** - Raw server-sent event with `type`, `payload`, `metadata`
|
|
31
|
+
- **`InvokeResult`** - Processed result with `messages`, `steps`, `events`, `result`
|
|
32
|
+
- **`InvokeParams`** - Parameters for invoking an Erdo agent
|
|
33
|
+
|
|
34
|
+
### UI Types
|
|
35
|
+
|
|
36
|
+
- **`UIContentType`** - Content type hints for UI rendering (charts, tables, etc.)
|
|
37
|
+
- **`ChartData`** - Data structure for chart components
|
|
38
|
+
- **`TableData`** - Data structure for table components
|
|
39
|
+
|
|
40
|
+
## Related Packages
|
|
41
|
+
|
|
42
|
+
- [`@erdoai/server`](https://www.npmjs.com/package/@erdoai/server) - Server-side client for invoking Erdo agents
|
|
43
|
+
- [`@erdoai/ui`](https://www.npmjs.com/package/@erdoai/ui) - React components for rendering agent results
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT
|