renderreport 0.2.0

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
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

//! Pack manifest definition
//!
//! The manifest file (pack.toml) describes a template pack.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Pack manifest (pack.toml)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PackManifest {
    /// Pack metadata
    pub pack: PackMeta,
    /// Compatibility requirements
    #[serde(default)]
    pub compatibility: CompatibilityInfo,
    /// Available templates
    #[serde(default)]
    pub templates: HashMap<String, TemplateEntry>,
    /// Available themes
    #[serde(default)]
    pub themes: HashMap<String, ThemeEntry>,
    /// Component overrides
    #[serde(default)]
    pub components: HashMap<String, ComponentEntry>,
}

/// Pack metadata
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PackMeta {
    /// Pack name
    pub name: String,
    /// Pack version (semver)
    pub version: String,
    /// Human-readable description
    #[serde(default)]
    pub description: Option<String>,
    /// Pack authors
    #[serde(default)]
    pub authors: Vec<String>,
    /// Pack capabilities/features
    #[serde(default)]
    pub capabilities: Vec<String>,
    /// License identifier (SPDX)
    #[serde(default)]
    pub license: Option<String>,
    /// Repository URL
    #[serde(default)]
    pub repository: Option<String>,
    /// Keywords for discovery
    #[serde(default)]
    pub keywords: Vec<String>,
}

/// Compatibility requirements
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CompatibilityInfo {
    /// Minimum renderreport engine version
    #[serde(default)]
    pub min_engine_version: Option<String>,
    /// Maximum renderreport engine version
    #[serde(default)]
    pub max_engine_version: Option<String>,
    /// Required Typst version (if using Typst-specific features)
    #[serde(default)]
    pub typst_version: Option<String>,
}

/// Template entry in manifest
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TemplateEntry {
    /// Template file path (relative to pack root)
    pub file: String,
    /// Human-readable description
    #[serde(default)]
    pub description: Option<String>,
    /// Default theme for this template
    #[serde(default)]
    pub default_theme: Option<String>,
    /// Required data schema (JSON Schema reference)
    #[serde(default)]
    pub schema: Option<String>,
}

/// Theme entry in manifest
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ThemeEntry {
    /// Theme file path (relative to pack root)
    pub file: String,
    /// Human-readable description
    #[serde(default)]
    pub description: Option<String>,
    /// Whether this is the default theme
    #[serde(default)]
    pub default: bool,
}

/// Component entry in manifest
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComponentEntry {
    /// Component file path (relative to pack root)
    pub file: String,
    /// Human-readable description
    #[serde(default)]
    pub description: Option<String>,
    /// Whether this overrides a standard component
    #[serde(default)]
    pub overrides: Option<String>,
}

impl PackManifest {
    /// Parse manifest from TOML string
    pub fn from_toml(toml_str: &str) -> Result<Self, toml::de::Error> {
        toml::from_str(toml_str)
    }

    /// Serialize manifest to TOML string
    pub fn to_toml(&self) -> Result<String, toml::ser::Error> {
        toml::to_string_pretty(self)
    }

    /// Get the default theme name
    pub fn default_theme_name(&self) -> Option<&str> {
        self.themes
            .iter()
            .find(|(_, entry)| entry.default)
            .map(|(name, _)| name.as_str())
    }
}

impl Default for PackManifest {
    fn default() -> Self {
        Self {
            pack: PackMeta {
                name: "unnamed".into(),
                version: "0.1.0".into(),
                description: None,
                authors: vec![],
                capabilities: vec![],
                license: None,
                repository: None,
                keywords: vec![],
            },
            compatibility: CompatibilityInfo::default(),
            templates: HashMap::new(),
            themes: HashMap::new(),
            components: HashMap::new(),
        }
    }
}