npm - @facturion/invoice-renderer - Versions diffs - 0.1.0 - Mend

@facturion/invoice-renderer 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Nicola Crivellin
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE ADDED Viewed

@@ -0,0 +1,20 @@
+@facturion/invoice-renderer
+===========================
+This package is licensed under the MIT License (see LICENSE).
+The renderer, layout, stylesheet, and the `view.*` document strings are the
+original work of this package. It builds on:
+--------------------------------------------------------------------------------
+@facturion/invoice
+  The simplified-invoice JSON data model, validation, and the net/total
+  computation helpers (lineNet, computeTotals).
+--------------------------------------------------------------------------------
+@facturion/codelists
+  Friendly multilingual labels for unit-of-measure (UN/ECE Rec 20/21) and
+  payment-means (UNTDID 4461) codes referenced by the rendered document.
+The EN 16931 business terms the layout reflects are defined by CEN
+(EN 16931-1).

package/README.md ADDED Viewed

@@ -0,0 +1,43 @@
+# @facturion/invoice-renderer
+Render the [`@facturion/invoice`](https://www.npmjs.com/package/@facturion/invoice)
+simplified-JSON model to a clean, human-readable **HTML invoice** — the
+presentation layer behind Facturion's invoice PDFs (feed the HTML to headless
+Chromium or any HTML→PDF tool).
+It owns presentation only: layout, the document stylesheet, and the `view.*`
+document strings. The data model and money math come from `@facturion/invoice`;
+unit and payment-means labels come from `@facturion/codelists`.
+## Install
+```sh
+npm install @facturion/invoice-renderer
+```
+## Usage
+```ts
+import { renderInvoiceDocument, renderInvoice, makeT } from "@facturion/invoice-renderer";
+// Batteries-included: a standalone HTML document (stylesheet inlined, labels resolved).
+const html = renderInvoiceDocument(invoice, { lang: "de" });
+// Or just the fragment, with your own label resolver:
+const fragment = renderInvoice(invoice, { t: makeT("en") });
+```
+- **`renderInvoiceDocument(invoice, { lang?, t? })`** → full `<!DOCTYPE html>` document.
+- **`renderInvoice(invoice, { t })`** → HTML fragment; `t(key, vars?)` resolves
+  `view.*` / `units.*` / `paymentMeans.*` and returns the key on a miss. Use
+  `makeT(lang)` for the default resolver, or inject your own.
+Partial invoices render fine (missing sections simply don't appear), so the
+renderer suits live previews as well as final documents.
+The bundled stylesheet is also importable directly, e.g.
+`@facturion/invoice-renderer/styles/view.css`.
+## License
+MIT. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE).

package/index.d.ts ADDED Viewed

@@ -0,0 +1,33 @@
+import type { Invoice, InvoiceTotals } from "@facturion/invoice";
+export type Lang = "en" | "de";
+/** Label resolver: `(key, vars?) => string`, returning the key unchanged on a miss. */
+export type TFunction = (key: string, vars?: Record<string, unknown>) => string;
+export { lineNet, computeTotals } from "@facturion/invoice";
+/** HTML-escape a value (`&`, `<`, `>`, `"`). */
+export function esc(s: unknown): string;
+/** Format a number with exactly two fraction digits; non-numerics pass through escaped. */
+export function amt(value: unknown): string;
+/** `amt(value)` optionally suffixed with a currency code. */
+export function curAmt(value: unknown, cur?: string): string;
+/** Render the invoice as an HTML fragment (no document chrome). */
+export function renderInvoice(invoice: Invoice, opts: { t: TFunction }): string;
+/** Render a standalone HTML document (stylesheet inlined, default labels). */
+export function renderInvoiceDocument(
+  invoice: Invoice,
+  opts?: { lang?: Lang; t?: TFunction },
+): string;
+/** Build the default label resolver for a language (bundled `view.*` + codelists). */
+export function makeT(lang: Lang): TFunction;
+/** Bundled `view.*` document strings, keyed by language. */
+export const VIEW: Record<Lang, Record<string, string>>;
+export const DEFAULT_LANG: Lang;
+export type { Invoice, InvoiceTotals };

package/package.json ADDED Viewed

