pdf

TypeScript libraries for PDF document creation and manipulation, with a focus on signing and encryption scenarios.

Packages

• cli - Command-line interface for PDF document manipulation and analysis
• copy - Module for recreating PDF documents using specified filters
• core - Core functionality for PDF document manipulation and processing
• doc - PDF document creation and editing capabilities
• font - Font handling and management for PDF documents
• form-json - JSON form data handling for PDF documents
• repair - Tools for repairing and fixing corrupted PDF documents
• tests - Test utilities and shared test resources

License

This project is dual-licensed under the AGPL-3.0 and a Commercial License:

AGPL-3.0

The library is open-source and freely available under the terms of the Affero General Public License (AGPL-3.0). This ensures that modifications and usage in network-based applications (e.g., SaaS) must be shared under the same license.

You can use the library under AGPL-3.0 if:

• Your project is open-source and distributed under a compatible license
• Your use complies with the AGPL-3.0 requirements

Commercial License

For use in proprietary, closed-source, or commercial projects where the AGPL is not suitable, a commercial license is available. This allows you to use the library without the AGPL's obligations.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.17.1 (2025-05-05)

Bug Fixes

• handle case where leaf certificate is trusted in CertificateChain (5b0d94c)
• improve LTV state handling in signature verification process for trusted leaf certificate (c92ab13)

1.17.0 (2025-01-07)

Bug Fixes

• cms: improve signing algorithm handling in OCSP response (6ddfbaf)
• doc: improve wording for identity verification and document structure warnings (52cb7af)
• doc: update default xref option to 0 for XRef Stream (cf115bc)
• forms: implement paint call on border and color change events (9b98eee)
• implement Registry class for managing circular dependencies and enhance CMS imports (c5cd79b)
• update repo-init action to use NPM token instead of GitHub token (7267dc2)

Features

• doc: add catalog getter with error handling in PDFDocument (7a1e043)
• doc: enable signature flags in AcroForm for PDFPage (ad910e7)
• forms: add name parameter to IFormComponentParameters and improve FormComponent structure (9822cde)
• tests: add password parameter to PdfRenderingHelper load and getPageHash methods (1acc968)
• tests: add PDF testing utilities and helpers (8911ac5)
• tests: add PKI handling and PDF file writing utilities (d088f1c)
• tests: enhance PdfRenderingHelper and add resource handling (f3c41b7)
• ViewWriter: add toString method to convert buffer to binary string (c471b75)

1.16.0 (2024-07-22)

Features

• Add RSA-PSS signature algorithm support (8f194b1)
• Support RSA-PSS algorithm parameters (51c2273)

1.15.0 (2024-06-03)

Bug Fixes

• Update type declaration for TS v5 (d087096)

Features

• Update CryptoEngine to support Ed25519 type (ca62bcf)

1.14.0 (2024-01-19)

Bug Fixes

• EOF handling in PDFDocumentUpdate (d53cfcc)
• incorrect wrongStructure calculation (1d13857)

Features

• formatting issue in SignatureBoxGroup class (b53ce8d)

1.13.18 (2024-01-16)

Bug Fixes

• issue #115 (91c238b)

1.13.17 (2024-01-04)

Bug Fixes

• error if xref table eol includes the SPACE char (4942598)
• improve error message for ParsingError (1fb04c8)

1.13.16 (2024-01-03)

Bug Fixes

• improve BadCharError message (15c5136)
• improve PDF Dictionary value conversion error (f08bd8f)
• incorrect type for ID field of Page Object (5d49348)

1.13.15 (2023-12-07)

Bug Fixes

• paint for TextEditor (6c698ee)
• read CrossReferenceTable (72e4d55)
• read stream value (10eaab0)

1.13.14 (2023-11-07)

Bug Fixes

• cross-reference stream index count (a5867b4)

1.13.13 (2023-10-03)

Note: Version bump only for package pdf

1.13.12 (2023-09-14)

Bug Fixes

• begin update with end of line if needed (5aa651b)
• enable cache to reduce value conversion (3e7a8ac)
• incorrect trailer size (72eb6af), closes #102

