@hartl-services/medusa-base 1.0.0 → 1.1.0

package/dist/admin-components/features/plugin-features/lib/plugin-features-admin-client.d.ts

@@ -55,7 +55,7 @@ export declare const listPluginFeatures: () => Promise<{
             source: "default" | "stored" | "config" | "none";
             invalidates: string[];
         } | {
-            type: "string" | "boolean" | "url";
+            type: "string" | "boolean" | "url" | "image";
             default: string | number | boolean | null;
             value: string | number | boolean | null;
             key: string;
@@ -135,7 +135,7 @@ export declare const retrievePluginFeatures: (pluginKey: string) => Promise<{
             source: "default" | "stored" | "config" | "none";
             invalidates: string[];
         } | {
-            type: "string" | "boolean" | "url";
+            type: "string" | "boolean" | "url" | "image";
             default: string | number | boolean | null;
             value: string | number | boolean | null;
             key: string;
@@ -215,7 +215,7 @@ export declare const updatePluginFeatures: (payload: UpdatePluginFeaturesPayload
             source: "default" | "stored" | "config" | "none";
             invalidates: string[];
         } | {
-            type: "string" | "boolean" | "url";
+            type: "string" | "boolean" | "url" | "image";
             default: string | number | boolean | null;
             value: string | number | boolean | null;
             key: string;
@@ -295,7 +295,7 @@ export declare const updatePluginSettings: (pluginKey: string, payload: UpdatePl
             source: "default" | "stored" | "config" | "none";
             invalidates: string[];
         } | {
-            type: "string" | "boolean" | "url";
+            type: "string" | "boolean" | "url" | "image";
             default: string | number | boolean | null;
             value: string | number | boolean | null;
             key: string;

package/dist/admin-components/i18n/texts.d.ts

@@ -59,6 +59,12 @@ export declare const texts: {
         numberMax: (max: number) => string;
         numberRange: (min: number, max: number) => string;
         selectPlaceholder: string;
+        imageUpload: string;
+        imageReplace: string;
+        imageRemove: string;
+        imageNone: string;
+        imageUploadFailed: string;
+        imagePreviewAlt: (label: string) => string;
         clearHint: string;
         source: {
             stored: string;

package/dist/admin-components/i18n/texts.js

@@ -59,6 +59,12 @@ export const texts = {
         numberMax: (max) => `Höchstens ${max}.`,
         numberRange: (min, max) => `Zwischen ${min} und ${max}.`,
         selectPlaceholder: "Bitte auswählen",
+        imageUpload: "Bild hochladen",
+        imageReplace: "Anderes Bild hochladen",
+        imageRemove: "Entfernen",
+        imageNone: "Kein Bild hinterlegt",
+        imageUploadFailed: "Das Bild konnte nicht hochgeladen werden.",
+        imagePreviewAlt: (label) => `Vorschau ${label}`,
         clearHint: "Ein leeres Feld speichern entfernt den gespeicherten Wert (dann gilt Konfiguration oder Standard).",
         source: {
             stored: "gespeichert",

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

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

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

@@ -3,20 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderFinancialDocument = void 0;
 const format_1 = require("./format");
 const html_utils_1 = require("./html-utils");
+const layout_1 = require("./layout");
 const labelsByKind = {
     cancellation: {
-        date: "Stornodatum",
-        recipient: "Stornorechnung an",
+        number: "Stornonummer",
         title: "Stornorechnung",
     },
     credit_note: {
-        date: "Gutschriftsdatum",
-        recipient: "Gutschrift an",
+        number: "Gutschriftnummer",
         title: "Gutschrift",
     },
     invoice: {
-        date: "Rechnungsdatum",
-        recipient: "Rechnung an",
+        number: "Rechnungsnummer",
         title: "Rechnung",
     },
 };
@@ -26,7 +24,8 @@ const renderAddress = (input) => {
         return (0, html_utils_1.escapeHtml)(input.order.email);
     }
     return [
-        [address.company, address.first_name, address.last_name]
+        address.company,
+        [address.first_name, address.last_name]
             .filter((part) => Boolean(part))
             .join(" "),
         address.address_1,
@@ -34,34 +33,43 @@ const renderAddress = (input) => {
         [address.postal_code, address.city]
             .filter((part) => Boolean(part))
             .join(" "),
-        address.country_code?.toUpperCase(),
+        address.country_code ? (0, layout_1.formatCountryName)(address.country_code) : null,
     ]
         .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>`)
+/** "Charge: L-1, MHD: 30.06.2027"; the quantity only when a line has several batches. */
+const renderBatchDetails = (line, timeZone) => {
+    const showQuantity = line.batch_allocations.length > 1;
+    return line.batch_allocations
+        .map((allocation) => {
+        const parts = [
+            `Charge: ${allocation.lot_number}`,
+            `MHD: ${(0, format_1.formatDocumentDate)(allocation.expiry_date, timeZone)}`,
+            showQuantity ? `Menge: ${allocation.quantity}` : null,
+        ].filter((part) => Boolean(part));
+        return `<div class="batch">${(0, html_utils_1.escapeHtml)(parts.join(", "))}</div>`;
+    })
         .join("");
-    return `<tr>
-        <td>
-          <strong>${(0, html_utils_1.escapeHtml)(line.title)}</strong>
+};
+const renderLines = (input, timeZone) => input.lines
+    .map((line) => `<tr>
+        <td class="item">
+          <div class="item-title">${(0, html_utils_1.escapeHtml)(line.title)}</div>
           ${line.sku ? `<div class="sku">SKU: ${(0, html_utils_1.escapeHtml)(line.sku)}</div>` : ""}
-          ${batchDetails}
+          ${renderBatchDetails(line, timeZone)}
         </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>`;
-})
+        <td class="number quantity">${(0, html_utils_1.escapeHtml)(line.quantity)}</td>
+        <td class="number">${(0, html_utils_1.renderMoney)(line.unit_price)}</td>
+        <td class="number">${(0, html_utils_1.renderMoney)(line.total)}</td>
+      </tr>`)
     .join("");
+const isExemptIntraCommunitySupply = (input) => input.order.tax_compliance?.exemption_wording ===
+    "steuerfreie_innergemeinschaftliche_lieferung";
 const renderTaxCompliance = (input) => {
     const evidence = input.order.tax_compliance;
-    if (!evidence ||
-        evidence.exemption_wording !==
-            "steuerfreie_innergemeinschaftliche_lieferung") {
+    if (!evidence || !isExemptIntraCommunitySupply(input)) {
         return "";
     }
     return `<section class="tax-compliance">
@@ -72,16 +80,18 @@ const renderTaxCompliance = (input) => {
     </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 discount = input.totals.discount_total;
+    const displayAmount = input.document.kind === "invoice" && Number(discount.amount) > 0
+        ? `-${discount.amount}`
+        : discount.amount;
+    return (0, html_utils_1.renderMoney)(discount, displayAmount);
 };
 const formatTaxRate = (rate) => new Intl.NumberFormat(format_1.DEFAULT_FORMAT_LOCALE, {
     maximumFractionDigits: 2,
     style: "percent",
 }).format(rate / 100);
+/** One totals row below the Menge/Einzelpreis columns; the amount sits under "Summe". */
+const renderTotalRow = (label, value, className) => `<tr${className ? ` class="${className}"` : ""}><td class="spacer"></td><td class="label" colspan="2">${(0, html_utils_1.escapeHtml)(label)}</td><td class="number">${value}</td></tr>`;
 const renderTaxRows = (input) => {
     const { tax_breakdown: breakdown, tax_total: taxTotal } = input.totals;
     const rows = breakdown.length > 0
@@ -91,16 +101,17 @@ const renderTaxRows = (input) => {
         }))
         : [{ 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>`)
+        .map(({ label, money }) => renderTotalRow(label, (0, html_utils_1.renderMoney)(money)))
         .join("");
 };
+/** Only invoices ask for payment; cancellations and credit notes do not. */
+const renderPaymentTerms = (input) => input.document.kind === "invoice" && input.settings.payment_terms
+    ? `<section class="payment-terms">${(0, html_utils_1.escapeHtml)(input.settings.payment_terms)}</section>`
+    : "";
 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: labels.number, value: input.document.number },
         {
             label: "Bestellung",
             value: (0, html_utils_1.formatOrderReference)(input.order.display_id),
@@ -112,30 +123,37 @@ const renderFinancialDocument = (input, layout, timeZone) => {
             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>
+    if (input.order.tax_compliance && isExemptIntraCommunitySupply(input)) {
+        metadata.push({
+            label: "Kunden-UID",
+            value: input.order.tax_compliance.customer_vat_number,
+        });
+    }
+    metadata.push({
+        label: "Datum",
+        value: (0, format_1.formatDocumentDate)(input.document.issued_at, timeZone),
+    });
+    const { totals } = input;
+    const body = `<table class="items financial-items">
+      <thead><tr><th class="item">Artikel</th><th class="number quantity">Menge</th><th class="number">Einzelpreis</th><th class="number">Summe</th></tr></thead>
+      <tbody class="lines">${renderLines(input, timeZone)}</tbody>
+      <tbody class="totals">
+        ${renderTotalRow("Zwischensumme", (0, html_utils_1.renderMoney)(totals.subtotal))}
+        ${renderTotalRow("Versand", (0, html_utils_1.renderMoney)(totals.shipping_total))}
+        ${renderTotalRow("Rabatt", renderDiscountTotal(input))}
         ${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>
+        ${renderTotalRow("Gesamt", (0, html_utils_1.renderMoney)(totals.total), "grand-total")}
       </tbody>
-    </table>`;
+    </table>
+    ${renderTaxCompliance(input)}
+    ${renderPaymentTerms(input)}`;
     return layout({
         body,
         documentTitle: labels.title,
         metadata,
         number: input.document.number,
         pageTitle: labels.title,
+        recipient: renderAddress(input),
     });
 };
 exports.renderFinancialDocument = renderFinancialDocument;

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

@@ -14,3 +14,17 @@ export type FormatDateOptions = {
     readonly options?: Omit<Intl.DateTimeFormatOptions, "timeZone">;
 };
 export declare const formatDate: (value: string | Date, { locale, options, timeZone }: FormatDateOptions) => string;
+export type MoneyParts = {
+    /** Currency symbol or code; empty when the amount could not be formatted. */
+    readonly currency: string;
+    /** Signed, localized number without the currency. */
+    readonly amount: string;
+};
+/**
+ * `formatMoney` split into currency and number, so a template can align the
+ * currency and the amount separately. Falls back to the whole
+ * `formatMoney` text as `amount`.
+ */
+export declare const formatMoneyParts: ({ amount, currencyCode }: FormatMoneyInput, { locale }?: FormatMoneyOptions) => MoneyParts;
+/** A document date as "01.01.2027" in the given time zone. */
+export declare const formatDocumentDate: (value: string | Date, timeZone: string) => string;

package/dist/documents/templates/format.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatDate = exports.formatMoney = exports.DEFAULT_FORMAT_LOCALE = void 0;
+exports.formatDocumentDate = exports.formatMoneyParts = 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);
@@ -28,3 +28,45 @@ const formatDate = (value, { locale = exports.DEFAULT_FORMAT_LOCALE, options, ti
     return new Intl.DateTimeFormat(locale, { timeZone, ...options }).format(date);
 };
 exports.formatDate = formatDate;
+/**
+ * `formatMoney` split into currency and number, so a template can align the
+ * currency and the amount separately. Falls back to the whole
+ * `formatMoney` text as `amount`.
+ */
+const formatMoneyParts = ({ amount, currencyCode }, { locale = exports.DEFAULT_FORMAT_LOCALE } = {}) => {
+    const numericAmount = Number(amount);
+    const fallback = {
+        currency: "",
+        amount: (0, exports.formatMoney)({ amount, currencyCode }, { locale }),
+    };
+    if (!Number.isFinite(numericAmount)) {
+        return fallback;
+    }
+    try {
+        const parts = new Intl.NumberFormat(locale, {
+            currency: currencyCode.toUpperCase(),
+            style: "currency",
+        }).formatToParts(numericAmount);
+        return {
+            currency: parts
+                .filter((part) => part.type === "currency")
+                .map((part) => part.value)
+                .join(""),
+            amount: parts
+                .filter((part) => part.type !== "currency" &&
+                !(part.type === "literal" && !part.value.trim()))
+                .map((part) => part.value)
+                .join(""),
+        };
+    }
+    catch {
+        return fallback;
+    }
+};
+exports.formatMoneyParts = formatMoneyParts;
+/** A document date as "01.01.2027" in the given time zone. */
+const formatDocumentDate = (value, timeZone) => (0, exports.formatDate)(value, {
+    timeZone,
+    options: { day: "2-digit", month: "2-digit", year: "numeric" },
+});
+exports.formatDocumentDate = formatDocumentDate;

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

@@ -1,11 +1,15 @@
 import type { DocumentHtmlFactory } from "../types";
+import { type DocumentTheme } from "./layout";
 /**
  * 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.
+ * on a document matches the period its number was allocated in. `theme`
+ * adds a project's CSS and page background (watermark) on top of the default
+ * look; the logo comes from the Documents settings (`input.settings`).
  */
-export declare const createDefaultDocumentHtmlFactory: ({ timeZone, }: {
+export declare const createDefaultDocumentHtmlFactory: ({ timeZone, theme, }: {
     timeZone: string;
+    theme?: DocumentTheme;
 }) => DocumentHtmlFactory;

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

@@ -10,9 +10,11 @@ const packing_list_1 = require("./packing-list");
  * 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.
+ * on a document matches the period its number was allocated in. `theme`
+ * adds a project's CSS and page background (watermark) on top of the default
+ * look; the logo comes from the Documents settings (`input.settings`).
  */
-const createDefaultDocumentHtmlFactory = ({ timeZone, }) => {
+const createDefaultDocumentHtmlFactory = ({ timeZone, theme, }) => {
     return (input) => {
         const kind = input.document.kind;
         switch (kind) {
@@ -20,12 +22,12 @@ const createDefaultDocumentHtmlFactory = ({ timeZone, }) => {
             case "cancellation":
             case "credit_note":
                 if ("totals" in input) {
-                    return (0, financial_document_1.renderFinancialDocument)(input, (0, layout_1.createDocumentLayout)(input.merchant, true), timeZone);
+                    return (0, financial_document_1.renderFinancialDocument)(input, (0, layout_1.createDocumentLayout)(input.merchant, input.settings, true, theme), timeZone);
                 }
                 break;
             case "packing_list":
                 if ("fulfillment" in input) {
-                    return (0, packing_list_1.renderPackingList)(input, (0, layout_1.createDocumentLayout)(input.merchant, false), timeZone);
+                    return (0, packing_list_1.renderPackingList)(input, (0, layout_1.createDocumentLayout)(input.merchant, input.settings, false, theme), timeZone);
                 }
                 break;
             default: {

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

@@ -1,2 +1,8 @@
+import type { DocumentMoney } from "../types";
 export declare const escapeHtml: (value: string | number | null | undefined) => string;
 export declare const formatOrderReference: (displayId: number | null) => string;
+/**
+ * An amount as `<span class="money">` with separate currency and amount
+ * spans; `amount` overrides the money's own amount (e.g. a negated value).
+ */
+export declare const renderMoney: (money: DocumentMoney, amount?: string) => string;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatOrderReference = exports.escapeHtml = void 0;
+exports.renderMoney = exports.formatOrderReference = exports.escapeHtml = void 0;
+const format_1 = require("./format");
 const escapeHtml = (value) => String(value ?? "")
     .replaceAll("&", "&")
     .replaceAll("<", "&lt;")
@@ -10,3 +11,12 @@ const escapeHtml = (value) => String(value ?? "")
 exports.escapeHtml = escapeHtml;
 const formatOrderReference = (displayId) => displayId === null ? "-" : `#${displayId}`;
 exports.formatOrderReference = formatOrderReference;
+/**
+ * An amount as `<span class="money">` with separate currency and amount
+ * spans; `amount` overrides the money's own amount (e.g. a negated value).
+ */
+const renderMoney = (money, amount = money.amount) => {
+    const parts = (0, format_1.formatMoneyParts)({ amount, currencyCode: money.currency_code });
+    return `<span class="money"><span class="currency">${(0, exports.escapeHtml)(parts.currency)}</span> <span class="amount">${(0, exports.escapeHtml)(parts.amount)}</span></span>`;
+};
+exports.renderMoney = renderMoney;

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

@@ -1,4 +1,19 @@
-import type { DocumentMerchant } from "../types";
+import type { DocumentRenderSettings, DocumentMerchant } from "../types";
+/**
+ * Shop-specific look on top of the default markup. A project passes it to
+ * `createDefaultDocumentHtmlFactory` from its own `htmlFactory`, so it keeps
+ * the plugin's content and changes only the appearance.
+ */
+export type DocumentTheme = {
+    /**
+     * CSS appended after the default stylesheet; later rules win. A
+     * full-page image such as a watermark belongs in `@page { background }`:
+     * it covers the whole sheet on every page, while Chromium clips fixed
+     * elements at the page margin and sizes an inline `<svg>` in them wrongly
+     * from the second page on.
+     */
+    readonly stylesheet?: string;
+};
 export type DocumentLayoutInput = {
     readonly body: string;
     readonly documentTitle: string;
@@ -8,10 +23,13 @@ export type DocumentLayoutInput = {
     }[];
     readonly number: string;
     readonly pageTitle: string;
+    /** Escaped recipient address markup; `null` leaves the block empty. */
+    readonly recipient: string | null;
 };
 export type DocumentLayout = (input: DocumentLayoutInput) => string;
+export declare const formatCountryName: (countryCode: string) => string;
 /**
  * `includeLegalDetails` adds UID, company register, contact and bank details
- * to the footer (financial documents); packing lists show only the name.
+ * to the footer (financial documents); packing lists show only the sender.
  */
-export declare const createDocumentLayout: (merchant: DocumentMerchant, includeLegalDetails: boolean) => DocumentLayout;
+export declare const createDocumentLayout: (merchant: DocumentMerchant, settings: DocumentRenderSettings, includeLegalDetails: boolean, theme?: DocumentTheme) => DocumentLayout;