@ask-ell/back-end 0.2.1 → 0.2.4

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @ask-ell/back-end
+
+## 0.2.4
+
+### Patch Changes
+
+- [#20](https://github.com/ask-ell/stacks/pull/20) [`6eb9d13`](https://github.com/ask-ell/stacks/commit/6eb9d13e6473a022eb1377d3ca688811379e0376) Thanks [@timbitwin](https://github.com/timbitwin)! - script renamed to program
+- Updated dependencies [[`6eb9d13`](https://github.com/ask-ell/stacks/commit/6eb9d13e6473a022eb1377d3ca688811379e0376)]:
+  - @ask-ell/node@0.0.6
+
+## 0.2.3
+
+### Patch Changes
+
+- [`473e25b`](https://github.com/ask-ell/stacks/commit/473e25b399b8ac336dabb5f8c9fda3b1428cabb6) Thanks [@timbitwin](https://github.com/timbitwin)! - Exported `CreateKeyvStoreAdapterOptions`, `ErrorInterceptorProps`, `NestApplicationFactoryParams`, and the `update-dependencies-versions` script types so they resolve correctly in generated documentation. Also wired up the `http`, `add-ons`, `filters`, `interceptors`, and `modules` barrels that were left disconnected from the package entry point after the last refactor, so the public API is fully reachable and documented from `index.ts`.
+- Updated dependencies [[`473e25b`](https://github.com/ask-ell/stacks/commit/473e25b399b8ac336dabb5f8c9fda3b1428cabb6), [`473e25b`](https://github.com/ask-ell/stacks/commit/473e25b399b8ac336dabb5f8c9fda3b1428cabb6), [`473e25b`](https://github.com/ask-ell/stacks/commit/473e25b399b8ac336dabb5f8c9fda3b1428cabb6)]:
+  - @ask-ell/core@1.3.6
+  - @ask-ell/nest@0.0.15
+  - @ask-ell/node@0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ask-ell/back-end",
-  "version": "0.2.1",
+  "version": "0.2.4",
   "private": false,
   "type": "commonjs",
   "main": "./src/index.js",
@@ -17,6 +17,7 @@
     "@nestjs/swagger": "*",
     "@nestjs/throttler": "*",
     "@sentry/nestjs": "*",
+    "express": "*",
     "helmet": "*",
     "keyv": "*",
     "pg": "*",

package/src/http/index.ts

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

package/src/http/types.ts

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

package/src/index.ts

@@ -2,7 +2,6 @@
  * @module @ask-ell/back-end
  */
 export * from './scripts';
-export * from './application.base';
-export * from './application.factory';
-export * from './error.interceptor';
+export * from './http';
+export * from './nest';
 export * from './keyv.store.adapter.factory';

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

@@ -6,9 +6,9 @@ import { ILogger, MaybeUndefined } from '@ask-ell/core';
 import { NestLogger } from '@ask-ell/nest';
 import { join } from 'node:path';
 
-import { createTmpFolder, TMP_FOLDER_PATH } from './utils';
+import { createTmpFolder, TMP_FOLDER_PATH } from './tmp';
 
-type CreateKeyvStoreAdapterOptions = {
+export type CreateKeyvStoreAdapterOptions = {
   postgresUri: MaybeUndefined<string>;
 };
 

package/src/nest/add-ons/index.ts

@@ -0,0 +1,6 @@
+export * from './add-on.interface';
+export * from './add-on.wrapper';
+export * from './types';
+export * from './implementations/sentry/sentry.add-on.state.interface';
+export * from './implementations/swagger/swagger.add-on.state.interface';
+export * from './implementations/swagger/types';

package/src/{application.base.ts → nest/application.base.ts}

@@ -1,6 +1,6 @@
 import { DynamicModule, Provider, Module, Global } from '@nestjs/common';
 
-import { RequirementModule } from './requirement.module';
+import { RequirementModule } from './modules';
 
 @Global()
 @Module({

package/src/{application.factory.ts → nest/application.factory.ts}

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

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

@@ -0,0 +1,23 @@
+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/filters/index.ts

@@ -0,0 +1 @@
+export * from './http.exception.filter';

package/src/nest/index.ts

@@ -0,0 +1,6 @@
+export * from './add-ons';
+export * from './application.base';
+export * from './application.factory';
+export * from './filters';
+export * from './interceptors';
+export * from './modules';

package/src/{error.interceptor.ts → nest/interceptors/error.interceptor.ts}

@@ -2,7 +2,7 @@ import { Entity, IResult, ok } from '@ask-ell/core';
 import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
 import { catchError, Observable, throwError } from 'rxjs';
 
-type ErrorInterceptorProps = {
+export type ErrorInterceptorProps = {
   errorConvertor: (error: unknown) => unknown;
 };
 

package/src/nest/interceptors/index.ts

@@ -0,0 +1,2 @@
+export * from './error.interceptor';
+export * from './response.format.interceptor';

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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,20 @@
+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

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

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

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

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

@@ -0,0 +1,9 @@
+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/index.ts

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

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

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

package/src/{requirement.module.ts → nest/modules/requirement/requirement.module.ts}

@@ -1,22 +1,19 @@
-import { Global, Module } from '@nestjs/common';
+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,
-  HealthModule,
-  ResponseFormatInterceptor,
-  HttpExceptionFilter,
-} from '@ask-ell/nest';
+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 { 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);
 
-@Global()
 @Module({
   imports: [
     HealthModule,

package/src/scripts/index.ts

@@ -1,2 +1,2 @@
-export * from './move-keyv-data.script';
-export * from './update-dependencies-versions.script';
+export * from './move-keyv-data.program';
+export * from './update-dependencies-versions.program';

package/src/scripts/{move-keyv-data.script.ts → move-keyv-data.program.ts}

@@ -1,5 +1,5 @@
 import { PercentageIncrementor } from '@ask-ell/core';
-import { Script, ExecuteOptions } from '@ask-ell/node';
+import { Program, ProgramExecutionOptions } from '@ask-ell/node';
 import { NestLogger } from '@ask-ell/nest';
 import { Client, QueryResult } from 'pg';
 
@@ -8,7 +8,7 @@ type KeyvRowData<Value = unknown> = {
   value: Value;
 };
 
-export class MoveKeyvDataScript extends Script {
+export class MoveKeyvDataProgram extends Program {
   constructor() {
     super({
       arguments: [
@@ -23,7 +23,7 @@ export class MoveKeyvDataScript extends Script {
           required: true,
         },
       ],
-      logger: NestLogger.fromClass(MoveKeyvDataScript),
+      logger: NestLogger.fromClass(MoveKeyvDataProgram),
     });
   }
 
@@ -31,7 +31,7 @@ export class MoveKeyvDataScript extends Script {
     logger,
     arguments: { origin, target },
     prompts: { confirm },
-  }: ExecuteOptions): Promise<void> {
+  }: ProgramExecutionOptions): Promise<void> {
     const originPostgresClient: Client = new Client(origin);
     const targetPostgresClient: Client = new Client(target);
 

package/src/scripts/{update-dependencies-versions.script.ts → update-dependencies-versions.program.ts}

@@ -4,7 +4,7 @@ import {
   UnknownEnvironmentVariableError,
 } from '@ask-ell/core';
 import { NestLogger } from '@ask-ell/nest';
-import { ExecuteOptions, Script } from '@ask-ell/node';
+import { ProgramExecutionOptions, Program } from '@ask-ell/node';
 import { spawnSync } from 'node:child_process';
 import { writeFileSync } from 'node:fs';
 import { mkdir } from 'node:fs/promises';
@@ -24,7 +24,7 @@ makeSureThatProjectRootPathIsDefined(PROJECT_ROOT_PATH);
 
 const NX_GRAPH_FILE_PATH: string = join(PROJECT_ROOT_PATH, 'tmp/graph.json');
 
-type PackageContent = {
+export type PackageContent = {
   version: string;
   dependencies: StringDictionnary;
   devDependencies: StringDictionnary;
@@ -42,22 +42,22 @@ function getOrganisationPackageFile(packageId: string): PackageContent {
   return require(packageFilePath);
 }
 
-type UpdateDependenciesVersionsScriptParams = {
+export type UpdateDependenciesVersionsProgramParams = {
   organisationPackagePrefix: string;
   blackListedPackages: string[];
 };
 
-type WorkspaceDependenciesMapElement = {
+export type WorkspaceDependenciesMapElement = {
   id: string;
   dependencies: string[];
   source: PackageContent;
 };
 
-type WorkspaceDependenciesMap = {
+export type WorkspaceDependenciesMap = {
   [id: string]: WorkspaceDependenciesMapElement;
 };
 
-export class UpdateDependenciesVersionsScript extends Script {
+export class UpdateDependenciesVersionsProgram extends Program {
   private organisationPackagePrefix: string;
   private blackListedPackages: string[];
   private workspaceDependenciesMap: WorkspaceDependenciesMap =
@@ -66,9 +66,9 @@ export class UpdateDependenciesVersionsScript extends Script {
   constructor({
     organisationPackagePrefix,
     blackListedPackages,
-  }: UpdateDependenciesVersionsScriptParams) {
+  }: UpdateDependenciesVersionsProgramParams) {
     super({
-      logger: NestLogger.fromClass(UpdateDependenciesVersionsScript),
+      logger: NestLogger.fromClass(UpdateDependenciesVersionsProgram),
       arguments: [
         {
           name: 'targetedPackage',
@@ -83,7 +83,7 @@ export class UpdateDependenciesVersionsScript extends Script {
   async execute({
     logger,
     arguments: { targetedPackage },
-  }: ExecuteOptions): Promise<void> {
+  }: ProgramExecutionOptions): Promise<void> {
     const workspaceDependenciesMapElements: WorkspaceDependenciesMapElement[] =
       Object.values(this.workspaceDependenciesMap).filter(
         ({ id }: WorkspaceDependenciesMapElement): boolean =>

package/src/add-ons/index.ts

@@ -1,2 +0,0 @@
-export * from './add-on.wrapper';
-export * from './types';

package/src/utils/index.ts

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