@biorate/nestjs-tools 1.169.1 → 2.0.0

package/index.d.ts

@@ -1,155 +0,0 @@
-import {
-  ArgumentsHost,
-  CallHandler,
-  CanActivate,
-  ExceptionFilter,
-  ExecutionContext,
-  NestInterceptor,
-  NestMiddleware,
-} from '@nestjs/common';
-import { Request, Response, NextFunction } from 'express';
-import { Observable } from 'rxjs';
-import { Options, RequestHandler } from 'http-proxy-middleware/dist/types';
-import { IPrometheus } from '@biorate/prometheus';
-import { ClientDrivenPort, MetricsDrivenPort, ILocalesDTO } from './interfaces';
-
-export * from './interfaces';
-
-declare module '@biorate/nestjs-tools' {
-  export class GetLocalesDTO implements ILocalesDTO {
-    lang: string;
-    namespace: string;
-  }
-
-  export class PostLocalesDTO extends GetLocalesDTO {}
-
-  export function AuthBasic(): (
-    target: any,
-    propertyKey?: any,
-    descriptor?: TypedPropertyDescriptor<any>,
-  ) => void;
-
-  export function Roles(...roles: number[]): (<T>(
-    target: Object,
-    propertyKey: string | symbol,
-    descriptor: TypedPropertyDescriptor<T>,
-  ) => TypedPropertyDescriptor<T> | void) &
-    (<TFunction extends Function>(target: TFunction) => void | TFunction) & {
-      KEY: symbol;
-    };
-
-  export class AllExceptionsFilter implements ExceptionFilter {
-    public catch(exception: unknown, host: ArgumentsHost): void;
-
-    protected log(exception: unknown): void;
-  }
-
-  export class RoutesInterceptor implements NestInterceptor {
-    public static readonly map: WeakMap<Request, { path: string }>;
-
-    public intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
-  }
-
-  export class TracingInterceptor implements NestInterceptor {
-    public intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
-  }
-
-  export class ProxyPrometheusMiddleware {
-    public static create(options?: Options): RequestHandler;
-  }
-
-  export class RequestCountMiddleware implements NestMiddleware {
-    public use(req: Request, res: Response, next: NextFunction): void;
-  }
-
-  export class ResponseTimeMiddleware implements NestMiddleware {
-    public use(req: Request, res: Response, next: NextFunction): void;
-  }
-
-  export class AuthGuardProvider implements CanActivate {
-    public canActivate(context: ExecutionContext): boolean;
-  }
-
-  export class RolesGuardProvider implements CanActivate {
-    public canActivate(context: ExecutionContext): boolean;
-  }
-
-  export class LocalesController {
-    protected static getFile(
-      namespace: string,
-      lang: string,
-    ): Promise<Record<string, unknown>>;
-
-    protected static getFileSync(
-      namespace: string,
-      lang: string,
-    ): Record<string, unknown>;
-
-    protected static putFile(
-      namespace: string,
-      lang: string,
-      data: Record<string, string>,
-    ): void;
-
-    protected get(param: GetLocalesDTO): Promise<Record<string, unknown>>;
-
-    protected post(param: PostLocalesDTO, body: Record<string, string>): Promise<void>;
-  }
-
-  export class ProbeController {
-    protected readiness(): number;
-
-    protected healthz(): number;
-  }
-
-  export class GetLocaleUseCase {
-    public async execute(
-      lang: string,
-      namespace: string,
-    ): Promise<Record<string, string>>;
-  }
-
-  export class SetLocaleUseCase {
-    public execute(lang: string, namespace: string): Promise<void>;
-  }
-
-  export class GetMetricsUseCase {
-    public execute(): Promise<string>;
-  }
-
-  export class ClientRepositoryAdapter implements ClientDrivenPort {
-    getLang(lang: string, namespace: string): Record<string, string>;
-
-    setLang(data: Record<string, string>, lang: string, namespace: string): void;
-  }
-
-  export class MetricsRepositoryAdapter implements MetricsDrivenPort {
-    get(): Promise<string>;
-  }
-
-  class ClientController {
-    protected readonly getLoc: GetLocaleUseCase;
-    protected readonly setLoc: SetLocaleUseCase;
-
-    protected getLocale(param: GetLocalesDTO): Promise<Record<string, string>>;
-
-    protected postLocale(
-      param: PostLocalesDTO,
-      body: Record<string, string>,
-    ): Promise<void>;
-  }
-
-  class MetricsController {
-    protected readonly getMetrics: GetMetricsUseCase;
-
-    protected metrics(): Promise<void>;
-  }
-
-  // @ts-ignore
-  export const controllers = { ClientController, MetricsController, ProbeController };
-
-  export function corsOriginHandler(
-    origin: string,
-    callback: (error: null | Error, origin: string) => void,
-  ): void;
-}

