einvoice/test/suite/einvoice_pdf-operations/test.pdf-07.metadata-preservation.ts
2025-05-25 19:45:37 +00:00

412 lines
14 KiB
TypeScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as plugins from '../plugins.js';
import { EInvoice } from '../../../ts/index.js';
import { CorpusLoader } from '../corpus.loader.js';
import { PerformanceTracker } from '../performance.tracker.js';
tap.test('PDF-07: Metadata Preservation - should preserve PDF metadata during operations', async (t) => {
// PDF-07: Verify PDF metadata is preserved when embedding/extracting XML
// This test ensures document properties and metadata remain intact
const performanceTracker = new PerformanceTracker('PDF-07: Metadata Preservation');
const corpusLoader = new CorpusLoader();
t.test('Preserve standard PDF metadata', async () => {
const startTime = performance.now();
const { PDFDocument } = plugins;
const pdfDoc = await PDFDocument.create();
// Set comprehensive metadata
const metadata = {
title: 'Test Invoice 2025-001',
author: 'Invoice System v3.0',
subject: 'Monthly Invoice for Services',
keywords: ['invoice', 'zugferd', 'factur-x', 'electronic', 'billing'],
creator: 'EInvoice Library',
producer: 'PDFLib Test Suite',
creationDate: new Date('2025-01-01T10:00:00Z'),
modificationDate: new Date('2025-01-25T14:30:00Z')
};
pdfDoc.setTitle(metadata.title);
pdfDoc.setAuthor(metadata.author);
pdfDoc.setSubject(metadata.subject);
pdfDoc.setKeywords(metadata.keywords);
pdfDoc.setCreator(metadata.creator);
pdfDoc.setProducer(metadata.producer);
pdfDoc.setCreationDate(metadata.creationDate);
pdfDoc.setModificationDate(metadata.modificationDate);
// Add content
const page = pdfDoc.addPage([595, 842]);
page.drawText('Invoice with Metadata', { x: 50, y: 750, size: 20 });
// Add invoice XML
const xmlContent = `<?xml version="1.0" encoding="UTF-8"?>
<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">
<ID>METADATA-TEST-001</ID>
<IssueDate>2025-01-25</IssueDate>
<DocumentCurrencyCode>EUR</DocumentCurrencyCode>
</Invoice>`;
await pdfDoc.attach(
Buffer.from(xmlContent, 'utf8'),
'invoice.xml',
{
mimeType: 'application/xml',
description: 'Invoice XML data',
afRelationship: plugins.AFRelationship.Data
}
);
const originalPdfBytes = await pdfDoc.save();
// Load into EInvoice and process
const einvoice = new EInvoice();
await einvoice.loadFromPdfBuffer(originalPdfBytes);
// Get back as PDF (if supported)
try {
const processedPdf = await einvoice.getPdfBuffer();
// Load processed PDF and check metadata
const processedDoc = await PDFDocument.load(processedPdf);
expect(processedDoc.getTitle()).toBe(metadata.title);
expect(processedDoc.getAuthor()).toBe(metadata.author);
expect(processedDoc.getSubject()).toBe(metadata.subject);
expect(processedDoc.getKeywords()).toBe(metadata.keywords.join(', '));
expect(processedDoc.getCreator()).toBe(metadata.creator);
console.log('All metadata preserved successfully');
} catch (error) {
console.log('PDF metadata preservation not fully supported:', error.message);
}
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('standard-metadata', elapsed);
});
t.test('Preserve custom metadata properties', async () => {
const startTime = performance.now();
const { PDFDocument, PDFDict, PDFName, PDFString } = plugins;
const pdfDoc = await PDFDocument.create();
// Add standard content
const page = pdfDoc.addPage();
page.drawText('Custom Metadata Test', { x: 50, y: 700, size: 16 });
// Access the info dictionary for custom properties
const infoDict = pdfDoc.context.trailerInfo.Info;
if (infoDict instanceof PDFDict) {
// Add custom metadata fields
infoDict.set(PDFName.of('InvoiceNumber'), PDFString.of('INV-2025-001'));
infoDict.set(PDFName.of('InvoiceDate'), PDFString.of('2025-01-25'));
infoDict.set(PDFName.of('CustomerID'), PDFString.of('CUST-12345'));
infoDict.set(PDFName.of('InvoiceType'), PDFString.of('ZUGFeRD 2.1'));
infoDict.set(PDFName.of('PaymentTerms'), PDFString.of('Net 30 days'));
infoDict.set(PDFName.of('TaxRate'), PDFString.of('19%'));
}
// Add XML attachment
const xmlContent = `<?xml version="1.0" encoding="UTF-8"?>
<Invoice>
<ID>INV-2025-001</ID>
<CustomerID>CUST-12345</CustomerID>
</Invoice>`;
await pdfDoc.attach(
Buffer.from(xmlContent, 'utf8'),
'invoice.xml',
{
mimeType: 'application/xml',
description: 'Invoice data with custom metadata'
}
);
const pdfBytes = await pdfDoc.save();
// Check if custom metadata is readable
const loadedDoc = await PDFDocument.load(pdfBytes);
const loadedInfo = loadedDoc.context.trailerInfo.Info;
if (loadedInfo instanceof PDFDict) {
const invoiceNum = loadedInfo.get(PDFName.of('InvoiceNumber'));
console.log('Custom metadata preserved in PDF');
}
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('custom-metadata', elapsed);
});
t.test('XMP metadata preservation', async () => {
const startTime = performance.now();
const { PDFDocument } = plugins;
// Create XMP metadata
const xmpMetadata = `<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
<x:xmpmeta xmlns:x="adobe:ns:meta/">
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description rdf:about=""
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:pdf="http://ns.adobe.com/pdf/1.3/"
xmlns:xmp="http://ns.adobe.com/xap/1.0/"
xmlns:fx="urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#">
<dc:title>
<rdf:Alt>
<rdf:li xml:lang="x-default">Electronic Invoice</rdf:li>
</rdf:Alt>
</dc:title>
<dc:creator>
<rdf:Seq>
<rdf:li>EInvoice System</rdf:li>
</rdf:Seq>
</dc:creator>
<dc:description>
<rdf:Alt>
<rdf:li xml:lang="x-default">ZUGFeRD 2.1 compliant invoice</rdf:li>
</rdf:Alt>
</dc:description>
<pdf:Producer>EInvoice Library with PDFLib</pdf:Producer>
<xmp:CreateDate>2025-01-25T10:00:00Z</xmp:CreateDate>
<xmp:ModifyDate>2025-01-25T14:30:00Z</xmp:ModifyDate>
<fx:DocumentType>INVOICE</fx:DocumentType>
<fx:DocumentFileName>invoice.xml</fx:DocumentFileName>
<fx:Version>2.1</fx:Version>
<fx:ConformanceLevel>EXTENDED</fx:ConformanceLevel>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
<?xpacket end="w"?>`;
const pdfDoc = await PDFDocument.create();
// Note: pdf-lib doesn't directly support XMP metadata
// This would require a more advanced PDF library
console.log('XMP metadata test - requires advanced PDF library support');
// Add basic content
const page = pdfDoc.addPage();
page.drawText('XMP Metadata Test', { x: 50, y: 700, size: 16 });
const pdfBytes = await pdfDoc.save();
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('xmp-metadata', elapsed);
});
t.test('Metadata during format conversion', async () => {
const startTime = performance.now();
// Test metadata preservation during invoice format conversion
const xmlContent = `<?xml version="1.0" encoding="UTF-8"?>
<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">
<UBLVersionID>2.1</UBLVersionID>
<ID>META-CONV-001</ID>
<IssueDate>2025-01-25</IssueDate>
<Note>Invoice with metadata for conversion test</Note>
<DocumentCurrencyCode>EUR</DocumentCurrencyCode>
<AccountingSupplierParty>
<Party>
<PartyName>
<Name>Test Supplier GmbH</Name>
</PartyName>
</Party>
</AccountingSupplierParty>
</Invoice>`;
const { PDFDocument } = plugins;
const pdfDoc = await PDFDocument.create();
// Set metadata that should be preserved
pdfDoc.setTitle('Conversion Test Invoice');
pdfDoc.setAuthor('Metadata Test Suite');
pdfDoc.setSubject('Testing metadata preservation during conversion');
pdfDoc.setKeywords(['conversion', 'metadata', 'test']);
pdfDoc.setCreationDate(new Date('2025-01-20T09:00:00Z'));
const page = pdfDoc.addPage();
page.drawText('Metadata Conversion Test', { x: 50, y: 700, size: 16 });
await pdfDoc.attach(
Buffer.from(xmlContent, 'utf8'),
'invoice.xml',
{
mimeType: 'application/xml',
description: 'Invoice for metadata conversion test'
}
);
const pdfBytes = await pdfDoc.save();
// Test preservation through EInvoice processing
const einvoice = new EInvoice();
await einvoice.loadFromPdfBuffer(pdfBytes);
// Check if we can still access the metadata
console.log('Metadata conversion test completed');
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('conversion-metadata', elapsed);
});
t.test('Language and locale metadata', async () => {
const startTime = performance.now();
const { PDFDocument } = plugins;
const pdfDoc = await PDFDocument.create();
// Set language-specific metadata
pdfDoc.setTitle('Rechnung Nr. 2025-001');
pdfDoc.setAuthor('Rechnungssystem v3.0');
pdfDoc.setSubject('Monatliche Rechnung für Dienstleistungen');
pdfDoc.setKeywords(['Rechnung', 'ZUGFeRD', 'elektronisch', 'Deutschland']);
pdfDoc.setLanguage('de-DE'); // German language tag
const page = pdfDoc.addPage();
page.drawText('Deutsche Rechnung', { x: 50, y: 700, size: 20 });
// Add German invoice XML
const xmlContent = `<?xml version="1.0" encoding="UTF-8"?>
<rsm:CrossIndustryInvoice xmlns:rsm="urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100">
<rsm:ExchangedDocument>
<ram:ID xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100">RECHNUNG-2025-001</ram:ID>
<ram:Name xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100">Rechnung</ram:Name>
<ram:LanguageID xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100">de</ram:LanguageID>
</rsm:ExchangedDocument>
</rsm:CrossIndustryInvoice>`;
await pdfDoc.attach(
Buffer.from(xmlContent, 'utf8'),
'rechnung.xml',
{
mimeType: 'application/xml',
description: 'Deutsche Rechnungsdaten'
}
);
const pdfBytes = await pdfDoc.save();
expect(pdfBytes.length).toBeGreaterThan(0);
console.log('Language metadata test completed');
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('language-metadata', elapsed);
});
t.test('Corpus metadata analysis', async () => {
const startTime = performance.now();
let metadataCount = 0;
let processedCount = 0;
const metadataTypes = {
title: 0,
author: 0,
subject: 0,
keywords: 0,
creator: 0,
producer: 0
};
const files = await corpusLoader.getAllFiles();
const pdfFiles = files.filter(f => f.endsWith('.pdf'));
// Sample PDFs for metadata analysis
const sampleSize = Math.min(40, pdfFiles.length);
const sample = pdfFiles.slice(0, sampleSize);
for (const file of sample) {
try {
const content = await corpusLoader.readFile(file);
const { PDFDocument } = plugins;
try {
const pdfDoc = await PDFDocument.load(content);
// Check for metadata
const title = pdfDoc.getTitle();
const author = pdfDoc.getAuthor();
const subject = pdfDoc.getSubject();
const keywords = pdfDoc.getKeywords();
const creator = pdfDoc.getCreator();
const producer = pdfDoc.getProducer();
if (title || author || subject || keywords || creator || producer) {
metadataCount++;
if (title) metadataTypes.title++;
if (author) metadataTypes.author++;
if (subject) metadataTypes.subject++;
if (keywords) metadataTypes.keywords++;
if (creator) metadataTypes.creator++;
if (producer) metadataTypes.producer++;
}
processedCount++;
} catch (error) {
// Skip PDFs that can't be loaded
}
} catch (error) {
console.log(`Error reading ${file}:`, error.message);
}
}
console.log(`Corpus metadata analysis (${processedCount} PDFs):`);
console.log(`- PDFs with metadata: ${metadataCount}`);
console.log('Metadata field frequency:', metadataTypes);
expect(processedCount).toBeGreaterThan(0);
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('corpus-metadata', elapsed);
});
t.test('Metadata size and encoding', async () => {
const startTime = performance.now();
const { PDFDocument } = plugins;
const pdfDoc = await PDFDocument.create();
// Test with very long metadata values
const longTitle = 'Invoice ' + 'Document '.repeat(50) + 'Title';
const longKeywords = Array(100).fill('keyword').map((k, i) => `${k}${i}`);
const longSubject = 'This is a very detailed subject line that describes the invoice document in great detail. '.repeat(5);
pdfDoc.setTitle(longTitle.substring(0, 255)); // PDF might have limits
pdfDoc.setKeywords(longKeywords.slice(0, 50)); // Reasonable limit
pdfDoc.setSubject(longSubject.substring(0, 500));
// Test special characters in metadata
pdfDoc.setAuthor('Müller & Associés S.à r.l.');
pdfDoc.setCreator('System © 2025 • München');
const page = pdfDoc.addPage();
page.drawText('Metadata Size Test', { x: 50, y: 700, size: 16 });
const pdfBytes = await pdfDoc.save();
// Verify metadata was set
const loadedDoc = await PDFDocument.load(pdfBytes);
const loadedTitle = loadedDoc.getTitle();
const loadedAuthor = loadedDoc.getAuthor();
expect(loadedTitle).toBeTruthy();
expect(loadedAuthor).toContain('Müller');
console.log('Metadata size and encoding test completed');
const elapsed = performance.now() - startTime;
performanceTracker.addMeasurement('metadata-size', elapsed);
});
// Print performance summary
performanceTracker.printSummary();
// Performance assertions
const avgTime = performanceTracker.getAverageTime();
expect(avgTime).toBeLessThan(300); // Metadata operations should be fast
});
tap.start();