@hartl-services/medusa-base 0.4.0 → 1.0.0

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

@@ -0,0 +1,7 @@
+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;

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];

package/dist/email/types/email-kinds.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailKindSchema = exports.EMAIL_KINDS = void 0;
+const zod_1 = require("@medusajs/framework/zod");
+exports.EMAIL_KINDS = [
+    "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",
+];
+exports.EmailKindSchema = zod_1.z.enum(exports.EMAIL_KINDS);

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

@@ -0,0 +1,4 @@
+export * from "./email-kinds";
+export * from "./shop-configuration";
+export * from "./smtp-configuration";
+export * from "./template-data";

package/dist/email/types/index.js

@@ -0,0 +1,20 @@
+"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("./email-kinds"), exports);
+__exportStar(require("./shop-configuration"), exports);
+__exportStar(require("./smtp-configuration"), exports);
+__exportStar(require("./template-data"), exports);

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

@@ -0,0 +1,43 @@
+import type { EmailKind } from "./email-kinds";
+import type { EmailRenderDataMap } from "./template-data";
+export type EmailTemplateContent = Readonly<{
+    bodyHtml: string;
+    subject: string;
+    text: string;
+}>;
+export type EmailLayout = (input: Readonly<{
+    bodyHtml: string;
+    preheader: string;
+    subject: string;
+}>) => string;
+export type EmailRendererMap = {
+    readonly [Kind in EmailKind]: (data: EmailRenderDataMap[Kind]) => EmailTemplateContent;
+};
+/**
+ * What a shop configures. `layout` and `renderers` are optional overrides of
+ * the plugin's neutral German defaults (branded with `displayName`); a
+ * partial `renderers` map replaces only the listed kinds.
+ */
+export type ShopEmailConfiguration = Readonly<{
+    affiliatePortalUrl: string;
+    displayName: string;
+    inviteUrl: (input: Readonly<{
+        token: string;
+    }>) => string;
+    layout?: EmailLayout;
+    orderNotificationEmail: string;
+    passwordResetUrl: (input: Readonly<{
+        locale: string | null;
+    }>) => string;
+    renderers?: Partial<EmailRendererMap>;
+}>;
+/** A `ShopEmailConfiguration` with the defaults merged in; used internally. */
+export type ResolvedShopEmailConfiguration = Readonly<Omit<ShopEmailConfiguration, "layout" | "renderers"> & {
+    layout: EmailLayout;
+    renderers: EmailRendererMap;
+}>;
+/** The `email` namespace of the base plugin options. */
+export type EmailPluginOptions = Readonly<{
+    jwtSecret: string;
+    shop: ShopEmailConfiguration;
+}>;

package/dist/email/types/shop-configuration.js

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

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

@@ -0,0 +1,9 @@
+export type ResolvedSmtpConfiguration = Readonly<{
+    from: string;
+    host: string;
+    password: string;
+    port: number;
+    requireTls: boolean;
+    secure: boolean;
+    user: string;
+}>;

package/dist/email/types/smtp-configuration.js

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

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

