https://github.com/wkentdag/payload-plugin-scheduler
PayloadCMS v2 plugin for scheduled posts
https://github.com/wkentdag/payload-plugin-scheduler
node-schedule payload-plugin payloadcms scheduler
Last synced: about 1 month ago
JSON representation
PayloadCMS v2 plugin for scheduled posts
- Host: GitHub
- URL: https://github.com/wkentdag/payload-plugin-scheduler
- Owner: wkentdag
- License: mit
- Created: 2024-04-15T09:54:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T18:51:25.000Z (over 1 year ago)
- Last Synced: 2025-10-02T04:14:27.238Z (5 months ago)
- Topics: node-schedule, payload-plugin, payloadcms, scheduler
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/payload-plugin-scheduler
- Size: 351 KB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# payload-plugin-scheduler
Payload plugin that enables scheduled publishing for draft-enabled collections, inspired by wordpress post scheduler.
## Installation
```sh
npm i payload-plugin-scheduler
```
## Usage
```ts
// payload.config.ts
import { buildConfig } from 'payload/config'
import { ScheduledPostPlugin } from 'payload-plugin-scheduler'
import Pages from './collections/Pages'
import Posts from './collections/Posts'
import Home from './globals/Home'
export default buildConfig({
collections: [Pages, Posts],
globals: [Home],
plugins: [
ScheduledPostPlugin({
collections: ['pages', 'posts'],
globals: ['home'],
interval: 10,
})
]
// ...more config
})
```
## Options
At least one collection / global is required.
### `collections?: string[]`
An array of collection slugs. All collections must have drafts enabled.
### `globals?: string[]`
An array of global slugs. All globals must have drafts enabled.
### `interval?: number`
Specify how frequently to check for scheduled posts (in minutes).
This value will also be passed to the `DatePicker` component. Defaults to 5 mins.
### `scheduledPosts?: Partial`
Custom configuration for the scheduled posts collection that gets merged with the defaults.
## Utils
### `SafeRelationship`
Drop-in replacement for the default [`relationship` field](https://payloadcms.com/docs/fields/relationship) to prevent users from publishing documents that have references to other docs that are still in draft / scheduled mode.
```ts
import type { Field } from 'payload'
import { SafeRelationship } from 'payload-plugin-scheduler'
const example: Field = SafeRelationship({
name: 'featured_content',
relationTo: ['posts', 'pages'],
hasMany: true,
})
```
## Approach
In a nutshell, the plugin creates a `publish_date` field that it uses to determine whether a pending draft update needs to be scheduled. If a draft document is saved with a `publish_date` that's in the future, it will be scheduled and automatically published on that date.
### `publish_date`
Datetime field added to enabled collections. Custom `Field` and `Cell` components display the schedule status in the client-side UI.
### `scheduled_posts`
Collection added by the plugin to store pending schedule updates. Can be customized via `scheduledPosts` option.
### Cron
A configurable timer checks for any posts to be scheduled in the upcoming interval window. For each hit, it creates a separate job that's fired at that document's `publish_date` (via [node-schedule](https://github.com/node-schedule/node-schedule)). The idea here is that you can configure your interval window to avoid super long running tasks that are more prone to flaking.
## Caveats
* This plugin doesn't support Payload 3.0 beta. I intend to update it once 3.0 is stable, but it'll require substantial re-architecting to work in a serverless environment.
* There's no logic in place to dedupe schedules across multiple instances of a single app (see https://github.com/wkentdag/payload-plugin-scheduler/issues/9)
* There's no logic in place to automatically publish any pending scheduled posts that weren't published due to server downtime.