@dudousxd/nestjs-durable 0.20.0 → 0.22.0

package/dist/index.cjs

@@ -342,8 +342,8 @@ DurableWorkerModule = _ts_decorate([
 ], DurableWorkerModule);
 
 // src/durable.module.ts
-var import_nestjs_durable_core7 = require("@dudousxd/nestjs-durable-core");
-var import_common7 = require("@nestjs/common");
+var import_nestjs_durable_core8 = require("@dudousxd/nestjs-durable-core");
+var import_common8 = require("@nestjs/common");
 var import_core4 = require("@nestjs/core");
 
 // src/durable-step.registrar.ts
@@ -484,7 +484,7 @@ EntityService = _ts_decorate3([
   ])
 ], EntityService);
 
-// src/timer-poller.ts
+// src/retention-poller.ts
 var import_nestjs_durable_core4 = require("@dudousxd/nestjs-durable-core");
 var import_common4 = require("@nestjs/common");
 function _ts_decorate4(decorators, target, key, desc) {
@@ -504,6 +504,113 @@ function _ts_param3(paramIndex, decorator) {
   };
 }
 __name(_ts_param3, "_ts_param");
+var DEFAULT_SWEEP_INTERVAL_MS = 6e4;
+var DEFAULT_BATCH_SIZE = 1e3;
+var MAX_BATCHES_PER_POLICY = 100;
+function validateRetention(retention) {
+  const seen = /* @__PURE__ */ new Set();
+  for (const policy of retention.policies) {
+    if (policy.statuses.length === 0) {
+      throw new Error("durable retention: each policy must list at least one status");
+    }
+    if (policy.maxAge == null && policy.maxCount == null) {
+      throw new Error("durable retention: each policy must set maxAge and/or maxCount");
+    }
+    if (policy.maxAge != null) (0, import_nestjs_durable_core4.parseDuration)(policy.maxAge);
+    for (const status of policy.statuses) {
+      if (!import_nestjs_durable_core4.TERMINAL_RUN_STATUSES.includes(status)) {
+        throw new Error(`durable retention: status "${status}" is not terminal; only ${import_nestjs_durable_core4.TERMINAL_RUN_STATUSES.join(", ")} can be pruned`);
+      }
+      if (seen.has(status)) {
+        throw new Error(`durable retention: status "${status}" appears in more than one policy; status sets must be disjoint`);
+      }
+      seen.add(status);
+    }
+  }
+}
+__name(validateRetention, "validateRetention");
+var RetentionPoller = class {
+  static {
+    __name(this, "RetentionPoller");
+  }
+  store;
+  options;
+  timer;
+  sweeping = false;
+  constructor(store, options) {
+    this.store = store;
+    this.options = options;
+  }
+  async onApplicationBootstrap() {
+    if (this.options.worker === false) return;
+    const retention = this.options.retention;
+    if (!retention || retention.policies.length === 0) return;
+    validateRetention(retention);
+    if (typeof this.store.pruneTerminalRuns !== "function") {
+      console.warn("[nestjs-durable] `retention` is configured but the store adapter does not implement pruneTerminalRuns; retention is disabled.");
+      return;
+    }
+    await this.sweep();
+    const intervalMs = retention.sweepInterval != null ? (0, import_nestjs_durable_core4.parseDuration)(retention.sweepInterval) : DEFAULT_SWEEP_INTERVAL_MS;
+    if (intervalMs > 0) {
+      this.timer = setInterval(() => void this.sweep(), intervalMs);
+      this.timer.unref?.();
+    }
+  }
+  onModuleDestroy() {
+    if (this.timer) clearInterval(this.timer);
+  }
+  async sweep() {
+    if (this.sweeping) return;
+    const retention = this.options.retention;
+    const prune = this.store.pruneTerminalRuns;
+    if (!retention || typeof prune !== "function") return;
+    this.sweeping = true;
+    try {
+      const batchSize = retention.batchSize ?? DEFAULT_BATCH_SIZE;
+      const now = Date.now();
+      for (const policy of retention.policies) {
+        for (let batch = 0; batch < MAX_BATCHES_PER_POLICY; batch++) {
+          const deleted = await prune.call(this.store, policy, now, batchSize);
+          if (deleted < batchSize) break;
+        }
+      }
+    } finally {
+      this.sweeping = false;
+    }
+  }
+};
+RetentionPoller = _ts_decorate4([
+  (0, import_common4.Injectable)(),
+  _ts_param3(0, (0, import_common4.Inject)(import_nestjs_durable_core4.STATE_STORE_CANONICAL)),
+  _ts_param3(1, (0, import_common4.Inject)(import_nestjs_durable_core4.DURABLE_OPTIONS_CANONICAL)),
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", [
+    typeof StateStore === "undefined" ? Object : StateStore,
+    typeof DurableModuleOptions === "undefined" ? Object : DurableModuleOptions
+  ])
+], RetentionPoller);
+
+// src/timer-poller.ts
+var import_nestjs_durable_core5 = require("@dudousxd/nestjs-durable-core");
+var import_common5 = require("@nestjs/common");
+function _ts_decorate5(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate5, "_ts_decorate");
+function _ts_metadata5(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata5, "_ts_metadata");
+function _ts_param4(paramIndex, decorator) {
+  return function(target, key) {
+    decorator(target, key, paramIndex);
+  };
+}
+__name(_ts_param4, "_ts_param");
 var TimerPoller = class {
   static {
     __name(this, "TimerPoller");
@@ -541,19 +648,19 @@ var TimerPoller = class {
       await this.engine.sweepTimeouts();
       const schedules = this.options.schedules;
       if (schedules && schedules.length > 0) {
-        await (0, import_nestjs_durable_core4.runSchedules)(this.engine, schedules, Date.now());
+        await (0, import_nestjs_durable_core5.runSchedules)(this.engine, schedules, Date.now());
       }
     } finally {
       this.polling = false;
     }
   }
 };
