@e22m4u/ts-rest-router 0.2.0 → 0.2.2

package/README.md

@@ -10,6 +10,16 @@ REST маршрутизатор на основе контроллеров дл
 - Валидация входящих данных.
 - Поддержка всех HTTP методов (GET, POST, PUT, PATCH и DELETE).
 
+## Содержание
+
+- [Установка](#установка)
+  - [Поддержка декораторов](#поддержка-декораторов)
+- [Базовый пример](#базовый-пример)
+- [Валидация](#валидация)
+- [Декораторы](#декораторы)
+- [Отладка](#отладка)
+- [Тесты](#тесты)
+
 ## Установка
 
 ```bash
@@ -28,7 +38,7 @@ npm install @e22m4u/ts-rest-router
 }
 ```
 
-## Базовое использование
+## Базовый пример
 
 Создание контроллера и методов.
 
@@ -39,24 +49,25 @@ import {postAction} from '@e22m4u/ts-rest-router';
 import {requestField} from '@e22m4u/ts-rest-router';
 import {restController} from '@e22m4u/ts-rest-router';
 
-@restController('/users')       // путь контроллера
-class UserController {          // класс контроллера
-  @postAction('/login')         // метод POST /users/login
+// объявление контроллера
+// и базового пути /users
+@restController('users')
+class UserController {
+  // объявление метода POST /users/login
+  // (использует базовый путь контроллера)
+  @postAction('login')
   async login(
-    @requestField('username', { // поле "username" в теле запроса
-      type: DataType.STRING,    // тип параметра допускает только строки
-      required: true,           // параметр является обязательным
-    })
-    username: string,
-    @requestField('password', { // поле "password" в теле запроса
-      type: DataType.STRING,    // тип параметра допускает только строки
-      required: true,           // параметр является обязательным
-    })
-    password: string,
+    // инъекция значений указанных полей
+    // извлеизвлекаемых из тела запроса
+    @requestField('username') username?: string,
+    @requestField('password') password?: string,
   ) {
-    return {                  // если метод возвращает объект,
-      id: '123',              // то результат будет представлен как
-      firstName: 'John',      // "Content-Type: application/json"
+    // так как метод возвращает объект,
+    // результат будет представлен как
+    // "Content-Type: application/json"
+    return {
+      id: 1,
+      firstName: 'John',
       lastName: 'Doe',
     };
   }
@@ -84,6 +95,90 @@ server.listen('8080', '0.0.0.0', () => {
 });
 ```
 
+## Валидация
+
+Указанные ниже декораторы используются для инъекции соответствующих параметров
+запроса в качестве аргументов метода контроллера. Каждый из указанных декораторов
+имеет параметр `schemaOrType`, в котором определяется тип ожидаемого значения
+или схема для проверки данных.
+
+- `@requestParam(name: string, schemaOrType?: DataSchema | DataType)`  
+  *- извлечение URL параметра по названию;*
+- `@requestQuery(name: string, schemaOrType?: DataSchema | DataType)`  
+  *- извлечение query параметра по названию;*
+- `@requestBody(schemaOrType?: DataSchema | DataType)`  
+  *- извлечение тела запроса;*
+- `@requestField(name: string, schemaOrType?: DataSchema | DataType)`  
+  *- извлечение свойства из тела запроса;*
+- `@requestHeader(name: string, schemaOrType?: DataSchema | DataType)`  
+  *- извлечение заголовка запроса по названию;*
+- `@requestCookie(name: string, schemaOrType?: DataSchema | DataType)`  
+  *- извлечение cookie запроса по названию;*
+
+Проверка входящих данных выполняется встроенным модулем
+[@e22m4u/ts-data-schema](https://www.npmjs.com/package/@e22m4u/ts-data-schema)
+(не требует установки). Ниже приводятся константы для определения допустимых
+типов извлекаемого значения.
+
+- `DataType.ANY` - принимает любой тип
+- `DataType.STRING` - строковые значения
+- `DataType.NUMBER` - числовые значения
+- `DataType.BOOLEAN` - логические значения
+- `DataType.ARRAY` - массивы
+- `DataType.OBJECT` - объекты (не экземпляры)
+
+Для определения дополнительных условий, используется объект `DataSchema`,
+с помощью которого можно определить структуру ожидаемого объекта, допустимые
+элементы массива, функции-валидаторы и другие ограничения входящих данных.
+
+```ts
+type DataSchema = {
+  type: DataType;
+  items?: DataSchema;
+  properties?: {[key: string]: DataSchema};
+  required?: boolean;
+  validate?: CallableValidator | CallableValidator[];
+  default?: unknown;
+}
+```
+
+Пример проверки передаваемого объекта методом POST:
+
+```ts
+import {DataType} from '@e22m4u/ts-rest-router';
+import {getAction} from '@e22m4u/ts-rest-router';
+import {postAction} from '@e22m4u/ts-rest-router';
+import {requestField} from '@e22m4u/ts-rest-router';
+import {restController} from '@e22m4u/ts-rest-router';
+
+@restController('users')
+class UserController {
+  @postAction()                        // POST /users
+  async create(
+    @requestBody({                     // декоратор тела запроса
+      type: DataType.OBJECT,           // в теле запроса ожидается объект
+      properties: {
+        name: {                        // схема свойства "name"
+          type: DataType.STRING,       // свойство должно содержать строку
+          required: true,              // свойство не может содержать undefined или null
+          validate: v => v.length > 2, // проверка длины строки
+        },
+        age: {                         // схема свойства "age"
+          type: DataType.NUMBER,       // свойство должно являться числом
+        }
+      },
+    })
+    body: {name: string, age?: number},
+  ) {
+    return {
+      id: 1,
+      name: body.name,
+      age: body.age,
+    };
+  }
+}
+```
+
 ## Декораторы
 
 Контроллер и методы:
@@ -125,16 +220,16 @@ server.listen('8080', '0.0.0.0', () => {
 ```ts
 @restController()
 class UserController {
-  // методы контроллера
+  // ...
 }
 ```
 
-Определение пути контроллера.
+Определение базового пути.
 
 ```ts
-@restController('/users')  // путь контроллера
+@restController('users')
 class UserController {
-  // методы контроллера
+  // ...
 }
 ```
 
@@ -142,12 +237,12 @@ class UserController {
 
 ```ts
 @restController({
-  path: '/api',              // путь контроллера
+  path: 'api',               // базовый путь
   before: [authMiddleware],  // middleware до обработки запроса
   after: [loggerMiddleware], // middleware после обработки запроса
 })
 class UserController {
-  // методы контроллера
+  // ...
 }
 ```
 
@@ -156,9 +251,9 @@ class UserController {
 Определение метода GET.
 
 ```ts
-@restController('/users') // путь контроллера
-class UserController {    // класс контроллера
-  @getAction('/whoAmI')   // маршрут GET /users/whoAmI
+@restController('users')
+class UserController {
+  @getAction('whoAmI')   // маршрут GET /users/whoAmI
   async whoAmI() {
     return {              // если метод возвращает объект,
       name: 'John',       // то результат будет представлен
@@ -171,9 +266,9 @@ class UserController {    // класс контроллера
 Дополнительные параметры декоратора.
 
 ```ts
-@restController('/users')      // путь контроллера
-class UserController {         // класс контроллера
-  @getAction('/whoAmI', {      // маршрут GET /users/whoAmI
+@restController('users')
+class UserController {
+  @getAction('whoAmI', {      // маршрут GET /users/whoAmI
     before: [authMiddleware],  // middleware до обработки запроса
     after: [loggerMiddleware], // middleware после обработки запроса
   })
@@ -193,12 +288,12 @@ class UserController {         // класс контроллера
 ```ts
 import {RequestContext} from '@e22m4u/js-trie-router';
 
-@restController('/users')      // путь контроллера
-class UserController {         // класс контроллера
-  @getAction('/:id')           // маршрут GET /users/:id
+@restController('users')
+class UserController {
+  @getAction(':id')
   findById(
-    @requestContext()          // включениее контекста запроса
-    ctx: RequestContext,       // в качестве параметра метода
+    @requestContext()          // инъекция контекста запроса
+    ctx: RequestContext,       // в качестве аргумента
   ) {
     console.log(ctx.req);      // IncomingMessage
     console.log(ctx.res);      // ServerResponse

package/dist/cjs/index.cjs

@@ -29,11 +29,13 @@ __export(index_exports, {
   NotAControllerError: () => NotAControllerError,
   REQUEST_CONTEXT_METADATA_KEY: () => REQUEST_CONTEXT_METADATA_KEY,
   REQUEST_DATA_METADATA_KEY: () => REQUEST_DATA_METADATA_KEY,
+  RESPONSE_BODY_METADATA_KEY: () => RESPONSE_BODY_METADATA_KEY,
   REST_ACTIONS_METADATA_KEY: () => REST_ACTIONS_METADATA_KEY,
   REST_CONTROLLER_METADATA_KEY: () => REST_CONTROLLER_METADATA_KEY,
   RequestContextReflector: () => RequestContextReflector,
   RequestDataReflector: () => RequestDataReflector,
   RequestDataSource: () => RequestDataSource,
+  ResponseBodyReflector: () => ResponseBodyReflector,
   RestActionReflector: () => RestActionReflector,
   RestControllerReflector: () => RestControllerReflector,
   RestRouter: () => RestRouter,
@@ -60,6 +62,7 @@ __export(index_exports, {
   requestParams: () => requestParams,
   requestQueries: () => requestQueries,
   requestQuery: () => requestQuery,
+  responseBody: () => responseBody,
   restAction: () => restAction,
   restController: () => restController,
   toCamelCase: () => toCamelCase
@@ -281,11 +284,11 @@ var RequestDataReflector = _RequestDataReflector;
 
 // dist/esm/decorators/request-data/request-data-decorator.js
 function requestData(options) {
-  return function(target, propertyKey, indexOrDescriptor) {
-    const decoratorType = (0, import_ts_reflector8.getDecoratorTargetType)(target, propertyKey, indexOrDescriptor);
+  return function(target, propertyKey, index) {
+    const decoratorType = (0, import_ts_reflector8.getDecoratorTargetType)(target, propertyKey, index);
     if (decoratorType !== import_ts_reflector7.DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
       throw new Error("@requestData decorator is only supported on an instance method parameter.");
-    RequestDataReflector.setMetadata(options, target.constructor, indexOrDescriptor, propertyKey);
+    RequestDataReflector.setMetadata(options, target.constructor, index, propertyKey);
   };
 }
 __name(requestData, "requestData");
@@ -437,16 +440,70 @@ function beforeAction(middleware) {
 }
 __name(beforeAction, "beforeAction");
 
-// dist/esm/decorators/rest-controller/rest-controller-metadata.js
+// dist/esm/decorators/response-body/response-body-metadata.js
 var import_ts_reflector17 = require("@e22m4u/ts-reflector");
-var REST_CONTROLLER_METADATA_KEY = new import_ts_reflector17.MetadataKey("restControllerMetadataKey");
+var RESPONSE_BODY_METADATA_KEY = new import_ts_reflector17.MetadataKey("responseBodyMetadataKey");
 
-// dist/esm/decorators/rest-controller/rest-controller-decorator.js
+// dist/esm/decorators/response-body/response-body-decorator.js
 var import_ts_reflector19 = require("@e22m4u/ts-reflector");
 var import_ts_reflector20 = require("@e22m4u/ts-reflector");
 
-// dist/esm/decorators/rest-controller/rest-controller-reflector.js
+// dist/esm/decorators/response-body/response-body-reflector.js
 var import_ts_reflector18 = require("@e22m4u/ts-reflector");
+var _ResponseBodyReflector = class _ResponseBodyReflector {
+  /**
+   * Set metadata.
+   *
+   * @param metadata
+   * @param target
+   * @param propertyKey
+   */
+  static setMetadata(metadata, target, propertyKey) {
+    const oldMap = import_ts_reflector18.Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+    const newMap = new Map(oldMap);
+    newMap.set(propertyKey, metadata);
+    import_ts_reflector18.Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, newMap, target);
+  }
+  /**
+   * Get metadata.
+   *
+   * @param target
+   */
+  static getMetadata(target) {
+    const metadata = import_ts_reflector18.Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+    return metadata ?? /* @__PURE__ */ new Map();
+  }
+};
+__name(_ResponseBodyReflector, "ResponseBodyReflector");
+var ResponseBodyReflector = _ResponseBodyReflector;
+
+// dist/esm/decorators/response-body/response-body-decorator.js
+function responseBody(schemaOrType) {
+  return function(target, propertyKey, descriptor) {
+    const decoratorType = (0, import_ts_reflector20.getDecoratorTargetType)(target, propertyKey, descriptor);
+    if (decoratorType !== import_ts_reflector19.DecoratorTargetType.INSTANCE_METHOD)
+      throw new Error("@responseBody decorator is only supported on an instance method.");
+    let schema;
+    if (typeof schemaOrType === "object") {
+      schema = schemaOrType;
+    } else if (typeof schemaOrType === "string") {
+      schema = { type: schemaOrType };
+    }
+    ResponseBodyReflector.setMetadata(schema ? { schema } : {}, target.constructor, propertyKey);
+  };
+}
+__name(responseBody, "responseBody");
+
+// dist/esm/decorators/rest-controller/rest-controller-metadata.js
+var import_ts_reflector21 = require("@e22m4u/ts-reflector");
+var REST_CONTROLLER_METADATA_KEY = new import_ts_reflector21.MetadataKey("restControllerMetadataKey");
+
+// dist/esm/decorators/rest-controller/rest-controller-decorator.js
+var import_ts_reflector23 = require("@e22m4u/ts-reflector");
+var import_ts_reflector24 = require("@e22m4u/ts-reflector");
+
+// dist/esm/decorators/rest-controller/rest-controller-reflector.js
+var import_ts_reflector22 = require("@e22m4u/ts-reflector");
 var _RestControllerReflector = class _RestControllerReflector {
   /**
    * Set metadata.
@@ -455,7 +512,7 @@ var _RestControllerReflector = class _RestControllerReflector {
    * @param target
    */
   static setMetadata(metadata, target) {
-    return import_ts_reflector18.Reflector.defineMetadata(REST_CONTROLLER_METADATA_KEY, metadata, target);
+    return import_ts_reflector22.Reflector.defineMetadata(REST_CONTROLLER_METADATA_KEY, metadata, target);
   }
   /**
    * Get metadata.
@@ -463,7 +520,7 @@ var _RestControllerReflector = class _RestControllerReflector {
    * @param target
    */
   static getMetadata(target) {
-    return import_ts_reflector18.Reflector.getOwnMetadata(REST_CONTROLLER_METADATA_KEY, target);
+    return import_ts_reflector22.Reflector.getOwnMetadata(REST_CONTROLLER_METADATA_KEY, target);
   }
 };
 __name(_RestControllerReflector, "RestControllerReflector");
@@ -472,8 +529,8 @@ var RestControllerReflector = _RestControllerReflector;
 // dist/esm/decorators/rest-controller/rest-controller-decorator.js
 function restController(pathOrOptions, options) {
   return function(target) {
-    const decoratorType = (0, import_ts_reflector20.getDecoratorTargetType)(target);
-    if (decoratorType !== import_ts_reflector19.DecoratorTargetType.CONSTRUCTOR)
+    const decoratorType = (0, import_ts_reflector24.getDecoratorTargetType)(target);
+    if (decoratorType !== import_ts_reflector23.DecoratorTargetType.CONSTRUCTOR)
       throw new Error("@restController decorator is only supported on a class.");
     if (typeof pathOrOptions === "string") {
       if (!options) {
@@ -490,15 +547,15 @@ function restController(pathOrOptions, options) {
 __name(restController, "restController");
 
 // dist/esm/decorators/request-context/request-context-metadata.js
-var import_ts_reflector21 = require("@e22m4u/ts-reflector");
-var REQUEST_CONTEXT_METADATA_KEY = new import_ts_reflector21.MetadataKey("requestContextMetadataKey");
+var import_ts_reflector25 = require("@e22m4u/ts-reflector");
+var REQUEST_CONTEXT_METADATA_KEY = new import_ts_reflector25.MetadataKey("requestContextMetadataKey");
 
 // dist/esm/decorators/request-context/request-context-decorator.js
-var import_ts_reflector23 = require("@e22m4u/ts-reflector");
-var import_ts_reflector24 = require("@e22m4u/ts-reflector");
+var import_ts_reflector27 = require("@e22m4u/ts-reflector");
+var import_ts_reflector28 = require("@e22m4u/ts-reflector");
 
 // dist/esm/decorators/request-context/request-context-reflector.js
-var import_ts_reflector22 = require("@e22m4u/ts-reflector");
+var import_ts_reflector26 = require("@e22m4u/ts-reflector");
 var _RequestContextReflector = class _RequestContextReflector {
   /**
    * Set metadata.
@@ -509,10 +566,10 @@ var _RequestContextReflector = class _RequestContextReflector {
    * @param propertyKey
    */
   static setMetadata(metadata, target, index, propertyKey) {
-    const oldMap = import_ts_reflector22.Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
+    const oldMap = import_ts_reflector26.Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
     const newMap = new Map(oldMap);
     newMap.set(index, metadata);
-    import_ts_reflector22.Reflector.defineMetadata(REQUEST_CONTEXT_METADATA_KEY, newMap, target, propertyKey);
+    import_ts_reflector26.Reflector.defineMetadata(REQUEST_CONTEXT_METADATA_KEY, newMap, target, propertyKey);
   }
   /**
    * Get metadata.
@@ -521,7 +578,7 @@ var _RequestContextReflector = class _RequestContextReflector {
    * @param propertyKey
    */
   static getMetadata(target, propertyKey) {
-    const metadata = import_ts_reflector22.Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
+    const metadata = import_ts_reflector26.Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
     return metadata ?? /* @__PURE__ */ new Map();
   }
 };
@@ -531,8 +588,8 @@ var RequestContextReflector = _RequestContextReflector;
 // dist/esm/decorators/request-context/request-context-decorator.js
 function requestContext(propertyName) {
   return function(target, propertyKey, indexOrDescriptor) {
-    const decoratorType = (0, import_ts_reflector24.getDecoratorTargetType)(target, propertyKey, indexOrDescriptor);
-    if (decoratorType !== import_ts_reflector23.DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
+    const decoratorType = (0, import_ts_reflector28.getDecoratorTargetType)(target, propertyKey, indexOrDescriptor);
+    if (decoratorType !== import_ts_reflector27.DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
       throw new Error("@requestContext decorator is only supported on an instance method parameter.");
     RequestContextReflector.setMetadata({ property: propertyName }, target.constructor, indexOrDescriptor, propertyKey);
   };
@@ -548,6 +605,7 @@ function httpResponse() {
 __name(httpResponse, "httpResponse");
 
 // dist/esm/controller-registry.js
+var import_ts_data_schema4 = require("@e22m4u/ts-data-schema");
 var _ControllerRegistry = class _ControllerRegistry extends DebuggableService {
   /**
    * Controllers.
@@ -828,6 +886,7 @@ var _ControllerRegistry = class _ControllerRegistry extends DebuggableService {
     const requestContextMetadataMap = RequestContextReflector.getMetadata(controllerCtor, actionName);
     const requestDataMetadataMap = RequestDataReflector.getMetadata(controllerCtor, actionName);
     const argsNumber = controllerCtor.prototype[actionName].length;
+    const defaultsApplier = this.getService(import_ts_data_schema4.DefaultValuesApplier);
     const dataTypeCaster = this.getService(import_ts_data_schema3.DataTypeCaster);
     const dataValidator = this.getService(import_ts_data_schema2.DataValidator);
     return (requestContext2) => {
@@ -872,13 +931,15 @@ var _ControllerRegistry = class _ControllerRegistry extends DebuggableService {
           }
           debug("Request data source is %v.", requestDataMd.source);
           if (requestDataMd.schema) {
+            data = defaultsApplier.applyDefaultValuesIfNeeded(data, requestDataMd.schema, requestDataMd.source);
+            debug("Default values applied.");
             data = dataTypeCaster.cast(data, requestDataMd.schema, {
               noTypeCastError: true,
               sourcePath: requestDataMd.source
             });
-            debug("Data type casting is passed.");
+            debug("Data type casting applied.");
             dataValidator.validate(data, requestDataMd.schema, requestDataMd.source);
-            debug("Data validation is passed.");
+            debug("Data validation passed.");
           }
           if (requestDataMd.property == null) {
             debug("Request data property is not specified.");
@@ -934,11 +995,13 @@ var RestRouter = _RestRouter;
   NotAControllerError,
   REQUEST_CONTEXT_METADATA_KEY,
   REQUEST_DATA_METADATA_KEY,
+  RESPONSE_BODY_METADATA_KEY,
   REST_ACTIONS_METADATA_KEY,
   REST_CONTROLLER_METADATA_KEY,
   RequestContextReflector,
   RequestDataReflector,
   RequestDataSource,
+  ResponseBodyReflector,
   RestActionReflector,
   RestControllerReflector,
   RestRouter,
@@ -965,6 +1028,7 @@ var RestRouter = _RestRouter;
   requestParams,
   requestQueries,
   requestQuery,
+  responseBody,
   restAction,
   restController,
   toCamelCase

package/dist/esm/controller-registry.js

@@ -8,6 +8,7 @@ import { DebuggableService } from './debuggable-service.js';
 import { RestActionReflector } from './decorators/index.js';
 import { RequestDataReflector } from './decorators/index.js';
 import { AfterActionReflector } from './decorators/index.js';
+import { DefaultValuesApplier } from '@e22m4u/ts-data-schema';
 import { BeforeActionReflector } from './decorators/index.js';
 import { RestControllerReflector } from './decorators/index.js';
 import { RequestContextReflector } from './decorators/index.js';
@@ -320,6 +321,7 @@ export class ControllerRegistry extends DebuggableService {
         const requestContextMetadataMap = RequestContextReflector.getMetadata(controllerCtor, actionName);
         const requestDataMetadataMap = RequestDataReflector.getMetadata(controllerCtor, actionName);
         const argsNumber = controllerCtor.prototype[actionName].length;
+        const defaultsApplier = this.getService(DefaultValuesApplier);
         const dataTypeCaster = this.getService(DataTypeCaster);
         const dataValidator = this.getService(DataValidator);
         return (requestContext) => {
@@ -378,16 +380,19 @@ export class ControllerRegistry extends DebuggableService {
                             break;
                     }
                     debug('Request data source is %v.', requestDataMd.source);
-                    // при наличии схемы данных выполняется
-                    // их конвертация и валидация
+                    // при наличии схемы данных применяются значения
+                    // по умолчанию, выполняется конвертация входящего
+                    // значения и валидация согласно схеме
                     if (requestDataMd.schema) {
+                        data = defaultsApplier.applyDefaultValuesIfNeeded(data, requestDataMd.schema, requestDataMd.source);
+                        debug('Default values applied.');
                         data = dataTypeCaster.cast(data, requestDataMd.schema, {
                             noTypeCastError: true,
                             sourcePath: requestDataMd.source,
                         });
-                        debug('Data type casting is passed.');
+                        debug('Data type casting applied.');
                         dataValidator.validate(data, requestDataMd.schema, requestDataMd.source);
-                        debug('Data validation is passed.');
+                        debug('Data validation passed.');
                     }
                     // если свойство данных не определено,
                     // то используем весь объекта данных

package/dist/esm/decorators/after-action/after-action-reflector.spec.js

@@ -1,5 +1,4 @@
 import { expect } from 'chai';
-import { describe } from 'mocha';
 import { Reflector } from '@e22m4u/ts-reflector';
 import { AfterActionReflector } from './after-action-reflector.js';
 import { AFTER_ACTION_METADATA_KEY } from './after-action-metadata.js';

package/dist/esm/decorators/before-action/before-action-reflector.spec.js

@@ -1,5 +1,4 @@
 import { expect } from 'chai';
-import { describe } from 'mocha';
 import { Reflector } from '@e22m4u/ts-reflector';
 import { BeforeActionReflector } from './before-action-reflector.js';
 import { BEFORE_ACTION_METADATA_KEY } from './before-action-metadata.js';

package/dist/esm/decorators/index.d.ts

@@ -2,5 +2,6 @@ export * from './rest-action/index.js';
 export * from './request-data/index.js';
 export * from './after-action/index.js';
 export * from './before-action/index.js';
+export * from './response-body/index.js';
 export * from './rest-controller/index.js';
 export * from './request-context/index.js';

package/dist/esm/decorators/index.js

@@ -2,5 +2,6 @@ export * from './rest-action/index.js';
 export * from './request-data/index.js';
 export * from './after-action/index.js';
 export * from './before-action/index.js';
+export * from './response-body/index.js';
 export * from './rest-controller/index.js';
 export * from './request-context/index.js';

package/dist/esm/decorators/request-context/request-context-reflector.spec.js

@@ -1,5 +1,4 @@
 import { expect } from 'chai';
-import { describe } from 'mocha';
 import { Reflector } from '@e22m4u/ts-reflector';
 import { RequestContextReflector } from './request-context-reflector.js';
 import { REQUEST_CONTEXT_METADATA_KEY } from './request-context-metadata.js';

package/dist/esm/decorators/request-data/request-data-decorator.d.ts

@@ -11,22 +11,22 @@ export type RequestDataOptions = RequestDataMetadata;
  *
  * @param options
  */
-export declare function requestData<T extends object>(options: RequestDataOptions): (target: Prototype<T>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare function requestData<T extends object>(options: RequestDataOptions): (target: Prototype<T>, propertyKey: string, index: number) => void;
 /**
  * Decorator aliases.
  */
-export declare const requestParams: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestParam: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestQueries: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestQuery: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestHeaders: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestHeader: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestCookies: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestCookie: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const requestField: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const requestParams: () => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestParam: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestQueries: () => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestQuery: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestHeaders: () => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestHeader: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestCookies: () => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestCookie: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, index: number) => void;
+export declare const requestField: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, index: number) => void;
 /**
  * Request body decorator.
  *
  * @param schemaOrType
  */
-export declare function requestBody(schemaOrType?: DataSchema | DataType): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare function requestBody(schemaOrType?: DataSchema | DataType): (target: Prototype<object>, propertyKey: string, index: number) => void;

package/dist/esm/decorators/request-data/request-data-decorator.js

@@ -9,12 +9,12 @@ import { RequestDataReflector } from './request-data-reflector.js';
  * @param options
  */
 export function requestData(options) {
-    return function (target, propertyKey, indexOrDescriptor) {
-        const decoratorType = getDecoratorTargetType(target, propertyKey, indexOrDescriptor);
+    return function (target, propertyKey, index) {
+        const decoratorType = getDecoratorTargetType(target, propertyKey, index);
         if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
             throw new Error('@requestData decorator is only supported ' +
                 'on an instance method parameter.');
-        RequestDataReflector.setMetadata(options, target.constructor, indexOrDescriptor, propertyKey);
+        RequestDataReflector.setMetadata(options, target.constructor, index, propertyKey);
     };
 }
 /**

package/dist/esm/decorators/request-data/request-data-reflector.spec.js

@@ -1,5 +1,4 @@
 import { expect } from 'chai';
-import { describe } from 'mocha';
 import { Reflector } from '@e22m4u/ts-reflector';
 import { RequestDataSource } from './request-data-metadata.js';
 import { RequestDataReflector } from './request-data-reflector.js';

package/dist/esm/decorators/response-body/index.d.ts

@@ -0,0 +1,3 @@
+export * from './response-body-metadata.js';
+export * from './response-body-decorator.js';
+export * from './response-body-reflector.js';

package/dist/esm/decorators/response-body/index.js

@@ -0,0 +1,3 @@
+export * from './response-body-metadata.js';
+export * from './response-body-decorator.js';
+export * from './response-body-reflector.js';

package/dist/esm/decorators/response-body/response-body-decorator.d.ts

@@ -0,0 +1,9 @@
+import { Prototype } from '../../types.js';
+import { DataType } from '@e22m4u/ts-data-schema';
+import { DataSchema } from '@e22m4u/ts-data-schema';
+/**
+ * Response body decorator.
+ *
+ * @param schemaOrType
+ */
+export declare function responseBody<T extends object>(schemaOrType?: DataSchema | DataType): (target: Prototype<T>, propertyKey: string, descriptor: PropertyDescriptor) => void;