@@ -0,0 +1,100 @@
+import { z } from "@medusajs/framework/zod";
+import type { EmailKind } from "./email-kinds";
+export declare const EmailPersistedDataSchemas: {
+    readonly "order.received": z.ZodObject<{
+        order_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.received.admin": z.ZodObject<{
+        order_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.shipped": z.ZodObject<{
+        order_id: z.ZodString;
+        fulfillment_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "order.canceled": z.ZodObject<{
+        order_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "order.return_requested": z.ZodObject<{
+        order_id: z.ZodString;
+        return_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.return_received": z.ZodObject<{
+        order_id: z.ZodString;
+        return_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.refunded": z.ZodObject<{
+        order_id: z.ZodString;
+        refund_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "auth.password_reset": z.ZodObject<{
+        locale: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "affiliate.consignment_report_due": z.ZodObject<{
+        affiliate_display_name: z.ZodString;
+        period_start: z.ZodString;
+        due_date: z.ZodString;
+        locale: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "user.invite": z.ZodObject<{}, z.core.$strict>;
+};
+export declare const EmailRenderDataSchemas: {
+    readonly "auth.password_reset": z.ZodObject<{
+        locale: z.ZodNullable<z.ZodString>;
+        reset_url: z.ZodString;
+    }, z.core.$strict>;
+    readonly "user.invite": z.ZodObject<{
+        invite_url: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.received": z.ZodObject<{
+        order_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.received.admin": z.ZodObject<{
+        order_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.shipped": z.ZodObject<{
+        order_id: z.ZodString;
+        fulfillment_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "order.canceled": z.ZodObject<{
+        order_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "order.return_requested": z.ZodObject<{
+        order_id: z.ZodString;
+        return_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.return_received": z.ZodObject<{
+        order_id: z.ZodString;
+        return_id: z.ZodString;
+    }, z.core.$strict>;
+    readonly "order.refunded": z.ZodObject<{
+        order_id: z.ZodString;
+        refund_id: z.ZodString;
+        documents_fact_fingerprint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly "affiliate.consignment_report_due": z.ZodObject<{
+        affiliate_display_name: z.ZodString;
+        period_start: z.ZodString;
+        due_date: z.ZodString;
+        locale: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+};
+export type EmailPersistedDataMap = {
+    readonly [Kind in EmailKind]: Readonly<z.infer<(typeof EmailPersistedDataSchemas)[Kind]>>;
+};
+type EmptyRenderContext = Readonly<Record<never, never>>;
+export type EmailEphemeralRenderContextMap = {
+    readonly [Kind in EmailKind]: Kind extends "auth.password_reset" ? Readonly<{
+        reset_url: string;
+    }> : Kind extends "user.invite" ? Readonly<{
+        invite_url: string;
+    }> : EmptyRenderContext;
+};
+export type EmailRenderDataMap = {
+    readonly [Kind in EmailKind]: Readonly<z.infer<(typeof EmailRenderDataSchemas)[Kind]> & EmailEphemeralRenderContextMap[Kind]>;
+};
+export {};

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

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailRenderDataSchemas = exports.EmailPersistedDataSchemas = void 0;
+const zod_1 = require("@medusajs/framework/zod");
+const affiliate_1 = require("@hartl-services/medusa-food-supplements-contracts/schemas/affiliate");
+const NonEmptyStringSchema = zod_1.z.string().trim().min(1);
+const NullableLocaleSchema = NonEmptyStringSchema.max(35).nullable();
+const DocumentsFactFingerprintSchema = zod_1.z
+    .string()
+    .regex(/^[a-f0-9]{64}$/)
+    .optional();
+exports.EmailPersistedDataSchemas = {
+    "order.received": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+    })
+        .strict(),
+    "order.received.admin": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+    })
+        .strict(),
+    "order.shipped": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+        fulfillment_id: NonEmptyStringSchema,
+        documents_fact_fingerprint: DocumentsFactFingerprintSchema,
+    })
+        .strict(),
+    "order.canceled": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+        documents_fact_fingerprint: DocumentsFactFingerprintSchema,
+    })
+        .strict(),
+    "order.return_requested": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+        return_id: NonEmptyStringSchema,
+    })
+        .strict(),
+    "order.return_received": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+        return_id: NonEmptyStringSchema,
+    })
+        .strict(),
+    "order.refunded": zod_1.z
+        .object({
+        order_id: NonEmptyStringSchema,
+        refund_id: NonEmptyStringSchema,
+        documents_fact_fingerprint: DocumentsFactFingerprintSchema,
+    })
+        .strict(),
+    "auth.password_reset": zod_1.z
+        .object({
+        locale: NullableLocaleSchema,
+    })
+        .strict(),
+    "affiliate.consignment_report_due": zod_1.z
+        .object({
+        affiliate_display_name: NonEmptyStringSchema,
+        period_start: affiliate_1.CalendarMonthSchema,
+        due_date: affiliate_1.CalendarDateSchema,
+        locale: NullableLocaleSchema,
+    })
+        .strict(),
+    "user.invite": zod_1.z.object({}).strict(),
+};
+exports.EmailRenderDataSchemas = {
+    ...exports.EmailPersistedDataSchemas,
+    "auth.password_reset": exports.EmailPersistedDataSchemas["auth.password_reset"].extend({
+        reset_url: zod_1.z.string().url(),
+    }),
+    "user.invite": exports.EmailPersistedDataSchemas["user.invite"].extend({
+        invite_url: zod_1.z.string().url(),
+    }),
+};

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

@@ -0,0 +1,32 @@
+import { type FileGatewayOptions, type FileModuleConfiguration, type S3CacheFileModuleConfigOptions, type S3CacheOptions, type S3CacheOptionsCache, type S3CacheStorageConfiguration, type ValidatedS3CacheProviderOptions } from "../types";
+export declare const validateS3CacheProviderOptions: (input: {
+    cache?: S3CacheOptionsCache;
+    gateway?: FileGatewayOptions;
+    s3?: S3CacheOptions;
+}) => ValidatedS3CacheProviderOptions;
+export declare const createS3CacheFileModuleConfig: (options?: S3CacheFileModuleConfigOptions) => FileModuleConfiguration;
+/**
+ * Validates the options once and returns both parts S3 Cache Storage needs:
+ * the File Module with the S3 provider (under `modules`) and the `gateway`
+ * part of the base plugin's `files` option that serves its `/files` routes.
+ * Both carry the same signing secret, so every URL the provider signs is one
+ * the routes accept.
+ */
+export declare const createS3CacheStorageConfig: (options: Omit<S3CacheFileModuleConfigOptions, "enabled" | "local">) => S3CacheStorageConfiguration;
+/**
+ * `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 S3_BUILD_PLACEHOLDERS: Readonly<Record<string, string>>;
+/**
+ * Static S3 credentials are optional (the AWS credential chain applies
+ * otherwise) but must be complete when present. They are never read during
+ * a build.
+ */
+export declare const resolveS3Credentials: (environment: NodeJS.ProcessEnv, phase: "build" | "runtime") => {
+    readonly accessKeyId: string;
+    readonly secretAccessKey: string;
+    readonly sessionToken?: string;
+} | undefined;
+export declare const resolveExpirationStrategy: (environment: NodeJS.ProcessEnv, defaultValue: "absolute" | "sliding") => "absolute" | "sliding";