@message-queue-toolkit/core 1.0.0 → 1.2.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export type { QueueConsumer, AsyncPublisher, SyncPublisher, TransactionObservabilityManager, Logger, } from './lib/types/MessageQueueTypes';
 export { AbstractQueueService } from './lib/queues/AbstractQueueService';
-export type { QueueOptions, QueueDependencies, QueueConsumerDependencies, } from './lib/queues/AbstractQueueService';
+export type { QueueOptions, QueueDependencies, QueueConsumerDependencies, Deserializer, CommonQueueLocator, } from './lib/queues/AbstractQueueService';
+export { isMessageError, MessageValidationError, MessageInvalidFormatError, } from './lib/errors/Errors';
 export { objectToBuffer } from './lib/utils/queueUtils';
 export { waitAndRetry } from './lib/utils/waitUtils';

package/dist/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitAndRetry = exports.objectToBuffer = exports.AbstractQueueService = void 0;
+exports.waitAndRetry = exports.objectToBuffer = 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");
+Object.defineProperty(exports, "isMessageError", { enumerable: true, get: function () { return Errors_1.isMessageError; } });
+Object.defineProperty(exports, "MessageValidationError", { enumerable: true, get: function () { return Errors_1.MessageValidationError; } });
+Object.defineProperty(exports, "MessageInvalidFormatError", { enumerable: true, get: function () { return Errors_1.MessageInvalidFormatError; } });
 var queueUtils_1 = require("./lib/utils/queueUtils");
 Object.defineProperty(exports, "objectToBuffer", { enumerable: true, get: function () { return queueUtils_1.objectToBuffer; } });
 var waitUtils_1 = require("./lib/utils/waitUtils");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAQA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAO7B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAQA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAS7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA"}

package/dist/lib/errors/Errors.d.ts

@@ -0,0 +1,13 @@
+import { InternalError } from '@lokalise/node-core';
+export type FreeformRecord = Record<string, any>;
+export type CommonErrorParams = {
+    message: string;
+    details?: FreeformRecord;
+};
+export declare class MessageInvalidFormatError extends InternalError {
+    constructor(params: CommonErrorParams);
+}
+export declare class MessageValidationError extends InternalError {
+    constructor(params: CommonErrorParams);
+}
+export declare function isMessageError(err: Error | undefined): err is MessageValidationError | MessageInvalidFormatError;

package/dist/lib/errors/Errors.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMessageError = exports.MessageValidationError = exports.MessageInvalidFormatError = void 0;
+const node_core_1 = require("@lokalise/node-core");
+class MessageInvalidFormatError extends node_core_1.InternalError {
+    constructor(params) {
+        super({
+            message: params.message,
+            errorCode: 'MESSAGE_INVALID_FORMAT',
+            details: params.details,
+        });
+        this.name = 'MessageInvalidFormat';
+    }
+}
+exports.MessageInvalidFormatError = MessageInvalidFormatError;
+class MessageValidationError extends node_core_1.InternalError {
+    constructor(params) {
+        super({
+            message: params.message,
+            errorCode: 'MESSAGE_VALIDATION_ERROR',
+            details: params.details,
+        });
+        this.name = 'MessageValidationError';
+    }
+}
+exports.MessageValidationError = MessageValidationError;
+function isMessageError(err) {
+    return ((err && (err.name === 'MessageValidationError' || err.name === 'MessageInvalidFormat')) ?? false);
+}
+exports.isMessageError = isMessageError;
+//# sourceMappingURL=Errors.js.map

package/dist/lib/errors/Errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../../../lib/errors/Errors.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AAUnD,MAAa,yBAA0B,SAAQ,yBAAa;IAC1D,YAAY,MAAyB;QACnC,KAAK,CAAC;YACJ,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,wBAAwB;YACnC,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC,CAAA;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAA;IACpC,CAAC;CACF;AATD,8DASC;AAED,MAAa,sBAAuB,SAAQ,yBAAa;IACvD,YAAY,MAAyB;QACnC,KAAK,CAAC;YACJ,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,0BAA0B;YACrC,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC,CAAA;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAA;IACtC,CAAC;CACF;AATD,wDASC;AAED,SAAgB,cAAc,CAC5B,GAAsB;IAEtB,OAAO,CACL,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,wBAAwB,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAsB,CAAC,CAAC,IAAI,KAAK,CACjG,CAAA;AACH,CAAC;AAND,wCAMC"}

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

