@hartl-services/medusa-base 0.4.0 → 1.0.0

package/dist/documents/config/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Documents part of the `@hartl-services/medusa-base/config` entry point: values a shop
+ * needs in `medusa-config.ts` or in a test, without loading the plugin itself.
+ */
+export { createDefaultDocumentHtmlFactory } from "../templates/html-factory";
+/**
+ * Placeholder environment values for `medusa build`. `medusa-config.ts` is
+ * evaluated at build time, where the runtime-only Documents PDF executable
+ * is not set; spread these under the real environment during the build.
+ */
+export declare const DOCUMENTS_BUILD_PLACEHOLDERS: Readonly<Record<string, string>>;

package/dist/documents/config/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUMENTS_BUILD_PLACEHOLDERS = exports.createDefaultDocumentHtmlFactory = void 0;
+/**
+ * Documents part of the `@hartl-services/medusa-base/config` entry point: values a shop
+ * needs in `medusa-config.ts` or in a test, without loading the plugin itself.
+ */
+var html_factory_1 = require("../templates/html-factory");
+Object.defineProperty(exports, "createDefaultDocumentHtmlFactory", { enumerable: true, get: function () { return html_factory_1.createDefaultDocumentHtmlFactory; } });
+/**
+ * Placeholder environment values for `medusa build`. `medusa-config.ts` is
+ * evaluated at build time, where the runtime-only Documents PDF executable
+ * is not set; spread these under the real environment during the build.
+ */
+exports.DOCUMENTS_BUILD_PLACEHOLDERS = {
+    DOCUMENT_PDF_EXECUTABLE: "google-chrome",
+};

package/dist/documents/templates/financial-document.d.ts

@@ -0,0 +1,3 @@
+import type { DocumentTemplateInput } from "../types";
+import type { DocumentLayout } from "./layout";
+export declare const renderFinancialDocument: (input: DocumentTemplateInput, layout: DocumentLayout, timeZone: string) => string;

