@rsdk/kafka.common 3.6.0-next.0 → 3.6.0-next.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.6.0-next.3](https://github.com/R-Vision/rsdk/compare/v3.6.0-next.2...v3.6.0-next.3) (2023-10-11)
+
+**Note:** Version bump only for package @rsdk/kafka.common
+
+## [3.6.0-next.2](https://github.com/R-Vision/rsdk/compare/v3.6.0-next.1...v3.6.0-next.2) (2023-10-10)
+
+**Note:** Version bump only for package @rsdk/kafka.common
+
 ## [3.6.0-next.0](https://github.com/R-Vision/rsdk/compare/v3.5.0...v3.6.0-next.0) (2023-10-06)
 
 **Note:** Version bump only for package @rsdk/kafka.common

package/dist/exceptions/payload-format-validator.exception.d.ts

@@ -0,0 +1,4 @@
+import { BootstrapException } from '@rsdk/core';
+export declare class InvalidPayloadFormatException extends BootstrapException {
+    constructor(value: string, allowedValues: string[]);
+}

package/dist/exceptions/payload-format-validator.exception.js

@@ -0,0 +1,30 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidPayloadFormatException = void 0;
+const common_1 = require("@rsdk/common");
+const core_1 = require("@rsdk/core");
+let InvalidPayloadFormatException = exports.InvalidPayloadFormatException = class InvalidPayloadFormatException extends core_1.BootstrapException {
+    constructor(value, allowedValues) {
+        super((0, common_1.text) `
+    PayloadFormat has wrong value: ${value}, allowed: ${allowedValues.join(',')}.
+    `);
+    }
+};
+exports.InvalidPayloadFormatException = InvalidPayloadFormatException = __decorate([
+    (0, core_1.Exception)({
+        description: (0, common_1.text) `
+  PayloadFormat has wrong value.
+  `,
+    }),
+    __metadata("design:paramtypes", [String, Array])
+], InvalidPayloadFormatException);
+//# sourceMappingURL=payload-format-validator.exception.js.map

package/dist/exceptions/payload-format-validator.exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-format-validator.exception.js","sourceRoot":"","sources":["../../src/exceptions/payload-format-validator.exception.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAoC;AACpC,qCAA2D;AAOpD,IAAM,6BAA6B,2CAAnC,MAAM,6BAA8B,SAAQ,yBAAkB;IACnE,YAAY,KAAa,EAAE,aAAuB;QAChD,KAAK,CAAC,IAAA,aAAI,EAAA;qCACuB,KAAK,cAAc,aAAa,CAAC,IAAI,CACpE,GAAG,CACJ;KACA,CAAC,CAAC;IACL,CAAC;CACF,CAAA;wCARY,6BAA6B;IALzC,IAAA,gBAAS,EAAC;QACT,WAAW,EAAE,IAAA,aAAI,EAAA;;GAEhB;KACF,CAAC;;GACW,6BAA6B,CAQzC"}

package/dist/index.d.ts

@@ -9,3 +9,6 @@ export { ServerKafkaExceptionFactory } from './exception';
 export { createLoggerAdapter } from './create-logger-adapter.fn';
 export { getTopicName, isEventType, EventType } from './event.type';
 export { KafkaHealthcheck } from './client/kafka.healthcheck';
+export * from './payload-format';
+export * from './exceptions/payload-format-validator.exception';
+export * from './validators/payload-format.validator';

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KafkaHealthcheck = exports.isEventType = exports.getTopicName = exports.createLoggerAdapter = exports.ServerKafkaExceptionFactory = exports.KafkaTopicType = exports.KAFKA_TOPIC_RSDK_METADATA_SCOPE = exports.KafkaMetadataProvider = exports.KafkaMetadataModule = exports.KafkaConfig = exports.KafkaClientModule = exports.KAFKA_CLIENT_INJECTION_TOKEN = exports.KAFKA_PRODUCER_INJECTION_TOKEN = exports.retryPolicy = void 0;
 var retry_policy_1 = require("./retry-policy");
@@ -26,4 +40,7 @@ Object.defineProperty(exports, "getTopicName", { enumerable: true, get: function
 Object.defineProperty(exports, "isEventType", { enumerable: true, get: function () { return event_type_1.isEventType; } });
 var kafka_healthcheck_1 = require("./client/kafka.healthcheck");
 Object.defineProperty(exports, "KafkaHealthcheck", { enumerable: true, get: function () { return kafka_healthcheck_1.KafkaHealthcheck; } });
+__exportStar(require("./payload-format"), exports);
+__exportStar(require("./exceptions/payload-format-validator.exception"), exports);
+__exportStar(require("./validators/payload-format.validator"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AAEpB,sDAG+B;AAF7B,8HAAA,8BAA8B,OAAA;AAC9B,4HAAA,4BAA4B,OAAA;AAG9B,oEAAiE;AAAxD,wHAAA,iBAAiB,OAAA;AAE1B,sDAAoD;AAA3C,2GAAA,WAAW,OAAA;AAEpB,0EAAuE;AAA9D,4HAAA,mBAAmB,OAAA;AAE5B,8EAA2E;AAAlE,gIAAA,qBAAqB,OAAA;AAC9B,4DAImC;AAHjC,iIAAA,+BAA+B,OAAA;AAE/B,gHAAA,cAAc,OAAA;AAGhB,yCAA0D;AAAjD,wHAAA,2BAA2B,OAAA;AAEpC,uEAAiE;AAAxD,+HAAA,mBAAmB,OAAA;AAE5B,2CAAoE;AAA3D,0GAAA,YAAY,OAAA;AAAE,yGAAA,WAAW,OAAA;AAElC,gEAA8D;AAArD,qHAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AAEpB,sDAG+B;AAF7B,8HAAA,8BAA8B,OAAA;AAC9B,4HAAA,4BAA4B,OAAA;AAG9B,oEAAiE;AAAxD,wHAAA,iBAAiB,OAAA;AAE1B,sDAAoD;AAA3C,2GAAA,WAAW,OAAA;AAEpB,0EAAuE;AAA9D,4HAAA,mBAAmB,OAAA;AAE5B,8EAA2E;AAAlE,gIAAA,qBAAqB,OAAA;AAC9B,4DAImC;AAHjC,iIAAA,+BAA+B,OAAA;AAE/B,gHAAA,cAAc,OAAA;AAGhB,yCAA0D;AAAjD,wHAAA,2BAA2B,OAAA;AAEpC,uEAAiE;AAAxD,+HAAA,mBAAmB,OAAA;AAE5B,2CAAoE;AAA3D,0GAAA,YAAY,OAAA;AAAE,yGAAA,WAAW,OAAA;AAElC,gEAA8D;AAArD,qHAAA,gBAAgB,OAAA;AAEzB,mDAAiC;AACjC,kFAAgE;AAChE,wEAAsD"}

package/dist/payload-format.d.ts

@@ -0,0 +1,6 @@
+export declare enum PayloadFormat {
+    PROTOBUF = "protobuf",
+    JSON = "json"
+}
+export declare const X_FORMAT_HEADER = "X-Format";
+export declare const DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;

package/dist/payload-format.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_PAYLOAD_FORMAT = exports.X_FORMAT_HEADER = exports.PayloadFormat = void 0;
+var PayloadFormat;
+(function (PayloadFormat) {
+    PayloadFormat["PROTOBUF"] = "protobuf";
+    PayloadFormat["JSON"] = "json";
+})(PayloadFormat || (exports.PayloadFormat = PayloadFormat = {}));
+exports.X_FORMAT_HEADER = 'X-Format';
+exports.DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;
+//# sourceMappingURL=payload-format.js.map

package/dist/payload-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-format.js","sourceRoot":"","sources":["../src/payload-format.ts"],"names":[],"mappings":";;;AAAA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAEY,QAAA,eAAe,GAAG,UAAU,CAAC;AAE7B,QAAA,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC"}

package/dist/validators/payload-format.validator.d.ts

@@ -0,0 +1,3 @@
+import { PayloadFormat } from '../payload-format';
+export declare const isValidPayloadFormat: (value: string | PayloadFormat) => value is PayloadFormat;
+export declare const assertIsPayloadFormat: (value: PayloadFormat | string) => asserts value is PayloadFormat;

package/dist/validators/payload-format.validator.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsPayloadFormat = exports.isValidPayloadFormat = void 0;
+const payload_format_validator_exception_1 = require("../exceptions/payload-format-validator.exception");
+const payload_format_1 = require("../payload-format");
+const isValidPayloadFormat = (value) => Object.values(payload_format_1.PayloadFormat).includes(value);
+exports.isValidPayloadFormat = isValidPayloadFormat;
+const assertIsPayloadFormat = (value) => {
+    if (!(0, exports.isValidPayloadFormat)(value)) {
+        throw new payload_format_validator_exception_1.InvalidPayloadFormatException(value, Object.values(payload_format_1.PayloadFormat));
+    }
+};
+exports.assertIsPayloadFormat = assertIsPayloadFormat;
+//# sourceMappingURL=payload-format.validator.js.map

package/dist/validators/payload-format.validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-format.validator.js","sourceRoot":"","sources":["../../src/validators/payload-format.validator.ts"],"names":[],"mappings":";;;AAAA,yGAAiG;AACjG,sDAAkD;AAE3C,MAAM,oBAAoB,GAAG,CAClC,KAA6B,EACL,EAAE,CAC1B,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAC,CAAC,QAAQ,CAAC,KAAsB,CAAC,CAAC;AAHnD,QAAA,oBAAoB,wBAG+B;AAEzD,MAAM,qBAAqB,GAAG,CACnC,KAA6B,EACG,EAAE;IAClC,IAAI,CAAC,IAAA,4BAAoB,EAAC,KAAK,CAAC,EAAE;QAChC,MAAM,IAAI,kEAA6B,CACrC,KAAK,EACL,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAC,CAC7B,CAAC;KACH;AACH,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/kafka.common",
-  "version": "3.6.0-next.0",
+  "version": "3.6.0-next.3",
   "description": "Common functionality for kafka consumers and producers",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -14,7 +14,7 @@
     "@nestjs/common": "^10.1.3",
     "@nestjs/microservices": "^10.1.3",
     "@rsdk/common": "^3.5.0",
-    "@rsdk/core": "^3.6.0-next.0",
+    "@rsdk/core": "^3.6.0-next.2",
     "@rsdk/logging": "^3.5.0",
     "@rsdk/metadata": "^3.6.0-next.0",
     "kafkajs": "^2.2.4",
@@ -24,5 +24,5 @@
   "dependencies": {
     "protobufjs": "^7.2.3"
   },
-  "gitHead": "961a3b1b9097af0d1a7163a8471bba09b67158c2"
+  "gitHead": "9568fb812dd4f326c98f14cbc6f2b6902a0968f0"
 }

package/src/exceptions/payload-format-validator.exception.ts

@@ -0,0 +1,17 @@
+import { text } from '@rsdk/common';
+import { BootstrapException, Exception } from '@rsdk/core';
+
+@Exception({
+  description: text`
+  PayloadFormat has wrong value.
+  `,
+})
+export class InvalidPayloadFormatException extends BootstrapException {
+  constructor(value: string, allowedValues: string[]) {
+    super(text`
+    PayloadFormat has wrong value: ${value}, allowed: ${allowedValues.join(
+      ',',
+    )}.
+    `);
+  }
+}

package/src/index.ts

@@ -25,3 +25,7 @@ export { createLoggerAdapter } from './create-logger-adapter.fn';
 export { getTopicName, isEventType, EventType } from './event.type';
 
 export { KafkaHealthcheck } from './client/kafka.healthcheck';
+
+export * from './payload-format';
+export * from './exceptions/payload-format-validator.exception';
+export * from './validators/payload-format.validator';

package/src/payload-format.ts

@@ -0,0 +1,8 @@
+export enum PayloadFormat {
+  PROTOBUF = 'protobuf',
+  JSON = 'json',
+}
+
+export const X_FORMAT_HEADER = 'X-Format';
+
+export const DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;

package/src/validators/payload-format.validator.ts

@@ -0,0 +1,18 @@
+import { InvalidPayloadFormatException } from '../exceptions/payload-format-validator.exception';
+import { PayloadFormat } from '../payload-format';
+
+export const isValidPayloadFormat = (
+  value: string | PayloadFormat,
+): value is PayloadFormat =>
+  Object.values(PayloadFormat).includes(value as PayloadFormat);
+
+export const assertIsPayloadFormat = (
+  value: PayloadFormat | string,
+): asserts value is PayloadFormat => {
+  if (!isValidPayloadFormat(value)) {
+    throw new InvalidPayloadFormatException(
+      value,
+      Object.values(PayloadFormat),
+    );
+  }
+};