@pdfluent/sdk-wasm 1.0.0-beta.10

package/xfa_wasm.d.ts

@@ -0,0 +1,526 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Chroma subsampling format
+ */
+export enum ChromaSampling {
+    /**
+     * Both vertically and horizontally subsampled.
+     */
+    Cs420 = 0,
+    /**
+     * Horizontally subsampled.
+     */
+    Cs422 = 1,
+    /**
+     * Not subsampled.
+     */
+    Cs444 = 2,
+    /**
+     * Monochrome.
+     */
+    Cs400 = 3,
+}
+
+/**
+ * Status of the currently-active license.
+ */
+export class LicenseStatus {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Whether output is marked via `/Producer` metadata (Trial tier).
+     */
+    readonly outputIsMarked: boolean;
+    /**
+     * Source: `"Default" | "EnvVar" | "Explicit"`.
+     */
+    readonly source: string;
+    /**
+     * Tier name: `"Trial" | "Developer" | "Team" | "Business" | "Enterprise"`.
+     */
+    readonly tier: string;
+}
+
+/**
+ * PDF document handle for analysis and text extraction.
+ *
+ * Uses `pdf-syntax` for metadata/geometry/signatures/compliance and
+ * `pdf-engine` for text extraction so the WASM path matches native decoding.
+ */
+export class PdfDoc {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Add a free-text (callout-style) annotation at the given page rectangle.
+     */
+    addFreeText(page_index: number, x: number, y: number, w: number, h: number, contents: string): Uint8Array;
+    /**
+     * Add a highlight annotation over the given page rectangle.
+     * Rectangle in PDF user-space coordinates (origin bottom-left).
+     * Optional `color_hex` like `"#ffeb3b"`; default yellow if `None`.
+     */
+    addHighlight(page_index: number, x: number, y: number, w: number, h: number, color_hex?: string | null): Uint8Array;
+    /**
+     * Add a sticky-note (text) annotation at the given page position.
+     */
+    addStickyNote(page_index: number, x: number, y: number, contents: string): Uint8Array;
+    /**
+     * Apply a diagonal text watermark to every page.
+     * `opacity` in 0.0..=1.0. Default rotation 45 deg, default colour gray.
+     */
+    addTextWatermark(text: string, opacity: number): Uint8Array;
+    /**
+     * Re-encode all content streams with deflate compression. Removes
+     * no-op overhead. Returns the optimised PDF as a `Uint8Array`.
+     */
+    compress(): Uint8Array;
+    /**
+     * Convert this PDF to PDF/A-1b, PDF/A-2b, or PDF/A-3b.
+     *
+     * `level` must be "1b", "2b", or "3b".
+     * Returns the converted PDF as a `Uint8Array`.
+     */
+    convertToPdfa(level: string): Uint8Array;
+    /**
+     * Delete the listed pages (0-based) from the document.
+     */
+    deletePages(pages: Uint32Array): Uint8Array;
+    /**
+     * DSS (Document Security Store) info as JSON, or null if absent.
+     */
+    dssInfo(): string | undefined;
+    /**
+     * Extract the listed pages (0-based) into a new document.
+     * Used to implement "split" workflows in the browser.
+     */
+    extractPages(pages: Uint32Array): Uint8Array;
+    /**
+     * Flatten XFA form fields into static PDF content.
+     *
+     * Returns the flattened PDF as a `Uint8Array`.
+     * Throws if the document has no XFA stream or flattening fails.
+     */
+    flattenXfa(): Uint8Array;
+    /**
+     * Parse existing annotations on a page as JSON.
+     *
+     * Returns a JSON array of annotation objects.
+     */
+    getAnnotations(page_index: number): string;
+    /**
+     * Text-run positions for a page.
+     *
+     * Returns a JSON array of `{text, x, y, width, height, fontSize}`
+     * objects in page space with origin at the top-left.  Each entry is a
+     * contiguous text run emitted by the same PDF interpreter that drives the
+     * renderer, which keeps the selection overlay aligned with the canvas.
+     *
+     * ```js
+     * const runs = JSON.parse(doc.getTextPositions(0));
+     * // runs[i] = { text: "Hello world", x: 72.0, y: 100.0, width: 96.0, height: 12.0, fontSize: 12.0 }
+     * ```
+     */
+    getTextPositions(page_index: number): string;
+    /**
+     * Check if the document has any signatures.
+     */
+    hasSignatures(): boolean;
+    /**
+     * Merge another PDF document into this one.
+     *
+     * Returns the merged PDF as a `Uint8Array`.
+     */
+    merge(other: Uint8Array): Uint8Array;
+    /**
+     * Document metadata as JSON.
+     */
+    metadata(): string;
+    /**
+     * Open a PDF from raw bytes.
+     */
+    static open(data: Uint8Array): PdfDoc;
+    /**
+     * Number of pages.
+     */
+    pageCount(): number;
+    /**
+     * Get page height in PDF points.
+     */
+    pageHeight(page_index: number): number;
+    /**
+     * Get page width in PDF points.
+     */
+    pageWidth(page_index: number): number;
+    /**
+     * Permanently remove content within the given page rectangle.
+     * Coordinates in PDF user-space (origin bottom-left).
+     */
+    redactRegion(page_index: number, x: number, y: number, w: number, h: number): Uint8Array;
+    /**
+     * Search-and-redact: every match of `query` (literal text, case-sensitive)
+     * is permanently removed from every page.
+     */
+    redactSearch(query: string): Uint8Array;
+    /**
+     * Render a page to RGBA pixels.
+     *
+     * Returns a Uint8Array with layout: `[width:4LE][height:4LE][RGBA pixels...]`.
+     * Use with Canvas ImageData:
+     * ```js
+     * const raw = doc.renderPage(0, 1.5);
+     * const view = new DataView(raw.buffer);
+     * const w = view.getUint32(0, true);
+     * const h = view.getUint32(4, true);
+     * const pixels = raw.slice(8);
+     * const imageData = new ImageData(new Uint8ClampedArray(pixels), w, h);
+     * ctx.putImageData(imageData, 0, 0);
+     * ```
+     */
+    renderPage(page_index: number, scale: number): Uint8Array;
+    /**
+     * Render a page directly to an HTML canvas element (wasm32 only).
+     *
+     * Calls `canvas.getContext("2d")`, sets the canvas dimensions to the
+     * rendered pixel size, and calls `putImageData` — no round-trip through
+     * a JS Uint8Array.  XFA documents are auto-flattened before rendering.
+     *
+     * ```js
+     * const canvas = document.getElementById('viewer');
+     * await doc.renderPageToCanvas(canvas, 0, 1.5);  // page 0, 108 DPI
+     * ```
+     */
+    renderPageToCanvas(canvas: HTMLCanvasElement, page_index: number, scale: number): void;
+    /**
+     * Render a page using Canvas2D vector draw calls.
+     *
+     * Falls back to the raster renderer if the vector device hits an
+     * unsupported PDF feature.
+     */
+    renderPageToCanvasVector(canvas: HTMLCanvasElement, page_index: number, scale: number): void;
+    /**
+     * Render a thumbnail constrained to a maximum dimension.
+     *
+     * Same return format as `renderPage`.
+     */
+    renderThumbnail(page_index: number, max_dimension: number): Uint8Array;
+    /**
+     * Re-order pages. `new_order` is a permutation of 0..pageCount.
+     */
+    reorderPages(new_order: Uint32Array): Uint8Array;
+    /**
+     * Rotate a single page by 90, 180, or 270 degrees (clockwise).
+     * `degrees` may be negative; values are normalised modulo 360.
+     */
+    rotatePage(page_index: number, degrees: number): Uint8Array;
+    /**
+     * Set a single AcroForm text-field value. Returns the new PDF bytes.
+     */
+    setFormField(path: string, value: string): Uint8Array;
+    /**
+     * Bulk-set multiple AcroForm text fields from a JSON object
+     * `{"field.path": "value", ...}`. Returns the new PDF bytes.
+     */
+    setFormFields(fields_json: string): Uint8Array;
+    /**
+     * Signature info as JSON array.
+     */
+    signatures(): string;
+    /**
+     * Extract plain text from a page (0-based index).
+     *
+     * Returns an empty string if the page index is out of range or text
+     * extraction fails.
+     */
+    text(page_index: number): string;
+    /**
+     * Validate against a PDF/A level. Returns compliance report as JSON.
+     */
+    validatePdfA(level: string): string;
+    /**
+     * Verify all digital signatures in the document.
+     *
+     * Returns JSON array with verification results per signature.
+     */
+    verifySignatures(): string;
+}
+
+/**
+ * Stateful editing handle.
+ *
+ * Construct with [`PdfDocMut::open`], apply any sequence of mutations
+ * (all `&mut self`), and finally call [`PdfDocMut::save`] to get the
+ * modified PDF bytes. `save` is non-consuming; you can continue
+ * editing after taking a snapshot.
+ */
+export class PdfDocMut {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Add a free-text annotation at the given page rectangle.
+     */
+    addFreeText(page_index: number, x: number, y: number, w: number, h: number, contents: string): void;
+    /**
+     * Add a highlight annotation over the given page rectangle.
+     * `color_hex` like `"#ffeb3b"` — defaults to yellow when `None`.
+     */
+    addHighlight(page_index: number, x: number, y: number, w: number, h: number, color_hex?: string | null): void;
+    /**
+     * Add a sticky-note annotation at the given page position.
+     */
+    addStickyNote(page_index: number, x: number, y: number, contents: string): void;
+    /**
+     * Apply a diagonal text watermark to every page.
+     */
+    addTextWatermark(text: string, opacity: number): void;
+    /**
+     * Re-encode content streams with deflate compression.
+     */
+    compress(): void;
+    /**
+     * Delete the listed pages (0-based) from the document.
+     */
+    deletePages(pages: Uint32Array): void;
+    /**
+     * Extract the listed pages (0-based) into a **new** document and
+     * return its bytes. Leaves the current editing session untouched.
+     *
+     * Use for split-style workflows where the original keeps the full
+     * set of pages and a subset is exported.
+     */
+    extractPages(pages: Uint32Array): Uint8Array;
+    /**
+     * Open a PDF for editing.
+     */
+    static open(bytes: Uint8Array): PdfDocMut;
+    /**
+     * Number of pages in the current document state.
+     */
+    pageCount(): number;
+    /**
+     * Permanently remove content within the given page rectangle.
+     */
+    redactRegion(page_index: number, x: number, y: number, w: number, h: number): void;
+    /**
+     * Search-and-redact: every literal match of `query` is permanently
+     * removed from every page.
+     */
+    redactSearch(query: string): void;
+    /**
+     * Re-order pages. `new_order` is a permutation of `0..page_count`.
+     */
+    reorderPages(new_order: Uint32Array): void;
+    /**
+     * Rotate a single page by 90/180/270 (or negative). Multiples of 90 only.
+     */
+    rotatePage(page_index: number, degrees: number): void;
+    /**
+     * Serialise the current document state to a `Uint8Array`.
+     *
+     * Non-consuming: subsequent mutations are still possible on the
+     * same handle.
+     */
+    save(): Uint8Array;
+    /**
+     * Set a single AcroForm text-field value.
+     *
+     * Note: pdfluent's high-level `PdfFormMut` requires a
+     * `pdfluent::PdfDocument`. To stay in-place on this handle, we use
+     * the lower-level lopdf walk via the `pdf-forms` engine. For 1.0,
+     * this supports flat top-level field hierarchies (no `/Kids`
+     * recursion) — same constraint as the Rust core.
+     */
+    setFormField(path: string, value: string): void;
+    /**
+     * Bulk-set multiple AcroForm text fields from a JSON object
+     * `{"field.path": "value", ...}`.
+     */
+    setFormFields(fields_json: string): void;
+}
+
+/**
+ * The main XFA processing engine for WASM.
+ *
+ * Holds a parsed FormTree and provides methods to extract/import data.
+ */
+export class XfaEngine {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Export all field values as a JSON string.
+     *
+     * Returns `{"form1.FieldName": "value", ...}`.
+     */
+    exportJson(): string;
+    /**
+     * Export the form schema as a JSON string.
+     *
+     * Returns metadata about each field (name, type, constraints).
+     */
+    exportSchema(): string;
+    /**
+     * Create an XfaEngine from a JSON array of field definitions.
+     *
+     * Expected format:
+     * ```json
+     * [
+     *   {"name": "FieldName", "value": "initial value", "calculate": "optional script"},
+     *   ...
+     * ]
+     * ```
+     */
+    static fromFields(fields_json: string): XfaEngine;
+    /**
+     * Create an XfaEngine from exported JSON data (e.g. from `exportJson`).
+     *
+     * Rebuilds the form tree from a flat field map.
+     */
+    static fromJson(json_str: string): XfaEngine;
+    /**
+     * Get a single field value by SOM path (e.g., "form1.Name").
+     */
+    getFieldValue(path: string): string | undefined;
+    /**
+     * Import field values from a JSON string.
+     *
+     * Accepts either:
+     * - `{"fields": {"form1.Name": "value"}}` (FormData format)
+     * - `{"form1.Name": "value"}` (flat format)
+     */
+    importJson(json_str: string): void;
+    /**
+     * Get the number of form nodes.
+     */
+    nodeCount(): number;
+    /**
+     * Run FormCalc calculate scripts to compute derived field values.
+     */
+    runCalculations(): void;
+    /**
+     * Set a single field value by SOM path.
+     */
+    setFieldValue(path: string, value: string): boolean;
+    /**
+     * Get engine version string.
+     */
+    static version(): string;
+}
+
+/**
+ * Activate the process-global license from a key string.
+ *
+ * Throws on invalid key or if the process has already been activated to a
+ * different tier this session.
+ */
+export function activateLicenseKey(key: string): void;
+
+/**
+ * Return the current license status. Always succeeds; defaults to Trial.
+ */
+export function licenseStatus(): LicenseStatus;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_licensestatus_free: (a: number, b: number) => void;
+    readonly __wbg_pdfdoc_free: (a: number, b: number) => void;
+    readonly __wbg_pdfdocmut_free: (a: number, b: number) => void;
+    readonly __wbg_xfaengine_free: (a: number, b: number) => void;
+    readonly activateLicenseKey: (a: number, b: number, c: number) => void;
+    readonly licenseStatus: () => number;
+    readonly licensestatus_outputIsMarked: (a: number) => number;
+    readonly licensestatus_source: (a: number, b: number) => void;
+    readonly licensestatus_tier: (a: number, b: number) => void;
+    readonly pdfdoc_addFreeText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly pdfdoc_addHighlight: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly pdfdoc_addStickyNote: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly pdfdoc_addTextWatermark: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly pdfdoc_compress: (a: number, b: number) => void;
+    readonly pdfdoc_convertToPdfa: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_deletePages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_dssInfo: (a: number, b: number) => void;
+    readonly pdfdoc_extractPages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_flattenXfa: (a: number, b: number) => void;
+    readonly pdfdoc_getAnnotations: (a: number, b: number, c: number) => void;
+    readonly pdfdoc_getTextPositions: (a: number, b: number, c: number) => void;
+    readonly pdfdoc_hasSignatures: (a: number) => number;
+    readonly pdfdoc_merge: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_metadata: (a: number, b: number) => void;
+    readonly pdfdoc_open: (a: number, b: number, c: number) => void;
+    readonly pdfdoc_pageCount: (a: number) => number;
+    readonly pdfdoc_pageHeight: (a: number, b: number) => number;
+    readonly pdfdoc_pageWidth: (a: number, b: number) => number;
+    readonly pdfdoc_redactRegion: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly pdfdoc_redactSearch: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_renderPage: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_renderPageToCanvas: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly pdfdoc_renderPageToCanvasVector: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly pdfdoc_renderThumbnail: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_reorderPages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_rotatePage: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_setFormField: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly pdfdoc_setFormFields: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_signatures: (a: number, b: number) => void;
+    readonly pdfdoc_text: (a: number, b: number, c: number) => void;
+    readonly pdfdoc_validatePdfA: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdoc_verifySignatures: (a: number, b: number) => void;
+    readonly pdfdocmut_addFreeText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly pdfdocmut_addHighlight: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly pdfdocmut_addStickyNote: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly pdfdocmut_addTextWatermark: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly pdfdocmut_compress: (a: number, b: number) => void;
+    readonly pdfdocmut_deletePages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdocmut_extractPages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdocmut_open: (a: number, b: number, c: number) => void;
+    readonly pdfdocmut_pageCount: (a: number) => number;
+    readonly pdfdocmut_redactRegion: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly pdfdocmut_redactSearch: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdocmut_reorderPages: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdocmut_rotatePage: (a: number, b: number, c: number, d: number) => void;
+    readonly pdfdocmut_save: (a: number, b: number) => void;
+    readonly pdfdocmut_setFormField: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly pdfdocmut_setFormFields: (a: number, b: number, c: number, d: number) => void;
+    readonly xfaengine_exportJson: (a: number, b: number) => void;
+    readonly xfaengine_exportSchema: (a: number, b: number) => void;
+    readonly xfaengine_fromFields: (a: number, b: number, c: number) => void;
+    readonly xfaengine_fromJson: (a: number, b: number, c: number) => void;
+    readonly xfaengine_getFieldValue: (a: number, b: number, c: number, d: number) => void;
+    readonly xfaengine_importJson: (a: number, b: number, c: number, d: number) => void;
+    readonly xfaengine_nodeCount: (a: number) => number;
+    readonly xfaengine_runCalculations: (a: number, b: number) => void;
+    readonly xfaengine_setFieldValue: (a: number, b: number, c: number, d: number, e: number) => number;
+    readonly xfaengine_version: (a: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;