Repository navigation
Escape document information when writing XMP metadata - #1819
Merged
Merged
Conversation
blikblum
requested changes
Oct 18, 2026
Comment on lines
+300
to
+303
| Pass metadata as plain text; PDFKit escapes it when writing XML (XMP) metadata. | ||
| Characters that XML 1.0 cannot represent are omitted from XMP. The original | ||
| values in `doc.info` and the PDF Info dictionary are not changed. | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| Pass metadata as plain text; PDFKit escapes it when writing XML (XMP) metadata. | |
| Characters that XML 1.0 cannot represent are omitted from XMP. The original | |
| values in `doc.info` and the PDF Info dictionary are not changed. |
Not needed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Fixes #1817. Metadata such as
Title: 'R&D <draft>'is now escaped when copied into XMP, so it remains XML text. This covers Title, Author, Subject, Keywords, Creator and Producer, preserves valid Unicode/whitespace, and omits characters XML 1.0 cannot represent.Escaping happens at the text interpolation boundary.
doc.info, the PDF Info dictionary and the explicitly rawappendXML()API retain their existing behavior.Validation: 561 tests pass, including visual regressions; 53 tool tests pass; build, CJS/ESM package checks, lint and changed-file formatting pass. The new tests fail 10/11 on the original base and pass 11/11 after the fix. They cover all six fields, updates before
end(), custom XML, PDF 1.3 and PDF/A/UA metadata structures. Built Node output was parsed with PDF.js and a strict XML parser; Chromium and Firefox generated and parsed browser PDFs with all six fields preserved. Full PDF/A or PDF/UA conformance validation was not run.Implemented and validated with OpenAI Codex assistance.
Checklist:
Review follow-up (2026-10-19): removed the requested guide paragraph and reconciled the changelog with current master. The merged tree passes all 576 tests and lint; original XML behavior and tests are unchanged.