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

Fix TypeScript and ESLint errors, resolve component imports

Browse Source 
- Fix TypeScript types in trigger-helpers with proper interfaces
- Remove all ESLint no-explicit-any warnings with better typing
- Fix component import paths from @/components/* to relative paths
- Regenerate import map with correct component references
- All compilation and linting errors resolved
This commit is contained in:
Bas van den Aakster
2025-09-09 10:13:00 +02:00
parent 3e9ff10076
commit 2bc01f30f8
7 changed files with 335 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
dev/app/(payload)/admin/importMap.js
View File

@@ -1,5 +1,9 @@
import { default as default_4845c503d8eeb95a2cf39d519276b9b7 } from '../../../../../components/WorkflowExecutionStatus'
import { default as default_28774f13376b69227276b43eee64e5a1 } from '../../../../../components/StatusCell'
import { default as default_623fcff70b12e3e87839f97bf237499a } from '../../../../../components/ErrorDisplay'
export const importMap = {
"../components/WorkflowExecutionStatus#default": default_4845c503d8eeb95a2cf39d519276b9b7,
"../components/StatusCell#default": default_28774f13376b69227276b43eee64e5a1,
"../components/ErrorDisplay#default": default_623fcff70b12e3e87839f97bf237499a
}

311
dev/payload-types.ts
View File

@@ -92,7 +92,7 @@ export interface Config {
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
};
db: {
defaultIDType: number;
defaultIDType: string;
};
globals: {};
globalsSelect: {};
@@ -136,7 +136,7 @@ export interface UserAuthOperations {
* via the `definition` "posts".
*/
export interface Post {
id: number;
id: string;
content?: string | null;
updatedAt: string;
createdAt: string;
@@ -146,7 +146,7 @@ export interface Post {
* via the `definition` "media".
*/
export interface Media {
id: number;
id: string;
updatedAt: string;
createdAt: string;
url?: string | null;
@@ -164,9 +164,9 @@ export interface Media {
* via the `definition` "auditLog".
*/
export interface AuditLog {
id: number;
post?: (number | null) | Post;
user?: (number | null) | User;
id: string;
post?: (string | null) | Post;
user?: (string | null) | User;
message?: string | null;
updatedAt: string;
createdAt: string;
@@ -176,7 +176,7 @@ export interface AuditLog {
* via the `definition` "users".
*/
export interface User {
id: number;
id: string;
updatedAt: string;
createdAt: string;
email: string;
@@ -202,7 +202,7 @@ export interface User {
* via the `definition` "workflows".
*/
export interface Workflow {
id: number;
id: string;
/**
* Human-readable name for the workflow
*/
@@ -214,36 +214,45 @@ export interface Workflow {
triggers?:
| {
type?: ('collection-trigger' | 'webhook-trigger' | 'global-trigger' | 'cron-trigger') | null;
parameters?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Collection that triggers the workflow
*/
collectionSlug?: ('posts' | 'media') | null;
__builtin_collectionSlug?: ('posts' | 'media') | null;
/**
* Collection operation that triggers the workflow
*/
operation?: ('create' | 'delete' | 'read' | 'update') | null;
__builtin_operation?: ('create' | 'delete' | 'read' | 'update') | null;
/**
* URL path for the webhook (e.g., "my-webhook"). Full URL will be /api/workflows/webhook/my-webhook
* URL path for the webhook (e.g., "my-webhook"). Full URL will be /api/workflows-webhook/my-webhook
*/
webhookPath?: string | null;
__builtin_webhookPath?: string | null;
/**
* Global that triggers the workflow
*/
global?: string | null;
__builtin_global?: string | null;
/**
* Global operation that triggers the workflow
*/
globalOperation?: 'update' | null;
__builtin_globalOperation?: 'update' | null;
/**
* Cron expression for scheduled execution (e.g., "0 0 * * *" for daily at midnight)
*/
cronExpression?: string | null;
__builtin_cronExpression?: string | null;
/**
* Timezone for cron execution (e.g., "America/New_York", "Europe/London"). Defaults to UTC.
*/
timezone?: string | null;
__builtin_timezone?: string | null;
/**
* JSONPath expression that must evaluate to true for this trigger to execute the workflow (e.g., "$.doc.status == 'published'")
* JSONPath expression that must evaluate to true for this trigger to execute the workflow (e.g., "$.trigger.doc.status == 'published'")
*/
condition?: string | null;
id?: string | null;
@@ -253,7 +262,18 @@ export interface Workflow {
| {
step?: ('http-request-step' | 'create-document') | null;
name?: string | null;
input?:
/**
* The URL to make the HTTP request to
*/
url?: string | null;
/**
* HTTP method to use
*/
method?: ('GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH') | null;
/**
* HTTP headers as JSON object (e.g., {"Content-Type": "application/json"})
*/
headers?:
| {
[k: string]: unknown;
}
@@ -262,6 +282,80 @@ export interface Workflow {
| number
| boolean
| null;
/**
* Request body data. Use JSONPath to reference values (e.g., {"postId": "$.trigger.doc.id", "title": "$.trigger.doc.title"})
*/
body?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Request timeout in milliseconds (default: 30000)
*/
timeout?: number | null;
authentication?: {
/**
* Authentication method
*/
type?: ('none' | 'bearer' | 'basic' | 'apikey') | null;
/**
* Bearer token value
*/
token?: string | null;
/**
* Basic auth username
*/
username?: string | null;
/**
* Basic auth password
*/
password?: string | null;
/**
* API key header name (e.g., "X-API-Key")
*/
headerName?: string | null;
/**
* API key value
*/
headerValue?: string | null;
};
/**
* Number of retry attempts on failure (max: 5)
*/
retries?: number | null;
/**
* Delay between retries in milliseconds
*/
retryDelay?: number | null;
/**
* The collection slug to create a document in
*/
collectionSlug?: string | null;
/**
* The document data to create. Use JSONPath to reference trigger data (e.g., {"title": "$.trigger.doc.title", "author": "$.trigger.doc.author"})
*/
data?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Create as draft (if collection has drafts enabled)
*/
draft?: boolean | null;
/**
* Locale for the document (if localization is enabled)
*/
locale?: string | null;
/**
* Step names that must complete before this step can run
*/
@@ -282,11 +376,11 @@ export interface Workflow {
* via the `definition` "workflow-runs".
*/
export interface WorkflowRun {
id: number;
id: string;
/**
* Reference to the workflow that was executed
*/
workflow: number | Workflow;
workflow: string | Workflow;
/**
* Version of the workflow that was executed
*/
@@ -380,7 +474,7 @@ export interface WorkflowRun {
* via the `definition` "payload-jobs".
*/
export interface PayloadJob {
id: number;
id: string;
/**
* Input data provided to the job
*/
@@ -472,40 +566,40 @@ export interface PayloadJob {
* via the `definition` "payload-locked-documents".
*/
export interface PayloadLockedDocument {
id: number;
id: string;
document?:
| ({
relationTo: 'posts';
value: number | Post;
value: string | Post;
} | null)
| ({
relationTo: 'media';
value: number | Media;
value: string | Media;
} | null)
| ({
relationTo: 'auditLog';
value: number | AuditLog;
value: string | AuditLog;
} | null)
| ({
relationTo: 'workflows';
value: number | Workflow;
value: string | Workflow;
} | null)
| ({
relationTo: 'workflow-runs';
value: number | WorkflowRun;
value: string | WorkflowRun;
} | null)
| ({
relationTo: 'users';
value: number | User;
value: string | User;
} | null)
| ({
relationTo: 'payload-jobs';
value: number | PayloadJob;
value: string | PayloadJob;
} | null);
globalSlug?: string | null;
user: {
relationTo: 'users';
value: number | User;
value: string | User;
};
updatedAt: string;
createdAt: string;
@@ -515,10 +609,10 @@ export interface PayloadLockedDocument {
* via the `definition` "payload-preferences".
*/
export interface PayloadPreference {
id: number;
id: string;
user: {
relationTo: 'users';
value: number | User;
value: string | User;
};
key?: string | null;
value?:
@@ -538,7 +632,7 @@ export interface PayloadPreference {
* via the `definition` "payload-migrations".
*/
export interface PayloadMigration {
id: number;
id: string;
name?: string | null;
batch?: number | null;
updatedAt: string;
@@ -592,13 +686,14 @@ export interface WorkflowsSelect<T extends boolean = true> {
| T
| {
type?: T;
collectionSlug?: T;
operation?: T;
webhookPath?: T;
global?: T;
globalOperation?: T;
cronExpression?: T;
timezone?: T;
parameters?: T;
__builtin_collectionSlug?: T;
__builtin_operation?: T;
__builtin_webhookPath?: T;
__builtin_global?: T;
__builtin_globalOperation?: T;
__builtin_cronExpression?: T;
__builtin_timezone?: T;
condition?: T;
id?: T;
};
@@ -607,7 +702,27 @@ export interface WorkflowsSelect<T extends boolean = true> {
| {
step?: T;
name?: T;
input?: T;
url?: T;
method?: T;
headers?: T;
body?: T;
timeout?: T;
authentication?:
| T
| {
type?: T;
token?: T;
username?: T;
password?: T;
headerName?: T;
headerValue?: T;
};
retries?: T;
retryDelay?: T;
collectionSlug?: T;
data?: T;
draft?: T;
locale?: T;
dependencies?: T;
condition?: T;
id?: T;
@@ -736,10 +851,118 @@ export interface TaskWorkflowCronExecutor {
*/
export interface TaskHttpRequestStep {
input: {
url?: string | null;
/**
* The URL to make the HTTP request to
*/
url: string;
/**
* HTTP method to use
*/
method?: ('GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH') | null;
/**
* HTTP headers as JSON object (e.g., {"Content-Type": "application/json"})
*/
headers?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Request body data. Use JSONPath to reference values (e.g., {"postId": "$.trigger.doc.id", "title": "$.trigger.doc.title"})
*/
body?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Request timeout in milliseconds (default: 30000)
*/
timeout?: number | null;
authentication?: {
/**
* Authentication method
*/
type?: ('none' | 'bearer' | 'basic' | 'apikey') | null;
/**
* Bearer token value
*/
token?: string | null;
/**
* Basic auth username
*/
username?: string | null;
/**
* Basic auth password
*/
password?: string | null;
/**
* API key header name (e.g., "X-API-Key")
*/
headerName?: string | null;
/**
* API key value
*/
headerValue?: string | null;
};
/**
* Number of retry attempts on failure (max: 5)
*/
retries?: number | null;
/**
* Delay between retries in milliseconds
*/
retryDelay?: number | null;
};
output: {
response?: string | null;
/**
* HTTP status code
*/
status?: number | null;
/**
* HTTP status text
*/
statusText?: string | null;
/**
* Response headers
*/
headers?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Response body
*/
body?: string | null;
/**
* Parsed response data (if JSON)
*/
data?:
| {
[k: string]: unknown;
}
| unknown[]
| string
| number
| boolean
| null;
/**
* Request duration in milliseconds
*/
duration?: number | null;
};
}
/**
@@ -753,7 +976,7 @@ export interface TaskCreateDocument {
*/
collectionSlug: string;
/**
* The document data to create
* The document data to create. Use JSONPath to reference trigger data (e.g., {"title": "$.trigger.doc.title", "author": "$.trigger.doc.author"})
*/
data:
| {

2
src/collections/Workflow.ts
View File

@@ -41,7 +41,7 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
type: 'ui',
admin: {
components: {
Field: '@/components/WorkflowExecutionStatus'
Field: '../components/WorkflowExecutionStatus'
},
condition: (data) => !!data?.id // Only show for existing workflows
}

4
src/collections/WorkflowRuns.ts
View File

@@ -40,7 +40,7 @@ export const WorkflowRunsCollection: CollectionConfig = {
admin: {
description: 'Current execution status',
components: {
Cell: '@/components/StatusCell'
Cell: '../components/StatusCell'
}
},
defaultValue: 'pending',
@@ -141,7 +141,7 @@ export const WorkflowRunsCollection: CollectionConfig = {
description: 'Error message if workflow execution failed',
condition: (_, siblingData) => siblingData?.status === 'failed',
components: {
Field: '@/components/ErrorDisplay'
Field: '../components/ErrorDisplay'
}
},
},

17
src/components/ErrorDisplay.tsx.disabled → src/components/ErrorDisplay.tsx
View File

@@ -166,14 +166,15 @@ export const ErrorDisplay: React.FC<ErrorDisplayProps> = ({
{/* Technical Details Toggle */}
<div>
<Button
onClick={() => setExpanded(!expanded)}
size="small"
buttonStyle="secondary"
style={{ marginBottom: expanded ? '12px' : '0' }}
>
{expanded ? 'Hide' : 'Show'} Technical Details
</Button>
<div style={{ marginBottom: expanded ? '12px' : '0' }}>
<Button
onClick={() => setExpanded(!expanded)}
size="small"
buttonStyle="secondary"
>
{expanded ? 'Hide' : 'Show'} Technical Details
</Button>
</div>
{expanded && (
<div style={{

2
src/exports/client.ts
View File

@@ -3,7 +3,7 @@
export { TriggerWorkflowButton } from '../components/TriggerWorkflowButton.js'
export { StatusCell } from '../components/StatusCell.js'
// export { ErrorDisplay } from '../components/ErrorDisplay.js' // Temporarily disabled
export { ErrorDisplay } from '../components/ErrorDisplay.js'
export { WorkflowExecutionStatus } from '../components/WorkflowExecutionStatus.js'
// Future client components can be added here:

73
src/utils/trigger-helpers.ts
View File

@@ -1,6 +1,22 @@
import type { Field } from 'payload'
import type { CustomTriggerConfig } from '../plugin/config-types.js'
// Types for better type safety
interface FieldWithName {
name: string
[key: string]: unknown
}
interface HookContext {
siblingData: Record<string, unknown>
value?: unknown
}
interface ValidationContext {
siblingData: Record<string, unknown>
}
/**
* Creates a virtual field for a trigger parameter that stores its value in the parameters JSON field
*
@@ -25,7 +41,7 @@ import type { CustomTriggerConfig } from '../plugin/config-types.js'
* }
* ```
*/
export function createTriggerField(field: any, triggerSlug: string): Field {
export function createTriggerField(field: FieldWithName, triggerSlug: string): Field {
const originalName = field.name
if (!originalName) {
throw new Error('Field must have a name property')
@@ -34,61 +50,70 @@ export function createTriggerField(field: any, triggerSlug: string): Field {
// Create a unique field name by prefixing with trigger slug
const uniqueFieldName = `__trigger_${triggerSlug}_${originalName}`
const resultField: any = {
const resultField: Record<string, unknown> = {
...field,
name: uniqueFieldName,
virtual: true,
admin: {
...(field.admin || {}),
condition: (data: any, siblingData: any) => {
...(field.admin as Record<string, unknown> || {}),
condition: (data: unknown, siblingData: Record<string, unknown>) => {
// Only show this field when the trigger type matches
const triggerMatches = siblingData?.type === triggerSlug
// If the original field had a condition, combine it with our trigger condition
if (field.admin?.condition) {
return triggerMatches && field.admin.condition(data, siblingData)
const originalCondition = (field.admin as Record<string, unknown>)?.condition
if (originalCondition && typeof originalCondition === 'function') {
return triggerMatches && (originalCondition as (data: unknown, siblingData: Record<string, unknown>) => boolean)(data, siblingData)
}
return triggerMatches
}
},
hooks: {
...(field.hooks || {}),
...(field.hooks as Record<string, unknown[]> || {}),
afterRead: [
...(field.hooks?.afterRead || []),
({ siblingData }: any) => {
...((field.hooks as Record<string, unknown[]>)?.afterRead || []),
({ siblingData }: HookContext) => {
// Read the value from the parameters JSON field
return siblingData?.parameters?.[originalName] ?? field.defaultValue
const parameters = siblingData?.parameters as Record<string, unknown>
return parameters?.[originalName] ?? (field as Record<string, unknown>).defaultValue
}
],
beforeChange: [
...(field.hooks?.beforeChange || []),
({ value, siblingData }: any) => {
...((field.hooks as Record<string, unknown[]>)?.beforeChange || []),
({ siblingData, value }: HookContext) => {
// Store the value in the parameters JSON field
if (!siblingData.parameters) {
siblingData.parameters = {}
}
siblingData.parameters[originalName] = value
const parameters = siblingData.parameters as Record<string, unknown>
parameters[originalName] = value
return undefined // Virtual field, don't store directly
}
]
}
},
name: uniqueFieldName,
virtual: true,
}
// Only add validate if the field supports it (data fields)
if (field.validate || field.required) {
resultField.validate = (value: any, args: any) => {
const paramValue = value ?? args.siblingData?.parameters?.[originalName]
const hasValidation = (field as Record<string, unknown>).validate || (field as Record<string, unknown>).required
if (hasValidation) {
resultField.validate = (value: unknown, args: ValidationContext) => {
const parameters = args.siblingData?.parameters as Record<string, unknown>
const paramValue = value ?? parameters?.[originalName]
// Check required validation
if (field.required && args.siblingData?.type === triggerSlug && !paramValue) {
const label = field.label || field.admin?.description || originalName
const isRequired = (field as Record<string, unknown>).required
if (isRequired && args.siblingData?.type === triggerSlug && !paramValue) {
const fieldLabel = (field as Record<string, unknown>).label as string
const adminDesc = ((field as Record<string, unknown>).admin as Record<string, unknown>)?.description as string
const label = fieldLabel || adminDesc || originalName
return `${label} is required for ${triggerSlug}`
}
// Run original validation if present
if (field.validate) {
return field.validate(paramValue, args)
const originalValidate = (field as Record<string, unknown>).validate
if (originalValidate && typeof originalValidate === 'function') {
return (originalValidate as (value: unknown, args: ValidationContext) => boolean | string)(paramValue, args)
}
return true
@@ -125,7 +150,7 @@ export function createTriggerField(field: any, triggerSlug: string): Field {
* ])
* ```
*/
export function createTrigger(slug: string, fields: Field[]): CustomTriggerConfig {
export function createTrigger(slug: string, fields: FieldWithName[]): CustomTriggerConfig {
return {
slug,
inputs: fields.map(field => createTriggerField(field, slug))