payload-plugin-newsletter 0.17.3 → 0.18.0

package/CHANGELOG.md

@@ -1,3 +1,51 @@
+## [0.18.0] - 2025-07-30
+
+### Added
+- **Media Field Population in Custom Blocks** - Fixed critical issue where media fields in custom blocks weren't populated during email conversion
+  - Added automatic media field population in preview endpoint before email conversion
+  - Media fields now receive full media objects with URLs instead of just ID strings
+  - Added `populateFields` option to `BroadcastCustomizations` interface for configurable field population
+  - Added recursive population support for array fields containing upload fields
+  - Comprehensive logging for media population success and failures
+  - Both email previews and sent emails now properly populate media relationships
+
+### Enhanced
+- **Preview Endpoint** - Significantly improved custom block support
+  - Preview endpoint now populates media fields before calling custom block converters
+  - Custom blocks with images now display correctly in email previews
+  - Added detailed logging for debugging media population issues
+  
+- **Broadcast Sync Logic** - Applied media population to all broadcast operations
+  - Create operation now populates media fields before provider sync
+  - Update operation populates media fields when content changes
+  - Deferred create operation (empty → content) now handles media population
+  - Ensures consistency between previews and actual sent emails
+
+### Technical
+- **New Helper Functions**
+  - `populateMediaFields()` - Recursively finds and populates upload fields in Lexical content
+  - `populateBlockMediaFields()` - Handles individual block media field population
+  - Support for both direct upload fields and upload fields within arrays
+  - Automatic detection of upload fields based on custom block configuration
+  - MongoDB ObjectId pattern matching for field population decisions
+
+### Types
+- **Enhanced BroadcastCustomizations Interface**
+  - Added `populateFields` option with string array or function signature
+  - Comprehensive documentation with usage examples
+  - Support for block-type-specific field population logic
+
+### Breaking Changes
+- None - all changes are backward compatible and additive
+
+## [0.17.4] - 2025-07-30
+
+### Fixed
+- **Resolved Lint Errors** - Fixed CI/CD build failures caused by lint errors
+  - Removed unused imports from `endpoints/broadcasts/index.ts`
+  - Prefixed unused `collectionSlug` parameter with underscore in `preview.ts`
+  - Ensures clean build and successful npm publish
+
 ## [0.17.3] - 2025-07-30
 
 ### Fixed

package/dist/collections.cjs

@@ -1625,7 +1625,87 @@ var createTestBroadcastEndpoint = (config, collectionSlug) => {
 };
 
 // src/endpoints/broadcasts/preview.ts
