@rsdk/kafka.producer.outbox.knex 1.0.13

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.
+
+## 1.0.13 (2023-06-06)
+
+**Note:** Version bump only for package @rsdk/kafka.producer.outbox.knex
+
+## 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.outbox.knex
+
+## 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/index.d.ts

@@ -0,0 +1 @@
+export { KnexOutboxProducer } from './knex-outbox.producer';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnexOutboxProducer = void 0;
+var knex_outbox_producer_1 = require("./knex-outbox.producer");
+Object.defineProperty(exports, "KnexOutboxProducer", { enumerable: true, get: function () { return knex_outbox_producer_1.KnexOutboxProducer; } });
+//# 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,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA"}

package/dist/knex-outbox.producer.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { EventType } from '@rsdk/kafka.common';
+export declare class KnexOutboxProducer {
+    static forEvent(eventType: EventType | EventType[]): DynamicModule;
+}

package/dist/knex-outbox.producer.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnexOutboxProducer = void 0;
+const autodoc_protocol_1 = require("@rsdk/autodoc.protocol");
+const db_knex_1 = require("@rsdk/db.knex");
+const metadata_1 = require("@rsdk/metadata");
+const omit_1 = __importDefault(require("lodash/omit"));
+const autodoc_resolver_1 = require("./metadata/autodoc.resolver");
+const constants_1 = require("./metadata/constants");
+const knex_producer_1 = require("./knex.producer");
+class KnexOutboxProducer {
+    static forEvent(eventType) {
+        const eventTypes = Array.isArray(eventType) ? eventType : [eventType];
+        const providers = eventTypes.map((eventType) => ({
+            inject: [db_knex_1.KNEX_INJECTION_TOKEN],
+            provide: eventType.$type,
+            useFactory: (knex) => {
+                return new knex_producer_1.KnexProducer(eventType, knex);
+            },
+        }));
+        const moduleDef = {
+            providers,
+            module: KnexOutboxProducer,
+            exports: providers,
+        };
+        const rsdkMetadata = new metadata_1.RsdkMetadata(moduleDef, constants_1.KNEX_OUTBOX_RSDK_METADATA_SCOPE);
+        for (const eventType of eventTypes) {
+            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: (0, omit_1.default)(eventType, 'toJSON'),
+            });
+        }
+        autodoc_protocol_1.AutodocMetadata.defineResolver(moduleDef, constants_1.KNEX_OUTBOX_RSDK_METADATA_SCOPE, autodoc_resolver_1.knexOutboxAutodocResolver);
+        return moduleDef;
+    }
+}
+exports.KnexOutboxProducer = KnexOutboxProducer;
+//# sourceMappingURL=knex-outbox.producer.js.map

package/dist/knex-outbox.producer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex-outbox.producer.js","sourceRoot":"","sources":["../src/knex-outbox.producer.ts"],"names":[],"mappings":";;;;;;AACA,6DAAyD;AACzD,2CAAqD;AAErD,6CAA8C;AAE9C,uDAA+B;AAE/B,kEAAwE;AACxE,oDAAuE;AAEvE,mDAA+C;AAE/C,MAAa,kBAAkB;IAC7B,MAAM,CAAC,QAAQ,CAAC,SAAkC;QAChD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACtE,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,CAAC;YAC1D,MAAM,EAAE,CAAC,8BAAoB,CAAC;YAC9B,OAAO,EAAE,SAAS,CAAC,KAAK;YACxB,UAAU,EAAE,CAAC,IAAU,EAA2B,EAAE;gBAClD,OAAO,IAAI,4BAAY,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC,CAAC;QAEJ,MAAM,SAAS,GAAG;YAChB,SAAS;YACT,MAAM,EAAE,kBAAkB;YAC1B,OAAO,EAAE,SAAS;SACnB,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,uBAAY,CACnC,SAAS,EACT,2CAA+B,CAChC,CAAC;QAEF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,YAAY,CAAC,GAAG,CAAC;gBACf,SAAS;gBACT,oPAAoP;gBACpP,SAAS,EAAE,IAAA,cAAI,EAAC,SAAS,EAAE,QAAQ,CAAC;aACrC,CAAC,CAAC;SACJ;QAED,kCAAe,CAAC,cAAc,CAC5B,SAAS,EACT,2CAA+B,EAC/B,4CAAyB,CAC1B,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AArCD,gDAqCC"}

package/dist/knex.producer.d.ts

@@ -0,0 +1,10 @@
+import type { EventType } from '@rsdk/kafka.common';
+import type { KafkaProducer, PublishOptions } from '@rsdk/kafka.producer';
+import { BaseProducer } from '@rsdk/kafka.producer';
+import type { Knex } from 'knex';
+export declare class KnexProducer<T extends EventType> extends BaseProducer<T> implements KafkaProducer<T> {
+    readonly protoType: T;
+    private readonly knex;
+    constructor(protoType: T, knex: Knex);
+    publish(payload: T, options?: PublishOptions): Promise<void>;
+}

package/dist/knex.producer.js

