mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 16:23:23 +00:00
Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
efdfaf5889 | ||
|
|
f12ac8172e | ||
|
|
672ab3236a | ||
|
|
7f04275d39 | ||
|
|
ea87f14308 | ||
|
|
ff788c1ecf | ||
|
|
72f3d7f66d | ||
|
|
5905f732de | ||
|
|
685875d1b9 | ||
|
|
768b70a003 | ||
|
|
21b22a033a | ||
|
|
03f1f62fbf | ||
|
|
e38b63d814 | ||
|
|
c78a8c2480 | ||
|
|
0c4d894f51 | ||
|
|
6d4e020133 | ||
|
|
b3de54b953 | ||
|
|
ed058c0721 | ||
|
|
273dea5a73 | ||
|
|
c81ef7f8a8 | ||
|
|
cddcfb1e4c | ||
|
|
80d32674a9 | ||
|
|
c7af628beb | ||
|
|
048fa33747 | ||
|
|
cb62874500 | ||
|
|
9efea193b1 | ||
|
|
c09d7d4fc5 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -4,6 +4,4 @@ node_modules/
|
|||||||
payload-docs
|
payload-docs
|
||||||
dist/
|
dist/
|
||||||
/dev/payload.db
|
/dev/payload.db
|
||||||
/dev/dev.db
|
|
||||||
dev.db
|
|
||||||
tsconfig.tsbuildinfo
|
tsconfig.tsbuildinfo
|
||||||
|
|||||||
@@ -126,10 +126,9 @@ When you start the dev server, look for these messages:
|
|||||||
🎯 Test interface will be available at: /mailing-test
|
🎯 Test interface will be available at: /mailing-test
|
||||||
|
|
||||||
✅ Example email templates created successfully
|
✅ Example email templates created successfully
|
||||||
|
PayloadCMS Mailing Plugin initialized successfully
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: The plugin initializes silently on success (no "initialized successfully" message). If you see no errors, the plugin loaded correctly.
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Server won't start
|
### Server won't start
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
USE_MEMORY_DB=true
|
|
||||||
PAYLOAD_SECRET=YOUR_SECRET_HERE
|
|
||||||
@@ -1,310 +0,0 @@
|
|||||||
'use client'
|
|
||||||
|
|
||||||
import { useState, useEffect } from 'react'
|
|
||||||
import Link from 'next/link'
|
|
||||||
|
|
||||||
interface EmailStats {
|
|
||||||
total: number
|
|
||||||
sent: number
|
|
||||||
pending: number
|
|
||||||
failed: number
|
|
||||||
processing: number
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function HomePage() {
|
|
||||||
const [emailStats, setEmailStats] = useState<EmailStats>({
|
|
||||||
total: 0,
|
|
||||||
sent: 0,
|
|
||||||
pending: 0,
|
|
||||||
failed: 0,
|
|
||||||
processing: 0
|
|
||||||
})
|
|
||||||
const [loading, setLoading] = useState<boolean>(true)
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
fetchEmailStats()
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
const fetchEmailStats = async () => {
|
|
||||||
try {
|
|
||||||
const response = await fetch('/api/test-email')
|
|
||||||
const data = await response.json()
|
|
||||||
|
|
||||||
if (data.outbox?.emails) {
|
|
||||||
const emails = data.outbox.emails
|
|
||||||
const stats: EmailStats = {
|
|
||||||
total: emails.length,
|
|
||||||
sent: emails.filter((email: any) => email.status === 'sent').length,
|
|
||||||
pending: emails.filter((email: any) => email.status === 'pending').length,
|
|
||||||
failed: emails.filter((email: any) => email.status === 'failed').length,
|
|
||||||
processing: emails.filter((email: any) => email.status === 'processing').length
|
|
||||||
}
|
|
||||||
setEmailStats(stats)
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Error fetching email statistics:', error)
|
|
||||||
} finally {
|
|
||||||
setLoading(false)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const StatCard = ({ label, value, color, description }: { label: string; value: number; color: string; description: string }) => (
|
|
||||||
<div style={{
|
|
||||||
backgroundColor: 'white',
|
|
||||||
border: '1px solid #e5e7eb',
|
|
||||||
borderRadius: '12px',
|
|
||||||
padding: '24px',
|
|
||||||
textAlign: 'center',
|
|
||||||
boxShadow: '0 1px 3px rgba(0, 0, 0, 0.1)',
|
|
||||||
}}>
|
|
||||||
<div style={{
|
|
||||||
fontSize: '3rem',
|
|
||||||
fontWeight: 'bold',
|
|
||||||
color: color,
|
|
||||||
marginBottom: '8px'
|
|
||||||
}}>
|
|
||||||
{value}
|
|
||||||
</div>
|
|
||||||
<div style={{
|
|
||||||
fontSize: '1.1rem',
|
|
||||||
fontWeight: '600',
|
|
||||||
color: '#374151',
|
|
||||||
marginBottom: '4px'
|
|
||||||
}}>
|
|
||||||
{label}
|
|
||||||
</div>
|
|
||||||
<div style={{
|
|
||||||
fontSize: '0.875rem',
|
|
||||||
color: '#6b7280'
|
|
||||||
}}>
|
|
||||||
{description}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div style={{
|
|
||||||
backgroundColor: '#f9fafb',
|
|
||||||
padding: '40px 20px',
|
|
||||||
minHeight: 'calc(100vh - 80px)'
|
|
||||||
}}>
|
|
||||||
<div style={{
|
|
||||||
maxWidth: '1200px',
|
|
||||||
margin: '0 auto'
|
|
||||||
}}>
|
|
||||||
{/* Header */}
|
|
||||||
<div style={{ textAlign: 'center', marginBottom: '48px' }}>
|
|
||||||
<h1 style={{
|
|
||||||
fontSize: '3rem',
|
|
||||||
fontWeight: 'bold',
|
|
||||||
color: '#1f2937',
|
|
||||||
marginBottom: '16px'
|
|
||||||
}}>
|
|
||||||
📧 PayloadCMS Mailing Plugin
|
|
||||||
</h1>
|
|
||||||
<p style={{
|
|
||||||
fontSize: '1.25rem',
|
|
||||||
color: '#6b7280',
|
|
||||||
marginBottom: '24px'
|
|
||||||
}}>
|
|
||||||
Development Dashboard
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<div style={{ display: 'flex', gap: '16px', justifyContent: 'center', flexWrap: 'wrap' }}>
|
|
||||||
<Link
|
|
||||||
href="/admin"
|
|
||||||
style={{
|
|
||||||
backgroundColor: '#3b82f6',
|
|
||||||
color: 'white',
|
|
||||||
padding: '12px 24px',
|
|
||||||
borderRadius: '8px',
|
|
||||||
textDecoration: 'none',
|
|
||||||
fontWeight: '500',
|
|
||||||
transition: 'background-color 0.2s'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
📊 Admin Panel
|
|
||||||
</Link>
|
|
||||||
<Link
|
|
||||||
href="/mailing-test"
|
|
||||||
style={{
|
|
||||||
backgroundColor: '#10b981',
|
|
||||||
color: 'white',
|
|
||||||
padding: '12px 24px',
|
|
||||||
borderRadius: '8px',
|
|
||||||
textDecoration: 'none',
|
|
||||||
fontWeight: '500',
|
|
||||||
transition: 'background-color 0.2s'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
🧪 Test Interface
|
|
||||||
</Link>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{/* Email Statistics */}
|
|
||||||
<div style={{ marginBottom: '48px' }}>
|
|
||||||
<div style={{
|
|
||||||
display: 'flex',
|
|
||||||
justifyContent: 'space-between',
|
|
||||||
alignItems: 'center',
|
|
||||||
marginBottom: '24px'
|
|
||||||
}}>
|
|
||||||
<h2 style={{
|
|
||||||
fontSize: '2rem',
|
|
||||||
fontWeight: 'bold',
|
|
||||||
color: '#1f2937'
|
|
||||||
}}>
|
|
||||||
Email Statistics
|
|
||||||
</h2>
|
|
||||||
<button
|
|
||||||
onClick={fetchEmailStats}
|
|
||||||
disabled={loading}
|
|
||||||
style={{
|
|
||||||
backgroundColor: loading ? '#9ca3af' : '#6b7280',
|
|
||||||
color: 'white',
|
|
||||||
padding: '8px 16px',
|
|
||||||
borderRadius: '6px',
|
|
||||||
border: 'none',
|
|
||||||
cursor: loading ? 'not-allowed' : 'pointer',
|
|
||||||
fontWeight: '500'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{loading ? 'Loading...' : 'Refresh'}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{loading ? (
|
|
||||||
<div style={{ textAlign: 'center', padding: '48px' }}>
|
|
||||||
<div style={{ color: '#6b7280', fontSize: '1.1rem' }}>Loading email statistics...</div>
|
|
||||||
</div>
|
|
||||||
) : (
|
|
||||||
<div style={{
|
|
||||||
display: 'grid',
|
|
||||||
gridTemplateColumns: 'repeat(auto-fit, minmax(250px, 1fr))',
|
|
||||||
gap: '24px'
|
|
||||||
}}>
|
|
||||||
<StatCard
|
|
||||||
label="Total Emails"
|
|
||||||
value={emailStats.total}
|
|
||||||
color="#1f2937"
|
|
||||||
description="All emails in the system"
|
|
||||||
/>
|
|
||||||
<StatCard
|
|
||||||
label="Successfully Sent"
|
|
||||||
value={emailStats.sent}
|
|
||||||
color="#10b981"
|
|
||||||
description="Delivered successfully"
|
|
||||||
/>
|
|
||||||
<StatCard
|
|
||||||
label="Pending"
|
|
||||||
value={emailStats.pending}
|
|
||||||
color="#f59e0b"
|
|
||||||
description="Waiting to be sent"
|
|
||||||
/>
|
|
||||||
<StatCard
|
|
||||||
label="Failed"
|
|
||||||
value={emailStats.failed}
|
|
||||||
color="#ef4444"
|
|
||||||
description="Failed to send"
|
|
||||||
/>
|
|
||||||
{emailStats.processing > 0 && (
|
|
||||||
<StatCard
|
|
||||||
label="Processing"
|
|
||||||
value={emailStats.processing}
|
|
||||||
color="#3b82f6"
|
|
||||||
description="Currently being sent"
|
|
||||||
/>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{/* Quick Actions */}
|
|
||||||
<div style={{
|
|
||||||
backgroundColor: 'white',
|
|
||||||
borderRadius: '12px',
|
|
||||||
padding: '32px',
|
|
||||||
border: '1px solid #e5e7eb',
|
|
||||||
boxShadow: '0 1px 3px rgba(0, 0, 0, 0.1)'
|
|
||||||
}}>
|
|
||||||
<h3 style={{
|
|
||||||
fontSize: '1.5rem',
|
|
||||||
fontWeight: 'bold',
|
|
||||||
color: '#1f2937',
|
|
||||||
marginBottom: '16px'
|
|
||||||
}}>
|
|
||||||
Quick Actions
|
|
||||||
</h3>
|
|
||||||
<div style={{
|
|
||||||
display: 'grid',
|
|
||||||
gridTemplateColumns: 'repeat(auto-fit, minmax(300px, 1fr))',
|
|
||||||
gap: '16px'
|
|
||||||
}}>
|
|
||||||
<div style={{ padding: '16px', backgroundColor: '#f9fafb', borderRadius: '8px' }}>
|
|
||||||
<h4 style={{ marginBottom: '8px', color: '#1f2937' }}>🎯 Test Email Sending</h4>
|
|
||||||
<p style={{ color: '#6b7280', marginBottom: '12px', fontSize: '0.9rem' }}>
|
|
||||||
Send test emails using templates with the interactive testing interface.
|
|
||||||
</p>
|
|
||||||
<Link
|
|
||||||
href="/mailing-test"
|
|
||||||
style={{
|
|
||||||
color: '#3b82f6',
|
|
||||||
textDecoration: 'none',
|
|
||||||
fontWeight: '500'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
Open Test Interface →
|
|
||||||
</Link>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div style={{ padding: '16px', backgroundColor: '#f9fafb', borderRadius: '8px' }}>
|
|
||||||
<h4 style={{ marginBottom: '8px', color: '#1f2937' }}>📝 Manage Templates</h4>
|
|
||||||
<p style={{ color: '#6b7280', marginBottom: '12px', fontSize: '0.9rem' }}>
|
|
||||||
Create and edit email templates in the Payload admin interface.
|
|
||||||
</p>
|
|
||||||
<Link
|
|
||||||
href="/admin/collections/email-templates"
|
|
||||||
style={{
|
|
||||||
color: '#3b82f6',
|
|
||||||
textDecoration: 'none',
|
|
||||||
fontWeight: '500'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
Manage Templates →
|
|
||||||
</Link>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div style={{ padding: '16px', backgroundColor: '#f9fafb', borderRadius: '8px' }}>
|
|
||||||
<h4 style={{ marginBottom: '8px', color: '#1f2937' }}>📬 Email Queue</h4>
|
|
||||||
<p style={{ color: '#6b7280', marginBottom: '12px', fontSize: '0.9rem' }}>
|
|
||||||
View and manage the email outbox and delivery status.
|
|
||||||
</p>
|
|
||||||
<Link
|
|
||||||
href="/admin/collections/emails"
|
|
||||||
style={{
|
|
||||||
color: '#3b82f6',
|
|
||||||
textDecoration: 'none',
|
|
||||||
fontWeight: '500'
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
View Email Queue →
|
|
||||||
</Link>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{/* Footer */}
|
|
||||||
<div style={{
|
|
||||||
textAlign: 'center',
|
|
||||||
marginTop: '48px',
|
|
||||||
padding: '24px',
|
|
||||||
color: '#6b7280',
|
|
||||||
fontSize: '0.875rem'
|
|
||||||
}}>
|
|
||||||
PayloadCMS Mailing Plugin Development Environment
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
import type { Metadata } from 'next'
|
|
||||||
|
|
||||||
export const metadata: Metadata = {
|
|
||||||
title: 'PayloadCMS Mailing Plugin - Development',
|
|
||||||
description: 'Development environment for PayloadCMS Mailing Plugin',
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function FrontendLayout({
|
|
||||||
children,
|
|
||||||
}: {
|
|
||||||
children: React.ReactNode
|
|
||||||
}) {
|
|
||||||
return (
|
|
||||||
<html lang="en">
|
|
||||||
<body style={{
|
|
||||||
margin: 0,
|
|
||||||
padding: 0,
|
|
||||||
fontFamily: '-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif'
|
|
||||||
}}>
|
|
||||||
{children}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -4,25 +4,24 @@ import config from '@payload-config'
|
|||||||
export async function POST(request: Request) {
|
export async function POST(request: Request) {
|
||||||
try {
|
try {
|
||||||
const payload = await getPayload({ config })
|
const payload = await getPayload({ config })
|
||||||
|
|
||||||
// Run jobs in the default queue (the plugin already schedules email processing on init)
|
// Queue the combined email queue processing job
|
||||||
const results = await payload.jobs.run({
|
const job = await payload.jobs.queue({
|
||||||
queue: 'default',
|
task: 'process-email-queue',
|
||||||
|
input: {},
|
||||||
})
|
})
|
||||||
|
|
||||||
const processedCount = Array.isArray(results) ? results.length : (results ? 1 : 0)
|
|
||||||
|
|
||||||
return Response.json({
|
return Response.json({
|
||||||
success: true,
|
success: true,
|
||||||
message: `Email queue processing completed. Processed ${processedCount} jobs.`,
|
message: 'Email queue processing job queued successfully (will process both pending and failed emails)',
|
||||||
processedJobs: processedCount,
|
jobId: job.id,
|
||||||
})
|
})
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.error('Process emails error:', error)
|
console.error('Process emails error:', error)
|
||||||
return Response.json(
|
return Response.json(
|
||||||
{
|
{
|
||||||
error: 'Failed to process emails',
|
error: 'Failed to process emails',
|
||||||
details: error instanceof Error ? error.message : 'Unknown error'
|
details: error instanceof Error ? error.message : 'Unknown error'
|
||||||
},
|
},
|
||||||
{ status: 500 }
|
{ status: 500 }
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -8,22 +8,6 @@ export async function POST(request: Request) {
|
|||||||
const body = await request.json()
|
const body = await request.json()
|
||||||
const { type = 'send', templateSlug, to, variables, scheduledAt, subject, html, text } = body
|
const { type = 'send', templateSlug, to, variables, scheduledAt, subject, html, text } = body
|
||||||
|
|
||||||
// Validate required fields
|
|
||||||
if (!to) {
|
|
||||||
return Response.json(
|
|
||||||
{ error: 'Recipient email address (to) is required' },
|
|
||||||
{ status: 400 }
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate email has either template or direct content
|
|
||||||
if (!templateSlug && (!subject || !html)) {
|
|
||||||
return Response.json(
|
|
||||||
{ error: 'Either templateSlug or both subject and html must be provided' },
|
|
||||||
{ status: 400 }
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Use the new sendEmail API
|
// Use the new sendEmail API
|
||||||
const emailOptions: any = {
|
const emailOptions: any = {
|
||||||
data: {
|
data: {
|
||||||
@@ -55,21 +39,12 @@ export async function POST(request: Request) {
|
|||||||
emailOptions.data.scheduledAt = scheduledAt ? new Date(scheduledAt) : new Date(Date.now() + 60000)
|
emailOptions.data.scheduledAt = scheduledAt ? new Date(scheduledAt) : new Date(Date.now() + 60000)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set processImmediately for "send now" type
|
|
||||||
const processImmediately = (type === 'send' && !scheduledAt)
|
|
||||||
emailOptions.processImmediately = processImmediately
|
|
||||||
|
|
||||||
const result = await sendEmail(payload, emailOptions)
|
const result = await sendEmail(payload, emailOptions)
|
||||||
|
|
||||||
return Response.json({
|
return Response.json({
|
||||||
success: true,
|
success: true,
|
||||||
emailId: result.id,
|
emailId: result.id,
|
||||||
message: processImmediately ? 'Email sent successfully' :
|
message: scheduledAt ? 'Email scheduled successfully' : 'Email queued successfully',
|
||||||
scheduledAt ? 'Email scheduled successfully' :
|
|
||||||
'Email queued successfully',
|
|
||||||
status: processImmediately ? 'sent' :
|
|
||||||
scheduledAt ? 'scheduled' :
|
|
||||||
'queued'
|
|
||||||
})
|
})
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.error('Test email error:', error)
|
console.error('Test email error:', error)
|
||||||
@@ -107,8 +82,8 @@ export async function GET() {
|
|||||||
total: totalDocs,
|
total: totalDocs,
|
||||||
},
|
},
|
||||||
mailing: {
|
mailing: {
|
||||||
pluginActive: 'mailing' in payload && !!payload.mailing,
|
pluginActive: !!(payload as any).mailing,
|
||||||
service: 'mailing' in payload && payload.mailing && 'service' in payload.mailing && !!payload.mailing.service,
|
service: !!(payload as any).mailing?.service,
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
|
|||||||
@@ -33,8 +33,6 @@ export default function MailingTestPage() {
|
|||||||
const [selectedTemplate, setSelectedTemplate] = useState<string>('')
|
const [selectedTemplate, setSelectedTemplate] = useState<string>('')
|
||||||
const [toEmail, setToEmail] = useState<string>('test@example.com')
|
const [toEmail, setToEmail] = useState<string>('test@example.com')
|
||||||
const [variables, setVariables] = useState<Record<string, any>>({})
|
const [variables, setVariables] = useState<Record<string, any>>({})
|
||||||
const [jsonVariables, setJsonVariables] = useState<string>('{}')
|
|
||||||
const [jsonError, setJsonError] = useState<string>('')
|
|
||||||
const [emailType, setEmailType] = useState<'send' | 'schedule'>('send')
|
const [emailType, setEmailType] = useState<'send' | 'schedule'>('send')
|
||||||
const [scheduleDate, setScheduleDate] = useState<string>('')
|
const [scheduleDate, setScheduleDate] = useState<string>('')
|
||||||
const [loading, setLoading] = useState<boolean>(false)
|
const [loading, setLoading] = useState<boolean>(false)
|
||||||
@@ -60,23 +58,6 @@ export default function MailingTestPage() {
|
|||||||
const template = templates.find(t => t.slug === templateSlug)
|
const template = templates.find(t => t.slug === templateSlug)
|
||||||
if (template?.previewData) {
|
if (template?.previewData) {
|
||||||
setVariables(template.previewData)
|
setVariables(template.previewData)
|
||||||
setJsonVariables(JSON.stringify(template.previewData, null, 2))
|
|
||||||
} else {
|
|
||||||
setVariables({})
|
|
||||||
setJsonVariables('{}')
|
|
||||||
}
|
|
||||||
setJsonError('')
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleJsonVariablesChange = (jsonString: string) => {
|
|
||||||
setJsonVariables(jsonString)
|
|
||||||
setJsonError('')
|
|
||||||
|
|
||||||
try {
|
|
||||||
const parsed = JSON.parse(jsonString)
|
|
||||||
setVariables(parsed)
|
|
||||||
} catch (error) {
|
|
||||||
setJsonError(error instanceof Error ? error.message : 'Invalid JSON')
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -86,11 +67,6 @@ export default function MailingTestPage() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (jsonError) {
|
|
||||||
setMessage('Please fix the JSON syntax error before sending')
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
setLoading(true)
|
setLoading(true)
|
||||||
setMessage('')
|
setMessage('')
|
||||||
|
|
||||||
@@ -112,8 +88,7 @@ export default function MailingTestPage() {
|
|||||||
const result = await response.json()
|
const result = await response.json()
|
||||||
|
|
||||||
if (result.success) {
|
if (result.success) {
|
||||||
const statusIcon = result.status === 'sent' ? '📧' : '📫'
|
setMessage(`✅ ${result.message} (ID: ${result.emailId})`)
|
||||||
setMessage(`✅ ${statusIcon} ${result.message} (ID: ${result.emailId})`)
|
|
||||||
fetchData() // Refresh email queue
|
fetchData() // Refresh email queue
|
||||||
} else {
|
} else {
|
||||||
setMessage(`❌ Error: ${result.error}`)
|
setMessage(`❌ Error: ${result.error}`)
|
||||||
@@ -229,43 +204,28 @@ export default function MailingTestPage() {
|
|||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
{selectedTemplate && (
|
{selectedTemplateData?.variables && (
|
||||||
<div style={{ marginBottom: '15px' }}>
|
<div style={{ marginBottom: '15px' }}>
|
||||||
<label style={{ display: 'block', marginBottom: '5px' }}>
|
<h3>Template Variables:</h3>
|
||||||
<strong>Template Variables (JSON):</strong>
|
{selectedTemplateData.variables.map(variable => (
|
||||||
{selectedTemplateData?.variables && (
|
<div key={variable.name} style={{ marginBottom: '10px' }}>
|
||||||
<small style={{ color: '#666', marginLeft: '8px' }}>
|
<label style={{ display: 'block', marginBottom: '5px' }}>
|
||||||
Available variables: {selectedTemplateData.variables.map(v => v.name).join(', ')}
|
{variable.name} {variable.required && <span style={{ color: 'red' }}>*</span>}
|
||||||
</small>
|
{variable.description && <small style={{ color: '#666' }}> - {variable.description}</small>}
|
||||||
)}
|
</label>
|
||||||
</label>
|
<input
|
||||||
<textarea
|
type={variable.type === 'number' ? 'number' : variable.type === 'date' ? 'datetime-local' : 'text'}
|
||||||
value={jsonVariables}
|
value={variables[variable.name] || ''}
|
||||||
onChange={(e) => handleJsonVariablesChange(e.target.value)}
|
onChange={(e) => setVariables({
|
||||||
placeholder='{\n "firstName": "John",\n "siteName": "MyApp",\n "createdAt": "2023-01-01T00:00:00Z"\n}'
|
...variables,
|
||||||
style={{
|
[variable.name]: variable.type === 'number' ? Number(e.target.value) :
|
||||||
width: '100%',
|
variable.type === 'boolean' ? e.target.checked :
|
||||||
height: '150px',
|
e.target.value
|
||||||
padding: '8px',
|
})}
|
||||||
borderRadius: '4px',
|
style={{ width: '100%', padding: '8px', borderRadius: '4px', border: '1px solid #ddd' }}
|
||||||
border: jsonError ? '2px solid #dc3545' : '1px solid #ddd',
|
/>
|
||||||
fontFamily: 'monaco, "Courier New", monospace',
|
|
||||||
fontSize: '13px',
|
|
||||||
resize: 'vertical'
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
{jsonError && (
|
|
||||||
<div style={{
|
|
||||||
color: '#dc3545',
|
|
||||||
fontSize: '12px',
|
|
||||||
marginTop: '5px',
|
|
||||||
padding: '5px',
|
|
||||||
backgroundColor: '#f8d7da',
|
|
||||||
borderRadius: '4px'
|
|
||||||
}}>
|
|
||||||
Invalid JSON: {jsonError}
|
|
||||||
</div>
|
</div>
|
||||||
)}
|
))}
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import { Metadata } from 'next'
|
|
||||||
import {redirect} from "next/navigation.js"
|
|
||||||
|
|
||||||
export const metadata: Metadata = {
|
|
||||||
title: 'PayloadCMS Mailing Plugin - Development',
|
|
||||||
description: 'Development environment for PayloadCMS Mailing Plugin',
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function HomePage() {
|
|
||||||
redirect('/dashboard')
|
|
||||||
}
|
|
||||||
@@ -90,7 +90,7 @@ export interface Config {
|
|||||||
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
|
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
|
||||||
};
|
};
|
||||||
db: {
|
db: {
|
||||||
defaultIDType: number;
|
defaultIDType: string;
|
||||||
};
|
};
|
||||||
globals: {};
|
globals: {};
|
||||||
globalsSelect: {};
|
globalsSelect: {};
|
||||||
@@ -100,7 +100,7 @@ export interface Config {
|
|||||||
};
|
};
|
||||||
jobs: {
|
jobs: {
|
||||||
tasks: {
|
tasks: {
|
||||||
'process-emails': ProcessEmailsTask;
|
processEmails: ProcessEmailsJob;
|
||||||
'send-email': TaskSendEmail;
|
'send-email': TaskSendEmail;
|
||||||
inline: {
|
inline: {
|
||||||
input: unknown;
|
input: unknown;
|
||||||
@@ -133,7 +133,7 @@ export interface UserAuthOperations {
|
|||||||
* via the `definition` "users".
|
* via the `definition` "users".
|
||||||
*/
|
*/
|
||||||
export interface User {
|
export interface User {
|
||||||
id: number;
|
id: string;
|
||||||
firstName?: string | null;
|
firstName?: string | null;
|
||||||
lastName?: string | null;
|
lastName?: string | null;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
@@ -159,7 +159,7 @@ export interface User {
|
|||||||
* via the `definition` "posts".
|
* via the `definition` "posts".
|
||||||
*/
|
*/
|
||||||
export interface Post {
|
export interface Post {
|
||||||
id: number;
|
id: string;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
}
|
}
|
||||||
@@ -168,7 +168,7 @@ export interface Post {
|
|||||||
* via the `definition` "media".
|
* via the `definition` "media".
|
||||||
*/
|
*/
|
||||||
export interface Media {
|
export interface Media {
|
||||||
id: number;
|
id: string;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
url?: string | null;
|
url?: string | null;
|
||||||
@@ -186,7 +186,7 @@ export interface Media {
|
|||||||
* via the `definition` "email-templates".
|
* via the `definition` "email-templates".
|
||||||
*/
|
*/
|
||||||
export interface EmailTemplate {
|
export interface EmailTemplate {
|
||||||
id: number;
|
id: string;
|
||||||
/**
|
/**
|
||||||
* A descriptive name for this email template
|
* A descriptive name for this email template
|
||||||
*/
|
*/
|
||||||
@@ -227,11 +227,11 @@ export interface EmailTemplate {
|
|||||||
* via the `definition` "emails".
|
* via the `definition` "emails".
|
||||||
*/
|
*/
|
||||||
export interface Email {
|
export interface Email {
|
||||||
id: number;
|
id: string;
|
||||||
/**
|
/**
|
||||||
* Email template used (optional if custom content provided)
|
* Email template used (optional if custom content provided)
|
||||||
*/
|
*/
|
||||||
template?: (number | null) | EmailTemplate;
|
template?: (string | null) | EmailTemplate;
|
||||||
/**
|
/**
|
||||||
* Recipient email addresses
|
* Recipient email addresses
|
||||||
*/
|
*/
|
||||||
@@ -316,7 +316,7 @@ export interface Email {
|
|||||||
* via the `definition` "payload-jobs".
|
* via the `definition` "payload-jobs".
|
||||||
*/
|
*/
|
||||||
export interface PayloadJob {
|
export interface PayloadJob {
|
||||||
id: number;
|
id: string;
|
||||||
/**
|
/**
|
||||||
* Input data provided to the job
|
* Input data provided to the job
|
||||||
*/
|
*/
|
||||||
@@ -363,7 +363,7 @@ export interface PayloadJob {
|
|||||||
| {
|
| {
|
||||||
executedAt: string;
|
executedAt: string;
|
||||||
completedAt: string;
|
completedAt: string;
|
||||||
taskSlug: 'inline' | 'process-emails' | 'send-email';
|
taskSlug: 'inline' | 'processEmails' | 'send-email';
|
||||||
taskID: string;
|
taskID: string;
|
||||||
input?:
|
input?:
|
||||||
| {
|
| {
|
||||||
@@ -396,7 +396,7 @@ export interface PayloadJob {
|
|||||||
id?: string | null;
|
id?: string | null;
|
||||||
}[]
|
}[]
|
||||||
| null;
|
| null;
|
||||||
taskSlug?: ('inline' | 'process-emails' | 'send-email') | null;
|
taskSlug?: ('inline' | 'processEmails' | 'send-email') | null;
|
||||||
queue?: string | null;
|
queue?: string | null;
|
||||||
waitUntil?: string | null;
|
waitUntil?: string | null;
|
||||||
processing?: boolean | null;
|
processing?: boolean | null;
|
||||||
@@ -408,36 +408,36 @@ export interface PayloadJob {
|
|||||||
* via the `definition` "payload-locked-documents".
|
* via the `definition` "payload-locked-documents".
|
||||||
*/
|
*/
|
||||||
export interface PayloadLockedDocument {
|
export interface PayloadLockedDocument {
|
||||||
id: number;
|
id: string;
|
||||||
document?:
|
document?:
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'users';
|
relationTo: 'users';
|
||||||
value: number | User;
|
value: string | User;
|
||||||
} | null)
|
} | null)
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'posts';
|
relationTo: 'posts';
|
||||||
value: number | Post;
|
value: string | Post;
|
||||||
} | null)
|
} | null)
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'media';
|
relationTo: 'media';
|
||||||
value: number | Media;
|
value: string | Media;
|
||||||
} | null)
|
} | null)
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'email-templates';
|
relationTo: 'email-templates';
|
||||||
value: number | EmailTemplate;
|
value: string | EmailTemplate;
|
||||||
} | null)
|
} | null)
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'emails';
|
relationTo: 'emails';
|
||||||
value: number | Email;
|
value: string | Email;
|
||||||
} | null)
|
} | null)
|
||||||
| ({
|
| ({
|
||||||
relationTo: 'payload-jobs';
|
relationTo: 'payload-jobs';
|
||||||
value: number | PayloadJob;
|
value: string | PayloadJob;
|
||||||
} | null);
|
} | null);
|
||||||
globalSlug?: string | null;
|
globalSlug?: string | null;
|
||||||
user: {
|
user: {
|
||||||
relationTo: 'users';
|
relationTo: 'users';
|
||||||
value: number | User;
|
value: string | User;
|
||||||
};
|
};
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
@@ -447,10 +447,10 @@ export interface PayloadLockedDocument {
|
|||||||
* via the `definition` "payload-preferences".
|
* via the `definition` "payload-preferences".
|
||||||
*/
|
*/
|
||||||
export interface PayloadPreference {
|
export interface PayloadPreference {
|
||||||
id: number;
|
id: string;
|
||||||
user: {
|
user: {
|
||||||
relationTo: 'users';
|
relationTo: 'users';
|
||||||
value: number | User;
|
value: string | User;
|
||||||
};
|
};
|
||||||
key?: string | null;
|
key?: string | null;
|
||||||
value?:
|
value?:
|
||||||
@@ -470,7 +470,7 @@ export interface PayloadPreference {
|
|||||||
* via the `definition` "payload-migrations".
|
* via the `definition` "payload-migrations".
|
||||||
*/
|
*/
|
||||||
export interface PayloadMigration {
|
export interface PayloadMigration {
|
||||||
id: number;
|
id: string;
|
||||||
name?: string | null;
|
name?: string | null;
|
||||||
batch?: number | null;
|
batch?: number | null;
|
||||||
updatedAt: string;
|
updatedAt: string;
|
||||||
@@ -628,9 +628,9 @@ export interface PayloadMigrationsSelect<T extends boolean = true> {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* This interface was referenced by `Config`'s JSON-Schema
|
* This interface was referenced by `Config`'s JSON-Schema
|
||||||
* via the `definition` "ProcessEmailsTask".
|
* via the `definition` "ProcessEmailsJob".
|
||||||
*/
|
*/
|
||||||
export interface ProcessEmailsTask {
|
export interface ProcessEmailsJob {
|
||||||
input?: unknown;
|
input?: unknown;
|
||||||
output?: unknown;
|
output?: unknown;
|
||||||
}
|
}
|
||||||
@@ -640,10 +640,6 @@ export interface ProcessEmailsTask {
|
|||||||
*/
|
*/
|
||||||
export interface TaskSendEmail {
|
export interface TaskSendEmail {
|
||||||
input: {
|
input: {
|
||||||
/**
|
|
||||||
* Process and send the email immediately instead of waiting for the queue processor
|
|
||||||
*/
|
|
||||||
processImmediately?: boolean | null;
|
|
||||||
/**
|
/**
|
||||||
* Use a template (leave empty for direct email)
|
* Use a template (leave empty for direct email)
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { sqliteAdapter } from '@payloadcms/db-sqlite'
|
import { mongooseAdapter } from '@payloadcms/db-mongodb'
|
||||||
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
||||||
import {
|
import {
|
||||||
FixedToolbarFeature,
|
FixedToolbarFeature,
|
||||||
@@ -6,6 +6,7 @@ import {
|
|||||||
HorizontalRuleFeature,
|
HorizontalRuleFeature,
|
||||||
InlineToolbarFeature,
|
InlineToolbarFeature,
|
||||||
} from '@payloadcms/richtext-lexical'
|
} from '@payloadcms/richtext-lexical'
|
||||||
|
import { MongoMemoryReplSet } from 'mongodb-memory-server'
|
||||||
import path from 'path'
|
import path from 'path'
|
||||||
import { buildConfig } from 'payload'
|
import { buildConfig } from 'payload'
|
||||||
import sharp from 'sharp'
|
import sharp from 'sharp'
|
||||||
@@ -23,7 +24,36 @@ if (!process.env.ROOT_DIR) {
|
|||||||
process.env.ROOT_DIR = dirname
|
process.env.ROOT_DIR = dirname
|
||||||
}
|
}
|
||||||
|
|
||||||
export default buildConfig({
|
const buildConfigWithMemoryDB = async () => {
|
||||||
|
// Use in-memory MongoDB for development and testing
|
||||||
|
if (process.env.NODE_ENV === 'test' || process.env.USE_MEMORY_DB === 'true' || !process.env.DATABASE_URI) {
|
||||||
|
console.log('🚀 Starting MongoDB in-memory database...')
|
||||||
|
|
||||||
|
const memoryDB = await MongoMemoryReplSet.create({
|
||||||
|
replSet: {
|
||||||
|
count: 1, // Single instance for dev (faster startup)
|
||||||
|
dbName: process.env.NODE_ENV === 'test' ? 'payloadmemory' : 'payload-mailing-dev',
|
||||||
|
storageEngine: 'wiredTiger',
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const uri = `${memoryDB.getUri()}&retryWrites=true`
|
||||||
|
process.env.DATABASE_URI = uri
|
||||||
|
|
||||||
|
console.log('✅ MongoDB in-memory database started')
|
||||||
|
console.log(`📊 Database URI: ${uri.replace(/mongodb:\/\/[^@]*@/, 'mongodb://***@')}`)
|
||||||
|
|
||||||
|
// Graceful shutdown
|
||||||
|
process.on('SIGINT', async () => {
|
||||||
|
console.log('🛑 Stopping MongoDB in-memory database...')
|
||||||
|
await memoryDB.stop()
|
||||||
|
process.exit(0)
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
console.log(`🔗 Using external MongoDB: ${process.env.DATABASE_URI?.replace(/mongodb:\/\/[^@]*@/, 'mongodb://***@')}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return buildConfig({
|
||||||
admin: {
|
admin: {
|
||||||
importMap: {
|
importMap: {
|
||||||
baseDir: path.resolve(dirname),
|
baseDir: path.resolve(dirname),
|
||||||
@@ -92,36 +122,148 @@ export default buildConfig({
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
db: sqliteAdapter({
|
db: mongooseAdapter({
|
||||||
client: {
|
ensureIndexes: true,
|
||||||
url: process.env.DATABASE_URI || 'file:./dev.db',
|
url: process.env.DATABASE_URI || '',
|
||||||
},
|
|
||||||
}),
|
}),
|
||||||
editor: lexicalEditor(),
|
editor: lexicalEditor(),
|
||||||
email: testEmailAdapter,
|
email: testEmailAdapter,
|
||||||
onInit: async (payload) => {
|
onInit: async (payload) => {
|
||||||
await seed(payload)
|
await seed(payload)
|
||||||
},
|
},
|
||||||
jobs: {
|
|
||||||
jobsCollectionOverrides: c => {
|
|
||||||
if (c.defaultJobsCollection.admin) c.defaultJobsCollection.admin.hidden = false
|
|
||||||
return c.defaultJobsCollection
|
|
||||||
},
|
|
||||||
autoRun: [
|
|
||||||
{
|
|
||||||
cron: '*/1 * * * *', // every minute
|
|
||||||
limit: 10, // limit jobs to process each run
|
|
||||||
queue: 'default', // name of the queue
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
plugins: [
|
plugins: [
|
||||||
mailingPlugin({
|
mailingPlugin({
|
||||||
defaultFrom: 'noreply@test.com',
|
defaultFrom: 'noreply@test.com',
|
||||||
initOrder: 'after',
|
initOrder: 'after',
|
||||||
|
transport: {
|
||||||
|
host: 'localhost',
|
||||||
|
port: 1025, // MailHog port for dev
|
||||||
|
secure: false,
|
||||||
|
auth: {
|
||||||
|
user: 'test',
|
||||||
|
pass: 'test',
|
||||||
|
},
|
||||||
|
},
|
||||||
retryAttempts: 3,
|
retryAttempts: 3,
|
||||||
retryDelay: 60000, // 1 minute for dev
|
retryDelay: 60000, // 1 minute for dev
|
||||||
queue: 'default',
|
queue: 'email-queue',
|
||||||
|
|
||||||
|
// Example: Collection overrides for customization
|
||||||
|
// Uncomment and modify as needed for your use case
|
||||||
|
/*
|
||||||
|
collections: {
|
||||||
|
templates: {
|
||||||
|
// Custom access controls - restrict who can manage templates
|
||||||
|
access: {
|
||||||
|
read: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:read')
|
||||||
|
},
|
||||||
|
create: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:create')
|
||||||
|
},
|
||||||
|
update: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:update')
|
||||||
|
},
|
||||||
|
delete: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// Custom admin UI settings
|
||||||
|
admin: {
|
||||||
|
group: 'Marketing',
|
||||||
|
description: 'Email templates with enhanced security and categorization'
|
||||||
|
},
|
||||||
|
// Add custom fields to templates
|
||||||
|
fields: [
|
||||||
|
// Default plugin fields are automatically included
|
||||||
|
{
|
||||||
|
name: 'category',
|
||||||
|
type: 'select',
|
||||||
|
options: [
|
||||||
|
{ label: 'Marketing', value: 'marketing' },
|
||||||
|
{ label: 'Transactional', value: 'transactional' },
|
||||||
|
{ label: 'System Notifications', value: 'system' }
|
||||||
|
],
|
||||||
|
defaultValue: 'transactional',
|
||||||
|
admin: {
|
||||||
|
position: 'sidebar',
|
||||||
|
description: 'Template category for organization'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'tags',
|
||||||
|
type: 'text',
|
||||||
|
hasMany: true,
|
||||||
|
admin: {
|
||||||
|
position: 'sidebar',
|
||||||
|
description: 'Tags for easy template filtering'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'isActive',
|
||||||
|
type: 'checkbox',
|
||||||
|
defaultValue: true,
|
||||||
|
admin: {
|
||||||
|
position: 'sidebar',
|
||||||
|
description: 'Only active templates can be used'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
// Custom validation hooks
|
||||||
|
hooks: {
|
||||||
|
beforeChange: [
|
||||||
|
({ data, req }) => {
|
||||||
|
// Example: Only admins can create system templates
|
||||||
|
if (data.category === 'system' && req.user?.role !== 'admin') {
|
||||||
|
throw new Error('Only administrators can create system notification templates')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Example: Auto-generate slug if not provided
|
||||||
|
if (!data.slug && data.name) {
|
||||||
|
data.slug = data.name.toLowerCase()
|
||||||
|
.replace(/[^a-z0-9]/g, '-')
|
||||||
|
.replace(/-+/g, '-')
|
||||||
|
.replace(/^-|-$/g, '')
|
||||||
|
}
|
||||||
|
|
||||||
|
return data
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
emails: {
|
||||||
|
// Restrict access to emails collection
|
||||||
|
access: {
|
||||||
|
read: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:read')
|
||||||
|
},
|
||||||
|
create: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:create')
|
||||||
|
},
|
||||||
|
update: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin' || user.permissions?.includes('mailing:update')
|
||||||
|
},
|
||||||
|
delete: ({ req: { user } }) => {
|
||||||
|
if (!user) return false
|
||||||
|
return user.role === 'admin'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// Custom admin configuration for emails
|
||||||
|
admin: {
|
||||||
|
group: 'Marketing',
|
||||||
|
description: 'Email delivery tracking and management',
|
||||||
|
defaultColumns: ['subject', 'to', 'status', 'priority', 'scheduledAt'],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
*/
|
||||||
|
|
||||||
// Optional: Custom rich text editor configuration
|
// Optional: Custom rich text editor configuration
|
||||||
// Comment out to use default lexical editor
|
// Comment out to use default lexical editor
|
||||||
@@ -139,6 +281,12 @@ export default buildConfig({
|
|||||||
// etc.
|
// etc.
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
|
|
||||||
|
|
||||||
|
// Called after mailing plugin is fully initialized
|
||||||
|
onReady: async (payload) => {
|
||||||
|
await seedUser(payload)
|
||||||
|
},
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
secret: process.env.PAYLOAD_SECRET || 'test-secret_key',
|
secret: process.env.PAYLOAD_SECRET || 'test-secret_key',
|
||||||
@@ -147,3 +295,6 @@ export default buildConfig({
|
|||||||
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export default buildConfigWithMemoryDB()
|
||||||
|
|||||||
@@ -3,14 +3,26 @@
|
|||||||
// Development startup script for PayloadCMS Mailing Plugin
|
// Development startup script for PayloadCMS Mailing Plugin
|
||||||
// This ensures proper environment setup and provides helpful information
|
// This ensures proper environment setup and provides helpful information
|
||||||
|
|
||||||
|
console.log('🚀 PayloadCMS Mailing Plugin - Development Mode')
|
||||||
|
console.log('=' .repeat(50))
|
||||||
|
|
||||||
// Set development environment
|
// Set development environment
|
||||||
process.env.NODE_ENV = process.env.NODE_ENV || 'development'
|
process.env.NODE_ENV = process.env.NODE_ENV || 'development'
|
||||||
|
|
||||||
// Set default SQLite database for development
|
// Enable in-memory MongoDB by default for development
|
||||||
if (!process.env.DATABASE_URI) {
|
if (!process.env.DATABASE_URI) {
|
||||||
process.env.DATABASE_URI = 'file:./dev.db'
|
process.env.USE_MEMORY_DB = 'true'
|
||||||
|
console.log('📦 Using in-memory MongoDB (no installation required)')
|
||||||
|
} else {
|
||||||
|
console.log(`🔗 Using external MongoDB: ${process.env.DATABASE_URI}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
console.log('')
|
||||||
|
console.log('🔧 Starting development server...')
|
||||||
|
console.log('📧 Mailing plugin configured with test transport')
|
||||||
|
console.log('🎯 Test interface will be available at: /mailing-test')
|
||||||
|
console.log('')
|
||||||
|
|
||||||
// Import and start Next.js
|
// Import and start Next.js
|
||||||
import('next/dist/cli/next-dev.js')
|
import('next/dist/cli/next-dev.js')
|
||||||
.then(({ nextDev }) => {
|
.then(({ nextDev }) => {
|
||||||
@@ -23,9 +35,11 @@ import('next/dist/cli/next-dev.js')
|
|||||||
|
|
||||||
// Handle graceful shutdown
|
// Handle graceful shutdown
|
||||||
process.on('SIGTERM', () => {
|
process.on('SIGTERM', () => {
|
||||||
|
console.log('\n🛑 Shutting down development server...')
|
||||||
process.exit(0)
|
process.exit(0)
|
||||||
})
|
})
|
||||||
|
|
||||||
process.on('SIGINT', () => {
|
process.on('SIGINT', () => {
|
||||||
|
console.log('\n🛑 Shutting down development server...')
|
||||||
process.exit(0)
|
process.exit(0)
|
||||||
})
|
})
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@xtr-dev/payload-mailing",
|
"name": "@xtr-dev/payload-mailing",
|
||||||
"version": "0.4.21",
|
"version": "0.1.21",
|
||||||
"description": "Template-based email system with scheduling and job processing for PayloadCMS",
|
"description": "Template-based email system with scheduling and job processing for PayloadCMS",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@@ -23,6 +23,9 @@
|
|||||||
"dev:generate-importmap": "npm run dev:payload generate:importmap",
|
"dev:generate-importmap": "npm run dev:payload generate:importmap",
|
||||||
"dev:generate-types": "npm run dev:payload generate:types",
|
"dev:generate-types": "npm run dev:payload generate:types",
|
||||||
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
||||||
|
"payload": "cross-env NODE_OPTIONS=--no-deprecation payload",
|
||||||
|
"generate:importmap": "npm run payload generate:importmap",
|
||||||
|
"generate:types": "npm run payload generate:types",
|
||||||
"lint": "eslint",
|
"lint": "eslint",
|
||||||
"lint:fix": "eslint ./src --fix",
|
"lint:fix": "eslint ./src --fix",
|
||||||
"prepublishOnly": "npm run clean && npm run build",
|
"prepublishOnly": "npm run clean && npm run build",
|
||||||
|
|||||||
31
payload.config.ts
Normal file
31
payload.config.ts
Normal file
@@ -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'),
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -1,36 +1,13 @@
|
|||||||
import type { CollectionConfig } from 'payload'
|
import type { CollectionConfig } from 'payload'
|
||||||
import { findExistingJobs, ensureEmailJob, updateEmailJobRelationship } from '../utils/jobScheduler.js'
|
|
||||||
import { createContextLogger } from '../utils/logger.js'
|
|
||||||
import { resolveID } from '../utils/helpers.js'
|
|
||||||
|
|
||||||
const Emails: CollectionConfig = {
|
const Emails: CollectionConfig = {
|
||||||
slug: 'emails',
|
slug: 'emails',
|
||||||
admin: {
|
admin: {
|
||||||
useAsTitle: 'subject',
|
useAsTitle: 'subject',
|
||||||
defaultColumns: ['subject', 'to', 'status', 'jobs', 'scheduledAt', 'sentAt'],
|
defaultColumns: ['subject', 'to', 'status', 'scheduledAt', 'sentAt'],
|
||||||
group: 'Mailing',
|
group: 'Mailing',
|
||||||
description: 'Email delivery and status tracking',
|
description: 'Email delivery and status tracking',
|
||||||
},
|
},
|
||||||
defaultPopulate: {
|
|
||||||
templateSlug: true,
|
|
||||||
to: true,
|
|
||||||
cc: true,
|
|
||||||
bcc: true,
|
|
||||||
from: true,
|
|
||||||
replyTo: true,
|
|
||||||
jobs: true,
|
|
||||||
status: true,
|
|
||||||
attempts: true,
|
|
||||||
lastAttemptAt: true,
|
|
||||||
error: true,
|
|
||||||
priority: true,
|
|
||||||
scheduledAt: true,
|
|
||||||
sentAt: true,
|
|
||||||
variables: true,
|
|
||||||
html: true,
|
|
||||||
text: true,
|
|
||||||
createdAt: true,
|
|
||||||
},
|
|
||||||
fields: [
|
fields: [
|
||||||
{
|
{
|
||||||
name: 'template',
|
name: 'template',
|
||||||
@@ -40,14 +17,6 @@ const Emails: CollectionConfig = {
|
|||||||
description: 'Email template used (optional if custom content provided)',
|
description: 'Email template used (optional if custom content provided)',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: 'templateSlug',
|
|
||||||
type: 'text',
|
|
||||||
admin: {
|
|
||||||
description: 'Slug of the email template (auto-populated from template relationship)',
|
|
||||||
readOnly: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
name: 'to',
|
name: 'to',
|
||||||
type: 'text',
|
type: 'text',
|
||||||
@@ -195,98 +164,22 @@ const Emails: CollectionConfig = {
|
|||||||
description: 'Email priority (1=highest, 10=lowest)',
|
description: 'Email priority (1=highest, 10=lowest)',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: 'jobs',
|
|
||||||
type: 'relationship',
|
|
||||||
relationTo: 'payload-jobs',
|
|
||||||
hasMany: true,
|
|
||||||
admin: {
|
|
||||||
description: 'Processing jobs associated with this email',
|
|
||||||
allowCreate: false,
|
|
||||||
readOnly: true,
|
|
||||||
},
|
|
||||||
filterOptions: ({ id }) => {
|
|
||||||
const emailId = resolveID(id)
|
|
||||||
return {
|
|
||||||
'input.emailId': {
|
|
||||||
equals: emailId ? String(emailId) : '',
|
|
||||||
},
|
|
||||||
}
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
],
|
||||||
hooks: {
|
|
||||||
beforeChange: [
|
|
||||||
async ({ data, req }) => {
|
|
||||||
// Auto-populate templateSlug from template relationship
|
|
||||||
if (data.template) {
|
|
||||||
try {
|
|
||||||
const template = await req.payload.findByID({
|
|
||||||
collection: 'email-templates',
|
|
||||||
id: typeof data.template === 'string' ? data.template : data.template.id,
|
|
||||||
})
|
|
||||||
data.templateSlug = template.slug
|
|
||||||
} catch (error) {
|
|
||||||
// If template lookup fails, clear the slug
|
|
||||||
data.templateSlug = undefined
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Clear templateSlug if template is removed
|
|
||||||
data.templateSlug = undefined
|
|
||||||
}
|
|
||||||
return data
|
|
||||||
}
|
|
||||||
],
|
|
||||||
// Simple approach: Only use afterChange hook for job management
|
|
||||||
// This avoids complex interaction between hooks and ensures document ID is always available
|
|
||||||
afterChange: [
|
|
||||||
async ({ doc, previousDoc, req, operation }) => {
|
|
||||||
// Skip if:
|
|
||||||
// 1. Email is not pending status
|
|
||||||
// 2. Jobs are not configured
|
|
||||||
// 3. Email already has jobs (unless status just changed to pending)
|
|
||||||
|
|
||||||
const shouldSkip =
|
|
||||||
doc.status !== 'pending' ||
|
|
||||||
!req.payload.jobs ||
|
|
||||||
(doc.jobs?.length > 0 && previousDoc?.status === 'pending')
|
|
||||||
|
|
||||||
if (shouldSkip) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Ensure a job exists for this email
|
|
||||||
// This function handles:
|
|
||||||
// - Checking for existing jobs (duplicate prevention)
|
|
||||||
// - Creating new job if needed
|
|
||||||
// - Returning all job IDs
|
|
||||||
const result = await ensureEmailJob(req.payload, doc.id, {
|
|
||||||
scheduledAt: doc.scheduledAt,
|
|
||||||
})
|
|
||||||
|
|
||||||
// Update the email's job relationship if we have jobs
|
|
||||||
// This handles both new jobs and existing jobs that weren't in the relationship
|
|
||||||
if (result.jobIds.length > 0) {
|
|
||||||
await updateEmailJobRelationship(req.payload, doc.id, result.jobIds, 'emails')
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
// Log error but don't throw - we don't want to fail the email operation
|
|
||||||
const logger = createContextLogger(req.payload, 'EMAILS_HOOK')
|
|
||||||
logger.error(`Failed to ensure job for email ${doc.id}:`, error)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
timestamps: true,
|
timestamps: true,
|
||||||
indexes: [
|
// indexes: [
|
||||||
{
|
// {
|
||||||
fields: ['status', 'scheduledAt'],
|
// fields: {
|
||||||
},
|
// status: 1,
|
||||||
{
|
// scheduledAt: 1,
|
||||||
fields: ['priority', 'createdAt'],
|
// },
|
||||||
},
|
// },
|
||||||
],
|
// {
|
||||||
|
// fields: {
|
||||||
|
// priority: -1,
|
||||||
|
// createdAt: 1,
|
||||||
|
// },
|
||||||
|
// },
|
||||||
|
// ],
|
||||||
}
|
}
|
||||||
|
|
||||||
export default Emails
|
export default Emails
|
||||||
|
|||||||
16
src/index.ts
16
src/index.ts
@@ -11,9 +11,9 @@ export { MailingService } from './services/MailingService.js'
|
|||||||
export { default as EmailTemplates, createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
export { default as EmailTemplates, createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
||||||
export { default as Emails } from './collections/Emails.js'
|
export { default as Emails } from './collections/Emails.js'
|
||||||
|
|
||||||
// Jobs (includes the individual email processing job)
|
// Jobs (includes the send email task)
|
||||||
export { mailingJobs } from './jobs/index.js'
|
export { mailingJobs, sendEmailJob } from './jobs/index.js'
|
||||||
export type { ProcessEmailJobInput } from './jobs/processEmailJob.js'
|
export type { SendEmailTaskInput } from './jobs/sendEmailTask.js'
|
||||||
|
|
||||||
// Main email sending function
|
// Main email sending function
|
||||||
export { sendEmail, type SendEmailOptions } from './sendEmail.js'
|
export { sendEmail, type SendEmailOptions } from './sendEmail.js'
|
||||||
@@ -26,12 +26,4 @@ export {
|
|||||||
processEmails,
|
processEmails,
|
||||||
retryFailedEmails,
|
retryFailedEmails,
|
||||||
parseAndValidateEmails,
|
parseAndValidateEmails,
|
||||||
sanitizeDisplayName,
|
} from './utils/helpers.js'
|
||||||
sanitizeFromName,
|
|
||||||
} from './utils/helpers.js'
|
|
||||||
|
|
||||||
// Email processing utilities
|
|
||||||
export { processEmailById, processJobById, processAllEmails } from './utils/emailProcessor.js'
|
|
||||||
|
|
||||||
// Job scheduling utilities
|
|
||||||
export { findExistingJobs, ensureEmailJob, updateEmailJobRelationship } from './utils/jobScheduler.js'
|
|
||||||
@@ -1,11 +1,35 @@
|
|||||||
import { processEmailJob } from './processEmailJob.js'
|
import { processEmailsJob, ProcessEmailsJobData } from './processEmailsJob.js'
|
||||||
|
import { sendEmailJob } from './sendEmailTask.js'
|
||||||
|
import { MailingService } from '../services/MailingService.js'
|
||||||
|
|
||||||
/**
|
|
||||||
* All mailing-related jobs that get registered with Payload
|
|
||||||
*/
|
|
||||||
export const mailingJobs = [
|
export const mailingJobs = [
|
||||||
processEmailJob,
|
{
|
||||||
|
slug: 'processEmails',
|
||||||
|
handler: async ({ job, req }: { job: any; req: any }) => {
|
||||||
|
// Get mailing context from payload
|
||||||
|
const payload = (req as any).payload
|
||||||
|
const mailingContext = payload.mailing
|
||||||
|
if (!mailingContext) {
|
||||||
|
throw new Error('Mailing plugin not properly initialized')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use the existing mailing service from context
|
||||||
|
await processEmailsJob(
|
||||||
|
job as { data: ProcessEmailsJobData },
|
||||||
|
{ req, mailingService: mailingContext.service }
|
||||||
|
)
|
||||||
|
|
||||||
|
return {
|
||||||
|
output: {
|
||||||
|
success: true,
|
||||||
|
message: 'Email queue processing completed successfully'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
interfaceName: 'ProcessEmailsJob',
|
||||||
|
},
|
||||||
|
sendEmailJob,
|
||||||
]
|
]
|
||||||
|
|
||||||
// Re-export everything from individual job files
|
export * from './processEmailsJob.js'
|
||||||
export * from './processEmailJob.js'
|
export * from './sendEmailTask.js'
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
import type { PayloadRequest } from 'payload'
|
|
||||||
import { processEmailById } from '../utils/emailProcessor.js'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Data passed to the individual email processing job
|
|
||||||
*/
|
|
||||||
export interface ProcessEmailJobInput {
|
|
||||||
/**
|
|
||||||
* The ID of the email to process
|
|
||||||
*/
|
|
||||||
emailId: string | number
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Job definition for processing a single email
|
|
||||||
*/
|
|
||||||
export const processEmailJob = {
|
|
||||||
slug: 'process-email',
|
|
||||||
label: 'Process Individual Email',
|
|
||||||
inputSchema: [
|
|
||||||
{
|
|
||||||
name: 'emailId',
|
|
||||||
type: 'text' as const,
|
|
||||||
required: true,
|
|
||||||
label: 'Email ID',
|
|
||||||
admin: {
|
|
||||||
description: 'The ID of the email to process and send'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
outputSchema: [
|
|
||||||
{
|
|
||||||
name: 'success',
|
|
||||||
type: 'checkbox' as const
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: 'emailId',
|
|
||||||
type: 'text' as const
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: 'status',
|
|
||||||
type: 'text' as const
|
|
||||||
}
|
|
||||||
],
|
|
||||||
handler: async ({ input, req }: { input: ProcessEmailJobInput; req: PayloadRequest }) => {
|
|
||||||
const payload = (req as any).payload
|
|
||||||
const { emailId } = input
|
|
||||||
|
|
||||||
if (!emailId) {
|
|
||||||
throw new Error('Email ID is required for processing')
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Process the individual email
|
|
||||||
await processEmailById(payload, String(emailId))
|
|
||||||
|
|
||||||
return {
|
|
||||||
output: {
|
|
||||||
success: true,
|
|
||||||
emailId: String(emailId),
|
|
||||||
status: 'sent',
|
|
||||||
message: `Email ${emailId} processed successfully`
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
throw new Error(`Failed to process email ${emailId}: ${String(error)}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export default processEmailJob
|
|
||||||
50
src/jobs/processEmailsJob.ts
Normal file
50
src/jobs/processEmailsJob.ts
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
import type { PayloadRequest } from 'payload'
|
||||||
|
import { MailingService } from '../services/MailingService.js'
|
||||||
|
|
||||||
|
export interface ProcessEmailsJobData {
|
||||||
|
// No type needed - always processes both pending and failed emails
|
||||||
|
}
|
||||||
|
|
||||||
|
export const processEmailsJob = async (
|
||||||
|
job: { data: ProcessEmailsJobData },
|
||||||
|
context: { req: PayloadRequest; mailingService: MailingService }
|
||||||
|
) => {
|
||||||
|
const { mailingService } = context
|
||||||
|
|
||||||
|
try {
|
||||||
|
console.log('🔄 Processing email queue (pending + failed emails)...')
|
||||||
|
|
||||||
|
// Process pending emails first
|
||||||
|
await mailingService.processEmails()
|
||||||
|
|
||||||
|
// Then retry failed emails
|
||||||
|
await mailingService.retryFailedEmails()
|
||||||
|
|
||||||
|
console.log('✅ Email queue processing completed successfully (pending and failed emails)')
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Email queue processing failed:', error)
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const scheduleEmailsJob = async (
|
||||||
|
payload: any,
|
||||||
|
queueName: string,
|
||||||
|
delay?: number
|
||||||
|
) => {
|
||||||
|
if (!payload.jobs) {
|
||||||
|
console.warn('PayloadCMS jobs not configured - emails will not be processed automatically')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await payload.jobs.queue({
|
||||||
|
queue: queueName,
|
||||||
|
task: 'processEmails',
|
||||||
|
input: {},
|
||||||
|
waitUntil: delay ? new Date(Date.now() + delay) : undefined,
|
||||||
|
})
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Failed to schedule email processing job:', error)
|
||||||
|
}
|
||||||
|
}
|
||||||
223
src/jobs/sendEmailTask.ts
Normal file
223
src/jobs/sendEmailTask.ts
Normal file
@@ -0,0 +1,223 @@
|
|||||||
|
import { sendEmail } from '../sendEmail.js'
|
||||||
|
import { BaseEmailDocument } from '../types/index.js'
|
||||||
|
|
||||||
|
export interface SendEmailTaskInput {
|
||||||
|
// Template mode fields
|
||||||
|
templateSlug?: string
|
||||||
|
variables?: Record<string, any>
|
||||||
|
|
||||||
|
// Direct email mode fields
|
||||||
|
subject?: string
|
||||||
|
html?: string
|
||||||
|
text?: string
|
||||||
|
|
||||||
|
// Common fields
|
||||||
|
to: string | string[]
|
||||||
|
cc?: string | string[]
|
||||||
|
bcc?: string | string[]
|
||||||
|
from?: string
|
||||||
|
fromName?: string
|
||||||
|
replyTo?: string
|
||||||
|
scheduledAt?: string | Date // ISO date string or Date object
|
||||||
|
priority?: number
|
||||||
|
|
||||||
|
// Allow any additional fields that users might have in their email collection
|
||||||
|
[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', 'from', 'fromName', 'replyTo', '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',
|
||||||
|
inputSchema: [
|
||||||
|
{
|
||||||
|
name: 'templateSlug',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'Template Slug',
|
||||||
|
admin: {
|
||||||
|
description: 'Use a template (leave empty for direct email)',
|
||||||
|
condition: (data: any) => !data.subject && !data.html
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'variables',
|
||||||
|
type: 'json' as const,
|
||||||
|
label: 'Template Variables',
|
||||||
|
admin: {
|
||||||
|
description: 'JSON object with variables for template rendering',
|
||||||
|
condition: (data: any) => Boolean(data.templateSlug)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'subject',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'Subject',
|
||||||
|
admin: {
|
||||||
|
description: 'Email subject (required if not using template)',
|
||||||
|
condition: (data: any) => !data.templateSlug
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'html',
|
||||||
|
type: 'textarea' as const,
|
||||||
|
label: 'HTML Content',
|
||||||
|
admin: {
|
||||||
|
description: 'HTML email content (required if not using template)',
|
||||||
|
condition: (data: any) => !data.templateSlug
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'text',
|
||||||
|
type: 'textarea' as const,
|
||||||
|
label: 'Text Content',
|
||||||
|
admin: {
|
||||||
|
description: 'Plain text email content (optional)',
|
||||||
|
condition: (data: any) => !data.templateSlug
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'to',
|
||||||
|
type: 'text' as const,
|
||||||
|
required: true,
|
||||||
|
label: 'To (Email Recipients)',
|
||||||
|
admin: {
|
||||||
|
description: 'Comma-separated list of email addresses'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'cc',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'CC (Carbon Copy)',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional comma-separated list of CC email addresses'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'bcc',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'BCC (Blind Carbon Copy)',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional comma-separated list of BCC email addresses'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'from',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'From Email',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional sender email address (uses default if not provided)'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'fromName',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'From Name',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional sender display name (e.g., "John Doe")'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'replyTo',
|
||||||
|
type: 'text' as const,
|
||||||
|
label: 'Reply To',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional reply-to email address'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'scheduledAt',
|
||||||
|
type: 'date' as const,
|
||||||
|
label: 'Schedule For',
|
||||||
|
admin: {
|
||||||
|
description: 'Optional date/time to schedule email for future delivery'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'priority',
|
||||||
|
type: 'number' as const,
|
||||||
|
label: 'Priority',
|
||||||
|
min: 1,
|
||||||
|
max: 10,
|
||||||
|
defaultValue: 5,
|
||||||
|
admin: {
|
||||||
|
description: 'Email priority (1 = highest, 10 = lowest)'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
outputSchema: [
|
||||||
|
{
|
||||||
|
name: 'id',
|
||||||
|
type: 'text' as const
|
||||||
|
}
|
||||||
|
],
|
||||||
|
handler: async ({ input, payload }: any) => {
|
||||||
|
// Cast input to our expected type
|
||||||
|
const taskInput = input as SendEmailTaskInput
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 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<BaseEmailDocument>(payload, sendEmailOptions)
|
||||||
|
|
||||||
|
return {
|
||||||
|
output: {
|
||||||
|
success: true,
|
||||||
|
id: email.id,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} catch (error) {
|
||||||
|
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
|
||||||
436
src/payload-types.ts
Normal file
436
src/payload-types.ts
Normal file
@@ -0,0 +1,436 @@
|
|||||||
|
/* 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;
|
||||||
|
/**
|
||||||
|
* Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")
|
||||||
|
*/
|
||||||
|
fromName?: 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;
|
||||||
|
fromName?: 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 {}
|
||||||
|
}
|
||||||
@@ -3,12 +3,18 @@ import { MailingPluginConfig, MailingContext } from './types/index.js'
|
|||||||
import { MailingService } from './services/MailingService.js'
|
import { MailingService } from './services/MailingService.js'
|
||||||
import { createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
import { createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
||||||
import Emails from './collections/Emails.js'
|
import Emails from './collections/Emails.js'
|
||||||
import { mailingJobs } from './jobs/index.js'
|
import { mailingJobs, scheduleEmailsJob } from './jobs/index.js'
|
||||||
|
|
||||||
|
|
||||||
export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Config): Config => {
|
export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Config): Config => {
|
||||||
const queueName = pluginConfig.queue || 'default'
|
const queueName = pluginConfig.queue || 'default'
|
||||||
|
|
||||||
|
// Validate queueName
|
||||||
|
if (!queueName || typeof queueName !== 'string') {
|
||||||
|
throw new Error('Invalid queue configuration: queue must be a non-empty string')
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// Handle templates collection configuration
|
// Handle templates collection configuration
|
||||||
const templatesConfig = pluginConfig.collections?.templates
|
const templatesConfig = pluginConfig.collections?.templates
|
||||||
const templatesSlug = typeof templatesConfig === 'string' ? templatesConfig : 'email-templates'
|
const templatesSlug = typeof templatesConfig === 'string' ? templatesConfig : 'email-templates'
|
||||||
@@ -106,6 +112,21 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
|
|||||||
},
|
},
|
||||||
} as MailingContext
|
} as MailingContext
|
||||||
|
|
||||||
|
console.log('PayloadCMS Mailing Plugin initialized successfully')
|
||||||
|
|
||||||
|
// Schedule the initial email processing job
|
||||||
|
try {
|
||||||
|
await scheduleEmailsJob(payload, queueName, 60000) // Schedule in 1 minute
|
||||||
|
console.log(`🔄 Scheduled initial email processing job in queue: ${queueName}`)
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Failed to schedule email processing job:', error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Call onReady callback if provided
|
||||||
|
if (pluginConfig.onReady) {
|
||||||
|
await pluginConfig.onReady(payload)
|
||||||
|
}
|
||||||
|
|
||||||
if (pluginConfig.initOrder !== 'after' && config.onInit) {
|
if (pluginConfig.initOrder !== 'after' && config.onInit) {
|
||||||
await config.onInit(payload)
|
await config.onInit(payload)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
import { Payload } from 'payload'
|
import { Payload } from 'payload'
|
||||||
import { getMailing, renderTemplateWithId, parseAndValidateEmails, sanitizeFromName } from './utils/helpers.js'
|
import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
|
||||||
import { BaseEmailDocument } from './types/index.js'
|
import { BaseEmailDocument } from './types/index.js'
|
||||||
import { processJobById } from './utils/emailProcessor.js'
|
|
||||||
import { createContextLogger } from './utils/logger.js'
|
|
||||||
import { pollForJobId } from './utils/jobPolling.js'
|
|
||||||
|
|
||||||
// Options for sending emails
|
// Options for sending emails
|
||||||
export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
|
export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
|
||||||
@@ -16,8 +13,6 @@ export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocumen
|
|||||||
data?: Partial<T>
|
data?: Partial<T>
|
||||||
// Common options
|
// Common options
|
||||||
collectionSlug?: string // defaults to 'emails'
|
collectionSlug?: string // defaults to 'emails'
|
||||||
processImmediately?: boolean // if true, creates job and processes it immediately
|
|
||||||
queue?: string // queue name for the job, defaults to mailing config queue
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -44,22 +39,22 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
|||||||
payload: Payload,
|
payload: Payload,
|
||||||
options: SendEmailOptions<TEmail>
|
options: SendEmailOptions<TEmail>
|
||||||
): Promise<TEmail> => {
|
): Promise<TEmail> => {
|
||||||
const mailingConfig = getMailing(payload)
|
const mailing = getMailing(payload)
|
||||||
const collectionSlug = options.collectionSlug || mailingConfig.collections.emails || 'emails'
|
const collectionSlug = options.collectionSlug || mailing.collections.emails || 'emails'
|
||||||
|
|
||||||
let emailData: Partial<TEmail> = { ...options.data } as Partial<TEmail>
|
let emailData: Partial<TEmail> = { ...options.data } as Partial<TEmail>
|
||||||
|
|
||||||
|
// If using a template, render it first
|
||||||
if (options.template) {
|
if (options.template) {
|
||||||
// Look up and render the template in a single operation to avoid duplicate lookups
|
const { html, text, subject } = await renderTemplate(
|
||||||
const { html, text, subject, templateId } = await renderTemplateWithId(
|
|
||||||
payload,
|
payload,
|
||||||
options.template.slug,
|
options.template.slug,
|
||||||
options.template.variables || {}
|
options.template.variables || {}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Template values take precedence over data values
|
||||||
emailData = {
|
emailData = {
|
||||||
...emailData,
|
...emailData,
|
||||||
template: templateId,
|
|
||||||
subject,
|
subject,
|
||||||
html,
|
html,
|
||||||
text,
|
text,
|
||||||
@@ -71,16 +66,20 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
|||||||
throw new Error('Field "to" is required for sending emails')
|
throw new Error('Field "to" is required for sending emails')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate required fields based on whether template was used
|
||||||
if (options.template) {
|
if (options.template) {
|
||||||
|
// When using template, subject and html should have been set by renderTemplate
|
||||||
if (!emailData.subject || !emailData.html) {
|
if (!emailData.subject || !emailData.html) {
|
||||||
throw new Error(`Template rendering failed: template "${options.template.slug}" did not provide required subject and html content`)
|
throw new Error(`Template rendering failed: template "${options.template.slug}" did not provide required subject and html content`)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
// When not using template, user must provide subject and html directly
|
||||||
if (!emailData.subject || !emailData.html) {
|
if (!emailData.subject || !emailData.html) {
|
||||||
throw new Error('Fields "subject" and "html" are required when sending direct emails without a template')
|
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)
|
||||||
if (emailData.to) {
|
if (emailData.to) {
|
||||||
emailData.to = parseAndValidateEmails(emailData.to as string | string[])
|
emailData.to = parseAndValidateEmails(emailData.to as string | string[])
|
||||||
}
|
}
|
||||||
@@ -92,15 +91,27 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
|||||||
}
|
}
|
||||||
if (emailData.replyTo) {
|
if (emailData.replyTo) {
|
||||||
const validated = parseAndValidateEmails(emailData.replyTo as string | string[])
|
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
|
emailData.replyTo = validated && validated.length > 0 ? validated[0] : undefined
|
||||||
}
|
}
|
||||||
if (emailData.from) {
|
if (emailData.from) {
|
||||||
const validated = parseAndValidateEmails(emailData.from as string | string[])
|
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
|
emailData.from = validated && validated.length > 0 ? validated[0] : undefined
|
||||||
}
|
}
|
||||||
|
|
||||||
emailData.fromName = sanitizeFromName(emailData.fromName as string)
|
// Sanitize fromName to prevent header injection
|
||||||
|
if (emailData.fromName) {
|
||||||
|
emailData.fromName = emailData.fromName
|
||||||
|
.trim()
|
||||||
|
// Remove/replace newlines and carriage returns to prevent header injection
|
||||||
|
.replace(/[\r\n]/g, ' ')
|
||||||
|
// Remove control characters (except space and printable characters)
|
||||||
|
.replace(/[\x00-\x1F\x7F-\x9F]/g, '')
|
||||||
|
// Note: We don't escape quotes here as that's handled in MailingService
|
||||||
|
}
|
||||||
|
|
||||||
|
// Normalize Date objects to ISO strings for consistent database storage
|
||||||
if (emailData.scheduledAt instanceof Date) {
|
if (emailData.scheduledAt instanceof Date) {
|
||||||
emailData.scheduledAt = emailData.scheduledAt.toISOString()
|
emailData.scheduledAt = emailData.scheduledAt.toISOString()
|
||||||
}
|
}
|
||||||
@@ -117,40 +128,17 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
|||||||
emailData.updatedAt = emailData.updatedAt.toISOString()
|
emailData.updatedAt = emailData.updatedAt.toISOString()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Create the email in the collection with proper typing
|
||||||
const email = await payload.create({
|
const email = await payload.create({
|
||||||
collection: collectionSlug,
|
collection: collectionSlug,
|
||||||
data: emailData
|
data: emailData
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Validate that the created email has the expected structure
|
||||||
if (!email || typeof email !== 'object' || !email.id) {
|
if (!email || typeof email !== 'object' || !email.id) {
|
||||||
throw new Error('Failed to create email: invalid response from database')
|
throw new Error('Failed to create email: invalid response from database')
|
||||||
}
|
}
|
||||||
|
|
||||||
if (options.processImmediately) {
|
|
||||||
const logger = createContextLogger(payload, 'IMMEDIATE')
|
|
||||||
|
|
||||||
if (!payload.jobs) {
|
|
||||||
throw new Error('PayloadCMS jobs not configured - cannot process email immediately')
|
|
||||||
}
|
|
||||||
|
|
||||||
// Poll for the job ID using configurable polling mechanism
|
|
||||||
const { jobId } = await pollForJobId({
|
|
||||||
payload,
|
|
||||||
collectionSlug,
|
|
||||||
emailId: email.id,
|
|
||||||
config: mailingConfig.jobPolling,
|
|
||||||
logger,
|
|
||||||
})
|
|
||||||
|
|
||||||
try {
|
|
||||||
await processJobById(payload, jobId)
|
|
||||||
logger.debug(`Successfully processed email ${email.id} immediately`)
|
|
||||||
} catch (error) {
|
|
||||||
logger.error(`Failed to process email ${email.id} immediately:`, error)
|
|
||||||
throw new Error(`Failed to process email ${email.id} immediately: ${String(error)}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return email as TEmail
|
return email as TEmail
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,20 +1,23 @@
|
|||||||
import {CollectionSlug, EmailAdapter, Payload, SendEmailOptions} from 'payload'
|
import { Payload } from 'payload'
|
||||||
import { Liquid } from 'liquidjs'
|
import { Liquid } from 'liquidjs'
|
||||||
|
import nodemailer, { Transporter } from 'nodemailer'
|
||||||
import {
|
import {
|
||||||
MailingPluginConfig,
|
MailingPluginConfig,
|
||||||
TemplateVariables,
|
TemplateVariables,
|
||||||
MailingService as IMailingService,
|
MailingService as IMailingService,
|
||||||
BaseEmailDocument, BaseEmailTemplateDocument
|
MailingTransportConfig,
|
||||||
|
BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
|
||||||
} from '../types/index.js'
|
} from '../types/index.js'
|
||||||
import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
|
import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
|
||||||
import { sanitizeDisplayName } from '../utils/helpers.js'
|
|
||||||
|
|
||||||
export class MailingService implements IMailingService {
|
export class MailingService implements IMailingService {
|
||||||
public payload: Payload
|
public payload: Payload
|
||||||
private config: MailingPluginConfig
|
private config: MailingPluginConfig
|
||||||
|
private transporter!: Transporter | any
|
||||||
private templatesCollection: string
|
private templatesCollection: string
|
||||||
private emailsCollection: string
|
private emailsCollection: string
|
||||||
private liquid: Liquid | null | false = null
|
private liquid: Liquid | null | false = null
|
||||||
|
private transporterInitialized = false
|
||||||
|
|
||||||
constructor(payload: Payload, config: MailingPluginConfig) {
|
constructor(payload: Payload, config: MailingPluginConfig) {
|
||||||
this.payload = payload
|
this.payload = payload
|
||||||
@@ -26,27 +29,53 @@ export class MailingService implements IMailingService {
|
|||||||
const emailsConfig = config.collections?.emails
|
const emailsConfig = config.collections?.emails
|
||||||
this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
|
this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
|
||||||
|
|
||||||
// Use Payload's configured email adapter
|
// Only initialize transporter if payload is properly set
|
||||||
if (!this.payload.email) {
|
if (payload && payload.db) {
|
||||||
throw new Error('Payload email configuration is required. Please configure email in your Payload config.')
|
this.initializeTransporter()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private initializeTransporter(): void {
|
||||||
|
if (this.transporterInitialized) return
|
||||||
|
|
||||||
|
if (this.config.transport) {
|
||||||
|
if ('sendMail' in this.config.transport) {
|
||||||
|
this.transporter = this.config.transport
|
||||||
|
} else {
|
||||||
|
this.transporter = nodemailer.createTransport(this.config.transport as MailingTransportConfig)
|
||||||
|
}
|
||||||
|
} else if (this.payload.email && 'sendMail' in this.payload.email) {
|
||||||
|
// Use Payload's configured mailer (cast to any to handle different adapter types)
|
||||||
|
this.transporter = this.payload.email as any
|
||||||
|
} else {
|
||||||
|
throw new Error('Email transport configuration is required either in plugin config or Payload config')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.transporterInitialized = true
|
||||||
|
}
|
||||||
|
|
||||||
private ensureInitialized(): void {
|
private ensureInitialized(): void {
|
||||||
if (!this.payload || !this.payload.db) {
|
if (!this.payload || !this.payload.db) {
|
||||||
throw new Error('MailingService payload not properly initialized')
|
throw new Error('MailingService payload not properly initialized')
|
||||||
}
|
}
|
||||||
if (!this.payload.email) {
|
if (!this.transporterInitialized) {
|
||||||
throw new Error('Email adapter not configured. Please ensure Payload has email configured.')
|
this.initializeTransporter()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sanitizes a display name for use in email headers to prevent header injection
|
* Sanitizes a display name for use in email headers to prevent header injection
|
||||||
* Uses the centralized sanitization utility with quote escaping for headers
|
* and ensure proper formatting
|
||||||
*/
|
*/
|
||||||
private sanitizeDisplayName(name: string): string {
|
private sanitizeDisplayName(name: string): string {
|
||||||
return sanitizeDisplayName(name, true) // escapeQuotes = true for email headers
|
return name
|
||||||
|
.trim()
|
||||||
|
// Remove/replace newlines and carriage returns to prevent header injection
|
||||||
|
.replace(/[\r\n]/g, ' ')
|
||||||
|
// Remove control characters (except space and printable characters)
|
||||||
|
.replace(/[\x00-\x1F\x7F-\x9F]/g, '')
|
||||||
|
// Escape quotes to prevent malformed headers
|
||||||
|
.replace(/"/g, '\\"')
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -125,17 +154,6 @@ export class MailingService implements IMailingService {
|
|||||||
throw new Error(`Email template not found: ${templateSlug}`)
|
throw new Error(`Email template not found: ${templateSlug}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
return this.renderTemplateDocument(template, variables)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Render a template document (for when you already have the template loaded)
|
|
||||||
* This avoids duplicate template lookups
|
|
||||||
* @internal
|
|
||||||
*/
|
|
||||||
async renderTemplateDocument(template: BaseEmailTemplateDocument, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }> {
|
|
||||||
this.ensureInitialized()
|
|
||||||
|
|
||||||
const emailContent = await this.renderEmailTemplate(template, variables)
|
const emailContent = await this.renderEmailTemplate(template, variables)
|
||||||
const subject = await this.renderTemplateString(template.subject || '', variables)
|
const subject = await this.renderTemplateString(template.subject || '', variables)
|
||||||
|
|
||||||
@@ -151,7 +169,7 @@ export class MailingService implements IMailingService {
|
|||||||
const currentTime = new Date().toISOString()
|
const currentTime = new Date().toISOString()
|
||||||
|
|
||||||
const { docs: pendingEmails } = await this.payload.find({
|
const { docs: pendingEmails } = await this.payload.find({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
where: {
|
where: {
|
||||||
and: [
|
and: [
|
||||||
{
|
{
|
||||||
@@ -191,7 +209,7 @@ export class MailingService implements IMailingService {
|
|||||||
const retryTime = new Date(Date.now() - retryDelay).toISOString()
|
const retryTime = new Date(Date.now() - retryDelay).toISOString()
|
||||||
|
|
||||||
const { docs: failedEmails } = await this.payload.find({
|
const { docs: failedEmails } = await this.payload.find({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
where: {
|
where: {
|
||||||
and: [
|
and: [
|
||||||
{
|
{
|
||||||
@@ -228,10 +246,10 @@ export class MailingService implements IMailingService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async processEmailItem(emailId: string): Promise<void> {
|
private async processEmailItem(emailId: string): Promise<void> {
|
||||||
try {
|
try {
|
||||||
await this.payload.update({
|
await this.payload.update({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
data: {
|
data: {
|
||||||
status: 'processing',
|
status: 'processing',
|
||||||
@@ -240,9 +258,8 @@ export class MailingService implements IMailingService {
|
|||||||
})
|
})
|
||||||
|
|
||||||
const email = await this.payload.findByID({
|
const email = await this.payload.findByID({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
depth: 1,
|
|
||||||
}) as BaseEmailDocument
|
}) as BaseEmailDocument
|
||||||
|
|
||||||
// Combine from and fromName for nodemailer using proper sanitization
|
// Combine from and fromName for nodemailer using proper sanitization
|
||||||
@@ -253,7 +270,7 @@ export class MailingService implements IMailingService {
|
|||||||
fromField = this.getDefaultFrom()
|
fromField = this.getDefaultFrom()
|
||||||
}
|
}
|
||||||
|
|
||||||
let mailOptions: SendEmailOptions = {
|
let mailOptions: any = {
|
||||||
from: fromField,
|
from: fromField,
|
||||||
to: email.to,
|
to: email.to,
|
||||||
cc: email.cc || undefined,
|
cc: email.cc || undefined,
|
||||||
@@ -264,19 +281,6 @@ export class MailingService implements IMailingService {
|
|||||||
text: email.text || undefined,
|
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
|
// Call beforeSend hook if configured
|
||||||
if (this.config.beforeSend) {
|
if (this.config.beforeSend) {
|
||||||
try {
|
try {
|
||||||
@@ -301,11 +305,10 @@ export class MailingService implements IMailingService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Send email using Payload's email adapter
|
await this.transporter.sendMail(mailOptions)
|
||||||
await this.payload.email.sendEmail(mailOptions)
|
|
||||||
|
|
||||||
await this.payload.update({
|
await this.payload.update({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
data: {
|
data: {
|
||||||
status: 'sent',
|
status: 'sent',
|
||||||
@@ -319,7 +322,7 @@ export class MailingService implements IMailingService {
|
|||||||
const maxAttempts = this.config.retryAttempts || 3
|
const maxAttempts = this.config.retryAttempts || 3
|
||||||
|
|
||||||
await this.payload.update({
|
await this.payload.update({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
data: {
|
data: {
|
||||||
status: attempts >= maxAttempts ? 'failed' : 'pending',
|
status: attempts >= maxAttempts ? 'failed' : 'pending',
|
||||||
@@ -336,14 +339,14 @@ export class MailingService implements IMailingService {
|
|||||||
|
|
||||||
private async incrementAttempts(emailId: string): Promise<number> {
|
private async incrementAttempts(emailId: string): Promise<number> {
|
||||||
const email = await this.payload.findByID({
|
const email = await this.payload.findByID({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
})
|
}) as BaseEmail
|
||||||
|
|
||||||
const newAttempts = ((email as any).attempts || 0) + 1
|
const newAttempts = (email.attempts || 0) + 1
|
||||||
|
|
||||||
await this.payload.update({
|
await this.payload.update({
|
||||||
collection: this.emailsCollection as CollectionSlug,
|
collection: this.emailsCollection as any,
|
||||||
id: emailId,
|
id: emailId,
|
||||||
data: {
|
data: {
|
||||||
attempts: newAttempts,
|
attempts: newAttempts,
|
||||||
@@ -389,7 +392,7 @@ export class MailingService implements IMailingService {
|
|||||||
if (engine === 'liquidjs') {
|
if (engine === 'liquidjs') {
|
||||||
try {
|
try {
|
||||||
await this.ensureLiquidJSInitialized()
|
await this.ensureLiquidJSInitialized()
|
||||||
if (this.liquid) {
|
if (this.liquid && typeof this.liquid !== 'boolean') {
|
||||||
return await this.liquid.parseAndRender(template, variables)
|
return await this.liquid.parseAndRender(template, variables)
|
||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
import {Payload, SendEmailOptions} from 'payload'
|
import { Payload } from 'payload'
|
||||||
import type { CollectionConfig, RichTextField } from 'payload'
|
import type { CollectionConfig, RichTextField } from 'payload'
|
||||||
|
import { Transporter } from 'nodemailer'
|
||||||
// Payload ID type (string or number)
|
|
||||||
export type PayloadID = string | number
|
|
||||||
|
|
||||||
// Payload relation type - can be populated (object with id) or unpopulated (just the ID)
|
|
||||||
export type PayloadRelation<T extends { id: PayloadID }> = T | PayloadID
|
|
||||||
|
|
||||||
// JSON value type that matches Payload's JSON field type
|
// JSON value type that matches Payload's JSON field type
|
||||||
export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
|
export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
|
||||||
@@ -14,7 +9,6 @@ export type JSONValue = string | number | boolean | { [k: string]: unknown } | u
|
|||||||
export interface BaseEmailDocument {
|
export interface BaseEmailDocument {
|
||||||
id: string | number
|
id: string | number
|
||||||
template?: any
|
template?: any
|
||||||
templateSlug?: string | null
|
|
||||||
to: string[]
|
to: string[]
|
||||||
cc?: string[] | null
|
cc?: string[] | null
|
||||||
bcc?: string[] | null
|
bcc?: string[] | null
|
||||||
@@ -46,19 +40,29 @@ export interface BaseEmailTemplateDocument {
|
|||||||
updatedAt?: string | Date | 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}
|
||||||
|
|
||||||
|
export type BaseEmailTemplate<TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmailTemplate, 'id'>
|
||||||
|
|
||||||
export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
|
export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
|
||||||
|
|
||||||
export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
|
export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
|
||||||
|
|
||||||
export type BeforeSendHook = (options: SendEmailOptions, email: BaseEmailDocument) => SendEmailOptions | Promise<SendEmailOptions>
|
export interface BeforeSendMailOptions {
|
||||||
|
from: string
|
||||||
export interface JobPollingConfig {
|
to: string[]
|
||||||
maxAttempts?: number // Maximum number of polling attempts (default: 5)
|
cc?: string[]
|
||||||
initialDelay?: number // Initial delay in milliseconds (default: 25)
|
bcc?: string[]
|
||||||
maxTotalTime?: number // Maximum total polling time in milliseconds (default: 3000)
|
replyTo?: string
|
||||||
maxBackoffDelay?: number // Maximum delay between attempts in milliseconds (default: 400)
|
subject: string
|
||||||
|
html: string
|
||||||
|
text?: string
|
||||||
|
attachments?: any[]
|
||||||
|
[key: string]: any
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type BeforeSendHook = (options: BeforeSendMailOptions, email: BaseEmailDocument) => BeforeSendMailOptions | Promise<BeforeSendMailOptions>
|
||||||
|
|
||||||
export interface MailingPluginConfig {
|
export interface MailingPluginConfig {
|
||||||
collections?: {
|
collections?: {
|
||||||
templates?: string | Partial<CollectionConfig>
|
templates?: string | Partial<CollectionConfig>
|
||||||
@@ -66,6 +70,7 @@ export interface MailingPluginConfig {
|
|||||||
}
|
}
|
||||||
defaultFrom?: string
|
defaultFrom?: string
|
||||||
defaultFromName?: string
|
defaultFromName?: string
|
||||||
|
transport?: Transporter | MailingTransportConfig
|
||||||
queue?: string
|
queue?: string
|
||||||
retryAttempts?: number
|
retryAttempts?: number
|
||||||
retryDelay?: number
|
retryDelay?: number
|
||||||
@@ -73,10 +78,21 @@ export interface MailingPluginConfig {
|
|||||||
templateEngine?: TemplateEngine
|
templateEngine?: TemplateEngine
|
||||||
richTextEditor?: RichTextField['editor']
|
richTextEditor?: RichTextField['editor']
|
||||||
beforeSend?: BeforeSendHook
|
beforeSend?: BeforeSendHook
|
||||||
|
onReady?: (payload: any) => Promise<void>
|
||||||
initOrder?: 'before' | 'after'
|
initOrder?: 'before' | 'after'
|
||||||
jobPolling?: JobPollingConfig
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface MailingTransportConfig {
|
||||||
|
host: string
|
||||||
|
port: number
|
||||||
|
secure?: boolean
|
||||||
|
auth?: {
|
||||||
|
user: string
|
||||||
|
pass: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
export interface QueuedEmail {
|
export interface QueuedEmail {
|
||||||
id: string
|
id: string
|
||||||
template?: string | null
|
template?: string | null
|
||||||
@@ -108,7 +124,6 @@ export interface TemplateVariables {
|
|||||||
|
|
||||||
export interface MailingService {
|
export interface MailingService {
|
||||||
processEmails(): Promise<void>
|
processEmails(): Promise<void>
|
||||||
processEmailItem(emailId: string): Promise<void>
|
|
||||||
retryFailedEmails(): Promise<void>
|
retryFailedEmails(): Promise<void>
|
||||||
renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }>
|
renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }>
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,89 +0,0 @@
|
|||||||
import type { Payload } from 'payload'
|
|
||||||
import { createContextLogger } from './logger.js'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Processes a single email by ID using the mailing service
|
|
||||||
* @param payload Payload instance
|
|
||||||
* @param emailId The ID of the email to process
|
|
||||||
* @returns Promise that resolves when email is processed
|
|
||||||
*/
|
|
||||||
export async function processEmailById(payload: Payload, emailId: string): Promise<void> {
|
|
||||||
// Get mailing context from payload
|
|
||||||
const mailingContext = (payload as any).mailing
|
|
||||||
|
|
||||||
if (!mailingContext) {
|
|
||||||
throw new Error(
|
|
||||||
'Mailing plugin not found on payload instance. ' +
|
|
||||||
'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!mailingContext.service) {
|
|
||||||
throw new Error(
|
|
||||||
'Mailing service not available. ' +
|
|
||||||
'The plugin may not have completed initialization. ' +
|
|
||||||
'Check that email configuration is properly set up in your Payload config.'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Process the specific email
|
|
||||||
await mailingContext.service.processEmailItem(emailId)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Processes a job immediately by finding and executing it
|
|
||||||
* @param payload Payload instance
|
|
||||||
* @param jobId The ID of the job to run immediately
|
|
||||||
* @returns Promise that resolves when job is processed
|
|
||||||
*/
|
|
||||||
export async function processJobById(payload: Payload, jobId: string): Promise<void> {
|
|
||||||
if (!payload.jobs) {
|
|
||||||
throw new Error('PayloadCMS jobs not configured - cannot process job immediately')
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Run a specific job by its ID (using where clause to find the job)
|
|
||||||
const result = await payload.jobs.run({
|
|
||||||
where: {
|
|
||||||
id: {
|
|
||||||
equals: jobId
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
} catch (error) {
|
|
||||||
const logger = createContextLogger(payload, 'PROCESSOR')
|
|
||||||
logger.error(`Job ${jobId} execution failed:`, error)
|
|
||||||
throw new Error(`Failed to process job ${jobId}: ${String(error)}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Processes all pending and failed emails using the mailing service
|
|
||||||
* @param payload Payload instance
|
|
||||||
* @returns Promise that resolves when all emails are processed
|
|
||||||
*/
|
|
||||||
export async function processAllEmails(payload: Payload): Promise<void> {
|
|
||||||
// Get mailing context from payload
|
|
||||||
const mailingContext = (payload as any).mailing
|
|
||||||
|
|
||||||
if (!mailingContext) {
|
|
||||||
throw new Error(
|
|
||||||
'Mailing plugin not found on payload instance. ' +
|
|
||||||
'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!mailingContext.service) {
|
|
||||||
throw new Error(
|
|
||||||
'Mailing service not available. ' +
|
|
||||||
'The plugin may not have completed initialization. ' +
|
|
||||||
'Check that email configuration is properly set up in your Payload config.'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Process pending emails first
|
|
||||||
await mailingContext.service.processEmails()
|
|
||||||
|
|
||||||
// Then retry failed emails
|
|
||||||
await mailingContext.service.retryFailedEmails()
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { Payload } from 'payload'
|
import { Payload } from 'payload'
|
||||||
import { TemplateVariables, PayloadID, PayloadRelation } from '../types/index.js'
|
import { TemplateVariables } from '../types/index.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse and validate email addresses
|
* Parse and validate email addresses
|
||||||
@@ -36,87 +36,6 @@ export const parseAndValidateEmails = (emails: string | string[] | null | undefi
|
|||||||
return emailList
|
return emailList
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sanitize display names to prevent email header injection
|
|
||||||
* Removes newlines, carriage returns, and control characters
|
|
||||||
* @param displayName - The display name to sanitize
|
|
||||||
* @param escapeQuotes - Whether to escape quotes (for email headers)
|
|
||||||
* @returns Sanitized display name
|
|
||||||
*/
|
|
||||||
export const sanitizeDisplayName = (displayName: string, escapeQuotes = false): string => {
|
|
||||||
if (!displayName) return displayName
|
|
||||||
|
|
||||||
let sanitized = displayName
|
|
||||||
.trim()
|
|
||||||
// Remove/replace newlines and carriage returns to prevent header injection
|
|
||||||
.replace(/[\r\n]/g, ' ')
|
|
||||||
// Remove control characters (except space and printable characters)
|
|
||||||
.replace(/[\x00-\x1F\x7F-\x9F]/g, '')
|
|
||||||
|
|
||||||
// Escape quotes if needed (for email headers)
|
|
||||||
if (escapeQuotes) {
|
|
||||||
sanitized = sanitized.replace(/"/g, '\\"')
|
|
||||||
}
|
|
||||||
|
|
||||||
return sanitized
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sanitize and validate fromName for emails
|
|
||||||
* Wrapper around sanitizeDisplayName for consistent fromName handling
|
|
||||||
* @param fromName - The fromName to sanitize
|
|
||||||
* @returns Sanitized fromName or undefined if empty after sanitization
|
|
||||||
*/
|
|
||||||
export const sanitizeFromName = (fromName: string | null | undefined): string | undefined => {
|
|
||||||
if (!fromName) return undefined
|
|
||||||
|
|
||||||
const sanitized = sanitizeDisplayName(fromName, false)
|
|
||||||
return sanitized.length > 0 ? sanitized : undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Type guard to check if a Payload relation is populated (object) or unpopulated (ID)
|
|
||||||
*/
|
|
||||||
export const isPopulated = <T extends { id: PayloadID }>(
|
|
||||||
value: PayloadRelation<T> | null | undefined
|
|
||||||
): value is T => {
|
|
||||||
return value !== null && value !== undefined && typeof value === 'object' && 'id' in value
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Resolves a Payload relation to just the ID
|
|
||||||
* Handles both populated (object with id) and unpopulated (string/number) values
|
|
||||||
*/
|
|
||||||
export const resolveID = <T extends { id: PayloadID }>(
|
|
||||||
value: PayloadRelation<T> | null | undefined
|
|
||||||
): PayloadID | undefined => {
|
|
||||||
if (value === null || value === undefined) return undefined
|
|
||||||
|
|
||||||
if (typeof value === 'string' || typeof value === 'number') {
|
|
||||||
return value
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof value === 'object' && 'id' in value) {
|
|
||||||
return value.id
|
|
||||||
}
|
|
||||||
|
|
||||||
return undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Resolves an array of Payload relations to an array of IDs
|
|
||||||
* Handles mixed arrays of populated and unpopulated values
|
|
||||||
*/
|
|
||||||
export const resolveIDs = <T extends { id: PayloadID }>(
|
|
||||||
values: (PayloadRelation<T> | null | undefined)[] | null | undefined
|
|
||||||
): PayloadID[] => {
|
|
||||||
if (!values || !Array.isArray(values)) return []
|
|
||||||
|
|
||||||
return values
|
|
||||||
.map(value => resolveID(value))
|
|
||||||
.filter((id): id is PayloadID => id !== undefined)
|
|
||||||
}
|
|
||||||
|
|
||||||
export const getMailing = (payload: Payload) => {
|
export const getMailing = (payload: Payload) => {
|
||||||
const mailing = (payload as any).mailing
|
const mailing = (payload as any).mailing
|
||||||
if (!mailing) {
|
if (!mailing) {
|
||||||
@@ -130,53 +49,6 @@ export const renderTemplate = async (payload: Payload, templateSlug: string, var
|
|||||||
return mailing.service.renderTemplate(templateSlug, variables)
|
return mailing.service.renderTemplate(templateSlug, variables)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Render a template and return both rendered content and template ID
|
|
||||||
* This is used by sendEmail to avoid duplicate template lookups
|
|
||||||
* @internal
|
|
||||||
*/
|
|
||||||
export const renderTemplateWithId = async (
|
|
||||||
payload: Payload,
|
|
||||||
templateSlug: string,
|
|
||||||
variables: TemplateVariables
|
|
||||||
): Promise<{ html: string; text: string; subject: string; templateId: PayloadID }> => {
|
|
||||||
const mailing = getMailing(payload)
|
|
||||||
const templatesCollection = mailing.config.collections?.templates || 'email-templates'
|
|
||||||
|
|
||||||
// Runtime validation: Ensure the collection exists in Payload
|
|
||||||
if (!payload.collections[templatesCollection]) {
|
|
||||||
throw new Error(
|
|
||||||
`Templates collection '${templatesCollection}' not found. ` +
|
|
||||||
`Available collections: ${Object.keys(payload.collections).join(', ')}`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Look up the template document once
|
|
||||||
const { docs: templateDocs } = await payload.find({
|
|
||||||
collection: templatesCollection as any,
|
|
||||||
where: {
|
|
||||||
slug: {
|
|
||||||
equals: templateSlug,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
limit: 1,
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!templateDocs || templateDocs.length === 0) {
|
|
||||||
throw new Error(`Template not found: ${templateSlug}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
const templateDoc = templateDocs[0]
|
|
||||||
|
|
||||||
// Render using the document directly to avoid duplicate lookup
|
|
||||||
const rendered = await mailing.service.renderTemplateDocument(templateDoc, variables)
|
|
||||||
|
|
||||||
return {
|
|
||||||
...rendered,
|
|
||||||
templateId: templateDoc.id,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const processEmails = async (payload: Payload): Promise<void> => {
|
export const processEmails = async (payload: Payload): Promise<void> => {
|
||||||
const mailing = getMailing(payload)
|
const mailing = getMailing(payload)
|
||||||
return mailing.service.processEmails()
|
return mailing.service.processEmails()
|
||||||
|
|||||||
@@ -1,115 +0,0 @@
|
|||||||
import { Payload } from 'payload'
|
|
||||||
import { JobPollingConfig } from '../types/index.js'
|
|
||||||
|
|
||||||
export interface PollForJobIdOptions {
|
|
||||||
payload: Payload
|
|
||||||
collectionSlug: string
|
|
||||||
emailId: string | number
|
|
||||||
config?: JobPollingConfig
|
|
||||||
logger?: {
|
|
||||||
debug: (message: string, ...args: any[]) => void
|
|
||||||
info: (message: string, ...args: any[]) => void
|
|
||||||
warn: (message: string, ...args: any[]) => void
|
|
||||||
error: (message: string, ...args: any[]) => void
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface PollForJobIdResult {
|
|
||||||
jobId: string
|
|
||||||
attempts: number
|
|
||||||
elapsedTime: number
|
|
||||||
}
|
|
||||||
|
|
||||||
// Default job polling configuration values
|
|
||||||
const DEFAULT_JOB_POLLING_CONFIG: Required<JobPollingConfig> = {
|
|
||||||
maxAttempts: 5,
|
|
||||||
initialDelay: 25,
|
|
||||||
maxTotalTime: 3000,
|
|
||||||
maxBackoffDelay: 400,
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Polls for a job ID associated with an email document using exponential backoff.
|
|
||||||
* This utility handles the complexity of waiting for auto-scheduled jobs to be created.
|
|
||||||
*
|
|
||||||
* The polling mechanism uses exponential backoff with configurable parameters:
|
|
||||||
* - Starts with an initial delay and doubles on each retry
|
|
||||||
* - Caps individual delays at maxBackoffDelay
|
|
||||||
* - Enforces a maximum total polling time
|
|
||||||
*
|
|
||||||
* @param options - Polling options including payload, collection, email ID, and config
|
|
||||||
* @returns Promise resolving to job ID and timing information
|
|
||||||
* @throws Error if job is not found within the configured limits
|
|
||||||
*/
|
|
||||||
export const pollForJobId = async (options: PollForJobIdOptions): Promise<PollForJobIdResult> => {
|
|
||||||
const { payload, collectionSlug, emailId, logger } = options
|
|
||||||
|
|
||||||
// Merge user config with defaults
|
|
||||||
const config: Required<JobPollingConfig> = {
|
|
||||||
...DEFAULT_JOB_POLLING_CONFIG,
|
|
||||||
...options.config,
|
|
||||||
}
|
|
||||||
|
|
||||||
const { maxAttempts, initialDelay, maxTotalTime, maxBackoffDelay } = config
|
|
||||||
const startTime = Date.now()
|
|
||||||
let jobId: string | undefined
|
|
||||||
|
|
||||||
for (let attempt = 0; attempt < maxAttempts; attempt++) {
|
|
||||||
const elapsedTime = Date.now() - startTime
|
|
||||||
|
|
||||||
// Check if we've exceeded the maximum total polling time
|
|
||||||
if (elapsedTime > maxTotalTime) {
|
|
||||||
throw new Error(
|
|
||||||
`Job polling timed out after ${maxTotalTime}ms for email ${emailId}. ` +
|
|
||||||
`The auto-scheduling may have failed or is taking longer than expected.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Calculate exponential backoff delay, capped at maxBackoffDelay
|
|
||||||
const delay = Math.min(initialDelay * Math.pow(2, attempt), maxBackoffDelay)
|
|
||||||
|
|
||||||
// Wait before checking (skip on first attempt)
|
|
||||||
if (attempt > 0) {
|
|
||||||
await new Promise(resolve => setTimeout(resolve, delay))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch the email document to check for associated jobs
|
|
||||||
const emailWithJobs = await payload.findByID({
|
|
||||||
collection: collectionSlug,
|
|
||||||
id: emailId,
|
|
||||||
})
|
|
||||||
|
|
||||||
// Check if jobs array exists and has entries
|
|
||||||
if (emailWithJobs.jobs && emailWithJobs.jobs.length > 0) {
|
|
||||||
const firstJob = Array.isArray(emailWithJobs.jobs) ? emailWithJobs.jobs[0] : emailWithJobs.jobs
|
|
||||||
jobId = typeof firstJob === 'string' ? firstJob : String(firstJob.id || firstJob)
|
|
||||||
|
|
||||||
return {
|
|
||||||
jobId,
|
|
||||||
attempts: attempt + 1,
|
|
||||||
elapsedTime: Date.now() - startTime,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log progress for attempts after the second try
|
|
||||||
if (attempt >= 2 && logger) {
|
|
||||||
logger.debug(`Waiting for job creation for email ${emailId}, attempt ${attempt + 1}/${maxAttempts}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we reach here, job was not found
|
|
||||||
const elapsedTime = Date.now() - startTime
|
|
||||||
const timeoutMsg = elapsedTime >= maxTotalTime
|
|
||||||
const errorType = timeoutMsg ? 'POLLING_TIMEOUT' : 'JOB_NOT_FOUND'
|
|
||||||
const baseMessage = timeoutMsg
|
|
||||||
? `Job polling timed out after ${maxTotalTime}ms for email ${emailId}`
|
|
||||||
: `No processing job found for email ${emailId} after ${maxAttempts} attempts (${elapsedTime}ms)`
|
|
||||||
|
|
||||||
throw new Error(
|
|
||||||
`${errorType}: ${baseMessage}. ` +
|
|
||||||
`This indicates the email was created but job auto-scheduling failed. ` +
|
|
||||||
`The email exists in the database but immediate processing cannot proceed. ` +
|
|
||||||
`You may need to: 1) Check job queue configuration, 2) Verify database hooks are working, ` +
|
|
||||||
`3) Process the email later using processEmailById('${emailId}').`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,152 +0,0 @@
|
|||||||
import type { Payload } from 'payload'
|
|
||||||
import { createContextLogger } from './logger.js'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Finds existing processing jobs for an email
|
|
||||||
*/
|
|
||||||
export async function findExistingJobs(
|
|
||||||
payload: Payload,
|
|
||||||
emailId: string | number
|
|
||||||
): Promise<{ docs: any[], totalDocs: number }> {
|
|
||||||
return await payload.find({
|
|
||||||
collection: 'payload-jobs',
|
|
||||||
where: {
|
|
||||||
'input.emailId': {
|
|
||||||
equals: String(emailId),
|
|
||||||
},
|
|
||||||
task: {
|
|
||||||
equals: 'process-email',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
limit: 10,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Ensures a processing job exists for an email
|
|
||||||
* Creates one if it doesn't exist, or returns existing job IDs
|
|
||||||
*
|
|
||||||
* This function is idempotent and safe for concurrent calls:
|
|
||||||
* - Uses atomic check-and-create pattern with retry logic
|
|
||||||
* - Multiple concurrent calls will only create one job
|
|
||||||
* - Database-level uniqueness prevents duplicate jobs
|
|
||||||
* - Race conditions are handled with exponential backoff retry
|
|
||||||
*/
|
|
||||||
export async function ensureEmailJob(
|
|
||||||
payload: Payload,
|
|
||||||
emailId: string | number,
|
|
||||||
options?: {
|
|
||||||
scheduledAt?: string | Date
|
|
||||||
queueName?: string
|
|
||||||
}
|
|
||||||
): Promise<{ jobIds: (string | number)[], created: boolean }> {
|
|
||||||
if (!payload.jobs) {
|
|
||||||
throw new Error('PayloadCMS jobs not configured - cannot create email job')
|
|
||||||
}
|
|
||||||
|
|
||||||
const normalizedEmailId = String(emailId)
|
|
||||||
const mailingContext = (payload as any).mailing
|
|
||||||
const queueName = options?.queueName || mailingContext?.config?.queue || 'default'
|
|
||||||
|
|
||||||
const logger = createContextLogger(payload, 'JOB_SCHEDULER')
|
|
||||||
|
|
||||||
// First, optimistically try to create the job
|
|
||||||
// If it fails due to uniqueness constraint, then check for existing jobs
|
|
||||||
// This approach minimizes the race condition window
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Attempt to create job - rely on database constraints for duplicate prevention
|
|
||||||
const job = await payload.jobs.queue({
|
|
||||||
queue: queueName,
|
|
||||||
task: 'process-email',
|
|
||||||
input: {
|
|
||||||
emailId: normalizedEmailId
|
|
||||||
},
|
|
||||||
waitUntil: options?.scheduledAt ? new Date(options.scheduledAt) : undefined
|
|
||||||
})
|
|
||||||
|
|
||||||
logger.info(`Auto-scheduled processing job ${job.id} for email ${normalizedEmailId}`)
|
|
||||||
|
|
||||||
return {
|
|
||||||
jobIds: [job.id],
|
|
||||||
created: true
|
|
||||||
}
|
|
||||||
} catch (createError) {
|
|
||||||
|
|
||||||
// Job creation failed - likely due to duplicate constraint or system issue
|
|
||||||
|
|
||||||
// Check if duplicate jobs exist (handles race condition where another process created job)
|
|
||||||
const existingJobs = await findExistingJobs(payload, normalizedEmailId)
|
|
||||||
|
|
||||||
|
|
||||||
if (existingJobs.totalDocs > 0) {
|
|
||||||
// Found existing jobs - return them (race condition handled successfully)
|
|
||||||
logger.debug(`Using existing jobs for email ${normalizedEmailId}: ${existingJobs.docs.map(j => j.id).join(', ')}`)
|
|
||||||
return {
|
|
||||||
jobIds: existingJobs.docs.map(job => job.id),
|
|
||||||
created: false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// No existing jobs found - this is a genuine error
|
|
||||||
// Enhanced error context for better debugging
|
|
||||||
const errorMessage = String(createError)
|
|
||||||
const isLikelyUniqueConstraint = errorMessage.toLowerCase().includes('duplicate') ||
|
|
||||||
errorMessage.toLowerCase().includes('unique') ||
|
|
||||||
errorMessage.toLowerCase().includes('constraint')
|
|
||||||
|
|
||||||
if (isLikelyUniqueConstraint) {
|
|
||||||
// This should not happen if our check above worked, but provide a clear error
|
|
||||||
logger.warn(`Unique constraint violation but no existing jobs found for email ${normalizedEmailId}`)
|
|
||||||
throw new Error(
|
|
||||||
`Database uniqueness constraint violation for email ${normalizedEmailId}, but no existing jobs found. ` +
|
|
||||||
`This indicates a potential data consistency issue. Original error: ${errorMessage}`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Non-constraint related error
|
|
||||||
logger.error(`Job creation error for email ${normalizedEmailId}: ${errorMessage}`)
|
|
||||||
throw new Error(`Failed to create job for email ${normalizedEmailId}: ${errorMessage}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Updates an email document to include job IDs in the relationship field
|
|
||||||
*/
|
|
||||||
export async function updateEmailJobRelationship(
|
|
||||||
payload: Payload,
|
|
||||||
emailId: string | number,
|
|
||||||
jobIds: (string | number)[],
|
|
||||||
collectionSlug: string = 'emails'
|
|
||||||
): Promise<void> {
|
|
||||||
try {
|
|
||||||
const normalizedEmailId = String(emailId)
|
|
||||||
const normalizedJobIds = jobIds.map(id => String(id))
|
|
||||||
|
|
||||||
// Get current jobs to avoid overwriting
|
|
||||||
const currentEmail = await payload.findByID({
|
|
||||||
collection: collectionSlug,
|
|
||||||
id: normalizedEmailId,
|
|
||||||
})
|
|
||||||
|
|
||||||
// Extract IDs from job objects or use the value directly if it's already an ID
|
|
||||||
// Jobs can be populated (objects with id field) or just IDs (strings/numbers)
|
|
||||||
const currentJobs = (currentEmail.jobs || []).map((job: any) =>
|
|
||||||
typeof job === 'object' && job !== null && job.id ? String(job.id) : String(job)
|
|
||||||
)
|
|
||||||
const allJobs = [...new Set([...currentJobs, ...normalizedJobIds])] // Deduplicate with normalized strings
|
|
||||||
|
|
||||||
await payload.update({
|
|
||||||
collection: collectionSlug,
|
|
||||||
id: normalizedEmailId,
|
|
||||||
data: {
|
|
||||||
jobs: allJobs
|
|
||||||
}
|
|
||||||
})
|
|
||||||
} catch (error) {
|
|
||||||
const normalizedEmailId = String(emailId)
|
|
||||||
const logger = createContextLogger(payload, 'JOB_SCHEDULER')
|
|
||||||
logger.error(`Failed to update email ${normalizedEmailId} with job relationship:`, error)
|
|
||||||
throw error
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
import type { Payload } from 'payload'
|
|
||||||
|
|
||||||
let pluginLogger: any = null
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get or create the plugin logger instance
|
|
||||||
* Uses PAYLOAD_MAILING_LOG_LEVEL environment variable to configure log level
|
|
||||||
* Defaults to 'info' if not set
|
|
||||||
*/
|
|
||||||
export function getPluginLogger(payload: Payload) {
|
|
||||||
if (!pluginLogger && payload.logger) {
|
|
||||||
const logLevel = process.env.PAYLOAD_MAILING_LOG_LEVEL || 'info'
|
|
||||||
|
|
||||||
pluginLogger = payload.logger.child({
|
|
||||||
level: logLevel,
|
|
||||||
plugin: '@xtr-dev/payload-mailing'
|
|
||||||
})
|
|
||||||
|
|
||||||
// Log the configured log level on first initialization
|
|
||||||
pluginLogger.info(`Logger initialized with level: ${logLevel}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback to console if logger not available (shouldn't happen in normal operation)
|
|
||||||
if (!pluginLogger) {
|
|
||||||
return {
|
|
||||||
debug: (...args: any[]) => console.log('[MAILING DEBUG]', ...args),
|
|
||||||
info: (...args: any[]) => console.log('[MAILING INFO]', ...args),
|
|
||||||
warn: (...args: any[]) => console.warn('[MAILING WARN]', ...args),
|
|
||||||
error: (...args: any[]) => console.error('[MAILING ERROR]', ...args),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return pluginLogger
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a context-specific logger for a particular operation
|
|
||||||
*/
|
|
||||||
export function createContextLogger(payload: Payload, context: string) {
|
|
||||||
const logger = getPluginLogger(payload)
|
|
||||||
|
|
||||||
return {
|
|
||||||
debug: (message: string, ...args: any[]) => logger.debug(`[${context}] ${message}`, ...args),
|
|
||||||
info: (message: string, ...args: any[]) => logger.info(`[${context}] ${message}`, ...args),
|
|
||||||
warn: (message: string, ...args: any[]) => logger.warn(`[${context}] ${message}`, ...args),
|
|
||||||
error: (message: string, ...args: any[]) => logger.error(`[${context}] ${message}`, ...args),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user