@xnestjs/ioredis 1.12.2 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/ioredis",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "description": "NestJS extension library for ioredis",
   "author": "Panates",
   "license": "MIT",
@@ -17,38 +17,22 @@
     "redis-semaphore": ">=5.6.0 <6"
   },
   "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./types/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./types/index.d.cts",
-        "default": "./cjs/index.js"
-      },
-      "default": "./esm/index.js"
+      "types": "./index.d.ts",
+      "default": "./index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
   "repository": {
     "registry": "https://github.com/panates/xnestjs.git",
     "directory": "packages/ioredis"
   },
-  "engines": {
-    "node": ">=16.0",
-    "npm": ">=7.0.0"
-  },
-  "files": [
-    "cjs/",
-    "esm/",
-    "types/",
-    "LICENSE",
-    "README.md"
-  ],
   "keywords": [
     "nestjs",
     "ioredis",

package/{esm/redis-client.js → redis-client.js}

@@ -1,8 +1,10 @@
 import { Mutex, Semaphore } from 'redis-semaphore';
 import { sharedLock } from './shared-lock.js';
 export class RedisClient {
+    locks = new Map();
+    cluster;
+    standalone;
     constructor(options) {
-        this.locks = new Map();
         this.cluster = options.cluster;
         this.standalone = options.standalone;
         if (!(this.cluster || this.standalone))

package/{esm/redis-core.module.js → redis-core.module.js}

@@ -11,6 +11,9 @@ import { RedisClient } from './redis-client.js';
 import { isClusterOptions, isStandaloneOptions } from './utils.js';
 const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
 let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
+    client;
+    connectionOptions;
+    logger;
     static forRoot(moduleOptions) {
         const connectionOptions = getRedisConfig(moduleOptions.useValue, moduleOptions.envPrefix);
         return this._createDynamicModule(moduleOptions, {

package/cjs/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IOREDIS_MODULE_TOKEN = exports.IOREDIS_CONNECTION_OPTIONS = void 0;
-exports.IOREDIS_CONNECTION_OPTIONS = Symbol('IOREDIS_CONNECTION_OPTIONS');
-exports.IOREDIS_MODULE_TOKEN = Symbol('IOREDIS_MODULE_ID');

package/cjs/get-redis-config.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRedisConfig = getRedisConfig;
-const tslib_1 = require("tslib");
-const node_process_1 = tslib_1.__importDefault(require("node:process"));
-const objects_1 = require("@jsopen/objects");
-const putil_varhelpers_1 = require("putil-varhelpers");
-const utils_js_1 = require("./utils.js");
-function getRedisConfig(options, prefix = 'REDIS_') {
-    const env = node_process_1.default.env;
-    const out = (0, objects_1.clone)(options || {});
-    let redisOptions;
-    if ((0, utils_js_1.isClusterOptions)(out)) {
-        redisOptions = out.redisOptions = out.redisOptions || {};
-        out.nodes =
-            out.nodes ?? (env[prefix + 'NODES'] || 'localhost:6379').split(/\s*,\s*/);
-    }
-    else {
-        redisOptions = out;
-        out.host = out.host ?? env[prefix + 'HOST'] ?? 'localhost';
-        out.port = out.port ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'PORT'], 6379);
-    }
-    redisOptions.db = redisOptions.db ?? (0, putil_varhelpers_1.toIntDef)(env[prefix + 'DB'], 0);
-    redisOptions.username = redisOptions.username ?? env[prefix + 'USERNAME'];
-    redisOptions.password = redisOptions.password ?? env[prefix + 'PASSWORD'];
-    redisOptions.autoResubscribe =
-        redisOptions.autoResubscribe ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'AUTO_RESUBSCRIBE']);
-    if (!redisOptions.reconnectOnError) {
-        let n = env[prefix + 'RECONNECT_ON_ERROR'];
-        if (n === 'true' || n === 'false') {
-            n = (0, putil_varhelpers_1.toBoolean)(n);
-        }
-        else
-            n = (0, putil_varhelpers_1.toInt)(n);
-        redisOptions.reconnectOnError = () => n;
-    }
-    redisOptions.connectTimeout =
-        redisOptions.connectTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'CONNECT_TIMEOUT']);
-    redisOptions.socketTimeout =
-        redisOptions.socketTimeout ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'SOCKET_TIMEOUT']);
-    redisOptions.keepAlive =
-        redisOptions.keepAlive ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'KEEP_ALIVE']);
-    redisOptions.noDelay =
-        redisOptions.noDelay ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'NO_DELAY']);
-    redisOptions.connectionName =
-        redisOptions.connectionName ?? env[prefix + 'CONNECTION_NAME'];
-    redisOptions.maxRetriesPerRequest =
-        redisOptions.maxRetriesPerRequest === null
-            ? null
-            : (redisOptions.maxRetriesPerRequest ??
-                (0, putil_varhelpers_1.toInt)(env[prefix + 'MAX_RETRIES_PER_REQUEST']));
-    out.lazyConnect =
-        options?.lazyConnect ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'LAZY_CONNECT'] ?? 'false');
-    return out;
-}

