@rsdk/core 0.14.0

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './metadata';
+export * from './options';
+export * from './transports';
+export * from './plugins';

package/dist/types/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("./metadata"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./transports"), exports);
+__exportStar(require("./plugins"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,4CAA0B;AAC1B,+CAA6B;AAC7B,4CAA0B"}

package/dist/types/metadata.d.ts

@@ -0,0 +1,38 @@
+import type { Primitive } from '@rsdk/common';
+import type { ParserMetadata, PropertyMetadata, SectionMetadata, SourceMetadata } from '../config';
+export type SerializablePropertyMetadata = Omit<PropertyMetadata, 'defaultValue' | 'parser'> & {
+    defaultValue: Primitive | Primitive[] | undefined;
+    parser: ParserMetadata;
+};
+export declare const serializePropertyMetadata: (metadata: PropertyMetadata) => SerializablePropertyMetadata;
+export type SerializableSectionMetadata = Omit<SectionMetadata, 'properties'> & {
+    properties: SerializablePropertyMetadata[];
+};
+export declare const transformSectionMetadata: ({ properties, ...rest }: SectionMetadata) => SerializableSectionMetadata;
+export type SerializableConfigMetadata = {
+    prefix: string;
+    sources: SourceMetadata[];
+    sections: SerializableSectionMetadata[];
+    properties: SerializablePropertyMetadata[];
+};
+/**
+ * Platfrom metadata is used to generate documentation
+ */
+export interface PlatformAppMetadata {
+    /**
+     * Application name
+     */
+    name: string;
+    /**
+     * Application description
+     */
+    description: string;
+    /**
+     * Supported protocols
+     */
+    protocols: string[];
+    /**
+     * Configuration scheme and options
+     */
+    config: SerializableConfigMetadata;
+}

package/dist/types/metadata.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformSectionMetadata = exports.serializePropertyMetadata = void 0;
+const common_1 = require("@rsdk/common");
+const serializePropertyMetadata = (metadata) => {
+    const { parser, defaultValue, ...rest } = metadata;
+    return {
+        ...rest,
+        parser: {
+            type: parser.type(),
+            description: parser.description(),
+        },
+        ...((0, common_1.hasKey)(metadata, 'defaultValue') && {
+            // Here we need to serialize Timespans and URLs
+            defaultValue: (0, common_1.isPrimitive)(defaultValue)
+                ? defaultValue
+                : Array.isArray(defaultValue)
+                    ? defaultValue.map((x) => ((0, common_1.isPrimitive)(x) ? x : x.toString()))
+                    : defaultValue?.toString(),
+        }),
+    };
+};
+exports.serializePropertyMetadata = serializePropertyMetadata;
+const transformSectionMetadata = ({ properties, ...rest }) => ({
+    ...rest,
+    // TODO: Если properties переделается в мапу, может быть проблема
+    properties: Object.values(properties).map(exports.serializePropertyMetadata),
+});
+exports.transformSectionMetadata = transformSectionMetadata;
+//# sourceMappingURL=metadata.js.map

package/dist/types/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/types/metadata.ts"],"names":[],"mappings":";;;AACA,yCAAmD;AAiB5C,MAAM,yBAAyB,GAAG,CACvC,QAA0B,EACI,EAAE;IAChC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;IAEnD,OAAO;QACL,GAAG,IAAI;QACP,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;YAEnB,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE;SAClC;QACD,GAAG,CAAC,IAAA,eAAM,EAAC,QAAQ,EAAE,cAAc,CAAC,IAAI;YACtC,+CAA+C;YAC/C,YAAY,EAAE,IAAA,oBAAW,EAAC,YAAY,CAAC;gBACrC,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;oBAC7B,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,oBAAW,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC9D,CAAC,CAAC,YAAY,EAAE,QAAQ,EAAE;SAC7B,CAAC;KAC6B,CAAC;AACpC,CAAC,CAAC;AArBW,QAAA,yBAAyB,6BAqBpC;AASK,MAAM,wBAAwB,GAAG,CAAC,EACvC,UAAU,EACV,GAAG,IAAI,EACS,EAA+B,EAAE,CAAC,CAAC;IACnD,GAAG,IAAI;IACP,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,iCAAyB,CAAC;CACrE,CAAC,CAAC;AAPU,QAAA,wBAAwB,4BAOlC"}

package/dist/types/options.d.ts

@@ -0,0 +1,68 @@
+import type { Constructor, RequiredFields } from '@rsdk/common';
+import type { ConfigModuleOptions } from '../config';
+import type { PlatformAppPlugin } from './plugins';
+import type { IPrimaryTransport, ITransport } from './transports';
+/**
+ * Not empty collection of modules
+ */
+type Modules = [Constructor, ...Constructor[]];
+export interface ManifestData {
+    /**
+     * Application name
+     */
+    name: string;
+    /**
+     * Application description
+     */
+    description: string;
+    /**
+     * Application version
+     */
+    version: string;
+}
+export interface PlatformManifestPathOptions {
+    /**
+     * Path to package.json file. By default will be $(cwd())/package.json
+     */
+    manifestPath?: string;
+}
+/**
+ * All application options
+ */
+export interface PlatformOptions extends PlatformManifestPathOptions {
+    /**
+     * Application modules
+     *
+     * Platform creates root module behind the scenes. It
+     * will automatically import all infrastructure modules
+     * such as logging, tracing, error handling etc.
+     *
+     * And finally it will import modules provided here which
+     * should deliver business value.
+     *
+     * NOTE: If you declare global guard or let's say interceptor
+     * via APP_GUARD or APP_INTERCEPTOR in one of your modules, they
+     * will be applied **inside** of internal global middleware.
+     */
+    modules?: Modules;
+    /**
+     * Configuration options
+     */
+    config?: Omit<ConfigModuleOptions, 'appName'>;
+    /**
+     * Transports are implemented outside @rsdk/core package
+     * Ex: @rsdk/fastify, @platfrom/grpc-server, etc.
+     *
+     * Array of transport must not be empty.
+     * First transport should be primary one (implement health and metrics
+     * endpoints)
+     */
+    transports?: [IPrimaryTransport, ...ITransport[]];
+    /**
+     * Plugins extend application functionality.
+     */
+    plugins?: PlatformAppPlugin[];
+}
+export type PlatformAppOptions = RequiredFields<PlatformOptions, 'transports' | 'modules'>;
+export type PlatformExtendedOptions = PlatformOptions & ManifestData;
+export {};

package/dist/types/options.js

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

package/dist/types/options.js.map

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

package/dist/types/plugins.d.ts

@@ -0,0 +1,51 @@
+import type { DynamicModule, MiddlewareConsumer } from '@nestjs/common';
+import type { Constructor } from '@rsdk/common';
+import type { IErrorsFormatter, IErrorsSender, IErrorsTransformer } from '../exceptions.handling';
+export type SpecifiedTransports = Readonly<string[]>;
+export type AppropriateTransports = SpecifiedTransports | 'any';
+export declare const hasSpecifiedTransports: (x: PlatformAppPlugin) => x is PlatformAppPlugin<readonly string[]>;
+/**
+ * PlatformApp philosophy assumes that initialization
+ * should not be exposed outside the library. But there
+ * are cases when initialization should be extended from
+ * outside. This is where plugins come in.
+ */
+export interface PlatformAppPlugin<T extends AppropriateTransports = AppropriateTransports> {
+    /**
+     * Returns list of appropriate transports.
+     *
+     * When a plugin is applied, system will check if at
+     * least one of appropriate transports exists in application.
+     * If none - BootstrapException will be thrown
+     *
+     * If plugin is not transport specific - literal "any" should
+     * be returned.
+     */
+    forTransports(): T;
+    /**
+     * Modules that will be imported to root. Will be
+     * applied after all core modules but before any application
+     * level modules.
+     */
+    modules?(): (Constructor | DynamicModule)[];
+    /**
+     * Additional error transformers
+     */
+    errorTransformers?(): IErrorsTransformer[];
+    /**
+     * Additional error formatter
+     */
+    errorFormatter?(): IErrorsFormatter;
+    /**
+     * Additional errors sender
+     */
+    errorSender?(): IErrorsSender;
+    /**
+     * Apply additional middleware (using MiddlewareConsumer).
+     * Will work only if application has HttpAdapter
+     *
+     * When adding a plugin
+     * @param consumer MiddlewareConsumer
+     */
+    configureMiddleware?(consumer: MiddlewareConsumer): void;
+}

package/dist/types/plugins.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasSpecifiedTransports = void 0;
+const hasSpecifiedTransports = (x) => x.forTransports() !== 'any';
+exports.hasSpecifiedTransports = hasSpecifiedTransports;
+//# sourceMappingURL=plugins.js.map

package/dist/types/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/types/plugins.ts"],"names":[],"mappings":";;;AAYO,MAAM,sBAAsB,GAAG,CACpC,CAAoB,EACyB,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,KAAK,KAAK,CAAC;AAFjE,QAAA,sBAAsB,0BAE2C"}

package/dist/types/transports.d.ts

@@ -0,0 +1,85 @@
+import type { Controller, INestApplication } from '@nestjs/common/interfaces';
+import type { AbstractHttpAdapter } from '@nestjs/core';
+import type { MicroserviceOptions } from '@nestjs/microservices';
+import type { Constructor } from '@rsdk/common';
+import type { IErrorsFormatter, IErrorsSender, IErrorsTransformer } from '../exceptions.handling';
+/**
+ * Base functionality of HTTP or microservice transport
+ */
+export interface ITransport {
+    /**
+     * @returns protocol in text format
+     */
+    getProtocol(): string;
+    /**
+     * @returns error formatting algorithm
+     */
+    getErrorsFormatter(): IErrorsFormatter;
+    /**
+     * @returns error transformers or empty array
+     */
+    getErrorTransformers(): IErrorsTransformer[];
+    /**
+     * @returns sending error algorithm
+     */
+    getErrorsSender?(): IErrorsSender;
+}
+/**
+ * Primary transport is transport that implements maintenance
+ * functionality: healthchecks and metrics.
+ *
+ * NOTE: Application should have at least one primary transport.
+ */
+export interface IPrimaryTransport extends ITransport {
+    getHealthController(): Constructor<Controller>;
+    getMetricsController(): Constructor<Controller>;
+}
+/**
+ * Transport based on Nest.js microservice.
+ */
+export interface IMicroserviceTransport extends ITransport {
+    /**
+     * @retures options ready to be passed to
+     * NestFactory.createMicroservice() or
+     * app.connectMicroservice()
+     */
+    createMicroserviceOptions(): MicroserviceOptions;
+    /**
+     * Should be called before passing options
+     * to app.connectMicroservice()
+     */
+    init(): void;
+    /**
+     * Additional logic that will be ran after
+     * microservice is started. Most common use
+     * is logging
+     */
+    onStart(): void;
+}
+export interface HttpOptions {
+    host: string;
+    port: number;
+}
+/**
+ * HTTP-based transport build on top of some HTTP
+ * adapter.
+ */
+export interface IHttpTransport extends IPrimaryTransport {
+    /**
+     * @returns AbstractHttpAdapter (from @nestjs/core)
+     *
+     * Most common are ExpressAdapter and FastifyAdater,
+     * but custom adapter can be implemented if needed
+     */
+    getAdapter(): AbstractHttpAdapter;
+    /**
+     * Applies any configuration to Nest application instance:
+     * middleware, body parsers and other.
+     * @param app INestApplication
+     */
+    configure(app: INestApplication): Promise<void> | void;
+    createHttpOptions(): HttpOptions;
+}
+export declare const isPrimaryTransport: (t: ITransport) => t is IPrimaryTransport;
+export declare const isHttpTransport: (t: ITransport) => t is IHttpTransport;
+export declare const isMicroserviceTransport: (t: ITransport) => t is IMicroserviceTransport;

package/dist/types/transports.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMicroserviceTransport = exports.isHttpTransport = exports.isPrimaryTransport = void 0;
+const isPrimaryTransport = (t) => typeof t.getHealthController === 'function' &&
+    typeof t.getMetricsController === 'function';
+exports.isPrimaryTransport = isPrimaryTransport;
+const isHttpTransport = (t) => t.getProtocol() === 'http';
+exports.isHttpTransport = isHttpTransport;
+const isMicroserviceTransport = (t) => typeof t.createMicroserviceOptions === 'function';
+exports.isMicroserviceTransport = isMicroserviceTransport;
+//# sourceMappingURL=transports.js.map

package/dist/types/transports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transports.js","sourceRoot":"","sources":["../../src/types/transports.ts"],"names":[],"mappings":";;;AAmGO,MAAM,kBAAkB,GAAG,CAAC,CAAa,EAA0B,EAAE,CAC1E,OAAQ,CAAuB,CAAC,mBAAmB,KAAK,UAAU;IAClE,OAAQ,CAAuB,CAAC,oBAAoB,KAAK,UAAU,CAAC;AAFzD,QAAA,kBAAkB,sBAEuC;AAE/D,MAAM,eAAe,GAAG,CAAC,CAAa,EAAuB,EAAE,CACpE,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;AADhB,QAAA,eAAe,mBACC;AAEtB,MAAM,uBAAuB,GAAG,CACrC,CAAa,EACgB,EAAE,CAC/B,OAAQ,CAA4B,CAAC,yBAAyB,KAAK,UAAU,CAAC;AAHnE,QAAA,uBAAuB,2BAG4C"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@rsdk/core",
+  "version": "0.14.0",
+  "description": "Nestjs based microservice chassis",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rm -rf dist/ && tsc",
+    "clean": "rm -rf dist/ node_modules/",
+    "compile:watch": "tsc -w",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint \"src/**/*.ts\" -f codeframe",
+    "lint:fix": "eslint \"src/**/*.ts\" -f codeframe --fix"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "1.4.0",
+    "@opentelemetry/auto-instrumentations-node": "0.36.1",
+    "@opentelemetry/context-async-hooks": "1.9.1",
+    "@opentelemetry/core": "1.9.1",
+    "@opentelemetry/exporter-trace-otlp-http": "0.35.1",
+    "@opentelemetry/propagator-b3": "1.9.1",
+    "@opentelemetry/resources": "1.9.1",
+    "@opentelemetry/sdk-node": "0.35.1",
+    "@opentelemetry/sdk-trace-base": "1.9.1",
+    "@opentelemetry/semantic-conventions": "1.9.1",
+    "prom-client": "^14.2.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/microservices": "^9.0.0",
+    "@rsdk/common": "^0.14.0",
+    "@rsdk/decorators": "^0.14.0",
+    "@rsdk/logging": "^0.14.0",
+    "axios": "^1.1.3",
+    "lodash": "^4.17.21",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.0.0"
+  },
+  "devDependencies": {
+    "@rsdk/prettier-config": "*",
+    "@rsdk/tsconfig": "*",
+    "@types/lodash": "^4.14.192",
+    "eslint-config-rsdk": "*"
+  },
+  "gitHead": "e05337f5e9aa6242fe74f7ca5a4b3122765a77c0"
+}

package/src/app/platform.app.ts

@@ -0,0 +1,52 @@
+import type { INestApplication } from '@nestjs/common/interfaces';
+import { NestFactory } from '@nestjs/core';
+
+import { PlatformContext } from '../platform.context';
+import type { PlatformAppMetadata, PlatformAppOptions } from '../types';
+
+/**
+ * Platform application itself.
+ *
+ * Just instantiate it, call run() method, and you are
+ * ready to go!
+ */
+export class PlatformApp {
+  private readonly context: PlatformContext;
+
+  constructor(readonly platformAppOptions: PlatformAppOptions) {
+    this.context = new PlatformContext(platformAppOptions);
+  }
+
+  /**
+   * Get all important information about PlatformApp instance
+   * @returns Readonly metadata
+   */
+  getMetadata(): Readonly<PlatformAppMetadata> {
+    return this.context.getMetadata();
+  }
+
+  /**
+   * Runs application.
+   * @returns Promise<void>
+   */
+  async run(): Promise<void> {
+    const context = this.context;
+    const app = await this.createApplication();
+
+    await context.runConfiguredApplication(app);
+  }
+
+  /**
+   * Создание и конфигурирование приложения по стандартному сценарию
+   * Не путать с запуском
+   * @private
+   */
+  private async createApplication(): Promise<INestApplication> {
+    const context = this.context;
+    const nestContext = context.getNestFactoryCreateOptions();
+    const app = await NestFactory.create(context.root, ...nestContext);
+
+    await context.configureApp(app);
+    return app;
+  }
+}

package/src/app-metadata/app-metadata.const.ts

@@ -0,0 +1,3 @@
+export const APP_NAME = Symbol('APP_NAME_TOKEN');
+export const APP_DESCRIPTION = Symbol('APP_DESCRIPTION_TOKEN');
+export const APP_VERSION = Symbol('APP_VERSION_TOKEN');

package/src/app-metadata/app-metadata.module.ts

@@ -0,0 +1,34 @@
+import type { DynamicModule, Provider } from '@nestjs/common';
+import { Module } from '@nestjs/common';
+
+import type { PlatformExtendedOptions } from '../types';
+
+import { APP_DESCRIPTION, APP_NAME, APP_VERSION } from './app-metadata.const';
+
+@Module({})
+export class AppMetadataModule {
+  static forRoot(options: PlatformExtendedOptions): DynamicModule {
+    const providers: Provider[] = [
+      {
+        provide: APP_NAME,
+        useValue: options.name,
+      },
+      {
+        provide: APP_DESCRIPTION,
+        useValue: options.description,
+      },
+      {
+        provide: APP_VERSION,
+        useValue: options.version,
+      },
+    ];
+
+    return {
+      global: true,
+      module: AppMetadataModule,
+      providers,
+
+      exports: providers,
+    };
+  }
+}

package/src/app-metadata/app-name.const.ts

@@ -0,0 +1 @@
+export const APP_NAME_PATTERN = /^[a-z][a-z-]*\.[a-z-.]*[a-z]$/;

package/src/app-metadata/app-name.validator.ts

@@ -0,0 +1,11 @@
+import { APP_NAME_PATTERN } from './app-name.const';
+import { InvalidAppNameException } from './exceptions';
+
+export const isValidAppName = (name: string): boolean =>
+  APP_NAME_PATTERN.test(name);
+
+export const assertAppName = (name: string): void => {
+  if (!isValidAppName(name)) {
+    throw new InvalidAppNameException(name);
+  }
+};

package/src/app-metadata/decorators/app-name.decorator.ts

@@ -0,0 +1,5 @@
+import { Inject } from '@nestjs/common';
+
+import { APP_NAME } from '../app-metadata.const';
+
+export const AppName = (): ParameterDecorator => Inject(APP_NAME);

package/src/app-metadata/decorators/index.ts

@@ -0,0 +1 @@
+export * from './app-name.decorator';

package/src/app-metadata/exceptions/app-name-validation.exception.ts

@@ -0,0 +1,23 @@
+import { text } from '@rsdk/common';
+
+import { BootstrapException, Exception } from '../../exceptions';
+import { APP_NAME_PATTERN } from '../app-name.const';
+
+@Exception({
+  description: text`
+    Application name (in package.json) doesn't follow naming
+    conventions.
+  `,
+})
+export class InvalidAppNameException extends BootstrapException {
+  constructor(name: string) {
+    super(text`
+      Application name <${name}> is invalid! It should match regexp
+      ${APP_NAME_PATTERN} which means that it
+      should include 2 or more parts separated with ".".
+      Last one is considered name, others are namespaces.
+      In each part only "a-z" and "-" are allowed!
+      Please fix it in your package.json file.
+    `);
+  }
+}

package/src/app-metadata/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './app-name-validation.exception';

package/src/app-metadata/index.ts

@@ -0,0 +1,2 @@
+export * from './app-metadata.module';
+export * from './app-name.validator';