mirror of
https://github.com/xtr-dev/payload-automation.git
synced 2025-12-10 08:53:23 +00:00
Bas van den Aakster
cadb40e401
- Create dedicated /server export for server-side functions and plugin
- Main export now contains only types (client-safe)
- Remove problematic /steps export that exposed server functions
- Update README with correct import structure
- Fix tests to use /server export
This prevents server-side code from being bundled in client JavaScript,
eliminating the "require is not defined in ES module scope" runtime error.
Breaking change: workflowsPlugin must now be imported from '/server':
import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
93 lines
2.6 KiB
Markdown
93 lines
2.6 KiB
Markdown
# @xtr-dev/payload-automation
|
|
|
|
A comprehensive workflow automation plugin for PayloadCMS 3.x that enables visual workflow building, execution tracking, and parallel processing.
|
|
|
|
⚠️ **Pre-release Warning**: This package is currently in active development (v0.0.x). Breaking changes may occur before v1.0.0. Not recommended for production use.
|
|
|
|
## Features
|
|
|
|
- 🔄 **Visual Workflow Builder** - Create complex workflows with drag-and-drop interface
|
|
- ⚡ **Parallel Execution** - Smart dependency resolution for optimal performance
|
|
- 🎯 **Multiple Triggers** - Collection hooks, webhooks, manual execution
|
|
- 📊 **Execution Tracking** - Complete history and monitoring of workflow runs
|
|
- 🔧 **Extensible Steps** - HTTP requests, document CRUD, email notifications
|
|
- 🔍 **JSONPath Integration** - Dynamic data interpolation and transformation
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @xtr-dev/payload-automation
|
|
# or
|
|
pnpm add @xtr-dev/payload-automation
|
|
# or
|
|
yarn add @xtr-dev/payload-automation
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```typescript
|
|
import { buildConfig } from 'payload'
|
|
import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
|
|
|
|
export default buildConfig({
|
|
// ... your config
|
|
plugins: [
|
|
workflowsPlugin({
|
|
collectionTriggers: {
|
|
posts: true, // Enable all CRUD triggers for posts
|
|
users: {
|
|
create: true, // Only enable create trigger for users
|
|
update: true
|
|
}
|
|
},
|
|
enabled: true,
|
|
}),
|
|
],
|
|
})
|
|
```
|
|
|
|
## Import Structure
|
|
|
|
The plugin uses separate exports to avoid bundling server-side code in client bundles:
|
|
|
|
```typescript
|
|
// Server-side plugin and functions
|
|
import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
|
|
|
|
// Client-side components
|
|
import { TriggerWorkflowButton } from '@xtr-dev/payload-automation/client'
|
|
|
|
// Types only (safe for both server and client)
|
|
import type { WorkflowsPluginConfig } from '@xtr-dev/payload-automation'
|
|
```
|
|
|
|
## Step Types
|
|
|
|
- **HTTP Request** - Make external API calls
|
|
- **Create Document** - Create PayloadCMS documents
|
|
- **Read Document** - Query documents with filters
|
|
- **Update Document** - Modify existing documents
|
|
- **Delete Document** - Remove documents
|
|
- **Send Email** - Send notifications via PayloadCMS email
|
|
|
|
## Data Resolution
|
|
|
|
Use JSONPath to access workflow data:
|
|
|
|
- `$.trigger.doc.id` - Access trigger document
|
|
- `$.steps.stepName.output` - Use previous step outputs
|
|
- `$.context` - Access workflow context
|
|
|
|
## Requirements
|
|
|
|
- PayloadCMS ^3.45.0
|
|
- Node.js ^18.20.2 || >=20.9.0
|
|
- pnpm ^9 || ^10
|
|
|
|
## Documentation
|
|
|
|
Full documentation coming soon. For now, explore the development environment in the repository for examples and patterns.
|
|
|
|
## License
|
|
|
|
MIT |