[UPDATE]: application status was refactorized

Author: Victor A Higuita

README.md

@@ -393,7 +393,7 @@ The tools extended by this class are: the **mapper**, the **validator**, the **m
 import messageResources, { Resources } from "../locals/messages/index";
 import { ILogProvider } from "../log/providerContracts/ILogProvider";
 export { IResult, Result, IResultT, ResultT } from "result-tsk";
-import applicationStatus from "../status/applicationStatus";
+import { ApplicationStatus } from "../status/applicationStatus";
 import wordResources from "../locals/words/index";
 import { Validator } from "validator-tsk";
 import mapper, { IMap } from "mapper-tsk";
@@ -415,7 +415,7 @@ export abstract class BaseUseCase<T> {
     this.validator = new Validator(
       messageResources,
       messageResources.keys.SOME_PARAMETERS_ARE_MISSING,
-      applicationStatus.INVALID_INPUT,
+      ApplicationStatus.INVALID_INPUT,
     );
   }
 
@@ -738,11 +738,11 @@ npx run-tsk setup project-name=my-awesome-project
       handlers: [this.getFeelingText],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.USER_NOT_FOUND,
+          applicationStatus: ApplicationStatus.USER_NOT_FOUND,
           httpStatus: HttpStatusEnum.NOT_FOUND,
         },
       ],
@@ -837,11 +837,11 @@ To get an overall idea, here an example:
       handlers: [this.login],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -912,15 +912,15 @@ When you have already registered (described) a model, it is not necessary to des
     handlers: [this.get],
     produces: [
       {
-        applicationStatus: applicationStatus.INVALID_INPUT,
+        applicationStatus: ApplicationStatus.INVALID_INPUT,
         httpStatus: HttpStatusEnum.BAD_REQUEST,
       },
       {
-        applicationStatus: applicationStatus.SUCCESS,
+        applicationStatus: ApplicationStatus.SUCCESS,
         httpStatus: HttpStatusEnum.SUCCESS,
       },
       {
-        applicationStatus: applicationStatus.UNAUTHORIZED,
+        applicationStatus: ApplicationStatus.UNAUTHORIZED,
         httpStatus: HttpStatusEnum.UNAUTHORIZED,
       },
     ],
