@expressots/adapter-express 1.3.0 → 1.4.0

package/README.md

@@ -2,6 +2,9 @@
 
 <!-- PROJECT SHIELDS -->
 
+[![Codecov][codecov-shield]][codecov-url]
+[![NPM][npm-shield]][npm-url]
+![Build][build-shield]
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
@@ -95,6 +98,11 @@ Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/expres
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 
+[codecov-url]: https://codecov.io/gh/expressots/adapter-express
+[codecov-shield]: https://img.shields.io/codecov/c/gh/expressots/adapter-express/main?style=for-the-badge&logo=codecov&labelColor=FB9AD1
+[npm-url]: https://www.npmjs.com/package/@expressots/adapter-express
+[npm-shield]: https://img.shields.io/npm/v/@expressots/adapter-express?style=for-the-badge&logo=npm&color=9B3922
+[build-shield]: https://img.shields.io/github/actions/workflow/status/expressots/adapter-express/build.yaml?branch=main&style=for-the-badge&logo=github
 [contributors-shield]: https://img.shields.io/github/contributors/expressots/adapter-express?style=for-the-badge
 [contributors-url]: https://github.com/expressots/adapter-express/graphs/contributors
 [forks-shield]: https://img.shields.io/github/forks/expressots/adapter-express?style=for-the-badge

package/lib/CHANGELOG.md

@@ -1,10 +1,34 @@
 
 
-## [1.3.0](https://github.com/expressots/adapter-express/compare/1.2.2...1.3.0) (2024-04-26)
+## [1.4.0](https://github.com/expressots/adapter-express/compare/1.3.0...1.4.0) (2024-06-07)
 
 
 ### Features
 
