ctypst 0.3.7

Safe, deterministic, embedded Typst for Rust applications
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
use std::path::PathBuf;
use std::sync::Mutex;

use typst::foundations::{Bytes, Dict, IntoValue};
use typst::text::Font;
use typst::{World as _, WorldExt as _};
use typst_as_lib::{TypstAsLibError, TypstEngine, TypstWorld};

use crate::files::{
    PackageFileList, Packages, SafeFsResolver, VirtualFiles, check_package, invalid_package,
};
use crate::{
    CompileOutput, CompileReport, CompileRequest, DiagnosticsPolicy, Document, Error, Limits,
    Result,
};

/// Builder for a capability-limited embedded Typst engine.
pub struct EngineBuilder {
    root: Option<PathBuf>,
    fonts: Vec<Vec<u8>>,
    sources: Vec<(String, String)>,
    binaries: Vec<(String, Vec<u8>)>,
    packages: Vec<(String, PackageFileList)>,
    limits: Limits,
    cache_age: usize,
}

impl Default for EngineBuilder {
    fn default() -> Self {
        Self {
            root: None,
            fonts: Vec::new(),
            sources: Vec::new(),
            binaries: Vec::new(),
            packages: Vec::new(),
            limits: Limits::default(),
            cache_age: 2,
        }
    }
}

impl EngineBuilder {
    #[must_use]
    /// Permit root-relative reads below one canonical filesystem directory.
    pub fn root(mut self, root: impl Into<PathBuf>) -> Self {
        self.root = Some(root.into());
        self
    }

    #[must_use]
    /// Add font bytes that will be validated and parsed at build time.
    pub fn fonts<I, B>(mut self, fonts: I) -> Self
    where
        I: IntoIterator<Item = B>,
        B: AsRef<[u8]>,
    {
        self.fonts
            .extend(fonts.into_iter().map(|font| font.as_ref().to_vec()));
        self
    }

    /// Add a persistent virtual Typst source.
    pub fn source(mut self, path: impl Into<String>, source: impl Into<String>) -> Result<Self> {
        let path = path.into();
        let source = source.into();
        let probe = VirtualFiles::new(self.limits, Packages::default());
        let _ = probe.apply_updates([(path.clone(), source.clone())], [])?;
        self.sources.push((path, source));
        Ok(self)
    }

    /// Add a persistent virtual binary asset.
    pub fn binary(mut self, path: impl Into<String>, binary: impl Into<Vec<u8>>) -> Result<Self> {
        let path = path.into();
        let binary = binary.into();
        let probe = VirtualFiles::new(self.limits, Packages::default());
        let _ = probe.apply_updates([], [(path.clone(), binary.clone())])?;
        self.binaries.push((path, binary));
        Ok(self)
    }

    /// Register the files of one Typst package for offline imports.
    ///
    /// `spec` is the full `@namespace/name:version` that templates import.
    /// Paths are package-relative, such as `typst.toml` or `src/lib.typ`, and
    /// the package's `typst.toml` must name this spec and a supplied
    /// entrypoint. Registered files are served from memory; any other package
    /// or version remains unavailable, and nothing is ever downloaded.
    pub fn package<I, P, B>(mut self, spec: &str, files: I) -> Result<Self>
    where
        I: IntoIterator<Item = (P, B)>,
        P: Into<String>,
        B: Into<Vec<u8>>,
    {
        let files = files
            .into_iter()
            .map(|(path, data)| (path.into(), data.into()))
            .collect::<Vec<_>>();
        let parsed = check_package(spec, &files, self.limits)?.to_string();
        if self.packages.iter().any(|(known, _)| *known == parsed) {
            return Err(invalid_package(parsed, "package is already registered"));
        }
        self.packages.push((parsed, files));
        Ok(self)
    }

    #[must_use]
    /// Replace the finite resource limits.
    pub const fn limits(mut self, limits: Limits) -> Self {
        self.limits = limits;
        self
    }

    #[must_use]
    /// Set the number of compilation generations retained by Typst's memo cache.
    pub const fn cache_age(mut self, compilations: usize) -> Self {
        self.cache_age = compilations;
        self
    }

