payload-plugin-newsletter 0.4.5 → 0.6.1

package/CHANGELOG.md

@@ -1,6 +1,11 @@
-## [0.4.5] - 2025-06-19
+## [0.6.1] - 2025-06-20
+
+- fix: update Broadcast provider to use correct API endpoints
+
 
-- fix: add tsup build system for proper ESM/CJS dual package support
+- fix: resolve ESLint error for unused variable in test mock
+- fix: update tests to support newsletter settings as global
+- feat: convert newsletter settings from collection to global
 
 
 All notable changes to this project will be documented in this file.
@@ -8,6 +13,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2025-06-20
+
+### Changed
+- **BREAKING**: Changed newsletter settings from a collection back to a global configuration
+  - Settings are now accessed as a single global config instead of multiple documents
+  - Removed the "name" and "active" fields as they're no longer needed for globals
+  - Settings now appear as a single page in the admin UI instead of a list view
+  - Updated all code to use `payload.findGlobal()` instead of `payload.find()`
+  
+### Migration Required
+- Users with existing newsletter-settings collections will need to manually copy their active configuration to the new global settings
+- After migration, the old newsletter-settings collection can be removed from the database
+
+### Fixed
+- Resolved user confusion around having multiple settings documents when only one could be active
+- Settings now follow the standard Payload pattern for configuration globals
+
+## [0.4.5] - 2025-06-19
+
+### Fixed
+- Added tsup build system for proper ESM/CJS dual package support
+
 ## [0.4.4] - 2025-06-16
 
 ### Fixed

package/ESM_FIX_SUMMARY.md

@@ -0,0 +1,74 @@
+# ESM/CJS Module Resolution Fix Summary
+
+## Changes Made
+
+### 1. **Added tsup Build Tool**
+- Added `tsup` v8.3.5 to devDependencies for proper ESM/CJS dual package support
+- Created `tsup.config.ts` with configuration for building both ESM and CJS outputs
+
+### 2. **Updated package.json**
+- Changed entry points from source files (`./src/`) to built files (`./dist/`)
+- Added proper exports configuration with both ESM and CJS support:
+  - ESM files: `.js` extension with `.d.ts` types
+  - CJS files: `.cjs` extension with `.d.cts` types
+- Updated build scripts to use tsup
+- Added `module` field pointing to ESM entry
+
+### 3. **Updated tsconfig.json**
+- Changed `moduleResolution` from "bundler" to "node" for better compatibility
+
+### 4. **Created Build Script**
+- Added `build-and-commit.sh` for easy building and verification
+
+## File Structure After Build
+
+```
+dist/
+├── index.js         # ESM main entry
+├── index.cjs        # CJS main entry
+├── index.d.ts       # TypeScript definitions
+├── index.d.cts      # CJS TypeScript definitions
+├── client.js        # ESM client export
+├── client.cjs       # CJS client export
+├── client.d.ts      # Client TypeScript definitions
+├── client.d.cts     # CJS Client TypeScript definitions
+├── types.js         # ESM types export
+├── types.cjs        # CJS types export
+├── types.d.ts       # Types TypeScript definitions
+├── types.d.cts      # CJS Types TypeScript definitions
+├── components.js    # ESM components export
+├── components.cjs   # CJS components export
+├── components.d.ts  # Components TypeScript definitions
+└── components.d.cts # CJS Components TypeScript definitions
+```
+
+## How to Build and Publish
+
+1. **Install dependencies**: `bun install`
+2. **Build the package**: `bun run build`
+3. **Test locally**: Link the package to test in your project
+4. **Publish**: `npm publish` (dist files will be included automatically)
+
+## Benefits
+
+1. **Proper ESM Support**: Next.js apps using `"type": "module"` can now import the package without issues
+2. **CJS Compatibility**: Still works with CommonJS projects
+3. **TypeScript Support**: Proper type definitions for both module systems
+4. **Clean Exports**: Clear separation of server/client code with proper exports
+5. **Future Proof**: Ready for the ESM-first ecosystem
+
+## Testing the Fix
+
+To test in your ContentQuant project:
+1. Build the plugin: `bun run build`
+2. Link locally: `npm link` in plugin directory
+3. Link in project: `npm link payload-plugin-newsletter` in ContentQuant
+4. Import and use normally
+
+## Next Steps
+
+1. Run `./build-and-commit.sh` to build the package
+2. Test the built package locally
+3. Commit changes with message: "fix: add tsup build system for proper ESM/CJS dual package support"
+4. Push to repository
+5. Publish new version to npm

package/dist/index.cjs

@@ -357,40 +357,17 @@ var createSubscribersCollection = (pluginConfig) => {
   return subscribersCollection;
 };
 
