veer 0.1.1

Inertia.js v3 server-side protocol superset for Rust
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

//! The Inertia "page object" — the JSON payload that drives the client adapter.

use serde::Serialize;
use serde_json::Value;
use std::collections::BTreeMap;

/// The shape the Inertia JS client expects.
///
/// Field order matches the protocol; serialized as snake/camelCase as required.
#[derive(Debug, Clone, Serialize)]
pub struct PageObject {
    /// Component name (e.g. `"Users/Index"`).
    pub component: String,
    /// Resolved props for this render.
    pub props: Value,
    /// Current URL.
    pub url: String,
    /// Asset version this response was generated against.
    pub version: String,
    /// Encrypted history flag (Inertia v2+).
    #[serde(rename = "encryptHistory", skip_serializing_if = "is_false")]
    pub encrypt_history: bool,
    /// Clear history flag (Inertia v2+).
    #[serde(rename = "clearHistory", skip_serializing_if = "is_false")]
    pub clear_history: bool,
    /// Keys whose values should merge into the client's existing prop state.
    #[serde(rename = "mergeProps", skip_serializing_if = "Vec::is_empty")]
    pub merge_props: Vec<String>,
    /// Keys whose merge state the server is asking the client to reset.
    #[serde(rename = "resetMergeProps", skip_serializing_if = "Vec::is_empty")]
    pub reset_merge_props: Vec<String>,
    /// Deferred props grouped by group name (Inertia v2+).
    #[serde(rename = "deferredProps", skip_serializing_if = "BTreeMap::is_empty")]
    pub deferred_props: BTreeMap<String, Vec<String>>,
}

fn is_false(b: &bool) -> bool {
    !*b
}

impl PageObject {
    /// Construct a new page object with required fields; other fields default-empty.
    pub fn new(
        component: impl Into<String>,
        props: Value,
        url: impl Into<String>,
        version: impl Into<String>,
    ) -> Self {
        Self {
            component: component.into(),
            props,
            url: url.into(),
            version: version.into(),
            encrypt_history: false,
            clear_history: false,
            merge_props: Vec::new(),
            reset_merge_props: Vec::new(),
            deferred_props: BTreeMap::new(),
        }
    }
}

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

    #[test]
    fn minimal_page_serializes_with_only_required_fields() {
        let p = PageObject::new("Home", json!({"msg": "hi"}), "/", "v1");
        let v = serde_json::to_value(&p).unwrap();
        assert_eq!(
            v,
            json!({
                "component": "Home",
                "props": {"msg": "hi"},
                "url": "/",
                "version": "v1"
            })
        );
    }

    #[test]
    fn flags_and_lists_serialize_when_non_default() {
        let mut p = PageObject::new("Home", json!({}), "/", "v1");
        p.encrypt_history = true;
        p.merge_props = vec!["notifications".into()];
        p.deferred_props
            .insert("dashboard".into(), vec!["stats".into()]);
        let v = serde_json::to_value(&p).unwrap();
        assert_eq!(v["encryptHistory"], true);
        assert_eq!(v["mergeProps"], json!(["notifications"]));
        assert_eq!(v["deferredProps"], json!({"dashboard": ["stats"]}));
    }
}