feat(encoder): Rename encoder class from ZugferdXmlEncoder to FacturXEncoder to better reflect Factur-X compliance. All related imports, exports, and tests have been updated while maintaining backward compatibility.

2025-03-17 15:18:33 +00:00
parent f07f81c585
commit cdf4179613
10 changed files with 687 additions and 36 deletions
--- a/ts/classes.decoder.ts
+++ b/ts/classes.decoder.ts
@ -1,7 +1,8 @@
 import * as plugins from './plugins.js';
+import * as xmldom from 'xmldom';

 /**
- * A class to convert a given ZUGFeRD XML string
+ * A class to convert a given XML string (ZUGFeRD/Factur-X, UBL or fatturaPA)
 * into a structured ILetter with invoice data.
 * 
 * Handles different invoice XML formats:
@ -12,6 +13,7 @@ import * as plugins from './plugins.js';
 export class ZUGFeRDXmlDecoder {
  private xmlString: string;
  private xmlFormat: string;
+  private xmlDoc: Document | null = null;

  constructor(xmlString: string) {
    if (!xmlString) {
@ -22,6 +24,14 @@ export class ZUGFeRDXmlDecoder {
    
    // Simple format detection based on string contents
    this.xmlFormat = this.detectFormat();
+    
+    // Parse XML to DOM
+    try {
+      const parser = new xmldom.DOMParser();
+      this.xmlDoc = parser.parseFromString(this.xmlString, 'text/xml');
+    } catch (error) {
+      console.error('Error parsing XML:', error);
+    }
  }

  /**
@ -51,14 +61,62 @@ export class ZUGFeRDXmlDecoder {
    return 'unknown';
  }

+  /**
+   * Extracts text from the first element matching the XPath-like selector
+   */
+  private getElementText(tagName: string): string {
+    if (!this.xmlDoc) {
+      return '';
+    }
+    
+    try {
+      // Basic handling for namespaced tags
+      let namespace = '';
+      let localName = tagName;
+      
+      if (tagName.includes(':')) {
+        const parts = tagName.split(':');
+        namespace = parts[0];
+        localName = parts[1];
+      }
+      
+      // Find all elements with this name
+      const elements = this.xmlDoc.getElementsByTagName(tagName);
+      if (elements.length > 0) {
+        return elements[0].textContent || '';
+      }
+      
+      // Try with just the local name if we didn't find it with the namespace
+      if (namespace) {
+        const elements = this.xmlDoc.getElementsByTagName(localName);
+        if (elements.length > 0) {
+          return elements[0].textContent || '';
+        }
+      }
+      
+      return '';
+    } catch (error) {
+      console.error(`Error extracting element ${tagName}:`, error);
+      return '';
+    }
+  }
+
  /**
   * Converts XML to a structured letter object
   */
  public async getLetterData(): Promise<plugins.tsclass.business.ILetter> {
    try {
-      // Try using SmartXml from plugins as a fallback
-      const smartxmlInstance = new plugins.smartxml.SmartXml();
-      return smartxmlInstance.parseXmlToObject(this.xmlString);
+      if (this.xmlFormat === 'CII') {
+        return this.parseCII();
+      } else if (this.xmlFormat === 'UBL') {
+        // For now, use the default implementation
+        return this.parseGeneric();
+      } else if (this.xmlFormat === 'FatturaPA') {
+        // For now, use the default implementation
+        return this.parseGeneric();
+      } else {
+        return this.parseGeneric();
+      }
    } catch (error) {
      console.error('Error converting XML to letter data:', error);
      
@ -67,6 +125,138 @@ export class ZUGFeRDXmlDecoder {
    }
  }
  
+  /**
+   * Parse CII (ZUGFeRD/Factur-X) formatted XML
+   */
+  private parseCII(): plugins.tsclass.business.ILetter {
+    // Extract invoice ID
+    let invoiceId = this.getElementText('ram:ID');
+    if (!invoiceId) {
+      // Try alternative locations
+      invoiceId = this.getElementText('rsm:ExchangedDocument ram:ID') || 'Unknown';
+    }
+    
+    // Extract seller name
+    let sellerName = this.getElementText('ram:Name');
+    if (!sellerName) {
+      sellerName = this.getElementText('ram:SellerTradeParty ram:Name') || 'Unknown Seller';
+    }
+    
+    // Extract buyer name
+    let buyerName = '';
+    // Try to find BuyerTradeParty Name specifically
+    if (this.xmlDoc) {
+      const buyerParties = this.xmlDoc.getElementsByTagName('ram:BuyerTradeParty');
+      if (buyerParties.length > 0) {
+        const nameElements = buyerParties[0].getElementsByTagName('ram:Name');
+        if (nameElements.length > 0) {
+          buyerName = nameElements[0].textContent || '';
+        }
+      }
+    }
+    
+    if (!buyerName) {
+      buyerName = 'Unknown Buyer';
+    }
+    
+    // Create seller
+    const seller: plugins.tsclass.business.IContact = {
+      name: sellerName,
+      type: 'company',
+      description: sellerName,
+      address: {
+        streetName: this.getElementText('ram:LineOne') || 'Unknown',
+        houseNumber: '0',  // Required by IAddress interface
+        city: this.getElementText('ram:CityName') || 'Unknown',
+        country: this.getElementText('ram:CountryID') || 'Unknown',
+        postalCode: this.getElementText('ram:PostcodeCode') || 'Unknown',
+      },
+    };
+    
+    // Create buyer
+    const buyer: plugins.tsclass.business.IContact = {
+      name: buyerName,
+      type: 'company',
+      description: buyerName,
+      address: {
+        streetName: 'Unknown',
+        houseNumber: '0',
+        city: 'Unknown',
+        country: 'Unknown',
+        postalCode: 'Unknown',
+      },
+    };
+    
+    // Extract invoice type
+    let invoiceType = 'debitnote';
+    const typeCode = this.getElementText('ram:TypeCode');
+    if (typeCode === '381') {
+      invoiceType = 'creditnote';
+    }
+    
+    // Create invoice data
+    const invoiceData: plugins.tsclass.finance.IInvoice = {
+      id: invoiceId,
+      status: null,
+      type: invoiceType as 'debitnote' | 'creditnote',
+      billedBy: seller,
+      billedTo: buyer,
+      deliveryDate: Date.now(),
+      dueInDays: 30,
+      periodOfPerformance: null,
+      printResult: null,
+      currency: (this.getElementText('ram:InvoiceCurrencyCode') || 'EUR') as plugins.tsclass.finance.TCurrency,
+      notes: [],
+      items: [
+        {
+          name: 'Item from XML',
+          unitQuantity: 1,
+          unitNetPrice: 0,
+          vatPercentage: 0,
+          position: 0,
+          unitType: 'units',
+        }
+      ],
+      reverseCharge: false,
+    };
+    
+    // Return a letter
+    return {
+      versionInfo: {
+        type: 'draft',
+        version: '1.0.0',
+      },
+      type: 'invoice',
+      date: Date.now(),
+      subject: `Invoice: ${invoiceId}`,
+      from: seller,
+      to: buyer,
+      content: {
+        invoiceData: invoiceData,
+        textData: null,
+        timesheetData: null,
+        contractData: null,
+      },
+      needsCoverSheet: false,
+      objectActions: [],
+      pdf: null,
+      incidenceId: null,
+      language: null,
+      legalContact: null,
+      logoUrl: null,
+      pdfAttachments: null,
+      accentColor: null,
+    };
+  }
+  
+  /**
+   * Parse generic XML using default approach
+   */
+  private parseGeneric(): plugins.tsclass.business.ILetter {
+    // Create a default letter with some extraction attempts
+    return this.createDefaultLetter();
+  }
+  
  /**
   * Creates a default letter object with minimal data
   */
@ -75,8 +265,10 @@ export class ZUGFeRDXmlDecoder {
    const seller: plugins.tsclass.business.IContact = {
      name: 'Unknown Seller',
      type: 'company',
+      description: 'Unknown Seller',  // Required by IContact interface
      address: {
        streetName: 'Unknown',
+        houseNumber: '0',  // Required by IAddress interface
        city: 'Unknown',
        country: 'Unknown',
        postalCode: 'Unknown',
@ -87,8 +279,10 @@ export class ZUGFeRDXmlDecoder {
    const buyer: plugins.tsclass.business.IContact = {
      name: 'Unknown Buyer',
      type: 'company',
+      description: 'Unknown Buyer',  // Required by IContact interface
      address: {
        streetName: 'Unknown',
+        houseNumber: '0',  // Required by IAddress interface
        city: 'Unknown',
        country: 'Unknown',
        postalCode: 'Unknown',
@ -96,17 +290,17 @@ export class ZUGFeRDXmlDecoder {
    };
    
    // Create default invoice data
-    const invoiceData: plugins.tsclass.business.IInvoiceData = {
+    const invoiceData: plugins.tsclass.finance.IInvoice = {
      id: 'Unknown',
      status: null,
-      type: 'invoice',
+      type: 'debitnote',
      billedBy: seller,
      billedTo: buyer,
      deliveryDate: Date.now(),
      dueInDays: 30,
      periodOfPerformance: null,
      printResult: null,
-      currency: 'EUR',
+      currency: 'EUR' as plugins.tsclass.finance.TCurrency,
      notes: [],
      items: [
        {
@ -124,7 +318,7 @@ export class ZUGFeRDXmlDecoder {
    // Return a default letter
    return {
      versionInfo: {
-        type: 'extracted',
+        type: 'draft',
        version: '1.0.0',
      },
      type: 'invoice',