@laminapdf/wasm 0.2.0-alpha.4 → 0.2.0-alpha.6

package/dist/lamina_pdf_render_hayro.js

@@ -95,10 +95,13 @@ export class HayroDocument {
         return v1;
     }
     /**
-     * Renders the request into `out` (exactly `width × height × 4` bytes, straight RGBA).
+     * Renders the request into `out` (exactly `width × height × 4` bytes, straight RGBA), in
+     * the page appearance `appearance` (0 original, 1 sepia, 2 dark, 3 high contrast with `ink`
+     * and `paper` as `0xRRGGBBAA`; the colours are ignored otherwise).
      *
      * # Errors
-     * As [`HayroDocument::plan`], plus `render-failed` and `invalid-argument` for a wrong size.
+     * As [`HayroDocument::plan`], plus `render-failed`, and `invalid-argument` for a wrong size
+     * or an unknown appearance.
      * @param {number} page
      * @param {number} scale
      * @param {number} x
@@ -108,12 +111,15 @@ export class HayroDocument {
      * @param {number} rotation
      * @param {number} flags
      * @param {number | null | undefined} background
+     * @param {number} appearance
+     * @param {number} ink
+     * @param {number} paper
      * @param {Uint8Array} out
      */
-    render(page, scale, x, y, width, height, rotation, flags, background, out) {
+    render(page, scale, x, y, width, height, rotation, flags, background, appearance, ink, paper, out) {
         var ptr0 = passArray8ToWasm0(out, wasm.__wbindgen_malloc);
         var len0 = WASM_VECTOR_LEN;
-        const ret = wasm.hayrodocument_render(this.__wbg_ptr, page, scale, x, y, width, height, rotation, flags, isLikeNone(background) ? Number.MAX_SAFE_INTEGER : (background) >>> 0, ptr0, len0, out);
+        const ret = wasm.hayrodocument_render(this.__wbg_ptr, page, scale, x, y, width, height, rotation, flags, isLikeNone(background) ? Number.MAX_SAFE_INTEGER : (background) >>> 0, appearance, ink, paper, ptr0, len0, out);
         if (ret[1]) {
             throw takeFromExternrefTable0(ret[0]);
         }

package/dist/lamina_pdf_text.d.ts

@@ -32,6 +32,18 @@ export interface Diagnostic {
 }
 
 
+
+/** One link on a page, in page space, and what following it does (by `kind`). */
+export type PageLinkJs = {
+    /** Its rectangle: `[x0, y0, x1, y1]`, top-left and bottom-right. */
+    rect: [number, number, number, number];
+    /** The areas that follow it, eight numbers per area; absent when the rectangle is the area. */
+    quads?: number[];
+    /** Its description (`/Contents`, document text). */
+    contents?: string;
+} & LinkToJs;
+
+
 /**
  * A colour for text options (the text module's records).
  */
@@ -42,6 +54,112 @@ export type ColorInit = number[] | string;
  */
 export type ProfileInit = "PDF/UA-1" | "PDF/A-2b" | "PDF/A-2u" | "PDF/A-3b";
 
+/**
+ * A document's properties, for a properties view.
+ */
+export interface PropertiesJs {
+    /**
+     * `/Title`.
+     */
+    title?: string;
+    /**
+     * `/Author`.
+     */
+    author?: string;
+    /**
+     * `/Subject`.
+     */
+    subject?: string;
+    /**
+     * `/Keywords`.
+     */
+    keywords?: string;
+    /**
+     * `/Creator`: the application the document was made with.
+     */
+    creator?: string;
+    /**
+     * `/Producer`: the application that wrote the PDF.
+     */
+    producer?: string;
+    /**
+     * `/CreationDate` as ISO 8601.
+     */
+    created?: string;
+    /**
+     * `/ModDate` as ISO 8601.
+     */
+    modified?: string;
+    /**
+     * The XMP packet as text.
+     */
+    xmp?: string;
+    /**
+     * The PDF version.
+     */
+    version?: string;
+    /**
+     * The number of pages.
+     */
+    pageCount: number;
+    /**
+     * The file's size in bytes.
+     */
+    fileSize: number;
+    /**
+     * The file is linearized ("fast web view").
+     */
+    linearized: boolean;
+    /**
+     * The catalog says the document is tagged.
+     */
+    tagged: boolean;
+    /**
+     * How the file is encrypted; absent when it isn't.
+     */
+    encryption?: EncryptionJs;
+    /**
+     * The fonts the pages use.
+     */
+    fonts: FontJs[];
+    /**
+     * The signatures present, not verified.
+     */
+    signatures: number;
+    /**
+     * The signature fields' full names.
+     */
+    signatureFields: string[];
+    /**
+     * What the document holds besides its pages.
+     */
+    contains: ContainsJs;
+}
+
+/**
+ * A font's encoding: a named one (`WinAnsiEncoding`, `Identity-H`), or the font's own.
+ */
+export type EncodingJs = { kind: "named"; name: string } | { kind: "custom" };
+
+/**
+ * A header or footer: text at the start, centre and end, with `{page}`, `{pages}`, `{section}`
+ * and `{title}` filled in.
+ */
+export interface PageRegionInit {
+    /**
+     * At the start of the line.
+     */
+    start?: string;
+    /**
+     * Centred.
+     */
+    center?: string;
+    /**
+     * At the end of the line.
+     */
+    end?: string;
+}
+
 /**
  * A job's progress (`laminapdf::Step::Progress`).
  */
@@ -349,11 +467,55 @@ export interface SetInfo {
     at?: string;
 }
 
+/**
+ * How `markdown` lays a document out.
+ */
+export interface MarkdownOptionsInit {
+    /**
+     * The body text's size in points (10.5 by default); headings scale from it.
+     */
+    size?: number;
+    /**
+     * A contents page listing headings of levels 1 to `contents`, at the start.
+     */
+    contents?: number;
+    /**
+     * The pages (by default A4, 56-point margins, "Page {page} of {pages}" in the footer).
+     */
+    page?: PageTemplateInit;
+}
+
 /**
  * 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 file is encrypted, and what its author permits.
+ */
+export interface EncryptionJs {
+    /**
+     * `/V`.
+     */
+    version: number;
+    /**
+     * `/R`.
+     */
+    revision: number;
+    /**
+     * The key length in bits.
+     */
+    keyBits: number;
+    /**
+     * The cipher streams use.
+     */
+    cipher: CipherJs;
+    /**
+     * What `/P` permits; absent when the handler gives no permissions.
+     */
+    permissions?: PermissionsJs;
+}
+
 /**
  * How a run of text is drawn.
  */
@@ -518,6 +680,32 @@ export interface StructureNodeJs {
     kids: StructureKidJs[];
 }
 
+/**
+ * One font the document uses.
+ */
+export interface FontJs {
+    /**
+     * Its name without a subset tag.
+     */
+    name?: string;
+    /**
+     * `Type0`, `Type1`, `MMType1`, `Type3` or `TrueType`.
+     */
+    kind?: string;
+    /**
+     * The file holds the font.
+     */
+    embedded: boolean;
+    /**
+     * The file holds only the glyphs used.
+     */
+    subset: boolean;
+    /**
+     * Its encoding; absent when the font gives none.
+     */
+    encoding?: EncodingJs;
+}
+
 /**
  * One outline item and its children.
  */
@@ -905,6 +1093,11 @@ export interface DocumentInfoJs {
  */
 export type PdfVersionInit = "1.4" | "1.5" | "1.6" | "1.7" | "2.0";
 
+/**
+ * The cipher a file's streams use (ISO 32000-2 §7.6): the one list, which the `.d.ts` gets as a union.
+ */
+export type CipherJs = "rc4" | "aes-128" | "aes-256" | "identity" | "other";
+
 /**
  * The cross-reference form.
  */
@@ -978,6 +1171,32 @@ export interface ModelsInit {
     langs?: string[];
 }
 
+/**
+ * The pages a Markdown document flows through.
+ */
+export interface PageTemplateInit {
+    /**
+     * The page's width and height in points.
+     */
+    size: [number, number];
+    /**
+     * Top, right, bottom and left margins in points (72 each by default).
+     */
+    margins?: [number, number, number, number];
+    /**
+     * The header.
+     */
+    header?: PageRegionInit;
+    /**
+     * The footer.
+     */
+    footer?: PageRegionInit;
+    /**
+     * The size of the header and footer text, in the regular font (8 points by default).
+     */
+    furnitureSize?: number;
+}
+
 /**
  * The pages an edit touched.
  */
@@ -986,6 +1205,11 @@ export interface EditedJs {
      * IDs of the pages whose content or attributes changed.
      */
     touchedPages: string[];
+    /**
+     * Whether the edit changed the document: one that only set values they already had leaves
+     * no step to undo.
+     */
+    changed: boolean;
 }
 
 /**
@@ -1003,11 +1227,77 @@ export type SaveModeJs = "auto" | "incremental" | "fullRewrite";
  */
 export type ExtractFormat = "markdown" | "json" | "text" | "chunks";
 
+/**
+ * What `markdown` added.
+ */
+export interface MarkdownReportJs {
+    /**
+     * The pages it added, in order, by ID.
+     */
+    pages: string[];
+}
+
 /**
  * What `provide` takes.
  */
 export type ModelResultInit = { kind: "layout"; regions: RegionInit[] } | { kind: "ocr"; words: WordInit[] };
 
+/**
+ * What a document holds besides its pages.
+ */
+export interface ContainsJs {
+    /**
+     * Some action runs JavaScript.
+     */
+    javascript: boolean;
+    /**
+     * The number of embedded files.
+     */
+    attachments: number;
+    /**
+     * The document has a form with at least one field.
+     */
+    forms: boolean;
+}
+
+/**
+ * What a file's author permits: a request to readers, not a lock.
+ */
+export interface PermissionsJs {
+    /**
+     * Printing.
+     */
+    print: boolean;
+    /**
+     * Printing at full quality.
+     */
+    printHighQuality: boolean;
+    /**
+     * Changing the contents.
+     */
+    modify: boolean;
+    /**
+     * Copying text and graphics.
+     */
+    copy: boolean;
+    /**
+     * Adding or changing annotations.
+     */
+    annotate: boolean;
+    /**
+     * Filling form fields.
+     */
+    fillForms: boolean;
+    /**
+     * Extracting text for accessibility.
+     */
+    accessibility: boolean;
+    /**
+     * Inserting, rotating or deleting pages.
+     */
+    assemble: boolean;
+}
+
 /**
  * What a run measures.
  */
@@ -1067,6 +1357,25 @@ export interface SaveReportJs {
  */
 export type OutputJs = "whole" | "appendedOnly";
 
+/**
+ * What an undo or redo did (`laminapdf::Reverted`).
+ */
+export interface RevertedJs {
+    /**
+     * How it went.
+     */
+    outcome: UndoOutcomeJs;
+    /**
+     * IDs of the pages the undone or redone transaction touched: draw these again.
+     */
+    touchedPages: string[];
+}
+
+/**
+ * What following a link does, by `kind`.
+ */
+export type LinkToJs = { kind: "dest"; target?: TargetJs } | { kind: "named"; name: string; target?: TargetJs } | { kind: "uri"; uri: string } | { kind: "remote"; file?: string } | { kind: "named-action"; name: string } | { kind: "unsupported"; action: string };
+
 /**
  * What happens to hidden text and page furniture.
  */
@@ -1213,6 +1522,13 @@ export class WasmBuilder {
      * `builder-finished`; `invalid-font`, `font-not-embeddable`.
      */
     fontBytes(bytes: Uint8Array): WasmFont;
+    /**
+     * Loads face `index` (from 0) of a font collection (`.ttc`, `.otc`) and registers it.
+     *
+     * # Errors
+     * `builder-finished`; `invalid-font`, `collection-index` (no such face), `font-not-embeddable`.
+     */
+    fontCollection(bytes: Uint8Array, index: number): WasmFont;
     /**
      * The natural language (`/Lang`), a BCP 47 tag.
      *
@@ -1220,6 +1536,17 @@ export class WasmBuilder {
      * `builder-finished`.
      */
     lang(lang: string): void;
+    /**
+     * Lays `markdown` out as tagged pages that flow, after any pages already added; its front
+     * matter's title, language, author and subject become the document's. Its warnings
+     * (`markdown-html-ignored`, `markdown-image-missing`, the flow's) are the finished
+     * document's.
+     *
+     * # Errors
+     * `builder-finished`; `unknown-option`, `invalid-argument`; `missing-glyph`,
+     * `flow-content-too-large`; `unknown-font` at `finish` for a font another builder registered.
+     */
+    markdown(markdown: string, resources: WasmMarkdownOptions, options: MarkdownOptionsInit | undefined): MarkdownReportJs;
     /**
      * The metadata, written as the Info dictionary and an XMP packet.
      *
@@ -1322,6 +1649,10 @@ export class WasmDocument {
      * Reading errors.
      */
     info(): DocumentInfoJs;
+    /**
+     * Whether the file is encrypted (it opened with its password, or the empty one).
+     */
+    isEncrypted(): boolean;
     /**
      * Whether the document says it is tagged (`/MarkInfo /Marked true`; the extract and text modules).
      *
@@ -1390,6 +1721,13 @@ export class WasmDocument {
      * Reading errors.
      */
     pageInfos(): PageInfoJs[];
+    /**
+     * The visible links on page `index`, in annotation order (the extract and text modules).
+     *
+     * # Errors
+     * `page-index-out-of-range`, `data-pending` and the reading errors.
+     */
+    pageLinks(index: number): PageLinkJs[];
     /**
      * A handle on page `index` that follows the page by its ID (F2).
      *
@@ -1397,6 +1735,13 @@ export class WasmDocument {
      * `page-index-out-of-range`; reading errors.
      */
     page(index: number): WasmPage;
+    /**
+     * The document's properties (the extract and text modules). Reads every object once.
+     *
+     * # Errors
+     * `data-pending` and the reading errors.
+     */
+    properties(): PropertiesJs;
     /**
      * Rebases onto `bytes`, the output of a save whose rebase failed (`not-rebased`).
      *
@@ -1405,12 +1750,13 @@ export class WasmDocument {
      */
     rebase(bytes: Uint8Array): void;
     /**
-     * Redoes the newest undone transaction; `undefined` when there is nothing to redo.
+     * Redoes the newest undone transaction: how it went and the pages it touched; `undefined`
+     * when there is nothing to redo.
      *
      * # Errors
      * As [`WasmDocument::undo`].
      */
-    redo(): UndoOutcomeJs | undefined;
+    redo(): RevertedJs | undefined;
     /**
      * A save as a job, stepped with a budget of work units (ADR 0028 §3, §4).
      *
@@ -1434,12 +1780,13 @@ export class WasmDocument {
      */
     structureTree(): StructureNodeJs[] | undefined;
     /**
-     * Undoes the newest transaction; `undefined` when there is nothing to undo.
+     * Undoes the newest transaction: how it went and the pages it touched; `undefined` when
+     * there is nothing to undo.
      *
      * # Errors
      * `nested-transaction`, `saved-not-rebased`; reading errors.
      */
-    undo(): UndoOutcomeJs | undefined;
+    undo(): RevertedJs | undefined;
     /**
      * A cursor over the warnings so far (build warnings first), each as the §1 object.
      */
@@ -1537,6 +1884,30 @@ export class WasmImage {
     readonly width: number;
 }
 
+/**
+ * The fonts and images of a Markdown build, by role and by the target the Markdown names.
+ */
+export class WasmMarkdownOptions {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * `font` for `role`: `regular`, `bold` (headings too), `italic`, `boldItalic`, `mono`, or
+     * `fallback` (each call adds one) for characters the others lack.
+     *
+     * # Errors
+     * `invalid-argument` for another role.
+     */
+    font(role: string, font: WasmFont): void;
+    /**
+     * `image` for the images whose target is `target`, as the Markdown writes it.
+     */
+    image(target: string, image: WasmImage): void;
+    /**
+     * No fonts (the standard 14 Helvetica family and Courier) and no images.
+     */
+    constructor();
+}
+
 /**
  * A page of a [`WasmDocument`], held by its ID (F2): moving pages doesn't retarget it.
  */
@@ -1874,6 +2245,7 @@ export interface InitOutput {
     readonly __wbg_wasmextractjob_free: (a: number, b: number) => void;
     readonly __wbg_wasmfont_free: (a: number, b: number) => void;
     readonly __wbg_wasmimage_free: (a: number, b: number) => void;
+    readonly __wbg_wasmmarkdownoptions_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;
@@ -1886,7 +2258,9 @@ export interface InitOutput {
     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_fontBytes: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmbuilder_fontCollection: (a: number, b: number, c: number, d: number) => [number, number, number];
     readonly wasmbuilder_lang: (a: number, b: number, c: number) => [number, number];
+    readonly wasmbuilder_markdown: (a: number, b: number, c: number, d: number, e: any) => [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];
@@ -1900,6 +2274,7 @@ export interface InitOutput {
     readonly wasmdocument_extractJob: (a: number, b: any) => [number, number, number];
     readonly wasmdocument_hasUnsavedChanges: (a: number) => number;
     readonly wasmdocument_info: (a: number) => [number, number, number];
+    readonly wasmdocument_isEncrypted: (a: number) => number;
     readonly wasmdocument_isTagged: (a: number) => [number, number, number];
     readonly wasmdocument_namedDestination: (a: number, b: number, c: number) => [number, number, number];
     readonly wasmdocument_openBytes: (a: number, b: number, c: any) => [number, number, number];
@@ -1910,6 +2285,8 @@ export interface InitOutput {
     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_pageLinks: (a: number, b: number) => [number, number, number];
+    readonly wasmdocument_properties: (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];
@@ -1928,6 +2305,9 @@ export interface InitOutput {
     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 wasmmarkdownoptions_font: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly wasmmarkdownoptions_image: (a: number, b: number, c: number, d: number) => void;
+    readonly wasmmarkdownoptions_new: () => number;
     readonly wasmpage_id: (a: number) => [number, number];
     readonly wasmpage_index: (a: number) => [number, number, number];
     readonly wasmpage_info: (a: number) => [number, number, number];