@xnestjs/ioredis 0.10.4 → 1.0.1

package/package.json

@@ -1,14 +1,35 @@
 {
   "name": "@xnestjs/ioredis",
-  "version": "0.10.4",
+  "version": "1.0.1",
   "description": "NestJS extension library for ioredis",
   "author": "Panates",
   "license": "MIT",
+  "scripts": {
+    "compile": "tsc --noEmit",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc -b tsconfig-build-cjs.json && cp ../../support/package.cjs.json ./build/cjs/package.json",
+    "build:esm": "tsc -b tsconfig-build-esm.json && cp ../../support/package.esm.json ./build/esm/package.json",
+    "postbuild": "cp README.md ../../LICENSE ./build && node ../../support/postbuild.cjs",
+    "lint": "eslint . --max-warnings=0",
+    "lint:fix": "eslint . --max-warnings=0 --fix",
+    "format": "prettier . --write --log-level=warn",
+    "check": "madge --circular src/**",
+    "test": "jest",
+    "cover": "jest --collect-coverage",
+    "clean": "npm run clean:src && npm run clean:build && npm run clean:cover",
+    "clean:src": "ts-cleanup -s src --all && ts-cleanup -s test --all",
+    "clean:build": "rimraf build",
+    "clean:cover": "rimraf coverage"
+  },
   "peerDependencies": {
-    "@nestjs/common": "^10.4.7",
-    "@nestjs/core": "^10.4.7",
-    "ioredis": "^5.4.1",
-    "redlock": "^5.0.0-beta.2"
+    "@nestjs/common": "^10.4.15",
+    "@nestjs/core": "^10.4.15",
+    "ioredis": "^5.4.2",
+    "redis-semaphore": "^5.6.1"
+  },
+  "devDependencies": {
+    "@nestjs/testing": "^10.4.15"
   },
   "type": "module",
   "exports": {
@@ -48,4 +69,4 @@
     "ioredis",
     "redis"
   ]
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Panates
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/cjs/index.js

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

package/cjs/package.json

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

package/cjs/redis-client.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisClient = void 0;
-const tslib_1 = require("tslib");
-const redlock_1 = tslib_1.__importDefault(require("redlock"));
-class RedisClient {
-    constructor(options) {
-        this.cluster = options.cluster;
-        this.standalone = options.standalone;
-        if (!(this.cluster || this.standalone))
-            throw new TypeError('One of "cluster" or "standalone" must be set');
-        this._redlock = new redlock_1.default([this.redis], options.lock);
-    }
-    get isCluster() {
-        return !!this.cluster;
-    }
-    get redis() {
-        return (this.cluster || this.standalone);
-    }
-    get lock() {
-        return this._redlock;
-    }
-}
-exports.RedisClient = RedisClient;

package/cjs/redis-core.module.js

@@ -1,125 +0,0 @@
-"use strict";
-var RedisCoreModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisCoreModule = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@nestjs/common");
-const core_1 = require("@nestjs/core");
-const crypto = tslib_1.__importStar(require("crypto"));
-const ioredis_1 = tslib_1.__importStar(require("ioredis"));
-const redis_constants_js_1 = require("./redis.constants.js");
-const redis_client_js_1 = require("./redis-client.js");
-const utils_js_1 = require("./utils.js");
-let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
-    constructor(options, moduleRef) {
-        this.options = options;
-        this.moduleRef = moduleRef;
-    }
-    static forRoot(options) {
-        const optionsProvider = {
-            provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
-            useValue: options,
-        };
-        const token = options.token || redis_client_js_1.RedisClient;
-        const connectionProvider = {
-            provide: token,
-            useFactory: () => this._createClient(options),
-        };
-        return {
-            module: RedisCoreModule_1,
-            providers: [connectionProvider, optionsProvider],
-            exports: [connectionProvider],
-        };
-    }
-    static forRootAsync(asyncOptions) {
-        if (!asyncOptions.useFactory)
-            throw new Error('Invalid configuration. Must provide "useFactory"');
-        const token = asyncOptions.token || redis_client_js_1.RedisClient;
-        const connectionProvider = {
-            provide: token,
-            inject: [redis_constants_js_1.IOREDIS_MODULE_OPTIONS],
-            useFactory: async (moduleOptions) => this._createClient(moduleOptions),
-        };
-        return {
-            module: RedisCoreModule_1,
-            imports: asyncOptions.imports,
-            providers: [
-                {
-                    provide: redis_constants_js_1.IOREDIS_MODULE_OPTIONS,
-                    useFactory: asyncOptions.useFactory,
-                    inject: asyncOptions.inject || [],
-                },
-                {
-                    provide: redis_constants_js_1.IOREDIS_MODULE_TOKEN,
-                    useValue: crypto.randomUUID(),
-                },
-                connectionProvider,
-            ],
-            exports: [connectionProvider],
-        };
-    }
-    static async _createClient(options) {
-        if (options.host && options.nodes) {
-            throw new TypeError(`You should set either "host" or "nodes", not both`);
-        }
-        const opts = { ...options };
-        const isCluster = (0, utils_js_1.isClusterOptions)(opts);
-        let client;
-        if (isCluster) {
-            delete opts.name;
-            delete opts.nodes;
-            const cluster = new ioredis_1.Cluster(opts.nodes, opts);
-            client = new redis_client_js_1.RedisClient({ cluster, lock: options.lock });
-        }
-        else {
-            if (options.host && options.host.includes('://')) {
-                const url = new URL(options.host);
-                options.host = url.hostname;
-                if (url.port)
-                    options.port = parseInt(url.port, 10);
-                if (url.username)
-                    options.username = url.username;
-                if (url.password)
-                    options.password = url.password;
-                if (url.protocol === 'rediss:') {
-                    // @ts-ignore
-                    options.tls = true;
-                }
-                const db = parseInt(url.pathname.substring(1), 10);
-                if (db > 0)
-                    options.db = db;
-            }
-            const standalone = new ioredis_1.default(options);
-            client = new redis_client_js_1.RedisClient({ standalone, lock: options.lock });
-        }
-        if (!options.lazyConnect) {
-            await new Promise((resolve, reject) => {
-                client.redis.once('ready', () => {
-                    client.redis.removeListener('error', reject);
-                    resolve();
-                });
-                client.redis.once('error', e => {
-                    client.redis.removeListener('ready', resolve);
-                    reject(e);
-                });
-            });
-        }
-        return client;
-    }
-    async onApplicationShutdown() {
-        try {
-            const client = this.moduleRef.get(this.options.token || redis_client_js_1.RedisClient);
-            await client.redis.quit();
-        }
-        catch {
-            //
-        }
-    }
-};
-exports.RedisCoreModule = RedisCoreModule;
-exports.RedisCoreModule = RedisCoreModule = RedisCoreModule_1 = tslib_1.__decorate([
-    (0, common_1.Global)(),
-    (0, common_1.Module)({}),
-    tslib_1.__param(0, (0, common_1.Inject)(redis_constants_js_1.IOREDIS_MODULE_OPTIONS)),
-    tslib_1.__metadata("design:paramtypes", [Object, core_1.ModuleRef])
-], RedisCoreModule);