@@ -1,5 +1,6 @@
-import type { ErrorReporter, ErrorResolver } from '@lokalise/node-core';
-import type { ZodSchema } from 'zod';
+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';
 export type QueueDependencies = {
     errorReporter: ErrorReporter;
@@ -9,20 +10,26 @@ export type QueueConsumerDependencies = {
     consumerErrorResolver: ErrorResolver;
     transactionObservabilityManager: TransactionObservabilityManager;
 };
-export type QueueOptions<MessagePayloadType extends object, QueueConfiguration extends object> = {
+export type Deserializer<MessagePayloadType extends object, QueueEngineMessageType extends object> = (message: QueueEngineMessageType, type: ZodType<MessagePayloadType>, errorProcessor: ErrorResolver) => Either<MessageInvalidFormatError | MessageValidationError, MessagePayloadType>;
+export type QueueOptions<MessagePayloadType extends object, QueueConfiguration extends object, QueueLocatorType extends object> = {
     messageSchema: ZodSchema<MessagePayloadType>;
     messageTypeField: string;
     queueName: string;
-    queueConfiguration: QueueConfiguration;
+    queueLocator?: QueueLocatorType;
+    queueConfiguration?: QueueConfiguration;
 };
-export declare abstract class AbstractQueueService<MessagePayloadType extends object, DependenciesType extends QueueDependencies, QueueConfiguration extends object, OptionsType extends QueueOptions<MessagePayloadType, QueueConfiguration> = QueueOptions<MessagePayloadType, QueueConfiguration>> {
+export type CommonQueueLocator = {
+    queueName: string;
+};
+export declare abstract class AbstractQueueService<MessagePayloadType extends object, DependenciesType extends QueueDependencies, QueueConfiguration extends object, QueueLocatorType extends object = CommonQueueLocator, OptionsType extends QueueOptions<MessagePayloadType, QueueConfiguration, QueueLocatorType> = QueueOptions<MessagePayloadType, QueueConfiguration, QueueLocatorType>> {
     protected readonly queueName: string;
     protected readonly errorReporter: ErrorReporter;
     protected readonly messageSchema: ZodSchema<MessagePayloadType>;
     protected readonly logger: Logger;
     protected readonly messageTypeField: string;
-    protected readonly queueConfiguration: QueueConfiguration;
-    constructor({ errorReporter, logger }: DependenciesType, { messageSchema, messageTypeField, queueName, queueConfiguration }: OptionsType);
+    protected readonly queueConfiguration?: QueueConfiguration;
+    protected readonly queueLocator?: QueueLocatorType;
+    constructor({ errorReporter, logger }: DependenciesType, { messageSchema, messageTypeField, queueName, queueConfiguration, queueLocator }: OptionsType);
     protected handleError(err: unknown): void;
     abstract close(): Promise<unknown>;
 }

package/dist/lib/queues/AbstractQueueService.js

@@ -10,13 +10,15 @@ class AbstractQueueService {
     logger;
     messageTypeField;
     queueConfiguration;
-    constructor({ errorReporter, logger }, { messageSchema, messageTypeField, queueName, queueConfiguration }) {
+    queueLocator;
+    constructor({ errorReporter, logger }, { messageSchema, messageTypeField, queueName, queueConfiguration, queueLocator }) {
         this.errorReporter = errorReporter;
         this.logger = logger;
         this.queueName = queueName;
         this.messageSchema = messageSchema;
         this.messageTypeField = messageTypeField;
         this.queueConfiguration = queueConfiguration;
+        this.queueLocator = queueLocator;
     }
     handleError(err) {
         const logObject = (0, node_core_1.resolveGlobalErrorLogObject)(err);

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;AAsBjE,MAAsB,oBAAoB;IASrB,SAAS,CAAQ;IACjB,aAAa,CAAe;IAC5B,aAAa,CAA+B;IAC5C,MAAM,CAAQ;IACd,gBAAgB,CAAQ;IACxB,kBAAkB,CAAoB;IAEzD,YACE,EAAE,aAAa,EAAE,MAAM,EAAoB,EAC3C,EAAE,aAAa,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,EAAe;QAE/E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;IAC9C,CAAC;IAES,WAAW,CAAC,GAAY;QAChC,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC5B,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;SAC1C;IACH,CAAC;CAGF;AAtCD,oDAsCC"}
+{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAyCjE,MAAsB,oBAAoB;IAWrB,SAAS,CAAQ;IACjB,aAAa,CAAe;IAC5B,aAAa,CAA+B;IAC5C,MAAM,CAAQ;IACd,gBAAgB,CAAQ;IACxB,kBAAkB,CAAqB;IACvC,YAAY,CAAmB;IAElD,YACE,EAAE,aAAa,EAAE,MAAM,EAAoB,EAC3C,EAAE,aAAa,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,EAAE,YAAY,EAAe;QAE7F,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAES,WAAW,CAAC,GAAY;QAChC,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC5B,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;SAC1C;IACH,CAAC;CAGF;AA1CD,oDA0CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "1.0.0",
+  "version": "1.2.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",
@@ -13,11 +13,12 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "del-cli dist && del-cli coverage && tsc",
     "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:ci": "npm run docker:start:dev && npm run test:coverage && npm run docker:stop:dev",
     "docker:start:dev": "",
     "docker:stop:dev": "",
     "format": "prettier --write .",
@@ -25,16 +26,16 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "^20.3.1",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
+    "@types/node": "^20.4.1",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.43.0",
+    "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.8",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   },
   "homepage": "https://github.com/kibertoad/message-queue-toolkit",
   "repository": {