syncable-ag-ui-core 0.2.1

Core type library for the AG-UI protocol - Syncable SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! AG-UI Core Types
//!
//! This crate provides the core type definitions for the AG-UI (Agent-User Interaction)
//! protocol. It includes event types, message structures, state management primitives,
//! and error handling for building AG-UI compatible agents.
//!
//! # Overview
//!
//! AG-UI is an event-based protocol that standardizes how AI agents communicate with
//! user-facing applications. This crate provides:
//!
//! - **Event types**: All ~25 AG-UI protocol event types (text messages, tool calls, state, etc.)
//! - **Message types**: Structured message formats for agent-user communication
//! - **State management**: State snapshots and JSON Patch delta operations
//! - **Error handling**: Comprehensive error types for protocol operations
//!
//! # Usage
//!
//! ```rust,ignore
//! use ag_ui_core::{Event, Result};
//! ```

pub mod error;
pub mod event;
pub mod patch;
pub mod state;
pub mod types;

// Re-export key types for convenience
pub use error::{AgUiError, Result};

/// Re-export serde_json::Value for consistent JSON handling across the crate
pub use serde_json::Value as JsonValue;

// Re-export all types at crate root for convenient access
pub use types::*;

// Re-export state traits and helpers
pub use state::{diff_states, AgentState, FwdProps, StateManager, TypedStateManager};

// Re-export event types
pub use event::{
    // Foundation types
    BaseEvent, Event, EventType, EventValidationError,
    // Text message events
    TextMessageChunkEvent, TextMessageContentEvent, TextMessageEndEvent, TextMessageStartEvent,
    // Thinking text message events
    ThinkingTextMessageContentEvent, ThinkingTextMessageEndEvent, ThinkingTextMessageStartEvent,
    // Tool call events
    ToolCallArgsEvent, ToolCallChunkEvent, ToolCallEndEvent, ToolCallResultEvent,
    ToolCallStartEvent,
    // Thinking step events
    ThinkingEndEvent, ThinkingStartEvent,
    // State events
    MessagesSnapshotEvent, StateDeltaEvent, StateSnapshotEvent,
    // Activity events
    ActivityDeltaEvent, ActivitySnapshotEvent,
    // Special events
    CustomEvent, RawEvent,
    // Run lifecycle events
    InterruptInfo, RunErrorEvent, RunFinishedEvent, RunFinishedOutcome, RunStartedEvent,
    // Step events
    StepFinishedEvent, StepStartedEvent,
};