@message-queue-toolkit/core 4.1.0 → 5.0.0

package/dist/index.d.ts

@@ -4,6 +4,8 @@ export type { NewQueueOptions, ExistingQueueOptions, NewQueueOptionsMultiSchema,
 export { isMessageError, MessageValidationError, MessageInvalidFormatError, } from './lib/errors/Errors';
 export { HandlerContainer, MessageHandlerConfig, MessageHandlerConfigBuilder, BarrierCallbackMultiConsumers, BarrierResult, BarrierResultPositive, BarrierResultNegative, } from './lib/queues/HandlerContainer';
 export type { HandlerContainerOptions, Handler } from './lib/queues/HandlerContainer';
+export { HandlerSpy } from './lib/queues/HandlerSpy';
+export type { SpyResult, HandlerSpyParams, PublicHandlerSpy } from './lib/queues/HandlerSpy';
 export { MessageSchemaContainer } from './lib/queues/MessageSchemaContainer';
 export type { MessageSchemaContainerOptions } from './lib/queues/MessageSchemaContainer';
 export { objectToBuffer } from './lib/utils/queueUtils';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isProduction = exports.reloadConfig = exports.parseMessage = exports.waitAndRetry = exports.objectToBuffer = exports.MessageSchemaContainer = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = exports.HandlerContainer = exports.MessageInvalidFormatError = exports.MessageValidationError = exports.isMessageError = exports.AbstractQueueService = void 0;
+exports.isProduction = exports.reloadConfig = exports.parseMessage = exports.waitAndRetry = exports.objectToBuffer = exports.MessageSchemaContainer = exports.HandlerSpy = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = exports.HandlerContainer = exports.MessageInvalidFormatError = exports.MessageValidationError = exports.isMessageError = exports.AbstractQueueService = void 0;
 var AbstractQueueService_1 = require("./lib/queues/AbstractQueueService");
 Object.defineProperty(exports, "AbstractQueueService", { enumerable: true, get: function () { return AbstractQueueService_1.AbstractQueueService; } });
 var Errors_1 = require("./lib/errors/Errors");
@@ -11,6 +11,8 @@ var HandlerContainer_1 = require("./lib/queues/HandlerContainer");
 Object.defineProperty(exports, "HandlerContainer", { enumerable: true, get: function () { return HandlerContainer_1.HandlerContainer; } });
 Object.defineProperty(exports, "MessageHandlerConfig", { enumerable: true, get: function () { return HandlerContainer_1.MessageHandlerConfig; } });
 Object.defineProperty(exports, "MessageHandlerConfigBuilder", { enumerable: true, get: function () { return HandlerContainer_1.MessageHandlerConfigBuilder; } });
+var HandlerSpy_1 = require("./lib/queues/HandlerSpy");
+Object.defineProperty(exports, "HandlerSpy", { enumerable: true, get: function () { return HandlerSpy_1.HandlerSpy; } });
 var MessageSchemaContainer_1 = require("./lib/queues/MessageSchemaContainer");
 Object.defineProperty(exports, "MessageSchemaContainer", { enumerable: true, get: function () { return MessageSchemaContainer_1.MessageSchemaContainer; } });
 var queueUtils_1 = require("./lib/utils/queueUtils");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAWA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAgB7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,kEAQsC;AAPpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAQ7B,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAG/B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AACrB,qDAAqD;AAA5C,0GAAA,YAAY,OAAA;AAErB,iDAAiE;AAAxD,wGAAA,YAAY,OAAA;AAAE,wGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAWA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAgB7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,kEAQsC;AAPpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAO7B,sDAAoD;AAA3C,wGAAA,UAAU,OAAA;AAGnB,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAG/B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AACrB,qDAAqD;AAA5C,0GAAA,YAAY,OAAA;AAErB,iDAAiE;AAAxD,wGAAA,YAAY,OAAA;AAAE,wGAAA,YAAY,OAAA"}

package/dist/lib/queues/AbstractQueueService.d.ts

@@ -1,8 +1,9 @@
 import type { ErrorReporter, ErrorResolver, Either } from '@lokalise/node-core';
 import type { ZodSchema, ZodType } from 'zod';
 import type { MessageInvalidFormatError, MessageValidationError } from '../errors/Errors';
-import type { Logger, TransactionObservabilityManager } from '../types/MessageQueueTypes';
+import type { Logger, TransactionObservabilityManager, MessageProcessingResult } from '../types/MessageQueueTypes';
 import type { MessageHandlerConfig } from './HandlerContainer';
+import type { HandlerSpy, PublicHandlerSpy, HandlerSpyParams } from './HandlerSpy';
 export type QueueDependencies = {
     errorReporter: ErrorReporter;
     logger: Logger;
@@ -20,16 +21,17 @@ export type DeletionConfig = {
     forceDeleteInProduction?: boolean;
 };
 export type CommonQueueOptions = {
+    messageTypeField: string;
+    messageIdField?: string;
+    handlerSpy?: HandlerSpy<object> | HandlerSpyParams | boolean;
     logMessages?: boolean;
 };
 export type NewQueueOptions<CreationConfigType extends object> = {
-    messageTypeField: string;
     locatorConfig?: never;
     deletionConfig?: DeletionConfig;
     creationConfig: CreationConfigType;
 } & CommonQueueOptions;
 export type ExistingQueueOptions<QueueLocatorType extends object> = {
-    messageTypeField: string;
     locatorConfig: QueueLocatorType;
     deletionConfig?: DeletionConfig;
     creationConfig?: never;
@@ -50,10 +52,13 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
     protected readonly errorReporter: ErrorReporter;
     readonly logger: Logger;
     protected readonly messageTypeField: string;
+    protected readonly messageIdField: string;
     protected readonly logMessages: boolean;
     protected readonly creationConfig?: QueueConfiguration;
     protected readonly locatorConfig?: QueueLocatorType;
     protected readonly deletionConfig?: DeletionConfig;
+    protected readonly _handlerSpy?: HandlerSpy<MessagePayloadSchemas>;
+    get handlerSpy(): PublicHandlerSpy<MessagePayloadSchemas>;
     constructor({ errorReporter, logger }: DependenciesType, options: OptionsType);
     protected abstract resolveSchema(message: MessagePayloadSchemas): Either<Error, ZodSchema<MessagePayloadSchemas>>;
     protected abstract resolveMessage(message: MessageEnvelopeType): Either<MessageInvalidFormatError | MessageValidationError, unknown>;
@@ -66,5 +71,6 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
      */
     protected logMessage(messageLogEntry: unknown): void;
     protected handleError(err: unknown, context?: Record<string, unknown>): void;
+    protected handleMessageProcessed(message: MessagePayloadSchemas | null, processingResult: MessageProcessingResult, messageId?: string): void;
     abstract close(): Promise<unknown>;
 }

package/dist/lib/queues/AbstractQueueService.js

@@ -3,22 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractQueueService = void 0;
 const node_util_1 = require("node:util");
 const node_core_1 = require("@lokalise/node-core");
+const HandlerSpy_1 = require("./HandlerSpy");
 class AbstractQueueService {
     errorReporter;
     logger;
     messageTypeField;
+    messageIdField;
     logMessages;
     creationConfig;
     locatorConfig;
     deletionConfig;
+    _handlerSpy;
+    get handlerSpy() {
+        if (!this._handlerSpy) {
+            throw new Error('HandlerSpy was not instantiated, please pass `handlerSpy` parameter during queue service creation.');
+        }
+        return this._handlerSpy;
+    }
     constructor({ errorReporter, logger }, options) {
         this.errorReporter = errorReporter;
         this.logger = logger;
         this.messageTypeField = options.messageTypeField;
+        this.messageIdField = options.messageIdField ?? 'id';
         this.creationConfig = options.creationConfig;
         this.locatorConfig = options.locatorConfig;
         this.deletionConfig = options.deletionConfig;
         this.logMessages = options.logMessages ?? false;
+        this._handlerSpy = (0, HandlerSpy_1.resolveHandlerSpy)(options);
     }
     /**
      * Format message for logging
@@ -47,6 +58,14 @@ class AbstractQueueService {
             this.errorReporter.report({ error: err, context });
         }
     }
+    handleMessageProcessed(message, processingResult, messageId) {
+        if (this._handlerSpy) {
+            this._handlerSpy.addProcessedMessage({
+                message,
+                processingResult,
+            }, messageId);
+        }
+    }
 }
 exports.AbstractQueueService = AbstractQueueService;
 //# sourceMappingURL=AbstractQueueService.js.map

package/dist/lib/queues/AbstractQueueService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AA8EjE,MAAsB,oBAAoB;IAYrB,aAAa,CAAe;IAC/B,MAAM,CAAQ;IACX,gBAAgB,CAAQ;IACxB,WAAW,CAAS;IACpB,cAAc,CAAqB;IACnC,aAAa,CAAmB;IAChC,cAAc,CAAiB;IAElD,YAAY,EAAE,aAAa,EAAE,MAAM,EAAoB,EAAE,OAAoB;QAC3E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;QAC1C,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAE5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAA;IACjD,CAAC;IAUD;;OAEG;IACO,iBAAiB,CAAC,OAA8B,EAAE,YAAoB;QAC9E,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACO,UAAU,CAAC,eAAwB;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;IACpC,CAAC;IAES,WAAW,CAAC,GAAY,EAAE,OAAiC;QACnE,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QACvC,CAAC;aAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,GAAG,SAAS;gBACZ,GAAG,OAAO;aACX,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;QACpD,CAAC;IACH,CAAC;CAGF;AAtED,oDAsEC"}
+{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAYjE,6CAAgD;AAyEhD,MAAsB,oBAAoB;IAYrB,aAAa,CAAe;IAC/B,MAAM,CAAQ;IACX,gBAAgB,CAAQ;IACxB,cAAc,CAAQ;IACtB,WAAW,CAAS;IACpB,cAAc,CAAqB;IACnC,aAAa,CAAmB;IAChC,cAAc,CAAiB;IAC/B,WAAW,CAAoC;IAElE,IAAI,UAAU;QACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,YAAY,EAAE,aAAa,EAAE,MAAM,EAAoB,EAAE,OAAoB;QAC3E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAA;QACpD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;QAC1C,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAE5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,IAAA,8BAAiB,EAAwB,OAAO,CAAC,CAAA;IACtE,CAAC;IAUD;;OAEG;IACO,iBAAiB,CAAC,OAA8B,EAAE,YAAoB;QAC9E,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACO,UAAU,CAAC,eAAwB;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;IACpC,CAAC;IAES,WAAW,CAAC,GAAY,EAAE,OAAiC;QACnE,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QACvC,CAAC;aAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,GAAG,SAAS;gBACZ,GAAG,OAAO;aACX,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;QACpD,CAAC;IACH,CAAC;IAES,sBAAsB,CAC9B,OAAqC,EACrC,gBAAyC,EACzC,SAAkB;QAElB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAClC;gBACE,OAAO;gBACP,gBAAgB;aACjB,EACD,SAAS,CACV,CAAA;QACH,CAAC;IACH,CAAC;CAGF;AAnGD,oDAmGC"}

package/dist/lib/queues/HandlerSpy.d.ts

@@ -0,0 +1,25 @@
+import type { MessageProcessingResult } from '../types/MessageQueueTypes';
+import type { CommonQueueOptions } from './AbstractQueueService';
+export type HandlerSpyParams = {
+    bufferSize?: number;
+    messageIdField?: string;
+};
+export type SpyResult<MessagePayloadSchemas extends object> = {
+    message: MessagePayloadSchemas | null;
+    processingResult: MessageProcessingResult;
+};
+export declare function isHandlerSpy<T extends object>(value: unknown): value is HandlerSpy<T>;
+export type PublicHandlerSpy<MessagePayloadSchemas extends object> = Omit<HandlerSpy<MessagePayloadSchemas>, 'addProcessedMessage'>;
+export declare class HandlerSpy<MessagePayloadSchemas extends object> {
+    name: string;
+    private readonly messageBuffer;
+    private readonly messageIdField;
+    private readonly spyPromises;
+    constructor(params?: HandlerSpyParams);
+    private messageMatchesFilter;
+    waitForMessageWithId(id: string, processingResult?: MessageProcessingResult): Promise<SpyResult<MessagePayloadSchemas>>;
+    waitForMessage(fields: Partial<MessagePayloadSchemas>, processingResult?: MessageProcessingResult): Promise<SpyResult<MessagePayloadSchemas>>;
+    clear(): void;
+    addProcessedMessage(processingResult: SpyResult<MessagePayloadSchemas>, messageId?: string): void;
+}
+export declare function resolveHandlerSpy<T extends object>(queueOptions: CommonQueueOptions): HandlerSpy<T> | undefined;

package/dist/lib/queues/HandlerSpy.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveHandlerSpy = exports.HandlerSpy = exports.isHandlerSpy = void 0;
+const node_crypto_1 = require("node:crypto");
+const node_core_1 = require("@lokalise/node-core");
+const toad_cache_1 = require("toad-cache");
+function isHandlerSpy(value) {
+    return ((0, node_core_1.isObject)(value) &&
+        (value instanceof HandlerSpy || value.name === 'HandlerSpy'));
+}
+exports.isHandlerSpy = isHandlerSpy;
+class HandlerSpy {
+    name = 'HandlerSpy';
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    messageBuffer;
+    messageIdField;
+    spyPromises;
+    constructor(params = {}) {
+        this.messageBuffer = new toad_cache_1.Fifo(params.bufferSize ?? 100);
+        // @ts-ignore
+        this.messageIdField = params.messageIdField ?? 'id';
+        this.spyPromises = [];
+    }
+    messageMatchesFilter(spyResult, fields, processingResult) {
+        return (Object.entries(fields).every(([key, value]) => {
+            // @ts-ignore
+            return spyResult.message[key] === value;
+        }) &&
+            (!processingResult || spyResult.processingResult === processingResult));
+    }
+    waitForMessageWithId(id, processingResult) {
+        return this.waitForMessage(
+        // @ts-ignore
+        {
+            [this.messageIdField]: id,
+        }, processingResult);
+    }
+    waitForMessage(fields, processingResult) {
+        const processedMessageEntry = Object.values(this.messageBuffer.items).find(
+        // @ts-ignore
+        (spyResult) => {
+            return this.messageMatchesFilter(spyResult.value, fields, processingResult);
+        });
+        if (processedMessageEntry) {
+            return Promise.resolve(processedMessageEntry.value);
+        }
+        let resolve;
+        const spyPromise = new Promise((_resolve) => {
+            resolve = _resolve;
+        });
+        this.spyPromises.push({
+            promise: spyPromise,
+            processingResult,
+            fields,
+            // @ts-ignore
+            resolve,
+        });
+        return spyPromise;
+    }
+    clear() {
+        this.messageBuffer.clear();
+    }
+    addProcessedMessage(processingResult, messageId) {
+        const resolvedMessageId = processingResult.message?.[this.messageIdField] ?? messageId ?? (0, node_crypto_1.randomUUID)();
+        // If we failed to parse message, let's store id at least
+        const resolvedProcessingResult = processingResult.message
+            ? processingResult
+            : {
+                ...processingResult,
+                message: {
+                    [this.messageIdField]: messageId,
+                },
+            };
+        // @ts-ignore
+        const cacheId = `${resolvedMessageId}-${Date.now()}-${(Math.random() + 1)
+            .toString(36)
+            .substring(7)}`;
+        this.messageBuffer.set(cacheId, resolvedProcessingResult);
+        const foundPromise = this.spyPromises.find((spyPromise) => {
+            return this.messageMatchesFilter(resolvedProcessingResult, spyPromise.fields, spyPromise.processingResult);
+        });
+        if (foundPromise) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+            foundPromise.resolve(processingResult);
+            const index = this.spyPromises.indexOf(foundPromise);
+            if (index > -1) {
+                // only splice array when item is found
+                this.spyPromises.splice(index, 1); // 2nd parameter means remove one item only
+            }
+        }
+    }
+}
+exports.HandlerSpy = HandlerSpy;
+function resolveHandlerSpy(queueOptions) {
+    if (isHandlerSpy(queueOptions.handlerSpy)) {
+        return queueOptions.handlerSpy;
+    }
+    if (!queueOptions.handlerSpy) {
+        return undefined;
+    }
+    if (queueOptions.handlerSpy === true) {
+        return new HandlerSpy();
+    }
+    return new HandlerSpy(queueOptions.handlerSpy);
+}
+exports.resolveHandlerSpy = resolveHandlerSpy;
+//# sourceMappingURL=HandlerSpy.js.map

package/dist/lib/queues/HandlerSpy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HandlerSpy.js","sourceRoot":"","sources":["../../../lib/queues/HandlerSpy.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AAExC,mDAA8C;AAC9C,2CAAiC;AA6BjC,SAAgB,YAAY,CAAmB,KAAc;IAC3D,OAAO,CACL,IAAA,oBAAQ,EAAC,KAAK,CAAC;QACf,CAAC,KAAK,YAAY,UAAU,IAAK,KAAuC,CAAC,IAAI,KAAK,YAAY,CAAC,CAChG,CAAA;AACH,CAAC;AALD,oCAKC;AAOD,MAAa,UAAU;IACd,IAAI,GAAG,YAAY,CAAA;IAC1B,8DAA8D;IAC7C,aAAa,CAAsB;IACnC,cAAc,CAA6B;IAC3C,WAAW,CAA6C;IAEzE,YAAY,SAA2B,EAAE;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,iBAAI,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,CAAC,CAAA;QACvD,aAAa;QACb,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAA;QACnD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;IACvB,CAAC;IAEO,oBAAoB,CAC1B,SAA4B,EAC5B,MAAsC,EACtC,gBAA0C;QAE1C,OAAO,CACL,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC5C,aAAa;YACb,OAAO,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAA;QACzC,CAAC,CAAC;YACF,CAAC,CAAC,gBAAgB,IAAI,SAAS,CAAC,gBAAgB,KAAK,gBAAgB,CAAC,CACvE,CAAA;IACH,CAAC;IAED,oBAAoB,CAAC,EAAU,EAAE,gBAA0C;QACzE,OAAO,IAAI,CAAC,cAAc;QACxB,aAAa;QACb;YACE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE;SAC1B,EACD,gBAAgB,CACjB,CAAA;IACH,CAAC;IAED,cAAc,CACZ,MAAsC,EACtC,gBAA0C;QAE1C,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI;QACxE,aAAa;QACb,CAAC,SAAqD,EAAE,EAAE;YACxD,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAA;QAC7E,CAAC,CACF,CAAA;QACD,IAAI,qBAAqB,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;QACrD,CAAC;QAED,IAAI,OAEK,CAAA;QACT,MAAM,UAAU,GAAG,IAAI,OAAO,CAAmC,CAAC,QAAQ,EAAE,EAAE;YAC5E,OAAO,GAAG,QAAQ,CAAA;QACpB,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACpB,OAAO,EAAE,UAAU;YACnB,gBAAgB;YAChB,MAAM;YACN,aAAa;YACb,OAAO;SACR,CAAC,CAAA;QAEF,OAAO,UAAU,CAAA;IACnB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAA;IAC5B,CAAC;IAED,mBAAmB,CAAC,gBAAkD,EAAE,SAAkB;QACxF,MAAM,iBAAiB,GACrB,gBAAgB,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,SAAS,IAAI,IAAA,wBAAU,GAAE,CAAA;QAE9E,yDAAyD;QACzD,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,OAAO;YACvD,CAAC,CAAC,gBAAgB;YAClB,CAAC,CAAC;gBACE,GAAG,gBAAgB;gBACnB,OAAO,EAAE;oBACP,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS;iBACjC;aACF,CAAA;QAEL,aAAa;QACb,MAAM,OAAO,GAAG,GAAG,iBAAiB,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;aACtE,QAAQ,CAAC,EAAE,CAAC;aACZ,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;QACjB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAA;QAEzD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;YACxD,OAAO,IAAI,CAAC,oBAAoB,CAC9B,wBAAwB,EACxB,UAAU,CAAC,MAAM,EACjB,UAAU,CAAC,gBAAgB,CAC5B,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,YAAY,EAAE,CAAC;YACjB,6DAA6D;YAC7D,YAAY,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YACpD,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;gBACf,uCAAuC;gBACvC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA,CAAC,2CAA2C;YAC/E,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAjHD,gCAiHC;AAED,SAAgB,iBAAiB,CAAmB,YAAgC;IAClF,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1C,OAAO,YAAY,CAAC,UAAsC,CAAA;IAC5D,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QACrC,OAAO,IAAI,UAAU,EAA8B,CAAA;IACrD,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,UAAU,CAA6B,CAAA;AAC5E,CAAC;AAZD,8CAYC"}

package/dist/lib/types/MessageQueueTypes.d.ts

@@ -3,6 +3,7 @@ export interface QueueConsumer {
     start(): Promise<unknown>;
     close(): Promise<unknown>;
 }
+export type MessageProcessingResult = 'retryLater' | 'consumed' | 'published' | 'error' | 'invalid_message';
 export interface SyncPublisher<MessagePayloadType> {
     publish(message: MessagePayloadType): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "private": false,
   "license": "MIT",
   "description": "Useful utilities, interfaces and base classes for message queue handling. Supports AMQP and SQS with a common abstraction on top currently",
@@ -17,25 +17,32 @@
     "build:release": "del-cli dist && del-cli coverage && npm run lint && tsc --project tsconfig.release.json",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint .  --ext .ts --fix",
-    "test:coverage": "",
+    "test": "vitest",
+    "test:coverage": "npm test -- --coverage",
     "test:ci": "npm run docker:start:dev && npm run test:coverage && npm run docker:stop:dev",
     "docker:start:dev": "",
     "docker:stop:dev": "",
     "format": "prettier --write .",
     "prepublishOnly": "npm run build:release"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@lokalise/node-core": "^8.3.0",
+    "toad-cache": "^3.4.1"
+  },
   "devDependencies": {
-    "@types/node": "^20.9.2",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
+    "@types/node": "^20.10.3",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "@vitest/coverage-v8": "^0.34.6",
     "del-cli": "^5.1.0",
-    "eslint": "^8.54.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-prettier": "^5.0.1",
     "prettier": "^3.1.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2",
+    "vitest": "0.34.6",
+    "vite": "4.5.0"
   },
   "homepage": "https://github.com/kibertoad/message-queue-toolkit",
   "repository": {