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

package/dist/generated/extract.d.ts

@@ -0,0 +1,235 @@
+/** One cell of a table block. */
+export type Cell = {
+    /** Its box in page space. */
+    bbox: [number, number, number, number];
+    /** The first column it covers, 0 at the left. */
+    col: number;
+    /** How many columns it covers. */
+    colSpan: number;
+    /** Whether it is in a header row. */
+    header: boolean;
+    /** The first row it covers, 0 at the top. */
+    row: number;
+    /** How many rows it covers. */
+    rowSpan: number;
+    /** Its visible text, lines joined by a space. */
+    text: string;
+};
+/** One chunk. */
+export type Chunk = {
+    /** The blocks it holds, in order. */
+    blockIds: string[];
+    /** The headings above its first block, outermost first. */
+    headingPath: string[];
+    /** `c<n>`, from 0, in order. */
+    id: string;
+    /** The pages its blocks are on, ascending. */
+    pages: number[];
+    /** Its area on each of those pages. */
+    regions: Region[];
+    /** The Markdown from the first block's start to the last block's end. */
+    text: string;
+    /** Where `text` sits in the Markdown. */
+    textRange: TextRange;
+    /** [`tokens_approx`] of `text`. */
+    tokensApprox: number;
+};
+/** ADR 0027 §4's `coordinates` block: top-left points of the displayed box. */
+export type Coordinates = {
+    /** `"CropBox"`, or `"default"` when the page had no usable box and US Letter was used. */
+    box: string;
+    /** Always `"top-left"`. */
+    origin: string;
+    /** The `/Rotate` applied, in degrees clockwise. */
+    rotate: number;
+    /** Always `"pt"`. */
+    unit: string;
+    /** The `/UserUnit` applied. */
+    userUnit: number;
+};
+/** Why text was left out. */
+export type DropReason = "invisible" | "off-page" | "tiny" | "clipped" | "low-contrast" | "artifact" | "running-header" | "running-footer" | "page-number";
+/**
+ * Text left out of the output ([ADR 0030] §4). It records a count, never the text, so a log of
+ * the output can't leak what was hidden.
+ *
+ * [ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+ */
+export type Dropped = {
+    /** Where it was, in page space. */
+    bbox: [number, number, number, number];
+    /** How many characters were left out. */
+    chars: number;
+    /** The page index. */
+    page: number;
+    /** Why it was left out (the first reason when there are several). */
+    reason: DropReason;
+    /**
+     * The run itself, only when [`DropOptions::keep_spans`](crate::DropOptions::keep_spans)
+     * asked for it.
+     */
+    spans?: Span[];
+};
+/**
+ * One extracted page ([ADR 0027] §4).
+ *
+ * [ADR 0027]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0027-coordinates-units-and-page-indexing.md
+ */
+export type ExtractedPage = {
+    /** The frame the boxes are in. */
+    coordinates: Coordinates;
+    /** The displayed height in points. */
+    height: number;
+    /** 0-based. */
+    index: number;
+    /** The page label (`/PageLabels`), when there is one. */
+    label?: string | null;
+    /** 1-based, as people count. */
+    number: number;
+    /** The displayed width in points (after `/Rotate` and `/UserUnit`). */
+    width: number;
+};
+/** The input, as ADR 0030 §1's `source` describes it. */
+export type ExtractedSource = {
+    /** The document's page count. */
+    pageCount: number;
+    /**
+     * The input's SHA-256 in hex: filled by the caller that holds the bytes (the façade), since
+     * a windowed source can't be hashed without reading it whole.
+     */
+    sha256?: string | null;
+    /** Where the reading order came from. */
+    structSource: StructSource;
+    /** Whether the catalog's `/MarkInfo` says `/Marked true`. */
+    tagged: boolean;
+};
+/** Why a run would be hidden from a reader; empty for visible text. */
+export type Flags = DropReason[];
+/** Who made the extraction (ADR 0030 §1's `generator`). */
+export type Generator = {
+    /** `"rules"`, or `"rules+models"` once model plug-ins exist. */
+    mode: string;
+    models: unknown[];
+    name: string;
+    version: string;
+};
+/** A block and where its text sits in the Markdown. */
+export type JsonBlock = {
+    /** The block's box in page space. */
+    bbox: [number, number, number, number];
+    /**
+     * The box divided by the page's width and height, clamped to [0, 1]; `None` when the
+     * block lies wholly outside the page.
+     */
+    bboxNorm?: [number, number, number, number] | null;
+    /** A table's cells, row by row; empty for every other block. */
+    cells?: Cell[];
+    /** In [0, 1]: 1 for structure from the tree, lower for structure inferred from layout. */
+    confidence: number;
+    /** `p<page index>-b<position in the page's reading order>`. */
+    id: string;
+    /** The page index. */
+    page: number;
+    /** The runs of text, in reading order. */
+    spans: Span[];
+    /** The structure types from the root down to the block; empty when untagged. */
+    structPath: string[];
+    /** The structure element the block comes from, when it comes from one. */
+    structRef?: StructRef | null;
+    /** The visible text, lines joined by a space after the text fixes (ADR 0030 §5). */
+    text: string;
+    textRange: TextRange;
+} & ({
+    /** 1–6. */
+    level: number;
+    type: "heading";
+} | {
+    type: "paragraph";
+} | {
+    /** 0 for the outermost list. */
+    depth: number;
+    /** The bullet or number that starts it. */
+    marker: string;
+    type: "list-item";
+} | {
+    type: "caption";
+} | {
+    type: "footnote";
+} | {
+    type: "other";
+} | {
+    /** The grid's columns. */
+    cols: number;
+    /** What found it. */
+    detector: TableDetector;
+    /** The grid's rows. */
+    rows: number;
+    type: "table";
+});
+/** A chunk's area on one page. */
+export type Region = {
+    /** The union of the chunk's blocks' boxes on that page, in page space. */
+    bbox: [number, number, number, number];
+    /** The page index. */
+    page: number;
+};
+/** One run of text in a block or a dropped entry. */
+export type Span = {
+    /** The baseline's y in page space (ADR 0027 §5). */
+    baseline: number;
+    /** Its box in page space. */
+    bbox: [number, number, number, number];
+    /** Why the run would be hidden; empty for visible text. */
+    flags: Flags;
+    /** The font's `/BaseFont`. */
+    font: string;
+    /** The glyph size in points. */
+    size: number;
+    /** The run's text. */
+    text: string;
+};
+/**
+ * A structure element ([ADR 0030] §1's `structRef`).
+ *
+ * [ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+ */
+export type StructRef = {
+    /** Its generation. */
+    gen: number;
+    /** The marked-content identifiers it covers on the page. */
+    mcids: number[];
+    /** The element's object number. */
+    obj: number;
+};
+/**
+ * Where the reading order came from ([ADR 0030] §2).
+ *
+ * [ADR 0030]: https://github.com/laudebugs/laminapdf/blob/main/docs/decisions/0030-extraction-output-and-model-plugins.md
+ */
+export type StructSource = "tagged" | "xycut" | "content";
+/** What found a table. */
+export type TableDetector = "lattice" | "stream" | "tagged";
+/**
+ * Where a piece of text sits in a rendering, in Unicode scalar values (`char`s), `start`
+ * inclusive and `end` exclusive. Code points, not bytes or UTF-16 units, so Python slices a
+ * rendering with them as they are; [`Rendered::slice`] does it in Rust.
+ */
+export type TextRange = {
+    /** One past the last character. */
+    end: number;
+    /** The first character. */
+    start: number;
+};
+/** The whole document. */
+export type Extraction = {
+    blocks: JsonBlock[];
+    chunks?: Chunk[] | null;
+    dropped: Dropped[];
+    generator: Generator;
+    pages: ExtractedPage[];
+    /** Always `"laminapdf.extract/1"`. */
+    schema: string;
+    source: ExtractedSource;
+    warnings: unknown[];
+};
+//# sourceMappingURL=extract.d.ts.map

