@ask-ell/back-end 0.2.4 → 0.2.6

package/src/secrets/local.secret.getter.d.ts

@@ -0,0 +1,3 @@
+import { FileSecretGetter } from './file.secret.getter';
+export declare const localSecretGetter: FileSecretGetter;
+//# sourceMappingURL=local.secret.getter.d.ts.map

package/src/secrets/local.secret.getter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.secret.getter.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/secrets/local.secret.getter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAI1E,eAAO,MAAM,iBAAiB,EAAE,gBAI/B,CAAC"}

package/src/secrets/local.secret.getter.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localSecretGetter = void 0;
+const file_secret_getter_1 = require("./file.secret.getter");
+const LOCAL_SECRETS_DIRECTORY = '.secrets';
+exports.localSecretGetter = (0, file_secret_getter_1.fileSecretGetter)(LOCAL_SECRETS_DIRECTORY)('Secrets directory not exists on this project. Local secrets will be unavailable.');

package/src/secrets/{types.ts → types.d.ts}

@@ -1 +1,2 @@
 export type SecretGetter = () => object;
+//# sourceMappingURL=types.d.ts.map

package/src/secrets/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/secrets/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC"}

package/src/secrets/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/tmp.d.ts

@@ -0,0 +1,4 @@
+import { ILogger } from '@ask-ell/core';
+export declare const TMP_FOLDER_PATH: string;
+export declare const createTmpFolder: (logger: ILogger) => void;
+//# sourceMappingURL=tmp.d.ts.map

package/src/tmp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tmp.d.ts","sourceRoot":"","sources":["../../../../packages/back-end/src/tmp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAIxC,eAAO,MAAM,eAAe,EAAE,MAAmC,CAAC;AAElE,eAAO,MAAM,eAAe,GAAI,QAAQ,OAAO,KAAG,IAQjD,CAAC"}

package/src/tmp.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTmpFolder = exports.TMP_FOLDER_PATH = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+exports.TMP_FOLDER_PATH = (0, node_path_1.join)(process.cwd(), 'tmp');
+const createTmpFolder = (logger) => {
+    const isTmpFolderExists = (0, node_fs_1.existsSync)(exports.TMP_FOLDER_PATH);
+    if (isTmpFolderExists) {
+        logger.info(`"${exports.TMP_FOLDER_PATH}" folder already exists.`);
+        return;
+    }
+    (0, node_fs_1.mkdirSync)(exports.TMP_FOLDER_PATH);
+    logger.info(`"${exports.TMP_FOLDER_PATH}" folder created.`);
+};
+exports.createTmpFolder = createTmpFolder;

package/.spec.swcrc

@@ -1,22 +0,0 @@
-{
-  "jsc": {
-    "target": "es2017",
-    "parser": {
-      "syntax": "typescript",
-      "decorators": true,
-      "dynamicImport": true
-    },
-    "transform": {
-      "decoratorMetadata": true,
-      "legacyDecorator": true
-    },
-    "keepClassNames": true,
-    "externalHelpers": true,
-    "loose": true
-  },
-  "module": {
-    "type": "es6"
-  },
-  "sourceMaps": true,
-  "exclude": []
-}

package/dist/tsconfig.lib.tsbuildinfo

@@ -1 +0,0 @@
-{"version":"6.0.3"}

package/eslint.config.mjs

@@ -1,22 +0,0 @@
-import baseConfig from '../../eslint.config.mjs';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: await import('jsonc-eslint-parser'),
-    },
-  },
-  {
-    ignores: ['**/out-tsc'],
-  },
-];

package/jest.config.ts

@@ -1,20 +0,0 @@
-import { readFileSync } from 'fs';
-
-// Reading the SWC compilation config for the spec files
-const swcJestConfig = JSON.parse(
-  readFileSync(`${__dirname}/.spec.swcrc`, 'utf-8')
-);
-
-// Disable .swcrc look-up by SWC core because we're passing in swcJestConfig ourselves
-swcJestConfig.swcrc = false;
-
-export default {
-  displayName: '@ask-ell/back-end',
-  preset: '../../jest.preset.js',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.[tj]s$': ['@swc/jest', swcJestConfig],
-  },
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: 'test-output/jest/coverage',
-};

package/project.json