-var createBroadcastPreviewEndpoint = (config, collectionSlug) => {
+async function populateMediaFields(content, payload, config) {
+  if (!content || typeof content !== "object") return content;
+  if (content.root?.children) {
+    for (const child of content.root.children) {
+      await populateBlockMediaFields(child, payload, config);
+    }
+  }
+  return content;
+}
+async function populateBlockMediaFields(node, payload, config) {
+  if (node.type === "block" && node.fields) {
+    const blockType = node.fields.blockType || node.fields.blockName;
+    const customBlocks = config.customizations?.broadcasts?.customBlocks || [];
+    const blockConfig = customBlocks.find((b) => b.slug === blockType);
+    if (blockConfig && blockConfig.fields) {
+      for (const field of blockConfig.fields) {
+        if (field.type === "upload" && field.relationTo && node.fields[field.name]) {
+          const fieldValue = node.fields[field.name];
+          if (typeof fieldValue === "string" && fieldValue.match(/^[a-f0-9]{24}$/i)) {
+            try {
+              const media = await payload.findByID({
+                collection: field.relationTo,
+                id: fieldValue,
+                depth: 0
+              });
+              if (media) {
+                node.fields[field.name] = media;
+                payload.logger?.info(`Populated ${field.name} for block ${blockType}:`, {
+                  mediaId: fieldValue,
+                  mediaUrl: media.url,
+                  filename: media.filename
+                });
+              }
+            } catch (error) {
+              payload.logger?.error(`Failed to populate ${field.name} for block ${blockType}:`, error);
+            }
+          }
+        }
+        if (field.type === "array" && field.fields) {
+          const arrayValue = node.fields[field.name];
+          if (Array.isArray(arrayValue)) {
+            for (const arrayItem of arrayValue) {
+              if (arrayItem && typeof arrayItem === "object") {
+                for (const arrayField of field.fields) {
+                  if (arrayField.type === "upload" && arrayField.relationTo && arrayItem[arrayField.name]) {
+                    const arrayFieldValue = arrayItem[arrayField.name];
+                    if (typeof arrayFieldValue === "string" && arrayFieldValue.match(/^[a-f0-9]{24}$/i)) {
+                      try {
+                        const media = await payload.findByID({
+                          collection: arrayField.relationTo,
+                          id: arrayFieldValue,
+                          depth: 0
+                        });
+                        if (media) {
+                          arrayItem[arrayField.name] = media;
+                          payload.logger?.info(`Populated array ${arrayField.name} for block ${blockType}:`, {
+                            mediaId: arrayFieldValue,
+                            mediaUrl: media.url,
+                            filename: media.filename
+                          });
+                        }
+                      } catch (error) {
+                        payload.logger?.error(`Failed to populate array ${arrayField.name} for block ${blockType}:`, error);
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  if (node.children) {
+    for (const child of node.children) {
+      await populateBlockMediaFields(child, payload, config);
+    }
+  }
+}
+var createBroadcastPreviewEndpoint = (config, _collectionSlug) => {
   return {
     path: "/preview",
     method: "post",
@@ -1640,7 +1720,9 @@ var createBroadcastPreviewEndpoint = (config, collectionSlug) => {
           }, { status: 400 });
         }
         const mediaUrl = req.payload.config.serverURL ? `${req.payload.config.serverURL}/api/media` : "/api/media";
-        const htmlContent = await convertToEmailSafeHtml(content, {
+        req.payload.logger?.info("Populating media fields for email preview...");
+        const populatedContent = await populateMediaFields(content, req.payload, config);
+        const htmlContent = await convertToEmailSafeHtml(populatedContent, {
           wrapInTemplate: true,
           preheader,
           mediaUrl,
@@ -1939,8 +2021,9 @@ var createBroadcastsCollection = (pluginConfig) => {
               }
               const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
               const provider = new BroadcastApiProvider2(providerConfig);
-              req.payload.logger.info("Converting content to HTML...");
-              const htmlContent = await convertToEmailSafeHtml(doc.contentSection?.content, {
+              req.payload.logger.info("Populating media fields and converting content to HTML...");
+              const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+              const htmlContent = await convertToEmailSafeHtml(populatedContent, {
                 customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
               });
               if (!htmlContent || htmlContent.trim() === "") {
@@ -2039,7 +2122,8 @@ var createBroadcastsCollection = (pluginConfig) => {
                   return doc;
                 }
                 req.payload.logger.info("Creating broadcast in provider (deferred from initial create)...");
-                const htmlContent = await convertToEmailSafeHtml(doc.contentSection?.content, {
+                const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+                const htmlContent = await convertToEmailSafeHtml(populatedContent, {
                   customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
                 });
                 if (!htmlContent || htmlContent.trim() === "") {
@@ -2100,7 +2184,8 @@ var createBroadcastsCollection = (pluginConfig) => {
                     updates.preheader = doc.contentSection?.preheader;
                   }
                   if (JSON.stringify(doc.contentSection?.content) !== JSON.stringify(previousDoc?.contentSection?.content)) {
-                    updates.content = await convertToEmailSafeHtml(doc.contentSection?.content, {
+                    const populatedContent = await populateMediaFields(doc.contentSection?.content, req.payload, pluginConfig);
+                    updates.content = await convertToEmailSafeHtml(populatedContent, {
                       customBlockConverter: pluginConfig.customizations?.broadcasts?.customBlockConverter
                     });
                   }