a2ui-types 0.2.0

Typed data models for the A2UI protocol (v0.9, v0.9.1, and v1.0)
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

use serde::{Deserialize, Serialize};

use super::catalog::Catalog;

// ---------------------------------------------------------------------------
// Renderer Capabilities
// ---------------------------------------------------------------------------

/// Renderer capabilities for v1.0, sent in transport metadata under
/// `a2uiRendererCapabilities`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RendererCapabilities {
    /// The capabilities structure for v1.0.
    #[serde(rename = "v1.0")]
    pub v10: RendererCapabilitiesV10,
}

/// The inner capabilities object for v1.0.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RendererCapabilitiesV10 {
    /// Catalog IDs supported by the renderer. Multiple catalogs can be mixed in a surface.
    #[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>>,
}

// ---------------------------------------------------------------------------
// Agent Capabilities
// ---------------------------------------------------------------------------

/// Agent capabilities for v1.0, advertised via Agent Card or transport initialization.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct AgentCapabilities {
    /// The capabilities structure for v1.0.
    #[serde(rename = "v1.0")]
    pub v10: AgentCapabilitiesV10,
}

/// The inner agent capabilities object for v1.0.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct AgentCapabilitiesV10 {
    /// Catalog IDs that the agent can generate UI for.
    #[serde(rename = "supportedCatalogIds")]
    pub supported_catalog_ids: Vec<String>,

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