@@ -1,26 +0,0 @@
-{
-  "name": "back-end",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/back-end/src",
-  "projectType": "library",
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "dependsOn": ["^build"],
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/packages/back-end",
-        "main": "packages/back-end/src/index.ts",
-        "tsConfig": "packages/back-end/tsconfig.lib.json",
-        "assets": ["packages/back-end/*.md"]
-      }
-    },
-    "test": {
-      "options": {
-        "passWithNoTests": true
-      }
-    },
-    "format": {}
-  }
-}

package/src/http/index.ts

@@ -1 +0,0 @@
-export * from './types';

package/src/http/types.ts

@@ -1,4 +0,0 @@
-export type HttpResponseBody<Data = unknown> = {
-  message: string;
-  data?: Data;
-};

package/src/keyv.store.adapter.factory.ts

@@ -1,43 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { KeyvStoreAdapter } from 'keyv';
-import KeyvSqlite from '@keyv/sqlite';
-import KeyvPostgres from '@keyv/postgres';
-import { ILogger, MaybeUndefined } from '@ask-ell/core';
-import { NestLogger } from '@ask-ell/nest';
-import { join } from 'node:path';
-
-import { createTmpFolder, TMP_FOLDER_PATH } from './tmp';
-
-export type CreateKeyvStoreAdapterOptions = {
-  postgresUri: MaybeUndefined<string>;
-};
-
-@Injectable()
-export class KeyvStoreAdapterFactory {
-  private logger: ILogger = NestLogger.fromClass(KeyvStoreAdapterFactory);
-
-  create(options: CreateKeyvStoreAdapterOptions): KeyvStoreAdapter {
-    const adapter: KeyvStoreAdapter = this.getKeyvStoreAdapter(options);
-    this.logger.log(
-      `Connected to database with adapter "${adapter.constructor.name}"`
-    );
-    return adapter;
-  }
-
-  private getKeyvStoreAdapter({
-    postgresUri,
-  }: CreateKeyvStoreAdapterOptions): KeyvStoreAdapter {
-    if (!postgresUri) {
-      createTmpFolder(this.logger);
-      const localDatabaseFilePath: string = join(
-        TMP_FOLDER_PATH,
-        'database.sqlite'
-      );
-      return new KeyvSqlite(localDatabaseFilePath);
-    }
-
-    return new KeyvPostgres({
-      uri: postgresUri,
-    });
-  }
-}

package/src/nest/add-ons/add-on.interface.ts

@@ -1,5 +0,0 @@
-import { INestApplication } from '@nestjs/common';
-
-export interface IAddOn<T> {
-  apply(application: INestApplication<T>): void;
-}

package/src/nest/add-ons/add-on.wrapper.ts

@@ -1,31 +0,0 @@
-import { INestApplication } from '@nestjs/common';
-
-import { IAddOn } from './add-on.interface';
-import { SecurityAddOn } from './implementations/security/security.add-on';
-import { AddOnWrapperParams } from './types';
-import { SwaggerAddon } from './implementations/swagger/swagger.add-on';
-import { SentryAddon } from './implementations/sentry/sentry.add-on';
-
-export class AddOnWrapper<T> implements IAddOn<T> {
-  private implementations: IAddOn<T>[] = [new SecurityAddOn()];
-
-  constructor(private params: AddOnWrapperParams) {
-    this.appendImplementations();
-  }
-
-  apply(application: INestApplication<T>): void {
-    this.implementations.forEach((addOn: IAddOn<T>): void => {
-      addOn.apply(application);
-    });
-  }
-
-  private appendImplementations(): void {
-    const { sentry, swagger } = this.params;
-    if (swagger) {
-      this.implementations.push(new SwaggerAddon(swagger));
-    }
-    if (sentry) {
-      this.implementations.push(new SentryAddon(sentry));
-    }
-  }
-}

package/src/nest/add-ons/implementations/security/security.add-on.ts

@@ -1,17 +0,0 @@
-import { INestApplication, ValidationPipe } from '@nestjs/common';
-import helmet from 'helmet';
-
-import { IAddOn } from '../../add-on.interface';
-
-export class SecurityAddOn<T> implements IAddOn<T> {
-  apply(application: INestApplication<T>): void {
-    application.enableCors();
-    application.use(helmet());
-    application.useGlobalPipes(
-      new ValidationPipe({
-        transform: true,
-        whitelist: false,
-      })
-    );
-  }
-}