+* Add http code decorator ([f0f6e0a](https://github.com/expressots/adapter-express/commit/f0f6e0aa034636d7df67d5f1cef83adb6a3af8bc))
+* add vitest and setup codecov in the ci ([14fd527](https://github.com/expressots/adapter-express/commit/14fd527a097d981778f2b3ba2a68effb68865d8f))
+* adjust doc, update metadata const for http decorator ([773f297](https://github.com/expressots/adapter-express/commit/773f297fee340b5d8de6a134454425328ddbbc03))
+* dev-http decorator changes ([8088f5c](https://github.com/expressots/adapter-express/commit/8088f5c2ef391abbe33d1e8750bef9a6fe34f699))
+* fix issues where decorator does not function properly when used multiple times in same file ([919815f](https://github.com/expressots/adapter-express/commit/919815f4f1232f9a319ed887a99f8c214b40341d))
+
+
+### Bug Fixes
+
+* build shield workflow status ([3e5d6c8](https://github.com/expressots/adapter-express/commit/3e5d6c814cb5ed71cfa7a4f5e65f77ad359671f6))
+* code coverage upload path ([aef20eb](https://github.com/expressots/adapter-express/commit/aef20eb2767506e7d9c7773233727c96cb5ca9b7))
+* remove codesee ci config ([043c423](https://github.com/expressots/adapter-express/commit/043c423c52d00c814c6357c1e7f6ed7caed3b2ac))
+* remove the decorator incorrect call in the library due mismatch on tsconfig ([58dbb52](https://github.com/expressots/adapter-express/commit/58dbb5258a7c2155dd34b1841dbfbe15884f4e21))
+
+
+### Code Refactoring
+
+* readme badges npm, coverage and build added ([d643acd](https://github.com/expressots/adapter-express/commit/d643acde38df4866155a0164f08c2d7f0261c705))
+
+## [1.3.0](https://github.com/expressots/adapter-express/compare/1.2.2...1.3.0) (2024-04-26)
+
+
+### Features
+
 * 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)

package/lib/README.md

@@ -2,6 +2,9 @@
 
 <!-- PROJECT SHIELDS -->
 
+[![Codecov][codecov-shield]][codecov-url]
+[![NPM][npm-shield]][npm-url]
+![Build][build-shield]
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
@@ -95,6 +98,11 @@ Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/expres
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 
+[codecov-url]: https://codecov.io/gh/expressots/adapter-express
+[codecov-shield]: https://img.shields.io/codecov/c/gh/expressots/adapter-express/main?style=for-the-badge&logo=codecov&labelColor=FB9AD1
+[npm-url]: https://www.npmjs.com/package/@expressots/adapter-express
+[npm-shield]: https://img.shields.io/npm/v/@expressots/adapter-express?style=for-the-badge&logo=npm&color=9B3922
+[build-shield]: https://img.shields.io/github/actions/workflow/status/expressots/adapter-express/build.yaml?branch=main&style=for-the-badge&logo=github
 [contributors-shield]: https://img.shields.io/github/contributors/expressots/adapter-express?style=for-the-badge
 [contributors-url]: https://github.com/expressots/adapter-express/graphs/contributors
 [forks-shield]: https://img.shields.io/github/forks/expressots/adapter-express?style=for-the-badge

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

@@ -16,6 +16,7 @@ const process_1 = __importDefault(require("process"));
 const application_express_base_1 = require("./application-express.base");
 const application_express_types_1 = require("./application-express.types");
 const inversify_express_server_1 = require("./express-utils/inversify-express-server");
+const http_status_middleware_1 = require("./express-utils/http-status-middleware");
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
  * @class AppExpress
@@ -97,6 +98,8 @@ let AppExpress = class AppExpress extends application_express_base_1.Application
         const sortedMiddlewarePipeline = middleware.getMiddlewarePipeline();
         const pipeline = sortedMiddlewarePipeline.map((entry) => entry.middleware);
         this.middlewares.push(...pipeline);
+        /* Apply the status code to the response */
+        this.middlewares.unshift(new http_status_middleware_1.HttpStatusCodeMiddleware());
         const expressServer = new inversify_express_server_1.InversifyExpressServer(this.container, null, {
             rootPath: this.globalPrefix,
         });

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ROUTING_ROOT_PATH = exports.NO_CONTROLLERS_FOUND = exports.DUPLICATED_CONTROLLER_NAME = exports.HTTP_VERBS_ENUM = exports.PARAMETER_TYPE = exports.METADATA_KEY = exports.TYPE = void 0;
+exports.DEFAULT_ROUTING_ROOT_PATH = exports.NO_CONTROLLERS_FOUND = exports.DUPLICATED_CONTROLLER_NAME = exports.HTTP_VERBS_ENUM = exports.PARAMETER_TYPE = exports.HTTP_CODE_METADATA = exports.METADATA_KEY = exports.TYPE = void 0;
 exports.TYPE = {
     AuthProvider: Symbol.for("AuthProvider"),
     Controller: Symbol.for("Controller"),
@@ -12,6 +12,11 @@ exports.METADATA_KEY = {
     controllerParameter: "inversify-express-utils:controller-parameter",
     httpContext: "inversify-express-utils:httpcontext",
 };
+exports.HTTP_CODE_METADATA = {
+    httpCode: "inversify-express-utils:httpcode",
+    statusCode: "inversify-express-utils:statuscode",
+    path: "inversify-express-utils:path",
+};
 var PARAMETER_TYPE;
 (function (PARAMETER_TYPE) {
     PARAMETER_TYPE[PARAMETER_TYPE["REQUEST"] = 0] = "REQUEST";

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

@@ -1,6 +1,6 @@
 "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.Http = exports.controller = exports.injectHttpContext = void 0;
 require("reflect-metadata");
 const inversify_1 = require("inversify");
 const constants_1 = require("./constants");
@@ -17,6 +17,21 @@ function controller(path, ...middleware) {
             path,
             target,
         };
+        const pathMetadata = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.path, Reflect);
+        const statusCodeMetadata = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.statusCode, Reflect);
+        let statusCodePathMapping = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.httpCode, Reflect);
+        if (!statusCodePathMapping) {
+            statusCodePathMapping = {};
+        }
+        for (const key in pathMetadata) {
+            if (statusCodeMetadata && statusCodeMetadata[key]) {
+                const realPath = pathMetadata[key] === "/" ? path : `${path}${pathMetadata[key]}`;
+                statusCodePathMapping[realPath] = statusCodeMetadata[key];
+            }
+        }
+        Reflect.defineMetadata(constants_1.HTTP_CODE_METADATA.httpCode, statusCodePathMapping, Reflect);
+        Reflect.deleteMetadata(constants_1.HTTP_CODE_METADATA.statusCode, Reflect);
+        Reflect.deleteMetadata(constants_1.HTTP_CODE_METADATA.path, Reflect);
         (0, inversify_1.decorate)((0, inversify_1.injectable)(), target);
         Reflect.defineMetadata(constants_1.METADATA_KEY.controller, currentMetadata, target);
         const previousMetadata = Reflect.getMetadata(constants_1.METADATA_KEY.controller, Reflect) || [];
@@ -25,6 +40,34 @@ function controller(path, ...middleware) {
     };
 }
 exports.controller = controller;
+/**
+ * Http decorator to define the status code for a route
+ * @param code
+ * @returns MethodDecorator
+ * @example
+ * ```ts
+ * @Http(200)
+ * @Get("/")
+ * hello() {
+ *  return "Hello World";
+ * }
+ * ```
+ */
+function Http(code) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+    return (target, key, descriptor) => {
+        let httpCodeMetadata = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.statusCode, Reflect);
+        if (httpCodeMetadata) {
+            httpCodeMetadata[key] = code;
+        }
+        else {
+            httpCodeMetadata = {};
+            httpCodeMetadata[key] = code;
+        }
+        Reflect.defineMetadata(constants_1.HTTP_CODE_METADATA.statusCode, httpCodeMetadata, Reflect);
+    };
+}
+exports.Http = Http;
 /**
  * Decorator to allow accept all HTTP methods
  * @param path route path, wildcard
@@ -88,6 +131,11 @@ function Delete(path, ...middleware) {
     return enhancedHttpMethod("delete", path, ...middleware);
 }
 exports.Delete = Delete;
+/**
+ * Decorator to allow OPTIONS HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function enhancedHttpMethod(method, path, ...middleware) {
     return (target, key) => {
         const metadata = {
@@ -98,6 +146,15 @@ function enhancedHttpMethod(method, path, ...middleware) {
             target,
         };
         let metadataList = [];
+        let pathMetadata = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.path, Reflect);
+        if (pathMetadata) {
+            pathMetadata[key] = path;
+        }
+        else {
+            pathMetadata = {};
+            pathMetadata[key] = path;
+        }
+        Reflect.defineMetadata(constants_1.HTTP_CODE_METADATA.path, pathMetadata, Reflect);
         if (!Reflect.hasOwnMetadata(constants_1.METADATA_KEY.controllerMethod, target.constructor)) {
             Reflect.defineMetadata(constants_1.METADATA_KEY.controllerMethod, metadataList, target.constructor);
         }
@@ -118,6 +175,12 @@ function enhancedHttpMethod(method, path, ...middleware) {
         });
     };
 }
+/**
+ * Decorator to allow custom HTTP method
+ * @param method custom HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 function httpMethod(method, path, ...middleware) {
     return (target, key) => {
         const metadata = {
@@ -128,6 +191,15 @@ function httpMethod(method, path, ...middleware) {
             target,
         };
         let metadataList = [];
+        let pathMetadata = Reflect.getOwnMetadata(constants_1.HTTP_CODE_METADATA.path, Reflect);
+        if (pathMetadata) {
+            pathMetadata[key] = path;
+        }
+        else {
+            pathMetadata = {};
+            pathMetadata[key] = path;
+        }
+        Reflect.defineMetadata(constants_1.HTTP_CODE_METADATA.path, pathMetadata, Reflect);
         if (!Reflect.hasOwnMetadata(constants_1.METADATA_KEY.controllerMethod, target.constructor)) {
             Reflect.defineMetadata(constants_1.METADATA_KEY.controllerMethod, metadataList, target.constructor);
         }
@@ -183,9 +255,17 @@ exports.next = paramDecoratorFactory(constants_1.PARAMETER_TYPE.NEXT);
  * @returns ParameterDecorator
  */
 exports.principal = paramDecoratorFactory(constants_1.PARAMETER_TYPE.PRINCIPAL);
+/**
+ * Parameter decorator to inject the request user object
+ * @returns ParameterDecorator
+ */
 function paramDecoratorFactory(parameterType) {
     return (name) => params(parameterType, name);
 }
+/**
+ * Parameter decorator to inject the request object
+ * @returns ParameterDecorator
+ */
 function params(type, parameterName) {
     return (target, methodName, index) => {
         let metadataList = {};
@@ -211,6 +291,12 @@ function params(type, parameterName) {
     };
 }
 exports.params = params;
+/**
+ * Converts a string value to the specified type.
+ * @param value The value to convert.
+ * @param type The type to convert the value to.
+ * @returns The converted value.
+ */
 function convertToType(value, type) {
     if (type === Number) {
         return Number(value);

package/lib/cjs/adapter-express/express-utils/http-status-middleware.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpStatusCodeMiddleware = void 0;
+require("reflect-metadata");
+const core_1 = require("@expressots/core");
+const constants_1 = require("./constants");
+/**
+ * Middleware that applies the status code to the response.
+ * @returns express.RequestHandler
+ */
+class HttpStatusCodeMiddleware extends core_1.ExpressoMiddleware {
+    use(req, res, next) {
+        const statusCodeMapping = Reflect.getMetadata(constants_1.HTTP_CODE_METADATA.httpCode, Reflect);
+        let path = req.path.endsWith("/") ? req.path.slice(0, -1) : req.path;
+        if (path === "/" || path === "") {
+            path = "/";
+        }
+        const statusCode = statusCodeMapping[path];
+        if (statusCode) {
+            res.status(statusCode);
+        }
+        else {
+            this.setDefaultStatusCode(req, res);
+        }
+        next();
+    }
+    setDefaultStatusCode(req, res) {
+        switch (req.method.toLowerCase()) {
+            case "get":
+                res.statusCode = 200;
+                break;
+            case "post":
+                res.statusCode = 201;
+                break;
+            case "put":
+                res.statusCode = 204;
+                break;
+            case "delete":
+                res.statusCode = 204;
+                break;
+            default:
+                res.statusCode = 200;
+                break;
+        }
+    }
+}
+exports.HttpStatusCodeMiddleware = HttpStatusCodeMiddleware;

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

@@ -9,6 +9,11 @@ export declare const METADATA_KEY: {
     controllerParameter: string;
     httpContext: string;
 };
+export declare const HTTP_CODE_METADATA: {
+    httpCode: string;
+    statusCode: string;
+    path: string;
+};
 export declare enum PARAMETER_TYPE {
     REQUEST = 0,
     RESPONSE = 1,

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

@@ -8,6 +8,20 @@ export declare const injectHttpContext: (target: import("inversify/lib/annotatio
  * @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;
+/**
+ * Http decorator to define the status code for a route
+ * @param code
+ * @returns MethodDecorator
+ * @example
+ * ```ts
+ * @Http(200)
+ * @Get("/")
+ * hello() {
+ *  return "Hello World";
+ * }
+ * ```
+ */
+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
@@ -50,6 +64,12 @@ export declare function Head(path: string, ...middleware: Array<Middleware>): Ha
  * @param middleware array of middleware to be applied to the route
  */
 export declare function Delete(path: string, ...middleware: Array<Middleware>): HandlerDecorator;
+/**
+ * Decorator to allow custom HTTP method
+ * @param method custom HTTP method
+ * @param path route path
+ * @param middleware array of middleware to be applied to the route
+ */
 export declare function httpMethod(method: keyof typeof HTTP_VERBS_ENUM, path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Parameter decorator to inject the request object
@@ -96,4 +116,8 @@ export declare const next: () => ParameterDecorator;
  * @returns ParameterDecorator
  */
 export declare const principal: () => ParameterDecorator;
+/**
+ * Parameter decorator to inject the request object
+ * @returns ParameterDecorator
+ */
 export declare function params(type: PARAMETER_TYPE, parameterName?: string): ParameterDecorator;

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

@@ -0,0 +1,11 @@
+import "reflect-metadata";
+import { Request, Response, NextFunction } from "express";
+import { ExpressoMiddleware } from "@expressots/core";
+/**
+ * Middleware that applies the status code to the response.
+ * @returns express.RequestHandler
+ */
+export declare class HttpStatusCodeMiddleware extends ExpressoMiddleware {
+    use(req: Request, res: Response, next: NextFunction): void | Promise<void>;
+    private setDefaultStatusCode;
+}

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -57,7 +57,10 @@
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "release": "release-it",
     "prepublish": "npm run build && npm pack",
-    "test": "jest",
+    "publish": "npm publish --tag latest",
+    "test": "vitest run --reporter default",
+    "test:watch": "vitest run --watch",
+    "coverage": "vitest run --coverage",
     "format": "prettier --write \"src/**/*.ts\" --cache",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix"
@@ -66,26 +69,29 @@
     "dotenv": "16.4.5",
     "inversify": "6.0.2",
     "inversify-binding-decorators": "4.0.0",
-    "jest": "29.5.0",
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.0.0",
+    "@codecov/vite-plugin": "^0.0.1-beta.6",
+    "@commitlint/cli": "18.0.0",
     "@commitlint/config-conventional": "17.7.0",
     "@expressots/core": "latest",
     "@release-it/conventional-changelog": "7.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "29.5.0",
     "@types/node": "20.4.9",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",
+    "@vitest/coverage-v8": "^1.4.0",
     "eslint": "8.48.0",
     "eslint-config-prettier": "9.0.0",
     "husky": "8.0.3",
     "prettier": "3.0.3",
     "release-it": "16.1.5",
     "ts-jest": "29.0.5",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "vite": "^5.2.8",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.4.0"
   },
   "release-it": {
     "git": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -57,7 +57,10 @@
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "release": "release-it",
     "prepublish": "npm run build && npm pack",
-    "test": "jest",
+    "publish": "npm publish --tag latest",
+    "test": "vitest run --reporter default",
+    "test:watch": "vitest run --watch",
+    "coverage": "vitest run --coverage",
     "format": "prettier --write \"src/**/*.ts\" --cache",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix"
@@ -66,26 +69,29 @@
     "dotenv": "16.4.5",
     "inversify": "6.0.2",
     "inversify-binding-decorators": "4.0.0",
-    "jest": "29.5.0",
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.0.0",
+    "@codecov/vite-plugin": "^0.0.1-beta.6",
+    "@commitlint/cli": "18.0.0",
     "@commitlint/config-conventional": "17.7.0",
     "@expressots/core": "latest",
     "@release-it/conventional-changelog": "7.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "29.5.0",
     "@types/node": "20.4.9",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",
+    "@vitest/coverage-v8": "^1.4.0",
     "eslint": "8.48.0",
     "eslint-config-prettier": "9.0.0",
     "husky": "8.0.3",
     "prettier": "3.0.3",
     "release-it": "16.1.5",
     "ts-jest": "29.0.5",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "vite": "^5.2.8",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.4.0"
   },
   "release-it": {
     "git": {