    /// Validate all resources and build the reusable engine.
    pub fn build(self) -> Result<Engine> {
        Self::check_limit(
            "font collection",
            "font file count",
            self.fonts.len(),
            self.limits.max_fonts,
        )?;
        let mut font_bytes = 0_usize;
        let mut parsed_fonts = Vec::new();
        for (index, font) in self.fonts.into_iter().enumerate() {
            Self::check_limit(
                &format!("font {index}"),
                "font file bytes",
                font.len(),
                self.limits.max_font_bytes,
            )?;
            font_bytes = font_bytes.saturating_add(font.len());
            Self::check_limit(
                "font collection",
                "total font bytes",
                font_bytes,
                self.limits.max_total_font_bytes,
            )?;
            let previous_faces = parsed_fonts.len();
            for parsed in Font::iter(Bytes::new(font)) {
                parsed_fonts.push(parsed);
                Self::check_limit(
                    "font collection",
                    "parsed font count",
                    parsed_fonts.len(),
                    self.limits.max_fonts,
                )?;
            }
            if parsed_fonts.len() == previous_faces {
                return Err(Error::InvalidFont { index });
            }
        }
        if parsed_fonts.is_empty() {
            return Err(Error::NoValidFont);
        }
        let packages = Packages::new(self.packages, self.limits)?;
        let virtual_files = VirtualFiles::new(self.limits, packages.clone());
        let _ = virtual_files.apply_updates(self.sources, self.binaries)?;
        let fs_resolver = self
            .root
            .as_deref()
            .map(|root| SafeFsResolver::new(root, self.limits, packages))
            .transpose()?;
        let mut builder = TypstEngine::builder()
            .fonts(parsed_fonts)
            .add_file_resolver(virtual_files.clone());
        if let Some(resolver) = &fs_resolver {
            builder = builder.add_file_resolver(resolver.clone());
        }
        builder.comemo_evict_max_age(Some(self.cache_age));
        Ok(Engine {
            inner: builder.build(),
            virtual_files,
            fs_resolver,
            compile_lock: Mutex::new(()),
            limits: self.limits,
        })
    }

    fn check_limit(
        resource: &str,
        limit_name: &'static str,
        actual: usize,
        maximum: usize,
    ) -> Result<()> {
        if actual > maximum {
            return Err(Error::Limit {
                resource: resource.to_owned(),
                limit_name,
                actual,
                maximum,
            });
        }
        Ok(())
    }
}

/// A reusable embedded Typst compiler with no ambient network or font access.
pub struct Engine {
    inner: TypstEngine,
    virtual_files: VirtualFiles,
    fs_resolver: Option<SafeFsResolver>,
    compile_lock: Mutex<()>,
    limits: Limits,
}

impl Engine {
    #[must_use]
    /// Start building a capability-limited engine.
    pub fn builder() -> EngineBuilder {
        EngineBuilder::default()
    }

    /// Compile one request under the engine lock and enforce its contracts.
    pub fn compile(&self, request: CompileRequest) -> Result<CompileOutput> {
        self.compile_tracked(request).result
    }

    /// Compile and report filesystem dependencies, including on failure.
    ///
    /// The report is captured under the compilation lock, so concurrent callers
    /// cannot mix dependency sets. Every call starts a fresh set, including when
    /// Typst reuses memoized work. Caller-provided virtual files and fonts remain
    /// the caller's responsibility to watch.
    pub fn compile_tracked(&self, request: CompileRequest) -> CompileReport {
        let Ok(_guard) = self.compile_lock.lock() else {
            return CompileReport {
                result: Err(Error::Poisoned),
                dependencies: Vec::new(),
            };
        };
        if let Some(resolver) = &self.fs_resolver
            && let Err(error) = resolver.reset()
        {
            return CompileReport {
                result: Err(error),
                dependencies: Vec::new(),
            };
        }
        let result = self.compile_request(request);
        let dependencies = self
            .fs_resolver
            .as_ref()
            .map(SafeFsResolver::dependencies)
            .transpose();
        match dependencies {
            Ok(paths) => CompileReport {
                result,
                dependencies: paths.unwrap_or_default(),
            },
            Err(error) => CompileReport {
                result: Err(error),
                dependencies: Vec::new(),
            },
        }
    }

