@expressots/core 2.16.0 → 2.16.2

package/lib/CHANGELOG.md

@@ -1,5 +1,24 @@
 
 
+## [2.16.2](https://github.com/expressots/expressots/compare/2.16.1...2.16.2) (2024-09-02)
+
+
+### Code Refactoring
+
+* add stackTrace app provider and add @expressots/cli to devDependencies ([212c681](https://github.com/expressots/expressots/commit/212c681eb32e4319545254f62d079da4b457a89a))
+* add test and coverage for base controller and error middleware ([5ddb7b2](https://github.com/expressots/expressots/commit/5ddb7b2265d8a7bcd3298133d5f7bb6c14e6d7ef))
+* adjust error middleware code property ([ef4e9b8](https://github.com/expressots/expressots/commit/ef4e9b8c2b93e5e3431172f60a28c433858557ae))
+* remove render from base controller, add usecase as type T ([9002129](https://github.com/expressots/expressots/commit/9002129f5f1eddd9da7c3b1f641e225d3776159a))
+* update templates main.ts removing reflect and serverenv type ([e5a789c](https://github.com/expressots/expressots/commit/e5a789c2a158eef1c0de658f00bb833e1eb8f644))
+* update templates nonop & add .env gitignore ([304cf88](https://github.com/expressots/expressots/commit/304cf885e9e9da7dbc7c24184868b1a557d93d04))
+
+## [2.16.1](https://github.com/expressots/expressots/compare/2.16.0...2.16.1) (2024-08-21)
+
+
+### Bug Fixes
+
+* remove reflect-metadata from main, add server env types ([43a5a33](https://github.com/expressots/expressots/commit/43a5a33d64381456930800555aef3ba0c6d1fd29))
+
 ## [2.16.0](https://github.com/expressots/expressots/compare/2.15.0...2.16.0) (2024-08-08)
 
 

package/lib/cjs/application/application-container.js

@@ -10,6 +10,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppContainer = void 0;
+require("reflect-metadata");
 const inversify_1 = require("inversify");
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
 /**

package/lib/cjs/common/index.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerEnvironment = void 0;
+var server_env_types_1 = require("./server-env.types");
+Object.defineProperty(exports, "ServerEnvironment", { enumerable: true, get: function () { return server_env_types_1.ServerEnvironment; } });

package/lib/cjs/common/server-env.types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerEnvironment = void 0;
+/**
+ * Enum representing possible server environments.
+ * @options Development - Development environment.
+ * @options Production - Production environment.
+ */
+var ServerEnvironment;
+(function (ServerEnvironment) {
+    ServerEnvironment["Development"] = "development";
+    ServerEnvironment["Production"] = "production";
+})(ServerEnvironment || (exports.ServerEnvironment = ServerEnvironment = {}));

package/lib/cjs/controller/base-controller.js

@@ -20,8 +20,14 @@ let BaseController = class BaseController {
      * @param res - The Express response object.
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
-    async callUseCaseAsync(useCase, res, successStatusCode) {
-        return res.status(successStatusCode).json(await useCase);
+    async callUseCaseAsync(useCase, res, successStatusCode = 200) {
+        try {
+            const result = await useCase;
+            res.status(successStatusCode).json(result);
+        }
+        catch (error) {
+            this.handleError(res, error);
+        }
     }
     /**
      * Calls a use case and sends an appropriate response based on the result.
@@ -29,42 +35,25 @@ let BaseController = class BaseController {
      * @param res - The Express response object.
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
-    callUseCase(useCase, res, successStatusCode) {
-        return res.status(successStatusCode).json(useCase);
+    callUseCase(useCase, res, successStatusCode = 200) {
+        try {
+            res.status(successStatusCode).json(useCase);
+        }
+        catch (error) {
+            this.handleError(res, error);
+        }
     }
     /**
-     * Synchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRender
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
-     *
-     */
-    callUseRender(res, template, options = {}) {
-        return res.render(template, options);
-    }
-    /**
-     * Asynchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRenderAsync
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
+     * Handles errors by sending a 500 status with an error message.
+     * This method can be extended to provide more detailed error handling.
      *
+     * @param res - The Express response object.
+     * @param error - The error that occurred during the execution of the use case.
      */
-    callUseRenderAsync(res, template, options = {}) {
-        return new Promise((resolve, reject) => {
-            res.render(template, options, (err, compiled) => {
-                if (err) {
-                    reject(err);
-                }
-                resolve(compiled);
-            });
+    handleError(res, error) {
+        res.status(500).json({
+            message: "An unexpected error occurred.",
+            error: error instanceof Error ? error.message : error,
         });
     }
 };

package/lib/cjs/error/error-handler-middleware.js

@@ -7,24 +7,21 @@ const utils_1 = require("./utils");
  * errorHandler is a custom Express error-handling middleware function.
  * It logs the error, sets the status code, and sends a JSON response containing the status code and error message.
  * @param error - An instance of IAppError containing error details.
- * @param req - The Express request object.
  * @param res - The Express response object.
  * @param next - The Express next function for passing control to the next middleware function.
  * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
  */
-function defaultErrorHandler(error, req, res, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-next, showStackTrace = false) {
+function defaultErrorHandler(error, res, next, showStackTrace = false) {
     try {
         if (error instanceof app_error_1.AppError) {
             res.status(error.statusCode).json({
-                statusCode: error.statusCode,
+                code: error.statusCode,
                 error: error.message,
             });
         }
         else {
             res.status(status_code_1.StatusCode.InternalServerError).json({
-                statusCode: status_code_1.StatusCode.InternalServerError,
+                code: status_code_1.StatusCode.InternalServerError,
                 error: "An unexpected error occurred.",
             });
         }

package/lib/cjs/middleware/middleware-service.js

@@ -283,7 +283,7 @@ let Middleware = class Middleware {
         const { errorHandler: errorHandling, showStackTrace } = options;
         if (!errorHandling) {
             this.errorHandler = (error, req, res, next) => {
-                (0, error_handler_middleware_1.default)(error, req, res, next, showStackTrace);
+                (0, error_handler_middleware_1.default)(error, res, next, showStackTrace);
             };
         }
         else {

package/lib/cjs/types/application/application-container.d.ts

@@ -1,3 +1,4 @@
+import "reflect-metadata";
 import { Container, ContainerModule, interfaces } from "inversify";
 /**
  * Interface for container options that can be passed to the AppContainer class.

package/lib/cjs/types/common/index.d.ts

@@ -1 +1,2 @@
 export { Pattern, ExpressoConfig } from "./project-config";
+export { ServerEnvironment } from "./server-env.types";

package/lib/cjs/types/common/server-env.types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Enum representing possible server environments.
+ * @options Development - Development environment.
+ * @options Production - Production environment.
+ */
+export declare enum ServerEnvironment {
+    Development = "development",
+    Production = "production"
+}

package/lib/cjs/types/controller/base-controller.d.ts

@@ -12,37 +12,21 @@ declare abstract class BaseController implements Controller {
      * @param res - The Express response object.
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
-    protected callUseCaseAsync(useCase: Promise<any>, res: Response, successStatusCode: number): Promise<any>;
+    protected callUseCaseAsync<T>(useCase: Promise<T>, res: Response, successStatusCode?: number): Promise<void>;
     /**
      * Calls a use case and sends an appropriate response based on the result.
      * @param useCase - The use case to call.
      * @param res - The Express response object.
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
-    protected callUseCase(useCase: any, res: Response, successStatusCode: number): any;
+    protected callUseCase<T>(useCase: T, res: Response, successStatusCode?: number): void;
     /**
-     * Synchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRender
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
-     *
-     */
-    protected callUseRender(res: Response, template: string, options?: object): void;
-    /**
-     * Asynchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRenderAsync
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
+     * Handles errors by sending a 500 status with an error message.
+     * This method can be extended to provide more detailed error handling.
      *
+     * @param res - The Express response object.
+     * @param error - The error that occurred during the execution of the use case.
      */
-    protected callUseRenderAsync(res: Response, template: string, options?: object): Promise<string>;
+    private handleError;
 }
 export { BaseController };

package/lib/cjs/types/error/error-handler-middleware.d.ts

@@ -1,12 +1,11 @@
-import { NextFunction, Request, Response } from "express";
+import { NextFunction, Response } from "express";
 /**
  * errorHandler is a custom Express error-handling middleware function.
  * It logs the error, sets the status code, and sends a JSON response containing the status code and error message.
  * @param error - An instance of IAppError containing error details.
- * @param req - The Express request object.
  * @param res - The Express response object.
  * @param next - The Express next function for passing control to the next middleware function.
  * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
  */
-declare function defaultErrorHandler(error: Error, req: Request, res: Response, next: NextFunction, showStackTrace?: boolean): void;
+declare function defaultErrorHandler(error: Error, res: Response, next: NextFunction, showStackTrace?: boolean): void;
 export default defaultErrorHandler;

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.16.0",
+  "version": "2.16.2",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.16.0",
+  "version": "2.16.2",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",