@patrickdk77/pdf-defuse 0.0.0-stage → 0.1.2

package/dist/findings.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FindingFactory = void 0;
+exports.findingSpec = findingSpec;
+exports.allFindingSpecs = allFindingSpecs;
+const types_1 = require("./types");
+const specs = new Map();
+function def(c, d, action, weight, description) {
+    specs.set(`${c}/${d}`, { action, weight, description });
+}
+// ENCRYPTED
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.EmptyPassword, 'strip', 10, 'PDF encrypted with an empty user password');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.UserPassword, 'strip', 0, 'PDF decrypted with the supplied user password');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.OwnerPassword, 'strip', 0, 'PDF decrypted with the supplied owner password');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.PasswordRequired, 'reject', 0, 'PDF requires a password, and the one supplied did not open it');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.CertificateHandler, 'reject', 0, "PDF encrypted for specific recipients' certificates");
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.UnknownHandler, 'reject', 0, 'PDF uses an unrecognized security handler');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.UnknownCryptFilter, 'reject', 0, 'PDF uses an unrecognized encryption filter');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.Rc4_40, 'info', 0, 'Encryption is RC4 with a 40-bit key');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.Rc4_128, 'info', 0, 'Encryption is RC4 with a 128-bit key');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.Rc4Other, 'info', 0, 'Encryption is RC4 with a <bits>-bit key');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.Aes128, 'info', 0, 'Encryption is AES with a 128-bit key');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.Aes256, 'info', 0, 'Encryption is AES with a 256-bit key');
+def(types_1.PdfCategory.Encrypted, types_1.PdfDetail.MetadataUnencrypted, 'info', 0, 'Document metadata is stored unencrypted');
+// CORRUPTED
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.Unparseable, 'reject', 0, 'PDF cannot be parsed');
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.Truncated, 'reject', 0, 'PDF ends before its trailer');
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.XrefRebuilt, 'strip', 10, 'Cross-reference table missing or broken. Objects were found by scanning');
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.MalformedObject, 'strip', 10, 'An object has the wrong type for where it is used');
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.StreamLengthWrong, 'strip', 10, "A stream's declared length is missing or wrong");
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.LeadingBytes, 'strip', 5, 'Data before the PDF header');
+def(types_1.PdfCategory.Corrupted, types_1.PdfDetail.TrailingBytes, 'strip', 10, 'Data after the end of the PDF');
+// JAVASCRIPT
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Document, 'strip', 70, 'Document-level JavaScript runs when the PDF opens');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.OpenAction, 'strip', 70, 'JavaScript runs when the PDF opens');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Page, 'strip', 50, 'JavaScript runs when a page opens or closes');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Field, 'strip', 50, 'JavaScript formats, checks or calculates a form field');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Annotation, 'strip', 50, 'JavaScript runs on mouse or focus events of an annotation');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Link, 'strip', 50, 'A link runs JavaScript when clicked');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Bookmark, 'strip', 50, 'A bookmark runs JavaScript when clicked');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Chained, 'strip', 50, 'JavaScript runs after another action');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Rendition, 'strip', 50, 'A media action carries JavaScript');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Url, 'strip', 50, 'A link uses a javascript: URL');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.Unattached, 'strip', 50, 'A JavaScript entry sits outside any action');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.PluginPassed, 'info', 40, 'JavaScript kept unchanged by plugin <plugin>');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.PluginScrubbed, 'info', 20, 'JavaScript rewritten and kept by plugin <plugin>');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.PluginFailed, 'strip', 0, 'Plugin <plugin> failed, so the JavaScript was removed');
+def(types_1.PdfCategory.JavaScript, types_1.PdfDetail.PluginRemoved, 'strip', 0, 'JavaScript removed by plugin <plugin>');
+// ACTION
+def(types_1.PdfCategory.Action, types_1.PdfDetail.Launch, 'strip', 80, 'An action runs a program or opens a file');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.RemoteGoto, 'strip', 60, 'A link opens another PDF file');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.EmbeddedGoto, 'strip', 60, 'A link opens a PDF embedded in this one');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.SubmitForm, 'strip', 40, 'A form sends its data to a URL');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.ImportData, 'strip', 40, 'A form loads data from a file');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.Hide, 'strip', 20, 'An action shows or hides annotations');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.SetLayerState, 'strip', 20, 'An action shows or hides content layers');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.Named, 'strip', 20, 'An action runs a viewer menu command');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.Triggered, 'strip', 20, 'An action fires on an event instead of a click');
+def(types_1.PdfCategory.Action, types_1.PdfDetail.Unknown, 'strip', 30, 'An action of a type this package does not recognize');
+// LINK
+def(types_1.PdfCategory.Link, types_1.PdfDetail.Safe, 'info', 0, 'Web or email link kept');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.FileUrl, 'strip', 60, 'A link opens a local file');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.NetworkPath, 'strip', 60, 'A link opens a network share');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.DataUrl, 'strip', 60, 'A link carries embedded data');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.OtherScheme, 'strip', 30, 'A link uses a scheme other than http, https or mailto');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.Credentials, 'strip', 40, 'A link hides its real host behind a user name');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.IpHost, 'strip', 40, 'A link points at a raw IP address');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.LookalikeHost, 'strip', 40, "A link's host uses punycode or mixed scripts");
+def(types_1.PdfCategory.Link, types_1.PdfDetail.EncodedHost, 'strip', 40, "A link's host is percent-encoded");
+def(types_1.PdfCategory.Link, types_1.PdfDetail.TextMismatch, 'strip', 40, "A link's tooltip names a different site");
+def(types_1.PdfCategory.Link, types_1.PdfDetail.FullPage, 'strip', 20, 'A link covers most of the page');
+def(types_1.PdfCategory.Link, types_1.PdfDetail.Relative, 'strip', 30, "A relative link with no base address, which resolves against the file's own location");
+// EMBEDDED_FILE
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.NoPlugin, 'strip', 30, '<Attached file "{name}"|An attached file> (<{sniffed}|{type}|unknown type>) removed. No plugin accepts this type');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.TypeMismatch, 'info', 40, 'The types of <attached file "{name}"|an unnamed attached file> disagree: <its name says {nameType}|its name has no known extension>, <it is declared {declared}|it has no declared type>, and <its content looks like {sniffed}|its content is not recognized>');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.PluginPassed, 'info', 20, 'Attached file kept by plugin <plugin> with nothing removed');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.PluginScrubbed, 'info', 10, 'Attached file cleaned and kept by plugin <plugin>');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.PluginFailed, 'strip', 0, 'Plugin <plugin> failed, so the attached file was removed');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.PluginRemoved, 'strip', 0, 'Attached file removed by plugin <plugin>');
+def(types_1.PdfCategory.EmbeddedFile, types_1.PdfDetail.Portfolio, 'strip', 30, 'PDF is a portfolio of files');
+// MEDIA
+def(types_1.PdfCategory.Media, types_1.PdfDetail.Movie, 'strip', 30, 'Embedded movie removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.Sound, 'strip', 30, 'Embedded sound removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.Screen, 'strip', 30, 'Embedded screen annotation removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.RichMedia, 'strip', 30, 'Embedded rich media removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.ThreeD, 'strip', 30, 'Embedded 3D content removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.Rendition, 'strip', 30, 'Embedded rendition removed');
+def(types_1.PdfCategory.Media, types_1.PdfDetail.Slideshow, 'strip', 30, 'Embedded slideshow removed');
+// ANNOTATION
+def(types_1.PdfCategory.Annotation, types_1.PdfDetail.UnknownSubtype, 'strip', 30, 'An annotation of a type outside the allowlist');
+// FORM
+def(types_1.PdfCategory.Form, types_1.PdfDetail.Fields, 'info', 0, 'PDF has fillable form fields');
+def(types_1.PdfCategory.Form, types_1.PdfDetail.Xfa, 'strip', 40, 'PDF has an XFA form, which carries its own scripts');
+def(types_1.PdfCategory.Form, types_1.PdfDetail.CalculationOrder, 'strip', 20, 'Form calculation order removed with the calculation scripts it ran');
+// SIGNATURE
+def(types_1.PdfCategory.Signature, types_1.PdfDetail.Signed, 'info', 0, 'PDF is digitally signed. A rewrite invalidates the signature');
+def(types_1.PdfCategory.Signature, types_1.PdfDetail.Certified, 'info', 0, 'PDF is certified against changes. A rewrite invalidates the certification');
+def(types_1.PdfCategory.Signature, types_1.PdfDetail.UsageRights, 'info', 0, 'PDF carries Reader usage rights, which disarming removes');
+// STRUCTURE
+def(types_1.PdfCategory.Structure, types_1.PdfDetail.IncrementalUpdates, 'strip', 0, 'PDF has earlier revisions, which can hold deleted content');
+def(types_1.PdfCategory.Structure, types_1.PdfDetail.UnreferencedObjects, 'strip', 0, 'PDF has objects nothing refers to');
+def(types_1.PdfCategory.Structure, types_1.PdfDetail.VersionUpgraded, 'info', 0, 'The catalog declares a newer PDF version than the header');
+def(types_1.PdfCategory.Structure, types_1.PdfDetail.ShadowedObjects, 'strip', 20, 'PDF holds object definitions its cross-reference table does not use, which other readers may pick instead');
+def(types_1.PdfCategory.Structure, types_1.PdfDetail.EscapedNames, 'info', 30, 'Keywords are written with escape codes, a known way to hide them from scanners');
+// CONTENT
+def(types_1.PdfCategory.Content, types_1.PdfDetail.Jbig2Image, 'info', 30, 'An image uses JBIG2 compression, a past source of reader exploits');
+def(types_1.PdfCategory.Content, types_1.PdfDetail.JpxImage, 'info', 10, 'An image uses JPEG 2000 compression, a past source of reader exploits');
+def(types_1.PdfCategory.Content, types_1.PdfDetail.Type3Font, 'info', 10, 'A Type 3 font draws glyphs with page-description commands, a past source of reader exploits');
+// METADATA
+def(types_1.PdfCategory.Metadata, types_1.PdfDetail.InfoDictionary, 'info', 0, 'Document information names an author, a tool or dates');
+def(types_1.PdfCategory.Metadata, types_1.PdfDetail.Xmp, 'info', 0, 'XMP metadata present');
+def(types_1.PdfCategory.Metadata, types_1.PdfDetail.Stripped, 'info', 0, 'Metadata removed because the caller turned on metadata stripping');
+// LIMIT
+def(types_1.PdfCategory.Limit, types_1.PdfDetail.FileSize, 'reject', 0, 'PDF exceeds the file size limit');
+def(types_1.PdfCategory.Limit, types_1.PdfDetail.ObjectCount, 'reject', 0, 'PDF exceeds the object count limit');
+def(types_1.PdfCategory.Limit, types_1.PdfDetail.DecompressedSize, 'reject', 0, 'PDF exceeds the decompressed size limit');
+def(types_1.PdfCategory.Limit, types_1.PdfDetail.NestingDepth, 'reject', 0, 'PDF exceeds the nesting depth limit');
+def(types_1.PdfCategory.Limit, types_1.PdfDetail.Time, 'reject', 0, 'PDF exceeds the time limit');
+// PROCESSING
+def(types_1.PdfCategory.Processing, types_1.PdfDetail.MemoryFallback, 'info', 0, '<part> was too large for memory and went through a temporary file');
+def(types_1.PdfCategory.Processing, types_1.PdfDetail.VerificationFailed, 'reject', 0, 'The defused output did not pass its own inspection, so nothing was written');
+def(types_1.PdfCategory.Processing, types_1.PdfDetail.ContentRemoved, 'strip', 20, 'Content was removed that no other finding names');
+/** The built-in spec for a kind of finding, or undefined for a kind pdf-defuse does not make, such as one from another package. */
+function findingSpec(category, detail) {
+    return specs.get(`${category}/${detail}`);
+}
+/** The spec of a kind pdf-defuse makes itself, which always has one. */
+function ownSpec(category, detail) {
+    const s = findingSpec(category, detail);
+    if (!s)
+        throw new Error(`No finding spec for ${category}/${detail}`);
+    return s;
+}
+function allFindingSpecs() {
+    return [...specs.entries()].map(([k, s]) => {
+        const [category, detail] = k.split('/');
+        return { category, detail, ...s };
+    });
+}
+class FindingFactory {
+    overrides;
+    constructor(overrides = []) {
+        this.overrides = overrides;
+    }
+    actionFor(category, detail) {
+        const exact = this.overrides.find(o => o.category === category && o.detail === detail);
+        if (exact)
+            return exact.action;
+        const byCategory = this.overrides.find(o => o.category === category && o.detail === undefined);
+        if (byCategory)
+            return byCategory.action;
+        return ownSpec(category, detail).action;
+    }
+    make(category, detail, location, data) {
+        const spec = ownSpec(category, detail);
+        // Values can come from the PDF, so the description shows no control or direction characters from them.
+        const shown = (v) => String(v).replace(/[\p{Cc}\p{Cf}]/gu, '?');
+        const description = spec.description.replace(/<([^<>]+)>/g, (m, body) => {
+            if (/^[a-z]+$/.test(body))
+                return data?.[body] !== undefined ? shown(data[body]) : m;
+            for (const alt of body.split('|')) {
+                let missing = false;
+                const filled = alt.replace(/\{([a-zA-Z]+)\}/g, (_, key) => {
+                    const v = data?.[key];
+                    if (v === undefined || v === '')
+                        missing = true;
+                    const s = shown(v ?? '');
+                    return s.length > 60 ? `${s.slice(0, 57)}...` : s;
+                });
+                if (!missing)
+                    return filled;
+            }
+            return m;
+        });
+        const f = { category, detail, description, action: this.actionFor(category, detail) };
+        if (location !== undefined)
+            f.location = location;
+        if (data !== undefined && Object.keys(data).length)
+            f.data = data;
+        return f;
+    }
+}
+exports.FindingFactory = FindingFactory;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export type { DelimitedOptions, FormulaHandling } from './data-plugins';
+export { csvPlugin, jsonPlugin, tsvPlugin } from './data-plugins';
+export { disarmPdf, disarmPdfSource, inspectPdf, inspectPdfSource } from './engine';
+export { allFindingSpecs } from './findings';
+export { bufferSink, bufferSource, fileSink, fileSource, writableSink } from './io';
+export { passThrough, pdfPlugin } from './plugins';
+export { COMBINATIONS, DEFAULT_BANDS, scoreFindings } from './score';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scoreFindings = exports.DEFAULT_BANDS = exports.COMBINATIONS = exports.pdfPlugin = exports.passThrough = exports.writableSink = exports.fileSource = exports.fileSink = exports.bufferSource = exports.bufferSink = exports.allFindingSpecs = exports.inspectPdfSource = exports.inspectPdf = exports.disarmPdfSource = exports.disarmPdf = exports.tsvPlugin = exports.jsonPlugin = exports.csvPlugin = void 0;
+var data_plugins_1 = require("./data-plugins");
+Object.defineProperty(exports, "csvPlugin", { enumerable: true, get: function () { return data_plugins_1.csvPlugin; } });
+Object.defineProperty(exports, "jsonPlugin", { enumerable: true, get: function () { return data_plugins_1.jsonPlugin; } });
+Object.defineProperty(exports, "tsvPlugin", { enumerable: true, get: function () { return data_plugins_1.tsvPlugin; } });
+var engine_1 = require("./engine");
+Object.defineProperty(exports, "disarmPdf", { enumerable: true, get: function () { return engine_1.disarmPdf; } });
+Object.defineProperty(exports, "disarmPdfSource", { enumerable: true, get: function () { return engine_1.disarmPdfSource; } });
+Object.defineProperty(exports, "inspectPdf", { enumerable: true, get: function () { return engine_1.inspectPdf; } });
+Object.defineProperty(exports, "inspectPdfSource", { enumerable: true, get: function () { return engine_1.inspectPdfSource; } });
+var findings_1 = require("./findings");
+Object.defineProperty(exports, "allFindingSpecs", { enumerable: true, get: function () { return findings_1.allFindingSpecs; } });
+var io_1 = require("./io");
+Object.defineProperty(exports, "bufferSink", { enumerable: true, get: function () { return io_1.bufferSink; } });
+Object.defineProperty(exports, "bufferSource", { enumerable: true, get: function () { return io_1.bufferSource; } });
+Object.defineProperty(exports, "fileSink", { enumerable: true, get: function () { return io_1.fileSink; } });
+Object.defineProperty(exports, "fileSource", { enumerable: true, get: function () { return io_1.fileSource; } });
+Object.defineProperty(exports, "writableSink", { enumerable: true, get: function () { return io_1.writableSink; } });
+var plugins_1 = require("./plugins");
+Object.defineProperty(exports, "passThrough", { enumerable: true, get: function () { return plugins_1.passThrough; } });
+Object.defineProperty(exports, "pdfPlugin", { enumerable: true, get: function () { return plugins_1.pdfPlugin; } });
+var score_1 = require("./score");
+Object.defineProperty(exports, "COMBINATIONS", { enumerable: true, get: function () { return score_1.COMBINATIONS; } });
+Object.defineProperty(exports, "DEFAULT_BANDS", { enumerable: true, get: function () { return score_1.DEFAULT_BANDS; } });
+Object.defineProperty(exports, "scoreFindings", { enumerable: true, get: function () { return score_1.scoreFindings; } });
+__exportStar(require("./types"), exports);

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import cjs from './index.js';
+export const { csvPlugin, jsonPlugin, tsvPlugin, disarmPdf, disarmPdfSource, inspectPdf, inspectPdfSource, allFindingSpecs, bufferSink, bufferSource, fileSink, fileSource, writableSink, passThrough, pdfPlugin, COMBINATIONS, DEFAULT_BANDS, scoreFindings, PdfCategory, PdfDetail, PdfRisk } = cjs;
+export default cjs;

package/dist/io.d.ts

@@ -0,0 +1,81 @@
+import type { Writable } from 'node:stream';
+import type { ByteSink, ByteSource } from './types';
+/** A source over bytes already in memory. Reads return views, not copies. */
+export declare function bufferSource(bytes: Uint8Array): ByteSource;
+/** A source over a local file, read at offsets through one file handle. */
+export declare function fileSource(filePath: string): ByteSource;
+/** Collects output in memory. */
+export declare function bufferSink(): ByteSink & {
+    result(): Uint8Array;
+    size(): number;
+};
+/** Writes to a local file. The file is created on the first write. */
+export declare function fileSink(filePath: string): ByteSink;
+/**
+ * Wraps any Node Writable, waiting for 'drain' when it applies backpressure. The stream's first error, or its
+ * closing before the end, fails the pending write and every later one.
+ */
+export declare function writableSink(stream: Writable): ByteSink;
+/** Random-access reader with a small block cache, so the parser can ask for overlapping windows cheaply. */
+export declare class Reader {
+    readonly source: ByteSource;
+    readonly size: number;
+    private readonly blockSize;
+    private readonly maxBlocks;
+    private readonly cache;
+    private readonly order;
+    constructor(source: ByteSource, size: number, blockSize?: number, maxBlocks?: number);
+    private block;
+    /** Reads up to `length` bytes at `offset`; shorter only at the end of the source. */
+    read(offset: number, length: number): Promise<Uint8Array>;
+    /** Yields the range in chunks without caching them. */
+    chunks(offset: number, length: number, chunkSize?: number): AsyncGenerator<Uint8Array>;
+}
+/** A private temporary directory, removed by cleanup(). It also keeps the run's first I/O error. */
+export declare class TempDir {
+    private readonly base;
+    private dir?;
+    private seq;
+    /**
+     * The first error from a temporary file or a watched source. The parser recovers from a failed read as if the
+     * file were damaged, so the engine checks this to report an I/O error instead of a verdict on the PDF.
+     */
+    ioError?: unknown;
+    constructor(base?: string);
+    file(suffix?: string): Promise<string>;
+    cleanup(): Promise<void>;
+    /**
+     * Wraps a source so that its errors also land in ioError. Once the source has given its size, a read that returns
+     * more or fewer bytes than that size allows is an error too: the parser would take the shifted bytes for the file.
+     */
+    watch(source: ByteSource): ByteSource;
+}
+/** A sink that keeps small output in memory and moves to a temporary file past a threshold. */
+export declare class SpillSink implements ByteSink {
+    private readonly temp;
+    private readonly threshold;
+    private chunks;
+    private size;
+    private filePath?;
+    private handle?;
+    private readonly md5;
+    private hex?;
+    spilled: boolean;
+    constructor(temp: TempDir, threshold: number);
+    write(chunk: Uint8Array): Promise<void>;
+    close(): Promise<void>;
+    /** Closes the sink and deletes its temporary file, once nothing will read what it holds again. */
+    dispose(): Promise<void>;
+    get length(): number;
+    /** The temporary file, once the sink has spilled. */
+    get path(): string | undefined;
+    digest(): string;
+    /** A source over what was written. Call after close(). */
+    source(): ByteSource;
+    read(chunkSize?: number): AsyncGenerator<Uint8Array>;
+}
+/**
+ * Copies a whole source, calling `checkTime` before each chunk. A read that returns more or fewer bytes than it asked
+ * for fails the copy, which would otherwise shift every byte after it.
+ */
+export declare function copyToSink(source: ByteSource, sink: ByteSink, checkTime?: () => void): Promise<void>;