mirror of
https://github.com/xtr-dev/payload-automation.git
synced 2025-12-10 00:43:23 +00:00
Fix client-side bundling by separating server and client exports
- 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>
This commit is contained in:
28
README.md
28
README.md
@@ -27,20 +27,40 @@ yarn add @xtr-dev/payload-automation
|
||||
|
||||
```typescript
|
||||
import { buildConfig } from 'payload'
|
||||
import { payloadAutomation } from '@xtr-dev/payload-automation'
|
||||
import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
|
||||
|
||||
export default buildConfig({
|
||||
// ... your config
|
||||
plugins: [
|
||||
payloadAutomation({
|
||||
collections: ['posts', 'users'], // Collections to monitor
|
||||
globals: ['settings'], // Globals to monitor
|
||||
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
|
||||
|
||||
@@ -30,10 +30,10 @@
|
||||
"types": "./dist/exports/views.d.ts",
|
||||
"default": "./dist/exports/views.js"
|
||||
},
|
||||
"./steps": {
|
||||
"import": "./dist/steps/index.js",
|
||||
"types": "./dist/steps/index.d.ts",
|
||||
"default": "./dist/steps/index.js"
|
||||
"./server": {
|
||||
"import": "./dist/exports/server.js",
|
||||
"types": "./dist/exports/server.d.ts",
|
||||
"default": "./dist/exports/server.js"
|
||||
}
|
||||
},
|
||||
"main": "dist/index.js",
|
||||
|
||||
26
src/exports/server.ts
Normal file
26
src/exports/server.ts
Normal file
@@ -0,0 +1,26 @@
|
||||
// Server-side only exports - should never be bundled for client
|
||||
// These contain Node.js dependencies and should only be used server-side
|
||||
|
||||
export { triggerCustomWorkflow, triggerWorkflowById } from '../core/trigger-custom-workflow.js'
|
||||
export { WorkflowExecutor } from '../core/workflow-executor.js'
|
||||
export { workflowsPlugin } from '../plugin/index.js'
|
||||
|
||||
// Export all step handlers (server-side only)
|
||||
export {
|
||||
createDocumentHandler,
|
||||
deleteDocumentHandler,
|
||||
httpStepHandler,
|
||||
readDocumentHandler,
|
||||
sendEmailHandler,
|
||||
updateDocumentHandler
|
||||
} from '../steps/index.js'
|
||||
|
||||
// Export step tasks configurations (server-side only)
|
||||
export {
|
||||
CreateDocumentStepTask,
|
||||
DeleteDocumentStepTask,
|
||||
HttpRequestStepTask,
|
||||
ReadDocumentStepTask,
|
||||
SendEmailStepTask,
|
||||
UpdateDocumentStepTask
|
||||
} from '../steps/index.js'
|
||||
24
src/index.ts
24
src/index.ts
@@ -1,19 +1,15 @@
|
||||
export { triggerCustomWorkflow, triggerWorkflowById } from './core/trigger-custom-workflow.js'
|
||||
// Main export contains only types and client-safe utilities
|
||||
// Server-side functions are exported via '@xtr-dev/payload-automation/server'
|
||||
|
||||
// Types only - safe for client bundling
|
||||
export type { CustomTriggerOptions, TriggerResult } from './core/trigger-custom-workflow.js'
|
||||
export { WorkflowExecutor } from './core/workflow-executor.js'
|
||||
export type { ExecutionContext, Workflow, WorkflowStep, WorkflowTrigger } from './core/workflow-executor.js'
|
||||
export type { WorkflowsPluginConfig } from './plugin/config-types.js'
|
||||
export { workflowsPlugin } from './plugin/index.js'
|
||||
|
||||
// Export all step tasks
|
||||
export {
|
||||
CreateDocumentStepTask,
|
||||
DeleteDocumentStepTask,
|
||||
HttpRequestStepTask,
|
||||
ReadDocumentStepTask,
|
||||
SendEmailStepTask,
|
||||
UpdateDocumentStepTask
|
||||
} from './steps/index.js'
|
||||
// Server-side functions are NOT re-exported here to avoid bundling issues
|
||||
// Import server-side functions from the /server export instead
|
||||
|
||||
// UI components are exported via separate client export to avoid CSS import issues during type generation
|
||||
// Use: import { TriggerWorkflowButton } from '@xtr-dev/payload-automation/client'
|
||||
// Server functions and plugin should be imported from '/server':
|
||||
// import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
|
||||
// UI components should be imported from '/client':
|
||||
// import { TriggerWorkflowButton } from '@xtr-dev/payload-automation/client'
|
||||
|
||||
14
src/test/basic.test.ts
Normal file
14
src/test/basic.test.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
|
||||
describe('PayloadCMS Automation Plugin', () => {
|
||||
it('should export the plugin function from server export', async () => {
|
||||
const { workflowsPlugin } = await import('../exports/server.js')
|
||||
expect(workflowsPlugin).toBeDefined()
|
||||
expect(typeof workflowsPlugin).toBe('function')
|
||||
})
|
||||
|
||||
it('should have the correct package name', async () => {
|
||||
// Basic test to ensure the plugin can be imported
|
||||
expect(true).toBe(true)
|
||||
})
|
||||
})
|
||||
8
vitest.config.ts
Normal file
8
vitest.config.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
import { defineConfig } from 'vitest/config'
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
globals: true,
|
||||
environment: 'node',
|
||||
},
|
||||
})
|
||||
Reference in New Issue
Block a user