Merge pull request #31 from xtr-dev/dev

Fix variables field type to support all JSON-compatible values

CUSTOM-TYPES.md

@@ -38,50 +38,55 @@ const customEmail = await sendEmail<MyEmail>(payload, {
 })
 ```
 
-## ID Type Compatibility
+## Compatibility
 
-The plugin works with both:
+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 type is used. The plugin automatically adapts to your setup.
+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[]
+  cc?: string[] | null
-  bcc?: string[]
+  bcc?: string[] | null
-  from?: string
+  from?: string | null
-  replyTo?: string
+  replyTo?: string | null
   subject: string
   html: string
-  text?: string
+  text?: string | null
-  variables?: Record<string, any>
+  variables?: JSONValue  // Supports any JSON-compatible value
-  scheduledAt?: string
+  scheduledAt?: string | null
-  sentAt?: string
+  sentAt?: string | null
-  status?: 'pending' | 'processing' | 'sent' | 'failed'
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
-  attempts?: number
+  attempts?: number | null
-  lastAttemptAt?: string
+  lastAttemptAt?: string | null
-  error?: string
+  error?: string | null
-  priority?: number
+  priority?: number | null
-  createdAt?: string
+  createdAt?: string | null
-  updatedAt?: string
+  updatedAt?: string | null
 }
 
 interface BaseEmailTemplateDocument {
   id: string | number
   name: string
   slug: string
-  subject?: string
+  subject?: string | null
   content?: any
-  createdAt?: string
+  createdAt?: string | null
-  updatedAt?: string
+  updatedAt?: string | null
 }
 ```
 

package.json

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

src/sendEmail.ts

@@ -83,12 +83,22 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
   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({

src/types/index.ts

@@ -2,38 +2,41 @@ import { Payload } from 'payload'
 import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'
 
-// Generic base interfaces that work with any ID type
+// 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[]
+  cc?: string[] | null
-  bcc?: string[]
+  bcc?: string[] | null
-  from?: string
+  from?: string | null
-  replyTo?: string
+  replyTo?: string | null
   subject: string
   html: string
-  text?: string
+  text?: string | null
-  variables?: Record<string, any>
+  variables?: JSONValue
-  scheduledAt?: string
+  scheduledAt?: string | null
-  sentAt?: string
+  sentAt?: string | null
-  status?: 'pending' | 'processing' | 'sent' | 'failed'
+  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
-  attempts?: number
+  attempts?: number | null
-  lastAttemptAt?: string
+  lastAttemptAt?: string | null
-  error?: string
+  error?: string | null
-  priority?: number
+  priority?: number | null
-  createdAt?: string
+  createdAt?: string | null
-  updatedAt?: string
+  updatedAt?: string | null
 }
 
 export interface BaseEmailTemplateDocument {
   id: string | number
   name: string
   slug: string
-  subject?: string
+  subject?: string | null
   content?: any
-  createdAt?: string
+  createdAt?: string | null
-  updatedAt?: string
+  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}
@@ -75,23 +78,23 @@ export interface MailingTransportConfig {
 
 export interface QueuedEmail {
   id: string
-  template?: string
+  template?: string | null
   to: string[]
-  cc?: string[]
+  cc?: string[] | null
-  bcc?: string[]
+  bcc?: string[] | null
-  from?: string
+  from?: string | null
-  replyTo?: string
+  replyTo?: string | null
   subject: string
   html: string
-  text?: string
+  text?: string | null
-  variables?: Record<string, any>
+  variables?: JSONValue
-  scheduledAt?: string
+  scheduledAt?: string | null
-  sentAt?: string
+  sentAt?: string | null
   status: 'pending' | 'processing' | 'sent' | 'failed'
   attempts: number
-  lastAttemptAt?: string
+  lastAttemptAt?: string | null
-  error?: string
+  error?: string | null
-  priority?: number
+  priority?: number | null
   createdAt: string
   updatedAt: string
 }