nestjs-power-queues 1.0.10 → 1.0.12

package/README.md

@@ -1,2 +1,144 @@
-# NestjsPowerQueues
-## NestJS wrapper for PowerQueues.
+# nestjs-power-queues — Secure, Scalable & Production‑Ready power-queues Integration for NestJS
+
+This module is a **dedicated, production-ready NestJS wrapper around `power-queues`** — a high‑performance Redis abstraction layer for Node.js.
+
+It is a **structured, type-safe, and feature-rich integration** designed specifically to bring all the power of `power-queues` into the NestJS ecosystem with zero friction.
+
+# 📦 Installation
+
+```bash
+npm install nestjs-power-queues
+```
+
+# 🧪 Quick Start Example
+
+## For example, you need to specify 2 connections: `queues1` and `queues2`
+
+### 1. 🔐 Environment Variables (power-redis -Friendly)
+
+Everything is configured using environment variables:
+
+```env
+REDIS_<NAME>_HOST=127.0.0.1
+REDIS_<NAME>_PORT=6379
+REDIS_<NAME>_PASSWORD=pass
+REDIS_<NAME>_DATABASE=0
+
+# TLS
+REDIS_<NAME>_TLS_CRT=/etc/ssl/client.crt
+REDIS_<NAME>_TLS_KEY=/etc/ssl/client.key
+REDIS_<NAME>_TLS_CA_CRT=/etc/ssl/ca.crt
+```
+
+Instead of `<NAME>` you need to specify a custom connection name and then specify these names in `QueueModule.forRoot` (allowed in lowercase).
+For example:
+
+```env
+REDIS_QUEUES1_HOST=127.0.0.1
+REDIS_QUEUES1_PORT=6379
+REDIS_QUEUES1_PASSWORD=
+REDIS_QUEUES1_DATABASE=0
+
+REDIS_QUEUES2_HOST=127.0.0.1
+REDIS_QUEUES2_PORT=6379
+REDIS_QUEUES2_PASSWORD=
+REDIS_QUEUES2_DATABASE=0
+```
+
+TLS fields are optional.
+
+---
+
+### 2. Register module with multiple Redis clients
+
+```ts
+import { QueueModule } from 'nestjs-power-queues';
+
+@Module({
+  imports: [
+    QueueModule.forRoot([ 'queues1', 'queues2' ]),
+  ],
+})
+export class AppModule {}
+```
+
+---
+
+### 3. Inject in a service
+
+```ts
+import { Injectable } from '@nestjs/common';
+import { 
+	InjectQueue,
+	QueueService, 
+} from 'nestjs-power-queues';
+
+@Injectable()
+export class MyService {
+  constructor(
+    @InjectQueue('queues1') private readonly queueService1: QueueService,
+    @InjectQueue('queues2') private readonly queueService2: QueueService,
+  ) {}
+
+  async test() {
+    await this.queueService1.addTasks('example:jobs', [
+      { payload },
+    ]);
+  }
+}
+```
+
+### 3. Create job processor
+
+```ts
+import { Injectable } from '@nestjs/common';
+import { 
+	InjectRedis,
+	RedisService, 
+} from 'nestjs-power-redis';
+import { QueueService } from 'nestjs-power-queues';
+
+@Injectable()
+export class MyService extends QueueService {
+  public readonly stream: string = `example:jobs`;
+  public readonly workerBatchTasksCount: number = 8192;
+  public readonly runOnInit: boolean = true;
+  public readonly executeBatchAtOnce: boolean = true;
+
+  constructor(
+    @InjectRedis('queues1') public readonly redisService: RedisService,
+  ) {}
+
+  async onExecute(id, payload) {
+  	// business-logic
+  }
+}
+```
+
+The `runOnInit` parameter determines whether queue processing should start immediately after the application starts.
+
+---
+
+## 🏗️ How It Works Internally
+
+### queueRoot()
+Loads all Redis configurations based on environment variables, applies TLS if present, and sets reconnection strategies.
+
+### RedisModule.forRoot()
+Creates dynamic providers for each Redis connection:
+```
+RedisQueue_queues1  
+RedisQueue_queues2
+```
+
+These providers are available through:
+```ts
+@InjectQueue('queues1')
+@InjectQueue('queues2')
+```
+
+---
+
+## 📜 License
+
+MIT - free for commercial and private use.

package/dist/index.cjs

@@ -23,44 +23,38 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  InjectQueue: () => InjectQueue,
   QueueModule: () => QueueModule,
   QueueService: () => QueueService,
-  redisRoot: () => import_nestjs_power_redis3.redisRoot
+  getQueueToken: () => getQueueToken,
+  queueRoot: () => import_nestjs_power_redis2.redisRoot
 });
 module.exports = __toCommonJS(index_exports);
-var import_nestjs_power_redis3 = require("nestjs-power-redis");
+var import_nestjs_power_redis2 = require("nestjs-power-redis");
+
+// src/InjectQueue.ts
+var import_common = require("@nestjs/common");
+var getQueueToken = /* @__PURE__ */ __name((name) => `QueueService_${name}`, "getQueueToken");
+var InjectQueue = /* @__PURE__ */ __name((name) => (0, import_common.Inject)(getQueueToken(name)), "InjectQueue");
 
 // src/QueueModule.ts
