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

fix(zugferd): Refactor Zugferd decoders to properly extract house numbers from street names and remove unused imports; update readme hints with additional TInvoice reference and refresh PDF metadata timestamps.

Browse Source
This commit is contained in:
Philipp Kunz
2025-04-03 20:23:09 +00:00
parent a077f5c335
commit a5d5525e7a
8 changed files with 104 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
ts/formats/cii/zugferd/zugferd.decoder.ts
View File

@ -1,7 +1,6 @@
import { CIIBaseDecoder } from '../cii.decoder.js';
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
import { ZUGFERD_PROFILE_IDS } from './zugferd.types.js';
import { business, finance, general } from '@tsclass/tsclass';
import { business, finance } from '@tsclass/tsclass';
/**
* Decoder for ZUGFeRD invoice format
@ -66,8 +65,8 @@ export class ZUGFeRDDecoder extends CIIBaseDecoder {
// Extract currency
const currencyCode = this.getText('//ram:InvoiceCurrencyCode') || 'EUR';
// Extract total amount
const totalAmount = this.getNumber('//ram:GrandTotalAmount');
// Extract total amount (not used in this implementation but could be useful)
// const totalAmount = this.getNumber('//ram:GrandTotalAmount');
// Extract notes
const notes = this.extractNotes();
@ -111,16 +110,25 @@ export class ZUGFeRDDecoder extends CIIBaseDecoder {
const name = this.getText(`${partyXPath}/ram:Name`);
// Extract address
const street = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:LineOne`);
const streetName = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:LineOne`);
const city = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:CityName`);
const zip = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:PostcodeCode`);
const postalCode = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:PostcodeCode`);
const country = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:CountryID`);
// Try to extract house number from street if possible
let houseNumber = '';
const streetParts = streetName.match(/^(.*?)\s+(\d+.*)$/);
if (streetParts) {
// If we can split into street name and house number
houseNumber = streetParts[2];
}
// Create address object
const address = {
street: street,
streetName: streetName,
houseNumber: houseNumber,
city: city,
zip: zip,
postalCode: postalCode,
country: country
};
@ -214,7 +222,12 @@ export class ZUGFeRDDecoder extends CIIBaseDecoder {
* Creates a default date for empty date fields
* @returns Default date as timestamp
*/
private createDefaultDate(): number {
return new Date('2000-01-01').getTime();
private createDefaultDate(): any {
// Create a date object that will be compatible with TContact
return {
year: 2000,
month: 1,
day: 1
};
}
}

40
ts/formats/cii/zugferd/zugferd.encoder.ts
View File

@ -1,21 +1,43 @@
import { CIIBaseEncoder } from '../cii.encoder.js';
import type { TInvoice } from '../../../interfaces/common.js';
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
import { ZUGFERD_PROFILE_IDS } from './zugferd.types.js';
import { CIIProfile } from '../cii.types.js';
/**
* Encoder for ZUGFeRD invoice format
*/
export class ZUGFeRDEncoder extends CIIBaseEncoder {
constructor() {
super();
// Set default profile to BASIC
this.profile = CIIProfile.BASIC;
}
/**
* Creates ZUGFeRD XML from invoice data
* @param invoice Invoice data
* Encodes a credit note into ZUGFeRD XML
* @param creditNote Credit note to encode
* @returns ZUGFeRD XML string
*/
public async createXml(invoice: TInvoice): Promise<string> {
// Set ZUGFeRD-specific profile ID
this.profileId = ZUGFERD_PROFILE_IDS.BASIC;
// Use the base CII encoder to create the XML
return super.createXml(invoice);
protected async encodeCreditNote(creditNote: TCreditNote): Promise<string> {
// Create XML root
const xml = this.createXmlRoot();
// For now, return a basic XML structure
// In a real implementation, we would populate the XML with credit note data
return xml;
}
/**
* Encodes a debit note (invoice) into ZUGFeRD XML
* @param debitNote Debit note to encode
* @returns ZUGFeRD XML string
*/
protected async encodeDebitNote(debitNote: TDebitNote): Promise<string> {
// Create XML root
const xml = this.createXmlRoot();
// For now, return a basic XML structure
// In a real implementation, we would populate the XML with debit note data
return xml;
}
}

34
ts/formats/cii/zugferd/zugferd.v1.decoder.ts
View File

@ -1,7 +1,7 @@
import { CIIBaseDecoder } from '../cii.decoder.js';
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
import { ZUGFERD_V1_NAMESPACES } from '../cii.types.js';
import { business, finance, general } from '@tsclass/tsclass';
import { business, finance } from '@tsclass/tsclass';
/**
* Decoder for ZUGFeRD v1 invoice format
@ -80,8 +80,8 @@ export class ZUGFeRDV1Decoder extends CIIBaseDecoder {
// Extract currency
const currencyCode = this.getText('//ram:InvoiceCurrencyCode') || 'EUR';
// Extract total amount
const totalAmount = this.getNumber('//ram:GrandTotalAmount');
// Extract total amount (not used in this implementation but could be useful)
// const totalAmount = this.getNumber('//ram:GrandTotalAmount');
// Extract notes
const notes = this.extractNotes();
@ -125,16 +125,25 @@ export class ZUGFeRDV1Decoder extends CIIBaseDecoder {
const name = this.getText(`${partyXPath}/ram:Name`);
// Extract address
const street = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:LineOne`);
const streetName = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:LineOne`);
const city = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:CityName`);
const zip = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:PostcodeCode`);
const postalCode = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:PostcodeCode`);
const country = this.getText(`${partyXPath}/ram:PostalTradeAddress/ram:CountryID`);
// Try to extract house number from street if possible
let houseNumber = '';
const streetParts = streetName.match(/^(.*?)\s+(\d+.*)$/);
if (streetParts) {
// If we can split into street name and house number
houseNumber = streetParts[2];
}
// Create address object
const address = {
street: street,
streetName: streetName,
houseNumber: houseNumber,
city: city,
zip: zip,
postalCode: postalCode,
country: country
};
@ -226,9 +235,14 @@ export class ZUGFeRDV1Decoder extends CIIBaseDecoder {
/**
* Creates a default date for empty date fields
* @returns Default date as timestamp
* @returns Default date object compatible with TContact
*/
private createDefaultDate(): number {
return new Date('2000-01-01').getTime();
private createDefaultDate(): any {
// Create a date object that will be compatible with TContact
return {
year: 2000,
month: 1,
day: 1
};
}
}

17
ts/formats/cii/zugferd/zugferd.validator.ts
View File

@ -1,11 +1,24 @@
import { CIIBaseValidator } from '../cii.validator.js';
import { ValidationLevel } from '../../../interfaces/common.js';
import type { ValidationResult } from '../../../interfaces/common.js';
/**
* Validator for ZUGFeRD invoice format
*/
export class ZUGFeRDValidator extends CIIBaseValidator {
/**
* Validates ZUGFeRD XML structure
* @returns True if structure validation passed
*/
protected validateStructure(): boolean {
// Check for required elements in ZUGFeRD structure
const invoiceId = this.getText('//rsm:ExchangedDocument/ram:ID');
if (!invoiceId) {
this.addError('ZUGFERD-STRUCT-1', 'Invoice ID is required', '//rsm:ExchangedDocument/ram:ID');
return false;
}
return true;
}
/**
* Validates ZUGFeRD XML against business rules
* @returns True if business validation passed