feat: add request body decorator

Co-authored-by: imdudu1 <[email protected]>

Author: jbl428

lib/decorators/constants.ts

@@ -2,3 +2,4 @@ export const HTTP_INTERFACE_METADATA = Symbol("HTTP_INTERFACE_METADATA");
 export const HTTP_EXCHANGE_METADATA = Symbol("HTTP_EXCHANGE_METADATA");
 export const PATH_VARIABLE_METADATA = Symbol("PATH_VARIABLE_METADATA");
 export const REQUEST_PARAM_METADATA = Symbol("REQUEST_PARAM_METADATA");
+export const REQUEST_BODY_METADATA = Symbol("REQUEST_BODY_METADATA");

lib/decorators/request-body.decorator.spec.ts

@@ -0,0 +1,48 @@
+import { describe, test, expect } from "vitest";
+import { REQUEST_BODY_METADATA } from "./constants";
+import {
+  RequestBody,
+  type RequestBodyMetadata,
+} from "./request-body.decorator";
+
+describe("RequestBody", () => {
+  test("should set request body metadata with empty key", () => {
+    // given
+    class TestService {
+      request(@RequestBody() query: { foo: string }): string {
+        return query.foo;
+      }
+    }
+
+    // when
+    const result: RequestBodyMetadata = Reflect.getMetadata(
+      REQUEST_BODY_METADATA,
+      TestService.prototype,
+      "request"
+    );
+
+    // then
+    expect(result).toHaveLength(1);
+    expect(result.get(0)).toBeUndefined();
+  });
+
+  test("should set request body metadata with key", () => {
+    // given
+    class TestService {
+      request(@RequestBody("foo") bar: string): string {
+        return bar;
+      }
+    }
+
+    // when
+    const result: RequestBodyMetadata = Reflect.getMetadata(
+      REQUEST_BODY_METADATA,
+      TestService.prototype,
+      "request"
+    );
+
+    // then
+    expect(result).toHaveLength(1);
+    expect(result.get(0)).toBe("foo");
+  });
+});

lib/decorators/request-body.decorator.ts

@@ -0,0 +1,24 @@
+import { REQUEST_BODY_METADATA } from "./constants";
+
+export type RequestBodyMetadata = Map<number, string | undefined>;
+
+export function RequestBody(key?: string): ParameterDecorator {
+  return (target, propertyKey, parameterIndex) => {
+    if (typeof propertyKey === "undefined") {
+      return;
+    }
+
+    const metadata =
+      Reflect.getMetadata(REQUEST_BODY_METADATA, target, propertyKey) ??
+      new Map();
+
+    metadata.set(parameterIndex, key);
+
+    Reflect.defineMetadata(
+      REQUEST_BODY_METADATA,
+      metadata,
+      target,
+      propertyKey
+    );
+  };
+}

package.json

@@ -21,7 +21,7 @@
   "homepage": "https://github.com/r2don/nest-http-interface#readme",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest run",
     "prepare": "husky install"
   },
   "devDependencies": {