package/dist/generated/extract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/generated/extract.ts"],"names":[],"mappings":"AAGA,iCAAiC;AACjC,MAAM,MAAM,IAAI,GAAG;IACjB,6BAA6B;IAC7B,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IACZ,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,iBAAiB;AACjB,MAAM,MAAM,KAAK,GAAG;IAClB,qCAAqC;IACrC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,uCAAuC;IACvC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,SAAS,EAAE,SAAS,CAAC;IACrB,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,+EAA+E;AAC/E,MAAM,MAAM,WAAW,GAAG;IACxB,0FAA0F;IAC1F,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,6BAA6B;AAC7B,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,UAAU,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAE3J;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,mCAAmC;IACnC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,MAAM,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,kCAAkC;IAClC,WAAW,EAAE,WAAW,CAAC;IACzB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,eAAe;IACf,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,eAAe,GAAG;IAC5B,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,yCAAyC;IACzC,YAAY,EAAE,YAAY,CAAC;IAC3B,6DAA6D;IAC7D,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC;AAEjC,2DAA2D;AAC3D,MAAM,MAAM,SAAS,GAAG;IACtB,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,SAAS,GAAG;IACtB,qCAAqC;IACrC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACnD,gEAAgE;IAChE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,0FAA0F;IAC1F,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,gFAAgF;IAChF,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC7B,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,SAAS,CAAC;CACtB,GAAG,CAAC;IACH,WAAW;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,CAAC;CACjB,GAAG;IACF,IAAI,EAAE,WAAW,CAAC;CACnB,GAAG;IACF,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;CACnB,GAAG;IACF,IAAI,EAAE,SAAS,CAAC;CACjB,GAAG;IACF,IAAI,EAAE,UAAU,CAAC;CAClB,GAAG;IACF,IAAI,EAAE,OAAO,CAAC;CACf,GAAG;IACF,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;CACf,CAAC,CAAC;AAEH,kCAAkC;AAClC,MAAM,MAAM,MAAM,GAAG;IACnB,0EAA0E;IAC1E,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qDAAqD;AACrD,MAAM,MAAM,IAAI,GAAG;IACjB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,2DAA2D;IAC3D,KAAK,EAAE,KAAK,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE1D,0BAA0B;AAC1B,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,0BAA0B;AAC1B,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,eAAe,CAAC;IACxB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC"}

