@meridianjs/job-queue-redis 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,41 @@
+import { IScheduler, ScheduledJobConfig, ModuleDefinition } from '@meridianjs/types';
+
+interface JobQueueOptions {
+    url: string;
+    /** Prefix for all queue names — defaults to "meridian:job" */
+    prefix?: string;
+}
+/**
+ * BullMQ-backed scheduler for cron and interval jobs.
+ *
+ * Each registered job gets its own named queue (`meridian:job:<name>`).
+ * BullMQ handles persistence, retries, and scheduling across restarts.
+ *
+ * Supports:
+ *   schedule: "0 2 * * *"           — cron expression (runs daily at 2 AM)
+ *   schedule: { interval: 5000 }    — millisecond interval (runs every 5 s)
+ *
+ * For local development without Redis, jobs are unavailable.
+ * Use the scheduler module only when Redis is configured.
+ */
+declare class RedisScheduler implements IScheduler {
+    private readonly connection;
+    private readonly prefix;
+    private readonly queues;
+    private readonly workers;
+    constructor(options: JobQueueOptions);
+    register(config: ScheduledJobConfig, fn: () => Promise<void>): Promise<void>;
+    close(): Promise<void>;
+}
+/**
+ * Meridian module definition for the Redis job scheduler.
+ *
+ * Register in meridian.config.ts:
+ * @example
+ * modules: [
+ *   { resolve: "@meridianjs/job-queue-redis", options: { url: process.env.REDIS_URL } }
+ * ]
+ */
+declare const JobQueueRedisModule: ModuleDefinition;
+
+export { type JobQueueOptions, RedisScheduler, JobQueueRedisModule as default };

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { IScheduler, ScheduledJobConfig, ModuleDefinition } from '@meridianjs/types';
+
+interface JobQueueOptions {
+    url: string;
+    /** Prefix for all queue names — defaults to "meridian:job" */
+    prefix?: string;
+}
+/**
+ * BullMQ-backed scheduler for cron and interval jobs.
+ *
+ * Each registered job gets its own named queue (`meridian:job:<name>`).
+ * BullMQ handles persistence, retries, and scheduling across restarts.
+ *
+ * Supports:
+ *   schedule: "0 2 * * *"           — cron expression (runs daily at 2 AM)
+ *   schedule: { interval: 5000 }    — millisecond interval (runs every 5 s)
+ *
+ * For local development without Redis, jobs are unavailable.
+ * Use the scheduler module only when Redis is configured.
+ */
+declare class RedisScheduler implements IScheduler {
+    private readonly connection;
+    private readonly prefix;
+    private readonly queues;
+    private readonly workers;
+    constructor(options: JobQueueOptions);
+    register(config: ScheduledJobConfig, fn: () => Promise<void>): Promise<void>;
+    close(): Promise<void>;
+}
+/**
+ * Meridian module definition for the Redis job scheduler.
+ *
+ * Register in meridian.config.ts:
+ * @example
+ * modules: [
+ *   { resolve: "@meridianjs/job-queue-redis", options: { url: process.env.REDIS_URL } }
+ * ]
+ */
+declare const JobQueueRedisModule: ModuleDefinition;
+
+export { type JobQueueOptions, RedisScheduler, JobQueueRedisModule as default };

package/dist/index.js