package/dist/documents/templates/financial-document.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderFinancialDocument = void 0;
+const format_1 = require("./format");
+const html_utils_1 = require("./html-utils");
+const labelsByKind = {
+    cancellation: {
+        date: "Stornodatum",
+        recipient: "Stornorechnung an",
+        title: "Stornorechnung",
+    },
+    credit_note: {
+        date: "Gutschriftsdatum",
+        recipient: "Gutschrift an",
+        title: "Gutschrift",
+    },
+    invoice: {
+        date: "Rechnungsdatum",
+        recipient: "Rechnung an",
+        title: "Rechnung",
+    },
+};
+const renderAddress = (input) => {
+    const address = input.order.billing_address;
+    if (!address) {
+        return (0, html_utils_1.escapeHtml)(input.order.email);
+    }
+    return [
+        [address.company, address.first_name, address.last_name]
+            .filter((part) => Boolean(part))
+            .join(" "),
+        address.address_1,
+        address.address_2,
+        [address.postal_code, address.city]
+            .filter((part) => Boolean(part))
+            .join(" "),
+        address.country_code?.toUpperCase(),
+    ]
+        .filter((part) => Boolean(part))
+        .map(html_utils_1.escapeHtml)
+        .join("<br />");
+};
+const renderLines = (input, timeZone) => input.lines
+    .map((line) => {
+    const batchDetails = line.batch_allocations
+        .map((allocation) => `<div class="batch">Charge: ${(0, html_utils_1.escapeHtml)(allocation.lot_number)} · MHD: ${(0, html_utils_1.escapeHtml)((0, format_1.formatDate)(allocation.expiry_date, { timeZone }))} · ${(0, html_utils_1.escapeHtml)(allocation.quantity)}</div>`)
+        .join("");
+    return `<tr>
+        <td>
+          <strong>${(0, html_utils_1.escapeHtml)(line.title)}</strong>
+          ${line.sku ? `<div class="sku">SKU: ${(0, html_utils_1.escapeHtml)(line.sku)}</div>` : ""}
+          ${batchDetails}
+        </td>
+        <td class="number">${(0, html_utils_1.escapeHtml)(line.quantity)}</td>
+        <td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: line.unit_price.amount, currencyCode: line.unit_price.currency_code }))}</td>
+        <td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: line.total.amount, currencyCode: line.total.currency_code }))}</td>
+      </tr>`;
+})
+    .join("");
+const renderTaxCompliance = (input) => {
+    const evidence = input.order.tax_compliance;
+    if (!evidence ||
+        evidence.exemption_wording !==
+            "steuerfreie_innergemeinschaftliche_lieferung") {
+        return "";
+    }
+    return `<section class="tax-compliance">
+      <h2>Steuerliche Angaben</h2>
+      <strong>${(0, html_utils_1.escapeHtml)(evidence.customer_company_name)}</strong><br />
+      UID des Kunden: ${(0, html_utils_1.escapeHtml)(evidence.customer_vat_number)}<br />
+      Steuerfreie innergemeinschaftliche Lieferung
+    </section>`;
+};
+const renderDiscountTotal = (input) => {
+    const { amount, currency_code: currencyCode } = input.totals.discount_total;
+    const displayAmount = input.document.kind === "invoice" && Number(amount) > 0
+        ? `-${amount}`
+        : amount;
+    return (0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: displayAmount, currencyCode }));
+};
+const formatTaxRate = (rate) => new Intl.NumberFormat(format_1.DEFAULT_FORMAT_LOCALE, {
+    maximumFractionDigits: 2,
+    style: "percent",
+}).format(rate / 100);
+const renderTaxRows = (input) => {
+    const { tax_breakdown: breakdown, tax_total: taxTotal } = input.totals;
+    const rows = breakdown.length > 0
+        ? breakdown.map((entry) => ({
+            label: `${entry.name} ${formatTaxRate(entry.rate)}`,
+            money: entry.tax_total,
+        }))
+        : [{ label: "Umsatzsteuer", money: taxTotal }];
+    return rows
+        .map(({ label, money }) => `<tr><td>${(0, html_utils_1.escapeHtml)(label)}</td><td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: money.amount, currencyCode: money.currency_code }))}</td></tr>`)
+        .join("");
+};
+const renderFinancialDocument = (input, layout, timeZone) => {
+    const labels = labelsByKind[input.document.kind];
+    const metadata = [
+        {
+            label: labels.date,
+            value: (0, format_1.formatDate)(input.document.issued_at, { timeZone }),
+        },
+        {
+            label: "Bestellung",
+            value: (0, html_utils_1.formatOrderReference)(input.order.display_id),
+        },
+    ];
+    if (input.document.kind !== "invoice") {
+        metadata.push({
+            label: "Ursprungsrechnung",
+            value: input.document.source_document_number ?? "-",
+        });
+    }
+    const body = `<section class="recipient">
+      <h2>${labels.recipient}</h2>
+      ${renderAddress(input)}
+    </section>
+    ${renderTaxCompliance(input)}
+    <table>
+      <thead><tr><th>Artikel</th><th class="number">Menge</th><th class="number">Einzelpreis</th><th class="number">Summe</th></tr></thead>
+      <tbody>${renderLines(input, timeZone)}</tbody>
+    </table>
+    <table class="totals">
+      <tbody>
+        <tr><td>Zwischensumme</td><td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: input.totals.subtotal.amount, currencyCode: input.totals.subtotal.currency_code }))}</td></tr>
+        <tr><td>Versand</td><td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: input.totals.shipping_total.amount, currencyCode: input.totals.shipping_total.currency_code }))}</td></tr>
+        <tr><td>Rabatt</td><td class="number">${renderDiscountTotal(input)}</td></tr>
+        ${renderTaxRows(input)}
+        <tr><td>Gesamt</td><td class="number">${(0, html_utils_1.escapeHtml)((0, format_1.formatMoney)({ amount: input.totals.total.amount, currencyCode: input.totals.total.currency_code }))}</td></tr>
+      </tbody>
+    </table>`;
+    return layout({
+        body,
+        documentTitle: labels.title,
+        metadata,
+        number: input.document.number,
+        pageTitle: labels.title,
+    });
+};
+exports.renderFinancialDocument = renderFinancialDocument;

