@falcondev-oss/workflow 0.1.0 → 0.2.0

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import IORedis from "ioredis";
 import { SuperJSONResult } from "superjson";
 import { Options } from "p-retry";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { SetOptional, Tagged } from "type-fest";
+import { Except, SetOptional, Tagged } from "type-fest";
 
 //#region src/errors.d.ts
 declare class WorkflowInputError extends UnrecoverableError {
@@ -16,6 +16,7 @@ declare class WorkflowInputError extends UnrecoverableError {
 declare const Settings: {
   defaultPrefix: string;
   defaultConnection: IORedis | undefined;
+  defaultCronTimezone: string | undefined;
 };
 //#endregion
 //#region src/serializer.d.ts
@@ -85,6 +86,9 @@ declare class Workflow<RunInput, Input, Output> {
   constructor(opts: WorkflowOptions<RunInput, Input, Output>);
   work(opts?: Omit<SetOptional<WorkerOptions, 'connection'>, 'autorun'>): Promise<this>;
   run(input: RunInput, opts?: JobsOptions): Promise<WorkflowJob<Output>>;
+  runIn(input: RunInput, delayMs: number, opts?: Except<JobsOptions, 'delay'>): Promise<WorkflowJob<Output>>;
+  runAt(input: RunInput, date: Date, opts?: Except<JobsOptions, 'delay'>): Promise<WorkflowJob<Output>>;
+  repeat(input: RunInput, cronOrInterval: string | number, opts?: Except<JobsOptions, 'repeat'>): Promise<WorkflowJob<Output>>;
   private getOrCreateQueue;
   private getOrCreateQueueEvents;
 }

package/dist/index.mjs

@@ -19,7 +19,8 @@ var WorkflowInputError = class extends UnrecoverableError {
 //#region src/settings.ts
 const Settings = {
 	defaultPrefix: "falcondev-oss-workflow",
-	defaultConnection: void 0
+	defaultConnection: void 0,
+	defaultCronTimezone: void 0
 };
 const defaultRedisConnection = createSingletonPromise(async () => {
 	if (Settings.defaultConnection) return Settings.defaultConnection;
@@ -219,6 +220,25 @@ var Workflow = class {
 			queueEvents: await this.getOrCreateQueueEvents()
 		});
 	}
+	async runIn(input, delayMs, opts) {
+		return this.run(input, {
+			delay: delayMs,
+			...opts
+		});
+	}
+	async runAt(input, date, opts) {
+		const now = Date.now();
+		return date.getTime() < now ? this.run(input, opts) : this.runIn(input, date.getTime() - Date.now(), opts);
+	}
+	async repeat(input, cronOrInterval, opts) {
+		return this.run(input, {
+			repeat: {
+				tz: Settings.defaultCronTimezone,
+				...typeof cronOrInterval === "string" ? { pattern: cronOrInterval } : { every: cronOrInterval }
+			},
+			...opts
+		});
+	}
 	async getOrCreateQueue() {
 		if (!this.queue) this.queue = new Queue(this.opts.id, {
 			prefix: Settings.defaultPrefix,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@falcondev-oss/workflow",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Simple type-safe queue worker with durable execution based on BullMQ.",
   "license": "MIT",
   "repository": "github:falcondev-oss/workflow",