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

WIP: Refactor triggers to TriggerConfig pattern

Browse Source 
- Convert webhook, global, and cron triggers to use TriggerConfig pattern like collectionTrigger
- Simplify trigger slug names (remove '-trigger' suffix)
- Update validation to use new slug names
- Add perfectionist/sort-exports rule disable
- Note: Workflow.ts integration still needs fixes for type compatibility
This commit is contained in:
Bas van den Aakster
2025-09-10 13:48:26 +02:00
parent 9a3b94ef60
commit b18e2eaf49
9 changed files with 208 additions and 225 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
eslint.config.js
View File

@@ -30,6 +30,7 @@ export default [
'no-console': 'off',
'perfectionist/sort-object-types': 'off',
'perfectionist/sort-objects': 'off',
'perfectionist/sort-exports': 'off',
},
},
{

40
src/collections/Workflow.ts
View File

@@ -1,18 +1,19 @@
import type {CollectionConfig, Field} from 'payload'
import type {WorkflowsPluginConfig} from "../plugin/config-types.js"
import {
getCollectionTriggerFields,
getCronTriggerFields,
getGlobalTriggerFields,
getWebhookTriggerFields
} from '../triggers/index.js'
export const createWorkflowCollection: <T extends string>(options: WorkflowsPluginConfig<T>) => CollectionConfig = ({
collectionTriggers,
steps,
triggers
}) => ({
import {
collectionTrigger,
cronTrigger,
globalTrigger,
webhookTrigger
} from '../triggers/index.js'
import {trigger} from '../triggers/helpers.js'
export const createWorkflowCollection: <T extends string>(options: WorkflowsPluginConfig<T>) => CollectionConfig = (options) => {
const {steps, collectionTriggers} = options
const triggers = (options.triggers || []).map(t => t(options))
return {
slug: 'workflows',
access: {
create: () => true,
@@ -60,10 +61,6 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
name: 'type',
type: 'select',
options: [
'collection-trigger',
'webhook-trigger',
'global-trigger',
'cron-trigger',
...(triggers || []).map(t => t.slug)
]
},
@@ -76,10 +73,10 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
defaultValue: {}
},
// Virtual fields for built-in triggers
...getCollectionTriggerFields(collectionTriggers),
...getWebhookTriggerFields(),
...getGlobalTriggerFields(),
...getCronTriggerFields(),
...trigger({slug: 'collection', fields: collectionTrigger(options).fields}).fields,
...trigger({slug: 'webhook', fields: webhookTrigger().fields}).fields,
...trigger({slug: 'global', fields: globalTrigger().fields}).fields,
...trigger({slug: 'cron', fields: cronTrigger().fields}).fields,
{
name: 'condition',
type: 'text',
@@ -91,7 +88,7 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
// Virtual fields for custom triggers
// Note: Custom trigger fields from trigger-helpers already have unique names
// We just need to pass them through without modification
...(triggers || []).flatMap(t => (t.inputs || []))
...(triggers || []).flatMap(t => (t.fields || []))
]
},
{
@@ -177,4 +174,5 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
},
maxPerDoc: 10,
},
})
}
}

11
src/plugin/config-types.ts
View File