package/interfaces/index.ts

@@ -1,11 +0,0 @@
-export * from './ports';
-
-export enum UserRoles {
-  Basic = 1 << 0,
-  Admin = 1 << 1,
-}
-
-export interface ILocalesDTO {
-  lang: string;
-  namespace: string;
-}

package/interfaces/ports/client.driven.port.ts

@@ -1,5 +0,0 @@
-export interface ClientDrivenPort {
-  getLang(lang: string, namespace: string): Record<string, string>;
-
-  setLang(data: Record<string, string>, lang: string, namespace: string): void;
-}

package/interfaces/ports/crud.driven.port.ts

@@ -1,57 +0,0 @@
-export type CrudFindOneDrivenPort<E, I, T = unknown> = {
-  findOne(id: I, transaction?: T): Promise<E>;
-};
-
-export type CrudFindManyDrivenPort<
-  E,
-  F = { offset: number; limit: number },
-  R = { total: number; offset: number; limit: number; items: E[] },
-  T = unknown,
-> = {
-  findMany(filter?: F, transaction?: T): Promise<R>;
-};
-
-export type CrudUpdateOneDrivenPort<E, I, D = E, T = unknown> = {
-  updateOne(id: I, data: D, transaction?: T): Promise<E>;
-};
-
-export type CrudUpdateManyDrivenPort<E, C, D = E[], T = unknown> = {
-  updateMany(criteria: C, data: D, transaction?: T): Promise<E[]>;
-};
-
-export type CrudInsertOneDrivenPort<E, T = unknown> = {
-  insertOne(data: E, transaction?: T): Promise<E>;
-};
-
-export type CrudInsertManyDrivenPort<E, R = E[], T = unknown> = {
-  insertMany(items: E[], transaction?: T): Promise<R>;
-};
-
-export type CrudDeleteOneDrivenPort<I, R = boolean, T = unknown> = {
-  deleteOne(id: I, transaction?: T): Promise<R>;
-};
-
-export type CrudDeleteManyDrivenPort<CD, R = number, T = unknown> = {
-  deleteMany(criteria?: CD, transaction?: T): Promise<R>;
-};
-
-export type CrudDrivenPort<
-  Id,
-  Entity,
-  FindManyFilter,
-  InsertManyResult,
-  UpdateManyCriteria,
-  DeleteCriteria,
-  FindManyresult = Entity[],
-  UpdateData = Entity,
-  DeleteOneResult = boolean,
-  DeleteManyResult = number,
-  Transaction = unknown,
-> = CrudFindOneDrivenPort<Entity, Id, Transaction> &
-  CrudFindManyDrivenPort<Entity, FindManyFilter, FindManyresult, Transaction> &
-  CrudUpdateOneDrivenPort<Entity, Id, UpdateData, Transaction> &
-  CrudUpdateManyDrivenPort<Entity, UpdateManyCriteria, UpdateData[], Transaction> &
-  CrudInsertOneDrivenPort<Entity, Transaction> &
-  CrudInsertManyDrivenPort<Entity, InsertManyResult, Transaction> &
-  CrudDeleteOneDrivenPort<Id, DeleteOneResult, Transaction> &
-  CrudDeleteManyDrivenPort<DeleteCriteria, DeleteManyResult, Transaction>;

package/src/app/application/service/client/get-locale.use-case.ts

@@ -1,13 +0,0 @@
-import { Inject, Injectable } from '@nestjs/common';
-import { Types } from '@biorate/inversion';
-import { ClientDrivenPort } from '../../ports';
-
-@Injectable()
-export class GetLocaleUseCase {
-  @Inject(Types.ClientDrivenPort)
-  protected readonly clientProvider: ClientDrivenPort;
-
-  public async execute(lang: string, namespace: string) {
-    return this.clientProvider.getLang(lang, namespace);
-  }
-}

package/src/app/application/service/client/set-locale.use-case.ts

@@ -1,13 +0,0 @@
-import { Inject, Injectable } from '@nestjs/common';
-import { Types } from '@biorate/inversion';
-import { ClientDrivenPort } from '../../ports';
-
-@Injectable()
-export class SetLocaleUseCase {
-  @Inject(Types.ClientDrivenPort)
-  protected readonly clientProvider: ClientDrivenPort;
-
-  public async execute(data: Record<string, string>, lang: string, namespace: string) {
-    return this.clientProvider.setLang(data, lang, namespace);
-  }
-}

