@nestjs-transactional/outbox 1.0.0 → 2.0.0

package/dist/index.js

@@ -1,62 +1,42 @@
-"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 });
-exports.EXTERNALIZATION_REGISTRY = exports.ExternalizationRegistry = exports.EXTERNALIZED_METADATA = exports.getExternalizedMetadata = exports.Externalized = exports.ExternalizationError = exports.EVENT_EXTERNALIZER = exports.DEFAULT_DRAIN_TIMEOUT_MS = void 0;
-__exportStar(require("./types/publication-status"), exports);
-__exportStar(require("./types/event-publication"), exports);
-__exportStar(require("./types/completion-mode"), exports);
-__exportStar(require("./types/resubmission-options"), exports);
-__exportStar(require("./types/staleness-config"), exports);
-__exportStar(require("./types/retry-config"), exports);
-__exportStar(require("./types/errors"), exports);
-var drain_1 = require("./shutdown/drain");
-Object.defineProperty(exports, "DEFAULT_DRAIN_TIMEOUT_MS", { enumerable: true, get: function () { return drain_1.DEFAULT_DRAIN_TIMEOUT_MS; } });
-__exportStar(require("./serialization/event-serializer"), exports);
-__exportStar(require("./serialization/event-type-registry"), exports);
-__exportStar(require("./serialization/event-type-resolver"), exports);
-__exportStar(require("./serialization/json-event-serializer"), exports);
-__exportStar(require("./repository/event-publication-repository"), exports);
-__exportStar(require("./registry/event-publication-registry"), exports);
-__exportStar(require("./registry/listener-registry"), exports);
-__exportStar(require("./registry/multi-ds-listener-registrar"), exports);
-__exportStar(require("./registry/outbox-listener-scanner"), exports);
-__exportStar(require("./decorators/outbox-events-handler.decorator"), exports);
-__exportStar(require("./decorators/inject-decorators"), exports);
-__exportStar(require("./tokens"), exports);
-__exportStar(require("./dispatcher/outbox-event-publisher"), exports);
-__exportStar(require("./dispatcher/data-source-outbox-publisher"), exports);
-__exportStar(require("./dispatcher/event-publication-processor"), exports);
-__exportStar(require("./dispatcher/processor-options"), exports);
-var event_externalizer_1 = require("./externalization/event-externalizer");
-Object.defineProperty(exports, "EVENT_EXTERNALIZER", { enumerable: true, get: function () { return event_externalizer_1.EVENT_EXTERNALIZER; } });
-var errors_1 = require("./externalization/errors");
-Object.defineProperty(exports, "ExternalizationError", { enumerable: true, get: function () { return errors_1.ExternalizationError; } });
-var externalized_decorator_1 = require("./externalization/externalized.decorator");
-Object.defineProperty(exports, "Externalized", { enumerable: true, get: function () { return externalized_decorator_1.Externalized; } });
-Object.defineProperty(exports, "getExternalizedMetadata", { enumerable: true, get: function () { return externalized_decorator_1.getExternalizedMetadata; } });
-Object.defineProperty(exports, "EXTERNALIZED_METADATA", { enumerable: true, get: function () { return externalized_decorator_1.EXTERNALIZED_METADATA; } });
-var externalization_registry_1 = require("./externalization/externalization-registry");
-Object.defineProperty(exports, "ExternalizationRegistry", { enumerable: true, get: function () { return externalization_registry_1.ExternalizationRegistry; } });
-Object.defineProperty(exports, "EXTERNALIZATION_REGISTRY", { enumerable: true, get: function () { return externalization_registry_1.EXTERNALIZATION_REGISTRY; } });
-__exportStar(require("./recovery/staleness-monitor"), exports);
-__exportStar(require("./recovery/outbox-retry-scheduler"), exports);
-__exportStar(require("./api/failed-event-publications"), exports);
-__exportStar(require("./api/incomplete-event-publications"), exports);
-__exportStar(require("./api/completed-event-publications"), exports);
-__exportStar(require("./recovery/startup-recovery"), exports);
-__exportStar(require("./module/outbox.module"), exports);
-__exportStar(require("./module/outbox-processing.module"), exports);
+export * from './types/publication-status.js';
+export * from './types/event-publication.js';
+export * from './types/completion-mode.js';
+export * from './types/resubmission-options.js';
+export * from './types/staleness-config.js';
+export * from './types/cleanup-config.js';
+export * from './types/retry-config.js';
+export * from './types/errors.js';
+export { DEFAULT_DRAIN_TIMEOUT_MS } from './shutdown/drain.js';
+export * from './serialization/event-serializer.js';
+export * from './serialization/event-type-registry.js';
+export * from './serialization/event-type-resolver.js';
+export * from './serialization/json-event-serializer.js';
+export * from './repository/event-publication-repository.js';
+export * from './registry/event-publication-registry.js';
+export * from './registry/listener-registry.js';
+export * from './registry/multi-ds-listener-registrar.js';
+export * from './registry/outbox-listener-scanner.js';
+export * from './decorators/outbox-events-handler.decorator.js';
+export * from './decorators/inject-decorators.js';
+export * from './tokens/index.js';
+export * from './dispatcher/outbox-event-publisher.js';
+export * from './dispatcher/data-source-outbox-publisher.js';
+export * from './dispatcher/event-publication-processor.js';
+export * from './dispatcher/processor-options.js';
+export { EVENT_EXTERNALIZER } from './externalization/event-externalizer.js';
+export { ExternalizationError } from './externalization/errors.js';
+// Exported because every externalizer implementation faces the same
+// problem: broker clients reject with values that are not `Error`s.
+export { describeThrown } from './externalization/describe-thrown.js';
+export { Externalized, getExternalizedMetadata, EXTERNALIZED_METADATA, } from './externalization/externalized.decorator.js';
+export { ExternalizationRegistry, EXTERNALIZATION_REGISTRY, } from './externalization/externalization-registry.js';
+export * from './recovery/staleness-monitor.js';
+export * from './recovery/outbox-cleanup-scheduler.js';
+export * from './recovery/outbox-retry-scheduler.js';
+export * from './api/failed-event-publications.js';
+export * from './api/incomplete-event-publications.js';
+export * from './api/completed-event-publications.js';
+export * from './recovery/startup-recovery.js';
+export * from './module/outbox.module.js';
+export * from './module/outbox-processing.module.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,4DAA0C;AAC1C,0DAAwC;AACxC,+DAA6C;AAC7C,2DAAyC;AACzC,uDAAqC;AACrC,iDAA+B;AAE/B,0CAA4D;AAAnD,iHAAA,wBAAwB,OAAA;AAEjC,mEAAiD;AACjD,sEAAoD;AACpD,sEAAoD;AACpD,wEAAsD;AAEtD,4EAA0D;AAE1D,wEAAsD;AACtD,+DAA6C;AAC7C,yEAAuD;AACvD,qEAAmD;AAEnD,+EAA6D;AAC7D,iEAA+C;AAE/C,2CAAyB;AAIzB,sEAAoD;AACpD,4EAA0D;AAC1D,2EAAyD;AACzD,iEAA+C;AAI/C,2EAA0E;AAAjE,wHAAA,kBAAkB,OAAA;AAC3B,mDAAgE;AAAvD,8GAAA,oBAAoB,OAAA;AAC7B,mFAIkD;AAHhD,sHAAA,YAAY,OAAA;AACZ,iIAAA,uBAAuB,OAAA;AACvB,+HAAA,qBAAqB,OAAA;AAMvB,uFAGoD;AAFlD,mIAAA,uBAAuB,OAAA;AACvB,oIAAA,wBAAwB,OAAA;AAG1B,+DAA6C;AAC7C,oEAAkD;AAElD,kEAAgD;AAChD,sEAAoD;AACpD,qEAAmD;AAEnD,8DAA4C;AAE5C,yDAAuC;AACvC,oEAAkD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/D,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,8CAA8C,CAAC;AAE7D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,uCAAuC,CAAC;AAEtD,cAAc,iDAAiD,CAAC;AAChE,cAAc,mCAAmC,CAAC;AAElD,cAAc,mBAAmB,CAAC;AAIlC,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,mCAAmC,CAAC;AAIlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,oEAAoE;AACpE,oEAAoE;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EACL,YAAY,EACZ,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,6CAA6C,CAAC;AAKrD,OAAO,EACL,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,+CAA+C,CAAC;AAEvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AAErD,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,gCAAgC,CAAC;AAE/C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC"}

