Merge pull request #68 from xtr-dev/dev

Fix filterOptions ObjectId casting error and bump version to 0.4.20

package.json

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

src/services/MailingService.ts

@@ -1,10 +1,10 @@
-import {CollectionSlug, EmailAdapter, Payload, SendEmailOptions} from 'payload'
+import { Payload } from 'payload'
 import { Liquid } from 'liquidjs'
 import {
   MailingPluginConfig,
   TemplateVariables,
   MailingService as IMailingService,
-  BaseEmailDocument, BaseEmailTemplateDocument
+  BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
 } from '../types/index.js'
 import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
 import { sanitizeDisplayName } from '../utils/helpers.js'
@@ -12,6 +12,7 @@ import { sanitizeDisplayName } from '../utils/helpers.js'
 export class MailingService implements IMailingService {
   public payload: Payload
   private config: MailingPluginConfig
+  private emailAdapter: any
   private templatesCollection: string
   private emailsCollection: string
   private liquid: Liquid | null | false = null
@@ -30,13 +31,14 @@ export class MailingService implements IMailingService {
     if (!this.payload.email) {
       throw new Error('Payload email configuration is required. Please configure email in your Payload config.')
     }
+    this.emailAdapter = this.payload.email
   }
 
   private ensureInitialized(): void {
     if (!this.payload || !this.payload.db) {
       throw new Error('MailingService payload not properly initialized')
     }
-    if (!this.payload.email) {
+    if (!this.emailAdapter) {
       throw new Error('Email adapter not configured. Please ensure Payload has email configured.')
     }
   }
@@ -151,7 +153,7 @@ export class MailingService implements IMailingService {
     const currentTime = new Date().toISOString()
 
     const { docs: pendingEmails } = await this.payload.find({
-      collection: this.emailsCollection as CollectionSlug,
+      collection: this.emailsCollection as any,
       where: {
         and: [
           {
@@ -191,7 +193,7 @@ export class MailingService implements IMailingService {
     const retryTime = new Date(Date.now() - retryDelay).toISOString()
 
     const { docs: failedEmails } = await this.payload.find({
-      collection: this.emailsCollection as CollectionSlug,
+      collection: this.emailsCollection as any,
       where: {
         and: [
           {
@@ -231,7 +233,7 @@ export class MailingService implements IMailingService {
   async processEmailItem(emailId: string): Promise<void> {
     try {
       await this.payload.update({
-        collection: this.emailsCollection as CollectionSlug,
+        collection: this.emailsCollection as any,
         id: emailId,
         data: {
           status: 'processing',
@@ -240,7 +242,7 @@ export class MailingService implements IMailingService {
       })
 
       const email = await this.payload.findByID({
-        collection: this.emailsCollection as CollectionSlug,
+        collection: this.emailsCollection as any,
         id: emailId,
         depth: 1,
       }) as BaseEmailDocument
@@ -253,7 +255,7 @@ export class MailingService implements IMailingService {
         fromField = this.getDefaultFrom()
       }
 
-      let mailOptions: SendEmailOptions = {
+      let mailOptions: any = {
         from: fromField,
         to: email.to,
         cc: email.cc || undefined,
@@ -264,19 +266,6 @@ export class MailingService implements IMailingService {
         text: email.text || undefined,
       }
 
-      if (!mailOptions.from) {
-        throw new Error('Email from field is required')
-      }
-      if (!mailOptions.to || (Array.isArray(mailOptions.to) && mailOptions.to.length === 0)) {
-        throw new Error('Email to field is required')
-      }
-      if (!mailOptions.subject) {
-        throw new Error('Email subject is required')
-      }
-      if (!mailOptions.html && !mailOptions.text) {
-        throw new Error('Email content is required')
-      }
-
       // Call beforeSend hook if configured
       if (this.config.beforeSend) {
         try {
@@ -302,10 +291,10 @@ export class MailingService implements IMailingService {
       }
 
       // Send email using Payload's email adapter
-      await this.payload.email.sendEmail(mailOptions)
+      await this.emailAdapter.sendEmail(mailOptions)
 
       await this.payload.update({
-        collection: this.emailsCollection as CollectionSlug,
+        collection: this.emailsCollection as any,
         id: emailId,
         data: {
           status: 'sent',
@@ -319,7 +308,7 @@ export class MailingService implements IMailingService {
       const maxAttempts = this.config.retryAttempts || 3
 
       await this.payload.update({
-        collection: this.emailsCollection as CollectionSlug,
+        collection: this.emailsCollection as any,
         id: emailId,
         data: {
           status: attempts >= maxAttempts ? 'failed' : 'pending',
@@ -336,14 +325,14 @@ export class MailingService implements IMailingService {
 
   private async incrementAttempts(emailId: string): Promise<number> {
     const email = await this.payload.findByID({
-      collection: this.emailsCollection as CollectionSlug,
+      collection: this.emailsCollection as any,
       id: emailId,
     })
 
     const newAttempts = ((email as any).attempts || 0) + 1
 
     await this.payload.update({
-      collection: this.emailsCollection as CollectionSlug,
+      collection: this.emailsCollection as any,
       id: emailId,
       data: {
         attempts: newAttempts,

src/types/index.ts

@@ -1,4 +1,4 @@
-import {Payload, SendEmailOptions} from 'payload'
+import { Payload } from 'payload'
 import type { CollectionConfig, RichTextField } from 'payload'
 
 // Payload ID type (string or number)
@@ -46,11 +46,28 @@ export interface BaseEmailTemplateDocument {
   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>
 
 export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
 
-export type BeforeSendHook = (options: SendEmailOptions, email: BaseEmailDocument) => SendEmailOptions | Promise<SendEmailOptions>
+export interface BeforeSendMailOptions {
+  from: string
+  to: string[]
+  cc?: string[]
+  bcc?: string[]
+  replyTo?: string
+  subject: string
+  html: string
+  text?: string
+  attachments?: any[]
+  [key: string]: any
+}
+
+export type BeforeSendHook = (options: BeforeSendMailOptions, email: BaseEmailDocument) => BeforeSendMailOptions | Promise<BeforeSendMailOptions>
 
 export interface JobPollingConfig {
   maxAttempts?: number        // Maximum number of polling attempts (default: 5)