@message-queue-toolkit/core 11.0.0 → 12.1.0

package/dist/index.d.ts

@@ -13,5 +13,14 @@ export { MessageSchemaContainer } from './lib/queues/MessageSchemaContainer';
 export type { MessageSchemaContainerOptions } from './lib/queues/MessageSchemaContainer';
 export { objectToBuffer } from './lib/utils/queueUtils';
 export { waitAndRetry } from './lib/utils/waitUtils';
-export { parseMessage } from './lib/utils/parseUtils';
+export { type ParseMessageResult, parseMessage } from './lib/utils/parseUtils';
+export { isRetryDateExceeded } from './lib/utils/dateUtils';
+export { toDatePreprocessor } from './lib/utils/toDateProcessor';
 export { reloadConfig, isProduction } from './lib/utils/envUtils';
+export { DomainEventEmitter } from './lib/events/DomainEventEmitter';
+export { EventRegistry } from './lib/events/EventRegistry';
+export { FakeListener } from './lib/events/fakes/FakeListener';
+export * from './lib/events/eventTypes';
+export * from './lib/events/baseEventSchemas';
+export * from './lib/messages/baseMessageSchemas';
+export * from './lib/messages/MetadataFiller';

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.HandlerSpy = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = exports.HandlerContainer = exports.DoNotProcessMessageError = exports.RetryMessageLaterError = exports.objectMatches = exports.isShallowSubset = exports.MessageInvalidFormatError = exports.MessageValidationError = exports.isMessageError = exports.AbstractQueueService = void 0;
+exports.FakeListener = exports.EventRegistry = exports.DomainEventEmitter = exports.isProduction = exports.reloadConfig = exports.toDatePreprocessor = exports.isRetryDateExceeded = exports.parseMessage = exports.waitAndRetry = exports.objectToBuffer = exports.MessageSchemaContainer = exports.HandlerSpy = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = exports.HandlerContainer = exports.DoNotProcessMessageError = exports.RetryMessageLaterError = exports.objectMatches = exports.isShallowSubset = exports.MessageInvalidFormatError = exports.MessageValidationError = exports.isMessageError = exports.AbstractQueueService = void 0;
 const tslib_1 = require("tslib");
 var AbstractQueueService_1 = require("./lib/queues/AbstractQueueService");
 Object.defineProperty(exports, "AbstractQueueService", { enumerable: true, get: function () { return AbstractQueueService_1.AbstractQueueService; } });
@@ -30,7 +30,21 @@ var waitUtils_1 = require("./lib/utils/waitUtils");
 Object.defineProperty(exports, "waitAndRetry", { enumerable: true, get: function () { return waitUtils_1.waitAndRetry; } });
 var parseUtils_1 = require("./lib/utils/parseUtils");
 Object.defineProperty(exports, "parseMessage", { enumerable: true, get: function () { return parseUtils_1.parseMessage; } });
+var dateUtils_1 = require("./lib/utils/dateUtils");
+Object.defineProperty(exports, "isRetryDateExceeded", { enumerable: true, get: function () { return dateUtils_1.isRetryDateExceeded; } });
+var toDateProcessor_1 = require("./lib/utils/toDateProcessor");
+Object.defineProperty(exports, "toDatePreprocessor", { enumerable: true, get: function () { return toDateProcessor_1.toDatePreprocessor; } });
 var envUtils_1 = require("./lib/utils/envUtils");
 Object.defineProperty(exports, "reloadConfig", { enumerable: true, get: function () { return envUtils_1.reloadConfig; } });
 Object.defineProperty(exports, "isProduction", { enumerable: true, get: function () { return envUtils_1.isProduction; } });
