Merge pull request #33 from xtr-dev/dev

Dev

CUSTOM-TYPES.md

@@ -44,6 +44,8 @@ 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.
@@ -53,6 +55,9 @@ Your Payload configuration determines which types are used. The plugin automatic
 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
@@ -64,16 +69,16 @@ interface BaseEmailDocument {
   subject: string
   html: string
   text?: string | null
-  variables?: Record<string, any> | null
+  variables?: JSONValue  // Supports any JSON-compatible value
-  scheduledAt?: string | null
+  scheduledAt?: string | Date | null
-  sentAt?: string | null
+  sentAt?: string | Date | null
   status?: 'pending' | 'processing' | 'sent' | 'failed' | null
   attempts?: number | null
-  lastAttemptAt?: string | null
+  lastAttemptAt?: string | Date | null
   error?: string | null
   priority?: number | null
-  createdAt?: string | null
+  createdAt?: string | Date | null
-  updatedAt?: string | null
+  updatedAt?: string | Date | null
 }
 
 interface BaseEmailTemplateDocument {
@@ -82,8 +87,8 @@ interface BaseEmailTemplateDocument {
   slug: string
   subject?: string | null
   content?: any
-  createdAt?: string | null
+  createdAt?: string | Date | null
-  updatedAt?: string | null
+  updatedAt?: string | Date | null
 }
 ```
 

package.json

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

src/jobs/sendEmailTask.ts

@@ -15,7 +15,7 @@ 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

src/sendEmail.ts

@@ -100,6 +100,23 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
     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({
     collection: collectionSlug,

src/types/index.ts

@@ -2,6 +2,9 @@ import { Payload } from 'payload'
 import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'
 
+// 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
@@ -14,16 +17,16 @@ export interface BaseEmailDocument {
   subject: string
   html: string
   text?: string | null
-  variables?: Record<string, any> | null
+  variables?: JSONValue
-  scheduledAt?: string | null
+  scheduledAt?: string | Date | null
-  sentAt?: string | null
+  sentAt?: string | Date | null
   status?: 'pending' | 'processing' | 'sent' | 'failed' | null
   attempts?: number | null
-  lastAttemptAt?: string | null
+  lastAttemptAt?: string | Date | null
   error?: string | null
   priority?: number | null
-  createdAt?: string | null
+  createdAt?: string | Date | null
-  updatedAt?: string | null
+  updatedAt?: string | Date | null
 }
 
 export interface BaseEmailTemplateDocument {
@@ -32,8 +35,8 @@ export interface BaseEmailTemplateDocument {
   slug: string
   subject?: string | null
   content?: any
-  createdAt?: string | null
+  createdAt?: string | Date | null
-  updatedAt?: string | 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}
@@ -84,12 +87,12 @@ export interface QueuedEmail {
   subject: string
   html: string
   text?: string | null
-  variables?: Record<string, any> | null
+  variables?: JSONValue
-  scheduledAt?: string | null
+  scheduledAt?: string | Date | null
-  sentAt?: string | null
+  sentAt?: string | Date | null
   status: 'pending' | 'processing' | 'sent' | 'failed'
   attempts: number
-  lastAttemptAt?: string | null
+  lastAttemptAt?: string | Date | null
   error?: string | null
   priority?: number | null
   createdAt: string