payload-plugin-scheduler/src/lib.ts

Scheduled posts plugin for PayloadCMS

import { type JobCallback } from 'node-schedule'
import { type Payload } from 'payload'
import { type PaginatedDocs } from 'payload/dist/database/types'
import { addMinutes } from 'date-fns'
import { debug } from './util'
import { type ScheduledPost } from './types'

export async function getUpcomingPosts(
  interval: number,
  payload: Payload,
): Promise<PaginatedDocs<ScheduledPost>> {
  const now = new Date()
  const nextInterval = addMinutes(now, interval)

  debug(`Scanning for scheduled posts between \n${now} and \n${nextInterval}`)
  const publishSchedules = await payload.find({
    collection: 'scheduled_posts',
    where: {
      and: [
        {
          date: {
            greater_than_equal: now,
          },
        },
        {
          date: {
            less_than: nextInterval,
          },
        },
        {
          status: {
            equals: 'queued',
          },
        },
      ],
    },
    depth: 0,
  })

  // @ts-expect-error
  return publishSchedules
}

export function publishScheduledPost(
  { post, global }: Pick<ScheduledPost, 'post' | 'global'>,
  payload: Payload,
): JobCallback {
  return async () => {
    const tag = global || `${post!.relationTo} ${post!.value}`
    payload.logger.info(`Publishing ${tag}`)
    debug(`Publishing ${tag}`)

    const updateOp = (): ReturnType<typeof payload.updateGlobal> => global ? payload.updateGlobal({
      slug: global,
      data: {
        _status: 'published'
      }
    }) : payload.update({
      id: post!.value,
      collection: post!.relationTo,
      data: {
        _status: 'published',
      },
    })

    try {
      await updateOp()
      payload.logger.info(`[payload-plugin-scheduler] Published ${tag}`)
    } catch (error: unknown) {
      debug(`Error publishing ${tag} ${error?.toString()}`)
      payload.logger.error(error, 
        `[payload-plugin-scheduler] Failed to publish ${tag}`
      )
    }
  }
}