@expressots/core 1.8.1 → 1.9.1

package/lib/cjs/types/provider/provider-service.d.ts

@@ -0,0 +1,31 @@
+import { Logger } from "./logger/logger-service";
+import { EnvValidatorProvider } from "./environment/env-validator.provider";
+/**
+ * Interface defining the methods for the Provider class.
+ */
+interface IProvider {
+    /**
+     * Returns an instance of the `EnvValidatorProvider`.
+     */
+    envValidator: EnvValidatorProvider;
+    /**
+     * Returns an instance of the `Logger`.
+     */
+    logger: Logger;
+}
+/**
+ * Class responsible for providing singleton instances of various services.
+ *
+ * This class implements the IProvider interface and is decorated with a
+ * singleton provider to ensure a single instance is reused.
+ */
+declare class Provider implements IProvider {
+    envValidator: EnvValidatorProvider;
+    logger: Logger;
+    /**
+     * Initializes the instances of the various providers.
+     */
+    constructor();
+}
+export { IProvider, Provider };
+//# sourceMappingURL=provider-service.d.ts.map

package/lib/cjs/types/provider/provider-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-service.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/provider/provider-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAE5E;;GAEG;AACH,UAAU,SAAS;IACjB;;OAEG;IACH,YAAY,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,cACM,QAAS,YAAW,SAAS;IACjC,YAAY,EAAE,oBAAoB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;;CAKJ;AAED,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC"}

package/lib/esm/application/application-factory.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppFactory = void 0;
+const logger_service_1 = require("../provider/logger/logger-service");
+const adapter_express_1 = require("@expressots/adapter-express");
+//import { AppFastify } from "./fastify/application-fastify";
+//import { IApplicationFastify } from "./fastify/application-fastify.interface";
+//import { Handler } from "@fastify/middie";
+/**
+ * AppFactory Class
+ *
+ * Responsible for creating an instance of the Application,
+ * either using a custom application type or with provided middlewares.
+ */
+class AppFactory {
+    static logger = new logger_service_1.Logger();
+    /* public static async create(
+      container: Container,
+      middlewares: Array<express.RequestHandler>,
+      httpServerFactory?: new () => AppFastify,
+    ): Promise<AppFastify>; */
+    /**
+     * Implementation of the create method, handling both overloads.
+     * @param container - InversifyJS container to resolve dependencies.
+     * @param appTypeOrMiddlewares - Custom application class or array of middlewares.
+     * @returns Instance of the application.
+     */
+    static async create(container, appTypeOrMiddlewares, httpServerFactory /*| AppFastify*/) {
+        let app /*| AppFastify*/ = {}; /*| AppFastify*/
+        if (this.isOpinionated(appTypeOrMiddlewares)) {
+            switch (httpServerFactory) {
+                case adapter_express_1.AppExpress:
+                    app = container.resolve(appTypeOrMiddlewares);
+                    app.create(container);
+                    return app;
+                /* case AppFastify:
+                  app = container.resolve(appTypeOrMiddlewares as new () => AppFastify);
+                  await app.create(container);
+                  return app as IApplicationFastify; */
+                default:
+                    app = container.resolve(appTypeOrMiddlewares);
+                    app.create(container);
+                    return app;
+            }
+        }
+        else {
+            switch (httpServerFactory) {
+                case adapter_express_1.AppExpress:
+                    app = container.get(adapter_express_1.AppExpress);
+                    app.create(container, appTypeOrMiddlewares);
+                    return app;
+                /* case AppFastify:
+                  app = container.get<AppFastify>(AppFastify);
+                  await app.create(container, appTypeOrMiddlewares as Array<Handler>);
+                  return app as AppFastify; */
+                default:
+                    app = container.get(adapter_express_1.AppExpress);
+                    app.create(container, appTypeOrMiddlewares);
+                    return app;
+            }
+        }
+    }
+    /**
+     * Checks if the provided parameter is a custom application type.
+     * @param appTypeOrMiddlewares - Custom application class or array of middlewares.
+     * @returns True if the provided parameter is a custom application type.
+     */
+    static isOpinionated(appTypeOrMiddlewares) {
+        return typeof appTypeOrMiddlewares === "function";
+    }
+}
+exports.AppFactory = AppFactory;