package/dist/generated/extract.js

@@ -0,0 +1,4 @@
+// @generated by cargo xtask gen boundary. DO NOT EDIT.
+// From crates/laminapdf-extract/schemas/extract.schema.json.
+export {};
+//# sourceMappingURL=extract.js.map

package/dist/generated/extract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract.js","sourceRoot":"","sources":["../../src/generated/extract.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,6DAA6D"}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import type { InitOptions, WasmSource } from "./init.js";
+/**
+ * Loads the base WebAssembly module (fetched next to the package); with `{ text: true }`, the text
+ * module too. Idempotent: later calls return at once (or load the text module). Everything else
+ * in the package is synchronous and needs this promise to have resolved.
+ *
+ * @param input - where the base module comes from (a URL, `Response`, bytes or
+ *   `WebAssembly.Module`), or options; omitted, the file next to the package.
+ * @example
+ * ```ts
+ * await init(); // or: await init({ text: true })
+ * ```
+ */
+export declare function init(input?: WasmSource | InitOptions): Promise<void>;
+/**
+ * Loads the text module (fonts, shaping and text layout; about 940 KB gzipped). Builders
+ * created afterwards can draw text. Idempotent.
+ *
+ * @param source - where it comes from; omitted, the file next to the package.
+ */
+export declare function loadText(source?: WasmSource): Promise<void>;
+/**
+ * Loads the extract module (reading plus text extraction). Documents opened afterwards can
+ * extract text with `page.text()`. Idempotent; not needed when the text module is loaded.
+ *
+ * @param source - where it comes from; omitted, the file next to the package.
+ */
+export declare function loadExtract(source?: WasmSource): Promise<void>;
+export * from "./api.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAIzD;;;;;;;;;;;GAWG;AACH,wBAAgB,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE9D;AAED,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,37 @@
+import { initWith, loadExtractWith, loadTextWith } from "./init.js";
+import { locate } from "./loader/fetch.js";
+/**
+ * Loads the base WebAssembly module (fetched next to the package); with `{ text: true }`, the text
+ * module too. Idempotent: later calls return at once (or load the text module). Everything else
+ * in the package is synchronous and needs this promise to have resolved.
+ *
+ * @param input - where the base module comes from (a URL, `Response`, bytes or
+ *   `WebAssembly.Module`), or options; omitted, the file next to the package.
+ * @example
+ * ```ts
+ * await init(); // or: await init({ text: true })
+ * ```
+ */
+export function init(input) {
+    return initWith(locate, input);
+}
+/**
+ * Loads the text module (fonts, shaping and text layout; about 940 KB gzipped). Builders
+ * created afterwards can draw text. Idempotent.
+ *
+ * @param source - where it comes from; omitted, the file next to the package.
+ */
+export function loadText(source) {
+    return loadTextWith(locate, source);
+}
+/**
+ * Loads the extract module (reading plus text extraction). Documents opened afterwards can
+ * extract text with `page.text()`. Idempotent; not needed when the text module is loaded.
+ *
+ * @param source - where it comes from; omitted, the file next to the package.
+ */
+export function loadExtract(source) {
+    return loadExtractWith(locate, source);
+}
+export * from "./api.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,IAAI,CAAC,KAAgC;IACnD,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAmB;IAC1C,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC7C,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,cAAc,UAAU,CAAC"}

