@dev.smartpricing/message-composer-utils 3.1.2

package/src/utils/templates/brand-cascade.ts

@@ -0,0 +1,156 @@
+import type {
+  EmailMessage,
+  EmailGlobalSettings,
+  EmailBlock,
+  BrandDefaultEmailSettings,
+  BrandDefaultButtonSettings,
+  BrandSocials,
+  SocialPlatform,
+} from "../../types/index.js";
+import { DEFAULT_EMAIL_GLOBAL_SETTINGS } from "../../types/index.js";
+
+/**
+ * Brand data needed for cascade resolution.
+ * This is the subset of BrandFromDb used at compile time.
+ */
+export interface BrandCascadeData {
+  default_email_settings: BrandDefaultEmailSettings;
+  default_button_settings: BrandDefaultButtonSettings;
+  default_socials: BrandSocials | null;
+  logo_url: string | null;
+}
+
+/**
+ * Resolves EmailGlobalSettings by cascading:
+ * generalSettings → brand → hardcoded defaults
+ */
+export function resolveEmailSettings(
+  settings: EmailGlobalSettings,
+  brand: BrandCascadeData | null,
+): Required<EmailGlobalSettings> {
+  const brandSettings = brand?.default_email_settings ?? {};
+  const brandButtons = brand?.default_button_settings ?? {};
+
+  return {
+    backgroundColor:
+      settings.backgroundColor ??
+      brandSettings.backgroundColor ??
+      DEFAULT_EMAIL_GLOBAL_SETTINGS.backgroundColor,
+    contentBackgroundColor:
+      settings.contentBackgroundColor ??
+      brandSettings.contentBackgroundColor ??
+      DEFAULT_EMAIL_GLOBAL_SETTINGS.contentBackgroundColor,
+    contentWidth:
+      settings.contentWidth ?? DEFAULT_EMAIL_GLOBAL_SETTINGS.contentWidth,
+    fontFamily:
+      settings.fontFamily ??
+      (brandSettings.fontFamily as typeof DEFAULT_EMAIL_GLOBAL_SETTINGS.fontFamily) ??
+      DEFAULT_EMAIL_GLOBAL_SETTINGS.fontFamily,
+    textColor:
+      settings.textColor ??
+      brandSettings.textColor ??
+      DEFAULT_EMAIL_GLOBAL_SETTINGS.textColor,
+    verticalSpacing:
+      settings.verticalSpacing ?? DEFAULT_EMAIL_GLOBAL_SETTINGS.verticalSpacing,
+    horizontalSpacing:
+      settings.horizontalSpacing ??
+      DEFAULT_EMAIL_GLOBAL_SETTINGS.horizontalSpacing,
+    button: {
+      backgroundColor: brandButtons.backgroundColor ?? "#000000",
+      textColor: brandButtons.textColor ?? "#FFFFFF",
+    },
+  };
+}
+
+/**
+ * Resolves blocks with brand cascade data.
+ * - Header: fills empty src with brand logo
+ * - Socials: fills missing URLs from brand socials
+ * - Buttons: fills undefined colors from brand button defaults
+ */
+function resolveBlocks(
+  blocks: EmailBlock[],
+  brand: BrandCascadeData | null,
+): EmailBlock[] {
+  if (!brand) return blocks;
+
+  return blocks.map((block) => {
+    switch (block.type) {
+      case "header": {
+        if (!block.settings.src && brand.logo_url) {
+          return {
+            ...block,
+            settings: { ...block.settings, src: brand.logo_url },
+          };
+        }
+        return block;
+      }
+      case "socials": {
+        if (!brand.default_socials) return block;
+        const resolvedSocials = { ...block.settings.socials };
+        for (const platform of Object.keys(
+          resolvedSocials,
+        ) as SocialPlatform[]) {
+          const blockSocial = resolvedSocials[platform];
+          if (!blockSocial?.enabled) continue;
+          // Enabled + no block URL → cascade from brand
+          if (!blockSocial.url) {
+            const brandUrl = brand.default_socials[platform];
+            if (brandUrl) {
+              resolvedSocials[platform] = { ...blockSocial, url: brandUrl };
+            }
+          }
+        }
+        return {
+          ...block,
+          settings: { ...block.settings, socials: resolvedSocials },
+        };
+      }
+      case "button": {
+        const brandButton = brand.default_button_settings;
+        return {
+          ...block,
+          settings: {
+            ...block.settings,
+            textColor: block.settings.textColor ?? brandButton.textColor,
+            backgroundColor:
+              block.settings.backgroundColor ?? brandButton.backgroundColor,
+          },
+        };
+      }
+      case "grid": {
+        // Recurse into grid column blocks
+        return {
+          ...block,
+          settings: {
+            ...block.settings,
+            columnData: block.settings.columnData.map((col) => ({
+              ...col,
+              blocks: resolveBlocks(col.blocks, brand) as typeof col.blocks,
+            })),
+          },
+        };
+      }
+      default:
+        return block;
+    }
+  });
+}
+
+/**
+ * Resolves the full email message body with brand cascade.
+ * Returns a new body where all undefined settings and block values
+ * are filled from the brand, then from hardcoded defaults.
+ *
+ * The returned body can be passed directly to translateEmailToMjml.
+ */
+export function resolveEmailBodyWithBrand(
+  body: EmailMessage["body"],
+  brand: BrandCascadeData | null,
+): EmailMessage["body"] {
+  return {
+    subject: body.subject,
+    blocks: resolveBlocks(body.blocks, brand),
+    settings: resolveEmailSettings(body.settings, brand),
+  };
+}

