Merge pull request #16 from expressots/241-refactor-appfactory

241 refactor appfactory

Author: rsaz

package.json

@@ -56,35 +56,36 @@
     "build": "npm run clean && npm run build:cjs && npm run copy",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "release": "release-it",
+    "prepublish": "npm run build && npm pack",
     "test": "jest",
     "format": "prettier --write \"src/**/*.ts\" --cache",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix"
   },
   "dependencies": {
-    "dotenv": "^16.0.3",
-    "inversify": "^6.0.1",
-    "inversify-binding-decorators": "^4.0.0",
-    "jest": "^29.5.0",
-    "reflect-metadata": "^0.1.13"
+    "dotenv": "16.4.5",
+    "inversify": "6.0.2",
+    "inversify-binding-decorators": "4.0.0",
+    "jest": "29.5.0",
+    "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^18.0.0",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@expressots/core": "^2.2.0",
-    "@release-it/conventional-changelog": "^7.0.1",
-    "@types/express": "^4.17.17",
-    "@types/jest": "^29.5.0",
-    "@types/node": "^20.4.9",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
-    "eslint": "^8.48.0",
-    "eslint-config-prettier": "^9.0.0",
-    "husky": "^8.0.3",
-    "prettier": "^3.0.3",
-    "release-it": "^16.1.5",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.2.2"
+    "@commitlint/config-conventional": "17.7.0",
+    "@expressots/core": "latest",
+    "@release-it/conventional-changelog": "7.0.1",
+    "@types/express": "4.17.21",
+    "@types/jest": "29.5.0",
+    "@types/node": "20.4.9",
+    "@typescript-eslint/eslint-plugin": "6.6.0",
+    "@typescript-eslint/parser": "6.6.0",
+    "eslint": "8.48.0",
+    "eslint-config-prettier": "9.0.0",
+    "husky": "8.0.3",
+    "prettier": "3.0.3",
+    "release-it": "16.1.5",
+    "ts-jest": "29.0.5",
+    "typescript": "5.2.2"
   },
   "release-it": {
     "git": {

src/adapter-express/application-base.ts src/adapter-express/application-express.base.ts

@@ -21,40 +21,32 @@ import { provide } from "inversify-binding-decorators";
  * @abstract
  */
 @provide(ApplicationBase)
-abstract class ApplicationBase {
+export abstract class ApplicationBase {
   /**
-   * Method to configure services that should be initialized
-   * before the server starts. It must be implemented by the
-   * extending class to set up necessary services or configurations.
-   * Can return a Promise for async configuration.
+   * Implement this method to set up required services or configurations before
+   * the server starts. This is essential for initializing dependencies or settings
+   * necessary for server operation. Supports asynchronous setup with a Promise.
    *
    * @abstract
    * @returns {void | Promise<void>}
    */
   protected abstract configureServices(): void | Promise<void>;
 
   /**
-   * Method to configure services or actions that should be executed
-   * after the server starts. It allows the extending class to perform
-   * any necessary operations once the server is up and running.
-   * Can return a Promise for async execution.
+   * Implement this method to execute actions or configurations after the server
+   * has started. Use this for operations that need to run once the server is
+   * operational. Supports asynchronous execution with a Promise.
    *
    * @abstract
    * @returns {void | Promise<void>}
    */
   protected abstract postServerInitialization(): void | Promise<void>;
 
   /**
-   * Method to perform any necessary actions or cleanup after the server
-   * is shutting down. This might include closing database connections,
-   * stopping background tasks, or other cleanup activities. It provides
-   * a clean exit point for the server.
-   * Can return a Promise for async cleanup.
-   *
-   * @abstract
-   * @returns {void | Promise<void>}
+   * Implement this method to handle cleanup and final actions when the server
+   * is shutting down. Ideal for closing resources, stopping tasks, or other
+   * cleanup procedures to ensure a graceful server shutdown. Supports asynchronous
+   * cleanup with a Promise.
    */
   protected abstract serverShutdown(): void | Promise<void>;
 }
-
-export { ApplicationBase };

src/adapter-express/application-express.interface.ts

@@ -1,11 +1,10 @@
 import { IApplicationMessageToConsole, RenderTemplateOptions } from "@expressots/core";
-import { ServerEnvironment } from "./application-express";
+import { ServerEnvironment } from "./application-express.types";
 
 /**
- * Interface representing the Application class for Expressjs
- * @interface IApplicationExpress
+ * Public Interface for the WebServer application.
  */
-interface IApplicationExpress {
+export interface IWebServerPublic {
   /**
    * Start listening on the given port and environment.
    * @param port - The port number to listen on.
@@ -16,7 +15,7 @@ interface IApplicationExpress {
     port: number,
     environment: ServerEnvironment,
     consoleMessage?: IApplicationMessageToConsole,
-  ): Promise<void> | void;
+  ): Promise<void>;
 
   /**
    * Configures the application's view engine based on the provided configuration options.
@@ -31,5 +30,3 @@ interface IApplicationExpress {
    */
   setEngine<T extends RenderTemplateOptions>(options: T): void;
 }
-
-export { IApplicationExpress };

src/adapter-express/application-express.ts

@@ -1,89 +1,45 @@
-import express, { Request, Response, NextFunction } from "express";
-import { Container } from "inversify";
-import { provide } from "inversify-binding-decorators";
-import process from "process";
 import {
   Console,
   IApplicationMessageToConsole,
-  IMiddleware,
-  Middleware,
-  Logger,
   IHandlebars,
+  Logger,
+  Middleware,
   RenderTemplateOptions,
 } from "@expressots/core";
-import { IApplicationExpress } from "./application-express.interface";
+import express from "express";
+import { Container } from "inversify";
+import { provide } from "inversify-binding-decorators";
+import process from "process";
+import { ApplicationBase } from "./application-express.base";
 import { InversifyExpressServer } from "./express-utils/inversify-express-server";
-import { ApplicationBase } from "./application-base";
-
-/**
- * ExpressHandler Type
- *
- * The ExpressHandler type is a union type that represents various types of Express middleware functions.
- * It can be one of the following types:
- * - express.ErrorRequestHandler: Handles errors in the middleware pipeline.
- * - express.RequestParamHandler: Handles parameters in the middleware pipeline.
- * - express.RequestHandler: General request handler.
- * - undefined: Represents the absence of a handler.
- */
-type ExpressHandler =
-  | express.ErrorRequestHandler
-  | express.RequestParamHandler
-  | express.RequestHandler
-  | undefined;
-
-/**
- * MiddlewareConfig Interface
- *
- * The MiddlewareConfig interface specifies the structure for middleware configuration objects.
- * - path: Optional. The route path for which the middleware is configured.
- * - middlewares: An array of ExpressHandler types that make up the middleware pipeline for the route specified by 'path'.
- */
-type MiddlewareConfig = {
-  path?: string;
-  middlewares: Array<ExpressHandler>;
-};
-
-/**
- * Expresso middleware interface.
- */
-interface IExpressoMiddleware {
-  //readonly name: string;
-  use(req: Request, res: Response, next: NextFunction): Promise<void> | void;
-}
-
-/**
- * Abstract class for creating custom Expresso middleware.
- * Custom middleware classes should extend this class and implement the use method.
- *
- */
-abstract class ExpressoMiddleware implements IExpressoMiddleware {
-  get name(): string {
-    return this.constructor.name;
-  }
-
-  abstract use(req: Request, res: Response, next: NextFunction): Promise<void> | void;
-}
-
-/**
- * Enum representing possible server environments.
- */
-enum ServerEnvironment {
-  Development = "development",
-  Production = "production",
-}
+import {
+  ExpressHandler,
+  ExpressoMiddleware,
+  IWebServer,
+  MiddlewareConfig,
+  ServerEnvironment,
+} from "./application-express.types";
 
 /**
- * The Application class provides a way to configure and manage an Express application.
- * @provide Application
+ * The AppExpress class provides methods for configuring and running an Express application.
+ * @class AppExpress
+ * @implements {IWebServer} - Interface for the WebServer application implementation.
+ * @extends {ApplicationBase} - Base class for the application implementation that provides lifecycle hooks.
+ * @method configure - Configures the InversifyJS container.
+ * @method listen - Start listening on the given port and environment.
+ * @method setGlobalRoutePrefix - Sets the global route prefix for the application.
+ * @method setEngine - Configures the application's view engine based on the provided configuration options.
+ * @method isDevelopment - Verifies if the current environment is development.
  */
-@provide(ApplicationExpress)
-class ApplicationExpress extends ApplicationBase implements IApplicationExpress {
+@provide(AppExpress)
+class AppExpress extends ApplicationBase implements IWebServer {
   private app: express.Application;
   private port: number;
   private environment: ServerEnvironment;
   private container: Container;
-  private middlewares: Array<ExpressHandler> = [];
-  private globalPrefix: string | undefined;
+  private globalPrefix: string = "/";
+  private middlewares: Array<ExpressHandler | MiddlewareConfig | ExpressoMiddleware> = [];
+  private console: Console;
 
   protected configureServices(): void | Promise<void> {}
   protected postServerInitialization(): void | Promise<void> {}
@@ -97,6 +53,15 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
     process.exit(0);
   }
 
+  /**
+   * Configures the InversifyJS container.
+   * @param container - The InversifyJS container.
+   */
+  async configure(container: Container): Promise<void> {
+    this.container = container;
+    this.console = this.container.get(Console);
+  }
+
   /**
    * Configures the Express application with the provided middleware entries.
    * @param app - The Express application instance.
@@ -137,19 +102,16 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
    * @param middlewares - An array of Express middlewares to be applied.
    * @returns The configured Application instance.
    */
-  private async init(
-    container: Container,
-    middlewares: Array<express.RequestHandler> = [],
-  ): Promise<ApplicationExpress> {
+  private async init(): Promise<AppExpress> {
     await this.configureServices();
 
-    const middleware = container.get<IMiddleware>(Middleware);
+    const middleware = this.container.get(Middleware);
     const sortedMiddlewarePipeline = middleware.getMiddlewarePipeline();
     const pipeline = sortedMiddlewarePipeline.map((entry) => entry.middleware);
 
-    this.middlewares.push(...middlewares, ...(pipeline as Array<ExpressHandler>));
+    this.middlewares.push(...(pipeline as Array<ExpressHandler>));
 
-    const expressServer = new InversifyExpressServer(container, null, {
+    const expressServer = new InversifyExpressServer(this.container, null, {
       rootPath: this.globalPrefix as string,
     });
 
@@ -167,23 +129,6 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
     return this;
   }
 
-  /**
-   * Create and configure the Express application.
-   * @param container - The InversifyJS container.
-   * @param middlewares - An array of Express middlewares to be applied.
-   * @returns The configured Application instance.
-   */
-  public async create(
-    container: Container,
-    middlewares: Array<ExpressHandler> = [],
-  ): Promise<ApplicationExpress> {
-    this.container = container;
-    this.middlewares = middlewares;
-    this.globalPrefix = this.globalPrefix || "/";
-
-    return this;
-  }
-
   /**
    * Start listening on the given port and environment.
    * @param port - The port number to listen on.
@@ -195,17 +140,14 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
     environment: ServerEnvironment,
     consoleMessage?: IApplicationMessageToConsole,
   ): Promise<void> {
-    /* Initializes the application and executes the middleware pipeline */
-    await this.init(this.container, this.middlewares as Array<express.RequestHandler>);
+    await this.init();
 
-    /* Sets the port and environment */
     this.port = port;
     this.environment = environment;
     this.app.set("env", environment);
 
     this.app.listen(this.port, () => {
-      const console: Console = this.container.get<Console>(Console);
-      console.messageServer(this.port, this.environment, consoleMessage);
+      this.console.messageServer(this.port, this.environment, consoleMessage);
 
       (["SIGTERM", "SIGHUP", "SIGBREAK", "SIGQUIT", "SIGINT"] as Array<NodeJS.Signals>).forEach(
         (signal) => {
@@ -214,7 +156,7 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
       );
     });
 
-    await Promise.resolve(this.postServerInitialization());
+    await this.postServerInitialization();
   }
 
   /**
@@ -265,16 +207,6 @@ class ApplicationExpress extends ApplicationBase implements IApplicationExpress
       .error("isDevelopment() method must be called on `PostServerInitialization`", "application");
     return false;
   }
-
-  /**
-   * Verifies if the current environment is production.
-   *
-   * @returns A boolean value indicating whether the current environment is production or not.
-   *
-   */
-  public get ExpressApp(): express.Application {
-    return this.app;
-  }
 }
 
-export { ApplicationExpress as AppExpress, ServerEnvironment };
+export { AppExpress };