@@ -1191,12 +1191,12 @@ This strategy is only needed in the **adapter layer** dependencies for **control
 First, all **dic strategy** starts from our **kernel index file** allocated into **adapters layer** as follows:
 ```ts
 // adapters/shared/kernel/index
-import applicationStatus from "../../../application/shared/status/applicationStatus";
+import { ApplicationStatus } from "../../../application/shared/status/applicationStatus";
 import appMessages, { localKeys } from "../../../application/shared/locals/messages";
 import tsKernel, { IServiceContainer } from "dic-tsk";
 
 tsKernel.init({
-  internalErrorCode: applicationStatus.INTERNAL_ERROR,
+  internalErrorCode: ApplicationStatus.INTERNAL_ERROR,
   appMessages,
   appErrorMessageKey: localKeys.DEPENDENCY_NOT_FOUND,
   applicationStatus,
@@ -1292,11 +1292,11 @@ export class TextFeelingController extends BaseController {
       handlers: [this.getFeelingText],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -1525,11 +1525,11 @@ initializeRoutes(router: IRouter): void {
     handlers: [authorization(), this.create],
     produces: [
       {
-        applicationStatus: applicationStatus.CREATED,
+        applicationStatus: ApplicationStatus.CREATED,
         httpStatus: HttpStatusEnum.CREATED,
       },
       {
-        applicationStatus: applicationStatus.UNAUTHORIZED,
+        applicationStatus: ApplicationStatus.UNAUTHORIZED,
         httpStatus: HttpStatusEnum.UNAUTHORIZED,
       },
     ],
@@ -1540,11 +1540,11 @@ initializeRoutes(router: IRouter): void {
     handlers: [authorization(), this.get],
     produces: [
       {
-        applicationStatus: applicationStatus.SUCCESS,
+        applicationStatus: ApplicationStatus.SUCCESS,
         httpStatus: HttpStatusEnum.SUCCESS,
       },
       {
-        applicationStatus: applicationStatus.UNAUTHORIZED,
+        applicationStatus: ApplicationStatus.UNAUTHORIZED,
         httpStatus: HttpStatusEnum.UNAUTHORIZED,
       },
     ],
@@ -1732,11 +1732,11 @@ export class UsersController extends BaseController {
       handlers: [authorization(), this.singUp],
       produces: [
         {
-          applicationStatus: applicationStatus.CREATED,
+          applicationStatus: ApplicationStatus.CREATED,
           httpStatus: HttpStatusEnum.CREATED,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -1747,11 +1747,11 @@ export class UsersController extends BaseController {
       handlers: [authorization(), this.get],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -1811,11 +1811,11 @@ export class UsersController extends BaseController {
       handlers: [authorization(), this.singUp],
       produces: [
         {
-          applicationStatus: applicationStatus.CREATED,
+          applicationStatus: ApplicationStatus.CREATED,
           httpStatus: HttpStatusEnum.CREATED,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -1826,11 +1826,11 @@ export class UsersController extends BaseController {
       handlers: [authorization(), this.get],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],

src/adapters/controllers/auth/Auth.controller.ts

@@ -13,13 +13,13 @@ import BaseController, {
   IRequest,
   IResponse,
   INextFunction,
-  EntryPointHandler,
+  RequestHandler,
   IRouter,
   ServiceContext,
   HttpContentTypeEnum,
   HttpMethodEnum,
   HttpHeaderEnum,
-  applicationStatus,
+  ApplicationStatus,
   HttpStatusEnum,
 } from "../base/Base.controller";
 
@@ -28,7 +28,7 @@ export class AuthController extends BaseController {
     super(AuthController.name, serviceContainer, ServiceContext.AUTH);
   }
 
-  login: EntryPointHandler = async (
+  login: RequestHandler = async (
     req: IRequest,
     res: IResponse,
     next: INextFunction,
@@ -49,7 +49,7 @@ export class AuthController extends BaseController {
     );
   };
 
-  logout: EntryPointHandler = async (
+  logout: RequestHandler = async (
     req: IRequest,
     res: IResponse,
     next: INextFunction,
@@ -73,11 +73,11 @@ export class AuthController extends BaseController {
       handlers: [this.logout],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],
@@ -125,11 +125,11 @@ export class AuthController extends BaseController {
       handlers: [this.login],
       produces: [
         {
-          applicationStatus: applicationStatus.SUCCESS,
+          applicationStatus: ApplicationStatus.SUCCESS,
           httpStatus: HttpStatusEnum.SUCCESS,
         },
         {
-          applicationStatus: applicationStatus.UNAUTHORIZED,
+          applicationStatus: ApplicationStatus.UNAUTHORIZED,
           httpStatus: HttpStatusEnum.UNAUTHORIZED,
         },
       ],

src/adapters/controllers/base/Base.controller.ts

@@ -1,7 +1,7 @@
 import { ILogProvider } from "../../../application/shared/log/providerContracts/ILogProvider";
 import { IUseCaseTraceRepository } from "../../repositories/trace/IUseCaseTrace.repository";
 import { UseCaseTraceRepository } from "../../repositories/trace/UseCaseTrace.repository";
-import applicationStatus from "../../../application/shared/status/applicationStatus";
+import { ApplicationStatus } from "../../../application/shared/status/applicationStatus";
 import { IApiDocGenerator, RouteType } from "./context/apiDoc/IApiDocGenerator";
 import { UseCaseTrace } from "../../../application/shared/log/UseCaseTrace";
 import { IResult } from "../../../application/shared/useCase/BaseUseCase";
@@ -20,11 +20,11 @@ import { IResponse } from "./context/IResponse";
 import { IRequest } from "./context/IRequest";
 import { IRouter } from "./context/IRouter";
 
-type EntryPointHandler = (req: IRequest, res: IResponse, next: INextFunction) => Promise<void>;
+type RequestHandler = (req: IRequest, res: IResponse, next: INextFunction) => Promise<void>;
 type HeaderType = { [key in HttpHeaderEnum]?: HttpContentTypeEnum | string };
 
 export {
-  EntryPointHandler,
+  RequestHandler,
   IRequest,
   IResponse,
   INextFunction,
@@ -34,7 +34,7 @@ export {
   HttpContentTypeEnum,
   HttpHeaderEnum,
   HttpStatusEnum,
-  applicationStatus,
+  ApplicationStatus,
 };
 
 export default abstract class BaseController {
@@ -82,7 +82,9 @@ export default abstract class BaseController {
   ): Promise<void> {
     this.setTransactionId(res);
     this.setHeaders(res, headersToSet);
-    res.status(HttpStatusResolver.getCode(result.statusCode.toString())).json(result);
+    res
+      .status(HttpStatusResolver.getCode(result.statusCode.toString() as ApplicationStatus))
+      .json(result);
   }
 
   private async getResultDto(
@@ -92,7 +94,9 @@ export default abstract class BaseController {
   ): Promise<void> {
     this.setTransactionId(res);
     this.setHeaders(res, headersToSet);
-    res.status(HttpStatusResolver.getCode(result.statusCode.toString())).json(result.toResultDto());
+    res
+      .status(HttpStatusResolver.getCode(result.statusCode.toString() as ApplicationStatus))
+      .json(result.toResultDto());
   }
 
   private async getResultData(
@@ -103,7 +107,7 @@ export default abstract class BaseController {
     this.setTransactionId(res);
     this.setHeaders(res, headersToSet);
     res
-      .status(HttpStatusResolver.getCode(result.statusCode.toString()))
+      .status(HttpStatusResolver.getCode(result.statusCode.toString() as ApplicationStatus))
       .json(result.message ? result.toResultDto() : result.toResultDto().data);
   }
 
@@ -123,7 +127,7 @@ export default abstract class BaseController {
     }
   }
 
-  setProducesCode(applicationStatus: string, httpStatus: HttpStatusEnum): void {
+  private setProducesCode(applicationStatus: string, httpStatus: HttpStatusEnum): void {
     if (!statusMapping[applicationStatus]) {
       statusMapping[applicationStatus] = httpStatus;
     }

src/adapters/controllers/base/context/IRouter.ts

@@ -1,13 +1,13 @@
-import { EntryPointHandler } from "../Base.controller";
+import { RequestHandler } from "../Base.controller";
 import { HttpMethodEnum } from "./HttpMethod.enum";
 
 export interface IRouter {
   (): IRouter;
-  [HttpMethodEnum.GET](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.POST](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.PUT](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.DELETE](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.PATCH](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.OPTIONS](path: string, ...handlers: EntryPointHandler[]): IRouter;
-  [HttpMethodEnum.HEAD](path: string, ...handlers: EntryPointHandler[]): IRouter;
+  [HttpMethodEnum.GET](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.POST](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.PUT](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.DELETE](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.PATCH](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.OPTIONS](path: string, ...handlers: RequestHandler[]): IRouter;
+  [HttpMethodEnum.HEAD](path: string, ...handlers: RequestHandler[]): IRouter;
 }

src/adapters/controllers/base/context/apiDoc/IApiDocGenerator.ts

@@ -1,4 +1,4 @@
-import { EntryPointHandler, HttpStatusEnum } from "../../Base.controller";
+import { RequestHandler, HttpStatusEnum } from "../../Base.controller";
 import { HttpContentTypeEnum } from "../HttpContentType.enum";
 import { HttpMethodEnum } from "../HttpMethod.enum";
 import {
@@ -46,7 +46,7 @@ export type ApiDoc = {
 export type RouteType = {
   method: HttpMethodEnum;
   path: string;
-  handlers: EntryPointHandler[];
+  handlers: RequestHandler[];
   produces: {
     applicationStatus: string;
     httpStatus: HttpStatusEnum;

src/adapters/controllers/base/httpResponse/AppStatusMapping.ts

@@ -1,24 +1,24 @@
-import applicationStatus from "../../../../application/shared/status/applicationStatus";
+import { ApplicationStatus } from "../../../../application/shared/status/applicationStatus";
 import { HttpStatusEnum } from "./HttpStatusEnum";
 
-const statusMapping: Record<string, number> & { default: number } = {
-  default: HttpStatusEnum.CONTINUE,
+const statusMapping: Record<string, number> & { DEFAULT: number } = {
+  DEFAULT: HttpStatusEnum.CONTINUE,
 };
 
 /* 
   You don't need to add mapping for all applicationStatus, 
   because if you use the produce property when you are setting the routes in the controller, 
-  it does the mapping for you according to the applicationStatus and HttpStatus that you will set.
+  it does the mapping for you according to the ApplicationStatus and HttpStatus that you will set.
   Here only map the applicationStatus that you will not use the produce property.
 */
-statusMapping[applicationStatus.SUCCESS] = HttpStatusEnum.SUCCESS;
-statusMapping[applicationStatus.CREATED] = HttpStatusEnum.CREATED;
-statusMapping[applicationStatus.NOT_CONTENT] = HttpStatusEnum.NOT_CONTENT;
-statusMapping[applicationStatus.INVALID_INPUT] = HttpStatusEnum.BAD_REQUEST;
-statusMapping[applicationStatus.UNAUTHORIZED] = HttpStatusEnum.UNAUTHORIZED;
-statusMapping[applicationStatus.NOT_FOUND] = HttpStatusEnum.NOT_FOUND;
-statusMapping[applicationStatus.INTERNAL_ERROR] = HttpStatusEnum.INTERNAL_SERVER_ERROR;
-statusMapping[applicationStatus.NOT_IMPLEMENTED] = HttpStatusEnum.NOT_IMPLEMENTED;
-statusMapping[applicationStatus.WORKER_ERROR] = HttpStatusEnum.INTERNAL_SERVER_ERROR;
+statusMapping[ApplicationStatus.SUCCESS] = HttpStatusEnum.SUCCESS;
+statusMapping[ApplicationStatus.CREATED] = HttpStatusEnum.CREATED;
+statusMapping[ApplicationStatus.NOT_CONTENT] = HttpStatusEnum.NOT_CONTENT;
+statusMapping[ApplicationStatus.INVALID_INPUT] = HttpStatusEnum.BAD_REQUEST;
+statusMapping[ApplicationStatus.UNAUTHORIZED] = HttpStatusEnum.UNAUTHORIZED;
+statusMapping[ApplicationStatus.NOT_FOUND] = HttpStatusEnum.NOT_FOUND;
+statusMapping[ApplicationStatus.INTERNAL_ERROR] = HttpStatusEnum.INTERNAL_SERVER_ERROR;
+statusMapping[ApplicationStatus.NOT_IMPLEMENTED] = HttpStatusEnum.NOT_IMPLEMENTED;
+statusMapping[ApplicationStatus.WORKER_ERROR] = HttpStatusEnum.INTERNAL_SERVER_ERROR;
 
 export default statusMapping;

src/adapters/controllers/base/httpResponse/HttpStatusResolver.ts

@@ -1,9 +1,10 @@
 import { DefaultValue } from "../../../../domain/shared/utils/DefaultValue";
+import { ApplicationStatus } from "../Base.controller";
 import { HttpStatusEnum } from "./HttpStatusEnum";
 import statusMapping from "./AppStatusMapping";
 
 export class HttpStatusResolver {
-  static getCode(applicationStatusCode: string): HttpStatusEnum {
-    return DefaultValue.evaluateAndGet(statusMapping[applicationStatusCode], statusMapping.default);
+  static getCode(applicationStatusCode: ApplicationStatus): HttpStatusEnum {
+    return DefaultValue.evaluateAndGet(statusMapping[applicationStatusCode], statusMapping.DEFAULT);
   }
 }