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

Fix variables field type to support all JSON-compatible values

Browse Source 
- Replace restrictive Record<string, any> with flexible JSONValue type for variables field
- Add JSONValue type alias that matches Payload's JSON field type specification
- Support string, number, boolean, objects, arrays, null, and undefined for variables
- Update both BaseEmailDocument and QueuedEmail interfaces consistently
- Update documentation to reflect JSONValue support

Fixes type constraint error where customer Email.variables field type
(string | number | boolean | {...} | unknown[] | null | undefined)
was not assignable to Record<string, any>.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Bas van den Aakster
2025-09-13 23:38:46 +02:00
parent ecc0b0a73e
commit 4dcbc1446a
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CUSTOM-TYPES.md
View File

@@ -53,6 +53,9 @@ Your Payload configuration determines which types are used. The plugin automatic
The base interfaces provided by the plugin: The base interfaces provided by the plugin:
```typescript ```typescript
// JSON value type that matches Payload's JSON field type
type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
interface BaseEmailDocument { interface BaseEmailDocument {
id: string | number id: string | number
template?: any template?: any
@@ -64,7 +67,7 @@ interface BaseEmailDocument {
subject: string subject: string
html: string html: string
text?: string | null text?: string | null
variables?: Record<string, any> | null variables?: JSONValue // Supports any JSON-compatible value
scheduledAt?: string | null scheduledAt?: string | null
sentAt?: string | null sentAt?: string | null
status?: 'pending' | 'processing' | 'sent' | 'failed' | null status?: 'pending' | 'processing' | 'sent' | 'failed' | null

7
src/types/index.ts
View File

@@ -2,6 +2,9 @@ import { Payload } from 'payload'
import type { CollectionConfig, RichTextField } from 'payload' import type { CollectionConfig, RichTextField } from 'payload'
import { Transporter } from 'nodemailer' import { Transporter } from 'nodemailer'
// JSON value type that matches Payload's JSON field type
export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
// Generic base interfaces that work with any ID type and null values // Generic base interfaces that work with any ID type and null values
export interface BaseEmailDocument { export interface BaseEmailDocument {
id: string | number id: string | number
@@ -14,7 +17,7 @@ export interface BaseEmailDocument {
subject: string subject: string
html: string html: string
text?: string | null text?: string | null
variables?: Record<string, any> | null variables?: JSONValue
scheduledAt?: string | null scheduledAt?: string | null
sentAt?: string | null sentAt?: string | null
status?: 'pending' | 'processing' | 'sent' | 'failed' | null status?: 'pending' | 'processing' | 'sent' | 'failed' | null
@@ -84,7 +87,7 @@ export interface QueuedEmail {
subject: string subject: string
html: string html: string
text?: string | null text?: string | null
variables?: Record<string, any> | null variables?: JSONValue
scheduledAt?: string | null scheduledAt?: string | null
sentAt?: string | null sentAt?: string | null
status: 'pending' | 'processing' | 'sent' | 'failed' status: 'pending' | 'processing' | 'sent' | 'failed'