@expressots/core 2.9.1 → 2.11.0

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

@@ -1,368 +1,368 @@
-/// <reference types="node" />
-import express, { Request, Response, NextFunction } from "express";
-import { OptionsJson } from "./interfaces/body-parser.interface";
-import { CompressionOptions } from "./interfaces/compression.interface";
-import { CorsOptions } from "./interfaces/cors.interface";
-import { CookieParserOptions } from "./interfaces/cookie-parser.interface";
-import { ServeStaticOptions } from "./interfaces/serve-static.interface";
-import { CookieSessionOptions } from "./interfaces/cookie-session/cookie-session.interface";
-import { ServeFaviconOptions } from "./interfaces/serve-favicon.interface";
-import { FormatFn, OptionsMorgan } from "./interfaces/morgan.interface";
-import { RateLimitOptions } from "./interfaces/express-rate-limit.interface";
-import { OptionsHelmet } from "./interfaces/helmet.interface";
-import { multer } from "./interfaces/multer.interface";
-import { SessionOptions } from "./interfaces/express-session.interface";
-/**
- * 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.
- */
-export type ExpressHandler = express.ErrorRequestHandler | express.RequestParamHandler | express.RequestHandler | undefined;
-/**
- * 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;
-}
-/**
- * MiddlewareOptions Type
- *
- * The MiddlewareOptions type represents arguments that can be passed to a middleware function.
- * It can either be a expressjs request handler function, a middleware configuration object that is composed by a route and an expressjs handler or
- */
-export type MiddlewareOptions = ExpressHandler | MiddlewareConfig | IExpressoMiddleware;
-/**
- * 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 | IExpressoMiddleware>;
-};
-/**
- * MiddlewarePipeline Interface
- *
- * The MiddlewarePipeline interface represents the metadata and actual middleware to be executed in a middleware pipeline.
- * - timestamp: The date and time at which the middleware was added to the pipeline.
- * - middleware: Can be either an ExpressHandler function or a MiddlewareConfig object defining a more complex middleware setup.
- */
-interface MiddlewarePipeline {
-    timestamp: Date;
-    middleware: ExpressHandler | MiddlewareConfig | IExpressoMiddleware;
-}
-/**
- * Interface for configuring and managing middlewares in the application.
- * Provides methods to be added automatically in the application without the need to import packages.
- */
-interface IMiddleware {
-    /**
-     * Adds a Rate Limit middleware to the middleware collection.
-     * The rate limiter is responsible for adding dynamic rate limit and request throttling to the application.
-     *
-     * @param options - Optional configuration options for the rate limiter.
-     */
-    addRateLimiter(options?: RateLimitOptions): void;
-    /**
-     * Adds a Body Parser middleware to the middleware collection.
-     * The body parser is responsible for parsing the incoming request bodies in a middleware.
-     *
-     * @param options - Optional configuration options for the JSON body parser.
-     */
-    addBodyParser(options?: OptionsJson): void;
-    /**
-     * Adds Cross-Origin Resource Sharing (CORS) middleware to enable or control cross-origin requests.
-     *
-     * @param options - Optional configuration options for CORS. Defines the behavior of CORS requests like allowed origins, methods, headers, etc.
-     */
-    addCors(options?: CorsOptions): void;
-    /**
-     * Adds Compression middleware to reduce the size of the response body and improve the speed of the client-server communication.
-     *
-     * @param options - Optional configuration options for Compression. Allows fine-tuning the compression behavior, such as setting the compression level, threshold, and filter functions to determine which requests should be compressed.
-     */
-    addCompression(options?: CompressionOptions): void;
-    /**
-     * Adds Cookie Parser middleware to parse the cookie header and populate req.cookies with an object keyed by the cookie names.
-     *
-     * @param secret - A string or array used for signing cookies. This is optional and if not specified, the cookie-parser will not parse signed cookies.
-     * @param options - Optional configuration options for Cookie Parser.
-     */
-    addCookieParser(secret?: string | Array<string> | undefined, options?: CookieParserOptions): void;
-    /**
-     * Adds Cookie Session middleware to enable cookie-based sessions.
-     *
-     * @param options - Optional configuration options for Cookie Session. Defines the behavior of cookie sessions like the name of the cookie, keys to sign the cookie, etc.
-     */
-    addCookieSession(options: CookieSessionOptions): void;
-    /**
-     * Adds Morgan middleware to log HTTP requests.
-     *
-     * @param format - The log format. Can be a string or a function.
-     * @param options - Optional configuration options for Morgan. Defines the behavior of the logger like the output stream, buffer duration, etc.
-     */
-    addMorgan(format: string | FormatFn, options?: OptionsMorgan): void;
-    /**
-     * Adds a middleware to serve the favicon to the middleware collection.
-     * The favicon is the icon that is displayed in the browser tab for the application.
-     *
-     * @param path - The path to the favicon file.
-     * @param options - Optional configuration options for serving the favicon. Defines the behavior of the favicon middleware like cache control, custom headers, etc.
-     */
-    addServeFavicon(path: string | Buffer, options?: ServeFaviconOptions): void;
-    /**
-     * Add a middleware to enable express-session.
-     *
-     * @param options - Optional configuration options for Session.
-     *
-     */
-    addSession(options: SessionOptions): void;
-    /**
-     * Configures the error handling middleware for the application.
-     *
-     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
-     */
-    setErrorHandler(errorHandling?: ExpressHandler): void;
-    /**
-     * Adds a middleware to serve static files from the specified root directory.
-     * Allows the application to serve files like images, CSS, JavaScript, etc.
-     *
-     * @param root - The root directory from which the static assets are to be served.
-     * @param options - Optional configuration options for serving static files. Defines behavior like cache control, custom headers, etc.
-     */
-    serveStatic(root: string, options?: ServeStaticOptions): void;
-    /**
-     * Adds a middleware to the middleware collection.
-     *
-     * @param options - The Express request handler function to be added to the middleware collection, or a middleware configuration object
-     * that is composed by a route and an expressjs handler, or a custom Expresso middleware.
-     *
-     * @example Express Handler
-     *  const middleware = (req, res, next) => {
-     *  // Your middleware logic here
-     *  next();
-     * }
-     *
-     * @example Middleware Configuration Object
-     * const middleware = {
-     *  path: "/",
-     *  middlewares: [] // Array of Express Handlers
-     * }
-     *
-     * @example Expresso Middleware
-     * class CustomMiddleware implements IExpressoMiddleware {
-     *  use(req: Request, res: Response, next: NextFunction): Promise<void> | void {
-     *   // Your middleware logic here
-     *   next();
-     *  }
-     * }
-     */
-    addMiddleware(options: MiddlewareOptions): void;
-    /**
-     * View middleware pipeline formatted.
-     * @returns void
-     */
-    viewMiddlewarePipeline(): void;
-    /**
-     * Gets the configured error handler middleware.
-     *
-     * @returns The error handler middleware.
-     */
-    getErrorHandler(): ExpressHandler;
-    /**
-     * Adds Helmet middleware to enhance security by setting various HTTP headers.
-     *
-     * @param options - Optional configuration options for Helmet.
-     * @returns The configuration options for Helmet middleware.
-     */
-    addHelmet(options?: OptionsHelmet): void;
-    /**
-     * Adds Multer middleware for handling multipart/form-data, typically used for file uploads.
-     *
-     * @param options - Optional configuration options for Multer.
-     */
-    setupMulter(options?: multer.Options): multer.Multer;
-}
-/**
- * Singleton class that implements the IConfigure interface.
- * Manages the middleware configuration for the application,
- * including adding Body Parser and retrieving all configured middlewares.
- *
- * @see IConfigure
- */
-declare class Middleware implements IMiddleware {
-    private middlewarePipeline;
-    private errorHandler;
-    private logger;
-    /**
-     * Retrieves the type of the middleware.
-     *
-     * @param middleware - The middleware to be checked.
-     *
-     * @returns The type of the middleware.
-     */
-    private getMiddlewareType;
-    /**
-     * Checks if a middleware with the given name exists in the middleware collection.
-     *
-     * @param middlewareName - The name of the middleware to be checked.
-     *
-     * @returns A boolean value indicating whether the middleware exists or not.
-     */
-    private middlewareExists;
-    addRateLimiter(options?: RateLimitOptions): void;
-    /**
-     * Adds a Body Parser middleware to the middleware collection using the given options.
-     *
-     * @param options - Optional configuration options for the JSON body parser.
-     */
-    addBodyParser(options?: OptionsJson): void;
-    /**
-     * Adds Cross-Origin Resource Sharing (CORS) middleware to enable or control cross-origin requests.
-     *
-     * @param options - Optional configuration options for CORS. Defines the behavior of CORS requests like allowed origins, methods, headers, etc.
-     */
-    addCors(options?: CorsOptions): void;
-    /**
-     * Adds Compression middleware to reduce the size of the response body and improve the speed of the client-server communication.
-     *
-     * @param options - Optional configuration options for Compression. Allows fine-tuning the compression behavior, such as setting the compression level, threshold, and filter functions to determine which requests should be compressed.
-     */
-    addCompression(options?: CompressionOptions): void;
-    /**
-     * Adds Morgan middleware to log HTTP requests.
-     *
-     * @param format - The log format. Can be a string or a function.
-     * @param options - Optional configuration options for Morgan. Defines the behavior of the logger like the output stream, buffer duration, etc.
-     */
-    addMorgan(format: string | FormatFn, options?: OptionsMorgan | undefined): void;
-    /**
-     * Adds Cookie Parser middleware to parse the cookie header and populate req.cookies with an object keyed by the cookie names.
-     *
-     * @param secret - A string or array used for signing cookies. This is optional and if not specified, the cookie-parser will not parse signed cookies.
-     * @param options - Optional configuration options for Cookie Parser.
-     */
-    addCookieParser(secret?: string | Array<string> | undefined, options?: CookieParserOptions | undefined): void;
-    /**
-     * Adds Cookie Session middleware to enable cookie-based sessions.
-     *
-     * @param options - Optional configuration options for Cookie Session. Defines the behavior of cookie sessions like the name of the cookie, keys to sign the cookie, etc.
-     */
-    addCookieSession(options: CookieSessionOptions): void;
-    /**
-     * Adds a middleware to serve the favicon to the middleware collection.
-     * The favicon is the icon that is displayed in the browser tab for the application.
-     *
-     * @param path - The path to the favicon file.
-     * @param options - Optional configuration options for serving the favicon. Defines the behavior of the favicon middleware like cache control, custom headers, etc.
-     */
-    addServeFavicon(path: string | Buffer, options?: ServeFaviconOptions): void;
-    setupMulter(options?: multer.Options): multer.Multer;
-    /**
-     * Adds a middleware to enhance security by setting various HTTP headers.
-     *
-     * @param options - Optional configuration options for Helmet.
-     *
-     */
-    addHelmet(options?: OptionsHelmet): void;
-    /**
-     * Add a middleware to enable express-session.
-     *
-     * @param options - Optional configuration options for Session.
-     *
-     */
-    addSession(options: SessionOptions): void;
-    /**
-     * Configures the error handling middleware for the application.
-     *
-     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
-     */
-    setErrorHandler(errorHandling?: ExpressHandler): void;
-    /**
-     * Adds a middleware to serve static files from the specified root directory.
-     * Allows the application to serve files like images, CSS, JavaScript, etc.
-     *
-     * @param root - The root directory from which the static assets are to be served.
-     * @param options - Optional configuration options for serving static files. Defines behavior like cache control, custom headers, etc.
-     */
-    serveStatic(root: string, options?: ServeStaticOptions): void;
-    /**
-     * Helper method to add middleware configuration objects to the middleware collection.
-     * @param middleware - The middleware configuration object to be added to the middleware collection.
-     * @returns void
-     */
-    private addConfigMiddleware;
-    /**
-     * Helper method to add express request handler functions to the middleware collection.
-     * @param middleware - The express request handler function to be added to the middleware collection.
-     * @returns void
-     */
-    private addExpressHandlerMiddleware;
-    /**
-     * Helper method to add custom Expresso middleware to the middleware collection.
-     * @param middleware - The custom Expresso middleware to be added to the middleware collection.
-     * @returns void
-     */
-    private addIExpressoMiddleware;
-    /**
-     * Adds a middleware to the middleware collection.
-     *
-     * @param options - The Express request handler function to be added to the middleware collection, or a middleware configuration object
-     * that is composed by a route and an expressjs handler, or a custom Expresso middleware.
-     *
-     * @example Express Handler
-     *  const middleware = (req, res, next) => {
-     *    // Your middleware logic here
-     *    next();
-     *  }
-     *
-     * @example Middleware Configuration Object
-     *  const middleware = {
-     *    path: "/",
-     *    middlewares: [] // Array of Express Handlers
-     *  }
-     *
-     * @example Expresso Middleware
-     *  class CustomMiddleware implements IExpressoMiddleware {
-     *    use(req: Request, res: Response, next: NextFunction): Promise<void> | void {
-     *    // Your middleware logic here
-     *      next();
-     *    }
-     *  }
-     */
-    addMiddleware(options: MiddlewareOptions): void;
-    /**
-     * Retrieves middleware pipeline in the order they were added.
-     *
-     * @returns An array of Express request handlers representing the middlewares.
-     */
-    getMiddlewarePipeline(): Array<MiddlewarePipeline>;
-    /**
-     * View middleware pipeline formatted.
-     * @returns void
-     */
-    viewMiddlewarePipeline(): void;
-    /**
-     * Gets the configured error handler middleware.
-     *
-     * @returns The error handler middleware.
-     */
-    getErrorHandler(): ExpressHandler;
-}
-export { Middleware, IMiddleware };
+/// <reference types="node" />
+import express, { Request, Response, NextFunction } from "express";
+import { OptionsJson } from "./interfaces/body-parser.interface";
+import { CompressionOptions } from "./interfaces/compression.interface";
+import { CorsOptions } from "./interfaces/cors.interface";
+import { CookieParserOptions } from "./interfaces/cookie-parser.interface";
+import { ServeStaticOptions } from "./interfaces/serve-static.interface";
+import { CookieSessionOptions } from "./interfaces/cookie-session/cookie-session.interface";
+import { ServeFaviconOptions } from "./interfaces/serve-favicon.interface";
+import { FormatFn, OptionsMorgan } from "./interfaces/morgan.interface";
+import { RateLimitOptions } from "./interfaces/express-rate-limit.interface";
+import { OptionsHelmet } from "./interfaces/helmet.interface";
+import { multer } from "./interfaces/multer.interface";
+import { SessionOptions } from "./interfaces/express-session.interface";
+/**
+ * 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.
+ */
+export type ExpressHandler = express.ErrorRequestHandler | express.RequestParamHandler | express.RequestHandler | undefined;
+/**
+ * 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;
+}
+/**
+ * MiddlewareOptions Type
+ *
+ * The MiddlewareOptions type represents arguments that can be passed to a middleware function.
+ * It can either be a expressjs request handler function, a middleware configuration object that is composed by a route and an expressjs handler or
+ */
+export type MiddlewareOptions = ExpressHandler | MiddlewareConfig | IExpressoMiddleware;
+/**
+ * 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 | IExpressoMiddleware>;
+};
+/**
+ * MiddlewarePipeline Interface
+ *
+ * The MiddlewarePipeline interface represents the metadata and actual middleware to be executed in a middleware pipeline.
+ * - timestamp: The date and time at which the middleware was added to the pipeline.
+ * - middleware: Can be either an ExpressHandler function or a MiddlewareConfig object defining a more complex middleware setup.
+ */
+interface MiddlewarePipeline {
+    timestamp: Date;
+    middleware: ExpressHandler | MiddlewareConfig | IExpressoMiddleware;
+}
+/**
+ * Interface for configuring and managing middlewares in the application.
+ * Provides methods to be added automatically in the application without the need to import packages.
+ */
+interface IMiddleware {
+    /**
+     * Adds a Rate Limit middleware to the middleware collection.
+     * The rate limiter is responsible for adding dynamic rate limit and request throttling to the application.
+     *
+     * @param options - Optional configuration options for the rate limiter.
+     */
+    addRateLimiter(options?: RateLimitOptions): void;
+    /**
+     * Adds a Body Parser middleware to the middleware collection.
+     * The body parser is responsible for parsing the incoming request bodies in a middleware.
+     *
+     * @param options - Optional configuration options for the JSON body parser.
+     */
+    addBodyParser(options?: OptionsJson): void;
+    /**
+     * Adds Cross-Origin Resource Sharing (CORS) middleware to enable or control cross-origin requests.
+     *
+     * @param options - Optional configuration options for CORS. Defines the behavior of CORS requests like allowed origins, methods, headers, etc.
+     */
+    addCors(options?: CorsOptions): void;
+    /**
+     * Adds Compression middleware to reduce the size of the response body and improve the speed of the client-server communication.
+     *
+     * @param options - Optional configuration options for Compression. Allows fine-tuning the compression behavior, such as setting the compression level, threshold, and filter functions to determine which requests should be compressed.
+     */
+    addCompression(options?: CompressionOptions): void;
+    /**
+     * Adds Cookie Parser middleware to parse the cookie header and populate req.cookies with an object keyed by the cookie names.
+     *
+     * @param secret - A string or array used for signing cookies. This is optional and if not specified, the cookie-parser will not parse signed cookies.
+     * @param options - Optional configuration options for Cookie Parser.
+     */
+    addCookieParser(secret?: string | Array<string> | undefined, options?: CookieParserOptions): void;
+    /**
+     * Adds Cookie Session middleware to enable cookie-based sessions.
+     *
+     * @param options - Optional configuration options for Cookie Session. Defines the behavior of cookie sessions like the name of the cookie, keys to sign the cookie, etc.
+     */
+    addCookieSession(options: CookieSessionOptions): void;
+    /**
+     * Adds Morgan middleware to log HTTP requests.
+     *
+     * @param format - The log format. Can be a string or a function.
+     * @param options - Optional configuration options for Morgan. Defines the behavior of the logger like the output stream, buffer duration, etc.
+     */
+    addMorgan(format: string | FormatFn, options?: OptionsMorgan): void;
+    /**
+     * Adds a middleware to serve the favicon to the middleware collection.
+     * The favicon is the icon that is displayed in the browser tab for the application.
+     *
+     * @param path - The path to the favicon file.
+     * @param options - Optional configuration options for serving the favicon. Defines the behavior of the favicon middleware like cache control, custom headers, etc.
+     */
+    addServeFavicon(path: string | Buffer, options?: ServeFaviconOptions): void;
+    /**
+     * Add a middleware to enable express-session.
+     *
+     * @param options - Optional configuration options for Session.
+     *
+     */
+    addSession(options: SessionOptions): void;
+    /**
+     * Configures the error handling middleware for the application.
+     *
+     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
+     */
+    setErrorHandler(errorHandling?: ExpressHandler): void;
+    /**
+     * Adds a middleware to serve static files from the specified root directory.
+     * Allows the application to serve files like images, CSS, JavaScript, etc.
+     *
+     * @param root - The root directory from which the static assets are to be served.
+     * @param options - Optional configuration options for serving static files. Defines behavior like cache control, custom headers, etc.
+     */
+    serveStatic(root: string, options?: ServeStaticOptions): void;
+    /**
+     * Adds a middleware to the middleware collection.
+     *
+     * @param options - The Express request handler function to be added to the middleware collection, or a middleware configuration object
+     * that is composed by a route and an expressjs handler, or a custom Expresso middleware.
+     *
+     * @example Express Handler
+     *  const middleware = (req, res, next) => {
+     *  // Your middleware logic here
+     *  next();
+     * }
+     *
+     * @example Middleware Configuration Object
+     * const middleware = {
+     *  path: "/",
+     *  middlewares: [] // Array of Express Handlers
+     * }
+     *
+     * @example Expresso Middleware
+     * class CustomMiddleware implements IExpressoMiddleware {
+     *  use(req: Request, res: Response, next: NextFunction): Promise<void> | void {
+     *   // Your middleware logic here
+     *   next();
+     *  }
+     * }
+     */
+    addMiddleware(options: MiddlewareOptions): void;
+    /**
+     * View middleware pipeline formatted.
+     * @returns void
+     */
+    viewMiddlewarePipeline(): void;
+    /**
+     * Gets the configured error handler middleware.
+     *
+     * @returns The error handler middleware.
+     */
+    getErrorHandler(): ExpressHandler;
+    /**
+     * Adds Helmet middleware to enhance security by setting various HTTP headers.
+     *
+     * @param options - Optional configuration options for Helmet.
+     * @returns The configuration options for Helmet middleware.
+     */
+    addHelmet(options?: OptionsHelmet): void;
+    /**
+     * Adds Multer middleware for handling multipart/form-data, typically used for file uploads.
+     *
+     * @param options - Optional configuration options for Multer.
+     */
+    setupMulter(options?: multer.Options): multer.Multer;
+}
+/**
+ * Singleton class that implements the IConfigure interface.
+ * Manages the middleware configuration for the application,
+ * including adding Body Parser and retrieving all configured middlewares.
+ *
+ * @see IConfigure
+ */
+declare class Middleware implements IMiddleware {
+    private middlewarePipeline;
+    private errorHandler;
+    private logger;
+    /**
+     * Retrieves the type of the middleware.
+     *
+     * @param middleware - The middleware to be checked.
+     *
+     * @returns The type of the middleware.
+     */
+    private getMiddlewareType;
+    /**
+     * Checks if a middleware with the given name exists in the middleware collection.
+     *
+     * @param middlewareName - The name of the middleware to be checked.
+     *
+     * @returns A boolean value indicating whether the middleware exists or not.
+     */
+    private middlewareExists;
+    addRateLimiter(options?: RateLimitOptions): void;
+    /**
+     * Adds a Body Parser middleware to the middleware collection using the given options.
+     *
+     * @param options - Optional configuration options for the JSON body parser.
+     */
+    addBodyParser(options?: OptionsJson): void;
+    /**
+     * Adds Cross-Origin Resource Sharing (CORS) middleware to enable or control cross-origin requests.
+     *
+     * @param options - Optional configuration options for CORS. Defines the behavior of CORS requests like allowed origins, methods, headers, etc.
+     */
+    addCors(options?: CorsOptions): void;
+    /**
+     * Adds Compression middleware to reduce the size of the response body and improve the speed of the client-server communication.
+     *
+     * @param options - Optional configuration options for Compression. Allows fine-tuning the compression behavior, such as setting the compression level, threshold, and filter functions to determine which requests should be compressed.
+     */
+    addCompression(options?: CompressionOptions): void;
+    /**
+     * Adds Morgan middleware to log HTTP requests.
+     *
+     * @param format - The log format. Can be a string or a function.
+     * @param options - Optional configuration options for Morgan. Defines the behavior of the logger like the output stream, buffer duration, etc.
+     */
+    addMorgan(format: string | FormatFn, options?: OptionsMorgan | undefined): void;
+    /**
+     * Adds Cookie Parser middleware to parse the cookie header and populate req.cookies with an object keyed by the cookie names.
+     *
+     * @param secret - A string or array used for signing cookies. This is optional and if not specified, the cookie-parser will not parse signed cookies.
+     * @param options - Optional configuration options for Cookie Parser.
+     */
+    addCookieParser(secret?: string | Array<string> | undefined, options?: CookieParserOptions | undefined): void;
+    /**
+     * Adds Cookie Session middleware to enable cookie-based sessions.
+     *
+     * @param options - Optional configuration options for Cookie Session. Defines the behavior of cookie sessions like the name of the cookie, keys to sign the cookie, etc.
+     */
+    addCookieSession(options: CookieSessionOptions): void;
+    /**
+     * Adds a middleware to serve the favicon to the middleware collection.
+     * The favicon is the icon that is displayed in the browser tab for the application.
+     *
+     * @param path - The path to the favicon file.
+     * @param options - Optional configuration options for serving the favicon. Defines the behavior of the favicon middleware like cache control, custom headers, etc.
+     */
+    addServeFavicon(path: string | Buffer, options?: ServeFaviconOptions): void;
+    setupMulter(options?: multer.Options): multer.Multer;
+    /**
+     * Adds a middleware to enhance security by setting various HTTP headers.
+     *
+     * @param options - Optional configuration options for Helmet.
+     *
+     */
+    addHelmet(options?: OptionsHelmet): void;
+    /**
+     * Add a middleware to enable express-session.
+     *
+     * @param options - Optional configuration options for Session.
+     *
+     */
+    addSession(options: SessionOptions): void;
+    /**
+     * Configures the error handling middleware for the application.
+     *
+     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
+     */
+    setErrorHandler(errorHandling?: ExpressHandler): void;
+    /**
+     * Adds a middleware to serve static files from the specified root directory.
+     * Allows the application to serve files like images, CSS, JavaScript, etc.
+     *
+     * @param root - The root directory from which the static assets are to be served.
+     * @param options - Optional configuration options for serving static files. Defines behavior like cache control, custom headers, etc.
+     */
+    serveStatic(root: string, options?: ServeStaticOptions): void;
+    /**
+     * Helper method to add middleware configuration objects to the middleware collection.
+     * @param middleware - The middleware configuration object to be added to the middleware collection.
+     * @returns void
+     */
+    private addConfigMiddleware;
+    /**
+     * Helper method to add express request handler functions to the middleware collection.
+     * @param middleware - The express request handler function to be added to the middleware collection.
+     * @returns void
+     */
+    private addExpressHandlerMiddleware;
+    /**
+     * Helper method to add custom Expresso middleware to the middleware collection.
+     * @param middleware - The custom Expresso middleware to be added to the middleware collection.
+     * @returns void
+     */
+    private addIExpressoMiddleware;
+    /**
+     * Adds a middleware to the middleware collection.
+     *
+     * @param options - The Express request handler function to be added to the middleware collection, or a middleware configuration object
+     * that is composed by a route and an expressjs handler, or a custom Expresso middleware.
+     *
+     * @example Express Handler
+     *  const middleware = (req, res, next) => {
+     *    // Your middleware logic here
+     *    next();
+     *  }
+     *
+     * @example Middleware Configuration Object
+     *  const middleware = {
+     *    path: "/",
+     *    middlewares: [] // Array of Express Handlers
+     *  }
+     *
+     * @example Expresso Middleware
+     *  class CustomMiddleware implements IExpressoMiddleware {
+     *    use(req: Request, res: Response, next: NextFunction): Promise<void> | void {
+     *    // Your middleware logic here
+     *      next();
+     *    }
+     *  }
+     */
+    addMiddleware(options: MiddlewareOptions): void;
+    /**
+     * Retrieves middleware pipeline in the order they were added.
+     *
+     * @returns An array of Express request handlers representing the middlewares.
+     */
+    getMiddlewarePipeline(): Array<MiddlewarePipeline>;
+    /**
+     * View middleware pipeline formatted.
+     * @returns void
+     */
+    viewMiddlewarePipeline(): void;
+    /**
+     * Gets the configured error handler middleware.
+     *
+     * @returns The error handler middleware.
+     */
+    getErrorHandler(): ExpressHandler;
+}
+export { Middleware, IMiddleware };