@@ -0,0 +1,55 @@
+{
+  "name": "@facturion/invoice-renderer",
+  "version": "0.1.0",
+  "description": "Render the @facturion/invoice simplified-JSON model to a human-readable HTML invoice — the presentation layer behind Facturion's invoice PDFs.",
+  "keywords": [
+    "en16931",
+    "einvoicing",
+    "invoice",
+    "html",
+    "pdf",
+    "renderer",
+    "zugferd",
+    "xrechnung",
+    "factur-x"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/facturion/packages.git",
+    "directory": "packages/invoice-renderer"
+  },
+  "homepage": "https://github.com/facturion/packages/tree/main/packages/invoice-renderer#readme",
+  "bugs": "https://github.com/facturion/packages/issues",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./styles/view.css": "./styles/view.css",
+    "./styles/utilities.css": "./styles/utilities.css",
+    "./styles/variables.css": "./styles/variables.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "styles",
+    "index.d.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "scripts": {
+    "test": "node --test test/*.test.js",
+    "prepublishOnly": "npm test"
+  },
+  "dependencies": {
+    "@facturion/codelists": "^0.1.1",
+    "@facturion/invoice": "^0.1.0"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/src/document.js ADDED Viewed

@@ -0,0 +1,43 @@
+// Batteries-included wrapper: a standalone HTML document for an invoice, with
+// the bundled stylesheet inlined and a default label resolver. This is what an
+// HTML→PDF service (e.g. headless Chromium) consumes.
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { renderInvoice } from "./render.js";
+import { makeT, DEFAULT_LANG } from "./i18n.js";
+const _stylesDir = join(dirname(fileURLToPath(import.meta.url)), "..", "styles");
+const _variablesCss = readFileSync(join(_stylesDir, "variables.css"), "utf-8");
+const _utilitiesCss = readFileSync(join(_stylesDir, "utilities.css"), "utf-8");
+const _viewCss = readFileSync(join(_stylesDir, "view.css"), "utf-8");
+const _HTML_LANG = { en: "en", de: "de" };
+/**
+ * Build a standalone HTML document for an invoice.
+ *
+ * @param invoice Simplified EN 16931 JSON (see @facturion/invoice).
+ * @param opts.lang Language for document strings. Default "en".
+ * @param opts.t   Override the label resolver (advanced; bypasses the bundled
+ *                 strings + codelists default).
+ */
+export function renderInvoiceDocument(invoice, { lang = DEFAULT_LANG, t } = {}) {
+  const resolve = t ?? makeT(lang);
+  const fragment = renderInvoice(invoice, { t: resolve });
+  const htmlLang = _HTML_LANG[lang] || DEFAULT_LANG;
+  return `<!DOCTYPE html>
+<html lang="${htmlLang}">
+<head>
+<meta charset="utf-8">
+<style>
+${_variablesCss}
+${_utilitiesCss}
+${_viewCss}
+body { margin: 0; padding: 0; background: #fff; }
+</style>
+</head>
+<body>${fragment}</body>
+</html>`;
+}

package/src/i18n.js ADDED Viewed

@@ -0,0 +1,140 @@
+// Document-chrome strings for the rendered invoice (the `view.*` namespace) and
+// the default label resolver. Vocabulary labels (`units.*`, `paymentMeans.*`)
+// are not bundled here — they resolve through @facturion/codelists so the
+// renderer and the rest of the toolchain share one source of truth.
+import { codelistLabel, unitLabel } from "@facturion/codelists";
+export const DEFAULT_LANG = "en";
+// The document strings the renderer references via `t("view.<key>")`. Sourced
+// from the Facturion app's invoice-view i18n; kept in sync deliberately.
+export const VIEW = {
+  en: {
+    accountName: "Account holder",
+    bic: "BIC",
+    cardHolder: "Card holder",
+    cardNumber: "Card number",
+    contract: "Contract",
+    creditNote: "Credit Note",
+    creditorId: "Creditor ID",
+    currency: "Currency",
+    debitedAccount: "Debited account",
+    deliverTo: "Deliver to",
+    deliveryDate: "Delivery date",
+    description: "Description",
+    despatchAdvice: "Delivery note",
+    documentAllowance: "Discount",
+    documentCharge: "Charge",
+    dueDate: "Due date",
+    from: "From",
+    iban: "IBAN",
+    invoice: "Invoice",
+    invoicingPeriod: "Invoicing period",
+    issueDate: "Issue date",
+    lineNo: "#",
+    linePeriod: "Service period",
+    lineTotal: "Total",
+    mandateReference: "Mandate reference",
+    notes: "Notes",
+    objectIdentifier: "Object ID",
+    payable: "Amount due",
+    payee: "Payee",
+    paymentInstructions: "Payment",
+    paymentMeans: "Method",
+    paymentTerms: "Payment terms",
+    preceding: "Preceding invoice",
+    prepaid: "Prepaid",
+    project: "Project",
+    purchaseOrder: "Your order",
+    quantity: "Qty",
+    receivingAdvice: "Receiving advice",
+    remittance: "Reference",
+    rounding: "Rounding",
+    salesOrder: "Sales order",
+    subtotal: "Subtotal",
+    taxableAmount: "taxable",
+    taxRate: "VAT",
+    taxRep: "Tax representative",
+    taxTotal: "VAT {{rate}} %",
+    tender: "Tender / lot",
+    to: "To",
+    unitPrice: "Unit price",
+  },
+  de: {
+    accountName: "Kontoinhaber",
+    bic: "BIC",
+    cardHolder: "Karteninhaber",
+    cardNumber: "Kartennummer",
+    contract: "Vertrag",
+    creditNote: "Gutschrift",
+    creditorId: "Gläubiger-ID",
+    currency: "Währung",
+    debitedAccount: "Belastetes Konto",
+    deliverTo: "Lieferadresse",
+    deliveryDate: "Leistungsdatum",
+    description: "Beschreibung",
+    despatchAdvice: "Lieferschein",
+    documentAllowance: "Nachlass",
+    documentCharge: "Aufschlag",
+    dueDate: "Fälligkeitsdatum",
+    from: "Von",
+    iban: "IBAN",
+    invoice: "Rechnung",
+    invoicingPeriod: "Leistungszeitraum",
+    issueDate: "Rechnungsdatum",
+    lineNo: "#",
+    linePeriod: "Leistungszeitraum",
+    lineTotal: "Gesamt",
+    mandateReference: "Mandatsreferenz",
+    notes: "Hinweise",
+    objectIdentifier: "Objekt-ID",
+    payable: "Zahlbetrag",
+    payee: "Zahlungsempfänger",
+    paymentInstructions: "Zahlung",
+    paymentMeans: "Zahlungsart",
+    paymentTerms: "Zahlungsbedingungen",
+    preceding: "Vorherige Rechnung",
+    prepaid: "Bereits gezahlt",
+    project: "Projekt",
+    purchaseOrder: "Ihre Bestellung",
+    quantity: "Menge",
+    receivingAdvice: "Empfangsbestätigung",
+    remittance: "Verwendungszweck",
+    rounding: "Rundung",
+    salesOrder: "Auftrag",
+    subtotal: "Zwischensumme",
+    taxableAmount: "netto",
+    taxRate: "MwSt.",
+    taxRep: "Steuervertreter",
+    taxTotal: "MwSt. {{rate}} %",
+    tender: "Ausschreibung",
+    to: "An",
+    unitPrice: "Einzelpreis",
+  },
+};
+/**
+ * Build the default label resolver for a language. Resolves `view.*` from the
+ * bundled strings (with `{{var}}` interpolation), and `units.*` /
+ * `paymentMeans.*` through @facturion/codelists. Returns the key unchanged on a
+ * miss, so the renderer's own fallbacks (to the raw code) still apply.
+ */
+export function makeT(lang) {
+  const view = VIEW[lang] ?? VIEW[DEFAULT_LANG];
+  return (key, vars = {}) => {
+    if (key.startsWith("units.")) {
+      let code = key.slice("units.".length);
+      const plural = code.endsWith("_plural");
+      if (plural) code = code.slice(0, -"_plural".length);
+      return unitLabel(code, lang, plural);
+    }
+    if (key.startsWith("paymentMeans.")) {
+      return codelistLabel("paymentMeans", key.slice("paymentMeans.".length), lang);
+    }
+    const k = key.startsWith("view.") ? key.slice("view.".length) : key;
+    const s = view[k];
+    if (typeof s !== "string") return key;
+    return s.replace(/\{\{(\w+)\}\}/g, (_, v) => String(vars[v] ?? ""));
+  };
+}

package/src/index.js ADDED Viewed

@@ -0,0 +1,6 @@
+// @facturion/invoice-renderer — render the @facturion/invoice simplified-JSON
+// model to a human-readable HTML invoice (the basis for an HTML→PDF flow).
+export { renderInvoice, esc, amt, curAmt, lineNet, computeTotals } from "./render.js";
+export { renderInvoiceDocument } from "./document.js";
+export { makeT, VIEW, DEFAULT_LANG } from "./i18n.js";