@hartl-services/medusa-base 2.5.0 → 2.6.1

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderFinancialDocument = void 0;
 const format_1 = require("./format");
+const lib_1 = require("../../shared/lib");
 const html_utils_1 = require("./html-utils");
 const layout_1 = require("./layout");
 const labelsByKind = {
@@ -21,7 +22,7 @@ const labelsByKind = {
 const renderAddress = (input) => {
     const address = input.order.billing_address;
     if (!address) {
-        return (0, html_utils_1.escapeHtml)(input.order.email);
+        return (0, lib_1.escapeHtml)(input.order.email);
     }
     return [
         address.company,
@@ -36,7 +37,7 @@ const renderAddress = (input) => {
         address.country_code ? (0, layout_1.formatCountryName)(address.country_code) : null,
     ]
         .filter((part) => Boolean(part))
-        .map(html_utils_1.escapeHtml)
+        .map(lib_1.escapeHtml)
         .join("<br />");
 };
 /** "Charge: L-1, MHD: 30.06.2027"; the quantity only when a line has several batches. */
@@ -49,18 +50,18 @@ const renderBatchDetails = (line, timeZone) => {
             `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>`;
+        return `<div class="batch">${(0, lib_1.escapeHtml)(parts.join(", "))}</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>` : ""}
+          <div class="item-title">${(0, lib_1.escapeHtml)(line.title)}</div>
+          ${line.sku ? `<div class="sku">SKU: ${(0, lib_1.escapeHtml)(line.sku)}</div>` : ""}
           ${renderBatchDetails(line, timeZone)}
         </td>
-        <td class="number quantity">${(0, html_utils_1.escapeHtml)(line.quantity)}</td>
+        <td class="number quantity">${(0, lib_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>`)
@@ -74,8 +75,8 @@ const renderTaxCompliance = (input) => {
     }
     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 />
+      <strong>${(0, lib_1.escapeHtml)(evidence.customer_company_name)}</strong><br />
+      UID des Kunden: ${(0, lib_1.escapeHtml)(evidence.customer_vat_number)}<br />
       Steuerfreie innergemeinschaftliche Lieferung
     </section>`;
 };
@@ -91,7 +92,7 @@ const formatTaxRate = (rate) => new Intl.NumberFormat(format_1.DEFAULT_FORMAT_LO
     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 renderTotalRow = (label, value, className) => `<tr${className ? ` class="${className}"` : ""}><td class="spacer"></td><td class="label" colspan="2">${(0, lib_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
@@ -106,7 +107,7 @@ const renderTaxRows = (input) => {
 };
 /** 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>`
+    ? `<section class="payment-terms">${(0, lib_1.escapeHtml)(input.settings.payment_terms)}</section>`
     : "";
 const renderFinancialDocument = (input, layout, timeZone) => {
     const labels = labelsByKind[input.document.kind];

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

@@ -7,7 +7,7 @@ import { type DocumentTheme } from "./layout";
  * are shown; the plugin passes its resolved `numbering.timeZone` so the date
  * 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`).
+ * look; logo and colors come from the shop appearance (`input.settings`).
  */
 export declare const createDefaultDocumentHtmlFactory: ({ timeZone, theme, }: {
     timeZone: string;

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

@@ -12,7 +12,7 @@ const packing_list_1 = require("./packing-list");
  * are shown; the plugin passes its resolved `numbering.timeZone` so the date
  * 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`).
+ * look; logo and colors come from the shop appearance (`input.settings`).
  */
 const createDefaultDocumentHtmlFactory = ({ timeZone, theme, }) => {
     return (input) => {

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

@@ -1,5 +1,4 @@
 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

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

@@ -1,14 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderMoney = exports.formatOrderReference = exports.escapeHtml = void 0;
+exports.renderMoney = exports.formatOrderReference = void 0;
+const lib_1 = require("../../shared/lib");
 const format_1 = require("./format");
-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;
 /**
@@ -17,6 +11,6 @@ exports.formatOrderReference = formatOrderReference;
  */
 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>`;
+    return `<span class="money"><span class="currency">${(0, lib_1.escapeHtml)(parts.currency)}</span> <span class="amount">${(0, lib_1.escapeHtml)(parts.amount)}</span></span>`;
 };
 exports.renderMoney = renderMoney;

package/dist/documents/templates/layout.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDocumentLayout = exports.formatCountryName = void 0;
-const html_utils_1 = require("./html-utils");
+const lib_1 = require("../../shared/lib");
 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)
+    .map(lib_1.escapeHtml)
     .join("<br />");
 const renderFooterColumn = (heading, lines) => {
     const content = joinLines(lines);
@@ -14,7 +14,7 @@ const renderFooterColumn = (heading, lines) => {
         return "";
     }
     const title = heading
-        ? `<div class="footer-heading">${(0, html_utils_1.escapeHtml)(heading)}</div>`
+        ? `<div class="footer-heading">${(0, lib_1.escapeHtml)(heading)}</div>`
         : "";
     return `<div class="footer-column">${title}${content}</div>`;
 };
@@ -24,7 +24,7 @@ const renderFooterColumn = (heading, lines) => {
  * 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([
+    const sender = `<div class="footer-column"><strong>${(0, lib_1.escapeHtml)(merchant.legal_name)}</strong><br />${joinLines([
         merchant.address_line1,
         merchant.address_line2,
         `${merchant.postal_code} ${merchant.city}`,
@@ -59,10 +59,10 @@ const renderMerchantFooter = (merchant, includeLegalDetails) => {
     ].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>`;
+    ? `<img class="logo" src="${(0, lib_1.escapeHtml)(settings.logo_src)}" alt="${(0, lib_1.escapeHtml)(merchant.legal_name)}" />`
+    : `<div class="logo-text">${(0, lib_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>`)
+    .map(({ label, value }) => `<tr><th scope="row">${(0, lib_1.escapeHtml)(label)}</th><td>${(0, lib_1.escapeHtml)(value)}</td></tr>`)
     .join("");
 /**
  * A4 with only a bottom page margin, which holds the page number
@@ -112,6 +112,25 @@ const DEFAULT_STYLESHEET = `
       .footer-column { flex: 1 1 0; }
       .footer-heading { color: var(--muted); }
 `;
+const COLOR_TOKENS = {
+    accent: "--accent",
+    text: "--text",
+    muted: "--muted",
+    line: "--line",
+    surface: "--table-head",
+};
+const HEX_COLOR = /^#[0-9a-f]{6}$/;
+/**
+ * The shop's appearance colors as a `:root` block that overrides the default
+ * tokens; only set, well-formed values are emitted (empty = no block, so the
+ * stylesheet stays the default).
+ */
+const renderColorTokens = (colors) => {
+    const declarations = Object.keys(COLOR_TOKENS)
+        .filter((token) => HEX_COLOR.test(colors[token] ?? ""))
+        .map((token) => `${COLOR_TOKENS[token]}: ${colors[token]};`);
+    return declarations.length ? `\n      :root { ${declarations.join(" ")} }\n` : "";
+};
 /**
  * `includeLegalDetails` adds UID, company register, contact and bank details
  * to the footer (financial documents); packing lists show only the sender.
@@ -120,8 +139,8 @@ const createDocumentLayout = (merchant, settings, includeLegalDetails, theme = {
 <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>
+    <title>${(0, lib_1.escapeHtml)(pageTitle)} ${(0, lib_1.escapeHtml)(number)}</title>
+    <style>${DEFAULT_STYLESHEET}${renderColorTokens(settings.colors)}${theme.stylesheet ?? ""}</style>
   </head>
   <body>
     <footer class="page-footer">${renderMerchantFooter(merchant, includeLegalDetails)}</footer>
@@ -130,7 +149,7 @@ const createDocumentLayout = (merchant, settings, includeLegalDetails, theme = {
       <section class="document-head">
         <address class="recipient">${recipient ?? ""}</address>
         <div class="document-info">
-          <h1>${(0, html_utils_1.escapeHtml)(documentTitle)}</h1>
+          <h1>${(0, lib_1.escapeHtml)(documentTitle)}</h1>
           <table class="document-metadata"><tbody>${renderMetadata(metadata)}</tbody></table>
         </div>
       </section>

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderPackingList = void 0;
 const format_1 = require("./format");
+const lib_1 = require("../../shared/lib");
 const html_utils_1 = require("./html-utils");
 const renderBatchAllocations = (line, timeZone) => {
     if (line.batch_allocations.length === 0) {
@@ -9,20 +10,20 @@ const renderBatchAllocations = (line, timeZone) => {
     }
     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>
+        <strong>${(0, lib_1.escapeHtml)(allocation.lot_number)}</strong>
+        <span>MHD: ${(0, lib_1.escapeHtml)((0, format_1.formatDocumentDate)(allocation.expiry_date, timeZone))}</span>
+        <span>Menge: ${(0, lib_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>` : ""}
+          <div class="item-title">${(0, lib_1.escapeHtml)(line.title)}</div>
+          ${line.sku ? `<div class="sku">SKU: ${(0, lib_1.escapeHtml)(line.sku)}</div>` : ""}
         </td>
         <td>${renderBatchAllocations(line, timeZone)}</td>
-        <td class="number">${(0, html_utils_1.escapeHtml)(line.quantity)}</td>
+        <td class="number">${(0, lib_1.escapeHtml)(line.quantity)}</td>
       </tr>`)
     .join("");
 const renderPackingList = (input, layout, timeZone) => layout({

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

@@ -1,3 +1,4 @@
+import type { ShopAppearanceColors } from "../../public";
 export type DocumentKind = "invoice" | "cancellation" | "credit_note";
 export type DocumentStatus = "processing" | "issued" | "failed";
 export type ShipmentInvoiceDecision = "pending" | "carrier" | "non_carrier";
@@ -146,13 +147,18 @@ export type DocumentMerchant = {
 };
 export type DocumentRenderSettings = {
     /**
-     * The uploaded logo as a `data:` URL, ready for `<img src>`; `null` when no
+     * The shop's logo (Shop-Stammdaten, Erscheinungsbild) 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;
+    /**
+     * The shop's appearance colors (`#rrggbb`); only the set ones. A color that
+     * is missing keeps the default stylesheet's value.
+     */
+    colors: ShopAppearanceColors;
 };
 export type FinancialDocumentRenderInput = DocumentTemplateInput & {
     merchant: DocumentMerchant;

package/dist/email/config/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveSmtp = exports.SMTP_BUILD_PLACEHOLDERS = exports.SMTP_ENVIRONMENT_VARIABLES = exports.defineShopEmailConfiguration = exports.createSmtpNotificationModuleConfig = void 0;
+const config_1 = require("../../public/config");
 const sender_1 = require("../domain/sender");
 var notification_module_1 = require("./notification-module");
 Object.defineProperty(exports, "createSmtpNotificationModuleConfig", { enumerable: true, get: function () { return notification_module_1.createSmtpNotificationModuleConfig; } });
@@ -29,38 +30,13 @@ exports.SMTP_BUILD_PLACEHOLDERS = {
     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);
+    const port = (0, config_1.integerEnvironment)(values, "SMTP_PORT", 1, 65535);
     if (port === undefined) {
         throw new TypeError("SMTP_PORT is required.");
     }
@@ -74,8 +50,8 @@ const resolveSmtp = (values, allowInsecure) => {
         host: values.SMTP_HOST,
         password: values.SMTP_PASSWORD,
         port,
-        requireTls: booleanValue(values, "SMTP_REQUIRE_TLS", false),
-        secure: booleanValue(values, "SMTP_SECURE", false),
+        requireTls: (0, config_1.booleanEnvironment)(values, "SMTP_REQUIRE_TLS", false),
+        secure: (0, config_1.booleanEnvironment)(values, "SMTP_SECURE", false),
         user: values.SMTP_USER,
     };
     if (!smtp.secure && !smtp.requireTls && !allowInsecure) {

package/dist/email/types/shop-configuration.d.ts

@@ -1,4 +1,4 @@
-import type { ShopMasterData } from "../../public";
+import type { ShopAppearanceColors, ShopMasterData } from "../../public";
 import type { EmailKind } from "./email-kinds";
 import type { EmailRenderDataMap } from "./template-data";
 export type EmailTemplateContent = Readonly<{
@@ -7,12 +7,13 @@ export type EmailTemplateContent = Readonly<{
     text: string;
 }>;
 /**
- * The shop's master data ("Shop-Stammdaten") plus the `logo` URL of the
- * E-Mail settings, read when the mail is sent. Every field may be missing; a
- * layout shows what is there instead of failing.
+ * The shop's master data ("Shop-Stammdaten") plus its appearance
+ * ("Erscheinungsbild": `logo` URL and `colors`), read when the mail is sent.
+ * Every field may be missing; a layout shows what is there instead of failing.
  */
 export type EmailShopDetails = Readonly<ShopMasterData & {
     logo?: string;
+    colors: ShopAppearanceColors;
 }>;
 /** Who reads a mail: a customer or the shop's own team. */
 export type EmailAudience = "customer" | "shop";
@@ -24,7 +25,7 @@ export type EmailLayout = (input: Readonly<{
     shop: EmailShopDetails;
 }>) => string;
 export type EmailRendererMap = {
-    readonly [Kind in EmailKind]: (data: EmailRenderDataMap[Kind]) => EmailTemplateContent;
+    readonly [Kind in EmailKind]: (data: EmailRenderDataMap[Kind], shop: EmailShopDetails) => EmailTemplateContent;
 };
 /**
  * What a shop configures. `layout` and `renderers` are optional overrides of

package/dist/files/config/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveExpirationStrategy = exports.resolveS3Credentials = exports.S3_BUILD_PLACEHOLDERS = exports.createS3CacheStorageConfig = exports.createS3CacheFileModuleConfig = exports.validateS3CacheProviderOptions = void 0;
+const config_1 = require("../../public/config");
 const PACKAGE_NAME = "medusa-s3-cache-storage";
 const DEFAULT_CACHE = {
     cleanupIntervalMs: 900_000,
@@ -205,10 +206,6 @@ exports.S3_BUILD_PLACEHOLDERS = {
     S3_CACHE_STORAGE_BUCKET: "build-bucket",
     S3_CACHE_STORAGE_REGION: "build-placeholder",
 };
-const optionalEnvironment = (environment, name) => {
-    const value = environment[name]?.trim();
-    return value ? value : undefined;
-};
 /**
  * Static S3 credentials are optional (the AWS credential chain applies
  * otherwise) but must be complete when present. They are never read during
@@ -218,9 +215,9 @@ const resolveS3Credentials = (environment, phase) => {
     if (phase === "build") {
         return undefined;
     }
-    const accessKeyId = optionalEnvironment(environment, "S3_CACHE_STORAGE_ACCESS_KEY_ID");
-    const secretAccessKey = optionalEnvironment(environment, "S3_CACHE_STORAGE_SECRET_ACCESS_KEY");
-    const sessionToken = optionalEnvironment(environment, "S3_CACHE_STORAGE_SESSION_TOKEN");
+    const accessKeyId = (0, config_1.optionalEnvironment)(environment, "S3_CACHE_STORAGE_ACCESS_KEY_ID");
+    const secretAccessKey = (0, config_1.optionalEnvironment)(environment, "S3_CACHE_STORAGE_SECRET_ACCESS_KEY");
+    const sessionToken = (0, config_1.optionalEnvironment)(environment, "S3_CACHE_STORAGE_SESSION_TOKEN");
     // A declared but blank key still counts: it signals intended static
     // credentials, which must then be complete.
     if (!("S3_CACHE_STORAGE_ACCESS_KEY_ID" in environment) &&
@@ -243,7 +240,7 @@ const resolveS3Credentials = (environment, phase) => {
 };
 exports.resolveS3Credentials = resolveS3Credentials;
 const resolveExpirationStrategy = (environment, defaultValue) => {
-    const value = optionalEnvironment(environment, "S3_CACHE_STORAGE_EXPIRATION_STRATEGY");
+    const value = (0, config_1.optionalEnvironment)(environment, "S3_CACHE_STORAGE_EXPIRATION_STRATEGY");
     if (value === undefined) {
         return defaultValue;
     }

package/dist/modules/documents/domain/options.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveDocumentPluginOptions = exports.DEFAULT_NUMBERING_TIME_ZONE = void 0;
 const utils_1 = require("@medusajs/framework/utils");
+const lib_1 = require("../../../shared/lib");
 const html_factory_1 = require("../../../documents/templates/html-factory");
 /** Used when the `documents.numbering.timeZone` option is not given. */
 exports.DEFAULT_NUMBERING_TIME_ZONE = "Europe/Vienna";
@@ -13,10 +14,7 @@ const resolveDocumentPluginOptions = (options) => {
     if (!timeZone) {
         throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, "The documents plugin requires a numbering time zone.");
     }
-    try {
-        new Intl.DateTimeFormat("en", { timeZone }).format();
-    }
-    catch {
+    if (!(0, lib_1.isValidTimeZone)(timeZone)) {
         throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, `The documents numbering time zone '${timeZone}' is invalid.`);
     }
     if (options?.htmlFactory !== undefined &&

package/dist/public/descriptor.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePluginFeatureDescriptor = validatePluginFeatureDescriptor;
 exports.definePluginFeatures = definePluginFeatures;
 const utils_1 = require("@medusajs/framework/utils");
+const lib_1 = require("../shared/lib");
 const KEY_PATTERN = /^[a-z][a-z0-9_]{0,62}$/;
 const SETTING_TYPES = new Set([
     "string",
@@ -12,30 +13,24 @@ const SETTING_TYPES = new Set([
     "secret",
     "select",
     "image",
+    "color",
 ]);
+const HEX_COLOR_PATTERN = /^#[0-9a-f]{6}$/;
 const ACTION_MODES = new Set(["sync", "background"]);
 const ADMIN_PAGE_PREFIX = "/settings/hartl-services/";
 const BASE_PAGE_PREFIX = "/settings/hartl-services/plugin/";
 const ADMIN_PAGE_PATTERN = /^\/settings\/hartl-services(\/[a-z0-9][a-z0-9_-]*)+$/;
-const isHttpUrl = (value) => {
-    try {
-        const url = new URL(value);
-        return url.protocol === "http:" || url.protocol === "https:";
-    }
-    catch {
-        return false;
-    }
-};
 const invalid = (pluginKey, message) => new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, `Ungültige Funktionsschalter für Plugin "${pluginKey}": ${message}`);
-const hasText = (value) => typeof value === "string" && value.trim().length > 0;
 const defaultMatchesType = (setting) => {
     const value = setting.default;
     switch (setting.type) {
         case "string":
-            return hasText(value);
+            return (0, lib_1.isNonEmptyString)(value);
         case "url":
         case "image":
-            return typeof value === "string" && isHttpUrl(value);
+            return typeof value === "string" && (0, lib_1.isHttpUrl)(value);
+        case "color":
+            return typeof value === "string" && HEX_COLOR_PATTERN.test(value);
         case "number":
             return typeof value === "number" && Number.isFinite(value);
         case "boolean":
@@ -60,7 +55,7 @@ const validateTypeExtras = (pluginKey, setting) => {
         }
         const values = new Set();
         for (const option of options) {
-            if (!hasText(option?.value) || !hasText(option?.label)) {
+            if (!(0, lib_1.isNonEmptyString)(option?.value) || !(0, lib_1.isNonEmptyString)(option?.label)) {
                 throw invalid(pluginKey, `Auswahl "${setting.key}" hat eine Option ohne value oder label.`);
             }
             if (values.has(option.value)) {
@@ -126,9 +121,12 @@ const validateSettings = (pluginKey, settings) => {
             throw invalid(pluginKey, `Einstellungs-Key "${setting.key}" ist doppelt.`);
         }
         seen.add(setting.key);
-        if (!hasText(setting.label)) {
+        if (!(0, lib_1.isNonEmptyString)(setting.label)) {
             throw invalid(pluginKey, `Einstellung "${setting.key}" hat kein label.`);
         }
+        if (setting.group !== undefined && !(0, lib_1.isNonEmptyString)(setting.group)) {
+            throw invalid(pluginKey, `Einstellung "${setting.key}": group muss ein nicht-leerer Text sein.`);
+        }
         if (!SETTING_TYPES.has(setting.type)) {
             throw invalid(pluginKey, `Einstellung "${setting.key}" hat einen unbekannten Typ.`);
         }
@@ -161,16 +159,16 @@ const validateActions = (pluginKey, actions) => {
             throw invalid(pluginKey, `Aktions-Key "${action.key}" ist doppelt.`);
         }
         seen.add(action.key);
-        if (!hasText(action.label)) {
+        if (!(0, lib_1.isNonEmptyString)(action.label)) {
             throw invalid(pluginKey, `Aktion "${action.key}" hat kein label.`);
         }
-        if (!hasText(action.workflow_id)) {
+        if (!(0, lib_1.isNonEmptyString)(action.workflow_id)) {
             throw invalid(pluginKey, `Aktion "${action.key}" hat keine workflow_id.`);
         }
         if (!ACTION_MODES.has(action.mode)) {
             throw invalid(pluginKey, `Aktion "${action.key}" hat einen unbekannten Modus.`);
         }
-        if (action.confirm !== undefined && !hasText(action.confirm)) {
+        if (action.confirm !== undefined && !(0, lib_1.isNonEmptyString)(action.confirm)) {
             throw invalid(pluginKey, `Aktion "${action.key}": confirm ist leer.`);
         }
     }

package/dist/public/enforcement.d.ts

@@ -1,4 +1,4 @@
-import type { MedusaRequestHandler } from "@medusajs/framework/http";
+import type { MiddlewareRoute, MedusaRequestHandler } from "@medusajs/framework/http";
 import type { MedusaContainer } from "@medusajs/framework/types";
 import type { PluginFeatureDescriptor } from "./types";
 /**
@@ -18,3 +18,23 @@ export declare function isPluginFeatureEnabledByKey(container: MedusaContainer,
  * with `NOT_FOUND` (404); all given keys must be enabled.
  */
 export declare function requirePluginFeature<K extends string>(descriptor: PluginFeatureDescriptor<K>, ...keys: K[]): MedusaRequestHandler;
+/**
+ * Route-gate factory for a plugin's `api/middlewares.ts`: bind the descriptor
+ * once, then declare one entry per matcher. Without `methods` Medusa
+ * registers the entry with `app.use`, i.e. as a prefix match that runs before
+ * every method-specific middleware (authentication included), so a disabled
+ * feature answers 404 for the route and everything below it. Without keys
+ * only the plugin switch is checked; several keys must all be enabled.
+ *
+ * ```ts
+ * const gate = pluginFeatureGate(affiliatePluginFeatures)
+ * routes: [gate("/store/affiliates"), gate("/admin/consignment-reports", "consignment")]
+ * ```
+ */
+export declare const pluginFeatureGate: <K extends string>(descriptor: PluginFeatureDescriptor<K>) => (matcher: string, ...keys: K[]) => MiddlewareRoute;
+/**
+ * Filter for subscribers of `plugin-features.updated.v1`,
+ * `plugin-settings.updated.v1` and the like: whether the event concerns the
+ * given plugin. Never throws; a malformed payload is not "own".
+ */
+export declare const isOwnPluginEvent: (data: unknown, pluginKey: string) => boolean;

package/dist/public/enforcement.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOwnPluginEvent = exports.pluginFeatureGate = void 0;
 exports.isPluginFeatureEnabled = isPluginFeatureEnabled;
 exports.isPluginFeatureEnabledByKey = isPluginFeatureEnabledByKey;
 exports.requirePluginFeature = requirePluginFeature;
@@ -58,3 +59,30 @@ function requirePluginFeature(descriptor, ...keys) {
         next();
     };
 }
+/**
+ * Route-gate factory for a plugin's `api/middlewares.ts`: bind the descriptor
+ * once, then declare one entry per matcher. Without `methods` Medusa
+ * registers the entry with `app.use`, i.e. as a prefix match that runs before
+ * every method-specific middleware (authentication included), so a disabled
+ * feature answers 404 for the route and everything below it. Without keys
+ * only the plugin switch is checked; several keys must all be enabled.
+ *
+ * ```ts
+ * const gate = pluginFeatureGate(affiliatePluginFeatures)
+ * routes: [gate("/store/affiliates"), gate("/admin/consignment-reports", "consignment")]
+ * ```
+ */
+const pluginFeatureGate = (descriptor) => (matcher, ...keys) => ({
+    matcher,
+    middlewares: [requirePluginFeature(descriptor, ...keys)],
+});
+exports.pluginFeatureGate = pluginFeatureGate;
+/**
+ * Filter for subscribers of `plugin-features.updated.v1`,
+ * `plugin-settings.updated.v1` and the like: whether the event concerns the
+ * given plugin. Never throws; a malformed payload is not "own".
+ */
+const isOwnPluginEvent = (data, pluginKey) => typeof data === "object" &&
+    data !== null &&
+    data.plugin_key === pluginKey;
+exports.isOwnPluginEvent = isOwnPluginEvent;

package/dist/public/index.d.ts

@@ -1,9 +1,10 @@
 export { PLUGIN_FEATURES_MODULE } from "./constants";
 export { definePluginFeatures } from "./descriptor";
 export { resolveEffectivePluginFeatures } from "./effective-features";
-export { isPluginFeatureEnabled, isPluginFeatureEnabledByKey, requirePluginFeature, } from "./enforcement";
+export { isOwnPluginEvent, isPluginFeatureEnabled, isPluginFeatureEnabledByKey, pluginFeatureGate, requirePluginFeature, } from "./enforcement";
+export { isBasePluginRegistered, resolveBaseModule } from "./module-access";
 export { getPluginSettings } from "./settings";
-export { getShopMasterData, shopMasterDataDescriptor, type ResolvedShopMasterData, type ShopMasterData, type ShopMasterDataKey, } from "./shop-master-data";
+export { getShopAppearance, getShopMasterData, shopMasterDataDescriptor, type ResolvedShopMasterData, type ShopAppearance, type ShopAppearanceColors, type ShopMasterData, type ShopMasterDataKey, } from "./shop-master-data";
 export { reportPluginActionProgress, type PluginActionProgress, } from "./action-progress";
 export type { BasePluginOptions, EffectivePluginFeatures, PluginActionDefinition, PluginActionMode, PluginActionProgressInput, PluginActionWorkflowInput, PluginFeatureDefinition, PluginFeatureDescriptor, PluginFeatureProvider, PluginSettingDefinition, PluginSettingOption, PluginSettingsFallback, PluginSettingType, PluginSettingValue, ResolvedPluginSettings, } from "./types";
 export type { CompleteCartHookDeclarations, CompleteCartHookName, CompleteCartOrderCreatedInput, CompleteCartParticipant, CompleteCartParticipantStep, CompleteCartValidateInput, } from "./complete-cart";

package/dist/public/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reportPluginActionProgress = exports.shopMasterDataDescriptor = exports.getShopMasterData = exports.getPluginSettings = exports.requirePluginFeature = exports.isPluginFeatureEnabledByKey = exports.isPluginFeatureEnabled = exports.resolveEffectivePluginFeatures = exports.definePluginFeatures = exports.PLUGIN_FEATURES_MODULE = void 0;
+exports.reportPluginActionProgress = exports.shopMasterDataDescriptor = exports.getShopMasterData = exports.getShopAppearance = exports.getPluginSettings = exports.resolveBaseModule = exports.isBasePluginRegistered = exports.requirePluginFeature = exports.pluginFeatureGate = exports.isPluginFeatureEnabledByKey = exports.isPluginFeatureEnabled = exports.isOwnPluginEvent = exports.resolveEffectivePluginFeatures = exports.definePluginFeatures = exports.PLUGIN_FEATURES_MODULE = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "PLUGIN_FEATURES_MODULE", { enumerable: true, get: function () { return constants_1.PLUGIN_FEATURES_MODULE; } });
 var descriptor_1 = require("./descriptor");
@@ -8,12 +8,18 @@ Object.defineProperty(exports, "definePluginFeatures", { enumerable: true, get:
 var effective_features_1 = require("./effective-features");
 Object.defineProperty(exports, "resolveEffectivePluginFeatures", { enumerable: true, get: function () { return effective_features_1.resolveEffectivePluginFeatures; } });
 var enforcement_1 = require("./enforcement");
+Object.defineProperty(exports, "isOwnPluginEvent", { enumerable: true, get: function () { return enforcement_1.isOwnPluginEvent; } });
 Object.defineProperty(exports, "isPluginFeatureEnabled", { enumerable: true, get: function () { return enforcement_1.isPluginFeatureEnabled; } });
 Object.defineProperty(exports, "isPluginFeatureEnabledByKey", { enumerable: true, get: function () { return enforcement_1.isPluginFeatureEnabledByKey; } });
+Object.defineProperty(exports, "pluginFeatureGate", { enumerable: true, get: function () { return enforcement_1.pluginFeatureGate; } });
 Object.defineProperty(exports, "requirePluginFeature", { enumerable: true, get: function () { return enforcement_1.requirePluginFeature; } });
+var module_access_1 = require("./module-access");
+Object.defineProperty(exports, "isBasePluginRegistered", { enumerable: true, get: function () { return module_access_1.isBasePluginRegistered; } });
+Object.defineProperty(exports, "resolveBaseModule", { enumerable: true, get: function () { return module_access_1.resolveBaseModule; } });
 var settings_1 = require("./settings");
 Object.defineProperty(exports, "getPluginSettings", { enumerable: true, get: function () { return settings_1.getPluginSettings; } });
 var shop_master_data_1 = require("./shop-master-data");
+Object.defineProperty(exports, "getShopAppearance", { enumerable: true, get: function () { return shop_master_data_1.getShopAppearance; } });
 Object.defineProperty(exports, "getShopMasterData", { enumerable: true, get: function () { return shop_master_data_1.getShopMasterData; } });
 Object.defineProperty(exports, "shopMasterDataDescriptor", { enumerable: true, get: function () { return shop_master_data_1.shopMasterDataDescriptor; } });
 var action_progress_1 = require("./action-progress");