package/dist/interfaces/outbox-event-handler.interface.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=outbox-event-handler.interface.js.map

package/dist/module/outbox-processing.module.d.ts

@@ -1,5 +1,5 @@
 import { type OnApplicationBootstrap, type OnApplicationShutdown } from '@nestjs/common';
-import { type OutboxProcessingBundle } from './outbox.module';
+import { type OutboxProcessingBundle } from './outbox.module.js';
 /**
  * Auto-starts every configured per-dataSource
  * {@link EventPublicationProcessor} and {@link StalenessMonitor} on

package/dist/module/outbox-processing.module.js

@@ -1,4 +1,3 @@
-"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);
@@ -11,10 +10,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutboxProcessingModule = void 0;
-const common_1 = require("@nestjs/common");
-const outbox_module_1 = require("./outbox.module");
+import { Inject, Module, } from '@nestjs/common';
+import { OUTBOX_PROCESSING_BUNDLE } from './outbox.module.js';
 /**
  * Auto-starts every configured per-dataSource
  * {@link EventPublicationProcessor} and {@link StalenessMonitor} on
@@ -52,6 +49,11 @@ let OutboxProcessingModule = class OutboxProcessingModule {
         for (const scheduler of this.bundle.retrySchedulers) {
             scheduler.start();
         }
+        // Likewise a no-op unless `cleanup.interval > 0` (C4) — retention
+        // of completed publications is opt-in, and stays manual otherwise.
+        for (const scheduler of this.bundle.cleanupSchedulers) {
+            scheduler.start();
+        }
     }
     /**
      * Drain every worker before NestJS proceeds with the rest of the
@@ -74,13 +76,14 @@ let OutboxProcessingModule = class OutboxProcessingModule {
             ...this.bundle.processors.map((processor) => processor.stop()),
             ...this.bundle.monitors.map((monitor) => monitor.stop()),
             ...this.bundle.retrySchedulers.map((scheduler) => scheduler.stop()),
+            ...this.bundle.cleanupSchedulers.map((scheduler) => scheduler.stop()),
         ]);
     }
 };
-exports.OutboxProcessingModule = OutboxProcessingModule;
-exports.OutboxProcessingModule = OutboxProcessingModule = __decorate([
-    (0, common_1.Module)({}),
-    __param(0, (0, common_1.Inject)(outbox_module_1.OUTBOX_PROCESSING_BUNDLE)),
+OutboxProcessingModule = __decorate([
+    Module({}),
+    __param(0, Inject(OUTBOX_PROCESSING_BUNDLE)),
     __metadata("design:paramtypes", [Object])
 ], OutboxProcessingModule);
+export { OutboxProcessingModule };
 //# sourceMappingURL=outbox-processing.module.js.map

package/dist/module/outbox-processing.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"outbox-processing.module.js","sourceRoot":"","sources":["../../src/module/outbox-processing.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAKwB;AAExB,mDAAwF;AAExF;;;;;;;;;;;;;;;;;;;GAmBG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAGd;IAFnB,YAEmB,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAC9C,CAAC;IAEJ,sBAAsB;QACpB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/C,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;QACD,iEAAiE;QACjE,wCAAwC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YACpD,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC9D,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACxD,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AA3CY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,eAAM,EAAC,EAAE,CAAC;IAGN,WAAA,IAAA,eAAM,EAAC,wCAAwB,CAAC,CAAA;;GAFxB,sBAAsB,CA2ClC"}
+{"version":3,"file":"outbox-processing.module.js","sourceRoot":"","sources":["../../src/module/outbox-processing.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,MAAM,EACN,MAAM,GAGP,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,wBAAwB,EAA+B,MAAM,oBAAoB,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;GAmBG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAGd;IAFnB,YAEmB,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAC9C,CAAC;IAEJ,sBAAsB;QACpB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/C,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;QACD,iEAAiE;QACjE,wCAAwC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YACpD,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,kEAAkE;QAClE,mEAAmE;QACnE,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACtD,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC9D,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACxD,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YACnE,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACtE,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAjDY,sBAAsB;IADlC,MAAM,CAAC,EAAE,CAAC;IAGN,WAAA,MAAM,CAAC,wBAAwB,CAAC,CAAA;;GAFxB,sBAAsB,CAiDlC"}

package/dist/module/outbox.module.d.ts

@@ -1,12 +1,14 @@
 import { type DynamicModule, type InjectionToken, type ModuleMetadata, type Provider, type Type } from '@nestjs/common';
-import { EventPublicationProcessor } from '../dispatcher/event-publication-processor';
-import { type EventPublicationProcessorOptions } from '../dispatcher/processor-options';
-import { OutboxRetryScheduler } from '../recovery/outbox-retry-scheduler';
-import { StalenessMonitor } from '../recovery/staleness-monitor';
-import { StartupRecoveryService } from '../recovery/startup-recovery';
-import { CompletionMode } from '../types/completion-mode';
-import { type OutboxRetryConfig } from '../types/retry-config';
-import { type StalenessConfig } from '../types/staleness-config';
+import { EventPublicationProcessor } from '../dispatcher/event-publication-processor.js';
+import { type EventPublicationProcessorOptions } from '../dispatcher/processor-options.js';
+import { OutboxCleanupScheduler } from '../recovery/outbox-cleanup-scheduler.js';
+import { OutboxRetryScheduler } from '../recovery/outbox-retry-scheduler.js';
+import { StalenessMonitor } from '../recovery/staleness-monitor.js';
+import { StartupRecoveryService } from '../recovery/startup-recovery.js';
+import { type OutboxCleanupConfig } from '../types/cleanup-config.js';
+import { CompletionMode } from '../types/completion-mode.js';
+import { type OutboxRetryConfig } from '../types/retry-config.js';
+import { type StalenessConfig } from '../types/staleness-config.js';
 /**
  * Synchronous options for {@link OutboxModule.forRoot}.
  *
@@ -43,6 +45,8 @@ export interface OutboxModuleOptions {
     readonly staleness?: Partial<StalenessConfig>;
     /** Automatic retry policy for FAILED publications (DD-026). Off unless `maxAttempts > 0`. */
     readonly retry?: Partial<OutboxRetryConfig>;
