a2ui-types 0.1.0

Typed data models for the A2UI protocol (v0.8 & v0.9)
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

use serde::{Deserialize, Serialize};

use super::catalog::Catalog;

// ---------------------------------------------------------------------------
// Client Capabilities
// ---------------------------------------------------------------------------

/// Client capabilities for v0.9, sent in A2A message metadata under `a2uiClientCapabilities`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClientCapabilities {
    /// The capabilities structure for v0.9.
    #[serde(rename = "v0.9")]
    pub v09: ClientCapabilitiesV09,
}

/// The inner capabilities object for v0.9.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClientCapabilitiesV09 {
    /// URIs of component and function catalogs supported by the client.
    #[serde(rename = "supportedCatalogIds")]
    pub supported_catalog_ids: Vec<String>,

    /// Inline catalog definitions (only if the agent declares `acceptsInlineCatalogs: true`).
    #[serde(rename = "inlineCatalogs", skip_serializing_if = "Option::is_none")]
    pub inline_catalogs: Option<Vec<Catalog>>,
}

// ---------------------------------------------------------------------------
// Server Capabilities
// ---------------------------------------------------------------------------

/// Server capabilities for v0.9, advertised via Agent Card or transport initialization.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ServerCapabilities {
    /// The server capabilities structure for v0.9.
    #[serde(rename = "v0.9")]
    pub v09: ServerCapabilitiesV09,
}

/// The inner server capabilities object for v0.9.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ServerCapabilitiesV09 {
    /// Catalog IDs that the server can generate UI for.
    #[serde(
        rename = "supportedCatalogIds",
        skip_serializing_if = "Option::is_none"
    )]
    pub supported_catalog_ids: Option<Vec<String>>,

    /// Whether the server accepts inline catalogs from the client.
    #[serde(
        rename = "acceptsInlineCatalogs",
        skip_serializing_if = "Option::is_none"
    )]
    pub accepts_inline_catalogs: Option<bool>,
}