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:
2025-08-31 18:06:39 +02:00
parent 19b9566df6
commit cadb40e401
6 changed files with 86 additions and 22 deletions

View File

@@ -27,20 +27,40 @@ yarn add @xtr-dev/payload-automation
```typescript ```typescript
import { buildConfig } from 'payload' import { buildConfig } from 'payload'
import { payloadAutomation } from '@xtr-dev/payload-automation' import { workflowsPlugin } from '@xtr-dev/payload-automation/server'
export default buildConfig({ export default buildConfig({
// ... your config // ... your config
plugins: [ plugins: [
payloadAutomation({ workflowsPlugin({
collections: ['posts', 'users'], // Collections to monitor collectionTriggers: {
globals: ['settings'], // Globals to monitor posts: true, // Enable all CRUD triggers for posts
users: {
create: true, // Only enable create trigger for users
update: true
}
},
enabled: 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 ## Step Types
- **HTTP Request** - Make external API calls - **HTTP Request** - Make external API calls

View File

@@ -30,10 +30,10 @@
"types": "./dist/exports/views.d.ts", "types": "./dist/exports/views.d.ts",
"default": "./dist/exports/views.js" "default": "./dist/exports/views.js"
}, },
"./steps": { "./server": {
"import": "./dist/steps/index.js", "import": "./dist/exports/server.js",
"types": "./dist/steps/index.d.ts", "types": "./dist/exports/server.d.ts",
"default": "./dist/steps/index.js" "default": "./dist/exports/server.js"
} }
}, },
"main": "dist/index.js", "main": "dist/index.js",

26
src/exports/server.ts Normal file
View 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'

View File

@@ -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 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 { ExecutionContext, Workflow, WorkflowStep, WorkflowTrigger } from './core/workflow-executor.js'
export type { WorkflowsPluginConfig } from './plugin/config-types.js' export type { WorkflowsPluginConfig } from './plugin/config-types.js'
export { workflowsPlugin } from './plugin/index.js'
// Export all step tasks // Server-side functions are NOT re-exported here to avoid bundling issues
export { // Import server-side functions from the /server export instead
CreateDocumentStepTask,
DeleteDocumentStepTask,
HttpRequestStepTask,
ReadDocumentStepTask,
SendEmailStepTask,
UpdateDocumentStepTask
} from './steps/index.js'
// UI components are exported via separate client export to avoid CSS import issues during type generation // Server functions and plugin should be imported from '/server':
// Use: import { TriggerWorkflowButton } from '@xtr-dev/payload-automation/client' // 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
View 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
View File

@@ -0,0 +1,8 @@
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
globals: true,
environment: 'node',
},
})