pdf-lib

What's Changed

• Compute multiline font size for multiline inputs by @milesnash in https://github.com/Hopding/pdf-lib/pull/983
• Fix key reuse bug by @Hopding in https://github.com/Hopding/pdf-lib/pull/1078
• Improved memory usage by @Masterwow3 in https://github.com/Hopding/pdf-lib/pull/1032

New Contributors

• @milesnash made their first contribution in https://github.com/Hopding/pdf-lib/pull/983
• @Masterwow3 made their first contribution in https://github.com/Hopding/pdf-lib/pull/1032

Full Changelog: https://github.com/Hopding/pdf-lib/compare/v1.17.0...v1.17.1

• Fix typo in docs (thanks @adrianjost!)
  • https://github.com/Hopding/pdf-lib/pull/985
• Make ImageAlignment publicly accessible (thanks @oktapodia!)
  • https://github.com/Hopding/pdf-lib/pull/988
• Create PDFDocument.copy() method (thanks @mohamedsalem401!)
  • https://github.com/Hopding/pdf-lib/pull/986
• Fix acrofield removal and flattening bug (thanks @Trapfether!)
  • https://github.com/Hopding/pdf-lib/pull/1002
• Set P property on widgets created by pdf-lib (thanks @Trapfether!)
  • https://github.com/Hopding/pdf-lib/pull/1003
• Create PDFPage.scale(), PDFPage.scaleContent(), and PDFPage.scaleAnnotations() methods (thanks @JNK90!)
  • https://github.com/Hopding/pdf-lib/pull/991
• Fix bug causing Helvetica font to be embedded unnecessarily (thanks @ssssota!)
  • https://github.com/Hopding/pdf-lib/pull/820
• Make random number generation deterministic across documents (thanks @ChingChang9!)
  • https://github.com/Hopding/pdf-lib/pull/1033

• Add getters/setters for all valid ViewerPreferences (thanks @mcshaz!):
  • https://github.com/Hopding/pdf-lib/issues/744
  • https://github.com/Hopding/pdf-lib/pull/745
  • https://github.com/Hopding/pdf-lib/pull/769
