ferro-json-ui 0.2.58

JSON-based server-driven UI schema types for Ferro
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

//! Rich text editor plugin for JSON-UI using Quill 2.0.3.
//!
//! Renders an interactive rich text editor backed by Quill. Each editor
//! container stores its field name in `data-ferro-field`; a single init
//! script discovers all `[data-ferro-quill]` elements, attaches Quill,
//! and mirrors HTML to the companion hidden input on every text-change.

use schemars::schema_for;
use serde_json::Value;

use crate::component::RichTextEditorProps;
use crate::data::resolve_path;
use crate::plugin::{Asset, JsonUiPlugin};
use crate::render::html_escape;

/// Quill 2.0.3 CDN asset URLs and SRI integrity hashes.
///
/// Hashes computed from the jsdelivr-served files via:
///   curl -s <URL> | openssl dgst -sha384 -binary | openssl base64 -A
const QUILL_CSS_URL: &str = "https://cdn.jsdelivr.net/npm/quill@2.0.3/dist/quill.snow.css";
const QUILL_CSS_SRI: &str =
    "sha384-ecIckRi4QlKYya/FQUbBUjS4qp65jF/J87Guw5uzTbO1C1Jfa/6kYmd6dXUF6D7i";
const QUILL_JS_URL: &str = "https://cdn.jsdelivr.net/npm/quill@2.0.3/dist/quill.js";
const QUILL_JS_SRI: &str =
    "sha384-utBUCeG4SYaCm4m7GQZYr8Hy8Fpy3V4KGjBZaf4WTKOcwhCYpt/0PfeEe3HNlwx8";

/// Rich text editor plugin backed by Quill 2.0.3.
///
/// Renders a container div (`<div data-ferro-quill ...>`) and a hidden input
/// that receives the editor HTML on every text-change event. The form handler
/// receives standard `field=<html>` POST data on submit.
///
/// # Security
/// - `field` and `label` values are HTML-escaped when emitted as attributes or
///   label text (T-162-04-03).
/// - CDN assets reference Quill 2.0.3 via jsdelivr and carry SRI sha384
///   integrity hashes pinned to the bytes served at phase landing (T-162-04-02).
/// - The editor produces user-controlled HTML. Sanitization on submit is the
///   consumer's responsibility (T-162-04-01).
pub struct RichTextEditorPlugin;

impl JsonUiPlugin for RichTextEditorPlugin {
    fn component_type(&self) -> &str {
        "RichTextEditor"
    }

    fn props_schema(&self) -> Value {
        serde_json::to_value(schema_for!(RichTextEditorProps)).unwrap_or(Value::Null)
    }

    fn render(&self, props: &Value, data: &Value) -> String {
        let parsed: RichTextEditorProps = match serde_json::from_value(props.clone()) {
            Ok(p) => p,
            Err(e) => {
                return format!(
                    "<!-- ferro-json-ui: failed to decode RichTextEditor props: {e} -->"
                )
            }
        };

        // Resolve initial value: data_path > default_value > empty.
        let initial = parsed
            .data_path
            .as_deref()
            .and_then(|p| resolve_path(data, p))
            .and_then(|v| v.as_str())
            .map(|s| s.to_string())
            .or_else(|| parsed.default_value.clone())
            .unwrap_or_default();

        // T-162-04-03: escape field, label, and initial value to prevent XSS via attributes.
        let field_esc = html_escape(&parsed.field);
        let label_esc = html_escape(&parsed.label);
        let initial_esc = html_escape(&initial);

        let mut html = String::new();
        html.push_str(&format!(
            "<label for=\"{field_esc}-editor\" class=\"text-sm font-medium text-text\">{label_esc}</label>"
        ));
        html.push_str(&format!(
            "<div id=\"{field_esc}-editor\" data-ferro-quill data-ferro-field=\"{field_esc}\">{initial_esc}</div>"
        ));
        html.push_str(&format!(
            "<input type=\"hidden\" name=\"{field_esc}\" id=\"{field_esc}-value\" value=\"{initial_esc}\">"
        ));
        if let Some(ref err) = parsed.error {
            html.push_str(&format!(
                "<p class=\"text-sm text-destructive mt-1\">{}</p>",
                html_escape(err)
            ));
        }
        html
    }

    fn css_assets(&self) -> Vec<Asset> {
        vec![Asset::new(QUILL_CSS_URL).integrity(QUILL_CSS_SRI)]
    }

    fn js_assets(&self) -> Vec<Asset> {
        vec![Asset::new(QUILL_JS_URL).integrity(QUILL_JS_SRI)]
    }

    fn init_script(&self) -> Option<String> {
        Some(
            r#"(function(){
    if (typeof Quill === 'undefined') return;
    document.querySelectorAll('[data-ferro-quill]').forEach(function(el){
        var field = el.dataset.ferroField;
        var quill = new Quill(el, { theme: 'snow' });
        var input = document.getElementById(field + '-value');
        if (input && input.value) {
            quill.root.innerHTML = input.value;
        }
        quill.on('text-change', function(){
            if (input) input.value = quill.root.innerHTML;
        });
    });
})();"#
                .to_string(),
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn rich_text_editor_plugin_component_type_is_rich_text_editor() {
        let p = RichTextEditorPlugin;
        assert_eq!(p.component_type(), "RichTextEditor");
    }

    #[test]
    fn rich_text_editor_plugin_assets_include_quill_2_0_3() {
        let p = RichTextEditorPlugin;
        let js = p.js_assets();
        let css = p.css_assets();
        assert!(
            js.iter().any(|a| a.url.contains("quill@2.0.3")),
            "js asset must reference quill@2.0.3"
        );
        assert!(
            css.iter().any(|a| a.url.contains("quill@2.0.3")),
            "css asset must reference quill@2.0.3"
        );
    }

    #[test]
    fn rich_text_editor_plugin_init_script_binds_data_ferro_quill() {
        let p = RichTextEditorPlugin;
        let script = p.init_script().expect("init_script returns Some");
        assert!(script.contains("data-ferro-quill"));
        assert!(script.contains("text-change"));
    }

    #[test]
    fn rich_text_editor_plugin_assets_carry_sri_hashes() {
        let p = RichTextEditorPlugin;
        let js = p.js_assets();
        let css = p.css_assets();
        let js_asset = js.first().expect("js asset present");
        let css_asset = css.first().expect("css asset present");
        assert_eq!(
            js_asset.integrity.as_deref(),
            Some(QUILL_JS_SRI),
            "js asset must pin sha384 SRI hash"
        );
        assert_eq!(
            css_asset.integrity.as_deref(),
            Some(QUILL_CSS_SRI),
            "css asset must pin sha384 SRI hash"
        );
        assert!(QUILL_JS_SRI.starts_with("sha384-"));
        assert!(QUILL_CSS_SRI.starts_with("sha384-"));
    }

    #[test]
    fn rich_text_editor_plugin_render_emits_container_and_hidden_input() {
        let p = RichTextEditorPlugin;
        let out = p.render(&json!({"field": "bio", "label": "Bio"}), &json!({}));
        assert!(
            out.contains("data-ferro-quill"),
            "output must contain data-ferro-quill"
        );
        assert!(
            out.contains("name=\"bio\""),
            "output must contain hidden input name"
        );
        assert!(
            out.contains("id=\"bio-editor\""),
            "output must contain editor container id"
        );
    }
}