schemaui 0.12.2

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

use super::{
    CompositeMode, Result, Schema, SchemaObject, SchemaResolver, UiNode, UiNodeKind, UiVariant,
};

pub(super) fn build_composite_kind(
    resolver: &SchemaResolver<'_>,
    schemas: &[Schema],
    mode: CompositeMode,
    active_refs: &mut Vec<String>,
) -> Result<UiNodeKind> {
    let variants = build_variants(resolver, schemas, active_refs)?;
    Ok(UiNodeKind::Composite {
        mode,
        allow_multiple: false,
        variants,
    })
}

pub(super) fn build_composite_node(
    resolver: &SchemaResolver<'_>,
    schemas: &[Schema],
    mode: CompositeMode,
    schema: &SchemaObject,
    pointer: String,
    required: bool,
    active_refs: &mut Vec<String>,
) -> Result<UiNode> {
    let kind = build_composite_kind(resolver, schemas, mode, active_refs)?;
    let default_value = if let UiNodeKind::Composite {
        variants,
        allow_multiple,
        ..
    } = &kind
    {
        super::defaults::infer_default_for_composite(variants, *allow_multiple)
    } else {
        None
    };

    Ok(UiNode {
        pointer,
        title: super::schema_helpers::schema_title(schema),
        description: super::schema_helpers::schema_description(schema),
        required,
        default_value,
        kind,
    })
}

pub(super) fn build_variant(
    resolver: &SchemaResolver<'_>,
    schema: &Schema,
    index: usize,
    active_refs: &mut Vec<String>,
) -> Result<UiVariant> {
    super::visit::with_resolved_schema(
        resolver,
        schema,
        active_refs,
        |resolved| {
            build_variant_from_resolved_schema(
                resolver,
                index,
                &resolved,
                super::visit::recursive_boundary_kind(&resolved),
            )
        },
        |resolved, active_refs| {
            let node = super::visit::visit_kind(resolver, &resolved, active_refs)?;
            build_variant_from_resolved_schema(resolver, index, &resolved, node)
        },
    )
}

pub(super) fn build_variant_from_resolved_schema(
    resolver: &SchemaResolver<'_>,
    index: usize,
    schema: &SchemaObject,
    node: UiNodeKind,
) -> Result<UiVariant> {
    let schema_value = super::schema_helpers::schema_to_value_with_defs(resolver, schema)?;
    let title = super::schema_helpers::schema_title(schema)
        .or_else(|| Some(super::naming::default_variant_title(index, schema)));
    let description = super::schema_helpers::schema_description(schema);
    let is_object = super::schema_helpers::is_object_schema(schema);

    Ok(UiVariant {
        id: format!("variant_{index}"),
        title,
        description,
        is_object,
        node,
        schema: schema_value,
    })
}

pub(super) fn build_single_variant_composite_kind(
    resolver: &SchemaResolver<'_>,
    schema: &SchemaObject,
    active_refs: &mut Vec<String>,
) -> Result<UiNodeKind> {
    let node = super::visit::visit_kind(resolver, schema, active_refs)?;
    build_single_variant_overlay_kind(resolver, schema, node)
}

pub(super) fn build_single_variant_overlay_kind(
    resolver: &SchemaResolver<'_>,
    schema: &SchemaObject,
    node: UiNodeKind,
) -> Result<UiNodeKind> {
    let variant = build_variant_from_resolved_schema(resolver, 0, schema, node)?;
    Ok(UiNodeKind::Composite {
        mode: CompositeMode::OneOf,
        allow_multiple: false,
        variants: vec![variant],
    })
}

fn build_variants(
    resolver: &SchemaResolver<'_>,
    schemas: &[Schema],
    active_refs: &mut Vec<String>,
) -> Result<Vec<UiVariant>> {
    let mut out = Vec::new();
    for (index, variant) in schemas.iter().enumerate() {
        out.push(build_variant(resolver, variant, index, active_refs)?);
    }
    Ok(out)
}