@@ -0,0 +1,46 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnexProducer = void 0;
+const crypto = __importStar(require("crypto"));
+const kafka_producer_1 = require("@rsdk/kafka.producer");
+class KnexProducer extends kafka_producer_1.BaseProducer {
+    protoType;
+    knex;
+    constructor(protoType, knex) {
+        super(protoType);
+        this.protoType = protoType;
+        this.knex = knex;
+    }
+    async publish(payload, options) {
+        const value = this.parsePayload(payload, options);
+        await this.knex('outbox').insert({
+            ...value,
+            id: crypto.randomUUID(),
+        });
+    }
+}
+exports.KnexProducer = KnexProducer;
+//# sourceMappingURL=knex.producer.js.map

package/dist/knex.producer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex.producer.js","sourceRoot":"","sources":["../src/knex.producer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AAQjC,yDAAoD;AAGpD,MAAa,YACX,SAAQ,6BAAe;IAGF;IAA+B;IAApD,YAAqB,SAAY,EAAmB,IAAU;QAC5D,KAAK,CAAC,SAAS,CAAC,CAAC;QADE,cAAS,GAAT,SAAS,CAAG;QAAmB,SAAI,GAAJ,IAAI,CAAM;IAE9D,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAU,EAAE,OAAwB;QAChD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,IAAI,CAAC,IAAI,CAAc,QAAQ,CAAC,CAAC,MAAM,CAAC;YAC5C,GAAG,KAAK;YACR,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;CACF;AAhBD,oCAgBC"}

package/dist/metadata/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 KnexOutboxAutodocResolver implements DocumentResolver {
+    getNode(rsdkMetadataProvider: RsdkMetadataProvider): Composite | null;
+}
+export declare const knexOutboxAutodocResolver: KnexOutboxAutodocResolver;
+export {};

package/dist/metadata/autodoc.resolver.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.knexOutboxAutodocResolver = void 0;
+const autodoc_protocol_1 = require("@rsdk/autodoc.protocol");
+const constants_1 = require("./constants");
+class KnexOutboxAutodocResolver {
+    getNode(rsdkMetadataProvider) {
+        const resources = rsdkMetadataProvider.get(constants_1.KNEX_OUTBOX_RSDK_METADATA_SCOPE);
+        if (!resources) {
+            return null;
+        }
+        return new autodoc_protocol_1.Composite(new autodoc_protocol_1.Table(resources.map((resource) => {
+            const { $type, $group, $partitionKeyField } = resource.value.eventType;
+            return {
+                Type: $type,
+                Group: $group,
+                PartitionKeyField: $partitionKeyField ?? '-',
+            };
+        })), 'Kafka knex outbox');
+    }
+}
+exports.knexOutboxAutodocResolver = new KnexOutboxAutodocResolver();
+//# sourceMappingURL=autodoc.resolver.js.map

package/dist/metadata/autodoc.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autodoc.resolver.js","sourceRoot":"","sources":["../../src/metadata/autodoc.resolver.ts"],"names":[],"mappings":";;;AACA,6DAA0D;AAG1D,2CAA8D;AAG9D,MAAM,yBAAyB;IAC7B,OAAO,CAAC,oBAA0C;QAChD,MAAM,SAAS,GAAG,oBAAoB,CAAC,GAAG,CACxC,2CAA+B,CAChC,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,MAAM,EAAE,kBAAkB,EAAE,GACzC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;YAE3B,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,MAAM;gBACb,iBAAiB,EAAE,kBAAkB,IAAI,GAAG;aAC7C,CAAC;QACJ,CAAC,CAAC,CACH,EACD,mBAAmB,CACpB,CAAC;IACJ,CAAC;CACF;AAEY,QAAA,yBAAyB,GAAG,IAAI,yBAAyB,EAAE,CAAC"}

package/dist/metadata/constants.d.ts

@@ -0,0 +1 @@
+export declare const KNEX_OUTBOX_RSDK_METADATA_SCOPE = "kafka-producer-direct";

package/dist/metadata/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KNEX_OUTBOX_RSDK_METADATA_SCOPE = void 0;
+exports.KNEX_OUTBOX_RSDK_METADATA_SCOPE = 'kafka-producer-direct';
+//# sourceMappingURL=constants.js.map

package/dist/metadata/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/metadata/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,+BAA+B,GAAG,uBAAuB,CAAC"}

package/dist/metadata/types.d.ts

@@ -0,0 +1,5 @@
+import type { EventType } from '@rsdk/kafka.common';
+export type KnexOutboxMetadata = {
+    eventType: EventType;
+    eventData: Omit<EventType, 'toJSON'>;
+};

package/dist/metadata/types.js

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