package/lib/esm/application/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppContainer = exports.ServerEnvironment = exports.Application = exports.AppInstance = void 0;
-var application_1 = require("./application");
-Object.defineProperty(exports, "AppInstance", { enumerable: true, get: function () { return application_1.AppInstance; } });
-Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
-Object.defineProperty(exports, "ServerEnvironment", { enumerable: true, get: function () { return application_1.ServerEnvironment; } });
+exports.AppFactory = exports.AppContainer = void 0;
 var app_container_1 = require("./app-container");
 Object.defineProperty(exports, "AppContainer", { enumerable: true, get: function () { return app_container_1.AppContainer; } });
+var application_factory_1 = require("./application-factory");
+Object.defineProperty(exports, "AppFactory", { enumerable: true, get: function () { return application_factory_1.AppFactory; } });

package/lib/esm/common/color-service.provider.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bgColorCodes = exports.colorCodes = exports.ColorStyle = void 0;
+/**
+ * Mapping of text color codes.
+ *
+ * @remarks
+ * Defines the ANSI escape codes for the corresponding colors in the terminal.
+ */
+const colorCodes = {
+    red: "\x1b[31m",
+    green: "\x1b[32m",
+    yellow: "\x1b[33m",
+    blue: "\x1b[34m",
+    white: "\x1b[37m",
+    black: "\x1b[30m",
+    none: "\x1b[0m",
+};
+exports.colorCodes = colorCodes;
+/**
+ * ANSI escape color codes mapping for different background colors.
+ */
+const bgColorCodes = {
+    red: "\x1b[41m",
+    green: "\x1b[42m",
+    yellow: "\x1b[43m",
+    blue: "\x1b[44m",
+    white: "\x1b[47m",
+    black: "\x1b[40m",
+    none: "\x1b[0m",
+};
+exports.bgColorCodes = bgColorCodes;
+/**
+ * Enum representing possible color styles for console output.
+ *
+ * @remarks
+ * Enum values correspond to the string representations of colors.
+ */
+var ColorStyle;
+(function (ColorStyle) {
+    ColorStyle["None"] = "none";
+    ColorStyle["Yellow"] = "yellow";
+    ColorStyle["Blue"] = "blue";
+    ColorStyle["Green"] = "green";
+    ColorStyle["Red"] = "red";
+})(ColorStyle || (exports.ColorStyle = ColorStyle = {}));

package/lib/esm/common/package-resolver.provider.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageResolver = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const logger_service_1 = require("../provider/logger/logger-service");
+/**
+ * Resolve package from the current working directory.
+ * @param packageName
+ * @param options
+ * @returns
+ */
+function packageResolver(packageName, ...options) {
+    const logger = new logger_service_1.Logger();
+    try {
+        const hasPackage = require.resolve(packageName, {
+            paths: [process.cwd()],
+        });
+        if (hasPackage) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const packageResolved = require(hasPackage);
+            if (typeof packageResolved === "function") {
+                return packageResolved(...options);
+            }
+            if (packageResolved.default &&
+                typeof packageResolved.default === "function") {
+                return packageResolved.default(...options);
+            }
+            return packageResolved;
+        }
+    }
+    catch (error) {
+        logger.warn(`Package [${packageName}] not installed. Please install it using your package manager.`, "package-resolver");
+    }
+}
+exports.packageResolver = packageResolver;

package/lib/esm/console/console.js

@@ -5,25 +5,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     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;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var Console_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Console = void 0;
-const chalk_1 = __importDefault(require("chalk"));
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-/**
- * Enum representing possible color styles for console output.
- */
-var ColorStyle;
-(function (ColorStyle) {
-    ColorStyle[ColorStyle["None"] = 0] = "None";
-    ColorStyle[ColorStyle["Yellow"] = 1] = "Yellow";
-    ColorStyle[ColorStyle["Blue"] = 2] = "Blue";
-    ColorStyle[ColorStyle["Green"] = 3] = "Green";
-    ColorStyle[ColorStyle["Red"] = 4] = "Red";
-})(ColorStyle || (ColorStyle = {}));
+const color_service_provider_1 = require("../common/color-service.provider");
 /**
  * The Console class provides methods for displaying styled messages in the console.
  * @provide Console
@@ -35,16 +21,9 @@ let Console = Console_1 = class Console {
      * @param colorStyle - The color style for the message.
      */
     async printColor(message, colorStyle) {
-        switch (colorStyle) {
-            case ColorStyle.Yellow:
-                return console.log(chalk_1.default.bgYellow.black(message));
-            case ColorStyle.Blue:
-                return console.log(chalk_1.default.bgBlue.black(message));
-            case ColorStyle.Green:
-                return console.log(chalk_1.default.bgGreen.black(message));
-            case ColorStyle.Red:
-                return console.log(chalk_1.default.bgRed.black(message));
-        }
+        const textColor = "black";
+        const bgColor = colorStyle;
+        console.log(`${color_service_provider_1.bgColorCodes[bgColor]}${color_service_provider_1.colorCodes[textColor]}${message}\x1b[0m`);
     }
     /**
      * Display a message in the console with details about the running server.
@@ -52,26 +31,24 @@ let Console = Console_1 = class Console {
      * @param environment - The server environment.
      * @param consoleMessage - Optional application message details for console output.
      */
