@laminapdf/wasm 0.0.0-stage → 0.2.0-alpha.3

package/dist/lamina_pdf_extract.d.ts

@@ -0,0 +1,1450 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/** A page's text as `WasmPage.text` returns it. */
+export interface PageTextJs {
+    /** The text by line, in content order (runs on one baseline, joined; trimmed). */
+    lines: string[];
+    /** The runs, in content order. */
+    runs: TextRunJs[];
+    /** Each glyph's quad in page space: 8 numbers per glyph (x0, y0 … x3, y3). */
+    quads: Float32Array;
+    /** Every glyph's text, concatenated. */
+    glyphText: string;
+    /** UTF-16 offsets into glyphText: glyph i is glyphText.slice(glyphOffsets[i], glyphOffsets[i + 1]). */
+    glyphOffsets: Uint32Array;
+    /** Glyphs whose Unicode is unknown (U+FFFD). */
+    unmapped: number;
+}
+
+
+
+/** An error or warning (ADR 0026 §1). Errors are thrown as this object. */
+export interface Diagnostic {
+    code: string;
+    kind: "input" | "io" | "unsupported" | "limit" | "security" | "usage" | "state" | "cancelled" | "internal";
+    message: string;
+    hint?: string;
+    didYouMean?: string[];
+    location?: { offset?: number; object?: number; streamOffset?: number; pageIndex?: number; id?: string };
+    data?: Record<string, unknown>;
+    docsUrl: string;
+}
+
+
+/**
+ * A conformance profile.
+ */
+export type ProfileInit = "PDF/UA-1" | "PDF/A-2b" | "PDF/A-2u" | "PDF/A-3b";
+
+/**
+ * A job's progress (`laminapdf::Step::Progress`).
+ */
+export interface ProgressJs {
+    /**
+     * Work done so far (units of the phase).
+     */
+    done: number;
+    /**
+     * The total, when known.
+     */
+    total?: number;
+    /**
+     * The phase (`parse`, `layout`, `extract`, `render`, `write`, `sign`).
+     */
+    phase: string;
+}
+
+/**
+ * A list of ops with its schema version ([ADR 0006] §6): `{ "v": 1, "ops": [ … ] }`, used
+ * for saved op logs, batch processing and sync messages. Unknown fields are rejected, and so
+ * is a `v` this reader does not know; [`OpLog::from_json`] checks `v` before reading any op.
+ *
+ * ```
+ * use laminapdf_ops::OpLog;
+ *
+ * let log = OpLog::from_json(r#"{ "v": 1, "ops": [{ "op": "rotatePage", "args": { "page": "p3.0", "rotate": 180 } }] }"#)?;
+ * assert_eq!(log.ops().len(), 1);
+ * assert_eq!(OpLog::from_json(r#"{ "v": 2, "ops": [] }"#).map_err(|e| e.code()), Err("unsupported-version"));
+ * # Ok::<(), laminapdf_ops::Error>(())
+ * ```
+ *
+ * [ADR 0006]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0006-op-log-and-undo.md
+ */
+export interface OpLog {
+    v: 1;
+    ops: Op[];
+}
+
+/**
+ * A page-label numbering style.
+ */
+export type LabelStyleInit = "decimal" | "upperRoman" | "lowerRoman" | "upperLetters" | "lowerLetters";
+
+/**
+ * An attached file's options.
+ */
+export interface AttachmentInit {
+    /**
+     * How the file relates to the document (default `unspecified`).
+     */
+    relationship?: AfRelationshipInit;
+    /**
+     * `/Desc`, shown next to the file.
+     */
+    description?: string;
+    /**
+     * When the file last changed, a PDF date (default: the document's creation date).
+     */
+    modDate?: string;
+}
+
+/**
+ * An editing operation ([ADR 0006] §1): typed and semantic (it names things by
+ * [`LaminaPdfId`](laminapdf_model::LaminaPdfId), never by object reference), serialisable, and free
+ * of ambient inputs (a modification date is in the payload), so the same op on the same
+ * document gives the same result on every platform.
+ *
+ * Apply it inside a transaction ([`Tx::apply`](crate::Tx::apply)); its JSON form is
+ * adjacently tagged, `{ "op": "rotatePage", "args": { … } }`, and unknown ops and fields
+ * are rejected, never skipped.
+ *
+ * ```
+ * use laminapdf_ops::Op;
+ *
+ * let op: Op = serde_json::from_str(r#"{ "op": "rotatePage", "args": { "page": "p3.0", "rotate": 90 } }"#)?;
+ * assert_eq!(serde_json::to_string(&op)?, r#"{"op":"rotatePage","args":{"page":"p3.0","rotate":90}}"#);
+ * assert!(serde_json::from_str::<Op>(r#"{ "op": "explode", "args": {} }"#).is_err());
+ * # Ok::<(), serde_json::Error>(())
+ * ```
+ *
+ * [ADR 0006]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0006-op-log-and-undo.md
+ */
+export type Op = { op: "setInfo"; args: SetInfo } | { op: "rotatePage"; args: RotatePage };
+
+/**
+ * Changes to the Info dictionary's text entries. For each field, `None` leaves the entry
+ * alone, `Some(None)` removes it and `Some(Some(text))` sets it (encoded as
+ * PDFDocEncoding when it can be, else UTF-16BE, §7.9.2.2).
+ *
+ * On the wire an absent field is left alone and `null` clears: `{ "title": "Report",
+ * "author": null }`.
+ */
+export interface InfoPatch {
+    /**
+     * `/Title`.
+     */
+    title?: string | null;
+    /**
+     * `/Author`.
+     */
+    author?: string | null;
+    /**
+     * `/Subject`.
+     */
+    subject?: string | null;
+    /**
+     * `/Keywords`.
+     */
+    keywords?: string | null;
+    /**
+     * `/Creator`: the application that created the original document.
+     */
+    creator?: string | null;
+    /**
+     * `/Producer`: the application that converted it to PDF.
+     */
+    producer?: string | null;
+}
+
+/**
+ * Edits the Info dictionary: applies `patch` and, when `at` is given, sets `/ModDate` to it.
+ * The date is part of the op, never read from a clock, so the same op gives the same bytes
+ * everywhere (ADR 0006 §1).
+ *
+ * An Info dictionary written directly in the trailer, or missing, becomes a new indirect
+ * object that the trailer's `/Info` points to (the first time the op changes something).
+ */
+export interface SetInfo {
+    /**
+     * The entries to set or clear.
+     */
+    patch?: InfoPatch;
+    /**
+     * The modification date to record as `/ModDate`.
+     */
+    at?: string;
+}
+
+/**
+ * How a destination shows its page (§12.3.2.2).
+ */
+export type FitInit = { type: "page" } | { type: "width"; top?: number } | { type: "height"; left?: number } | { type: "xyz"; left?: number; top?: number; zoom?: number } | { type: "rect"; x: number; y: number; width: number; height: number } | { type: "bounds" };
+
+/**
+ * How a viewer lays pages out.
+ */
+export type PageLayoutInit = "singlePage" | "oneColumn" | "twoColumnLeft" | "twoColumnRight" | "twoPageLeft" | "twoPageRight";
+
+/**
+ * How an attached file relates to the document (`/AFRelationship`).
+ */
+export type AfRelationshipInit = "source" | "data" | "alternative" | "supplement" | "unspecified";
+
+/**
+ * How an undo or redo went (`laminapdf::UndoOutcome`).
+ */
+export type UndoOutcomeJs = "applied" | "partial" | "skipped";
+
+/**
+ * How the Markdown is cut into chunks.
+ */
+export interface ChunkInit {
+    /**
+     * A chunk's budget in approximate tokens (characters / 4); 512 by default.
+     */
+    maxTokens?: number;
+    /**
+     * Approximate tokens of whole blocks repeated from the chunk before; 0 by default.
+     */
+    overlap?: number;
+    /**
+     * Where chunks may start; `"headings"` by default.
+     */
+    splitOn?: SplitOnName;
+}
+
+/**
+ * How viewers present the document when it opens.
+ */
+export interface ViewerPreferencesInit {
+    /**
+     * Show the title, not the file name.
+     */
+    displayDocTitle?: boolean;
+    /**
+     * The panel shown.
+     */
+    pageMode?: PageModeInit;
+    /**
+     * The page layout.
+     */
+    pageLayout?: PageLayoutInit;
+}
+
+/**
+ * Object numbering in a full rewrite.
+ */
+export type RenumberJs = "keep" | "compact";
+
+/**
+ * One outline item and its children.
+ */
+export interface OutlineEntryInit {
+    /**
+     * The title shown.
+     */
+    title: string;
+    /**
+     * Where it goes (none: a heading).
+     */
+    target?: LinkTargetInit;
+    /**
+     * Its children.
+     */
+    children?: OutlineEntryInit[];
+    /**
+     * Shown expanded.
+     */
+    open?: boolean;
+    /**
+     * The title's colour, RGB 0 to 1.
+     */
+    color?: [number, number, number];
+    /**
+     * Bold title.
+     */
+    bold?: boolean;
+    /**
+     * Italic title.
+     */
+    italic?: boolean;
+}
+
+/**
+ * One page's facts (`laminapdf::PageInfo`).
+ */
+export interface PageInfoJs {
+    /**
+     * The 0-based index.
+     */
+    index: number;
+    /**
+     * The stable page ID (`p12.0`).
+     */
+    id: string;
+    /**
+     * Displayed width in points.
+     */
+    width: number;
+    /**
+     * Displayed height in points.
+     */
+    height: number;
+    /**
+     * `/Rotate` in degrees.
+     */
+    rotation: number;
+    /**
+     * The page label, when the document defines one (document text).
+     */
+    label?: string;
+}
+
+/**
+ * One page-label range, from page `start` (0-based) on.
+ */
+export interface PageLabelInit {
+    /**
+     * The first page of the range.
+     */
+    start: number;
+    /**
+     * The numbering style (none: prefix only).
+     */
+    style?: LabelStyleInit;
+    /**
+     * A prefix.
+     */
+    prefix?: string;
+    /**
+     * The first number (default 1).
+     */
+    first?: number;
+}
+
+/**
+ * One text run (`laminapdf::extract::PageTextRun`): glyphs of one font, size, direction and marked
+ * content on one baseline, in logical order.
+ */
+export interface TextRunJs {
+    /**
+     * The run's text in logical order (document text).
+     */
+    text: string;
+    /**
+     * The font's `/BaseFont` (document text).
+     */
+    font: string;
+    /**
+     * Font size in user-space units, the text matrix applied.
+     */
+    size: number;
+    /**
+     * Vertical writing.
+     */
+    vertical: boolean;
+    /**
+     * The marked-content ID the run is in, if any.
+     */
+    mcid?: number;
+    /**
+     * The text comes from an `/ActualText` span.
+     */
+    actualText: boolean;
+    /**
+     * Drawn invisibly (`Tr` 3 or 7).
+     */
+    invisible: boolean;
+    /**
+     * The bounds of the run's glyph quads, in page space (ADR 0027).
+     */
+    bounds: [number, number, number, number];
+    /**
+     * The run's glyphs: `[start, end)` into the page's glyph arrays.
+     */
+    glyphs: [number, number];
+}
+
+/**
+ * Options for `WasmDocument.extract`.
+ */
+export interface ExtractInit {
+    /**
+     * What to return.
+     */
+    format: ExtractFormat;
+    /**
+     * The 0-based page indices to extract, in this order; every page by default.
+     */
+    pages?: number[];
+    /**
+     * Where the reading order comes from; `"auto"` by default.
+     */
+    readingOrder?: ReadingOrderName;
+    /**
+     * What happens to hidden text.
+     */
+    drop?: DropInit;
+    /**
+     * Which table detectors run; `"lattice"` by default.
+     */
+    tables?: TableModeName;
+    /**
+     * Join words hyphenated across lines; on by default.
+     */
+    dehyphenate?: boolean;
+    /**
+     * Write `<!-- page N -->` before each page's first block (Markdown, chunks and JSON).
+     */
+    pageMarkers?: boolean;
+    /**
+     * How chunks are cut (`chunks`, and `json` to include them).
+     */
+    chunk?: ChunkInit;
+}
+
+/**
+ * Options for `WasmDocument.openBytes`.
+ */
+export interface OpenOptionsInit {
+    /**
+     * The user or owner password of an encrypted document.
+     */
+    password?: string;
+    /**
+     * Refuse files that need repair (`strict`).
+     */
+    strict?: boolean;
+    /**
+     * Resource limits (ADR 0003 §3); each one left out keeps its default.
+     */
+    limits?: LimitsInit;
+}
+
+/**
+ * Options for `WasmPage.text`.
+ */
+export interface TextOptionsInit {
+    /**
+     * Leave out text drawn invisibly (rendering modes 3 and 7: OCR layers, hidden text).
+     */
+    skipInvisible?: boolean;
+}
+
+/**
+ * Options for a new document: everything that would come from the environment is given,
+ * so the same calls give the same bytes.
+ */
+export interface BuildOptionsInit {
+    /**
+     * The header version (default 1.7).
+     */
+    version?: PdfVersionInit;
+    /**
+     * The first `/ID` entry: 16 bytes as 32 hex digits (default: a content hash).
+     */
+    id?: string;
+    /**
+     * `/Producer`.
+     */
+    producer?: string;
+    /**
+     * `/CreationDate`, a PDF date (`D:20261030120000Z`).
+     */
+    creationDate?: string;
+    /**
+     * Flate-compress content streams (default `true`).
+     */
+    compress?: boolean;
+    /**
+     * A tagged document (structure tree, `/MarkInfo`) even before any element (default
+     * `false`; a page using `beginTag` or `beginArtifact` makes it tagged either way).
+     */
+    tagged?: boolean;
+    /**
+     * Conformance profiles: `PDF/UA-1` with at most one PDF/A profile. `finish` then fails
+     * with a coded error for each machine-checkable rule the document breaks.
+     */
+    profiles?: ProfileInit[];
+}
+
+/**
+ * Options for saving.
+ */
+export interface SaveOptionsInit {
+    /**
+     * The mode (default `auto`).
+     */
+    mode?: SaveModeJs;
+    /**
+     * Save even when it invalidates signatures (removing them from the output).
+     */
+    invalidateSignatures?: boolean;
+    /**
+     * Write an encrypted document as a plaintext full rewrite.
+     */
+    removeEncryption?: boolean;
+    /**
+     * What an incremental save returns.
+     */
+    output?: OutputJs;
+    /**
+     * Numbering in a full rewrite.
+     */
+    renumber?: RenumberJs;
+    /**
+     * The cross-reference form.
+     */
+    xref?: XrefJs;
+}
+
+/**
+ * Sets a page's rotation to `rotate` (absolute, not relative to the current value).
+ *
+ * `/Rotate` is written on the page object itself, so a value inherited from a `/Pages`
+ * node is materialised on this page and its siblings keep theirs; an existing own entry
+ * keeps its position in the dictionary. The page object is changed, never replaced, so the
+ * page keeps its [`PageId`] and object number ([ADR 0005] §5). Nothing is written when the
+ * page already displays at `rotate` without an own entry.
+ *
+ * On the wire: `{ "op": "rotatePage", "args": { "page": "p12.0", "rotate": 90 } }`.
+ *
+ * [ADR 0005]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0005-document-model.md
+ */
+export interface RotatePage {
+    /**
+     * The page.
+     */
+    page: string;
+    /**
+     * The rotation in degrees clockwise: 0, 90, 180 or 270.
+     */
+    rotate: 0 | 90 | 180 | 270;
+}
+
+/**
+ * The Info dictionary's text entries; absent ones are left out (document text).
+ */
+export interface DocumentInfoJs {
+    /**
+     * `/Title`.
+     */
+    title?: string;
+    /**
+     * `/Author`.
+     */
+    author?: string;
+    /**
+     * `/Subject`.
+     */
+    subject?: string;
+    /**
+     * `/Keywords`.
+     */
+    keywords?: string;
+    /**
+     * `/Creator`.
+     */
+    creator?: string;
+    /**
+     * `/Producer`.
+     */
+    producer?: string;
+}
+
+/**
+ * The PDF version of a new document.
+ */
+export type PdfVersionInit = "1.4" | "1.5" | "1.6" | "1.7" | "2.0";
+
+/**
+ * The cross-reference form.
+ */
+export type XrefJs = "stream" | "classic";
+
+/**
+ * The document metadata (Info and XMP from the same values).
+ */
+export interface MetadataInit {
+    /**
+     * Title.
+     */
+    title?: string;
+    /**
+     * Author.
+     */
+    author?: string;
+    /**
+     * Subject.
+     */
+    subject?: string;
+    /**
+     * Keywords.
+     */
+    keywords?: string;
+    /**
+     * Creator (the application that made the content).
+     */
+    creator?: string;
+    /**
+     * Producer.
+     */
+    producer?: string;
+    /**
+     * Creation date, a PDF date.
+     */
+    creationDate?: string;
+    /**
+     * Modification date, a PDF date.
+     */
+    modDate?: string;
+}
+
+/**
+ * The kind of change an op makes. The save planner checks it against `DocMDP` / `FieldMDP`
+ * permissions and the document's `SaveConstraint` ([ADR 0007]).
+ *
+ * [ADR 0007]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0007-save-planner.md
+ */
+export type ModificationClass = "metadata" | "formFill" | "annotation" | "signature" | "pageStructure" | "content" | "document";
+
+/**
+ * The pages an edit touched.
+ */
+export interface EditedJs {
+    /**
+     * IDs of the pages whose content or attributes changed.
+     */
+    touchedPages: string[];
+}
+
+/**
+ * The panel a viewer opens with.
+ */
+export type PageModeInit = "none" | "outlines" | "thumbnails" | "fullScreen" | "optionalContent" | "attachments";
+
+/**
+ * The save mode (ADR 0007 §3).
+ */
+export type SaveModeJs = "auto" | "incremental" | "fullRewrite";
+
+/**
+ * What `WasmDocument.extract` returns.
+ */
+export type ExtractFormat = "markdown" | "json" | "text" | "chunks";
+
+/**
+ * What a save wrote (`laminapdf::SaveReport`).
+ */
+export interface SaveReportJs {
+    /**
+     * Bytes written.
+     */
+    bytesWritten: number;
+    /**
+     * The mode used (`incremental` or `fullRewrite`).
+     */
+    mode: SaveModeJs;
+    /**
+     * Old → new object numbers, when a full rewrite renumbered.
+     */
+    renumbered?: Record<string, number>;
+    /**
+     * Where the appended revision starts, for an incremental save.
+     */
+    appendOffset?: number;
+    /**
+     * How many signatures the save invalidated (with `invalidateSignatures`).
+     */
+    invalidatedSignatures: number;
+    /**
+     * Whether encryption was removed.
+     */
+    encryptionRemoved: boolean;
+}
+
+/**
+ * What an incremental save returns.
+ */
+export type OutputJs = "whole" | "appendedOnly";
+
+/**
+ * What happens to hidden text and page furniture.
+ */
+export interface DropInit {
+    /**
+     * Keep each dropped run's text in its `dropped` entry (JSON only), for auditing a file.
+     */
+    keepSpans?: boolean;
+    /**
+     * Drop running headers, footers, page numbers and artifact-marked text too, listing them
+     * in `dropped`; on by default.
+     */
+    furniture?: boolean;
+}
+
+/**
+ * Where a link or outline item goes.
+ */
+export type LinkTargetInit = { type: "uri"; uri: string } | { type: "page"; index: number; fit?: FitInit } | { type: "named"; name: string };
+
+/**
+ * Where chunks may start.
+ */
+export type SplitOnName = "headings" | "blocks" | "pages";
+
+/**
+ * Where the reading order comes from.
+ */
+export type ReadingOrderName = "auto" | "tagged" | "layout" | "content-stream";
+
+/**
+ * Which table detectors run.
+ */
+export type TableModeName = "off" | "lattice" | "lattice-and-stream";
+
+/**
+ * `Limits` with every field optional (ADR 0003 §3; names as in Rust, camelCase).
+ */
+export interface LimitsInit {
+    /**
+     *
+     */
+    maxNestingDepth?: number;
+    /**
+     *
+     */
+    maxStreamDecoded?: number;
+    /**
+     *
+     */
+    maxDecodedTotal?: number;
+    /**
+     *
+     */
+    maxFilterChain?: number;
+    /**
+     *
+     */
+    maxResolveDepth?: number;
+    /**
+     *
+     */
+    maxPageTreeDepth?: number;
+    /**
+     *
+     */
+    maxTreeDepth?: number;
+    /**
+     *
+     */
+    maxStringLength?: number;
+    /**
+     *
+     */
+    maxXrefSections?: number;
+    /**
+     *
+     */
+    maxObjectNumber?: number;
+    /**
+     *
+     */
+    maxWarnings?: number;
+    /**
+     *
+     */
+    maxContentOperators?: number;
+    /**
+     *
+     */
+    maxXobjectDepth?: number;
+    /**
+     *
+     */
+    maxImagePixels?: number;
+    /**
+     *
+     */
+    maxReadWindow?: number;
+}
+
+
+/**
+ * Builds a new document: pages, navigation and metadata, then [`WasmBuilder::finish`]
+ * gives a [`WasmDocument`] (unsaved; its save is a full rewrite).
+ */
+export class WasmBuilder {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Attaches a file (`/EmbeddedFiles`, the catalog's `/AF`): `name`, its bytes and its MIME
+     * type. The same name again replaces the file.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument` (a date that isn't a PDF date); `unknown-option`.
+     */
+    attach(name: string, bytes: Uint8Array, mime: string, options: AttachmentInit | undefined): void;
+    /**
+     * Defines the named destination `name`: page `index` shown as `fit` (default: the page).
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument` for a bad `fit`.
+     */
+    destination(name: string, index: number, fit: FitInit | undefined): void;
+    /**
+     * Writes the fonts, links, page tree, outline and metadata, and returns the document.
+     * The builder is finished afterwards, and so are its unfinished pages.
+     *
+     * # Errors
+     * `builder-finished`; `page-index-out-of-range`, `unknown-destination`,
+     * `invalid-page-labels`, `invalid-geometry`, `subset-failed`.
+     */
+    finish(): WasmDocument;
+    /**
+     * The natural language (`/Lang`), a BCP 47 tag.
+     *
+     * # Errors
+     * `builder-finished`.
+     */
+    lang(lang: string): void;
+    /**
+     * The metadata, written as the Info dictionary and an XMP packet.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument` (a date that isn't a PDF date).
+     */
+    metadata(metadata: MetadataInit): void;
+    /**
+     * A builder for a new, empty document.
+     *
+     * # Errors
+     * `invalid-argument` / `unknown-option` for bad options.
+     */
+    constructor(options: BuildOptionsInit | undefined);
+    /**
+     * Adds outline items (with their children); returns their IDs in pre-order.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument`; `limit-exceeded`.
+     */
+    outline(entries: OutlineEntryInit[]): string[];
+    /**
+     * The page labels, ranges by first page (checked at [`WasmBuilder::finish`]).
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument`.
+     */
+    pageLabels(ranges: PageLabelInit[]): void;
+    /**
+     * A page of `width` × `height` points, written by [`WasmPageBuilder::finish`].
+     */
+    page(width: number, height: number): WasmPageBuilder;
+    /**
+     * How viewers present the document when it opens.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-argument`.
+     */
+    viewerPreferences(prefs: ViewerPreferencesInit): void;
+}
+
+/**
+ * An open PDF: read it, edit it with ops (with undo), save it. The binding of
+ * `laminapdf::Document`, method for method (F12).
+ */
+export class WasmDocument {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Applies an op log (`{ "v": 1, "ops": [ … ] }`) as one transaction.
+     *
+     * # Errors
+     * `invalid-op-log`, `unsupported-version`; as [`WasmDocument::apply`].
+     */
+    applyLog(json: string): EditedJs;
+    /**
+     * Applies `ops` (the op JSON of ADR 0006 §6) in order, as one transaction.
+     *
+     * # Errors
+     * `invalid-argument` / `unknown-option` for a value that isn't an op; the first op's
+     * error (nothing is applied).
+     */
+    apply(ops: Op[]): EditedJs;
+    /**
+     * The document's text for retrieval and LLMs, as one string: Markdown, plain text, the
+     * `laminapdf.extract/1` JSON, or the chunks as a JSON array (the extract and text modules).
+     *
+     * # Errors
+     * `page-index-out-of-range` for a page in `pages` past the end; `data-pending` and the
+     * reading errors; `unknown-option` / `invalid-argument` for bad options.
+     */
+    extract(options: ExtractInit): string;
+    /**
+     * Whether there are changes no save has written yet.
+     */
+    hasUnsavedChanges(): boolean;
+    /**
+     * The Info dictionary's text entries.
+     *
+     * # Errors
+     * Reading errors.
+     */
+    info(): DocumentInfoJs;
+    /**
+     * Opens a document from its bytes.
+     *
+     * # Errors
+     * The §1 object: `not-pdf`, `password-required`, `wrong-password`, `limit-exceeded`, …;
+     * `invalid-argument` / `unknown-option` for bad options.
+     */
+    static openBytes(bytes: Uint8Array, options: OpenOptionsInit | undefined): WasmDocument;
+    /**
+     * Opens a document over a sparse source whose bytes arrive later. Until the source holds
+     * what a call needs, the call throws `data-pending` with `data.ranges` (`[offset, length]`
+     * pairs): supply them and call again. Lazy reads on the document can do the same.
+     *
+     * # Errors
+     * As `openBytes`, and `data-pending`.
+     */
+    static openSource(source: WasmSparseSource, options: OpenOptionsInit | undefined): WasmDocument;
+    /**
+     * A handle on the page with `id` (`p12.0`).
+     *
+     * # Errors
+     * `invalid-argument` for a malformed ID; `unknown-page`.
+     */
+    pageById(id: string): WasmPage;
+    /**
+     * The number of pages.
+     *
+     * # Errors
+     * Reading errors.
+     */
+    pageCount(): number;
+    /**
+     * Page `index`'s facts.
+     *
+     * # Errors
+     * `page-index-out-of-range`; reading errors.
+     */
+    pageInfo(index: number): PageInfoJs;
+    /**
+     * Every page's facts, in order (one page-tree walk).
+     *
+     * # Errors
+     * Reading errors.
+     */
+    pageInfos(): PageInfoJs[];
+    /**
+     * A handle on page `index` that follows the page by its ID (F2).
+     *
+     * # Errors
+     * `page-index-out-of-range`; reading errors.
+     */
+    page(index: number): WasmPage;
+    /**
+     * Rebases onto `bytes`, the output of a save whose rebase failed (`not-rebased`).
+     *
+     * # Errors
+     * `no-pending-save`; reading errors in `bytes`.
+     */
+    rebase(bytes: Uint8Array): void;
+    /**
+     * Redoes the newest undone transaction; `undefined` when there is nothing to redo.
+     *
+     * # Errors
+     * As [`WasmDocument::undo`].
+     */
+    redo(): UndoOutcomeJs | undefined;
+    /**
+     * A save as a job, stepped with a budget of work units (ADR 0028 §3, §4).
+     *
+     * # Errors
+     * `invalid-argument` / `unknown-option` for bad options.
+     */
+    saveJob(options: SaveOptionsInit | undefined): WasmSaveJob;
+    /**
+     * Saves and rebases onto the output, running to completion: `{ bytes, report }`.
+     *
+     * # Errors
+     * The save's errors (`would-invalidate-signatures`, `requires-rewrite`, …).
+     */
+    save(options: SaveOptionsInit | undefined): { bytes: Uint8Array<ArrayBuffer>; report: SaveReportJs };
+    /**
+     * Undoes the newest transaction; `undefined` when there is nothing to undo.
+     *
+     * # Errors
+     * `nested-transaction`, `saved-not-rebased`; reading errors.
+     */
+    undo(): UndoOutcomeJs | undefined;
+    /**
+     * A cursor over the warnings so far (build warnings first), each as the §1 object.
+     */
+    warnings(): WasmWarningCursor;
+}
+
+/**
+ * An image to draw (decoded or passed through once, shared by every use).
+ */
+export class WasmImage {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * A JPEG, passed through (`DCTDecode`).
+     *
+     * # Errors
+     * `invalid-image`, `unsupported-image`.
+     */
+    static jpeg(bytes: Uint8Array): WasmImage;
+    /**
+     * A PNG (alpha as an `/SMask`).
+     *
+     * # Errors
+     * `invalid-image`, `unsupported-image`, `image-too-large`.
+     */
+    static png(bytes: Uint8Array): WasmImage;
+    /**
+     * Raw 8-bit RGBA pixels, row by row.
+     *
+     * # Errors
+     * `invalid-image` when the length isn't `width × height × 4`.
+     */
+    static rgba(width: number, height: number, rgba: Uint8Array): WasmImage;
+    /**
+     * Height in pixels.
+     */
+    readonly height: number;
+    /**
+     * Width in pixels.
+     */
+    readonly width: number;
+}
+
+/**
+ * A page of a [`WasmDocument`], held by its ID (F2): moving pages doesn't retarget it.
+ */
+export class WasmPage {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The page's current 0-based index.
+     *
+     * # Errors
+     * `unknown-page` when the page is gone; `disposed` when its document is freed; reading
+     * errors.
+     */
+    index(): number;
+    /**
+     * The page's facts now.
+     *
+     * # Errors
+     * As [`WasmPage::index`].
+     */
+    info(): PageInfoJs;
+    /**
+     * The page's text: lines, runs, glyph quads and glyph text (the extract and text modules).
+     *
+     * # Errors
+     * `unknown-page` when the page is gone; `disposed` when its document is freed;
+     * `data-pending` and the reading errors; `unknown-option` / `invalid-argument` for bad
+     * options.
+     */
+    text(options: TextOptionsInit | undefined): PageTextJs;
+    /**
+     * The page's stable ID (`p12.0`).
+     */
+    readonly id: string;
+}
+
+/**
+ * One page being drawn, in page space (points from the top-left, y down; ADR 0027).
+ * Invalid geometry is reported by [`WasmPageBuilder::finish`] (`invalid-geometry`).
+ */
+export class WasmPageBuilder {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Opens an artifact until the matching `endTag`: `kind` is `layout`, `page`, `pagination`
+     * or `background`.
+     *
+     * # Errors
+     * `invalid-argument` for another kind.
+     */
+    beginArtifact(kind: string): void;
+    /**
+     * Opens a structure element until the matching `endTag`: `kind` names a standard type
+     * (`Document`, `Part`, `Sect`, `H1`–`H6`, `P`, `L`, `LI`, `Lbl`, `LBody`, `Table`, `TR`,
+     * `TH`, `TD`, `Figure`, `Caption`, `Link`, `Span`, `Quote`, `Note`, `Code`), the role of
+     * `custom` when given; `/Alt`, `/ActualText`, `/Lang`, `/E`; `scope` is `row`, `column` or
+     * `both` when given.
+     *
+     * # Errors
+     * `invalid-argument` for an unknown `kind` or `scope`.
+     */
+    beginTag(kind: string, custom?: string | null, alt?: string | null, actualText?: string | null, lang?: string | null, expansion?: string | null, scope?: string | null): void;
+    /**
+     * The blend mode, camelCase (`multiply`, `colorDodge`, …).
+     *
+     * # Errors
+     * `invalid-argument` for an unknown mode.
+     */
+    blendMode(mode: string): void;
+    /**
+     * Clips to `path` (with `rule`) until the next `restore`.
+     *
+     * # Errors
+     * As [`WasmPageBuilder::fill_path`].
+     */
+    clipPath(path: Float64Array, rule: string): void;
+    /**
+     * Ends the innermost open element or artifact (none open: nothing happens).
+     *
+     * # Errors
+     * `builder-finished`.
+     */
+    endTag(): void;
+    /**
+     * The fill colour as `#rrggbb` or `#rgb` (`DeviceRGB`).
+     *
+     * # Errors
+     * `invalid-color`.
+     */
+    fillColorHex(hex: string): void;
+    /**
+     * The colour fills use: 1 (gray), 3 (RGB) or 4 (CMYK) components, 0 to 1.
+     *
+     * # Errors
+     * `invalid-argument` for another number of components.
+     */
+    fillColor(components: Float64Array): void;
+    /**
+     * Fills `path` (the flat path encoding) with `rule` (`nonZero` or `evenOdd`).
+     *
+     * # Errors
+     * `invalid-argument` for a bad path or rule.
+     */
+    fillPath(path: Float64Array, rule: string): void;
+    /**
+     * Fills `path` with `rule`, then strokes it with the current stroke style.
+     *
+     * # Errors
+     * As [`WasmPageBuilder::fill_path`].
+     */
+    fillStrokePath(path: Float64Array, rule: string): void;
+    /**
+     * Writes the page into its builder: content stream, resources and page dictionary.
+     * Returns its page ID. The page is finished afterwards: every later call on it fails
+     * with `builder-finished`.
+     *
+     * # Errors
+     * `builder-finished` (the page or its builder already finished); `invalid-geometry` for
+     * the first invalid value drawn; `unknown-font` for a font from another builder.
+     */
+    finish(): string;
+    /**
+     * Draws `image` scaled into the rectangle.
+     *
+     * # Errors
+     * `builder-finished`.
+     */
+    image(image: WasmImage, x: number, y: number, width: number, height: number): void;
+    /**
+     * A link annotation over the rectangle, with `contents` as its alternate text.
+     *
+     * # Errors
+     * `invalid-argument` / `unknown-option` for a bad target.
+     */
+    link(x: number, y: number, width: number, height: number, target: LinkTargetInit, contents?: string | null): void;
+    /**
+     * Fill and stroke opacity, 0 to 1 (an `ExtGState`).
+     *
+     * # Errors
+     * `builder-finished`.
+     */
+    opacity(fill: number, stroke: number): void;
+    /**
+     * Restores the graphics state (`Q`); one without a matching save is ignored.
+     *
+     * # Errors
+     * `builder-finished`.
+     */
+    restore(): void;
+    /**
+     * `/Rotate`: 0, 90, 180 or 270 degrees.
+     *
+     * # Errors
+     * `invalid-argument` for another angle.
+     */
+    rotate(degrees: number): void;
+    /**
+     * Saves the graphics state (`q`).
+     *
+     * # Errors
+     * `builder-finished` after [`WasmPageBuilder::finish`] (so does every drawing method).
+     */
+    save(): void;
+    /**
+     * `/CropBox`, `/BleedBox`, `/TrimBox` or `/ArtBox` (`kind`: `crop`, `bleed`, `trim`,
+     * `art`), in the media box's page space.
+     *
+     * # Errors
+     * `invalid-argument` for another kind.
+     */
+    setBox(kind: "crop" | "bleed" | "trim" | "art", x: number, y: number, width: number, height: number): void;
+    /**
+     * The stroke colour as `#rrggbb` or `#rgb`.
+     *
+     * # Errors
+     * `invalid-color`.
+     */
+    strokeColorHex(hex: string): void;
+    /**
+     * The colour strokes use (as [`WasmPageBuilder::fill_color`]).
+     *
+     * # Errors
+     * As [`WasmPageBuilder::fill_color`].
+     */
+    strokeColor(components: Float64Array): void;
+    /**
+     * Strokes `path` with the current stroke style.
+     *
+     * # Errors
+     * `invalid-argument` for a bad path.
+     */
+    strokePath(path: Float64Array): void;
+    /**
+     * The style later strokes use: `width` (points), `cap` (`butt`, `round`, `square`),
+     * `join` (`miter`, `round`, `bevel`), the miter limit and a dash pattern (empty: solid).
+     *
+     * # Errors
+     * `invalid-argument` for an unknown cap or join.
+     */
+    strokeStyle(width: number, cap: string, join: string, miterLimit: number, dash: Float64Array, dashPhase: number): void;
+    /**
+     * Applies `[a, b, c, d, e, f]` (page space) to what is drawn next.
+     *
+     * # Errors
+     * `invalid-argument` unless there are 6 numbers.
+     */
+    transform(m: Float64Array): void;
+    /**
+     * `/UserUnit`, for pages larger than 14,400 units.
+     */
+    userUnit(unit: number): void;
+}
+
+/**
+ * A save in progress (F10). Each `step` checks that the document is unchanged since the
+ * job was created (`document-changed`).
+ */
+export class WasmSaveJob {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Stops the job: its next step fails with `cancelled`.
+     */
+    cancel(): void;
+    /**
+     * Runs at most `budget` work units: `{ state: "progress", done, total?, phase }` or
+     * `{ state: "done", bytes, report }`.
+     *
+     * # Errors
+     * `cancelled`, `document-changed`, `job-finished`, `disposed` when the document is freed,
+     * or the save's own errors.
+     */
+    step(budget: number): ({ state: "progress" } & ProgressJs) | { state: "done"; bytes: Uint8Array<ArrayBuffer>; report: SaveReportJs };
+}
+
+/**
+ * A PDF of known size whose bytes arrive later: give it to `WasmDocument.openSource`, and
+ * after a `data-pending` error `supply` the ranges in its `data.ranges` and call again.
+ */
+export class WasmSparseSource {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * An empty source of `size` bytes holding at most `budget` bytes (no limit when omitted).
+     *
+     * # Errors
+     * `invalid-argument` when a number isn't a whole number of bytes.
+     */
+    constructor(size: number, budget?: number | null);
+    /**
+     * Adds `bytes` at `offset` (bytes already held win over overlapping ones).
+     *
+     * # Errors
+     * `invalid-argument` past the end; `source-budget-exceeded` over the budget.
+     */
+    supply(offset: number, bytes: Uint8Array): void;
+    /**
+     * What to fetch for the ranges a `data-pending` asked for (flat `[start, end, …]`): each
+     * widened to blocks of `block` bytes (0: as asked) plus `readahead`, merged, minus what is
+     * held, in the same flat form. The planning step of `laminapdf-source`'s `retry`, so every
+     * loop plans the same way.
+     *
+     * # Errors
+     * `invalid-argument` for an odd length or a value that isn't a whole number of bytes.
+     */
+    toFetch(asked: Float64Array, block: number, readahead: number): Float64Array;
+    /**
+     * The source's size in bytes.
+     */
+    readonly size: number;
+}
+
+/**
+ * The warnings of a document, read in batches (F8).
+ */
+export class WasmWarningCursor {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Up to `max` more warnings, each as the ADR 0026 §1 object; empty at the end.
+     */
+    nextBatch(max: number): Diagnostic[];
+    /**
+     * How many warnings are left.
+     */
+    remaining(): number;
+}
+
+export function __wbg_reset_state(): void;
+
+/**
+ * Whether the most recent allocation failed: after a trap, `true` means the module ran out of
+ * memory.
+ */
+export function allocationFailed(): boolean;
+
+/**
+ * Whether this module is the text module (fonts, `text`, `textBox`).
+ */
+export function hasText(): boolean;
+
+/**
+ * The crate version (`@laminapdf/wasm`'s).
+ */
+export function version(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_wasmbuilder_free: (a: number, b: number) => void;
+    readonly __wbg_wasmdocument_free: (a: number, b: number) => void;
+    readonly __wbg_wasmimage_free: (a: number, b: number) => void;
+    readonly __wbg_wasmpage_free: (a: number, b: number) => void;
+    readonly __wbg_wasmpagebuilder_free: (a: number, b: number) => void;
+    readonly __wbg_wasmsavejob_free: (a: number, b: number) => void;
+    readonly __wbg_wasmsparsesource_free: (a: number, b: number) => void;
+    readonly __wbg_wasmwarningcursor_free: (a: number, b: number) => void;
+    readonly allocationFailed: () => number;
+    readonly hasText: () => number;
+    readonly version: () => [number, number];
+    readonly wasmbuilder_attach: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: any) => [number, number];
+    readonly wasmbuilder_destination: (a: number, b: number, c: number, d: number, e: any) => [number, number];
+    readonly wasmbuilder_finish: (a: number) => [number, number, number];
+    readonly wasmbuilder_lang: (a: number, b: number, c: number) => [number, number];
+    readonly wasmbuilder_metadata: (a: number, b: any) => [number, number];
+    readonly wasmbuilder_new: (a: any) => [number, number, number];
+    readonly wasmbuilder_outline: (a: number, b: any) => [number, number, number];
+    readonly wasmbuilder_page: (a: number, b: number, c: number) => number;
+    readonly wasmbuilder_pageLabels: (a: number, b: any) => [number, number];
+    readonly wasmbuilder_viewerPreferences: (a: number, b: any) => [number, number];
+    readonly wasmdocument_apply: (a: number, b: any) => [number, number, number];
+    readonly wasmdocument_applyLog: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmdocument_extract: (a: number, b: any) => [number, number, number, number];
+    readonly wasmdocument_hasUnsavedChanges: (a: number) => number;
+    readonly wasmdocument_info: (a: number) => [number, number, number];
+    readonly wasmdocument_openBytes: (a: number, b: number, c: any) => [number, number, number];
+    readonly wasmdocument_openSource: (a: number, b: any) => [number, number, number];
+    readonly wasmdocument_page: (a: number, b: number) => [number, number, number];
+    readonly wasmdocument_pageById: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmdocument_pageCount: (a: number) => [number, number, number];
+    readonly wasmdocument_pageInfo: (a: number, b: number) => [number, number, number];
+    readonly wasmdocument_pageInfos: (a: number) => [number, number, number];
+    readonly wasmdocument_rebase: (a: number, b: number, c: number) => [number, number];
+    readonly wasmdocument_redo: (a: number) => [number, number, number];
+    readonly wasmdocument_save: (a: number, b: any) => [number, number, number];
+    readonly wasmdocument_saveJob: (a: number, b: any) => [number, number, number];
+    readonly wasmdocument_undo: (a: number) => [number, number, number];
+    readonly wasmdocument_warnings: (a: number) => number;
+    readonly wasmimage_height: (a: number) => number;
+    readonly wasmimage_jpeg: (a: number, b: number) => [number, number, number];
+    readonly wasmimage_png: (a: number, b: number) => [number, number, number];
+    readonly wasmimage_rgba: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly wasmimage_width: (a: number) => number;
+    readonly wasmpage_id: (a: number) => [number, number];
+    readonly wasmpage_index: (a: number) => [number, number, number];
+    readonly wasmpage_info: (a: number) => [number, number, number];
+    readonly wasmpage_text: (a: number, b: any) => [number, number, number];
+    readonly wasmpagebuilder_beginArtifact: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_beginTag: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number) => [number, number];
+    readonly wasmpagebuilder_blendMode: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_clipPath: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly wasmpagebuilder_endTag: (a: number) => [number, number];
+    readonly wasmpagebuilder_fillColor: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_fillColorHex: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_fillPath: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly wasmpagebuilder_fillStrokePath: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly wasmpagebuilder_finish: (a: number) => [number, number, number, number];
+    readonly wasmpagebuilder_image: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
+    readonly wasmpagebuilder_link: (a: number, b: number, c: number, d: number, e: number, f: any, g: number, h: number) => [number, number];
+    readonly wasmpagebuilder_opacity: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_restore: (a: number) => [number, number];
+    readonly wasmpagebuilder_rotate: (a: number, b: number) => [number, number];
+    readonly wasmpagebuilder_save: (a: number) => [number, number];
+    readonly wasmpagebuilder_setBox: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly wasmpagebuilder_strokeColor: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_strokeColorHex: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_strokePath: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_strokeStyle: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number];
+    readonly wasmpagebuilder_transform: (a: number, b: number, c: number) => [number, number];
+    readonly wasmpagebuilder_userUnit: (a: number, b: number) => void;
+    readonly wasmsavejob_cancel: (a: number) => void;
+    readonly wasmsavejob_step: (a: number, b: number) => [number, number, number];
+    readonly wasmsparsesource_new: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmsparsesource_size: (a: number) => number;
+    readonly wasmsparsesource_supply: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly wasmsparsesource_toFetch: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly wasmwarningcursor_nextBatch: (a: number, b: number) => any;
+    readonly wasmwarningcursor_remaining: (a: number) => number;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;