@hartl-services/medusa-base 1.1.0 → 2.1.0

package/dist/email/types/template-data.d.ts

@@ -363,6 +363,9 @@ export declare const EmailPersistedDataSchemas: {
         locale: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     readonly "user.invite": z.ZodObject<{}, z.core.$strict>;
+    readonly "auth.verification": z.ZodObject<{
+        locale: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
 };
 export declare const EmailRenderDataSchemas: {
     readonly "auth.password_reset": z.ZodObject<{
@@ -374,6 +377,10 @@ export declare const EmailRenderDataSchemas: {
         invite_url: z.ZodString;
         expires_at: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
+    readonly "auth.verification": z.ZodObject<{
+        locale: z.ZodNullable<z.ZodString>;
+        verify_url: z.ZodString;
+    }, z.core.$strict>;
     readonly "order.received": z.ZodObject<{
         order_id: z.ZodString;
         summary: z.ZodOptional<z.ZodObject<{
@@ -601,6 +608,8 @@ export type EmailEphemeralRenderContextMap = {
     }> : Kind extends "user.invite" ? Readonly<{
         invite_url: string;
         expires_at?: string;
+    }> : Kind extends "auth.verification" ? Readonly<{
+        verify_url: string;
     }> : EmptyRenderContext;
 };
 export type EmailRenderDataMap = {

package/dist/email/types/template-data.js

@@ -215,6 +215,11 @@ exports.EmailPersistedDataSchemas = {
     })
         .strict(),
     "user.invite": zod_1.z.object({}).strict(),
+    "auth.verification": zod_1.z
+        .object({
+        locale: NullableLocaleSchema,
+    })
+        .strict(),
 };
 exports.EmailRenderDataSchemas = {
     ...exports.EmailPersistedDataSchemas,
@@ -228,4 +233,7 @@ exports.EmailRenderDataSchemas = {
         /** When the invite expires (ISO 8601), from the current invite. */
         expires_at: zod_1.z.string().datetime().optional(),
     }),
+    "auth.verification": exports.EmailPersistedDataSchemas["auth.verification"].extend({
+        verify_url: zod_1.z.string().url(),
+    }),
 };

package/dist/modules/documents/domain/options.d.ts

@@ -1,6 +1,5 @@
 import type { DocumentHtmlFactory } from "../../../documents/types/html-factory";
-import type { DocumentMerchantOption, DocumentPdfOptions } from "../../../documents/types/documents";
-import { type DocumentMerchantValues } from "./merchant";
+import type { DocumentPdfOptions } from "../../../documents/types/documents";
 /** Used when the `documents.numbering.timeZone` option is not given. */
 export declare const DEFAULT_NUMBERING_TIME_ZONE = "Europe/Vienna";
 /** The `documents` namespace of the base plugin options. */
@@ -10,11 +9,6 @@ export type DocumentPluginOptions = {
      * `createDefaultDocumentHtmlFactory` with the `numbering.timeZone`.
      */
     htmlFactory?: DocumentHtmlFactory;
-    /**
-     * Fallback for the shop master data of the base plugin: used per field
-     * only where no value is stored there.
-     */
-    merchant?: DocumentMerchantOption;
     numbering?: {
         timeZone?: string;
     };
@@ -22,8 +16,6 @@ export type DocumentPluginOptions = {
 };
 export type ResolvedDocumentPluginOptions = {
     htmlFactory: DocumentHtmlFactory;
-    /** The `merchant` option keyed by shop master data field. */
-    merchantFallback: DocumentMerchantValues;
     numbering: {
         timeZone: string;
     };

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveDocumentPluginOptions = exports.DEFAULT_NUMBERING_TIME_ZONE = void 0;
 const utils_1 = require("@medusajs/framework/utils");
 const html_factory_1 = require("../../../documents/templates/html-factory");
-const merchant_1 = require("./merchant");
 /** Used when the `documents.numbering.timeZone` option is not given. */
 exports.DEFAULT_NUMBERING_TIME_ZONE = "Europe/Vienna";
 const resolveDocumentPluginOptions = (options) => {
@@ -24,14 +23,9 @@ const resolveDocumentPluginOptions = (options) => {
         typeof options.htmlFactory !== "function") {
         throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, "The documents 'htmlFactory' option must be a function.");
     }
-    if (options?.merchant !== undefined &&
-        (typeof options.merchant !== "object" || options.merchant === null)) {
-        throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, "The documents 'merchant' option must be an object.");
-    }
     const executablePath = options?.pdf?.executablePath?.trim() || "google-chrome";
     return {
         htmlFactory: options?.htmlFactory ?? (0, html_factory_1.createDefaultDocumentHtmlFactory)({ timeZone }),
-        merchantFallback: (0, merchant_1.merchantOptionToFallback)(options?.merchant),
         numbering: { timeZone },
         pdf: { executablePath },
     };

package/dist/public/shop-master-data.d.ts

@@ -1,5 +1,4 @@
 import type { MedusaContainer } from "@medusajs/framework/types";
-import type { PluginSettingsFallback } from "./types";
 /**
  * The base's own descriptor: the shop's master data (Firmenangaben), edited
  * on the generic plugin page like any plugin's settings. It cannot be
@@ -18,8 +17,8 @@ export type ResolvedShopMasterData = {
     missing: ShopMasterDataKey[];
 };
 /**
- * The shop's master data for server-side code. Precedence per key: stored in
- * the Admin > `fallback` (e.g. a plugin's own medusa-config option). A
- * missing base plugin fails with `UNEXPECTED_STATE`; read failures propagate.
+ * The shop's master data for server-side code, exactly as stored in the
+ * Admin: there is no config fallback. A missing base plugin fails with
+ * `UNEXPECTED_STATE`; read failures propagate.
  */
-export declare function getShopMasterData(container: MedusaContainer, fallback?: PluginSettingsFallback<ShopMasterDataKey>): Promise<ResolvedShopMasterData>;
+export declare function getShopMasterData(container: MedusaContainer): Promise<ResolvedShopMasterData>;

package/dist/public/shop-master-data.js

@@ -74,12 +74,12 @@ exports.shopMasterDataDescriptor = (0, descriptor_1.definePluginFeatures)({
     ],
 });
 /**
- * The shop's master data for server-side code. Precedence per key: stored in
- * the Admin > `fallback` (e.g. a plugin's own medusa-config option). A
- * missing base plugin fails with `UNEXPECTED_STATE`; read failures propagate.
+ * The shop's master data for server-side code, exactly as stored in the
+ * Admin: there is no config fallback. A missing base plugin fails with
+ * `UNEXPECTED_STATE`; read failures propagate.
  */
-async function getShopMasterData(container, fallback) {
-    const resolved = await (0, settings_1.getPluginSettings)(container, exports.shopMasterDataDescriptor, fallback);
+async function getShopMasterData(container) {
+    const resolved = await (0, settings_1.getPluginSettings)(container, exports.shopMasterDataDescriptor);
     const values = {};
     for (const [key, value] of Object.entries(resolved.values)) {
         if (typeof value === "string") {

package/dist/shop-config/build-food-shop-config.js

@@ -5,6 +5,7 @@ exports.defineFoodShopConfig = defineFoodShopConfig;
 const logger_1 = require("@medusajs/framework/logger");
 const utils_1 = require("@medusajs/framework/utils");
 const config_1 = require("../public/config");
+const customer_verification_snapshot_1 = require("../email/customer-verification-snapshot");
 const sentry_logger_1 = require("../public/sentry-logger");
 const options_1 = require("./options");
 /**
@@ -18,7 +19,6 @@ const options_1 = require("./options");
  */
 function buildFoodShopConfig(options, environment = process.env) {
     (0, options_1.assertFoodShopConfigOptions)(options);
-    const { merchant } = options;
     if (options.loadEnvFile !== false) {
         (0, utils_1.loadEnv)(process.env.NODE_ENV || "development", process.cwd());
     }
@@ -157,14 +157,14 @@ function buildFoodShopConfig(options, environment = process.env) {
                         orderNotificationEmail: options.orderNotificationEmail,
                         // The e-mail module appends "#token=<token>".
                         passwordResetUrl: () => (0, config_1.shopUrl)(storefrontOrigin, `${storefrontPath}/reset-password`),
+                        // Account confirmation (E-Mail toggle `customer_verification`);
+                        // the e-mail module appends "#token=<token>".
+                        verifyAccountUrl: () => (0, config_1.shopUrl)(storefrontOrigin, `${storefrontPath}/verify-account`),
                         timeZone: options.timeZone,
                     },
                 },
                 documents: {
                     htmlFactory: options.documentHtmlFactory,
-                    // Fallback only: the shop master data in the Admin ("Hartl Services
-                    // Plugins" -> Shop-Stammdaten) wins per field.
-                    merchant,
                     numbering: {
                         // Chooses the annual document-number period; matches the date the
                         // HTML factory prints.
@@ -179,7 +179,7 @@ function buildFoodShopConfig(options, environment = process.env) {
         },
         {
             resolve: "@hartl-services/medusa-tax-compliance",
-            options: { merchant },
+            options: {},
         },
         {
             resolve: "@hartl-services/medusa-free-shipping",
@@ -231,6 +231,17 @@ function buildFoodShopConfig(options, environment = process.env) {
                 authCors: env.AUTH_CORS,
                 jwtSecret: env.JWT_SECRET,
                 cookieSecret: env.COOKIE_SECRET,
+                // Medusa reads this synchronously on every login and keeps the
+                // `authVerificationsPerActor` object (defineConfig and ConfigManager
+                // copy `http` shallowly), so a getter switches e-mail confirmation of
+                // customer accounts at run time. It answers from an in-memory copy of
+                // the E-Mail plugin's `customer_verification` toggle, refreshed at
+                // most every 30 s (see customer-verification-snapshot.ts).
+                authVerificationsPerActor: {
+                    get customer() {
+                        return (0, customer_verification_snapshot_1.customerVerificationActors)();
+                    },
+                },
             },
             // The storefront turns its customer JWT into a Medusa browser session
             // at login, so its browser-side cart and payment calls carry the

package/dist/shop-config/options.d.ts

@@ -1,16 +1,14 @@
-import type { DocumentHtmlFactory, DocumentMerchantOption } from "../documents/types";
+import type { DocumentHtmlFactory } from "../documents/types";
 /**
  * The shop-specific facts of a food shop. Deployment values and secrets are
  * not options: they come from the environment (see the README).
  */
 export type FoodShopConfigOptions = Readonly<{
     /**
-     * Fallback for the shop master data (Admin -> "Hartl Services Plugins" ->
-     * Shop-Stammdaten) that documents and tax compliance read per field. Its
-     * `legalName` is also the seeded store name.
+     * Shop name in the branding of the default e-mail templates (and the store
+     * name of a shop's initial seed). Company name, address and UID are not
+     * options: they come only from the Shop-Stammdaten in the Admin.
      */
-    merchant: DocumentMerchantOption;
-    /** Shop name in the branding of the default e-mail templates. */
     displayName: string;
     /** Receives the shop's order notification e-mails. */
     orderNotificationEmail: string;

package/dist/shop-config/options.js

@@ -45,20 +45,6 @@ const requireObject = (value, name) => {
  */
 function assertFoodShopConfigOptions(options) {
     const candidate = requireObject(options, "options");
-    const merchant = requireObject(candidate.merchant, "merchant");
-    requireText(merchant.legalName, "merchant.legalName");
-    requireCountryCode(merchant.countryCode, "merchant.countryCode");
-    if (merchant.vatNumber !== undefined) {
-        requireText(merchant.vatNumber, "merchant.vatNumber");
-    }
-    const address = requireObject(merchant.registeredAddress, "merchant.registeredAddress");
-    requireText(address.address1, "merchant.registeredAddress.address1");
-    if (address.address2 !== undefined) {
-        requireText(address.address2, "merchant.registeredAddress.address2");
-    }
-    requireText(address.city, "merchant.registeredAddress.city");
-    requireText(address.postalCode, "merchant.registeredAddress.postalCode");
-    requireCountryCode(address.countryCode, "merchant.registeredAddress.countryCode");
     requireText(candidate.displayName, "displayName");
     requireEmail(candidate.orderNotificationEmail, "orderNotificationEmail");
     requireTimeZone(candidate.timeZone, "timeZone");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hartl-services/medusa-base",
-  "version": "1.1.0",
+  "version": "2.1.0",
   "description": "Base plugin for Hartl Services Medusa shops: per-plugin feature toggles with a generic Admin settings page, a Store endpoint for storefronts, enforcement helpers, the complete-cart hook composition, the root redirect, cart-promotion link repair, the built-in E-Mail, Documents and S3 file storage modules, config helpers with the turnkey food-shop preset, and the Sentry logger wrapper and instrumentation.",
   "license": "MIT",
   "files": [
@@ -88,7 +88,7 @@
     "mime-types": "3.0.1",
     "nodemailer": "6.10.1",
     "ulid": "^2.4.0",
-    "@hartl-services/medusa-food-supplements-contracts": "^0.17.0"
+    "@hartl-services/medusa-food-supplements-contracts": "^0.18.0"
   },
   "devDependencies": {
     "@medusajs/admin-sdk": "2.19.0",

package/dist/modules/documents/domain/merchant.d.ts

@@ -1,22 +0,0 @@
-import type { DocumentMerchant, DocumentMerchantOption } from "../../../documents/types/documents";
-/** Shop master data keys (base plugin, `plugin_key: "shop"`) documents read. */
-export type DocumentMerchantKey = keyof DocumentMerchant;
-export type DocumentMerchantValues = Partial<Record<DocumentMerchantKey, string>>;
-/** Without these a financial document or packing list has no legal sender. */
-export declare const DOCUMENT_MERCHANT_REQUIRED_FIELDS: readonly ["legal_name", "address_line1", "postal_code", "city", "country_code"];
-/** Development placeholder UID: never printed on a document. */
-export declare const MERCHANT_VAT_PLACEHOLDER = "ATU00000000";
-/**
- * The plugin's `merchant` option as a per-field fallback for the shop master
- * data. Empty values are left out so they never shadow a declared default.
- */
-export declare const merchantOptionToFallback: (option: DocumentMerchantOption | undefined) => DocumentMerchantValues;
-export type DocumentMerchantResolution = {
-    merchant: DocumentMerchant;
-    missing: [];
-} | {
-    merchant: null;
-    missing: DocumentMerchantKey[];
-};
-/** Maps resolved shop master data to the render input's `merchant`. */
-export declare const toDocumentMerchant: (values: DocumentMerchantValues) => DocumentMerchantResolution;

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

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDocumentMerchant = exports.merchantOptionToFallback = exports.MERCHANT_VAT_PLACEHOLDER = exports.DOCUMENT_MERCHANT_REQUIRED_FIELDS = void 0;
-/** Without these a financial document or packing list has no legal sender. */
-exports.DOCUMENT_MERCHANT_REQUIRED_FIELDS = [
-    "legal_name",
-    "address_line1",
-    "postal_code",
-    "city",
-    "country_code",
-];
-/** Development placeholder UID: never printed on a document. */
-exports.MERCHANT_VAT_PLACEHOLDER = "ATU00000000";
-const text = (value) => {
-    if (typeof value !== "string") {
-        return null;
-    }
-    const trimmed = value.trim();
-    return trimmed ? trimmed : null;
-};
-const vatNumber = (value) => {
-    const normalized = text(value);
-    return normalized &&
-        normalized.replace(/\s+/g, "").toUpperCase() === exports.MERCHANT_VAT_PLACEHOLDER
-        ? null
-        : normalized;
-};
-/**
- * The plugin's `merchant` option as a per-field fallback for the shop master
- * data. Empty values are left out so they never shadow a declared default.
- */
-const merchantOptionToFallback = (option) => {
-    if (!option) {
-        return {};
-    }
-    const address = option.registeredAddress;
-    const entries = [
-        ["legal_name", option.legalName],
-        ["address_line1", address?.address1],
-        ["address_line2", address?.address2],
-        ["postal_code", address?.postalCode],
-        ["city", address?.city],
-        [
-            "country_code",
-            text(address?.countryCode ?? option.countryCode)?.toLowerCase(),
-        ],
-        ["vat_number", option.vatNumber],
-    ];
-    const fallback = {};
-    for (const [key, value] of entries) {
-        const normalized = text(value);
-        if (normalized) {
-            fallback[key] = normalized;
-        }
-    }
-    return fallback;
-};
-exports.merchantOptionToFallback = merchantOptionToFallback;
-/** Maps resolved shop master data to the render input's `merchant`. */
-const toDocumentMerchant = (values) => {
-    const missing = exports.DOCUMENT_MERCHANT_REQUIRED_FIELDS.filter((key) => !text(values[key]));
-    if (missing.length > 0) {
-        return { merchant: null, missing };
-    }
-    return {
-        merchant: {
-            legal_name: text(values.legal_name),
-            address_line1: text(values.address_line1),
-            address_line2: text(values.address_line2),
-            postal_code: text(values.postal_code),
-            city: text(values.city),
-            country_code: text(values.country_code).toLowerCase(),
-            vat_number: vatNumber(values.vat_number),
-            email: text(values.email),
-            phone: text(values.phone),
-            website: text(values.website),
-            iban: text(values.iban),
-            bic: text(values.bic),
-            company_register_number: text(values.company_register_number),
-            company_register_court: text(values.company_register_court),
-        },
-        missing: [],
-    };
-};
-exports.toDocumentMerchant = toDocumentMerchant;