@expressots/adapter-express 1.2.1 → 1.3.0

package/lib/CHANGELOG.md

@@ -1,52 +1,66 @@
 
 
-## [1.2.1](https://github.com/expressots/adapter-express/compare/1.2.0...1.2.1) (2024-04-04)
+## [1.3.0](https://github.com/expressots/adapter-express/compare/1.2.2...1.3.0) (2024-04-26)
 
 
-### Code Refactoring
+### Features
 
-* adapter expressto to be used in AppFactory ([239501e](https://github.com/expressots/adapter-express/commit/239501e41bfd98ecc0893a50c34de58dd8914d9e))
+* returns httpServer for e2e testing with supertest ([97999fb](https://github.com/expressots/adapter-express/commit/97999fbc7ac977e47caf023d7541e588ef50d548))
+
+## [1.2.2](https://github.com/expressots/adapter-express/compare/1.2.1...1.2.2) (2024-04-25)
+
+
+### Bug Fixes
+
+* validate parameter types in param decorator by default ([b7a8657](https://github.com/expressots/adapter-express/commit/b7a8657598ce51a6fa44c3a388d38106b47ad70d))
+
+## [1.2.1](https://github.com/expressots/adapter-express/compare/1.2.0...1.2.1) (2024-04-04)
+
+
+### Code Refactoring
+
+* adapter expressto to be used in AppFactory ([239501e](https://github.com/expressots/adapter-express/commit/239501e41bfd98ecc0893a50c34de58dd8914d9e))
 * rename items for standardization and improve doc ([2e691d5](https://github.com/expressots/adapter-express/commit/2e691d50731e8d4d689fe4b4420daab8ba2f5803))
 
-## [1.2.0](https://github.com/expressots/adapter-express/compare/1.1.1...1.2.0) (2024-3-5)
-
-
-### Features
-
-* add expressots middleware support ([809f148](https://github.com/expressots/adapter-express/commit/809f148a2b9a6bb0aa41f231595b3a4c394574ee))
-* bump @commitlint/cli from 17.8.1 to 18.0.0 ([15fbb1a](https://github.com/expressots/adapter-express/commit/15fbb1a84c758df25b60f2a893fd44829db3c0dc))
-* fix middleware binding to constructor ([3a6f7dc](https://github.com/expressots/adapter-express/commit/3a6f7dca40889133b09630582c775156392c4fd7))
+## [1.2.0](https://github.com/expressots/adapter-express/compare/1.1.1...1.2.0) (2024-3-5)
+
+
+### Features
+
+* add expressots middleware support ([809f148](https://github.com/expressots/adapter-express/commit/809f148a2b9a6bb0aa41f231595b3a4c394574ee))
+* bump @commitlint/cli from 17.8.1 to 18.0.0 ([15fbb1a](https://github.com/expressots/adapter-express/commit/15fbb1a84c758df25b60f2a893fd44829db3c0dc))
+* fix middleware binding to constructor ([3a6f7dc](https://github.com/expressots/adapter-express/commit/3a6f7dca40889133b09630582c775156392c4fd7))
 * fix path call on expresso middleware ([934ae17](https://github.com/expressots/adapter-express/commit/934ae17110489315536e28b71cde24f5f18d88dc))
 
-## [1.1.1](https://github.com/expressots/adapter-express/compare/1.1.0...1.1.1) (2023-10-10)
-
-
-### Bug Fixes
-
-* add global prefix on opinionated ([d9d5a06](https://github.com/expressots/adapter-express/commit/d9d5a0669241ed14541a1452aa0deaa12c1109b4))
-* add global route prefix for both templates ([046fd2c](https://github.com/expressots/adapter-express/commit/046fd2c2e2c5beacf9602f929b223713d48e8b9c))
-* adjust build pipeline ([4f164a2](https://github.com/expressots/adapter-express/commit/4f164a2f6ee5c23512a8e6643b90a74891ec52c4))
-* adjust build script and remove esm build option ([b35af7b](https://github.com/expressots/adapter-express/commit/b35af7b9ea91935572920314eddc8f5258bca4bc))
+## [1.1.1](https://github.com/expressots/adapter-express/compare/1.1.0...1.1.1) (2023-10-10)
+
+
+### Bug Fixes
+
+* add global prefix on opinionated ([d9d5a06](https://github.com/expressots/adapter-express/commit/d9d5a0669241ed14541a1452aa0deaa12c1109b4))
+* add global route prefix for both templates ([046fd2c](https://github.com/expressots/adapter-express/commit/046fd2c2e2c5beacf9602f929b223713d48e8b9c))
+* adjust build pipeline ([4f164a2](https://github.com/expressots/adapter-express/commit/4f164a2f6ee5c23512a8e6643b90a74891ec52c4))
+* adjust build script and remove esm build option ([b35af7b](https://github.com/expressots/adapter-express/commit/b35af7b9ea91935572920314eddc8f5258bca4bc))
 * path in codeql analysis report ([035aa16](https://github.com/expressots/adapter-express/commit/035aa16a9d62de8d7e2b39bae052d8d5499799da))
 
-## 1.1.0 (2023-09-21)
-
-
-### Features
-
-* add express as an adapter ([2870790](https://github.com/expressots/adapter-express/commit/28707900882422d0f882e5e18c9bf01457e5640d))
-* add expressjs adapter ([263d12d](https://github.com/expressots/adapter-express/commit/263d12dce314cc4125a0f5b14eaa0b5e171f165f))
-* add peer dependency @expressots/core ([7e8ec24](https://github.com/expressots/adapter-express/commit/7e8ec240fe5caf72a0c371ba317c0d0f52898571))
-
-
-### Bug Fixes
-
-* add dev 0 package version ([748b62a](https://github.com/expressots/adapter-express/commit/748b62ad101ed6efe4454f9a9f0d684f1118dec6))
-* add dev version ([31baee3](https://github.com/expressots/adapter-express/commit/31baee3e7dd578e14fbc6e1e11eb88ae939e1d28))
-* consume new middlewareConfig base ([bed7b4a](https://github.com/expressots/adapter-express/commit/bed7b4ae682a8c8d55c705e5d2f9b40b136e2af1))
-* expose controller interface ([468818f](https://github.com/expressots/adapter-express/commit/468818fec78e06392cb6024cb4b257edebfd8d38))
-* signature to [@core-v2](https://github.com/core-v2).2 ([4fb5c58](https://github.com/expressots/adapter-express/commit/4fb5c58aa4f011c3aa97803ebc8a80ae72d5b56d))
-* update [@core](https://github.com/core) dependency to altest ([0138609](https://github.com/expressots/adapter-express/commit/01386093f6116e4731270fd17a1250b564387c56))
+## 1.1.0 (2023-09-21)
+
+
+### Features
+
+* add express as an adapter ([2870790](https://github.com/expressots/adapter-express/commit/28707900882422d0f882e5e18c9bf01457e5640d))
+* add expressjs adapter ([263d12d](https://github.com/expressots/adapter-express/commit/263d12dce314cc4125a0f5b14eaa0b5e171f165f))
+* add peer dependency @expressots/core ([7e8ec24](https://github.com/expressots/adapter-express/commit/7e8ec240fe5caf72a0c371ba317c0d0f52898571))
+
+
+### Bug Fixes
+
+* add dev 0 package version ([748b62a](https://github.com/expressots/adapter-express/commit/748b62ad101ed6efe4454f9a9f0d684f1118dec6))
+* add dev version ([31baee3](https://github.com/expressots/adapter-express/commit/31baee3e7dd578e14fbc6e1e11eb88ae939e1d28))
+* consume new middlewareConfig base ([bed7b4a](https://github.com/expressots/adapter-express/commit/bed7b4ae682a8c8d55c705e5d2f9b40b136e2af1))
+* expose controller interface ([468818f](https://github.com/expressots/adapter-express/commit/468818fec78e06392cb6024cb4b257edebfd8d38))
+* signature to [@core-v2](https://github.com/core-v2).2 ([4fb5c58](https://github.com/expressots/adapter-express/commit/4fb5c58aa4f011c3aa97803ebc8a80ae72d5b56d))
+* update [@core](https://github.com/core) dependency to altest ([0138609](https://github.com/expressots/adapter-express/commit/01386093f6116e4731270fd17a1250b564387c56))
 * update peer dependecy for [@core](https://github.com/core) ([16a01f3](https://github.com/expressots/adapter-express/commit/16a01f353f3285a68a2038ceb40b6498c64c5a34))
 
 ## 0.0.1 (2023-09-05)

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

@@ -14,8 +14,8 @@ const core_1 = require("@expressots/core");
 const inversify_binding_decorators_1 = require("inversify-binding-decorators");
 const process_1 = __importDefault(require("process"));
 const application_express_base_1 = require("./application-express.base");
-const inversify_express_server_1 = require("./express-utils/inversify-express-server");
 const application_express_types_1 = require("./application-express.types");
+const inversify_express_server_1 = require("./express-utils/inversify-express-server");
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
  * @class AppExpress
@@ -30,6 +30,7 @@ const application_express_types_1 = require("./application-express.types");
 let AppExpress = class AppExpress extends application_express_base_1.ApplicationBase {
     constructor() {
         super(...arguments);
+        this.logger = new core_1.Logger();
         this.globalPrefix = "/";
         this.middlewares = [];
     }
@@ -118,7 +119,7 @@ let AppExpress = class AppExpress extends application_express_base_1.Application
      */
     async listen(port, environment, consoleMessage) {
         await this.init();
-        this.port = port;
+        this.port = port || 3000;
         this.environment = environment;
         this.app.set("env", environment);
         this.app.listen(this.port, () => {
@@ -174,6 +175,17 @@ let AppExpress = class AppExpress extends application_express_base_1.Application
             .error("isDevelopment() method must be called on `PostServerInitialization`", "application");
         return false;
     }
+    /**
+     * Get the underlying HTTP server. (default: Express.js)
+     * @returns The underlying HTTP server after initialization.
+     */
+    async getHttpServer() {
+        if (!this.app) {
+            this.logger.error("The method can only be called in `app.provider` or in e2e tests with supertest.", "adapter-express");
+            throw new Error("Incorrect usage of `getHttpServer` method");
+        }
+        return this.app;
+    }
 };
 exports.AppExpress = AppExpress;
 exports.AppExpress = AppExpress = __decorate([

package/lib/cjs/adapter-express/express-utils/decorators.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.params = exports.Principal = exports.next = exports.cookies = exports.headers = exports.body = exports.query = exports.param = exports.response = exports.request = exports.httpMethod = exports.Delete = exports.Head = exports.Patch = exports.Put = exports.Post = exports.Get = exports.all = exports.controller = exports.injectHttpContext = void 0;
+exports.params = exports.principal = exports.next = exports.cookies = exports.headers = exports.body = exports.query = exports.param = exports.response = exports.request = exports.httpMethod = exports.Delete = exports.Head = exports.Patch = exports.Put = exports.Post = exports.Get = exports.All = exports.controller = exports.injectHttpContext = void 0;
 require("reflect-metadata");
 const inversify_1 = require("inversify");
 const constants_1 = require("./constants");
 exports.injectHttpContext = (0, inversify_1.inject)(constants_1.TYPE.HttpContext);
+/**
+ * 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
+ */
 function controller(path, ...middleware) {
     return (target) => {
         const currentMetadata = {
@@ -20,34 +25,99 @@ function controller(path, ...middleware) {
     };
 }
 exports.controller = controller;
-function all(path, ...middleware) {
+/**
+ * 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
+ */
+function All(path, ...middleware) {
     return httpMethod("all", path, ...middleware);
 }
-exports.all = all;
+exports.All = All;
+/**
+ * Decorator to allow GET HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Get(path, ...middleware) {
-    return httpMethod("get", path, ...middleware);
+    return enhancedHttpMethod("get", path, ...middleware);
 }
 exports.Get = Get;
+/**
+ * Decorator to allow POST HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Post(path, ...middleware) {
     return httpMethod("post", path, ...middleware);
 }
 exports.Post = Post;
+/**
+ * Decorator to allow PUT HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Put(path, ...middleware) {
-    return httpMethod("put", path, ...middleware);
+    return enhancedHttpMethod("put", path, ...middleware);
 }
 exports.Put = Put;
+/**
+ * Decorator to allow PATCH HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Patch(path, ...middleware) {
-    return httpMethod("patch", path, ...middleware);
+    return enhancedHttpMethod("patch", path, ...middleware);
 }
 exports.Patch = Patch;
+/**
+ * Decorator to allow HEAD HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Head(path, ...middleware) {
     return httpMethod("head", path, ...middleware);
 }
 exports.Head = Head;
+/**
+ * Decorator to allow DELETE HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function Delete(path, ...middleware) {
-    return httpMethod("delete", path, ...middleware);
+    return enhancedHttpMethod("delete", path, ...middleware);
 }
 exports.Delete = Delete;
+function enhancedHttpMethod(method, path, ...middleware) {
+    return (target, key) => {
+        const metadata = {
+            key,
+            method,
+            middleware,
+            path,
+            target,
+        };
+        let metadataList = [];
+        if (!Reflect.hasOwnMetadata(constants_1.METADATA_KEY.controllerMethod, target.constructor)) {
+            Reflect.defineMetadata(constants_1.METADATA_KEY.controllerMethod, metadataList, target.constructor);
+        }
+        else {
+            metadataList = Reflect.getOwnMetadata(constants_1.METADATA_KEY.controllerMethod, target.constructor);
+        }
+        metadataList.push(metadata);
+        const paramsInfo = Reflect.getMetadata("design:paramtypes", target, key) || [];
+        metadataList.forEach((m) => {
+            m.middleware.unshift((req, res, next) => {
+                req.params &&
+                    Object.keys(req.params).forEach((param, idx) => {
+                        const type = paramsInfo[idx];
+                        req.params[param] = convertToType(req.params[param], type);
+                    });
+                next();
+            });
+        });
+    };
+}
 function httpMethod(method, path, ...middleware) {
     return (target, key) => {
         const metadata = {
@@ -68,18 +138,51 @@ function httpMethod(method, path, ...middleware) {
     };
 }
 exports.httpMethod = httpMethod;
-/*
- * Parameter Decorators
+/**
+ * Parameter decorator to inject the request object
+ * @returns ParameterDecorator
  */
 exports.request = paramDecoratorFactory(constants_1.PARAMETER_TYPE.REQUEST);
+/**
+ * Parameter decorator to inject the response object
+ * @returns ParameterDecorator
+ */
 exports.response = paramDecoratorFactory(constants_1.PARAMETER_TYPE.RESPONSE);
+/**
+ * Parameter decorator to inject parameters from the route
+ * @returns ParameterDecorator
+ */
 exports.param = paramDecoratorFactory(constants_1.PARAMETER_TYPE.PARAMS);
+/**
+ * Parameter decorator to inject query parameters
+ * @returns ParameterDecorator
+ */
 exports.query = paramDecoratorFactory(constants_1.PARAMETER_TYPE.QUERY);
+/**
+ * Parameter decorator to inject the request body
+ * @returns ParameterDecorator
+ */
 exports.body = paramDecoratorFactory(constants_1.PARAMETER_TYPE.BODY);
+/**
+ * Parameter decorator to inject the request headers
+ * @returns ParameterDecorator
+ */
 exports.headers = paramDecoratorFactory(constants_1.PARAMETER_TYPE.HEADERS);
+/**
+ * Parameter decorator to inject the request cookies
+ * @returns ParameterDecorator
+ */
 exports.cookies = paramDecoratorFactory(constants_1.PARAMETER_TYPE.COOKIES);
+/**
+ * Parameter decorator next function
+ * @returns ParameterDecorator
+ */
 exports.next = paramDecoratorFactory(constants_1.PARAMETER_TYPE.NEXT);
-exports.Principal = paramDecoratorFactory(constants_1.PARAMETER_TYPE.PRINCIPAL);
+/**
+ * Parameter decorator to inject the principal object obtained from AuthProvider
+ * @returns ParameterDecorator
+ */
+exports.principal = paramDecoratorFactory(constants_1.PARAMETER_TYPE.PRINCIPAL);
 function paramDecoratorFactory(parameterType) {
     return (name) => params(parameterType, name);
 }
@@ -108,3 +211,15 @@ function params(type, parameterName) {
     };
 }
 exports.params = params;
+function convertToType(value, type) {
+    if (type === Number) {
+        return Number(value);
+    }
+    else if (type === String) {
+        return value;
+    }
+    else if (type === Boolean) {
+        return value === "true" || value === "1";
+    }
+    return value;
+}

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

@@ -1,4 +1,5 @@
 import { IApplicationMessageToConsole, RenderTemplateOptions } from "@expressots/core";
+import express from "express";
 import { Container } from "inversify";
 import { ApplicationBase } from "./application-express.base";
 import { IWebServer, ServerEnvironment } from "./application-express.types";
@@ -14,6 +15,7 @@ import { IWebServer, ServerEnvironment } from "./application-express.types";
  * @method isDevelopment - Verifies if the current environment is development.
  */
 declare class AppExpress extends ApplicationBase implements IWebServer {
+    private logger;
     private app;
     private port;
     private environment;
@@ -81,5 +83,10 @@ declare class AppExpress extends ApplicationBase implements IWebServer {
      * @returns A boolean value indicating whether the current environment is development or not.
      */
     protected isDevelopment(): boolean;
+    /**
+     * Get the underlying HTTP server. (default: Express.js)
+     * @returns The underlying HTTP server after initialization.
+     */
+    getHttpServer(): Promise<express.Application>;
 }
 export { AppExpress };

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

@@ -1,3 +1,4 @@
+import express from "express";
 import { IApplicationMessageToConsole, RenderTemplateOptions } from "@expressots/core";
 import { ServerEnvironment } from "./application-express.types";
 /**
@@ -23,4 +24,9 @@ export interface IWebServerPublic {
      *                      This includes the extension name, view path, and the engine function itself.
      */
     setEngine<T extends RenderTemplateOptions>(options: T): void;
+    /**
+     * Get the underlying HTTP server. (default: Express.js)
+     * @returns The underlying HTTP server after initialization.
+     */
+    getHttpServer(): Promise<express.Application>;
 }

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

@@ -1,23 +1,99 @@
 import "reflect-metadata";
 import { PARAMETER_TYPE, HTTP_VERBS_ENUM } from "./constants";
-import type { Controller, HandlerDecorator, Middleware } from "./interfaces";
+import type { HandlerDecorator, Middleware } from "./interfaces";
 export declare const injectHttpContext: (target: import("inversify/lib/annotation/decorator_utils").DecoratorTarget<unknown>, 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
+ */
 export declare function controller(path: string, ...middleware: Array<Middleware>): (target: NewableFunction) => void;
-export declare function all(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
+/**
+ * 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
+ */
+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
+ */
 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
+ */
 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
+ */
 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
+ */
 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
+ */
 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
+ */
 export declare function Delete(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 export declare function httpMethod(method: keyof typeof HTTP_VERBS_ENUM, path: string, ...middleware: Array<Middleware>): HandlerDecorator;
+/**
+ * Parameter decorator to inject the request object
+ * @returns ParameterDecorator
+ */
 export declare const request: () => ParameterDecorator;
+/**
+ * Parameter decorator to inject the response object
+ * @returns ParameterDecorator
+ */
 export declare const response: () => ParameterDecorator;
+/**
+ * Parameter decorator to inject parameters from the route
+ * @returns ParameterDecorator
+ */
 export declare const param: (paramName?: string) => ParameterDecorator;
+/**
+ * Parameter decorator to inject query parameters
+ * @returns ParameterDecorator
+ */
 export declare const query: (queryParamName?: string) => ParameterDecorator;
+/**
+ * Parameter decorator to inject the request body
+ * @returns ParameterDecorator
+ */
 export declare const body: () => ParameterDecorator;
+/**
+ * Parameter decorator to inject the request headers
+ * @returns ParameterDecorator
+ */
 export declare const headers: (headerName?: string) => ParameterDecorator;
+/**
+ * Parameter decorator to inject the request cookies
+ * @returns ParameterDecorator
+ */
 export declare const cookies: (cookieName?: string) => ParameterDecorator;
+/**
+ * Parameter decorator next function
+ * @returns ParameterDecorator
+ */
 export declare const next: () => ParameterDecorator;
-export declare const Principal: () => ParameterDecorator;
-export declare function params(type: PARAMETER_TYPE, parameterName?: string): (target: unknown | Controller, methodName: string | symbol, index: number) => void;
+/**
+ * Parameter decorator to inject the principal object obtained from AuthProvider
+ * @returns ParameterDecorator
+ */
+export declare const principal: () => ParameterDecorator;
+export declare function params(type: PARAMETER_TYPE, parameterName?: string): ParameterDecorator;

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",