@fin.cx/einvoice 5.0.2

package/ts/index.ts

@@ -0,0 +1,164 @@
+// Import main class
+import { EInvoice } from './einvoice.js';
+
+// Import interfaces
+import * as common from './interfaces/common.js';
+
+// Import factories
+import { DecoderFactory } from './formats/factories/decoder.factory.js';
+import { EncoderFactory } from './formats/factories/encoder.factory.js';
+import { ValidatorFactory } from './formats/factories/validator.factory.js';
+
+// Import base classes
+import { BaseDecoder } from './formats/base/base.decoder.js';
+import { BaseEncoder } from './formats/base/base.encoder.js';
+import { BaseValidator } from './formats/base/base.validator.js';
+
+// Import UBL base classes
+import { UBLBaseDecoder } from './formats/ubl/ubl.decoder.js';
+import { UBLBaseEncoder } from './formats/ubl/ubl.encoder.js';
+import { UBLBaseValidator } from './formats/ubl/ubl.validator.js';
+
+// Import CII base classes
+import { CIIBaseDecoder } from './formats/cii/cii.decoder.js';
+import { CIIBaseEncoder } from './formats/cii/cii.encoder.js';
+import { CIIBaseValidator } from './formats/cii/cii.validator.js';
+
+// Import PDF utilities
+import { PDFEmbedder } from './formats/pdf/pdf.embedder.js';
+import { PDFExtractor } from './formats/pdf/pdf.extractor.js';
+import {
+  BaseXMLExtractor,
+  StandardXMLExtractor,
+  AssociatedFilesExtractor,
+  TextXMLExtractor
+} from './formats/pdf/extractors/index.js';
+
+// Import format detector
+import { FormatDetector } from './formats/utils/format.detector.js';
+
+// Import error classes
+import {
+  EInvoiceError,
+  EInvoiceParsingError,
+  EInvoiceValidationError,
+  EInvoicePDFError,
+  EInvoiceFormatError,
+  ErrorRecovery,
+  ErrorContext
+} from './errors.js';
+
+// Import Factur-X implementation
+import { FacturXDecoder } from './formats/cii/facturx/facturx.decoder.js';
+import { FacturXEncoder } from './formats/cii/facturx/facturx.encoder.js';
+import { FacturXValidator } from './formats/cii/facturx/facturx.validator.js';
+
+// Import ZUGFeRD implementation
+import { ZUGFeRDDecoder } from './formats/cii/zugferd/zugferd.decoder.js';
+import { ZUGFeRDEncoder } from './formats/cii/zugferd/zugferd.encoder.js';
+import { ZUGFeRDValidator } from './formats/cii/zugferd/zugferd.validator.js';
+import { ZUGFeRDV1Decoder } from './formats/cii/zugferd/zugferd.v1.decoder.js';
+
+// Export interfaces
+export type {
+  // Common interfaces
+  TInvoice,
+  TCreditNote,
+  TDebitNote,
+  TContact,
+  TLetterEnvelope,
+  TDocumentEnvelope,
+  IPdf,
+
+  // Validation interfaces
+  ValidationError,
+  ValidationResult,
+  IValidator,
+
+  // Format interfaces
+  ExportFormat,
+  EInvoiceOptions
+} from './interfaces/common.js';
+
+export { ValidationLevel, InvoiceFormat } from './interfaces/common.js';
+
+// Export interfaces (legacy support)
+export { common as interfaces };
+
+// Export main class
+export { EInvoice };
+
+// Export factories
+export { DecoderFactory, EncoderFactory, ValidatorFactory };
+
+// Export base classes
+export { BaseDecoder, BaseEncoder, BaseValidator };
+
+// Export UBL base classes
+export { UBLBaseDecoder, UBLBaseEncoder, UBLBaseValidator };
+
+// Export CII base classes
+export { CIIBaseDecoder, CIIBaseEncoder, CIIBaseValidator };
+
+// Export Factur-X implementation
+export { FacturXDecoder, FacturXEncoder, FacturXValidator };
+
+// Export ZUGFeRD implementation
+export { ZUGFeRDDecoder, ZUGFeRDEncoder, ZUGFeRDValidator, ZUGFeRDV1Decoder };
+
+// Export PDF utilities
+export {
+  PDFEmbedder,
+  PDFExtractor,
+  BaseXMLExtractor,
+  StandardXMLExtractor,
+  AssociatedFilesExtractor,
+  TextXMLExtractor
+};
+
+// Export format detector
+export { FormatDetector };
+
+// Export error classes
+export {
+  EInvoiceError,
+  EInvoiceParsingError,
+  EInvoiceValidationError,
+  EInvoicePDFError,
+  EInvoiceFormatError,
+  ErrorRecovery,
+  ErrorContext
+};
+
+/**
+ * Validates an XML string against the appropriate format rules
+ * @param xml XML content to validate
+ * @param level Validation level (syntax, semantic, business)
+ * @returns ValidationResult with the result of validation
+ */
+export function validateXml(
+  xml: string,
+  level: common.ValidationLevel = common.ValidationLevel.SYNTAX
+): common.ValidationResult {
+  try {
+    const validator = ValidatorFactory.createValidator(xml);
+    return validator.validate(level);
+  } catch (error) {
+    return {
+      valid: false,
+      errors: [{
+        code: 'VAL-ERROR',
+        message: `Validation error: ${error.message}`
+      }],
+      level
+    };
+  }
+}
+
+/**
+ * Creates a new EInvoice instance
+ * @returns A new EInvoice instance
+ */
+export function createEInvoice(): EInvoice {
+  return new EInvoice();
+}

