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

package/lib/cjs/adapter-express/render/engine.js

@@ -1,15 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Engine = void 0;
+exports.setEngineEjs = setEngineEjs;
+exports.setEngineHandlebars = setEngineHandlebars;
+exports.setEnginePug = setEnginePug;
+const core_1 = require("@expressots/core");
+const resolve_render_1 = require("./resolve-render");
+const constants_1 = require("./constants");
 /**
- * The supported view engines.
- * @enum {string}
- * @readonly
- * @public
+ * Set Ejs as the view engine
+ * @param {Application} app - The express application
+ * @param {EjsOptions} [options=EJS_DEFAULTS] - The ejs options
  */
-var Engine;
-(function (Engine) {
-    Engine["HBS"] = "hbs";
-    Engine["EJS"] = "ejs";
-    Engine["PUG"] = "pug";
-})(Engine || (exports.Engine = Engine = {}));
+async function setEngineEjs(app, options = constants_1.EJS_DEFAULTS) {
+    (0, resolve_render_1.packageResolver)("ejs");
+    app.set("view engine", options.viewEngine || constants_1.EJS_DEFAULTS.viewEngine);
+    app.set("views", options.viewsDir || constants_1.EJS_DEFAULTS.viewsDir);
+    if (Array.isArray(options.viewsDir)) {
+        options.viewsDir.forEach((dir) => {
+            app.set("views", dir);
+        });
+    }
+    if (options.serverOptions) {
+        app.locals = {
+            ...app.locals,
+            ...options.serverOptions,
+        };
+    }
+}
+/**
+ * Set Handlebars as the view engine
+ * @param {express.Application} app - The express application
+ * @param {HandlebarsOptions} [options=HANDLEBARS_DEFAULTS] - The handlebars options
+ */
+async function setEngineHandlebars(app, options = constants_1.HANDLEBARS_DEFAULTS) {
+    const logger = new core_1.Logger();
+    try {
+        const hbs = (0, resolve_render_1.packageResolver)("hbs");
+        hbs.registerPartials(options.partialsDir || constants_1.DEFAULT_PARTIALS_DIR);
+        app.set("view engine", options.viewEngine || constants_1.HANDLEBARS_DEFAULTS.viewEngine);
+        app.set("views", options.viewsDir || constants_1.HANDLEBARS_DEFAULTS.viewsDir);
+    }
+    catch (error) {
+        logger.error(error.message, "handlebars-config");
+    }
+}
+/**
+ * Set Pug as the view engine
+ * @param {express.Application} app - The express application
+ * @param {PugOptions} [options=PUG_DEFAULTS] - The pug options
+ */
+async function setEnginePug(app, options = constants_1.PUG_DEFAULTS) {
+    (0, resolve_render_1.packageResolver)("pug");
+    app.set("view engine", options.viewEngine || constants_1.PUG_DEFAULTS.viewEngine);
+    app.set("views", options.viewsDir || constants_1.PUG_DEFAULTS.viewsDir);
+}

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

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

package/lib/cjs/di/di.interfaces.js

@@ -0,0 +1,10 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-namespace */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FactoryType = void 0;
+var FactoryType;
+(function (FactoryType) {
+    FactoryType["DynamicValue"] = "toDynamicValue";
+    FactoryType["Factory"] = "toFactory";
+    FactoryType["Provider"] = "toProvider";
+})(FactoryType || (exports.FactoryType = FactoryType = {}));

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

@@ -19,6 +19,17 @@
  * @abstract
  */
 export declare abstract class ApplicationBase {
+    /**
+     * Implement this method to set up global configurations for the server.
+     * This method is called before any other server initialization methods.
+     * Use this method to configure global settings that apply to the entire
+     * server application. Supports asynchronous setup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    protected abstract globalConfiguration(): void | Promise<void>;
     /**
      * Implement this method to set up required services or configurations before
      * the server starts. This is essential for initializing dependencies or settings
@@ -26,6 +37,7 @@ export declare abstract class ApplicationBase {
      *
      * @abstract
      * @returns {void | Promise<void>}
+     * @public API
      */
     protected abstract configureServices(): void | Promise<void>;
     /**
@@ -35,6 +47,7 @@ export declare abstract class ApplicationBase {
      *
      * @abstract
      * @returns {void | Promise<void>}
+     * @public API
      */
     protected abstract postServerInitialization(): void | Promise<void>;
     /**
@@ -42,6 +55,10 @@ export declare abstract class ApplicationBase {
      * 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.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
      */
     protected abstract serverShutdown(): void | Promise<void>;
 }

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

