@falcondev-oss/workflow 0.7.4 → 0.8.3

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { Meter, Span } from "@opentelemetry/api";
 import { SuperJSONResult } from "superjson";
 import { Options } from "p-retry";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { AddOptions, Job, Queue, QueueOptions, WorkerOptions } from "groupmq";
+import { AddOptions, Job, Queue, QueueOptions, Worker, WorkerOptions } from "groupmq";
 import { Except, IsUnknown, SetOptional, Tagged } from "type-fest";
 
 //#region src/settings.d.ts
@@ -103,18 +103,21 @@ type WorkflowWorkerOptions<Input> = Except<WorkerOptions<WorkflowJobPayloadInter
   };
 };
 declare class Workflow<RunInput, Input, Output> {
-  id: string;
-  private opts;
-  private queue?;
+  'id': string;
+  private 'opts';
+  private 'queue'?;
+  '~internal': {
+    getOrCreateQueue: () => Promise<WorkflowQueueInternal<Input>>;
+  };
   constructor(opts: WorkflowOptions<RunInput, Input, Output>);
-  work(opts?: WorkflowWorkerOptions<Input>): Promise<this>;
-  run(input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runIn(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runAt(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runCron(scheduleId: string, cron: string, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runEvery(scheduleId: string, everyMs: number, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  private getOrCreateQueue;
-  private setupMetrics;
+  'work'(opts?: WorkflowWorkerOptions<Input>): Promise<Worker<WorkflowJobPayloadInternal<Input>>>;
+  'run'(input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runIn'(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runAt'(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runCron'(scheduleId: string, cron: string, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runEvery'(scheduleId: string, everyMs: number, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  private 'getOrCreateQueue';
+  private 'setupMetrics';
 }
 interface WorkflowRunContext<Input> {
   input: IsUnknown<Input> extends true ? undefined : Input;

package/dist/index.mjs

@@ -7294,7 +7294,7 @@ var require_parser = /* @__PURE__ */ __commonJSMin(((exports, module) => {
 }));
 
 //#endregion
-//#region node_modules/.pnpm/groupmq@1.1.0_ioredis@5.8.2/node_modules/groupmq/dist/index.js
+//#region node_modules/.pnpm/groupmq@1.1.0_ioredis@5.9.2/node_modules/groupmq/dist/index.js
 var import_parser = /* @__PURE__ */ __toESM$1(require_parser(), 1);
 const __INLINED_LUA_SCRIPTS__ = {
 	"change-delay": "-- argv: ns, jobId, newDelayUntil, now\nlocal ns = KEYS[1]\nlocal jobId = ARGV[1]\nlocal newDelayUntil = tonumber(ARGV[2])\nlocal now = tonumber(ARGV[3])\n\nlocal jobKey = ns .. \":job:\" .. jobId\nlocal delayedKey = ns .. \":delayed\"\nlocal readyKey = ns .. \":ready\"\n\n-- Check if job exists\nlocal exists = redis.call(\"EXISTS\", jobKey)\nif exists == 0 then\n  return 0\nend\n\nlocal groupId = redis.call(\"HGET\", jobKey, \"groupId\")\nif not groupId then\n  return 0\nend\n\nlocal gZ = ns .. \":g:\" .. groupId\n\n-- Update job's delayUntil field\nredis.call(\"HSET\", jobKey, \"delayUntil\", tostring(newDelayUntil))\n\n-- Check if job is currently in delayed set\nlocal inDelayed = redis.call(\"ZSCORE\", delayedKey, jobId)\n\nif newDelayUntil > 0 and newDelayUntil > now then\n  -- Job should be delayed\n  redis.call(\"HSET\", jobKey, \"status\", \"delayed\")\n  if inDelayed then\n    -- Update existing delay\n    redis.call(\"ZADD\", delayedKey, newDelayUntil, jobId)\n  else\n    -- Move to delayed\n    redis.call(\"ZADD\", delayedKey, newDelayUntil, jobId)\n    -- If this is the head job, remove group from ready\n    local head = redis.call(\"ZRANGE\", gZ, 0, 0)\n    if head and #head > 0 and head[1] == jobId then\n      redis.call(\"ZREM\", readyKey, groupId)\n    end\n  end\nelse\n  -- Job should be ready immediately\n  redis.call(\"HSET\", jobKey, \"status\", \"waiting\")\n  if inDelayed then\n    -- Remove from delayed\n    redis.call(\"ZREM\", delayedKey, jobId)\n    -- If this is the head job, ensure group is in ready\n    local head = redis.call(\"ZRANGE\", gZ, 0, 0, \"WITHSCORES\")\n    if head and #head >= 2 and head[1] == jobId then\n      local headScore = tonumber(head[2])\n      redis.call(\"ZADD\", readyKey, headScore, groupId)\n    end\n  end\nend\n\nreturn 1\n\n\n",
@@ -9706,14 +9706,15 @@ var WorkflowStep = class WorkflowStep {
 //#endregion
 //#region src/workflow.ts
 var Workflow = class {
-	id;
-	opts;
-	queue;
-	constructor(opts) {
+	"id";
+	"opts";
+	"queue";
+	"~internal" = { getOrCreateQueue: this.getOrCreateQueue.bind(this) };
+	"constructor"(opts) {
 		this.id = opts.id;
 		this.opts = opts;
 	}
-	async work(opts) {
+	async "work"(opts) {
 		const queue = await this.getOrCreateQueue();
 		const worker = new Worker({
 			handler: async (job) => {
@@ -9762,9 +9763,9 @@ var Workflow = class {
 			Settings.logger?.info?.(`[${this.opts.id}] Received ${signal}, shutting down worker...`);
 			await worker.close();
 		}, { wait: 1e4 });
-		return this;
+		return worker;
 	}
-	async run(input, opts) {
+	async "run"(input, opts) {
 		const parsedInput = this.opts.schema && await this.opts.schema["~standard"].validate(input);
 		if (parsedInput?.issues) throw new Error("Invalid workflow input");
 		const queue = await this.getOrCreateQueue();
@@ -9788,33 +9789,33 @@ var Workflow = class {
 			}) });
 		});
 	}
-	async runIn(input, delayMs, opts) {
+	async "runIn"(input, delayMs, opts) {
 		return this.run(input, {
 			delay: delayMs,
 			...opts
 		});
 	}
-	async runAt(input, date, opts) {
+	async "runAt"(input, date, opts) {
 		return this.run(input, {
 			runAt: date,
 			...opts
 		});
 	}
-	async runCron(scheduleId, cron, input, opts) {
+	async "runCron"(scheduleId, cron, input, opts) {
 		return this.run(input, {
 			groupId: scheduleId,
 			repeat: { pattern: cron },
 			...opts
 		});
 	}
-	async runEvery(scheduleId, everyMs, input, opts) {
+	async "runEvery"(scheduleId, everyMs, input, opts) {
 		return this.run(input, {
 			groupId: scheduleId,
 			repeat: { every: everyMs },
 			...opts
 		});
 	}
-	async getOrCreateQueue() {
+	async "getOrCreateQueue"() {
 		if (!this.queue) this.queue = new Queue({
 			namespace: this.opts.id,
 			redis: this.opts.redis ?? await defaultRedisConnection(),
@@ -9823,7 +9824,7 @@ var Workflow = class {
 		});
 		return this.queue;
 	}
-	async setupMetrics({ meter, prefix }) {
+	async "setupMetrics"({ meter, prefix }) {
 		const attributes = { workflow_id: this.opts.id };
 		const queue = await this.getOrCreateQueue();
 		const completedJobsGauge = meter.createObservableGauge(`${prefix}_workflow_completed_jobs`, { description: "Number of completed workflow jobs" });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@falcondev-oss/workflow",
   "type": "module",
-  "version": "0.7.4",
+  "version": "0.8.3",
   "description": "Simple type-safe queue worker with durable execution using Redis.",
   "license": "MIT",
   "repository": "github:falcondev-oss/workflow",
@@ -37,26 +37,26 @@
     "@antfu/utils": "^9.3.0",
     "@opentelemetry/api": "^1.9.0",
     "@standard-schema/spec": "^1.1.0",
-    "@types/node": "^25.0.3",
+    "@types/node": "^25.1.0",
     "exit-hook": "^5.0.1",
-    "ioredis": "^5.8.2",
+    "groupmq": "^1.1.0",
+    "ioredis": "^5.9.2",
     "p-retry": "^7.1.1",
     "superjson": "^2.2.6",
-    "type-fest": "^5.3.1"
+    "type-fest": "^5.4.2"
   },
   "devDependencies": {
     "@falcondev-oss/configs": "^5.0.2",
     "@testcontainers/redis": "^11.11.0",
     "arktype": "^2.1.29",
     "eslint": "^9.39.2",
-    "groupmq": "^1.1.0",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "rolldown": "1.0.0-rc.2",
     "tsdown": "0.19.0-beta.5",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18",
-    "zod": "^4.3.4"
+    "zod": "^4.3.6"
   },
   "scripts": {
     "build": "tsdown",