@rsdk/events.common 5.4.0-next.2

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [5.4.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.1...v5.4.0-next.2) (2024-11-25)
+
+### Features
+
+* **nats:** nats transport/kv/os + examples + docs ([#306](https://github.com/R-Vision/rsdk/issues/306)) ([de67eed](https://github.com/R-Vision/rsdk/commit/de67eed8b4cb17ec9d359067eae1e0c35d6cc736))

package/dist/event.codec.d.ts

@@ -0,0 +1,21 @@
+import type { EventPayload, EventType } from './event.type';
+export interface EventCodec<E extends EventType> {
+    decode<P extends EventPayload<E> = EventPayload<E>>(buffer: Buffer): P;
+    encode<P extends EventPayload<E> = EventPayload<E>>(payload: P): Buffer;
+}
+/**
+ * Protobuf-encoding strategy
+ */
+export declare class ProtoEventCodec<E extends EventType> implements EventCodec<E> {
+    readonly eventType: E;
+    constructor(eventType: E);
+    decode<P extends EventPayload<E>>(buffer: Buffer): P;
+    encode<P extends EventPayload<E>>(payload: P): Buffer;
+}
+/**
+ * JSON-encoding strategy
+ */
+export declare class JSONEventCodec<E extends EventType> implements EventCodec<E> {
+    decode<P extends EventPayload<E>>(buffer: Buffer): P;
+    encode<P extends EventPayload<E>>(payload: P): Buffer;
+}

package/dist/event.codec.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONEventCodec = exports.ProtoEventCodec = void 0;
+/**
+ * Protobuf-encoding strategy
+ */
+class ProtoEventCodec {
+    eventType;
+    constructor(eventType) {
+        this.eventType = eventType;
+    }
+    decode(buffer) {
+        return this.eventType.decode(buffer);
+    }
+    encode(payload) {
+        return Buffer.from(this.eventType.encode(payload).finish());
+    }
+}
+exports.ProtoEventCodec = ProtoEventCodec;
+/**
+ * JSON-encoding strategy
+ */
+class JSONEventCodec {
+    decode(buffer) {
+        return JSON.parse(buffer.toString());
+    }
+    encode(payload) {
+        return Buffer.from(JSON.stringify(payload));
+    }
+}
+exports.JSONEventCodec = JSONEventCodec;
+//# sourceMappingURL=event.codec.js.map

package/dist/event.codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.codec.js","sourceRoot":"","sources":["../src/event.codec.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACH,MAAa,eAAe;IACL;IAArB,YAAqB,SAAY;QAAZ,cAAS,GAAT,SAAS,CAAG;IAAG,CAAC;IAErC,MAAM,CAA4B,MAAc;QAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAA4B,OAAU;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AAVD,0CAUC;AAED;;GAEG;AACH,MAAa,cAAc;IACzB,MAAM,CAA4B,MAAc;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAA4B,OAAU;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AARD,wCAQC"}

package/dist/event.type.d.ts

@@ -0,0 +1,19 @@
+import type { Reader, Writer } from 'protobufjs/minimal';
+/**
+ * Генерируется при компиляции proto-файлов
+ */
+export interface EventType<T = any> {
+    $group: string;
+    $partitionKeyField: string | null;
+    $type: string;
+    encode(message: T): Writer;
+    decode(data: Uint8Array | Reader): T;
+}
+/**
+ * Выводит тип payload из EventType
+ */
+export type EventPayload<E extends EventType> = E extends EventType<infer P> ? P : never;
+/**
+ * Проверяет, является ли переданный тип EventType
+ */
+export declare const isEventType: <T = any>(x: any) => x is EventType<T>;

package/dist/event.type.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEventType = void 0;
+/**
+ * Проверяет, является ли переданный тип EventType
+ */
+const isEventType = (x) => typeof x === 'object' &&
+    typeof x.$type === 'string' &&
+    typeof x.$group === 'string';
+exports.isEventType = isEventType;
+//# sourceMappingURL=event.type.js.map

package/dist/event.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.type.js","sourceRoot":"","sources":["../src/event.type.ts"],"names":[],"mappings":";;;AAqBA;;GAEG;AACI,MAAM,WAAW,GAAG,CAAU,CAAM,EAAqB,EAAE,CAChE,OAAO,CAAC,KAAK,QAAQ;IACrB,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;IAC3B,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC;AAHlB,QAAA,WAAW,eAGO"}

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

@@ -0,0 +1,5 @@
+import type { EnumValue } from '@rsdk/common';
+import { BootstrapException } from '@rsdk/core';
+export declare class PayloadFormatException extends BootstrapException {
+    constructor(value: string, allowed: EnumValue[]);
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayloadFormatException = void 0;
+const core_1 = require("@rsdk/core");
+class PayloadFormatException extends core_1.BootstrapException {
+    constructor(value, allowed) {
+        super(`PayloadFormat has wrong value: ${value}, allowed: ${allowed.join(',')}`);
+    }
+}
+exports.PayloadFormatException = PayloadFormatException;
+//# sourceMappingURL=payload-format.exception.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payload-format.exception.js","sourceRoot":"","sources":["../../src/exceptions/payload-format.exception.ts"],"names":[],"mappings":";;;AACA,qCAAgD;AAEhD,MAAa,sBAAuB,SAAQ,yBAAkB;IAC5D,YAAY,KAAa,EAAE,OAAoB;QAC7C,KAAK,CACH,kCAAkC,KAAK,cAAc,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACzE,CAAC;IACJ,CAAC;CACF;AAND,wDAMC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './event.type';
+export * from './event.codec';
+export * from './exceptions/payload-format.exception';
+export * from './payload.format';

package/dist/index.js

@@ -0,0 +1,21 @@
+"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 });
+__exportStar(require("./event.type"), exports);
+__exportStar(require("./event.codec"), exports);
+__exportStar(require("./exceptions/payload-format.exception"), exports);
+__exportStar(require("./payload.format"), 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,+CAA6B;AAC7B,gDAA8B;AAC9B,wEAAsD;AACtD,mDAAiC"}

package/dist/payload.format.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Способ сериализации данных события
+ */
+export declare enum PayloadFormat {
+    PROTOBUF = "protobuf",
+    JSON = "json"
+}
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat
+ */
+export declare const isPayloadFormat: (value: string) => value is PayloadFormat;
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat. В случае,
+ * если передано неверное значение - бросает ошибку
+ */
+export declare const assertIsPayloadFormat: (value: string) => asserts value is PayloadFormat;
+/**
+ * Заголовок, через который передаётся способ сериализации
+ */
+export declare const X_FORMAT_HEADER = "X-Format";
+/**
+ * Сериализация по умолчанию (protobuf)
+ */
+export declare const DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;
+/**
+ * Заголовок, через который передаётся тип сообщения
+ */
+export declare const X_TYPE_HEADER = "X-Type";

package/dist/payload.format.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.X_TYPE_HEADER = exports.DEFAULT_PAYLOAD_FORMAT = exports.X_FORMAT_HEADER = exports.assertIsPayloadFormat = exports.isPayloadFormat = exports.PayloadFormat = void 0;
+const common_1 = require("@rsdk/common");
+const payload_format_exception_1 = require("./exceptions/payload-format.exception");
+/**
+ * Способ сериализации данных события
+ */
+var PayloadFormat;
+(function (PayloadFormat) {
+    PayloadFormat["PROTOBUF"] = "protobuf";
+    PayloadFormat["JSON"] = "json";
+})(PayloadFormat || (exports.PayloadFormat = PayloadFormat = {}));
+const allowed = common_1.Enum.values(PayloadFormat);
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat
+ */
+const isPayloadFormat = (value) => allowed.includes(value);
+exports.isPayloadFormat = isPayloadFormat;
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat. В случае,
+ * если передано неверное значение - бросает ошибку
+ */
+const assertIsPayloadFormat = (value) => {
+    if ((0, exports.isPayloadFormat)(value)) {
+        return;
+    }
+    throw new payload_format_exception_1.PayloadFormatException(value, allowed);
+};
+exports.assertIsPayloadFormat = assertIsPayloadFormat;
+/**
+ * Заголовок, через который передаётся способ сериализации
+ */
+exports.X_FORMAT_HEADER = 'X-Format';
+/**
+ * Сериализация по умолчанию (protobuf)
+ */
+exports.DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;
+/**
+ * Заголовок, через который передаётся тип сообщения
+ */
+exports.X_TYPE_HEADER = 'X-Type';
+//# 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,yCAAoC;AAEpC,oFAA+E;AAE/E;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED,MAAM,OAAO,GAAG,aAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAE3C;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,KAAa,EAA0B,EAAE,CACvE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AADb,QAAA,eAAe,mBACF;AAE1B;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CACnC,KAAa,EACmB,EAAE;IAClC,IAAI,IAAA,uBAAe,EAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IAED,MAAM,IAAI,iDAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC,CAAC;AARW,QAAA,qBAAqB,yBAQhC;AAEF;;GAEG;AACU,QAAA,eAAe,GAAG,UAAU,CAAC;AAE1C;;GAEG;AACU,QAAA,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC;AAE7D;;GAEG;AACU,QAAA,aAAa,GAAG,QAAQ,CAAC"}

package/jest.config.e2e.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.e2e');

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config');

package/jest.config.unit.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.unit');

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@rsdk/events.common",
+  "version": "5.4.0-next.2",
+  "description": "Useful common classes, functions and types",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@rsdk/common": "*",
+    "@rsdk/core": "*"
+  },
+  "gitHead": "be4deac03b38b3f923a08116e1dc2b55838905b0",
+  "dependencies": {
+    "protobufjs": "^7.4.0"
+  }
+}

package/src/event.codec.ts

@@ -0,0 +1,35 @@
+import type { EventPayload, EventType } from './event.type';
+
+export interface EventCodec<E extends EventType> {
+  decode<P extends EventPayload<E> = EventPayload<E>>(buffer: Buffer): P;
+
+  encode<P extends EventPayload<E> = EventPayload<E>>(payload: P): Buffer;
+}
+
+/**
+ * Protobuf-encoding strategy
+ */
+export class ProtoEventCodec<E extends EventType> implements EventCodec<E> {
+  constructor(readonly eventType: E) {}
+
+  decode<P extends EventPayload<E>>(buffer: Buffer): P {
+    return this.eventType.decode(buffer);
+  }
+
+  encode<P extends EventPayload<E>>(payload: P): Buffer {
+    return Buffer.from(this.eventType.encode(payload).finish());
+  }
+}
+
+/**
+ * JSON-encoding strategy
+ */
+export class JSONEventCodec<E extends EventType> implements EventCodec<E> {
+  decode<P extends EventPayload<E>>(buffer: Buffer): P {
+    return JSON.parse(buffer.toString());
+  }
+
+  encode<P extends EventPayload<E>>(payload: P): Buffer {
+    return Buffer.from(JSON.stringify(payload));
+  }
+}

package/src/event.type.ts

@@ -0,0 +1,28 @@
+import type { Reader, Writer } from 'protobufjs/minimal';
+
+/**
+ * Генерируется при компиляции proto-файлов
+ */
+export interface EventType<T = any> {
+  $group: string;
+  $partitionKeyField: string | null;
+  $type: string;
+
+  encode(message: T): Writer;
+
+  decode(data: Uint8Array | Reader): T;
+}
+
+/**
+ * Выводит тип payload из EventType
+ */
+export type EventPayload<E extends EventType> =
+  E extends EventType<infer P> ? P : never;
+
+/**
+ * Проверяет, является ли переданный тип EventType
+ */
+export const isEventType = <T = any>(x: any): x is EventType<T> =>
+  typeof x === 'object' &&
+  typeof x.$type === 'string' &&
+  typeof x.$group === 'string';

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

@@ -0,0 +1,10 @@
+import type { EnumValue } from '@rsdk/common';
+import { BootstrapException } from '@rsdk/core';
+
+export class PayloadFormatException extends BootstrapException {
+  constructor(value: string, allowed: EnumValue[]) {
+    super(
+      `PayloadFormat has wrong value: ${value}, allowed: ${allowed.join(',')}`,
+    );
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './event.type';
+export * from './event.codec';
+export * from './exceptions/payload-format.exception';
+export * from './payload.format';

package/src/payload.format.ts

@@ -0,0 +1,50 @@
+import { Enum } from '@rsdk/common';
+
+import { PayloadFormatException } from './exceptions/payload-format.exception';
+
+/**
+ * Способ сериализации данных события
+ */
+export enum PayloadFormat {
+  PROTOBUF = 'protobuf',
+  JSON = 'json',
+}
+
+const allowed = Enum.values(PayloadFormat);
+
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat
+ */
+export const isPayloadFormat = (value: string): value is PayloadFormat =>
+  allowed.includes(value);
+
+/**
+ * Проверяет, является ли переданная строка - одним
+ * из значений перечисления PayloadFormat. В случае,
+ * если передано неверное значение - бросает ошибку
+ */
+export const assertIsPayloadFormat = (
+  value: string,
+): asserts value is PayloadFormat => {
+  if (isPayloadFormat(value)) {
+    return;
+  }
+
+  throw new PayloadFormatException(value, allowed);
+};
+
+/**
+ * Заголовок, через который передаётся способ сериализации
+ */
+export const X_FORMAT_HEADER = 'X-Format';
+
+/**
+ * Сериализация по умолчанию (protobuf)
+ */
+export const DEFAULT_PAYLOAD_FORMAT = PayloadFormat.PROTOBUF;
+
+/**
+ * Заголовок, через который передаётся тип сообщения
+ */
+export const X_TYPE_HEADER = 'X-Type';

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.test.e2e.ts",
+    "**/*.test.manual-e2e.ts",
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  }
+}