@fin.cx/einvoice 5.1.4 → 5.2.1

package/ts/plugins.ts

@@ -9,27 +9,12 @@ 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 xmldom from 'xmldom';
+import { DOMParser, XMLSerializer, xmldom } from './vendor/xmldom.js';
 import * as xpath from 'xpath';
 
-// XSLT/Schematron imports
-import * as SaxonJS from 'saxon-js';
-
 // Compression-related imports
-import * as pako from 'pako';
+import { pako } from './vendor/pako.js';
 
 // Business model imports
 import { business, finance, general } from '@tsclass/tsclass';
@@ -41,24 +26,12 @@ export {
   path,
   crypto,
   
-  // PDF-lib exports
-  PDFDocument,
-  PDFDict,
-  PDFName,
-  PDFRawStream,
-  PDFArray,
-  PDFString,
-  AFRelationship,
-  
   // XML-related exports
   DOMParser,
   XMLSerializer,
   xmldom,
   xpath,
   
-  // XSLT/Schematron exports
-  SaxonJS,
-  
   // Compression-related exports
   pako,
   

package/ts/readme.md

@@ -0,0 +1,76 @@
+# @fin.cx/einvoice
+
+Source module for the main `@fin.cx/einvoice` package.
+
+This directory contains the public TypeScript API for loading, validating, converting, and embedding European e-invoice XML.
+
+## Issue Reporting and Security
+
+For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
+
+## What this module exports
+
+- `EInvoice`
+- `createEInvoice()`
+- `validateXml(xml, level?)`
+- `FormatDetector`
+- `PDFExtractor`, `PDFEmbedder`
+- `DecoderFactory`, `EncoderFactory`, `ValidatorFactory`
+- `BaseDecoder`, `BaseEncoder`, `BaseValidator`
+- `UBLBase*` and `CIIBase*` extension points
+- Factur-X and ZUGFeRD format-specific classes
+- root types such as `TInvoice`, `ValidationResult`, `ExportFormat`, `IPdf`
+
+## Main workflow
+
+```ts
+import { EInvoice, ValidationLevel } from '@fin.cx/einvoice';
+
+const invoice = await EInvoice.fromFile('./invoice.xml');
+const validation = await invoice.validate(ValidationLevel.BUSINESS);
+const xml = await invoice.exportXml('facturx');
+```
+
+## Format support
+
+| Format | Detect | Import | Export | Notes |
+| --- | --- | --- | --- | --- |
+| `ubl` | Yes | Yes | Yes | Generic UBL flow |
+| `xrechnung` | Yes | Yes | Yes | UBL-based profile |
+| `cii` | Yes | Yes | Yes | Generic export currently routes through the Factur-X encoder path |
+| `facturx` | Yes | Yes | Yes | Main CII generation path |
+| `zugferd` | Yes | Yes | Yes | Input supports v1 and v2+ |
+| `fatturapa` | Yes | No | No | Detection only at the moment |
+
+## Important implementation notes
+
+- `peppol` is not a root-level XML export target.
+- `FatturaPA` is not fully implemented for import/export.
+- PDF support means extracting or embedding XML into existing PDFs, not generating invoice PDFs from scratch.
+- Validation is useful and extensive, but should not be documented as blanket certification.
+
+## Related directories
+
+- `../readme.md`: full package README for end users
+- `../ts_install/readme.md`: install-time resource bootstrap module
+
+## License and Legal Information
+
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](../license) file.
+
+**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.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
+
+### Company Information
+
+Task Venture Capital GmbH<br>
+Registered at District Court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts/vendor/modules.d.ts

@@ -0,0 +1,32 @@
+declare module 'xmldom' {
+  export class DOMParser {
+    parseFromString(source: string, mimeType: string): Document;
+  }
+
+  export class XMLSerializer {
+    serializeToString(node: Node): string;
+  }
+}
+
+declare module 'pako' {
+  export function inflate(input: Uint8Array | ArrayBuffer | string, options?: unknown): Uint8Array;
+}
+
+declare module 'saxon-js' {
+  export function compile(options: {
+    stylesheetText: string;
+    warnings?: string;
+    [key: string]: unknown;
+  }): Promise<unknown>;
+
+  export function transform(options: {
+    stylesheetInternal?: unknown;
+    sourceText: string;
+    destination?: string;
+    stylesheetParams?: Record<string, unknown>;
+    [key: string]: unknown;
+  }): Promise<{
+    principalResult: string;
+    [key: string]: unknown;
+  }>;
+}

package/ts/vendor/pako.ts

