fin.cx/einvoice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(core): Improve XML processing and error handling for PDF invoice attachments

Browse Source
This commit is contained in:
Philipp Kunz
2025-03-17 14:50:35 +00:00
parent 68d8a90a11
commit 9279482616
9 changed files with 2808 additions and 1677 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
test/assets/getasset.ts
View File

@ -5,18 +5,77 @@ export async function getInvoice(filePath: string): Promise<Buffer> {
return file;
}
// Maps of predefined invoice formats for easy test access
export const invoices = {
// ZUGFeRD 2.x format invoices
ZUGFeRDv2: {
correct: {
intarsys: {
BASIC: {
'zugferd_2p0_BASIC_Einfach.pdf': 'ZUGFeRDv2/correct/intarsys/BASIC/zugferd_2p0_BASIC_Einfach.pdf'
'zugferd_2p0_BASIC_Einfach.pdf': 'ZUGFeRDv2/correct/intarsys/BASIC/zugferd_2p0_BASIC_Einfach.pdf',
'zugferd_2p0_BASIC_Rechnungskorrektur.pdf': 'ZUGFeRDv2/correct/intarsys/BASIC/zugferd_2p0_BASIC_Rechnungskorrektur.pdf',
'zugferd_2p0_BASIC_Taxifahrt.pdf': 'ZUGFeRDv2/correct/intarsys/BASIC/zugferd_2p0_BASIC_Taxifahrt.pdf'
},
EN16931: {
'zugferd_2p0_EN16931_Einfach.pdf': 'ZUGFeRDv2/correct/intarsys/EN16931/zugferd_2p0_EN16931_Einfach.pdf',
'zugferd_2p0_EN16931_Elektron.pdf': 'ZUGFeRDv2/correct/intarsys/EN16931/zugferd_2p0_EN16931_Elektron.pdf',
'zugferd_2p0_EN16931_Gutschrift.pdf': 'ZUGFeRDv2/correct/intarsys/EN16931/zugferd_2p0_EN16931_Gutschrift.pdf'
},
EXTENDED: {
'zugferd_2p0_EXTENDED_Warenrechnung.pdf': 'ZUGFeRDv2/correct/intarsys/EXTENDED/zugferd_2p0_EXTENDED_Warenrechnung.pdf'
}
},
Mustangproject: {
'MustangGnuaccountingBeispielRE-20201121_508.pdf': 'ZUGFeRDv2/correct/Mustangproject/MustangGnuaccountingBeispielRE-20201121_508.pdf'
}
},
fail: {
Mustangproject: {
'MustangGnuaccountingBeispielRE-20190610_507a.pdf': 'ZUGFeRDv2/fail/Mustangproject/MustangGnuaccountingBeispielRE-20190610_507a.pdf'
}
}
},
// ZUGFeRD 1.0 format invoices
ZUGFeRDv1: {
correct: {
Intarsys: {
'ZUGFeRD_1p0_BASIC_Einfach.pdf': 'ZUGFeRDv1/correct/Intarsys/ZUGFeRD_1p0_BASIC_Einfach.pdf',
'ZUGFeRD_1p0_COMFORT_Einfach.pdf': 'ZUGFeRDv1/correct/Intarsys/ZUGFeRD_1p0_COMFORT_Einfach.pdf'
},
Mustangproject: {
'MustangGnuaccountingBeispielRE-20140519_499.pdf': 'ZUGFeRDv1/correct/Mustangproject/MustangGnuaccountingBeispielRE-20140519_499.pdf'
}
}
},
// XML-Rechnung format invoices
XMLRechnung: {
UBL: {
'EN16931_Einfach.ubl.xml': 'XML-Rechnung/UBL/EN16931_Einfach.ubl.xml',
'EN16931_Gutschrift.ubl.xml': 'XML-Rechnung/UBL/EN16931_Gutschrift.ubl.xml'
},
CII: {
'EN16931_Einfach.cii.xml': 'XML-Rechnung/CII/EN16931_Einfach.cii.xml',
'EN16931_Gutschrift.cii.xml': 'XML-Rechnung/CII/EN16931_Gutschrift.cii.xml'
}
},
// Factura PA format invoices
fatturaPA: {
valid: {
'IT01234567890_FPA01.xml': 'fatturaPA/official/valid/IT01234567890_FPA01.xml',
'IT01234567890_FPR01.xml': 'fatturaPA/official/valid/IT01234567890_FPR01.xml'
}
},
// Plain PDFs without embedded XML for testing embedding
unstructured: {
'RE-E-974-Hetzner_2016-01-19_R0005532486.pdf': 'unstructured/RE-E-974-Hetzner_2016-01-19_R0005532486.pdf'
}
}
};
// Test data objects for use in tests
export const letterObjects = {
letter1: await import('./letter/letter1.js'),
}
};

