@pdfluent/sdk-wasm 1.0.0 → 1.2.0

package/LICENSE-COMMERCIAL

@@ -98,6 +98,14 @@ to relicense and need no licence from PDFluent. `NOTICE` records which they are;
 
 This licence covers the components on PDFluent's side of that boundary.
 
+Optional model files and runtime libraries that the software downloads on
+your explicit request (for example with `pdfluent models install`) are
+licensed as follows. Model files trained by PDFluent are licensed under
+the same terms as the software. Third-party model files and runtime
+libraries are licensed to you under their own terms, listed in the notice
+that accompanies them, and are provided as-is; PDFluent gives no warranty
+or indemnity for them.
+
 
 4. Attribution
 --------------

package/NOTICE

@@ -71,6 +71,9 @@ that. See https://pdfluent.com/sdk/pricing.
 
   pdfluent             — the unified facade SDK
   pdf-engine           — orchestration and document model
+                         (the TATR post-processing behind `ort-tables` is a port of
+                          Microsoft's table-transformer, © Microsoft Corporation,
+                          MIT; that notice ships inside the crate as THIRD_PARTY.md)
   pdf-manip            — page-level manipulation (merge, split, rotate, etc.)
                          (six unmodified Adobe CMap resources, compiled in
                           to read the character codes of a predefined CMap;
@@ -81,11 +84,14 @@ that. See https://pdfluent.com/sdk/pricing.
   pdfluent-sign        — digital signatures (PAdES, S/MIME)
   pdf-compliance       — PDF/A, PDF/UA, PDF/X validation and conversion
   pdfluent-extract     — text and image extraction
+  epub-extract         — EPUB content extraction
   pdfluent-forms       — AcroForm support
   pdf-annot            — annotations
   pdf-docx             — DOCX export
   pdf-xlsx             — XLSX export and table extraction
+  xlsx-extract         — XLSX workbook extraction to engine blocks
   pdf-pptx             — PowerPoint PPTX export
+  pptx-extract         — PowerPoint PPTX extraction to blocks
   pdf-invoice          — FDF/XFDF form data exchange and ZUGFeRD/Factur-X
   pdf-text-format      — text run formatting
   pdf-standard-fonts   — the Standard 14 font programs, compiled in
@@ -107,6 +113,7 @@ that. See https://pdfluent.com/sdk/pricing.
   xfa-js-sandboxed     — sandboxed JavaScript runtime for XFA scripts
   formcalc-interpreter — FormCalc evaluation
   xfa-json             — XFA JSON conversion
+  pdfluent-cli         — command-line interface over the facade
 
 The Software produces the same output whether or not a commercial licence is
 held: there is no licence key, nothing is withheld and no marker is added

package/README.md

@@ -295,4 +295,4 @@ add-on). The two texts are `LICENSE` and `LICENSE-COMMERCIAL` in this package.
 - **Documentation:** <https://pdfluent.com/docs>
 - **Pricing:** <https://pdfluent.com/sdk/pricing>
 - **PDFluent editor** (source-available): <https://github.com/pdfluent/pdfluent>. The free desktop app this SDK powers.
