@hartl-services/medusa-base 0.4.0 → 1.1.0

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

@@ -0,0 +1,35 @@
+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;
+    readonly metadata: readonly {
+        readonly label: string;
+        readonly value: string;
+    }[];
+    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 sender.
+ */
+export declare const createDocumentLayout: (merchant: DocumentMerchant, settings: DocumentRenderSettings, includeLegalDetails: boolean, theme?: DocumentTheme) => DocumentLayout;

package/dist/documents/templates/layout.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDocumentLayout = exports.formatCountryName = void 0;
+const html_utils_1 = require("./html-utils");
+const formatCountryName = (countryCode) => new Intl.DisplayNames("de", { type: "region" }).of(countryCode.toUpperCase()) ?? countryCode.toUpperCase();
+exports.formatCountryName = formatCountryName;
+const joinLines = (lines) => lines
+    .filter((line) => Boolean(line))
+    .map(html_utils_1.escapeHtml)
+    .join("<br />");
+const renderFooterColumn = (heading, lines) => {
+    const content = joinLines(lines);
+    if (!content) {
+        return "";
+    }
+    const title = heading
+        ? `<div class="footer-heading">${(0, html_utils_1.escapeHtml)(heading)}</div>`
+        : "";
+    return `<div class="footer-column">${title}${content}</div>`;
+};
+/**
+ * Legal footer in three columns: sender with UID and company register,
+ * contact, bank. Packing lists (`includeLegalDetails: false`) show only the
+ * sender's name and address.
+ */
+const renderMerchantFooter = (merchant, includeLegalDetails) => {
+    const sender = `<div class="footer-column"><strong>${(0, html_utils_1.escapeHtml)(merchant.legal_name)}</strong><br />${joinLines([
+        merchant.address_line1,
+        merchant.address_line2,
+        `${merchant.postal_code} ${merchant.city}`,
+        (0, exports.formatCountryName)(merchant.country_code),
+        ...(includeLegalDetails
+            ? [
+                merchant.vat_number ? `UID: ${merchant.vat_number}` : null,
+                merchant.company_register_number
+                    ? `Firmenbuchnummer: ${merchant.company_register_number}`
+                    : null,
+                merchant.company_register_court
+                    ? `Firmenbuchgericht: ${merchant.company_register_court}`
+                    : null,
+            ]
+            : []),
+    ])}</div>`;
+    if (!includeLegalDetails) {
+        return sender;
+    }
+    return [
+        sender,
+        renderFooterColumn("Kontakt", [
+            merchant.phone,
+            merchant.email,
+            merchant.website,
+        ]),
+        // The heading names the IBAN; only the BIC keeps its label.
+        renderFooterColumn("Bankverbindung", [
+            merchant.iban,
+            merchant.bic ? `BIC: ${merchant.bic}` : null,
+        ]),
+    ].join("");
+};
+const renderLetterhead = (merchant, settings) => settings.logo_src
+    ? `<img class="logo" src="${(0, html_utils_1.escapeHtml)(settings.logo_src)}" alt="${(0, html_utils_1.escapeHtml)(merchant.legal_name)}" />`
+    : `<div class="logo-text">${(0, html_utils_1.escapeHtml)(merchant.legal_name)}</div>`;
+const renderMetadata = (metadata) => metadata
+    .map(({ label, value }) => `<tr><th scope="row">${(0, html_utils_1.escapeHtml)(label)}</th><td>${(0, html_utils_1.escapeHtml)(value)}</td></tr>`)
+    .join("");
+/**
+ * A4 with only a bottom page margin, which holds the page number
+ * (`@bottom-right`; `counter(pages)` works only in page margin boxes). `.page`
+ * carries the other margins and repeats them on every printed page
+ * (`box-decoration-break: clone`); the fixed footer is positioned in the page
+ * area, `--footer-height` reserves its space at the bottom of each page.
+ */
+const DEFAULT_STYLESHEET = `
+      @page { size: A4; margin: 0 0 8mm 0; @bottom-right { color: #6b7280; content: "Seite " counter(page) " von " counter(pages); font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 7.5pt; padding-right: 20mm; vertical-align: top; } }
+      :root { --accent: #111827; --text: #1f2937; --muted: #6b7280; --line: #d1d5db; --table-head: #f3f4f6; --page-x: 20mm; --page-top: 18mm; --footer-height: 30mm; }
+      * { box-sizing: border-box; }
+      html, body { margin: 0; padding: 0; }
+      body { color: var(--text); font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 10pt; line-height: 1.4; -webkit-print-color-adjust: exact; print-color-adjust: exact; }
+      .page { -webkit-box-decoration-break: clone; box-decoration-break: clone; padding: var(--page-top) var(--page-x) calc(var(--footer-height) + 8mm); }
+      .letterhead { margin-bottom: 14mm; min-height: 16mm; }
+      .logo { display: block; height: 22mm; max-width: 90mm; object-fit: contain; object-position: left center; width: auto; }
+      .logo-text { color: var(--accent); font-size: 20pt; font-weight: 700; letter-spacing: 0.02em; }
+      .document-head { break-inside: avoid; display: flex; gap: 12mm; justify-content: space-between; margin-bottom: 14mm; page-break-inside: avoid; }
+      .recipient { flex: 1 1 0; font-style: normal; padding-top: 9mm; }
+      .document-info { flex: 0 0 78mm; }
+      h1 { color: var(--accent); font-size: 16pt; font-weight: 400; letter-spacing: 0.08em; margin: 0 0 3mm; text-transform: uppercase; }
+      h2 { break-after: avoid; font-size: 10pt; margin: 8mm 0 2mm; page-break-after: avoid; }
+      .document-metadata { border-collapse: collapse; width: 100%; }
+      .document-metadata th, .document-metadata td { border: 0; font-weight: 400; padding: 0; text-align: left; vertical-align: top; }
+      .document-metadata td { text-align: right; }
+      .muted, .sku, .batch { color: var(--muted); }
+      .batch, .packing-batch { font-size: 8pt; margin-top: 1mm; }
+      .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; }
+      .items th { background: var(--table-head); font-weight: 700; text-align: left; }
+      .items th.number { text-align: right; }
+      .items th, .items td { padding: 2.5mm 2mm; vertical-align: top; }
+      .items tbody.lines td { border-bottom: 1px solid var(--line); }
+      .number { text-align: right; white-space: nowrap; }
+      .money { white-space: nowrap; }
+      .items tbody.totals td { padding-bottom: 1.5mm; padding-top: 1.5mm; }
+      .items tbody.totals tr:first-child td { padding-top: 3mm; }
+      .items tbody.totals tr.grand-total td.label, .items tbody.totals tr.grand-total td.number { border-bottom: 1px solid var(--line); border-top: 1px solid var(--line); font-weight: 700; padding-bottom: 2mm; padding-top: 2mm; }
+      .payment-terms { margin-top: 10mm; white-space: pre-line; }
+      .recipient, .tax-compliance, .payment-terms, .items tbody.totals { break-inside: avoid; page-break-inside: avoid; }
+      .page-footer { align-items: flex-start; bottom: 4mm; color: var(--text); display: flex; font-size: 8pt; gap: 8mm; left: var(--page-x); line-height: 1.35; position: fixed; right: var(--page-x); }
+      .footer-column { flex: 1 1 0; }
+      .footer-heading { color: var(--muted); }
+`;
+/**
+ * `includeLegalDetails` adds UID, company register, contact and bank details
+ * to the footer (financial documents); packing lists show only the sender.
+ */
+const createDocumentLayout = (merchant, settings, includeLegalDetails, theme = {}) => ({ body, documentTitle, metadata, number, pageTitle, recipient }) => `<!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>${DEFAULT_STYLESHEET}${theme.stylesheet ?? ""}</style>
+  </head>
+  <body>
+    <footer class="page-footer">${renderMerchantFooter(merchant, includeLegalDetails)}</footer>
+    <main class="page">
+      <header class="letterhead">${renderLetterhead(merchant, settings)}</header>
+      <section class="document-head">
+        <address class="recipient">${recipient ?? ""}</address>
+        <div class="document-info">
+          <h1>${(0, html_utils_1.escapeHtml)(documentTitle)}</h1>
+          <table class="document-metadata"><tbody>${renderMetadata(metadata)}</tbody></table>
+        </div>
+      </section>
+      ${body}
+    </main>
+  </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,51 @@
+"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, html_utils_1.escapeHtml)((0, format_1.formatDocumentDate)(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 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>` : ""}
+        </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 class="items packing-items">
+      <thead><tr><th class="item">Bezeichnung</th><th>Charge</th><th class="number">Benötigte Menge</th></tr></thead>
+      <tbody class="lines">${renderLines(input, timeZone)}</tbody>
+    </table>`,
+    documentTitle: "Packliste",
+    metadata: [
+        { label: "Packlistennummer", value: input.document.number },
+        {
+            label: "Bestellung",
+            value: (0, html_utils_1.formatOrderReference)(input.order.display_id),
+        },
+        { label: "Fulfillment", value: input.fulfillment.id },
+        {
+            label: "Erstellungsdatum",
+            value: (0, format_1.formatDocumentDate)(input.document.generated_at, timeZone),
+        },
+        { label: "Lagerplatz", value: input.fulfillment.location_name },
+    ],
+    number: input.document.number,
+    pageTitle: "Packliste",
+    recipient: null,
+});
+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,191 @@
+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;
+};
+/**
+ * The Documents settings (Admin -> "Hartl Services Plugins" -> Dokumente) a
+ * render needs, read when a document is rendered. Not part of the stored
+ * snapshot: a regenerated document shows the current values.
+ */
+export type DocumentRenderSettings = {
+    /**
+     * The uploaded logo as a `data:` URL, ready for `<img src>`; `null` when no
+     * logo is set or it could not be loaded (the document then shows the
+     * merchant's legal name instead).
+     */
+    logo_src: string | null;
+    /** Payment terms printed below the totals of an invoice; `null` = none. */
+    payment_terms: string | null;
+};
+export type FinancialDocumentRenderInput = DocumentTemplateInput & {
+    merchant: DocumentMerchant;
+    settings: DocumentRenderSettings;
+};
+export type PackingListRenderInput = PackingListTemplateInput & {
+    merchant: DocumentMerchant;
+    settings: DocumentRenderSettings;
+};
+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 });

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

@@ -0,0 +1,8 @@
+import type { DocumentRenderInput } from "./documents";
+/**
+ * The only project-specific document extension point. PDF rendering and file
+ * storage stay inside the plugin; projects control semantic markup and CSS.
+ */
+export type DocumentHtmlFactory = (input: DocumentRenderInput) => string | Promise<string>;
+export declare const defineDocumentHtmlFactory: (factory: DocumentHtmlFactory) => DocumentHtmlFactory;
+export type { DocumentTheme } from "../templates/layout";

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineDocumentHtmlFactory = void 0;
+const defineDocumentHtmlFactory = (factory) => factory;
+exports.defineDocumentHtmlFactory = defineDocumentHtmlFactory;

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

@@ -0,0 +1,5 @@
+export * from "./admin-api";
+export * from "./documents";
+export * from "./document-summary";
+export * from "./html-factory";
+export * from "./store-api";

package/dist/documents/types/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./admin-api"), exports);
+__exportStar(require("./documents"), exports);
+__exportStar(require("./document-summary"), exports);
+__exportStar(require("./html-factory"), exports);
+__exportStar(require("./store-api"), exports);

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

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

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

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

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

@@ -0,0 +1,17 @@
+import type { ResolvedSmtpConfiguration, ShopEmailConfiguration } from "../types";
+export { createSmtpNotificationModuleConfig } from "./notification-module";
+export declare const defineShopEmailConfiguration: <Configuration extends ShopEmailConfiguration>(configuration: Configuration) => Configuration;
+export type { ResolvedSmtpConfiguration, ShopEmailConfiguration, } from "../types";
+export declare const SMTP_ENVIRONMENT_VARIABLES: readonly ["SMTP_HOST", "SMTP_PORT", "SMTP_SECURE", "SMTP_USER", "SMTP_PASSWORD", "SMTP_FROM", "SMTP_REQUIRE_TLS"];
+/**
+ * `medusa build` loads the configuration without deployment secrets. These
+ * placeholders only satisfy the required-variable checks of a build; they
+ * never reach a running server.
+ */
+export declare const SMTP_BUILD_PLACEHOLDERS: Readonly<Record<string, string>>;
+/**
+ * Validates the SMTP environment values and returns the transport
+ * configuration. `allowInsecure` permits plain SMTP for development, tests
+ * and builds; otherwise `SMTP_SECURE` or `SMTP_REQUIRE_TLS` must be `true`.
+ */
+export declare const resolveSmtp: (values: Readonly<Record<(typeof SMTP_ENVIRONMENT_VARIABLES)[number], string>>, allowInsecure: boolean) => ResolvedSmtpConfiguration;

package/dist/email/config/index.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveSmtp = exports.SMTP_BUILD_PLACEHOLDERS = exports.SMTP_ENVIRONMENT_VARIABLES = exports.defineShopEmailConfiguration = exports.createSmtpNotificationModuleConfig = void 0;
+var notification_module_1 = require("./notification-module");
+Object.defineProperty(exports, "createSmtpNotificationModuleConfig", { enumerable: true, get: function () { return notification_module_1.createSmtpNotificationModuleConfig; } });
+const defineShopEmailConfiguration = (configuration) => configuration;
+exports.defineShopEmailConfiguration = defineShopEmailConfiguration;
+exports.SMTP_ENVIRONMENT_VARIABLES = [
+    "SMTP_HOST",
+    "SMTP_PORT",
+    "SMTP_SECURE",
+    "SMTP_USER",
+    "SMTP_PASSWORD",
+    "SMTP_FROM",
+    "SMTP_REQUIRE_TLS",
+];
+/**
+ * `medusa build` loads the configuration without deployment secrets. These
+ * placeholders only satisfy the required-variable checks of a build; they
+ * never reach a running server.
+ */
+exports.SMTP_BUILD_PLACEHOLDERS = {
+    SMTP_FROM: "no-reply@smtp.build.invalid",
+    SMTP_HOST: "smtp.build.invalid",
+    SMTP_PASSWORD: "build-password",
+    SMTP_PORT: "2525",
+    SMTP_REQUIRE_TLS: "false",
+    SMTP_SECURE: "false",
+    SMTP_USER: "build-user",
+};
+const optionalValue = (values, name) => {
+    const value = values[name]?.trim();
+    return value ? value : undefined;
+};
+const integerValue = (values, name, minimum, maximum) => {
+    const value = optionalValue(values, name);
+    if (value === undefined) {
+        return undefined;
+    }
+    const parsed = Number(value);
+    if (!Number.isInteger(parsed) || parsed < minimum || parsed > maximum) {
+        throw new TypeError(`${name} must be an integer from ${minimum} through ${maximum}.`);
+    }
+    return parsed;
+};
+const booleanValue = (values, name, defaultValue) => {
+    const value = optionalValue(values, name);
+    if (value === undefined) {
+        return defaultValue;
+    }
+    if (value !== "true" && value !== "false") {
+        throw new TypeError(`${name} must be either "true" or "false".`);
+    }
+    return value === "true";
+};
+/**
+ * Validates the SMTP environment values and returns the transport
+ * configuration. `allowInsecure` permits plain SMTP for development, tests
+ * and builds; otherwise `SMTP_SECURE` or `SMTP_REQUIRE_TLS` must be `true`.
+ */
+const resolveSmtp = (values, allowInsecure) => {
+    const port = integerValue(values, "SMTP_PORT", 1, 65535);
+    if (port === undefined) {
+        throw new TypeError("SMTP_PORT is required.");
+    }
+    if (!/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(values.SMTP_FROM)) {
+        throw new TypeError("SMTP_FROM must be a valid email address.");
+    }
+    const smtp = {
+        from: values.SMTP_FROM,
+        host: values.SMTP_HOST,
+        password: values.SMTP_PASSWORD,
+        port,
+        requireTls: booleanValue(values, "SMTP_REQUIRE_TLS", false),
+        secure: booleanValue(values, "SMTP_SECURE", false),
+        user: values.SMTP_USER,
+    };
+    if (!smtp.secure && !smtp.requireTls && !allowInsecure) {
+        throw new TypeError("SMTP must use SMTP_SECURE=true or SMTP_REQUIRE_TLS=true outside development and test.");
+    }
+    return smtp;
+};
+exports.resolveSmtp = resolveSmtp;

package/dist/email/config/notification-module.d.ts

@@ -0,0 +1,22 @@
+import type { ResolvedSmtpConfiguration } from "../types";
+export declare const createSmtpNotificationModuleConfig: (smtp: ResolvedSmtpConfiguration) => {
+    resolve: string;
+    options: {
+        providers: {
+            id: string;
+            options: {
+                channels: string[];
+                smtp: Readonly<{
+                    from: string;
+                    host: string;
+                    password: string;
+                    port: number;
+                    requireTls: boolean;
+                    secure: boolean;
+                    user: string;
+                }>;
+            };
+            resolve: string;
+        }[];
+    };
+};

package/dist/email/config/notification-module.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSmtpNotificationModuleConfig = void 0;
+const createSmtpNotificationModuleConfig = (smtp) => ({
+    resolve: "@medusajs/medusa/notification",
+    options: {
+        providers: [
+            {
+                id: "smtp",
+                options: {
+                    channels: ["email"],
+                    smtp,
+                },
+                resolve: "@hartl-services/medusa-base/providers/smtp",
+            },
+        ],
+    },
+});
+exports.createSmtpNotificationModuleConfig = createSmtpNotificationModuleConfig;

package/dist/email/types/email-kinds.d.ts

@@ -0,0 +1,15 @@
+import { z } from "@medusajs/framework/zod";
+export declare const EMAIL_KINDS: readonly ["order.received", "order.received.admin", "order.shipped", "order.canceled", "order.return_requested", "order.return_received", "order.refunded", "auth.password_reset", "affiliate.consignment_report_due", "user.invite"];
+export declare const EmailKindSchema: z.ZodEnum<{
+    "order.received": "order.received";
+    "order.received.admin": "order.received.admin";
+    "order.shipped": "order.shipped";
+    "order.canceled": "order.canceled";
+    "order.return_requested": "order.return_requested";
+    "order.return_received": "order.return_received";
+    "order.refunded": "order.refunded";
+    "auth.password_reset": "auth.password_reset";
+    "affiliate.consignment_report_due": "affiliate.consignment_report_due";
+    "user.invite": "user.invite";
+}>;
+export type EmailKind = (typeof EMAIL_KINDS)[number];