package/dist/documents/templates/format.d.ts

@@ -0,0 +1,16 @@
+export declare const DEFAULT_FORMAT_LOCALE = "de-AT";
+export type FormatMoneyInput = {
+    readonly amount: number | string;
+    readonly currencyCode: string;
+};
+export type FormatMoneyOptions = {
+    readonly locale?: Intl.LocalesArgument;
+};
+export declare const formatMoney: ({ amount, currencyCode }: FormatMoneyInput, { locale }?: FormatMoneyOptions) => string;
+export type FormatDateOptions = {
+    readonly locale?: Intl.LocalesArgument;
+    /** IANA time zone the date is shown in; there is deliberately no default. */
+    readonly timeZone: string;
+    readonly options?: Omit<Intl.DateTimeFormatOptions, "timeZone">;
+};
+export declare const formatDate: (value: string | Date, { locale, options, timeZone }: FormatDateOptions) => string;

package/dist/documents/templates/format.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDate = exports.formatMoney = exports.DEFAULT_FORMAT_LOCALE = void 0;
+exports.DEFAULT_FORMAT_LOCALE = "de-AT";
+const formatMoney = ({ amount, currencyCode }, { locale = exports.DEFAULT_FORMAT_LOCALE } = {}) => {
+    const numericAmount = Number(amount);
+    const normalizedCurrencyCode = currencyCode.toUpperCase();
+    const fallback = `${String(amount)} ${normalizedCurrencyCode}`;
+    if (!Number.isFinite(numericAmount)) {
+        return fallback;
+    }
+    try {
+        return new Intl.NumberFormat(locale, {
+            currency: normalizedCurrencyCode,
+            style: "currency",
+        }).format(numericAmount);
+    }
+    catch {
+        return fallback;
+    }
+};
+exports.formatMoney = formatMoney;
+const formatDate = (value, { locale = exports.DEFAULT_FORMAT_LOCALE, options, timeZone }) => {
+    const date = value instanceof Date ? value : new Date(value);
+    if (Number.isNaN(date.getTime())) {
+        return String(value);
+    }
+    return new Intl.DateTimeFormat(locale, { timeZone, ...options }).format(date);
+};
+exports.formatDate = formatDate;

package/dist/documents/templates/html-factory.d.ts

@@ -0,0 +1,11 @@
+import type { DocumentHtmlFactory } from "../types";
+/**
+ * The plugin's default document markup (German, locale de-AT). The legal
+ * sender comes with every render input (`input.merchant`, the base plugin's
+ * shop master data). `timeZone` is the IANA time zone in which printed dates
+ * are shown; the plugin passes its resolved `numbering.timeZone` so the date
+ * on a document matches the period its number was allocated in.
+ */
+export declare const createDefaultDocumentHtmlFactory: ({ timeZone, }: {
+    timeZone: string;
+}) => DocumentHtmlFactory;

package/dist/documents/templates/html-factory.js

@@ -0,0 +1,39 @@
+"use strict";
+/* eslint-disable @medusajs/use-medusa-error-not-generic-error -- Invalid render inputs are programmer errors, not HTTP responses. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultDocumentHtmlFactory = void 0;
+const layout_1 = require("./layout");
+const financial_document_1 = require("./financial-document");
+const packing_list_1 = require("./packing-list");
+/**
+ * The plugin's default document markup (German, locale de-AT). The legal
+ * sender comes with every render input (`input.merchant`, the base plugin's
+ * shop master data). `timeZone` is the IANA time zone in which printed dates
+ * are shown; the plugin passes its resolved `numbering.timeZone` so the date
+ * on a document matches the period its number was allocated in.
+ */
+const createDefaultDocumentHtmlFactory = ({ timeZone, }) => {
+    return (input) => {
+        const kind = input.document.kind;
+        switch (kind) {
+            case "invoice":
+            case "cancellation":
+            case "credit_note":
+                if ("totals" in input) {
+                    return (0, financial_document_1.renderFinancialDocument)(input, (0, layout_1.createDocumentLayout)(input.merchant, true), timeZone);
+                }
+                break;
+            case "packing_list":
+                if ("fulfillment" in input) {
+                    return (0, packing_list_1.renderPackingList)(input, (0, layout_1.createDocumentLayout)(input.merchant, false), timeZone);
+                }
+                break;
+            default: {
+                const unsupportedKind = kind;
+                throw new TypeError(`Unsupported document kind: ${unsupportedKind}`);
+            }
+        }
+        throw new TypeError(`Invalid input for document kind: ${kind}`);
+    };
+};
+exports.createDefaultDocumentHtmlFactory = createDefaultDocumentHtmlFactory;

