@rsdk/kafka.producer 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [2.0.0](https://github.com/R-Vision/rsdk/compare/v1.0.12...v2.0.0) (2023-06-06)
+
+**Note:** Version bump only for package @rsdk/kafka.producer
+
+## 1.0.12 (2023-05-23)
+
+### Bug Fixes
+
+* remove private dependencies from `peerDependencies` section ([0bce6ff](https://github.com/R-Vision/rsdk/commit/0bce6ffb5b699e2ed1dc9aca77cbdbf085267ff7))
+
+## 1.0.11 (2023-05-23)
+
+**Note:** Version bump only for package @rsdk/kafka.producer
+
+## 1.0.10 (2023-05-22)
+
+### Bug Fixes
+
+* add "access: public" to new packages ([04d5983](https://github.com/R-Vision/rsdk/commit/04d5983cfa3e97c5d8219e07208a0499a8c6bc83))

package/dist/base.producer.d.ts

@@ -0,0 +1,9 @@
+import type { EventType } from '@rsdk/kafka.common';
+import type { KafkaProducer, OutboxTable, PublishOptions } from './types';
+export declare abstract class BaseProducer<T extends EventType> implements KafkaProducer<T> {
+    readonly eventType: T;
+    constructor(eventType: T);
+    protected getPartitionKey(payload: T, partitionKeyField: string | null): string;
+    protected parsePayload(payload: T, options?: PublishOptions): Partial<OutboxTable>;
+    abstract publish(payload: T, options?: PublishOptions | undefined): Promise<void>;
+}

package/dist/base.producer.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseProducer = void 0;
+const crypto_1 = require("crypto");
+const get_1 = __importDefault(require("lodash/get"));
+class BaseProducer {
+    eventType;
+    constructor(eventType) {
+        this.eventType = eventType;
+    }
+    getPartitionKey(payload, partitionKeyField) {
+        const partitionKey = typeof partitionKeyField === 'string' && partitionKeyField.length > 0
+            ? (0, get_1.default)(payload, partitionKeyField, (0, crypto_1.randomUUID)())
+            : (0, get_1.default)(payload, 'id') ||
+                (0, get_1.default)(payload, 'uuid') ||
+                (0, get_1.default)(payload, 'guid', (0, crypto_1.randomUUID)());
+        return String(partitionKey);
+    }
+    parsePayload(payload, options) {
+        return {
+            group: this.eventType.$group,
+            metadata: options?.metadata ? options.metadata : null,
+            partition_key: options?.partitionKey
+                ? String(options.partitionKey)
+                : this.getPartitionKey(payload, this.eventType.$partitionKeyField),
+            payload: Buffer.from(this.eventType.encode(payload).finish()),
+            type: this.eventType.$type,
+        };
+    }
+}
+exports.BaseProducer = BaseProducer;
+//# sourceMappingURL=base.producer.js.map

package/dist/base.producer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.producer.js","sourceRoot":"","sources":["../src/base.producer.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAoC;AAGpC,qDAA6B;AAI7B,MAAsB,YAAY;IAGX;IAArB,YAAqB,SAAY;QAAZ,cAAS,GAAT,SAAS,CAAG;IAAG,CAAC;IAE3B,eAAe,CACvB,OAAU,EACV,iBAAgC;QAEhC,MAAM,YAAY,GAChB,OAAO,iBAAiB,KAAK,QAAQ,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACnE,CAAC,CAAC,IAAA,aAAG,EAAC,OAAO,EAAE,iBAAiB,EAAE,IAAA,mBAAU,GAAE,CAAC;YAC/C,CAAC,CAAC,IAAA,aAAG,EAAC,OAAO,EAAE,IAAI,CAAC;gBAClB,IAAA,aAAG,EAAC,OAAO,EAAE,MAAM,CAAC;gBACpB,IAAA,aAAG,EAAC,OAAO,EAAE,MAAM,EAAE,IAAA,mBAAU,GAAE,CAAC,CAAC;QAEzC,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC;IAC9B,CAAC;IAES,YAAY,CACpB,OAAU,EACV,OAAwB;QAExB,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM;YAC5B,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;YACrD,aAAa,EAAE,OAAO,EAAE,YAAY;gBAClC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;YACpE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YAC7D,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK;SAC3B,CAAC;IACJ,CAAC;CAMF;AAtCD,oCAsCC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { BaseProducer } from './base.producer';
+export { InjectProducer } from './inject-producer.decorator';
+export { KafkaProducer, OutboxTable, PublishOptions } from './types';

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectProducer = exports.BaseProducer = void 0;
+var base_producer_1 = require("./base.producer");
+Object.defineProperty(exports, "BaseProducer", { enumerable: true, get: function () { return base_producer_1.BaseProducer; } });
+var inject_producer_decorator_1 = require("./inject-producer.decorator");
+Object.defineProperty(exports, "InjectProducer", { enumerable: true, get: function () { return inject_producer_decorator_1.InjectProducer; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,yEAA6D;AAApD,2HAAA,cAAc,OAAA"}

package/dist/inject-producer.decorator.d.ts

@@ -0,0 +1,3 @@
+import { Inject } from '@nestjs/common';
+import type { EventType } from '@rsdk/kafka.common';
+export declare const InjectProducer: <T>(eventType: EventType<T>) => ReturnType<typeof Inject>;

package/dist/inject-producer.decorator.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectProducer = void 0;
+const common_1 = require("@nestjs/common");
+const InjectProducer = (eventType) => (0, common_1.Inject)(eventType.$type);
+exports.InjectProducer = InjectProducer;
+//# sourceMappingURL=inject-producer.decorator.js.map

package/dist/inject-producer.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject-producer.decorator.js","sourceRoot":"","sources":["../src/inject-producer.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAGjC,MAAM,cAAc,GAAG,CAC5B,SAAuB,EACI,EAAE,CAAC,IAAA,eAAM,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAF3C,QAAA,cAAc,kBAE6B"}

package/dist/types.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+export interface PublishOptions {
+    metadata?: Record<string, any>;
+    partitionKey?: string | number;
+}
+export interface OutboxTable {
+    id: string;
+    type: string;
+    group: string;
+    partition_key: string;
+    metadata: Record<string, any> | null;
+    payload: Buffer;
+}
+export interface KafkaProducer<T> {
+    publish(payload: T, options?: PublishOptions | undefined): Promise<void>;
+}

package/dist/types.js

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

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@rsdk/kafka.producer",
+  "version": "2.0.0",
+  "description": "Publishers for kafka (different direct and outbox strategies)",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/microservices": "^9.0.0",
+    "@nestjs/typeorm": "^9.0.0",
+    "@rsdk/common": "^2.0.0",
+    "@rsdk/core": "^2.0.0",
+    "@rsdk/kafka.common": "^2.0.0",
+    "@rsdk/logging": "^2.0.0",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "9fe1395b8e38e1c7b9578dd5eed12e0c57a9087f"
+}

package/src/base.producer.ts

@@ -0,0 +1,46 @@
+import { randomUUID } from 'crypto';
+
+import type { EventType } from '@rsdk/kafka.common';
+import get from 'lodash/get';
+
+import type { KafkaProducer, OutboxTable, PublishOptions } from './types';
+
+export abstract class BaseProducer<T extends EventType>
+  implements KafkaProducer<T>
+{
+  constructor(readonly eventType: T) {}
+
+  protected getPartitionKey(
+    payload: T,
+    partitionKeyField: string | null,
+  ): string {
+    const partitionKey =
+      typeof partitionKeyField === 'string' && partitionKeyField.length > 0
+        ? get(payload, partitionKeyField, randomUUID())
+        : get(payload, 'id') ||
+          get(payload, 'uuid') ||
+          get(payload, 'guid', randomUUID());
+
+    return String(partitionKey);
+  }
+
+  protected parsePayload(
+    payload: T,
+    options?: PublishOptions,
+  ): Partial<OutboxTable> {
+    return {
+      group: this.eventType.$group,
+      metadata: options?.metadata ? options.metadata : null,
+      partition_key: options?.partitionKey
+        ? String(options.partitionKey)
+        : this.getPartitionKey(payload, this.eventType.$partitionKeyField),
+      payload: Buffer.from(this.eventType.encode(payload).finish()),
+      type: this.eventType.$type,
+    };
+  }
+
+  abstract publish(
+    payload: T,
+    options?: PublishOptions | undefined,
+  ): Promise<void>;
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export { BaseProducer } from './base.producer';
+export { InjectProducer } from './inject-producer.decorator';
+export { KafkaProducer, OutboxTable, PublishOptions } from './types';

package/src/inject-producer.decorator.ts

@@ -0,0 +1,6 @@
+import { Inject } from '@nestjs/common';
+import type { EventType } from '@rsdk/kafka.common';
+
+export const InjectProducer = <T>(
+  eventType: EventType<T>,
+): ReturnType<typeof Inject> => Inject(eventType.$type);

package/src/types.ts

@@ -0,0 +1,20 @@
+export interface PublishOptions {
+  // Metadata must be a plain object. Object will be stringified.
+  metadata?: Record<string, any>;
+  partitionKey?: string | number;
+}
+
+export interface OutboxTable {
+  id: string;
+  type: string;
+  group: string;
+  partition_key: string;
+  metadata: Record<string, any> | null;
+  payload: Buffer;
+}
+
+// TODO: Добавить типизацию T extends EventType. Но с текущим генерируемым кодом это не работает
+// т. к. интерфейс события по факту не экстендит EventType
+export interface KafkaProducer<T> {
+  publish(payload: T, options?: PublishOptions | undefined): Promise<void>;
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}