package/ts/interfaces/common.ts

@@ -0,0 +1,90 @@
+import { business, finance } from '../plugins.js';
+
+/**
+ * Supported electronic invoice formats
+ */
+export enum InvoiceFormat {
+  UNKNOWN = 'unknown',
+  UBL = 'ubl', // Universal Business Language
+  CII = 'cii', // Cross-Industry Invoice
+  ZUGFERD = 'zugferd', // ZUGFeRD (German e-invoice format)
+  FACTURX = 'facturx', // Factur-X (French e-invoice format)
+  XRECHNUNG = 'xrechnung', // XRechnung (German e-invoice implementation of EN16931)
+  FATTURAPA = 'fatturapa' // FatturaPA (Italian e-invoice format)
+}
+
+/**
+ * Formats supported for export operations
+ * This is a subset of InvoiceFormat that only includes formats
+ * that can be generated and embedded in PDFs
+ */
+export type ExportFormat = 'facturx' | 'zugferd' | 'xrechnung' | 'ubl' | 'cii';
+
+/**
+ * Describes a validation level for invoice validation
+ */
+export enum ValidationLevel {
+  SYNTAX = 'syntax', // Schema validation only
+  SEMANTIC = 'semantic', // Semantic validation (field types, required fields, etc.)
+  BUSINESS = 'business' // Business rule validation
+}
+
+/**
+ * Describes a validation error
+ */
+export interface ValidationError {
+  code: string; // Error code (e.g. "BR-16")
+  message: string; // Error message
+  location?: string; // XPath or location in the document
+}
+
+/**
+ * Result of a validation operation
+ */
+export interface ValidationResult {
+  valid: boolean; // Overall validation result
+  errors: ValidationError[]; // List of validation errors
+  level: ValidationLevel; // The level that was validated
+}
+
+/**
+ * Options for the EInvoice class
+ */
+export interface EInvoiceOptions {
+  validateOnLoad?: boolean; // Whether to validate when loading an invoice
+  validationLevel?: ValidationLevel; // Level of validation to perform
+}
+
+/**
+ * Interface for validator implementations
+ */
+export interface IValidator {
+  validate(level?: ValidationLevel): ValidationResult;
+  isValid(): boolean;
+  getValidationErrors(): ValidationError[];
+}
+
+/**
+ * PDF interface
+ */
+export interface IPdf {
+  name: string;
+  id: string;
+  metadata: {
+    textExtraction: string;
+    format?: string;
+    embeddedXml?: {
+      filename: string;
+      description: string;
+    };
+  };
+  buffer: Uint8Array;
+}
+
+// Re-export types from tsclass for convenience
+export type { TInvoice } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TCreditNote } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TDebitNote } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TContact } from '@tsclass/tsclass/dist_ts/business/index.js';
+export type { TLetterEnvelope } from '@tsclass/tsclass/dist_ts/business/index.js';
+export type { TDocumentEnvelope } from '@tsclass/tsclass/dist_ts/business/index.js';

