@rnw-community/nestjs-rxjs-lock 0.52.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2021 Vitalii Yehorov and others
+
+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/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from './nestjs-rxjs-lock.module';
+export * from './nestjs-rxjs-lock-module.options';
+export * from './nestjs-rxjs-lock-service/nestjs-rxjs-lock.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,qDAAqD,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./nestjs-rxjs-lock.module"), exports);
+__exportStar(require("./nestjs-rxjs-lock-module.options"), exports);
+__exportStar(require("./nestjs-rxjs-lock-service/nestjs-rxjs-lock.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,oEAAkD;AAClD,sFAAoE"}

package/dist/cjs/nestjs-rxjs-lock-module.options.d.ts

@@ -0,0 +1,6 @@
+import type Redlock from 'redlock';
+export interface NestJSRxJSLockModuleOptions extends Redlock.Options {
+    defaultExpireMs: number;
+}
+export declare const defaultNestJSRxJSLockModuleOptions: NestJSRxJSLockModuleOptions;
+//# sourceMappingURL=nestjs-rxjs-lock-module.options.d.ts.map

package/dist/cjs/nestjs-rxjs-lock-module.options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock-module.options.d.ts","sourceRoot":"","sources":["../../src/nestjs-rxjs-lock-module.options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,2BAA4B,SAAQ,OAAO,CAAC,OAAO;IAChE,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,kCAAkC,EAAE,2BAGhD,CAAC"}

package/dist/cjs/nestjs-rxjs-lock-module.options.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultNestJSRxJSLockModuleOptions = void 0;
+exports.defaultNestJSRxJSLockModuleOptions = {
+    defaultExpireMs: 10000,
+    retryCount: 0,
+};
+//# sourceMappingURL=nestjs-rxjs-lock-module.options.js.map

package/dist/cjs/nestjs-rxjs-lock-module.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock-module.options.js","sourceRoot":"","sources":["../../src/nestjs-rxjs-lock-module.options.ts"],"names":[],"mappings":";;;AAMa,QAAA,kCAAkC,GAAgC;IAC3E,eAAe,EAAE,KAAK;IACtB,UAAU,EAAE,CAAC;CAChB,CAAC"}

package/dist/cjs/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.d.ts

@@ -0,0 +1,24 @@
+import { type Observable } from 'rxjs';
+import type { NestJSRxJSLockModuleOptions } from '../nestjs-rxjs-lock-module.options';
+import type { RedisService } from 'nestjs-redis';
+export declare abstract class NestJSRxJSLockService<E = string> {
+    readonly redis: RedisService;
+    readonly options: NestJSRxJSLockModuleOptions;
+    private readonly lock;
+    private readonly expireInMs;
+    protected constructor(redis: RedisService, options: NestJSRxJSLockModuleOptions);
+    /**
+     * RxJS wrapper for redlock acquire lock method
+     *
+     * @see https://www.npmjs.com/package/redlock
+     *
+     * @param name Redis lock key name
+     * @param prefix Redis lock key prefix
+     * @param handler$ Observable handler with business logic to be executed under lock
+     * @param expireInMs Lock expiration time in milliseconds, default option is used if not provided
+     * @returns Observable<T> returned from handler$
+     */
+    lock$<T>(name: string, prefix: E, handler$: () => Observable<T>, expireInMs?: number): Observable<T>;
+    private static generateName;
+}
+//# sourceMappingURL=nestjs-rxjs-lock.service.d.ts.map

package/dist/cjs/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock.service.d.ts","sourceRoot":"","sources":["../../../src/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAqD,MAAM,MAAM,CAAC;AAI1F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD,8BAAsB,qBAAqB,CAAC,CAAC,GAAG,MAAM;IAM9C,QAAQ,CAAC,KAAK,EAAE,YAAY;IAC5B,QAAQ,CAAC,OAAO,EAAE,2BAA2B;IANjD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAU;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IAEpC,SAAS,aAEI,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,2BAA2B;IAUjD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,SAAkB,GAAG,UAAU,CAAC,CAAC,CAAC;IAU7G,OAAO,CAAC,MAAM,CAAC,YAAY;CAG9B"}

package/dist/cjs/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestJSRxJSLockService = void 0;
+const redlock_1 = __importDefault(require("redlock"));
+const rxjs_1 = require("rxjs");
+const shared_1 = require("@rnw-community/shared");
+class NestJSRxJSLockService {
+    constructor(
+    // TODO: Can we avoid nestjs-redis dependency?
+    redis, options) {
+        this.redis = redis;
+        this.options = options;
+        const { defaultExpireMs, ...redlockOptions } = options;
+        this.expireInMs = options.defaultExpireMs;
+        const redisInstances = Array.from(redis.getClients().values());
+        this.lock = new redlock_1.default(redisInstances, redlockOptions);
+    }
+    /**
+     * RxJS wrapper for redlock acquire lock method
+     *
+     * @see https://www.npmjs.com/package/redlock
+     *
+     * @param name Redis lock key name
+     * @param prefix Redis lock key prefix
+     * @param handler$ Observable handler with business logic to be executed under lock
+     * @param expireInMs Lock expiration time in milliseconds, default option is used if not provided
+     * @returns Observable<T> returned from handler$
+     */
+    lock$(name, prefix, handler$, expireInMs = this.expireInMs) {
+        const lockName = NestJSRxJSLockService.generateName(name, prefix);
+        // TODO: Why do we have an array of locks here?
+        return (0, rxjs_1.from)(this.lock.acquire([lockName], expireInMs)).pipe((0, rxjs_1.concatMap)(lock => handler$().pipe((0, rxjs_1.finalize)(() => void lock.unlock()))), (0, rxjs_1.catchError)((e) => (0, rxjs_1.throwError)(() => `Lock for "${lockName}" failed: ${(0, shared_1.getErrorMessage)(e)}`)));
+    }
+    static generateName(name, prefix) {
+        return ['lock', prefix, name].filter(shared_1.isNotEmptyString).join(':');
+    }
+}
+exports.NestJSRxJSLockService = NestJSRxJSLockService;
+//# sourceMappingURL=nestjs-rxjs-lock.service.js.map

package/dist/cjs/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock.service.js","sourceRoot":"","sources":["../../../src/nestjs-rxjs-lock-service/nestjs-rxjs-lock.service.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,+BAA0F;AAE1F,kDAA0E;AAK1E,MAAsB,qBAAqB;IAIvC;IACI,8CAA8C;IACrC,KAAmB,EACnB,OAAoC;QADpC,UAAK,GAAL,KAAK,CAAc;QACnB,YAAO,GAAP,OAAO,CAA6B;QAE7C,MAAM,EAAE,eAAe,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,CAAC;QACvD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;QAE1C,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,GAAG,IAAI,iBAAO,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAI,IAAY,EAAE,MAAS,EAAE,QAA6B,EAAE,UAAU,GAAG,IAAI,CAAC,UAAU;QACzF,MAAM,QAAQ,GAAG,qBAAqB,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAElE,+CAA+C;QAC/C,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CACvD,IAAA,gBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,IAAA,eAAQ,EAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EACtE,IAAA,iBAAU,EAAC,CAAC,CAAU,EAAE,EAAE,CAAC,IAAA,iBAAU,EAAC,GAAG,EAAE,CAAC,aAAa,QAAQ,aAAa,IAAA,wBAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACvG,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,YAAY,CAAI,IAAY,EAAE,MAAS;QAClD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,yBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;CACJ;AAzCD,sDAyCC"}

package/dist/cjs/nestjs-rxjs-lock.module.d.ts

@@ -0,0 +1,7 @@
+import { type DynamicModule, type Type } from '@nestjs/common';
+import { type NestJSRxJSLockModuleOptions } from './nestjs-rxjs-lock-module.options';
+import { NestJSRxJSLockService } from './nestjs-rxjs-lock-service/nestjs-rxjs-lock.service';
+export declare class NestJSRxJSLockModule {
+    static registerTypedAsync<E = string>(options?: Partial<NestJSRxJSLockModuleOptions>): [DynamicModule, Type<NestJSRxJSLockService<E>>];
+}
+//# sourceMappingURL=nestjs-rxjs-lock.module.d.ts.map

package/dist/cjs/nestjs-rxjs-lock.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock.module.d.ts","sourceRoot":"","sources":["../../src/nestjs-rxjs-lock.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,aAAa,EAAsB,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAGnF,OAAO,EAAE,KAAK,2BAA2B,EAAsC,MAAM,mCAAmC,CAAC;AACzH,OAAO,EAAE,qBAAqB,EAAE,MAAM,qDAAqD,CAAC;AAE5F,qBACa,oBAAoB;IAC7B,MAAM,CAAC,kBAAkB,CAAC,CAAC,GAAG,MAAM,EAChC,OAAO,GAAE,OAAO,CAAC,2BAA2B,CAAM,GACnD,CAAC,aAAa,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;CAiBrD"}

package/dist/cjs/nestjs-rxjs-lock.module.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var NestJSRxJSLockModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestJSRxJSLockModule = void 0;
+// eslint-disable-next-line max-classes-per-file
+const common_1 = require("@nestjs/common");
+const nestjs_redis_1 = require("nestjs-redis");
+const nestjs_rxjs_lock_module_options_1 = require("./nestjs-rxjs-lock-module.options");
+const nestjs_rxjs_lock_service_1 = require("./nestjs-rxjs-lock-service/nestjs-rxjs-lock.service");
+let NestJSRxJSLockModule = NestJSRxJSLockModule_1 = class NestJSRxJSLockModule {
+    static registerTypedAsync(options = {}) {
+        let LockService = class LockService extends nestjs_rxjs_lock_service_1.NestJSRxJSLockService {
+            constructor(redis) {
+                super(redis, { ...nestjs_rxjs_lock_module_options_1.defaultNestJSRxJSLockModuleOptions, ...options });
+            }
+        };
+        LockService = __decorate([
+            (0, common_1.Injectable)(),
+            __metadata("design:paramtypes", [nestjs_redis_1.RedisService])
+        ], LockService);
+        const LockModule = {
+            imports: [nestjs_redis_1.RedisModule],
+            module: NestJSRxJSLockModule_1,
+            providers: [LockService],
+            exports: [LockService],
+        };
+        return [LockModule, LockService];
+    }
+};
+NestJSRxJSLockModule = NestJSRxJSLockModule_1 = __decorate([
+    (0, common_1.Module)({})
+], NestJSRxJSLockModule);
+exports.NestJSRxJSLockModule = NestJSRxJSLockModule;
+//# sourceMappingURL=nestjs-rxjs-lock.module.js.map

package/dist/cjs/nestjs-rxjs-lock.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs-rxjs-lock.module.js","sourceRoot":"","sources":["../../src/nestjs-rxjs-lock.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,gDAAgD;AAChD,2CAAmF;AACnF,+CAAyD;AAEzD,uFAAyH;AACzH,kGAA4F;AAGrF,IAAM,oBAAoB,4BAA1B,MAAM,oBAAoB;IACtB,AAAP,MAAM,CAAC,kBAAkB,CACrB,UAAgD,EAAE;QAElD,IACM,WAAW,GADjB,MACM,WAAY,SAAQ,gDAAwB;YAC9C,YAAY,KAAmB;gBAC3B,KAAK,CAAC,KAAK,EAAE,EAAE,GAAG,oEAAkC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YACxE,CAAC;SACJ,CAAA;QAJK,WAAW;YADhB,IAAA,mBAAU,GAAE;6CAEU,2BAAY;WAD7B,WAAW,CAIhB;QAED,MAAM,UAAU,GAAG;YACf,OAAO,EAAE,CAAC,0BAAW,CAAC;YACtB,MAAM,EAAE,sBAAoB;YAC5B,SAAS,EAAE,CAAC,WAAW,CAAC;YACxB,OAAO,EAAE,CAAC,WAAW,CAAC;SACzB,CAAC;QAEF,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACrC,CAAC;CACJ,CAAA;AApBY,oBAAoB;IADhC,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,oBAAoB,CAoBhC;AApBY,oDAAoB"}