@mondart/nestjs-common-module-caching 3.1.6 → 3.2.1

package/README.md

@@ -0,0 +1,143 @@
+# @mondart/nestjs-common-module-caching
+
+Redis-backed caching for NestJS: a `CachingService` for direct key/value
+access, an HTTP response-caching interceptor, and a `DistributedLockService`
+for coordinating work across multiple instances of the same service (e.g. so
+only one replica runs a given cron tick).
+
+## Registration
+
+```ts
+import { CachingModule } from '@mondart/nestjs-common-module-caching';
+
+@Module({
+  imports: [
+    CachingModule.register({
+      host: 'localhost',
+      port: 6379,
+      password: 'secret',
+      database: 0,
+      namespace: 'my-service',
+      ttl: 60_000, // default TTL in ms
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Or asynchronously:
+
+```ts
+CachingModule.registerAsync({
+  imports: [ConfigModule],
+  inject: [ConfigService],
+  useFactory: (config: ConfigService) => ({
+    host: config.get('REDIS_HOST'),
+    port: config.get('REDIS_PORT'),
+    password: config.get('REDIS_PASSWORD'),
+  }),
+});
+```
+
+`CachingModule` is `@Global()`, so `CachingService` and
+`DistributedLockService` are available for injection anywhere without
+re-importing the module.
+
+## CachingService
+
+```ts
+constructor(private readonly cachingService: CachingService) {}
+
+await this.cachingService.set('user:42', user, 60); // ttlSeconds
+const user = await this.cachingService.get<User>('user:42');
+await this.cachingService.setMany([{ key: 'a', value: 1, ttlSeconds: 30 }]);
+const [a, b] = await this.cachingService.getMany<number>(['a', 'b']);
+await this.cachingService.has('user:42');
+await this.cachingService.ttl('user:42');
+await this.cachingService.del('user:42');
+await this.cachingService.delMany(['a', 'b']);
+await this.cachingService.clear();
+```
+
+## Caching HTTP responses
+
+`CachingModule` registers `CachingInterceptor` globally, but it only caches a
+`GET` route when the handler (or controller) is explicitly opted in — nothing
+is cached by default.
+
+```ts
+import {
+  UseCachingInterceptorDecorator,
+  SkipCachingInterceptorDecorator,
+} from '@mondart/nestjs-common-module-caching';
+
+@UseCachingInterceptorDecorator({ ttl: 30_000 })
+@Get()
+findAll() { ... }
+
+@SkipCachingInterceptorDecorator()
+@Get('live')
+findLive() { ... } // never cached, even if the controller opts in
+```
+
+`key`/`ttl` accept the same static value or factory function types as
+`@nestjs/cache-manager`'s own `CacheKey`/`CacheTTL`. When no `key` is given,
+requests are cached per `ControllerName_methodName:<url+query hash>`.
+
+## Distributed locking
+
+Use this to stop the same piece of work (typically a `@Cron()` handler)
+running concurrently across multiple instances of a service.
+
+### Programmatic: `DistributedLockService.runExclusive`
+
+```ts
+constructor(private readonly lockService: DistributedLockService) {}
+
+@Cron('*/5 * * * *')
+async syncJob() {
+  await this.lockService.runExclusive(
+    'sync-job',
+    async ({ signal }) => {
+      for (const item of items) {
+        if (signal.aborted) break; // lock could no longer be renewed
+        await process(item);
+      }
+    },
+    { ttlMs: 30_000, autoExtend: true }, // autoExtend defaults to true
+  );
+}
+```
+
+- Returns `undefined` without invoking the callback when another instance
+  already holds the lock — the expected outcome on replicas that lose the
+  race for a given tick.
+- With `autoExtend` (default `true`), the lock is renewed on an interval
+  (`ttlMs / 3` by default, or `extensionIntervalMs`) for as long as the
+  callback runs. If renewal ever falls behind the lock's real TTL, the
+  callback's `signal` is aborted so long-running work can check
+  `signal.aborted` and stop early instead of continuing to run without
+  exclusivity.
+- `acquire`, `release`, and `extend` are also available individually for
+  manual lock management.
+
+### Declarative: `@DistributedLockDecorator`
+
+```ts
+import { DistributedLockDecorator } from '@mondart/nestjs-common-module-caching';
+
+@Cron('*/5 * * * *')
+@DistributedLockDecorator({ key: 'sync-job', ttlMs: 30_000 })
+async syncJob() { ... }
+```
+
+`key` can also be a function of the method's arguments, e.g.
+`key: (tenantId: string) => \`sync-job:${tenantId}\`` to scope the lock per
+call. This works on methods that Nest itself never routes through an
+interceptor (like `@Cron()` handlers) because `DistributedLockExplorer`
+wraps decorated methods directly at application bootstrap, rather than
+relying on the request pipeline.
+
+Both approaches share the same `DistributedLockService` under the hood, so
+lock keys are namespaced the same way (`CachingModuleOptions.namespace`,
+if set) regardless of which style you use.