package/cjs/redis.constants.js

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

package/cjs/redis.interface.js

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

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/utils.js

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

package/esm/index.js

@@ -1,3 +0,0 @@
-export * from './redis.interface.js';
-export * from './redis.module.js';
-export * from './redis-client.js';

package/esm/package.json

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

package/esm/redis-client.js

@@ -1,19 +0,0 @@
-import Redlock from 'redlock';
-export class RedisClient {
-    constructor(options) {
-        this.cluster = options.cluster;
-        this.standalone = options.standalone;
-        if (!(this.cluster || this.standalone))
-            throw new TypeError('One of "cluster" or "standalone" must be set');
-        this._redlock = new Redlock([this.redis], options.lock);
-    }
-    get isCluster() {
-        return !!this.cluster;
-    }
-    get redis() {
-        return (this.cluster || this.standalone);
-    }
-    get lock() {
-        return this._redlock;
-    }
-}

package/esm/redis-core.module.js

@@ -1,122 +0,0 @@
-var RedisCoreModule_1;
-import { __decorate, __metadata, __param } from "tslib";
-import { Global, Inject, Module } from '@nestjs/common';
-import { ModuleRef } from '@nestjs/core';
-import * as crypto from 'crypto';
-import Redis, { Cluster } from 'ioredis';
-import { IOREDIS_MODULE_OPTIONS, IOREDIS_MODULE_TOKEN } from './redis.constants.js';
-import { RedisClient } from './redis-client.js';
-import { isClusterOptions } from './utils.js';
-let RedisCoreModule = RedisCoreModule_1 = class RedisCoreModule {
-    constructor(options, moduleRef) {
-        this.options = options;
-        this.moduleRef = moduleRef;
-    }
-    static forRoot(options) {
-        const optionsProvider = {
-            provide: IOREDIS_MODULE_OPTIONS,
-            useValue: options,
-        };
-        const token = options.token || RedisClient;
-        const connectionProvider = {
-            provide: token,
-            useFactory: () => this._createClient(options),
-        };
-        return {
-            module: RedisCoreModule_1,
-            providers: [connectionProvider, optionsProvider],
-            exports: [connectionProvider],
-        };
-    }
-    static forRootAsync(asyncOptions) {
-        if (!asyncOptions.useFactory)
-            throw new Error('Invalid configuration. Must provide "useFactory"');
-        const token = asyncOptions.token || RedisClient;
-        const connectionProvider = {
-            provide: token,
-            inject: [IOREDIS_MODULE_OPTIONS],
-            useFactory: async (moduleOptions) => this._createClient(moduleOptions),
-        };
-        return {
-            module: RedisCoreModule_1,
-            imports: asyncOptions.imports,
-            providers: [
-                {
-                    provide: IOREDIS_MODULE_OPTIONS,
-                    useFactory: asyncOptions.useFactory,
-                    inject: asyncOptions.inject || [],
-                },
-                {
-                    provide: IOREDIS_MODULE_TOKEN,
-                    useValue: crypto.randomUUID(),
-                },
-                connectionProvider,
-            ],
-            exports: [connectionProvider],
-        };
-    }
-    static async _createClient(options) {
-        if (options.host && options.nodes) {
-            throw new TypeError(`You should set either "host" or "nodes", not both`);
-        }
-        const opts = { ...options };
-        const isCluster = isClusterOptions(opts);
-        let client;
-        if (isCluster) {
-            delete opts.name;
-            delete opts.nodes;
-            const cluster = new Cluster(opts.nodes, opts);
-            client = new RedisClient({ cluster, lock: options.lock });
-        }
-        else {
-            if (options.host && options.host.includes('://')) {
-                const url = new URL(options.host);
-                options.host = url.hostname;
-                if (url.port)
-                    options.port = parseInt(url.port, 10);
-                if (url.username)
-                    options.username = url.username;
-                if (url.password)
-                    options.password = url.password;
-                if (url.protocol === 'rediss:') {
-                    // @ts-ignore
-                    options.tls = true;
-                }
-                const db = parseInt(url.pathname.substring(1), 10);
-                if (db > 0)
-                    options.db = db;
-            }
-            const standalone = new Redis(options);
-            client = new RedisClient({ standalone, lock: options.lock });
-        }
-        if (!options.lazyConnect) {
-            await new Promise((resolve, reject) => {
-                client.redis.once('ready', () => {
-                    client.redis.removeListener('error', reject);
-                    resolve();
-                });
-                client.redis.once('error', e => {
-                    client.redis.removeListener('ready', resolve);
-                    reject(e);
-                });
-            });
-        }
-        return client;
-    }
-    async onApplicationShutdown() {
-        try {
-            const client = this.moduleRef.get(this.options.token || RedisClient);
-            await client.redis.quit();
-        }
-        catch {
-            //
-        }
-    }
-};
-RedisCoreModule = RedisCoreModule_1 = __decorate([
-    Global(),
-    Module({}),
-    __param(0, Inject(IOREDIS_MODULE_OPTIONS)),
-    __metadata("design:paramtypes", [Object, ModuleRef])
-], RedisCoreModule);
-export { RedisCoreModule };

