schemaui 0.6.0

A Rust library for generating TUI and Web UIs from JSON Schemas for configuration management.
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use std::path::PathBuf;

use serde_json::{Value, json};

use crate::io::{DocumentFormat, input::parse_document_str};
use crate::ui_ast::{build_ui_ast, index, layout};

fn schema_path() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("tests")
        .join("schemas")
        .join("test-comprehensive.schema.json")
}

#[test]
fn layout_field_pointers_reference_valid_nodes() {
    let path = schema_path();

    let contents = std::fs::read_to_string(&path).expect("schema file readable");
    let schema_value: Value =
        parse_document_str(&contents, DocumentFormat::Json).expect("schema parses at runtime");
    let ast = build_ui_ast(&schema_value).expect("runtime UiAst");

    let pointers = index::collect_pointers(&ast);
    let layout = layout::build_ui_layout(&ast);

    assert!(
        !layout.roots.is_empty(),
        "layout must expose at least one root for the comprehensive schema",
    );

    for root in &layout.roots {
        assert!(
            !root.sections.is_empty(),
            "layout root '{}' must contain at least one section",
            root.id,
        );
        for section in &root.sections {
            for pointer in &section.field_pointers {
                assert!(
                    pointers.contains(pointer),
                    "layout references unknown field pointer: {pointer}",
                );
            }
        }
    }
}

#[test]
fn layout_groups_scalar_roots_into_general_section() {
    let schema = json!({
        "type": "object",
        "properties": {
            "metadata": {
                "type": "object",
                "properties": {
                    "serviceName": {"type": "string"}
                }
            },
            "generalFlag": {"type": "string"}
        }
    });

    let ast = build_ui_ast(&schema).expect("runtime UiAst");
    let layout = layout::build_ui_layout(&ast);

    // Expect one object root for "metadata" and a separate "general" root
    // that collects non-object top-level fields such as "generalFlag".
    let general = layout
        .roots
        .iter()
        .find(|root| root.id == "general")
        .expect("general root");
    let general_section = general.sections.first().expect("general section");
    assert!(
        general_section
            .field_pointers
            .iter()
            .any(|p| p == "/generalFlag"),
        "general section should include the scalar top-level field",
    );

    let metadata = layout
        .roots
        .iter()
        .find(|root| root.id == "metadata")
        .expect("metadata root");
    let metadata_section = metadata.sections.first().expect("metadata section");
    assert_eq!(metadata_section.pointer, "/metadata");
    assert!(
        metadata_section
            .field_pointers
            .iter()
            .any(|p| p == "/metadata/serviceName"),
        "metadata section should include its child field pointer",
    );
}

#[test]
fn layout_preserves_declared_root_and_nested_property_order() {
    let schema = json!({
        "type": "object",
        "properties": {
            "zeta": {
                "type": "object",
                "title": "Zeta",
                "properties": {
                    "second": {"type": "string"},
                    "first": {"type": "string"},
                    "network": {
                        "type": "object",
                        "title": "Network",
                        "properties": {
                            "port": {"type": "integer"}
                        }
                    },
                    "auth": {
                        "type": "object",
                        "title": "Auth",
                        "properties": {
                            "user": {"type": "string"}
                        }
                    }
                }
            },
            "alpha": {
                "type": "object",
                "title": "Alpha",
                "properties": {
                    "enabled": {"type": "boolean"}
                }
            }
        }
    });

    let ast = build_ui_ast(&schema).expect("runtime UiAst");
    let layout = layout::build_ui_layout(&ast);

    let root_ids: Vec<_> = layout.roots.iter().map(|root| root.id.as_str()).collect();
    assert_eq!(
        root_ids,
        vec!["zeta", "alpha"],
        "layout roots should follow schema declaration order",
    );

    let zeta = layout
        .roots
        .iter()
        .find(|root| root.id == "zeta")
        .expect("zeta root");
    let zeta_section = zeta.sections.first().expect("zeta section");

    assert_eq!(
        zeta_section.field_pointers,
        vec!["/zeta/second", "/zeta/first"],
        "field list should preserve declared property order within an object section",
    );

    let child_pointers: Vec<_> = zeta_section
        .children
        .iter()
        .map(|section| section.pointer.as_str())
        .collect();
    assert_eq!(
        child_pointers,
        vec!["/zeta/network", "/zeta/auth"],
        "nested section order should follow schema declaration order",
    );
}