@@ -1,9 +1,8 @@
-import { IApplicationMessageToConsole } from "@expressots/core";
 import express from "express";
-import { Container } from "inversify";
+import { AppContainer, IConsoleMessage, ProviderManager, IMiddleware } from "@expressots/core";
+import { RenderEngine, Env, Server } from "@expressots/shared";
+import { interfaces } from "../di/di.interfaces";
 import { ApplicationBase } from "./application-express.base";
-import { IWebServer, ServerEnvironment } from "./application-express.types";
-import { Engine, EngineOptions } from "./render/engine";
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
  * @class AppExpress
@@ -15,16 +14,20 @@ import { Engine, EngineOptions } from "./render/engine";
  * @method setEngine - Configures the application's view engine based on the provided configuration options.
  * @method isDevelopment - Verifies if the current environment is development.
  */
-declare class AppExpress extends ApplicationBase implements IWebServer {
+export declare class AppExpress extends ApplicationBase implements Server.IWebServer {
     private logger;
+    private console;
     private app;
     private port;
-    private environment;
-    private container;
+    private environment?;
+    private appContainer;
     private globalPrefix;
+    private middlewareManager;
     private middlewares;
-    private console;
+    private providerManager;
     private renderOptions;
+    constructor();
+    protected globalConfiguration(): void | Promise<void>;
     protected configureServices(): void | Promise<void>;
     protected postServerInitialization(): void | Promise<void>;
     protected serverShutdown(): void | Promise<void>;
@@ -33,10 +36,29 @@ declare class AppExpress extends ApplicationBase implements IWebServer {
      */
     private handleExit;
     /**
-     * Configures the InversifyJS container.
-     * @param container - The InversifyJS container.
+     * Initialize the InversifyJS container with the provided modules and options.
+     * @param appModules - An array of application modules to be loaded into the container.
+     * @param containerOptions - Container global configuration options.
+     * @option skipBaseClassChecks - Skip the base class checks for the container.
+     * @option autoBindInjectable - Automatically bind the injectable classes.
+     * @option defaultScope - The default scope to use for bindings.
+     *
+     * @returns The configured AppContainer instance.
+     * @public API
+     */
+    configContainer(appModules: Array<interfaces.ContainerModule>, containerOptions?: interfaces.ContainerOptions): AppContainer;
+    /**
+     * Get the ProviderManager instance.
+     * @returns The ProviderManager instance.
+     * @public API
+     */
+    get Provider(): ProviderManager;
+    /**
+     * Get the Middleware instance.
+     * @returns The Middleware instance.
+     * @public API
      */
-    configure(container: Container): Promise<void>;
+    get Middleware(): IMiddleware;
     /**
      * Configures the Express application with the provided middleware entries.
      * @param app - The Express application instance.
@@ -53,18 +75,15 @@ declare class AppExpress extends ApplicationBase implements IWebServer {
     /**
      * Start listening on the given port and environment.
      * @param port - The port number to listen on.
-     * @param environment - The server environment.
-     * @param consoleMessage - Optional message to display in the console.
+     * @param appInfo - Optional message to display the app name and version.
+     * @public API
      */
-    listen(port: number, environment: ServerEnvironment, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
+    listen(port: number | string, appInfo?: IConsoleMessage): Promise<void>;
     /**
      * Sets the global route prefix for the application.
-     *
-     * @public
      * @method setGlobalRoutePrefix
-     *
      * @param {string} prefix - The prefix to use for all routes.
-     *
+     * @public API
      */
     setGlobalRoutePrefix(prefix: string): void;
     /**
@@ -73,25 +92,41 @@ declare class AppExpress extends ApplicationBase implements IWebServer {
     private configEngine;
     /**
      * Configures the application's view engine based on the provided configuration options.
-     *
-     * @public
      * @method setEngine
      * @template T - A generic type extending from RenderTemplateOptions.
      *
      * @param {Engine} engine - The view engine to set
      * @param {EngineOptions} [options] - The configuration options for the view engine
+     * @public API
      */
-    setEngine<T extends EngineOptions>(engine: Engine, options?: T): Promise<void>;
+    setEngine<T extends RenderEngine.EngineOptions>(engine: RenderEngine.Engine, options?: T): Promise<void>;
     /**
      * Verifies if the current environment is development.
-     *
      * @returns A boolean value indicating whether the current environment is development or not.
+     * @public API
      */
     protected isDevelopment(): boolean;
+    /**
+     * Load environment variables from the specified file based on the environment configuration.
+     * @param environment - The environment to load configuration for.
+     * @param options - The options to use for loading the environment configuration.
+     * @option env - The environment configuration options.
+     * @example
+     * ```typescript
+     * {
+              env: {
+                  development: ".env.development",
+                  production: ".env.production"
+              }
+          }
+      * ```
+     * @public API
+     */
+    initEnvironment(environment: Env.Environment, options?: Env.IEnvironment): void;
     /**
      * Get the underlying HTTP server. (default: Express.js)
      * @returns The underlying HTTP server after initialization.
+     * @public API
      */
     getHttpServer(): Promise<express.Application>;
 }
-export { AppExpress };

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

@@ -1,21 +1,4 @@
-import express, { Request, Response, NextFunction } from "express";
-import { IApplicationMessageToConsole } from "@expressots/core";
-import { Container } from "inversify";
-import { Engine, EngineOptions } from "./render/engine";
-/**
- * Interface for the WebServer application implementation.
- */
-export interface IWebServer {
-    configure(container: Container): Promise<void>;
-    listen(port: number, environment: ServerEnvironment, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
-    setEngine<T extends EngineOptions>(engine: Engine, options?: T): Promise<void>;
-}
-/**
- * Constructor type for IWebServer.
- */
-export interface IWebServerConstructor<T extends IWebServer> {
-    new (): T;
-}
+import express from "express";
 /**
  * ExpressHandler Type
  *
@@ -38,26 +21,3 @@ export type MiddlewareConfig = {
     path?: string;
     middlewares: Array<ExpressHandler>;
 };
-/**
- * Expresso middleware interface.
- */
-interface IExpressoMiddleware {
-    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.
- *
- */
-export declare abstract class ExpressoMiddleware implements IExpressoMiddleware {
-    get name(): string;
-    abstract use(req: Request, res: Response, next: NextFunction): Promise<void> | void;
-}
-/**
- * Enum representing possible server environments.
- */
-export declare enum ServerEnvironment {
-    Development = "development",
-    Production = "production"
-}
-export {};

package/lib/cjs/types/adapter-express/express-utils/base-middleware.d.ts

@@ -1,5 +1,5 @@
 import type { NextFunction, Request, Response } from "express";
-import { interfaces as inversifyInterfaces } from "inversify";
+import { interfaces as inversifyInterfaces } from "../../di/di.interfaces";
 import type { HttpContext } from "./interfaces";
 export declare abstract class BaseMiddleware implements BaseMiddleware {
     httpContext: HttpContext;

package/lib/cjs/types/adapter-express/express-utils/constants.d.ts

@@ -40,5 +40,5 @@ export declare enum HTTP_VERBS_ENUM {
     trace = "TRACE"
 }
 export declare const DUPLICATED_CONTROLLER_NAME: (name: string) => string;
-export declare const NO_CONTROLLERS_FOUND: string;
+export declare const NO_CONTROLLERS_FOUND = "No controller found! Please ensure that you have register at least one Controller.";
 export declare const DEFAULT_ROUTING_ROOT_PATH = "/";

package/lib/cjs/types/adapter-express/express-utils/decorators.d.ts

@@ -2,67 +2,75 @@ import "reflect-metadata";
 import { PARAMETER_TYPE, HTTP_VERBS_ENUM } from "./constants";
 import type { HandlerDecorator, Middleware } from "./interfaces";
 import { Request } from "express";
-export declare const injectHttpContext: (target: import("inversify/lib/annotation/decorator_utils").DecoratorTarget<unknown>, targetKey?: string | symbol | undefined, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor<unknown>) => void;
+export declare const injectHttpContext: (target: import("@expressots/core/lib/cjs/types/di/annotation/decorator_utils").DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor<unknown>) => void;
 /**
  * Controller decorator to define a new controller
  * @param path route path
  * @param middleware array of middleware to be applied to all routes in the controller
+ * @public API
  */
 export declare function controller(path: string, ...middleware: Array<Middleware>): (target: NewableFunction) => void;
 /**
  * Http decorator to define the status code for a route
  * @param code
  * @returns MethodDecorator
- * @example
- * ```ts
+ * @example ```typescript
  * @Http(200)
  * @Get("/")
  * hello() {
  *  return "Hello World";
  * }
  * ```
+ * @public API
  */
 export declare function Http(code: number): (target: object, key: string | symbol, descriptor: TypedPropertyDescriptor<any>) => void;
 /**
  * Decorator to allow accept all HTTP methods
  * @param path route path, wildcard
  * @param middleware array of middleware to be applied to all routes defined in path logic
+ * @public API
  */
 export declare function All(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow GET HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Get(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow POST HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Post(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow PUT HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Put(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow PATCH HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Patch(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow HEAD HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Head(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Decorator to allow DELETE HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Delete(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
@@ -70,6 +78,7 @@ export declare function Delete(path: string, ...middleware: Array<Middleware>):
  * @param method custom HTTP method
  * @param path route path
  * @param middleware array of middleware to be applied to the route
+ * @public API
  */
 export declare function Method(method: keyof typeof HTTP_VERBS_ENUM, path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
@@ -120,13 +129,17 @@ export declare const principal: () => ParameterDecorator;
 /**
  * Parameter decorator to inject the request object
  * @returns ParameterDecorator
+ * @param type - The type of parameter to inject
+ * @param parameterName - The name of the parameter to inject
+ * @public API
  */
 export declare function params(type: PARAMETER_TYPE, parameterName?: string): ParameterDecorator;
 /**
  * Render decorator to define the template and default data for a route
  * @param template The template to render
  * @param defaultData The default data to pass to the template
- * @returns
+ * @returns MethodDecorator
+ * @public API
  */
 export declare function Render(template: string, defaultData?: Record<string, unknown>): MethodDecorator;
 export declare function getRenderMetadata(target: object, propertyKey: string | symbol): {
@@ -187,6 +200,7 @@ type FieldOptions = {
  * @param multerOptions
  * @default { none: true }
  * @returns MethodDecorator
+ * @public API
  */
 export declare function FileUpload(options?: FieldOptions | Array<FieldOptions> | {
     none?: boolean;

package/lib/cjs/types/adapter-express/express-utils/http-status-middleware.d.ts

@@ -6,6 +6,8 @@ import { ExpressoMiddleware } from "@expressots/core";
  * @returns express.RequestHandler
  */
 export declare class HttpStatusCodeMiddleware extends ExpressoMiddleware {
+    private globalPrefix;
+    constructor(globalPrefix?: string);
     use(req: Request, res: Response, next: NextFunction): void | Promise<void>;
     /**
      * Find the matching parameter path.

package/lib/cjs/types/adapter-express/express-utils/interfaces.d.ts

@@ -1,5 +1,5 @@
 import type { Application, NextFunction, Request, RequestHandler, Response } from "express";
-import { interfaces as inversifyInterfaces } from "inversify";
+import { interfaces as inversifyInterfaces } from "../../di/di.interfaces";
 import { HTTP_VERBS_ENUM, PARAMETER_TYPE } from "./constants";
 import { HttpResponseMessage } from "./httpResponseMessage";
 type Prototype<T> = {

package/lib/cjs/types/adapter-express/express-utils/inversify-express-server.d.ts

@@ -1,5 +1,5 @@
 import express, { Application, Router } from "express";
-import { interfaces } from "inversify";
+import { interfaces } from "../../di/di.interfaces";
 import type { AuthProvider, ConfigFunction, RoutingConfig } from "./interfaces";
 export declare class InversifyExpressServer {
     private _router;

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

@@ -1,4 +1,4 @@
-import { interfaces } from "inversify";
+import { interfaces } from "../../di/di.interfaces";
 import type { BaseController, ControllerMetadata, ControllerMethodMetadata, ControllerParameterMetadata, DecoratorTarget, IHttpActionResult } from "./interfaces";
 export declare function getControllersFromContainer(container: interfaces.Container, forceControllers: boolean): Array<BaseController>;
 export declare function getControllersFromMetadata(): Array<DecoratorTarget>;

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

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

package/lib/cjs/types/adapter-express/render/constants.d.ts

@@ -0,0 +1,26 @@
+import { RenderEngine } from "@expressots/shared";
+/**
+ * Ejs defaults
+ * @type {EjsOptions}
+ * @constant
+ * @default
+ */
+export declare const EJS_DEFAULTS: RenderEngine.EjsOptions;
+/**
+ * Handlebars defaults
+ * @type {HandlebarsOptions}
+ * @constant
+ * @default
+ */
+export declare const HANDLEBARS_DEFAULTS: RenderEngine.HandlebarsOptions;
+/**
+ * Default partials directory
+ */
+export declare const DEFAULT_PARTIALS_DIR: string;
+/**
+ * Pug defaults
+ * @type {PugOptions}
+ * @constant
+ * @default
+ */
+export declare const PUG_DEFAULTS: RenderEngine.PugOptions;

package/lib/cjs/types/adapter-express/render/engine.d.ts

@@ -1,28 +1,20 @@
-import { EjsOptions } from "./ejs/ejs.config";
-import { HandlebarsOptions } from "./handlebars/hbs.config";
+import { Application } from "express";
+import { RenderEngine } from "@expressots/shared";
 /**
- * The configuration options for the view engine.
- * @typedef {HandlebarsOptions | EjsOptions} EngineOptions
- * @private
+ * Set Ejs as the view engine
+ * @param {Application} app - The express application
+ * @param {EjsOptions} [options=EJS_DEFAULTS] - The ejs options
  */
-export type RenderOptions = {
-    engine: Engine;
-    options?: EngineOptions;
-};
+export declare function setEngineEjs(app: Application, options?: RenderEngine.EjsOptions): Promise<void>;
 /**
- * The supported view engines.
- * @enum {string}
- * @readonly
- * @public
+ * Set Handlebars as the view engine
+ * @param {express.Application} app - The express application
+ * @param {HandlebarsOptions} [options=HANDLEBARS_DEFAULTS] - The handlebars options
  */
-export declare enum Engine {
-    HBS = "hbs",
-    EJS = "ejs",
-    PUG = "pug"
-}
+export declare function setEngineHandlebars(app: Application, options?: RenderEngine.HandlebarsOptions): Promise<void>;
 /**
- * The configuration options for the view engine.
- * @typedef {HandlebarsOptions | EjsOptions} EngineOptions
- * @public
+ * Set Pug as the view engine
+ * @param {express.Application} app - The express application
+ * @param {PugOptions} [options=PUG_DEFAULTS] - The pug options
  */
-export type EngineOptions = HandlebarsOptions | EjsOptions;
+export declare function setEnginePug(app: Application, options?: RenderEngine.PugOptions): Promise<void>;

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

@@ -1,4 +1,4 @@
-export { EjsOptions as EJS } from "./ejs/ejs.config";
-export { HandlebarsOptions as HBS } from "./handlebars/hbs.config";
-export { PugOptions as PUG } from "./pug/pug.config";
-export { Engine } from "./engine";
+import { RenderEngine } from "@expressots/shared";
+export type EJS = RenderEngine.EjsOptions;
+export type HBS = RenderEngine.HandlebarsOptions;
+export type PUG = RenderEngine.PugOptions;