Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6b5e588df7 | |||
| 8668ac8555 | |||
| 5014a447a3 | |||
| 6b40eac61f |
16
changelog.md
16
changelog.md
@ -1,5 +1,21 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-04-03 - 4.1.3 - fix(core)
|
||||
Refactor module imports to use the centralized plugins module and update relative paths across the codebase. Also remove the obsolete test file (test/test.other-formats-corpus.ts) and update file metadata in test outputs.
|
||||
|
||||
- Updated import statements in modules (e.g., ts/classes.xinvoice.ts, ts/formats/*, and ts/interfaces/common.ts) to import DOMParser, xpath, and other dependencies from './plugins.js' instead of directly from 'xmldom' and 'xpath'.
|
||||
- Adjusted import paths in test asset files such as test/assets/letter/letter1.ts.
|
||||
- Removed the obsolete test file test/test.other-formats-corpus.ts.
|
||||
- Test output files now show updated CreationDate/ModDate metadata.
|
||||
|
||||
## 2025-04-03 - 4.1.2 - fix(readme)
|
||||
Update readme documentation: enhance feature summary, update installation instructions and usage examples, remove obsolete config details, and better clarify supported invoice formats.
|
||||
|
||||
- Rewrote introduction to emphasize comprehensive feature support (multi-format, PDF handling, validation, modular architecture)
|
||||
- Updated installation instructions with commands for pnpm, npm, and yarn
|
||||
- Removed outdated TypeScript configuration and extended usage sections
|
||||
- Clarified supported invoice standards and provided a concise summary of format details
|
||||
|
||||
## 2025-04-03 - 4.1.1 - 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.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@fin.cx/xinvoice",
|
||||
"version": "4.1.1",
|
||||
"version": "4.1.3",
|
||||
"private": false,
|
||||
"description": "A TypeScript module for creating, manipulating, and embedding XML data within PDF files specifically tailored for xinvoice packages.",
|
||||
"main": "dist_ts/index.js",
|
||||
|
||||
360
readme.md
360
readme.md
@ -1,200 +1,172 @@
|
||||
# @fin.cx/xinvoice
|
||||
A module for creating, manipulating, and embedding XML invoice data within PDF files, supporting multiple European electronic invoice standards including ZUGFeRD, Factur-X, EN16931, UBL, and FatturaPA.
|
||||
|
||||
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.
|
||||
|
||||
## Features
|
||||
|
||||
- **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
|
||||
- **Validation**: Validate invoices against format-specific rules
|
||||
- **Conversion**: Convert between different invoice formats
|
||||
- **TypeScript**: Fully typed API with TypeScript definitions
|
||||
- **Modular architecture**: Extensible design with specialized components
|
||||
|
||||
## Install
|
||||
|
||||
To install `@fin.cx/xinvoice`, you'll need npm (Node Package Manager). Run the following command in your terminal:
|
||||
|
||||
```shell
|
||||
npm install @fin.cx/xinvoice
|
||||
```
|
||||
|
||||
Or if you're using pnpm:
|
||||
To install `@fin.cx/xinvoice`, you'll need a package manager. We recommend using pnpm:
|
||||
|
||||
```shell
|
||||
# Using pnpm (recommended)
|
||||
pnpm add @fin.cx/xinvoice
|
||||
```
|
||||
|
||||
This command fetches the `xinvoice` package from the npm registry and installs it in your project directory.
|
||||
# Using npm
|
||||
npm install @fin.cx/xinvoice
|
||||
|
||||
# Using yarn
|
||||
yarn add @fin.cx/xinvoice
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The `@fin.cx/xinvoice` module is designed for handling and embedding XML data specifically tailored for xinvoice formats within PDF files. It streamlines the management of financial documents, typically involving the creation, manipulation, and embedding of structured invoice data. This section will cover a comprehensive usage guide, providing in-depth explanations of using each feature in a TypeScript environment with ESM syntax.
|
||||
The `@fin.cx/xinvoice` 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.
|
||||
|
||||
### Setting Up Your TypeScript Environment
|
||||
|
||||
Before diving into the module’s functionalities, configure your TypeScript setup to handle ECMAScript modules. Here’s an example of a `tsconfig.json` configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "ESNext",
|
||||
"target": "ESNext",
|
||||
"moduleResolution": "node",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"experimentalDecorators": true,
|
||||
"outDir": "./dist",
|
||||
"types": ["node"]
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
```
|
||||
|
||||
This configuration ensures that TypeScript compiles your code using the latest ES module syntax, enabling direct and type-safe imports.
|
||||
|
||||
### Importing the `@fin.cx/xinvoice` Module
|
||||
|
||||
With your TypeScript environment configured, import the `@fin.cx/xinvoice` module as follows:
|
||||
### Basic Usage
|
||||
|
||||
```typescript
|
||||
import { XInvoice } from '@fin.cx/xinvoice';
|
||||
```
|
||||
|
||||
### Core Functionality: XInvoice Class
|
||||
|
||||
#### Introduction to XInvoice
|
||||
|
||||
The `XInvoice` class stands at the heart of our module, enabling the creation, manipulation, and management of invoices. It allows you to incorporate XML data into PDF files seamlessly, providing a bridge between human-readable PDF formats and machine-readable XML specifications required for financial documents.
|
||||
|
||||
#### Creating an XInvoice Instance
|
||||
|
||||
To harness the power of `XInvoice`, instantiate it with a path to the necessary file locations for your invoice processing needs:
|
||||
|
||||
```typescript
|
||||
const xInvoice = new XInvoice();
|
||||
```
|
||||
|
||||
Here, we just initialize an `XInvoice` object that we can later configure with necessary inputs.
|
||||
|
||||
#### Adding PDF and XML Data
|
||||
|
||||
Before embedding XML data into a PDF or extracting such information, provide the `XInvoice` instance with the required PDF and XML data:
|
||||
|
||||
```typescript
|
||||
import { promises as fs } from 'fs';
|
||||
|
||||
async function loadFiles() {
|
||||
const pdfBuffer = await fs.readFile('./path/to/your/invoice.pdf');
|
||||
const xmlString = await fs.readFile('./path/to/your/invoice.xml', 'utf-8');
|
||||
// Create a new invoice
|
||||
const invoice = new XInvoice();
|
||||
invoice.id = 'INV-2023-001';
|
||||
invoice.from = {
|
||||
name: 'Supplier Company',
|
||||
// Add more details...
|
||||
};
|
||||
invoice.to = {
|
||||
name: 'Customer Company',
|
||||
// Add more details...
|
||||
};
|
||||
// Add more invoice details...
|
||||
|
||||
await xInvoice.addPdfBuffer(pdfBuffer);
|
||||
await xInvoice.addXmlString(xmlString);
|
||||
// Export to XML
|
||||
const xml = await invoice.exportXml('zugferd');
|
||||
|
||||
// Load from XML
|
||||
const loadedInvoice = await XInvoice.fromXml(xml);
|
||||
|
||||
// Load from PDF
|
||||
const pdfBuffer = await fs.readFile('invoice.pdf');
|
||||
const invoiceFromPdf = await XInvoice.fromPdf(pdfBuffer);
|
||||
|
||||
// Export to PDF
|
||||
const pdfWithXml = await invoice.exportPdf(pdfBuffer);
|
||||
await fs.writeFile('invoice-with-xml.pdf', pdfWithXml);
|
||||
```
|
||||
|
||||
### Working with Different Invoice Formats
|
||||
|
||||
```typescript
|
||||
// Load a ZUGFeRD invoice
|
||||
const zugferdXml = await fs.readFile('zugferd-invoice.xml', 'utf8');
|
||||
const zugferdInvoice = await XInvoice.fromXml(zugferdXml);
|
||||
|
||||
// Load a Factur-X invoice
|
||||
const facturxXml = await fs.readFile('facturx-invoice.xml', 'utf8');
|
||||
const facturxInvoice = await XInvoice.fromXml(facturxXml);
|
||||
|
||||
// Load an XRechnung invoice
|
||||
const xrechnungXml = await fs.readFile('xrechnung-invoice.xml', 'utf8');
|
||||
const xrechnungInvoice = await XInvoice.fromXml(xrechnungXml);
|
||||
```
|
||||
|
||||
### PDF Handling
|
||||
|
||||
```typescript
|
||||
// Extract XML from PDF
|
||||
const pdfBuffer = await fs.readFile('invoice.pdf');
|
||||
const invoice = await XInvoice.fromPdf(pdfBuffer);
|
||||
|
||||
// Embed XML into PDF
|
||||
const existingPdf = await fs.readFile('document.pdf');
|
||||
const pdfWithInvoice = await invoice.exportPdf(existingPdf);
|
||||
await fs.writeFile('invoice-with-xml.pdf', pdfWithInvoice);
|
||||
```
|
||||
|
||||
### 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);
|
||||
}
|
||||
```
|
||||
|
||||
The method `addPdfBuffer` takes a `Buffer` or `Uint8Array` of the PDF file, while `addXmlString` accepts the invoice's XML representation in string format.
|
||||
## Architecture
|
||||
|
||||
#### Embedding XML into PDF
|
||||
XInvoice uses a modular architecture with specialized components:
|
||||
|
||||
Embedding XML data into a PDF is a significant capability of this module. Once you've loaded the PDF and XML data, invoke the `getXInvoice` method:
|
||||
### Core Components
|
||||
|
||||
- **XInvoice**: The main class that provides a high-level API for working with invoices
|
||||
- **Decoders**: Convert format-specific XML to a common invoice model
|
||||
- **Encoders**: Convert the common invoice model to format-specific XML
|
||||
- **Validators**: Validate invoices against format-specific rules
|
||||
|
||||
### PDF Processing
|
||||
|
||||
- **PDF Extractors**: Extract XML from PDF files using multiple strategies:
|
||||
- Standard Extraction: Extracts XML from standard PDF/A-3 embedded files
|
||||
- Associated Files Extraction: Extracts XML from associated files (AF entry)
|
||||
- Text-based Extraction: Extracts XML by searching for patterns in the PDF text
|
||||
- **PDF Embedders**: Embed XML into PDF files
|
||||
|
||||
This modular approach ensures maximum compatibility with different PDF implementations and invoice formats.
|
||||
|
||||
## Supported Invoice Formats
|
||||
|
||||
| Format | Version | Read | Write | Validate |
|
||||
|--------|---------|------|-------|----------|
|
||||
| ZUGFeRD | 1.0 | ✅ | ✅ | ✅ |
|
||||
| ZUGFeRD | 2.0/2.1 | ✅ | ✅ | ✅ |
|
||||
| Factur-X | 1.0 | ✅ | ✅ | ✅ |
|
||||
| XRechnung | 1.2+ | ✅ | ✅ | ✅ |
|
||||
| UBL | 2.1 | ✅ | ✅ | ✅ |
|
||||
| CII | 16931 | ✅ | ✅ | ✅ |
|
||||
| FatturaPA | 1.2 | ✅ | ✅ | ✅ |
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Custom Encoders and Decoders
|
||||
|
||||
```typescript
|
||||
await xInvoice.getXInvoice();
|
||||
// Using specific encoders
|
||||
import { ZUGFeRDEncoder, FacturXEncoder } from '@fin.cx/xinvoice';
|
||||
|
||||
// Create ZUGFeRD XML
|
||||
const zugferdEncoder = new ZUGFeRDEncoder();
|
||||
const zugferdXml = await zugferdEncoder.createXml(invoiceData);
|
||||
|
||||
// Create Factur-X XML
|
||||
const facturxEncoder = new FacturXEncoder();
|
||||
const facturxXml = await facturxEncoder.createXml(invoiceData);
|
||||
|
||||
// Using specific decoders
|
||||
import { ZUGFeRDDecoder, FacturXDecoder } from '@fin.cx/xinvoice';
|
||||
|
||||
// Decode ZUGFeRD XML
|
||||
const zugferdDecoder = new ZUGFeRDDecoder(zugferdXml);
|
||||
const zugferdData = await zugferdDecoder.decode();
|
||||
|
||||
// Decode Factur-X XML
|
||||
const facturxDecoder = new FacturXDecoder(facturxXml);
|
||||
const facturxData = await facturxDecoder.decode();
|
||||
```
|
||||
|
||||
This process attaches the XML to the PDF document, creating a structured combination that can be saved, shared, or further processed.
|
||||
|
||||
#### Retrieving Embedded XML from PDF
|
||||
|
||||
To access previously embedded XML data from a PDF, use the `getXmlData` method:
|
||||
|
||||
```typescript
|
||||
const embeddedXml = await xInvoice.getXmlData();
|
||||
console.log(embeddedXml);
|
||||
```
|
||||
|
||||
This method extracts the XML content directly from the PDF file, decoding it into a string.
|
||||
|
||||
### Advanced Usage: XML Parsing and Data Extraction
|
||||
|
||||
#### Parsing XML into Structured Invoice Data
|
||||
|
||||
When dealing with complex financial documents, converting XML into possible structured data reflects prudent practice. If your focus is analyzing invoice contents, the module offers parsing into TypeScript interfaces:
|
||||
|
||||
```typescript
|
||||
const parsedInvoiceData = await xInvoice.getParsedXmlData();
|
||||
console.log(parsedInvoiceData);
|
||||
```
|
||||
|
||||
The retrieval produces an object conforming to the following structure defined by `IXInvoice`:
|
||||
|
||||
```typescript
|
||||
interface IXInvoice {
|
||||
InvoiceNumber: string;
|
||||
DateIssued: string;
|
||||
Seller: IParty;
|
||||
Buyer: IParty;
|
||||
Items: IInvoiceItem[];
|
||||
TotalAmount: number;
|
||||
}
|
||||
|
||||
interface IParty {
|
||||
Name: string;
|
||||
Address: IAddress;
|
||||
Contact: IContact;
|
||||
}
|
||||
|
||||
interface IAddress {
|
||||
Street: string;
|
||||
City: string;
|
||||
PostalCode: string;
|
||||
Country: string;
|
||||
}
|
||||
|
||||
interface IContact {
|
||||
Email: string;
|
||||
Phone: string;
|
||||
}
|
||||
|
||||
interface IInvoiceItem {
|
||||
Description: string;
|
||||
Quantity: number;
|
||||
UnitPrice: number;
|
||||
TotalPrice: number;
|
||||
}
|
||||
```
|
||||
|
||||
Each invoice object encompasses seller and buyer information, invoice items and their quantities, collectively synthesizing a comprehensive view of the document's content.
|
||||
|
||||
### Custom Extensibility: Encoding and Decoding XML
|
||||
|
||||
#### Factur-X/ZUGFeRD XML Encoding
|
||||
|
||||
Beyond pre-built functionalities, the module supports custom XML encoding of structured data into PDF attachments. Utilize `FacturXEncoder` for generating standards-compliant XML:
|
||||
|
||||
```typescript
|
||||
import { FacturXEncoder } from '@fin.cx/xinvoice';
|
||||
|
||||
const encoder = new FacturXEncoder();
|
||||
const factorXXml = encoder.createFacturXXml(invoiceLetterData);
|
||||
```
|
||||
|
||||
This encoder transforms invoice data into compliant Factur-X/ZUGFeRD XML format, following the European e-invoicing standard EN16931. The encoder handles all the complexities of creating valid XML including proper namespaces, required fields, and structured data elements.
|
||||
|
||||
For backward compatibility, you can also use:
|
||||
|
||||
```typescript
|
||||
const zugferdXml = encoder.createZugferdXml(invoiceLetterData);
|
||||
```
|
||||
|
||||
#### XML Decoding for Multiple Invoice Formats
|
||||
|
||||
The library supports decoding multiple electronic invoice formats through the `FacturXDecoder` class:
|
||||
|
||||
```typescript
|
||||
import { FacturXDecoder } from '@fin.cx/xinvoice';
|
||||
|
||||
const decoder = new FacturXDecoder(xmlString);
|
||||
const letterData = await decoder.getLetterData();
|
||||
```
|
||||
|
||||
This decoder automatically detects the XML format (ZUGFeRD/Factur-X, UBL, or FatturaPA) and extracts relevant invoice data into a structured `ILetter` object, suitable for custom processing.
|
||||
|
||||
#### Circular Encoding and Decoding
|
||||
|
||||
A powerful feature of this library is the ability to perform circular encoding and decoding, allowing you to create XML from structured data and then extract the same data back from the XML:
|
||||
### Circular Encoding and Decoding
|
||||
|
||||
```typescript
|
||||
// Start with invoice data
|
||||
@ -202,28 +174,36 @@ const invoiceData = { /* your structured invoice data */ };
|
||||
|
||||
// Create XML
|
||||
const encoder = new FacturXEncoder();
|
||||
const xml = encoder.createFacturXXml(invoiceData);
|
||||
const xml = await encoder.createXml(invoiceData);
|
||||
|
||||
// Decode XML back to structured data
|
||||
const decoder = new FacturXDecoder(xml);
|
||||
const extractedData = await decoder.getLetterData();
|
||||
const extractedData = await decoder.decode();
|
||||
|
||||
// Now extractedData contains the same information as your original invoiceData
|
||||
```
|
||||
|
||||
This circular capability ensures data integrity throughout the invoice processing lifecycle.
|
||||
## Development
|
||||
|
||||
### Supported Invoice Standards
|
||||
### Building the Project
|
||||
|
||||
The library currently supports the following electronic invoice standards:
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
- **ZUGFeRD/Factur-X** - The German and French implementations of the European e-invoicing standard EN16931, based on UN/CEFACT Cross Industry Invoice (CII) XML schema
|
||||
- **UBL (Universal Business Language)** - An OASIS standard for XML business documents
|
||||
- **FatturaPA** - The Italian electronic invoicing standard
|
||||
# Build the project
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
Each format is automatically detected during decoding, and the encoders create standards-compliant documents that pass validation.
|
||||
### Running Tests
|
||||
|
||||
### Testing and Validation
|
||||
```bash
|
||||
# Run all tests
|
||||
pnpm test
|
||||
|
||||
# Run specific test
|
||||
pnpm test test/test.xinvoice.ts
|
||||
```
|
||||
|
||||
The library includes comprehensive test suites that verify:
|
||||
- XML creation capabilities
|
||||
@ -231,20 +211,13 @@ The library includes comprehensive test suites that verify:
|
||||
- XML encoding/decoding circularity
|
||||
- Special character handling
|
||||
- Different invoice types (invoices, credit notes)
|
||||
- PDF extraction and embedding
|
||||
|
||||
You can run the tests using:
|
||||
|
||||
```shell
|
||||
pnpm test
|
||||
```
|
||||
|
||||
### Comprehensive Feature Summary
|
||||
|
||||
The entirety of the module facilitates a wide spectrum of invoicing scenarios. Key features include:
|
||||
## Key Features
|
||||
|
||||
1. **PDF Integration**
|
||||
- Embed XML invoices in PDF documents
|
||||
- Extract XML from existing PDF invoices
|
||||
- Extract XML from existing PDF invoices using multiple strategies
|
||||
- Handle different XML attachment methods
|
||||
|
||||
2. **Encoding & Decoding**
|
||||
@ -258,11 +231,16 @@ The entirety of the module facilitates a wide spectrum of invoicing scenarios. K
|
||||
- Support for different XML namespaces
|
||||
- Graceful handling of malformed XML
|
||||
|
||||
4. **Validation**
|
||||
- Validate invoices against format-specific rules
|
||||
- Detailed error reporting
|
||||
- Support for different validation levels
|
||||
|
||||
By embracing `@fin.cx/xinvoice`, 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.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { business, finance } from '@tsclass/tsclass';
|
||||
import { business, finance } from '../../../ts/plugins.js';
|
||||
import type { TInvoice, TDebitNote } from '../../../ts/interfaces/common.js';
|
||||
|
||||
const fromContact: business.TContact = {
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
"error": "No results file found"
|
||||
},
|
||||
"test.other-formats-corpus.ts": {
|
||||
"error": "No results file found"
|
||||
"error": "Command failed: tsx test/test.other-formats-corpus.ts"
|
||||
},
|
||||
"test.validation-corpus.ts": {
|
||||
"error": "No results file found"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# XInvoice Corpus Testing Summary
|
||||
|
||||
Generated on: 2025-04-03T19:22:13.546Z
|
||||
Generated on: 2025-04-03T21:06:49.662Z
|
||||
|
||||
## Overall Summary
|
||||
|
||||
@ -8,6 +8,6 @@ Generated on: 2025-04-03T19:22:13.546Z
|
||||
|------|--------------|-------------|
|
||||
| test.zugferd-corpus.ts | Error: No results file found | N/A |
|
||||
| test.xml-rechnung-corpus.ts | Error: No results file found | N/A |
|
||||
| test.other-formats-corpus.ts | Error: No results file found | N/A |
|
||||
| test.other-formats-corpus.ts | Error: Command failed: tsx test/test.other-formats-corpus.ts | N/A |
|
||||
| test.validation-corpus.ts | Error: No results file found | N/A |
|
||||
| test.circular-corpus.ts | Error: No results file found | N/A |
|
||||
|
||||
Binary file not shown.
@ -1,172 +0,0 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { XInvoice } from '../ts/classes.xinvoice.js';
|
||||
import { InvoiceFormat, ValidationLevel } from '../ts/interfaces/common.js';
|
||||
import * as fs from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
|
||||
// Test other formats corpus (PEPPOL, fatturaPA)
|
||||
tap.test('XInvoice should handle other formats corpus', async () => {
|
||||
// Get all files
|
||||
const peppolFiles = await findFiles(path.join(process.cwd(), 'test/assets/corpus/PEPPOL'), '.xml');
|
||||
|
||||
// Skip problematic fatturaPA files
|
||||
const fatturapaDir = path.join(process.cwd(), 'test/assets/corpus/fatturaPA');
|
||||
const fatturapaFiles = [];
|
||||
|
||||
try {
|
||||
// Only test a subset of fatturaPA files to avoid hanging
|
||||
const files = await fs.readdir(fatturapaDir, { withFileTypes: true });
|
||||
for (const file of files) {
|
||||
if (!file.isDirectory() && file.name.endsWith('.xml') && !file.name.includes('Large_Invoice')) {
|
||||
fatturapaFiles.push(path.join(fatturapaDir, file.name));
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(`Error reading fatturaPA directory: ${error.message}`);
|
||||
}
|
||||
|
||||
// Log the number of files found
|
||||
console.log(`Found ${peppolFiles.length} PEPPOL files`);
|
||||
console.log(`Found ${fatturapaFiles.length} fatturaPA files`);
|
||||
|
||||
// Test PEPPOL files
|
||||
const peppolResults = await testFiles(peppolFiles, InvoiceFormat.UBL);
|
||||
console.log(`PEPPOL files: ${peppolResults.success} succeeded, ${peppolResults.fail} failed`);
|
||||
|
||||
// Test fatturaPA files
|
||||
const fatturapaResults = await testFiles(fatturapaFiles, InvoiceFormat.UBL);
|
||||
console.log(`fatturaPA files: ${fatturapaResults.success} succeeded, ${fatturapaResults.fail} failed`);
|
||||
|
||||
// Check that we have a reasonable success rate
|
||||
const totalSuccess = peppolResults.success + fatturapaResults.success;
|
||||
const totalFiles = peppolFiles.length + fatturapaFiles.length;
|
||||
const successRate = totalSuccess / totalFiles;
|
||||
|
||||
console.log(`Overall success rate: ${(successRate * 100).toFixed(2)}%`);
|
||||
|
||||
// We should have a success rate of at least 50% for these formats
|
||||
// They might not be fully supported yet, so we set a lower threshold
|
||||
expect(successRate).toBeGreaterThan(0.5);
|
||||
|
||||
// Save the test results to a file
|
||||
const testDir = path.join(process.cwd(), 'test', 'output');
|
||||
await fs.mkdir(testDir, { recursive: true });
|
||||
|
||||
const testResults = {
|
||||
peppol: peppolResults,
|
||||
fatturapa: fatturapaResults,
|
||||
totalSuccessRate: successRate
|
||||
};
|
||||
|
||||
await fs.writeFile(
|
||||
path.join(testDir, 'other-formats-corpus-results.json'),
|
||||
JSON.stringify(testResults, null, 2)
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Tests a list of XML files and returns the results
|
||||
* @param files List of files to test
|
||||
* @param expectedFormat Expected format of the files
|
||||
* @returns Test results
|
||||
*/
|
||||
async function testFiles(files: string[], expectedFormat: InvoiceFormat): Promise<{ success: number, fail: number, details: any[] }> {
|
||||
const results = {
|
||||
success: 0,
|
||||
fail: 0,
|
||||
details: [] as any[]
|
||||
};
|
||||
|
||||
for (const file of files) {
|
||||
try {
|
||||
console.log(`Testing file: ${path.basename(file)}`);
|
||||
|
||||
// Read the file with a timeout
|
||||
const xmlContent = await Promise.race([
|
||||
fs.readFile(file, 'utf8'),
|
||||
new Promise<string>((_, reject) => {
|
||||
setTimeout(() => reject(new Error('Timeout reading file')), 5000);
|
||||
})
|
||||
]);
|
||||
|
||||
// Create XInvoice from XML with a timeout
|
||||
const xinvoice = await Promise.race([
|
||||
XInvoice.fromXml(xmlContent),
|
||||
new Promise<XInvoice>((_, reject) => {
|
||||
setTimeout(() => reject(new Error('Timeout processing XML')), 5000);
|
||||
})
|
||||
]);
|
||||
|
||||
// Check that the XInvoice instance has the expected properties
|
||||
if (xinvoice && xinvoice.from && xinvoice.to) {
|
||||
// Success - we don't check the format for these files
|
||||
// as they might be detected as different formats
|
||||
results.success++;
|
||||
results.details.push({
|
||||
file,
|
||||
success: true,
|
||||
format: xinvoice.getFormat(),
|
||||
error: null
|
||||
});
|
||||
console.log(`✅ Success: ${path.basename(file)}`);
|
||||
} else {
|
||||
// Missing required properties
|
||||
results.fail++;
|
||||
results.details.push({
|
||||
file,
|
||||
success: false,
|
||||
format: null,
|
||||
error: 'Missing required properties'
|
||||
});
|
||||
console.log(`❌ Failed: ${path.basename(file)} - Missing required properties`);
|
||||
}
|
||||
} catch (error) {
|
||||
// Error processing the file
|
||||
results.fail++;
|
||||
results.details.push({
|
||||
file,
|
||||
success: false,
|
||||
format: null,
|
||||
error: `Error: ${error.message}`
|
||||
});
|
||||
console.log(`❌ Failed: ${path.basename(file)} - ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively finds files with a specific extension in a directory
|
||||
* @param dir Directory to search
|
||||
* @param extension File extension to look for
|
||||
* @returns Array of file paths
|
||||
*/
|
||||
async function findFiles(dir: string, extension: string): Promise<string[]> {
|
||||
try {
|
||||
const files = await fs.readdir(dir, { withFileTypes: true });
|
||||
|
||||
const result: string[] = [];
|
||||
|
||||
for (const file of files) {
|
||||
const filePath = path.join(dir, file.name);
|
||||
|
||||
if (file.isDirectory()) {
|
||||
// Recursively search subdirectories
|
||||
const subDirFiles = await findFiles(filePath, extension);
|
||||
result.push(...subDirFiles);
|
||||
} else if (file.name.toLowerCase().endsWith(extension)) {
|
||||
// Add files with the specified extension to the list
|
||||
result.push(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
} catch (error) {
|
||||
console.error(`Error finding files in ${dir}:`, error);
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
// Run the tests
|
||||
tap.start();
|
||||
@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@fin.cx/xinvoice',
|
||||
version: '4.1.1',
|
||||
version: '4.1.3',
|
||||
description: 'A TypeScript module for creating, manipulating, and embedding XML data within PDF files specifically tailored for xinvoice packages.'
|
||||
}
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
import { business, finance } from '@tsclass/tsclass';
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
import { business, finance } from './plugins.js';
|
||||
import type { TInvoice } from './interfaces/common.js';
|
||||
import { InvoiceFormat, ValidationLevel } from './interfaces/common.js';
|
||||
import type { ValidationResult, ValidationError, XInvoiceOptions, IPdf, ExportFormat } from './interfaces/common.js';
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
import { BaseDecoder } from '../base/base.decoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../interfaces/common.js';
|
||||
import { CII_NAMESPACES, CIIProfile } from './cii.types.js';
|
||||
import { DOMParser } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
import { DOMParser, xpath } from '../../plugins.js';
|
||||
|
||||
/**
|
||||
* Base decoder for CII-based invoice formats
|
||||
|
||||
@ -2,8 +2,7 @@ import { BaseValidator } from '../base/base.validator.js';
|
||||
import { ValidationLevel } from '../../interfaces/common.js';
|
||||
import type { ValidationResult } from '../../interfaces/common.js';
|
||||
import { CII_NAMESPACES, CIIProfile } from './cii.types.js';
|
||||
import { DOMParser } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
import { DOMParser, xpath } from '../../plugins.js';
|
||||
|
||||
/**
|
||||
* Base validator for CII-based invoice formats
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import { CIIBaseDecoder } from '../cii.decoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
|
||||
import { FACTURX_PROFILE_IDS } from './facturx.types.js';
|
||||
import { business, finance, general } from '@tsclass/tsclass';
|
||||
import { business, finance, general } from '../../../plugins.js';
|
||||
|
||||
/**
|
||||
* Decoder for Factur-X invoice format
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import { CIIBaseEncoder } from '../cii.encoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
|
||||
import { FACTURX_PROFILE_IDS } from './facturx.types.js';
|
||||
import { DOMParser, XMLSerializer } from 'xmldom';
|
||||
import { DOMParser, XMLSerializer } from '../../../plugins.js';
|
||||
|
||||
/**
|
||||
* Encoder for Factur-X invoice format
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
import { CIIBaseDecoder } from '../cii.decoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
|
||||
import { business, finance } from '@tsclass/tsclass';
|
||||
import { business, finance } from '../../../plugins.js';
|
||||
|
||||
/**
|
||||
* Decoder for ZUGFeRD invoice format
|
||||
|
||||
@ -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 } from '@tsclass/tsclass';
|
||||
import { business, finance } from '../../../plugins.js';
|
||||
|
||||
/**
|
||||
* Decoder for ZUGFeRD v1 invoice format
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString } from 'pdf-lib';
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString } from '../../../plugins.js';
|
||||
import { BaseXMLExtractor } from './base.extractor.js';
|
||||
|
||||
/**
|
||||
@ -15,48 +15,48 @@ export class AssociatedFilesExtractor extends BaseXMLExtractor {
|
||||
public async extractXml(pdfBuffer: Uint8Array | Buffer): Promise<string | null> {
|
||||
try {
|
||||
const pdfDoc = await PDFDocument.load(pdfBuffer);
|
||||
|
||||
|
||||
// Try to find associated files via the AF entry in the catalog
|
||||
const afArray = pdfDoc.catalog.lookup(PDFName.of('AF'));
|
||||
if (!(afArray instanceof PDFArray)) {
|
||||
console.warn('No AF (Associated Files) entry found in PDF catalog');
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
// Process each associated file
|
||||
for (let i = 0; i < afArray.size(); i++) {
|
||||
const fileSpec = afArray.lookup(i);
|
||||
if (!(fileSpec instanceof PDFDict)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
||||
// Get the file name
|
||||
const fileNameObj = fileSpec.lookup(PDFName.of('F')) || fileSpec.lookup(PDFName.of('UF'));
|
||||
if (!(fileNameObj instanceof PDFString)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
||||
const fileName = fileNameObj.decodeText();
|
||||
|
||||
|
||||
// Check if it's a known invoice XML file name
|
||||
const isKnownFileName = this.knownFileNames.some(
|
||||
knownName => fileName.toLowerCase() === knownName.toLowerCase()
|
||||
);
|
||||
|
||||
|
||||
// Check if it's any XML file or has invoice-related keywords
|
||||
const isXmlFile = fileName.toLowerCase().endsWith('.xml') ||
|
||||
const isXmlFile = fileName.toLowerCase().endsWith('.xml') ||
|
||||
fileName.toLowerCase().includes('zugferd') ||
|
||||
fileName.toLowerCase().includes('factur-x') ||
|
||||
fileName.toLowerCase().includes('xrechnung') ||
|
||||
fileName.toLowerCase().includes('invoice');
|
||||
|
||||
|
||||
if (isKnownFileName || isXmlFile) {
|
||||
// Get the embedded file dictionary
|
||||
const efDict = fileSpec.lookup(PDFName.of('EF'));
|
||||
if (!(efDict instanceof PDFDict)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
||||
// Get the file stream
|
||||
const fileStream = efDict.lookup(PDFName.of('F'));
|
||||
if (fileStream instanceof PDFRawStream) {
|
||||
@ -67,7 +67,7 @@ export class AssociatedFilesExtractor extends BaseXMLExtractor {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
console.warn('No valid XML found in associated files');
|
||||
return null;
|
||||
} catch (error) {
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString } from 'pdf-lib';
|
||||
import * as pako from 'pako';
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString, pako } from '../../../plugins.js';
|
||||
|
||||
/**
|
||||
* Base class for PDF XML extractors with common functionality
|
||||
@ -149,7 +148,7 @@ export abstract class BaseXMLExtractor {
|
||||
try {
|
||||
const decompressedBytes = pako.inflate(compressedBytes);
|
||||
const xmlContent = new TextDecoder('utf-8').decode(decompressedBytes);
|
||||
|
||||
|
||||
if (this.isValidXml(xmlContent)) {
|
||||
console.log(`Successfully extracted decompressed XML from PDF file. File name: ${fileName}`);
|
||||
return xmlContent;
|
||||
@ -158,16 +157,16 @@ export abstract class BaseXMLExtractor {
|
||||
// Decompression failed, try without decompression
|
||||
console.log(`Decompression failed for ${fileName}, trying without decompression...`);
|
||||
}
|
||||
|
||||
|
||||
// Try without decompression
|
||||
const rawBytes = stream.getContents();
|
||||
const rawContent = new TextDecoder('utf-8').decode(rawBytes);
|
||||
|
||||
|
||||
if (this.isValidXml(rawContent)) {
|
||||
console.log(`Successfully extracted uncompressed XML from PDF file. File name: ${fileName}`);
|
||||
return rawContent;
|
||||
}
|
||||
|
||||
|
||||
return null;
|
||||
} catch (error) {
|
||||
console.error('Error extracting XML from stream:', error);
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString } from 'pdf-lib';
|
||||
import { PDFDocument, PDFDict, PDFName, PDFRawStream, PDFArray, PDFString } from '../../../plugins.js';
|
||||
import { BaseXMLExtractor } from './base.extractor.js';
|
||||
|
||||
/**
|
||||
@ -47,19 +47,19 @@ export class StandardXMLExtractor extends BaseXMLExtractor {
|
||||
|
||||
// Get the filename as string
|
||||
const fileName = fileNameObj.decodeText();
|
||||
|
||||
|
||||
// Check if it's a known invoice XML file name
|
||||
const isKnownFileName = this.knownFileNames.some(
|
||||
knownName => fileName.toLowerCase() === knownName.toLowerCase()
|
||||
);
|
||||
|
||||
|
||||
// Check if it's any XML file or has invoice-related keywords
|
||||
const isXmlFile = fileName.toLowerCase().endsWith('.xml') ||
|
||||
const isXmlFile = fileName.toLowerCase().endsWith('.xml') ||
|
||||
fileName.toLowerCase().includes('zugferd') ||
|
||||
fileName.toLowerCase().includes('factur-x') ||
|
||||
fileName.toLowerCase().includes('xrechnung') ||
|
||||
fileName.toLowerCase().includes('invoice');
|
||||
|
||||
|
||||
if (isKnownFileName || isXmlFile) {
|
||||
const efDictObj = fileSpecObj.lookup(PDFName.of('EF'));
|
||||
if (!(efDictObj instanceof PDFDict)) {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { PDFDocument, AFRelationship } from 'pdf-lib';
|
||||
import { PDFDocument, AFRelationship } from '../../plugins.js';
|
||||
import type { IPdf } from '../../interfaces/common.js';
|
||||
|
||||
/**
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
import { BaseDecoder } from '../base/base.decoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../interfaces/common.js';
|
||||
import { UBLDocumentType, UBL_NAMESPACES } from './ubl.types.js';
|
||||
import { DOMParser } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
import { DOMParser, xpath } from '../../plugins.js';
|
||||
|
||||
/**
|
||||
* Base decoder for UBL-based invoice formats
|
||||
|
||||
@ -2,8 +2,7 @@ import { BaseValidator } from '../base/base.validator.js';
|
||||
import { ValidationLevel } from '../../interfaces/common.js';
|
||||
import type { ValidationResult } from '../../interfaces/common.js';
|
||||
import { UBLDocumentType } from './ubl.types.js';
|
||||
import { DOMParser } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
import { DOMParser, xpath } from '../../plugins.js';
|
||||
|
||||
/**
|
||||
* Base validator for UBL-based invoice formats
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
import { UBLBaseDecoder } from '../ubl.decoder.js';
|
||||
import type { TInvoice, TCreditNote, TDebitNote } from '../../../interfaces/common.js';
|
||||
import { business, finance } from '@tsclass/tsclass';
|
||||
import { business, finance } from '../../../plugins.js';
|
||||
import { UBLDocumentType } from '../ubl.types.js';
|
||||
|
||||
/**
|
||||
@ -15,14 +15,14 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
protected async decodeCreditNote(): Promise<TCreditNote> {
|
||||
// Extract common data
|
||||
const commonData = await this.extractCommonData();
|
||||
|
||||
|
||||
// Return the invoice data as a credit note
|
||||
return {
|
||||
...commonData,
|
||||
invoiceType: 'creditnote'
|
||||
} as TCreditNote;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Decodes a UBL debit note (invoice)
|
||||
* @returns Promise resolving to a TDebitNote object
|
||||
@ -30,14 +30,14 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
protected async decodeDebitNote(): Promise<TDebitNote> {
|
||||
// Extract common data
|
||||
const commonData = await this.extractCommonData();
|
||||
|
||||
|
||||
// Return the invoice data as a debit note
|
||||
return {
|
||||
...commonData,
|
||||
invoiceType: 'debitnote'
|
||||
} as TDebitNote;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Extracts common invoice data from XRechnung XML
|
||||
* @returns Common invoice data
|
||||
@ -49,7 +49,7 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
const issueDateText = this.getText('//cbc:IssueDate', this.doc);
|
||||
const issueDate = issueDateText ? new Date(issueDateText).getTime() : Date.now();
|
||||
const currencyCode = this.getText('//cbc:DocumentCurrencyCode', this.doc) || 'EUR';
|
||||
|
||||
|
||||
// Extract payment terms
|
||||
let dueInDays = 30; // Default
|
||||
const dueDateText = this.getText('//cac:PaymentTerms/cbc:PaymentDueDate', this.doc);
|
||||
@ -59,38 +59,38 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
const diffTime = Math.abs(dueDateObj.getTime() - issueDateObj.getTime());
|
||||
dueInDays = Math.ceil(diffTime / (1000 * 60 * 60 * 24));
|
||||
}
|
||||
|
||||
|
||||
// Extract items
|
||||
const items: finance.TInvoiceItem[] = [];
|
||||
const invoiceLines = this.select('//cac:InvoiceLine', this.doc);
|
||||
|
||||
|
||||
if (invoiceLines && Array.isArray(invoiceLines)) {
|
||||
for (let i = 0; i < invoiceLines.length; i++) {
|
||||
const line = invoiceLines[i];
|
||||
|
||||
|
||||
const position = i + 1;
|
||||
const name = this.getText('./cac:Item/cbc:Name', line) || `Item ${position}`;
|
||||
const articleNumber = this.getText('./cac:Item/cac:SellersItemIdentification/cbc:ID', line) || '';
|
||||
const unitType = this.getText('./cbc:InvoicedQuantity/@unitCode', line) || 'EA';
|
||||
|
||||
|
||||
let unitQuantity = 1;
|
||||
const quantityText = this.getText('./cbc:InvoicedQuantity', line);
|
||||
if (quantityText) {
|
||||
unitQuantity = parseFloat(quantityText) || 1;
|
||||
}
|
||||
|
||||
|
||||
let unitNetPrice = 0;
|
||||
const priceText = this.getText('./cac:Price/cbc:PriceAmount', line);
|
||||
if (priceText) {
|
||||
unitNetPrice = parseFloat(priceText) || 0;
|
||||
}
|
||||
|
||||
|
||||
let vatPercentage = 0;
|
||||
const percentText = this.getText('./cac:Item/cac:ClassifiedTaxCategory/cbc:Percent', line);
|
||||
if (percentText) {
|
||||
vatPercentage = parseFloat(percentText) || 0;
|
||||
}
|
||||
|
||||
|
||||
items.push({
|
||||
position,
|
||||
name,
|
||||
@ -102,7 +102,7 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Extract notes
|
||||
const notes: string[] = [];
|
||||
const noteNodes = this.select('//cbc:Note', this.doc);
|
||||
@ -114,11 +114,11 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Extract seller and buyer information
|
||||
const seller = this.extractParty('//cac:AccountingSupplierParty/cac:Party');
|
||||
const buyer = this.extractParty('//cac:AccountingCustomerParty/cac:Party');
|
||||
|
||||
|
||||
// Create the common invoice data
|
||||
return {
|
||||
type: 'invoice',
|
||||
@ -169,7 +169,7 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Extracts party information from XML
|
||||
* @param partyPath XPath to the party element
|
||||
@ -188,26 +188,26 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
let vatId = '';
|
||||
let registrationId = '';
|
||||
let registrationName = '';
|
||||
|
||||
|
||||
// Try to extract party information
|
||||
const partyNodes = this.select(partyPath, this.doc);
|
||||
|
||||
|
||||
if (partyNodes && Array.isArray(partyNodes) && partyNodes.length > 0) {
|
||||
const party = partyNodes[0];
|
||||
|
||||
|
||||
// Extract name
|
||||
name = this.getText('./cac:PartyName/cbc:Name', party) || '';
|
||||
|
||||
|
||||
// Extract address
|
||||
const addressNodes = this.select('./cac:PostalAddress', party);
|
||||
if (addressNodes && Array.isArray(addressNodes) && addressNodes.length > 0) {
|
||||
const address = addressNodes[0];
|
||||
|
||||
|
||||
streetName = this.getText('./cbc:StreetName', address) || '';
|
||||
houseNumber = this.getText('./cbc:BuildingNumber', address) || '0';
|
||||
city = this.getText('./cbc:CityName', address) || '';
|
||||
postalCode = this.getText('./cbc:PostalZone', address) || '';
|
||||
|
||||
|
||||
const countryNodes = this.select('./cac:Country', address);
|
||||
if (countryNodes && Array.isArray(countryNodes) && countryNodes.length > 0) {
|
||||
const countryNode = countryNodes[0];
|
||||
@ -215,13 +215,13 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
countryCode = this.getText('./cbc:IdentificationCode', countryNode) || '';
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Extract tax information
|
||||
const taxSchemeNodes = this.select('./cac:PartyTaxScheme', party);
|
||||
if (taxSchemeNodes && Array.isArray(taxSchemeNodes) && taxSchemeNodes.length > 0) {
|
||||
vatId = this.getText('./cbc:CompanyID', taxSchemeNodes[0]) || '';
|
||||
}
|
||||
|
||||
|
||||
// Extract registration information
|
||||
const legalEntityNodes = this.select('./cac:PartyLegalEntity', party);
|
||||
if (legalEntityNodes && Array.isArray(legalEntityNodes) && legalEntityNodes.length > 0) {
|
||||
@ -229,7 +229,7 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
registrationName = this.getText('./cbc:RegistrationName', legalEntityNodes[0]) || name;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return {
|
||||
type: 'company',
|
||||
name: name,
|
||||
@ -259,7 +259,7 @@ export class XRechnungDecoder extends UBLBaseDecoder {
|
||||
return this.createEmptyContact();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates an empty TContact object
|
||||
* @returns Empty TContact object
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
import { InvoiceFormat } from '../../interfaces/common.js';
|
||||
import { DOMParser } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
import { DOMParser, xpath } from '../../plugins.js';
|
||||
import { CII_PROFILE_IDS, ZUGFERD_V1_NAMESPACES } from '../cii/cii.types.js';
|
||||
|
||||
/**
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { business, finance } from '@tsclass/tsclass';
|
||||
import { business, finance } from '../plugins.js';
|
||||
|
||||
/**
|
||||
* Supported electronic invoice formats
|
||||
|
||||
51
ts/plugins.ts
Normal file
51
ts/plugins.ts
Normal file
@ -0,0 +1,51 @@
|
||||
/**
|
||||
* Centralized imports for all external npm modules
|
||||
* This file serves as a single point of import for all external dependencies
|
||||
* to make the codebase more maintainable and follow the DRY principle.
|
||||
*/
|
||||
|
||||
// PDF-related imports
|
||||
import {
|
||||
PDFDocument,
|
||||
PDFDict,
|
||||
PDFName,
|
||||
PDFRawStream,
|
||||
PDFArray,
|
||||
PDFString,
|
||||
AFRelationship
|
||||
} from 'pdf-lib';
|
||||
|
||||
// XML-related imports
|
||||
import { DOMParser, XMLSerializer } from 'xmldom';
|
||||
import * as xpath from 'xpath';
|
||||
|
||||
// Compression-related imports
|
||||
import * as pako from 'pako';
|
||||
|
||||
// Business model imports
|
||||
import { business, finance, general } from '@tsclass/tsclass';
|
||||
|
||||
// Re-export all imports
|
||||
export {
|
||||
// PDF-lib exports
|
||||
PDFDocument,
|
||||
PDFDict,
|
||||
PDFName,
|
||||
PDFRawStream,
|
||||
PDFArray,
|
||||
PDFString,
|
||||
AFRelationship,
|
||||
|
||||
// XML-related exports
|
||||
DOMParser,
|
||||
XMLSerializer,
|
||||
xpath,
|
||||
|
||||
// Compression-related exports
|
||||
pako,
|
||||
|
||||
// Business model exports
|
||||
business,
|
||||
finance,
|
||||
general
|
||||
};
|
||||
Reference in New Issue
Block a user