windjammer-ui 0.3.6

Cross-platform UI framework for Windjammer (Web, Desktop, Mobile)
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
429
//! Server-Side Rendering (SSR) for web targets

use crate::component::Component;
use crate::vdom::{VElement, VNode, VText};
use std::collections::HashMap;

/// SSR renderer that converts VNodes to HTML strings
pub struct SSRRenderer {
    /// Generated HTML
    html: String,
    /// Component state for hydration
    state: HashMap<String, String>,
    /// Hydration script
    hydration_script: String,
}

impl SSRRenderer {
    /// Create a new SSR renderer
    pub fn new() -> Self {
        Self {
            html: String::new(),
            state: HashMap::new(),
            hydration_script: String::new(),
        }
    }

    /// Render a component to HTML string
    pub fn render_to_string<C: Component>(&mut self, component: C) -> String {
        let vnode = component.render();
        self.render_vnode(&vnode);
        self.html.clone()
    }

    /// Render a component to full HTML document with hydration
    pub fn render_to_document<C: Component>(&mut self, component: C, title: &str) -> String {
        let body_html = self.render_to_string(component);

        format!(
            r#"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{}</title>
    <script id="__WINDJAMMER_STATE__" type="application/json">
    {}
    </script>
</head>
<body>
    <div id="app">{}</div>
    <script>
        {}
    </script>
</body>
</html>"#,
            Self::escape_html(title),
            serde_json::to_string(&self.state).unwrap_or_default(),
            body_html,
            self.get_hydration_script()
        )
    }

    /// Get the hydration script
    pub fn get_hydration_script(&self) -> String {
        if !self.hydration_script.is_empty() {
            return self.hydration_script.clone();
        }

        // Default hydration script
        r#"
        (function() {
            // Hydration: Attach event listeners to server-rendered HTML
            const state = JSON.parse(document.getElementById('__WINDJAMMER_STATE__').textContent);
            
            // Store state for client-side hydration
            window.__WINDJAMMER_HYDRATION_STATE__ = state;
            
            // Mark as hydrated
            document.getElementById('app').setAttribute('data-hydrated', 'true');
            
            console.log('Windjammer: Hydration complete', state);
        })();
        "#
        .to_string()
    }

    /// Render a VNode to HTML
    fn render_vnode(&mut self, vnode: &VNode) {
        match vnode {
            VNode::Element(element) => self.render_element(element),
            VNode::Text(text) => self.render_text(text),
            VNode::Component(_) => {
                // Components should be expanded before SSR
                self.html.push_str("<!-- Component not expanded -->");
            }
            VNode::Empty => {}
        }
    }

    /// Render an element
    fn render_element(&mut self, element: &VElement) {
        // Opening tag
        self.html.push('<');
        self.html.push_str(&element.tag);

        // Attributes
        for (key, value) in &element.attrs {
            self.html.push(' ');
            self.html.push_str(&Self::escape_attribute(key));
            self.html.push_str("=\"");
            self.html.push_str(&Self::escape_attribute(value));
            self.html.push('"');
        }

        // Self-closing tags
        if element.children.is_empty() && Self::is_void_element(&element.tag) {
            self.html.push_str(" />");
            return;
        }

        self.html.push('>');

        // Children
        for child in &element.children {
            self.render_vnode(child);
        }

        // Closing tag
        self.html.push_str("</");
        self.html.push_str(&element.tag);
        self.html.push('>');
    }

    /// Render text
    fn render_text(&mut self, text: &VText) {
        self.html.push_str(&Self::escape_html(&text.content));
    }

    /// Check if element is self-closing (void element)
    fn is_void_element(tag: &str) -> bool {
        matches!(
            tag,
            "area"
                | "base"
                | "br"
                | "col"
                | "embed"
                | "hr"
                | "img"
                | "input"
                | "link"
                | "meta"
                | "param"
                | "source"
                | "track"
                | "wbr"
        )
    }

    /// Escape HTML special characters
    fn escape_html(text: &str) -> String {
        text.replace('&', "&amp;")
            .replace('<', "&lt;")
            .replace('>', "&gt;")
            .replace('"', "&quot;")
            .replace('\'', "&#x27;")
    }

    /// Escape attribute values
    fn escape_attribute(text: &str) -> String {
        text.replace('&', "&amp;")
            .replace('"', "&quot;")
            .replace('<', "&lt;")
            .replace('>', "&gt;")
    }

    /// Add component state for hydration
    pub fn add_state(&mut self, key: String, value: String) {
        self.state.insert(key, value);
    }

    /// Set custom hydration script
    pub fn set_hydration_script(&mut self, script: String) {
        self.hydration_script = script;
    }
}

impl Default for SSRRenderer {
    fn default() -> Self {
        Self::new()
    }
}

/// Streaming SSR renderer for large pages
pub struct StreamingSSRRenderer {
    chunk_size: usize,
    chunks: Vec<String>,
}

impl StreamingSSRRenderer {
    /// Create a new streaming SSR renderer
    pub fn new(chunk_size: usize) -> Self {
        Self {
            chunk_size,
            chunks: Vec::new(),
        }
    }

    /// Render a VNode and return chunks
    pub fn render_vnode(&mut self, vnode: &VNode) -> Vec<String> {
        self.chunks.clear();
        let mut buffer = String::new();

        self.render_vnode_to_buffer(vnode, &mut buffer);

        // Split into chunks
        for chunk in buffer.as_bytes().chunks(self.chunk_size) {
            self.chunks.push(String::from_utf8_lossy(chunk).to_string());
        }

        self.chunks.clone()
    }

