@vytches/ddd-messaging 0.26.0

package/dist/outbox/outbox-repository.interface.d.ts

@@ -0,0 +1,61 @@
+import { IOutboxMessage, MessagePriority, MessageStatus } from './outbox-interfaces';
+export declare abstract class IOutboxRepository {
+    /**
+     * Saves a message to the outbox
+     * @param message Message to save
+     * @returns ID of the saved message
+     */
+    abstract saveMessage<T = unknown>(message: IOutboxMessage<T>): Promise<string>;
+    /**
+     * Saves multiple messages to the outbox
+     * @param messages Messages to save
+     * @returns IDs of the saved messages
+     */
+    abstract saveBatch<T = unknown>(messages: IOutboxMessage<T>[]): Promise<string[]>;
+    /**
+     * Gets unprocessed messages from the outbox
+     * @param limit Maximum number of messages to retrieve
+     * @param priorityOrder Order of priority for processing (default: [CRITICAL, HIGH, NORMAL, LOW])
+     * @returns Unprocessed messages
+     */
+    abstract getUnprocessedMessages(limit?: number, priorityOrder?: MessagePriority[]): Promise<IOutboxMessage[]>;
+    /**
+     * Gets specific message by ID
+     * @param id Message ID
+     * @returns Message or null if not found
+     */
+    abstract getById(id: string): Promise<IOutboxMessage | null>;
+    /**
+     * Updates message status
+     * @param id Message ID
+     * @param status New status
+     * @param error Optional error information
+     */
+    abstract updateStatus(id: string, status: MessageStatus, error?: Error): Promise<void>;
+    /**
+     * Updates message status for multiple messages
+     * @param ids Message IDs
+     * @param status New status
+     */
+    abstract updateStatusBatch(ids: string[], status: MessageStatus): Promise<void>;
+    /**
+     * Increments attempt counter for a message
+     * @param id Message ID
+     * @returns Updated attempt count
+     */
+    abstract incrementAttempt(id: string): Promise<number>;
+    /**
+     * Deletes messages with specified status older than a specified date
+     * @param olderThan Date threshold
+     * @param status Status of messages to delete
+     * @returns Number of deleted messages
+     */
+    abstract deleteByStatusAndAge(olderThan: Date, status: MessageStatus): Promise<number>;
+    /**
+     * Schedules a message for delayed processing
+     * @param message Message to schedule
+     * @param processAfter When to process the message
+     * @returns ID of the saved message
+     */
+    abstract scheduleMessage<T = unknown>(message: IOutboxMessage<T>, processAfter: Date): Promise<string>;
+}

package/dist/outbox/outbox-service.d.ts

@@ -0,0 +1,82 @@
+import { IDomainEvent } from '../../../contracts/src/index.ts';
+import { IOutboxMessage, OutboxMessageOptions, MessagePriority } from './outbox-interfaces';
+import { IOutboxRepository } from './outbox-repository.interface';
+export interface OutboxServiceOptions {
+    /** Default priority for messages */
+    defaultPriority?: MessagePriority;
+    /** Default metadata to add to all messages */
+    defaultMetadata?: Record<string, unknown>;
+    /** Enable automatic cleanup of processed messages */
+    autoCleanup?: boolean;
+    /** Age threshold for cleanup (in days) */
+    cleanupAfterDays?: number;
+    /** Enable logging */
+    enableLogging?: boolean;
+}
+export declare class OutboxService {
+    private readonly repository;
+    private readonly options;
+    private readonly logger;
+    constructor(repository: IOutboxRepository, options?: OutboxServiceOptions);
+    /**
+     * Saves a message to the outbox
+     */
+    saveMessage<T = unknown>(messageType: string, payload: T, options?: OutboxMessageOptions): Promise<string>;
+    /**
+     * Saves multiple messages to the outbox in a batch
+     */
+    saveMessages<T = unknown>(messages: Array<{
+        messageType: string;
+        payload: T;
+        options?: OutboxMessageOptions;
+    }>): Promise<string[]>;
+    /**
+     * Schedules a message for delayed processing
+     */
+    scheduleMessage<T = unknown>(messageType: string, payload: T, delayMs: number, options?: OutboxMessageOptions): Promise<string>;
+    /**
+     * Saves a high priority message to the outbox
+     */
+    saveHighPriorityMessage<T = unknown>(messageType: string, payload: T, options?: OutboxMessageOptions): Promise<string>;
+    /**
+     * Saves a critical priority message to the outbox
+     */
+    saveCriticalMessage<T = unknown>(messageType: string, payload: T, options?: OutboxMessageOptions): Promise<string>;
+    /**
+     * Converts a domain event to an outbox message and saves it
+     */
+    saveDomainEvent(event: IDomainEvent, options?: OutboxMessageOptions): Promise<string>;
+    /**
+     * Gets a message by ID
+     */
+    getMessage(id: string): Promise<IOutboxMessage | null>;
+    /**
+     * Gets pending messages (for monitoring purposes)
+     */
+    getPendingMessages(limit?: number): Promise<IOutboxMessage[]>;
+    /**
+     * Retries a failed message by resetting it to pending status
+     */
+    retryMessage(id: string): Promise<void>;
+    /**
+     * Retries multiple failed messages
+     */
+    retryMessages(ids: string[]): Promise<void>;
+    /**
+     * Cleans up old processed messages
+     */
+    cleanup(olderThanDays?: number): Promise<number>;
+    /**
+     * Gets outbox statistics
+     */
+    getStats(): Promise<{
+        totalPending: number;
+        totalProcessing: number;
+        totalProcessed: number;
+        totalFailed: number;
+    }>;
+    /**
+     * Logs messages if logging is enabled
+     */
+    private log;
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@vytches/ddd-messaging",
+  "version": "0.26.0",
+  "description": "Outbox pattern and reliable message delivery",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "LLMGUIDE.md",
+    "README.md",
+    "dist"
+  ],
+  "keywords": [
+    "ddd",
+    "domain-driven-design",
+    "typescript",
+    "messaging"
+  ],
+  "author": "VytchesDDD",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vytches/ddd.git",
+    "directory": "packages/messaging"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vite": "^7.3.2",
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^2.0.0",
+    "@vytches/ddd-testing": "0.26.0"
+  },
+  "nx": {
+    "tags": [
+      "scope:messaging",
+      "type:lib",
+      "layer:integration"
+    ]
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "dependencies": {
+    "@vytches/ddd-events": "0.26.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "clean": "rm -rf dist .tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src --ext .ts",
+    "type-check": "tsc --noEmit"
+  }
+}