package/esm/redis.constants.js

@@ -1,2 +0,0 @@
-export const IOREDIS_MODULE_OPTIONS = Symbol('IOREDIS_MODULE_OPTIONS');
-export const IOREDIS_MODULE_TOKEN = Symbol('IOREDIS_MODULE_ID');

package/esm/redis.interface.js

@@ -1 +0,0 @@
-export {};

package/esm/redis.module.js

@@ -1,22 +0,0 @@
-var RedisModule_1;
-import { __decorate } from "tslib";
-import { Module } from '@nestjs/common';
-import { RedisCoreModule } from './redis-core.module.js';
-let RedisModule = RedisModule_1 = class RedisModule {
-    static forRoot(options) {
-        return {
-            module: RedisModule_1,
-            imports: [RedisCoreModule.forRoot(options)],
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: RedisModule_1,
-            imports: [RedisCoreModule.forRootAsync(options)],
-        };
-    }
-};
-RedisModule = RedisModule_1 = __decorate([
-    Module({})
-], RedisModule);
-export { RedisModule };

package/esm/utils.js

@@ -1,3 +0,0 @@
-export function isClusterOptions(options) {
-    return options && typeof options === 'object' && Array.isArray(options.nodes);
-}

package/types/index.d.cts

@@ -1,3 +0,0 @@
-export * from './redis.interface.js';
-export * from './redis.module.js';
-export * from './redis-client.js';

