@fin.cx/einvoice 5.0.3 → 5.1.3

package/ts/formats/validation/validation.types.ts

@@ -0,0 +1,274 @@
+/**
+ * Enhanced validation types for EN16931 compliance
+ */
+
+export interface ValidationResult {
+  // Core identification
+  ruleId: string;                    // e.g., "BR-CO-14"
+  source: string;                     // e.g., "EN16931", "PEPPOL", "XRECHNUNG"
+  severity: 'error' | 'warning' | 'info';
+  message: string;
+  
+  // Semantic references
+  btReference?: string;               // Business Term reference (e.g., "BT-112")
+  bgReference?: string;               // Business Group reference (e.g., "BG-23")
+  
+  // Location information
+  semanticPath?: string;              // BT/BG-based path (portable across syntaxes)
+  syntaxPath?: string;                // XPath/JSON Pointer to concrete field
+  field?: string;                     // Simple field name
+  
+  // Values and validation context
+  value?: any;                        // Actual value found
+  expected?: any;                     // Expected value or pattern
+  tolerance?: number;                 // Numeric tolerance applied
+  
+  // Context
+  profile?: string;                   // e.g., "EN16931", "PEPPOL_BIS_3.0", "XRECHNUNG_3.0"
+  codeList?: {
+    name: string;                     // e.g., "ISO4217", "UNCL5305"
+    version: string;                  // e.g., "2021"
+  };
+  
+  // Remediation
+  hint?: string;                      // Machine-friendly hint key
+  remediation?: string;               // Human-readable fix suggestion
+}
+
+export interface ValidationOptions {
+  // Profile and target
+  profile?: 'EN16931' | 'PEPPOL_BIS_3.0' | 'XRECHNUNG_3.0' | 'FACTURX_BASIC' | 'FACTURX_EN16931';
+  formatHint?: 'UBL' | 'CII';
+  
+  // Validation toggles
+  checkCalculations?: boolean;
+  checkVAT?: boolean;
+  checkAllowances?: boolean;
+  checkCodeLists?: boolean;
+  checkCardinality?: boolean;
+  
+  // Tolerances
+  tolerance?: number;                 // Default 0.01 for currency
+  currencyMinorUnits?: Map<string, number>; // Currency-specific decimal places
+  
+  // Mode
+  strictMode?: boolean;               // Fail on warnings
+  reportOnly?: boolean;               // Non-blocking validation
+  featureFlags?: string[];            // Enable specific rule sets
+}
+
+export interface ValidationReport {
+  // Summary
+  valid: boolean;
+  profile: string;
+  timestamp: string;
+  validatorVersion: string;
+  rulesetVersion: string;
+  
+  // Results
+  results: ValidationResult[];
+  errorCount: number;
+  warningCount: number;
+  infoCount: number;
+  
+  // Coverage
+  rulesChecked: number;
+  rulesTotal: number;
+  coverage: number;                   // Percentage
+  
+  // Performance
+  validationTime: number;              // Milliseconds
+  
+  // Document info
+  documentId?: string;
+  documentType?: string;
+  format?: string;
+}
+
+// Code list definitions
+export const CodeLists = {
+  // ISO 4217 Currency codes
+  ISO4217: {
+    version: '2021',
+    codes: new Set([
+      'EUR', 'USD', 'GBP', 'CHF', 'SEK', 'NOK', 'DKK', 'PLN', 'CZK', 'HUF',
+      'RON', 'BGN', 'HRK', 'TRY', 'ISK', 'JPY', 'CNY', 'AUD', 'CAD', 'NZD'
+    ])
+  },
+  
+  // ISO 3166-1 alpha-2 Country codes
+  ISO3166: {
+    version: '2020',
+    codes: new Set([
+      'DE', 'FR', 'IT', 'ES', 'NL', 'BE', 'AT', 'CH', 'GB', 'IE', 'PT', 'GR',
+      'SE', 'NO', 'DK', 'FI', 'PL', 'CZ', 'HU', 'RO', 'BG', 'HR', 'SI', 'SK',
+      'LT', 'LV', 'EE', 'LU', 'MT', 'CY', 'US', 'CA', 'AU', 'NZ', 'JP', 'CN'
+    ])
+  },
+  
+  // UNCL5305 Tax category codes
+  UNCL5305: {
+    version: 'D16B',
+    codes: new Map([
+      ['S', 'Standard rate'],
+      ['Z', 'Zero rated'],
+      ['E', 'Exempt from tax'],
+      ['AE', 'VAT Reverse Charge'],
+      ['K', 'VAT exempt for EEA intra-community supply'],
+      ['G', 'Free export outside EU'],
+      ['O', 'Services outside scope of tax'],
+      ['L', 'Canary Islands general indirect tax'],
+      ['M', 'Tax for production, services and importation in Ceuta and Melilla']
+    ])
+  },
+  
+  // UNCL1001 Document type codes
+  UNCL1001: {
+    version: 'D16B',
+    codes: new Map([
+      ['380', 'Commercial invoice'],
+      ['381', 'Credit note'],
+      ['383', 'Debit note'],
+      ['384', 'Corrected invoice'],
+      ['389', 'Self-billed invoice'],
+      ['751', 'Invoice information for accounting purposes']
+    ])
+  },
+  
+  // UNCL4461 Payment means codes
+  UNCL4461: {
+    version: 'D16B',
+    codes: new Map([
+      ['1', 'Instrument not defined'],
+      ['10', 'In cash'],
+      ['20', 'Cheque'],
+      ['30', 'Credit transfer'],
+      ['31', 'Debit transfer'],
+      ['42', 'Payment to bank account'],
+      ['48', 'Bank card'],
+      ['49', 'Direct debit'],
+      ['58', 'SEPA credit transfer'],
+      ['59', 'SEPA direct debit']
+    ])
+  },
+  
+  // UNECE Rec 20 Unit codes (subset)
+  UNECERec20: {
+    version: '2021',
+    codes: new Map([
+      ['C62', 'One (unit)'],
+      ['DAY', 'Day'],
+      ['HAR', 'Hectare'],
+      ['HUR', 'Hour'],
+      ['KGM', 'Kilogram'],
+      ['KTM', 'Kilometre'],
+      ['KWH', 'Kilowatt hour'],
+      ['LS', 'Lump sum'],
+      ['LTR', 'Litre'],
+      ['MIN', 'Minute'],
+      ['MMT', 'Millimetre'],
+      ['MON', 'Month'],
+      ['MTK', 'Square metre'],
+      ['MTQ', 'Cubic metre'],
+      ['MTR', 'Metre'],
+      ['NAR', 'Number of articles'],
+      ['NPR', 'Number of pairs'],
+      ['P1', 'Percent'],
+      ['SET', 'Set'],
+      ['TNE', 'Tonne (metric ton)'],
+      ['WEE', 'Week']
+    ])
+  }
+};
+
+// Business Term (BT) and Business Group (BG) mappings
+export const SemanticModel = {
+  // Document level BTs
+  BT1: 'Invoice number',
+  BT2: 'Invoice issue date',
+  BT3: 'Invoice type code',
+  BT5: 'Invoice currency code',
+  BT6: 'VAT accounting currency code',
+  BT7: 'Value added tax point date',
+  BT8: 'Value added tax point date code',
+  BT9: 'Payment due date',
+  BT10: 'Buyer reference',
+  BT11: 'Project reference',
+  BT12: 'Contract reference',
+  BT13: 'Purchase order reference',
+  BT14: 'Sales order reference',
+  BT15: 'Receiving advice reference',
+  BT16: 'Despatch advice reference',
+  BT17: 'Tender or lot reference',
+  BT18: 'Invoiced object identifier',
+  BT19: 'Buyer accounting reference',
+  BT20: 'Payment terms',
+  BT21: 'Seller note',
+  BT22: 'Buyer note',
+  BT23: 'Business process',
+  BT24: 'Specification identifier',
+  
+  // Seller BTs (BG-4)
+  BT27: 'Seller name',
+  BT28: 'Seller trading name',
+  BT29: 'Seller identifier',
+  BT30: 'Seller legal registration identifier',
+  BT31: 'Seller VAT identifier',
+  BT32: 'Seller tax registration identifier',
+  BT33: 'Seller additional legal information',
+  BT34: 'Seller electronic address',
+  
+  // Buyer BTs (BG-7)
+  BT44: 'Buyer name',
+  BT45: 'Buyer trading name',
+  BT46: 'Buyer identifier',
+  BT47: 'Buyer legal registration identifier',
+  BT48: 'Buyer VAT identifier',
+  BT49: 'Buyer electronic address',
+  
+  // Monetary totals (BG-22)
+  BT106: 'Sum of Invoice line net amount',
+  BT107: 'Sum of allowances on document level',
+  BT108: 'Sum of charges on document level',
+  BT109: 'Invoice total amount without VAT',
+  BT110: 'Invoice total VAT amount',
+  BT111: 'Invoice total VAT amount in accounting currency',
+  BT112: 'Invoice total amount with VAT',
+  BT113: 'Paid amount',
+  BT114: 'Rounding amount',
+  BT115: 'Amount due for payment',
+  
+  // Business Groups
+  BG1: 'Invoice note',
+  BG2: 'Process control',
+  BG3: 'Preceding Invoice reference',
+  BG4: 'Seller',
+  BG5: 'Seller postal address',
+  BG6: 'Seller contact',
+  BG7: 'Buyer',
+  BG8: 'Buyer postal address',
+  BG9: 'Buyer contact',
+  BG10: 'Payee',
+  BG11: 'Seller tax representative',
+  BG12: 'Seller tax representative postal address',
+  BG13: 'Delivery information',
+  BG14: 'Delivery or invoice period',
+  BG15: 'Deliver to address',
+  BG16: 'Payment instructions',
+  BG17: 'Credit transfer',
+  BG18: 'Payment card information',
+  BG19: 'Direct debit',
+  BG20: 'Document level allowances',
+  BG21: 'Document level charges',
+  BG22: 'Document totals',
+  BG23: 'VAT breakdown',
+  BG24: 'Additional supporting documents',
+  BG25: 'Invoice line',
+  BG26: 'Invoice line period',
+  BG27: 'Invoice line allowances',
+  BG28: 'Invoice line charges',
+  BG29: 'Price details',
+  BG30: 'Line VAT information',
+  BG31: 'Item information',
+  BG32: 'Item attributes'
+};