-TimerPoller = _ts_decorate4([
-  (0, import_common4.Injectable)(),
-  _ts_param3(1, (0, import_common4.Inject)(import_nestjs_durable_core4.DURABLE_OPTIONS_CANONICAL)),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", [
-    typeof import_nestjs_durable_core4.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core4.WorkflowEngine,
+TimerPoller = _ts_decorate5([
+  (0, import_common5.Injectable)(),
+  _ts_param4(1, (0, import_common5.Inject)(import_nestjs_durable_core5.DURABLE_OPTIONS_CANONICAL)),
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", [
+    typeof import_nestjs_durable_core5.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core5.WorkflowEngine,
     typeof DurableModuleOptions === "undefined" ? Object : DurableModuleOptions
   ])
 ], TimerPoller);
@@ -562,8 +669,8 @@ TimerPoller = _ts_decorate4([
 var CONTEXT_ACCESSOR = Symbol.for("@dudousxd/nestjs-context:accessor");
 
 // src/workflow.registrar.ts
-var import_nestjs_durable_core5 = require("@dudousxd/nestjs-durable-core");
-var import_common5 = require("@nestjs/common");
+var import_nestjs_durable_core6 = require("@dudousxd/nestjs-durable-core");
+var import_common6 = require("@nestjs/common");
 var import_core3 = require("@nestjs/core");
 
 // src/input-validation.ts
@@ -606,23 +713,23 @@ function isStepInterceptor(target) {
 __name(isStepInterceptor, "isStepInterceptor");
 
 // src/workflow.registrar.ts
-function _ts_decorate5(decorators, target, key, desc) {
+function _ts_decorate6(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate5, "_ts_decorate");
-function _ts_metadata5(k, v) {
+__name(_ts_decorate6, "_ts_decorate");
+function _ts_metadata6(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-__name(_ts_metadata5, "_ts_metadata");
-function _ts_param4(paramIndex, decorator) {
+__name(_ts_metadata6, "_ts_metadata");
+function _ts_param5(paramIndex, decorator) {
   return function(target, key) {
     decorator(target, key, paramIndex);
   };
 }
-__name(_ts_param4, "_ts_param");
+__name(_ts_param5, "_ts_param");
 var WorkflowRegistrar = class {
   static {
     __name(this, "WorkflowRegistrar");
@@ -675,11 +782,11 @@ var WorkflowRegistrar = class {
       const validateInput = meta.validateInput ?? (meta.inputSchema ? classValidatorInput(meta.inputSchema) : void 0);
       const eventBatch = meta.debounce ? {
         mode: "debounce",
-        windowMs: (0, import_nestjs_durable_core5.parseDuration)(meta.debounce)
+        windowMs: (0, import_nestjs_durable_core6.parseDuration)(meta.debounce)
       } : meta.batch ? {
         mode: "batch",
         maxSize: meta.batch.maxSize,
-        windowMs: (0, import_nestjs_durable_core5.parseDuration)(meta.batch.within)
+        windowMs: (0, import_nestjs_durable_core6.parseDuration)(meta.batch.within)
       } : void 0;
       const workflowCtor = workflow.constructor;
       this.engine.register(meta.name, meta.version, (ctx, input) => workflow.run(ctx, input), {
@@ -699,7 +806,7 @@ var WorkflowRegistrar = class {
         this.engine.register(dlqName, meta.version, inline);
         deadLetterByWorkflow.set(meta.name, dlqName);
       } else if (meta.deadLetterWorkflow) {
-        deadLetterByWorkflow.set(meta.name, (0, import_nestjs_durable_core5.workflowName)(meta.deadLetterWorkflow));
+        deadLetterByWorkflow.set(meta.name, (0, import_nestjs_durable_core6.workflowName)(meta.deadLetterWorkflow));
       }
     });
     this.installDeadLetterRouting(deadLetterByWorkflow);
@@ -721,7 +828,7 @@ var WorkflowRegistrar = class {
   * a `dlq:<runId>` id, so re-recovery never double-dispatches.
   */
   installDeadLetterRouting(byWorkflow) {
-    const fallback = this.options.deadLetterWorkflow ? (0, import_nestjs_durable_core5.workflowName)(this.options.deadLetterWorkflow) : void 0;
+    const fallback = this.options.deadLetterWorkflow ? (0, import_nestjs_durable_core6.workflowName)(this.options.deadLetterWorkflow) : void 0;
     if (byWorkflow.size === 0 && !fallback) return;
     this.engine.onDead((run) => {
       const target = byWorkflow.get(run.workflow) ?? fallback;
@@ -735,15 +842,15 @@ var WorkflowRegistrar = class {
     });
   }
 };
-WorkflowRegistrar = _ts_decorate5([
-  (0, import_common5.Injectable)(),
-  _ts_param4(3, (0, import_common5.Inject)(import_nestjs_durable_core5.STATE_STORE_CANONICAL)),
-  _ts_param4(4, (0, import_common5.Inject)(import_nestjs_durable_core5.DURABLE_OPTIONS_CANONICAL)),
-  _ts_metadata5("design:type", Function),
-  _ts_metadata5("design:paramtypes", [
+WorkflowRegistrar = _ts_decorate6([
+  (0, import_common6.Injectable)(),
+  _ts_param5(3, (0, import_common6.Inject)(import_nestjs_durable_core6.STATE_STORE_CANONICAL)),
+  _ts_param5(4, (0, import_common6.Inject)(import_nestjs_durable_core6.DURABLE_OPTIONS_CANONICAL)),
+  _ts_metadata6("design:type", Function),
+  _ts_metadata6("design:paramtypes", [
     typeof import_core3.DiscoveryService === "undefined" ? Object : import_core3.DiscoveryService,
     typeof import_core3.MetadataScanner === "undefined" ? Object : import_core3.MetadataScanner,
-    typeof import_nestjs_durable_core5.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core5.WorkflowEngine,
+    typeof import_nestjs_durable_core6.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core6.WorkflowEngine,
     typeof StateStore === "undefined" ? Object : StateStore,
     typeof DurableModuleOptions === "undefined" ? Object : DurableModuleOptions
   ])
@@ -751,19 +858,19 @@ WorkflowRegistrar = _ts_decorate5([
 
 // src/workflow.service.ts
 var import_node_crypto = require("crypto");
-var import_nestjs_durable_core6 = require("@dudousxd/nestjs-durable-core");
-var import_common6 = require("@nestjs/common");
-function _ts_decorate6(decorators, target, key, desc) {
+var import_nestjs_durable_core7 = require("@dudousxd/nestjs-durable-core");
+var import_common7 = require("@nestjs/common");
+function _ts_decorate7(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate6, "_ts_decorate");
-function _ts_metadata6(k, v) {
+__name(_ts_decorate7, "_ts_decorate");
+function _ts_metadata7(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-__name(_ts_metadata6, "_ts_metadata");
+__name(_ts_metadata7, "_ts_metadata");
 var WorkflowService = class {
   static {
     __name(this, "WorkflowService");
@@ -803,22 +910,22 @@ var WorkflowService = class {
     return this.engine.publishEvent(name, payload, opts);
   }
 };
-WorkflowService = _ts_decorate6([
-  (0, import_common6.Injectable)(),
-  _ts_metadata6("design:type", Function),
-  _ts_metadata6("design:paramtypes", [
-    typeof import_nestjs_durable_core6.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core6.WorkflowEngine
+WorkflowService = _ts_decorate7([
+  (0, import_common7.Injectable)(),
+  _ts_metadata7("design:type", Function),
+  _ts_metadata7("design:paramtypes", [
+    typeof import_nestjs_durable_core7.WorkflowEngine === "undefined" ? Object : import_nestjs_durable_core7.WorkflowEngine
   ])
 ], WorkflowService);
 
 // src/durable.module.ts
-function _ts_decorate7(decorators, target, key, desc) {
+function _ts_decorate8(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate7, "_ts_decorate");
+__name(_ts_decorate8, "_ts_decorate");
 function resolveAccessor(moduleRef) {
   try {
     return moduleRef.get(CONTEXT_ACCESSOR, {
@@ -864,13 +971,13 @@ var DurableModule = class _DurableModule {
   }
   static forRoot(options) {
     return _DurableModule.build({
-      provide: import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL,
+      provide: import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL,
       useValue: options
     });
   }
   static forRootAsync(options) {
     return _DurableModule.build({
-      provide: import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL,
+      provide: import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL,
       useFactory: options.useFactory,
       inject: options.inject ?? []
     });
@@ -885,41 +992,41 @@ var DurableModule = class _DurableModule {
       providers: [
         optionsProvider,
         {
-          provide: import_nestjs_durable_core7.STATE_STORE_CANONICAL,
+          provide: import_nestjs_durable_core8.STATE_STORE_CANONICAL,
           useFactory: /* @__PURE__ */ __name((options) => options.store, "useFactory"),
           inject: [
-            import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL
+            import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL
           ]
         },
         {
-          provide: import_nestjs_durable_core7.TRANSPORT_CANONICAL,
+          provide: import_nestjs_durable_core8.TRANSPORT_CANONICAL,
           useFactory: /* @__PURE__ */ __name((options) => options.transport ?? null, "useFactory"),
           inject: [
-            import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL
+            import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL
           ]
         },
         // Legacy back-compat aliases (deprecated tokens still resolve to the same instances):
         {
-          provide: import_nestjs_durable_core7.STATE_STORE,
-          useExisting: import_nestjs_durable_core7.STATE_STORE_CANONICAL
+          provide: import_nestjs_durable_core8.STATE_STORE,
+          useExisting: import_nestjs_durable_core8.STATE_STORE_CANONICAL
         },
         {
-          provide: import_nestjs_durable_core7.TRANSPORT,
-          useExisting: import_nestjs_durable_core7.TRANSPORT_CANONICAL
+          provide: import_nestjs_durable_core8.TRANSPORT,
+          useExisting: import_nestjs_durable_core8.TRANSPORT_CANONICAL
         },
         {
-          provide: import_nestjs_durable_core7.DURABLE_OPTIONS,
-          useExisting: import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL
+          provide: import_nestjs_durable_core8.DURABLE_OPTIONS,
+          useExisting: import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL
         },
         {
-          provide: import_nestjs_durable_core7.WorkflowEngine,
+          provide: import_nestjs_durable_core8.WorkflowEngine,
           useFactory: /* @__PURE__ */ __name(async (store, transport, opts, moduleRef) => {
             const primary = transport ?? opts.transports?.[0]?.transport;
             const accessor = resolveAccessor(moduleRef);
             const context = opts.context ?? (accessor ? () => carrierFromAccessor(accessor) : void 0);
             const runtime = accessor ? await resolveContextRuntime() : void 0;
             const rehydrate = runtime && ((carrier, fn) => carrier && Object.keys(carrier).length > 0 ? runtime.deserialize(carrier, fn) : fn());
-            const engine = new import_nestjs_durable_core7.WorkflowEngine({
+            const engine = new import_nestjs_durable_core8.WorkflowEngine({
               store,
               transport: transport ?? void 0,
               transports: opts.transports,
@@ -946,9 +1053,9 @@ var DurableModule = class _DurableModule {
             return engine;
           }, "useFactory"),
           inject: [
-            import_nestjs_durable_core7.STATE_STORE_CANONICAL,
-            import_nestjs_durable_core7.TRANSPORT_CANONICAL,
-            import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL,
+            import_nestjs_durable_core8.STATE_STORE_CANONICAL,
+            import_nestjs_durable_core8.TRANSPORT_CANONICAL,
+            import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL,
             import_core4.ModuleRef
           ]
         },
@@ -956,23 +1063,24 @@ var DurableModule = class _DurableModule {
         EntityService,
         WorkflowRegistrar,
         DurableStepRegistrar,
-        TimerPoller
+        TimerPoller,
+        RetentionPoller
       ],
       exports: [
         WorkflowService,
         EntityService,
-        import_nestjs_durable_core7.WorkflowEngine,
-        import_nestjs_durable_core7.STATE_STORE,
-        import_nestjs_durable_core7.STATE_STORE_CANONICAL,
-        import_nestjs_durable_core7.TRANSPORT,
-        import_nestjs_durable_core7.TRANSPORT_CANONICAL,
-        import_nestjs_durable_core7.DURABLE_OPTIONS_CANONICAL
+        import_nestjs_durable_core8.WorkflowEngine,
+        import_nestjs_durable_core8.STATE_STORE,
+        import_nestjs_durable_core8.STATE_STORE_CANONICAL,
+        import_nestjs_durable_core8.TRANSPORT,
+        import_nestjs_durable_core8.TRANSPORT_CANONICAL,
+        import_nestjs_durable_core8.DURABLE_OPTIONS_CANONICAL
       ]
     };
   }
 };
-DurableModule = _ts_decorate7([
-  (0, import_common7.Module)({})
+DurableModule = _ts_decorate8([
+  (0, import_common8.Module)({})
 ], DurableModule);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {