Merge pull request #29 from xtr-dev/dev

Support custom ID types (string/number) for improved compatibility
Remove duplicate BaseEmailDocument definition
2025-12-10 08:13:23 +00:00 · 2025-09-13 23:24:55 +02:00 · 2025-09-13 23:22:23 +02:00 · 2025-09-13 23:21:33 +02:00 · 2025-09-13 23:18:37 +02:00 · 2025-09-13 23:11:16 +02:00
15 changed files with 783 additions and 488 deletions
--- a/CUSTOM-TYPES.md
+++ b/CUSTOM-TYPES.md
@@ -0,0 +1,88 @@
 # 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!
  }
 })
 ```
 ## ID Type Compatibility
 The plugin works with both:
 - **String IDs**: `id: string`
 - **Number IDs**: `id: number`
 Your Payload configuration determines which type is used. The plugin automatically adapts to your setup.
 ## Type Definitions
 The base interfaces provided by the plugin:
 ```typescript
 interface BaseEmailDocument {
  id: string | number
  template?: any
  to: string[]
  cc?: string[]
  bcc?: string[]
  from?: string
  replyTo?: string
  subject: string
  html: string
  text?: string
  variables?: Record<string, any>
  scheduledAt?: string
  sentAt?: string
  status?: 'pending' | 'processing' | 'sent' | 'failed'
  attempts?: number
  lastAttemptAt?: string
  error?: string
  priority?: number
  createdAt?: string
  updatedAt?: string
 }
 interface BaseEmailTemplateDocument {
  id: string | number
  name: string
  slug: string
  subject?: string
  content?: any
  createdAt?: string
  updatedAt?: string
 }
 ```
 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-types.ts
+++ b/dev/payload-types.ts
@@ -100,7 +100,8 @@ export interface Config {
  };
  jobs: {
    tasks: {
-      'process-email-queue': ProcessEmailQueueJob;
+      processEmails: ProcessEmailsJob;
      'send-email': TaskSendEmail;
      inline: {
        input: unknown;
        output: unknown;
@@ -232,21 +233,17 @@ export interface Email {
   */
  template?: (string | null) | EmailTemplate;
  /**
-   * Template slug used for this email
+   * Recipient email addresses
   */
-  templateSlug?: string | null;
+  to: string[];
  /**
-   * Recipient email address(es), comma-separated
+   * CC email addresses
   */
-  to: string;
+  cc?: string[] | null;
  /**
-   * CC email address(es), comma-separated
+   * BCC email addresses
   */
-  cc?: string | null;
+  bcc?: string[] | null;
  /**
   * BCC email address(es), comma-separated
   */
  bcc?: string | null;
  /**
   * Sender email address (optional, uses default if not provided)
   */
@@ -362,7 +359,7 @@ export interface PayloadJob {
    | {
        executedAt: string;
        completedAt: string;
-        taskSlug: 'inline' | 'process-email-queue';
+        taskSlug: 'inline' | 'processEmails' | 'send-email';
        taskID: string;
        input?:
          | {
@@ -395,7 +392,7 @@ export interface PayloadJob {
        id?: string | null;
      }[]
    | null;
-  taskSlug?: ('inline' | 'process-email-queue') | null;
+  taskSlug?: ('inline' | 'processEmails' | 'send-email') | null;
  queue?: string | null;
  waitUntil?: string | null;
  processing?: boolean | null;
@@ -542,7 +539,6 @@ export interface EmailTemplatesSelect<T extends boolean = true> {
 */
 export interface EmailsSelect<T extends boolean = true> {
  template?: T;
  templateSlug?: T;
  to?: T;
  cc?: T;
  bcc?: T;
@@ -627,12 +623,69 @@ export interface PayloadMigrationsSelect<T extends boolean = true> {
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
- * via the `definition` "ProcessEmailQueueJob".
+ * via the `definition` "ProcessEmailsJob".
 */
-export interface ProcessEmailQueueJob {
+export interface ProcessEmailsJob {
  input?: unknown;
  output?: unknown;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "TaskSend-email".
 */
 export interface TaskSendEmail {
  input: {
    /**
     * Use a template (leave empty for direct email)
     */
    templateSlug?: string | null;
    /**
     * JSON object with variables for template rendering
     */
    variables?:
      | {
          [k: string]: unknown;
        }
      | unknown[]
      | string
      | number
      | boolean
      | null;
    /**
     * Email subject (required if not using template)
     */
    subject?: string | null;
    /**
     * HTML email content (required if not using template)
     */
    html?: string | null;
    /**
     * Plain text email content (optional)
     */
    text?: string | null;
    /**
     * Comma-separated list of email addresses
     */
    to: string;
    /**
     * Optional comma-separated list of CC email addresses
     */
    cc?: string | null;
    /**
     * Optional comma-separated list of BCC email addresses
     */
    bcc?: string | null;
    /**
     * Optional date/time to schedule email for future delivery
     */
    scheduledAt?: string | null;
    /**
     * Email priority (1 = highest, 10 = lowest)
     */
    priority?: number | null;
  };
  output?: unknown;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "auth".
--- a/dev/payload.config.ts
+++ b/dev/payload.config.ts
@@ -1,12 +1,10 @@
 import { mongooseAdapter } from '@payloadcms/db-mongodb'
 import { lexicalEditor } from '@payloadcms/richtext-lexical'
 import {
  BlocksFeature,
  FixedToolbarFeature,
  HeadingFeature,
  HorizontalRuleFeature,
  InlineToolbarFeature,
  lexicalHTML,
 } from '@payloadcms/richtext-lexical'
 import { MongoMemoryReplSet } from 'mongodb-memory-server'
 import path from 'path'
@@ -17,7 +15,7 @@ import { fileURLToPath } from 'url'
 import { testEmailAdapter } from './helpers/testEmailAdapter.js'
 import { seed, seedUser } from './seed.js'
 import mailingPlugin from "../src/plugin.js"
-import { sendEmail } from "../src/utils/helpers.js"
+import {sendEmail} from "@xtr-dev/payload-mailing"
 const filename = fileURLToPath(import.meta.url)
 const dirname = path.dirname(filename)
@@ -85,15 +83,19 @@ const buildConfigWithMemoryDB = async () => {
                  // Queue the welcome email using template slug
                  const emailId = await sendEmail(req.payload, {
-                    templateSlug: 'welcome-email',
+                    template: {
-                    to: doc.email,
+                      slug: 'welcome-email',
-                    variables: {
+                      variables: {
-                      firstName: doc.firstName || doc.email?.split('@')?.[0],
+                        firstName: doc.firstName || doc.email?.split('@')?.[0],
-                      siteName: 'PayloadCMS Mailing Demo',
+                        siteName: 'PayloadCMS Mailing Demo',
-                      createdAt: new Date().toISOString(),
+                        createdAt: new Date().toISOString(),
-                      isPremium: false,
+                        isPremium: false,
-                      dashboardUrl: 'http://localhost:3000/admin',
+                        dashboardUrl: 'http://localhost:3000/admin',
                      },
                    },
                    data: {
                      to: doc.email,
                    }
                  })
                  console.log('✅ Welcome email queued successfully. Email ID:', emailId)
@@ -280,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/dev/tsconfig.json
+++ b/dev/tsconfig.json
@@ -19,13 +19,13 @@
      "@payload-config": [
        "./payload.config.ts"
      ],
-      "temp-project": [
+      "@xtr-dev/payload-mailing": [
        "../src/index.ts"
      ],
-      "temp-project/client": [
+      "@xtr-dev/payload-mailing/client": [
        "../src/exports/client.ts"
      ],
-      "temp-project/rsc": [
+      "@xtr-dev/payload-mailing/rsc": [
        "../src/exports/rsc.ts"
      ]
    },
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@xtr-dev/payload-mailing",
-  "version": "0.1.7",
+  "version": "0.1.13",
  "description": "Template-based email system with scheduling and job processing for PayloadCMS",
  "type": "module",
  "main": "dist/index.js",
@@ -23,8 +23,9 @@
    "dev:generate-importmap": "npm run dev:payload generate:importmap",
    "dev:generate-types": "npm run dev:payload generate:types",
    "dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
-    "generate:importmap": "npm run dev:generate-importmap",
+    "payload": "cross-env NODE_OPTIONS=--no-deprecation payload",
-    "generate:types": "npm run dev:generate-types",
+    "generate:importmap": "npm run payload generate:importmap",
    "generate:types": "npm run payload generate:types",
    "lint": "eslint",
    "lint:fix": "eslint ./src --fix",
    "prepublishOnly": "npm run clean && npm run build",
--- a/payload.config.ts
+++ b/payload.config.ts
@@ -0,0 +1,31 @@
 /**
 * This config is only used to generate types.
 */
 import { BaseDatabaseAdapter, buildConfig, Payload} from 'payload'
 import Emails from "./src/collections/Emails.js"
 import {createEmailTemplatesCollection} from "./src/collections/EmailTemplates.js"
 import path from "path"
 import { fileURLToPath } from 'url'
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 export default buildConfig({
  collections: [
    Emails,
    createEmailTemplatesCollection()
  ],
  db: {
    allowIDOnCreate: undefined,
    defaultIDType: 'number',
    init: function (args: { payload: Payload; }): BaseDatabaseAdapter {
      throw new Error('Function not implemented.');
    },
    name: undefined
  },
  secret: '',
  typescript: {
    outputFile: path.resolve(__dirname, 'src/payload-types.ts'),
  }
 });
--- a/src/index.ts
+++ b/src/index.ts
@@ -16,7 +16,7 @@ export { mailingJobs, sendEmailJob } from './jobs/index.js'
 export type { SendEmailTaskInput } from './jobs/sendEmailTask.js'
 // Main email sending function
-export { sendEmail, type BaseEmailData, type SendEmailOptions } from './sendEmail.js'
+export { sendEmail, type SendEmailOptions } from './sendEmail.js'
 export { default as sendEmailDefault } from './sendEmail.js'
 // Utility functions for developers
--- a/src/jobs/sendEmailTask.ts
+++ b/src/jobs/sendEmailTask.ts
@@ -1,4 +1,5 @@
-import { sendEmail, type BaseEmailData } from '../sendEmail.js'
+import { sendEmail } from '../sendEmail.js'
 import { BaseEmailDocument } from '../types/index.js'
 export interface SendEmailTaskInput {
  // Template mode fields
@@ -21,6 +22,45 @@ export interface SendEmailTaskInput {
  [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',
@@ -115,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
+      // Transform task input into sendEmail options using helper function
-      const sendEmailOptions: any = {
+      const sendEmailOptions = transformTaskInputToSendEmailOptions(taskInput)
        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)
        }
      })
      // Use the sendEmail helper to create the email
-      const email = await sendEmail<BaseEmailData>(payload, sendEmailOptions)
+      const email = await sendEmail<BaseEmailDocument>(payload, sendEmailOptions)
      return {
        output: {
          success: true,
-          emailId: email.id,
+          id: 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
        }
      }
    } catch (error) {
-      const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+      if (error instanceof Error) {
-      throw new Error(`Failed to queue email: ${errorMessage}`)
+        // 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/payload-types.ts
+++ b/src/payload-types.ts
@@ -0,0 +1,431 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
 * This file was automatically generated by Payload.
 * DO NOT MODIFY IT BY HAND. Instead, modify your source Payload config,
 * and re-run `payload generate:types` to regenerate this file.
 */
 /**
 * Supported timezones in IANA format.
 *
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "supportedTimezones".
 */
 export type SupportedTimezones =
  | 'Pacific/Midway'
  | 'Pacific/Niue'
  | 'Pacific/Honolulu'
  | 'Pacific/Rarotonga'
  | 'America/Anchorage'
  | 'Pacific/Gambier'
  | 'America/Los_Angeles'
  | 'America/Tijuana'
  | 'America/Denver'
  | 'America/Phoenix'
  | 'America/Chicago'
  | 'America/Guatemala'
  | 'America/New_York'
  | 'America/Bogota'
  | 'America/Caracas'
  | 'America/Santiago'
  | 'America/Buenos_Aires'
  | 'America/Sao_Paulo'
  | 'Atlantic/South_Georgia'
  | 'Atlantic/Azores'
  | 'Atlantic/Cape_Verde'
  | 'Europe/London'
  | 'Europe/Berlin'
  | 'Africa/Lagos'
  | 'Europe/Athens'
  | 'Africa/Cairo'
  | 'Europe/Moscow'
  | 'Asia/Riyadh'
  | 'Asia/Dubai'
  | 'Asia/Baku'
  | 'Asia/Karachi'
  | 'Asia/Tashkent'
  | 'Asia/Calcutta'
  | 'Asia/Dhaka'
  | 'Asia/Almaty'
  | 'Asia/Jakarta'
  | 'Asia/Bangkok'
  | 'Asia/Shanghai'
  | 'Asia/Singapore'
  | 'Asia/Tokyo'
  | 'Asia/Seoul'
  | 'Australia/Brisbane'
  | 'Australia/Sydney'
  | 'Pacific/Guam'
  | 'Pacific/Noumea'
  | 'Pacific/Auckland'
  | 'Pacific/Fiji';
 export interface Config {
  auth: {
    users: UserAuthOperations;
  };
  blocks: {};
  collections: {
    emails: Email;
    'email-templates': EmailTemplate;
    users: User;
    'payload-locked-documents': PayloadLockedDocument;
    'payload-preferences': PayloadPreference;
    'payload-migrations': PayloadMigration;
  };
  collectionsJoins: {};
  collectionsSelect: {
    emails: EmailsSelect<false> | EmailsSelect<true>;
    'email-templates': EmailTemplatesSelect<false> | EmailTemplatesSelect<true>;
    users: UsersSelect<false> | UsersSelect<true>;
    'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
    'payload-preferences': PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>;
    'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
  };
  db: {
    defaultIDType: number;
  };
  globals: {};
  globalsSelect: {};
  locale: null;
  user: User & {
    collection: 'users';
  };
  jobs: {
    tasks: unknown;
    workflows: unknown;
  };
 }
 export interface UserAuthOperations {
  forgotPassword: {
    email: string;
    password: string;
  };
  login: {
    email: string;
    password: string;
  };
  registerFirstUser: {
    email: string;
    password: string;
  };
  unlock: {
    email: string;
    password: string;
  };
 }
 /**
 * Email delivery and status tracking
 *
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "emails".
 */
 export interface Email {
  id: number;
  /**
   * Email template used (optional if custom content provided)
   */
  template?: (number | null) | EmailTemplate;
  /**
   * Recipient email addresses
   */
  to: string[];
  /**
   * CC email addresses
   */
  cc?: string[] | null;
  /**
   * BCC email addresses
   */
  bcc?: string[] | null;
  /**
   * Sender email address (optional, uses default if not provided)
   */
  from?: string | null;
  /**
   * Reply-to email address
   */
  replyTo?: string | null;
  /**
   * Email subject line
   */
  subject: string;
  /**
   * Rendered HTML content of the email
   */
  html: string;
  /**
   * Plain text version of the email
   */
  text?: string | null;
  /**
   * Template variables used to render this email
   */
  variables?:
    | {
        [k: string]: unknown;
      }
    | unknown[]
    | string
    | number
    | boolean
    | null;
  /**
   * When this email should be sent (leave empty for immediate)
   */
  scheduledAt?: string | null;
  /**
   * When this email was actually sent
   */
  sentAt?: string | null;
  /**
   * Current status of this email
   */
  status: 'pending' | 'processing' | 'sent' | 'failed';
  /**
   * Number of send attempts made
   */
  attempts?: number | null;
  /**
   * When the last send attempt was made
   */
  lastAttemptAt?: string | null;
  /**
   * Last error message if send failed
   */
  error?: string | null;
  /**
   * Email priority (1=highest, 10=lowest)
   */
  priority?: number | null;
  updatedAt: string;
  createdAt: string;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "email-templates".
 */
 export interface EmailTemplate {
  id: number;
  /**
   * A descriptive name for this email template
   */
  name: string;
  /**
   * Unique identifier for this template (e.g., "welcome-email", "password-reset")
   */
  slug: string;
  /**
   * Email subject line. You can use Handlebars variables like {{firstName}} or {{siteName}}.
   */
  subject: string;
  /**
   * Email content with rich text formatting. Supports Handlebars variables like {{firstName}} and helpers like {{formatDate createdAt "long"}}. Content is converted to HTML and plain text automatically.
   */
  content: {
    root: {
      type: string;
      children: {
        type: string;
        version: number;
        [k: string]: unknown;
      }[];
      direction: ('ltr' | 'rtl') | null;
      format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
      indent: number;
      version: number;
    };
    [k: string]: unknown;
  };
  updatedAt: string;
  createdAt: string;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "users".
 */
 export interface User {
  id: number;
  updatedAt: string;
  createdAt: string;
  email: string;
  resetPasswordToken?: string | null;
  resetPasswordExpiration?: string | null;
  salt?: string | null;
  hash?: string | null;
  loginAttempts?: number | null;
  lockUntil?: string | null;
  sessions?:
    | {
        id: string;
        createdAt?: string | null;
        expiresAt: string;
      }[]
    | null;
  password?: string | null;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-locked-documents".
 */
 export interface PayloadLockedDocument {
  id: number;
  document?:
    | ({
        relationTo: 'emails';
        value: number | Email;
      } | null)
    | ({
        relationTo: 'email-templates';
        value: number | EmailTemplate;
      } | null)
    | ({
        relationTo: 'users';
        value: number | User;
      } | null);
  globalSlug?: string | null;
  user: {
    relationTo: 'users';
    value: number | User;
  };
  updatedAt: string;
  createdAt: string;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-preferences".
 */
 export interface PayloadPreference {
  id: number;
  user: {
    relationTo: 'users';
    value: number | User;
  };
  key?: string | null;
  value?:
    | {
        [k: string]: unknown;
      }
    | unknown[]
    | string
    | number
    | boolean
    | null;
  updatedAt: string;
  createdAt: string;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-migrations".
 */
 export interface PayloadMigration {
  id: number;
  name?: string | null;
  batch?: number | null;
  updatedAt: string;
  createdAt: string;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "emails_select".
 */
 export interface EmailsSelect<T extends boolean = true> {
  template?: T;
  to?: T;
  cc?: T;
  bcc?: T;
  from?: T;
  replyTo?: T;
  subject?: T;
  html?: T;
  text?: T;
  variables?: T;
  scheduledAt?: T;
  sentAt?: T;
  status?: T;
  attempts?: T;
  lastAttemptAt?: T;
  error?: T;
  priority?: T;
  updatedAt?: T;
  createdAt?: T;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "email-templates_select".
 */
 export interface EmailTemplatesSelect<T extends boolean = true> {
  name?: T;
  slug?: T;
  subject?: T;
  content?: T;
  updatedAt?: T;
  createdAt?: T;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "users_select".
 */
 export interface UsersSelect<T extends boolean = true> {
  updatedAt?: T;
  createdAt?: T;
  email?: T;
  resetPasswordToken?: T;
  resetPasswordExpiration?: T;
  salt?: T;
  hash?: T;
  loginAttempts?: T;
  lockUntil?: T;
  sessions?:
    | T
    | {
        id?: T;
        createdAt?: T;
        expiresAt?: T;
      };
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-locked-documents_select".
 */
 export interface PayloadLockedDocumentsSelect<T extends boolean = true> {
  document?: T;
  globalSlug?: T;
  user?: T;
  updatedAt?: T;
  createdAt?: T;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-preferences_select".
 */
 export interface PayloadPreferencesSelect<T extends boolean = true> {
  user?: T;
  key?: T;
  value?: T;
  updatedAt?: T;
  createdAt?: T;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "payload-migrations_select".
 */
 export interface PayloadMigrationsSelect<T extends boolean = true> {
  name?: T;
  batch?: T;
  updatedAt?: T;
  createdAt?: T;
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "auth".
 */
 export interface Auth {
  [k: string]: unknown;
 }
 declare module 'payload' {
  export interface GeneratedTypes extends Config {}
 }
--- a/src/sendEmail.ts
+++ b/src/sendEmail.ts
@@ -1,22 +1,9 @@
 import { Payload } from 'payload'
 import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
-
+import { BaseEmailDocument } from './types/index.js'
 // Base type for email data that all emails must have
 // Compatible with PayloadCMS generated types that include null
 export interface BaseEmailData {
  to: string | string[]
  cc?: string | string[] | null
  bcc?: string | string[] | null
  subject?: string | null
  html?: string | null
  text?: string | null
  scheduledAt?: string | Date | null
  priority?: number | null
  [key: string]: any
 }
 // Options for sending emails
-export interface SendEmailOptions<T extends BaseEmailData = BaseEmailData> {
+export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
  // Template-based email
  template?: {
    slug: string
@@ -48,14 +35,14 @@ export interface SendEmailOptions<T extends BaseEmailData = BaseEmailData> {
 * })
 * ```
 */
