schemaui 0.5.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
use crate::tui::app::{App, UiOptions};
use crate::tui::model::build_form_schema;
use crate::tui::state::FormState;
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use jsonschema::validator_for;
use serde_json::json;

fn build_nested_overlay_app() -> App {
    let schema = json!({
        "type": "object",
        "properties": {
            "service": {
                "oneOf": [
                    {
                        "title": "http",
                        "type": "object",
                        "properties": {
                            "routes": {
                                "type": "array",
                                "default": [
                                    {"type": "standard", "path": "/"},
                                    {"type": "standard", "path": "/status"}
                                ],
                                "items": {
                                    "oneOf": [
                                        {
                                            "title": "Standard Route",
                                            "type": "object",
                                            "properties": {
                                                "type": {
                                                    "type": "string",
                                                    "const": "standard"
                                                },
                                                "path": {"type": "string"}
                                            },
                                            "required": ["type", "path"]
                                        },
                                        {
                                            "title": "Regex Route",
                                            "type": "object",
                                            "properties": {
                                                "type": {
                                                    "type": "string",
                                                    "const": "regex"
                                                },
                                                "pattern": {"type": "string"}
                                            },
                                            "required": ["type", "pattern"]
                                        }
                                    ]
                                }
                            }
                        }
                    }
                ]
            }
        }
    });
    let form_schema = build_form_schema(&schema).expect("schema");
    let form_state = FormState::from_schema(&form_schema);
    let validator = validator_for(&schema).expect("validator");
    App::new(form_state, validator, UiOptions::default())
}

fn build_key_value_overlay_app() -> App {
    let schema = json!({
        "type": "object",
        "properties": {
            "headers": {
                "type": "object",
                "additionalProperties": {"type": "string"},
                "default": {
                    "X-One": "1",
                    "X-Two": "2"
                }
            }
        }
    });
    let form_schema = build_form_schema(&schema).expect("schema");
    let form_state = FormState::from_schema(&form_schema);
    let validator = validator_for(&schema).expect("validator");
    App::new(form_state, validator, UiOptions::default())
}

fn build_scalar_array_overlay_app() -> App {
    let schema = json!({
        "type": "object",
        "properties": {
            "tags": {
                "type": "array",
                "default": ["a", "b"],
                "items": {"type": "string"}
            }
        }
    });
    let form_schema = build_form_schema(&schema).expect("schema");
    let form_state = FormState::from_schema(&form_schema);
    let validator = validator_for(&schema).expect("validator");
    App::new(form_state, validator, UiOptions::default())
}

fn activate_service_variant(app: &mut App) {
    let form_state = app.form_state_mut_for_test();
    let field = form_state
        .field_mut_by_pointer("/service")
        .expect("service field present");
    field.apply_composite_selection(0, None);
}

fn focus_field(state: &mut FormState, pointer: &str) {
    for (root_idx, root) in state.roots.iter().enumerate() {
        for (section_idx, section) in root.sections.iter().enumerate() {
            if let Some(field_idx) = section.fields.iter().position(|field| {
                field.schema.pointer == pointer || field.schema.pointer.ends_with(pointer)
            }) {
                state.set_root_index(root_idx);
                state.set_section_index(section_idx);
                state.set_field_index(field_idx);
                return;
            }
        }
    }
    let mut available = Vec::new();
    for root in &state.roots {
        for section in &root.sections {
            for field in &section.fields {
                available.push(field.schema.pointer.clone());
            }
        }
    }
    panic!("field {pointer} not found; available: {available:?}");
}

fn key(code: KeyCode, modifiers: KeyModifiers) -> KeyEvent {
    KeyEvent::new(code, modifiers)
}

// Test removed: Ctrl+S behavior with nested overlays is complex and needs redesign

