Merge pull request #33 from xtr-dev/dev

Dev
Fix scheduledAt type in SendEmailTaskInput and add Date normalization
2025-12-10 08:13:23 +00:00 · 2025-09-13 23:53:56 +02:00 · 2025-09-13 23:53:25 +02:00 · 2025-09-13 23:52:53 +02:00 · 2025-09-13 23:48:28 +02:00 · 2025-09-13 23:45:39 +02:00
9 changed files with 259 additions and 448 deletions
--- a/CUSTOM-TYPES.md
+++ b/CUSTOM-TYPES.md
@@ -0,0 +1,95 @@
+# Using Custom ID Types
+
+The mailing plugin now supports both `string` and `number` ID types. By default, it works with the generic `BaseEmailDocument` interface, but you can provide your own types for full type safety.
+
+## Usage with Your Generated Types
+
+When you have your own generated Payload types (e.g., from `payload generate:types`), you can use them with the mailing plugin:
+
+```typescript
+import { sendEmail, BaseEmailDocument } from '@xtr-dev/payload-mailing'
+import { Email } from './payload-types' // Your generated types
+
+// Option 1: Use your specific Email type
+const email = await sendEmail<Email>(payload, {
+  template: {
+    slug: 'welcome',
+    variables: { name: 'John' }
+  },
+  data: {
+    to: 'user@example.com',
+    // All your custom fields are now type-safe
+  }
+})
+
+// Option 2: Extend BaseEmailDocument for custom fields
+interface MyEmail extends BaseEmailDocument {
+  customField: string
+  anotherField?: number
+}
+
+const customEmail = await sendEmail<MyEmail>(payload, {
+  data: {
+    to: 'user@example.com',
+    subject: 'Hello',
+    html: '<p>Hello World</p>',
+    customField: 'my value', // Type-safe!
+  }
+})
+```
+
+## Compatibility
+
+The plugin works with:
+- **String IDs**: `id: string`
+- **Number IDs**: `id: number`
+- **Nullable fields**: Fields can be `null`, `undefined`, or have values
+- **Date fields**: Timestamp fields support both `Date` objects and `string` (ISO) formats
+- **JSON variables**: Variables field supports any JSON-compatible value type
+- **Generated types**: Works with `payload generate:types` output
+
+Your Payload configuration determines which types are used. The plugin automatically adapts to your setup.
+
+## Type Definitions
+
+The base interfaces provided by the plugin:
+
+```typescript
+// JSON value type that matches Payload's JSON field type
+type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
+
+interface BaseEmailDocument {
+  id: string | number
+  template?: any
+  to: string[]
+  cc?: string[] | null
+  bcc?: string[] | null
+  from?: string | null
+  replyTo?: string | null
+  subject: string
+  html: string
+  text?: string | null
+  variables?: JSONValue  // Supports any JSON-compatible value
+  scheduledAt?: string | Date | null
+  sentAt?: string | Date | null
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
+  attempts?: number | null
+  lastAttemptAt?: string | Date | null
+  error?: string | null
+  priority?: number | null
+  createdAt?: string | Date | null
+  updatedAt?: string | Date | null
+}
+
+interface BaseEmailTemplateDocument {
+  id: string | number
+  name: string
+  slug: string
+  subject?: string | null
+  content?: any
+  createdAt?: string | Date | null
+  updatedAt?: string | Date | null
+}
+```
+
+These provide a foundation that works with any ID type while maintaining type safety for the core email functionality.
--- a/README.md
+++ b/README.md
@@ -139,10 +139,6 @@ mailingPlugin({
  retryDelay: 300000,            // 5 minutes (default)

  // Advanced options
-  emailWrapper: (email) => ({    // optional layout wrapper
-    ...email,
-    html: `<html><body>${email.html}</body></html>`
-  }),
  richTextEditor: lexicalEditor(),  // optional custom editor
  onReady: async (payload) => {     // optional initialization hook
    console.log('Mailing plugin ready!')
@@ -227,7 +223,7 @@ Thanks for joining {{siteName}}. We're excited to have you!

 **What you can do:**
 • Create beautiful emails with rich text formatting
-• Use the emailWrapper hook to add custom layouts  
+  
 • Queue and schedule emails effortlessly

 Your account was created on {{formatDate createdAt "long"}}.
@@ -238,282 +234,6 @@ The {{siteName}} Team

 ## Advanced Features

-### Custom HTML Layouts with Email Wrapper Hook
-
-The `emailWrapper` hook allows you to apply consistent HTML layouts and styling to all emails sent through the plugin. This is perfect for adding company branding, headers, footers, and responsive styling.
-
-#### Basic Email Wrapper
-
-```typescript
-mailingPlugin({
-  // ... other config
-  emailWrapper: (email) => {
-    const wrappedHtml = `
-      <!DOCTYPE html>
-      <html>
-      <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <title>${email.subject}</title>
-        <style>
-          body { font-family: Arial, sans-serif; margin: 0; padding: 20px; background-color: #f4f4f4; }
-          .container { max-width: 600px; margin: 0 auto; background: white; border-radius: 8px; overflow: hidden; }
-          .header { background: #007bff; color: white; padding: 20px; text-align: center; }
-          .content { padding: 30px; line-height: 1.6; }
-          .footer { background: #f8f9fa; padding: 15px; text-align: center; color: #6c757d; font-size: 14px; }
-
-          /* Responsive styles */
-          @media only screen and (max-width: 600px) {
-            .container { margin: 0 10px; }
-            .content { padding: 20px; }
-          }
-        </style>
-      </head>
-      <body>
-        <div class="container">
-          <div class="header">
-            <h1>My Company</h1>
-          </div>
-          <div class="content">
-            ${email.html}
-          </div>
-          <div class="footer">
-            © 2024 My Company. All rights reserved.<br>
-            <a href="#" style="color: #007bff;">Unsubscribe</a> |
-            <a href="#" style="color: #007bff;">Contact Support</a>
-          </div>
-        </div>
-      </body>
-      </html>
-    `
-
-    return {
-      ...email,
-      html: wrappedHtml,
-      text: `MY COMPANY\n\n${email.text}\n\n© 2024 My Company\nUnsubscribe: [link] | Contact Support: [link]`
-    }
-  }
-})
-```
-
-#### Advanced Email Wrapper with Dynamic Content
-
-```typescript
-mailingPlugin({
-  // ... other config
-  emailWrapper: (email) => {
-    // You can access email properties and customize based on content
-    const isTransactional = email.subject?.includes('Receipt') || email.subject?.includes('Confirmation');
-    const headerColor = isTransactional ? '#28a745' : '#007bff';
-    const headerText = isTransactional ? 'Order Confirmation' : 'My Company';
-
-    const wrappedHtml = `
-      <!DOCTYPE html>
-      <html lang="en">
-      <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <meta http-equiv="X-UA-Compatible" content="IE=edge">
-        <title>${email.subject}</title>
-        <!--[if mso]>
-        <noscript>
-          <xml>
-            <o:OfficeDocumentSettings>
-              <o:PixelsPerInch>96</o:PixelsPerInch>
-            </o:OfficeDocumentSettings>
-          </xml>
-        </noscript>
-        <![endif]-->
-        <style>
-          /* Reset styles */
-          body, table, td, a { -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
-          table, td { mso-table-lspace: 0pt; mso-table-rspace: 0pt; }
-          img { -ms-interpolation-mode: bicubic; border: 0; outline: none; text-decoration: none; }
-
-          /* Base styles */
-          body {
-            margin: 0 !important;
-            padding: 0 !important;
-            background-color: #f4f4f4;
-            font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
-          }
-
-          .email-container {
-            max-width: 600px;
-            margin: 0 auto;
-            background-color: #ffffff;
-            border-radius: 8px;
-            overflow: hidden;
-            box-shadow: 0 2px 10px rgba(0,0,0,0.1);
-          }
-
-          .email-header {
-            background: linear-gradient(135deg, ${headerColor}, ${headerColor}dd);
-            color: white;
-            padding: 30px 20px;
-            text-align: center;
-          }
-
-          .email-content {
-            padding: 30px;
-            color: #333333;
-            line-height: 1.6;
-          }
-
-          .email-footer {
-            background-color: #f8f9fa;
-            padding: 20px;
-            text-align: center;
-            color: #6c757d;
-            font-size: 14px;
-            border-top: 1px solid #e9ecef;
-          }
-
-          .email-footer a {
-            color: ${headerColor};
-            text-decoration: none;
-          }
-
-          /* Responsive */
-          @media only screen and (max-width: 600px) {
-            .email-container {
-              margin: 0 10px !important;
-            }
-            .email-header, .email-content {
-              padding: 20px !important;
-            }
-          }
-        </style>
-      </head>
-      <body>
-        <div class="email-container">
-          <div class="email-header">
-            <h1 style="margin: 0; font-size: 24px;">${headerText}</h1>
-          </div>
-          <div class="email-content">
-            ${email.html}
-          </div>
-          <div class="email-footer">
-            <p style="margin: 0 0 10px;">© ${new Date().getFullYear()} My Company. All rights reserved.</p>
-            <p style="margin: 0;">
-              <a href="mailto:support@mycompany.com">Contact Support</a> |
-              <a href="#">Privacy Policy</a> |
-              <a href="#">Unsubscribe</a>
-            </p>
-          </div>
-        </div>
-      </body>
-      </html>
-    `
-
-    // Also enhance the plain text version
-    const wrappedText = `
-${headerText.toUpperCase()}
-${'='.repeat(headerText.length)}
-
-${email.text || email.html?.replace(/<[^>]*>/g, '')}
-
---
-© ${new Date().getFullYear()} My Company. All rights reserved.
-Contact Support: support@mycompany.com
-Privacy Policy: [link]
-Unsubscribe: [link]
-    `.trim();
-
-    return {
-      ...email,
-      html: wrappedHtml,
-      text: wrappedText
-    }
-  }
-})
-```
-
-#### External CSS and Assets
-
-You can also reference external stylesheets and assets:
-
-```typescript
-mailingPlugin({
-  emailWrapper: (email) => {
-    const wrappedHtml = `
-      <!DOCTYPE html>
-      <html>
-      <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <title>${email.subject}</title>
-        <!-- External CSS -->
-        <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" rel="stylesheet">
-        <style>
-          body { font-family: 'Inter', sans-serif; }
-          /* Your custom styles here */
-        </style>
-      </head>
-      <body>
-        <div style="max-width: 600px; margin: 0 auto;">
-          <img src="https://mycompany.com/email-header.png" alt="My Company" style="width: 100%; height: auto;">
-          <div style="padding: 20px;">
-            ${email.html}
-          </div>
-          <img src="https://mycompany.com/email-footer.png" alt="Footer" style="width: 100%; height: auto;">
-        </div>
-      </body>
-      </html>
-    `;
-
-    return { ...email, html: wrappedHtml };
-  }
-})
-```
-
-#### Template-Specific Layouts
-
-You can customize layouts based on email templates:
-
-```typescript
-mailingPlugin({
-  emailWrapper: (email, context) => {
-    // Access template information if available
-    const templateSlug = context?.templateSlug;
-
-    let layoutClass = 'default-layout';
-    let headerColor = '#007bff';
-
-    if (templateSlug === 'welcome-email') {
-      layoutClass = 'welcome-layout';
-      headerColor = '#28a745';
-    } else if (templateSlug === 'invoice-email') {
-      layoutClass = 'invoice-layout';
-      headerColor = '#dc3545';
-    }
-
-    const wrappedHtml = `
-      <!DOCTYPE html>
-      <html>
-      <head>
-        <meta charset="utf-8">
-        <title>${email.subject}</title>
-        <style>
-          .${layoutClass} { /* template-specific styles */ }
-          .header { background-color: ${headerColor}; }
-        </style>
-      </head>
-      <body>
-        <div class="${layoutClass}">
-          ${email.html}
-        </div>
-      </body>
-      </html>
-    `;
-
-    return { ...email, html: wrappedHtml };
-  }
-})
-```
-
-The `emailWrapper` hook receives the email object with `html`, `text`, and `subject` properties, and should return the modified email object with your custom layout applied.
-
 ### Custom Rich Text Editor

 Override the rich text editor used for templates:
--- a/dev/payload.config.ts
+++ b/dev/payload.config.ts
@@ -282,56 +282,6 @@ const buildConfigWithMemoryDB = async () => {
          ],
        }),

-        emailWrapper: (email) => {
-          // Example: wrap email content in a custom layout
-          const wrappedHtml = `
-            <!DOCTYPE html>
-            <html>
-            <head>
-              <meta charset="utf-8">
-              <meta name="viewport" content="width=device-width, initial-scale=1">
-              <title>${email.subject}</title>
-              <style>
-                body { font-family: Arial, sans-serif; margin: 0; padding: 20px; background-color: #f5f5f5; }
-                .container { max-width: 600px; margin: 0 auto; background: white; border-radius: 8px; overflow: hidden; }
-                .header { background: #007bff; color: white; padding: 20px; text-align: center; }
-                .content { padding: 30px; }
-                .footer { background: #f8f9fa; padding: 15px; text-align: center; font-size: 12px; color: #6c757d; }
-              </style>
-            </head>
-            <body>
-              <div class="container">
-                <div class="header">
-                  <h1>My Company</h1>
-                </div>
-                <div class="content">
-                  ${email.html}
-                </div>
-                <div class="footer">
-                  This email was sent from My Company. If you have questions, contact support@mycompany.com
-                </div>
-              </div>
-            </body>
-            </html>
-          `
-
-          const wrappedText = `
-MY COMPANY
-==========
-
-${email.text || email.html?.replace(/<[^>]*>/g, '')}
-
---
-This email was sent from My Company.
-If you have questions, contact support@mycompany.com
-          `
-
-          return {
-            ...email,
-            html: wrappedHtml,
-            text: wrappedText.trim(),
-          }
-        },

        // Called after mailing plugin is fully initialized
        onReady: async (payload) => {
--- a/dev/seed.ts
+++ b/dev/seed.ts
@@ -102,7 +102,7 @@ export const seed = async (payload: Payload) => {
                        format: 0,
                        mode: 'normal',
                        style: '',
-                        text: 'Use the emailWrapper hook to add custom layouts',
+                        text: 'Create beautiful emails with rich text formatting',
                        type: 'text',
                        version: 1,
                      },
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@xtr-dev/payload-mailing",
-  "version": "0.1.8",
+  "version": "0.1.17",
  "description": "Template-based email system with scheduling and job processing for PayloadCMS",
  "type": "module",
  "main": "dist/index.js",
--- a/src/jobs/sendEmailTask.ts
+++ b/src/jobs/sendEmailTask.ts
@@ -1,5 +1,5 @@
 import { sendEmail } from '../sendEmail.js'
-import { Email } from '../payload-types.js'
+import { BaseEmailDocument } from '../types/index.js'

 export interface SendEmailTaskInput {
  // Template mode fields
@@ -15,13 +15,52 @@ export interface SendEmailTaskInput {
  to: string | string[]
  cc?: string | string[]
  bcc?: string | string[]
-  scheduledAt?: string // ISO date string
+  scheduledAt?: string | Date // ISO date string or Date object
  priority?: number

  // Allow any additional fields that users might have in their email collection
  [key: string]: any
 }

+/**
+ * Transforms task input into sendEmail options by separating template and data fields
+ */
+function transformTaskInputToSendEmailOptions(taskInput: SendEmailTaskInput) {
+  const sendEmailOptions: any = {
+    data: {}
+  }
+
+  // If using template mode, set template options
+  if (taskInput.templateSlug) {
+    sendEmailOptions.template = {
+      slug: taskInput.templateSlug,
+      variables: taskInput.variables || {}
+    }
+  }
+
+  // Standard email fields that should be copied to data
+  const standardFields = ['to', 'cc', 'bcc', 'subject', 'html', 'text', 'scheduledAt', 'priority']
+
+  // Template-specific fields that should not be copied to data
+  const templateFields = ['templateSlug', 'variables']
+
+  // Copy standard fields to data
+  standardFields.forEach(field => {
+    if (taskInput[field] !== undefined) {
+      sendEmailOptions.data[field] = taskInput[field]
+    }
+  })
+
+  // Copy any additional custom fields that aren't template or standard fields
+  Object.keys(taskInput).forEach(key => {
+    if (!templateFields.includes(key) && !standardFields.includes(key)) {
+      sendEmailOptions.data[key] = taskInput[key]
+    }
+  })
+
+  return sendEmailOptions
+}
+
 export const sendEmailJob = {
  slug: 'send-email',
  label: 'Send Email',
@@ -116,64 +155,42 @@ export const sendEmailJob = {
      }
    }
  ],
+  outputSchema: [
+    {
+      name: 'id',
+      type: 'text' as const
+    }
+  ],
  handler: async ({ input, payload }: any) => {
    // Cast input to our expected type
    const taskInput = input as SendEmailTaskInput

    try {
-      // Prepare options for sendEmail based on task input
-      const sendEmailOptions: any = {
-        data: {}
-      }
-
-      // If using template mode
-      if (taskInput.templateSlug) {
-        sendEmailOptions.template = {
-          slug: taskInput.templateSlug,
-          variables: taskInput.variables || {}
-        }
-      }
-
-      // Build data object from task input
-      const dataFields = ['to', 'cc', 'bcc', 'subject', 'html', 'text', 'scheduledAt', 'priority']
-      const additionalFields: string[] = []
-
-      // Copy standard fields
-      dataFields.forEach(field => {
-        if (taskInput[field] !== undefined) {
-          sendEmailOptions.data[field] = taskInput[field]
-        }
-      })
-
-      // Copy any additional custom fields
-      Object.keys(taskInput).forEach(key => {
-        if (!['templateSlug', 'variables', ...dataFields].includes(key)) {
-          sendEmailOptions.data[key] = taskInput[key]
-          additionalFields.push(key)
-        }
-      })
+      // Transform task input into sendEmail options using helper function
+      const sendEmailOptions = transformTaskInputToSendEmailOptions(taskInput)

      // Use the sendEmail helper to create the email
-      const email = await sendEmail<Email>(payload, sendEmailOptions)
+      const email = await sendEmail<BaseEmailDocument>(payload, sendEmailOptions)

      return {
        output: {
          success: true,
-          emailId: email.id,
-          message: `Email queued successfully with ID: ${email.id}`,
-          mode: taskInput.templateSlug ? 'template' : 'direct',
-          templateSlug: taskInput.templateSlug || null,
-          subject: email.subject,
-          recipients: Array.isArray(email.to) ? email.to.length : 1,
-          scheduledAt: email.scheduledAt || null
+          id: email.id,
        }
      }

    } catch (error) {
-      const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-      throw new Error(`Failed to queue email: ${errorMessage}`)
+      if (error instanceof Error) {
+        // Preserve original error and stack trace
+        const wrappedError = new Error(`Failed to queue email: ${error.message}`)
+        wrappedError.stack = error.stack
+        wrappedError.cause = error
+        throw wrappedError
+      } else {
+        throw new Error(`Failed to queue email: ${String(error)}`)
+      }
    }
  }
 }

-export default sendEmailJob
+export default sendEmailJob
--- a/src/sendEmail.ts
+++ b/src/sendEmail.ts
@@ -1,9 +1,9 @@
 import { Payload } from 'payload'
 import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
-import {Email} from "./payload-types.js"
+import { BaseEmailDocument } from './types/index.js'

 // Options for sending emails
-export interface SendEmailOptions<T extends Email = Email> {
+export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
  // Template-based email
  template?: {
    slug: string
@@ -35,14 +35,14 @@ export interface SendEmailOptions<T extends Email = Email> {
 * })
 * ```
 */
-export const sendEmail = async <T extends Email = Email>(
+export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocument>(
  payload: Payload,
-  options: SendEmailOptions<T>
-): Promise<T> => {
+  options: SendEmailOptions<TEmail>
+): Promise<TEmail> => {
  const mailing = getMailing(payload)
  const collectionSlug = options.collectionSlug || mailing.collections.emails || 'emails'

-  let emailData: Partial<T> = { ...options.data } as Partial<T>
+  let emailData: Partial<TEmail> = { ...options.data } as Partial<TEmail>

  // If using a template, render it first
  if (options.template) {
@@ -58,7 +58,7 @@ export const sendEmail = async <T extends Email = Email>(
      subject,
      html,
      text,
-    } as Partial<T>
+    } as Partial<TEmail>
  }

  // Validate required fields
@@ -83,12 +83,39 @@ export const sendEmail = async <T extends Email = Email>(
  if (emailData.to) {
    emailData.to = parseAndValidateEmails(emailData.to as string | string[])
  }
-  if (emailData.cc) {
+  if (emailData.cc && emailData.cc !== null) {
    emailData.cc = parseAndValidateEmails(emailData.cc as string | string[])
  }
-  if (emailData.bcc) {
+  if (emailData.bcc && emailData.bcc !== null) {
    emailData.bcc = parseAndValidateEmails(emailData.bcc as string | string[])
  }
+  if (emailData.replyTo && emailData.replyTo !== null) {
+    const validated = parseAndValidateEmails(emailData.replyTo as string | string[])
+    // replyTo should be a single email, so take the first one if array
+    emailData.replyTo = validated && validated.length > 0 ? validated[0] : undefined
+  }
+  if (emailData.from && emailData.from !== null) {
+    const validated = parseAndValidateEmails(emailData.from as string | string[])
+    // from should be a single email, so take the first one if array
+    emailData.from = validated && validated.length > 0 ? validated[0] : undefined
+  }
+
+  // Normalize Date objects to ISO strings for consistent database storage
+  if (emailData.scheduledAt instanceof Date) {
+    emailData.scheduledAt = emailData.scheduledAt.toISOString()
+  }
+  if (emailData.sentAt instanceof Date) {
+    emailData.sentAt = emailData.sentAt.toISOString()
+  }
+  if (emailData.lastAttemptAt instanceof Date) {
+    emailData.lastAttemptAt = emailData.lastAttemptAt.toISOString()
+  }
+  if (emailData.createdAt instanceof Date) {
+    emailData.createdAt = emailData.createdAt.toISOString()
+  }
+  if (emailData.updatedAt instanceof Date) {
+    emailData.updatedAt = emailData.updatedAt.toISOString()
+  }

  // Create the email in the collection with proper typing
  const email = await payload.create({
@@ -96,7 +123,12 @@ export const sendEmail = async <T extends Email = Email>(
    data: emailData
  })

-  return email as T
+  // Validate that the created email has the expected structure
+  if (!email || typeof email !== 'object' || !email.id) {
+    throw new Error('Failed to create email: invalid response from database')
+  }
+
+  return email as TEmail
 }

 export default sendEmail
--- a/src/services/MailingService.ts
+++ b/src/services/MailingService.ts
@@ -5,10 +5,8 @@ import {
  MailingPluginConfig,
  TemplateVariables,
  MailingService as IMailingService,
-  EmailTemplate,
-  QueuedEmail,
  MailingTransportConfig,
-  EmailObject
+  BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
 } from '../types/index.js'
 import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'

@@ -133,7 +131,7 @@ export class MailingService implements IMailingService {
    }

    const emailContent = await this.renderEmailTemplate(template, variables)
-    const subject = await this.renderTemplateString(template.subject, variables)
+    const subject = await this.renderTemplateString(template.subject || '', variables)

    return {
      html: emailContent.html,
@@ -238,10 +236,10 @@ export class MailingService implements IMailingService {
      const email = await this.payload.findByID({
        collection: this.emailsCollection as any,
        id: emailId,
-      }) as QueuedEmail
+      }) as BaseEmailDocument

-      let emailObject: EmailObject = {
-        from: email.from || this.getDefaultFrom(),
+      const mailOptions = {
+        from: email.from,
        to: email.to,
        cc: email.cc || undefined,
        bcc: email.bcc || undefined,
@@ -249,23 +247,6 @@ export class MailingService implements IMailingService {
        subject: email.subject,
        html: email.html,
        text: email.text || undefined,
-        variables: email.variables,
-      }
-
-      // Apply emailWrapper hook if configured
-      if (this.config.emailWrapper) {
-        emailObject = await this.config.emailWrapper(emailObject)
-      }
-
-      const mailOptions = {
-        from: emailObject.from,
-        to: emailObject.to,
-        cc: emailObject.cc || undefined,
-        bcc: emailObject.bcc || undefined,
-        replyTo: emailObject.replyTo || undefined,
-        subject: emailObject.subject,
-        html: emailObject.html,
-        text: emailObject.text || undefined,
      }

      await this.transporter.sendMail(mailOptions)
@@ -304,7 +285,7 @@ export class MailingService implements IMailingService {
    const email = await this.payload.findByID({
      collection: this.emailsCollection as any,
      id: emailId,
-    }) as QueuedEmail
+    }) as BaseEmail

    const newAttempts = (email.attempts || 0) + 1

@@ -319,7 +300,7 @@ export class MailingService implements IMailingService {
    return newAttempts
  }

-  private async getTemplateBySlug(templateSlug: string): Promise<EmailTemplate | null> {
+  private async getTemplateBySlug(templateSlug: string): Promise<BaseEmailTemplateDocument | null> {
    try {
      const { docs } = await this.payload.find({
        collection: this.templatesCollection as any,
@@ -331,7 +312,7 @@ export class MailingService implements IMailingService {
        limit: 1,
      })

-      return docs.length > 0 ? docs[0] as EmailTemplate : null
+      return docs.length > 0 ? docs[0] as BaseEmailTemplateDocument : null
    } catch (error) {
      console.error(`Template with slug '${templateSlug}' not found:`, error)
      return null
@@ -396,7 +377,7 @@ export class MailingService implements IMailingService {
    })
  }

-  private async renderEmailTemplate(template: EmailTemplate, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
+  private async renderEmailTemplate(template: BaseEmailTemplateDocument, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
    if (!template.content) {
      return { html: '', text: '' }
    }
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -1,20 +1,47 @@
 import { Payload } from 'payload'
-import type { CollectionConfig, RichTextField, TypedCollection } from 'payload'
+import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'

-export interface EmailObject {
-  to: string | string[]
-  cc?: string | string[]
-  bcc?: string | string[]
-  from?: string
-  replyTo?: string
+// JSON value type that matches Payload's JSON field type
+export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
+
+// Generic base interfaces that work with any ID type and null values
+export interface BaseEmailDocument {
+  id: string | number
+  template?: any
+  to: string[]
+  cc?: string[] | null
+  bcc?: string[] | null
+  from?: string | null
+  replyTo?: string | null
  subject: string
  html: string
-  text?: string
-  variables?: Record<string, any>
+  text?: string | null
+  variables?: JSONValue
+  scheduledAt?: string | Date | null
+  sentAt?: string | Date | null
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
+  attempts?: number | null
+  lastAttemptAt?: string | Date | null
+  error?: string | null
+  priority?: number | null
+  createdAt?: string | Date | null
+  updatedAt?: string | Date | null
 }

-export type EmailWrapperHook = (email: EmailObject) => EmailObject | Promise<EmailObject>
+export interface BaseEmailTemplateDocument {
+  id: string | number
+  name: string
+  slug: string
+  subject?: string | null
+  content?: any
+  createdAt?: string | Date | null
+  updatedAt?: string | Date | null
+}
+
+export type BaseEmail<TEmail extends BaseEmailDocument = BaseEmailDocument, TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'> | TEmailTemplate['id'] | undefined | null}
+
+export type BaseEmailTemplate<TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmailTemplate, 'id'>

 export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>

@@ -31,7 +58,6 @@ export interface MailingPluginConfig {
  queue?: string
  retryAttempts?: number
  retryDelay?: number
-  emailWrapper?: EmailWrapperHook
  templateRenderer?: TemplateRendererHook
  templateEngine?: TemplateEngine
  richTextEditor?: RichTextField['editor']
@@ -49,36 +75,26 @@ export interface MailingTransportConfig {
  }
 }

-export interface EmailTemplate {
-  id: string
-  name: string
-  slug: string
-  subject: string
-  content: any // Lexical editor state
-  createdAt: string
-  updatedAt: string
-}
-

 export interface QueuedEmail {
  id: string
-  template?: string
+  template?: string | null
  to: string[]
-  cc?: string[]
-  bcc?: string[]
-  from?: string
-  replyTo?: string
+  cc?: string[] | null
+  bcc?: string[] | null
+  from?: string | null
+  replyTo?: string | null
  subject: string
  html: string
-  text?: string
-  variables?: Record<string, any>
-  scheduledAt?: string
-  sentAt?: string
+  text?: string | null
+  variables?: JSONValue
+  scheduledAt?: string | Date | null
+  sentAt?: string | Date | null
  status: 'pending' | 'processing' | 'sent' | 'failed'
  attempts: number
-  lastAttemptAt?: string
-  error?: string
-  priority?: number
+  lastAttemptAt?: string | Date | null
+  error?: string | null
+  priority?: number | null
  createdAt: string
  updatedAt: string
 }
Author	SHA1	Message	Date
Bas	7f04275d39	Merge pull request #33 from xtr-dev/dev Dev	2025-09-13 23:53:56 +02:00
Bas van den Aakster	20afe30e88	Fix scheduledAt type in SendEmailTaskInput and add Date normalization - Update SendEmailTaskInput.scheduledAt to support string \| Date types - Add Date object normalization to ISO strings in sendEmail processing - Ensure consistent database storage format for all timestamp fields - Convert Date objects to ISO strings before database operations Resolves remaining "Type Date is not assignable to type string" error for scheduledAt field in job task input. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:53:25 +02:00
Bas van den Aakster	02b3fecadf	Bump package version to 0.1.17 in `package.json`.	2025-09-13 23:52:53 +02:00
Bas	ea87f14308	Merge pull request #32 from xtr-dev/dev Dev	2025-09-13 23:48:28 +02:00
Bas van den Aakster	6886027727	Bump package version to 0.1.16 in `package.json`.	2025-09-13 23:45:39 +02:00
Bas van den Aakster	965569be06	Add Date type support for timestamp fields - Update scheduledAt, sentAt, lastAttemptAt, createdAt, updatedAt fields to support Date \| string \| null - Support both Date objects and ISO string formats for all timestamp fields - Update BaseEmailDocument, BaseEmailTemplateDocument, and QueuedEmail interfaces consistently - Update documentation to reflect Date object compatibility Fixes type constraint error where customer timestamp fields use Date objects but plugin interfaces only supported string formats. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:44:57 +02:00
Bas	ff788c1ecf	Merge pull request #31 from xtr-dev/dev Fix variables field type to support all JSON-compatible values	2025-09-13 23:41:43 +02:00
Bas van den Aakster	c12438aaa2	Bump package version to 0.1.15 in `package.json`.	2025-09-13 23:40:31 +02:00
Bas van den Aakster	4dcbc1446a	Fix variables field type to support all JSON-compatible values - Replace restrictive Record<string, any> with flexible JSONValue type for variables field - Add JSONValue type alias that matches Payload's JSON field type specification - Support string, number, boolean, objects, arrays, null, and undefined for variables - Update both BaseEmailDocument and QueuedEmail interfaces consistently - Update documentation to reflect JSONValue support Fixes type constraint error where customer Email.variables field type (string \| number \| boolean \| {...} \| unknown[] \| null \| undefined) was not assignable to Record<string, any>. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:38:46 +02:00
Bas	72f3d7f66d	Merge pull request #30 from xtr-dev/dev Add null value support to BaseEmailDocument interface	2025-09-13 23:35:25 +02:00
Bas van den Aakster	ecc0b0a73e	Fix type inconsistencies and missing null checks - Update QueuedEmail interface to include `\| null` for optional fields to match BaseEmailDocument - Add missing null checks for replyTo and from fields in sendEmail processing - Add proper email validation for replyTo and from fields (single email addresses) - Ensure type consistency across all email-related interfaces Fixes potential type conflicts between QueuedEmail and BaseEmailDocument, and ensures all nullable email fields are properly validated. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:32:44 +02:00
Bas van den Aakster	a959673fc1	Bump package version to 0.1.14 in `package.json`.	2025-09-13 23:31:23 +02:00
Bas van den Aakster	8809db6aff	Add null value support to BaseEmailDocument interface - Update BaseEmailDocument to support `\| null` for optional fields (cc, bcc, from, replyTo, text, etc.) - Update BaseEmailTemplateDocument to support `\| null` for optional fields - Add explicit null checks in sendEmail processing to handle null values properly - Update CUSTOM-TYPES.md documentation to reflect null value compatibility Fixes type constraint error where customer Email types had `cc?: string[] \| null` but BaseEmailDocument only supported `cc?: string[]`. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:27:53 +02:00
Bas	5905f732de	Merge pull request #29 from xtr-dev/dev Support custom ID types (string/number) for improved compatibility	2025-09-13 23:24:55 +02:00
Bas van den Aakster	4c495a72b0	Remove duplicate BaseEmailDocument definition - Remove duplicate BaseEmailDocument interface from sendEmail.ts - Import BaseEmailDocument from types/index.ts instead - Update sendEmailTask.ts to import from types/index.ts - Maintain single source of truth for BaseEmailDocument type definition 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:22:23 +02:00
Bas van den Aakster	8518c716e8	Bump package version to 0.1.13 in `package.json`.	2025-09-13 23:21:33 +02:00
Bas van den Aakster	570190be01	Support custom ID types (string/number) for improved compatibility - Replace hardcoded payload-types imports with generic BaseEmailDocument interface - Update sendEmail and sendEmailTask to work with both string and number IDs - Refactor MailingService to use generic document types instead of specific ones - Add BaseEmailDocument and BaseEmailTemplateDocument interfaces supporting id: string \| number - Export BaseEmailDocument for users to extend with their custom fields - Fix TypeScript compilation error in template subject handling - Add CUSTOM-TYPES.md documentation for users with different ID types Fixes compatibility issue where plugin required number IDs but user projects used string IDs. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:18:37 +02:00
Bas	685875d1b9	Merge pull request #28 from xtr-dev/dev Dev	2025-09-13 23:11:16 +02:00
Bas van den Aakster	79044b7bc3	Remove unused BaseEmail imports - Remove BaseEmail import from sendEmail.ts (no longer used after type refactoring) - Remove BaseEmail import from sendEmailTask.ts (no longer used after type refactoring) - BaseEmail types are still used in MailingService.ts for proper type casting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:10:20 +02:00
Bas van den Aakster	e7304fe1a2	Improve type safety, error handling, and code maintainability - Simplify sendEmail generic constraints for better type safety - Add validation before type assertions in sendEmail - Preserve error stack traces in sendEmailTask error handling - Extract field copying logic into reusable helper function - Improve code documentation and separation of concerns 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:06:02 +02:00
Bas van den Aakster	790eedfee7	Bump package version to 0.1.12 in `package.json`.	2025-09-13 23:01:06 +02:00
Bas van den Aakster	9520ec5ed1	Refactor email types for enhanced consistency and type safety - Replace `EmailTemplate` with `BaseEmailTemplate` for stricter type validation. - Update `sendEmail` and `sendEmailTask` to utilize refined `BaseEmail` structure. - Simplify type definitions in `MailingService` and related modules.	2025-09-13 23:00:41 +02:00
Bas	768b70a003	Merge pull request #27 from xtr-dev/dev Align `sendEmail` and `sendEmailTask` with updated `BaseEmail` typing	2025-09-13 22:49:05 +02:00
Bas van den Aakster	e91ab7e54e	Bump package version to 0.1.11 in `package.json`.	2025-09-13 22:48:55 +02:00
Bas van den Aakster	06f9c2cb5b	Align `sendEmail` and `sendEmailTask` with updated `BaseEmail` typing - Refactor `sendEmail` to return extended type with `id` for better type inference. - Update `sendEmailTask` to use `BaseEmail` instead of `Email`. - Add `outputSchema` in `sendEmailTask` for consistent output structure.	2025-09-13 22:46:30 +02:00
Bas	21b22a033a	Merge pull request #26 from xtr-dev/dev Refactor `sendEmail` to improve type safety and align with `BaseEmail…	2025-09-13 22:41:28 +02:00
Bas van den Aakster	6ad90874cf	Refactor `sendEmail` to improve type safety and align with `BaseEmail` interface - Replace `Email` with `BaseEmail` for stricter type validation. - Update `SendEmailOptions` and `sendEmail` typing for improved extensibility.	2025-09-13 22:39:28 +02:00
Bas	03f1f62fbf	Merge pull request #25 from xtr-dev/dev Remove `emailWrapper` hook and all associated references.	2025-09-13 22:34:48 +02:00
Bas van den Aakster	e55e4197d3	Bump package version to 0.1.9 in `package.json`.	2025-09-13 22:32:19 +02:00
Bas van den Aakster	2e6feccf54	Remove `emailWrapper` hook and all associated references. - Simplified email sending logic by dropping custom layout wrapping. - Updated service, config, types, and readme to remove `emailWrapper` usage. - Retained focus on core email functionality while ensuring consistent formatting.	2025-09-13 22:31:05 +02:00