@@ -1,4 +1,6 @@
import type {Field, TaskConfig} from "payload"
import type {TaskConfig} from "payload"
import type {Trigger} from "../triggers/types.js"
export type CollectionTriggerConfigCrud = {
create?: true
@@ -9,10 +11,7 @@ export type CollectionTriggerConfigCrud = {
export type CollectionTriggerConfig = CollectionTriggerConfigCrud | true
export type CustomTriggerConfig = {
inputs?: Field[]
slug: string,
}
export type TriggerConfig = <T extends string>(config: WorkflowsPluginConfig<T>) => Trigger
export type WorkflowsPluginConfig<TSlug extends string> = {
collectionTriggers: {
@@ -20,6 +19,6 @@ export type WorkflowsPluginConfig<TSlug extends string> = {
}
enabled?: boolean
steps: TaskConfig<string>[],
triggers?: CustomTriggerConfig[]
triggers?: TriggerConfig[]
webhookPrefix?: string
}

23
src/triggers/collection-trigger.ts
View File

@@ -1,19 +1,14 @@
import type {Field} from 'payload'
import type {TriggerConfig} from '../plugin/config-types.js'
import type { WorkflowsPluginConfig } from '../plugin/config-types.js'
import {triggerField} from "./helpers.js"
export function getCollectionTriggerFields<T extends string>(
collectionTriggers: WorkflowsPluginConfig<T>['collectionTriggers']
): Field[] {
return [
triggerField({
export const collectionTrigger: TriggerConfig = ({collectionTriggers}) => ({
slug: 'collection',
fields: [
{
name: 'collectionSlug',
type: 'select',
options: Object.keys(collectionTriggers || {}),
}),
triggerField({
},
{
name: 'operation',
type: 'select',
options: [
@@ -22,6 +17,6 @@ export function getCollectionTriggerFields<T extends string>(
'read',
'update',
],
})
]
}
]
})

27
src/triggers/cron-trigger.ts
View File

@@ -1,25 +1,23 @@
import type {Field} from 'payload'
import type {TriggerConfig} from '../plugin/config-types.js'
import {triggerField} from "./helpers.js"
export function getCronTriggerFields(): Field[] {
return [
triggerField({
export const cronTrigger: TriggerConfig = () => ({
slug: 'cron',
fields: [
{
name: 'cronExpression',
type: 'text',
admin: {
condition: (_, siblingData) => siblingData?.type === 'cron-trigger',
description: 'Cron expression for scheduled execution (e.g., "0 0 * * *" for daily at midnight)',
placeholder: '0 0 * * *'
},
validate: (value: any, {siblingData}: any) => {
const cronValue = value || siblingData?.parameters?.cronExpression
if (siblingData?.type === 'cron-trigger' && !cronValue) {
if (siblingData?.type === 'cron' && !cronValue) {
return 'Cron expression is required for cron triggers'
}
// Validate cron expression format if provided
if (siblingData?.type === 'cron-trigger' && cronValue) {
if (siblingData?.type === 'cron' && cronValue) {
// Basic format validation - should be 5 parts separated by spaces
const cronParts = cronValue.trim().split(/\s+/)
if (cronParts.length !== 5) {
@@ -32,19 +30,18 @@ export function getCronTriggerFields(): Field[] {
return true
},
}),
triggerField({
},
{
name: 'timezone',
type: 'text',
admin: {
condition: (_, siblingData) => siblingData?.type === 'cron-trigger',
description: 'Timezone for cron execution (e.g., "America/New_York", "Europe/London"). Defaults to UTC.',
placeholder: 'UTC'
},
defaultValue: 'UTC',
validate: (value: any, {siblingData}: any) => {
const tzValue = value || siblingData?.parameters?.timezone
if (siblingData?.type === 'cron-trigger' && tzValue) {
if (siblingData?.type === 'cron' && tzValue) {
try {
// Test if timezone is valid by trying to create a date with it
new Intl.DateTimeFormat('en', {timeZone: tzValue})
@@ -55,6 +52,6 @@ export function getCronTriggerFields(): Field[] {
}
return true
},
})
]
}
]
})

21
src/triggers/global-trigger.ts
View File

@@ -1,28 +1,25 @@
import type {Field} from 'payload'
import type {TriggerConfig} from '../plugin/config-types.js'
import {triggerField} from "./helpers.js"
export function getGlobalTriggerFields(): Field[] {
return [
triggerField({
export const globalTrigger: TriggerConfig = () => ({
slug: 'global',
fields: [
{
name: 'global',
type: 'select',
admin: {
condition: (_, siblingData) => siblingData?.type === 'global-trigger',
description: 'Global that triggers the workflow',
},
options: [], // Will be populated dynamically based on available globals
}),
triggerField({
},
{
name: 'globalOperation',
type: 'select',
admin: {
condition: (_, siblingData) => siblingData?.type === 'global-trigger',
description: 'Global operation that triggers the workflow',
},
options: [
'update'
],
})
]
}
]
})

14
src/triggers/helpers.ts
View File

@@ -1,12 +1,10 @@
import type {Field, TextField, SelectField} from "payload"
import type {Field} from "payload"
import type {Trigger} from "./types.js"
type FieldWithName = TextField | SelectField | (Field & { name: string })
type Options = {
slug: string,
fields?: FieldWithName[]
fields?: ({name: string} & Field)[]
}
export const trigger = ({
@@ -15,18 +13,18 @@ export const trigger = ({
}: Options): Trigger => {
return {
slug,
fields: (fields || []).map(triggerField) as Field[]
fields: (fields || []).map(f => triggerField(slug, f))
}
}
export const triggerField = (field: FieldWithName): Field => ({
export const triggerField = (slug: string, field: {name: string} & Field): Field => ({
...field,
name: '__trigger_' + field.name,
admin: {
...(field.admin as any || {}),
...(field.admin as unknown || {}),
condition: (_, siblingData, __) => {
const previous = field.admin?.condition?.call(null, _, siblingData, __)
return previous !== false // Preserve existing condition if it exists
return previous || (siblingData?.type === slug)
},
},
hooks: {

8
src/triggers/index.ts
View File

@@ -1,4 +1,4 @@
export { getCollectionTriggerFields } from './collection-trigger.js'
export { getCronTriggerFields } from './cron-trigger.js'
export { getGlobalTriggerFields } from './global-trigger.js'
export { getWebhookTriggerFields } from './webhook-trigger.js'
export { collectionTrigger } from './collection-trigger.js'
export { cronTrigger } from './cron-trigger.js'
export { globalTrigger } from './global-trigger.js'
export { webhookTrigger } from './webhook-trigger.js'

18
src/triggers/webhook-trigger.ts
View File

@@ -1,22 +1,20 @@
import type {Field} from 'payload'
import type {TriggerConfig} from '../plugin/config-types.js'
import {triggerField} from "./helpers.js"
export function getWebhookTriggerFields(): Field[] {
return [
triggerField({
export const webhookTrigger: TriggerConfig = () => ({
slug: 'webhook',
fields: [
{
name: 'webhookPath',
type: 'text',
admin: {
condition: (_, siblingData) => siblingData?.type === 'webhook-trigger',
description: 'URL path for the webhook (e.g., "my-webhook"). Full URL will be /api/workflows-webhook/my-webhook',
},
validate: (value: any, {siblingData}: any) => {
if (siblingData?.type === 'webhook-trigger' && !value && !siblingData?.parameters?.webhookPath) {
if (siblingData?.type === 'webhook' && !value && !siblingData?.parameters?.webhookPath) {
return 'Webhook path is required for webhook triggers'
}
return true
},
})
]
}
]
})