workflow-cron-sleep 1.0.0 → 1.0.1

package/README.md

@@ -97,7 +97,7 @@ Separate your scheduling logic from your business logic by keeping workflows and
 import { cronSleep } from "workflow-cron-sleep"
 import { startReportProcessor } from "./steps"
 
-interface ReportSchedulerInput {
+export interface ReportSchedulerInput {
     reportId: string
     cronExpression: string
 }
@@ -111,7 +111,30 @@ export async function reportScheduler(input: ReportSchedulerInput) {
     await cronSleep(cronExpression, { timezone: "America/New_York" })
     
     // Trigger the processor workflow
-    await startReportProcessor(reportId)
+    await startReportProcessor(reportId, cronExpression)
+}
+```
+
+**`workflows/report-processor.ts`** - The processor workflow (business logic)
+```typescript
+import { restartScheduler } from "./steps"
+
+export interface ReportProcessorInput {
+    reportId: string
+    cronExpression: string
+}
+
+export async function reportProcessorWorkflow(input: ReportProcessorInput) {
+    "use workflow"
+    
+    const { reportId, cronExpression } = input
+    
+    // Your business logic here
+    await generateReport(reportId)
+    await sendNotifications(reportId)
+    
+    // Restart the scheduler for the next occurrence
+    await restartScheduler(reportId, cronExpression)
 }
 ```
 
@@ -119,14 +142,22 @@ export async function reportScheduler(input: ReportSchedulerInput) {
 ```typescript
 import { start } from "workflow"
 import { reportProcessorWorkflow } from "./report-processor"
+import { reportScheduler } from "./report-scheduler"
 
-export async function startReportProcessor(reportId: string) {
+export async function startReportProcessor(reportId: string, cronExpression: string) {
     "use step"
-    await start(reportProcessorWorkflow, [{ reportId }])
+    await start(reportProcessorWorkflow, [{ reportId, cronExpression }])
+}
+
+export async function restartScheduler(reportId: string, cronExpression: string) {
+    "use step"
+    await start(reportScheduler, [{ reportId, cronExpression }])
 }
 ```
 
-This pattern keeps your scheduling and business logic decoupled, making each workflow easier to test and maintain.
+This pattern keeps your scheduling and business logic decoupled, and creates a recurring loop: scheduler → processor → scheduler → ...
+
+For this pattern, it is recommended to return and persist your `runId` for each scheduler workflow run, in case you need to cancel a run. If the cron expression changes, you can cancel the current scheduler run and create a new one with the new cron expression.
 
 ## Requirements
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "workflow-cron-sleep",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Sleep until the next cron expression occurrence in Vercel Workflows",
     "type": "module",
     "main": "dist/index.js",
@@ -40,4 +40,4 @@
         "typescript": "^5.3.0",
         "workflow": "^4.0.1-beta.44"
     }
-}
+}