@expressots/adapter-express 3.0.0-beta.1 → 3.0.0-beta.2

package/lib/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [3.0.0-beta.2](https://github.com/expressots/adapter-express/compare/3.0.0-beta.1...3.0.0) (2024-11-24)
+
+### Features
+
+- add getHttpServer method and update listen method to return a promise ([82895c2](https://github.com/expressots/adapter-express/commit/82895c279c6103c7e96ee01810030d656142d509))
+- add unit tests for various utility functions and application lifecycle methods ([d3d91b0](https://github.com/expressots/adapter-express/commit/d3d91b05205460eac1399c991dd25b06d942d93d))
+- add unit tests IOC container addScoped, addSingleton, addTransient, get ([e3028fa](https://github.com/expressots/adapter-express/commit/e3028fa3bd7e0c57835dbd200f0621d3a9a27a1e))
+- implement Express Micro API adapter with route management and IoC container ([1720378](https://github.com/expressots/adapter-express/commit/1720378011603b1d0b8806e92f6b469067be577a))
+
+### Bug Fixes
+
+- exclude dependency injection files from coverage collection ([e8fdd90](https://github.com/expressots/adapter-express/commit/e8fdd908258b83f35d1121c1000b45039f6fd960))
+- update @expressots/core dependency version to use semantic versioning ([2130e4d](https://github.com/expressots/adapter-express/commit/2130e4d850c35ad35855c7def32fb86ddeffca64))
+
+### Code Refactoring
+
+- clean up whitespace and formatting in various test files ([5be0404](https://github.com/expressots/adapter-express/commit/5be0404cec12363d40a1181c7209527369422cf3))
+
 ## [3.0.0-beta.1](https://github.com/expressots/adapter-express/compare/1.8.2...3.0.0) (2024-11-18)
 
 ### Features

package/lib/cjs/adapter-express/index.js

@@ -18,6 +18,7 @@ exports.RenderEngine = exports.AppExpress = void 0;
 __exportStar(require("./express-utils"), exports);
 var application_express_1 = require("./application-express");
 Object.defineProperty(exports, "AppExpress", { enumerable: true, get: function () { return application_express_1.AppExpress; } });
+__exportStar(require("./micro-api"), exports);
 var shared_1 = require("@expressots/shared");
 Object.defineProperty(exports, "RenderEngine", { enumerable: true, get: function () { return shared_1.RenderEngine; } });
 __exportStar(require("./render"), exports);

package/lib/cjs/adapter-express/micro-api/application-express-micro-container.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IOC = void 0;
+const core_1 = require("@expressots/core");
+/**
+ * Inversion of Control Container
+ * @public API
+ */
+class IOC {
+    constructor(containerOptions) {
+        this.container = new core_1.Container(containerOptions);
+    }
+    /**
+     * Add a singleton to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addSingleton(concrete) {
+        this.container.bind(concrete).toSelf().inSingletonScope();
+    }
+    /**
+     * Add a transient to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addTransient(concrete) {
+        this.container.bind(concrete).toSelf().inTransientScope();
+    }
+    /**
+     * Add a scoped to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addScoped(concrete) {
+        this.container.bind(concrete).toSelf().inRequestScope();
+    }
+    /**
+     * Get an instance from the container
+     * @param identifier - The identifier for the instance
+     * @returns The resolved instance
+     * @public API
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    get(identifier) {
+        return this.container.get(identifier);
+    }
+}
+exports.IOC = IOC;

package/lib/cjs/adapter-express/micro-api/application-express-micro-route.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Route = void 0;
+const core_1 = require("@expressots/core");
+class Route {
+    constructor(app) {
+        this.logger = new core_1.Logger();
+        this.routes = [];
+        this.globalPrefix = "";
+        this.app = app;
+    }
+    /**
+     * Set the global route prefix
+     * @param prefix
+     * @public API
+     */
+    setGlobalRoutePrefix(prefix) {
+        this.globalPrefix = prefix;
+    }
+    /**
+     * Define a route
+     * @param method - HTTP method
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    define(method, path, handler, ...middleware) {
+        const normalizedPath = `${this.globalPrefix.replace(/\/$/, "")}/${path.replace(/^\//, "")}`;
+        this.routes.push({ method, path: normalizedPath, handler, middleware });
+        this.logger.info(`Route ${method.toUpperCase()} '${normalizedPath}' added.`, "Route");
+    }
+    /**
+     * Define a GET route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    get(path, handler, ...middleware) {
+        this.define("get", path, handler, ...middleware);
+    }
+    /**
+     * Define a POST route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    post(path, handler, ...middleware) {
+        this.define("post", path, handler, ...middleware);
+    }
+    /**
+     * Define a PUT route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    put(path, handler, ...middleware) {
+        this.define("put", path, handler, ...middleware);
+    }
+    /**
+     * Define a DELETE route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    delete(path, handler, ...middleware) {
+        this.define("delete", path, handler, ...middleware);
+    }
+    /**
+     * Define a PATCH route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    patch(path, handler, ...middleware) {
+        this.define("patch", path, handler, ...middleware);
+    }
+    /**
+     * Apply the routes to the Express application
+     */
+    applyRoutes() {
+        this.routes.forEach(({ method, path, handler, middleware }) => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this.app[method](path, ...middleware, handler);
+        });
+    }
+    /**
+     * Get the routes
+     * @returns Array of route definitions
+     * @public API
+     */
+    get Routes() {
+        return this.routes;
+    }
+}
+exports.Route = Route;

package/lib/cjs/adapter-express/micro-api/application-express-micro.js

@@ -0,0 +1,177 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMicroAPI = createMicroAPI;
+const core_1 = require("@expressots/core");
+const shared_1 = require("@expressots/shared");
+const express_1 = __importDefault(require("express"));
+const fs_1 = __importDefault(require("fs"));
+const application_express_micro_container_1 = require("./application-express-micro-container");
+const application_express_micro_route_1 = require("./application-express-micro-route");
+class AppExpressMicro {
+    constructor() {
+        this.logger = new core_1.Logger();
+        this.globalPrefix = "/";
+    }
+    /**
+     * Handle the exit of the server
+     * @private
+     */
+    handleExit() {
+        this.logger.info("Server shutting down.", "MicroAPI");
+        process.exit(0);
+    }
+    /**
+     * Configure the middleware for the application
+     * @private
+     */
+    configureMiddleware() {
+        const sortedMiddlewarePipeline = this.middlewareManager.getMiddlewarePipeline();
+        const pipeline = sortedMiddlewarePipeline.map((entry) => entry.middleware);
+        for (const entry of pipeline) {
+            if (typeof entry === "function") {
+                this.app.use(entry);
+            }
+            else if (entry.middlewares) {
+                const { path, middlewares } = entry;
+                for (const mid of middlewares) {
+                    if (path) {
+                        this.app.use(path, mid);
+                    }
+                    else {
+                        this.app.use(mid);
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Set the global route prefix
+     * @param prefix - The global route prefix
+     * @public API
+     */
+    setGlobalRoutePrefix(prefix) {
+        this.globalPrefix = prefix;
+    }
+    /**
+     * Initialize the environment for the application
+     * @param environment - The environment to initialize
+     * @param options - Options for the environment initialization
+     * @public API
+     */
+    initEnvironment(environment, options) {
+        this.environment = environment;
+        if (options === undefined) {
+            (0, shared_1.config)({ path: ".env" });
+        }
+        else {
+            if (!options.env[environment]) {
+                this.logger.error(`Environment configuration for [${environment}] does not exist.`, "adapter-express");
+                process.exit(1);
+            }
+            else {
+                const envFileName = options.env[environment];
+                if (!fs_1.default.existsSync(envFileName)) {
+                    this.logger.error(`Environment file [${envFileName}] does not exist.`, "adapter-express");
+                    process.exit(1);
+                }
+                else {
+                    (0, shared_1.config)({ path: envFileName });
+                }
+            }
+        }
+    }
+    /**
+     * Get the Middleware instance
+     * @returns IMiddleware
+     * @public API
+     */
+    get Middleware() {
+        return this.middlewareManager;
+    }
+    /**
+     * Get the Route instance
+     * @returns IRoute
+     * @public API
+     */
+    get Route() {
+        return this.routeManager;
+    }
+    /**
+     * Get the Container instance
+     * @returns IIOC
+     * @public API
+     */
+    get Container() {
+        return this.container;
+    }
+    /**
+     * Get the Express HTTP Server instance
+     * @returns express.Application
+     * @public API
+     */
+    getHttpServer() {
+        return this.app;
+    }
+    /**
+     * Create a new instance of the Express Micro API adapter
+     * @param config - Configuration options
+     * @returns ICreateMicroAPI
+     * @public API
+     */
+    create(config) {
+        this.app = (0, express_1.default)();
+        this.routeManager = new application_express_micro_route_1.Route(this.app);
+        this.container = new application_express_micro_container_1.IOC(config?.containerOptions);
+        this.middlewareManager = new core_1.Middleware();
+        this.environment = "development";
+        return this;
+    }
+    /**
+     * Build the Web Server Micro API
+     * @returns IWebServerMicroAPI
+     * @public API
+     */
+    build() {
+        this.routeManager.setGlobalRoutePrefix(this.globalPrefix);
+        return this;
+    }
+    /**
+     * Listen for incoming requests
+     * @param port - The port to listen on
+     * @param appInfo - Information about the application
+     * @public API
+     */
+    async listen(port, appInfo) {
+        const logger = new core_1.Logger();
+        this.port = typeof port === "string" ? parseInt(port, 10) : port || 3000;
+        this.configureMiddleware();
+        this.routeManager.applyRoutes();
+        if (this.Middleware.getErrorHandler()) {
+            this.app.use(this.Middleware.getErrorHandler());
+        }
+        return new Promise((resolve) => {
+            this.app.listen(this.port, () => {
+                const appInfoNormalized = appInfo ? `${appInfo?.appName} - ${appInfo?.appVersion} ` : "";
+                logger.info(`${appInfoNormalized}[${this.port}:${this.environment}]`, "MicroAPI");
+                ["SIGTERM", "SIGHUP", "SIGBREAK", "SIGQUIT", "SIGINT"].forEach((signal) => {
+                    process.on(signal, this.handleExit.bind(this));
+                });
+                resolve();
+            });
+        });
+    }
+}
+/**
+ * Create a new instance of the Express Micro API adapter
+ * @param config - Configuration options
+ * @returns ICreateMicroAPI
+ * @public API
+ */
+function createMicroAPI(config) {
+    const microAPI = new AppExpressMicro();
+    const create = microAPI.create.bind(microAPI);
+    return create(config);
+}

package/lib/cjs/adapter-express/micro-api/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMicroAPI = void 0;
+var application_express_micro_1 = require("./application-express-micro");
+Object.defineProperty(exports, "createMicroAPI", { enumerable: true, get: function () { return application_express_micro_1.createMicroAPI; } });

package/lib/cjs/types/adapter-express/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./express-utils";
 export { AppExpress } from "./application-express";
+export * from "./micro-api";
 export { IWebServerPublic, IWebServer, IWebServerConstructor, Environment, IEnvironment, RenderEngine, } from "@expressots/shared";
 export * from "./render";

package/lib/cjs/types/adapter-express/micro-api/application-express-micro-container.d.ts

@@ -0,0 +1,47 @@
+import { interfaces } from "@expressots/core";
+/**
+ * Inversion of Control Container interface
+ * @public API
+ */
+export interface IIOC {
+    addSingleton<T>(concrete: interfaces.Newable<T>): void;
+    addTransient<T>(concrete: interfaces.Newable<T>): void;
+    addScoped<T>(concrete: interfaces.Newable<T>): void;
+    get<I>(identifier: interfaces.ServiceIdentifier<I>): I;
+}
+/**
+ * Inversion of Control Container
+ * @public API
+ */
+export declare class IOC {
+    private container;
+    constructor(containerOptions?: interfaces.ContainerOptions);
+    /**
+     * Add a singleton to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addSingleton<T>(concrete: interfaces.Newable<T>): void;
+    /**
+     * Add a transient to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addTransient<T>(concrete: interfaces.Newable<T>): void;
+    /**
+     * Add a scoped to the container
+     * @param identifierOrConcrete - The identifier or concrete class
+     * @param concrete - The concrete class if identifier is provided
+     * @public API
+     */
+    addScoped<T>(concrete: interfaces.Newable<T>): void;
+    /**
+     * Get an instance from the container
+     * @param identifier - The identifier for the instance
+     * @returns The resolved instance
+     * @public API
+     */
+    get(identifier: interfaces.ServiceIdentifier): any;
+}

package/lib/cjs/types/adapter-express/micro-api/application-express-micro-route.d.ts

@@ -0,0 +1,93 @@
+import express from "express";
+import { Middleware } from "../express-utils/interfaces";
+type RouteDefinition = {
+    method: "get" | "post" | "put" | "patch" | "delete";
+    path: string;
+    handler: express.RequestHandler;
+    middleware: Array<Middleware>;
+};
+/**
+ * Route manager for Express Micro API adapter
+ * @public API
+ */
+export interface IRoute {
+    define(method: "get" | "post" | "put" | "delete" | "patch", path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    get(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    post(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    put(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    delete(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    patch(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+}
+export declare class Route implements IRoute {
+    private logger;
+    private routes;
+    private app;
+    private globalPrefix;
+    constructor(app: express.Application);
+    /**
+     * Set the global route prefix
+     * @param prefix
+     * @public API
+     */
+    setGlobalRoutePrefix(prefix: string): void;
+    /**
+     * Define a route
+     * @param method - HTTP method
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    define(method: "get" | "post" | "put" | "delete" | "patch", path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Define a GET route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    get(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Define a POST route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    post(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Define a PUT route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    put(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Define a DELETE route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    delete(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Define a PATCH route
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route middleware
+     * @public API
+     */
+    patch(path: string, handler: express.RequestHandler, ...middleware: Array<Middleware>): void;
+    /**
+     * Apply the routes to the Express application
+     */
+    applyRoutes(): void;
+    /**
+     * Get the routes
+     * @returns Array of route definitions
+     * @public API
+     */
+    get Routes(): Array<RouteDefinition>;
+}
+export {};

package/lib/cjs/types/adapter-express/micro-api/application-express-micro.d.ts

@@ -0,0 +1,79 @@
+import { IMiddleware, interfaces } from "@expressots/core";
+import { Env, IConsoleMessage } from "@expressots/shared";
+import express from "express";
+import { IIOC } from "./application-express-micro-container";
+import { IRoute } from "./application-express-micro-route";
+/**
+ * Configuration options for the Express Micro API adapter
+ * @public API
+ */
+export type MicroAPIConfig = {
+    containerOptions: interfaces.ContainerOptions;
+};
+/**
+ * Interface for the Create Method of Express Micro API adapter
+ */
+export interface ICreateMicroAPI {
+    /**
+     * Initialize the environment for the application
+     * @param environment - The environment to initialize
+     * @param options - Options for the environment initialization
+     * @public API
+     */
+    initEnvironment(environment: Env.Environment, options?: Env.IEnvironment): void;
+    /**
+     * Set the global route prefix
+     * @param prefix - The global route prefix
+     * @public API
+     */
+    setGlobalRoutePrefix(prefix: string): void;
+    /**
+     * Get the Container instance
+     * @returns IIOC - The container instance interface
+     * @public API
+     */
+    get Container(): IIOC;
+    /**
+     * Get the Express HTTP Server instance
+     * @returns express.Application
+     * @public API
+     */
+    getHttpServer(): express.Application;
+    /**
+     * Build the Web Server Micro API
+     * @returns IWebServerMicroAPI
+     * @public API
+     */
+    build(): IWebServerMicroAPI;
+}
+/**
+ * Interface for the Build Method of the Web Server Micro API adapter
+ */
+export interface IWebServerMicroAPI {
+    /**
+     * Get the Middleware instance
+     * @returns IMiddleware
+     * @public API
+     */
+    get Middleware(): IMiddleware;
+    /**
+     * Get the Route instance
+     * @returns IRoute
+     * @public API
+     */
+    get Route(): IRoute;
+    /**
+     * Listen for incoming requests
+     * @param port - The port to listen on
+     * @param appInfo - Information about the application
+     * @public API
+     */
+    listen(port: number | string, appInfo?: IConsoleMessage): Promise<void>;
+}
+/**
+ * Create a new instance of the Express Micro API adapter
+ * @param config - Configuration options
+ * @returns ICreateMicroAPI
+ * @public API
+ */
+export declare function createMicroAPI(config?: MicroAPIConfig): ICreateMicroAPI;

package/lib/cjs/types/adapter-express/micro-api/index.d.ts

@@ -0,0 +1 @@
+export { createMicroAPI, MicroAPIConfig } from "./application-express-micro";

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.2",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -70,7 +70,7 @@
     "@codecov/vite-plugin": "^0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "3.0.0-beta.1",
+    "@expressots/core": "^3.0.0-beta.1",
     "@expressots/shared": "0.2.0",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.2",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -70,7 +70,7 @@
     "@codecov/vite-plugin": "^0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "3.0.0-beta.1",
+    "@expressots/core": "^3.0.0-beta.1",
     "@expressots/shared": "0.2.0",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",