package/dist/documents/templates/html-utils.d.ts

@@ -0,0 +1,2 @@
+export declare const escapeHtml: (value: string | number | null | undefined) => string;
+export declare const formatOrderReference: (displayId: number | null) => string;

package/dist/documents/templates/html-utils.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatOrderReference = exports.escapeHtml = void 0;
+const escapeHtml = (value) => String(value ?? "")
+    .replaceAll("&", "&")
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;")
+    .replaceAll('"', "&quot;")
+    .replaceAll("'", "&#039;");
+exports.escapeHtml = escapeHtml;
+const formatOrderReference = (displayId) => displayId === null ? "-" : `#${displayId}`;
+exports.formatOrderReference = formatOrderReference;

package/dist/documents/templates/layout.d.ts

@@ -0,0 +1,17 @@
+import type { DocumentMerchant } from "../types";
+export type DocumentLayoutInput = {
+    readonly body: string;
+    readonly documentTitle: string;
+    readonly metadata: readonly {
+        readonly label: string;
+        readonly value: string;
+    }[];
+    readonly number: string;
+    readonly pageTitle: string;
+};
+export type DocumentLayout = (input: DocumentLayoutInput) => string;
+/**
+ * `includeLegalDetails` adds UID, company register, contact and bank details
+ * to the footer (financial documents); packing lists show only the name.
+ */
+export declare const createDocumentLayout: (merchant: DocumentMerchant, includeLegalDetails: boolean) => DocumentLayout;