    fn compile_request(&self, request: CompileRequest) -> Result<CompileOutput> {
        Self::check_size(
            &request.source,
            "path bytes",
            request.source.len(),
            self.limits.max_path_bytes,
        )?;
        Self::check_size(
            &request.source,
            "input count",
            request.inputs.len(),
            self.limits.max_inputs,
        )?;
        let input_bytes = request
            .inputs
            .iter()
            .map(|(key, value)| key.len().saturating_add(value.len()))
            .fold(0_usize, usize::saturating_add);
        Self::check_size(
            &request.source,
            "input bytes",
            input_bytes,
            self.limits.max_input_bytes,
        )?;
        let snapshot = self
            .virtual_files
            .apply_updates(request.sources, request.binaries)?;
        let mut inputs = Dict::new();
        for (key, value) in &request.inputs {
            inputs.insert(key.as_str().into(), value.clone().into_value());
        }
        let result = (|| {
            let compiled = self
                .inner
                .compile_with_input::<_, _, Document>(request.source.as_str(), inputs);
            let warnings =
                format_diagnostics(&self.inner, request.source.as_str(), &compiled.warnings);
            if request.diagnostics == DiagnosticsPolicy::DenyWarnings && !warnings.is_empty() {
                return Err(Error::Warnings {
                    document: request.source.clone(),
                    diagnostics: warnings.join("; "),
                });
            }
            let document = compiled.output.map_err(|error| Error::Compile {
                document: request.source.clone(),
                diagnostics: format_compile_error(&self.inner, request.source.as_str(), &error),
            })?;
            let actual = document.pages().len();
            if !request.pages.accepts(actual, self.limits.max_pages) {
                return Err(Error::PageCount {
                    document: request.source.clone(),
                    actual,
                    expected: request.pages.describe(self.limits.max_pages),
                });
            }
            Ok(CompileOutput { document, warnings })
        })();
        if let Some(snapshot) = snapshot {
            self.virtual_files.restore(snapshot)?;
        }
        result
    }

    #[cfg(feature = "pdf")]
    pub(crate) fn check_pdf_size(&self, bytes: usize) -> Result<()> {
        Self::check_size("PDF", "PDF bytes", bytes, self.limits.max_pdf_bytes)
    }

    #[cfg(feature = "raster")]
    pub(crate) fn check_raster_size(&self, pixels: usize) -> Result<()> {
        Self::check_size(
            "raster page",
            "raster pixels",
            pixels,
            self.limits.max_raster_pixels,
        )
    }

    fn check_size(
        resource: &str,
        limit_name: &'static str,
        actual: usize,
        maximum: usize,
    ) -> Result<()> {
        if actual > maximum {
            return Err(Error::Limit {
                resource: resource.to_owned(),
                limit_name,
                actual,
                maximum,
            });
        }
        Ok(())
    }
}

/// Render one compilation failure for [`Error::Compile`]: the diagnostic
/// messages with their file and line when the span resolves, never the
/// `Debug` rendering of the whole diagnostic list. Non-Typst failures keep
/// their existing text.
fn format_compile_error(engine: &TypstEngine, source: &str, error: &TypstAsLibError) -> String {
    match error {
        TypstAsLibError::TypstSource(diagnostics) => {
            format_diagnostics(engine, source, diagnostics).join("; ")
        }
        _ => error.to_string(),
    }
}

/// Join Typst diagnostics as readable `message (file:line)` entries for
/// [`Error::Compile`] and [`Error::Warnings`]. The file and line are omitted
/// when the span does not resolve; the message is always kept.
fn format_diagnostics(
    engine: &TypstEngine,
    source: &str,
    diagnostics: &[typst::diag::SourceDiagnostic],
) -> Vec<String> {
    engine
        .with_world(source, |world| {
            diagnostics
                .iter()
                .map(|diagnostic| format_diagnostic(world, diagnostic))
                .collect::<Vec<_>>()
        })
        .unwrap_or_else(|_| {
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.message.as_str().to_owned())
                .collect()
        })
}

/// One Typst diagnostic as `message (file:line)`: the file is the
/// workspace-relative virtual path (or `package@vpath` for package files)
/// and the line is 1-based. Detached spans keep the bare message.
fn format_diagnostic(world: &TypstWorld<'_>, diagnostic: &typst::diag::SourceDiagnostic) -> String {
    let message = diagnostic.message.as_str();
    let Some(id) = diagnostic.span.id() else {
        return message.to_owned();
    };
    let rooted = id.get();
    let file = match rooted.root() {
        typst::syntax::VirtualRoot::Project => rooted.vpath().get_without_slash().to_owned(),
        typst::syntax::VirtualRoot::Package(spec) => {
            format!("{spec}{}", rooted.vpath().get_with_slash())
        }
    };
    let line = world.range(diagnostic.span).and_then(|range| {
        let text = world.source(id).ok()?;
        // The range start can split a character; without a clean prefix there
        // is no line to report, so only the file is kept.
        let prefix = text.text().get(..range.start.min(text.text().len()))?;
        Some(prefix.split('\n').count())
    });
    match line {
        Some(line) => format!("{message} ({file}:{line})"),
        None => format!("{message} ({file})"),
    }
}