package/cjs/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./get-redis-config.js"), exports);
-tslib_1.__exportStar(require("./redis.module.js"), exports);
-tslib_1.__exportStar(require("./redis-client.js"), exports);
-tslib_1.__exportStar(require("./shared-lock.js"), exports);
-tslib_1.__exportStar(require("./types.js"), exports);

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/redis-client.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisClient = void 0;
-const redis_semaphore_1 = require("redis-semaphore");
-const shared_lock_js_1 = require("./shared-lock.js");
-class RedisClient {
-    constructor(options) {
-        this.locks = new Map();
-        this.cluster = options.cluster;
-        this.standalone = options.standalone;
-        if (!(this.cluster || this.standalone))
-            throw new TypeError('One of "cluster" or "standalone" must be set');
-    }
-    get isCluster() {
-        return !!this.cluster;
-    }
-    get redis() {
-        return (this.cluster || this.standalone);
-    }
-    quit() {
-        return this.redis.quit();
-    }
-    _getLock(kind, key) {
-        const lock = this.locks.get(key);
-        if (lock) {
-            if (lock.refCount > 0) {
-                if (lock._kind !== kind)
-                    throw new Error(`Lock "${key}" is already in use by a different kind of lock (${lock._kind})`);
-                return lock;
-            }
-            this.locks.delete(key);
-        }
-    }
-    obtainMutex(key, options) {
-        let lock = this._getLock('mutex', key);
-        if (lock)
-            return lock;
-        lock = (0, shared_lock_js_1.sharedLock)(new redis_semaphore_1.Mutex(this.redis, key, options));
-        this.locks.set(key, lock);
-        return lock;
-    }
-    obtainSemaphore(key, limit, options) {
-        let lock = this._getLock('semaphore', key);
-        if (lock)
-            return lock;
-        lock = (0, shared_lock_js_1.sharedLock)(new redis_semaphore_1.Semaphore(this.redis, key, limit, options));
-        this.locks.set(key, lock);
-        return lock;
-    }
-    obtainMultiSemaphore(key, limit, options) {
-        let lock = this._getLock('multi-semaphore', key);
-        if (lock)
-            return lock;
-        lock = (0, shared_lock_js_1.sharedLock)(new redis_semaphore_1.Semaphore(this.redis, key, limit, options));
-        this.locks.set(key, lock);
-        return lock;
-    }
-}
-exports.RedisClient = RedisClient;

package/cjs/redis-core.module.js