-export const sendEmail = async <T extends BaseEmailData = BaseEmailData>(
+export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocument>(
  payload: Payload,
-  options: SendEmailOptions<T>
+  options: SendEmailOptions<TEmail>
-): Promise<T> => {
+): 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) {
@@ -71,7 +58,7 @@ export const sendEmail = async <T extends BaseEmailData = BaseEmailData>(
      subject,
      html,
      text,
-    } as Partial<T>
+    } as Partial<TEmail>
  }
  // Validate required fields
@@ -79,8 +66,17 @@ export const sendEmail = async <T extends BaseEmailData = BaseEmailData>(
    throw new Error('Field "to" is required for sending emails')
  }
-  if (!emailData.subject || !emailData.html) {
+  // Validate required fields based on whether template was used
-    throw new Error('Fields "subject" and "html" are required when not using a template')
+  if (options.template) {
    // When using template, subject and html should have been set by renderTemplate
    if (!emailData.subject || !emailData.html) {
      throw new Error(`Template rendering failed: template "${options.template.slug}" did not provide required subject and html content`)
    }
  } else {
    // When not using template, user must provide subject and html directly
    if (!emailData.subject || !emailData.html) {
      throw new Error('Fields "subject" and "html" are required when sending direct emails without a template')
    }
  }
  // Process email addresses using shared validation (handle null values)
@@ -94,18 +90,18 @@ export const sendEmail = async <T extends BaseEmailData = BaseEmailData>(
    emailData.bcc = parseAndValidateEmails(emailData.bcc as string | string[])
  }
-  // Convert scheduledAt to ISO string if it's a Date
+  // Create the email in the collection with proper typing
  if (emailData.scheduledAt instanceof Date) {
    emailData.scheduledAt = emailData.scheduledAt.toISOString()
  }
  // Create the email in the collection
  const email = await payload.create({
-    collection: collectionSlug as any,
+    collection: collectionSlug,
-    data: emailData as any
+    data: emailData
  })
-  return email as unknown 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 = {
+      const mailOptions = {
-        from: email.from || this.getDefaultFrom(),
+        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,44 @@
 import { Payload } from 'payload'
-import type { CollectionConfig, RichTextField, TypedCollection } from 'payload'
+import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'
-export interface EmailObject {
+// Generic base interfaces that work with any ID type
-  to: string | string[]
+export interface BaseEmailDocument {
-  cc?: string | string[]
+  id: string | number
-  bcc?: string | string[]
+  template?: any
  to: string[]
  cc?: string[]
  bcc?: string[]
  from?: string
  replyTo?: string
  subject: string
  html: string
  text?: string
  variables?: Record<string, any>
  scheduledAt?: string
  sentAt?: string
  status?: 'pending' | 'processing' | 'sent' | 'failed'
  attempts?: number
  lastAttemptAt?: string
  error?: string
  priority?: number
  createdAt?: string
  updatedAt?: string
 }
-export type EmailWrapperHook = (email: EmailObject) => EmailObject | Promise<EmailObject>
+export interface BaseEmailTemplateDocument {
  id: string | number
  name: string
  slug: string
  subject?: string
  content?: any
  createdAt?: string
  updatedAt?: string
 }
 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 +55,6 @@ export interface MailingPluginConfig {
  queue?: string
  retryAttempts?: number
  retryDelay?: number
  emailWrapper?: EmailWrapperHook
  templateRenderer?: TemplateRendererHook
  templateEngine?: TemplateEngine
  richTextEditor?: RichTextField['editor']
@@ -49,16 +72,6 @@ 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
--- a/src/utils/helpers.ts
+++ b/src/utils/helpers.ts
@@ -15,9 +15,20 @@ export const parseAndValidateEmails = (emails: string | string[] | null | undefi
    emailList = emails.split(',').map(email => email.trim()).filter(Boolean)
  }
-  // Basic email validation
+  // RFC 5322 compliant email validation
-  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/
+  const emailRegex = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
-  const invalidEmails = emailList.filter(email => !emailRegex.test(email))
+  const invalidEmails = emailList.filter(email => {
    // Check basic format
    if (!emailRegex.test(email)) return true
    // Check for common invalid patterns
    if (email.includes('..') || email.startsWith('.') || email.endsWith('.')) return true
    if (email.includes('@.') || email.includes('.@')) return true
    // Check domain has at least one dot
    const parts = email.split('@')
    if (parts.length !== 2 || !parts[1].includes('.')) return true
    return false
  })
  if (invalidEmails.length > 0) {
    throw new Error(`Invalid email addresses: ${invalidEmails.join(', ')}`)
  }
Author	SHA1	Message	Date
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
Bas	e38b63d814	Merge pull request #24 from xtr-dev/dev Dev	2025-09-13 22:00:51 +02:00
Bas van den Aakster	31721dc110	Add comment to clarify purpose of `payload.config.ts`	2025-09-13 22:00:29 +02:00
Bas van den Aakster	6e4f754306	Fix critical type safety and validation issues Issue 2 - Type Safety: - Remove dangerous 'as any' casts in sendEmail function - Use proper typing for payload.create() calls - Maintain type safety throughout email creation process Issue 3 - Email Validation: - Implement RFC 5322 compliant email regex - Add comprehensive validation for common invalid patterns - Check for consecutive dots, invalid domain formats - Prevent emails like 'test@.com' and 'test@domain.' Issue 4 - Error Message Logic: - Add contextual error messages for template vs direct email modes - Distinguish between template rendering failures and missing direct email content - Provide clearer guidance to developers on what went wrong Additional fixes: - Update imports to use generated Email type instead of BaseEmailData - Maintain compatibility with updated sendEmail interface 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 21:57:02 +02:00
Bas van den Aakster	45559804b0	Refactor email handling for improved type safety and extensibility - Replace `BaseEmailData` with `Email` type for stricter type validation - Update `sendEmail` API to support new typed structure and template integration - Migrate to `@xtr-dev/payload-mailing` for enhanced email sending capabilities - Remove unnecessary null checks and redundant code in email scheduling logic - Regenerate PayloadCMS types for aligning with revised schema changes - Update dev scripts and imports for seamless compatibility with the new email module	2025-09-13 21:51:52 +02:00
Bas van den Aakster	934b7c2de7	Fix ES module __dirname error in payload config Resolves: ReferenceError: __dirname is not defined in ES module scope - Import fileURLToPath from 'url' module - Create __filename and __dirname using ES module pattern - Maintains compatibility with TypeScript output file path resolution 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 21:50:05 +02:00