@expressots/adapter-express 1.2.1 → 1.2.2

package/lib/CHANGELOG.md

@@ -1,5 +1,12 @@
 
 
+## [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)
 
 

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/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.2.2",
   "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.2.2",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",