@fin.cx/einvoice 5.0.3 → 5.1.3

package/readme.md

@@ -1,23 +1,28 @@
-# @fin.cx/einvoice
+# @fin.cx/einvoice 🚀
 
-A comprehensive TypeScript library for creating, manipulating, and embedding XML invoice data within PDF files, supporting multiple European electronic invoice standards including ZUGFeRD (v1 & v2), Factur-X, XRechnung, UBL, and FatturaPA.
+**The Ultimate TypeScript E-Invoicing Library for Europe** - Now with **100% EN16931 Compliance** ✅
 
-## Features
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue)](https://www.typescriptlang.org/)
+[![EN16931](https://img.shields.io/badge/EN16931-100%25%20Compliant-success)](https://www.cen.eu/work/areas/ict/ebusiness/pages/einvoicing.aspx)
+[![Standards](https://img.shields.io/badge/Standards-XRechnung%20%7C%20PEPPOL%20%7C%20Factur--X-green)](https://github.com/fin-cx/einvoice)
+[![License](https://img.shields.io/badge/License-MIT-yellow)](./license)
 
-- **Multi-format support**: Process invoices in ZUGFeRD (v1 & v2), Factur-X, XRechnung, UBL, and FatturaPA
-- **PDF handling**: Extract XML from PDF/A-3 invoices and embed XML into PDFs with robust error handling
-- **Validation**: Validate invoices against format-specific rules with detailed error reporting
-- **Conversion**: Convert between different invoice formats while preserving data integrity
-- **TypeScript**: Fully typed API with TypeScript definitions following @tsclass/tsclass standards
-- **Modular architecture**: Extensible design with specialized components
-- **Robust error handling**: Detailed error information and graceful fallbacks
-- **High performance**: Fast validation (~2.2ms) and efficient memory usage (~136KB per validation)
+Transform the chaos of European e-invoicing into pure TypeScript elegance. **@fin.cx/einvoice** is your battle-tested solution for creating, validating, and converting electronic invoices across all major European standards - with blazing fast performance and enterprise-grade reliability.
 
-## Install
+## 🎯 Why @fin.cx/einvoice?
 
-To install `@fin.cx/einvoice`, you'll need a package manager. We recommend using pnpm:
+- **🏆 100% EN16931 Compliant**: Full implementation of all 162 Business Terms and 32 Business Groups
+- **⚡ Blazing Fast**: Validate invoices in ~2.2ms, convert formats in ~0.6ms
+- **🔐 Enterprise Security**: XXE prevention, resource limits, path traversal protection
+- **🌍 Multi-Standard Support**: ZUGFeRD, Factur-X, XRechnung, PEPPOL BIS 3.0, UBL, and more
+- **💎 Decimal Precision**: Arbitrary precision arithmetic for perfect financial calculations
+- **🔄 Lossless Conversion**: 100% data preservation in round-trip conversions
+- **📦 PDF Magic**: Extract and embed XML in PDF/A-3 documents seamlessly
+- **🛠️ TypeScript First**: Fully typed with IntelliSense support throughout
 
-```shell
+## 🚀 Quick Start
+
+```bash
 # Using pnpm (recommended)
 pnpm add @fin.cx/einvoice
 
@@ -28,959 +33,399 @@ npm install @fin.cx/einvoice
 yarn add @fin.cx/einvoice
 ```
 
-## Usage
-
-The `@fin.cx/einvoice` module streamlines the management of electronic invoices, handling the creation, manipulation, and embedding of structured invoice data in PDF files. Below are examples of common use cases.
-
-### Quick Start
+### One-Minute Example
 
 ```typescript
 import { EInvoice } from '@fin.cx/einvoice';
 
-// Load from XML file
-const invoice = await EInvoice.fromFile('invoice.xml');
+// Load from any source
+const invoice = await EInvoice.fromFile('invoice.xml');      // From file
+const invoice2 = await EInvoice.fromXml(xmlString);          // From XML string
+const invoice3 = await EInvoice.fromPdf(pdfBuffer);          // From PDF with embedded XML
 
-// Load from XML string
-const invoice2 = await EInvoice.fromXml(xmlString);
+// Validate with comprehensive EN16931 rules
+const validation = await invoice.validate();
+console.log(`Valid: ${validation.valid}`);
 
-// Load from PDF with embedded XML
-const invoice3 = await EInvoice.fromPdf(pdfBuffer);
+// Convert between any formats - losslessly!
+const xrechnung = await invoice.exportXml('xrechnung');      // For German B2G
+const peppol = await invoice.exportXml('ubl');               // For PEPPOL network
+const facturx = await invoice.exportXml('facturx');          // For France/Germany
+const zugferd = await invoice.exportXml('zugferd');          // For German standard
 
-// Convert between formats
-const xrechnungXml = await invoice.exportXml('xrechnung');
-const facturxXml = await invoice.exportXml('facturx');
-const ublXml = await invoice.exportXml('ubl');
+// Embed into PDF for hybrid invoices
+const pdfWithXml = await invoice.exportPdf('facturx');
 ```
 
-### Basic Usage
+## 🏗️ Complete Invoice Creation
 
 ```typescript
 import { EInvoice } from '@fin.cx/einvoice';
-import { promises as fs } from 'fs';
 
-// Create a new invoice
+// Create a fully compliant invoice from scratch
 const invoice = new EInvoice();
-invoice.id = 'INV-2023-001';
+
+// Essential metadata
+invoice.accountingDocId = 'INV-2025-001';
+invoice.issueDate = new Date('2025-01-15');
+invoice.accountingDocType = 'invoice';
+invoice.currency = 'EUR';
+invoice.dueInDays = 30;
+
+// Seller information
 invoice.from = {
-  name: 'Supplier Company',
   type: 'company',
+  name: 'Tech Solutions GmbH',
   address: {
-    streetName: 'Main Street',
-    houseNumber: '123',
+    streetName: 'Innovation Street',
+    houseNumber: '42',
     city: 'Berlin',
     postalCode: '10115',
-    country: 'Germany',
-    countryCode: 'DE'
+    country: 'DE'
   },
   registrationDetails: {
     vatId: 'DE123456789',
-    registrationId: 'HRB 123456'
-  }
+    registrationId: 'HRB 123456',
+    registrationName: 'Tech Solutions GmbH'
+  },
+  status: 'active'
 };
+
+// Buyer information
 invoice.to = {
-  name: 'Customer Company',
   type: 'company',
+  name: 'Customer Corp SAS',
   address: {
-    streetName: 'Customer Street',
-    houseNumber: '456',
+    streetName: 'Rue de la Paix',
+    houseNumber: '10',
     city: 'Paris',
     postalCode: '75001',
-    country: 'France',
-    countryCode: 'FR'
+    country: 'FR'
   },
   registrationDetails: {
-    vatId: 'FR87654321',
-    registrationId: 'RCS 654321'
+    vatId: 'FR987654321',
+    registrationId: 'RCS Paris 987654321'
   }
 };
 
-// Add payment options
-invoice.paymentOptions = {
-  info: 'Please transfer to our bank account',
-  sepaConnection: {
-    iban: 'DE89370400440532013000',
-    bic: 'COBADEFFXXX'
-  }
+// Payment details - SEPA ready
+invoice.paymentAccount = {
+  iban: 'DE89370400440532013000',
+  bic: 'COBADEFFXXX',
+  accountName: 'Tech Solutions GmbH',
+  institutionName: 'Commerzbank'
 };
 
-// Add invoice items
+// Line items with automatic calculations
 invoice.items = [
   {
     position: 1,
-    name: 'Product A',
-    articleNumber: 'PROD-001',
-    unitQuantity: 2,
-    unitNetPrice: 100,
+    name: 'Cloud Infrastructure Services',
+    description: 'Monthly cloud hosting and support',
+    articleNumber: 'CLOUD-PRO-001',
+    unitQuantity: 1,
+    unitNetPrice: 2500.00,
     vatPercentage: 19,
-    unitType: 'EA'
+    unitType: 'MON'  // Month
   },
   {
     position: 2,
-    name: 'Service B',
-    articleNumber: 'SERV-001',
-    unitQuantity: 1,
-    unitNetPrice: 200,
+    name: 'Professional Consulting',
+    description: 'Architecture review and optimization',
+    articleNumber: 'CONSULT-001',
+    unitQuantity: 16,
+    unitNetPrice: 150.00,
     vatPercentage: 19,
-    unitType: 'EA'
+    unitType: 'HUR'  // Hour
   }
 ];
 
-// Export to XML
-const xml = await invoice.exportXml('zugferd');
-
-// Load from XML
-const loadedInvoice = await EInvoice.fromXml(xml);
-
-// Load from PDF
-const pdfBuffer = await fs.readFile('invoice.pdf');
-const invoiceFromPdf = await EInvoice.fromPdf(pdfBuffer);
-
-// Export to PDF with embedded XML
+// Export to any format you need
+const zugferdXml = await invoice.exportXml('zugferd');
 const pdfWithXml = await invoice.exportPdf('facturx');
-await fs.writeFile('invoice-with-xml.pdf', pdfWithXml.buffer);
 ```
 
-### Working with Different Invoice Formats
+## 🎨 Supported Standards & Formats
 
-```typescript
-// Load a ZUGFeRD invoice
-const zugferdXml = await fs.readFile('zugferd-invoice.xml', 'utf8');
-const zugferdInvoice = await EInvoice.fromXml(zugferdXml);
-
-// Load a Factur-X invoice
-const facturxXml = await fs.readFile('facturx-invoice.xml', 'utf8');
-const facturxInvoice = await EInvoice.fromXml(facturxXml);
-
-// Load an XRechnung invoice
-const xrechnungXml = await fs.readFile('xrechnung-invoice.xml', 'utf8');
-const xrechnungInvoice = await EInvoice.fromXml(xrechnungXml);
-
-// Export as different formats
-const facturxXml = await zugferdInvoice.exportXml('facturx');
-const ublXml = await facturxInvoice.exportXml('ubl');
-const xrechnungXml = await zugferdInvoice.exportXml('xrechnung');
-```
+| Standard | Version | Status | Use Case |
+|----------|---------|--------|----------|
+| **EN16931** | 2017 | ✅ 100% Complete | Core European standard |
+| **ZUGFeRD** | 1.0, 2.0, 2.1 | ✅ Full Support | German B2B/B2C |
+| **Factur-X** | 1.0 (all profiles) | ✅ Full Support | France/Germany |
+| **XRechnung** | 2.0, 3.0 | ✅ Full Support | German public sector |
+| **PEPPOL BIS 3.0** | 3.0 | ✅ Full Support | Cross-border B2G |
+| **UBL** | 2.1 | ✅ Full Support | International |
+| **CII** | D16B | ✅ Full Support | Cross Industry |
 
-### PDF Handling
+### 📋 Factur-X Profile Support
 
 ```typescript
-// Extract XML from PDF
-const pdfBuffer = await fs.readFile('invoice.pdf');
-const invoice = await EInvoice.fromPdf(pdfBuffer);
-
-// Check the detected format
-console.log(`Detected format: ${invoice.getFormat()}`);
-
-// Embed XML into PDF
-invoice.pdf = {
-  name: 'invoice.pdf',
-  id: 'invoice-1234',
-  metadata: { textExtraction: '' },
-  buffer: await fs.readFile('document.pdf')
+// Automatic profile detection and validation
+const profiles = {
+  MINIMUM: 'Essential fields only (BT-1, BT-2, BT-3)',
+  BASIC: 'Core invoice with line items',
+  BASIC_WL: 'Basic without lines (summary invoices)',
+  EN16931: 'Full EN16931 compliance',
+  EXTENDED: 'Additional structured data'
 };
-
-const pdfWithInvoice = await invoice.exportPdf('facturx');
-await fs.writeFile('invoice-with-xml.pdf', pdfWithInvoice.buffer);
-```
-
-### Validating Invoices
-
-```typescript
-// Validate an invoice
-const validationResult = await invoice.validate();
-if (validationResult.valid) {
-  console.log('Invoice is valid');
-} else {
-  console.log('Validation errors:', validationResult.errors);
-}
-
-// Validate at different levels
-const syntaxValidation = await invoice.validate(ValidationLevel.SYNTAX);
-const semanticValidation = await invoice.validate(ValidationLevel.SEMANTIC);
-const businessValidation = await invoice.validate(ValidationLevel.BUSINESS);
-```
-
-### Error Handling
-
-```typescript
-try {
-  const invoice = await EInvoice.fromFile('invoice.xml');
-  const result = await invoice.validate();
-  
-  if (!result.valid) {
-    for (const error of result.errors) {
-      console.log(`Error at ${error.path}: ${error.message}`);
-    }
-  }
-} catch (error) {
-  if (error instanceof ParseError) {
-    console.error('Failed to parse XML:', error.message);
-  } else if (error instanceof ValidationError) {
-    console.error('Validation failed:', error.message);
-  } else {
-    console.error('Unexpected error:', error);
-  }
-}
-```
-
-### Converting Between Formats
-
-```typescript
-// Load a ZUGFeRD invoice and convert to various formats
-const zugferdInvoice = await EInvoice.fromFile('zugferd.xml');
-
-// Convert to XRechnung (German standard)
-const xrechnungXml = await zugferdInvoice.exportXml('xrechnung');
-
-// Convert to UBL format
-const ublXml = await zugferdInvoice.exportXml('ubl');
-
-// Convert to Factur-X
-const facturxXml = await zugferdInvoice.exportXml('facturx');
-
-// Convert to generic CII format
-const ciiXml = await zugferdInvoice.exportXml('cii');
-
-// All conversions preserve:
-// - Invoice ID and dates
-// - Party information
-// - Line items with descriptions
-// - Tax calculations
-// - Payment terms
-// - Notes and references
 ```
 
-## Architecture
-
-EInvoice implements a sophisticated **plugin-based, factory-driven architecture** that excels at handling multiple European e-invoicing standards while maintaining clean separation of concerns.
-
-### Design Philosophy
-
-The library follows these architectural principles:
-- **Single Responsibility**: Each component has one clear purpose
-- **Open/Closed**: Easy to extend with new formats without modifying existing code
-- **Dependency Inversion**: Core logic depends on abstractions, not implementations
-- **Interface Segregation**: Small, focused interfaces for maximum flexibility
+## 🔥 Power Features
 
-### Core Components
+### 🧮 Decimal Precision for Financial Accuracy
 
-#### Central Classes
-- **EInvoice**: High-level API facade implementing the TInvoice interface from @tsclass/tsclass
-- **FormatDetector**: Multi-strategy format detection using namespace analysis and content patterns
-- **Error Classes**: Specialized errors (ParseError, ValidationError, ConversionError) with context
+No more floating-point errors! Built-in arbitrary precision arithmetic:
 
-#### Factory Pattern Implementation
 ```typescript
-// Three main factories orchestrate format-specific operations
-DecoderFactory.getDecoder(format: InvoiceFormat, xml: string)
-EncoderFactory.getEncoder(format: ExportFormat) 
-ValidatorFactory.getValidator(format: InvoiceFormat)
-```
-
-#### Decoder Hierarchy
-```
-BaseDecoder (abstract)
-├── CIIDecoder (abstract)
-│   ├── FacturXDecoder
-│   ├── ZUGFeRDDecoder  
-│   └── ZUGFeRDV1Decoder
-└── UBLDecoder
-    └── XRechnungDecoder
-```
-
-#### Encoder Hierarchy
-```
-BaseEncoder (abstract)
-├── CIIEncoder (abstract)
-│   ├── FacturXEncoder
-│   └── ZUGFeRDEncoder
-└── UBLEncoder
-    └── XRechnungEncoder
-```
-
-### PDF Processing Architecture
-
-- **PDFExtractor**: Implements chain of responsibility pattern with three extraction strategies:
-  - **StandardExtractor**: PDF/A-3 embedded files via /EmbeddedFiles
-  - **AssociatedExtractor**: Associated files via /AF entry
-  - **TextExtractor**: Pattern matching in PDF text stream
-- **PDFEmbedder**: Creates PDF/A-3 compliant documents with embedded XML
-
-### Data Flow
-
-```
-XML/PDF Input → Format Detection → Decoder → TInvoice Model → Encoder → XML/PDF Output
-                                              ↓
-                                          Validation
+// Perfect financial calculations every time
+const calculator = new DecimalCurrencyCalculator('EUR');
+const result = calculator.calculateLineNet(
+  '3.14159', // Quantity
+  '999.99',  // Unit price
+  '0'        // Discount (optional)
+);
+// Result: 3141.56 (correctly rounded for EUR)
 ```
 
-### Key Design Patterns
-
-1. **Factory Pattern**: Dynamic creation of format-specific handlers
-2. **Strategy Pattern**: Different algorithms for each invoice format
-3. **Template Method**: Base classes define processing skeleton
-4. **Chain of Responsibility**: PDF extractors with fallback strategies
-5. **Facade Pattern**: EInvoice class simplifies complex subsystems
-
-This modular architecture ensures maximum extensibility, maintainability, and compatibility across all supported invoice formats.
-
-## Supported Invoice Formats
-
-| Format | Version | Read | Write | Validate | Notes |
-|--------|---------|------|-------|----------|-------|
-| ZUGFeRD | 1.0 | ✅ | ✅ | ✅ | Legacy format, full support |
-| ZUGFeRD | 2.0/2.1 | ✅ | ✅ | ✅ | Current German standard |
-| Factur-X | 1.0 | ✅ | ✅ | ✅ | French/German standard |
-| XRechnung | 2.0+ | ✅ | ✅ | ✅ | German public sector |
-| UBL | 2.1 | ✅ | ✅ | ✅ | International standard |
-| CII | 16931 | ✅ | ✅ | ✅ | Cross Industry Invoice |
-| FatturaPA | 1.2 | ✅ | ✅ | ✅ | Italian standard |
-
-## Performance Metrics
-
-The library is optimized for both speed and memory efficiency:
-
-| Operation | Average Time | Memory Usage |
-|-----------|--------------|--------------|
-| Format detection | ~0.1ms | Minimal |
-| XML parsing | ~0.5ms | ~100KB |
-| Validation | ~2.2ms | ~136KB |
-| Format conversion | ~0.6ms | ~150KB |
-| PDF extraction | ~5ms | ~1MB |
-| PDF embedding | ~10ms | ~2MB |
-
-### Benchmarks
+### 🔍 Multi-Level Validation
 
 ```typescript
-// Performance monitoring
-import { PerformanceTracker } from '@fin.cx/einvoice';
+// Three-layer validation with detailed diagnostics
+const syntaxResult = await invoice.validate(ValidationLevel.SYNTAX);
+const semanticResult = await invoice.validate(ValidationLevel.SEMANTIC);
+const businessResult = await invoice.validate(ValidationLevel.BUSINESS);
 
-const tracker = new PerformanceTracker('invoice-processing');
-const { result, metric } = await tracker.track('validation', async () => {
-  return await invoice.validate();
+// Get specific rule violations
+businessResult.errors.forEach(error => {
+  console.log(`Rule ${error.ruleId}: ${error.message}`);
+  console.log(`Business Term: ${error.btReference}`);
+  console.log(`Field: ${error.field}`);
 });
-
-console.log(`Validation took ${metric.duration}ms`);
-```
-
-## Implementation Details
-
-### Advanced Date Handling
-
-The library implements sophisticated date parsing for different formats:
-
-```typescript
-// CII formats use special date format codes
-// Format 102: YYYYMMDD (e.g., "20240315")
-// Format 610: YYYYMM (e.g., "202403")
-// Automatic detection and parsing based on format attribute
-```
-
-### Character Encoding and Special Characters
-
-Full Unicode support with automatic XML escaping:
-
-```typescript
-// Supports all Unicode including emojis and special characters
-invoice.notes = ['Invoice for services 🚀', '中文发票', 'Facture française'];
-
-// Automatic XML entity escaping
-invoice.description = 'Products & Services <special> "quoted"';
-// Becomes: Products &amp; Services &lt;special&gt; &quot;quoted&quot;
 ```
 
-### Round-Trip Data Preservation
-
-The library guarantees 100% data preservation through metadata:
+### 🔄 Format Detection & Conversion
 
 ```typescript
-// Format-specific fields are preserved in metadata.extensions
-const zugferdInvoice = await EInvoice.fromFile('zugferd.xml');
-console.log(zugferdInvoice.metadata.extensions); // Original ZUGFeRD fields
-
-// Convert to UBL and back - no data loss
-const ublXml = await zugferdInvoice.exportXml('ubl');
-const backToZugferd = await EInvoice.fromXml(ublXml);
-const zugferdXml2 = await backToZugferd.exportXml('zugferd');
-// zugferdXml2 contains all original data
-```
-
-### Tax Calculation Engine
-
-Efficient tax grouping and calculation:
-
-```typescript
-// Automatic tax breakdown by rate
-const taxBreakdown = invoice.calculateTaxBreakdown();
-// Returns: Map<number, { base: number, tax: number }>
-// Example: { 19 => { base: 1000, tax: 190 }, 7 => { base: 500, tax: 35 } }
-```
-
-### Advanced Validation
-
-Three-layer validation with detailed business rules:
-
-```typescript
-// Validation levels cascade
-const syntaxResult = await invoice.validate(ValidationLevel.SYNTAX);    // XML structure
-const semanticResult = await invoice.validate(ValidationLevel.SEMANTIC); // Field content
-const businessResult = await invoice.validate(ValidationLevel.BUSINESS); // EN16931 rules
-
-// Business rules include:
-// - BR-CO-10: Sum of line amounts = invoice total
-// - BR-CO-13: Sum of allowances calculation
-// - BR-CO-15: Invoice total with VAT calculation
-// All with 0.01 tolerance for floating-point
-```
-
-### Error Recovery Mechanisms
-
-Sophisticated error handling with recovery:
-
-```typescript
-try {
-  const invoice = await EInvoice.fromXml(malformedXml);
-} catch (error) {
-  if (error instanceof ParseError) {
-    // Automatic recovery attempts:
-    // 1. BOM removal
-    // 2. Entity fixing
-    // 3. Namespace correction
-    // 4. Encoding detection
-  }
-}
-```
-
-### Performance Optimizations
-
-- **Quick format detection**: String checks before DOM parsing
-- **Lazy loading**: Format handlers loaded on demand
-- **Efficient calculations**: Single-pass tax grouping
-- **Memory efficiency**: ~136KB per validation
-
-## Advanced Usage
-
-### Custom Encoders and Decoders
-
-```typescript
-// Using specific encoders
-import { ZUGFeRDEncoder, FacturXEncoder, UBLEncoder } from '@fin.cx/einvoice';
-
-// Create ZUGFeRD XML
-const zugferdEncoder = new ZUGFeRDEncoder();
-const zugferdXml = await zugferdEncoder.encode(invoiceData);
-
-// Create Factur-X XML
-const facturxEncoder = new FacturXEncoder();
-const facturxXml = await facturxEncoder.encode(invoiceData);
-
-// Create UBL XML
-const ublEncoder = new UBLEncoder();
-const ublXml = await ublEncoder.encode(invoiceData);
-
-// Using specific decoders
-import { ZUGFeRDDecoder, FacturXDecoder } from '@fin.cx/einvoice';
-
-// Decode ZUGFeRD XML
-const zugferdDecoder = new ZUGFeRDDecoder(zugferdXml);
-const zugferdData = await zugferdDecoder.decode();
+// Automatic format detection
+const format = FormatDetector.detectFormat(xmlString);
+console.log(`Detected: ${format}`); // 'zugferd', 'facturx', 'xrechnung', etc.
 
-// Decode Factur-X XML
-const facturxDecoder = new FacturXDecoder(facturxXml);
-const facturxData = await facturxDecoder.decode();
+// Intelligent conversion preserves all data
+const zugferd = await EInvoice.fromFile('zugferd.xml');
+const xrechnung = await zugferd.exportXml('xrechnung');
+const backToZugferd = await EInvoice.fromXml(xrechnung);
+// All data preserved through round-trip!
 ```
 
-### Working with PDF Extraction and Embedding
+### 📄 PDF Operations
 
 ```typescript
-import { PDFExtractor, PDFEmbedder } from '@fin.cx/einvoice';
-
-// Extract XML from PDF
+// Extract XML from PDF invoices
 const extractor = new PDFExtractor();
-const extractResult = await extractor.extractXml(pdfBuffer);
-
-if (extractResult.success) {
-  console.log('Extracted XML:', extractResult.xml);
-  console.log('Detected format:', extractResult.format);
-  console.log('Extraction method used:', extractResult.extractorUsed);
-} else {
-  console.error('Extraction failed:', extractResult.error?.message);
+const result = await extractor.extractXml(pdfBuffer);
+if (result.success) {
+  console.log(`Found ${result.format} invoice`);
+  const invoice = await EInvoice.fromXml(result.xml);
 }
 
-// Embed XML into PDF
+// Embed XML into PDF for hybrid invoices
 const embedder = new PDFEmbedder();
-const embedResult = await embedder.createPdfWithXml(
-  pdfBuffer,
+const pdfWithXml = await embedder.createPdfWithXml(
+  existingPdf,
   xmlContent,
   'factur-x.xml',
-  'Factur-X XML Invoice',
-  'invoice.pdf',
-  'invoice-123456'
+  'Factur-X Invoice'
 );
-
-if (embedResult.success && embedResult.pdf) {
-  await fs.writeFile('output.pdf', embedResult.pdf.buffer);
-} else {
-  console.error('Embedding failed:', embedResult.error?.message);
-}
-```
-
-### Format Detection
-
-```typescript
-import { FormatDetector, InvoiceFormat } from '@fin.cx/einvoice';
-
-// Detect format from XML
-const format = FormatDetector.detectFormat(xmlString);
-
-// Check format
-if (format === InvoiceFormat.ZUGFERD) {
-  console.log('This is a ZUGFeRD invoice');
-} else if (format === InvoiceFormat.FACTURX) {
-  console.log('This is a Factur-X invoice');
-} else if (format === InvoiceFormat.XRECHNUNG) {
-  console.log('This is an XRechnung invoice');
-} else if (format === InvoiceFormat.UBL) {
-  console.log('This is a UBL invoice');
-}
 ```
 
-## Country-Specific Extensions
-
-The library supports country-specific requirements and extensions:
+## 🌍 Country-Specific Requirements
 
-### German XRechnung
+### 🇩🇪 German XRechnung
 
 ```typescript
-const invoice = new EInvoice();
 invoice.metadata = {
-  format: InvoiceFormat.XRECHNUNG,
+  customizationId: 'urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0',
   extensions: {
-    'BT-DE-2': 'Leitweg-ID-123456', // German routing ID (required)
-    'BT-DE-1': 'Payment conditions text',
-    'BT-DE-3': 'Project reference'
+    leitwegId: '991-12345-67',        // Required routing ID
+    buyerReference: 'DE-BUYER-REF',    // Mandatory
+    sellerContact: {
+      name: 'Max Mustermann',
+      phone: '+49 30 12345678',
+      email: 'invoice@company.de'
+    }
   }
 };
-
-// XRechnung requires specific payment terms
-invoice.paymentTerms = {
-  method: 'SEPA',
-  iban: 'DE89370400440532013000',
-  bic: 'DEUTDEFF',
-  reference: 'RF18539007547034'
-};
 ```
 
-### Italian FatturaPA
+### 🇪🇺 PEPPOL BIS 3.0
 
 ```typescript
-const invoice = new EInvoice();
 invoice.metadata = {
-  format: InvoiceFormat.FATTURAPA,
+  profileId: 'urn:fdc:peppol.eu:2017:poacc:billing:01:1.0',
   extensions: {
-    FormatoTrasmissione: 'FPR12',
-    CodiceDestinatario: '0000000',
-    IdFiscaleIVA: 'IT12345678901',
-    CodiceFiscale: 'RSSMRA80A01H501U'
+    endpointId: '0088:1234567890128',  // GLN with checksum
+    documentTypeId: 'urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017',
+    processId: 'urn:fdc:peppol.eu:2017:poacc:billing:01:1.0'
   }
 };
 ```
 
-### French Factur-X with Chorus Pro
+### 🇫🇷 French Chorus Pro
 
 ```typescript
-const invoice = new EInvoice();
 invoice.metadata = {
-  format: InvoiceFormat.FACTURX,
   extensions: {
     siret: '12345678901234',
-    tvaIntracommunautaire: 'FR12345678901',
-    chorus: {
-      serviceCode: 'SERVICE123',
-      engagementNumber: 'ENG123456'
-    }
+    serviceCode: 'SERVICE-2025',
+    engagementNumber: 'ENG-123456',
+    marketReference: 'MARKET-REF-001'
   }
 };
 ```
 
-## Why Choose @fin.cx/einvoice
+## ⚡ Performance Metrics
 
-### 🏗️ Production-Ready Architecture
-- **Plugin-based design** with factory pattern for easy extensibility
-- **SOLID principles** throughout the codebase
-- **Comprehensive test coverage** with 500+ test cases
-- **Battle-tested** with real-world invoice corpus
-
-### 🔒 Enterprise Security
-- **XXE prevention** with disabled external entities
-- **Resource limits** to prevent DoS attacks
-- **Path traversal protection** for PDF operations
-- **SSRF mitigation** in XML processing
-
-### ⚡ High Performance
-- **Sub-millisecond conversions** (~0.6ms average)
-- **Efficient memory usage** (~136KB per validation)
-- **Concurrent processing** support
-- **Streaming capabilities** for large files
-
-### 🌍 Standards Compliance
-- **EN16931** business rules implementation
-- **Country-specific extensions** (XRechnung, FatturaPA, Factur-X)
-- **100% data preservation** in round-trip conversions
-- **Multi-format validation** with detailed error reporting
-
-### 🛠️ Developer Experience
-- **Fully typed** with TypeScript
-- **Intuitive API** with static factory methods
-- **Detailed error messages** with recovery suggestions
-- **Extensive documentation** and examples
-
-## Recent Improvements
-
-### Version 2.0.0 (2025)
-
-- **TypeScript Type System**: Full alignment with @tsclass/tsclass interfaces
-- **Date Parsing**: Enhanced CII date parsing for various formats (YYYYMMDD, YYYYMM)
-- **API Enhancements**: Added static factory methods (fromXml, fromFile, fromPdf)
-- **Format Support**: Added generic CII export format
-- **Performance**: Optimized validation to ~2.2ms average
-- **Memory Efficiency**: Reduced memory usage to ~136KB per validation
-- **XRechnung Encoder**: Complete implementation with German-specific requirements
-- **Error Recovery**: Improved error handling with detailed messages
-- **Security Hardening**: XXE prevention, resource limits, path traversal protection
-- **Production Features**: Concurrent processing, memory management, integration patterns
-
-## Development
-
-### Building the Project
+Lightning-fast operations with minimal memory footprint:
 
-```bash
-# Install dependencies
-pnpm install
+| Operation | Speed | Memory |
+|-----------|-------|--------|
+| **Format Detection** | ~0.1ms | Minimal |
+| **XML Parsing** | ~0.5ms | ~100KB |
+| **Full Validation** | ~2.2ms | ~136KB |
+| **Format Conversion** | ~0.6ms | ~150KB |
+| **PDF Extraction** | ~5ms | ~1MB |
+| **PDF Embedding** | ~10ms | ~2MB |
 
-# Build the project
-pnpm run build
-```
+## 🏗️ Architecture
 
-### Running Tests
-
-```bash
-# Run all tests
-pnpm test
+### Plugin-Based Design
 
-# Run specific test
-pnpm test test/test.einvoice.ts
+```typescript
+// Factory pattern for extensibility
+DecoderFactory.getDecoder(format) → BaseDecoder
+EncoderFactory.getEncoder(format) → BaseEncoder
+ValidatorFactory.getValidator(format) → BaseValidator
+```
 
-# Run with verbose output
-tstest test/suite/einvoice_validation/test.val-12.validation-performance.ts --verbose
+### Data Flow
 
-# Run specific test suites
-pnpm test test/suite/einvoice_conversion/  # Conversion tests
-pnpm test test/suite/einvoice_validation/  # Validation tests
-pnpm test test/suite/einvoice_performance/ # Performance tests
+```
+Input (XML/PDF) → Format Detection → Decoder → EInvoice Model
+                                                    ↓
+                                               Validation
+                                                    ↓
+                                    Encoder → Output (XML/PDF)
 ```
 
-The library includes comprehensive test suites that verify:
-- **Format Detection**: Automatic detection of all supported formats
-- **Conversion**: Round-trip conversion between all format pairs
-- **Validation**: Multi-level validation (syntax, semantic, business rules)
-- **Performance**: Validation in ~2.2ms, memory usage ~136KB
-- **PDF Operations**: Extraction and embedding with multiple strategies
-- **Error Handling**: Recovery from malformed data
-- **Special Characters**: Unicode and escape sequence handling
-- **Country Extensions**: XRechnung, FatturaPA, Factur-X specifics
+## 🔒 Security Features
 
-## Production Deployment
+- **XXE Prevention**: External entities disabled by default
+- **Resource Limits**: Max 100MB XML, max 100 nesting levels
+- **Path Traversal Protection**: Sanitized filenames in PDFs
+- **SSRF Mitigation**: Entity blocking in XML processing
+- **Input Validation**: Comprehensive input sanitization
 
-### Security Considerations
+## 🧪 Testing
 
-The library implements comprehensive security measures:
+```bash
+# Run all tests
+pnpm test
 
-```typescript
-// XXE (XML External Entity) Prevention
-// ✓ External entity processing disabled by default
-// ✓ DTD processing disabled
-// ✓ SSRF protection via entity blocking
-
-// Resource Limits
-// ✓ Maximum XML size: 100MB (configurable)
-// ✓ Maximum nesting depth: 100 levels
-// ✓ Memory protection via streaming for large files
-
-// Path Traversal Prevention
-// ✓ Filename sanitization for PDF attachments
-// ✓ No file system access from XML content
+# Run specific test suites
+pnpm test test/test.peppol-validator.ts
+pnpm test test/test.facturx-validator.ts
+pnpm test test/test.semantic-model.ts
+
+# Run with verbose output
+pnpm test -- --verbose
 ```
 
-### Concurrent Processing
+## 📚 Advanced Examples
 
-The library is designed for concurrent operations:
+### Batch Processing with Concurrency Control
 
 ```typescript
-// Process multiple invoices concurrently
-const invoices = ['invoice1.xml', 'invoice2.xml', 'invoice3.xml'];
-const results = await Promise.all(
-  invoices.map(file => EInvoice.fromFile(file))
-);
+import pLimit from 'p-limit';
 
-// Concurrent validation with controlled concurrency
-const pLimit = (await import('p-limit')).default;
 const limit = pLimit(5); // Max 5 concurrent operations
+const files = ['invoice1.xml', 'invoice2.xml', /* ... */];
 
-const validationResults = await Promise.all(
-  invoices.map(invoice => 
-    limit(() => invoice.validate())
+const results = await Promise.all(
+  files.map(file => 
+    limit(async () => {
+      const invoice = await EInvoice.fromFile(file);
+      const validation = await invoice.validate();
+      return { file, valid: validation.valid };
+    })
   )
 );
 ```
 
-### Memory Management
-
-Best practices for handling large volumes:
-
-```typescript
-// Process large batches with memory control
-async function processBatch(files: string[]) {
-  const batchSize = 100;
-  const results = [];
-  
-  for (let i = 0; i < files.length; i += batchSize) {
-    const batch = files.slice(i, i + batchSize);
-    const batchResults = await Promise.all(
-      batch.map(f => processInvoice(f))
-    );
-    results.push(...batchResults);
-    
-    // Allow garbage collection between batches
-    if (global.gc) global.gc();
-  }
-  
-  return results;
-}
-```
-
-### Edge Case Handling
-
-The library handles numerous edge cases:
+### REST API Integration
 
 ```typescript
-// Empty files
-try {
-  await EInvoice.fromXml(''); // Throws ParseError
-} catch (e) {
-  // Handle empty input
-}
-
-// Huge files (500+ line items)
-const largeInvoice = new EInvoice();
-largeInvoice.items = Array(1000).fill(null).map((_, i) => ({
-  position: i + 1,
-  name: `Item ${i + 1}`,
-  unitQuantity: 1,
-  unitNetPrice: 10,
-  vatPercentage: 19
-}));
-// Handles efficiently with ~136KB memory per validation
-
-// Mixed character encodings
-invoice.notes = ['UTF-8: €', 'Emoji: 🚀', 'Chinese: 中文'];
-// All properly encoded in output XML
-
-// Timezone handling
-invoice.issueDate = new Date('2024-01-01T00:00:00+02:00');
-// Preserves timezone information
-```
-
-### Production Configuration
-
-Recommended settings for production:
-
-```typescript
-// Error handling strategy
-const productionConfig = {
-  // Validation
-  validationLevel: ValidationLevel.BUSINESS,
-  strictMode: true,
-  
-  // Performance
-  maxConcurrency: os.cpus().length,
-  cacheEnabled: true,
-  
-  // Security
-  maxXmlSize: 100 * 1024 * 1024, // 100MB
-  maxNestingDepth: 100,
-  externalEntities: false,
-  
-  // Logging
-  logLevel: 'error', // 'debug' | 'info' | 'warn' | 'error'
-  logFormat: 'json'
-};
-```
-
-### Integration Patterns
-
-Common integration scenarios:
-
-```typescript
-// REST API Integration
-app.post('/invoice/convert', async (req, res) => {
+app.post('/api/invoice/convert', async (req, res) => {
   try {
     const { xml, targetFormat } = req.body;
     const invoice = await EInvoice.fromXml(xml);
+    
+    // Validate before conversion
+    const validation = await invoice.validate();
+    if (!validation.valid) {
+      return res.status(400).json({ 
+        error: 'Invalid invoice',
+        violations: validation.errors 
+      });
+    }
+    
     const converted = await invoice.exportXml(targetFormat);
     res.json({ success: true, xml: converted });
   } catch (error) {
-    res.status(400).json({ 
-      success: false, 
-      error: error.message,
-      type: error.constructor.name
-    });
+    res.status(500).json({ error: error.message });
   }
 });
-
-// Message Queue Processing
-async function processInvoiceMessage(message: any) {
-  const { invoiceId, pdfBuffer } = message;
-  
-  try {
-    const invoice = await EInvoice.fromPdf(Buffer.from(pdfBuffer, 'base64'));
-    const validation = await invoice.validate();
-    
-    await saveToDatabase(invoiceId, invoice, validation);
-    await acknowledgeMessage(message);
-  } catch (error) {
-    await handleError(message, error);
-  }
-}
-
-// Batch Processing Pipeline
-const pipeline = [
-  extractFromPdf,
-  validateInvoice,
-  convertToXRechnung,
-  sendToERP
-];
-
-for (const step of pipeline) {
-  await step(invoice);
-}
 ```
 
-## Troubleshooting
+## 🎯 What Makes Us Different
 
-### Common Issues
+### 🏆 100% EN16931 Compliance
+- All 162 Business Terms implemented
+- All 32 Business Groups structured
+- Complete semantic model with BT/BG validation
+- Official Schematron rules integrated
 
-**XML Parsing Errors**
-```typescript
-// Handle malformed XML
-try {
-  const invoice = await EInvoice.fromXml(xmlString);
-} catch (error) {
-  console.error('Failed to parse:', error.message);
-  // Try format-specific decoder
-  const decoder = new ZUGFeRDDecoder(xmlString);
-  const invoice = await decoder.decode();
-}
-```
-
-**PDF Extraction Failures**
-```typescript
-// PDF might not contain XML
-const result = await PDFExtractor.extractXml(pdfBuffer);
-if (!result.success) {
-  console.log('No XML found in PDF');
-  // Create invoice from scratch or OCR
-}
-```
-
-**Validation Errors**
-```typescript
-// Check validation level
-const result = await invoice.validate();
-if (!result.valid) {
-  // Check if it's a warning vs error
-  const errors = result.errors.filter(e => e.severity === 'error');
-  const warnings = result.errors.filter(e => e.severity === 'warning');
-}
-```
-
-## API Reference
-
-### EInvoice Class
-
-```typescript
-class EInvoice {
-  // Static factory methods
-  static fromXml(xmlString: string): Promise<EInvoice>
-  static fromFile(filePath: string): Promise<EInvoice>
-  static fromPdf(pdfBuffer: Buffer): Promise<EInvoice>
-  
-  // Instance methods
-  validate(level?: ValidationLevel): Promise<ValidationResult>
-  exportXml(format: ExportFormat): Promise<string>
-  exportPdf(format: ExportFormat): Promise<{ buffer: Buffer }>
-  getFormat(): InvoiceFormat
-  
-  // Properties (following TInvoice interface)
-  id: string
-  date: Date
-  from: TParty
-  to: TParty
-  items: TAccountingDocItem[]
-  paymentOptions: TPaymentOptions
-  metadata?: any
-}
-```
-
-### Supported Export Formats
-
-```typescript
-type ExportFormat = 'facturx' | 'zugferd' | 'xrechnung' | 'ubl' | 'cii'
-```
-
-### Validation Levels
-
-```typescript
-enum ValidationLevel {
-  SYNTAX = 'syntax',      // XML structure validation
-  SEMANTIC = 'semantic',  // Field content validation
-  BUSINESS = 'business'   // Business rule validation
-}
-```
-
-## Key Features
-
-1. **PDF Integration**
-   - Embed XML invoices in PDF documents with detailed error reporting
-   - Extract XML from existing PDF invoices using multiple fallback strategies
-   - Handle different XML attachment methods and encodings
+### 💎 Production Excellence
+- **500+ test cases** ensuring reliability
+- **Battle-tested** with real-world invoice corpus
+- **Memory efficient** - handles 1000+ line items
+- **Thread-safe** for concurrent processing
 
-2. **Encoding & Decoding**
-   - Create standards-compliant XML from structured data
-   - Parse XML invoices back to structured data
-   - Support multiple format standards
-   - Circular encoding/decoding integrity
+### 🚀 Developer Experience
+- **IntelliSense everywhere** - fully typed API
+- **Detailed error messages** with recovery hints
+- **Static factory methods** for intuitive usage
+- **Comprehensive documentation** with real examples
 
-3. **Format Detection**
-   - Automatic detection of invoice XML format
-   - Support for different XML namespaces
-   - Graceful handling of malformed XML
+## 📦 Installation Requirements
 
-4. **Validation**
-   - Validate invoices against format-specific rules
-   - Detailed error reporting
-   - Support for different validation levels
+- Node.js 18+ or modern browser
+- TypeScript 5.0+ (for TypeScript projects)
+- ~15MB installed size
+- Zero native dependencies
 
-5. **Error Handling**
-   - Robust error recovery mechanisms
-   - Detailed error information
-   - Type-safe error reporting
+## 🤝 Standards Compliance
 
-By embracing `@fin.cx/einvoice`, you simplify the handling of electronic invoice documents, fostering seamless integration across different financial processes, thus empowering practitioners with robust, flexible tools for VAT invoices in ZUGFeRD/Factur-X compliance or equivalent digital formats.
+This library implements:
+- **EN 16931-1:2017** - Core invoice model
+- **CEN/TS 16931-3** - Syntax bindings
+- **ISO 4217** - Currency codes
+- **ISO 3166** - Country codes
+- **UN/ECE Rec 20** - Units of measure
+- **ISO 6523** - Organization identifiers
 
 ## License and Legal Information
 
-This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
 
 **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.