#[test]
fn esc_pops_only_top_overlay() {
    let mut app = build_nested_overlay_app();
    activate_service_variant(&mut app);
    app.open_overlay_for_test();
    {
        let overlay_form = app
            .active_overlay_form_state_for_test()
            .expect("overlay form");
        focus_field(overlay_form, "/routes");
    }
    app.open_overlay_for_test();
    assert_eq!(app.overlay_depth_for_test(), 2);

    app.handle_key_for_test(key(KeyCode::Esc, KeyModifiers::NONE))
        .expect("close overlay2");
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "esc closes only top overlay",
    );

    app.handle_key_for_test(key(KeyCode::Esc, KeyModifiers::NONE))
        .expect("close overlay1");
    assert_eq!(app.overlay_depth_for_test(), 0);
}

#[test]
fn ctrl_arrows_manage_entries_without_closing_overlay() {
    let mut app = build_nested_overlay_app();
    activate_service_variant(&mut app);
    app.open_overlay_for_test();
    {
        let overlay_form = app
            .active_overlay_form_state_for_test()
            .expect("overlay form level1");
        focus_field(overlay_form, "/routes");
    }
    app.open_overlay_for_test();
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(app.overlay_selected_entry_for_test(), Some(0));

    app.handle_key_for_test(key(KeyCode::Right, KeyModifiers::CONTROL))
        .expect("ctrl+right");
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(app.overlay_selected_entry_for_test(), Some(1));

    app.handle_key_for_test(key(KeyCode::Left, KeyModifiers::CONTROL))
        .expect("ctrl+left");
    assert_eq!(app.overlay_selected_entry_for_test(), Some(0));

    app.handle_key_for_test(key(KeyCode::Left, KeyModifiers::CONTROL))
        .expect("ctrl+left boundary");
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(app.overlay_selected_entry_for_test(), Some(0));

    app.handle_key_for_test(key(KeyCode::Down, KeyModifiers::CONTROL))
        .expect("ctrl+down reorder");
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(
        app.overlay_selected_entry_for_test(),
        Some(1),
        "entry should move to index 1 after reorder",
    );

    app.handle_key_for_test(key(KeyCode::Up, KeyModifiers::CONTROL))
        .expect("ctrl+up reorder back");
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(app.overlay_selected_entry_for_test(), Some(0));
}

#[test]
fn entry_focus_respects_arrow_keys() {
    let mut app = build_nested_overlay_app();
    activate_service_variant(&mut app);
    app.open_overlay_for_test();
    {
        let overlay_form = app
            .active_overlay_form_state_for_test()
            .expect("overlay form level1");
        focus_field(overlay_form, "/routes");
    }
    app.open_overlay_for_test();
    assert_eq!(app.overlay_depth_for_test(), 2);
    assert_eq!(app.overlay_entry_focus_for_test(), Some(true));

    app.handle_key_for_test(key(KeyCode::Down, KeyModifiers::NONE))
        .expect("down from entry focus jumps into fields");
    assert_eq!(app.overlay_entry_focus_for_test(), Some(false));

    app.handle_key_for_test(key(KeyCode::Up, KeyModifiers::NONE))
        .expect("up from first field returns to entries");
    assert_eq!(app.overlay_entry_focus_for_test(), Some(true));
    assert_eq!(
        app.overlay_selected_entry_for_test(),
        Some(1),
        "up from first field should cycle to previous entry",
    );
}

#[test]
fn scalar_array_overlay_opens_for_primitive_array_field() {
    let mut app = build_scalar_array_overlay_app();
    {
        let form_state = app.form_state_mut_for_test();
        focus_field(form_state, "/tags");
    }

    app.open_overlay_for_test();

    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "scalar array overlay should open"
    );
    assert_eq!(
        app.overlay_selected_entry_for_test(),
        Some(0),
        "first scalar array entry should be selected by default",
    );
}

