@expressots/core 1.4.1 → 1.5.0-dev

package/lib/README.md

@@ -1,61 +1,61 @@
-<p align="center">
-  <a href="https://expresso-ts.com/" target="blank"><img src="https://github.com/expressots/expressots/blob/main/media/expressots.png" width="120" alt="Expresso TS Logo" /></a>
-</p>
-
-# Expresso TS
-
-A Typescript + [Node.js]("https://nodejs.org/en/") lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🚀
-
-## Philosophy
-
-ExpressoTS is a developer-friendly framework designed to streamline the process of building server-side applications. With a focus on readability, maintainability, and scalability, ExpressoTS aims to simplify the development process by providing a clear and concise structure.
-
-Gone are the days of tedious setup tasks such as configuring logging systems, handling authentication, and connecting to databases. With ExpressoTS, developers can focus on what really matters - writing code. The framework takes care of the repetitive and time-consuming aspects of development, allowing developers to work more efficiently.
-
-One of the key features of Expresso TS is its flexible and extensible architecture. The framework provides a simple but powerful dependency injection system that enables developers to quickly and easily extend its functionality by creating and adding providers. This allows developers to seamlessly integrate new features throughout the entire application without having to worry about the complexities of integration.
-
-Whether you're building a simple API or a complex enterprise application, Expresso TS can help you deliver your project on time and on budget. With a comprehensive set of tools and features, Expresso TS makes it easy to build high-quality, scalable, and maintainable server-side applications.
-
-## Getting Started
-
-- Here is our [Official Documentation](https://expresso-ts.com/)
-- Checkout our [First Steps documentation](https://expresso-ts.com/docs/overview/first-steps)
-- Our [CLI Documentation](https://expresso-ts.com/docs/category/cli)
-
-## Questions
-
-For questions and support please use the Official [Discord Channel](https://discord.com/invite/PyPJfGK). We have a very active community there, that will be happy to help you. Post your questions in the channel called **HELP EXPRESSO TS** and forum called **help**.
-
-## Issues
-
-The [Issue Reporting Channel](https://github.com/expressots/expressots/issues) is for bug report and feature request **only**.
-
-Before you create an issue, please make sure you read the [Contribution Guidelines](CONTRIBUTING.md).
-
-## Support the project
-
-Expresso TS is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to your support. If you'd like to help, please consider:
-
-- Become a sponsor on **[Sponsor no GitHub](https://github.com/sponsors/expressots)**
-- Follow the **[organization](https://github.com/expressots)** on GitHub and Star ⭐ the project
-- Subscribe to the Twitch channel: **[Richard Zampieri](https://www.twitch.tv/richardzampieri)**
-- Join our **[Discord](https://discord.com/invite/PyPJfGK)**
-- Contribute submitting **[issues and pull requests](https://github.com/expressots/expressots/issues/new/choose)**
-- Share the project with your friends and colleagues
-
-## Contributors
-
-- [Daniel Boll](https://github.com/daniel-boll)
-- [Felipe Fontana](https://github.com/f0ntana)
-- [Juliano Soares](https://github.com/juliano-soares)
-- [Vitor Caminha](https://github.com/VitorCaminha)
-- [Ariel Betti](https://github.com/ArielBetti)
-- [Rodrigo da Hora](https://github.com/dahorarodrigo)
-
-## Backers
-
-- Work in progress
-
-## License
-
-ExpressoTS is **[MIT licensed](LICENSE.md)**
+<p align="center">
+  <a href="https://expresso-ts.com/" target="blank"><img src="https://github.com/expressots/expressots/blob/main/media/expressots.png" width="120" alt="Expresso TS Logo" /></a>
+</p>
+
+# Expresso TS
+
+A Typescript + [Node.js]("https://nodejs.org/en/") lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🚀
+
+## Philosophy
+
+ExpressoTS is a developer-friendly framework designed to streamline the process of building server-side applications. With a focus on readability, maintainability, and scalability, ExpressoTS aims to simplify the development process by providing a clear and concise structure.
+
+Gone are the days of tedious setup tasks such as configuring logging systems, handling authentication, and connecting to databases. With ExpressoTS, developers can focus on what really matters - writing code. The framework takes care of the repetitive and time-consuming aspects of development, allowing developers to work more efficiently.
+
+One of the key features of Expresso TS is its flexible and extensible architecture. The framework provides a simple but powerful dependency injection system that enables developers to quickly and easily extend its functionality by creating and adding providers. This allows developers to seamlessly integrate new features throughout the entire application without having to worry about the complexities of integration.
+
+Whether you're building a simple API or a complex enterprise application, Expresso TS can help you deliver your project on time and on budget. With a comprehensive set of tools and features, Expresso TS makes it easy to build high-quality, scalable, and maintainable server-side applications.
+
+## Getting Started
+
+- Here is our [Official Documentation](https://expresso-ts.com/)
+- Checkout our [First Steps documentation](https://expresso-ts.com/docs/overview/first-steps)
+- Our [CLI Documentation](https://expresso-ts.com/docs/category/cli)
+
+## Questions
+
+For questions and support please use the Official [Discord Channel](https://discord.com/invite/PyPJfGK). We have a very active community there, that will be happy to help you. Post your questions in the channel called **HELP EXPRESSO TS** and forum called **help**.
+
+## Issues
+
+The [Issue Reporting Channel](https://github.com/expressots/expressots/issues) is for bug report and feature request **only**.
+
+Before you create an issue, please make sure you read the [Contribution Guidelines](CONTRIBUTING.md).
+
+## Support the project
+
+Expresso TS is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to your support. If you'd like to help, please consider:
+
+- Become a sponsor on **[Sponsor no GitHub](https://github.com/sponsors/expressots)**
+- Follow the **[organization](https://github.com/expressots)** on GitHub and Star ⭐ the project
+- Subscribe to the Twitch channel: **[Richard Zampieri](https://www.twitch.tv/richardzampieri)**
+- Join our **[Discord](https://discord.com/invite/PyPJfGK)**
+- Contribute submitting **[issues and pull requests](https://github.com/expressots/expressots/issues/new/choose)**
+- Share the project with your friends and colleagues
+
+## Contributors
+
+- [Daniel Boll](https://github.com/daniel-boll)
+- [Felipe Fontana](https://github.com/f0ntana)
+- [Juliano Soares](https://github.com/juliano-soares)
+- [Vitor Caminha](https://github.com/VitorCaminha)
+- [Ariel Betti](https://github.com/ArielBetti)
+- [Rodrigo da Hora](https://github.com/dahorarodrigo)
+
+## Backers
+
+- Work in progress
+
+## License
+
+ExpressoTS is **[MIT licensed](LICENSE.md)**

package/lib/cjs/application/application.js

@@ -15,11 +15,11 @@ var Application_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerEnvironment = exports.Application = exports.AppInstance = void 0;
 const express_1 = __importDefault(require("express"));
+const process_1 = __importDefault(require("process"));
+const error_handler_middleware_1 = __importDefault(require("../error/error-handler-middleware"));
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
 const inversify_express_utils_1 = require("inversify-express-utils");
-const process_1 = __importDefault(require("process"));
 const console_1 = require("../console/console");
-const error_handler_middleware_1 = __importDefault(require("../error/error-handler-middleware"));
 /**
  * Enum representing possible server environments.
  */
@@ -98,6 +98,25 @@ let Application = Application_1 = class Application {
         });
         this.postServerInitialization();
     }
+    /**
+     * Configures the application's view engine based on the provided configuration options.
+     *
+     * @public
+     * @method setEngine
+     * @template T - A generic type extending from RenderTemplateOptions.
+     *
+     * @param {T} options - An object of type T (must be an object that extends RenderTemplateOptions)
+     *                      that provides the configuration options for setting the view engine.
+     *                      This includes the extension name, view path, and the engine function itself.
+     */
+    setEngine(options) {
+        if ("extName" in options) {
+            const { extName, viewPath, engine } = options;
+            this.app.engine(extName, engine);
+            this.app.set("view engine", extName);
+            this.app.set("views", viewPath);
+        }
+    }
 };
 Application = Application_1 = __decorate([
     (0, inversify_binding_decorators_1.provide)(Application_1),

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

@@ -21,7 +21,7 @@ var BaseController_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseController = void 0;
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-const error_1 = require("../error");
+const logger_1 = require("../logger");
 /**
  * The BaseController class is an abstract base class for controllers.
  * It provides methods for handling use case calls and sending appropriate responses.
@@ -43,14 +43,7 @@ let BaseController = BaseController_1 = class BaseController {
      */
     callUseCaseAsync(useCase, res, successStatusCode) {
         return __awaiter(this, void 0, void 0, function* () {
-            let dataReturn;
-            try {
-                dataReturn = yield useCase;
-                return res.status(successStatusCode).json(dataReturn);
-            }
-            catch (error) {
-                error_1.Report.Error(error, undefined, this.serviceName);
-            }
+            return res.status(successStatusCode).json(yield useCase);
         });
     }
     /**
@@ -60,14 +53,43 @@ let BaseController = BaseController_1 = class BaseController {
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
     callUseCase(useCase, res, successStatusCode) {
-        let dataReturn;
-        try {
-            dataReturn = useCase;
-            return res.status(successStatusCode).json(dataReturn);
-        }
-        catch (error) {
-            error_1.Report.Error(error, undefined, this.serviceName);
-        }
+        return res.status(successStatusCode).json(useCase);
+    }
+    /**
+    * 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.
+     *
+     */
+    callUseRenderAsync(res, template, options = {}) {
+        return new Promise((resolve, reject) => {
+            res.render(template, options, (err, compiled) => {
+                if (err) {
+                    (0, logger_1.log)(logger_1.LogLevel.Error, err.message, "base-controller");
+                    reject(err);
+                }
+                resolve(compiled);
+            });
+        });
     }
 };
 BaseController = BaseController_1 = __decorate([

package/lib/cjs/error/report.js

@@ -11,12 +11,22 @@ exports.Report = void 0;
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
 const logger_1 = require("../logger");
 /**
- * Report class is a utility class to manage and throw application-specific errors.
+ * Report class is a utility class to manage and log errors within the application.
+ * It is responsible for creating a standardized error object, logging it,
+ * and then throwing the error for further handling.
  */
 let Report = Report_1 = class Report {
     /**
-     * Error method takes an instance of AppError and throws it.
-     * @param error - An instance of AppError containing error details.
+     * The Error method is responsible for generating a standardized error object,
+     * logging the error, and then throwing it for further handling.
+     * The error thrown is of the custom type IAppError, which extends the built-in Error class.
+     *
+     * @param error - An instance of Error or a string that describes the error.
+     * @param statusCode - The HTTP status code associated with the error (default is 500).
+     * @param service - The service name associated with the error. If not specified,
+     *                  it defaults to the name of the calling function.
+     *
+     * @throws An object of the custom type IAppError, which includes details about the error.
      */
     static Error(error, statusCode, service) {
         var _a, _b;

package/lib/cjs/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./decorator"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./error"), exports);
 __exportStar(require("./logger"), exports);
+__exportStar(require("./render"), exports);

package/lib/cjs/render/handlebars.interface.js

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

package/lib/cjs/render/index.js

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

package/lib/cjs/render/render.type.js

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

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

@@ -1,6 +1,7 @@
 import express from "express";
 import { Container } from "inversify";
 import { IApplicationMessageToConsole } from "../console/console";
+import { RenderTemplateOptions } from "../render";
 /**
  * Enum representing possible server environments.
  */
@@ -47,6 +48,18 @@ declare class Application {
      * @param consoleMessage - Optional message to display in the console.
      */
     listen(port: number, environment: ServerEnvironment, consoleMessage?: IApplicationMessageToConsole): void;
+    /**
+     * Configures the application's view engine based on the provided configuration options.
+     *
+     * @public
+     * @method setEngine
+     * @template T - A generic type extending from RenderTemplateOptions.
+     *
+     * @param {T} options - An object of type T (must be an object that extends RenderTemplateOptions)
+     *                      that provides the configuration options for setting the view engine.
+     *                      This includes the extension name, view path, and the engine function itself.
+     */
+    setEngine<T extends RenderTemplateOptions>(options: T): void;
 }
 declare const appServerInstance: Application;
 export { appServerInstance as AppInstance, Application, ServerEnvironment };

package/lib/cjs/types/application/application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/application.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,OAAO,EAAW,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAG3E;;GAEG;AACH,aAAK,iBAAiB;IAClB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC5B;AAED;;;GAGG;AACH,cACM,WAAW;IAEb,OAAO,CAAC,GAAG,CAAsB;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,WAAW,CAAoB;IAEvC;;OAEG;;IAGH;;OAEG;IACH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAEnC;;OAEG;IACH,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAE1C;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAIhC;;;;;OAKG;IACI,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,GAAE,OAAO,CAAC,cAAc,EAAO,GAAG,WAAW;IAoC5F;;;;;OAKG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI;CAanH;AAED,QAAA,MAAM,iBAAiB,EAAE,WAA+B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,IAAI,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/application.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAG9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,OAAO,EAAW,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAe,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAE/D;;GAEG;AACH,aAAK,iBAAiB;IAClB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC5B;AAED;;;GAGG;AACH,cACM,WAAW;IAEb,OAAO,CAAC,GAAG,CAAsB;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,WAAW,CAAoB;IAEvC;;OAEG;;IAGH;;OAEG;IACH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAEnC;;OAEG;IACH,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAE1C;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAIhC;;;;;OAKG;IACI,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,GAAE,OAAO,CAAC,cAAc,EAAO,GAAG,WAAW;IAoC5F;;;;;OAKG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI;IAchH;;;;;;;;;;OAUG;IACI,SAAS,CAAC,CAAC,SAAS,qBAAqB,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI;CAQtE;AAED,QAAA,MAAM,iBAAiB,EAAE,WAA+B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,IAAI,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC"}

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

@@ -1,3 +1,4 @@
+import { Response } from 'express';
 import { interfaces } from 'inversify-express-utils';
 /**
  * The BaseController class is an abstract base class for controllers.
@@ -17,14 +18,38 @@ declare abstract class BaseController implements interfaces.Controller {
      * @param res - The Express response object.
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
-    protected callUseCaseAsync(useCase: Promise<any>, res: any, successStatusCode: number): Promise<any>;
+    protected callUseCaseAsync(useCase: Promise<any>, res: Response, successStatusCode: number): Promise<Response<any, Record<string, any>>>;
     /**
      * 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: any, successStatusCode: number): any;
+    protected callUseCase(useCase: any, res: Response, successStatusCode: number): Response<any, Record<string, any>>;
+    /**
+    * 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?: {}): 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.
+     *
+     */
+    protected callUseRenderAsync(res: Response, template: string, options?: {}): Promise<string>;
 }
 export { BaseController };
 //# sourceMappingURL=base-controller.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"base-controller.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/controller/base-controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD;;;;GAIG;AACH,uBACe,cAAe,YAAW,UAAU,CAAC,UAAU;IAE1D,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,WAAW,GAAE,MAAS;IAIlC;;;;;OAKG;cACa,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;IAa3F;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;CAc1E;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"base-controller.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/controller/base-controller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD;;;;GAIG;AACH,uBACe,cAAe,YAAW,UAAU,CAAC,UAAU;IAE1D,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,WAAW,GAAE,MAAW;IAIpC;;;;;OAKG;cACa,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM;IAIhG;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM;IAI3E;;;;;;;;;;MAUE;IACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,IAAI;IAI5E;;;;;;;;;;OAUG;IACH,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;CAW/F;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"error-handler-middleware.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/error-handler-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAIrC;;;;;;;GAOG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAE7F;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"error-handler-middleware.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/error-handler-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC;;;;;;;GAOG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAE7F;AAED,eAAe,YAAY,CAAC"}

package/lib/cjs/types/error/report.d.ts

@@ -6,13 +6,23 @@ interface IAppError {
     stack?: string;
 }
 /**
- * Report class is a utility class to manage and throw application-specific errors.
+ * Report class is a utility class to manage and log errors within the application.
+ * It is responsible for creating a standardized error object, logging it,
+ * and then throwing the error for further handling.
  */
 declare class Report {
     static stack: string;
     /**
-     * Error method takes an instance of AppError and throws it.
-     * @param error - An instance of AppError containing error details.
+     * The Error method is responsible for generating a standardized error object,
+     * logging the error, and then throwing it for further handling.
+     * The error thrown is of the custom type IAppError, which extends the built-in Error class.
+     *
+     * @param error - An instance of Error or a string that describes the error.
+     * @param statusCode - The HTTP status code associated with the error (default is 500).
+     * @param service - The service name associated with the error. If not specified,
+     *                  it defaults to the name of the calling function.
+     *
+     * @throws An object of the custom type IAppError, which includes details about the error.
      */
     static Error(error: Error | string, statusCode?: number, service?: string): void;
 }

package/lib/cjs/types/error/report.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/report.ts"],"names":[],"mappings":"AAGA,UAAU,SAAS;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAGD;;GAEG;AACH,cACM,MAAM;IACR,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC;IAErB;;;OAGG;WACW,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;CA6B1F;AAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/report.ts"],"names":[],"mappings":"AAGA,UAAU,SAAS;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,cACM,MAAM;IACR,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;OAWG;WACW,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;CA6B1F;AAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC"}

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

@@ -7,4 +7,5 @@ export * from "./decorator";
 export * from "./environment";
 export * from "./error";
 export * from "./logger";
+export * from "./render";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/core/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/core/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/lib/cjs/types/render/handlebars.interface.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Configuration options for Express Handlebars.
+ * @interface ConfigOptions
+ */
+interface ConfigOptions {
+    extname?: string;
+    layoutDir?: string;
+    defaultLayout?: string | false;
+}
+/**
+ * Callback function for rendering templates.
+ * @callback RenderCallback
+ *
+ * @param {Error | null} err - The error object.
+ * @param {string} [content] - The rendered content.
+ */
+interface RenderCallback {
+    (err: Error | null, content?: string): void;
+}
+/**
+ * Function for rendering templates.
+ * @typedef Engine
+ *
+ * @param {string} viewPath - The path to the directory containing the templates.
+ * @param {ConfigOptions} options - The configuration options for the template engine.
+ * @param {RenderCallback} [callback] - The callback function for rendering templates.
+ */
+type Engine = (viewPath: string, options: ConfigOptions, callback?: RenderCallback) => void;
+/**
+ * Interface representing the configuration options for Handlebars templates.
+ */
+interface IHandlebars {
+    /**
+     * Specifies the extension name for the Handlebars templates.
+     */
+    extName: string;
+    /**
+     * Specifies the path to the directory containing the Handlebars templates.
+     */
+    viewPath: string;
+    /**
+     * Specifies the function for rendering Handlebars templates.
+     */
+    engine: Engine;
+}
+export { IHandlebars };
+//# sourceMappingURL=handlebars.interface.d.ts.map

package/lib/cjs/types/render/handlebars.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlebars.interface.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/render/handlebars.interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,UAAU,aAAa;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAClC;AAED;;;;;;GAMG;AACH,UAAU,cAAc;IACpB,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/C;AAED;;;;;;;GAOG;AACH,KAAK,MAAM,GAAG,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,aAAa,EACtB,QAAQ,CAAC,EAAE,cAAc,KACxB,IAAI,CAAC;AAEV;;GAEG;AACH,UAAU,WAAW;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

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

@@ -0,0 +1,3 @@
+export { IHandlebars } from "./handlebars.interface";
+export { RenderTemplateOptions } from "./render.type";
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/types/render/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/render/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC"}

package/lib/cjs/types/render/render.type.d.ts

@@ -0,0 +1,13 @@
+import { IHandlebars } from "./handlebars.interface";
+/**
+ * Type alias for the configuration options for rendering templates.
+ *
+ * Currently, this type alias is equivalent to the `IHandlebars` interface,
+ * and represents the configuration options for Handlebars templates.
+ *
+ * In the future, this type could be expanded to include configuration options
+ * for other template engines.
+ */
+type RenderTemplateOptions = IHandlebars;
+export { RenderTemplateOptions };
+//# sourceMappingURL=render.type.d.ts.map

package/lib/cjs/types/render/render.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.type.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/render/render.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;;;;;GAQG;AACH,KAAK,qBAAqB,GAAG,WAAW,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/lib/esm/application/application.js

@@ -9,11 +9,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var Application_1;
 import express from "express";
+import process from "process";
+import errorHandler from "../error/error-handler-middleware";
 import { provide } from "inversify-binding-decorators";
 import { InversifyExpressServer } from "inversify-express-utils";
-import process from "process";
 import { Console } from "../console/console";
-import errorHandler from "../error/error-handler-middleware";
 /**
  * Enum representing possible server environments.
  */
@@ -94,6 +94,25 @@ let Application = Application_1 = class Application {
         });
         this.postServerInitialization();
     }
+    /**
+     * Configures the application's view engine based on the provided configuration options.
+     *
+     * @public
+     * @method setEngine
+     * @template T - A generic type extending from RenderTemplateOptions.
+     *
+     * @param {T} options - An object of type T (must be an object that extends RenderTemplateOptions)
+     *                      that provides the configuration options for setting the view engine.
+     *                      This includes the extension name, view path, and the engine function itself.
+     */
+    setEngine(options) {
+        if ("extName" in options) {
+            const { extName, viewPath, engine } = options;
+            this.app.engine(extName, engine);
+            this.app.set("view engine", extName);
+            this.app.set("views", viewPath);
+        }
+    }
 };
 Application = Application_1 = __decorate([
     provide(Application_1),

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

@@ -9,7 +9,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var BaseController_1;
 import { provide } from 'inversify-binding-decorators';
-import { Report } from '../error';
+import { LogLevel, log } from '../logger';
 /**
  * The BaseController class is an abstract base class for controllers.
  * It provides methods for handling use case calls and sending appropriate responses.
@@ -31,14 +31,7 @@ let BaseController = BaseController_1 = class BaseController {
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
     async callUseCaseAsync(useCase, res, successStatusCode) {
-        let dataReturn;
-        try {
-            dataReturn = await useCase;
-            return res.status(successStatusCode).json(dataReturn);
-        }
-        catch (error) {
-            Report.Error(error, undefined, this.serviceName);
-        }
+        return res.status(successStatusCode).json(await useCase);
     }
     /**
      * Calls a use case and sends an appropriate response based on the result.
@@ -47,14 +40,43 @@ let BaseController = BaseController_1 = class BaseController {
      * @param successStatusCode - The HTTP status code to return upon successful execution.
      */
     callUseCase(useCase, res, successStatusCode) {
-        let dataReturn;
-        try {
-            dataReturn = useCase;
-            return res.status(successStatusCode).json(dataReturn);
-        }
-        catch (error) {
-            Report.Error(error, undefined, this.serviceName);
-        }
+        return res.status(successStatusCode).json(useCase);
+    }
+    /**
+    * 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.
+     *
+     */
+    callUseRenderAsync(res, template, options = {}) {
+        return new Promise((resolve, reject) => {
+            res.render(template, options, (err, compiled) => {
+                if (err) {
+                    log(LogLevel.Error, err.message, "base-controller");
+                    reject(err);
+                }
+                resolve(compiled);
+            });
+        });
     }
 };
 BaseController = BaseController_1 = __decorate([