pdf-oxide-wasm 0.3.38 → 0.3.40

package/bundler/pdf_oxide.d.ts

@@ -1,6 +1,26 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * Horizontal-alignment enum shared by `textInRect`, buffered `table`, and
+ * `streamingTable`. Maps 1:1 onto [`crate::writer::TextAlign`] /
+ * [`crate::writer::CellAlign`]. Exported to JS as `Align` via `js_name`.
+ */
+export enum Align {
+    /**
+     * Align to the left edge.
+     */
+    Left = 0,
+    /**
+     * Center horizontally.
+     */
+    Center = 1,
+    /**
+     * Align to the right edge.
+     */
+    Right = 2,
+}
+
 /**
  * Style configuration for header/footer text.
  */
@@ -25,6 +45,59 @@ export class ArtifactStyle {
     constructor();
 }
 
+/**
+ * WASM handle to a streaming-table building session. Created by
+ * `FluentPageBuilder.streamingTable()`; rows are pushed via `pushRow`,
+ * and the session is sealed with `finish()`.
+ *
+ * Single-use: `finish()` twice throws, and `pushRow` after `finish()`
+ * throws. The rows are buffered and replayed against the real Rust
+ * `StreamingTable` at `WasmFluentPageBuilder.done()` commit time —
+ * preserving the FluentPageBuilder borrow-lifetime invariant that can't
+ * cross the wasm-bindgen boundary.
+ */
+export class StreamingTable {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Number of fully-completed batches waiting for finish().
+     */
+    batchCount(): number;
+    /**
+     * Number of columns configured on this streaming table.
+     */
+    columnCount(): number;
+    /**
+     * Seal the streaming table — the buffered rows are flushed onto the
+     * parent page's op queue, to be replayed against the real Rust
+     * `StreamingTable` at `done()` commit time. Calling `finish()` twice
+     * throws.
+     */
+    finish(): void;
+    /**
+     * Explicitly flush the current batch to `completed_batches`.
+     * Called automatically when `batch_size` rows accumulate.
+     */
+    flush(): void;
+    /**
+     * Number of rows in the current (not-yet-flushed) batch.
+     */
+    pendingRowCount(): number;
+    /**
+     * Push one row as an array of cell strings (all rowspan=1). Returns an
+     * error if the table has already been finished or if the row's cell count
+     * does not match the column count. Auto-flushes the batch when full.
+     */
+    pushRow(cells: string[]): void;
+    /**
+     * Push one row with per-cell rowspan values. `cells` is a JS array of
+     * `[text, rowspan]` two-element arrays. `rowspan == 1` is a normal cell.
+     * Auto-flushes the batch when full.
+     */
+    pushRowSpan(cells: any): void;
+}
+
 /**
  * A header or footer artifact definition.
  */