@@ -0,0 +1,108 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  RedisScheduler: () => RedisScheduler,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_bullmq = require("bullmq");
+var import_ioredis = __toESM(require("ioredis"));
+var RedisScheduler = class {
+  connection;
+  prefix;
+  queues = /* @__PURE__ */ new Map();
+  workers = /* @__PURE__ */ new Map();
+  constructor(options) {
+    this.prefix = options.prefix ?? "meridian:job";
+    this.connection = new import_ioredis.default(options.url, {
+      maxRetriesPerRequest: null
+    });
+  }
+  async register(config, fn) {
+    const queueName = `${this.prefix}:${config.name}`;
+    const queue = new import_bullmq.Queue(queueName, {
+      connection: this.connection
+    });
+    const repeatOpts = typeof config.schedule === "string" ? { pattern: config.schedule } : { every: config.schedule.interval };
+    const existingRepeatable = await queue.getRepeatableJobs();
+    for (const job of existingRepeatable) {
+      await queue.removeRepeatableByKey(job.key);
+    }
+    await queue.add(
+      config.name,
+      {},
+      {
+        repeat: {
+          ...repeatOpts,
+          ...config.numberOfExecutions ? { limit: config.numberOfExecutions } : {}
+        },
+        removeOnComplete: { count: 100 },
+        removeOnFail: { count: 50 }
+      }
+    );
+    const worker = new import_bullmq.Worker(
+      queueName,
+      async () => {
+        await fn();
+      },
+      {
+        connection: this.connection,
+        concurrency: 1
+        // jobs run sequentially per name
+      }
+    );
+    worker.on("completed", (job) => {
+      console.info(`[Scheduler] Job "${config.name}" completed (id: ${job.id})`);
+    });
+    worker.on("failed", (job, err) => {
+      console.error(`[Scheduler] Job "${config.name}" failed:`, err.message);
+    });
+    this.queues.set(config.name, queue);
+    this.workers.set(config.name, worker);
+  }
+  async close() {
+    await Promise.all([
+      ...[...this.workers.values()].map((w) => w.close()),
+      ...[...this.queues.values()].map((q) => q.close())
+    ]);
+    await this.connection.quit();
+  }
+};
+var JobQueueRedisModule = {
+  key: "scheduler",
+  service: RedisScheduler
+};
+var index_default = JobQueueRedisModule;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  RedisScheduler
+});

package/dist/index.mjs

@@ -0,0 +1,73 @@
+// src/index.ts
+import { Queue, Worker } from "bullmq";
+import IORedis from "ioredis";
+var RedisScheduler = class {
+  connection;
+  prefix;
+  queues = /* @__PURE__ */ new Map();
+  workers = /* @__PURE__ */ new Map();
+  constructor(options) {
+    this.prefix = options.prefix ?? "meridian:job";
+    this.connection = new IORedis(options.url, {
+      maxRetriesPerRequest: null
+    });
+  }
+  async register(config, fn) {
+    const queueName = `${this.prefix}:${config.name}`;
+    const queue = new Queue(queueName, {
+      connection: this.connection
+    });
+    const repeatOpts = typeof config.schedule === "string" ? { pattern: config.schedule } : { every: config.schedule.interval };
+    const existingRepeatable = await queue.getRepeatableJobs();
+    for (const job of existingRepeatable) {
+      await queue.removeRepeatableByKey(job.key);
+    }
+    await queue.add(
+      config.name,
+      {},
+      {
+        repeat: {
+          ...repeatOpts,
+          ...config.numberOfExecutions ? { limit: config.numberOfExecutions } : {}
+        },
+        removeOnComplete: { count: 100 },
+        removeOnFail: { count: 50 }
+      }
+    );
+    const worker = new Worker(
+      queueName,
+      async () => {
+        await fn();
+      },
+      {
+        connection: this.connection,
+        concurrency: 1
+        // jobs run sequentially per name
+      }
+    );
+    worker.on("completed", (job) => {
+      console.info(`[Scheduler] Job "${config.name}" completed (id: ${job.id})`);
+    });
+    worker.on("failed", (job, err) => {
+      console.error(`[Scheduler] Job "${config.name}" failed:`, err.message);
+    });
+    this.queues.set(config.name, queue);
+    this.workers.set(config.name, worker);
+  }
+  async close() {
+    await Promise.all([
+      ...[...this.workers.values()].map((w) => w.close()),
+      ...[...this.queues.values()].map((q) => q.close())
+    ]);
+    await this.connection.quit();
+  }
+};
+var JobQueueRedisModule = {
+  key: "scheduler",
+  service: RedisScheduler
+};
+var index_default = JobQueueRedisModule;
+export {
+  RedisScheduler,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@meridianjs/job-queue-redis",
+  "version": "0.1.0",
+  "description": "Meridian job queue — BullMQ-backed IScheduler for cron and interval jobs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@meridianjs/types": "^0.1.0",
+    "bullmq": "^5.0.0",
+    "ioredis": "^5.3.2"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "*"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}