package/dist/documents/templates/layout.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDocumentLayout = void 0;
+const html_utils_1 = require("./html-utils");
+const formatCountryName = (countryCode) => new Intl.DisplayNames("de", { type: "region" }).of(countryCode.toUpperCase()) ?? countryCode.toUpperCase();
+const renderMerchantAddress = (merchant) => [
+    merchant.address_line1,
+    merchant.address_line2,
+    [merchant.postal_code, merchant.city].join(" "),
+    formatCountryName(merchant.country_code),
+]
+    .filter((part) => Boolean(part))
+    .map(html_utils_1.escapeHtml)
+    .join("<br />");
+/** Legal footer: name, UID, company register, contact and bank details that are set. */
+const renderMerchantFooter = (merchant, includeLegalDetails) => {
+    if (!includeLegalDetails) {
+        return (0, html_utils_1.escapeHtml)(merchant.legal_name);
+    }
+    const register = [
+        merchant.company_register_number
+            ? `Firmenbuchnummer: ${merchant.company_register_number}`
+            : null,
+        merchant.company_register_court
+            ? `Firmenbuchgericht: ${merchant.company_register_court}`
+            : null,
+    ];
+    const lines = [
+        [
+            merchant.legal_name,
+            merchant.vat_number ? `UID: ${merchant.vat_number}` : null,
+            ...register,
+        ],
+        [merchant.email, merchant.phone, merchant.website],
+        [
+            merchant.iban ? `IBAN: ${merchant.iban}` : null,
+            merchant.bic ? `BIC: ${merchant.bic}` : null,
+        ],
+    ];
+    return lines
+        .map((parts) => parts
+        .filter((part) => Boolean(part))
+        .map(html_utils_1.escapeHtml)
+        .join(" · "))
+        .filter(Boolean)
+        .join("<br />");
+};
+const renderMetadata = (metadata) => metadata
+    .map(({ label, value }) => `<div><strong>${(0, html_utils_1.escapeHtml)(label)}:</strong> ${(0, html_utils_1.escapeHtml)(value)}</div>`)
+    .join("");
+/**
+ * `includeLegalDetails` adds UID, company register, contact and bank details
+ * to the footer (financial documents); packing lists show only the name.
+ */
+const createDocumentLayout = (merchant, includeLegalDetails) => ({ body, documentTitle, metadata, number, pageTitle }) => `<!doctype html>
+<html lang="de">
+  <head>
+    <meta charset="utf-8" />
+    <title>${(0, html_utils_1.escapeHtml)(pageTitle)} ${(0, html_utils_1.escapeHtml)(number)}</title>
+    <style>
+      @page { margin: 18mm; }
+      body { color: #1f2937; font-family: Arial, sans-serif; font-size: 11px; line-height: 1.45; }
+      h1 { font-size: 24px; margin: 0 0 6px; }
+      h2 { break-after: avoid; font-size: 12px; margin: 22px 0 6px; page-break-after: avoid; text-transform: uppercase; }
+      .header { border-bottom: 2px solid #111827; display: flex; gap: 32px; justify-content: space-between; padding-bottom: 16px; }
+      .document-metadata { display: flex; flex-wrap: wrap; gap: 6px 28px; margin: 18px 0 22px; }
+      .document-metadata div { min-width: 180px; }
+      .muted, .sku, .batch { color: #6b7280; }
+      .batch, .packing-batch { font-size: 10px; margin-top: 2px; }
+      .packing-batch { display: flex; gap: 12px; justify-content: space-between; }
+      table { border-collapse: collapse; page-break-inside: auto; width: 100%; }
+      thead { display: table-header-group; }
+      tfoot { display: table-footer-group; }
+      tbody { page-break-inside: auto; }
+      tr { break-inside: avoid; page-break-inside: avoid; }
+      th { background: #f3f4f6; font-size: 10px; text-align: left; text-transform: uppercase; }
+      th, td { border-bottom: 1px solid #d1d5db; padding: 8px 6px; vertical-align: top; }
+      .number { text-align: right; white-space: nowrap; }
+      .recipient, .tax-compliance, .totals { break-inside: avoid; page-break-inside: avoid; }
+      .totals { margin-left: auto; margin-top: 16px; width: 260px; }
+      .totals td { border: 0; padding: 3px 0; }
+      .totals tr:last-child td { border-top: 2px solid #111827; font-size: 14px; font-weight: 700; padding-top: 7px; }
+      footer { border-top: 1px solid #d1d5db; break-inside: avoid; color: #6b7280; font-size: 9px; margin-top: 28px; page-break-inside: avoid; padding-top: 10px; }
+    </style>
+  </head>
+  <body>
+    <section class="header">
+      <div><h1>${(0, html_utils_1.escapeHtml)(documentTitle)}</h1><div class="muted">${(0, html_utils_1.escapeHtml)(number)}</div></div>
+      <div><strong>${(0, html_utils_1.escapeHtml)(merchant.legal_name)}</strong><br />${renderMerchantAddress(merchant)}</div>
+    </section>
+    <section class="document-metadata">${renderMetadata(metadata)}</section>
+    ${body}
+    <footer>${renderMerchantFooter(merchant, includeLegalDetails)}</footer>
+  </body>
+</html>`;
+exports.createDocumentLayout = createDocumentLayout;

package/dist/documents/templates/packing-list.d.ts

@@ -0,0 +1,3 @@
+import type { PackingListTemplateInput } from "../types";
+import type { DocumentLayout } from "./layout";
+export declare const renderPackingList: (input: PackingListTemplateInput, layout: DocumentLayout, timeZone: string) => string;