+var DomainEventEmitter_1 = require("./lib/events/DomainEventEmitter");
+Object.defineProperty(exports, "DomainEventEmitter", { enumerable: true, get: function () { return DomainEventEmitter_1.DomainEventEmitter; } });
+var EventRegistry_1 = require("./lib/events/EventRegistry");
+Object.defineProperty(exports, "EventRegistry", { enumerable: true, get: function () { return EventRegistry_1.EventRegistry; } });
+var FakeListener_1 = require("./lib/events/fakes/FakeListener");
+Object.defineProperty(exports, "FakeListener", { enumerable: true, get: function () { return FakeListener_1.FakeListener; } });
+tslib_1.__exportStar(require("./lib/events/eventTypes"), exports);
+tslib_1.__exportStar(require("./lib/events/baseEventSchemas"), exports);
+tslib_1.__exportStar(require("./lib/messages/baseMessageSchemas"), exports);
+tslib_1.__exportStar(require("./lib/messages/MetadataFiller"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;AAWA,0EAAsF;AAA7E,4HAAA,oBAAoB,OAAA;AAC7B,wEAA6C;AAE7C,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,qDAAuE;AAA9D,6GAAA,eAAe,OAAA;AAAE,2GAAA,aAAa,OAAA;AAEvC,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAE/B,oEAAyE;AAAhE,6HAAA,wBAAwB,OAAA;AAEjC,kEAIsC;AAHpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAY7B,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;AAWA,0EAAsF;AAA7E,4HAAA,oBAAoB,OAAA;AAC7B,wEAA6C;AAE7C,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,qDAAuE;AAA9D,6GAAA,eAAe,OAAA;AAAE,2GAAA,aAAa,OAAA;AAEvC,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAE/B,oEAAyE;AAAhE,6HAAA,wBAAwB,OAAA;AAEjC,kEAIsC;AAHpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAY7B,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,qDAA8E;AAA5C,0GAAA,YAAY,OAAA;AAC9C,mDAA2D;AAAlD,gHAAA,mBAAmB,OAAA;AAC5B,+DAAgE;AAAvD,qHAAA,kBAAkB,OAAA;AAE3B,iDAAiE;AAAxD,wGAAA,YAAY,OAAA;AAAE,wGAAA,YAAY,OAAA;AAEnC,sEAAoE;AAA3D,wHAAA,kBAAkB,OAAA;AAC3B,4DAA0D;AAAjD,8GAAA,aAAa,OAAA;AACtB,gEAA8D;AAArD,4GAAA,YAAY,OAAA;AAErB,kEAAuC;AACvC,wEAA6C;AAC7C,4EAAiD;AAEjD,wEAA6C"}

package/dist/lib/events/DomainEventEmitter.d.ts

@@ -0,0 +1,24 @@
+import type { EventRegistry } from './EventRegistry';
+import type { AnyEventHandler, SingleEventHandler, CommonEventDefinition, CommonEventDefinitionSchemaType, EventTypeNames } from './eventTypes';
+export declare class DomainEventEmitter<SupportedEvents extends CommonEventDefinition[]> {
+    private readonly eventRegistry;
+    private readonly eventHandlerMap;
+    private readonly anyHandlers;
+    constructor({ eventRegistry }: {
+        eventRegistry: EventRegistry<SupportedEvents>;
+    });
+    emit<SupportedEvent extends SupportedEvents[number]>(supportedEvent: SupportedEvent, data: Omit<CommonEventDefinitionSchemaType<SupportedEvent>, 'type'>): Promise<void>;
+    /**
+     * Register handler for a specific event
+     */
+    on<EventTypeName extends EventTypeNames<SupportedEvents[number]>>(eventTypeName: EventTypeName, handler: SingleEventHandler<SupportedEvents, EventTypeName>): void;
+    /**
+     * Register handler for multiple events
+     */
+    onMany<EventTypeName extends EventTypeNames<SupportedEvents[number]>>(eventTypeNames: EventTypeName[], handler: SingleEventHandler<SupportedEvents, EventTypeName>): void;
+    /**
+     * Register handler for all events supported by the emitter
+     */
+    onAny(handler: AnyEventHandler<SupportedEvents>): void;
+    private addOnHandler;
+}

package/dist/lib/events/DomainEventEmitter.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainEventEmitter = void 0;
+const node_core_1 = require("@lokalise/node-core");
+class DomainEventEmitter {
+    eventRegistry;
+    eventHandlerMap = {};
+    anyHandlers = [];
+    constructor({ eventRegistry }) {
+        this.eventRegistry = eventRegistry;
+    }
+    async emit(supportedEvent, data) {
+        const eventTypeName = supportedEvent.schema.shape.type.value;
+        if (!this.eventRegistry.isSupportedEvent(eventTypeName)) {
+            throw new node_core_1.InternalError({
+                errorCode: 'UNKNOWN_EVENT',
+                message: `Unknown event ${eventTypeName}`,
+            });
+        }
+        const eventHandlers = this.eventHandlerMap[eventTypeName];
+        // No relevant handlers are registered, we can stop processing
+        if (!eventHandlers && this.anyHandlers.length === 0) {
+            return;
+        }
+        const validatedEvent = this.eventRegistry
+            .getEventDefinitionByTypeName(eventTypeName)
+            .schema.parse({
+            type: eventTypeName,
+            ...data,
+        });
+        if (eventHandlers) {
+            for (const handler of eventHandlers) {
+                await handler.handleEvent(validatedEvent);
+            }
+        }
+        for (const handler of this.anyHandlers) {
+            await handler.handleEvent(validatedEvent);
+        }
+    }
+    /**
+     * Register handler for a specific event
+     */
+    on(eventTypeName, handler) {
+        this.addOnHandler(eventTypeName, handler);
+    }
+    /**
+     * Register handler for multiple events
+     */
+    onMany(eventTypeNames, handler) {
+        for (const eventTypeName of eventTypeNames) {
+            this.on(eventTypeName, handler);
+        }
+    }
+    /**
+     * Register handler for all events supported by the emitter
+     */
+    onAny(handler) {
+        this.anyHandlers.push(handler);
+    }
+    addOnHandler(eventTypeName, handler) {
+        if (!this.eventHandlerMap[eventTypeName]) {
+            this.eventHandlerMap[eventTypeName] = [];
+        }
+        this.eventHandlerMap[eventTypeName].push(handler);
+    }
+}
+exports.DomainEventEmitter = DomainEventEmitter;
+//# sourceMappingURL=DomainEventEmitter.js.map

package/dist/lib/events/DomainEventEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DomainEventEmitter.js","sourceRoot":"","sources":["../../../lib/events/DomainEventEmitter.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AAYnD,MAAa,kBAAkB;IACZ,aAAa,CAAgC;IAE7C,eAAe,GAG5B,EAAE,CAAA;IACW,WAAW,GAAuC,EAAE,CAAA;IAErE,YAAY,EAAE,aAAa,EAAqD;QAC9E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;IAEM,KAAK,CAAC,IAAI,CACf,cAA8B,EAC9B,IAAmE;QAEnE,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAA;QAE5D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAa,CAAC;gBACtB,SAAS,EAAE,eAAe;gBAC1B,OAAO,EAAE,iBAAiB,aAAa,EAAE;aAC1C,CAAC,CAAA;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;QAEzD,8DAA8D;QAC9D,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpD,OAAM;QACR,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa;aACtC,4BAA4B,CAAC,aAAa,CAAC;aAC3C,MAAM,CAAC,KAAK,CAAC;YACZ,IAAI,EAAE,aAAa;YACnB,GAAG,IAAI;SACR,CAAC,CAAA;QAEJ,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;gBACpC,MAAM,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;YAC3C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;OAEG;IACI,EAAE,CACP,aAA4B,EAC5B,OAA2D;QAE3D,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;IAED;;OAEG;IACI,MAAM,CACX,cAA+B,EAC/B,OAA2D;QAE3D,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAyC;QACpD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAChC,CAAC;IAEO,YAAY,CAClB,aAAsD,EACtD,OAAqB;QAErB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,EAAE,CAAA;QAC1C,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACnD,CAAC;CACF;AA1FD,gDA0FC"}

package/dist/lib/events/EventRegistry.d.ts

@@ -0,0 +1,9 @@
+import type { CommonEventDefinition, EventTypeNames } from './eventTypes';
+export declare class EventRegistry<SupportedEvents extends CommonEventDefinition[]> {
+    readonly supportedEvents: SupportedEvents;
+    private readonly supportedEventsSet;
+    private readonly supportedEventMap;
+    constructor(supportedEvents: SupportedEvents);
+    getEventDefinitionByTypeName: <EventTypeName extends EventTypeNames<SupportedEvents[number]>>(eventTypeName: EventTypeName) => CommonEventDefinition;
+    isSupportedEvent(eventTypeName: string): boolean;
+}

package/dist/lib/events/EventRegistry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventRegistry = void 0;
+class EventRegistry {
+    supportedEvents;
+    supportedEventsSet;
+    supportedEventMap = {};
+    constructor(supportedEvents) {
+        this.supportedEvents = supportedEvents;
+        this.supportedEventsSet = new Set();
+        for (const supportedEvent of supportedEvents) {
+            this.supportedEventMap[supportedEvent.schema.shape.type.value] = supportedEvent;
+            this.supportedEventsSet.add(supportedEvent.schema.shape.type.value);
+        }
+    }
+    getEventDefinitionByTypeName = (eventTypeName) => {
+        return this.supportedEventMap[eventTypeName];
+    };
+    isSupportedEvent(eventTypeName) {
+        return this.supportedEventsSet.has(eventTypeName);
+    }
+}
+exports.EventRegistry = EventRegistry;
+//# sourceMappingURL=EventRegistry.js.map

package/dist/lib/events/EventRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventRegistry.js","sourceRoot":"","sources":["../../../lib/events/EventRegistry.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IACR,eAAe,CAAiB;IAC/B,kBAAkB,CAAa;IAC/B,iBAAiB,GAA0C,EAAE,CAAA;IAE9E,YAAY,eAAgC;QAC1C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAA;QAE3C,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;YAC7C,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,cAAc,CAAA;YAC/E,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrE,CAAC;IACH,CAAC;IAEM,4BAA4B,GAAG,CAGpC,aAA4B,EACL,EAAE;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAA;IAC9C,CAAC,CAAA;IAEM,gBAAgB,CAAC,aAAqB;QAC3C,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IACnD,CAAC;CACF;AA1BD,sCA0BC"}

package/dist/lib/events/baseEventSchemas.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const BASE_EVENT_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    timestamp: z.ZodString;
+    type: z.ZodLiteral<string>;
+    payload: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    timestamp: string;
+    type: string;
+    payload?: {} | undefined;
+}, {
+    id: string;
+    timestamp: string;
+    type: string;
+    payload?: {} | undefined;
+}>;
+export type BaseEventType = z.infer<typeof BASE_EVENT_SCHEMA>;

package/dist/lib/events/baseEventSchemas.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_EVENT_SCHEMA = void 0;
+const zod_1 = require("zod");
+// Core fields that describe either internal event or external message
+exports.BASE_EVENT_SCHEMA = zod_1.z.object({
+    id: zod_1.z.string().describe('event unique identifier'),
+    timestamp: zod_1.z.string().datetime().describe('iso 8601 datetime'),
+    type: zod_1.z.literal('<replace.me>').describe('event type name'),
+    payload: zod_1.z.optional(zod_1.z.object({})).describe('event payload based on type'),
+});
+//# sourceMappingURL=baseEventSchemas.js.map

package/dist/lib/events/baseEventSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseEventSchemas.js","sourceRoot":"","sources":["../../../lib/events/baseEventSchemas.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,sEAAsE;AACzD,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAClD,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC9D,IAAI,EAAE,OAAC,CAAC,OAAO,CAAS,cAAc,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnE,OAAO,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;CAC1E,CAAC,CAAA"}

package/dist/lib/events/eventTypes.d.ts

@@ -0,0 +1,20 @@
+import type { ZodObject, ZodTypeAny } from 'zod';
+import type z from 'zod';
+import type { BASE_EVENT_SCHEMA } from './baseEventSchemas';
+export type EventTypeNames<EventDefinition extends CommonEventDefinition> = CommonEventDefinitionSchemaType<EventDefinition>['type'];
+export type CommonEventDefinition = {
+    schema: ZodObject<Omit<(typeof BASE_EVENT_SCHEMA)['shape'], 'payload'> & {
+        payload: ZodTypeAny;
+    }>;
+    schemaVersion?: string;
+};
+export type CommonEventDefinitionSchemaType<T extends CommonEventDefinition> = z.infer<T['schema']>;
+export type EventHandler<EventDefinitionSchema extends CommonEventDefinitionSchemaType<CommonEventDefinition> = CommonEventDefinitionSchemaType<CommonEventDefinition>> = {
+    handleEvent(event: EventDefinitionSchema): void | Promise<void>;
+};
+export type AnyEventHandler<EventDefinitions extends CommonEventDefinition[]> = EventHandler<CommonEventDefinitionSchemaType<EventDefinitions[number]>>;
+export type SingleEventHandler<EventDefinition extends CommonEventDefinition[], EventTypeName extends EventTypeNames<EventDefinition[number]>> = EventHandler<EventFromArrayByTypeName<EventDefinition, EventTypeName>>;
+type EventFromArrayByTypeName<EventDefinition extends CommonEventDefinition[], EventTypeName extends EventTypeNames<EventDefinition[number]>> = Extract<CommonEventDefinitionSchemaType<EventDefinition[number]>, {
+    type: EventTypeName;
+}>;
+export {};

package/dist/lib/events/eventTypes.js

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

package/dist/lib/events/eventTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventTypes.js","sourceRoot":"","sources":["../../../lib/events/eventTypes.ts"],"names":[],"mappings":""}

package/dist/lib/events/fakes/FakeListener.d.ts

@@ -0,0 +1,6 @@
+import type { AnyEventHandler, CommonEventDefinition } from '../eventTypes';
+export declare class FakeListener<SupportedEvents extends CommonEventDefinition[]> implements AnyEventHandler<SupportedEvents> {
+    receivedEvents: SupportedEvents[number]['schema']['_output'][];
+    constructor(_supportedEvents: SupportedEvents);
+    handleEvent(event: SupportedEvents[number]['schema']['_output']): void | Promise<void>;
+}

package/dist/lib/events/fakes/FakeListener.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FakeListener = void 0;
+class FakeListener {
+    receivedEvents = [];
+    constructor(_supportedEvents) {
+        this.receivedEvents = [];
+    }
+    handleEvent(event) {
+        this.receivedEvents.push(event);
+    }
+}
+exports.FakeListener = FakeListener;
+//# sourceMappingURL=FakeListener.js.map

package/dist/lib/events/fakes/FakeListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeListener.js","sourceRoot":"","sources":["../../../../lib/events/fakes/FakeListener.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAY;IAGhB,cAAc,GAAmD,EAAE,CAAA;IAE1E,YAAY,gBAAiC;QAC3C,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,WAAW,CAAC,KAAmD;QAC7D,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,CAAC;CACF;AAZD,oCAYC"}

package/dist/lib/messages/MetadataFiller.d.ts

@@ -0,0 +1,25 @@
+import type { BaseEventType } from '../events/baseEventSchemas';
+import type { CommonEventDefinition } from '../events/eventTypes';
+import type { MessageMetadataType } from './baseMessageSchemas';
+export type IdGenerator = () => string;
+export type TimestampGenerator = () => string;
+export type MetadataFillerOptions = {
+    serviceId: string;
+    schemaVersion: string;
+    idGenerator?: IdGenerator;
+    timestampGenerator?: TimestampGenerator;
+    defaultVersion?: string;
+};
+export type MetadataFiller<T extends BaseEventType = BaseEventType, D = CommonEventDefinition, M = MessageMetadataType> = {
+    produceMetadata(currentMessage: T, eventDefinition: D, precedingMessageMetadata?: M): M;
+    produceId(): string;
+    produceTimestamp(): string;
+};
+export declare class CommonMetadataFiller implements MetadataFiller {
+    private readonly serviceId;
+    readonly produceId: IdGenerator;
+    readonly produceTimestamp: TimestampGenerator;
+    private readonly defaultVersion;
+    constructor(options: MetadataFillerOptions);
+    produceMetadata(_currentMessage: BaseEventType, eventDefinition: CommonEventDefinition, precedingMessageMetadata?: MessageMetadataType): MessageMetadataType;
+}

package/dist/lib/messages/MetadataFiller.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonMetadataFiller = void 0;
+const node_crypto_1 = require("node:crypto");
+class CommonMetadataFiller {
+    serviceId;
+    produceId;
+    produceTimestamp;
+    defaultVersion;
+    constructor(options) {
+        this.serviceId = options.serviceId;
+        this.defaultVersion = options.defaultVersion ?? '1.0.0';
+        this.produceId =
+            options.idGenerator ??
+                (() => {
+                    return (0, node_crypto_1.randomUUID)();
+                });
+        this.produceTimestamp =
+            options.timestampGenerator ??
+                (() => {
+                    return new Date().toISOString();
+                });
+    }
+    produceMetadata(_currentMessage, eventDefinition, precedingMessageMetadata) {
+        return {
+            producedBy: this.serviceId,
+            originatedFrom: precedingMessageMetadata?.originatedFrom ?? this.serviceId,
+            schemaVersion: eventDefinition.schemaVersion ?? this.defaultVersion,
+            correlationId: precedingMessageMetadata?.correlationId ?? this.produceId(),
+        };
+    }
+}
+exports.CommonMetadataFiller = CommonMetadataFiller;
+//# sourceMappingURL=MetadataFiller.js.map

package/dist/lib/messages/MetadataFiller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetadataFiller.js","sourceRoot":"","sources":["../../../lib/messages/MetadataFiller.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AA4BxC,MAAa,oBAAoB;IACd,SAAS,CAAQ;IAClB,SAAS,CAAa;IACtB,gBAAgB,CAAoB;IACnC,cAAc,CAAQ;IAEvC,YAAY,OAA8B;QACxC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QAClC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,OAAO,CAAA;QACvD,IAAI,CAAC,SAAS;YACZ,OAAO,CAAC,WAAW;gBACnB,CAAC,GAAG,EAAE;oBACJ,OAAO,IAAA,wBAAU,GAAE,CAAA;gBACrB,CAAC,CAAC,CAAA;QACJ,IAAI,CAAC,gBAAgB;YACnB,OAAO,CAAC,kBAAkB;gBAC1B,CAAC,GAAG,EAAE;oBACJ,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;gBACjC,CAAC,CAAC,CAAA;IACN,CAAC;IAED,eAAe,CACb,eAA8B,EAC9B,eAAsC,EACtC,wBAA8C;QAE9C,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,SAAS;YAC1B,cAAc,EAAE,wBAAwB,EAAE,cAAc,IAAI,IAAI,CAAC,SAAS;YAC1E,aAAa,EAAE,eAAe,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc;YACnE,aAAa,EAAE,wBAAwB,EAAE,aAAa,IAAI,IAAI,CAAC,SAAS,EAAE;SAC3E,CAAA;IACH,CAAC;CACF;AAjCD,oDAiCC"}

package/dist/lib/messages/baseMessageSchemas.d.ts

@@ -0,0 +1,64 @@
+import z from 'zod';
+export declare const MESSAGE_METADATA_SCHEMA: z.ZodObject<{
+    schemaVersion: z.ZodString;
+    producedBy: z.ZodString;
+    originatedFrom: z.ZodString;
+    correlationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    schemaVersion: string;
+    producedBy: string;
+    originatedFrom: string;
+    correlationId: string;
+}, {
+    schemaVersion: string;
+    producedBy: string;
+    originatedFrom: string;
+    correlationId: string;
+}>;
+export declare const BASE_MESSAGE_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    timestamp: z.ZodString;
+    type: z.ZodLiteral<string>;
+    payload: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+}, {
+    metadata: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodString;
+        producedBy: z.ZodString;
+        originatedFrom: z.ZodString;
+        correlationId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        producedBy: string;
+        originatedFrom: string;
+        correlationId: string;
+    }, {
+        schemaVersion: string;
+        producedBy: string;
+        originatedFrom: string;
+        correlationId: string;
+    }>>;
+}>, "strip", z.ZodTypeAny, {
+    id: string;
+    timestamp: string;
+    type: string;
+    payload?: {} | undefined;
+    metadata?: {
+        schemaVersion: string;
+        producedBy: string;
+        originatedFrom: string;
+        correlationId: string;
+    } | undefined;
+}, {
+    id: string;
+    timestamp: string;
+    type: string;
+    payload?: {} | undefined;
+    metadata?: {
+        schemaVersion: string;
+        producedBy: string;
+        originatedFrom: string;
+        correlationId: string;
+    } | undefined;
+}>;
+export type BaseMessageType = z.infer<typeof BASE_MESSAGE_SCHEMA>;
+export type MessageMetadataType = z.infer<typeof MESSAGE_METADATA_SCHEMA>;

