payload-plugin-newsletter 0.16.3 → 0.16.6

package/CHANGELOG.md

@@ -1,3 +1,65 @@
+## [0.16.6] - 2025-07-29
+
+### Fixed
+- **Critical: Update Sync Now Works** - Fixed the afterChange hook that was blocking update operations
+  - Removed the `operation !== 'create'` check that prevented the afterChange hook from running on updates
+  - Moved update sync logic from beforeChange to afterChange for proper architectural pattern
+  - Updates are now synced AFTER they're saved to Payload, ensuring consistency
+  - Provider sync failures no longer block Payload updates
+
+### Improved
+- **Better Hook Architecture** - Sync operations now happen in the correct lifecycle stage
+  - beforeChange was architecturally wrong - if provider sync failed, data would be inconsistent
+  - afterChange ensures Payload data is saved first, then syncs to provider
+  - More resilient to network failures and API errors
+
+### Technical
+- Consolidated create and update logic in a single afterChange hook
+- Added comprehensive content change detection before syncing
+- Enhanced logging for update sync operations
+- Removed redundant beforeChange hook logic
+
+## [0.16.5] - 2025-07-29
+
+### Breaking Changes
+- **Field Renaming** - Renamed `status` field to `sendStatus` throughout the codebase
+  - This avoids confusion with Payload's built-in `_status` field (draft/published)
+  - Database field is now `sendStatus` for email send status (draft, scheduled, sending, sent, etc.)
+  - All references in providers, endpoints, and types have been updated
+  - If you have existing broadcast data with a `status` field, you'll need to migrate it to `sendStatus`
+
+### Fixed
+- **Update Sync** - Fixed issue where broadcast updates made in Payload weren't syncing to the Broadcast provider
+  - The update hook now correctly checks `sendStatus` instead of the non-existent `status` field
+  - Provider can now properly determine if a broadcast is editable based on its send status
+
+### Technical
+- Updated `Broadcast` type interface to use `sendStatus` property
+- Updated all provider implementations (Broadcast and Resend) to use `sendStatus`
+- Updated send and schedule endpoints to set `sendStatus` field
+- All TypeScript errors resolved
+
+## [0.16.4] - 2025-07-27
+
+### Added
+- **Access Control for Broadcasts** - Added proper access control to the Broadcasts collection
+  - Public read access for all users
+  - Create, update, and delete operations require authenticated users
+  - Prevents unauthorized modifications to broadcast content
+  - Follows Payload's standard access control patterns
+
+### Improved
+- **Enhanced Update Sync Debugging** - Added detailed logging for broadcast update synchronization
+  - Logs when update hooks are triggered with operation details
+  - Shows what fields are being synced to the provider
+  - Helps diagnose why updates might not be syncing
+  - Added info logging for skipped updates due to status restrictions
+- **Clearer Field Naming** - Renamed `status` field to `sendStatus` to avoid confusion with Payload's `_status`
+  - Database field is now `sendStatus` (draft, scheduled, sending, sent, etc.)
+  - Payload's versioning field remains `_status` (draft, published)
+  - Added virtual `status` field for API backward compatibility
+  - Makes it clear which status controls email sending vs content publishing
+
 ## [0.16.3] - 2025-07-27
 
 ### Improved

package/dist/collections.cjs