@@ -71,6 +144,17 @@ export class WasmCertificate {
      * the DER doesn't parse.
      */
     static load(data: Uint8Array): WasmCertificate;
+    /**
+     * Load a signer certificate + private key from PEM strings.
+     * `certPem` must begin `-----BEGIN CERTIFICATE-----`.
+     * `keyPem` must begin `-----BEGIN PRIVATE KEY-----` or `-----BEGIN RSA PRIVATE KEY-----`.
+     */
+    static loadPem(cert_pem: string, key_pem: string): WasmCertificate;
+    /**
+     * Load a signer certificate + private key from a PKCS#12 (.p12/.pfx) blob.
+     * `password` is the passphrase protecting the key bag.
+     */
+    static loadPkcs12(data: Uint8Array, password: string): WasmCertificate;
     /**
      * Whether the certificate is currently within its validity
      * window. Does NOT verify chain, trust-root, or revocation.
@@ -141,6 +225,12 @@ export class WasmDocumentBuilder {
      * Set document keywords (comma-separated per PDF convention).
      */
     keywords(keywords: string): void;
+    /**
+     * Set the document's natural language tag (e.g. `"en-US"`).
+     *
+     * Emitted as `/Lang` in the catalog when `taggedPdfUa1()` is set.
+     */
+    language(lang: string): void;
     /**
      * Start a new US Letter page.
      */
@@ -151,6 +241,10 @@ export class WasmDocumentBuilder {
      * chains off the instance returned here.
      */
     constructor();
+    /**
+     * Run a JavaScript script when the document is opened (`/OpenAction`).
+     */
+    onOpen(script: string): void;
     /**
      * Start a new page with custom dimensions in PDF points
      * (72 pt = 1 inch).
@@ -161,10 +255,24 @@ export class WasmDocumentBuilder {
      * **Consumes** `font` — reusing the `WasmEmbeddedFont` throws.
      */
     registerEmbeddedFont(name: string, font: WasmEmbeddedFont): void;
+    /**
+     * Add a role-map entry: custom structure type → standard PDF structure type.
+     *
+     * Emitted in `/RoleMap` inside the StructTreeRoot when `taggedPdfUa1()`
+     * is set. Multiple calls accumulate entries.
+     */
+    roleMap(custom: string, standard: string): void;
     /**
      * Set document subject.
      */
     subject(subject: string): void;
+    /**
+     * Enable PDF/UA-1 tagged PDF mode.
+     *
+     * When enabled, `build()` emits `/MarkInfo`, `/StructTreeRoot`, `/Lang`,
+     * and `/ViewerPreferences` in the catalog. Opt-in — no effect unless called.
+     */
+    taggedPdfUa1(): void;
     /**
      * Set document title.
      */
@@ -207,7 +315,22 @@ export class WasmFluentPageBuilder {
     free(): void;
     [Symbol.dispose](): void;
     at(x: number, y: number): void;
+    /**
+     * Place a 1-D barcode image at `(x, y, w, h)` on the page.
+     * `barcodeType`: 0=Code128 1=Code39 2=EAN13 3=EAN8 4=UPCA 5=ITF
+     * 6=Code93 7=Codabar.
+     */
+    barcode1d(barcode_type: number, data: string, x: number, y: number, w: number, h: number): void;
+    /**
+     * Place a QR-code image at `(x, y, size, size)` on the page.
+     */
+    barcodeQr(data: string, x: number, y: number, size: number): void;
     checkbox(name: string, x: number, y: number, w: number, h: number, checked: boolean): void;
+    /**
+     * Lay out `text` as balanced multi-column flow (`columnCount` columns,
+     * `gapPt` points between columns). Paragraphs in `text` are separated by `"\n\n"`.
+     */
+    columns(column_count: number, gap_pt: number, text: string): void;
     /**
      * Add a dropdown combo-box.
      */
@@ -224,22 +347,77 @@ export class WasmFluentPageBuilder {
      * ```
      */
     done(builder: WasmDocumentBuilder): void;
+    fieldCalculate(script: string): void;
+    fieldFormat(script: string): void;
+    fieldKeystroke(script: string): void;
+    fieldValidate(script: string): void;
     /**
      * Draw a filled rectangle. RGB channels in 0.0-1.0.
      */
     filledRect(x: number, y: number, w: number, h: number, r: number, g: number, b: number): void;
     font(name: string, size: number): void;
+    /**
+     * Add a footnote: inline `refMark` at the cursor and `noteText` body
+     * near the page bottom with a separator artifact line.
+     */
+    footnote(ref_mark: string, note_text: string): void;
     freeText(x: number, y: number, w: number, h: number, text: string): void;
     heading(level: number, text: string): void;
     highlight(r: number, g: number, b: number): void;
     horizontalRule(): void;
+    /**
+     * Embed a decorative image (JPEG/PNG/WebP bytes) as an /Artifact (no alt text).
+     */
+    imageArtifact(bytes: Uint8Array, x: number, y: number, w: number, h: number): void;
+    /**
+     * Embed an image (JPEG/PNG/WebP bytes) with an accessibility alt text.
+     */
+    imageWithAlt(bytes: Uint8Array, x: number, y: number, w: number, h: number, alt_text: string): void;
+    /**
+     * Emit `text` inline (advances cursorX only, not cursorY).
+     */
+    inline(text: string): void;
+    /**
+     * Inline bold run.
+     */
+    inlineBold(text: string): void;
+    /**
+     * Inline colored run (RGB 0.0–1.0).
+     */
+    inlineColor(r: number, g: number, b: number, text: string): void;
+    /**
+     * Inline italic run.
+     */
+    inlineItalic(text: string): void;
     /**
      * Draw a line from (x1, y1) to (x2, y2) with 1pt black stroke.
      */
     line(x1: number, y1: number, x2: number, y2: number): void;
+    linkJavascript(script: string): void;
     linkNamed(destination: string): void;
     linkPage(page: number): void;
     linkUrl(url: string): void;
+    /**
+     * Measure the rendered width of `text` in the builder's current font
+     * and size, in PDF points. Pure query — does not mutate state.
+     *
+     * Thin JS view over [`crate::writer::FluentPageBuilder::measure`]. The
+     * WASM class tracks the current font/size independently of the
+     * buffered ops so this query is served without a live builder.
+     */
+    measure(text: string): number;
+    /**
+     * Finish the current page and start a new one with the same page
+     * size. Cursor resets to the top-left margin (72, height-72). The
+     * builder's font carries over.
+     */
+    newPageSameSize(): void;
+    /**
+     * Advance cursorY by one line-height and reset cursorX to 72 pt.
+     */
+    newline(): void;
+    onClose(script: string): void;
+    onOpen(script: string): void;
     paragraph(text: string): void;
     /**
      * Add a clickable push button with a visible caption.
@@ -255,14 +433,75 @@ export class WasmFluentPageBuilder {
      * Draw a stroked rectangle outline (1pt black).
      */
     rect(x: number, y: number, w: number, h: number): void;
+    /**
+     * Points remaining on the current page below the cursor (down to the
+     * 72 pt bottom margin). Mirrors
+     * [`crate::writer::FluentPageBuilder::remaining_space`] using the WASM
+     * class's independently-tracked cursor — accurate after `at`, `text`,
+     * `space`, `newPageSameSize`, `textInRect` and the table helpers.
+     */
+    remainingSpace(): number;
+    /**
+     * Add an unsigned signature placeholder field at the given bounds.
+     */
+    signatureField(name: string, x: number, y: number, w: number, h: number): void;
     space(points: number): void;
     squiggly(r: number, g: number, b: number): void;
     stamp(name: string): void;
     stickyNote(text: string): void;
     stickyNoteAt(x: number, y: number, text: string): void;
+    /**
+     * Open a streaming table. Returns a `StreamingTable` handle the caller
+     * pushes rows into; call `finish()` when done. The streamed rows are
+     * buffered per-table and replayed against the real Rust
+     * `StreamingTable` at `done()` commit time — avoiding the
+     * FluentPageBuilder-lifetime problem that otherwise can't cross the
+     * wasm-bindgen boundary.
+     */
+    streamingTable(spec: any): StreamingTable;
     strikeout(r: number, g: number, b: number): void;
+    /**
+     * Draw a straight line with explicit stroke width and RGB colour.
+     */
+    strokeLine(x1: number, y1: number, x2: number, y2: number, width: number, r: number, g: number, b: number): void;
+    /**
+     * Draw a dashed line. `dash` is alternating on/off lengths in points; `phase` is the starting offset.
+     */
+    strokeLineDashed(x1: number, y1: number, x2: number, y2: number, width: number, r: number, g: number, b: number, dash: Float32Array, phase: number): void;
+    /**
+     * Draw a stroked rectangle with explicit stroke width and RGB colour.
+     */
+    strokeRect(x: number, y: number, w: number, h: number, width: number, r: number, g: number, b: number): void;
+    /**
+     * Draw a dashed rectangle border. `dash` is alternating on/off lengths in points; `phase` is the starting offset.
+     */
+    strokeRectDashed(x: number, y: number, w: number, h: number, width: number, r: number, g: number, b: number, dash: Float32Array, phase: number): void;
+    /**
+     * Render a buffered table from a JS object:
+     *
+     * ```javascript
+     * page.table({
+     *   columns: [
+     *     { header: "SKU", width: 100, align: Align.Left },
+     *     { header: "Qty", width: 60,  align: Align.Right },
+     *   ],
+     *   rows: [["A-1","12"], ["B-2","3"]],
+     *   hasHeader: true,
+     * });
+     * ```
+     *
+     * Uses `serde-wasm-bindgen` for deserialisation. Replays against the
+     * Rust `Table` builder at `done()` commit time.
+     */
+    table(spec: any): void;
     text(text: string): void;
     textField(name: string, x: number, y: number, w: number, h: number, default_value?: string | null): void;
+    /**
+     * Place wrapped text inside a rectangle with horizontal alignment.
+     * `align` is the `Align` enum (0 = Left, 1 = Center, 2 = Right) — also
+     * accepts a raw integer for JS callers that pre-date the enum import.
+     */
+    textInRect(x: number, y: number, w: number, h: number, text: string, align: number): void;
     underline(r: number, g: number, b: number): void;
     watermark(text: string): void;
     watermarkConfidential(): void;
@@ -682,6 +921,21 @@ export class WasmPdfDocument {
      * Flatten annotations on a page into the page content.
      */
     flattenPageAnnotations(page_index: number): void;
+    /**
+     * Create a flattened PDF where each page is rendered as an image.
+     * Burns in all annotations, form fields, and overlays.
+     * Returns the flattened PDF as bytes.
+     */
+    flattenToImages(dpi?: number | null): Uint8Array;
+    /**
+     * Return warnings collected during the last form-flattening save.
+     *
+     * Each entry names a widget field that had no `/AP` appearance stream;
+     * flattening such a field produces a blank rectangle.
+     *
+     * @returns Array of warning strings
+     */
+    flattenWarnings(): string[];
     /**
      * Get annotations from a page.
      *
@@ -805,6 +1059,16 @@ export class WasmPdfDocument {
      * @param threshold - Fraction of pages (0.0-1.0) where text must repeat (heuristic mode)
      */
     removeHeaders(threshold: number): number;
+    /**
+     * Render a page to an image (PNG).
+     *
+     * Requires the `rendering` feature.
+     *
+     * @param page_index - Zero-based page number
+     * @param dpi - Dots per inch (default: 150)
+     * @returns Uint8Array containing the PNG image data
+     */
+    renderPage(page_index: number, dpi?: number | null): Uint8Array;
     /**
      * Reposition an image on a page.
      */
@@ -838,6 +1102,16 @@ export class WasmPdfDocument {
      * @returns Uint8Array containing the modified PDF
      */
     saveToBytes(): Uint8Array;
+    /**
+     * Save with options (compress, garbage_collect, linearize) and return bytes.
+     *
+     * @param {Object} [options] - Optional save options.
+     * @param {boolean} [options.compress=true] - Compress raw streams with FlateDecode.
+     * @param {boolean} [options.garbageCollect=true] - Remove unreachable objects.
+     * @param {boolean} [options.linearize=false] - Linearize (reserved, no-op).
+     * @returns Uint8Array containing the modified PDF
+     */
+    saveWithOptions(compress?: boolean | null, garbage_collect?: boolean | null, linearize?: boolean | null): Uint8Array;
     /**
      * Search for text across all pages.
      *
@@ -1018,10 +1292,9 @@ export class WasmPdfPageRegion {
 
 /**
  * A single existing PDF signature surfaced by
- * `WasmPdfDocument.signatures()`. `verify()` runs the RSA-PKCS#1 v1.5
- * signer-attributes check; `verifyDetached()` adds the
- * `messageDigest` content-hash check. RSA-PSS / ECDSA signers still
- * throw an `UnsupportedFeature`-mapped JS error.
+ * `WasmPdfDocument.signatures()`. `verify()` runs the signer-attributes
+ * check; `verifyDetached()` adds the `messageDigest` content-hash check.
+ * Supported: RSA-PKCS#1 v1.5, RSA-PSS, ECDSA P-256/P-384.
  */
 export class WasmSignature {
     private constructor();
@@ -1099,7 +1372,11 @@ export class WasmTimestamp {
      */
     static parse(data: Uint8Array): WasmTimestamp;
     /**
-     * Cryptographic verify — not yet implemented.
+     * Cryptographically verify this TimeStampToken.
+     *
+     * Returns `true` when the TSA's signature and `messageDigest` both pass.
+     * Returns `false` when a crypto check fails (tampered token or wrong key).
+     * Throws when the token is not CMS-wrapped or uses an unsupported algorithm.
      */
     verify(): boolean;
     /**
@@ -1153,3 +1430,11 @@ export function disableLogging(): void;
  * ```
  */
 export function setLogLevel(level: string): void;
+
+/**
+ * Sign raw PDF bytes and return the signed PDF as a `Uint8Array`.
+ *
+ * `cert` must carry a private key (loaded via `Certificate.loadPem` or
+ * `Certificate.loadPkcs12`).
+ */
+export function signPdfBytes(pdf_data: Uint8Array, cert: WasmCertificate, reason?: string | null, location?: string | null): Uint8Array;

package/bundler/pdf_oxide.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./pdf_oxide_bg.js";
 __wbg_set_wasm(wasm);
 
 export {
-    ArtifactStyle, WasmArtifact, WasmCertificate, WasmDocumentBuilder, WasmEmbeddedFont, WasmFluentPageBuilder, WasmFooter, WasmHeader, WasmOcrConfig, WasmOcrEngine, WasmPageTemplate, WasmPdf, WasmPdfDocument, WasmPdfPageRegion, WasmSignature, WasmTimestamp, disableLogging, setLogLevel
+    Align, ArtifactStyle, StreamingTable, WasmArtifact, WasmCertificate, WasmDocumentBuilder, WasmEmbeddedFont, WasmFluentPageBuilder, WasmFooter, WasmHeader, WasmOcrConfig, WasmOcrEngine, WasmPageTemplate, WasmPdf, WasmPdfDocument, WasmPdfPageRegion, WasmSignature, WasmTimestamp, disableLogging, setLogLevel, signPdfBytes
 } from "./pdf_oxide_bg.js";