package/dist/documents/templates/packing-list.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderPackingList = void 0;
+const format_1 = require("./format");
+const html_utils_1 = require("./html-utils");
+const renderBatchAllocations = (line, timeZone) => {
+    if (line.batch_allocations.length === 0) {
+        return '<span class="muted">-</span>';
+    }
+    return line.batch_allocations
+        .map((allocation) => `<div class="packing-batch">
+        <strong>${(0, html_utils_1.escapeHtml)(allocation.lot_number)}</strong>
+        <span>MHD: ${(0, format_1.formatDate)(allocation.expiry_date, { timeZone })}</span>
+        <span>Menge: ${(0, html_utils_1.escapeHtml)(allocation.quantity)}</span>
+      </div>`)
+        .join("");
+};
+const renderLines = (input, timeZone) => input.lines
+    .map((line) => `<tr>
+        <td>
+          <strong>${(0, html_utils_1.escapeHtml)(line.title)}</strong>
+          ${line.sku ? `<div class="sku">SKU: ${(0, html_utils_1.escapeHtml)(line.sku)}</div>` : ""}
+        </td>
+        <td>${renderBatchAllocations(line, timeZone)}</td>
+        <td class="number">${(0, html_utils_1.escapeHtml)(line.quantity)}</td>
+      </tr>`)
+    .join("");
+const renderPackingList = (input, layout, timeZone) => layout({
+    body: `<table>
+      <thead><tr><th>Bezeichnung</th><th>Charge</th><th class="number">Benötigte Menge</th></tr></thead>
+      <tbody>${renderLines(input, timeZone)}</tbody>
+    </table>`,
+    documentTitle: "Packliste",
+    metadata: [
+        {
+            label: "Bestellung",
+            value: (0, html_utils_1.formatOrderReference)(input.order.display_id),
+        },
+        { label: "Fulfillment", value: input.fulfillment.id },
+        {
+            label: "Erstellungsdatum",
+            value: (0, format_1.formatDate)(input.document.generated_at, { timeZone }),
+        },
+        { label: "Lagerplatz", value: input.fulfillment.location_name },
+    ],
+    number: input.document.number,
+    pageTitle: "Packliste",
+});
+exports.renderPackingList = renderPackingList;

package/dist/documents/types/admin-api.d.ts

@@ -0,0 +1 @@
+export type * from "@hartl-services/medusa-food-supplements-contracts/types/documents-admin";

package/dist/documents/types/admin-api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/documents/types/document-summary.d.ts

@@ -0,0 +1 @@
+export type { StoreDocument as DocumentSummary } from "@hartl-services/medusa-food-supplements-contracts/types/documents-store";

package/dist/documents/types/document-summary.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/documents/types/documents.d.ts

