@expressots/core 2.10.0 → 2.11.0

package/lib/CHANGELOG.md

@@ -1,5 +1,26 @@
 
 
+## [2.11.0](https://github.com/expressots/expressots/compare/2.10.0...2.11.0) (2024-04-04)
+
+
+### Features
+
+* bump @types/node from 20.12.2 to 20.12.3 ([430ada9](https://github.com/expressots/expressots/commit/430ada937b04ad12ca26dad1decabffe0b5299ab))
+
+
+### Bug Fixes
+
+* update adpater version to latest ([89c671d](https://github.com/expressots/expressots/commit/89c671d2905ceea8877ee5cc6c6fc8ddae262549))
+* update console tests ([c639466](https://github.com/expressots/expressots/commit/c6394663749fe4ebda9ce0b54ccaa7e83593d0df))
+* upgrade tsconfig-paths from 4.1.2 to 4.2.0 ([fc373a6](https://github.com/expressots/expressots/commit/fc373a64d41174351439a356afd3708aba0e8661))
+* upgrade tsconfig-paths from 4.1.2 to 4.2.0 ([e8f0d68](https://github.com/expressots/expressots/commit/e8f0d68a02999d8bcf9936c1973b62a9c97119ac))
+
+
+### Code Refactoring
+
+* appfactory class ([3fde40a](https://github.com/expressots/expressots/commit/3fde40a8754e22ad377e58d2c5a0b16fcf116dd0))
+* rename items for standardization and improve doc ([d01f4d1](https://github.com/expressots/expressots/commit/d01f4d191a09716fde688404506ea7895efaf127))
+
 ## [2.10.0](https://github.com/expressots/expressots/compare/2.9.1...2.10.0) (2024-03-31)
 
 

package/lib/cjs/application/{app-container.js → application-container.js}

@@ -18,16 +18,18 @@ const inversify_binding_decorators_1 = require("inversify-binding-decorators");
  * and the ability to skip base class checks. The container can be loaded with multiple
  * ContainerModule instances, facilitating modular and organized code.
  *
- * Usage:
- * const appContainer = new AppContainer(options);
- * const container = appContainer.create(modules);
- *
- * @provide AppContainer
+ * @example
+ * ```typescript
+ * const container = new AppContainer();
+ * container.create([new MyModule()]);
  */
 let AppContainer = class AppContainer {
     /**
      * Constructs the AppContainer instance.
-     * @param options - The options for creating the container. Can include custom default scope and skip base class checks setting.
+     * @param options - The options for creating the container with default request scope.
+     * @option options.defaultScope - The default scope for bindings in the container.
+     * @option options.skipBaseClassChecks - Allows skipping of base class checks when working with derived classes.
+     * @option options.autoBindInjectable - Allows auto-binding of injectable classes.
      */
     constructor(options) {
         this.options = {

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

@@ -2,73 +2,38 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppFactory = void 0;
 const logger_provider_1 = require("../provider/logger/logger.provider");
-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";
+/**
+ * Type guard to check if input is a constructor type of IWebServer.
+ * @param input - Input to check.
+ * @returns True if input is a constructor type of IWebServer.
+ */
+function isWebServerConstructor(input) {
+    return input && typeof input === "function";
+}
 /**
  * AppFactory Class
  *
- * Responsible for creating an instance of the Application,
- * either using a custom application type or with provided middlewares.
+ * Responsible for creating an instance of the IWebServer implementation using a custom application type.
  */
 class AppFactory {
-    /* public static async create(
-      container: Container,
-      middlewares: Array<express.RequestHandler>,
-      httpServerFactory?: new () => AppFastify,
-    ): Promise<AppFastify>; */
     /**
-     * Implementation of the create method, handling both overloads.
+     * Create an instance of a web server.
      * @param container - InversifyJS container to resolve dependencies.
-     * @param appTypeOrMiddlewares - Custom application class or array of middlewares.
-     * @returns Instance of the application.
+     * @param webServerType - Constructor of a class that implements IWebServer, or array of middlewares.
+     * @returns A promise that resolves to an instance of IWebServer.
      */
-    static async create(container, appTypeOrMiddlewares, httpServerFactory /*| AppFastify*/) {
-        // Set the container for the application global access
+    static async create(container, webServerType) {
         AppFactory.container = container;
-        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;
-            }
+        if (isWebServerConstructor(webServerType)) {
+            const webServerInstance = new webServerType();
+            await webServerInstance.configure(container);
+            return webServerInstance;
         }
         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;
-            }
+            this.logger.error("Invalid web server type.", "app-factory:create");
+            throw new Error("Invalid web server type.");
         }
     }
-    /**
-     * 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;
 AppFactory.logger = new logger_provider_1.Logger();

package/lib/cjs/application/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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_container_1 = require("./application-container");
+Object.defineProperty(exports, "AppContainer", { enumerable: true, get: function () { return application_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/cjs/console/console.js

@@ -8,7 +8,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Console = void 0;
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-const color_service_provider_1 = require("../common/color-service.provider");
+const color_codes_1 = require("../common/color-codes");
 /**
  * The Console class provides methods for displaying styled messages in the console.
  * @provide Console
@@ -22,7 +22,7 @@ let Console = class Console {
     async printColor(message, colorStyle) {
         const textColor = "black";
         const bgColor = colorStyle;
-        console.log(`${color_service_provider_1.bgColorCodes[bgColor]}${color_service_provider_1.colorCodes[textColor]}${message}\x1b[0m`);
+        console.log(`${color_codes_1.bgColorCodes[bgColor]}${color_codes_1.colorCodes[textColor]}${message}\x1b[0m`);
     }
     /**
      * Display a message in the console with details about the running server.
@@ -35,19 +35,19 @@ let Console = class Console {
             appName: consoleMessage?.appName || "Application",
             appVersion: consoleMessage?.appVersion || "not provided",
         };
-        let terminalColor = color_service_provider_1.ColorStyle.None;
+        let terminalColor = color_codes_1.ColorStyle.None;
         switch (environment.toLowerCase()) {
             case "development":
-                terminalColor = color_service_provider_1.ColorStyle.Yellow;
+                terminalColor = color_codes_1.ColorStyle.Yellow;
                 break;
             case "staging":
-                terminalColor = color_service_provider_1.ColorStyle.Blue;
+                terminalColor = color_codes_1.ColorStyle.Blue;
                 break;
             case "production":
-                terminalColor = color_service_provider_1.ColorStyle.Green;
+                terminalColor = color_codes_1.ColorStyle.Green;
                 break;
             default:
-                terminalColor = color_service_provider_1.ColorStyle.Red;
+                terminalColor = color_codes_1.ColorStyle.Red;
                 break;
         }
         this.printColor(`${appConsoleMessage.appName} version ${appConsoleMessage.appVersion} is running on ` +

package/lib/cjs/provider/dto-validator/dto-validator.provider.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValidateDTO = void 0;
 require("reflect-metadata");
 const status_code_1 = require("../../error/status-code");
-const package_resolver_provider_1 = require("../../common/package-resolver.provider");
+const package_resolver_1 = require("../../common/package-resolver");
 const logger_provider_1 = require("../logger/logger.provider");
 /**
  * Validate the DTO using class-validator and class-transformer.
@@ -15,8 +15,8 @@ const logger_provider_1 = require("../logger/logger.provider");
 function ValidateDTO(type) {
     return async (req, res, next) => {
         const logger = new logger_provider_1.Logger();
-        const classValidator = (0, package_resolver_provider_1.packageResolver)("class-validator");
-        const classTransformer = (0, package_resolver_provider_1.packageResolver)("class-transformer");
+        const classValidator = (0, package_resolver_1.packageResolver)("class-validator");
+        const classTransformer = (0, package_resolver_1.packageResolver)("class-transformer");
         if (!classValidator || !classTransformer) {
             return next();
         }

package/lib/cjs/provider/logger/logger.provider.js

@@ -11,7 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
 const inversify_1 = require("inversify");
-const color_service_provider_1 = require("../../common/color-service.provider");
+const color_codes_1 = require("../../common/color-codes");
 /**
  * Applies a specified color to a text string.
  *
@@ -20,7 +20,7 @@ const color_service_provider_1 = require("../../common/color-service.provider");
  * @returns The colored text.
  */
 function colorText(text, color) {
-    return `${color_service_provider_1.colorCodes[color]}${text}\x1b[0m`;
+    return `${color_codes_1.colorCodes[color]}${text}\x1b[0m`;
 }
 /**
  * Class that provides logging functionality with colorized text.

package/lib/cjs/types/application/{app-container.d.ts → application-container.d.ts}

@@ -23,18 +23,20 @@ interface ContainerOptions {
  * and the ability to skip base class checks. The container can be loaded with multiple
  * ContainerModule instances, facilitating modular and organized code.
  *
- * Usage:
- * const appContainer = new AppContainer(options);
- * const container = appContainer.create(modules);
- *
- * @provide AppContainer
+ * @example
+ * ```typescript
+ * const container = new AppContainer();
+ * container.create([new MyModule()]);
  */
 declare class AppContainer {
     private container;
     private options;
     /**
      * Constructs the AppContainer instance.
-     * @param options - The options for creating the container. Can include custom default scope and skip base class checks setting.
+     * @param options - The options for creating the container with default request scope.
+     * @option options.defaultScope - The default scope for bindings in the container.
+     * @option options.skipBaseClassChecks - Allows skipping of base class checks when working with derived classes.
+     * @option options.autoBindInjectable - Allows auto-binding of injectable classes.
      */
     constructor(options?: ContainerOptions);
     /**

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

@@ -1,34 +1,19 @@
-import express from "express";
+import { IWebServer, IWebServerPublic, IWebServerConstructor } from "@expressots/adapter-express";
 import { Container } from "inversify";
-import { AppExpress, IApplicationExpress } from "@expressots/adapter-express";
 /**
  * AppFactory Class
  *
- * Responsible for creating an instance of the Application,
- * either using a custom application type or with provided middlewares.
+ * Responsible for creating an instance of the IWebServer implementation using a custom application type.
  */
 declare class AppFactory {
     static container: Container;
     private static logger;
     /**
-     * Creates an instance of the application using a custom application type.
+     * Create an instance of a web server.
      * @param container - InversifyJS container to resolve dependencies.
-     * @param CustomAppType - Custom application class extending Application.
-     * @returns Instance of the application.
+     * @param webServerType - Constructor of a class that implements IWebServer, or array of middlewares.
+     * @returns A promise that resolves to an instance of IWebServer.
      */
-    static create(container: Container, CustomAppType: new () => AppExpress, httpServerFactory?: new () => AppExpress): Promise<IApplicationExpress>;
-    /**
-     * Creates an instance of the application with provided middlewares.
-     * @param container - InversifyJS container to resolve dependencies.
-     * @param middlewares - Array of Express middlewares to be applied.
-     * @returns Instance of the application.
-     */
-    static create(container: Container, middlewares: Array<express.RequestHandler>, httpServerFactory?: new () => AppExpress): Promise<AppExpress>;
-    /**
-     * 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.
-     */
-    private static isOpinionated;
+    static create<T extends IWebServer>(container: Container, webServerType: IWebServerConstructor<T>): Promise<IWebServerPublic>;
 }
 export { AppFactory };

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

@@ -1,2 +1,2 @@
-export { AppContainer } from "./app-container";
+export { AppContainer } from "./application-container";
 export { AppFactory } from "./application-factory";

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

@@ -1 +1 @@
-export { Pattern, ExpressoConfig } from "./project-config.provider";
+export { Pattern, ExpressoConfig } from "./project-config";

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -78,7 +78,7 @@
     "@expressots/adapter-express": "latest",
     "@release-it/conventional-changelog": "7.0.2",
     "@types/express": "4.17.21",
-    "@types/node": "20.12.2",
+    "@types/node": "20.12.3",
     "@typescript-eslint/eslint-plugin": "6.21.0",
     "@typescript-eslint/parser": "6.6.0",
     "@vitest/coverage-v8": "1.4.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -78,7 +78,7 @@
     "@expressots/adapter-express": "latest",
     "@release-it/conventional-changelog": "7.0.2",
     "@types/express": "4.17.21",
-    "@types/node": "20.12.2",
+    "@types/node": "20.12.3",
     "@typescript-eslint/eslint-plugin": "6.21.0",
     "@typescript-eslint/parser": "6.6.0",
     "@vitest/coverage-v8": "1.4.0",