renderreport 0.2.1

Data-driven report generation with Typst as embedded render engine — no CLI dependency
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

//! Report patterns — pre-configured component compositions
//!
//! Patterns define the logical structure and flow for common report types:
//! - AuditPattern: Security/compliance audit with findings, impact, roadmap
//! - MarketingPattern: Product/feature showcase with benefits, CTA
//! - ExecutivePattern: High-level summary with key metrics, top findings, recommendation

use serde_json::Value;

pub mod audit;
pub mod marketing;
pub mod executive;

pub use audit::AuditPattern;
pub use marketing::MarketingPattern;
pub use executive::ExecutivePattern;

/// Base pattern: logical report structure
///
/// Every report follows a narrative flow:
/// 1. Hero/intro (title, context)
/// 2. Context (why this matters)
/// 3. Analysis (what we found)
/// 4. Solution (what to do)
/// 5. Actions (next steps)
/// 6. CTA (call to action)
///
/// Patterns instantiate this with sensible defaults for specific use cases.
pub struct BasePattern {
    /// Hero component (HeroSummary, ProductHero, etc.)
    pub hero: Option<Value>,
    /// Context section — why this matters, background
    pub context: Vec<Value>,
    /// Analysis section — findings, metrics, assessment
    pub analysis: Vec<Value>,
    /// Solution section — recommendations, approach
    pub solution: Vec<Value>,
    /// Actions section — concrete next steps
    pub actions: Vec<Value>,
    /// Call-to-action (CTABox, etc.)
    pub cta: Option<Value>,
}

impl BasePattern {
    /// Create empty pattern
    pub fn new() -> Self {
        Self {
            hero: None,
            context: Vec::new(),
            analysis: Vec::new(),
            solution: Vec::new(),
            actions: Vec::new(),
            cta: None,
        }
    }

    /// Convert pattern to flat component list for rendering
    pub fn to_components(&self) -> Vec<Value> {
        let mut components = Vec::new();

        if let Some(hero) = &self.hero {
            components.push(hero.clone());
        }

        if !self.context.is_empty() {
            components.push(section("Context", 2));
            components.extend(self.context.iter().cloned());
        }

        if !self.analysis.is_empty() {
            components.push(section("Analysis", 2));
            components.extend(self.analysis.iter().cloned());
        }

        if !self.solution.is_empty() {
            components.push(section("Recommended Actions", 2));
            components.extend(self.solution.iter().cloned());
        }

        if !self.actions.is_empty() {
            components.push(section("Implementation", 2));
            components.extend(self.actions.iter().cloned());
        }

        if let Some(cta) = &self.cta {
            components.push(cta.clone());
        }

        components
    }
}

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

/// Helper: create Section component as JSON
fn section(title: &str, level: usize) -> Value {
    serde_json::json!({
        "type": "section",
        "data": {
            "title": title,
            "level": level,
            "content": []
        }
    })
}

/// Helper: wrap component in JSON envelope
pub fn component_json(component_id: &str, data: Value) -> Value {
    serde_json::json!({
        "type": component_id,
        "data": data
    })
}