refactor: change primitive map to metadata map

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

Author: jbl428

lib/decorators/path-variable.decorator.ts

@@ -1,6 +1,7 @@
 import { PATH_VARIABLE_METADATA } from "./constants";
+import { MetadataMap } from "../types/metadata-map";
 
-export type PathVariableMetadata = Map<number, string>;
+export type PathVariableMetadata = MetadataMap<number, string>;
 
 export function PathVariable(name: string): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
@@ -10,7 +11,7 @@ export function PathVariable(name: string): ParameterDecorator {
 
     const metadata: PathVariableMetadata =
       Reflect.getMetadata(PATH_VARIABLE_METADATA, target, propertyKey) ??
-      new Map();
+      new MetadataMap();
 
     metadata.set(parameterIndex, name);
 

lib/decorators/request-body.decorator.ts

@@ -1,4 +1,5 @@
 import { REQUEST_BODY_METADATA } from "./constants";
+import { MetadataMap } from "../types/metadata-map";
 
 export type RequestBodyMetadata = Map<number, string | undefined>;
 
@@ -10,7 +11,7 @@ export function RequestBody(key?: string): ParameterDecorator {
 
     const metadata =
       Reflect.getMetadata(REQUEST_BODY_METADATA, target, propertyKey) ??
-      new Map();
+      new MetadataMap();
 
     metadata.set(parameterIndex, key);
 

lib/decorators/request-form.decorator.ts

@@ -1,6 +1,7 @@
 import { REQUEST_FORM_METADATA } from "./constants";
+import { MetadataMap } from "../types/metadata-map";
 
-export type RequestFromMetadata = Map<number, string | undefined>;
+export type RequestFromMetadata = MetadataMap<number, string | undefined>;
 
 export function RequestForm(key?: string): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
@@ -10,7 +11,7 @@ export function RequestForm(key?: string): ParameterDecorator {
 
     const metadata =
       Reflect.getMetadata(REQUEST_FORM_METADATA, target, propertyKey) ??
-      new Map();
+      new MetadataMap();
 
     metadata.set(parameterIndex, key);
 

lib/decorators/request-header.decorator.ts

@@ -1,6 +1,7 @@
 import { REQUEST_HEADER_METADATA } from "./constants";
+import { MetadataMap } from "../types/metadata-map";
 
-export type RequestHeaderMetadata = Map<number, string>;
+export type RequestHeaderMetadata = MetadataMap<number, string>;
 
 export function RequestHeader(key?: string): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
@@ -10,7 +11,7 @@ export function RequestHeader(key?: string): ParameterDecorator {
 
     const metadata =
       Reflect.getMetadata(REQUEST_HEADER_METADATA, target, propertyKey) ??
-      new Map();
+      new MetadataMap();
 
     metadata.set(parameterIndex, key);
 

lib/decorators/request-param.decorator.ts

@@ -1,6 +1,7 @@
 import { REQUEST_PARAM_METADATA } from "./constants";
+import { MetadataMap } from "../types/metadata-map";
 
-export type RequestParamMetadata = Map<number, string | undefined>;
+export type RequestParamMetadata = MetadataMap<number, string | undefined>;
 
 export function RequestParam(key?: string): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
@@ -10,7 +11,7 @@ export function RequestParam(key?: string): ParameterDecorator {
 
     const metadata =
       Reflect.getMetadata(REQUEST_PARAM_METADATA, target, propertyKey) ??
-      new Map();
+      new MetadataMap();
 
     metadata.set(parameterIndex, key);
 

lib/types/metadata-map.ts

@@ -0,0 +1,7 @@
+import { TupleArrayBuilder } from "../utils/tuple-array-builder";
+
+export class MetadataMap<K, V> extends Map<K, V> {
+  toArray(): Array<[K, V]> {
+    return TupleArrayBuilder.of(this);
+  }
+}

lib/utils/tuple-array-builder.ts

@@ -0,0 +1,17 @@
+export class TupleArrayBuilder {
+  static of<A, B>(value: unknown): Array<[A, B]> {
+    if (typeof value === "undefined") {
+      return [];
+    }
+
+    if (value instanceof Map) {
+      return [...value.entries()];
+    }
+
+    if (typeof value === "object" && value !== null) {
+      return Object.entries(value) as Array<[A, B]>;
+    }
+
+    return [];
+  }
+}

lib/utils/url-builder.spec.ts

@@ -4,6 +4,7 @@ import {
   type PathVariableMetadata,
   type RequestParamMetadata,
 } from "../decorators";
+import { MetadataMap } from "../types/metadata-map";
 
 describe("URLBuilder", () => {
   test("should build with base url", () => {
@@ -25,7 +26,7 @@ describe("URLBuilder", () => {
     const host = "https://example.com";
     const path = "api/users/{id}";
     const args = [1, 2];
-    const pathParam: PathVariableMetadata = new Map([[1, "id"]]);
+    const pathParam: PathVariableMetadata = new MetadataMap([[1, "id"]]);
     const urlBuilder = new URLBuilder(host, path, args, { pathParam });
 
     // when
@@ -40,7 +41,7 @@ describe("URLBuilder", () => {
     const host = "https://example.com";
     const path = "";
     const args = ["search"];
-    const queryParam: RequestParamMetadata = new Map([[0, "keyword"]]);
+    const queryParam: RequestParamMetadata = new MetadataMap([[0, "keyword"]]);
     const urlBuilder = new URLBuilder(host, path, args, { queryParam });
 
     // when
@@ -55,7 +56,7 @@ describe("URLBuilder", () => {
     const host = "https://example.com";
     const path = "api/user";
     const args = [{ keyword: "search" }];
-    const queryParam: RequestParamMetadata = new Map([[0, undefined]]);
+    const queryParam: RequestParamMetadata = new MetadataMap([[0, undefined]]);
     const urlBuilder = new URLBuilder(host, path, args, { queryParam });
 
     // when

lib/utils/url-builder.ts

@@ -1,3 +1,4 @@
+import { TupleArrayBuilder } from "./tuple-array-builder";
 import {
   type PathVariableMetadata,
   type RequestParamMetadata,
@@ -20,8 +21,8 @@ export class URLBuilder {
       this.host = this.path;
       this.path = "";
     }
-    this.#pathParams = this.toArray(metadata.pathParam);
-    this.#queryParams = this.toArray(metadata.queryParam);
+    this.#pathParams = metadata.pathParam?.toArray() ?? [];
+    this.#queryParams = metadata.queryParam?.toArray() ?? [];
   }
 
   build(): string {
@@ -48,7 +49,7 @@ export class URLBuilder {
         return;
       }
 
-      this.toArray<string, unknown>(this.args[paramIndex]).forEach(
+      TupleArrayBuilder.of<string, unknown>(this.args[paramIndex]).forEach(
         ([key, value]) => {
           searchParams.set(key, `${value?.toString() ?? ""}`);
         }
@@ -79,20 +80,4 @@ export class URLBuilder {
   private replaceSlash(url: string): string {
     return url.replace(/\/{2,}/g, "/");
   }
-
-  private toArray<A, B>(value: unknown): Array<[A, B]> {
-    if (typeof value === "undefined") {
-      return [];
-    }
-
-    if (value instanceof Map) {
-      return [...value.entries()];
-    }
-
-    if (typeof value === "object" && value !== null) {
-      return Object.entries(value) as Array<[A, B]>;
-    }
-
-    return [];
-  }
 }