package/src/utils/templates/email-compiler.ts

@@ -0,0 +1,155 @@
+import type {
+  EmailMessage,
+  EmailBlock,
+  GridAllowedBlock,
+  PostEntity,
+} from "../../types/index.js";
+import type { JSONContent } from "@tiptap/core";
+
+/**
+ * Extract parameters from TipTap JSONContent
+ */
+function extractParamsFromContent(content: JSONContent | undefined): string[] {
+  if (!content) return [];
+
+  const results: string[] = [];
+
+  // Extract from text nodes
+  if (content.type === "text" && content.text) {
+    const matches = content.text.matchAll(/\{\{([^}]+)\}\}/g);
+    for (const match of matches) {
+      results.push(match[1]);
+    }
+  }
+
+  // Extract from mentions
+  if (content.type === "mention" && content.attrs?.label) {
+    results.push(content.attrs.label);
+  }
+
+  // Recurse through content
+  if (content.content && Array.isArray(content.content)) {
+    for (const child of content.content) {
+      results.push(...extractParamsFromContent(child));
+    }
+  }
+
+  return results;
+}
+
+/**
+ * Extract parameters from email blocks recursively
+ */
+function extractParamsFromBlocks(
+  blocks: (EmailBlock | GridAllowedBlock)[],
+): string[] {
+  const results: string[] = [];
+
+  for (const block of blocks) {
+    switch (block.type) {
+      case "heading":
+      case "paragraph":
+      case "discount":
+      case "footer":
+      case "unsubscribe_link":
+        results.push(...extractParamsFromContent(block.settings.content));
+        break;
+      case "socials":
+        for (const social of Object.values(block.settings.socials)) {
+          if (social.enabled && social.url) {
+            const matches = social.url.matchAll(/\{\{([^}]+)\}\}/g);
+            for (const match of matches) {
+              results.push(match[1]);
+            }
+          }
+        }
+        break;
+      case "button":
+        results.push(...extractParamsFromContent(block.settings.content));
+        // Extract from URL
+        if (block.settings.url) {
+          const matches = block.settings.url.matchAll(/\{\{([^}]+)\}\}/g);
+          for (const match of matches) {
+            results.push(match[1]);
+          }
+        }
+        break;
+
+      case "grid":
+        // Recurse into grid columns
+        for (const col of block.settings.columnData) {
+          results.push(...extractParamsFromBlocks(col.blocks));
+        }
+        break;
+      case "image":
+        // Extract from image href
+        if (block.settings.href) {
+          const matches = block.settings.href.matchAll(/\{\{([^}]+)\}\}/g);
+          for (const match of matches) {
+            results.push(match[1]);
+          }
+        }
+        break;
+      case "top_products":
+        if (block.settings.storeId) {
+          const matches = block.settings.storeId.matchAll(/\{\{([^}]+)\}\}/g);
+          for (const match of matches) {
+            results.push(match[1]);
+          }
+        }
+        break;
+      // Other blocks don't have parameters
+      default:
+        break;
+    }
+  }
+
+  return results;
+}
+
+/**
+ * Extract required parameters from email template
+ */
+export function extractEmailParameters(
+  message: EmailMessage | PostEntity<EmailMessage>,
+): string[] {
+  const paramRegex = /\{\{([^}]+)\}\}/g;
+  const results: string[] = [];
+
+  // Extract from subject
+  if (message.body.subject) {
+    for (const match of message.body.subject.matchAll(paramRegex)) {
+      results.push(match[1]);
+    }
+  }
+
+  // Extract from preheader
+  if (message.metadata.preheader) {
+    for (const match of message.metadata.preheader.matchAll(paramRegex)) {
+      results.push(match[1]);
+    }
+  }
+
+  // Extract from blocks recursively
+  results.push(...extractParamsFromBlocks(message.body.blocks));
+
+  // Dedupe using Set
+  return [...new Set(results)];
+}
+
+/**
+ * Validate email parameters
+ */
+export function validateEmailParameters(
+  message: EmailMessage,
+  parameters: Record<string, unknown>,
+): { valid: boolean; missing: string[] } {
+  const required = extractEmailParameters(message);
+  const provided = Object.keys(parameters);
+  const missing = required.filter((p) => !provided.includes(p));
+
+  return {
+    valid: missing.length === 0,
+    missing,
+  };
+}