cqrs-boilerplate-code 1.0.0 → 1.0.1

package/dist/middleware/interceptor/response-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-handler.js","sourceRoot":"","sources":["../../../src/middleware/interceptor/response-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAKwB;AAExB,+BAAkC;AAIlC,8EAAyE;AACzE,qDAAoD;AAK7C,IAAM,eAAe,GAArB,MAAM,eAAe;IAEP;IADnB,YACmB,MAAqB;QAArB,WAAM,GAAN,MAAM,CAAe;IACrC,CAAC;IAEJ,SAAS,CAAC,SAA2B,EAAE,IAAiB;QACtD,OAAO,IAAI,iBAAU,CAAC,CAAC,UAAU,EAAE,EAAE;YACnC,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC;gBACtB,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;oBACb,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;oBACpD,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1B,CAAC;gBACD,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;oBACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;oBAC/D,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACxB,CAAC;gBACD,QAAQ,EAAE,GAAG,EAAE;oBACb,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACxB,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IASO,cAAc,CACpB,iBAAmC,EACnC,MAAmB;QAEnB,IAAI,cAAc,GAAG,iBAAiB;aACnC,YAAY,EAAE;aACd,WAAW,EAAkB,CAAC;QAEjC,MAAM,UAAU,GAAQ,IAAI,+CAAqB,EAAE,CAAC,sBAAsB,CACxE,cAAc,CAAC,UAAU,EACzB,MAAM,CACP,CAAC;QACF,cAAc,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU;YAC/C,CAAC,CAAC,UAAU,CAAC,UAAU;YACvB,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC;QAClC,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;QACzD,IAAI,UAAU,EAAE,UAAU,EAAE,CAAC;YAC3B,OAAO,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC;QACvC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;CACF,CAAA;AAnDY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;qCAGgB,sBAAa;GAF7B,eAAe,CAmD3B","sourcesContent":["import {\n    CallHandler,\n    ExecutionContext,\n    Injectable,\n    NestInterceptor,\n} from \"@nestjs/common\";\nimport { ServerResponse } from \"http\";\nimport { Observable } from \"rxjs\";\nimport { GenericErrorResponse } from \"../../core-common/response-model/generic-error-response.model\";\nimport { GenericSuccessResponse } from \"../../core-common/response-model/generic-success-response.model\";\nimport { Result } from \"../../core-common/result-model/result\";\nimport { HttpResponseFormatter } from \"../utils/http-response.formatter\";\nimport { LoggerService } from \"@core-common/logger\";\n/**\n * Intercepts the response and returns a standard ApiReponse object\n */\n@Injectable()\nexport class ResponseHandler implements NestInterceptor {\n  constructor(\n    private readonly logger: LoggerService\n  ) {}\n\n  intercept(exContext: ExecutionContext, next: CallHandler): Observable<any> {\n    return new Observable((subscriber) => {\n      next.handle().subscribe({\n        next: (data) => {\n          const mapped = this.handleResponse(exContext, data);\n          subscriber.next(mapped);\n        },\n        error: (err) => {\n          this.logger.error('Error in ResponseHandler Interceptor', err);\n          subscriber.error(err);\n        },\n        complete: () => {\n          subscriber.complete();\n        },\n      });\n    });\n  }\n\n  /**\n   * Checks the response content and appropriately sets the status code and wraps the return value in a ApiErroReponse or a\n   * ApiSuccessReponse\n   * @param excecutionContext  - Instance of the executionContext object\n   * @param result  Data returned by the controller method\n   * @returns - Instance of ApiSuccessReponse or ApiErrorReponse\n   */\n  private handleResponse(\n    excecutionContext: ExecutionContext,\n    result: Result<any>,\n  ): GenericSuccessResponse<any> | GenericErrorResponse {\n    let serverResponse = excecutionContext\n      .switchToHttp()\n      .getResponse<ServerResponse>();\n\n    const apiReponse: any = new HttpResponseFormatter().getStandardApiResponse(\n      serverResponse.statusCode,\n      result,\n    );\n    serverResponse.statusCode = apiReponse.statusCode\n      ? apiReponse.statusCode\n      : apiReponse?.error?.statusCode;\n    serverResponse[`statusCode`] = serverResponse.statusCode;\n    if (apiReponse?.statusCode) {\n      delete apiReponse?.error?.statusCode;\n    }\n    return apiReponse;\n  }\n}\n"]}

package/dist/middleware/platform-auth.middleware.d.ts

@@ -0,0 +1,5 @@
+import { NestMiddleware } from "@nestjs/common";
+import { Request, Response } from "express";
+export declare class AuthMiddleware implements NestMiddleware<Request, Response> {
+    use(req: Request, _res: Response, next: () => void): void;
+}

