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

package/dist/lamina_pdf_base.d.ts

@@ -490,6 +490,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;
 }
 
 /**
@@ -537,6 +542,20 @@ 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[];
+}
+
 /**
  * Where a link or outline item goes.
  */
@@ -722,6 +741,10 @@ export class WasmDocument {
      * Reading errors.
      */
     info(): DocumentInfoJs;
+    /**
+     * Whether the file is encrypted (it opened with its password, or the empty one).
+     */
+    isEncrypted(): boolean;
     /**
      * Opens a document from its bytes.
      *
@@ -782,12 +805,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).
      *
@@ -803,12 +827,13 @@ export class WasmDocument {
      */
     save(options: SaveOptionsInit | undefined): { bytes: Uint8Array<ArrayBuffer>; report: SaveReportJs };
     /**
-     * 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.
      */
@@ -1184,6 +1209,7 @@ export interface InitOutput {
     readonly wasmdocument_applyLog: (a: number, b: number, c: number) => [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_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];

package/dist/lamina_pdf_base.js

@@ -264,6 +264,15 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * Whether the file is encrypted (it opened with its password, or the empty one).
+     * @returns {boolean}
+     */
+    isEncrypted() {
+        let ret;
+        ret = wasm.wasmdocument_isEncrypted(this.__wbg_ptr);
+        return ret !== 0;
+    }
     /**
      * Opens a document from its bytes.
      *
@@ -401,11 +410,12 @@ export class WasmDocument {
         }
     }
     /**
-     * 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`].
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     redo() {
         let ret;
@@ -448,11 +458,12 @@ export class WasmDocument {
         return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * 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.
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     undo() {
         let ret;

package/dist/lamina_pdf_extract.d.ts

@@ -32,11 +32,110 @@ 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 conformance profile.
  */
 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 job's progress (`laminapdf::Step::Progress`).
  */
@@ -308,6 +407,32 @@ export interface SetInfo {
  */
 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 target shows its page, in page space; an unset coordinate is left out.
  */
@@ -395,6 +520,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.
  */
@@ -742,6 +893,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.
  */
@@ -823,6 +979,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;
 }
 
 /**
@@ -845,6 +1006,62 @@ export type ExtractFormat = "markdown" | "json" | "text" | "chunks";
  */
 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 save wrote (`laminapdf::SaveReport`).
  */
@@ -880,6 +1097,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.
  */
@@ -1114,6 +1350,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).
      *
@@ -1182,6 +1422,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).
      *
@@ -1189,6 +1436,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`).
      *
@@ -1197,12 +1451,22 @@ 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;
+    /**
+     * The document for reader mode, as JSON: whether it can be shown and why not, its
+     * language, its blocks in the structure tree's order (figures, formulas and tables as crops
+     * with their alternate text) and the checks' measures (the extract module only).
+     *
+     * # Errors
+     * `data-pending` and the reading errors.
+     */
+    reflow(): string;
     /**
      * A save as a job, stepped with a budget of work units (ADR 0028 §3, §4).
      *
@@ -1226,12 +1490,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.
      */
@@ -1651,6 +1916,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];
@@ -1661,8 +1927,11 @@ 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_reflow: (a: number) => [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_structureTree: (a: number) => [number, number, number];

package/dist/lamina_pdf_extract.js

@@ -312,6 +312,15 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * Whether the file is encrypted (it opened with its password, or the empty one).
+     * @returns {boolean}
+     */
+    isEncrypted() {
+        let ret;
+        ret = wasm.wasmdocument_isEncrypted(this.__wbg_ptr);
+        return ret !== 0;
+    }
     /**
      * Whether the document says it is tagged (`/MarkInfo /Marked true`; the extract and text modules).
      *
@@ -466,6 +475,22 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * 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.
+     * @param {number} index
+     * @returns {PageLinkJs[]}
+     */
+    pageLinks(index) {
+        let ret;
+        ret = wasm.wasmdocument_pageLinks(this.__wbg_ptr, index);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * A handle on page `index` that follows the page by its ID (F2).
      *
@@ -482,6 +507,21 @@ export class WasmDocument {
         }
         return WasmPage.__wrap(ret[0]);
     }
+    /**
+     * The document's properties (the extract and text modules). Reads every object once.
+     *
+     * # Errors
+     * `data-pending` and the reading errors.
+     * @returns {PropertiesJs}
+     */
+    properties() {
+        let ret;
+        ret = wasm.wasmdocument_properties(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * Rebases onto `bytes`, the output of a save whose rebase failed (`not-rebased`).
      *
@@ -499,11 +539,12 @@ export class WasmDocument {
         }
     }
     /**
-     * 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`].
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     redo() {
         let ret;
@@ -513,6 +554,34 @@ export class WasmDocument {
         }
         return takeFromExternrefTable0(ret[0]);
     }
+    /**
+     * The document for reader mode, as JSON: whether it can be shown and why not, its
+     * language, its blocks in the structure tree's order (figures, formulas and tables as crops
+     * with their alternate text) and the checks' measures (the extract module only).
+     *
+     * # Errors
+     * `data-pending` and the reading errors.
+     * @returns {string}
+     */
+    reflow() {
+        let deferred2_0;
+        let deferred2_1;
+        try {
+            let ret;
+            ret = wasm.wasmdocument_reflow(this.__wbg_ptr);
+            var ptr1 = ret[0];
+            var len1 = ret[1];
+            if (ret[3]) {
+                ptr1 = 0; len1 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred2_0 = ptr1;
+            deferred2_1 = len1;
+            return getStringFromWasm0(ptr1, len1);
+        } finally {
+            wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+        }
+    }
     /**
      * A save as a job, stepped with a budget of work units (ADR 0028 §3, §4).
      *
@@ -562,11 +631,12 @@ export class WasmDocument {
         return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * 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.
-     * @returns {UndoOutcomeJs | undefined}
+     * @returns {RevertedJs | undefined}
      */
     undo() {
         let ret;

package/dist/lamina_pdf_render_hayro.d.ts

@@ -35,12 +35,15 @@ export class HayroDocument {
      */
     plan(page: number, scale: number, x: number, y: number, width: number, height: number, rotation: number, flags: number, background?: number | null): Uint32Array;
     /**
-     * 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.
      */
-    render(page: number, scale: number, x: number, y: number, width: number, height: number, rotation: number, flags: number, background: number | null | undefined, out: Uint8Array): void;
+    render(page: number, scale: number, x: number, y: number, width: number, height: number, rotation: number, flags: number, background: number | null | undefined, appearance: number, ink: number, paper: number, out: Uint8Array): void;
 }
 
 /**
@@ -78,7 +81,7 @@ export interface InitOutput {
     readonly hayrodocument_page: (a: number, b: number) => [number, number, number, number];
     readonly hayrodocument_pageCount: (a: number) => number;
     readonly hayrodocument_plan: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number, number, number];
-    readonly hayrodocument_render: (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: any) => [number, number];
+    readonly hayrodocument_render: (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, p: any) => [number, number];
     readonly inputbuffer_new: (a: number) => [number, number, number];
     readonly inputbuffer_write: (a: number, b: number, c: number, d: number) => [number, number];
     readonly __wbindgen_exn_store: (a: number) => void;