payload-plugin-newsletter 0.15.1 → 0.16.0

package/CHANGELOG.md

@@ -1,3 +1,47 @@
+## [0.16.0] - 2025-07-27
+
+### Changed
+- **Send = Publish Workflow** - Simplified broadcast sending to use Payload's native draft/publish system
+  - Publishing a broadcast now automatically sends it via the configured email provider
+  - Removed custom Send/Schedule modal in favor of Payload's built-in UI
+  - Scheduled publishing supported via Payload's Jobs Queue system
+  - Breaking: Removed `SendBroadcastModal` and `ActionsCell` components
+- **Streamlined UI** - Removed custom action buttons from broadcasts list view
+  - Users now use standard Payload publish/schedule functionality
+  - Cleaner interface that follows Payload's patterns
+  - Less code to maintain while providing better integration
+
+### Added
+- **Automatic Send on Publish** - New `afterChange` hook that sends broadcasts when published
+  - Checks if broadcast is transitioning to published status
+  - Automatically calls provider's send method
+  - Updates broadcast status to "sending" after successful send
+  - Handles failures gracefully with status update to "failed"
+- **Jobs Queue Documentation** - Added comprehensive setup instructions for scheduled publishing
+  - Vercel Cron configuration example
+  - Security setup with CRON_SECRET
+  - Step-by-step guide for enabling scheduled broadcasts
+
+### Removed
+- **Custom UI Components** (Breaking Change)
+  - `SendBroadcastModal` - Custom send/schedule modal
+  - `ActionsCell` - Custom action buttons in list view
+  - `actions` field from Broadcasts collection
+  - These are replaced by Payload's native publish/schedule functionality
+
+### Technical
+- Enabled `versions` configuration on Broadcasts collection with drafts and scheduled publishing
+- Updated default columns to show both `_status` (Draft/Published) and `status` (send status)
+- Improved TypeScript exports by removing deleted component references
+- All tests passing with minor version upgrade
+
+### Migration Guide
+If you were using the custom Send/Schedule modal:
+1. The functionality is now built into Payload's publish system
+2. To send immediately: Click "Publish"
+3. To schedule: Click "Schedule" (requires Jobs Queue setup)
+4. Remove any imports of `SendBroadcastModal` or `ActionsCell` from your code
+
 ## [0.15.1] - 2025-07-27
 
 ### Fixed

package/README.md

@@ -241,6 +241,50 @@ This adds a `broadcasts` collection with:
 - Custom email blocks (buttons, dividers)
 - Inline email preview with React Email
 - Automatic sync with your email provider
+- Draft/publish system with scheduled publishing support
+
+### Send = Publish Workflow
+
+The plugin integrates seamlessly with Payload's draft/publish system:
+
+- **Draft**: Create and edit broadcasts without sending
+- **Publish**: Publishing a broadcast automatically sends it via your configured email provider
+- **Schedule**: Use Payload's scheduled publishing to send broadcasts at a future time
+
+**How it works:**
+1. Create a broadcast and save as draft
+2. When ready, click "Publish" to send immediately
+3. Or use "Schedule" to publish (and send) at a specific date/time
+
+**Important**: Scheduled publishing requires configuring Payload's Jobs Queue. For Vercel deployments, add this to your `vercel.json`:
+
+```json
+{
+  "crons": [
+    {
+      "path": "/api/payload-jobs/run",
+      "schedule": "*/5 * * * *"
+    }
+  ]
+}
+```
+
+And secure the endpoint in your `payload.config.ts`:
+
+```typescript
+export default buildConfig({
+  // ... other config
+  jobs: {
+    access: {
+      run: ({ req }) => {
+        if (req.user) return true
+        const authHeader = req.headers.get('authorization')
+        return authHeader === `Bearer ${process.env.CRON_SECRET}`
+      },
+    },
+  },
+})
+```
 
 ### Custom Email Templates (v0.12.0+)
 

package/dist/collections.cjs

@@ -1168,6 +1168,12 @@ var createBroadcastsCollection = (pluginConfig) => {
   const customizations = pluginConfig.customizations?.broadcasts;
   return {
     slug: "broadcasts",
+    versions: {
+      drafts: {
+        autosave: true,
+        schedulePublish: true
+      }
+    },
     labels: {
       singular: "Broadcast",
       plural: "Broadcasts"
@@ -1175,7 +1181,7 @@ var createBroadcastsCollection = (pluginConfig) => {
     admin: {
       useAsTitle: "subject",
       description: "Individual email campaigns sent to subscribers",
-      defaultColumns: ["subject", "status", "sentAt", "recipientCount", "actions"]
+      defaultColumns: ["subject", "_status", "status", "sentAt", "recipientCount"]
     },
     fields: [
       {
@@ -1388,18 +1394,6 @@ var createBroadcastsCollection = (pluginConfig) => {
           condition: () => false
           // Hidden by default
         }
-      },
-      // UI Field for custom actions in list view
-      {
-        name: "actions",
-        type: "ui",
-        admin: {
-          components: {
-            Cell: "payload-plugin-newsletter/components#ActionsCell",
-            Field: "payload-plugin-newsletter/components#EmptyField"
-          },
-          disableListColumn: false
-        }
       }
     ],
     hooks: {
@@ -1513,6 +1507,48 @@ var createBroadcastsCollection = (pluginConfig) => {
             req.payload.logger.error("Failed to delete broadcast from provider:", error);
           }
           return doc;
+        },
+        // Hook to send when published
+        async ({ doc, req }) => {
+          if (doc._status === "published" && doc.providerId) {
+            if (doc.status === "sent" || doc.status === "sending") {
+              return doc;
+            }
+            try {
+              const broadcastConfig = pluginConfig.providers?.broadcast;
+              const resendConfig = pluginConfig.providers?.resend;
+              if (!broadcastConfig && !resendConfig) {
+                req.payload.logger.error("No provider configured for sending");
+                return doc;
+              }
+              if (broadcastConfig) {
+                const { BroadcastApiProvider: BroadcastApiProvider2 } = await Promise.resolve().then(() => (init_broadcast2(), broadcast_exports));
+                const provider = new BroadcastApiProvider2(broadcastConfig);
+                await provider.send(doc.providerId);
+              }
+              await req.payload.update({
+                collection: "broadcasts",
+                id: doc.id,
+                data: {
+                  status: "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);
+              await req.payload.update({
+                collection: "broadcasts",
+                id: doc.id,
+                data: {
+                  status: "failed" /* FAILED */
+                },
+                req
+              });
+            }
+          }
+          return doc;
         }
       ]
     }