@@ -291,9 +291,9 @@ var init_broadcast2 = __esm({
       async update(id, data) {
         try {
           const existing = await this.get(id);
-          if (!this.canEditInStatus(existing.status)) {
+          if (!this.canEditInStatus(existing.sendStatus)) {
             throw new BroadcastProviderError(
-              `Cannot update broadcast in status: ${existing.status}`,
+              `Cannot update broadcast in status: ${existing.sendStatus}`,
               "INVALID_STATUS" /* INVALID_STATUS */,
               this.name
             );
@@ -336,9 +336,9 @@ var init_broadcast2 = __esm({
       async delete(id) {
         try {
           const existing = await this.get(id);
-          if (!this.canEditInStatus(existing.status)) {
+          if (!this.canEditInStatus(existing.sendStatus)) {
             throw new BroadcastProviderError(
-              `Cannot delete broadcast in status: ${existing.status}`,
+              `Cannot delete broadcast in status: ${existing.sendStatus}`,
               "INVALID_STATUS" /* INVALID_STATUS */,
               this.name
             );
@@ -497,7 +497,7 @@ var init_broadcast2 = __esm({
           subject: broadcast.subject,
           preheader: broadcast.preheader,
           content: broadcast.body,
-          status: this.mapBroadcastStatus(broadcast.status),
+          sendStatus: this.mapBroadcastStatus(broadcast.status),
           trackOpens: broadcast.track_opens,
           trackClicks: broadcast.track_clicks,
           replyTo: broadcast.reply_to,
@@ -1191,6 +1191,19 @@ var createBroadcastsCollection = (pluginConfig) => {
   const customizations = pluginConfig.customizations?.broadcasts;
   return {
     slug: "broadcasts",
+    access: {
+      read: () => true,
+      // Public read access
+      create: ({ req: { user } }) => {
+        return Boolean(user);
+      },
+      update: ({ req: { user } }) => {
+        return Boolean(user);
+      },
+      delete: ({ req: { user } }) => {
+        return Boolean(user);
+      }
+    },
     versions: {
       drafts: {
         autosave: true,
@@ -1204,7 +1217,7 @@ var createBroadcastsCollection = (pluginConfig) => {
     admin: {
       useAsTitle: "subject",
       description: "Individual email campaigns sent to subscribers",
-      defaultColumns: ["subject", "_status", "status", "sentAt", "recipientCount"]
+      defaultColumns: ["subject", "_status", "sendStatus", "sentAt", "recipientCount"]
     },
     fields: [
       {
@@ -1264,8 +1277,9 @@ var createBroadcastsCollection = (pluginConfig) => {
         ]
       },
       {
-        name: "status",
+        name: "sendStatus",
         type: "select",
+        label: "Send Status",
         required: true,
         defaultValue: "draft" /* DRAFT */,
         options: [
@@ -1279,6 +1293,7 @@ var createBroadcastsCollection = (pluginConfig) => {
         ],
         admin: {
           readOnly: true,
+          description: "The status of the email send operation",
           components: {
             Cell: "payload-plugin-newsletter/components#StatusBadge"
           }
@@ -1335,7 +1350,7 @@ var createBroadcastsCollection = (pluginConfig) => {
         type: "group",
         admin: {
           readOnly: true,
-          condition: (data) => data?.status === "sent" /* SENT */
+          condition: (data) => data?.sendStatus === "sent" /* SENT */
         },
         fields: [
           {
@@ -1394,7 +1409,7 @@ var createBroadcastsCollection = (pluginConfig) => {
         name: "scheduledAt",
         type: "date",
         admin: {
-          condition: (data) => data?.status === "scheduled" /* SCHEDULED */,
+          condition: (data) => data?.sendStatus === "scheduled" /* SCHEDULED */,
           date: {
             displayFormat: "MMM d, yyyy h:mm a"
           }
@@ -1420,58 +1435,130 @@ var createBroadcastsCollection = (pluginConfig) => {
       }
     ],
     hooks: {
-      // Sync with provider on create
+      // Sync with provider on create and update
       afterChange: [
-        async ({ doc, operation, req }) => {
-          if (!hasProviders || operation !== "create") return doc;
-          try {
-            const providerConfig = await getBroadcastConfig(req, pluginConfig);
-            if (!providerConfig || !providerConfig.token) {
-              req.payload.logger.error("Broadcast provider not configured in Newsletter Settings or environment variables");
-              return doc;
-            }
-            const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
-            const provider = new BroadcastApiProvider2(providerConfig);
-            const htmlContent = await convertToEmailSafeHtml(doc.contentSection?.content);
-            const providerBroadcast = await provider.create({
-              name: doc.subject,
-              // Use subject as name since we removed the name field
-              subject: doc.subject,
-              preheader: doc.contentSection?.preheader,
-              content: htmlContent,
-              trackOpens: doc.settings?.trackOpens,
-              trackClicks: doc.settings?.trackClicks,
-              replyTo: doc.settings?.replyTo || providerConfig.replyTo,
-              audienceIds: doc.audienceIds?.map((a) => a.audienceId)
-            });
-            await req.payload.update({
-              collection: "broadcasts",
-              id: doc.id,
-              data: {
+        async ({ doc, operation, req, previousDoc }) => {
+          if (!hasProviders) return doc;
+          if (operation === "create") {
+            try {
+              const providerConfig = await getBroadcastConfig(req, pluginConfig);
+              if (!providerConfig || !providerConfig.token) {
+                req.payload.logger.error("Broadcast provider not configured in Newsletter Settings or environment variables");
+                return doc;
+              }
+              const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
+              const provider = new BroadcastApiProvider2(providerConfig);
+              const htmlContent = await convertToEmailSafeHtml(doc.contentSection?.content);
+              const providerBroadcast = await provider.create({
+                name: doc.subject,
+                // Use subject as name since we removed the name field
+                subject: doc.subject,
+                preheader: doc.contentSection?.preheader,
+                content: htmlContent,
+                trackOpens: doc.settings?.trackOpens,
+                trackClicks: doc.settings?.trackClicks,
+                replyTo: doc.settings?.replyTo || providerConfig.replyTo,
+                audienceIds: doc.audienceIds?.map((a) => a.audienceId)
+              });
+              await req.payload.update({
+                collection: "broadcasts",
+                id: doc.id,
+                data: {
+                  providerId: providerBroadcast.id,
+                  providerData: providerBroadcast.providerData
+                },
+                req
+              });
+              return {
+                ...doc,
                 providerId: providerBroadcast.id,
                 providerData: providerBroadcast.providerData
-              },
-              req
+              };
+            } catch (error) {
+              if (error instanceof Error) {
+                req.payload.logger.error("Failed to create broadcast in provider:", {
+                  message: error.message,
+                  stack: error.stack,
+                  name: error.name,
+                  // If it's a BroadcastProviderError, it might have additional details
+                  ...error.details
+                });
+              } else {
+                req.payload.logger.error("Failed to create broadcast in provider:", error);
+              }
+              return doc;
+            }
+          }
+          if (operation === "update" && doc.providerId) {
+            req.payload.logger.info("Broadcast afterChange update hook triggered", {
+              operation,
+              hasProviderId: !!doc.providerId,
+              sendStatus: doc.sendStatus,
+              publishStatus: doc._status
             });
-            return {
-              ...doc,
-              providerId: providerBroadcast.id,
-              providerData: providerBroadcast.providerData
-            };
-          } catch (error) {
-            if (error instanceof Error) {
-              req.payload.logger.error("Failed to create broadcast in provider:", {
-                message: error.message,
-                stack: error.stack,
-                name: error.name,
-                // If it's a BroadcastProviderError, it might have additional details
-                ...error.details
-              });
-            } else {
-              req.payload.logger.error("Failed to create broadcast in provider:", error);
+            try {
+              const providerConfig = await getBroadcastConfig(req, pluginConfig);
+              if (!providerConfig || !providerConfig.token) {
+                req.payload.logger.error("Broadcast provider not configured in Newsletter Settings or environment variables");
+                return doc;
+              }
+              const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
+              const provider = new BroadcastApiProvider2(providerConfig);
+              const capabilities = provider.getCapabilities();
+              const sendStatus = doc.sendStatus || "draft" /* DRAFT */;
+              if (!capabilities.editableStatuses.includes(sendStatus)) {
+                req.payload.logger.info(`Skipping sync for broadcast in status: ${sendStatus}`);
+                return doc;
+              }
+              const contentChanged = doc.subject !== previousDoc?.subject || doc.contentSection?.preheader !== previousDoc?.contentSection?.preheader || JSON.stringify(doc.contentSection?.content) !== JSON.stringify(previousDoc?.contentSection?.content) || doc.settings?.trackOpens !== previousDoc?.settings?.trackOpens || doc.settings?.trackClicks !== previousDoc?.settings?.trackClicks || doc.settings?.replyTo !== previousDoc?.settings?.replyTo || JSON.stringify(doc.audienceIds) !== JSON.stringify(previousDoc?.audienceIds);
+              if (contentChanged) {
+                const updates = {};
+                if (doc.subject !== previousDoc?.subject) {
+                  updates.name = doc.subject;
+                  updates.subject = doc.subject;
+                }
+                if (doc.contentSection?.preheader !== previousDoc?.contentSection?.preheader) {
+                  updates.preheader = doc.contentSection?.preheader;
+                }
+                if (JSON.stringify(doc.contentSection?.content) !== JSON.stringify(previousDoc?.contentSection?.content)) {
+                  updates.content = await convertToEmailSafeHtml(doc.contentSection?.content);
+                }
+                if (doc.settings?.trackOpens !== previousDoc?.settings?.trackOpens) {
+                  updates.trackOpens = doc.settings.trackOpens;
+                }
+                if (doc.settings?.trackClicks !== previousDoc?.settings?.trackClicks) {
+                  updates.trackClicks = doc.settings.trackClicks;
+                }
+                if (doc.settings?.replyTo !== previousDoc?.settings?.replyTo) {
+                  updates.replyTo = doc.settings.replyTo || providerConfig.replyTo;
+                }
+                if (JSON.stringify(doc.audienceIds) !== JSON.stringify(previousDoc?.audienceIds)) {
+                  updates.audienceIds = doc.audienceIds?.map((a) => a.audienceId);
+                }
+                req.payload.logger.info("Syncing broadcast updates to provider", {
+                  providerId: doc.providerId,
+                  updates
+                });
+                await provider.update(doc.providerId, updates);
+                req.payload.logger.info(`Broadcast ${doc.id} synced to provider successfully`);
+              } else {
+                req.payload.logger.info("No content changes to sync to provider");
+              }
+            } catch (error) {
+              if (error instanceof Error) {
+                req.payload.logger.error("Failed to sync broadcast update to provider:", {
+                  message: error.message,
+                  stack: error.stack,
+                  name: error.name,
+                  // If it's a BroadcastProviderError, it might have additional details
+                  ...error.details
+                });
+              } else {
+                req.payload.logger.error("Failed to sync broadcast update to provider:", error);
+              }
             }
-            return doc;
           }
+          return doc;
         },
         // Hook to send when published
         async ({ doc, operation, previousDoc, req }) => {
@@ -1479,7 +1566,7 @@ var createBroadcastsCollection = (pluginConfig) => {
           const wasUnpublished = !previousDoc?._status || previousDoc._status === "draft";
           const isNowPublished = doc._status === "published";
           if (wasUnpublished && isNowPublished && doc.providerId) {
-            if (doc.status === "sent" || doc.status === "sending") {
+            if (doc.sendStatus === "sent" /* SENT */ || doc.sendStatus === "sending" /* SENDING */) {
               return doc;
             }
             try {
@@ -1498,7 +1585,7 @@ var createBroadcastsCollection = (pluginConfig) => {
                 collection: "broadcasts",
                 id: doc.id,
                 data: {
-                  status: "sending" /* SENDING */,
+                  sendStatus: "sending" /* SENDING */,
                   sentAt: (/* @__PURE__ */ new Date()).toISOString()
                 },
                 req
@@ -1520,7 +1607,7 @@ var createBroadcastsCollection = (pluginConfig) => {
                 collection: "broadcasts",
                 id: doc.id,
                 data: {
-                  status: "failed" /* FAILED */
+                  sendStatus: "failed" /* FAILED */
                 },
                 req
               });
@@ -1529,62 +1616,8 @@ var createBroadcastsCollection = (pluginConfig) => {
           return doc;
         }
       ],
-      // Sync updates with provider
-      beforeChange: [
-        async ({ data, originalDoc, operation, req }) => {
-          if (!hasProviders || !originalDoc?.providerId || operation !== "update") return data;
-          try {
-            const providerConfig = await getBroadcastConfig(req, pluginConfig);
-            if (!providerConfig || !providerConfig.token) {
-              req.payload.logger.error("Broadcast provider not configured in Newsletter Settings or environment variables");
-              return data;
-            }
-            const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
-            const provider = new BroadcastApiProvider2(providerConfig);
-            const capabilities = provider.getCapabilities();
-            if (!capabilities.editableStatuses.includes(originalDoc.status)) {
-              return data;
-            }
-            const updates = {};
-            if (data.subject !== originalDoc.subject) {
-              updates.name = data.subject;
-              updates.subject = data.subject;
-            }
-            if (data.contentSection?.preheader !== originalDoc.contentSection?.preheader) updates.preheader = data.contentSection?.preheader;
-            if (data.contentSection?.content !== originalDoc.contentSection?.content) {
-              updates.content = await convertToEmailSafeHtml(data.contentSection?.content);
-            }
-            if (data.settings?.trackOpens !== originalDoc.settings?.trackOpens) {
-              updates.trackOpens = data.settings.trackOpens;
-            }
-            if (data.settings?.trackClicks !== originalDoc.settings?.trackClicks) {
-              updates.trackClicks = data.settings.trackClicks;
-            }
-            if (data.settings?.replyTo !== originalDoc.settings?.replyTo) {
-              updates.replyTo = data.settings.replyTo || providerConfig.replyTo;
-            }
-            if (JSON.stringify(data.audienceIds) !== JSON.stringify(originalDoc.audienceIds)) {
-              updates.audienceIds = data.audienceIds?.map((a) => a.audienceId);
-            }
-            if (Object.keys(updates).length > 0) {
-              await provider.update(originalDoc.providerId, updates);
-            }
-          } catch (error) {
-            if (error instanceof Error) {
-              req.payload.logger.error("Failed to update broadcast in provider:", {
-                message: error.message,
-                stack: error.stack,
-                name: error.name,
-                // If it's a BroadcastProviderError, it might have additional details
-                ...error.details
-              });
-            } else {
-              req.payload.logger.error("Failed to update broadcast in provider:", error);
-            }
-          }
-          return data;
-        }
-      ],
+      // beforeChange hooks can be added here if needed
+      beforeChange: [],
       // Handle deletion
       afterDelete: [
         async ({ doc, req }) => {
@@ -1598,7 +1631,7 @@ var createBroadcastsCollection = (pluginConfig) => {
             const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
             const provider = new BroadcastApiProvider2(providerConfig);
             const capabilities = provider.getCapabilities();
-            if (capabilities.editableStatuses.includes(doc.status)) {
+            if (capabilities.editableStatuses.includes(doc.sendStatus)) {
               await provider.delete(doc.providerId);
             }
           } catch (error) {