package/dist/init.d.ts

@@ -0,0 +1,88 @@
+import * as baseGlue from "@laminapdf/wasm/base";
+import { Instance } from "./internal/instance.js";
+/** The base module's wasm-bindgen glue. */
+export type BaseGlue = typeof baseGlue;
+/** The text module's wasm-bindgen glue (a superset of the base module's API). */
+export type TextGlue = typeof import("@laminapdf/wasm/text");
+/**
+ * Where a module comes from: a URL (or URL string) to fetch, a `Response` (or a promise of one),
+ * the bytes, or a compiled `WebAssembly.Module` (Cloudflare Workers import one).
+ */
+export type WasmSource = URL | string | Response | PromiseLike<Response> | ArrayBuffer | ArrayBufferView | WebAssembly.Module;
+/** Options for {@link init}. */
+export interface InitOptions {
+    /** The base module (default: the `lamina_pdf_base.wasm` next to the package, per export condition). */
+    readonly module?: WasmSource;
+    /**
+     * Also load the text module (fonts and text): `true` for the default file, or where it comes
+     * from. Without it, only builders created after a later {@link loadText} can draw text.
+     */
+    readonly text?: boolean | WasmSource;
+    /**
+     * Also load the extract module (reading plus text extraction, about half the text module's
+     * size): `true` for the default file, or where it comes from. Documents opened afterwards can
+     * extract text ({@link PageRef.text}). Not needed when the text module is loaded.
+     */
+    readonly extract?: boolean | WasmSource;
+}
+/**
+ * How an export condition finds a module's default file; `undefined` lets the wasm-bindgen glue
+ * fetch the `.wasm` next to itself.
+ */
+export type Locate = (module: "base" | "text" | "extract") => WasmSource | undefined | Promise<WasmSource | undefined>;
+/** Loads the text module (once; a failed load can be retried). */
+export declare function loadTextWith(locate: Locate, source?: WasmSource): Promise<void>;
+/**
+ * Loads the extract module (once; a failed load can be retried). Not when the text module is
+ * loaded or loading: it extracts too, and documents open in it first, so the extract module
+ * would never be used.
+ */
+export declare function loadExtractWith(locate: Locate, source?: WasmSource): Promise<void>;
+/** `init` for an export condition's `locate`. */
+export declare function initWith(locate: Locate, input?: WasmSource | InitOptions): Promise<void>;
+/** The base module. @throws {@link LaminaPdfError} `not-initialized` before `init()`. */
+export declare function baseModule(): Instance<BaseGlue>;
+/**
+ * The module documents are opened in: the text module when loaded, else the extract module, else
+ * the base one (each a superset of the base module's reading API; the first two extract text).
+ * @throws {@link LaminaPdfError} `not-initialized` before `init()`.
+ */
+export declare function readingModule(): Instance<BaseGlue>;
+/**
+ * Whether documents opened or built from now on can extract text: the extract or the text module
+ * is loaded. A document opened earlier stays in the module it was opened in; ask it with
+ * {@link Document.canExtractText}.
+ */
+export declare function isExtractLoaded(): boolean;
+/** Whether `doc` lives in a module that extracts text (the extract or the text module). */
+export declare function extractsText(doc: object): boolean;
+/** The text module, when loaded. */
+export declare function textModule(): Instance<TextGlue> | undefined;
+/** Whether `init()` has finished. */
+export declare function isInitialized(): boolean;
+/** Whether the text module is loaded (builders created now can draw text). */
+export declare function isTextLoaded(): boolean;
+/** The size of each loaded module's linear memory, in bytes. */
+export interface WasmMemory {
+    /** The base module's (absent before `init()`). */
+    readonly base?: number;
+    /** The text module's (absent until it is loaded). */
+    readonly text?: number;
+    /** The extract module's (absent until it is loaded). */
+    readonly extract?: number;
+}
+/**
+ * The size of each loaded module's WebAssembly memory. Memory grows and never shrinks; freed
+ * documents and builders leave room that later ones reuse.
+ *
+ * @returns the byte length of each loaded module's memory.
+ */
+export declare function wasmMemory(): WasmMemory;
+/**
+ * Replaces each loaded module's instance with a fresh one, so its memory returns to the size it
+ * had after `init()`: WebAssembly memory grows and never shrinks, and this gives it back. Every
+ * document, page, builder and save job made before throws `instance-reset` afterwards, so call it
+ * while none is in use, such as between jobs on a server. Images and fonts keep working.
+ */
+export declare function reset(): void;
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,2CAA2C;AAC3C,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;AACvC,iFAAiF;AACjF,MAAM,MAAM,QAAQ,GAAG,cAAc,sBAAsB,CAAC,CAAC;AAI7D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,GAAG,GACH,MAAM,GACN,QAAQ,GACR,WAAW,CAAC,QAAQ,CAAC,GACrB,WAAW,GACX,eAAe,GACf,WAAW,CAAC,MAAM,CAAC;AAEvB,gCAAgC;AAChC,MAAM,WAAW,WAAW;IAC1B,uGAAuG;IACvG,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,KAAK,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;AA6DvH,kEAAkE;AAClE,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAMlF;AAED,iDAAiD;AACjD,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAe9F;AAED,yFAAyF;AACzF,wBAAgB,UAAU,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAK/C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAGlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAEzC;AAED,2FAA2F;AAC3F,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAKjD;AAED,oCAAoC;AACpC,wBAAgB,UAAU,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,SAAS,CAE3D;AAED,qCAAqC;AACrC,wBAAgB,aAAa,IAAI,OAAO,CAEvC;AAED,8EAA8E;AAC9E,wBAAgB,YAAY,IAAI,OAAO,CAEtC;AAED,gEAAgE;AAChE,MAAM,WAAW,UAAU;IACzB,kDAAkD;IAClD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,UAAU,CAMvC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAE5B"}

