@message-queue-toolkit/core 3.6.0 → 4.0.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export type { QueueConsumer, AsyncPublisher, SyncPublisher, TransactionObservabilityManager, Logger, SchemaMap, } from './lib/types/MessageQueueTypes';
+export type { QueueConsumer, AsyncPublisher, SyncPublisher, TransactionObservabilityManager, Logger, LogFn, SchemaMap, ExtraParams, } from './lib/types/MessageQueueTypes';
 export { AbstractQueueService } from './lib/queues/AbstractQueueService';
 export type { NewQueueOptions, ExistingQueueOptions, NewQueueOptionsMultiSchema, ExistingQueueOptionsMultiSchema, MonoSchemaQueueOptions, MultiSchemaConsumerOptions, QueueDependencies, QueueConsumerDependencies, Deserializer, CommonQueueLocator, DeletionConfig, MultiSchemaPublisherOptions, } from './lib/queues/AbstractQueueService';
 export { isMessageError, MessageValidationError, MessageInvalidFormatError, } from './lib/errors/Errors';
-export { HandlerContainer, MessageHandlerConfig, MessageHandlerConfigBuilder, BarrierCallbackMultiConsumers, } from './lib/queues/HandlerContainer';
+export { HandlerContainer, MessageHandlerConfig, MessageHandlerConfigBuilder, BarrierCallbackMultiConsumers, BarrierResult, BarrierResultPositive, BarrierResultNegative, } from './lib/queues/HandlerContainer';
 export type { HandlerContainerOptions, Handler } from './lib/queues/HandlerContainer';
 export { MessageSchemaContainer } from './lib/queues/MessageSchemaContainer';
 export type { MessageSchemaContainerOptions } from './lib/queues/MessageSchemaContainer';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AASA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAgB7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,kEAKsC;AAJpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAK7B,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;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"}

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

@@ -1,34 +1,43 @@
 import type { Either } from '@lokalise/node-core';
 import type { ZodSchema } from 'zod';
 export type LogFormatter<MessagePayloadSchema> = (message: MessagePayloadSchema) => unknown;
-export type BarrierCallbackMultiConsumers<MessagePayloadSchema extends object, ExecutionContext> = (message: MessagePayloadSchema, context: ExecutionContext) => Promise<boolean>;
+export type BarrierResult<BarrierOutput> = BarrierResultPositive<BarrierOutput> | BarrierResultNegative;
+export type BarrierResultPositive<BarrierOutput> = {
+    isPassing: true;
+    output: BarrierOutput;
+};
+export type BarrierResultNegative = {
+    isPassing: false;
+    output?: never;
+};
+export type BarrierCallbackMultiConsumers<MessagePayloadSchema extends object, ExecutionContext, BarrierOutput> = (message: MessagePayloadSchema, context: ExecutionContext) => Promise<BarrierResult<BarrierOutput>>;
 export declare const defaultLogFormatter: <MessagePayloadSchema>(message: MessagePayloadSchema) => MessagePayloadSchema;
