@hartl-services/medusa-base 0.4.0 → 1.1.0

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,68 @@
+import type { ShopMasterData } from "../../public";
+import type { EmailKind } from "./email-kinds";
+import type { EmailRenderDataMap } from "./template-data";
+export type EmailTemplateContent = Readonly<{
+    bodyHtml: string;
+    subject: string;
+    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.
+ */
+export type EmailShopDetails = Readonly<ShopMasterData & {
+    logo?: string;
+}>;
+/** Who reads a mail: a customer or the shop's own team. */
+export type EmailAudience = "customer" | "shop";
+export type EmailLayout = (input: Readonly<{
+    audience: EmailAudience;
+    bodyHtml: string;
+    preheader: string;
+    subject: string;
+    shop: EmailShopDetails;
+}>) => 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<{
+    /**
+     * Link to an order in the Medusa Admin; the shop's order notification shows
+     * an "Im Admin öffnen" button only when it is set.
+     */
+    adminOrderUrl?: (input: Readonly<{
+        orderId: string;
+    }>) => string;
+    affiliatePortalUrl: string;
+    displayName: string;
+    inviteUrl: (input: Readonly<{
+        token: string;
+    }>) => string;
+    layout?: EmailLayout;
+    orderNotificationEmail: string;
+    passwordResetUrl: (input: Readonly<{
+        locale: string | null;
+    }>) => string;
+    renderers?: Partial<EmailRendererMap>;
+    /**
+     * IANA time zone of dates in the default templates (e.g. the order time in
+     * the shop's order notification); without it they are left out.
+     */
+    timeZone?: string;
+}>;
+/** 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 });