package/dist/lib/messages/baseMessageSchemas.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_MESSAGE_SCHEMA = exports.MESSAGE_METADATA_SCHEMA = void 0;
+const tslib_1 = require("tslib");
+const zod_1 = tslib_1.__importDefault(require("zod"));
+const baseEventSchemas_1 = require("../events/baseEventSchemas");
+// External message metadata that describe the context in which the message was created, primarily used for debugging purposes
+exports.MESSAGE_METADATA_SCHEMA = zod_1.default
+    .object({
+    schemaVersion: zod_1.default.string().min(1).describe('message schema version'),
+    // this is always set to a service that created the message
+    producedBy: zod_1.default.string().min(1).describe('app/service that produced the message'),
+    // this is always propagated within the message chain. For the first message in the chain it is equal to "producedBy"
+    originatedFrom: zod_1.default
+        .string()
+        .min(1)
+        .describe('app/service that initiated entire workflow that led to creating this message'),
+    // this is always propagated within the message chain.
+    correlationId: zod_1.default.string().describe('unique identifier passed to all events in workflow chain'),
+})
+    .describe('external message metadata');
+exports.BASE_MESSAGE_SCHEMA = baseEventSchemas_1.BASE_EVENT_SCHEMA.extend({
+    // For internal domain events that did not originate within a message chain metadata field can be omitted, producer should then assume it is initiating a new chain
+    metadata: exports.MESSAGE_METADATA_SCHEMA.optional(),
+});
+//# sourceMappingURL=baseMessageSchemas.js.map