-- Built by [Innovation Trigger BV](https://pdfluent.com)
+- Built by [Innovation Trigger B.V.](https://pdfluent.com)

package/THIRD_PARTY_LICENSES.txt

@@ -321,7 +321,8 @@ unic-char-range, unic-common, unic-ucd-ident, unic-ucd-version, unicode-bidi,
 unicode-normalization, unicode-properties, unicode-segmentation, unicode-width,
 unicode-xid, url, utf-8, utf8_iter, utf8parse, uuid, vello_common, vello_cpu,
 wasm-bindgen, wasm-bindgen-futures, wasm-bindgen-macro,
-wasm-bindgen-macro-support, wasm-bindgen-shared, wasm-streams, web-sys,
+wasm-bindgen-macro-support, wasm-bindgen-shared, wasm-streams, wasmi, wasmi_collections, wasmi_core,
+wasmi_ir, web-sys,
 web-time, web_atoms, weezl, winapi, winapi-i686-pc-windows-gnu,
 winapi-x86_64-pc-windows-gnu, window-vibrancy, windows, windows-collections,
 windows-core, windows-future, windows-implement, windows-interface,
@@ -412,8 +413,7 @@ new_debug_unreachable, nom, nom_locate, noop_proc_macro, nu-ansi-term,
 number_prefix, objc2, objc2-encode, objc2-foundation, open, openssl-sys,
 os_pipe, pango, pango-sys, pdf-bench, pdf-desktop, pdf-diff, pdf-java,
 pdfluent-lopdf, phf, phf_generator, phf_macros, phf_shared, plist,
-precomputed-hash, quick-xml, redox_syscall, redox_users, rfd, rgb, rquickjs,
-rquickjs-core, rquickjs-macro, rquickjs-sys, rusqlite, schannel, schemars,
+precomputed-hash, quick-xml, redox_syscall, redox_users, rfd, rgb, rusqlite, schannel, schemars,
 schemars_derive, sharded-slab, shared_child, sigchld, simd-adler32,
 simd_helpers, slab, soup3, soup3-sys, spin, strsim, synstructure, tiff,
 tokio, tokio-macros, tokio-native-tls, tokio-util, tower, tower-http,
@@ -731,6 +731,152 @@ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+================================================================================
+QuickJS-ng — the script engine, compiled into xfa-js-sandboxed's WebAssembly module
+https://github.com/quickjs-ng/quickjs   (version 0.7.0)
+================================================================================
+
+QuickJS (MIT) is a component of crates/xfa-js-sandboxed/wasm-guest/qjs_guest.wasm:
+the module is compiled from the C sources in wasm-guest/quickjs/ (two changes,
+listed in wasm-guest/PATCHES.md) and is interpreted by the wasmi crate. No native
+C code runs. The module also contains code from wasi-libc (Apache-2.0 WITH
+LLVM-exception; MIT and BSD-2-Clause parts derived from musl) and LLVM
+compiler-rt (Apache-2.0 WITH LLVM-exception), linked in by the toolchain
+(zig 0.16.0, build tooling only, not shipped). See wasm-guest/NOTICE.
+
+The MIT License (MIT)
+ 
+Copyright (c) 2017-2021 Fabrice Bellard
+Copyright (c) 2017-2021 Charlie Gordon
+Copyright (c) 2023 Ben Noordhuis
+Copyright (c) 2023 Saúl Ibarra Corretgé
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+================================================================================
+tract — ONNX inference for the optional vision layer (#636)
+https://github.com/sonos/tract
+================================================================================
+
+The `vision` cargo feature of pdf-engine (off by default; passthrough in
+pdfluent) runs ONNX models through tract-onnx 0.23 (default-features off, so
+without the `transformers` op-set). No trained model ships; the only ONNX
+bytes in the tree are the 152-byte identity fixture the tests run.
+
+Copyright (c) Mathieu Poumeyrol and the tract contributors.
+
+Dual-licensed under MIT and Apache-2.0, at our option. The crates as resolved
+(tract-onnx, tract-onnx-opl, tract-hir, tract-core, tract-data,
+tract-extra, tract-nnef, tract-linalg and their transitive dependencies
+bytes, derive-new, log, memmap2, nom, nom-language, num-integer,
+num-rational, num-traits, prost, smallvec and the tract-*-sys/metal
+helpers) each declare MIT OR Apache-2.0 and are covered by the texts below;
+both are permissive and impose no copyleft obligation on the product. This
+entry stands outside the `cargo license 2026-05-26` list above because that
+list predates the dependency; the next regeneration absorbs these crates.
+
+--- MIT License ---
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+--- Apache License, Version 2.0 ---
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+================================================================================
+table-transformer — Table Transformer structure post-processing (MIT)
+https://github.com/microsoft/table-transformer
+commit 16d124f616109746b7785f03085100f1f6247575
+================================================================================
+
+Copyright (c) Microsoft Corporation.
+
+What is used, in two forms:
+
+  crates/pdf-engine/src/learned/tables_tatr.rs        a Rust port of the
+             publisher's row/column/header/spanning-cell reconciliation and
+             grid-cell construction (`objects_to_cells` and everything it
+             calls), behind the `ort-tables` feature of pdf-engine. Same
+             thresholds, same refinement, same cells; the parity test feeds
+             raw ONNX outputs and requires the Python-decoded cells, value
+             for value.
+  scripts/extraction/tables_b/tatr_postprocess.py     the Python original,
+             `src/postprocess.py` at the commit above, vendored verbatim
+             (see the header in that file). The zero-shot eval runs TATR
+             through it rather than through a reimplementation, so a TATR
+             number is the publisher's reading of its own boxes.
+
+MIT is permissive, no copyleft: the licence text below is that commit's
+LICENSE, word for word. The same copyright line and text ship inside the
+pdf-engine crate as THIRD_PARTY.md, because a crates.io reader has this
+file's section in front of them only through the repository.
+
+--- MIT License ---
+
+MIT License
+
+Copyright (c) Microsoft Corporation.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE
+
 ================================================================================
 END OF THIRD PARTY LICENSES
 ================================================================================

package/package.json

@@ -2,7 +2,7 @@
   "name": "@pdfluent/sdk-wasm",
   "type": "module",
   "description": "PDFluent browser SDK — find and replace PDF text programmatically while preserving fonts and layout, plus edit, annotate, redact, sign and validate PDFs (including XFA), entirely client-side via WASM.",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "license": "SEE LICENSE IN LICENSE-OFFER",
   "repository": {
     "type": "git",
@@ -18,7 +18,8 @@
     "LICENSE-COMMERCIAL",
     "LICENSE-OFFER",
     "NOTICE",
-    "THIRD_PARTY_LICENSES.txt"
+    "THIRD_PARTY_LICENSES.txt",
+    "xfa_wasm.augment.d.ts"
   ],
   "main": "xfa_wasm.js",
   "types": "xfa_wasm.d.ts",
@@ -43,11 +44,21 @@
     "redact"
   ],
   "homepage": "https://pdfluent.com",
-  "author": "Innovation Trigger BV <team@pdfluent.com>",
+  "author": "Innovation Trigger B.V. <team@pdfluent.com>",
   "bugs": {
     "url": "https://github.com/pdfluent/pdfluent-sdk/issues"
   },
-  "publishConfig": {
-    "access": "public"
+  "exports": {
+    ".": {
+      "types": "./xfa_wasm.d.ts",
+      "import": "./xfa_wasm.js",
+      "default": "./xfa_wasm.js"
+    },
+    "./augment": {
+      "types": "./xfa_wasm.augment.d.ts"
+    },
+    "./xfa_wasm_bg.wasm": "./xfa_wasm_bg.wasm",
+    "./package.json": "./package.json",
+    "./*": "./*"
   }
 }

package/xfa_wasm.augment.d.ts

@@ -0,0 +1,188 @@
+/**
+ * Hand-maintained TypeScript supplement for `@pdfluent/sdk-wasm`.
+ *
+ * Augments the generated `xfa_wasm.d.ts` with:
+ * - `PdfluentError` class declaration (errors thrown by all WASM methods)
+ * - `XfaWasmError` legacy alias (kept for older consumer code that imported
+ *   the pre-1.0 type name)
+ * - `free()` lifecycle documentation for `PdfDoc` and `XfaEngine`
+ *
+ * Usage: import this file alongside the main module in projects that need
+ * strict error handling:
+ *
+ * ```ts
+ * import init, { PdfDoc } from '@pdfluent/sdk-wasm';
+ * import type { PdfluentError } from '@pdfluent/sdk-wasm/pkg-types/xfa_wasm.augment';
+ * ```
+ *
+ * Or add this file to your `tsconfig.json` `types` array for global augmentation.
+ */
+
+/* --- Typed error class ----------------------------------------------------- */
+
+/**
+ * Structured error thrown by every fallible PDFluent WASM operation.
+ *
+ * `PdfluentError` is a real `class` (extends `Error`) registered on
+ * `globalThis.__PdfluentError` the first time the WASM module loads. The
+ * thrown instance is a true subclass of `Error`, so
+ * `error instanceof PdfluentError` works in user code.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import init, { PdfDoc, PdfluentError } from '@pdfluent/sdk-wasm';
+ * await init();
+ *
+ * try {
+ *   using doc = PdfDoc.open(corruptBytes);
+ * } catch (e) {
+ *   if (e instanceof PdfluentError) {
+ *     console.error(`[${e.code}] ${e.message} (in ${e.operation})`);
+ *     if (e.code === 'E-PARSE-INVALID-PDF') {
+ *       // show "not a valid PDF" UI feedback
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ## Properties
+ *
+ * | Property | Type | Description |
+ * |----------|------|-------------|
+ * | `code` | `string` | Stable C8 catalogue code, format `E-<CATEGORY>-<SPECIFIC>`. |
+ * | `message` | `string` | Human-readable description. |
+ * | `operation` | `string` | API call that failed (e.g. `"PdfDoc.open"`). |
+ * | `help` | `string` | Optional actionable hint (may be empty). |
+ * | `docsUrl` | `string` | Deep-link to documentation at `https://pdfluent.com/errors/<code>`. |
+ * | `legacyCode` | `string` | Pre-1.0 SCREAMING_SNAKE_CASE identifier, preserved for backward compatibility. |
+ *
+ * ## C8 Error codes (canonical, from `docs/error_catalogue.md`)
+ *
+ * | Code | Thrown by |
+ * |------|-----------|
+ * | `E-PARSE-INVALID-PDF` | `PdfDoc.open` — bytes are not a valid PDF |
+ * | `E-IO-GENERIC` | I/O failure |
+ * | `E-PARSE-UNSUPPORTED-VERSION` | `PdfDoc.open` — PDF version too new |
+ * | `E-COMPLIANCE-PDFA-INVALID` | `convertToPdfa`, `validatePdfA` |
+ * | `E-ENV-UNSUPPORTED-ON-WASM` | Native-only operation invoked from WASM |
+ * | `E-INTERNAL` | Internal safety-net |
+ * | `E-WASM-INVALID-ARGUMENT` | Argument validation (e.g. `validatePdfA("xyz")`) |
+ * | `E-WASM-PAGE-OUT-OF-RANGE` | Page index outside `0..page_count` |
+ * | `E-WASM-RENDER-FAILED` | `renderPage`, `renderPageToCanvas` |
+ * | `E-WASM-RENDER-FALLBACK` | Vector renderer hit unsupported feature |
+ * | `E-WASM-TEXT-EXTRACT-FAILED` | `getTextPositions` |
+ * | `E-WASM-XFA-FAILED` | `flattenXfa` |
+ * | `E-WASM-MERGE-FAILED` | `merge` |
+ * | `E-WASM-SAVE-FAILED` | Internal save / serialize |
+ * | `E-WASM-INVALID-JSON` | `fromFields`, `fromJson`, `importJson`, schema export |
+ * | `E-WASM-FORMCALC-FAILED` | `runCalculations` |
+ * | `E-SECURITY-DECRYPTION-FAILED` | `decryptPdf`, `signPdf`: wrong password, or one that does not entitle the call |
+ * | `E-WASM-SIGN-FAILED` | `signPdf` |
+ *
+ * ## Backward compatibility
+ *
+ * Before 1.0 the WASM binding threw `XfaWasmError` with a SCREAMING_SNAKE_CASE
+ * `.code` property. That identifier is preserved on the new `.legacyCode`
+ * property and on the `XfaWasmError` type alias (see below) so existing
+ * consumer code keeps working. Newly-written code should use `.code` with the
+ * `E-<CATEGORY>-<SPECIFIC>` strings.
+ */
+export declare class PdfluentError extends Error {
+  /** Stable C8 catalogue code in `E-<CATEGORY>-<SPECIFIC>` format. */
+  readonly code: string;
+  /** Short identifier of the API call that failed (e.g. `"PdfDoc.open"`). */
+  readonly operation: string;
+  /** Optional actionable hint for developers. May be empty string. */
+  readonly help: string;
+  /** Deep-link into the error documentation. */
+  readonly docsUrl: string;
+  /** Pre-1.0 SCREAMING_SNAKE_CASE identifier, kept for backward compatibility. */
+  readonly legacyCode: string;
+}
+
+/**
+ * Legacy alias for `PdfluentError`. Existing code that does
+ * `import { XfaWasmError }` keeps compiling; new code should use
+ * `PdfluentError`.
+ *
+ * @deprecated Use {@link PdfluentError}.
+ */
+export type XfaWasmError = PdfluentError;
+
+/* --- Type guards ----------------------------------------------------------- */
+
+/**
+ * Type guard: returns `true` when `e` is a `PdfluentError` thrown by the WASM module.
+ *
+ * ```ts
+ * try {
+ *   doc.flattenXfa();
+ * } catch (e) {
+ *   if (isPdfluentError(e)) {
+ *     console.error(e.code, e.help);
+ *   }
+ * }
+ * ```
+ */
+export declare function isPdfluentError(e: unknown): e is PdfluentError;
+
+/**
+ * Legacy alias for {@link isPdfluentError}.
+ * @deprecated Use {@link isPdfluentError}.
+ */
+export declare function isXfaWasmError(e: unknown): e is PdfluentError;
+
+/* --- Lifecycle augmentation ----------------------------------------------- */
+
+/**
+ * Lifecycle contract for WASM objects that hold native memory.
+ *
+ * Both `PdfDoc` and `XfaEngine` allocate memory in the WASM heap. The JavaScript
+ * garbage collector does **not** free WASM heap memory — you must call `free()`
+ * explicitly, or use the `using` keyword (TypeScript 5.2+, requires `--target ES2022`
+ * or newer and `lib: ["ESNext.Disposable"]`).
+ *
+ * ### Option 1 — `using` (recommended, TypeScript 5.2+)
+ *
+ * ```ts
+ * {
+ *   using doc = PdfDoc.open(bytes);
+ *   const count = doc.pageCount();
+ * } // doc.free() called automatically here
+ * ```
+ *
+ * ### Option 2 — explicit `free()`
+ *
+ * ```ts
+ * const doc = PdfDoc.open(bytes);
+ * try {
+ *   const count = doc.pageCount();
+ * } finally {
+ *   doc.free();
+ * }
+ * ```
+ *
+ * ### After `free()`
+ *
+ * Once `free()` is called, the object's native pointer is invalidated. Any
+ * subsequent method call throws a `PdfluentError` with code `"E-INTERNAL"`.
+ */
+export interface WasmLifecycle {
+  /**
+   * Release all native WASM heap memory owned by this object.
+   *
+   * - Must be called when you are done with the object, unless you used `using`.
+   * - After calling `free()`, all methods throw.
+   * - Calling `free()` twice is safe (no-op).
+   * - Equivalent to `[Symbol.dispose]()`.
+   */
+  free(): void;
+
+  /**
+   * Alias for `free()`, called automatically by the `using` statement.
+   *
+   * See {@link WasmLifecycle.free} for full lifecycle documentation.
+   */
+  [Symbol.dispose](): void;
+}