+    /** Retention policy for COMPLETED publications (C4). Off unless `interval > 0`. */
+    readonly cleanup?: Partial<OutboxCleanupConfig>;
     readonly republishOnStartup?: boolean;
     readonly startupBatchSize?: number;
     readonly completionMode?: CompletionMode;
@@ -71,6 +75,8 @@ export interface OutboxModuleAsyncFactoryResult {
     readonly staleness?: Partial<StalenessConfig>;
     /** Automatic retry policy for FAILED publications (DD-026). Off unless `maxAttempts > 0`. */
     readonly retry?: Partial<OutboxRetryConfig>;
+    /** Retention policy for COMPLETED publications (C4). Off unless `interval > 0`. */
+    readonly cleanup?: Partial<OutboxCleanupConfig>;
     readonly republishOnStartup?: boolean;
     readonly startupBatchSize?: number;
     readonly completionMode?: CompletionMode;
@@ -110,6 +116,7 @@ export interface OutboxProcessingBundle {
     readonly processors: readonly EventPublicationProcessor[];
     readonly monitors: readonly StalenessMonitor[];
     readonly retrySchedulers: readonly OutboxRetryScheduler[];
+    readonly cleanupSchedulers: readonly OutboxCleanupScheduler[];
     readonly recoveryServices: readonly StartupRecoveryService[];
 }
 /**