inkhaven 2.4.0

Inkhaven — TUI literary work editor for Typst books
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

//! WBLD-1 (WB-P11) — the world dossier export.
//!
//! `/export` assembles a single readable Markdown document from everything the
//! worldbuilder knows: the compiled world state, the plausibility report, the
//! magic ledger, the recorded `fact:world` facts, and the Worldbuilding Journey
//! (the session timeline). It is a *record*, not generated prose — every line is
//! the author's own material or a deterministic measurement. Markdown keeps it
//! portable (no Typst-compile step) and naturally Unicode-clean for any project
//! language.

use crate::world::plausibility::Warning;
use crate::world::types::MagicLedger;

use super::session::SessionTurn;

/// Everything the dossier renders. Borrowed so the app assembles it without
/// cloning the world.
pub(super) struct DossierInput<'a> {
    pub world_name: &'a str,
    pub generated_at: &'a str,
    /// The compiled-state summary (`summarise_compiled`), if a world compiled.
    pub compiled: Option<&'a str>,
    pub score: Option<u8>,
    pub warnings: &'a [Warning],
    pub ledger: Option<&'a MagicLedger>,
    /// `(title, body)` of each `fact:world` paragraph, in tree order.
    pub facts: &'a [(String, String)],
    pub journey: &'a [SessionTurn],
}

/// Render the dossier to a Markdown string.
pub(super) fn build_dossier(input: &DossierInput) -> String {
    let mut s = String::new();
    let name = if input.world_name.trim().is_empty() { "Untitled world" } else { input.world_name.trim() };
    s.push_str(&format!("# World Dossier — {name}\n\n"));
    s.push_str(&format!("_Generated {} by the Inkhaven worldbuilder._\n\n", input.generated_at));

    // Plausibility headline.
    if let Some(score) = input.score {
        s.push_str(&format!("**Plausibility:** {score}/100\n\n"));
    }

    // Compiled world state.
    s.push_str("## Compiled world state\n\n");
    match input.compiled {
        Some(c) if !c.trim().is_empty() => {
            s.push_str("```\n");
            s.push_str(c.trim());
            s.push_str("\n```\n\n");
        }
        _ => s.push_str("_No world compiled yet — declare one (interview or `/set`), then `/compile`._\n\n"),
    }

    // Plausibility detail.
    if !input.warnings.is_empty() {
        s.push_str("## Plausibility warnings\n\n");
        for w in input.warnings {
            let sev = match w.severity {
                crate::world::plausibility::Severity::High => "HIGH",
                crate::world::plausibility::Severity::Medium => "MEDIUM",
                crate::world::plausibility::Severity::Low => "LOW",
            };
            s.push_str(&format!("- **[{sev}]** {}\n", w.text.trim()));
        }
        s.push('\n');
    }

    // Magic ledger.
    if let Some(l) = input.ledger {
        s.push_str("## Magic ledger\n\n");
        s.push_str(&format!(
            "Ledger is **{}** with {} rule(s).\n\n",
            if l.enabled { "enabled" } else { "disabled" },
            l.rules.len()
        ));
        for r in &l.rules {
            let kind = if r.kind.trim().is_empty() { "(no kind)" } else { r.kind.trim() };
            let covers = if r.covers.is_empty() { "—".to_string() } else { r.covers.join(", ") };
            s.push_str(&format!("- **{kind}** — covers {covers}"));
            if !r.description.trim().is_empty() {
                s.push_str(&format!(": {}", r.description.trim()));
            }
            s.push('\n');
        }
        s.push('\n');
    }

    // Recorded world facts.
    s.push_str("## World facts\n\n");
    if input.facts.is_empty() {
        s.push_str("_None recorded yet — capture them with `/wfact`._\n\n");
    } else {
        for (title, body) in input.facts {
            s.push_str(&format!("### {}\n\n", title.trim()));
            let body = body.trim();
            if !body.is_empty() {
                s.push_str(body);
                s.push_str("\n\n");
            }
        }
    }

    // The journey.
    s.push_str("## Worldbuilding Journey\n\n");
    if input.journey.is_empty() {
        s.push_str("_No steps recorded yet._\n\n");
    } else {
        for t in input.journey {
            let when = t.at.get(..16).unwrap_or(&t.at);
            let arc = match (t.plausibility_before, t.plausibility_after) {
                (Some(b), Some(a)) if a != b => format!(" · ★{b}→{a}"),
                (_, Some(a)) => format!(" · ★{a}"),
                _ => String::new(),
            };
            s.push_str(&format!(
                "{}. `{when}` **{}** — {}{arc}\n",
                t.seq,
                t.user.trim(),
                t.assistant_summary.trim(),
            ));
        }
        s.push('\n');
    }

    s
}