package/dist/middleware/platform-auth.middleware.js

@@ -0,0 +1,22 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthMiddleware = void 0;
+const common_1 = require("@nestjs/common");
+let AuthMiddleware = class AuthMiddleware {
+    use(req, _res, next) {
+        const authHeader = req.headers["authorization"];
+        console.log("Auth Middleware executed", authHeader);
+        next();
+    }
+};
+exports.AuthMiddleware = AuthMiddleware;
+exports.AuthMiddleware = AuthMiddleware = __decorate([
+    (0, common_1.Injectable)()
+], AuthMiddleware);
+//# sourceMappingURL=platform-auth.middleware.js.map

package/dist/middleware/platform-auth.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-auth.middleware.js","sourceRoot":"","sources":["../../src/middleware/platform-auth.middleware.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA4D;AAIrD,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,GAAG,CAAC,GAAY,EAAE,IAAc,EAAE,IAAgB;QAChD,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAGhD,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;QACpD,IAAI,EAAE,CAAC;IACT,CAAC;CACF,CAAA;AARY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;GACA,cAAc,CAQ1B","sourcesContent":["import { Injectable, NestMiddleware } from \"@nestjs/common\";\nimport { Request, Response } from \"express\";\n\n@Injectable()\nexport class AuthMiddleware implements NestMiddleware<Request, Response> {\n  use(req: Request, _res: Response, next: () => void): void {\n    const authHeader = req.headers[\"authorization\"];\n    // Implement your authentication logic here\n    // For example, validate JWT token from authHeader      \n    console.log(\"Auth Middleware executed\", authHeader);\n    next();\n  }\n}\n"]}

package/dist/middleware/utils/http-response.formatter.d.ts

@@ -0,0 +1,11 @@
+import { GenericErrorResponse } from "../../core-common/response-model/generic-error-response.model";
+import { GenericSuccessResponse } from "../../core-common/response-model/generic-success-response.model";
+export declare class HttpResponseFormatter {
+    constructor();
+    getStandardApiResponse(statusCode: number, responseData: any): GenericSuccessResponse<any> | GenericErrorResponse;
+    private getSuccessResponse;
+    private isSuccessfulResult;
+    private isFailedResult;
+    private getFailureResponse;
+    private getStatusCode;
+}

package/dist/middleware/utils/http-response.formatter.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpResponseFormatter = void 0;
+const common_1 = require("@nestjs/common");
+const already_exists_error_1 = require("../../core-common/error/custom-error/already-exists.error");
+const generic_error_1 = require("../../core-common/error/generic.error");
+const generic_error_response_model_1 = require("../../core-common/response-model/generic-error-response.model");
+const generic_success_response_model_1 = require("../../core-common/response-model/generic-success-response.model");
+const result_1 = require("../../core-common/result-model/result");
+const error_1 = require("../../core-common/error");
+const internal_server_error_1 = require("../../core-common/error/custom-error/internal-server.error");
+class HttpResponseFormatter {
+    constructor() { }
+    getStandardApiResponse(statusCode, responseData) {
+        if (this.isSuccessfulResult(responseData)) {
+            return this.getSuccessResponse(responseData, statusCode);
+        }
+        if (this.isFailedResult(responseData)) {
+            return this.getFailureResponse(responseData);
+        }
+        return responseData;
+    }
+    getSuccessResponse(responseData, statusCode) {
+        const apiSuccessResponse = new generic_success_response_model_1.GenericSuccessResponse();
+        apiSuccessResponse.initialize(responseData, statusCode);
+        return apiSuccessResponse;
+    }
+    isSuccessfulResult(responseData) {
+        return responseData instanceof result_1.Result && responseData.success;
+    }
+    isFailedResult(responseData) {
+        return responseData instanceof result_1.Result && !responseData.success;
+    }
+    getFailureResponse(result) {
+        const statusCode = this.getStatusCode(result.error);
+        const apiErrorResponse = new generic_error_response_model_1.GenericErrorResponse();
+        apiErrorResponse.initialize(result, statusCode);
+        return apiErrorResponse;
+    }
+    getStatusCode(error) {
+        if (error instanceof error_1.BadRequestError) {
+            return common_1.HttpStatus.BAD_REQUEST;
+        }
+        if (error instanceof error_1.UnauthorizedError) {
+            return common_1.HttpStatus.UNAUTHORIZED;
+        }
+        if (error instanceof error_1.ForbiddenError) {
+            return common_1.HttpStatus.FORBIDDEN;
+        }
+        if (error instanceof error_1.NotFoundError) {
+            return common_1.HttpStatus.NOT_FOUND;
+        }
+        if (error instanceof already_exists_error_1.AlreadyExistsError) {
+            return common_1.HttpStatus.CONFLICT;
+        }
+        if (error instanceof error_1.ConflictError) {
+            return common_1.HttpStatus.CONFLICT;
+        }
+        if (error instanceof error_1.ValidationError) {
+            return common_1.HttpStatus.UNPROCESSABLE_ENTITY;
+        }
+        if (error instanceof error_1.UnprocessableEntityError) {
+            return common_1.HttpStatus.UNPROCESSABLE_ENTITY;
+        }
+        if (error instanceof error_1.ServiceUnavailableError) {
+            return common_1.HttpStatus.SERVICE_UNAVAILABLE;
+        }
+        if (error instanceof internal_server_error_1.InternalServerError) {
+            return common_1.HttpStatus.INTERNAL_SERVER_ERROR;
+        }
+        if (error instanceof generic_error_1.GenericError) {
+            return error.statusCode;
+        }
+        return common_1.HttpStatus.INTERNAL_SERVER_ERROR;
+    }
+}
+exports.HttpResponseFormatter = HttpResponseFormatter;
+//# sourceMappingURL=http-response.formatter.js.map