-    async messageServer(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    port, environment, consoleMessage) {
+    async messageServer(port, environment, consoleMessage) {
         const appConsoleMessage = {
             appName: consoleMessage?.appName || "Application",
             appVersion: consoleMessage?.appVersion || "not provided",
         };
-        let terminalColor = ColorStyle.None;
+        let terminalColor = color_service_provider_1.ColorStyle.None;
         switch (environment.toLowerCase()) {
             case "development":
-                terminalColor = ColorStyle.Yellow;
+                terminalColor = color_service_provider_1.ColorStyle.Yellow;
                 break;
             case "staging":
-                terminalColor = ColorStyle.Blue;
+                terminalColor = color_service_provider_1.ColorStyle.Blue;
                 break;
             case "production":
-                terminalColor = ColorStyle.Green;
+                terminalColor = color_service_provider_1.ColorStyle.Green;
                 break;
             default:
-                terminalColor = ColorStyle.Red;
+                terminalColor = color_service_provider_1.ColorStyle.Red;
                 break;
         }
         this.printColor(`${appConsoleMessage.appName} version ${appConsoleMessage.appVersion} is running on ` +

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

@@ -5,28 +5,16 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     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;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 var BaseController_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseController = void 0;
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-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.
  * @provide BaseController
  */
 let BaseController = BaseController_1 = class BaseController {
-    serviceName;
-    /**
-     * Constructs a new BaseController instance with a specified service name.
-     * @param serviceName - The name of the service associated with the controller.
-     */
-    constructor(serviceName = "") {
-        this.serviceName = serviceName;
-    }
     /**
      * Calls an asynchronous use case and sends an appropriate response based on the result.
      * @param useCase - A promise representing the asynchronous use case to call.
@@ -74,7 +62,6 @@ let BaseController = BaseController_1 = class BaseController {
         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);
@@ -84,6 +71,5 @@ let BaseController = BaseController_1 = class BaseController {
 };
 exports.BaseController = BaseController;
 exports.BaseController = BaseController = BaseController_1 = __decorate([
-    (0, inversify_binding_decorators_1.provide)(BaseController_1),
-    __metadata("design:paramtypes", [String])
+    (0, inversify_binding_decorators_1.provide)(BaseController_1)
 ], BaseController);

package/lib/esm/decorator/scope-binding.js

@@ -4,10 +4,40 @@ exports.provideTransient = exports.provideSingleton = void 0;
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
+/**
+ * Provides a singleton binding for the given identifier.
+ *
+ * @remarks
+ * Singleton binding ensures that the same instance of a dependency is reused within the entire container.
+ *
+ * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
+ * @returns A fluent interface for further configuring the binding.
+ *
+ * @example
+ * ```typescript
+ * @provideSingleton(ServiceIdentifier)
+ * class MyService {}
+ * ```
+ */
 const provideSingleton = (identifier) => {
     return (0, inversify_binding_decorators_1.fluentProvide)(identifier).inSingletonScope().done();
 };
 exports.provideSingleton = provideSingleton;
+/**
+ * Provides a transient binding for the given identifier.
+ *
+ * @remarks
+ * Transient binding ensures that a new instance of a dependency is created every time it is resolved.
+ *
+ * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
+ * @returns A fluent interface for further configuring the binding.
+ *
+ * @example
+ * ```typescript
+ * @provideTransient(ServiceIdentifier)
+ * class MyService {}
+ * ```
+ */
 const provideTransient = (identifier) => {
     return (0, inversify_binding_decorators_1.fluentProvide)(identifier).inTransientScope().done();
 };

package/lib/esm/error/report.js

@@ -5,10 +5,14 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     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;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 var Report_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Report = void 0;
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
+const logger_service_1 = require("../provider/logger/logger-service");
 const app_error_1 = require("./app-error");
 /**
  * Report class is a utility class to manage and log errors within the application.
@@ -18,19 +22,23 @@ const app_error_1 = require("./app-error");
 let Report = class Report {
     static { Report_1 = this; }
     static stack;
+    logger;
+    constructor() {
+        this.logger = new logger_service_1.Logger();
+    }
     /**
      * 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.
+     * The error thrown is of the custom type AppError, 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.
+     * @throws An object of the custom type AppError, which includes details about the error.
      */
-    Error(error, statusCode, service) {
+    error(error, statusCode, service) {
         let appError = {};
         if (error instanceof Error) {
             appError = new app_error_1.AppError(error.message, statusCode, service);
@@ -38,10 +46,12 @@ let Report = class Report {
         else {
             appError = new app_error_1.AppError(error, statusCode, service);
         }
-        throw appError;
+        this.logger.error(appError.message, appError.service || "service-undefined");
+        return appError;
     }
 };
 exports.Report = Report;
 exports.Report = Report = Report_1 = __decorate([
-    (0, inversify_binding_decorators_1.provide)(Report_1)
+    (0, inversify_binding_decorators_1.provide)(Report_1),
+    __metadata("design:paramtypes", [])
 ], Report);

package/lib/esm/index.mjs

@@ -20,7 +20,7 @@ __exportStar(require("./console"), exports);
 __exportStar(require("./container-module"), exports);
 __exportStar(require("./controller"), exports);
 __exportStar(require("./decorator"), exports);
-__exportStar(require("./environment"), exports);
 __exportStar(require("./error"), exports);
-__exportStar(require("./logger"), exports);
+__exportStar(require("./middleware"), exports);
+__exportStar(require("./provider"), exports);
 __exportStar(require("./render"), exports);

package/lib/esm/middleware/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Middleware = void 0;
+var middleware_service_1 = require("./middleware-service");
+Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return middleware_service_1.Middleware; } });

package/lib/esm/middleware/interfaces/body-parser.interface.js

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

package/lib/esm/middleware/interfaces/compression.interface.js

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

package/lib/esm/middleware/interfaces/cors.interface.js

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

package/lib/esm/middleware/interfaces/serve-static.interface.js

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

package/lib/esm/middleware/middleware-resolver.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.middlewareResolver = void 0;
+const logger_service_1 = require("../provider/logger/logger-service");
+/**
+ * MiddlewareResolver class is responsible for resolving and retrieving Express middlewares
+ * by their names. It maintains a registry of available middlewares and provides
+ * a method to retrieve them by their name. If a middleware is not installed, it logs
+ * an informative message.
+ */
+class MiddlewareResolver {
+    logger;
+    constructor() {
+        this.logger = new logger_service_1.Logger();
+    }
+    /**
+     * A registry object mapping middleware names to their corresponding package names.
+     * It is used to identify and require the middleware from the current working directory.
+     */
+    middlewareRegistry = {
+        cors: "cors",
+        compression: "compression",
+        // Add other middlewares
+    };
+    /**
+     * Retrieves a middleware by its name and optionally configures it with provided options.
+     *
+     * @param {string} middlewareName - The name of the middleware to be retrieved.
+     * @param {...any} options - Optional arguments to configure the middleware.
+     * @returns {express.RequestHandler | null} - Returns the configured middleware or null if not found or not installed.
+     */
+    getMiddleware(middlewareName, ...options) {
+        const packageName = this.middlewareRegistry[middlewareName];
+        if (!packageName) {
+            console.error(`Middleware ${middlewareName} not found`);
+            return null;
+        }
+        let hasMiddleware = "";
+        try {
+            hasMiddleware = require.resolve(packageName, { paths: [process.cwd()] });
+        }
+        catch (error) {
+            this.logger.warn(`Middleware [${middlewareName}] not installed. Please install it using your package manager.`, "middleware-resolver");
+        }
+        if (hasMiddleware) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const middleware = require(hasMiddleware);
+            return middleware(...options) || middleware.default(...options);
+        }
+        else {
+            this.logger.warn(`Middleware [${middlewareName}] not installed. Please install it using your package manager.`, "middleware-resolver");
+        }
+        return null;
+    }
+}
+/**
+ * A utility function that wraps the creation and retrieval of middleware.
+ * It creates a new instance of MiddlewareResolver and calls the getMiddleware method.
+ *
+ * @param {string} middleware - The name of the middleware to be retrieved.
+ * @param {...any} options - Optional arguments to configure the middleware.
+ * @returns {express.RequestHandler | null} - Returns the configured middleware or null if not found or not installed.
+ */
+function middlewareResolver(middleware, ...options) {
+    const resolver = new MiddlewareResolver();
+    return resolver.getMiddleware(middleware, ...options);
+}
+exports.middlewareResolver = middlewareResolver;