feat: add http interface decorator

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

Author: jbl428

.eslintrc.yml

@@ -5,7 +5,11 @@ extends:
   - standard-with-typescript
   - plugin:@typescript-eslint/recommended
   - plugin:prettier/recommended
-overrides: [ ]
+overrides:
+  - files: [ 'vitest.config.ts', 'global.vitest.ts' ]
+    parser: '@typescript-eslint/parser'
+    parserOptions:
+      project: 'tsconfig.spec.json'
 parserOptions:
   project: 'tsconfig.json'
   ecmaVersion: latest

global.vitest.ts

@@ -0,0 +1 @@
+import "reflect-metadata";

lib/decorators/constants.ts

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

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

@@ -0,0 +1,29 @@
+import { describe, test, expect } from "vitest";
+import { HTTP_INTERFACE_METADATA } from "./constants";
+import { HttpInterface } from "./http-interface.decorator";
+
+describe("HttpInterface", () => {
+  test("should set default url metadata", () => {
+    // given
+    @HttpInterface()
+    class TestService {}
+
+    // when
+    const result = Reflect.getMetadata(HTTP_INTERFACE_METADATA, TestService);
+
+    // then
+    expect(result).toBe("");
+  });
+
+  test("should set provided url metadata", () => {
+    // given
+    @HttpInterface("/api/v1/sample")
+    class TestService {}
+
+    // when
+    const result = Reflect.getMetadata(HTTP_INTERFACE_METADATA, TestService);
+
+    // then
+    expect(result).toBe("/api/v1/sample");
+  });
+});

lib/decorators/http-interface.decorator.ts

@@ -0,0 +1,7 @@
+import { HTTP_INTERFACE_METADATA } from "./constants";
+
+export function HttpInterface(url = ""): ClassDecorator {
+  return (target) => {
+    Reflect.defineMetadata(HTTP_INTERFACE_METADATA, url, target);
+  };
+}

lib/decorators/index.ts

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

lib/index.ts

@@ -1 +1,2 @@
+export * from "./decorators";
 export * from "./http-interface.module";

tsconfig.spec.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["vitest.config.ts", "global.vitest.ts"],
+}

vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: "./global.vitest.ts",
+  },
+});