/// A Typst string literal (`"…"`, quotes included) with the only two characters
/// that can break a string escaped, and control characters flattened to spaces.
/// Rendering user prose as a *string* (not markup) makes injection impossible —
/// no `#`, `*`, `$`, `@`, `<` in a fact body is ever interpreted.
fn ts(s: &str) -> String {
    let mut out = String::with_capacity(s.len() + 2);
    out.push('"');
    for c in s.chars() {
        match c {
            '\\' => out.push_str("\\\\"),
            '"' => out.push_str("\\\""),
            '\n' | '\r' | '\t' => out.push(' '),
            _ => out.push(c),
        }
    }
    out.push('"');
    out
}

/// Render the dossier as a self-contained, compilable Typst document (WS-P3).
/// Structure is native Typst; every piece of author/measured text is emitted as
/// a string literal via [`ts`], so any project language and any punctuation is
/// safe. Compiled to PDF in-process by `/export --pdf`.
pub(super) fn build_dossier_typst(input: &DossierInput) -> String {
    let name = if input.world_name.trim().is_empty() { "Untitled world" } else { input.world_name.trim() };
    let mut s = String::new();
    s.push_str("#set document(title: ");
    s.push_str(&ts(&format!("World Dossier — {name}")));
    s.push_str(")\n");
    s.push_str("#set page(paper: \"a4\", margin: 2cm, numbering: \"1\")\n");
    s.push_str("#set text(font: (\"Libertinus Serif\", \"New Computer Modern\"), size: 11pt)\n");
    s.push_str("#set heading(numbering: \"1.\")\n\n");
    s.push_str(&format!("#text(size: 20pt, weight: \"bold\")[World Dossier — #({})]\n\n", ts(name)));
    s.push_str(&format!("#emph[Generated #({}) by the Inkhaven worldbuilder.]\n\n", ts(input.generated_at)));

    if let Some(score) = input.score {
        s.push_str(&format!("*Plausibility:* {score}/100\n\n"));
    }

    s.push_str("= Compiled world state\n\n");
    match input.compiled {
        Some(c) if !c.trim().is_empty() => {
            s.push_str(&format!("#raw(block: true, {})\n\n", ts(c.trim())));
        }
        _ => s.push_str("#emph[No world compiled yet.]\n\n"),
    }

    if !input.warnings.is_empty() {
        s.push_str("= Plausibility warnings\n\n");
        for w in input.warnings {
            let sev = match w.severity {
                crate::world::plausibility::Severity::High => "HIGH",
                crate::world::plausibility::Severity::Medium => "MEDIUM",
                crate::world::plausibility::Severity::Low => "LOW",
            };
            s.push_str(&format!("- *[{sev}]* #({})\n", ts(w.text.trim())));
        }
        s.push('\n');
    }

    if let Some(l) = input.ledger {
        s.push_str("= Magic ledger\n\n");
        s.push_str(&format!(
            "Ledger is *{}* with {} rule(s).\n\n",
            if l.enabled { "enabled" } else { "disabled" },
            l.rules.len()
        ));
        for r in &l.rules {
            let kind = if r.kind.trim().is_empty() { "(no kind)".to_string() } else { r.kind.trim().to_string() };
            let covers = if r.covers.is_empty() { "—".to_string() } else { r.covers.join(", ") };
            s.push_str(&format!("- *#({})* — covers #({})", ts(&kind), ts(&covers)));
            if !r.description.trim().is_empty() {
                s.push_str(&format!(": #({})", ts(r.description.trim())));
            }
            s.push('\n');
        }
        s.push('\n');
    }

    s.push_str("= World facts\n\n");
    if input.facts.is_empty() {
        s.push_str("#emph[None recorded yet.]\n\n");
    } else {
        for (title, body) in input.facts {
            s.push_str(&format!("== #({})\n\n", ts(title.trim())));
            let body = body.trim();
            if !body.is_empty() {
                s.push_str(&format!("#({})\n\n", ts(body)));
            }
        }
    }

    s.push_str("= Worldbuilding Journey\n\n");
    if input.journey.is_empty() {
        s.push_str("#emph[No steps recorded yet.]\n\n");
    } else {
        for t in input.journey {
            let when = t.at.get(..16).unwrap_or(&t.at);
            let arc = match (t.plausibility_before, t.plausibility_after) {
                (Some(b), Some(a)) if a != b => format!(" · {b}→{a}"),
                (_, Some(a)) => format!(" · {a}"),
                _ => String::new(),
            };
            s.push_str(&format!(
                "+ #({}) — #({}){}\n",
                ts(&format!("{} {}", when, t.user.trim())),
                ts(t.assistant_summary.trim()),
                arc,
            ));
        }
        s.push('\n');
    }

    s
}

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

    #[test]
    fn dossier_has_every_section_and_reports_empty_states() {
        let input = DossierInput {
            world_name: "Aldoria",
            generated_at: "2026-07-29T10:00",
            compiled: Some("World: Aldoria\nAstronomy: G star"),
            score: Some(88),
            warnings: &[Warning::medium("nations: capital is landlocked")],
            ledger: None,
            facts: &[],
            journey: &[],
        };
        let md = build_dossier(&input);
        assert!(md.contains("# World Dossier — Aldoria"));
        assert!(md.contains("**Plausibility:** 88/100"));
        assert!(md.contains("## Compiled world state"));
        assert!(md.contains("G star"));
        assert!(md.contains("**[MEDIUM]** nations: capital is landlocked"));
        assert!(md.contains("## World facts"));
        assert!(md.contains("capture them with `/wfact`"));
        assert!(md.contains("## Worldbuilding Journey"));
        assert!(md.contains("_No steps recorded yet._"));
    }

    #[test]
    fn typst_dossier_escapes_prose_as_string_literals() {
        // A fact body full of Typst-hostile characters must be neutralised.
        let input = DossierInput {
            world_name: "Aldoria",
            generated_at: "t",
            compiled: None,
            score: Some(90),
            warnings: &[],
            ledger: None,
            facts: &[("Injection".into(), "danger: #set page(width: 1pt) \"quote\" \\ end".into())],
            journey: &[],
        };
        let typ = build_dossier_typst(&input);
        // Structure is present.
        assert!(typ.contains("#set document(title:"));
        assert!(typ.contains("= World facts"));
        // The whole hostile body is wrapped in ONE `#("…")` string literal with
        // its quotes and backslashes escaped — so the `#set` inside it is inert
        // text, not a live directive.
        assert!(typ.contains(r#"#("danger: #set page(width: 1pt) \"quote\" \\ end")"#));
    }

    #[test]
    fn dossier_renders_facts_and_journey_when_present() {
        let input = DossierInput {
            world_name: "Aldoria",
            generated_at: "t",
            compiled: None,
            score: None,
            warnings: &[],
            ledger: None,
            facts: &[("Tidal harbours".into(), "The moons drive double tides.".into())],
            journey: &[SessionTurn {
                seq: 1,
                at: "2026-07-29T09:30:00Z".into(),
                user: "/star K".into(),
                assistant_summary: "shaping delta accepted".into(),
                plausibility_before: Some(100),
                plausibility_after: Some(95),
                ..Default::default()
            }],
        };
        let md = build_dossier(&input);
        assert!(md.contains("### Tidal harbours"));
        assert!(md.contains("The moons drive double tides."));
        assert!(md.contains("1. `2026-07-29T09:30` **/star K** — shaping delta accepted · ★100→95"));
        // No compiled world → the hint shows.
        assert!(md.contains("declare one"));
    }
}