package/src/nest/add-ons/implementations/sentry/sentry.add-on.state.interface.ts

@@ -1,5 +0,0 @@
-export interface ISentryAddOnState {
-  publicKey: string;
-  host: string;
-  projectId: string;
-}

package/src/nest/add-ons/implementations/sentry/sentry.add-on.ts

@@ -1,24 +0,0 @@
-import { Entity, type IResult, ok } from '@ask-ell/core';
-import { NestSentryConfiguration } from '@ask-ell/nest';
-
-import { ISentryAddOnState } from './sentry.add-on.state.interface';
-import { ISentryAddOn } from './sentry.add-on.interface';
-
-export class SentryAddon<T>
-  extends Entity<ISentryAddOnState>
-  implements ISentryAddOn<T>
-{
-  checkStateValidity(): IResult<void> {
-    return ok();
-  }
-
-  apply(): void {
-    const { host, projectId, publicKey } = this.getSnapshot();
-
-    new NestSentryConfiguration({
-      publicKey,
-      host,
-      projectId,
-    }).init();
-  }
-}

package/src/nest/add-ons/implementations/swagger/swagger.add-on.state.interface.ts

@@ -1,7 +0,0 @@
-import { AuthMethod } from './types';
-
-export interface ISwaggerAddOnState {
-  title: string;
-  auths?: AuthMethod[];
-  enabledInProduction?: boolean;
-}

package/src/nest/add-ons/implementations/swagger/swagger.add-on.ts

@@ -1,59 +0,0 @@
-import {
-  Entity,
-  ILogger,
-  type IResult,
-  isOnDevelopmentMode,
-  ok,
-} from '@ask-ell/core';
-import { NestLogger } from '@ask-ell/nest';
-import { type INestApplication } from '@nestjs/common';
-import {
-  DocumentBuilder,
-  type OpenAPIObject,
-  SwaggerModule,
-} from '@nestjs/swagger';
-
-import { ISwaggerAddOnState } from './swagger.add-on.state.interface';
-import { ISwaggerAddOn } from './swagger.add-on.interface';
-import { AuthMethod } from './types';
-
-export class SwaggerAddon<T>
-  extends Entity<ISwaggerAddOnState>
-  implements ISwaggerAddOn<T>
-{
-  private logger: ILogger = NestLogger.fromClass(SwaggerAddon);
-
-  checkStateValidity(): IResult<void> {
-    return ok();
-  }
-
-  apply(application: INestApplication<T>): void {
-    const { title, auths, enabledInProduction } = this.getSnapshot();
-
-    if (!enabledInProduction && !isOnDevelopmentMode()) {
-      return;
-    }
-
-    const documentBuilder: DocumentBuilder = new DocumentBuilder().setTitle(
-      title
-    );
-
-    auths?.forEach((auth: AuthMethod): void => {
-      if (auth === 'bearer') {
-        documentBuilder.addBearerAuth();
-      }
-    });
-
-    const documentBuild: Omit<OpenAPIObject, 'paths'> = documentBuilder.build();
-
-    const documentFactory = (): OpenAPIObject =>
-      SwaggerModule.createDocument(application, documentBuild);
-
-    SwaggerModule.setup('/swagger', application, documentFactory, {
-      customSiteTitle: title,
-      jsonDocumentUrl: '/swagger/json',
-    });
-
-    this.logger.log('Swagger initialized');
-  }
-}

package/src/nest/application.base.ts

@@ -1,18 +0,0 @@
-import { DynamicModule, Provider, Module, Global } from '@nestjs/common';
-
-import { RequirementModule } from './modules';
-
-@Global()
-@Module({
-  imports: [RequirementModule],
-})
-export class ApplicationBase {
-  static withProviders(providers: Provider[]): DynamicModule {
-    const providersAndExports: Provider[] = [...providers];
-    return {
-      module: this,
-      providers: providersAndExports,
-      exports: [...providersAndExports],
-    };
-  }
-}

package/src/nest/application.factory.ts

