Merge pull request #31 from xtr-dev/dev

Fix variables field type to support all JSON-compatible values

CUSTOM-TYPES.md

@@ -0,0 +1,93 @@
+# 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
+- **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 | null
+  sentAt?: string | null
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
+  attempts?: number | null
+  lastAttemptAt?: string | null
+  error?: string | null
+  priority?: number | null
+  createdAt?: string | null
+  updatedAt?: string | null
+}
+
+interface BaseEmailTemplateDocument {
+  id: string | number
+  name: string
+  slug: string
+  subject?: string | null
+  content?: any
+  createdAt?: string | null
+  updatedAt?: string | null
+}
+```
+
+These provide a foundation that works with any ID type while maintaining type safety for the core email functionality.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xtr-dev/payload-mailing",
-  "version": "0.1.9",
+  "version": "0.1.15",
   "description": "Template-based email system with scheduling and job processing for PayloadCMS",
   "type": "module",
   "main": "dist/index.js",

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
@@ -22,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',
@@ -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

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,22 @@ 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
+  }
 
   // Create the email in the collection with proper typing
   const email = await payload.create({
@@ -96,7 +106,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

src/services/MailingService.ts

@@ -5,10 +5,8 @@ import {
   MailingPluginConfig,
   TemplateVariables,
   MailingService as IMailingService,
-  EmailTemplate,
-  QueuedEmail,
   MailingTransportConfig,
-  BaseEmail
+  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,7 +236,7 @@ export class MailingService implements IMailingService {
       const email = await this.payload.findByID({
         collection: this.emailsCollection as any,
         id: emailId,
-      }) as BaseEmail
+      }) as BaseEmailDocument
 
       const mailOptions = {
         from: email.from,
@@ -287,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
 
@@ -302,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,
@@ -314,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
@@ -379,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: '' }
     }

src/types/index.ts

@@ -1,9 +1,47 @@
 import { Payload } from 'payload'
 import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'
-import {Email} from "../payload-types.js"
 
-export type BaseEmail<TEmail = Email, TEmailTemplate = EmailTemplate> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'>}
+// 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 | null
+  variables?: JSONValue
+  scheduledAt?: string | null
+  sentAt?: string | null
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
+  attempts?: number | null
+  lastAttemptAt?: string | null
+  error?: string | null
+  priority?: number | null
+  createdAt?: string | null
+  updatedAt?: string | null
+}
+
+export interface BaseEmailTemplateDocument {
+  id: string | number
+  name: string
+  slug: string
+  subject?: string | null
+  content?: any
+  createdAt?: string | null
+  updatedAt?: string | 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>
 
@@ -37,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 | null
+  sentAt?: string | null
   status: 'pending' | 'processing' | 'sent' | 'failed'
   attempts: number
-  lastAttemptAt?: string
-  error?: string
-  priority?: number
+  lastAttemptAt?: string | null
+  error?: string | null
+  priority?: number | null
   createdAt: string
   updatedAt: string
 }