package/dist/init.js

@@ -0,0 +1,139 @@
+// Loading the WebAssembly modules (ADR 0016 §2, §3): `init()` compiles and instantiates the base
+// module once; the text module is loaded by `init({ text: true })` or `loadText()`, the extract
+// module (base + text extraction) by `init({ extract: true })` or `loadExtract()`. After
+// that, every call is synchronous. `reset()` replaces each loaded module's instance
+// (internal/instance.ts). Each export condition supplies its own `Locate` (src/loader/), so
+// this file has no environment detection and no runtime-specific API.
+import * as baseGlue from "@laminapdf/wasm/base";
+import { packageError } from "./errors.js";
+import { Instance } from "./internal/instance.js";
+const base = {};
+const text = {};
+const extract = {};
+function isOptions(input) {
+    if (typeof input !== "object" || input === null || "then" in input)
+        return false;
+    const proto = Object.getPrototypeOf(input);
+    return proto === Object.prototype || proto === null;
+}
+/**
+ * Loads `slot`'s module once with `glue` (a failed load can be retried). A later call naming a
+ * different source than the first throws `already-initialized` instead of being ignored.
+ */
+function load(slot, name, glue, locate, source) {
+    if (slot.pending !== undefined) {
+        if (source !== undefined && source !== slot.requested) {
+            return Promise.reject(packageError("already-initialized", `the ${name} module is already loaded or loading from another source; the new source is ignored`));
+        }
+        return slot.pending;
+    }
+    slot.requested = source;
+    slot.pending = (async () => {
+        const g = await glue();
+        const from = source ?? (await locate(name));
+        const exports = (await g.default(from === undefined ? undefined : { module_or_path: from }));
+        slot.loaded = new Instance(name, g, exports);
+    })().catch((e) => {
+        slot.pending = undefined;
+        slot.requested = undefined;
+        throw e;
+    });
+    return slot.pending;
+}
+/** Loads the text module (once; a failed load can be retried). */
+export function loadTextWith(locate, source) {
+    return load(text, "text", () => import("@laminapdf/wasm/text"), locate, source);
+}
+/**
+ * Loads the extract module (once; a failed load can be retried). Not when the text module is
+ * loaded or loading: it extracts too, and documents open in it first, so the extract module
+ * would never be used.
+ */
+export function loadExtractWith(locate, source) {
+    const loadIt = () => load(extract, "extract", () => import("@laminapdf/wasm/extract"), locate, source);
+    // A source given is honoured as for any module; without one, a text module loaded or loading
+    // makes the extract module unnecessary, unless that load fails.
+    if (source !== undefined || text.pending === undefined)
+        return loadIt();
+    return text.pending.catch(loadIt);
+}
+/** `init` for an export condition's `locate`. */
+export async function initWith(locate, input) {
+    const options = input === undefined ? {} : isOptions(input) ? input : { module: input };
+    const loads = [load(base, "base", async () => baseGlue, locate, options.module)];
+    if (options.text !== undefined && options.text !== false) {
+        loads.push(loadTextWith(locate, options.text === true ? undefined : options.text));
+    }
+    // The text module extracts too: with it, the extract module would never be used.
+    if (options.extract !== undefined &&
+        options.extract !== false &&
+        (options.text === undefined || options.text === false)) {
+        loads.push(loadExtractWith(locate, options.extract === true ? undefined : options.extract));
+    }
+    await Promise.all(loads);
+}
+/** The base module. @throws {@link LaminaPdfError} `not-initialized` before `init()`. */
+export function baseModule() {
+    if (base.loaded === undefined) {
+        throw packageError("not-initialized", "init() has not finished loading the WebAssembly module");
+    }
+    return base.loaded;
+}
+/**
+ * The module documents are opened in: the text module when loaded, else the extract module, else
+ * the base one (each a superset of the base module's reading API; the first two extract text).
+ * @throws {@link LaminaPdfError} `not-initialized` before `init()`.
+ */
+export function readingModule() {
+    const base = baseModule();
+    return (text.loaded ?? extract.loaded ?? base);
+}
+/**
+ * Whether documents opened or built from now on can extract text: the extract or the text module
+ * is loaded. A document opened earlier stays in the module it was opened in; ask it with
+ * {@link Document.canExtractText}.
+ */
+export function isExtractLoaded() {
+    return extract.loaded !== undefined || text.loaded !== undefined;
+}
+/** Whether `doc` lives in a module that extracts text (the extract or the text module). */
+export function extractsText(doc) {
+    return ((text.loaded !== undefined && doc instanceof text.loaded.glue.WasmDocument) ||
+        (extract.loaded !== undefined && doc instanceof extract.loaded.glue.WasmDocument));
+}
+/** The text module, when loaded. */
+export function textModule() {
+    return text.loaded;
+}
+/** Whether `init()` has finished. */
+export function isInitialized() {
+    return base.loaded !== undefined;
+}
+/** Whether the text module is loaded (builders created now can draw text). */
+export function isTextLoaded() {
+    return text.loaded !== undefined;
+}
+/**
+ * The size of each loaded module's WebAssembly memory. Memory grows and never shrinks; freed
+ * documents and builders leave room that later ones reuse.
+ *
+ * @returns the byte length of each loaded module's memory.
+ */
+export function wasmMemory() {
+    return {
+        ...(base.loaded === undefined ? {} : { base: base.loaded.memoryBytes }),
+        ...(text.loaded === undefined ? {} : { text: text.loaded.memoryBytes }),
+        ...(extract.loaded === undefined ? {} : { extract: extract.loaded.memoryBytes }),
+    };
+}
+/**
+ * Replaces each loaded module's instance with a fresh one, so its memory returns to the size it
+ * had after `init()`: WebAssembly memory grows and never shrinks, and this gives it back. Every
+ * document, page, builder and save job made before throws `instance-reset` afterwards, so call it
+ * while none is in use, such as between jobs on a server. Images and fonts keep working.
+ */
+export function reset() {
+    for (const slot of [base, text, extract])
+        slot.loaded?.replace();
+}
+//# sourceMappingURL=init.js.map