@@ -0,0 +1,174 @@
+export type DocumentKind = "invoice" | "cancellation" | "credit_note";
+export type DocumentStatus = "processing" | "issued" | "failed";
+export type ShipmentInvoiceDecision = "pending" | "carrier" | "non_carrier";
+export type RefundResolutionState = "pending_source" | "processing" | "ready" | "not_applicable" | "failed";
+export type RefundCommunicationOwner = "standalone" | "cancellation";
+export type OrderCancellationResolutionState = "pending" | "processing" | "ready" | "failed";
+export type DocumentMoney = {
+    amount: string;
+    currency_code: string;
+};
+export type DocumentAddress = {
+    first_name: string | null;
+    last_name: string | null;
+    company: string | null;
+    address_1: string | null;
+    address_2: string | null;
+    postal_code: string | null;
+    city: string | null;
+    country_code: string | null;
+};
+export type DocumentBatchAllocationDTO = {
+    batch_id: string;
+    lot_number: string;
+    expiry_date: string;
+    quantity: number;
+};
+export type DocumentTaxComplianceDTO = {
+    customer_company_name: string;
+    customer_vat_number: string;
+    exemption_wording: "steuerfreie_innergemeinschaftliche_lieferung";
+};
+/**
+ * Tax amount of one configured tax rate (name and percentage as calculated on
+ * the order's tax lines). Amounts are rounded to the currency's minor unit and
+ * sum up exactly to the rounded document tax total.
+ */
+export type DocumentTaxBreakdownEntry = {
+    name: string;
+    code: string | null;
+    rate: number;
+    tax_total: DocumentMoney;
+};
+export type DocumentTemplateLine = {
+    id: string;
+    title: string;
+    sku: string | null;
+    quantity: number;
+    unit_price: DocumentMoney;
+    subtotal: DocumentMoney;
+    tax_total: DocumentMoney;
+    total: DocumentMoney;
+    batch_allocations: DocumentBatchAllocationDTO[];
+};
+/**
+ * Stable input contract for the project-owned HTML factory. It is a value
+ * snapshot, never a live Medusa order model, so rendering stays isolated from
+ * Medusa internals and the Storefront can import the types safely.
+ */
+export type DocumentTemplateInput = {
+    document: {
+        id: string;
+        kind: DocumentKind;
+        number: string;
+        issued_at: string;
+        source_document_number: string | null;
+    };
+    order: {
+        id: string;
+        display_id: number | null;
+        email: string;
+        currency_code: string;
+        billing_address: DocumentAddress | null;
+        tax_compliance: DocumentTaxComplianceDTO | null;
+    };
+    lines: DocumentTemplateLine[];
+    totals: {
+        subtotal: DocumentMoney;
+        tax_total: DocumentMoney;
+        /** Empty for documents without tax lines and for legacy snapshots. */
+        tax_breakdown: DocumentTaxBreakdownEntry[];
+        shipping_total: DocumentMoney;
+        discount_total: DocumentMoney;
+        total: DocumentMoney;
+    };
+};
+export type DocumentSnapshot = DocumentTemplateInput;
+export type PackingListLifecycleStatus = "active" | "canceled";
+export type PackingListGenerationStatus = "processing" | "ready" | "failed";
+export type PackingListBatchAllocation = {
+    batch_id: string;
+    lot_number: string;
+    expiry_date: string;
+    quantity: number;
+};
+export type PackingListTemplateLine = {
+    line_item_id: string;
+    inventory_item_id: string | null;
+    title: string;
+    sku: string | null;
+    quantity: number;
+    batch_allocations: PackingListBatchAllocation[];
+};
+export type PackingListTemplateInput = {
+    document: {
+        kind: "packing_list";
+        id: string;
+        number: string;
+        source_revision: number;
+        generated_at: string;
+    };
+    order: {
+        id: string;
+        display_id: number | null;
+    };
+    fulfillment: {
+        id: string;
+        created_at: string;
+        location_id: string;
+        location_name: string;
+    };
+    lines: PackingListTemplateLine[];
+};
+export type PackingListSnapshot = PackingListTemplateInput;
+/**
+ * The shop's legal sender facts, read from the base plugin's shop master
+ * data ("Shop-Stammdaten") when a document is rendered. Not part of the
+ * stored snapshot. Optional fields are `null` when not set; the development
+ * UID placeholder `ATU00000000` arrives as `vat_number: null`.
+ */
+export type DocumentMerchant = {
+    legal_name: string;
+    address_line1: string;
+    address_line2: string | null;
+    postal_code: string;
+    city: string;
+    /** Lower-case ISO 3166-1 alpha-2 code. */
+    country_code: string;
+    vat_number: string | null;
+    email: string | null;
+    phone: string | null;
+    website: string | null;
+    iban: string | null;
+    bic: string | null;
+    company_register_number: string | null;
+    company_register_court: string | null;
+};
+/**
+ * Optional `merchant` plugin option: used per field only where the shop
+ * master data in the base plugin has no value (same shape as the demo shop's
+ * `merchant` constant in medusa-config).
+ */
+export type DocumentMerchantOption = {
+    countryCode: string;
+    legalName: string;
+    registeredAddress: {
+        address1: string;
+        address2?: string;
+        city: string;
+        countryCode: string;
+        postalCode: string;
+    };
+    vatNumber?: string;
+};
+export type FinancialDocumentRenderInput = DocumentTemplateInput & {
+    merchant: DocumentMerchant;
+};
+export type PackingListRenderInput = PackingListTemplateInput & {
+    merchant: DocumentMerchant;
+};
+export type DocumentRenderInput = FinancialDocumentRenderInput | PackingListRenderInput;
+export type DocumentPdfOptions = {
+    /** Absolute executable path or command name for the bundled Chromium renderer. */
+    executablePath?: string;
+};

package/dist/documents/types/documents.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });