payload-plugin-newsletter 0.20.6 → 0.20.7

package/CHANGELOG.md

@@ -1,3 +1,47 @@
+## [0.20.7] - 2025-08-02
+
+### Added
+- **Comprehensive Email Wrapper System** - Unified email rendering that uses the same wrapper for previews and actual sends
+  - Preview component now passes ALL form fields to the preview endpoint as `documentData`
+  - Custom wrappers receive complete document data, not just content
+  - Consistent HTML output between preview and actual email sends
+  - Support for accessing any custom fields added to broadcasts collection
+  - Wrapper is applied during actual send operations, not just previews
+
+### Enhanced
+- **Email Preview Component** - Builds document data from all form fields for wrapper access
+  - Collects all field values using `useFormFields` hook
+  - Passes complete form state to preview endpoint
+  - Enables custom wrappers to access metadata like slug, issueNumber, custom fields
+
+- **Preview Endpoint** - Updated to accept and forward documentData to email wrapper
+  - Receives documentData from preview component
+  - Passes through to convertToEmailSafeHtml function
+  - Maintains backward compatibility with existing implementations
+
+- **Email Wrapper Interface** - Enhanced type definitions for better developer experience
+  - Added `EmailWrapperOptions` interface with documentData support
+  - Updated `CustomEmailWrapper` type for consistency
+  - Generic `Record<string, any>` allows any custom fields
+
+- **Broadcast Sync Hooks** - Now apply wrapper during actual email sends
+  - Create operation uses wrapper when syncing to provider
+  - Update operation maintains wrapper consistency
+  - Deferred creates (from draft to published) include wrapper
+  - Same HTML template used for both preview and actual sends
+
+### Technical Changes
+- Updated `convertToEmailSafeHtml` to accept documentData in options
+- Modified all sync operations in Broadcasts collection to use email preview config
+- Wrapper customization now available throughout the email lifecycle
+- No breaking changes - wrapper remains optional with sensible defaults
+
+### Benefits
+- **Flexibility** - Users can pass any custom fields without plugin modifications
+- **Consistency** - Identical HTML in preview and actual email sends
+- **Future Proof** - Add new fields to broadcasts without updating plugin code
+- **No Breaking Changes** - Existing implementations continue to work unchanged
+
 ## [0.20.6] - 2025-08-01
 
 ### Fixed

package/dist/admin.js

@@ -22,10 +22,20 @@ var BroadcastInlinePreview = () => {
         setLoading(false);
         return;
       }
+      const documentData = {};
+      Object.entries(fields || {}).forEach(([key, field]) => {
+        if (field && typeof field === "object" && "value" in field) {
+          documentData[key] = field.value;
+        }
+      });
       const response = await fetch("/api/broadcasts/preview", {
         method: "POST",
         headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({ content: contentValue })
+        body: JSON.stringify({
+          content: contentValue,
+          documentData
+          // Pass all form data
+        })
       });
       if (!response.ok) {
         throw new Error(`Preview failed: ${response.statusText}`);

package/dist/collections.cjs

@@ -979,7 +979,8 @@ async function convertToEmailSafeHtml(editorState, options) {
     if (options.customWrapper) {
       return await Promise.resolve(options.customWrapper(sanitizedHtml, {
         preheader: options.preheader,
-        subject: options.subject
+        subject: options.subject,
+        documentData: options.documentData
       }));
     }
     return wrapInEmailTemplate(sanitizedHtml, options.preheader);
@@ -1866,7 +1867,7 @@ var createBroadcastPreviewEndpoint = (config, _collectionSlug) => {
     handler: async (req) => {
       try {
         const data = await (req.json?.() || Promise.resolve({}));
-        const { content, preheader, subject } = data;
+        const { content, preheader, subject, documentData } = data;
         if (!content) {
           return Response.json({
             success: false,
@@ -1882,6 +1883,8 @@ var createBroadcastPreviewEndpoint = (config, _collectionSlug) => {
           preheader,
           subject,
           mediaUrl,
+          documentData,
+          // Pass all document data
           customBlockConverter: config.customizations?.broadcasts?.customBlockConverter,
           customWrapper: emailPreviewConfig?.customWrapper
         });
@@ -2181,7 +2184,14 @@ var createBroadcastsCollection = (pluginConfig) => {
               const provider = new BroadcastApiProvider2(providerConfig);
               req.payload.logger.info("Populating media fields and converting content to HTML...");
               const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+              const emailPreviewConfig = pluginConfig.customizations?.broadcasts?.emailPreview;
               const htmlContent = await convertToEmailSafeHtml(populatedContent, {
+                wrapInTemplate: emailPreviewConfig?.wrapInTemplate ?? true,
+                customWrapper: emailPreviewConfig?.customWrapper,
+                preheader: doc.contentSection?.preheader,
+                subject: doc.subject,
+                documentData: doc,
+                // Pass entire document
                 customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
               });
               if (!htmlContent || htmlContent.trim() === "") {
@@ -2281,7 +2291,14 @@ var createBroadcastsCollection = (pluginConfig) => {
                 }
                 req.payload.logger.info("Creating broadcast in provider (deferred from initial create)...");
                 const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+                const emailPreviewConfig = pluginConfig.customizations?.broadcasts?.emailPreview;
                 const htmlContent = await convertToEmailSafeHtml(populatedContent, {
+                  wrapInTemplate: emailPreviewConfig?.wrapInTemplate ?? true,
+                  customWrapper: emailPreviewConfig?.customWrapper,
+                  preheader: doc.contentSection?.preheader,
+                  subject: doc.subject,
+                  documentData: doc,
+                  // Pass entire document
                   customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
                 });
                 if (!htmlContent || htmlContent.trim() === "") {
@@ -2343,7 +2360,14 @@ var createBroadcastsCollection = (pluginConfig) => {
                   }
                   if (JSON.stringify(doc.contentSection?.content) !== JSON.stringify(previousDoc?.contentSection?.content)) {
                     const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+                    const emailPreviewConfig = pluginConfig.customizations?.broadcasts?.emailPreview;
                     updates.content = await convertToEmailSafeHtml(populatedContent, {
+                      wrapInTemplate: emailPreviewConfig?.wrapInTemplate ?? true,
+                      customWrapper: emailPreviewConfig?.customWrapper,
+                      preheader: doc.contentSection?.preheader,
+                      subject: doc.subject,
+                      documentData: doc,
+                      // Pass entire document
                       customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
                     });
                   }