package/dist/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,gGAAgG;AAChG,yFAAyF;AACzF,oFAAoF;AACpF,4FAA4F;AAC5F,sEAAsE;AACtE,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAqDlD,MAAM,IAAI,GAAmB,EAAE,CAAC;AAChC,MAAM,IAAI,GAAmB,EAAE,CAAC;AAChC,MAAM,OAAO,GAAsB,EAAE,CAAC;AAEtC,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACjF,MAAM,KAAK,GAAY,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACtD,CAAC;AAKD;;;GAGG;AACH,SAAS,IAAI,CACX,IAAa,EACb,IAAiC,EACjC,IAAsB,EACtB,MAAc,EACd,MAA8B;IAE9B,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACtD,OAAO,OAAO,CAAC,MAAM,CACnB,YAAY,CACV,qBAAqB,EACrB,OAAO,IAAI,qFAAqF,CACjG,CACF,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;IACxB,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,IAAI,EAAE;QACzB,MAAM,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAE1F,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;QACxB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,OAAO,CAAC;AACtB,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,MAAmB;IAC9D,OAAO,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAClF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc,EAAE,MAAmB;IACjE,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvG,6FAA6F;IAC7F,gEAAgE;IAChE,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,MAAM,EAAE,CAAC;IACxE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED,iDAAiD;AACjD,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,MAAc,EAAE,KAAgC;IAC7E,MAAM,OAAO,GAAgB,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACrG,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACjF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrF,CAAC;IACD,iFAAiF;IACjF,IACE,OAAO,CAAC,OAAO,KAAK,SAAS;QAC7B,OAAO,CAAC,OAAO,KAAK,KAAK;QACzB,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,EACtD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9F,CAAC;IACD,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,UAAU;IACxB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,YAAY,CAAC,iBAAiB,EAAE,wDAAwD,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,CAAkC,CAAC;AAClF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;AACnE,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,CACL,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,YAAY,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;QAC3E,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,YAAY,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAClF,CAAC;AACJ,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,UAAU;IACxB,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;AACnC,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY;IAC1B,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;AACnC,CAAC;AAYD;;;;;GAKG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO;QACL,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACvE,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACvE,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;KACjF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK;IACnB,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC;QAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;AACnE,CAAC"}

