@nuxt-customer-portal/core 0.6.1 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @nuxt-customer-portal/core
 
+## 0.8.0
+
+### Minor Changes
+
+- 175854d: Support validated conditional sections in email texts and HTML templates, preserve conditional tags in the visual editor, and let administrators preview purchase emails with or without downloads.
+
+### Patch Changes
+
+- 28bb7af: Add public purchase file permalinks, confirmation email download links, external thank-you page delivery integration, and database records for public and portal download requests.
+
+## 0.7.0
+
 ## 0.6.1
 
 ## 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt-customer-portal/core",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "license": "MIT",
   "homepage": "https://nuxt-customer-portal.com",
   "repository": {

package/portal.manifest.mjs

@@ -1,6 +1,6 @@
 export default {
   id: 'core',
-  version: '0.6.1',
+  version: '0.8.0',
   source: '@nuxt-customer-portal/core',
   dependsOn: [],
   schema: './server/db/schema/index.ts',

package/server/utils/portal-email.ts

@@ -1,3 +1,4 @@
+import { renderEmailTemplate, validateEmailTemplateSyntax } from '../../shared/email-template'
 import { isPortalDemo, rejectDemoAction } from './demo'
 import { createHash } from 'node:crypto'
 import { eq } from 'drizzle-orm'
@@ -173,34 +174,25 @@ export const decryptPortalEmailSecret = (value: string) => {
   }
 }
 
-const replacePlaceholders = (input: string, values: Record<string, string>, allowed: Set<string>) =>
-  input.replace(placeholderPattern, (_match, key: string) => {
-    if (!allowed.has(key)) {
-      throw new Error(`Unknown email placeholder: ${key}`)
-    }
-    if (!(key in values)) {
-      throw new Error(`Missing email placeholder value: ${key}`)
-    }
-    return values[key]!
-  })
-
 export const validatePortalEmailTemplate = (template: string) => {
   const found = [...template.matchAll(placeholderPattern)].map((match) => match[1]!)
   if (!found.includes('body')) {
     throw createError({ statusCode: 422, message: 'The email template must contain {{body}}' })
   }
-  const unknown = found.find((key) => !TEMPLATE_PLACEHOLDERS.has(key))
-  if (unknown) {
-    throw createError({ statusCode: 422, message: `Unknown template placeholder: ${unknown}` })
+  try {
+    validateEmailTemplateSyntax(template, TEMPLATE_PLACEHOLDERS, 'template')
+  } catch (error) {
+    throw createError({ statusCode: 422, message: error instanceof Error ? error.message : 'Invalid email template' })
   }
 }
 
 export const validatePortalEmailText = (definition: PortalEmailDefinition, text: PortalEmailText) => {
   const allowed = new Set([...definition.placeholders.map((item) => item.key), 'brand_name'])
   for (const value of [text.subject, text.body, text.footer ?? '']) {
-    const unknown = [...value.matchAll(placeholderPattern)].map((match) => match[1]!).find((key) => !allowed.has(key))
-    if (unknown) {
-      throw createError({ statusCode: 422, message: `Unknown ${definition.id} placeholder: ${unknown}` })
+    try {
+      validateEmailTemplateSyntax(value, allowed, definition.id)
+    } catch (error) {
+      throw createError({ statusCode: 422, message: error instanceof Error ? error.message : 'Invalid email text' })
     }
   }
 }
@@ -336,9 +328,9 @@ export const renderPortalEmail = async (input: {
   const brandName = branding.brandName
   const messageValues = { ...input.values, brand_name: brandName }
   const allowed = new Set([...input.definition.placeholders.map((item) => item.key), 'brand_name'])
-  const subject = replacePlaceholders(text.subject, messageValues, allowed)
-  const bodySource = replacePlaceholders(text.body, messageValues, allowed)
-  const footerSource = replacePlaceholders(text.footer ?? '', messageValues, allowed)
+  const subject = renderEmailTemplate(text.subject, messageValues, allowed)
+  const bodySource = renderEmailTemplate(text.body, messageValues, allowed)
+  const footerSource = renderEmailTemplate(text.footer ?? '', messageValues, allowed)
   const body = renderPortalEmailMarkdown(bodySource)
   const footer = renderPortalEmailMarkdown(footerSource)
   const htmlTemplate = input.htmlTemplate ?? settings.htmlTemplate
@@ -348,7 +340,7 @@ export const renderPortalEmail = async (input: {
     input.inlineBrandAssets && htmlTemplate.includes(`{{${key}}}`)
       ? inlineBrandAsset(value, brandName, `portal-${key.replaceAll('_', '-')}`, inlineAttachments)
       : renderBrandAsset(value, brandName)
-  const html = replacePlaceholders(
+  const html = renderEmailTemplate(
     htmlTemplate,
     {
       subject: escapeHtml(subject),

package/server/utils/public-api-route.ts

@@ -1,7 +1,8 @@
 export function isPublicStoreRoute(method: string, pathname: string) {
   return (
     (method === 'GET' &&
-      (/^\/api\/store\/v1\/products(?:\/[^/]+)?$/.test(pathname) ||
+      (/^\/api\/store\/purchases\/[^/]+(?:\/files\/[^/]+)?$/.test(pathname) ||
+        /^\/api\/store\/v1\/products(?:\/[^/]+)?$/.test(pathname) ||
         /^\/api\/store\/(product|media)\/[^/]+$/.test(pathname) ||
         /^\/api\/store\/planning\/[^/]+\/availability$/.test(pathname) ||
         pathname === '/api/store/planning/hold' ||

package/shared/email-template.ts

@@ -0,0 +1,90 @@
+type EmailNode =
+  | { type: 'text'; value: string }
+  | { type: 'value'; key: string }
+  | { type: 'if'; key: string; yes: EmailNode[]; no: EmailNode[] }
+
+function parseEmailTemplate(source: string, allowed: Set<string>, label = 'email'): EmailNode[] {
+  const root: EmailNode[] = []
+  const stack: Array<{ node: Extract<EmailNode, { type: 'if' }>; parent: EmailNode[]; otherwise: boolean }> = []
+  let current = root
+  let offset = 0
+  const text = (value: string) => {
+    if (/{{\s*(?:#if\b|\/if\b|else\b)/.test(value)) {
+      throw new Error('Incomplete email conditional tag')
+    }
+    if (value) {
+      current.push({ type: 'text', value })
+    }
+  }
+  const checkKey = (key: string) => {
+    if (!allowed.has(key)) {
+      throw new Error(`Unknown ${label} placeholder: ${key}`)
+    }
+  }
+  for (const match of source.matchAll(/{{([\s\S]*?)}}/g)) {
+    text(source.slice(offset, match.index))
+    offset = match.index + match[0].length
+    const token = match[1]!.trim()
+    const condition = token.match(/^#if\s+([a-z0-9_]+)$/i)
+    if (condition) {
+      checkKey(condition[1]!)
+      if (stack.length >= 20) {
+        throw new Error('Email conditionals may nest at most 20 levels')
+      }
+      const node: Extract<EmailNode, { type: 'if' }> = { type: 'if', key: condition[1]!, yes: [], no: [] }
+      current.push(node)
+      stack.push({ node, parent: current, otherwise: false })
+      current = node.yes
+    } else if (token === 'else') {
+      const frame = stack.at(-1)
+      if (!frame || frame.otherwise) {
+        throw new Error('Unexpected {{else}} in email template')
+      }
+      frame.otherwise = true
+      current = frame.node.no
+    } else if (token === '/if') {
+      const frame = stack.pop()
+      if (!frame) {
+        throw new Error('Unexpected {{/if}} in email template')
+      }
+      current = frame.parent
+    } else if (/^[a-z0-9_]+$/i.test(token)) {
+      checkKey(token)
+      current.push({ type: 'value', key: token })
+    } else {
+      throw new Error(`Unsupported email template tag: {{${token}}}`)
+    }
+  }
+  text(source.slice(offset))
+  if (stack.length) {
+    throw new Error('Missing {{/if}} in email template')
+  }
+  return root
+}
+
+export function validateEmailTemplateSyntax(source: string, allowed: Set<string>, label = 'email') {
+  parseEmailTemplate(source, allowed, label)
+}
+
+export function renderEmailTemplate(source: string, values: Record<string, string>, allowed: Set<string>) {
+  const nodes = parseEmailTemplate(source, allowed)
+  const value = (key: string) => {
+    if (!Object.hasOwn(values, key)) {
+      throw new Error(`Missing email placeholder value: ${key}`)
+    }
+    return values[key]!
+  }
+  const render = (items: EmailNode[]): string =>
+    items
+      .map((node) => {
+        if (node.type === 'text') {
+          return node.value
+        }
+        if (node.type === 'value') {
+          return value(node.key)
+        }
+        return render(value(node.key).trim() ? node.yes : node.no)
+      })
+      .join('')
+  return render(nodes)
+}