@@ -1,170 +0,0 @@
-"use strict";
-var RedisCoreModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisCoreModule = void 0;
-const tslib_1 = require("tslib");
-const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
-const common_1 = require("@nestjs/common");
-const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
-const crypto = tslib_1.__importStar(require("crypto"));
-const ioredis_1 = tslib_1.__importStar(require("ioredis"));
-const constants_js_1 = require("./constants.js");
-const get_redis_config_js_1 = require("./get-redis-config.js");
-const redis_client_js_1 = require("./redis-client.js");
-const utils_js_1 = require("./utils.js");
-const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
-let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
-    static forRoot(moduleOptions) {
-        const connectionOptions = (0, get_redis_config_js_1.getRedisConfig)(moduleOptions.useValue, moduleOptions.envPrefix);
-        return this._createDynamicModule(moduleOptions, {
-            providers: [
-                {
-                    provide: constants_js_1.IOREDIS_CONNECTION_OPTIONS,
-                    useValue: connectionOptions,
-                },
-            ],
-        });
-    }
-    static forRootAsync(asyncOptions) {
-        node_assert_1.default.ok(asyncOptions.useFactory, 'useFactory is required');
-        return this._createDynamicModule(asyncOptions, {
-            providers: [
-                {
-                    provide: constants_js_1.IOREDIS_CONNECTION_OPTIONS,
-                    inject: asyncOptions.inject,
-                    useFactory: async (...args) => {
-                        const opts = await asyncOptions.useFactory(...args);
-                        return (0, get_redis_config_js_1.getRedisConfig)(opts, asyncOptions.envPrefix);
-                    },
-                },
-            ],
-        });
-    }
-    static _createDynamicModule(opts, metadata) {
-        const token = opts.token ?? redis_client_js_1.RedisClient;
-        const providers = [
-            {
-                provide: token,
-                inject: [constants_js_1.IOREDIS_CONNECTION_OPTIONS],
-                useFactory: async (connectionOptions) => {
-                    return this._createClient(connectionOptions);
-                },
-            },
-            {
-                provide: CLIENT_TOKEN,
-                useExisting: token,
-            },
-            {
-                provide: common_1.Logger,
-                useValue: typeof opts.logger === 'string'
-                    ? new common_1.Logger(opts.logger)
-                    : opts.logger,
-            },
-        ];
-        return {
-            global: opts.global,
-            module: RedisCoreModule_1,
-            imports: opts.imports,
-            ...metadata,
-            providers: [
-                ...(metadata.providers ?? []),
-                ...providers,
-                {
-                    provide: constants_js_1.IOREDIS_MODULE_TOKEN,
-                    useValue: crypto.randomUUID(),
-                },
-            ],
-            exports: [constants_js_1.IOREDIS_CONNECTION_OPTIONS, token, ...(metadata.exports ?? [])],
-        };
-    }
-    static _createClient(options) {
-        const opts = { ...options };
-        let client;
-        if ((0, utils_js_1.isClusterOptions)(opts)) {
-            const startupNodes = opts.nodes;
-            delete opts.name;
-            delete opts.nodes;
-            opts.lazyConnect = true;
-            const cluster = new ioredis_1.Cluster(startupNodes, opts);
-            client = new redis_client_js_1.RedisClient({ cluster });
-        }
-        else if ((0, utils_js_1.isStandaloneOptions)(opts)) {
-            if (opts.host && opts.host.includes('://')) {
-                const url = new URL(opts.host);
-                opts.host = url.hostname;
-                if (url.port)
-                    opts.port = parseInt(url.port, 10);
-                if (url.username)
-                    opts.username = url.username;
-                if (url.password)
-                    opts.password = url.password;
-                if (url.protocol === 'rediss:') {
-                    // @ts-ignore
-                    opts.tls = true;
-                }
-                const db = parseInt(url.pathname.substring(1), 10);
-                if (db > 0)
-                    opts.db = db;
-            }
-            const standalone = new ioredis_1.default({
-                ...opts,
-                lazyConnect: true,
-            });
-            client = new redis_client_js_1.RedisClient({ standalone });
-        }
-        else
-            throw new TypeError(`Invalid connection options`);
-        return client;
-    }
-    /**
-     *
-     * @constructor
-     */
-    constructor(client, connectionOptions, logger) {
-        this.client = client;
-        this.connectionOptions = connectionOptions;
-        this.logger = logger;
-    }
-    async onApplicationBootstrap() {
-        const opts = this.connectionOptions;
-        if (opts.lazyConnect)
-            return;
-        const isCluster = (0, utils_js_1.isClusterOptions)(opts);
-        const hosts = isCluster
-            ? opts.nodes
-                .map(x => typeof x === 'object'
-                ? x.host + ':' + x.port
-                : typeof x === 'number'
-                    ? 'localhost:' + x
-                    : x)
-                .join(', ')
-            : opts.host;
-        if (hosts) {
-            this.logger?.log('Connecting to redis at ' + ansi_colors_1.default.blue(hosts));
-            common_1.Logger.flush();
-            try {
-                if (this.client.redis.status === 'wait')
-                    await this.client.redis.connect();
-                await this.client.redis.ping();
-            }
-            catch (e) {
-                this.logger?.error('Redis connection failed: ' + e.message);
-                throw e;
-            }
-        }
-    }
-    async onApplicationShutdown() {
-        try {
-            await this.client.quit();
-        }
-        catch {
-            //
-        }
-    }
-};
-exports.RedisCoreModule = RedisCoreModule;
-exports.RedisCoreModule = RedisCoreModule = RedisCoreModule_1 = tslib_1.__decorate([
-    tslib_1.__param(0, (0, common_1.Inject)(CLIENT_TOKEN)),
-    tslib_1.__param(1, (0, common_1.Inject)(constants_js_1.IOREDIS_CONNECTION_OPTIONS)),
-    tslib_1.__metadata("design:paramtypes", [redis_client_js_1.RedisClient, Object, common_1.Logger])
-], RedisCoreModule);