package/dist/internal/handle.d.ts

@@ -0,0 +1,58 @@
+import type { Glue, Instance } from "./instance.js";
+/** A handle the garbage collector reclaimed without a `free()`. */
+export interface Leak {
+    /** The handle's class: `Document`, `Builder` or `Image`. */
+    readonly handle: string;
+}
+/**
+ * Reports every document, builder and image created from now on that the garbage collector
+ * reclaims without a `free()` or `using`: a debugging aid for code that should free what it
+ * makes. Reclaimed handles are freed anyway, only later. `onLeak()` turns the reports off.
+ *
+ * @param hook - called once per leaked handle, some time after the collection.
+ */
+export declare function onLeak(hook?: (leak: Leak) => void): void;
+/** Watches `handle` for a leak while a hook is set; {@link forget} once it is freed. */
+export declare function watch(handle: object, name: string): void;
+/** Stops watching `handle`. */
+export declare function forget(handle: object): void;
+/** A handle on memory in one WebAssembly instance. */
+export declare abstract class Handle<G extends Glue = Glue> {
+    #private;
+    /**
+     * @param name - the class, as messages name it.
+     * @param instance - the instance the handle's memory lives in.
+     * @param parent - the handle it is freed with, if any.
+     */
+    protected constructor(name: string, instance: Instance<G>, parent?: Handle);
+    /** The instance this handle lives in (for the handles it makes). */
+    protected get instance(): Instance<G>;
+    /** Whether the handle's raw objects can be freed: its instance is current and hasn't trapped. */
+    protected get owned(): boolean;
+    /** Whether `free()` ran on this handle or its parent. */
+    protected get isFreed(): boolean;
+    /**
+     * @throws {@link LaminaPdfError} `disposed` after `free()` (here or on the parent);
+     *   `instance-reset` when the instance was replaced (a trapped one is replaced first).
+     */
+    protected assertLive(): void;
+    /** Runs `f` (calls into the glue) on this live handle; see {@link Instance.call}. */
+    protected call<T>(f: (glue: G) => T): T;
+    /** Frees the WebAssembly side; called at most once, and only while {@link owned}. */
+    protected abstract release(): void;
+    /**
+     * Frees the handle's memory now; without it, the garbage collector frees it later. A second
+     * call does nothing, and any other call afterwards throws `disposed`. Prefer `using`, which
+     * calls this at the end of the block.
+     */
+    free(): void;
+    /** Frees the handle at the end of a `using` block (an alias of `free()`). */
+    [Symbol.dispose](): void;
+}
+/** Gives `target`'s prototype the dispose method under {@link DISPOSE} where it isn't `Symbol.dispose`. */
+export declare function disposable(target: {
+    readonly prototype: {
+        free(): void;
+    };
+}): void;
+//# sourceMappingURL=handle.d.ts.map

