payload-plugin-newsletter 0.14.3 → 0.15.1

package/CHANGELOG.md

@@ -1,3 +1,58 @@
+## [0.15.1] - 2025-07-27
+
+### Fixed
+- **Email-Compatible Block Editor** - Resolved Next.js serialization errors with custom blocks
+  - Custom blocks are now processed server-side using Lexical's proven BlocksFeature pattern
+  - Prevents "Functions cannot be passed directly to Client Components" errors
+  - Maintains full email compatibility while enabling custom block functionality
+- **Block Validation System** - Added validation utilities for email compatibility
+  - `validateEmailBlocks()` warns about potentially incompatible block types
+  - `createEmailSafeBlocks()` processes blocks for email-safe configurations
+  - Automatic detection of complex field types that may not render in email clients
+
+### Improved
+- **Server-Side Block Processing** - Enhanced `createEmailLexicalEditor()` function
+  - Processes custom blocks into Lexical editor configuration before client serialization
+  - Clean separation between email-compatible and web-only content blocks
+  - Better performance through pre-configured editor instances
+- **Enhanced Documentation** - Updated extension points guide with new approach
+  - Examples showing both legacy and new server-side processing methods
+  - Block validation utilities documentation
+  - Email compatibility best practices
+
+### Technical
+- Added `createEmailLexicalEditor()` for server-side editor configuration
+- Enhanced `createEmailContentField()` to accept pre-configured editors
+- New utility exports: `validateEmailBlocks`, `createEmailSafeBlocks`
+- Improved TypeScript support for custom block configurations
+
+## [0.15.0] - 2025-07-27
+
+### Added
+- **Plugin Extensibility System** - New customization API for extending the Broadcasts collection
+  - `additionalFields` - Add custom fields to the Broadcasts collection
+  - `customBlocks` - Extend the email content editor with custom blocks
+  - `fieldOverrides` - Override default field configurations (e.g., content field customization)
+  - Full TypeScript support for all customization options
+- **New Export Paths** for advanced usage
+  - `payload-plugin-newsletter/fields` - Access field factories and configurations
+  - `payload-plugin-newsletter/collections` - Access collection factories
+  - Export `createEmailSafeFeatures` function for custom rich text configurations
+- **Comprehensive Documentation** - New extension points guide with examples and best practices
+  - Email-safe block creation guidelines
+  - TypeScript support documentation
+  - Migration and backward compatibility information
+
+### Improved
+- Enhanced `createEmailContentField` to accept `additionalBlocks` parameter
+- Maintained full backward compatibility with existing installations
+- Added examples for e-commerce, SaaS, and content marketing use cases
+
+### Technical
+- Updated build configuration to include new export paths
+- Added proper TypeScript interfaces for customization options
+- Enhanced field and collection factories for better extensibility
+
 ## [0.14.3] - 2025-07-23
 
 ### Fixed

package/README.md

@@ -725,6 +725,53 @@ newsletterPlugin({
 })
 ```
 
+### Extending the Broadcasts Collection (v0.15.0+)
+
+You can extend the Broadcasts collection with additional fields and custom email-compatible blocks:
+
+```typescript
+import type { Block } from 'payload'
+
+const customBlock: Block = {
+  slug: 'product-spotlight',
+  labels: { singular: 'Product Spotlight', plural: 'Product Spotlights' },
+  fields: [
+    { name: 'product', type: 'relationship', relationTo: 'products', required: true },
+    { name: 'description', type: 'textarea' }
+  ]
+}
+
+newsletterPlugin({
+  // ... existing config
+  customizations: {
+    broadcasts: {
+      additionalFields: [
+        {
+          name: 'slug',
+          type: 'text',
+          required: true,
+          admin: { position: 'sidebar' }
+        }
+      ],
+      customBlocks: [customBlock], // Processed server-side for email compatibility
+      fieldOverrides: {
+        content: (defaultField) => ({
+          ...defaultField,
+          admin: {
+            ...defaultField.admin,
+            description: 'Custom description'
+          }
+        })
+      }
+    }
+  }
+})
+```
+
+**Note**: Custom blocks are processed server-side to ensure email compatibility and prevent Next.js serialization errors.
+
+For complete extensibility documentation, see the [Extension Points Guide](./docs/architecture/extension-points.md).
+
 ## Troubleshooting
 
 ### Common Issues