-export type HandlerConfigOptions<MessagePayloadSchema extends object, ExecutionContext> = {
+export type HandlerConfigOptions<MessagePayloadSchema extends object, ExecutionContext, BarrierOutput> = {
     messageLogFormatter?: LogFormatter<MessagePayloadSchema>;
-    preHandlerBarrier?: BarrierCallbackMultiConsumers<MessagePayloadSchema, ExecutionContext>;
+    preHandlerBarrier?: BarrierCallbackMultiConsumers<MessagePayloadSchema, ExecutionContext, BarrierOutput>;
 };
-export declare class MessageHandlerConfig<const MessagePayloadSchema extends object, const ExecutionContext> {
+export declare class MessageHandlerConfig<const MessagePayloadSchema extends object, const ExecutionContext, const BarrierOutput = unknown> {
     readonly schema: ZodSchema<MessagePayloadSchema>;
-    readonly handler: Handler<MessagePayloadSchema, ExecutionContext>;
+    readonly handler: Handler<MessagePayloadSchema, ExecutionContext, BarrierOutput>;
     readonly messageLogFormatter: LogFormatter<MessagePayloadSchema>;
-    readonly preHandlerBarrier?: BarrierCallbackMultiConsumers<MessagePayloadSchema, ExecutionContext>;
-    constructor(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext>, options?: HandlerConfigOptions<MessagePayloadSchema, ExecutionContext>);
+    readonly preHandlerBarrier?: BarrierCallbackMultiConsumers<MessagePayloadSchema, ExecutionContext, BarrierOutput>;
+    constructor(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext, BarrierOutput>, options?: HandlerConfigOptions<MessagePayloadSchema, ExecutionContext, BarrierOutput>);
 }
 export declare class MessageHandlerConfigBuilder<MessagePayloadSchemas extends object, ExecutionContext> {
     private readonly configs;
     constructor();
-    addConfig<MessagePayloadSchema extends MessagePayloadSchemas>(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext>, options?: HandlerConfigOptions<MessagePayloadSchema, ExecutionContext>): this;
-    build(): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext>[];
+    addConfig<MessagePayloadSchema extends MessagePayloadSchemas, const BarrierOutput>(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext, BarrierOutput>, options?: HandlerConfigOptions<MessagePayloadSchema, ExecutionContext, BarrierOutput>): this;
+    build(): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext, any>[];
 }
-export type Handler<MessagePayloadSchemas, ExecutionContext> = (message: MessagePayloadSchemas, context: ExecutionContext) => Promise<Either<'retryLater', 'success'>>;
+export type Handler<MessagePayloadSchemas, ExecutionContext, BarrierOutput = undefined> = (message: MessagePayloadSchemas, context: ExecutionContext, barrierOutput: BarrierOutput) => Promise<Either<'retryLater', 'success'>>;
 export type HandlerContainerOptions<MessagePayloadSchemas extends object, ExecutionContext> = {
-    messageHandlers: MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext>[];
+    messageHandlers: MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext, unknown>[];
     messageTypeField: string;
 };
 export declare class HandlerContainer<MessagePayloadSchemas extends object, ExecutionContext> {
     private readonly messageHandlers;
     private readonly messageTypeField;
     constructor(options: HandlerContainerOptions<MessagePayloadSchemas, ExecutionContext>);
-    resolveHandler(messageType: string): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext>;
+    resolveHandler<BarrierResult>(messageType: string): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext, BarrierResult>;
     private resolveHandlerMap;
 }

package/dist/lib/queues/HandlerContainer.js

@@ -17,13 +17,15 @@ class MessageHandlerConfig {
 }
 exports.MessageHandlerConfig = MessageHandlerConfig;
 class MessageHandlerConfigBuilder {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     configs;
     constructor() {
         this.configs = [];
     }
     addConfig(schema, handler, options) {
+        this.configs.push(new MessageHandlerConfig(schema, 
         // @ts-ignore
-        this.configs.push(new MessageHandlerConfig(schema, handler, options));
+        handler, options));
         return this;
     }
     build() {
@@ -38,12 +40,12 @@ class HandlerContainer {
         this.messageTypeField = options.messageTypeField;
         this.messageHandlers = this.resolveHandlerMap(options.messageHandlers);
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     resolveHandler(messageType) {
         const handler = this.messageHandlers[messageType];
         if (!handler) {
             throw new Error(`Unsupported message type: ${messageType}`);
         }
+        // @ts-ignore
         return handler;
     }
     resolveHandlerMap(supportedHandlers) {

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

@@ -1 +1 @@
-{"version":3,"file":"HandlerContainer.js","sourceRoot":"","sources":["../../../lib/queues/HandlerContainer.ts"],"names":[],"mappings":";;;AAUO,MAAM,mBAAmB,GAAG,CAAuB,OAA6B,EAAE,EAAE,CAAC,OAAO,CAAA;AAAtF,QAAA,mBAAmB,uBAAmE;AAOnG,MAAa,oBAAoB;IAIf,MAAM,CAAiC;IACvC,OAAO,CAAiD;IACxD,mBAAmB,CAAoC;IACvD,iBAAiB,CAGhC;IAED,YACE,MAAuC,EACvC,OAAwD,EACxD,OAAsE;QAEtE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,mBAAmB,GAAG,OAAO,EAAE,mBAAmB,IAAI,2BAAmB,CAAA;QAC9E,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAA;IACrD,CAAC;CACF;AAtBD,oDAsBC;AAED,MAAa,2BAA2B;IACrB,OAAO,CAAiE;IAEzF;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;IACnB,CAAC;IAED,SAAS,CACP,MAAuC,EACvC,OAAwD,EACxD,OAAsE;QAEtE,aAAa;QACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;QACrE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AApBD,kEAoBC;AAYD,MAAa,gBAAgB;IACV,eAAe,CAG/B;IACgB,gBAAgB,CAAQ;IAEzC,YAAY,OAAyE;QACnF,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACxE,CAAC;IAED,8DAA8D;IACvD,cAAc,CACnB,WAAmB;QAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACjD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAA;SAC5D;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,iBAAiB,CACvB,iBAAkF;QAElF,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,aAAa;YACb,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAA;YACnE,GAAG,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;YACxB,OAAO,GAAG,CAAA;QACZ,CAAC,EACD,EAAmF,CACpF,CAAA;IACH,CAAC;CACF;AApCD,4CAoCC"}
+{"version":3,"file":"HandlerContainer.js","sourceRoot":"","sources":["../../../lib/queues/HandlerContainer.ts"],"names":[],"mappings":";;;AA4BO,MAAM,mBAAmB,GAAG,CAAuB,OAA6B,EAAE,EAAE,CAAC,OAAO,CAAA;AAAtF,QAAA,mBAAmB,uBAAmE;AAenG,MAAa,oBAAoB;IAKf,MAAM,CAAiC;IACvC,OAAO,CAAgE;IACvE,mBAAmB,CAAoC;IACvD,iBAAiB,CAIhC;IAED,YACE,MAAuC,EACvC,OAAuE,EACvE,OAAqF;QAErF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,mBAAmB,GAAG,OAAO,EAAE,mBAAmB,IAAI,2BAAmB,CAAA;QAC9E,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAA;IACrD,CAAC;CACF;AAxBD,oDAwBC;AAED,MAAa,2BAA2B;IACtC,8DAA8D;IAC7C,OAAO,CAAsE;IAE9F;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;IACnB,CAAC;IAED,SAAS,CACP,MAAuC,EACvC,OAAuE,EACvE,OAAqF;QAErF,IAAI,CAAC,OAAO,CAAC,IAAI,CACf,IAAI,oBAAoB,CACtB,MAAM;QACN,aAAa;QACb,OAAO,EACP,OAAO,CACR,CACF,CAAA;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AA3BD,kEA2BC;AAaD,MAAa,gBAAgB;IACV,eAAe,CAG/B;IACgB,gBAAgB,CAAQ;IAEzC,YAAY,OAAyE;QACnF,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACxE,CAAC;IAEM,cAAc,CACnB,WAAmB;QAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACjD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAA;SAC5D;QACD,aAAa;QACb,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,iBAAiB,CACvB,iBAA2F;QAE3F,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,aAAa;YACb,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAA;YACnE,GAAG,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;YACxB,OAAO,GAAG,CAAA;QACZ,CAAC,EACD,EAA4F,CAC7F,CAAA;IACH,CAAC;CACF;AApCD,4CAoCC"}

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

@@ -18,6 +18,9 @@ export type LogFn = {
     (obj: unknown, msg?: string, ...args: any[]): void;
     (msg: string, ...args: any[]): void;
 };
+export type ExtraParams = {
+    logger?: Logger;
+};
 export type Logger = {
     error: LogFn;
     info: LogFn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "3.6.0",
+  "version": "4.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",
@@ -26,16 +26,16 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "^20.4.1",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
+    "@types/node": "^20.7.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
     "del-cli": "^5.0.0",
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^5.0.0",
     "prettier": "^3.0.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   },
   "homepage": "https://github.com/kibertoad/message-queue-toolkit",
   "repository": {