package/cjs/redis.module.js

@@ -1,25 +0,0 @@
-"use strict";
-var RedisModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisModule = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@nestjs/common");
-const redis_core_module_js_1 = require("./redis-core.module.js");
-let RedisModule = RedisModule_1 = class RedisModule {
-    static forRoot(options) {
-        return {
-            module: RedisModule_1,
-            imports: [redis_core_module_js_1.RedisCoreModule.forRoot(options || {})],
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: RedisModule_1,
-            imports: [redis_core_module_js_1.RedisCoreModule.forRootAsync(options)],
-        };
-    }
-};
-exports.RedisModule = RedisModule;
-exports.RedisModule = RedisModule = RedisModule_1 = tslib_1.__decorate([
-    (0, common_1.Module)({})
-], RedisModule);

package/cjs/shared-lock.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharedLock = sharedLock;
-function sharedLock(lock) {
-    let _this;
-    const _sharedLock = (_this = {
-        get refCount() {
-            return _this._refCount;
-        },
-        async acquire(callback) {
-            if (callback) {
-                await this.acquire();
-                try {
-                    return await callback();
-                }
-                finally {
-                    await this.release();
-                }
-            }
-            if (_this._refCount <= 0) {
-                _this._refCount = 1;
-                await lock.acquire();
-                return;
-            }
-            _this._refCount++;
-        },
-        async tryAcquire(callback) {
-            if (callback) {
-                if (!(await this.tryAcquire()))
-                    return false;
-                try {
-                    return await callback();
-                }
-                finally {
-                    await this.release();
-                }
-            }
-            if (_this._refCount <= 0) {
-                _this._refCount = 1;
-                if (await lock.tryAcquire())
-                    return true;
-                _this._refCount = -1;
-                return false;
-            }
-            _this._refCount++;
-            return true;
-        },
-        async release(force) {
-            if (_this._refCount <= 0)
-                return;
-            if (force || _this._refCount === 1) {
-                try {
-                    _this._refCount = -1;
-                    await lock.release();
-                    return;
-                }
-                catch {
-                    // do nothing
-                }
-            }
-            _this._refCount--;
-        },
-    });
-    Object.setPrototypeOf(_sharedLock, lock);
-    Object.defineProperty(_sharedLock, '_refCount', {
-        value: 0,
-        writable: true,
-        enumerable: false,
-        configurable: false,
-    });
-    return lock;
-}

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/utils.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isClusterOptions = isClusterOptions;
-exports.isStandaloneOptions = isStandaloneOptions;
-function isClusterOptions(options) {
-    return options && typeof options === 'object' && Array.isArray(options.nodes);
-}
-function isStandaloneOptions(options) {
-    return options && typeof options === 'object' && options.host;
-}

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,5 +0,0 @@
-export * from './get-redis-config.js';
-export * from './redis.module.js';
-export * from './redis-client.js';
-export * from './shared-lock.js';
-export * from './types.js';