@@ -1,23 +0,0 @@
-import { ConsoleLogger, DynamicModule, INestApplication } from '@nestjs/common';
-import { NestFactory } from '@nestjs/core';
-import { IServerProvider } from '@ask-ell/node';
-
-import { AddOnWrapper, AddOnWrapperParams } from './add-ons';
-
-export type NestApplicationFactoryParams = {
-  addons: AddOnWrapperParams;
-  module: DynamicModule;
-};
-
-export async function createNestApplication({
-  module,
-  addons: addonsParams,
-}: NestApplicationFactoryParams): Promise<IServerProvider> {
-  const application: INestApplication = await NestFactory.create(module, {
-    logger: new ConsoleLogger({
-      json: true,
-    }),
-  });
-  new AddOnWrapper(addonsParams).apply(application);
-  return application;
-}

package/src/nest/filters/http.exception.filter.ts

@@ -1,23 +0,0 @@
-import {
-  type ExceptionFilter,
-  type ArgumentsHost,
-  Catch,
-  HttpException,
-} from '@nestjs/common';
-import type { HttpArgumentsHost } from '@nestjs/common/interfaces';
-import type { Response } from 'express';
-
-import type { HttpResponseBody } from '../../http';
-
-@Catch(HttpException)
-export class HttpExceptionFilter implements ExceptionFilter {
-  catch(exception: HttpException, host: ArgumentsHost): void {
-    const context: HttpArgumentsHost = host.switchToHttp();
-    const response: Response = context.getResponse<Response>();
-    const status: number = exception.getStatus();
-    const responseData: HttpResponseBody = {
-      message: exception.message,
-    };
-    response.status(status).json(responseData);
-  }
-}

package/src/nest/interceptors/error.interceptor.ts

@@ -1,25 +0,0 @@
-import { Entity, IResult, ok } from '@ask-ell/core';
-import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
-import { catchError, Observable, throwError } from 'rxjs';
-
-export type ErrorInterceptorProps = {
-  errorConvertor: (error: unknown) => unknown;
-};
-
-export class ErrorInterceptor
-  extends Entity<ErrorInterceptorProps>
-  implements NestInterceptor
-{
-  override checkStateValidity(): IResult {
-    return ok();
-  }
-
-  intercept(_: ExecutionContext, next: CallHandler): Observable<unknown> {
-    const { errorConvertor } = this.getSnapshot();
-    return next.handle().pipe(
-      catchError((error: unknown): Observable<never> => {
-        return throwError((): unknown => errorConvertor(error));
-      })
-    );
-  }
-}

package/src/nest/interceptors/response.format.interceptor.ts

@@ -1,29 +0,0 @@
-import {
-  Injectable,
-  NestInterceptor,
-  ExecutionContext,
-  CallHandler,
-} from '@nestjs/common';
-import { Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
-
-import { HttpResponseBody } from '../../http/types';
-
-@Injectable()
-export class ResponseFormatInterceptor<T>
-  implements NestInterceptor<T, HttpResponseBody<T>>
-{
-  intercept(
-    _context: ExecutionContext,
-    next: CallHandler
-  ): Observable<HttpResponseBody<T>> {
-    return next.handle().pipe(
-      map(
-        (data: T): HttpResponseBody<T> => ({
-          data,
-          message: 'ok',
-        })
-      )
-    );
-  }
-}

package/src/nest/modules/health/health.module.ts

@@ -1,20 +0,0 @@
-import {
-  MiddlewareConsumer,
-  Module,
-  NestModule,
-  RequestMethod,
-} from '@nestjs/common';
-
-import { PingMiddleware } from './middlewares';
-
-@Module({
-  providers: [PingMiddleware],
-})
-export class HealthModule implements NestModule {
-  configure(consumer: MiddlewareConsumer): void {
-    consumer.apply(PingMiddleware).forRoutes({
-      path: '/health/ping',
-      method: RequestMethod.GET,
-    });
-  }
-}

package/src/nest/modules/health/index.ts

@@ -1 +0,0 @@
-export * from './health.module';

package/src/nest/modules/health/middlewares/ping.middleware.ts

@@ -1,9 +0,0 @@
-import { Injectable, NestMiddleware } from '@nestjs/common';
-import type { Request, Response } from 'express';
-
-@Injectable()
-export class PingMiddleware implements NestMiddleware {
-  use(_request: Request, response: Response): void {
-    response.end('Pong');
-  }
-}

package/src/nest/modules/requirement/requirement.module.ts

@@ -1,56 +0,0 @@
-import { Module } from '@nestjs/common';
-import { ConfigModule } from '@nestjs/config';
-import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR } from '@nestjs/core';
-import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
-import type { ILogger } from '@ask-ell/core';
-import { NestLogger } from '@ask-ell/nest';
-import { SentryGlobalFilter, SentryModule } from '@sentry/nestjs/setup';
-
-import { KeyvStoreAdapterFactory } from '../../../keyv.store.adapter.factory';
-import { dockerSecretGetter, localSecretGetter } from '../../../secrets';
-import { HealthModule } from '../health';
-import { ResponseFormatInterceptor } from '../../interceptors';
-import { HttpExceptionFilter } from '../../filters';
-
-const configModuleLogger: ILogger = NestLogger.fromClass(ConfigModule);
-
-@Module({
-  imports: [
-    HealthModule,
-    SentryModule.forRoot(),
-    ThrottlerModule.forRoot([
-      {
-        ttl: 60000,
-        limit: 30,
-      },
-    ]),
-    ConfigModule.forRoot({
-      isGlobal: true,
-      load: [
-        dockerSecretGetter(configModuleLogger),
-        localSecretGetter(configModuleLogger),
-      ],
-    }),
-  ],
-  providers: [
-    KeyvStoreAdapterFactory,
-    {
-      provide: APP_GUARD,
-      useClass: ThrottlerGuard,
-    },
-    {
-      provide: APP_INTERCEPTOR,
-      useClass: ResponseFormatInterceptor,
-    },
-    {
-      provide: APP_FILTER,
-      useClass: HttpExceptionFilter,
-    },
-    {
-      provide: APP_FILTER,
-      useClass: SentryGlobalFilter,
-    },
-  ],
-  exports: [ConfigModule, SentryModule, KeyvStoreAdapterFactory],
-})
-export class RequirementModule {}

