@e22m4u/ts-rest-router 0.0.6 → 0.0.7

package/src/decorators/request-data/request-data-decorator.spec.ts

@@ -13,23 +13,24 @@ import {headers} from './request-data-decorator.js';
 import {bodyParam} from './request-data-decorator.js';
 import {requestData} from './request-data-decorator.js';
 import {RequestDataSource} from './request-data-metadata.js';
-import {RequestDataMetadata} from './request-data-metadata.js';
 import {RequestDataReflector} from './request-data-reflector.js';
 
 describe('requestData', function () {
-  it('sets a given argument to the target metadata', function () {
-    const md: RequestDataMetadata = {
-      source: RequestDataSource.PARAMS,
+  it('sets given options to the target metadata', function () {
+    const options = {
+      source: RequestDataSource.BODY,
+      schema: {type: DataType.STRING},
+      property: 'prop',
       customOption: 'myOption',
     };
     class Target {
       myMethod(
-        @requestData(md)
+        @requestData(options)
         prop: unknown,
       ) {}
     }
     const res = RequestDataReflector.getMetadata(Target, 'myMethod');
-    expect(res.get(0)).to.be.eql(md);
+    expect(res.get(0)).to.be.eql(options);
   });
 
   describe('request data by a given source', function () {

package/src/decorators/request-data/request-data-decorator.ts

@@ -9,12 +9,17 @@ import {RequestDataSource} from './request-data-metadata.js';
 import {RequestDataMetadata} from './request-data-metadata.js';
 import {RequestDataReflector} from './request-data-reflector.js';
 
+/**
+ * Request data options.
+ */
+export type RequestDataOptions = RequestDataMetadata;
+
 /**
  * Request data decorator.
  *
- * @param metadata
+ * @param options
  */
-export function requestData<T extends object>(metadata: RequestDataMetadata) {
+export function requestData<T extends object>(options: RequestDataOptions) {
   return function (
     target: Prototype<T>,
     propertyKey: string,
@@ -31,7 +36,7 @@ export function requestData<T extends object>(metadata: RequestDataMetadata) {
           'on an instance method parameter.',
       );
     RequestDataReflector.setMetadata(
-      metadata,
+      options,
       target.constructor as Constructor<T>,
       indexOrDescriptor,
       propertyKey,
@@ -40,11 +45,11 @@ export function requestData<T extends object>(metadata: RequestDataMetadata) {
 }
 
 /**
- * Create data decorator.
+ * Create request data decorator with source.
  *
  * @param source
  */
-function createDataDecorator(source: RequestDataSource) {
+function createRequestDataDecoratorWithSource(source: RequestDataSource) {
   return function () {
     const schema = {type: DataType.OBJECT};
     return requestData({schema, source});
@@ -52,11 +57,13 @@ function createDataDecorator(source: RequestDataSource) {
 }
 
 /**
- * Create property decorator.
+ * Create request data property decorator with source.
  *
  * @param source
  */
-function createPropertyDecorator(source: RequestDataSource) {
+function createRequestDataPropertyDecoratorWithSource(
+  source: RequestDataSource,
+) {
   return function (propertyKey: string, schemaOrType?: DataSchema | DataType) {
     const properties = {} as NoUndef<DataSchema['properties']>;
     const rootSchema: DataSchema = {type: DataType.OBJECT};
@@ -78,15 +85,33 @@ function createPropertyDecorator(source: RequestDataSource) {
 /**
  * Decorator aliases.
  */
-export const params = createDataDecorator(RequestDataSource.PARAMS);
-export const param = createPropertyDecorator(RequestDataSource.PARAMS);
-export const queries = createDataDecorator(RequestDataSource.QUERY);
-export const query = createPropertyDecorator(RequestDataSource.QUERY);
-export const headers = createDataDecorator(RequestDataSource.HEADERS);
-export const header = createPropertyDecorator(RequestDataSource.HEADERS);
-export const cookies = createDataDecorator(RequestDataSource.COOKIE);
-export const cookie = createPropertyDecorator(RequestDataSource.COOKIE);
-export const bodyParam = createPropertyDecorator(RequestDataSource.BODY);
+export const params = createRequestDataDecoratorWithSource(
+  RequestDataSource.PARAMS,
+);
+export const param = createRequestDataPropertyDecoratorWithSource(
+  RequestDataSource.PARAMS,
+);
+export const queries = createRequestDataDecoratorWithSource(
+  RequestDataSource.QUERY,
+);
+export const query = createRequestDataPropertyDecoratorWithSource(
+  RequestDataSource.QUERY,
+);
+export const headers = createRequestDataDecoratorWithSource(
+  RequestDataSource.HEADERS,
+);
+export const header = createRequestDataPropertyDecoratorWithSource(
+  RequestDataSource.HEADERS,
+);
+export const cookies = createRequestDataDecoratorWithSource(
+  RequestDataSource.COOKIE,
+);
+export const cookie = createRequestDataPropertyDecoratorWithSource(
+  RequestDataSource.COOKIE,
+);
+export const bodyParam = createRequestDataPropertyDecoratorWithSource(
+  RequestDataSource.BODY,
+);
 
 /**
  * Request body decorator.

package/src/decorators/request-data/request-data-metadata.ts

@@ -19,7 +19,6 @@ export type RequestDataMetadata = {
   source: RequestDataSource;
   schema?: DataSchema;
   property?: string;
-  [option: string]: unknown | undefined;
 };
 
 /**