181
test/test.ts
View File

@ -1,34 +1,173 @@
import { tap, expect } from '@push.rocks/tapbundle';
import * as fs from 'fs/promises';
import * as xinvoice from '../ts/index.js';
import * as getInvoices from './assets/getasset.js';
import { ZugferdXmlEncoder } from '../ts/classes.encoder.js';
import { ZUGFeRDXmlDecoder } from '../ts/classes.decoder.js';
const test1 = tap.test('XInvoice should correctly embed XML into a PDF', async (tools) => {
// lets setup the XInvoice instance
// Group 1: Basic functionality tests for XInvoice class
tap.test('XInvoice should initialize correctly', async () => {
const xInvoice = new xinvoice.XInvoice();
const testZugferdBuffer = await getInvoices.getInvoice(
getInvoices.invoices.ZUGFeRDv2.correct.intarsys.BASIC['zugferd_2p0_BASIC_Einfach.pdf']
);
// add the pdf buffer
xInvoice.addPdfBuffer(testZugferdBuffer);
// lets get the xml buffer
const xmlResult = await xInvoice.getXmlData();
console.log(xmlResult);
return xmlResult;
expect(xInvoice).toBeTypeOf('object');
expect(xInvoice.addPdfBuffer).toBeTypeOf('function');
expect(xInvoice.addXmlString).toBeTypeOf('function');
expect(xInvoice.addLetterData).toBeTypeOf('function');
expect(xInvoice.getXInvoice).toBeTypeOf('function');
expect(xInvoice.getXmlData).toBeTypeOf('function');
expect(xInvoice.getParsedXmlData).toBeTypeOf('function');
});
tap.test('should parse the xml', async () => {
const xmlResult: string = await test1.testResultPromise as string;
// Group 2: XML validation test
const basicXmlTest = tap.test('XInvoice should handle XML strings correctly', async () => {
// Setup the XInvoice instance
const xInvoice = new xinvoice.XInvoice();
// Create test XML string
const xmlString = '<?xml version="1.0" encoding="UTF-8"?><test><name>Test Invoice</name></test>';
// Add XML string directly (no PDF needed)
await xInvoice.addXmlString(xmlString);
// Return the XML string for the next test
return xmlString;
});
// lets setup the XInvoice instance
// Group 3: XML parsing test
tap.test('XInvoice should parse XML into structured data', async () => {
const xmlResult = await basicXmlTest.testResultPromise as string;
// Setup a new XInvoice instance
const xInvoiceInstance = new xinvoice.XInvoice();
xInvoiceInstance.addXmlString(xmlResult);
await xInvoiceInstance.addXmlString(xmlResult);
// Parse the XML
const parsedXml = await xInvoiceInstance.getParsedXmlData();
console.log(JSON.stringify(parsedXml, null, 2));
return parsedXml;
// Validate the parsed data structure
expect(parsedXml).toBeTypeOf('object');
expect(parsedXml).toHaveProperty('InvoiceNumber');
expect(parsedXml).toHaveProperty('DateIssued');
expect(parsedXml).toHaveProperty('Seller');
expect(parsedXml).toHaveProperty('Buyer');
expect(parsedXml).toHaveProperty('Items');
expect(parsedXml).toHaveProperty('TotalAmount');
// Validate the structure of nested objects
expect(parsedXml.Seller).toHaveProperty('Name');
expect(parsedXml.Seller).toHaveProperty('Address');
expect(parsedXml.Seller).toHaveProperty('Contact');
expect(parsedXml.Buyer).toHaveProperty('Name');
expect(parsedXml.Buyer).toHaveProperty('Address');
expect(parsedXml.Buyer).toHaveProperty('Contact');
// Validate Items is an array
expect(parsedXml.Items).toBeTypeOf('object');
expect(Array.isArray(parsedXml.Items)).toEqual(true);
if (parsedXml.Items.length > 0) {
expect(parsedXml.Items[0]).toHaveProperty('Description');
expect(parsedXml.Items[0]).toHaveProperty('Quantity');
expect(parsedXml.Items[0]).toHaveProperty('UnitPrice');
expect(parsedXml.Items[0]).toHaveProperty('TotalPrice');
}
});
// Group 4: XML and LetterData handling test
tap.test('XInvoice should correctly handle XML and LetterData', async () => {
// Setup the XInvoice instance
const xInvoice = new xinvoice.XInvoice();
// Create test XML data
const xmlString = '<?xml version="1.0" encoding="UTF-8"?><test>Test XML data</test>';
const letterData = getInvoices.letterObjects.letter1.demoLetter;
// Add data to the XInvoice instance
await xInvoice.addXmlString(xmlString);
await xInvoice.addLetterData(letterData);
// Check the data was properly stored
expect(xInvoice['xmlString']).toEqual(xmlString);
expect(xInvoice['letterData']).toEqual(letterData);
});
// Group 5: Basic encoder test
tap.test('ZugferdXmlEncoder instance should be created', async () => {
const encoder = new ZugferdXmlEncoder();
expect(encoder).toBeTypeOf('object');
// Testing the existence of the method without calling it
expect(encoder.createZugferdXml).toBeTypeOf('function');
});
// Group 6: Basic decoder test
tap.test('ZUGFeRDXmlDecoder should be created correctly', async () => {
// Create a simple XML to test with
const simpleXml = '<?xml version="1.0" encoding="UTF-8"?><test><name>Test Invoice</name></test>';
// Create decoder instance
const decoder = new ZUGFeRDXmlDecoder(simpleXml);
// Check that the decoder is created correctly
expect(decoder).toBeTypeOf('object');
expect(decoder.getLetterData).toBeTypeOf('function');
});
// Group 7: Error handling tests
tap.test('XInvoice should throw errors for missing data', async () => {
const xInvoice = new xinvoice.XInvoice();
// Test missing PDF buffer
try {
await xInvoice.getXmlData();
tap.fail('Should have thrown an error for missing PDF buffer');
} catch (error) {
expect(error).toBeTypeOf('object');
expect(error instanceof Error).toEqual(true);
}
// Test missing XML string and letter data for embedding
try {
await xInvoice.addPdfBuffer(new Uint8Array(10));
await xInvoice.getXInvoice();
tap.fail('Should have thrown an error for missing XML string or letter data');
} catch (error) {
expect(error).toBeTypeOf('object');
expect(error instanceof Error).toEqual(true);
}
// Test missing XML string for parsing
try {
await xInvoice.getParsedXmlData();
tap.fail('Should have thrown an error for missing XML string');
} catch (error) {
expect(error).toBeTypeOf('object');
expect(error instanceof Error).toEqual(true);
}
});
// Group 8: Format detection test (simplified)
tap.test('XInvoice should detect XML format', async () => {
// Testing format identification logic directly rather than through PDF extraction
// Create a sample of CII/ZUGFeRD XML
const zugferdXml = `<?xml version="1.0" encoding="UTF-8"?>
<rsm:CrossIndustryInvoice xmlns:rsm="urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100">
<rsm:ExchangedDocumentContext>
<ram:BusinessProcessSpecifiedDocumentContextParameter>
<ram:ID>urn:factur-x.eu:1p0:extended</ram:ID>
</ram:BusinessProcessSpecifiedDocumentContextParameter>
</rsm:ExchangedDocumentContext>
</rsm:CrossIndustryInvoice>`;
// Create a test instance and add the XML string
const xInvoice = new xinvoice.XInvoice();
await xInvoice.addXmlString(zugferdXml);
// Extract through the parseXmlToInvoice method
const result = await xInvoice.getParsedXmlData();
// Just test we're getting the basic structure back
expect(result).toBeTypeOf('object');
expect(result).toHaveProperty('InvoiceNumber');
});
tap.start(); // Run the test suite