package/src/scripts/move-keyv-data.program.ts

@@ -1,88 +0,0 @@
-import { PercentageIncrementor } from '@ask-ell/core';
-import { Program, ProgramExecutionOptions } from '@ask-ell/node';
-import { NestLogger } from '@ask-ell/nest';
-import { Client, QueryResult } from 'pg';
-
-type KeyvRowData<Value = unknown> = {
-  key: string;
-  value: Value;
-};
-
-export class MoveKeyvDataProgram extends Program {
-  constructor() {
-    super({
-      arguments: [
-        {
-          name: 'origin',
-          description: 'Origin Postgres database URI',
-          required: true,
-        },
-        {
-          name: 'target',
-          description: 'Target Postgres database URI',
-          required: true,
-        },
-      ],
-      logger: NestLogger.fromClass(MoveKeyvDataProgram),
-    });
-  }
-
-  async execute({
-    logger,
-    arguments: { origin, target },
-    prompts: { confirm },
-  }: ProgramExecutionOptions): Promise<void> {
-    const originPostgresClient: Client = new Client(origin);
-    const targetPostgresClient: Client = new Client(target);
-
-    logger.log('Reading databases...');
-
-    await Promise.all([
-      originPostgresClient.connect(),
-      targetPostgresClient.connect(),
-    ]);
-
-    try {
-      const { rows }: QueryResult<KeyvRowData> =
-        await originPostgresClient.query('SELECT * FROM keyv');
-
-      const rowsCount: number = rows.length;
-      logger.log(
-        `You're going to insert ${rowsCount} keyv entries from the original database to the target database.`
-      );
-
-      const confirmed: boolean = await confirm(
-        'Are you sure you want to proceed?'
-      );
-
-      if (confirmed) {
-        logger.log('Inserting entries into the target database...');
-        const incrementor: PercentageIncrementor = new PercentageIncrementor(
-          rowsCount
-        );
-        incrementor.onIncrement(({ achivmentOnPercent }): void => {
-          logger.log(`Progress: ${achivmentOnPercent}%`);
-        });
-
-        for (const { key, value } of rows) {
-          await targetPostgresClient.query(
-            'INSERT INTO keyv (key, value) VALUES ($1, $2)',
-            [key, value]
-          );
-          incrementor.increment();
-        }
-
-        logger.log(`${rowsCount} entries inserted into the target database.`);
-        logger.log('Migration completed successfully.');
-      } else {
-        logger.log('Migration cancelled.');
-      }
-    } finally {
-      await Promise.all([
-        originPostgresClient.end(),
-        targetPostgresClient.end(),
-      ]);
-      logger.log('Database connections closed.');
-    }
-  }
-}