xtr.dev/payload-mailing
1
0
Fork 0
mirror of https://github.com/xtr-dev/payload-mailing.git synced 2025-12-10 08:13:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #32 from xtr-dev/dev

Browse Source 
Dev
This commit is contained in:
Bas
2025-09-13 23:48:28 +02:00
committed by GitHub
parent ff788c1ecf 6886027727
commit 8a447ec9ab
3 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CUSTOM-TYPES.md
View File

@@ -44,6 +44,8 @@ The plugin works with:
- **String IDs**: `id: string`
- **Number IDs**: `id: number`
- **Nullable fields**: Fields can be `null`, `undefined`, or have values
- **Date fields**: Timestamp fields support both `Date` objects and `string` (ISO) formats
- **JSON variables**: Variables field supports any JSON-compatible value type
- **Generated types**: Works with `payload generate:types` output
Your Payload configuration determines which types are used. The plugin automatically adapts to your setup.
@@ -68,15 +70,15 @@ interface BaseEmailDocument {
html: string
text?: string | null
variables?: JSONValue // Supports any JSON-compatible value
scheduledAt?: string | null
sentAt?: string | null
scheduledAt?: string | Date | null
sentAt?: string | Date | null
status?: 'pending' | 'processing' | 'sent' | 'failed' | null
attempts?: number | null
lastAttemptAt?: string | null
lastAttemptAt?: string | Date | null
error?: string | null
priority?: number | null
createdAt?: string | null
updatedAt?: string | null
createdAt?: string | Date | null
updatedAt?: string | Date | null
}
interface BaseEmailTemplateDocument {
@@ -85,8 +87,8 @@ interface BaseEmailTemplateDocument {
slug: string
subject?: string | null
content?: any
createdAt?: string | null
updatedAt?: string | null
createdAt?: string | Date | null
updatedAt?: string | Date | null
}
```

2
package.json
View File

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

20
src/types/index.ts
View File

@@ -18,15 +18,15 @@ export interface BaseEmailDocument {
html: string
text?: string | null
variables?: JSONValue
scheduledAt?: string | null
sentAt?: string | null
scheduledAt?: string | Date | null
sentAt?: string | Date | null
status?: 'pending' | 'processing' | 'sent' | 'failed' | null
attempts?: number | null
lastAttemptAt?: string | null
lastAttemptAt?: string | Date | null
error?: string | null
priority?: number | null
createdAt?: string | null
updatedAt?: string | null
createdAt?: string | Date | null
updatedAt?: string | Date | null
}
export interface BaseEmailTemplateDocument {
@@ -35,8 +35,8 @@ export interface BaseEmailTemplateDocument {
slug: string
subject?: string | null
content?: any
createdAt?: string | null
updatedAt?: string | null
createdAt?: 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}
@@ -88,11 +88,11 @@ export interface QueuedEmail {
html: string
text?: string | null
variables?: JSONValue
scheduledAt?: string | null
sentAt?: string | null
scheduledAt?: string | Date | null
sentAt?: string | Date | null
status: 'pending' | 'processing' | 'sent' | 'failed'
attempts: number
lastAttemptAt?: string | null
lastAttemptAt?: string | Date | null
error?: string | null
priority?: number | null
createdAt: string