schemaui 0.7.1

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

use anyhow::Result;
use jsonschema::validator_for;
use serde_json::{Map, Value};

use crate::core::frontend::{Frontend, FrontendContext};
use crate::core::io::input::schema_with_defaults;
use crate::core::ui_ast::{UiAst, UiAstBundle, build_ui_ast_bundle};
use crate::schema::metadata::root_schema_header;

/// Core pipeline for preparing a `FrontendContext` from a base JSON Schema,
/// optional title, and optional default data.
///
/// This is the shared part of the flow:
///
/// ```text
/// io::input -> (schema, defaults) -> enriched schema -> ui_ast -> FrontendContext
/// ```
#[derive(Debug)]
enum UiAstSource {
    Runtime,
    Prepared(UiAstBundle),
}

#[derive(Debug)]
pub struct SchemaPipeline {
    schema: Value,
    title: Option<String>,
    defaults: Option<Value>,
    ui_ast_source: UiAstSource,
}

impl SchemaPipeline {
    pub fn new(schema: Value) -> Self {
        Self {
            schema,
            title: None,
            defaults: None,
            ui_ast_source: UiAstSource::Runtime,
        }
    }

    pub fn with_title(mut self, title: Option<String>) -> Self {
        self.title = title;
        self
    }

    pub fn with_defaults(mut self, defaults: Option<Value>) -> Self {
        self.defaults = defaults;
        self
    }

    /// Provide a prepared UiAst to be used instead of building one at runtime.
    /// If `ast` is None, the pipeline falls back to runtime UiAst building.
    pub fn with_prepared_ui_ast(mut self, ast: Option<UiAst>) -> Self {
        if let Some(ast) = ast {
            self.ui_ast_source = UiAstSource::Prepared(UiAstBundle::from_ui_ast(ast));
        }
        self
    }

    /// Provide a prepared bundle of shared UI artifacts.
    ///
    /// This lets the runtime reuse both `UiAst` and `UiLayout`, instead of
    /// rebuilding layout-oriented structures from the schema again.
    pub fn with_prepared_ui_bundle(mut self, bundle: Option<UiAstBundle>) -> Self {
        if let Some(bundle) = bundle {
            self.ui_ast_source = UiAstSource::Prepared(bundle);
        }
        self
    }

    fn build_frontend_context(self) -> Result<FrontendContext> {
        let SchemaPipeline {
            schema,
            title,
            defaults,
            ui_ast_source,
        } = self;

        let data = defaults.unwrap_or_else(|| Value::Object(Map::new()));
        let enriched = schema_with_defaults(&schema, &data);
        let (schema_title, schema_description) = root_schema_header(&enriched);

        let validator = validator_for(&enriched)?;
        let bundle = match ui_ast_source {
            UiAstSource::Runtime => build_ui_ast_bundle(&enriched)?,
            UiAstSource::Prepared(bundle) => bundle,
        };
        let (ui_ast, layout) = bundle.into_parts();

        Ok(FrontendContext {
            title: title.or(schema_title),
            description: schema_description,
            ui_ast,
            layout,
            initial_data: data,
            schema: enriched,
            validator,
        })
    }

    pub fn run_with_frontend<F>(self, frontend: F) -> Result<Value>
    where
        F: Frontend,
    {
        let ctx = self.build_frontend_context()?;
        frontend.run(ctx)
    }
}