#[test]
fn scalar_array_overlay_can_delete_all_entries_without_recreating_last() {
    let mut app = build_scalar_array_overlay_app();
    {
        let form_state = app.form_state_mut_for_test();
        focus_field(form_state, "/tags");
    }

    // Open scalar array overlay for /tags.
    app.open_overlay_for_test();
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "scalar array overlay should open before deletions",
    );

    fn tags_len(app: &mut App) -> usize {
        let form_state = app.form_state_mut_for_test();
        let field = form_state
            .field_mut_by_pointer("/tags")
            .expect("tags field present");
        field
            .composite_list_panel()
            .map(|(entries, _selected)| entries.len())
            .unwrap_or(0)
    }

    assert_eq!(tags_len(&mut app), 2, "default tags array has two entries");

    // First Ctrl+D: remove one entry; overlay should remain open.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("first Ctrl+D in scalar array overlay");
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "overlay should stay open while scalar array is non-empty",
    );
    assert_eq!(
        tags_len(&mut app),
        1,
        "one entry should remain after first deletion",
    );

    // Second Ctrl+D: remove last entry; overlay should close and list become empty.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("second Ctrl+D in scalar array overlay");
    assert_eq!(
        app.overlay_depth_for_test(),
        0,
        "deleting the last entry should close the scalar array overlay instead of reopening it",
    );
    assert_eq!(
        tags_len(&mut app),
        0,
        "scalar array field should be truly empty after deleting the last entry",
    );
}

#[test]
fn nested_list_overlay_deleting_all_entries_returns_to_parent_overlay() {
    let mut app = build_nested_overlay_app();
    activate_service_variant(&mut app);

    // Open overlay1 for the `service` composite field.
    app.open_overlay_for_test();
    {
        let overlay_form = app
            .active_overlay_form_state_for_test()
            .expect("overlay form level1");
        focus_field(overlay_form, "/routes");
    }

    // Open overlay2 for the `routes` list.
    app.open_overlay_for_test();
    assert_eq!(
        app.overlay_depth_for_test(),
        2,
        "expected nested list overlay depth to be 2 before deletions",
    );

    // First deletion: list still has entries, so list overlay should stay at depth 2.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("Ctrl+D to delete first route entry");
    assert_eq!(
        app.overlay_depth_for_test(),
        2,
        "list overlay should remain open while composite list still has entries",
    );

    // Second deletion: removing last entry should close only the list overlay and
    // return to the parent (service) overlay at depth 1, without reopening a new
    // list overlay with an auto-created entry.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("Ctrl+D to delete last route entry");
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "after deleting the last list entry, control should return to the parent overlay",
    );
    assert_eq!(
        app.overlay_selected_entry_for_test(),
        None,
        "no list entry should be selected once the list is empty",
    );
}

#[test]
fn key_value_overlay_can_delete_all_entries_without_recreating_last() {
    let mut app = build_key_value_overlay_app();
    {
        let form_state = app.form_state_mut_for_test();
        focus_field(form_state, "/headers");
    }

    // Open key/value overlay for /headers.
    app.open_overlay_for_test();
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "key/value overlay should open before deletions",
    );

    fn headers_len(app: &mut App) -> usize {
        let form_state = app.form_state_mut_for_test();
        let field = form_state
            .field_mut_by_pointer("/headers")
            .expect("headers field present");
        field
            .composite_list_panel()
            .map(|(entries, _selected)| entries.len())
            .unwrap_or(0)
    }

    assert_eq!(
        headers_len(&mut app),
        2,
        "default headers map should expose two entries in the collection panel",
    );

    // First Ctrl+D: remove one entry; overlay should remain open.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("first Ctrl+D in key/value overlay");
    assert_eq!(
        app.overlay_depth_for_test(),
        1,
        "overlay should stay open while key/value map still has entries",
    );
    assert_eq!(
        headers_len(&mut app),
        1,
        "one entry should remain after first deletion",
    );

    // Second Ctrl+D: remove last entry; overlay should close and map become empty.
    app.handle_key_for_test(key(KeyCode::Char('d'), KeyModifiers::CONTROL))
        .expect("second Ctrl+D in key/value overlay");
    assert_eq!(
        app.overlay_depth_for_test(),
        0,
        "deleting the last entry should close the key/value overlay instead of reopening it",
    );
    assert_eq!(
        headers_len(&mut app),
        0,
        "key/value field should be truly empty after deleting the last entry",
    );
}