-var import_common2 = require("@nestjs/common");
-var import_nestjs_power_redis2 = require("nestjs-power-redis");
+var import_common3 = require("@nestjs/common");
+var import_nestjs_power_redis = require("nestjs-power-redis");
 
 // src/QueueService.ts
-var import_common = require("@nestjs/common");
+var import_common2 = require("@nestjs/common");
 var import_power_queues = require("power-queues");
-var import_nestjs_power_redis = require("nestjs-power-redis");
-function _ts_decorate(decorators, target, key, desc) {
-  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-  return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-__name(_ts_decorate, "_ts_decorate");
-function _ts_metadata(k, v) {
-  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-__name(_ts_metadata, "_ts_metadata");
 var _QueueService = class _QueueService extends import_power_queues.PowerQueues {
   constructor(redisService) {
     super();
     __publicField(this, "redisService");
-    __publicField(this, "logger", new import_common.Logger("QueueService"));
+    __publicField(this, "logger", new import_common2.Logger("QueueService"));
     __publicField(this, "runOnInit", false);
     __publicField(this, "redis");
-    __publicField(this, "abort", new AbortController());
     this.redisService = redisService;
+    this.redis = redisService.redis;
   }
   async onModuleInit() {
-    this.redis = this.redisService.redis;
     await this.loadScripts(this.runOnInit);
     if (this.runOnInit) {
       await this.runQueue();
@@ -74,48 +68,51 @@ var _QueueService = class _QueueService extends import_power_queues.PowerQueues
 };
 __name(_QueueService, "QueueService");
 var QueueService = _QueueService;
-QueueService = _ts_decorate([
-  (0, import_common.Injectable)(),
-  _ts_metadata("design:type", Function),
-  _ts_metadata("design:paramtypes", [
-    typeof import_nestjs_power_redis.RedisService === "undefined" ? Object : import_nestjs_power_redis.RedisService
-  ])
-], QueueService);
 
 // src/QueueModule.ts
-function _ts_decorate2(decorators, target, key, desc) {
+function _ts_decorate(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate2, "_ts_decorate");
+__name(_ts_decorate, "_ts_decorate");
 var _QueueModule = class _QueueModule {
   static forRoot(names) {
+    const queueProviders = names.map((name) => ({
+      provide: getQueueToken(name),
+      useFactory: /* @__PURE__ */ __name((redisService) => {
+        return new QueueService(redisService);
+      }, "useFactory"),
+      inject: [
+        (0, import_nestjs_power_redis.getRedisToken)(name)
+      ]
+    }));
     return {
       module: _QueueModule,
       imports: [
-        ...(0, import_nestjs_power_redis2.redisRoot)(names)
+        import_nestjs_power_redis.RedisModule.forRoot(names)
       ],
       providers: [
-        import_nestjs_power_redis2.RedisService,
-        QueueService
+        ...queueProviders
       ],
       exports: [
-        import_nestjs_power_redis2.RedisService,
-        QueueService
+        ...queueProviders,
+        import_nestjs_power_redis.RedisModule
       ]
     };
   }
 };
 __name(_QueueModule, "QueueModule");
 var QueueModule = _QueueModule;
-QueueModule = _ts_decorate2([
-  (0, import_common2.Module)({})
+QueueModule = _ts_decorate([
+  (0, import_common3.Module)({})
 ], QueueModule);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  InjectQueue,
   QueueModule,
   QueueService,
-  redisRoot
+  getQueueToken,
+  queueRoot
 });

package/dist/index.d.cts

@@ -1,9 +1,12 @@
 import { RedisService } from 'nestjs-power-redis';
-export { redisRoot } from 'nestjs-power-redis';
+export { redisRoot as queueRoot } from 'nestjs-power-redis';
 import { DynamicModule, OnModuleInit, OnModuleDestroy, Logger } from '@nestjs/common';
 import { IORedisLike } from 'power-redis';
 import { PowerQueues } from 'power-queues';
 
+declare const getQueueToken: (name: string) => string;
+declare const InjectQueue: (name: string) => PropertyDecorator & ParameterDecorator;
+
 declare class QueueModule {
     static forRoot(names: string[]): DynamicModule;
 }
@@ -13,10 +16,9 @@ declare class QueueService extends PowerQueues implements OnModuleInit, OnModule
     readonly logger: Logger;
     readonly runOnInit: boolean;
     redis: IORedisLike;
-    abort: AbortController;
     constructor(redisService: RedisService);
     onModuleInit(): Promise<void>;
     onModuleDestroy(): Promise<void>;
 }
 
-export { QueueModule, QueueService };
+export { InjectQueue, QueueModule, QueueService, getQueueToken };

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 import { RedisService } from 'nestjs-power-redis';
-export { redisRoot } from 'nestjs-power-redis';
+export { redisRoot as queueRoot } from 'nestjs-power-redis';
 import { DynamicModule, OnModuleInit, OnModuleDestroy, Logger } from '@nestjs/common';
 import { IORedisLike } from 'power-redis';
 import { PowerQueues } from 'power-queues';
 
+declare const getQueueToken: (name: string) => string;
+declare const InjectQueue: (name: string) => PropertyDecorator & ParameterDecorator;
+
 declare class QueueModule {
     static forRoot(names: string[]): DynamicModule;
 }
@@ -13,10 +16,9 @@ declare class QueueService extends PowerQueues implements OnModuleInit, OnModule
     readonly logger: Logger;
     readonly runOnInit: boolean;
     redis: IORedisLike;
-    abort: AbortController;
     constructor(redisService: RedisService);
     onModuleInit(): Promise<void>;
     onModuleDestroy(): Promise<void>;
 }
 
-export { QueueModule, QueueService };
+export { InjectQueue, QueueModule, QueueService, getQueueToken };

package/dist/index.js

@@ -4,27 +4,20 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
 // src/index.ts
-import { redisRoot as redisRoot2 } from "nestjs-power-redis";
+import { redisRoot as queueRoot } from "nestjs-power-redis";
+
+// src/InjectQueue.ts
+import { Inject } from "@nestjs/common";
+var getQueueToken = /* @__PURE__ */ __name((name) => `QueueService_${name}`, "getQueueToken");
+var InjectQueue = /* @__PURE__ */ __name((name) => Inject(getQueueToken(name)), "InjectQueue");
 
 // src/QueueModule.ts
 import { Module } from "@nestjs/common";
-import { redisRoot, RedisService as RedisService2 } from "nestjs-power-redis";
+import { RedisModule, getRedisToken } from "nestjs-power-redis";
 
 // src/QueueService.ts
-import { Injectable, Logger } from "@nestjs/common";
+import { Logger } from "@nestjs/common";
 import { PowerQueues } from "power-queues";
-import { RedisService } from "nestjs-power-redis";
-function _ts_decorate(decorators, target, key, desc) {
-  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-  return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-__name(_ts_decorate, "_ts_decorate");
-function _ts_metadata(k, v) {
-  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-__name(_ts_metadata, "_ts_metadata");
 var _QueueService = class _QueueService extends PowerQueues {
   constructor(redisService) {
     super();
@@ -32,11 +25,10 @@ var _QueueService = class _QueueService extends PowerQueues {
     __publicField(this, "logger", new Logger("QueueService"));
     __publicField(this, "runOnInit", false);
     __publicField(this, "redis");
-    __publicField(this, "abort", new AbortController());
     this.redisService = redisService;
+    this.redis = redisService.redis;
   }
   async onModuleInit() {
-    this.redis = this.redisService.redis;
     await this.loadScripts(this.runOnInit);
     if (this.runOnInit) {
       await this.runQueue();
@@ -50,47 +42,50 @@ var _QueueService = class _QueueService extends PowerQueues {
 };
 __name(_QueueService, "QueueService");
 var QueueService = _QueueService;
-QueueService = _ts_decorate([
-  Injectable(),
-  _ts_metadata("design:type", Function),
-  _ts_metadata("design:paramtypes", [
-    typeof RedisService === "undefined" ? Object : RedisService
-  ])
-], QueueService);
 
 // src/QueueModule.ts
-function _ts_decorate2(decorators, target, key, desc) {
+function _ts_decorate(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate2, "_ts_decorate");
+__name(_ts_decorate, "_ts_decorate");
 var _QueueModule = class _QueueModule {
   static forRoot(names) {
+    const queueProviders = names.map((name) => ({
+      provide: getQueueToken(name),
+      useFactory: /* @__PURE__ */ __name((redisService) => {
+        return new QueueService(redisService);
+      }, "useFactory"),
+      inject: [
+        getRedisToken(name)
+      ]
+    }));
     return {
       module: _QueueModule,
       imports: [
-        ...redisRoot(names)
+        RedisModule.forRoot(names)
       ],
       providers: [
-        RedisService2,
-        QueueService
+        ...queueProviders
       ],
       exports: [
-        RedisService2,
-        QueueService
+        ...queueProviders,
+        RedisModule
       ]
     };
   }
 };
 __name(_QueueModule, "QueueModule");
 var QueueModule = _QueueModule;
-QueueModule = _ts_decorate2([
+QueueModule = _ts_decorate([
   Module({})
 ], QueueModule);
 export {
+  InjectQueue,
   QueueModule,
   QueueService,
-  redisRoot2 as redisRoot
+  getQueueToken,
+  queueRoot
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nestjs-power-queues",
-	"version": "1.0.10",
+	"version": "1.0.12",
 	"description": "NestJS wrapper for PowerQueues.",
 	"author": "ihor-bielchenko",
 	"license": "MIT",
@@ -87,8 +87,8 @@
 	"dependencies": {
 		"@nestjs-labs/nestjs-ioredis": "^11.0.4",
 		"@nestjs/common": "^11.1.8",
-		"full-utils": "^2.0.3",
-		"nestjs-power-redis": "^1.0.4",
-		"power-queues": "^2.0.12"
+		"full-utils": "^2.0.5",
+		"nestjs-power-redis": "^1.0.8",
+		"power-queues": "^2.0.16"
 	}
 }