package/src/app/application/service/metrics/get-metrics.use-case.ts

@@ -1,13 +0,0 @@
-import { Inject, Injectable } from '@nestjs/common';
-import { Types } from '@biorate/inversion';
-import { MetricsDrivenPort } from '../../ports';
-
-@Injectable()
-export class GetMetricsUseCase {
-  @Inject(Types.MetricsDrivenPort)
-  protected readonly metricsProvider: MetricsDrivenPort;
-
-  public async execute() {
-    return this.metricsProvider.get();
-  }
-}

package/src/app/infrastructure/adapters/client.repository.adapter.ts

@@ -1,35 +0,0 @@
-import { merge } from 'lodash';
-import { mkdirSync, writeFileSync, readFileSync } from 'fs';
-import { Injectable } from '@nestjs/common';
-import { path } from '@biorate/tools';
-import { ClientDrivenPort } from '../../application';
-
-@Injectable()
-export class ClientRepositoryAdapter implements ClientDrivenPort {
-  public getLang(lang: string, namespace: string) {
-    try {
-      return JSON.parse(
-        readFileSync(
-          path.create(process.cwd(), 'locales', namespace, `${lang}.json`),
-          'utf-8',
-        ),
-      );
-    } catch {
-      return {};
-    }
-  }
-
-  public setLang(data: Record<string, string>, lang: string, namespace: string) {
-    try {
-      const directory = path.create(process.cwd(), 'locales', namespace);
-      mkdirSync(directory, { recursive: true });
-      writeFileSync(
-        path.create(directory, `${lang}.json`),
-        JSON.stringify(merge(this.getLang(lang, namespace), data), null, '  '),
-        'utf-8',
-      );
-    } catch (e) {
-      console.warn(e);
-    }
-  }
-}

package/src/app/infrastructure/adapters/metrics.repository.adapter.ts

@@ -1,13 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { inject, Types } from '@biorate/inversion';
-import { IPrometheus } from '@biorate/prometheus';
-import { MetricsDrivenPort } from '../../application';
-
-@Injectable()
-export class MetricsRepositoryAdapter implements MetricsDrivenPort {
-  @inject(Types.Prometheus) protected prometheus: IPrometheus;
-
-  public get() {
-    return this.prometheus.registry.metrics();
-  }
-}

package/src/app/infrastructure/controllers/client.controller.ts

@@ -1,28 +0,0 @@
-import { Controller, Get, Post, Param, Body, Header } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { GetLocaleUseCase, SetLocaleUseCase } from '../../application';
-import { GetLocalesDTO, PostLocalesDTO } from './dto';
-
-@ApiTags('Client')
-@Controller('client')
-export class ClientController {
-  public constructor(
-    protected readonly getLoc: GetLocaleUseCase,
-    protected readonly setLoc: SetLocaleUseCase,
-  ) {}
-
-  @Get('locale/:lang/:namespace')
-  @ApiOperation({ summary: 'Get locale' })
-  protected getLocale(@Param() param: GetLocalesDTO) {
-    return this.getLoc.execute(param.lang, param.namespace);
-  }
-
-  @Post('locale/:lang/:namespace')
-  @ApiOperation({ summary: 'Put locale' })
-  protected async postLocale(
-    @Param() param: PostLocalesDTO,
-    @Body() body: Record<string, string>,
-  ) {
-    return this.setLoc.execute(body, param.lang, param.namespace);
-  }
-}

package/src/app/infrastructure/controllers/dto/locales.ts

@@ -1,15 +0,0 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { IsString } from 'class-validator';
-import { ILocalesDTO } from '../../../../../interfaces';
-
-export class GetLocalesDTO implements ILocalesDTO {
-  @IsString()
-  @ApiProperty({ type: String, required: true })
-  lang: string;
-
-  @IsString()
-  @ApiProperty({ type: String, required: true })
-  namespace: string;
-}
-
-export class PostLocalesDTO extends GetLocalesDTO {}

package/src/app/infrastructure/controllers/metrics.controller.ts

@@ -1,16 +0,0 @@
-import { Controller, Get, Header } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { GetMetricsUseCase } from '../../application';
-
-@ApiTags('Metrics')
-@Controller('metrics')
-export class MetricsController {
-  public constructor(protected readonly getMetrics: GetMetricsUseCase) {}
-
-  @Get()
-  @Header('content-type', 'text/plain')
-  @ApiOperation({ summary: 'Prometheus metrics hook' })
-  protected async metrics() {
-    return this.getMetrics.execute();
-  }
-}