• Fix bug preventing PDFs with flattened forms from being printed (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/pull/750
  • https://github.com/Hopding/pdf-lib/pull/770
• Add PDFTextField.setFontSize(...) method to PDFTextField and other field types (thanks @duffyd!):
  • https://github.com/Hopding/pdf-lib/issues/727
  • https://github.com/Hopding/pdf-lib/pull/754
  • https://github.com/Hopding/pdf-lib/pull/777
  • https://github.com/Hopding/pdf-lib/pull/776

• Add option to create hidden form fields (thanks @jbeuckm!):
  • https://github.com/Hopding/pdf-lib/pull/730
• Fix bug preventing some forms from being flattened (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/722
  • https://github.com/Hopding/pdf-lib/pull/723
  • https://github.com/Hopding/pdf-lib/pull/732
• Fix bug causing rotated form fields to be flattened incorrectly (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/733
  • https://github.com/Hopding/pdf-lib/pull/734
• Update logic for updating PDFRadioGroup and PDFCheckBox appearance streams:
  • https://github.com/Hopding/pdf-lib/pull/743

• Fix bug causing incorrect radio group appearance to be generated (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/678
  • https://github.com/Hopding/pdf-lib/pull/720

• Add options to disable custom font ligatures (thanks @hefler!):
  • https://github.com/Hopding/pdf-lib/issues/490
  • https://github.com/Hopding/pdf-lib/pull/642
  • https://github.com/Hopding/pdf-lib/pull/704
• Add method to expose page reference for widgets (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/pull/695
• Fix bug related to form field borders (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/682
  • https://github.com/Hopding/pdf-lib/pull/696
• Add PDFTextField.setImage(...) method (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/pull/700
  • https://github.com/Hopding/pdf-lib/pull/718
• Add option to display document's title in the window's title bar (thanks @multiplegeorges!):
  • https://github.com/Hopding/pdf-lib/pull/708
  • https://github.com/Hopding/pdf-lib/pull/719
• Add PDFForm.flatten() method (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/554
  • https://github.com/Hopding/pdf-lib/pull/716

• Improve PDF-A3 and Factur-X support (thanks @DkDavid!):
  • https://github.com/Hopding/pdf-lib/pull/508
• Support forms with hex string default appearances (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/pull/677
  • https://github.com/Hopding/pdf-lib/pull/693
• Fix issue with negative bounds when generating text field appearance streams (thanks @btecu!):
  • https://github.com/Hopding/pdf-lib/issues/680
  • https://github.com/Hopding/pdf-lib/pull/687

• Add PDFDocument.addJavaScript method (thanks @brodo!):
  • https://github.com/Hopding/pdf-lib/pull/643
  • https://github.com/Hopding/pdf-lib/pull/654

• Fix handling of null PDFDict entries:
  • https://github.com/Hopding/pdf-lib/issues/607
  • https://github.com/Hopding/pdf-lib/pull/608
• Fix bug causing errors to be thrown when filling forms with signature fields:
  • https://github.com/Hopding/pdf-lib/issues/625
  • https://github.com/Hopding/pdf-lib/pull/626

• Fix PDFField.acroField type bug
• Set Print flag on new widget annotations so new fields are printed after being added to a page:
  • https://github.com/Hopding/pdf-lib/issues/603
  • https://github.com/Hopding/pdf-lib/pull/604

• Add APIs to support form creation, filling, and reading:
  • https://github.com/Hopding/pdf-lib/pull/599

Examples and documentation:
* https://github.com/Hopding/pdf-lib#create-form
* https://github.com/Hopding/pdf-lib#fill-form
* https://github.com/Hopding/pdf-lib#creating-and-filling-forms
* https://github.com/Hopding/pdf-lib#fonts-and-unicode

• Add rotate option to PDFPage.drawEllipse and PDFPage.drawSvgPath (thanks @soadzoor!)
  • https://github.com/Hopding/pdf-lib/pull/511
  • https://github.com/Hopding/pdf-lib/pull/547
• Add customName option to PDFDocument.embedFont and PDFDocument.embedStandardFont to allow deterministic output from PDFDocument.save (thanks @ztoben and @trevtrich!)
  • https://github.com/Hopding/pdf-lib/pull/543
  • https://github.com/Hopding/pdf-lib/issues/537

• Fix transparent PNG embedding bug (thanks @soadzoor!):
  • https://github.com/Hopding/pdf-lib/pull/502
  • https://github.com/Hopding/pdf-lib/issues/473
  • https://github.com/Hopding/pdf-lib/issues/483
• Add blendMode option to all PDFPage drawing methods (thanks @bockoblur!):
  • https://github.com/Hopding/pdf-lib/pull/503
  • https://github.com/Hopding/pdf-lib/issues/500
• Add dashArray, dashPhase, borderDashArray, and borderDashPhase options to PDFPage drawing methods to allow control of dashes borders and lines (thanks @soadzoor!):
  • https://github.com/Hopding/pdf-lib/pull/498
• Add borderLineCap option to PDFPage drawing methods (thanks @soadzoor!):
  • https://github.com/Hopding/pdf-lib/pull/499

• Add opacity and borderOpacity options to all page drawing methods (thanks @soadzoor!):
  • See examples here and here
  • https://github.com/Hopding/pdf-lib/issues/210
  • https://github.com/Hopding/pdf-lib/pull/487
• Handle indirect objects with objectNumber=0 when parsing:
  • https://github.com/Hopding/pdf-lib/pull/496

• Add PDFDocument.attach method to add attachments to a document (thanks @sebastinez!):
  • See example here: https://github.com/Hopding/pdf-lib#add-attachments
  • https://github.com/Hopding/pdf-lib/issues/229
  • https://github.com/Hopding/pdf-lib/pull/455
  • https://github.com/Hopding/pdf-lib/commit/f0fccbef12bbc6423ce66caab311915d38a3e981
  • https://github.com/Hopding/pdf-lib/commit/dd32d28d909c2d47a7de073c4d3971c72c024cd7

• Build and publish ESM bundle; Document Deno support:
  • https://github.com/Hopding/pdf-lib/pull/448
• Add capNumbers: boolean option to PDFDocument.load(...) to allow capping parsed numbers to Number.MAX_SAFE_INTEGER:
  • https://github.com/Hopding/pdf-lib/issues/454
  • https://github.com/Hopding/pdf-lib/pull/458
  • https://github.com/Hopding/pdf-lib/pull/461
• Fix PDFPage.drawLine(...) API to remove breaking change introduced in https://github.com/Hopding/pdf-lib/pull/437:
  • https://github.com/Hopding/pdf-lib/pull/437#issuecomment-633491379
  • https://github.com/Hopding/pdf-lib/pull/460

• Fix page removal bug:
  • https://github.com/Hopding/pdf-lib/issues/440
  • https://github.com/Hopding/pdf-lib/pull/441
• Handle parsing invalid PDFName objects:
  • https://github.com/Hopding/pdf-lib/issues/408#issuecomment-618898401
  • https://github.com/Hopding/pdf-lib/pull/429
• Support setting of line cap style when drawing lines (thanks @taxilian!):
  • https://github.com/Hopding/pdf-lib/pull/437

• Update PDFPage methods for setting width/height/size to handle pages with CropBoxes:
  • https://github.com/Hopding/pdf-lib/issues/399
  • https://github.com/Hopding/pdf-lib/pull/405
• Add methods to PDFObject subclasses to access underlying values:
  • https://github.com/Hopding/pdf-lib/issues/238
  • https://github.com/Hopding/pdf-lib/pull/414
• Fix bug preventing JPG images using the CMYK colorspace from displaying (thanks @zwaldowski!):
  • https://github.com/Hopding/pdf-lib/pull/415
• Add methods to PDFDocument for reading document metadata (thanks @timKraeuter!):
  • See examples here: https://github.com/Hopding/pdf-lib#read-document-metadata
  • https://github.com/Hopding/pdf-lib/pull/336
  • https://github.com/Hopding/pdf-lib/pull/423

• Fix bug causing parser to fail when parsing empty dictionaries:
  • https://github.com/Hopding/pdf-lib/issues/369
  • https://github.com/Hopding/pdf-lib/pull/370
• Fix bug causing index out of bounds error to be thrown when removing certain pages in certain documents:
  • https://github.com/Hopding/pdf-lib/issues/376
  • https://github.com/Hopding/pdf-lib/pull/378

• Add support for PDF embedding (thanks @tessi!):
  • https://github.com/Hopding/pdf-lib/issues/184
  • https://github.com/Hopding/pdf-lib/pull/348
  • Example
• Add types for older TypeScript versions:
  • https://github.com/Hopding/pdf-lib/issues/308
  • https://github.com/Hopding/pdf-lib/issues/366
  • https://github.com/Hopding/pdf-lib/pull/368