awaken-ext-generative-ui 0.6.0

Server-driven UI component plugin (A2UI) for Awaken
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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// A single A2UI v0.8 server-to-client message.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiMessage {
    /// Populate the component map for a surface.
    #[serde(
        rename = "surfaceUpdate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub surface_update: Option<A2uiSurfaceUpdate>,
    /// Populate or mutate the surface data model.
    #[serde(
        rename = "dataModelUpdate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub data_model_update: Option<A2uiDataModelUpdate>,
    /// Signal the root component for initial render.
    #[serde(
        rename = "beginRendering",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub begin_rendering: Option<A2uiBeginRendering>,
    /// Delete a surface.
    #[serde(
        rename = "deleteSurface",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub delete_surface: Option<A2uiDeleteSurface>,
}

/// Parameters for starting a surface render.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiBeginRendering {
    #[serde(rename = "surfaceId")]
    pub surface_id: String,
    pub root: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub styles: Option<HashMap<String, String>>,
}

/// Parameters for updating components on a surface.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiSurfaceUpdate {
    #[serde(rename = "surfaceId")]
    pub surface_id: String,
    pub components: Vec<A2uiComponent>,
}

/// A single raw A2UI component definition.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiComponent {
    pub id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub weight: Option<f64>,
    /// v0.8 component payload, e.g. `{ "Text": { ... } }`.
    pub component: Value,
}

/// Parameters for updating the data model.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiDataModelUpdate {
    #[serde(rename = "surfaceId")]
    pub surface_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
    pub contents: Vec<A2uiDataModelEntry>,
}

/// A single data model entry in the v0.8 `contents` array.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiDataModelEntry {
    pub key: String,
    #[serde(
        rename = "valueString",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub value_string: Option<String>,
    #[serde(
        rename = "valueNumber",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub value_number: Option<f64>,
    #[serde(
        rename = "valueBoolean",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub value_boolean: Option<bool>,
    #[serde(rename = "valueMap", default, skip_serializing_if = "Option::is_none")]
    pub value_map: Option<Vec<A2uiDataModelEntry>>,
}

/// Parameters for deleting a surface.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct A2uiDeleteSurface {
    #[serde(rename = "surfaceId")]
    pub surface_id: String,
}