schemaui 0.11.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

use std::{fs, path::Path};

use anyhow::Result;
use serde_json::Value;

use crate::io::{DocumentFormat, input::parse_document_str};
use crate::precompile::{build_ui_artifact_bundle, resolve_file_format};
use crate::schema::metadata::root_schema_header;
use crate::web::session::SessionResponse;

/// Build a minimal Web session snapshot (SessionResponse) from a schema value
/// and optional defaults value.
pub fn build_session_snapshot(
    schema_value: &Value,
    defaults_value: Option<&Value>,
) -> Result<SessionResponse> {
    let defaults_value = defaults_value
        .cloned()
        .unwrap_or_else(|| Value::Object(Default::default()));

    let (title, description) = root_schema_header(schema_value);
    let bundle = build_ui_artifact_bundle(schema_value, Some(&defaults_value))?;
    let (ui_ast, layout) = bundle.ui.into_parts();

    let formats: Vec<String> = DocumentFormat::available_formats()
        .into_iter()
        .map(|f| f.to_string())
        .collect();

    Ok(SessionResponse {
        title,
        description,
        ui_ast,
        data: defaults_value,
        formats,
        layout: Some(layout),
    })
}

/// Build a minimal Web session snapshot (SessionResponse) from a schema file
/// and optional defaults file. This mirrors the runtime WebSessionBuilder
/// logic but is intended for use at compile-time or in external codegen
/// tools.
pub fn build_session_snapshot_from_files(
    schema_path: &Path,
    schema_format: DocumentFormat,
    defaults_path: Option<&Path>,
) -> Result<SessionResponse> {
    let schema_raw = fs::read_to_string(schema_path)?;
    let schema_value: Value = parse_document_str(&schema_raw, schema_format)?;

    let defaults_value = if let Some(path) = defaults_path {
        let format = resolve_file_format(path, schema_format, "defaults file")?;
        let raw = fs::read_to_string(path)?;
        Some(parse_document_str(&raw, format)?)
    } else {
        None
    };

    build_session_snapshot(&schema_value, defaults_value.as_ref())
}

/// Write a SessionResponse snapshot as pretty JSON to a file.
pub fn write_session_snapshot_json(snapshot: &SessionResponse, out_path: &Path) -> Result<()> {
    let json = serde_json::to_string_pretty(snapshot)?;
    fs::write(out_path, json)?;
    Ok(())
}

/// Write a TypeScript module exporting a SessionResponse constant. This is
/// useful for static SPA deployments where the session payload is embedded
/// directly into the frontend bundle.
pub fn write_session_snapshot_ts_module(
    snapshot: &SessionResponse,
    out_path: &Path,
    export_name: &str,
) -> Result<()> {
    let json = serde_json::to_string_pretty(snapshot)?;
    let src = format!(
        "import type {{ SessionResponse }} from '@schemaui/types/SessionResponse';\n\nexport const {export_name}: SessionResponse = {json} as const;\n",
    );
    fs::write(out_path, src)?;
    Ok(())
}