package/dist/internal/handle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../../src/internal/handle.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAQpD,mEAAmE;AACnE,MAAM,WAAW,IAAI;IACnB,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAQD;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI,CAExD;AAED,wFAAwF;AACxF,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAExD;AAED,+BAA+B;AAC/B,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAE3C;AAED,sDAAsD;AACtD,8BAAsB,MAAM,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI;;IAQhD;;;;OAIG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,EAKzE;IAED,oEAAoE;IACpE,SAAS,KAAK,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAEpC;IAED,iGAAiG;IACjG,SAAS,KAAK,KAAK,IAAI,OAAO,CAE7B;IAED,yDAAyD;IACzD,SAAS,KAAK,OAAO,IAAI,OAAO,CAE/B;IAED;;;OAGG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI,CAK3B;IAED,qFAAqF;IACrF,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAGtC;IAED,qFAAqF;IACrF,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC;IAEnC;;;;OAIG;IACH,IAAI,IAAI,IAAI,CAMX;IAED,6EAA6E;IAC7E,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAEvB;CACF;AAED,2GAA2G;AAC3G,wBAAgB,UAAU,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,SAAS,EAAE;QAAE,IAAI,IAAI,IAAI,CAAA;KAAE,CAAA;CAAE,GAAG,IAAI,CASjF"}