package/ts/interfaces.ts

@@ -0,0 +1,98 @@
+export interface IEInvoice {
+  InvoiceNumber: string;
+  DateIssued: string; // Date in ISO 8601 format
+  Seller: IParty;
+  Buyer: IParty;
+  Items: IInvoiceItem[];
+  TotalAmount: number;
+}
+
+export interface IParty {
+  Name: string;
+  Address: IAddress;
+  Contact: IContact;
+  TaxRegistration?: string;
+}
+
+export interface IAddress {
+  Street: string;
+  City: string;
+  PostalCode: string;
+  Country: string;
+}
+
+export interface IContact {
+  Email: string;
+  Phone: string;
+}
+
+export interface IInvoiceItem {
+  Description: string;
+  Quantity: number;
+  UnitPrice: number;
+  TotalPrice: number;
+}
+
+/**
+ * Supported electronic invoice formats
+ */
+export enum InvoiceFormat {
+  UNKNOWN = 'unknown',
+  UBL = 'ubl', // Universal Business Language
+  CII = 'cii', // Cross-Industry Invoice
+  ZUGFERD = 'zugferd', // ZUGFeRD (German e-invoice format)
+  FACTURX = 'facturx', // Factur-X (French e-invoice format)
+  XRECHNUNG = 'xrechnung', // XRechnung (German e-invoice implementation of EN16931)
+  FATTURAPA = 'fatturapa' // FatturaPA (Italian e-invoice format)
+}
+
+/**
+ * Formats supported for export operations
+ * This is a subset of InvoiceFormat that only includes formats
+ * that can be generated and embedded in PDFs
+ */
+export type ExportFormat = 'facturx' | 'zugferd' | 'xrechnung' | 'ubl' | 'cii';
+
+/**
+ * Describes a validation level for invoice validation
+ */
+export enum ValidationLevel {
+  SYNTAX = 'syntax', // Schema validation only
+  SEMANTIC = 'semantic', // Semantic validation (field types, required fields, etc.)
+  BUSINESS = 'business' // Business rule validation
+}
+
+/**
+ * Describes a validation error
+ */
+export interface ValidationError {
+  code: string; // Error code (e.g. "BR-16")
+  message: string; // Error message
+  location?: string; // XPath or location in the document
+}
+
+/**
+ * Result of a validation operation
+ */
+export interface ValidationResult {
+  valid: boolean; // Overall validation result
+  errors: ValidationError[]; // List of validation errors
+  level: ValidationLevel; // The level that was validated
+}
+
+/**
+ * Options for the EInvoice class
+ */
+export interface EInvoiceOptions {
+  validateOnLoad?: boolean; // Whether to validate when loading an invoice
+  validationLevel?: ValidationLevel; // Level of validation to perform
+}
+
+/**
+ * Interface for validator implementations
+ */
+export interface IValidator {
+  validate(level?: ValidationLevel): ValidationResult;
+  isValid(): boolean;
+  getValidationErrors(): ValidationError[];
+}

package/ts/plugins.ts

@@ -0,0 +1,61 @@
+/**
+ * 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.
+ */
+
+// Node.js built-in modules
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import * as crypto from 'crypto';
+
+// 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 {
+  // Node.js built-in modules
+  fs,
+  path,
+  crypto,
+  
+  // 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
+};