package/src/app/infrastructure/controllers/probe.controller.ts

@@ -1,18 +0,0 @@
-import { Controller, Get } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
-
-@ApiTags('Probe')
-@Controller('probe')
-export class ProbeController {
-  @Get('readiness')
-  @ApiOperation({ summary: 'Readiness probe' })
-  protected readiness() {
-    return 1;
-  }
-
-  @Get('healthz')
-  @ApiOperation({ summary: 'Healthz probe' })
-  protected healthz() {
-    return 1;
-  }
-}

package/src/cors.ts

@@ -1,19 +0,0 @@
-import { container, Types } from '@biorate/inversion';
-import { IConfig } from '@biorate/config';
-import { CorsBadOriginError } from './errors';
-
-export function corsOriginHandler(
-  origin: string,
-  callback: (error: null | Error, origin: string) => void,
-) {
-  if (!origin) return callback(null, origin);
-  const config = container.get<IConfig>(Types.Config);
-  if (config.get<string>('ENV') === 'debug') return callback(null, origin);
-  const regexp = new RegExp(
-    config.get<string>(
-      'ALLOWED_ORIGIN',
-      config.get<string>('package.name').replace('-server', ''),
-    ),
-  );
-  callback(regexp.test(origin) ? null : new CorsBadOriginError(origin), origin);
-}

package/src/decorators/auth.ts