package/dist/middleware/utils/http-response.formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-response.formatter.js","sourceRoot":"","sources":["../../../src/middleware/utils/http-response.formatter.ts"],"names":[],"mappings":";;;AAAA,2CAA4C;AAC5C,oGAA+F;AAC/F,yEAAqE;AACrE,gHAAqG;AACrG,oHAAyG;AACzG,kEAA+D;AAC/D,mDAA+L;AAC/L,sGAAiG;AAKjG,MAAa,qBAAqB;IAChC,gBAAe,CAAC;IAMT,sBAAsB,CAC3B,UAAkB,EAClB,YAAiB;QAEjB,IAAI,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAQO,kBAAkB,CACxB,YAAiB,EACjB,UAAkB;QAElB,MAAM,kBAAkB,GAAG,IAAI,uDAAsB,EAAE,CAAC;QACxD,kBAAkB,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACxD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAOO,kBAAkB,CAAC,YAAiB;QAC1C,OAAO,YAAY,YAAY,eAAM,IAAI,YAAY,CAAC,OAAO,CAAC;IAChE,CAAC;IAOO,cAAc,CAAC,YAAiB;QACtC,OAAO,YAAY,YAAY,eAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;IACjE,CAAC;IAMO,kBAAkB,CAAC,MAAmB;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,gBAAgB,GAAG,IAAI,mDAAoB,EAAE,CAAC;QACpD,gBAAgB,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAChD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,aAAa,CAAC,KAAmB;QACvC,IAAI,KAAK,YAAY,uBAAe,EAAE,CAAC;YACrC,OAAO,mBAAU,CAAC,WAAW,CAAC;QAChC,CAAC;QAED,IAAI,KAAK,YAAY,yBAAiB,EAAE,CAAC;YACvC,OAAO,mBAAU,CAAC,YAAY,CAAC;QACjC,CAAC;QAED,IAAI,KAAK,YAAY,sBAAc,EAAE,CAAC;YACpC,OAAO,mBAAU,CAAC,SAAS,CAAC;QAC9B,CAAC;QAED,IAAI,KAAK,YAAY,qBAAa,EAAE,CAAC;YACnC,OAAO,mBAAU,CAAC,SAAS,CAAC;QAC9B,CAAC;QAED,IAAI,KAAK,YAAY,yCAAkB,EAAE,CAAC;YACxC,OAAO,mBAAU,CAAC,QAAQ,CAAC;QAC7B,CAAC;QAED,IAAI,KAAK,YAAY,qBAAa,EAAE,CAAC;YACnC,OAAO,mBAAU,CAAC,QAAQ,CAAC;QAC7B,CAAC;QAED,IAAI,KAAK,YAAY,uBAAe,EAAE,CAAC;YACrC,OAAO,mBAAU,CAAC,oBAAoB,CAAC;QACzC,CAAC;QAED,IAAI,KAAK,YAAY,gCAAwB,EAAE,CAAC;YAC9C,OAAO,mBAAU,CAAC,oBAAoB,CAAC;QACzC,CAAC;QAED,IAAI,KAAK,YAAY,+BAAuB,EAAE,CAAC;YAC7C,OAAO,mBAAU,CAAC,mBAAmB,CAAC;QACxC,CAAC;QAED,IAAI,KAAK,YAAY,2CAAmB,EAAE,CAAC;YACzC,OAAO,mBAAU,CAAC,qBAAqB,CAAC;QAC1C,CAAC;QAED,IAAI,KAAK,YAAY,4BAAY,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC,UAAU,CAAC;QAC1B,CAAC;QAED,OAAO,mBAAU,CAAC,qBAAqB,CAAC;IAC1C,CAAC;CACF;AAjHD,sDAiHC","sourcesContent":["import { HttpStatus } from \"@nestjs/common\";\nimport { AlreadyExistsError } from \"../../core-common/error/custom-error/already-exists.error\";\nimport { GenericError } from \"../../core-common/error/generic.error\";\nimport { GenericErrorResponse } from \"../../core-common/response-model/generic-error-response.model\";\nimport { GenericSuccessResponse } from \"../../core-common/response-model/generic-success-response.model\";\nimport { Result } from \"../../core-common/result-model/result\";\nimport { BadRequestError, ConflictError, ForbiddenError, NotFoundError, ServiceUnavailableError, UnauthorizedError, UnprocessableEntityError, ValidationError } from \"../../core-common/error\";\nimport { InternalServerError } from \"../../core-common/error/custom-error/internal-server.error\";\n\n/**\n * Helps in returning a appropriate and standard Response format  based on success or error scenario\n */\nexport class HttpResponseFormatter {\n  constructor() {}\n  /**\n   * Returns a standard formatted  ApiSuccesReponse or ApiErrorResponse depending on the response data\n   * @param statusCode - Http Status code\n   * @param responseData - Response value from the api controller method\n   */\n  public getStandardApiResponse(\n    statusCode: number,\n    responseData: any,\n  ): GenericSuccessResponse<any> | GenericErrorResponse {\n    if (this.isSuccessfulResult(responseData)) {\n      return this.getSuccessResponse(responseData, statusCode);\n    }\n\n    if (this.isFailedResult(responseData)) {\n      return this.getFailureResponse(responseData);\n    }\n\n    return responseData;\n  }\n\n  /**\n   *\n   * @param responseData Initializes and returns  the success api response\n   * @param statusCode - Http Status code\n   * @returns - instance of ApiSuccessResponse object\n   */\n  private getSuccessResponse(\n    responseData: any,\n    statusCode: number,\n  ): GenericSuccessResponse<any> {\n    const apiSuccessResponse = new GenericSuccessResponse();\n    apiSuccessResponse.initialize(responseData, statusCode);\n    return apiSuccessResponse;\n  }\n\n  /**\n   * Checks if the the data is of type Result and is successful\n   * @param responseData - response data\n   * @returns - boolean\n   */\n  private isSuccessfulResult(responseData: any): boolean {\n    return responseData instanceof Result && responseData.success;\n  }\n\n  /**\n   * Checks if the the data is of type Result and is successful\n   * @param responseData - response data\n   * @returns - boolean\n   */\n  private isFailedResult(responseData: any): boolean {\n    return responseData instanceof Result && !responseData.success;\n  }\n\n  /**\n   * Gets the failure response based on the result contents\n   * @param result - Result object returned from the controller method\n   */\n  private getFailureResponse(result: Result<any>) {\n    const statusCode = this.getStatusCode(result.error);\n    const apiErrorResponse = new GenericErrorResponse();\n    apiErrorResponse.initialize(result, statusCode);\n    return apiErrorResponse;\n  }\n\n  private getStatusCode(error: GenericError): number {\n    if (error instanceof BadRequestError) {\n      return HttpStatus.BAD_REQUEST;\n    }\n\n    if (error instanceof UnauthorizedError) {\n      return HttpStatus.UNAUTHORIZED;\n    }\n\n    if (error instanceof ForbiddenError) {\n      return HttpStatus.FORBIDDEN;\n    }\n\n    if (error instanceof NotFoundError) {\n      return HttpStatus.NOT_FOUND;\n    }\n\n    if (error instanceof AlreadyExistsError) {\n      return HttpStatus.CONFLICT;\n    }\n\n    if (error instanceof ConflictError) {\n      return HttpStatus.CONFLICT;\n    }\n\n    if (error instanceof ValidationError) {\n      return HttpStatus.UNPROCESSABLE_ENTITY;\n    }\n\n    if (error instanceof UnprocessableEntityError) {\n      return HttpStatus.UNPROCESSABLE_ENTITY;\n    }\n\n    if (error instanceof ServiceUnavailableError) {\n      return HttpStatus.SERVICE_UNAVAILABLE;\n    }\n\n    if (error instanceof InternalServerError) {\n      return HttpStatus.INTERNAL_SERVER_ERROR;\n    }\n\n    if (error instanceof GenericError) {\n      return error.statusCode;\n    }\n\n    return HttpStatus.INTERNAL_SERVER_ERROR;\n  }\n}\n"]}