-// src/collections/NewsletterSettings.ts
-var createNewsletterSettingsCollection = (pluginConfig) => {
+// src/globals/NewsletterSettings.ts
+var createNewsletterSettingsGlobal = (pluginConfig) => {
   const slug = pluginConfig.settingsSlug || "newsletter-settings";
   return {
     slug,
-    labels: {
-      singular: "Newsletter Setting",
-      plural: "Newsletter Settings"
-    },
+    label: "Newsletter Settings",
     admin: {
-      useAsTitle: "name",
-      defaultColumns: ["name", "provider", "active", "updatedAt"],
       group: "Newsletter",
       description: "Configure email provider settings and templates"
     },
     fields: [
-      {
-        name: "name",
-        type: "text",
-        label: "Configuration Name",
-        required: true,
-        admin: {
-          description: 'A descriptive name for this configuration (e.g., "Production", "Development", "Marketing Emails")'
-        }
-      },
-      {
-        name: "active",
-        type: "checkbox",
-        label: "Active",
-        defaultValue: false,
-        admin: {
-          description: "Only one configuration can be active at a time"
-        }
-      },
       {
         type: "tabs",
         tabs: [
@@ -650,53 +627,16 @@ var createNewsletterSettingsCollection = (pluginConfig) => {
     ],
     hooks: {
       beforeChange: [
-        async ({ data, req, operation }) => {
+        async ({ data, req }) => {
           if (!req.user || req.user.collection !== "users") {
             throw new Error("Only administrators can modify newsletter settings");
           }
-          if (data?.active && operation !== "create") {
-            await req.payload.update({
-              collection: slug,
-              where: {
-                id: {
-                  not_equals: data.id
-                }
-              },
-              data: {
-                active: false
-              }
-              // Keep overrideAccess: true for admin operations after verification
-            });
-          }
-          if (operation === "create" && data?.active) {
-            const existingActive = await req.payload.find({
-              collection: slug,
-              where: {
-                active: {
-                  equals: true
-                }
-              }
-              // Keep overrideAccess: true for admin operations
-            });
-            if (existingActive.docs.length > 0) {
-              for (const doc of existingActive.docs) {
-                await req.payload.update({
-                  collection: slug,
-                  id: doc.id,
-                  data: {
-                    active: false
-                  }
-                  // Keep overrideAccess: true for admin operations
-                });
-              }
-            }
-          }
           return data;
         }
       ],
       afterChange: [
         async ({ doc, req }) => {
-          if (req.payload.newsletterEmailService && doc.active) {
+          if (req.payload.newsletterEmailService) {
             try {
               console.warn("Newsletter settings updated, reinitializing service...");
             } catch {
@@ -709,11 +649,8 @@ var createNewsletterSettingsCollection = (pluginConfig) => {
     access: {
       read: () => true,
       // Settings can be read publicly for validation
-      create: adminOnly(pluginConfig),
-      update: adminOnly(pluginConfig),
-      delete: adminOnly(pluginConfig)
-    },
-    timestamps: true
+      update: adminOnly(pluginConfig)
+    }
   };
 };
 
@@ -900,20 +837,22 @@ var BroadcastProvider = class {
   }
   async addContact(contact) {
     try {
-      const response = await fetch(`${this.apiUrl}/api/v1/contacts`, {
+      const [firstName, ...lastNameParts] = (contact.name || "").split(" ");
+      const lastName = lastNameParts.join(" ");
+      const response = await fetch(`${this.apiUrl}/api/v1/subscribers.json`, {
         method: "POST",
         headers: {
           "Authorization": `Bearer ${this.token}`,
           "Content-Type": "application/json"
         },
         body: JSON.stringify({
-          email: contact.email,
-          name: contact.name,
-          status: contact.subscriptionStatus === "active" ? "subscribed" : "unsubscribed",
-          metadata: {
-            locale: contact.locale,
-            source: contact.source,
-            ...contact.utmParameters
+          subscriber: {
+            email: contact.email,
+            first_name: firstName || void 0,
+            last_name: lastName || void 0,
+            tags: [`lang:${contact.locale || "en"}`],
+            is_active: contact.subscriptionStatus === "active",
+            source: contact.source
           }
         })
       });
@@ -932,7 +871,7 @@ var BroadcastProvider = class {
   async updateContact(contact) {
     try {
       const searchResponse = await fetch(
-        `${this.apiUrl}/api/v1/contacts?email=${encodeURIComponent(contact.email)}`,
+        `${this.apiUrl}/api/v1/subscribers/find.json?email=${encodeURIComponent(contact.email)}`,
         {
           headers: {
             "Authorization": `Bearer ${this.token}`
@@ -943,26 +882,27 @@ var BroadcastProvider = class {
         await this.addContact(contact);
         return;
       }
-      const contacts = await searchResponse.json();
-      const existingContact = contacts.data?.[0];
-      if (!existingContact) {
+      const existingContact = await searchResponse.json();
+      if (!existingContact || !existingContact.id) {
         await this.addContact(contact);
         return;
       }
-      const response = await fetch(`${this.apiUrl}/api/v1/contacts/${existingContact.id}`, {
-        method: "PUT",
+      const [firstName, ...lastNameParts] = (contact.name || "").split(" ");
+      const lastName = lastNameParts.join(" ");
+      const response = await fetch(`${this.apiUrl}/api/v1/subscribers.json`, {
+        method: "PATCH",
         headers: {
           "Authorization": `Bearer ${this.token}`,
           "Content-Type": "application/json"
         },
         body: JSON.stringify({
           email: contact.email,
-          name: contact.name,
-          status: contact.subscriptionStatus === "active" ? "subscribed" : "unsubscribed",
-          metadata: {
-            locale: contact.locale,
-            source: contact.source,
-            ...contact.utmParameters
+          subscriber: {
+            first_name: firstName || void 0,
+            last_name: lastName || void 0,
+            tags: [`lang:${contact.locale || "en"}`],
+            is_active: contact.subscriptionStatus === "active",
+            source: contact.source
           }
         })
       });
@@ -981,7 +921,7 @@ var BroadcastProvider = class {
   async removeContact(email) {
     try {
       const searchResponse = await fetch(
-        `${this.apiUrl}/api/v1/contacts?email=${encodeURIComponent(email)}`,
+        `${this.apiUrl}/api/v1/subscribers/find.json?email=${encodeURIComponent(email)}`,
         {
           headers: {
             "Authorization": `Bearer ${this.token}`
@@ -991,16 +931,17 @@ var BroadcastProvider = class {
       if (!searchResponse.ok) {
         return;
       }
-      const contacts = await searchResponse.json();
-      const contact = contacts.data?.[0];
-      if (!contact) {
+      const contact = await searchResponse.json();
+      if (!contact || !contact.id) {
         return;
       }
-      const response = await fetch(`${this.apiUrl}/api/v1/contacts/${contact.id}`, {
-        method: "DELETE",
+      const response = await fetch(`${this.apiUrl}/api/v1/subscribers/deactivate.json`, {
+        method: "POST",
         headers: {
-          "Authorization": `Bearer ${this.token}`
-        }
+          "Authorization": `Bearer ${this.token}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ email })
       });
       if (!response.ok) {
         const error = await response.text();
@@ -1193,18 +1134,11 @@ var createSubscribeEndpoint = (config) => {
             errors: validation.errors
           });
         }
-        const settingsResult = await req.payload.find({
-          collection: config.settingsSlug || "newsletter-settings",
-          where: {
-            active: {
-              equals: true
-            }
-          },
-          limit: 1,
+        const settings = await req.payload.findGlobal({
+          slug: config.settingsSlug || "newsletter-settings",
           overrideAccess: false
           // No user context for public endpoint
         });
-        const settings = settingsResult.docs[0];
         const allowedDomains = settings?.subscriptionSettings?.allowedDomains?.map((d) => d.domain) || [];
         if (!isDomainAllowed(trimmedEmail, allowedDomains)) {
           return res.status(400).json({
@@ -1909,8 +1843,8 @@ var newsletterPlugin = (pluginConfig) => (incomingConfig) => {
     return incomingConfig;
   }
   const subscribersCollection = createSubscribersCollection(config);
-  const settingsCollection = createNewsletterSettingsCollection(config);
-  let collections = [...incomingConfig.collections || [], subscribersCollection, settingsCollection];
+  const settingsGlobal = createNewsletterSettingsGlobal(config);
+  let collections = [...incomingConfig.collections || [], subscribersCollection];
   if (config.features?.newsletterScheduling?.enabled) {
     const targetCollections = config.features.newsletterScheduling.collections || "articles";
     const collectionsToExtend = Array.isArray(targetCollections) ? targetCollections : [targetCollections];
@@ -1933,7 +1867,8 @@ var newsletterPlugin = (pluginConfig) => (incomingConfig) => {
     ...incomingConfig,
     collections,
     globals: [
-      ...incomingConfig.globals || []
+      ...incomingConfig.globals || [],
+      settingsGlobal
     ],
     endpoints: [
       ...incomingConfig.endpoints || [],
@@ -1941,16 +1876,9 @@ var newsletterPlugin = (pluginConfig) => (incomingConfig) => {
     ],
     onInit: async (payload) => {
       try {
-        const settingsResult = await payload.find({
-          collection: config.settingsSlug || "newsletter-settings",
-          where: {
-            active: {
-              equals: true
-            }
-          },
-          limit: 1
+        const settings = await payload.findGlobal({
+          slug: config.settingsSlug || "newsletter-settings"
         });
-        const settings = settingsResult.docs[0];
         let emailServiceConfig;
         if (settings) {
           emailServiceConfig = {