feat: add http exchange decorator

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

Author: jbl428

lib/decorators/constants.ts

@@ -1 +1,2 @@
 export const HTTP_INTERFACE_METADATA = Symbol("HTTP_INTERFACE_METADATA");
+export const HTTP_EXCHANGE_METADATA = Symbol("HTTP_EXCHANGE_METADATA");

lib/decorators/http-exchange.decorator.spec.ts

@@ -0,0 +1,43 @@
+import { describe, test, expect } from "vitest";
+import { HTTP_EXCHANGE_METADATA } from "./constants";
+import {
+  type HttpExchangeMetadata,
+  GetExchange,
+  PostExchange,
+  PutExchange,
+  DeleteExchange,
+  OptionsExchange,
+  PatchExchange,
+  HeadExchange,
+} from "./http-exchange.decorator";
+
+describe("HttpExchange", () => {
+  test.each([
+    ["GET", GetExchange],
+    ["POST", PostExchange],
+    ["PUT", PutExchange],
+    ["DELETE", DeleteExchange],
+    ["PATCH", PatchExchange],
+    ["HEAD", HeadExchange],
+    ["OPTIONS", OptionsExchange],
+  ])("should set %s method metadata", (method, decorator) => {
+    // given
+    class TestService {
+      @decorator("/api/v1/sample")
+      async request(): Promise<string> {
+        return "";
+      }
+    }
+
+    // when
+    const result: HttpExchangeMetadata = Reflect.getMetadata(
+      HTTP_EXCHANGE_METADATA,
+      TestService.prototype,
+      "request"
+    );
+
+    // then
+    expect(result.method).toBe(method);
+    expect(result.url).toBe("/api/v1/sample");
+  });
+});

lib/decorators/http-exchange.decorator.ts

@@ -0,0 +1,40 @@
+import { HTTP_EXCHANGE_METADATA } from "./constants";
+
+type HttpMethod =
+  | "GET"
+  | "POST"
+  | "PUT"
+  | "DELETE"
+  | "PATCH"
+  | "HEAD"
+  | "OPTIONS";
+
+export interface HttpExchangeMetadata {
+  method: HttpMethod;
+  url: string;
+}
+
+type AsyncFunction = (...args: unknown[]) => Promise<unknown>;
+
+export function HttpExchange(method: HttpMethod, url: string) {
+  return function <P extends string>(
+    target: Record<P, AsyncFunction>,
+    propertyKey: P
+  ) {
+    Reflect.defineMetadata(
+      HTTP_EXCHANGE_METADATA,
+      { method, url },
+      target,
+      propertyKey
+    );
+  };
+}
+
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+export const GetExchange = (url = "") => HttpExchange("GET", url);
+export const PostExchange = (url = "") => HttpExchange("POST", url);
+export const PutExchange = (url = "") => HttpExchange("PUT", url);
+export const DeleteExchange = (url = "") => HttpExchange("DELETE", url);
+export const PatchExchange = (url = "") => HttpExchange("PATCH", url);
+export const HeadExchange = (url = "") => HttpExchange("HEAD", url);
+export const OptionsExchange = (url = "") => HttpExchange("OPTIONS", url);

lib/decorators/index.ts

@@ -1,2 +1,3 @@
 export * from "./http-interface.decorator";
+export * from "./http-exchange.decorator";
 export * from "./constants";