Skip to content

Escape document information when writing XMP metadata - #1819

Open
ac1982 wants to merge 1 commit into
foliojs:masterfrom
ac1982:fix/xmp-info-text
Open

ac1982 wants to merge 1 commit into
foliojs:masterfrom
ac1982:fix/xmp-info-text

Conversation

@ac1982

@ac1982 ac1982 commented Oct 15, 2026

Copy link
Copy Markdown

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 raw appendXML() API retain their existing behavior. A documentation note explains the plain-text input contract and invalid-character handling.

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:

  • Unit Tests
  • Documentation
  • Update CHANGELOG.md
  • Ready to be merged

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

XMP metadata: document info strings are written unescaped (malformed XML)

1 participant