a2ui-base 0.2.1

Framework-agnostic base for A2UI (Agent to UI): protocol, models, and catalog
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! A2UI v1.0 Server-to-Client Messages
//!
//! Mirrors the JSON Schema `server_to_client.json`.

use serde::{Deserialize, Serialize};

use super::common_types::FunctionCall;

// ---------------------------------------------------------------------------
// Top-level envelope
// ---------------------------------------------------------------------------

/// A single A2UI message from the server.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct A2uiMessage {
    pub version: String,
    #[serde(flatten)]
    pub payload: A2uiPayload,
}

/// The typed payload of a server-to-client message.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum A2uiPayload {
    CreateSurface(CreateSurfacePayload),
    UpdateComponents(UpdateComponentsPayload),
    UpdateDataModel(UpdateDataModelPayload),
    DeleteSurface(DeleteSurfacePayload),
    CallFunction(CallFunctionPayload),
    ActionResponse(ActionResponsePayload),
}

// ---------------------------------------------------------------------------
// createSurface
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct CreateSurfacePayload {
    pub create_surface: CreateSurfaceData,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct CreateSurfaceData {
    pub surface_id: String,
    pub catalog_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub surface_properties: Option<serde_json::Value>,
    #[serde(default)]
    pub send_data_model: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub components: Option<Vec<serde_json::Value>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data_model: Option<serde_json::Value>,
}

// ---------------------------------------------------------------------------
// updateComponents
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct UpdateComponentsPayload {
    pub update_components: UpdateComponentsData,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct UpdateComponentsData {
    pub surface_id: String,
    pub components: Vec<serde_json::Value>,
}

// ---------------------------------------------------------------------------
// updateDataModel
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct UpdateDataModelPayload {
    pub update_data_model: UpdateDataModelData,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct UpdateDataModelData {
    pub surface_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<serde_json::Value>,
}

// ---------------------------------------------------------------------------
// deleteSurface
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct DeleteSurfacePayload {
    pub delete_surface: DeleteSurfaceData,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct DeleteSurfaceData {
    pub surface_id: String,
}

// ---------------------------------------------------------------------------
// callFunction
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct CallFunctionPayload {
    pub call_function: FunctionCall,
    pub function_call_id: String,
    #[serde(default)]
    pub want_response: bool,
}

// ---------------------------------------------------------------------------
// actionResponse
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct ActionResponsePayload {
    pub action_response: ActionResponseData,
    pub action_id: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct ActionResponseData {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<ActionResponseError>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ActionResponseError {
    pub code: String,
    pub message: String,
}