@rsdk/kafka.producer.outbox 4.0.0-next.10

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [4.0.0-next.10](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.9...v4.0.0-next.10) (2023-11-29)
+
+**Note:** Version bump only for package @rsdk/kafka.producer.outbox
+
+## [4.0.0-next.9](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.8...v4.0.0-next.9) (2023-11-29)
+
+**Note:** Version bump only for package @rsdk/kafka.producer.outbox
+
+## [4.0.0-next.8](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.7...v4.0.0-next.8) (2023-11-29)
+
+### Features
+
+* Kafka batch producer ([#150](https://github.com/R-Vision/rsdk/issues/150)) ([2faa2f4](https://github.com/R-Vision/rsdk/commit/2faa2f41ca0dbb6d8a92cbf0ab20cf5cefeaf4e9))

package/dist/constants.d.ts

@@ -0,0 +1,11 @@
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+/**
+ * Имя outbox-таблицы по умолчанию
+ */
+export declare const DEFAULT_OUTBOX_TABLE_NAME = "outbox";
+export declare const OUTBOX_FACTORY_PROVIDER_TOKEN = "OUTBOX_FACTORY_PROVIDER";
+export declare const BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN = "BATCH_OUTBOX_FACTORY_PROVIDER";
+export declare const createOutboxProducerToken: <T extends EventType<any>>(eventType: T) => string;
+export declare const createOutboxBatchProducerToken: <T extends MaybeReadonlyArray<EventType<any>>>(eventType: T) => string;
+export declare const OUTBOX_RSDK_METADATA_SCOPE = "OUTBOX_RSDK_METADATA_SCOPE";

package/dist/constants.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OUTBOX_RSDK_METADATA_SCOPE = exports.createOutboxBatchProducerToken = exports.createOutboxProducerToken = exports.BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN = exports.OUTBOX_FACTORY_PROVIDER_TOKEN = exports.DEFAULT_OUTBOX_TABLE_NAME = void 0;
+const common_1 = require("@rsdk/common");
+/**
+ * Имя outbox-таблицы по умолчанию
+ */
+exports.DEFAULT_OUTBOX_TABLE_NAME = 'outbox';
+exports.OUTBOX_FACTORY_PROVIDER_TOKEN = 'OUTBOX_FACTORY_PROVIDER';
+exports.BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN = 'BATCH_OUTBOX_FACTORY_PROVIDER';
+const createOutboxProducerToken = (eventType) => `KAFKA_OUTBOX_PRODUCER_${common_1.Case.toUpperSnake(eventType.$type)}`;
+exports.createOutboxProducerToken = createOutboxProducerToken;
+const createOutboxBatchProducerToken = (eventType) => `KAFKA_OUTBOX_BATCH_PRODUCER_${common_1.Case.toUpperSnake(eventType
+    .map((e) => e.$type)
+    .sort()
+    .join('_'))}`;
+exports.createOutboxBatchProducerToken = createOutboxBatchProducerToken;
+exports.OUTBOX_RSDK_METADATA_SCOPE = 'OUTBOX_RSDK_METADATA_SCOPE';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AAIpC;;GAEG;AACU,QAAA,yBAAyB,GAAG,QAAQ,CAAC;AACrC,QAAA,6BAA6B,GAAG,yBAAyB,CAAC;AAC1D,QAAA,mCAAmC,GAC9C,+BAA+B,CAAC;AAC3B,MAAM,yBAAyB,GAAG,CACvC,SAAY,EACJ,EAAE,CAAC,yBAAyB,aAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AAF9D,QAAA,yBAAyB,6BAEqC;AAEpE,MAAM,8BAA8B,GAAG,CAG5C,SAAY,EACJ,EAAE,CACV,+BAA+B,aAAI,CAAC,YAAY,CAC9C,SAAS;KACN,GAAG,CAAC,CAAC,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;KAC9B,IAAI,EAAE;KACN,IAAI,CAAC,GAAG,CAAC,CACb,EAAE,CAAC;AAVO,QAAA,8BAA8B,kCAUrC;AACO,QAAA,0BAA0B,GAAG,4BAA4B,CAAC"}

package/dist/decorator.d.ts

@@ -0,0 +1,4 @@
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+export declare const InjectOutboxProducer: (eventType: EventType) => ParameterDecorator;
+export declare const InjectOutboxBatchProducer: (eventType: MaybeReadonlyArray<EventType>) => ParameterDecorator;

package/dist/decorator.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectOutboxBatchProducer = exports.InjectOutboxProducer = void 0;
+const common_1 = require("@nestjs/common");
+const metadata_1 = require("@rsdk/metadata");
+const constants_1 = require("./constants");
+const outbox_module_generator_1 = require("./outbox.module-generator");
+const InjectOutboxProducer = (eventType) => {
+    return (target, propertyKey, parameterIndex) => {
+        const producerToken = (0, constants_1.createOutboxProducerToken)(eventType);
+        (0, common_1.Inject)(producerToken)(target, propertyKey, parameterIndex);
+        metadata_1.RsdkMetadata.setWithScope(target, metadata_1.PLATFORM_RAW_GLOBAL_METADATA_SCOPE, producerToken, outbox_module_generator_1.OutboxModuleGenerator.createOutboxModuleDefinition(eventType), true);
+    };
+};
+exports.InjectOutboxProducer = InjectOutboxProducer;
+const InjectOutboxBatchProducer = (eventType) => {
+    return (target, propertyKey, parameterIndex) => {
+        const batchProducerToken = (0, constants_1.createOutboxBatchProducerToken)(eventType);
+        (0, common_1.Inject)(batchProducerToken)(target, propertyKey, parameterIndex);
+        metadata_1.RsdkMetadata.setWithScope(target, metadata_1.PLATFORM_RAW_GLOBAL_METADATA_SCOPE, batchProducerToken, outbox_module_generator_1.OutboxModuleGenerator.createBatchOutboxModuleDefinition(eventType), true);
+    };
+};
+exports.InjectOutboxBatchProducer = InjectOutboxBatchProducer;
+//# sourceMappingURL=decorator.js.map

package/dist/decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAGxC,6CAGwB;AAExB,2CAGqB;AACrB,uEAAkE;AAE3D,MAAM,oBAAoB,GAAG,CAClC,SAAoB,EACA,EAAE;IACtB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;QAC7C,MAAM,aAAa,GAAG,IAAA,qCAAyB,EAAC,SAAS,CAAC,CAAC;QAE3D,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QAC3D,uBAAY,CAAC,YAAY,CACvB,MAAM,EACN,6CAAkC,EAClC,aAAa,EACb,+CAAqB,CAAC,4BAA4B,CAAC,SAAS,CAAC,EAC7D,IAAI,CACL,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,oBAAoB,wBAe/B;AAEK,MAAM,yBAAyB,GAAG,CACvC,SAAwC,EACpB,EAAE;IACtB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;QAC7C,MAAM,kBAAkB,GAAG,IAAA,0CAA8B,EAAC,SAAS,CAAC,CAAC;QAErE,IAAA,eAAM,EAAC,kBAAkB,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QAChE,uBAAY,CAAC,YAAY,CACvB,MAAM,EACN,6CAAkC,EAClC,kBAAkB,EAClB,+CAAqB,CAAC,iCAAiC,CAAC,SAAS,CAAC,EAClE,IAAI,CACL,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,yBAAyB,6BAepC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { InjectOutboxProducer, InjectOutboxBatchProducer } from './decorator';
+export * from './outbox-events.factory';
+export * from './constants';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,24 @@
+"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.InjectOutboxBatchProducer = exports.InjectOutboxProducer = void 0;
+var decorator_1 = require("./decorator");
+Object.defineProperty(exports, "InjectOutboxProducer", { enumerable: true, get: function () { return decorator_1.InjectOutboxProducer; } });
+Object.defineProperty(exports, "InjectOutboxBatchProducer", { enumerable: true, get: function () { return decorator_1.InjectOutboxBatchProducer; } });
+__exportStar(require("./outbox-events.factory"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./types"), exports);
+//# 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,yCAA8E;AAArE,iHAAA,oBAAoB,OAAA;AAAE,sHAAA,yBAAyB,OAAA;AAExD,0DAAwC;AACxC,8CAA4B;AAC5B,0CAAwB"}

package/dist/outbox-events.factory.d.ts

@@ -0,0 +1,10 @@
+import type { EventPayload, EventType } from '@rsdk/kafka.common';
+import type { PublishOptions } from '@rsdk/kafka.producer';
+import { EventsFactory } from '@rsdk/kafka.producer';
+import type { OutboxTable } from './types';
+/**
+ * Подготавливает данные для вставки в таблицу outbox
+ */
+export declare class OutboxEventsFactory<E extends EventType> extends EventsFactory<E, OutboxTable> {
+    create<P extends EventPayload<E> = EventPayload<E>>(payload: P, options?: PublishOptions): OutboxTable;
+}

package/dist/outbox-events.factory.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutboxEventsFactory = void 0;
+const kafka_producer_1 = require("@rsdk/kafka.producer");
+const node_crypto_1 = require("node:crypto");
+/**
+ * Подготавливает данные для вставки в таблицу outbox
+ */
+class OutboxEventsFactory extends kafka_producer_1.EventsFactory {
+    create(payload, options) {
+        return {
+            id: (0, node_crypto_1.randomUUID)(),
+            group: this.eventType.$group,
+            metadata: this.getMetadata(options?.metadata),
+            partition_key: this.getPartitionKey(this.eventType, options),
+            payload: this.serializePayload(payload),
+            type: this.eventType.$type,
+        };
+    }
+}
+exports.OutboxEventsFactory = OutboxEventsFactory;
+//# sourceMappingURL=outbox-events.factory.js.map

package/dist/outbox-events.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbox-events.factory.js","sourceRoot":"","sources":["../src/outbox-events.factory.ts"],"names":[],"mappings":";;;AAEA,yDAAqD;AACrD,6CAAyC;AAIzC;;GAEG;AACH,MAAa,mBAAyC,SAAQ,8BAG7D;IACC,MAAM,CACJ,OAAU,EACV,OAAwB;QAExB,OAAO;YACL,EAAE,EAAE,IAAA,wBAAU,GAAE;YAChB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM;YAC5B,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC;YAC7C,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC;YAC5D,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;YACvC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK;SAC3B,CAAC;IACJ,CAAC;CACF;AAjBD,kDAiBC"}

package/dist/outbox.autodoc-resolver.d.ts

@@ -0,0 +1,8 @@
+import type { DocumentResolver } from '@rsdk/autodoc.protocol';
+import { Composite } from '@rsdk/autodoc.protocol';
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
+declare class OutboxAutodocResolver implements DocumentResolver {
+    getNode(rsdkMetadataProvider: RsdkMetadataProvider): Composite | null;
+}
+export declare const outboxAutodocResolver: OutboxAutodocResolver;
+export {};

package/dist/outbox.autodoc-resolver.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.outboxAutodocResolver = void 0;
+const autodoc_protocol_1 = require("@rsdk/autodoc.protocol");
+const kafka_common_1 = require("@rsdk/kafka.common");
+const constants_1 = require("./constants");
+class OutboxAutodocResolver {
+    getNode(rsdkMetadataProvider) {
+        const resources = rsdkMetadataProvider.get(constants_1.OUTBOX_RSDK_METADATA_SCOPE);
+        if (!resources) {
+            return null;
+        }
+        return new autodoc_protocol_1.Composite(new autodoc_protocol_1.Table(resources.map((resource) => {
+            const { $type, $partitionKeyField } = resource.value.eventType;
+            return {
+                Type: $type,
+                TopicName: (0, kafka_common_1.getTopicName)(resource.value.eventType),
+                PartitionKeyField: $partitionKeyField ?? '-',
+            };
+        })), 'Kafka outbox');
+    }
+}
+exports.outboxAutodocResolver = new OutboxAutodocResolver();
+//# sourceMappingURL=outbox.autodoc-resolver.js.map

package/dist/outbox.autodoc-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbox.autodoc-resolver.js","sourceRoot":"","sources":["../src/outbox.autodoc-resolver.ts"],"names":[],"mappings":";;;AACA,6DAA0D;AAC1D,qDAAkD;AAGlD,2CAAyD;AAGzD,MAAM,qBAAqB;IACzB,OAAO,CAAC,oBAA0C;QAChD,MAAM,SAAS,GAAG,oBAAoB,CAAC,GAAG,CACxC,sCAA0B,CAC3B,CAAC;QAEF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,IAAI,CAAC;SACb;QAED,OAAO,IAAI,4BAAS,CAClB,IAAI,wBAAK,CACP,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACzB,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;YAE/D,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,SAAS,EAAE,IAAA,2BAAY,EAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;gBACjD,iBAAiB,EAAE,kBAAkB,IAAI,GAAG;aAC7C,CAAC;QACJ,CAAC,CAAC,CACH,EACD,cAAc,CACf,CAAC;IACJ,CAAC;CACF;AAEY,QAAA,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC"}

package/dist/outbox.module-generator.d.ts

@@ -0,0 +1,7 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+export declare class OutboxModuleGenerator {
+    static createOutboxModuleDefinition(eventType: EventType): DynamicModule;
+    static createBatchOutboxModuleDefinition(eventTypes: MaybeReadonlyArray<EventType>): DynamicModule;
+}

package/dist/outbox.module-generator.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutboxModuleGenerator = void 0;
+const autodoc_protocol_1 = require("@rsdk/autodoc.protocol");
+const kafka_producer_1 = require("@rsdk/kafka.producer");
+const metadata_1 = require("@rsdk/metadata");
+const omit_1 = __importDefault(require("lodash/omit"));
+const constants_1 = require("./constants");
+const outbox_autodoc_resolver_1 = require("./outbox.autodoc-resolver");
+class OutboxModuleGenerator {
+    static createOutboxModuleDefinition(eventType) {
+        const providers = [
+            {
+                inject: [constants_1.OUTBOX_FACTORY_PROVIDER_TOKEN, kafka_producer_1.ProducerConfig],
+                /**
+                 * TODO: А если пользователь будет использовать одновременно knex и typeorm?
+                 * Сейчас произойдёт неопределённое поведение. А надо наверное ошибку кидать?
+                 * (В целом следуем концепции того что в приложении не должно быть два плагина для работы с СУБД)
+                 */
+                provide: (0, constants_1.createOutboxProducerToken)(eventType),
+                useFactory: (outboxProducerFactory, config) => outboxProducerFactory.createProducer(eventType, config),
+            },
+        ];
+        const moduleDef = {
+            providers,
+            module: OutboxModuleGenerator,
+            exports: providers,
+        };
+        const rsdkMetadata = new metadata_1.RsdkMetadata(moduleDef, constants_1.OUTBOX_RSDK_METADATA_SCOPE);
+        rsdkMetadata.add({
+            eventType,
+            eventData: (0, omit_1.default)(eventType, 'toJSON'),
+        });
+        autodoc_protocol_1.AutodocMetadata.defineResolver(moduleDef, constants_1.OUTBOX_RSDK_METADATA_SCOPE, outbox_autodoc_resolver_1.outboxAutodocResolver);
+        return moduleDef;
+    }
+    static createBatchOutboxModuleDefinition(eventTypes) {
+        const providers = [
+            {
+                inject: [constants_1.BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN, kafka_producer_1.ProducerConfig],
+                /**
+                 * TODO: А если пользователь будет использовать одновременно knex и typeorm?
+                 * Сейчас произойдёт неопределённое поведение. А надо наверное ошибку кидать?
+                 * (В целом следуем концепции того что в приложении не должно быть два плагина для работы с СУБД)
+                 */
+                provide: (0, constants_1.createOutboxBatchProducerToken)(eventTypes),
+                useFactory: (outboxProducerFactory, config) => outboxProducerFactory.createBatchProducer(eventTypes, config),
+            },
+        ];
+        const moduleDef = {
+            providers,
+            module: OutboxModuleGenerator,
+            exports: providers,
+        };
+        const rsdkMetadata = new metadata_1.RsdkMetadata(moduleDef, constants_1.OUTBOX_RSDK_METADATA_SCOPE);
+        for (const eventType of eventTypes) {
+            rsdkMetadata.add({
+                eventType: eventType,
+                eventData: (0, omit_1.default)(eventType, 'toJSON'),
+            });
+        }
+        autodoc_protocol_1.AutodocMetadata.defineResolver(moduleDef, constants_1.OUTBOX_RSDK_METADATA_SCOPE, outbox_autodoc_resolver_1.outboxAutodocResolver);
+        return moduleDef;
+    }
+}
+exports.OutboxModuleGenerator = OutboxModuleGenerator;
+//# sourceMappingURL=outbox.module-generator.js.map

package/dist/outbox.module-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbox.module-generator.js","sourceRoot":"","sources":["../src/outbox.module-generator.ts"],"names":[],"mappings":";;;;;;AACA,6DAAyD;AAIzD,yDAAsD;AACtD,6CAA8C;AAC9C,uDAA+B;AAE/B,2CAMqB;AACrB,uEAAkE;AAOlE,MAAa,qBAAqB;IAChC,MAAM,CAAC,4BAA4B,CAAC,SAAoB;QACtD,MAAM,SAAS,GAAG;YAChB;gBACE,MAAM,EAAE,CAAC,yCAA6B,EAAE,+BAAc,CAAC;gBACvD;;;;mBAIG;gBACH,OAAO,EAAE,IAAA,qCAAyB,EAAC,SAAS,CAAC;gBAC7C,UAAU,EAAE,CACV,qBAAiD,EACjD,MAAsB,EACI,EAAE,CAC5B,qBAAqB,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC;aAC1D;SACF,CAAC;QACF,MAAM,SAAS,GAAkB;YAC/B,SAAS;YACT,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE,SAAS;SACnB,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,uBAAY,CACnC,SAAS,EACT,sCAA0B,CAC3B,CAAC;QAEF,YAAY,CAAC,GAAG,CAAC;YACf,SAAS;YACT,SAAS,EAAE,IAAA,cAAI,EAAC,SAAS,EAAE,QAAQ,CAAC;SACrC,CAAC,CAAC;QAEH,kCAAe,CAAC,cAAc,CAC5B,SAAS,EACT,sCAA0B,EAC1B,+CAAqB,CACtB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,iCAAiC,CACtC,UAAyC;QAEzC,MAAM,SAAS,GAAG;YAChB;gBACE,MAAM,EAAE,CAAC,+CAAmC,EAAE,+BAAc,CAAC;gBAC7D;;;;mBAIG;gBACH,OAAO,EAAE,IAAA,0CAA8B,EAAC,UAAU,CAAC;gBACnD,UAAU,EAAE,CACV,qBAAsD,EACtD,MAAsB,EACI,EAAE,CAC5B,qBAAqB,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC;aAChE;SACF,CAAC;QACF,MAAM,SAAS,GAAkB;YAC/B,SAAS;YACT,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE,SAAS;SACnB,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,uBAAY,CACnC,SAAS,EACT,sCAA0B,CAC3B,CAAC;QAEF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,YAAY,CAAC,GAAG,CAAC;gBACf,SAAS,EAAE,SAAS;gBACpB,SAAS,EAAE,IAAA,cAAI,EAAC,SAAS,EAAE,QAAQ,CAAC;aACrC,CAAC,CAAC;SACJ;QAED,kCAAe,CAAC,cAAc,CAC5B,SAAS,EACT,sCAA0B,EAC1B,+CAAqB,CACtB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAtFD,sDAsFC"}

package/dist/types.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="node" />
+import type { EventType } from '@rsdk/kafka.common';
+import type { KafkaBatchProducer, KafkaProducer, ProducerConfig, ProducerOptions } from '@rsdk/kafka.producer';
+/**
+ * Структура таблицы outbox (имя может быть переопределено)
+ */
+export interface OutboxTable {
+    /**
+     * Идентификатор события (UUID)
+     */
+    id: string;
+    /**
+     * Тип события: FQN из protobuf
+     */
+    type: string;
+    /**
+     * Группа - указывается в опции event в protobuf
+     */
+    group: string;
+    /**
+     * Ключ партиционирования. Вычисляется в зависимости от
+     * переданной опции partitionKeyField (в protobuf) и структуры события.
+     * Может быть явно задан при публикации.
+     */
+    partition_key: string;
+    /**
+     * Метаданные события (включая служебные)
+     *
+     * NOTE: Здесь используется any, а не unknown из-за особенностей
+     * типизации typeorm
+     */
+    metadata: Record<string, any> | null;
+    /**
+     * Сериализованные данные события
+     */
+    payload: Buffer;
+}
+export interface OutboxProducerOptions extends ProducerOptions {
+    /** Переопределяет имя таблицы (default: "outbox") */
+    tableName?: string;
+}
+export type OutboxMetadata = {
+    eventType: EventType;
+    eventData: Omit<EventType, 'toJSON'>;
+};
+export interface OutboxProducerFactory<T extends EventType> {
+    createProducer(eventType: T, producerConfig: ProducerConfig): KafkaProducer<T>;
+}
+export interface OutboxBatchProducerFactory<T extends EventType[]> {
+    createBatchProducer(eventTypes: T, producerConfig: ProducerConfig): KafkaBatchProducer<T>;
+}

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,33 @@
+{
+  "name": "@rsdk/kafka.producer.outbox",
+  "version": "4.0.0-next.10",
+  "description": "Commonly types and utils for outbox",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/microservices": "^10.0.0",
+    "@rsdk/autodoc.protocol": "^4.0.0-next.10",
+    "@rsdk/common": "^4.0.0-next.10",
+    "@rsdk/core": "^4.0.0-next.10",
+    "@rsdk/kafka.common": "^4.0.0-next.10",
+    "@rsdk/kafka.producer": "^4.0.0-next.10",
+    "@rsdk/logging": "^4.0.0-next.10",
+    "@rsdk/metadata": "^4.0.0-next.10",
+    "kafkajs": "^2.2.4",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.0.0"
+  },
+  "dependencies": {
+    "@rsdk/nest-tools": "^4.0.0-next.10",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "c41d4da9aa0318d5e6417514c763618ce924f9b7"
+}

package/src/constants.ts

@@ -0,0 +1,27 @@
+import { Case } from '@rsdk/common';
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+
+/**
+ * Имя outbox-таблицы по умолчанию
+ */
+export const DEFAULT_OUTBOX_TABLE_NAME = 'outbox';
+export const OUTBOX_FACTORY_PROVIDER_TOKEN = 'OUTBOX_FACTORY_PROVIDER';
+export const BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN =
+  'BATCH_OUTBOX_FACTORY_PROVIDER';
+export const createOutboxProducerToken = <T extends EventType>(
+  eventType: T,
+): string => `KAFKA_OUTBOX_PRODUCER_${Case.toUpperSnake(eventType.$type)}`;
+
+export const createOutboxBatchProducerToken = <
+  T extends MaybeReadonlyArray<EventType>,
+>(
+  eventType: T,
+): string =>
+  `KAFKA_OUTBOX_BATCH_PRODUCER_${Case.toUpperSnake(
+    eventType
+      .map((e: EventType) => e.$type)
+      .sort()
+      .join('_'),
+  )}`;
+export const OUTBOX_RSDK_METADATA_SCOPE = 'OUTBOX_RSDK_METADATA_SCOPE';

package/src/decorator.ts

@@ -0,0 +1,47 @@
+import { Inject } from '@nestjs/common';
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+import {
+  PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+  RsdkMetadata,
+} from '@rsdk/metadata';
+
+import {
+  createOutboxBatchProducerToken,
+  createOutboxProducerToken,
+} from './constants';
+import { OutboxModuleGenerator } from './outbox.module-generator';
+
+export const InjectOutboxProducer = (
+  eventType: EventType,
+): ParameterDecorator => {
+  return (target, propertyKey, parameterIndex) => {
+    const producerToken = createOutboxProducerToken(eventType);
+
+    Inject(producerToken)(target, propertyKey, parameterIndex);
+    RsdkMetadata.setWithScope(
+      target,
+      PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+      producerToken,
+      OutboxModuleGenerator.createOutboxModuleDefinition(eventType),
+      true,
+    );
+  };
+};
+
+export const InjectOutboxBatchProducer = (
+  eventType: MaybeReadonlyArray<EventType>,
+): ParameterDecorator => {
+  return (target, propertyKey, parameterIndex) => {
+    const batchProducerToken = createOutboxBatchProducerToken(eventType);
+
+    Inject(batchProducerToken)(target, propertyKey, parameterIndex);
+    RsdkMetadata.setWithScope(
+      target,
+      PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+      batchProducerToken,
+      OutboxModuleGenerator.createBatchOutboxModuleDefinition(eventType),
+      true,
+    );
+  };
+};

package/src/index.ts

@@ -0,0 +1,5 @@
+export { InjectOutboxProducer, InjectOutboxBatchProducer } from './decorator';
+
+export * from './outbox-events.factory';
+export * from './constants';
+export * from './types';

package/src/outbox-events.factory.ts

@@ -0,0 +1,28 @@
+import type { EventPayload, EventType } from '@rsdk/kafka.common';
+import type { PublishOptions } from '@rsdk/kafka.producer';
+import { EventsFactory } from '@rsdk/kafka.producer';
+import { randomUUID } from 'node:crypto';
+
+import type { OutboxTable } from './types';
+
+/**
+ * Подготавливает данные для вставки в таблицу outbox
+ */
+export class OutboxEventsFactory<E extends EventType> extends EventsFactory<
+  E,
+  OutboxTable
+> {
+  create<P extends EventPayload<E> = EventPayload<E>>(
+    payload: P,
+    options?: PublishOptions,
+  ): OutboxTable {
+    return {
+      id: randomUUID(),
+      group: this.eventType.$group,
+      metadata: this.getMetadata(options?.metadata),
+      partition_key: this.getPartitionKey(this.eventType, options),
+      payload: this.serializePayload(payload),
+      type: this.eventType.$type,
+    };
+  }
+}

package/src/outbox.autodoc-resolver.ts

@@ -0,0 +1,36 @@
+import type { DocumentResolver } from '@rsdk/autodoc.protocol';
+import { Composite, Table } from '@rsdk/autodoc.protocol';
+import { getTopicName } from '@rsdk/kafka.common';
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
+
+import { OUTBOX_RSDK_METADATA_SCOPE } from './constants';
+import type { OutboxMetadata } from './types';
+
+class OutboxAutodocResolver implements DocumentResolver {
+  getNode(rsdkMetadataProvider: RsdkMetadataProvider): Composite | null {
+    const resources = rsdkMetadataProvider.get<OutboxMetadata>(
+      OUTBOX_RSDK_METADATA_SCOPE,
+    );
+
+    if (!resources) {
+      return null;
+    }
+
+    return new Composite(
+      new Table(
+        resources.map((resource) => {
+          const { $type, $partitionKeyField } = resource.value.eventType;
+
+          return {
+            Type: $type,
+            TopicName: getTopicName(resource.value.eventType),
+            PartitionKeyField: $partitionKeyField ?? '-',
+          };
+        }),
+      ),
+      'Kafka outbox',
+    );
+  }
+}
+
+export const outboxAutodocResolver = new OutboxAutodocResolver();

package/src/outbox.module-generator.ts

@@ -0,0 +1,110 @@
+import type { DynamicModule } from '@nestjs/common';
+import { AutodocMetadata } from '@rsdk/autodoc.protocol';
+import type { MaybeReadonlyArray } from '@rsdk/common.node';
+import type { EventType } from '@rsdk/kafka.common';
+import type { KafkaProducer } from '@rsdk/kafka.producer';
+import { ProducerConfig } from '@rsdk/kafka.producer';
+import { RsdkMetadata } from '@rsdk/metadata';
+import omit from 'lodash/omit';
+
+import {
+  BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN,
+  createOutboxBatchProducerToken,
+  createOutboxProducerToken,
+  OUTBOX_FACTORY_PROVIDER_TOKEN,
+  OUTBOX_RSDK_METADATA_SCOPE,
+} from './constants';
+import { outboxAutodocResolver } from './outbox.autodoc-resolver';
+import type {
+  OutboxBatchProducerFactory,
+  OutboxMetadata,
+  OutboxProducerFactory,
+} from './types';
+
+export class OutboxModuleGenerator {
+  static createOutboxModuleDefinition(eventType: EventType): DynamicModule {
+    const providers = [
+      {
+        inject: [OUTBOX_FACTORY_PROVIDER_TOKEN, ProducerConfig],
+        /**
+         * TODO: А если пользователь будет использовать одновременно knex и typeorm?
+         * Сейчас произойдёт неопределённое поведение. А надо наверное ошибку кидать?
+         * (В целом следуем концепции того что в приложении не должно быть два плагина для работы с СУБД)
+         */
+        provide: createOutboxProducerToken(eventType),
+        useFactory: (
+          outboxProducerFactory: OutboxProducerFactory<any>,
+          config: ProducerConfig,
+        ): KafkaProducer<EventType> =>
+          outboxProducerFactory.createProducer(eventType, config),
+      },
+    ];
+    const moduleDef: DynamicModule = {
+      providers,
+      module: OutboxModuleGenerator,
+      exports: providers,
+    };
+
+    const rsdkMetadata = new RsdkMetadata<OutboxMetadata>(
+      moduleDef,
+      OUTBOX_RSDK_METADATA_SCOPE,
+    );
+
+    rsdkMetadata.add({
+      eventType, // Потому что https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#:~:text=If%20the%20value%20has%20a%20toJSON()%20method%2C%20it%27s%20responsible%20to%20define%20what%20data%20will%20be%20serialized.
+      eventData: omit(eventType, 'toJSON'),
+    });
+
+    AutodocMetadata.defineResolver(
+      moduleDef,
+      OUTBOX_RSDK_METADATA_SCOPE,
+      outboxAutodocResolver,
+    );
+    return moduleDef;
+  }
+
+  static createBatchOutboxModuleDefinition(
+    eventTypes: MaybeReadonlyArray<EventType>,
+  ): DynamicModule {
+    const providers = [
+      {
+        inject: [BATCH_OUTBOX_FACTORY_PROVIDER_TOKEN, ProducerConfig],
+        /**
+         * TODO: А если пользователь будет использовать одновременно knex и typeorm?
+         * Сейчас произойдёт неопределённое поведение. А надо наверное ошибку кидать?
+         * (В целом следуем концепции того что в приложении не должно быть два плагина для работы с СУБД)
+         */
+        provide: createOutboxBatchProducerToken(eventTypes),
+        useFactory: (
+          outboxProducerFactory: OutboxBatchProducerFactory<any>,
+          config: ProducerConfig,
+        ): KafkaProducer<EventType> =>
+          outboxProducerFactory.createBatchProducer(eventTypes, config),
+      },
+    ];
+    const moduleDef: DynamicModule = {
+      providers,
+      module: OutboxModuleGenerator,
+      exports: providers,
+    };
+
+    const rsdkMetadata = new RsdkMetadata<OutboxMetadata>(
+      moduleDef,
+      OUTBOX_RSDK_METADATA_SCOPE,
+    );
+
+    for (const eventType of eventTypes) {
+      rsdkMetadata.add({
+        eventType: eventType, // Потому что https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#:~:text=If%20the%20value%20has%20a%20toJSON()%20method%2C%20it%27s%20responsible%20to%20define%20what%20data%20will%20be%20serialized.
+        eventData: omit(eventType, 'toJSON'),
+      });
+    }
+
+    AutodocMetadata.defineResolver(
+      moduleDef,
+      OUTBOX_RSDK_METADATA_SCOPE,
+      outboxAutodocResolver,
+    );
+    return moduleDef;
+  }
+}

package/src/types.ts

@@ -0,0 +1,71 @@
+import type { EventType } from '@rsdk/kafka.common';
+import type {
+  KafkaBatchProducer,
+  KafkaProducer,
+  ProducerConfig,
+  ProducerOptions,
+} from '@rsdk/kafka.producer';
+
+/**
+ * Структура таблицы outbox (имя может быть переопределено)
+ */
+export interface OutboxTable {
+  /**
+   * Идентификатор события (UUID)
+   */
+  id: string;
+
+  /**
+   * Тип события: FQN из protobuf
+   */
+  type: string;
+
+  /**
+   * Группа - указывается в опции event в protobuf
+   */
+  group: string;
+
+  /**
+   * Ключ партиционирования. Вычисляется в зависимости от
+   * переданной опции partitionKeyField (в protobuf) и структуры события.
+   * Может быть явно задан при публикации.
+   */
+  partition_key: string;
+
+  /**
+   * Метаданные события (включая служебные)
+   *
+   * NOTE: Здесь используется any, а не unknown из-за особенностей
+   * типизации typeorm
+   */
+  metadata: Record<string, any> | null;
+
+  /**
+   * Сериализованные данные события
+   */
+  payload: Buffer;
+}
+
+export interface OutboxProducerOptions extends ProducerOptions {
+  /** Переопределяет имя таблицы (default: "outbox") */
+  tableName?: string;
+}
+
+export type OutboxMetadata = {
+  eventType: EventType;
+  eventData: Omit<EventType, 'toJSON'>;
+};
+
+export interface OutboxProducerFactory<T extends EventType> {
+  createProducer(
+    eventType: T,
+    producerConfig: ProducerConfig,
+  ): KafkaProducer<T>;
+}
+
+export interface OutboxBatchProducerFactory<T extends EventType[]> {
+  createBatchProducer(
+    eventTypes: T,
+    producerConfig: ProducerConfig,
+  ): KafkaBatchProducer<T>;
+}

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", "**/*.test.ts", "**/*.spec.e2e.ts", "**/*.test.e2e.ts"]
+}