1.13.11 (2023-09-14)

Bug Fixes

• macos Viewer doesn't show aes256 encrypted document (d7b952f), closes #99

1.13.10 (2023-08-28)

Bug Fixes

• use User password for Owner if Owner is empty (6d6f692)

1.13.9 (2023-08-23)

Bug Fixes

• incorrect stream cloning (e3d1531)

1.13.8 (2023-08-22)

Bug Fixes

• error on AcroForm getting (9cf0890)
• incorrect caching of indexes during cloning (cde3b39)

1.13.7 (2023-08-10)

Bug Fixes

• AcroFrom duplicates Fields on addField (f9d5950)
• error in component getting by name if Kid is not a field (824492c)
• error on Signature field splitting if it doesn't belong to parent field (0197121)
• fix error with incorrect cache map (bd96819), closes #94
• improve Signature.groupName renaming and add tests (8c82fd3)
• increase speed of serialization (449bf26)
• problems with signature groups (bab4d06)
• remove Widget from AcroFrom on split (071d28e)
• remove XFA on copy (33273ff)

1.13.6 (2023-06-29)

Bug Fixes

• use components to get isSigned (0917550)

1.13.5 (2023-06-29)

Bug Fixes

• incorrect signature removing (5c60716)

1.13.4 (2023-06-22)

Bug Fixes

• error on null cloning (1eb6339), closes #88
• sig doesn't draw an image for Widget + Field (4ae6bee)

1.13.3 (2023-06-15)

Bug Fixes

• split single widget for signature box (364fd5d)

1.13.2 (2023-06-15)

Bug Fixes

• don't run setter if value is the same for groupName (d7bf4f1)

1.13.1 (2023-06-14)

Bug Fixes

• return info about changed indexes after doc cloning (bca6679)

1.13.0 (2023-06-14)

Bug Fixes

• Can't sign document with visual annotation (1d890dd), closes #75
• CheckBox sets V into Widget (57dd535)
• incorrect XRef decoding (d3e2ec4)
• isSigned returns incorrect result (8b99611)
• minor issues (462c2c4)
• recursive error (e026393)
• return white color for empty arrays (03ff8c5)
• text field with multiple widgets (cbea2bf), closes #73
• unable to change width for widget (c31a2ed), closes #76
• use CharacterEncodingDictionary #80 (abb92cb)

Features

• compute font size for TextEditor (58da52d)
• support hybrid xref reading #78 (12aa11c)

1.12.0 (2023-06-01)

Features

• support page padding (1f827da)

1.11.3 (2023-05-08)

Bug Fixes

• incorrect BBox when changing Y coordinate (9cb56a2)

1.11.2 (2023-05-05)

Bug Fixes

• app doesn't draw Appearance content for multiple updates (810c44a)
• getComponentByName with argument type can't return null (93f4f21)
• Is not works content alignment for render (5d017f2), closes #62
• Unable to set value for Radio widget (d156dbe), closes #61

1.11.1 (2023-05-05)

Bug Fixes