package/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './redis.interface.js';
-export * from './redis.module.js';
-export * from './redis-client.js';

package/types/redis-client.d.ts

@@ -1,19 +0,0 @@
-import { Cluster as IORedisCluster, Redis as IORedisClient } from 'ioredis';
-import Redlock from 'redlock';
-import type { LockSettings } from './redis.interface.js';
-export declare namespace RedisClient {
-    interface Options {
-        cluster?: IORedisCluster;
-        standalone?: IORedisClient;
-        lock?: LockSettings;
-    }
-}
-export declare class RedisClient {
-    readonly _redlock: Redlock;
-    cluster?: IORedisCluster;
-    standalone?: IORedisClient;
-    constructor(options: RedisClient.Options);
-    get isCluster(): boolean;
-    get redis(): IORedisCluster | IORedisClient;
-    get lock(): Redlock;
-}

package/types/redis-core.module.d.ts

@@ -1,12 +0,0 @@
-import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
-import { ModuleRef } from '@nestjs/core';
-import { RedisClientAsyncOptions, RedisClientOptions, RedisClusterAsyncOptions, RedisClusterOptions } from './redis.interface.js';
-export declare class RedisCoreModule implements OnApplicationShutdown {
-    private readonly options;
-    private readonly moduleRef;
-    constructor(options: RedisClientOptions | RedisClusterOptions, moduleRef: ModuleRef);
-    static forRoot(options: RedisClientOptions | RedisClusterOptions): DynamicModule;
-    static forRootAsync(asyncOptions: RedisClientAsyncOptions | RedisClusterAsyncOptions): DynamicModule;
-    private static _createClient;
-    onApplicationShutdown(): Promise<void>;
-}

package/types/redis.constants.d.ts

@@ -1,2 +0,0 @@
-export declare const IOREDIS_MODULE_OPTIONS: unique symbol;
-export declare const IOREDIS_MODULE_TOKEN: unique symbol;

package/types/redis.interface.d.ts

@@ -1,38 +0,0 @@
-import type { ModuleMetadata } from '@nestjs/common/interfaces';
-import type { RedisOptions } from 'ioredis';
-import type { ClusterOptions } from 'ioredis/built/cluster/ClusterOptions';
-import type { ClusterNode } from 'ioredis/built/cluster/index.js';
-import type { Lock, Settings as RedlockSettings } from 'redlock';
-export interface RedisClientOptions extends RedisOptions {
-    /**
-     * Injection token
-     */
-    token?: any;
-    lock?: LockSettings;
-}
-export interface RedisClusterOptions extends ClusterOptions {
-    /**
-     * Injection token
-     */
-    token?: any;
-    nodes: ClusterNode[];
-}
-export interface RedisClientAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    /**
-     * Injection token
-     */
-    token?: any;
-    useFactory?: (...args: any[]) => Promise<RedisClientOptions> | RedisClientOptions;
-    inject?: any[];
-}
-export interface RedisClusterAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    /**
-     * Injection token
-     */
-    token?: any;
-    useFactory?: (...args: any[]) => Promise<RedisClusterOptions> | RedisClusterOptions;
-    inject?: any[];
-}
-export interface LockSettings extends RedlockSettings {
-}
-export { Lock };

package/types/redis.module.d.ts

@@ -1,6 +0,0 @@
-import { DynamicModule } from '@nestjs/common';
-import { RedisClientAsyncOptions, RedisClientOptions, RedisClusterAsyncOptions, RedisClusterOptions } from './redis.interface.js';
-export declare class RedisModule {
-    static forRoot(options: RedisClientOptions | RedisClusterOptions): DynamicModule;
-    static forRootAsync(options: RedisClientAsyncOptions | RedisClusterAsyncOptions): DynamicModule;
-}

package/types/utils.d.ts

@@ -1,2 +0,0 @@
-import { RedisClusterOptions } from './redis.interface.js';
-export declare function isClusterOptions(options: any): options is RedisClusterOptions;