package/dist/caching.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"caching.module.d.ts","sourceRoot":"","sources":["../src/caching.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA4B,MAAM,gBAAgB,CAAC;AAGzE,OAAO,EAEL,yBAAyB,EAEzB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AAMxC,qBAEa,aAAa;IAKxB,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa;IAoD7D,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa;IAiDvE,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAWzC,OAAO,CAAC,MAAM,CAAC,oBAAoB;CA2CpC"}
+{"version":3,"file":"caching.module.d.ts","sourceRoot":"","sources":["../src/caching.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA4B,MAAM,gBAAgB,CAAC;AAGzE,OAAO,EAEL,yBAAyB,EAEzB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AAQxC,qBAEa,aAAa;IAKxB,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa;IAuD7D,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa;IAoDvE,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAWzC,OAAO,CAAC,MAAM,CAAC,oBAAoB;CA2CpC"}

package/dist/caching.module.js

@@ -48,11 +48,14 @@ const caching_interface_1 = require("./interfaces/caching.interface");
 const redis_1 = __importStar(require("@keyv/redis"));
 const core_1 = require("@nestjs/core");
 const caching_interceptor_1 = require("./interceptors/caching.interceptor");
+const distributed_lock_service_1 = require("./services/distributed-lock.service");
+const distributed_lock_explorer_1 = require("./explorers/distributed-lock.explorer");
 let CachingModule = CachingModule_1 = class CachingModule {
     static register(options) {
         return {
             module: CachingModule_1,
             imports: [
+                core_1.DiscoveryModule,
                 cache_manager_1.CacheModule.register({
                     isGlobal: true,
                     useFactory: async (cachingOptions) => ({
@@ -88,8 +91,10 @@ let CachingModule = CachingModule_1 = class CachingModule {
                     useClass: caching_interceptor_1.CachingInterceptor,
                 },
                 caching_service_1.CachingService,
+                distributed_lock_service_1.DistributedLockService,
+                distributed_lock_explorer_1.DistributedLockExplorer,
             ],
-            exports: [caching_service_1.CachingService, cache_manager_1.CacheModule],
+            exports: [caching_service_1.CachingService, distributed_lock_service_1.DistributedLockService, cache_manager_1.CacheModule],
         };
     }
     static registerAsync(options) {
@@ -97,6 +102,7 @@ let CachingModule = CachingModule_1 = class CachingModule {
         return {
             module: CachingModule_1,
             imports: [
+                core_1.DiscoveryModule,
                 ...(options.imports || []),
                 asyncOptionsProvider,
                 cache_manager_1.CacheModule.registerAsync({
@@ -131,8 +137,10 @@ let CachingModule = CachingModule_1 = class CachingModule {
                     useFactory: (cacheManager) => new caching_service_1.CachingService(cacheManager),
                     inject: [cache_manager_1.CACHE_MANAGER],
                 },
+                distributed_lock_service_1.DistributedLockService,
+                distributed_lock_explorer_1.DistributedLockExplorer,
             ],
-            exports: [caching_service_1.CachingService, cache_manager_1.CacheModule],
+            exports: [caching_service_1.CachingService, distributed_lock_service_1.DistributedLockService, cache_manager_1.CacheModule],
         };
     }
     static createAsyncOptionsProvider(options) {

package/dist/caching.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"caching.module.js","sourceRoot":"","sources":["../src/caching.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAyE;AACzE,gEAA4D;AAC5D,yDAAmE;AACnE,sEAKwC;AAExC,qDAAkE;AAClE,uCAA+C;AAC/C,4EAAwE;AAIjE,IAAM,aAAa,qBAAnB,MAAM,aAAa;IAKxB,MAAM,CAAC,QAAQ,CAAC,OAA6B;QAC3C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE;gBACP,2BAAW,CAAC,QAAQ,CAAC;oBACnB,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CAAC,CAAC;wBAC3D,MAAM,EAAE;4BACN,IAAI,YAAI,CACN;gCACE,KAAK,EAAE,IAAI,eAAS,CAAC;oCACnB,GAAG,EAAE,WAAW,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE;oCAC5D,MAAM,EAAE;wCACN,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,SAAS,EAAE,cAAc,CAAC,SAAS;wCACnC,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,KAAK;qCACjC;oCACD,QAAQ,EAAE,cAAc,CAAC,QAAQ;oCACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,SAAS;oCAC9C,QAAQ,EAAE,cAAc,CAAC,QAAQ;iCACZ,CAAC;6BACzB,EACD;gCACE,SAAS,EAAE,cAAc,CAAC,SAAS;gCACnC,GAAG,EAAE,cAAc,CAAC,GAAG;6BACxB,CACF;yBACF;qBACF,CAAC;iBACH,CAAC;aACH;YACD,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;gBACD,gCAAc;aACf;YACD,OAAO,EAAE,CAAC,gCAAc,EAAE,2BAAW,CAAC;SACvC,CAAC;IACJ,CAAC;IAOD,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,MAAM,oBAAoB,GAAG,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAEtE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE;gBACP,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC1B,oBAAoB;gBACpB,2BAAW,CAAC,aAAa,CAAqB;oBAC5C,OAAO,EAAE,CAAC,oBAAoB,CAAC;oBAC/B,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CAAC,CAAC;wBAC3D,MAAM,EAAE;4BACN,IAAI,YAAI,CACN;gCACE,KAAK,EAAE,IAAI,eAAS,CAAC;oCACnB,GAAG,EAAE,WAAW,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE;oCAC5D,MAAM,EAAE;wCACN,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,SAAS,EAAE,cAAc,CAAC,SAAS;wCACnC,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,KAAK;qCACjC;oCACD,QAAQ,EAAE,cAAc,CAAC,QAAQ;oCACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,SAAS;oCAC9C,QAAQ,EAAE,cAAc,CAAC,QAAQ;iCACZ,CAAC;6BACzB,EACD;gCACE,SAAS,EAAE,cAAc,CAAC,SAAS;gCACnC,GAAG,EAAE,cAAc,CAAC,GAAG;6BACxB,CACF;yBACF;qBACF,CAAC;oBACF,MAAM,EAAE,CAAC,0CAAsB,CAAC;iBACjC,CAAC;aACH;YACD,SAAS,EAAE;gBAET;oBACE,OAAO,EAAE,gCAAc;oBACvB,UAAU,EAAE,CAAC,YAAmB,EAAE,EAAE,CAAC,IAAI,gCAAc,CAAC,YAAY,CAAC;oBACrE,MAAM,EAAE,CAAC,6BAAa,CAAC;iBACxB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,EAAE,2BAAW,CAAC;SACvC,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CACvC,OAAkC;QAElC,MAAM,SAAS,GAAe,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACjE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS;YACT,OAAO,EAAE,CAAC,0CAAsB,CAAC;SAClC,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAkC;QAElC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;aACF,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;QACzD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;gBACL;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CACzD,MAAM,cAAc,CAAC,mBAAmB,EAAE;oBAC5C,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;iBAClD;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;gBACD,GAAG,CAAC,OAAO,CAAC,QAAQ;oBAClB,CAAC,CAAC;wBACE;4BACE,OAAO,EAAE,OAAO,CAAC,QAAQ;4BACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;yBAC3B;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;CACF,CAAA;AAhKY,sCAAa;wBAAb,aAAa;IAFzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CAgKzB"}
+{"version":3,"file":"caching.module.js","sourceRoot":"","sources":["../src/caching.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAyE;AACzE,gEAA4D;AAC5D,yDAAmE;AACnE,sEAKwC;AAExC,qDAAkE;AAClE,uCAAgE;AAChE,4EAAwE;AACxE,kFAA6E;AAC7E,qFAAgF;AAIzE,IAAM,aAAa,qBAAnB,MAAM,aAAa;IAKxB,MAAM,CAAC,QAAQ,CAAC,OAA6B;QAC3C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE;gBACP,sBAAe;gBACf,2BAAW,CAAC,QAAQ,CAAC;oBACnB,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CAAC,CAAC;wBAC3D,MAAM,EAAE;4BACN,IAAI,YAAI,CACN;gCACE,KAAK,EAAE,IAAI,eAAS,CAAC;oCACnB,GAAG,EAAE,WAAW,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE;oCAC5D,MAAM,EAAE;wCACN,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,SAAS,EAAE,cAAc,CAAC,SAAS;wCACnC,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,KAAK;qCACjC;oCACD,QAAQ,EAAE,cAAc,CAAC,QAAQ;oCACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,SAAS;oCAC9C,QAAQ,EAAE,cAAc,CAAC,QAAQ;iCACZ,CAAC;6BACzB,EACD;gCACE,SAAS,EAAE,cAAc,CAAC,SAAS;gCACnC,GAAG,EAAE,cAAc,CAAC,GAAG;6BACxB,CACF;yBACF;qBACF,CAAC;iBACH,CAAC;aACH;YACD,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;gBACD,gCAAc;gBACd,iDAAsB;gBACtB,mDAAuB;aACxB;YACD,OAAO,EAAE,CAAC,gCAAc,EAAE,iDAAsB,EAAE,2BAAW,CAAC;SAC/D,CAAC;IACJ,CAAC;IAOD,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,MAAM,oBAAoB,GAAG,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAEtE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE;gBACP,sBAAe;gBACf,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC1B,oBAAoB;gBACpB,2BAAW,CAAC,aAAa,CAAqB;oBAC5C,OAAO,EAAE,CAAC,oBAAoB,CAAC;oBAC/B,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CAAC,CAAC;wBAC3D,MAAM,EAAE;4BACN,IAAI,YAAI,CACN;gCACE,KAAK,EAAE,IAAI,eAAS,CAAC;oCACnB,GAAG,EAAE,WAAW,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE;oCAC5D,MAAM,EAAE;wCACN,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,IAAI,EAAE,cAAc,CAAC,IAAI;wCACzB,SAAS,EAAE,cAAc,CAAC,SAAS;wCACnC,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,KAAK;qCACjC;oCACD,QAAQ,EAAE,cAAc,CAAC,QAAQ;oCACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,SAAS;oCAC9C,QAAQ,EAAE,cAAc,CAAC,QAAQ;iCACZ,CAAC;6BACzB,EACD;gCACE,SAAS,EAAE,cAAc,CAAC,SAAS;gCACnC,GAAG,EAAE,cAAc,CAAC,GAAG;6BACxB,CACF;yBACF;qBACF,CAAC;oBACF,MAAM,EAAE,CAAC,0CAAsB,CAAC;iBACjC,CAAC;aACH;YACD,SAAS,EAAE;gBAET;oBACE,OAAO,EAAE,gCAAc;oBACvB,UAAU,EAAE,CAAC,YAAmB,EAAE,EAAE,CAAC,IAAI,gCAAc,CAAC,YAAY,CAAC;oBACrE,MAAM,EAAE,CAAC,6BAAa,CAAC;iBACxB;gBACD,iDAAsB;gBACtB,mDAAuB;aACxB;YACD,OAAO,EAAE,CAAC,gCAAc,EAAE,iDAAsB,EAAE,2BAAW,CAAC;SAC/D,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CACvC,OAAkC;QAElC,MAAM,SAAS,GAAe,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACjE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS;YACT,OAAO,EAAE,CAAC,0CAAsB,CAAC;SAClC,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAkC;QAElC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;aACF,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;QACzD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;gBACL;oBACE,OAAO,EAAE,0CAAsB;oBAC/B,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CACzD,MAAM,cAAc,CAAC,mBAAmB,EAAE;oBAC5C,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;iBAClD;gBACD;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,wCAAkB;iBAC7B;gBACD,GAAG,CAAC,OAAO,CAAC,QAAQ;oBAClB,CAAC,CAAC;wBACE;4BACE,OAAO,EAAE,OAAO,CAAC,QAAQ;4BACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;yBAC3B;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;CACF,CAAA;AAtKY,sCAAa;wBAAb,aAAa;IAFzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CAsKzB"}

package/dist/constants/caching.const.d.ts

@@ -1,3 +1,4 @@
 export declare const SKIP_CACHING_INTERCEPTOR_KEY = "skipCachingInterceptor";
 export declare const USE_CACHING_INTERCEPTOR_KEY = "useCachingInterceptor";
+export declare const DISTRIBUTED_LOCK_KEY = "distributedLock";
 //# sourceMappingURL=caching.const.d.ts.map

package/dist/constants/caching.const.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"caching.const.d.ts","sourceRoot":"","sources":["../../src/constants/caching.const.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B,2BAA2B,CAAC;AACrE,eAAO,MAAM,2BAA2B,0BAA0B,CAAC"}
+{"version":3,"file":"caching.const.d.ts","sourceRoot":"","sources":["../../src/constants/caching.const.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B,2BAA2B,CAAC;AACrE,eAAO,MAAM,2BAA2B,0BAA0B,CAAC;AACnE,eAAO,MAAM,oBAAoB,oBAAoB,CAAC"}

package/dist/constants/caching.const.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.USE_CACHING_INTERCEPTOR_KEY = exports.SKIP_CACHING_INTERCEPTOR_KEY = void 0;
+exports.DISTRIBUTED_LOCK_KEY = exports.USE_CACHING_INTERCEPTOR_KEY = exports.SKIP_CACHING_INTERCEPTOR_KEY = void 0;
 exports.SKIP_CACHING_INTERCEPTOR_KEY = 'skipCachingInterceptor';
 exports.USE_CACHING_INTERCEPTOR_KEY = 'useCachingInterceptor';
+exports.DISTRIBUTED_LOCK_KEY = 'distributedLock';
 //# sourceMappingURL=caching.const.js.map

package/dist/constants/caching.const.js.map

@@ -1 +1 @@
-{"version":3,"file":"caching.const.js","sourceRoot":"","sources":["../../src/constants/caching.const.ts"],"names":[],"mappings":";;;AAAa,QAAA,4BAA4B,GAAG,wBAAwB,CAAC;AACxD,QAAA,2BAA2B,GAAG,uBAAuB,CAAC"}
+{"version":3,"file":"caching.const.js","sourceRoot":"","sources":["../../src/constants/caching.const.ts"],"names":[],"mappings":";;;AAAa,QAAA,4BAA4B,GAAG,wBAAwB,CAAC;AACxD,QAAA,2BAA2B,GAAG,uBAAuB,CAAC;AACtD,QAAA,oBAAoB,GAAG,iBAAiB,CAAC"}

package/dist/decorators/distributed-lock.decorator.d.ts

@@ -0,0 +1,3 @@
+import { DistributedLockMethodOptions } from '../interfaces/distributed-lock.interface';
+export declare const DistributedLockDecorator: (options: DistributedLockMethodOptions) => import("@nestjs/common").CustomDecorator<string>;
+//# sourceMappingURL=distributed-lock.decorator.d.ts.map

package/dist/decorators/distributed-lock.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/distributed-lock.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AAkBxF,eAAO,MAAM,wBAAwB,GACnC,SAAS,4BAA4B,qDACQ,CAAC"}

package/dist/decorators/distributed-lock.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistributedLockDecorator = void 0;
+const common_1 = require("@nestjs/common");
+const caching_const_1 = require("../constants/caching.const");
+const DistributedLockDecorator = (options) => (0, common_1.SetMetadata)(caching_const_1.DISTRIBUTED_LOCK_KEY, options);
+exports.DistributedLockDecorator = DistributedLockDecorator;
+//# sourceMappingURL=distributed-lock.decorator.js.map

package/dist/decorators/distributed-lock.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.decorator.js","sourceRoot":"","sources":["../../src/decorators/distributed-lock.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,8DAAkE;AAmB3D,MAAM,wBAAwB,GAAG,CACtC,OAAqC,EACrC,EAAE,CAAC,IAAA,oBAAW,EAAC,oCAAoB,EAAE,OAAO,CAAC,CAAC;AAFnC,QAAA,wBAAwB,4BAEW"}

package/dist/errors/distributed-lock-lost.error.d.ts

@@ -0,0 +1,5 @@
+export declare class DistributedLockLostError extends Error {
+    readonly key: string;
+    constructor(key: string);
+}
+//# sourceMappingURL=distributed-lock-lost.error.d.ts.map

package/dist/errors/distributed-lock-lost.error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock-lost.error.d.ts","sourceRoot":"","sources":["../../src/errors/distributed-lock-lost.error.ts"],"names":[],"mappings":"AAAA,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,GAAG,EAAE,MAAM;gBAAX,GAAG,EAAE,MAAM;CAMxC"}

package/dist/errors/distributed-lock-lost.error.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistributedLockLostError = void 0;
+class DistributedLockLostError extends Error {
+    constructor(key) {
+        super(`Distributed lock "${key}" was lost before the protected work finished`);
+        this.key = key;
+        this.name = 'DistributedLockLostError';
+    }
+}
+exports.DistributedLockLostError = DistributedLockLostError;
+//# sourceMappingURL=distributed-lock-lost.error.js.map

package/dist/errors/distributed-lock-lost.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock-lost.error.js","sourceRoot":"","sources":["../../src/errors/distributed-lock-lost.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,wBAAyB,SAAQ,KAAK;IACjD,YAA4B,GAAW;QACrC,KAAK,CACH,qBAAqB,GAAG,+CAA+C,CACxE,CAAC;QAHwB,QAAG,GAAH,GAAG,CAAQ;QAIrC,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACzC,CAAC;CACF;AAPD,4DAOC"}

package/dist/explorers/distributed-lock.explorer.d.ts

@@ -0,0 +1,14 @@
+import { OnModuleInit } from '@nestjs/common';
+import { DiscoveryService, MetadataScanner, Reflector } from '@nestjs/core';
+import { DistributedLockService } from '../services/distributed-lock.service';
+export declare class DistributedLockExplorer implements OnModuleInit {
+    private readonly discoveryService;
+    private readonly metadataScanner;
+    private readonly reflector;
+    private readonly distributedLockService;
+    private readonly logger;
+    constructor(discoveryService: DiscoveryService, metadataScanner: MetadataScanner, reflector: Reflector, distributedLockService: DistributedLockService);
+    onModuleInit(): void;
+    private wrapIfDecorated;
+}
+//# sourceMappingURL=distributed-lock.explorer.d.ts.map

package/dist/explorers/distributed-lock.explorer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.explorer.d.ts","sourceRoot":"","sources":["../../src/explorers/distributed-lock.explorer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAI5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAU9E,qBACa,uBAAwB,YAAW,YAAY;IAIxD,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IANzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4C;gBAGhD,gBAAgB,EAAE,gBAAgB,EAClC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,EACpB,sBAAsB,EAAE,sBAAsB;IAGjE,YAAY,IAAI,IAAI;IAyBpB,OAAO,CAAC,eAAe;CAkCxB"}

package/dist/explorers/distributed-lock.explorer.js

@@ -0,0 +1,70 @@
+"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 DistributedLockExplorer_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistributedLockExplorer = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const caching_const_1 = require("../constants/caching.const");
+const distributed_lock_service_1 = require("../services/distributed-lock.service");
+let DistributedLockExplorer = DistributedLockExplorer_1 = class DistributedLockExplorer {
+    constructor(discoveryService, metadataScanner, reflector, distributedLockService) {
+        this.discoveryService = discoveryService;
+        this.metadataScanner = metadataScanner;
+        this.reflector = reflector;
+        this.distributedLockService = distributedLockService;
+        this.logger = new common_1.Logger(DistributedLockExplorer_1.name);
+    }
+    onModuleInit() {
+        const wrappers = [
+            ...this.discoveryService.getProviders(),
+            ...this.discoveryService.getControllers(),
+        ];
+        for (const wrapper of wrappers) {
+            const instance = wrapper.instance;
+            if (!instance || typeof instance !== 'object') {
+                continue;
+            }
+            const prototype = Object.getPrototypeOf(instance);
+            if (!prototype) {
+                continue;
+            }
+            for (const methodName of this.metadataScanner.getAllMethodNames(prototype)) {
+                this.wrapIfDecorated(instance, prototype, methodName);
+            }
+        }
+    }
+    wrapIfDecorated(instance, prototype, methodName) {
+        const originalMethod = instance[methodName];
+        if (typeof originalMethod !== 'function') {
+            return;
+        }
+        const options = this.reflector.get(caching_const_1.DISTRIBUTED_LOCK_KEY, originalMethod);
+        if (!options) {
+            return;
+        }
+        const distributedLockService = this.distributedLockService;
+        instance[methodName] = function (...args) {
+            const key = typeof options.key === 'function' ? options.key(...args) : options.key;
+            return distributedLockService.runExclusive(key, () => originalMethod.apply(this, args), options);
+        };
+        this.logger.debug(`Wrapped ${prototype.constructor.name}.${methodName} with a distributed lock`);
+    }
+};
+exports.DistributedLockExplorer = DistributedLockExplorer;
+exports.DistributedLockExplorer = DistributedLockExplorer = DistributedLockExplorer_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [core_1.DiscoveryService,
+        core_1.MetadataScanner,
+        core_1.Reflector,
+        distributed_lock_service_1.DistributedLockService])
+], DistributedLockExplorer);
+//# sourceMappingURL=distributed-lock.explorer.js.map

package/dist/explorers/distributed-lock.explorer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.explorer.js","sourceRoot":"","sources":["../../src/explorers/distributed-lock.explorer.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAAkE;AAClE,uCAA4E;AAE5E,8DAAkE;AAElE,mFAA8E;AAWvE,IAAM,uBAAuB,+BAA7B,MAAM,uBAAuB;IAGlC,YACmB,gBAAkC,EAClC,eAAgC,EAChC,SAAoB,EACpB,sBAA8C;QAH9C,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,oBAAe,GAAf,eAAe,CAAiB;QAChC,cAAS,GAAT,SAAS,CAAW;QACpB,2BAAsB,GAAtB,sBAAsB,CAAwB;QANhD,WAAM,GAAG,IAAI,eAAM,CAAC,yBAAuB,CAAC,IAAI,CAAC,CAAC;IAOhE,CAAC;IAEJ,YAAY;QACV,MAAM,QAAQ,GAAsB;YAClC,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE;YACvC,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE;SAC1C,CAAC;QAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC9C,SAAS;YACX,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS;YACX,CAAC;YAED,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAC7D,SAAS,CACV,EAAE,CAAC;gBACF,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;IACH,CAAC;IAEO,eAAe,CACrB,QAA6B,EAC7B,SAAiB,EACjB,UAAkB;QAElB,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE,CAAC;YACzC,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAChC,oCAAoB,EACpB,cAAc,CACf,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QAED,MAAM,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC3D,QAAQ,CAAC,UAAU,CAAC,GAAG,UAAyB,GAAG,IAAe;YAChE,MAAM,GAAG,GACP,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YAEzE,OAAO,sBAAsB,CAAC,YAAY,CACxC,GAAG,EACH,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EACtC,OAAO,CACR,CAAC;QACJ,CAAC,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,WAAY,SAAS,CAAC,WAAgC,CAAC,IAAI,IAAI,UAAU,0BAA0B,CACpG,CAAC;IACJ,CAAC;CACF,CAAA;AArEY,0DAAuB;kCAAvB,uBAAuB;IADnC,IAAA,mBAAU,GAAE;qCAK0B,uBAAgB;QACjB,sBAAe;QACrB,gBAAS;QACI,iDAAsB;GAPtD,uBAAuB,CAqEnC"}

package/dist/index.d.ts

@@ -1,10 +1,15 @@
 export * from './caching.module';
 export * from './services/caching.service';
+export * from './services/distributed-lock.service';
 export * from './interfaces/caching.interface';
+export * from './interfaces/distributed-lock.interface';
 export * from './interfaces/use-caching-interceptor-decorator-params.interface';
 export * from './constants/caching.const';
 export * from './decorators/use-caching-interceptor.decorator';
 export * from './decorators/skip-caching-interceptor.decorator';
+export * from './decorators/distributed-lock.decorator';
+export * from './explorers/distributed-lock.explorer';
+export * from './errors/distributed-lock-lost.error';
 export * from './interceptors/caching.interceptor';
 export * from './factories/caching-query-key.facroty';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iEAAiE,CAAC;AAChF,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,iEAAiE,CAAC;AAChF,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC"}

package/dist/index.js

@@ -16,11 +16,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./caching.module"), exports);
 __exportStar(require("./services/caching.service"), exports);
+__exportStar(require("./services/distributed-lock.service"), exports);
 __exportStar(require("./interfaces/caching.interface"), exports);
+__exportStar(require("./interfaces/distributed-lock.interface"), exports);
 __exportStar(require("./interfaces/use-caching-interceptor-decorator-params.interface"), exports);
 __exportStar(require("./constants/caching.const"), exports);
 __exportStar(require("./decorators/use-caching-interceptor.decorator"), exports);
 __exportStar(require("./decorators/skip-caching-interceptor.decorator"), exports);
+__exportStar(require("./decorators/distributed-lock.decorator"), exports);
+__exportStar(require("./explorers/distributed-lock.explorer"), exports);
+__exportStar(require("./errors/distributed-lock-lost.error"), exports);
 __exportStar(require("./interceptors/caching.interceptor"), exports);
 __exportStar(require("./factories/caching-query-key.facroty"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,6DAA2C;AAC3C,iEAA+C;AAC/C,kGAAgF;AAChF,4DAA0C;AAC1C,iFAA+D;AAC/D,kFAAgE;AAChE,qEAAmD;AACnD,wEAAsD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,6DAA2C;AAC3C,sEAAoD;AACpD,iEAA+C;AAC/C,0EAAwD;AACxD,kGAAgF;AAChF,4DAA0C;AAC1C,iFAA+D;AAC/D,kFAAgE;AAChE,0EAAwD;AACxD,wEAAsD;AACtD,uEAAqD;AACrD,qEAAmD;AACnD,wEAAsD"}

package/dist/interfaces/distributed-lock.interface.d.ts

@@ -0,0 +1,18 @@
+export interface DistributedLockOptions {
+    ttlMs: number;
+    autoExtend?: boolean;
+    extensionIntervalMs?: number;
+}
+export interface DistributedLock {
+    key: string;
+    token: string;
+    ttlMs: number;
+}
+export interface DistributedLockCallbackContext {
+    signal: AbortSignal;
+}
+export type DistributedLockCallback<T> = (context: DistributedLockCallbackContext) => Promise<T>;
+export interface DistributedLockMethodOptions extends DistributedLockOptions {
+    key: string | ((...args: any[]) => string);
+}
+//# sourceMappingURL=distributed-lock.interface.d.ts.map

package/dist/interfaces/distributed-lock.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/distributed-lock.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IAMd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAM7C,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CACvC,OAAO,EAAE,8BAA8B,KACpC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEhB,MAAM,WAAW,4BAA6B,SAAQ,sBAAsB;IAK1E,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,CAAC;CAC5C"}

package/dist/interfaces/distributed-lock.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=distributed-lock.interface.js.map

package/dist/interfaces/distributed-lock.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.interface.js","sourceRoot":"","sources":["../../src/interfaces/distributed-lock.interface.ts"],"names":[],"mappings":""}

package/dist/services/caching.service.d.ts

@@ -1,10 +1,11 @@
 import { Cache } from 'cache-manager';
-import { Keyv } from '@keyv/redis';
+import { Keyv, RedisClientConnectionType } from '@keyv/redis';
 export declare class CachingService {
     private cacheManager;
     private readonly logger;
     constructor(cacheManager: Cache);
     getStore(): Keyv<any>;
+    getRedisClient(): Promise<RedisClientConnectionType>;
     get<T>(key: string): Promise<T | undefined>;
     getMany<T>(keys?: string[]): Promise<T[] | undefined>;
     set<T>(key: string, value: T, ttlSeconds?: number): Promise<string>;

package/dist/services/caching.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"caching.service.d.ts","sourceRoot":"","sources":["../../src/services/caching.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,qBACa,cAAc;IAIU,OAAO,CAAC,YAAY;IAHvD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAEpB;gBACwC,YAAY,EAAE,KAAK;IAkB9D,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC;IAQf,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAc3C,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;IAerD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAanE,OAAO,CAAC,CAAC,EACb,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,CAAC,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACrD,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAapD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzC,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAQzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAGpD"}
+{"version":3,"file":"caching.service.d.ts","sourceRoot":"","sources":["../../src/services/caching.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAkB,EAAE,IAAI,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAEzE,qBACa,cAAc;IAIU,OAAO,CAAC,YAAY;IAHvD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAEpB;gBACwC,YAAY,EAAE,KAAK;IAkB9D,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC;IAOf,cAAc,IAAI,OAAO,CAAC,yBAAyB,CAAC;IASpD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAc3C,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;IAerD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAanE,OAAO,CAAC,CAAC,EACb,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,CAAC,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACrD,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAapD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzC,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAQzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAGpD"}

package/dist/services/caching.service.js

@@ -36,6 +36,10 @@ let CachingService = CachingService_1 = class CachingService {
     getStore() {
         return this.cacheManager.stores?.[0];
     }
+    async getRedisClient() {
+        const redisStore = this.getStore().opts.store;
+        return redisStore.getClient();
+    }
     async get(key) {
         const result = await this.cacheManager.get(key);
         if (result) {

package/dist/services/caching.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"caching.service.js","sourceRoot":"","sources":["../../src/services/caching.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4D;AAC5D,yDAAsD;AAEtD,uCAAmC;AAG5B,IAAM,cAAc,sBAApB,MAAM,cAAc;IAIzB,YAAmC,YAA2B;QAAnB,iBAAY,GAAZ,YAAY,CAAO;QAH7C,WAAM,GAAG,IAAI,eAAM,CAAC,gBAAc,CAAC,IAAI,EAAE;YACxD,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,YAAY,YAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAMD,QAAQ;QACN,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAMD,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAS,GAAG,CAAC,CAAC;QACxD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC;QACjC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAQD,KAAK,CAAC,OAAO,CAAI,IAAe;QAC9B,MAAM,OAAO,GACX,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAS,IAAI,CAAC,CAAC;QAC7C,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAQD,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAQ,EAAE,UAAmB;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAChC,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC;IACJ,CAAC;IAOD,KAAK,CAAC,OAAO,CACX,IAAsD;QAEtD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACtC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YACjC,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC,CAAC,CAAC;QACJ,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAMD,KAAK,CAAC,OAAO,CAAC,IAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAKD,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IACzC,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,SAAS,CAAC;IAC1D,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AAzHY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAKE,WAAA,IAAA,eAAM,EAAC,6BAAa,CAAC,CAAA;;GAJvB,cAAc,CAyH1B"}
+{"version":3,"file":"caching.service.js","sourceRoot":"","sources":["../../src/services/caching.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4D;AAC5D,yDAAsD;AAEtD,uCAAyE;AAGlE,IAAM,cAAc,sBAApB,MAAM,cAAc;IAIzB,YAAmC,YAA2B;QAAnB,iBAAY,GAAZ,YAAY,CAAO;QAH7C,WAAM,GAAG,IAAI,eAAM,CAAC,gBAAc,CAAC,IAAI,EAAE;YACxD,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,YAAY,YAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAMD,QAAQ;QACN,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAKD,KAAK,CAAC,cAAc;QAClB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,KAAuB,CAAC;QAChE,OAAO,UAAU,CAAC,SAAS,EAAE,CAAC;IAChC,CAAC;IAMD,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAS,GAAG,CAAC,CAAC;QACxD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC;QACjC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAQD,KAAK,CAAC,OAAO,CAAI,IAAe;QAC9B,MAAM,OAAO,GACX,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAS,IAAI,CAAC,CAAC;QAC7C,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAQD,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAQ,EAAE,UAAmB;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAChC,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC;IACJ,CAAC;IAOD,KAAK,CAAC,OAAO,CACX,IAAsD;QAEtD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACtC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YACjC,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC,CAAC,CAAC;QACJ,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAMD,KAAK,CAAC,OAAO,CAAC,IAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAKD,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IACzC,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,SAAS,CAAC;IAC1D,CAAC;IAMD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AAjIY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAKE,WAAA,IAAA,eAAM,EAAC,6BAAa,CAAC,CAAA;;GAJvB,cAAc,CAiI1B"}

package/dist/services/distributed-lock.service.d.ts

@@ -0,0 +1,17 @@
+import { CachingModuleOptions } from '../interfaces/caching.interface';
+import { DistributedLock, DistributedLockCallback, DistributedLockOptions } from '../interfaces/distributed-lock.interface';
+import { CachingService } from './caching.service';
+export declare class DistributedLockService {
+    private readonly cachingService;
+    private readonly cachingOptions;
+    private readonly logger;
+    constructor(cachingService: CachingService, cachingOptions: CachingModuleOptions);
+    acquire(key: string, ttlMs: number): Promise<DistributedLock | null>;
+    release(lock: DistributedLock): Promise<boolean>;
+    extend(lock: DistributedLock, ttlMs?: number): Promise<boolean>;
+    runExclusive<T>(key: string, callback: DistributedLockCallback<T>, options: DistributedLockOptions): Promise<T | undefined>;
+    private startExtension;
+    private getNamespacedKey;
+    private validateTtl;
+}
+//# sourceMappingURL=distributed-lock.service.d.ts.map

package/dist/services/distributed-lock.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.service.d.ts","sourceRoot":"","sources":["../../src/services/distributed-lock.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAgBnD,qBACa,sBAAsB;IAM/B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAE/B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAPjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAEpB;gBAGgB,cAAc,EAAE,cAAc,EAE9B,cAAc,EAAE,oBAAoB;IAUjD,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAwBpE,OAAO,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBhD,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,SAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BnE,YAAY,CAAC,CAAC,EAClB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,uBAAuB,CAAC,CAAC,CAAC,EACpC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA4DzB,OAAO,CAAC,cAAc;IA0CtB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,WAAW;CAKpB"}

package/dist/services/distributed-lock.service.js

@@ -0,0 +1,161 @@
+"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 __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var DistributedLockService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistributedLockService = void 0;
+const common_1 = require("@nestjs/common");
+const crypto_1 = require("crypto");
+const caching_interface_1 = require("../interfaces/caching.interface");
+const distributed_lock_lost_error_1 = require("../errors/distributed-lock-lost.error");
+const caching_service_1 = require("./caching.service");
+const RELEASE_SCRIPT = `
+if redis.call('get', KEYS[1]) == ARGV[1] then
+  return redis.call('del', KEYS[1])
+end
+return 0
+`;
+const EXTEND_SCRIPT = `
+if redis.call('get', KEYS[1]) == ARGV[1] then
+  return redis.call('pexpire', KEYS[1], ARGV[2])
+end
+return 0
+`;
+let DistributedLockService = DistributedLockService_1 = class DistributedLockService {
+    constructor(cachingService, cachingOptions) {
+        this.cachingService = cachingService;
+        this.cachingOptions = cachingOptions;
+        this.logger = new common_1.Logger(DistributedLockService_1.name, {
+            timestamp: true,
+        });
+    }
+    async acquire(key, ttlMs) {
+        this.validateTtl(ttlMs);
+        if (!key.trim()) {
+            throw new Error('Distributed lock key must not be empty');
+        }
+        const namespacedKey = this.getNamespacedKey(key);
+        const token = (0, crypto_1.randomUUID)();
+        const redis = await this.cachingService.getRedisClient();
+        const result = await redis.set(namespacedKey, token, {
+            PX: ttlMs,
+            NX: true,
+        });
+        return result === 'OK' ? { key: namespacedKey, token, ttlMs } : null;
+    }
+    async release(lock) {
+        const redis = await this.cachingService.getRedisClient();
+        const result = await redis.eval(RELEASE_SCRIPT, {
+            keys: [lock.key],
+            arguments: [lock.token],
+        });
+        return Number(result) === 1;
+    }
+    async extend(lock, ttlMs = lock.ttlMs) {
+        this.validateTtl(ttlMs);
+        const redis = await this.cachingService.getRedisClient();
+        const result = await redis.eval(EXTEND_SCRIPT, {
+            keys: [lock.key],
+            arguments: [lock.token, String(ttlMs)],
+        });
+        if (Number(result) === 1) {
+            lock.ttlMs = ttlMs;
+            return true;
+        }
+        return false;
+    }
+    async runExclusive(key, callback, options) {
+        const lock = await this.acquire(key, options.ttlMs);
+        if (!lock) {
+            this.logger.debug(`Skipped "${key}": lock is already held by another instance`);
+            return undefined;
+        }
+        const autoExtend = options.autoExtend ?? true;
+        const abortController = new AbortController();
+        let extensionInterval;
+        let workError;
+        let releaseError;
+        let result;
+        try {
+            extensionInterval = autoExtend
+                ? this.startExtension(lock, abortController, options.extensionIntervalMs)
+                : undefined;
+            result = await callback({ signal: abortController.signal });
+        }
+        catch (error) {
+            workError = error;
+        }
+        finally {
+            if (extensionInterval) {
+                clearInterval(extensionInterval);
+            }
+            try {
+                await this.release(lock);
+            }
+            catch (error) {
+                releaseError = error;
+            }
+        }
+        if (releaseError) {
+            this.logger.error(`Failed to release distributed lock "${lock.key}": ${releaseError.message}`);
+        }
+        if (workError) {
+            throw workError;
+        }
+        if (releaseError) {
+            throw releaseError;
+        }
+        return result;
+    }
+    startExtension(lock, abortController, configuredInterval) {
+        const intervalMs = configuredInterval ?? Math.max(100, Math.floor(lock.ttlMs / 3));
+        if (intervalMs <= 0 || intervalMs >= lock.ttlMs) {
+            throw new Error('Lock extension interval must be positive and shorter than its TTL');
+        }
+        let deadline = Date.now() + lock.ttlMs;
+        return setInterval(() => {
+            void this.extend(lock)
+                .then((extended) => {
+                if (extended) {
+                    deadline = Date.now() + lock.ttlMs;
+                    return;
+                }
+                this.logger.warn(`Distributed lock "${lock.key}" is no longer owned by this instance`);
+                abortController.abort(new distributed_lock_lost_error_1.DistributedLockLostError(lock.key));
+            })
+                .catch((error) => {
+                this.logger.warn(`Failed to extend distributed lock "${lock.key}": ${error.message}`);
+                if (Date.now() >= deadline) {
+                    this.logger.error(`Distributed lock "${lock.key}" expired while work was still running`);
+                    abortController.abort(new distributed_lock_lost_error_1.DistributedLockLostError(lock.key));
+                }
+            });
+        }, intervalMs).unref();
+    }
+    getNamespacedKey(key) {
+        const namespace = this.cachingOptions.namespace?.replace(/:+$/, '');
+        return namespace ? `${namespace}:${key}` : key;
+    }
+    validateTtl(ttlMs) {
+        if (!Number.isInteger(ttlMs) || ttlMs <= 0) {
+            throw new Error('Distributed lock TTL must be a positive integer');
+        }
+    }
+};
+exports.DistributedLockService = DistributedLockService;
+exports.DistributedLockService = DistributedLockService = DistributedLockService_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(1, (0, common_1.Inject)(caching_interface_1.CACHING_MODULE_OPTIONS)),
+    __metadata("design:paramtypes", [caching_service_1.CachingService, Object])
+], DistributedLockService);
+//# sourceMappingURL=distributed-lock.service.js.map

package/dist/services/distributed-lock.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributed-lock.service.js","sourceRoot":"","sources":["../../src/services/distributed-lock.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4D;AAC5D,mCAAoC;AACpC,uEAGyC;AAMzC,uFAAiF;AACjF,uDAAmD;AAEnD,MAAM,cAAc,GAAG;;;;;CAKtB,CAAC;AAEF,MAAM,aAAa,GAAG;;;;;CAKrB,CAAC;AAGK,IAAM,sBAAsB,8BAA5B,MAAM,sBAAsB;IAKjC,YACmB,cAA8B,EAE/C,cAAqD;QAFpC,mBAAc,GAAd,cAAc,CAAgB;QAE9B,mBAAc,GAAd,cAAc,CAAsB;QAPtC,WAAM,GAAG,IAAI,eAAM,CAAC,wBAAsB,CAAC,IAAI,EAAE;YAChE,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;IAMA,CAAC;IASJ,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa;QACtC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,IAAA,mBAAU,GAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,EAAE;YACnD,EAAE,EAAE,KAAK;YACT,EAAE,EAAE,IAAI;SACT,CAAC,CAAC;QAEH,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACvE,CAAC;IASD,KAAK,CAAC,OAAO,CAAC,IAAqB;QACjC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE;YAC9C,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;YAChB,SAAS,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;SACxB,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IASD,KAAK,CAAC,MAAM,CAAC,IAAqB,EAAE,KAAK,GAAG,IAAI,CAAC,KAAK;QACpD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE;YAC7C,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;YAChB,SAAS,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;SACvC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAeD,KAAK,CAAC,YAAY,CAChB,GAAW,EACX,QAAoC,EACpC,OAA+B;QAE/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,YAAY,GAAG,6CAA6C,CAC7D,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,IAAI,iBAA6C,CAAC;QAClD,IAAI,SAAkB,CAAC;QACvB,IAAI,YAAqB,CAAC;QAC1B,IAAI,MAAqB,CAAC;QAE1B,IAAI,CAAC;YACH,iBAAiB,GAAG,UAAU;gBAC5B,CAAC,CAAC,IAAI,CAAC,cAAc,CACjB,IAAI,EACJ,eAAe,EACf,OAAO,CAAC,mBAAmB,CAC5B;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,GAAG,MAAM,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;gBAAS,CAAC;YACT,IAAI,iBAAiB,EAAE,CAAC;gBACtB,aAAa,CAAC,iBAAiB,CAAC,CAAC;YACnC,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,YAAY,GAAG,KAAK,CAAC;YACvB,CAAC;QACH,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,uCAAuC,IAAI,CAAC,GAAG,MAAO,YAAsB,CAAC,OAAO,EAAE,CACvF,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,SAAS,CAAC;QAClB,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,YAAY,CAAC;QACrB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAQO,cAAc,CACpB,IAAqB,EACrB,eAAgC,EAChC,kBAA2B;QAE3B,MAAM,UAAU,GACd,kBAAkB,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAClE,IAAI,UAAU,IAAI,CAAC,IAAI,UAAU,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEvC,OAAO,WAAW,CAAC,GAAG,EAAE;YACtB,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;iBACnB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;oBACnC,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,qBAAqB,IAAI,CAAC,GAAG,uCAAuC,CACrE,CAAC;gBACF,eAAe,CAAC,KAAK,CAAC,IAAI,sDAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAChE,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;gBACtB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sCAAsC,IAAI,CAAC,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;gBACF,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;oBAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qBAAqB,IAAI,CAAC,GAAG,wCAAwC,CACtE,CAAC;oBACF,eAAe,CAAC,KAAK,CAAC,IAAI,sDAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAEO,gBAAgB,CAAC,GAAW;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpE,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACjD,CAAC;IAEO,WAAW,CAAC,KAAa;QAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;CACF,CAAA;AA7MY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,eAAM,EAAC,0CAAsB,CAAC,CAAA;qCADE,gCAAc;GANtC,sBAAsB,CA6MlC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondart/nestjs-common-module-caching",
-  "version": "3.1.6",
+  "version": "3.2.1",
   "description": "Caching module for NestJS.",
   "author": {
     "name": "Mondart"
@@ -17,7 +17,7 @@
     "build": "tsc -p tsconfig.json"
   },
   "dependencies": {
-    "@mondart/nestjs-common-module-core": "^3.2.4",
+    "@mondart/nestjs-common-module-core": "^3.2.6",
     "@keyv/redis": "4.2.0",
     "@nestjs/cache-manager": "^3.0.0",
     "cache-manager": "6.4.0",