feat: add bearer decorator

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

Author: jbl428

lib/builders/request-header.builder.spec.ts

@@ -4,7 +4,10 @@ import { RequestHeaderBuilder } from './request-header.builder';
 describe('RequestHeaderBuilder', () => {
   test('should build header with explicit key', () => {
     // given
-    const builder = new RequestHeaderBuilder(0, 'keyword');
+    const builder = new RequestHeaderBuilder({
+      parameterIndex: 0,
+      key: 'keyword',
+    });
     const args = ['search'];
 
     // when
@@ -16,7 +19,11 @@ describe('RequestHeaderBuilder', () => {
 
   test('should build header with explicit key and default', () => {
     // given
-    const builder = new RequestHeaderBuilder(0, 'keyword', 'search');
+    const builder = new RequestHeaderBuilder({
+      parameterIndex: 0,
+      key: 'keyword',
+      defaultValue: 'search',
+    });
     const args = [null];
 
     // when
@@ -28,7 +35,9 @@ describe('RequestHeaderBuilder', () => {
 
   test('should build header without key', () => {
     // given
-    const builder = new RequestHeaderBuilder(1);
+    const builder = new RequestHeaderBuilder({
+      parameterIndex: 1,
+    });
     const args = ['invalid', { foo: 'bar' }];
 
     // when
@@ -37,4 +46,20 @@ describe('RequestHeaderBuilder', () => {
     // then
     expect(actual).toEqual({ foo: 'bar' });
   });
+
+  test('should apply transform function to args', () => {
+    // given
+    const builder = new RequestHeaderBuilder({
+      parameterIndex: 0,
+      key: 'keyword',
+      transform: (value) => value.toUpperCase(),
+    });
+    const args = ['search'];
+
+    // when
+    const actual = builder.build(args);
+
+    // then
+    expect(actual).toEqual({ keyword: 'SEARCH' });
+  });
 });

lib/builders/request-header.builder.ts

@@ -1,30 +1,27 @@
 import { TupleArrayBuilder } from './tuple-array.builder';
+import { type ParamDecoratorOption } from '../types/param-decorator-option.interface';
 
 export class RequestHeaderBuilder {
-  metadata: Array<
-    [
-      index: number,
-      value: [key: string | undefined, defaultValue: string | undefined],
-    ]
-  > = [];
+  metadata: Array<ParamDecoratorOption<string, string>> = [];
 
-  constructor(index: number, key?: string, defaultValue?: string) {
-    this.add(index, key, defaultValue);
+  constructor(option: ParamDecoratorOption<string, string>) {
+    this.add(option);
   }
 
-  add(index: number, key?: string, defaultValue?: string): void {
-    this.metadata.push([index, [key, defaultValue]]);
+  add(option: ParamDecoratorOption<string, string>): void {
+    this.metadata.push(option);
   }
 
   build(args: any[]): HeadersInit {
     return this.metadata.reduce<Record<string, string>>(
-      (acc, [index, [key, defaultValue]]) => {
+      (acc, { parameterIndex, key, defaultValue, transform }) => {
         if (key != null) {
-          acc[key] = String(args[index] ?? defaultValue ?? '');
+          const value = String(args[parameterIndex] ?? defaultValue ?? '');
+          acc[key] = transform != null ? transform(value) : value;
           return acc;
         }
 
-        TupleArrayBuilder.of<string, unknown>(args[index]).forEach(
+        TupleArrayBuilder.of<string, unknown>(args[parameterIndex]).forEach(
           ([key, value]) => {
             acc[key] = String(value);
           },

lib/decorators/index.ts

@@ -6,3 +6,4 @@ export * from './request-header.decorator';
 export * from './request-param.decorator';
 export * from './request-form.decorator';
 export * from './constants';
+export * from './utils';

lib/decorators/request-body.decorator.ts

@@ -1,6 +1,11 @@
 import { REQUEST_BODY_METADATA } from './constants';
 import { RequestBodyBuilder } from '../builders/request-body.builder';
 
+export function RequestBody(key?: string): ParameterDecorator;
+export function RequestBody(
+  key: string,
+  defaultValue?: unknown,
+): ParameterDecorator;
 export function RequestBody(
   key?: string,
   defaultValue?: unknown,

lib/decorators/request-form.decorator.ts

@@ -1,6 +1,11 @@
 import { REQUEST_FORM_METADATA } from './constants';
 import { RequestFormBuilder } from '../builders/request-form.builder';
 
+export function RequestForm(key?: string): ParameterDecorator;
+export function RequestForm(
+  key: string,
+  defaultValue?: string,
+): ParameterDecorator;
 export function RequestForm(
   key?: string,
   defaultValue?: string,

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

@@ -40,7 +40,14 @@ describe('RequestHeader', () => {
     );
 
     // then
-    expect(result.metadata).toEqual([[0, [undefined, undefined]]]);
+    expect(result.metadata).toMatchInlineSnapshot(`
+      [
+        {
+          "key": undefined,
+          "parameterIndex": 0,
+        },
+      ]
+    `);
   });
 
   test('should set request header metadata with key', () => {
@@ -59,14 +66,21 @@ describe('RequestHeader', () => {
     );
 
     // then
-    expect(result.metadata).toEqual([[0, ['foo', undefined]]]);
+    expect(result.metadata).toMatchInlineSnapshot(`
+      [
+        {
+          "key": "foo",
+          "parameterIndex": 0,
+        },
+      ]
+    `);
   });
 
   test('should set request header metadata with multiple decorator', () => {
     // given
     class TestService {
       request(
-        @RequestHeader('foo', 'default') foo: string,
+        @RequestHeader('foo', { defaultValue: 'default' }) foo: string,
         @RequestHeader() bar: { bar: string },
       ): string {
         return foo;
@@ -81,9 +95,18 @@ describe('RequestHeader', () => {
     );
 
     // then
-    expect(result.metadata).toEqual([
-      [1, [undefined, undefined]],
-      [0, ['foo', 'default']],
-    ]);
+    expect(result.metadata).toMatchInlineSnapshot(`
+      [
+        {
+          "key": undefined,
+          "parameterIndex": 1,
+        },
+        {
+          "defaultValue": "default",
+          "key": "foo",
+          "parameterIndex": 0,
+        },
+      ]
+    `);
   });
 });

lib/decorators/request-header.decorator.ts

@@ -1,9 +1,14 @@
 import { REQUEST_HEADER_METADATA } from './constants';
 import { RequestHeaderBuilder } from '../builders/request-header.builder';
 
+export function RequestHeader(key?: string): ParameterDecorator;
+export function RequestHeader(
+  key: string,
+  option?: { defaultValue?: string; transform?: (value: string) => string },
+): ParameterDecorator;
 export function RequestHeader(
   key?: string,
-  defaultValue?: string,
+  option?: { defaultValue?: string; transform?: (value: string) => string },
 ): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
     if (propertyKey == null) {
@@ -17,13 +22,13 @@ export function RequestHeader(
     );
 
     if (builder != null) {
-      builder.add(parameterIndex, key, defaultValue);
+      builder.add({ parameterIndex, key, ...option });
       return;
     }
 
     Reflect.defineMetadata(
       REQUEST_HEADER_METADATA,
-      new RequestHeaderBuilder(parameterIndex, key, defaultValue),
+      new RequestHeaderBuilder({ parameterIndex, key, ...option }),
       target,
       propertyKey,
     );

lib/decorators/utils/bearer.decorator.spec.ts

@@ -0,0 +1,27 @@
+import { describe, expect, test } from 'vitest';
+import { Bearer } from './bearer.decorator';
+import { type RequestHeaderBuilder } from '../../builders/request-header.builder';
+import { REQUEST_HEADER_METADATA } from '../constants';
+
+describe('Bearer', () => {
+  test('should set request header metadata with key', () => {
+    // given
+    class TestService {
+      request(@Bearer() token: string): string {
+        return token;
+      }
+    }
+
+    // when
+    const result: RequestHeaderBuilder = Reflect.getMetadata(
+      REQUEST_HEADER_METADATA,
+      TestService.prototype,
+      'request',
+    );
+
+    // then
+    expect(result.metadata).toHaveLength(1);
+    expect(result.metadata[0].key).toBe('Authorization');
+    expect(result.metadata[0].transform?.('token')).toBe('Bearer token');
+  });
+});

lib/decorators/utils/bearer.decorator.ts

@@ -0,0 +1,7 @@
+import { RequestHeader } from '../request-header.decorator';
+
+export function Bearer(): ParameterDecorator {
+  return RequestHeader('Authorization', {
+    transform: (value) => `Bearer ${value}`,
+  });
+}

lib/decorators/utils/index.ts

@@ -0,0 +1 @@
+export * from './bearer.decorator';