• enable support for text widgets in nested Fields (#56) (10fb372)
• Wrong appearance for Comb text fields (abb65ec), closes #60

1.11.0 (2023-03-30)

Bug Fixes

• problem with wrapWidget usage (7a73765)

Features

• add Choice dictionary (fa41dce)
• add clear method to Array (62a02ab)
• add ComboBox (b7057bf)
• add form-json package (f7447b7)

1.10.4 (2023-03-15)

Bug Fixes

• circular dependencies (#51) (b887268)

1.10.3 (2023-03-14)

Bug Fixes

• rollup error and update project dependencies (#50) (7111e61)

1.10.2 (2023-03-14)

Bug Fixes

• Hancock files (#49) (78d9180)

1.10.1 (2023-03-08)

Bug Fixes

• Support TrueType font (#48) (aa43a72), closes #47

1.10.0 (2023-03-01)

Features

• file attachment (#46) (7cd5df0)

1.9.0 (2023-02-24)

Features

• Page management (#45) (d6140bc)

1.8.5 (2023-02-09)

Bug Fixes

• font adding, incorrect Tj operator (#42) (366e02e)

1.8.4 (2023-02-09)

Note: Version bump only for package pdf

1.8.3 (2023-02-08)

Bug Fixes

• incorrect encryption for Sig, Dict fields and Array items (#40) (5f09f85)

1.8.2 (2023-02-08)

Bug Fixes

• signature verification (#39) (39630f4)

1.8.1 (2023-02-06)

Bug Fixes

• incorrect content on signing (#38) (c3b1b3a)

1.8.0 (2023-02-03)

Features

• Document clone (#37) (ffaa1b7)

1.7.1 (2023-01-31)

Bug Fixes

• Add RC4 for Standard Encryption (#36) (99d0f08)

1.7.0 (2023-01-31)

Features

• Public Key encryption (#35) (0763e20)

1.6.7 (2023-01-24)

Bug Fixes

• verification reason (#34) (e5eb8c9)

1.6.6 (2023-01-24)

Bug Fixes

• add state for malformed CMS (14fa460)

1.6.5 (2023-01-23)

Note: Version bump only for package pdf

1.6.4 (2023-01-22)

Bug Fixes

• sign encrypted document (#27) (1d7aa90)

1.6.3 (2023-01-22)

Bug Fixes

• core: Page inheritance (#26) (c2b4cfc), closes #21

1.6.2 (2023-01-22)

Note: Version bump only for package pdf

1.6.1 (2023-01-22)

Note: Version bump only for package pdf

1.6.0 (2023-01-22)

Features

• Encryption (#23) (2966abc)

1.5.2 (2023-01-17)

Bug Fixes

• error on AP getting for TextEdit (7e5575c)

1.5.1 (2023-01-15)

Bug Fixes

• incorrect result for FormComponent.left (7efdca6)

1.5.0 (2022-12-27)

Bug Fixes

• error on null object getting #14 (a049632)

Features

• add stopPropagation for CertificateStorage IResult (bcdb90a)
• use params for verify (faceb75)

1.4.0 (2022-12-05)

Features

• improve PageTreeNode (28bc6d3), closes #12

1.3.0 (2022-11-30)

Bug Fixes

• cli: error on getEngine (1ceb0fe)
• doc: problems with getEngine (518444a)
• TS errors after tsc update (f2f332a)

Features

• core: support Lock Dictionary (6b030ea)
• use pkijs TS beta version (a26bf46)

1.2.3 (2022-03-07)

Bug Fixes

• incorrect id for braipoolP512r1 curve (2fff41a)

1.2.2 (2022-03-04)

Bug Fixes

• ESM module with require statement (4af13f0)

1.2.1 (2022-03-04)

Bug Fixes

• error on edwords curves usage (da59fdf)

1.2.0 (2022-02-28)

Bug Fixes

• Incorrect Date regular expresion (7a81575)

Features

• Support new ECC and Hash mechanisms (ba71c82)

1.1.4 (2022-02-16)

Bug Fixes

• Error on padded header parsing (c9c1d5b)
• Error on padded xref table (9839135)

1.1.3 (2022-02-16)

Bug Fixes

• Enable LTV sate if VRI is null and revocations present (ef6eb51)

1.1.2 (2022-02-10)

Bug Fixes

• Add signedData object to verification result (b152155)
• Type declaration (37e2de6)

1.1.1 (2022-02-08)

Bug Fixes

• Incorrect import order for DefaultCertificateStorageHandler (e6b70f1)
• multiple pkijs import (4f88151)

1.1.0 (2022-01-27)

Bug Fixes

• cms: Error on certs getting (a423350)
• Error on bad encoded revocation items (5483508)
• Export ICertificateStorageHandler (51d66d5)
• findCRL always returns null (fa601df)
• Incorrect signature name for encrypted PDF (7d49501)

Features

• Add info about LTV status disabling (8af682f)
• Add wrongStructure field to PDFDocument (4641ffa)
• cms: Improve chain validation (bcc5dc1)

1.0.11 (2022-01-13)

Note: Version bump only for package pdf