package/dist/lib/messages/baseMessageSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseMessageSchemas.js","sourceRoot":"","sources":["../../../lib/messages/baseMessageSchemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,iEAA8D;AAE9D,8HAA8H;AACjH,QAAA,uBAAuB,GAAG,aAAC;KACrC,MAAM,CAAC;IACN,aAAa,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACnE,2DAA2D;IAC3D,UAAU,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAC/E,qHAAqH;IACrH,cAAc,EAAE,aAAC;SACd,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,8EAA8E,CAAC;IAC3F,sDAAsD;IACtD,aAAa,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0DAA0D,CAAC;CAC/F,CAAC;KACD,QAAQ,CAAC,2BAA2B,CAAC,CAAA;AAE3B,QAAA,mBAAmB,GAAG,oCAAiB,CAAC,MAAM,CAAC;IAC1D,mKAAmK;IACnK,QAAQ,EAAE,+BAAuB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAA"}

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

@@ -12,8 +12,9 @@ type CommonQueueLocator = {
 export declare abstract class AbstractQueueService<MessagePayloadSchemas extends object, MessageEnvelopeType extends object, DependenciesType extends QueueDependencies, QueueConfiguration extends object, QueueLocatorType extends object = CommonQueueLocator, OptionsType extends QueueOptions<QueueConfiguration, QueueLocatorType> = QueueOptions<QueueConfiguration, QueueLocatorType>, ExecutionContext = undefined, PrehandlerOutput = undefined> {
     protected readonly errorReporter: ErrorReporter;
     readonly logger: Logger;
-    protected readonly messageTypeField: string;
     protected readonly messageIdField: string;
+    protected readonly messageTypeField: string;
+    protected readonly messageTimestampField: string;
     protected readonly logMessages: boolean;
     protected readonly creationConfig?: QueueConfiguration;
     protected readonly locatorConfig?: QueueLocatorType;
@@ -36,6 +37,7 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
     protected handleMessageProcessed(message: MessagePayloadSchemas | null, processingResult: MessageProcessingResult, messageId?: string): void;
     protected processPrehandlersInternal(preHandlers: Prehandler<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[], message: MessagePayloadSchemas): Promise<PrehandlerOutput>;
     protected preHandlerBarrierInternal<BarrierOutput>(barrier: BarrierCallback<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput, BarrierOutput> | undefined, message: MessagePayloadSchemas, executionContext: ExecutionContext, preHandlerOutput: PrehandlerOutput): Promise<BarrierResult<BarrierOutput>>;
+    protected tryToExtractTimestamp(message: MessagePayloadSchemas): Date | undefined;
     protected abstract resolveNextFunction(preHandlers: Prehandler<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[], message: MessagePayloadSchemas, index: number, preHandlerOutput: PrehandlerOutput, resolve: (value: PrehandlerOutput | PromiseLike<PrehandlerOutput>) => void, reject: (err: Error) => void): (preHandlerResult: PrehandlerResult) => void;
     protected resolveNextPreHandlerFunctionInternal(preHandlers: Prehandler<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[], executionContext: ExecutionContext, message: MessagePayloadSchemas, index: number, preHandlerOutput: PrehandlerOutput, resolve: (value: PrehandlerOutput | PromiseLike<PrehandlerOutput>) => void, reject: (err: Error) => void): (preHandlerResult: PrehandlerResult) => void;
     protected abstract processPrehandlers(message: MessagePayloadSchemas, messageType: string): Promise<PrehandlerOutput>;

package/dist/lib/queues/AbstractQueueService.js

@@ -3,12 +3,14 @@ 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 toDateProcessor_1 = require("../utils/toDateProcessor");
 const HandlerSpy_1 = require("./HandlerSpy");
 class AbstractQueueService {
     errorReporter;
     logger;
-    messageTypeField;
     messageIdField;
+    messageTypeField;
+    messageTimestampField;
     logMessages;
     creationConfig;
     locatorConfig;
@@ -23,8 +25,9 @@ class AbstractQueueService {
     constructor({ errorReporter, logger }, options) {
         this.errorReporter = errorReporter;
         this.logger = logger;
-        this.messageTypeField = options.messageTypeField;
         this.messageIdField = options.messageIdField ?? 'id';
+        this.messageTypeField = options.messageTypeField;
+        this.messageTimestampField = options.messageTimestampField ?? 'timestamp';
         this.creationConfig = options.creationConfig;
         this.locatorConfig = options.locatorConfig;
         this.deletionConfig = options.deletionConfig;
@@ -103,6 +106,18 @@ class AbstractQueueService {
         // @ts-ignore
         return await barrier(message, executionContext, preHandlerOutput);
     }
+    tryToExtractTimestamp(message) {
+        // @ts-ignore
+        if (this.messageTimestampField in message) {
+            // @ts-ignore
+            const res = (0, toDateProcessor_1.toDatePreprocessor)(message[this.messageTimestampField]);
+            if (!(res instanceof Date)) {
+                throw new Error(`${this.messageTimestampField} invalid type`);
+            }
+            return res;
+        }
+        return undefined;
+    }
     // eslint-disable-next-line max-params
     resolveNextPreHandlerFunctionInternal(preHandlers, executionContext, message, index, preHandlerOutput, resolve, reject) {
         return (preHandlerResult) => {

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;AAejE,6CAAgD;AAYhD,MAAsB,oBAAoB;IAarB,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,mBAAmB,CAC3B,QAAsC,EACtC,gBAAyC,EACzC,SAAkB;QAElB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf;YACE,gBAAgB;YAChB,SAAS;SACV,EACD,+BAA+B,SAAS,IAAI,cAAc,EAAE,CAC7D,CAAA;IACH,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;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,aAAa;YACb,MAAM,iBAAiB,GAAuB,OAAO,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,SAAS,CAAA;YAEzF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAA;QACxE,CAAC;IACH,CAAC;IAES,0BAA0B,CAClC,WAAoF,EACpF,OAA8B;QAE9B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,EAAsB,CAAC,CAAA;QAChD,CAAC;QAED,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC;gBACH,MAAM,gBAAgB,GAAG,EAAsB,CAAA;gBAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CACnC,WAAW,EACX,OAAO,EACP,CAAC,EACD,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CAAA;gBACD,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;YAC7B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAY,CAAC,CAAA;YACtB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAES,KAAK,CAAC,yBAAyB,CACvC,OAEa,EACb,OAA8B,EAC9B,gBAAkC,EAClC,gBAAkC;QAElC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,aAAa;YACb,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,SAAS;aAClB,CAAA;QACH,CAAC;QAED,aAAa;QACb,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;IACnE,CAAC;IAWD,sCAAsC;IAC5B,qCAAqC,CAC7C,WAAoF,EACpF,gBAAkC,EAClC,OAA8B,EAC9B,KAAa,EACb,gBAAkC,EAClC,OAA0E,EAC1E,MAA4B;QAE5B,OAAO,CAAC,gBAAkC,EAAE,EAAE;YAC5C,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC;gBACnC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACN,6DAA6D;gBAC7D,WAAW,CAAC,KAAK,CAAC,CAChB,OAAO,EACP,gBAAgB;gBAChB,aAAa;gBACb,gBAAgB,EAChB,IAAI,CAAC,qCAAqC,CACxC,WAAW,EACX,gBAAgB,EAChB,OAAO,EACP,KAAK,GAAG,CAAC,EACT,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CACF,CAAA;YACH,CAAC;QACH,CAAC,CAAA;IACH,CAAC;CAqBF;AAvOD,oDAuOC"}
+{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAMjE,8DAA6D;AAU7D,6CAAgD;AAYhD,MAAsB,oBAAoB;IAarB,aAAa,CAAe;IAC/B,MAAM,CAAQ;IACX,cAAc,CAAQ;IACtB,gBAAgB,CAAQ;IACxB,qBAAqB,CAAQ;IAC7B,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,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAA;QACpD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,IAAI,WAAW,CAAA;QACzE,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,mBAAmB,CAC3B,QAAsC,EACtC,gBAAyC,EACzC,SAAkB;QAElB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf;YACE,gBAAgB;YAChB,SAAS;SACV,EACD,+BAA+B,SAAS,IAAI,cAAc,EAAE,CAC7D,CAAA;IACH,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;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,aAAa;YACb,MAAM,iBAAiB,GAAuB,OAAO,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,SAAS,CAAA;YAEzF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAA;QACxE,CAAC;IACH,CAAC;IAES,0BAA0B,CAClC,WAAoF,EACpF,OAA8B;QAE9B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,EAAsB,CAAC,CAAA;QAChD,CAAC;QAED,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC;gBACH,MAAM,gBAAgB,GAAG,EAAsB,CAAA;gBAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CACnC,WAAW,EACX,OAAO,EACP,CAAC,EACD,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CAAA;gBACD,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;YAC7B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAY,CAAC,CAAA;YACtB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAES,KAAK,CAAC,yBAAyB,CACvC,OAEa,EACb,OAA8B,EAC9B,gBAAkC,EAClC,gBAAkC;QAElC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,aAAa;YACb,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,SAAS;aAClB,CAAA;QACH,CAAC;QAED,aAAa;QACb,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;IACnE,CAAC;IAES,qBAAqB,CAAC,OAA8B;QAC5D,aAAa;QACb,IAAI,IAAI,CAAC,qBAAqB,IAAI,OAAO,EAAE,CAAC;YAC1C,aAAa;YACb,MAAM,GAAG,GAAG,IAAA,oCAAkB,EAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAA;YACnE,IAAI,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,qBAAqB,eAAe,CAAC,CAAA;YAC/D,CAAC;YAED,OAAO,GAAG,CAAA;QACZ,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAWD,sCAAsC;IAC5B,qCAAqC,CAC7C,WAAoF,EACpF,gBAAkC,EAClC,OAA8B,EAC9B,KAAa,EACb,gBAAkC,EAClC,OAA0E,EAC1E,MAA4B;QAE5B,OAAO,CAAC,gBAAkC,EAAE,EAAE;YAC5C,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC;gBACnC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACN,6DAA6D;gBAC7D,WAAW,CAAC,KAAK,CAAC,CAChB,OAAO,EACP,gBAAgB;gBAChB,aAAa;gBACb,gBAAgB,EAChB,IAAI,CAAC,qCAAqC,CACxC,WAAW,EACX,gBAAgB,EAChB,OAAO,EACP,KAAK,GAAG,CAAC,EACT,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CACF,CAAA;YACH,CAAC;QACH,CAAC,CAAA;IACH,CAAC;CAqBF;AAxPD,oDAwPC"}

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

@@ -1,3 +1,4 @@
+import type { TransactionObservabilityManager } from '@lokalise/node-core';
 import type { ZodSchema } from 'zod';
 export interface QueueConsumer {
     start(): Promise<unknown>;
@@ -10,10 +11,7 @@ export interface SyncPublisher<MessagePayloadType> {
 export interface AsyncPublisher<MessagePayloadType, MessageOptions> {
     publish(message: MessagePayloadType, options: MessageOptions): Promise<unknown>;
 }
-export type TransactionObservabilityManager = {
-    start: (transactionSpanId: string) => unknown;
-    stop: (transactionSpanId: string) => unknown;
-};
+export { TransactionObservabilityManager };
 export type LogFn = {
     <T extends object>(obj: T, msg?: string, ...args: any[]): void;
     (obj: unknown, msg?: string, ...args: any[]): void;

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

@@ -14,6 +14,7 @@ export type QueueConsumerDependencies = {
 export type CommonQueueOptions = {
     messageTypeField: string;
     messageIdField?: string;
+    messageTimestampField?: string;
     handlerSpy?: HandlerSpy<object> | HandlerSpyParams | boolean;
     logMessages?: boolean;
     deletionConfig?: DeletionConfig;
@@ -44,5 +45,6 @@ export type DeadLetterQueueOptions<CreationConfigType extends object, QueueLocat
 export type QueueConsumerOptions<CreationConfigType extends object, QueueLocatorType extends object, DeadLetterQueueIntegrationOptions extends object, MessagePayloadSchemas extends object, ExecutionContext, PrehandlerOutput = undefined, DeadLetterQueueCreationConfigType extends object = CreationConfigType, DeadLetterQueueQueueLocatorType extends object = QueueLocatorType> = QueueOptions<CreationConfigType, QueueLocatorType> & {
     handlers: MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[];
     deadLetterQueue?: DeadLetterQueueOptions<DeadLetterQueueCreationConfigType, DeadLetterQueueQueueLocatorType, DeadLetterQueueIntegrationOptions>;
+    maxRetryDuration?: number;
 };
 export {};

package/dist/lib/utils/dateUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the retry date is exceeded
+ *
+ * @param timestamp
+ * @param maxRetryDuration max retry duration in seconds
+ */
+export declare const isRetryDateExceeded: (timestamp: Date, maxRetryDuration: number) => boolean;

package/dist/lib/utils/dateUtils.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRetryDateExceeded = void 0;
+/**
+ * Check if the retry date is exceeded
+ *
+ * @param timestamp
+ * @param maxRetryDuration max retry duration in seconds
+ */
+const isRetryDateExceeded = (timestamp, maxRetryDuration) => {
+    const lastRetryDate = new Date(timestamp.getTime() + maxRetryDuration * 1000);
+    return new Date() > lastRetryDate;
+};
+exports.isRetryDateExceeded = isRetryDateExceeded;
+//# sourceMappingURL=dateUtils.js.map

package/dist/lib/utils/dateUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dateUtils.js","sourceRoot":"","sources":["../../../lib/utils/dateUtils.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAe,EAAE,gBAAwB,EAAW,EAAE;IACxF,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,gBAAgB,GAAG,IAAI,CAAC,CAAA;IAC7E,OAAO,IAAI,IAAI,EAAE,GAAG,aAAa,CAAA;AACnC,CAAC,CAAA;AAHY,QAAA,mBAAmB,uBAG/B"}

package/dist/lib/utils/parseUtils.d.ts

@@ -1,4 +1,24 @@
 import type { Either, ErrorResolver } from '@lokalise/node-core';
 import type { ZodSchema } from 'zod';
 import type { MessageInvalidFormatError, MessageValidationError } from '../errors/Errors';
-export declare function parseMessage<T extends object>(messagePayload: unknown, schema: ZodSchema<T>, errorProcessor: ErrorResolver): Either<MessageInvalidFormatError | MessageValidationError, T>;
+export type ParseMessageResult<T> = {
+    originalMessage: T;
+    parsedMessage: T;
+};
+/**
+ * Parses a message payload using the provided schema and error processor to handle validation.
+ * The function attempts to parse the message payload based on the provided schema.
+ * If successful, it returns a success object containing the parsed message along with the original message.
+ * If an error occurs during parsing, it returns an error object processed by the error processor.
+ *
+ * In success case, it returns original and parsed messages because zod is cutting off additional fields that are not
+ * defined in the schema, and we might add extra fields on publish to be used on the consumer side.
+ * eg: timestamp to avoid infinite retries on the same message.
+ *
+ * @param messagePayload The message payload to be parsed.
+ * @param schema The Zod schema used for parsing the message payload.
+ * @param errorProcessor An error resolver function used to process any validation errors encountered during parsing.
+ *
+ * @returns Either an object indicating a successful parsing result or an error encountered during parsing.
+ */
+export declare function parseMessage<T extends object>(messagePayload: unknown, schema: ZodSchema<T>, errorProcessor: ErrorResolver): Either<MessageInvalidFormatError | MessageValidationError, ParseMessageResult<T>>;

package/dist/lib/utils/parseUtils.js

@@ -1,11 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseMessage = void 0;
+/**
+ * Parses a message payload using the provided schema and error processor to handle validation.
+ * The function attempts to parse the message payload based on the provided schema.
+ * If successful, it returns a success object containing the parsed message along with the original message.
+ * If an error occurs during parsing, it returns an error object processed by the error processor.
+ *
+ * In success case, it returns original and parsed messages because zod is cutting off additional fields that are not
+ * defined in the schema, and we might add extra fields on publish to be used on the consumer side.
+ * eg: timestamp to avoid infinite retries on the same message.
+ *
+ * @param messagePayload The message payload to be parsed.
+ * @param schema The Zod schema used for parsing the message payload.
+ * @param errorProcessor An error resolver function used to process any validation errors encountered during parsing.
+ *
+ * @returns Either an object indicating a successful parsing result or an error encountered during parsing.
+ */
 function parseMessage(messagePayload, schema, errorProcessor) {
     try {
-        return {
-            result: schema.parse(messagePayload),
-        };
+        const parsedMessage = schema.parse(messagePayload);
+        return { result: { parsedMessage, originalMessage: messagePayload } };
     }
     catch (exception) {
         return {

package/dist/lib/utils/parseUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseUtils.js","sourceRoot":"","sources":["../../../lib/utils/parseUtils.ts"],"names":[],"mappings":";;;AAKA,SAAgB,YAAY,CAC1B,cAAuB,EACvB,MAAoB,EACpB,cAA6B;IAE7B,IAAI,CAAC;QACH,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;SACrC,CAAA;IACH,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,OAAO;YACL,KAAK,EAAE,cAAc,CAAC,YAAY,CAAC,SAAS,CAAC;SAC9C,CAAA;IACH,CAAC;AACH,CAAC;AAdD,oCAcC"}
+{"version":3,"file":"parseUtils.js","sourceRoot":"","sources":["../../../lib/utils/parseUtils.ts"],"names":[],"mappings":";;;AAUA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,YAAY,CAC1B,cAAuB,EACvB,MAAoB,EACpB,cAA6B;IAE7B,IAAI,CAAC;QACH,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAElD,OAAO,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,cAAmB,EAAE,EAAE,CAAA;IAC5E,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,OAAO;YACL,KAAK,EAAE,cAAc,CAAC,YAAY,CAAC,SAAS,CAAC;SAC9C,CAAA;IACH,CAAC;AACH,CAAC;AAdD,oCAcC"}

package/dist/lib/utils/toDateProcessor.d.ts

@@ -0,0 +1 @@
+export declare const toDatePreprocessor: (value: unknown) => unknown;

package/dist/lib/utils/toDateProcessor.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDatePreprocessor = void 0;
+const toDatePreprocessor = (value) => {
+    switch (typeof value) {
+        case 'string':
+        case 'number':
+            return new Date(value);
+        default:
+            return value; // could not coerce, return the original and face the consequences during validation
+    }
+};
+exports.toDatePreprocessor = toDatePreprocessor;
+//# sourceMappingURL=toDateProcessor.js.map

package/dist/lib/utils/toDateProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toDateProcessor.js","sourceRoot":"","sources":["../../../lib/utils/toDateProcessor.ts"],"names":[],"mappings":";;;AAAO,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAE,EAAE;IACnD,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;QAExB;YACE,OAAO,KAAK,CAAA,CAAC,oFAAoF;IACrG,CAAC;AACH,CAAC,CAAA;AATY,QAAA,kBAAkB,sBAS9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "11.0.0",
+  "version": "12.1.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",
@@ -25,22 +25,23 @@
     "prepublishOnly": "npm run build:release"
   },
   "dependencies": {
-    "@lokalise/node-core": "^9.14.0",
+    "@lokalise/node-core": "^9.17.0",
     "fast-equals": "^5.0.1",
-    "toad-cache": "^3.7.0"
+    "toad-cache": "^3.7.0",
+    "zod": "^3.23.6"
   },
   "devDependencies": {
-    "@types/node": "^20.11.25",
+    "@types/node": "^20.12.8",
     "@typescript-eslint/eslint-plugin": "^7.7.1",
     "@typescript-eslint/parser": "^7.7.1",
-    "@vitest/coverage-v8": "^1.5.0",
+    "@vitest/coverage-v8": "^1.6.0",
     "del-cli": "^5.1.0",
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-vitest": "0.4.1",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5",
-    "vitest": "^1.5.0"
+    "vitest": "^1.6.0"
   },
   "homepage": "https://github.com/kibertoad/message-queue-toolkit",
   "repository": {