    #[allow(clippy::only_used_in_recursion)]
    fn render_vnode_to_buffer(&self, vnode: &VNode, buffer: &mut String) {
        match vnode {
            VNode::Element(element) => {
                buffer.push('<');
                buffer.push_str(&element.tag);

                for (key, value) in &element.attrs {
                    buffer.push(' ');
                    buffer.push_str(key);
                    buffer.push_str("=\"");
                    buffer.push_str(&SSRRenderer::escape_attribute(value));
                    buffer.push('"');
                }

                if element.children.is_empty() && SSRRenderer::is_void_element(&element.tag) {
                    buffer.push_str(" />");
                } else {
                    buffer.push('>');
                    for child in &element.children {
                        self.render_vnode_to_buffer(child, buffer);
                    }
                    buffer.push_str("</");
                    buffer.push_str(&element.tag);
                    buffer.push('>');
                }
            }
            VNode::Text(text) => {
                buffer.push_str(&SSRRenderer::escape_html(&text.content));
            }
            VNode::Component(_) => {
                buffer.push_str("<!-- Component -->");
            }
            VNode::Empty => {}
        }
    }
}

/// Hydration helper for client-side
pub struct Hydration {
    state: HashMap<String, String>,
}

impl Hydration {
    /// Create from serialized state
    pub fn from_state(state_json: &str) -> Result<Self, String> {
        let state: HashMap<String, String> =
            serde_json::from_str(state_json).map_err(|e| e.to_string())?;
        Ok(Self { state })
    }

    /// Get state value
    pub fn get(&self, key: &str) -> Option<&String> {
        self.state.get(key)
    }

    /// Check if element is hydrated
    pub fn is_hydrated(&self) -> bool {
        !self.state.is_empty()
    }

    /// Helper extension for render_to_document_with_html
    #[allow(dead_code)]
    fn render_to_document_with_html(&self, title: &str, body_html: &str) -> String {
        format!(
            r#"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{}</title>
</head>
<body>
    {}
</body>
</html>"#,
            title, body_html
        )
    }
}

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

    #[test]
    fn test_ssr_render_simple_element() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(VElement::new("div").child(VNode::Text(VText::new("Hello"))));

        renderer.render_vnode(&vnode);
        assert_eq!(renderer.html, "<div>Hello</div>");
    }

    #[test]
    fn test_ssr_render_with_attributes() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(
            VElement::new("div")
                .attr("class", "container")
                .child(VNode::Text(VText::new("Content"))),
        );

        renderer.render_vnode(&vnode);
        assert!(renderer.html.contains("class=\"container\""));
        assert!(renderer.html.contains("Content"));
    }

    #[test]
    fn test_ssr_render_void_element() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(VElement::new("br"));

        renderer.render_vnode(&vnode);
        assert_eq!(renderer.html, "<br />");
    }

    #[test]
    fn test_ssr_escape_html() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(
            VElement::new("div").child(VNode::Text(VText::new("<script>alert('xss')</script>"))),
        );

        renderer.render_vnode(&vnode);
        assert!(renderer.html.contains("&lt;script&gt;"));
        assert!(!renderer.html.contains("<script>"));
    }

    #[test]
    fn test_ssr_nested_elements() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(
            VElement::new("div")
                .child(VNode::Element(
                    VElement::new("p").child(VNode::Text(VText::new("Nested"))),
                ))
                .child(VNode::Element(
                    VElement::new("span").child(VNode::Text(VText::new("Content"))),
                )),
        );

        renderer.render_vnode(&vnode);
        assert!(renderer.html.contains("<div>"));
        assert!(renderer.html.contains("<p>Nested</p>"));
        assert!(renderer.html.contains("<span>Content</span>"));
        assert!(renderer.html.contains("</div>"));
    }

    #[test]
    fn test_ssr_document_generation() {
        let mut renderer = SSRRenderer::new();

        // Create a simple component render result
        let vnode = VNode::Element(VElement::new("h1").child(VNode::Text(VText::new("Hello SSR"))));
        renderer.render_vnode(&vnode);

        // Test that HTML was generated
        assert!(renderer.html.contains("<h1>Hello SSR</h1>"));
    }

    #[test]
    fn test_streaming_ssr() {
        let mut renderer = StreamingSSRRenderer::new(10); // Small chunk size for testing
        let vnode = VNode::Element(
            VElement::new("div").child(VNode::Text(VText::new("This is a longer text"))),
        );

        let chunks = renderer.render_vnode(&vnode);
        assert!(!chunks.is_empty());

        // Recombine chunks
        let combined: String = chunks.into_iter().collect();
        assert!(combined.contains("<div>"));
        assert!(combined.contains("This is a longer text"));
        assert!(combined.contains("</div>"));
    }

    #[test]
    fn test_hydration_state() {
        let mut renderer = SSRRenderer::new();
        renderer.add_state("count".to_string(), "42".to_string());
        renderer.add_state("name".to_string(), "Alice".to_string());

        let state_json = serde_json::to_string(&renderer.state).unwrap();
        let hydration = Hydration::from_state(&state_json).unwrap();

        assert_eq!(hydration.get("count"), Some(&"42".to_string()));
        assert_eq!(hydration.get("name"), Some(&"Alice".to_string()));
        assert!(hydration.is_hydrated());
    }

    #[test]
    fn test_attribute_escaping() {
        let mut renderer = SSRRenderer::new();
        let vnode = VNode::Element(
            VElement::new("input")
                .attr("value", "Test \"quoted\" value")
                .attr("data-test", "<script>"),
        );

        renderer.render_vnode(&vnode);
        assert!(renderer.html.contains("&quot;"));
        assert!(renderer.html.contains("&lt;script&gt;"));
    }
}