@ag-ui/core 0.0.34 → 0.0.35
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 +46 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @ag-ui/core
|
|
2
|
+
|
|
3
|
+
TypeScript definitions & runtime schemas for the **Agent-User Interaction (AG-UI) Protocol**.
|
|
4
|
+
|
|
5
|
+
`@ag-ui/core` delivers the strongly-typed building blocks that every other AG-UI package is built on: message & state models, run inputs and the full set of streaming event types.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @ag-ui/core
|
|
11
|
+
pnpm add @ag-ui/core
|
|
12
|
+
yarn add @ag-ui/core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- 🧩 **Typed data models** – `Message`, `Tool`, `Context`, `RunAgentInput`, `State` …
|
|
18
|
+
- 🔄 **Streaming events** – 16 core event kinds covering assistant messages, tool calls, state updates and run lifecycle.
|
|
19
|
+
- ✅ **Runtime validation** – schemas catch malformed payloads early.
|
|
20
|
+
- 🚀 **Framework-agnostic** – works in Node.js, browsers and any agent framework that can emit JSON.
|
|
21
|
+
|
|
22
|
+
## Quick example
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { EventSchemas, EventType } from "@ag-ui/core";
|
|
26
|
+
|
|
27
|
+
// Validate an incoming event
|
|
28
|
+
EventSchemas.parse({
|
|
29
|
+
type: EventType.TEXT_MESSAGE_CONTENT,
|
|
30
|
+
messageId: "msg_123",
|
|
31
|
+
delta: "Hello, world!",
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Documentation
|
|
36
|
+
|
|
37
|
+
- Concepts & architecture: [`docs/concepts`](https://docs.ag-ui.com/concepts/architecture)
|
|
38
|
+
- Full API reference: [`docs/sdk/js/core`](https://docs.ag-ui.com/sdk/js/core/overview)
|
|
39
|
+
|
|
40
|
+
## Contributing
|
|
41
|
+
|
|
42
|
+
Bug reports and pull requests are welcome! Please read our [contributing guide](https://docs.ag-ui.com/development/contributing) first.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT © 2025 AG-UI Protocol Contributors
|