@@ -0,0 +1,8 @@
+import * as pakoRuntime from 'pako';
+
+export interface IPakoModule {
+  inflate(input: Uint8Array | ArrayBuffer | string, options?: unknown): Uint8Array;
+  [key: string]: unknown;
+}
+
+export const pako: IPakoModule = pakoRuntime as unknown as IPakoModule;

package/ts/vendor/pdflib.ts

@@ -0,0 +1,12 @@
+export type TPdfLibModule = typeof import('pdf-lib');
+
+let cachedPdfLib: Promise<TPdfLibModule> | undefined;
+
+// Use pdf-lib's bundled UMD build; the package entry requires JSON font assets,
+// which some TS runners corrupt with require hooks.
+const nativeImport = Function('specifier', 'return import(specifier)') as (specifier: string) => Promise<TPdfLibModule>;
+
+export const loadPdfLib = async (): Promise<TPdfLibModule> => {
+  cachedPdfLib ||= nativeImport('pdf-lib/dist/pdf-lib.js');
+  return cachedPdfLib;
+};

package/ts/vendor/saxonjs.ts

@@ -0,0 +1,36 @@
+export interface ISaxonJSCompileOptions {
+  stylesheetText: string;
+  warnings?: string;
+  [key: string]: unknown;
+}
+
+export interface ISaxonJSTransformOptions {
+  stylesheetInternal?: unknown;
+  stylesheetFileName?: string;
+  sourceText: string;
+  destination?: string;
+  stylesheetParams?: Record<string, unknown>;
+  [key: string]: unknown;
+}
+
+export interface ISaxonJSTransformResult {
+  principalResult: string;
+  [key: string]: unknown;
+}
+
+export interface ISaxonJSModule {
+  compile?: (options: ISaxonJSCompileOptions) => Promise<unknown>;
+  transform(options: ISaxonJSTransformOptions, executionMode?: 'async' | 'sync'): Promise<ISaxonJSTransformResult> | ISaxonJSTransformResult;
+  [key: string]: unknown;
+}
+
+let cachedSaxonJS: Promise<ISaxonJSModule> | undefined;
+
+export const loadSaxonJS = async (): Promise<ISaxonJSModule> => {
+  cachedSaxonJS ||= import('saxon-js').then((saxonJSRuntime) => {
+    const runtime = (saxonJSRuntime as any).default ?? saxonJSRuntime;
+    return runtime as ISaxonJSModule;
+  });
+
+  return cachedSaxonJS;
+};

package/ts/vendor/xmldom.ts

@@ -0,0 +1,27 @@
+import * as xmldomRuntime from 'xmldom';
+
+export interface IDOMParser {
+  parseFromString(source: string, mimeType: string): Document;
+}
+
+export interface IDOMParserConstructor {
+  new (): IDOMParser;
+}
+
+export interface IXMLSerializer {
+  serializeToString(node: Node): string;
+}
+
+export interface IXMLSerializerConstructor {
+  new (): IXMLSerializer;
+}
+
+export interface IXmlDomModule {
+  DOMParser: IDOMParserConstructor;
+  XMLSerializer: IXMLSerializerConstructor;
+  [key: string]: unknown;
+}
+
+export const DOMParser: IDOMParserConstructor = xmldomRuntime.DOMParser as unknown as IDOMParserConstructor;
+export const XMLSerializer: IXMLSerializerConstructor = xmldomRuntime.XMLSerializer as unknown as IXMLSerializerConstructor;
+export const xmldom: IXmlDomModule = xmldomRuntime as unknown as IXmlDomModule;

package/npmextra.json

@@ -1,35 +0,0 @@
-{
-  "gitzone": {
-    "projectType": "npm",
-    "module": {
-      "githost": "code.foss.global",
-      "gitscope": "fin.cx",
-      "gitrepo": "xinvoice",
-      "description": "A TypeScript module for creating, manipulating, and embedding XML data within PDF files specifically tailored for xinvoice packages.",
-      "npmPackagename": "@fin.cx/xinvoice",
-      "license": "MIT",
-      "projectDomain": "fin.cx",
-      "keywords": [
-        "xinvoice",
-        "XML embedding",
-        "PDF manipulation",
-        "invoice processing",
-        "financial documents",
-        "document generation",
-        "typescript",
-        "ZUGFeRD",
-        "XML parsing",
-        "PDF library",
-        "esm",
-        "financial technology"
-      ]
-    }
-  },
-  "npmci": {
-    "npmGlobalTools": [],
-    "npmAccessLevel": "public"
-  },
-  "tsdoc": {
-    "legal": "\n## License and Legal Information\n\nThis 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. \n\n**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.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
-  }
-}