@message-queue-toolkit/core 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+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 { objectToBuffer } from './lib/utils/queueUtils';
+export { waitAndRetry } from './lib/utils/waitUtils';

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitAndRetry = exports.objectToBuffer = exports.AbstractQueueService = void 0;
+var AbstractQueueService_1 = require("./lib/queues/AbstractQueueService");
+Object.defineProperty(exports, "AbstractQueueService", { enumerable: true, get: function () { return AbstractQueueService_1.AbstractQueueService; } });
+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");
+Object.defineProperty(exports, "waitAndRetry", { enumerable: true, get: function () { return waitUtils_1.waitAndRetry; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

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

@@ -0,0 +1,28 @@
+import type { ErrorReporter, ErrorResolver } from '@lokalise/node-core';
+import type { ZodSchema } from 'zod';
+import type { Logger, TransactionObservabilityManager } from '../types/MessageQueueTypes';
+export type QueueDependencies = {
+    errorReporter: ErrorReporter;
+    logger: Logger;
+};
+export type QueueConsumerDependencies = {
+    consumerErrorResolver: ErrorResolver;
+    transactionObservabilityManager: TransactionObservabilityManager;
+};
+export type QueueOptions<MessagePayloadType extends object, QueueConfiguration extends object> = {
+    messageSchema: ZodSchema<MessagePayloadType>;
+    messageTypeField: string;
+    queueName: string;
+    queueConfiguration: QueueConfiguration;
+};
+export declare abstract class AbstractQueueService<MessagePayloadType extends object, DependenciesType extends QueueDependencies, QueueConfiguration extends object, OptionsType extends QueueOptions<MessagePayloadType, QueueConfiguration> = QueueOptions<MessagePayloadType, QueueConfiguration>> {
+    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 handleError(err: unknown): void;
+    abstract close(): Promise<unknown>;
+}

package/dist/lib/queues/AbstractQueueService.js

@@ -0,0 +1,30 @@
+"use strict";
+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");
+class AbstractQueueService {
+    queueName;
+    errorReporter;
+    messageSchema;
+    logger;
+    messageTypeField;
+    queueConfiguration;
+    constructor({ errorReporter, logger }, { messageSchema, messageTypeField, queueName, queueConfiguration }) {
+        this.errorReporter = errorReporter;
+        this.logger = logger;
+        this.queueName = queueName;
+        this.messageSchema = messageSchema;
+        this.messageTypeField = messageTypeField;
+        this.queueConfiguration = queueConfiguration;
+    }
+    handleError(err) {
+        const logObject = (0, node_core_1.resolveGlobalErrorLogObject)(err);
+        this.logger.error(logObject);
+        if (node_util_1.types.isNativeError(err)) {
+            this.errorReporter.report({ error: err });
+        }
+    }
+}
+exports.AbstractQueueService = AbstractQueueService;
+//# sourceMappingURL=AbstractQueueService.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,27 @@
+export interface QueueConsumer {
+    start(): Promise<unknown>;
+    close(): Promise<unknown>;
+}
+export interface SyncPublisher<MessagePayloadType> {
+    publish(message: MessagePayloadType): void;
+}
+export interface AsyncPublisher<MessagePayloadType, MessageOptions> {
+    publish(message: MessagePayloadType, options: MessageOptions): Promise<unknown>;
+}
+export type TransactionObservabilityManager = {
+    start: (transactionSpanId: string) => unknown;
+    stop: (transactionSpanId: string) => unknown;
+};
+export type LogFn = {
+    <T extends object>(obj: T, msg?: string, ...args: any[]): void;
+    (obj: unknown, msg?: string, ...args: any[]): void;
+    (msg: string, ...args: any[]): void;
+};
+export type Logger = {
+    error: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    debug: LogFn;
+    trace: LogFn;
+    fatal: LogFn;
+};

package/dist/lib/types/MessageQueueTypes.js

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

package/dist/lib/types/MessageQueueTypes.js.map

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

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

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare const objectToBuffer: <T extends object>(object: T) => Buffer;

package/dist/lib/utils/queueUtils.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectToBuffer = void 0;
+const objectToBuffer = (object) => {
+    return Buffer.from(JSON.stringify(object));
+};
+exports.objectToBuffer = objectToBuffer;
+//# sourceMappingURL=queueUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queueUtils.js","sourceRoot":"","sources":["../../../lib/utils/queueUtils.ts"],"names":[],"mappings":";;;AAAO,MAAM,cAAc,GAAG,CAAmB,MAAS,EAAU,EAAE;IACpE,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;AAC5C,CAAC,CAAA;AAFY,QAAA,cAAc,kBAE1B"}

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

@@ -0,0 +1 @@
+export declare const waitAndRetry: <T>(predicateFn: () => T, sleepTime?: number, maxRetryCount?: number) => Promise<T>;

package/dist/lib/utils/waitUtils.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitAndRetry = void 0;
+const waitAndRetry = async (predicateFn, sleepTime = 100, maxRetryCount = 0) => {
+    return new Promise((resolve, reject) => {
+        let retryCount = 0;
+        function performCheck() {
+            if (maxRetryCount !== 0 && retryCount > maxRetryCount) {
+                resolve(predicateFn());
+            }
+            Promise.resolve()
+                .then(() => {
+                return predicateFn();
+            })
+                .then((result) => {
+                if (result) {
+                    resolve(result);
+                }
+                else {
+                    retryCount++;
+                    setTimeout(performCheck, sleepTime);
+                }
+            })
+                .catch((err) => {
+                reject(err);
+            });
+        }
+        performCheck();
+    });
+};
+exports.waitAndRetry = waitAndRetry;
+//# sourceMappingURL=waitUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"waitUtils.js","sourceRoot":"","sources":["../../../lib/utils/waitUtils.ts"],"names":[],"mappings":";;;AAAO,MAAM,YAAY,GAAG,KAAK,EAC/B,WAAoB,EACpB,SAAS,GAAG,GAAG,EACf,aAAa,GAAG,CAAC,EACL,EAAE;IACd,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,SAAS,YAAY;YACnB,IAAI,aAAa,KAAK,CAAC,IAAI,UAAU,GAAG,aAAa,EAAE;gBACrD,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;aACvB;YACD,OAAO,CAAC,OAAO,EAAE;iBACd,IAAI,CAAC,GAAG,EAAE;gBACT,OAAO,WAAW,EAAE,CAAA;YACtB,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,IAAI,MAAM,EAAE;oBACV,OAAO,CAAC,MAAM,CAAC,CAAA;iBAChB;qBAAM;oBACL,UAAU,EAAE,CAAA;oBACZ,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;iBACpC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;QACN,CAAC;QAED,YAAY,EAAE,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AA9BY,QAAA,YAAY,gBA8BxB"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@message-queue-toolkit/core",
+  "version": "1.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",
+  "maintainers": [
+    {
+      "name": "Igor Savin",
+      "email": "kibertoad@gmail.com"
+    }
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "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": "",
+    "docker:start:dev": "",
+    "docker:stop:dev": "",
+    "format": "prettier --write .",
+    "prepublishOnly": "npm run build:release"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.3.1",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.43.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"
+  },
+  "homepage": "https://github.com/kibertoad/message-queue-toolkit",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kibertoad/message-queue-toolkit.git"
+  },
+  "keywords": [
+    "message",
+    "queue",
+    "queues",
+    "abstract",
+    "common",
+    "utils",
+    "sqs",
+    "amqp",
+    "rabbitmq",
+    "rabbit"
+  ],
+  "files": [
+    "README.md",
+    "LICENSE",
+    "dist/*"
+  ]
+}