payload-plugin-newsletter 0.16.2 → 0.16.5

package/CHANGELOG.md

@@ -1,3 +1,53 @@
+## [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
+- **Enhanced Error Logging** - Improved error logging for broadcast operations
+  - Now logs full error details including message, stack trace, and any additional error properties
+  - Helps diagnose API connection issues, authentication failures, and validation errors
+  - Structured error logging makes it easier to identify root causes
+  - Applied to all broadcast hooks: create, update, delete, and send
+
 ## [0.16.2] - 2025-07-27
 
 ### Fixed

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"
           }
@@ -1459,7 +1474,17 @@ var createBroadcastsCollection = (pluginConfig) => {
               providerData: providerBroadcast.providerData
             };
           } catch (error) {
-            req.payload.logger.error("Failed to create broadcast in provider:", 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;
           }
         },
@@ -1469,7 +1494,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 {
@@ -1488,19 +1513,29 @@ var createBroadcastsCollection = (pluginConfig) => {
                 collection: "broadcasts",
                 id: doc.id,
                 data: {
-                  status: "sending" /* SENDING */,
+                  sendStatus: "sending" /* SENDING */,
                   sentAt: (/* @__PURE__ */ new Date()).toISOString()
                 },
                 req
               });
               req.payload.logger.info(`Broadcast ${doc.id} sent successfully`);
             } catch (error) {
-              req.payload.logger.error(`Failed to send broadcast ${doc.id}:`, error);
+              if (error instanceof Error) {
+                req.payload.logger.error(`Failed to send broadcast ${doc.id}:`, {
+                  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 send broadcast ${doc.id}:`, error);
+              }
               await req.payload.update({
                 collection: "broadcasts",
                 id: doc.id,
                 data: {
-                  status: "failed" /* FAILED */
+                  sendStatus: "failed" /* FAILED */
                 },
                 req
               });
@@ -1513,6 +1548,14 @@ var createBroadcastsCollection = (pluginConfig) => {
       beforeChange: [
         async ({ data, originalDoc, operation, req }) => {
           if (!hasProviders || !originalDoc?.providerId || operation !== "update") return data;
+          req.payload.logger.info("Broadcast beforeChange update hook triggered", {
+            operation,
+            hasProviderId: !!originalDoc?.providerId,
+            originalSendStatus: originalDoc?.sendStatus,
+            originalPublishStatus: originalDoc?._status,
+            newSendStatus: data?.sendStatus,
+            newPublishStatus: data?._status
+          });
           try {
             const providerConfig = await getBroadcastConfig(req, pluginConfig);
             if (!providerConfig || !providerConfig.token) {
@@ -1522,7 +1565,9 @@ 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(originalDoc.status)) {
+            const sendStatus = originalDoc.sendStatus || "draft" /* DRAFT */;
+            if (!capabilities.editableStatuses.includes(sendStatus)) {
+              req.payload.logger.info(`Skipping sync for broadcast in status: ${sendStatus}`);
               return data;
             }
             const updates = {};
@@ -1547,10 +1592,27 @@ var createBroadcastsCollection = (pluginConfig) => {
               updates.audienceIds = data.audienceIds?.map((a) => a.audienceId);
             }
             if (Object.keys(updates).length > 0) {
+              req.payload.logger.info("Syncing broadcast updates to provider", {
+                providerId: originalDoc.providerId,
+                updates
+              });
               await provider.update(originalDoc.providerId, updates);
+              req.payload.logger.info("Successfully synced broadcast updates to provider");
+            } else {
+              req.payload.logger.info("No broadcast updates to sync to provider");
             }
           } catch (error) {
-            req.payload.logger.error("Failed to update broadcast in provider:", 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;
         }
@@ -1568,11 +1630,21 @@ 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) {
-            req.payload.logger.error("Failed to delete broadcast from provider:", error);
+            if (error instanceof Error) {
+              req.payload.logger.error("Failed to delete broadcast from 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 delete broadcast from provider:", error);
+            }
           }
           return doc;
         }