package/dist/metadata/types.js.map

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

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@rsdk/kafka.producer.outbox.knex",
+  "version": "1.0.13",
+  "description": "Producing messages to outbox table (on top of knex)",
+  "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",
+    "@rsdk/autodoc.protocol": "^1.0.13",
+    "@rsdk/common": "^1.0.13",
+    "@rsdk/core": "^1.0.13",
+    "@rsdk/db.knex": "^1.0.13",
+    "@rsdk/kafka.common": "^1.0.13",
+    "@rsdk/kafka.producer": "^1.0.13",
+    "@rsdk/logging": "^1.0.13",
+    "@rsdk/metadata": "^1.0.13",
+    "knex": "^2.4.2"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "1f40e539993d341b239f78bf2f8b29b44fae9c1e"
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { KnexOutboxProducer } from './knex-outbox.producer';

package/src/knex-outbox.producer.ts

@@ -0,0 +1,51 @@
+import type { DynamicModule } from '@nestjs/common';
+import { AutodocMetadata } from '@rsdk/autodoc.protocol';
+import { KNEX_INJECTION_TOKEN } from '@rsdk/db.knex';
+import type { EventType } from '@rsdk/kafka.common';
+import { RsdkMetadata } from '@rsdk/metadata';
+import type { Knex } from 'knex';
+import omit from 'lodash/omit';
+
+import { knexOutboxAutodocResolver } from './metadata/autodoc.resolver';
+import { KNEX_OUTBOX_RSDK_METADATA_SCOPE } from './metadata/constants';
+import type { KnexOutboxMetadata } from './metadata/types';
+import { KnexProducer } from './knex.producer';
+
+export class KnexOutboxProducer {
+  static forEvent(eventType: EventType | EventType[]): DynamicModule {
+    const eventTypes = Array.isArray(eventType) ? eventType : [eventType];
+    const providers = eventTypes.map((eventType: EventType) => ({
+      inject: [KNEX_INJECTION_TOKEN],
+      provide: eventType.$type,
+      useFactory: (knex: Knex): KnexProducer<EventType> => {
+        return new KnexProducer(eventType, knex);
+      },
+    }));
+
+    const moduleDef = {
+      providers,
+      module: KnexOutboxProducer,
+      exports: providers,
+    };
+
+    const rsdkMetadata = new RsdkMetadata<KnexOutboxMetadata>(
+      moduleDef,
+      KNEX_OUTBOX_RSDK_METADATA_SCOPE,
+    );
+
+    for (const eventType of eventTypes) {
+      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,
+      KNEX_OUTBOX_RSDK_METADATA_SCOPE,
+      knexOutboxAutodocResolver,
+    );
+    return moduleDef;
+  }
+}

package/src/knex.producer.ts

@@ -0,0 +1,28 @@
+import * as crypto from 'crypto';
+
+import type { EventType } from '@rsdk/kafka.common';
+import type {
+  KafkaProducer,
+  OutboxTable,
+  PublishOptions,
+} from '@rsdk/kafka.producer';
+import { BaseProducer } from '@rsdk/kafka.producer';
+import type { Knex } from 'knex';
+
+export class KnexProducer<T extends EventType>
+  extends BaseProducer<T>
+  implements KafkaProducer<T>
+{
+  constructor(readonly protoType: T, private readonly knex: Knex) {
+    super(protoType);
+  }
+
+  async publish(payload: T, options?: PublishOptions): Promise<void> {
+    const value = this.parsePayload(payload, options);
+
+    await this.knex<OutboxTable>('outbox').insert({
+      ...value,
+      id: crypto.randomUUID(),
+    });
+  }
+}

package/src/metadata/autodoc.resolver.ts

@@ -0,0 +1,36 @@
+import type { DocumentResolver } from '@rsdk/autodoc.protocol';
+import { Composite, Table } from '@rsdk/autodoc.protocol';
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
+
+import { KNEX_OUTBOX_RSDK_METADATA_SCOPE } from './constants';
+import type { KnexOutboxMetadata } from './types';
+
+class KnexOutboxAutodocResolver implements DocumentResolver {
+  getNode(rsdkMetadataProvider: RsdkMetadataProvider): Composite | null {
+    const resources = rsdkMetadataProvider.get<KnexOutboxMetadata>(
+      KNEX_OUTBOX_RSDK_METADATA_SCOPE,
+    );
+
+    if (!resources) {
+      return null;
+    }
+
+    return new Composite(
+      new Table(
+        resources.map((resource) => {
+          const { $type, $group, $partitionKeyField } =
+            resource.value.eventType;
+
+          return {
+            Type: $type,
+            Group: $group,
+            PartitionKeyField: $partitionKeyField ?? '-',
+          };
+        }),
+      ),
+      'Kafka knex outbox',
+    );
+  }
+}
+
+export const knexOutboxAutodocResolver = new KnexOutboxAutodocResolver();

package/src/metadata/constants.ts

@@ -0,0 +1 @@
+export const KNEX_OUTBOX_RSDK_METADATA_SCOPE = 'kafka-producer-direct';

package/src/metadata/types.ts

@@ -0,0 +1,6 @@
+import type { EventType } from '@rsdk/kafka.common';
+
+export type KnexOutboxMetadata = {
+  eventType: EventType;
+  eventData: Omit<EventType, 'toJSON'>;
+};

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"]
+}