@@ -1,9 +0,0 @@
-import { UseGuards } from '@nestjs/common';
-import { ApiBasicAuth } from '@nestjs/swagger';
-import { AuthGuardProvider } from '../providers';
-
-export const AuthBasic =
-  () => (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => {
-    ApiBasicAuth()(target, propertyKey!, descriptor!);
-    UseGuards(AuthGuardProvider)(target, propertyKey!, descriptor!);
-  };

package/src/decorators/roles.ts

@@ -1,12 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-
-export const ROLES_KEY = Symbol('RolesKey');
-
-export const Roles = (...roles: number[]) =>
-  SetMetadata(
-    ROLES_KEY,
-    roles.reduce((memo, item) => {
-      memo |= item;
-      return memo;
-    }, 0),
-  );

package/src/errors.ts

@@ -1,19 +0,0 @@
-import { BaseError } from '@biorate/errors';
-
-export class UnsupportedProtocolError extends BaseError {
-  public constructor(name: string) {
-    super(`Unsupported protocol: [%s]`, [name]);
-  }
-}
-
-export class AxiosRequestError extends BaseError {
-  public constructor(code: number, error: string, message: string) {
-    super(`Axios request error (%s) [%s]: %s`, [code, error, message]);
-  }
-}
-
-export class CorsBadOriginError extends BaseError {
-  public constructor(origin: string) {
-    super(`Cors bad origin error: [%s]`, [origin]);
-  }
-}

package/src/filters/all-exception-filter.ts

@@ -1,91 +0,0 @@
-import { AxiosError } from '@biorate/axios';
-import { BaseError } from '@biorate/errors';
-import { WebSocket } from 'ws';
-import {
-  ExceptionFilter,
-  Catch,
-  ArgumentsHost,
-  HttpException,
-  HttpStatus,
-  BadRequestException,
-} from '@nestjs/common';
-import { AxiosRequestError, UnsupportedProtocolError } from '../errors';
-
-@Catch()
-export class AllExceptionsFilter implements ExceptionFilter {
-  public catch(exception: Error, host: ArgumentsHost) {
-    const type = host.getType();
-    const method = <`_${typeof type}`>`_${type}`;
-    if (!this[method]) throw new UnsupportedProtocolError(host.getType());
-    this[method](exception, host);
-  }
-
-  private _http(exception: Error, host: ArgumentsHost) {
-    const ctx = host.switchToHttp();
-    const response = ctx.getResponse();
-    const request = ctx.getRequest();
-    const meta = (exception as BaseError)?.meta;
-    const status =
-      exception instanceof HttpException
-        ? exception.getStatus()
-        : meta?.status ?? HttpStatus.INTERNAL_SERVER_ERROR;
-    this.log(exception);
-    response.status(status).json({
-      status,
-      code: this.code(exception),
-      hint: this.hint(exception),
-      path: request.url,
-      meta: meta?.meta,
-    });
-  }
-
-  private _ws(exception: Error, host: ArgumentsHost) {
-    const ctx = host.switchToWs();
-    const socket = ctx.getClient<WebSocket>();
-    const meta = (exception as BaseError)?.meta;
-    const status = meta?.status ?? HttpStatus.INTERNAL_SERVER_ERROR;
-    this.log(exception);
-    socket.send(
-      //TODO: add serializers factory
-      JSON.stringify({
-        event: 'error',
-        data: {
-          status,
-          code: this.code(exception),
-          hint: this.hint(exception),
-          meta: meta?.meta,
-        },
-      }),
-    );
-  }
-
-  private _rpc(exception: Error, host: ArgumentsHost) {
-    throw new UnsupportedProtocolError('rpc');
-  }
-
-  private code(exception: Error) {
-    return (<BaseError>exception).code ?? exception.constructor.name;
-  }
-
-  private hint(exception: Error) {
-    return (
-      (
-        (<BadRequestException>exception)?.getResponse?.() as {
-          message?: [string];
-        }
-      )?.message ?? (<BaseError>exception).message
-    );
-  }
-
-  protected log(exception: Error) {
-    if (exception instanceof AxiosError)
-      console.error(
-        new AxiosRequestError(
-          exception?.response?.data?.statusCode,
-          exception?.response?.data?.error,
-          exception?.response?.data?.message,
-        ).stack,
-      );
-    else console.error(exception.stack);
-  }
-}

package/src/http/controllers/locales.ts

@@ -1,79 +0,0 @@
-import { Controller, Get, Post, Param, Body, Header } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { path } from '@biorate/tools';
-import { promises as fs, readFileSync, writeFileSync, mkdirSync } from 'fs';
-import { merge } from 'lodash';
-import { GetLocalesDTO, PostLocalesDTO } from '../dto';
-
-@ApiTags('Locales')
-@Controller('locales')
-export class LocalesController {
-  protected static async getFile(namespace: string, lang: string) {
-    try {
-      return JSON.parse(
-        await fs.readFile(
-          path.create(process.cwd(), 'locales', namespace, `${lang}.json`),
-          'utf-8',
-        ),
-      );
-    } catch {
-      return {};
-    }
-  }
-
-  protected static getFileSync(namespace: string, lang: string) {
-    try {
-      return JSON.parse(
-        readFileSync(
-          path.create(process.cwd(), 'locales', namespace, `${lang}.json`),
-          'utf-8',
-        ),
-      );
-    } catch {
-      return {};
-    }
-  }
-
-  protected static putFile(
-    namespace: string,
-    lang: string,
-    data: Record<string, string>,
-  ) {
-    try {
-      const directory = path.create(process.cwd(), 'locales', namespace);
-      mkdirSync(directory, { recursive: true });
-      writeFileSync(
-        path.create(directory, `${lang}.json`),
-        JSON.stringify(data, null, '  '),
-        'utf-8',
-      );
-    } catch (e) {
-      console.warn(e);
-    }
-  }
-
-  @Get(':lang/:namespace')
-  @Header(
-    'Deprecation',
-    'Use domain controller instead [@biorate/nestjs-tools >= v1.121.0]',
-  )
-  @ApiOperation({ summary: 'Get locales', deprecated: true })
-  protected get(@Param() param: GetLocalesDTO) {
-    return LocalesController.getFile(param.namespace, param.lang);
-  }
-
-  @Post(':lang/:namespace')
-  @Header(
-    'Deprecation',
-    'Use domain controller instead [@biorate/nestjs-tools >= v1.121.0]',
-  )
-  @ApiOperation({ summary: 'Put locales', deprecated: true })
-  protected async post(
-    @Param() param: PostLocalesDTO,
-    @Body() body: Record<string, string>,
-  ) {
-    const data = LocalesController.getFileSync(param.namespace, param.lang);
-    const result = merge(data, body);
-    LocalesController.putFile(param.namespace, param.lang, result);
-  }
-}

package/src/http/controllers/metrics.ts

@@ -1,21 +0,0 @@
-import { inject, Types } from '@biorate/inversion';
-import { Controller, Get, Header } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { IPrometheus } from '@biorate/prometheus';
-
-@ApiTags('Metrics')
-@Controller('metrics')
-export class MetricsController {
-  @inject(Types.Prometheus) protected prometheus: IPrometheus;
-
-  @Get()
-  @Header('content-type', 'text/plain')
-  @Header(
-    'Deprecation',
-    'Use domain controller instead [@biorate/nestjs-tools >= v1.121.0]',
-  )
-  @ApiOperation({ summary: 'Prometheus metrics hook', deprecated: true })
-  protected async metrics() {
-    return this.prometheus.registry.metrics();
-  }
-}