@e22m4u/ts-rest-router 0.2.1 → 0.2.2

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);
   };
@@ -938,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,
@@ -969,6 +1028,7 @@ var RestRouter = _RestRouter;
   requestParams,
   requestQueries,
   requestQuery,
+  responseBody,
   restAction,
   restController,
   toCamelCase

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-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/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;

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

@@ -0,0 +1,23 @@
+import { DecoratorTargetType } from '@e22m4u/ts-reflector';
+import { getDecoratorTargetType } from '@e22m4u/ts-reflector';
+import { ResponseBodyReflector } from './response-body-reflector.js';
+/**
+ * Response body decorator.
+ *
+ * @param schemaOrType
+ */
+export function responseBody(schemaOrType) {
+    return function (target, propertyKey, descriptor) {
+        const decoratorType = getDecoratorTargetType(target, propertyKey, descriptor);
+        if (decoratorType !== 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);
+    };
+}

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

@@ -0,0 +1 @@
+export {};

package/dist/esm/decorators/response-body/response-body-decorator.spec.js

@@ -0,0 +1,61 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { expect } from 'chai';
+import { DataType } from '@e22m4u/ts-data-schema';
+import { responseBody } from './response-body-decorator.js';
+import { ResponseBodyReflector } from './response-body-reflector.js';
+describe('responseBody', function () {
+    it('does not require arguments', function () {
+        class Target {
+            myMethod() { }
+        }
+        __decorate([
+            responseBody(),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "myMethod", null);
+        const res = ResponseBodyReflector.getMetadata(Target);
+        expect(res.get('myMethod')).to.be.eql({});
+    });
+    it('sets the given DataType to the target metadata', function () {
+        class Target {
+            myMethod() { }
+        }
+        __decorate([
+            responseBody(DataType.STRING),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "myMethod", null);
+        const res = ResponseBodyReflector.getMetadata(Target);
+        expect(res.get('myMethod')).to.be.eql({ schema: { type: DataType.STRING } });
+    });
+    it('sets the given schema to the target metadata', function () {
+        const schema = {
+            type: DataType.OBJECT,
+            properties: {
+                foo: { type: DataType.STRING },
+                bar: { type: DataType.NUMBER },
+            },
+        };
+        class Target {
+            myMethod() { }
+        }
+        __decorate([
+            responseBody(schema),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "myMethod", null);
+        const res = ResponseBodyReflector.getMetadata(Target);
+        expect(res.get('myMethod')).to.be.eql({ schema });
+    });
+});

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

@@ -0,0 +1,16 @@
+import { MetadataKey } from '@e22m4u/ts-reflector';
+import { DataSchema } from '@e22m4u/ts-data-schema';
+/**
+ * Response body metadata.
+ */
+export type ResponseBodyMetadata = {
+    schema?: DataSchema;
+};
+/**
+ * Response body metadata map.
+ */
+export type ResponseBodyMetadataMap = Map<string, ResponseBodyMetadata>;
+/**
+ * Response body metadata key.
+ */
+export declare const RESPONSE_BODY_METADATA_KEY: MetadataKey<ResponseBodyMetadataMap>;

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

@@ -0,0 +1,5 @@
+import { MetadataKey } from '@e22m4u/ts-reflector';
+/**
+ * Response body metadata key.
+ */
+export const RESPONSE_BODY_METADATA_KEY = new MetadataKey('responseBodyMetadataKey');

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

@@ -0,0 +1,22 @@
+import { Constructor } from '../../types.js';
+import { ResponseBodyMetadata } from './response-body-metadata.js';
+import { ResponseBodyMetadataMap } from './response-body-metadata.js';
+/**
+ * Response body reflector.
+ */
+export declare class ResponseBodyReflector {
+    /**
+     * Set metadata.
+     *
+     * @param metadata
+     * @param target
+     * @param propertyKey
+     */
+    static setMetadata(metadata: ResponseBodyMetadata, target: Constructor, propertyKey: string): void;
+    /**
+     * Get metadata.
+     *
+     * @param target
+     */
+    static getMetadata(target: Constructor): ResponseBodyMetadataMap;
+}

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

@@ -0,0 +1,29 @@
+import { Reflector } from '@e22m4u/ts-reflector';
+import { RESPONSE_BODY_METADATA_KEY } from './response-body-metadata.js';
+/**
+ * Response body reflector.
+ */
+export class ResponseBodyReflector {
+    /**
+     * Set metadata.
+     *
+     * @param metadata
+     * @param target
+     * @param propertyKey
+     */
+    static setMetadata(metadata, target, propertyKey) {
+        const oldMap = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+        const newMap = new Map(oldMap);
+        newMap.set(propertyKey, metadata);
+        Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, newMap, target);
+    }
+    /**
+     * Get metadata.
+     *
+     * @param target
+     */
+    static getMetadata(target) {
+        const metadata = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+        return metadata ?? new Map();
+    }
+}

package/dist/esm/decorators/response-body/response-body-reflector.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/decorators/response-body/response-body-reflector.spec.js

@@ -0,0 +1,58 @@
+import { expect } from 'chai';
+import { Reflector } from '@e22m4u/ts-reflector';
+import { ResponseBodyReflector } from './response-body-reflector.js';
+import { RESPONSE_BODY_METADATA_KEY } from './response-body-metadata.js';
+describe('ResponseBodyReflector', function () {
+    describe('setMetadata', function () {
+        it('sets a given value as target metadata', function () {
+            class Target {
+            }
+            const md1 = {};
+            const md2 = {};
+            ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey1');
+            ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey2');
+            const res = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+            expect(res).to.be.instanceof(Map);
+            expect(res.get('propertyKey1')).to.be.eq(md1);
+            expect(res.get('propertyKey2')).to.be.eq(md2);
+        });
+        it('overrides existing metadata', function () {
+            class Target {
+            }
+            const md1 = {};
+            const md2 = {};
+            ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey');
+            const res1 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+            expect(res1).to.be.instanceof(Map);
+            expect(res1.get('propertyKey')).to.be.eq(md1);
+            ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey');
+            const res2 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+            expect(res2).to.be.instanceof(Map);
+            expect(res2.get('propertyKey')).to.be.eq(md2);
+        });
+    });
+    describe('getMetadata', function () {
+        it('returns an existing metadata of the target', function () {
+            class Target {
+            }
+            const md1 = {};
+            const md2 = {};
+            const mdMap = new Map([
+                ['propertyKey1', md1],
+                ['propertyKey2', md2],
+            ]);
+            Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, mdMap, Target);
+            const res = ResponseBodyReflector.getMetadata(Target);
+            expect(res).to.be.instanceof(Map);
+            expect(res.get('propertyKey1')).to.be.eq(md1);
+            expect(res.get('propertyKey2')).to.be.eq(md2);
+        });
+        it('returns an empty map if no metadata', function () {
+            class Target {
+            }
+            const res = ResponseBodyReflector.getMetadata(Target);
+            expect(res).to.be.instanceof(Map);
+            expect(res).to.be.empty;
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/ts-rest-router",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "REST маршрутизатор на основе контроллеров для TypeScript",
   "author": "e22m4u <e22m4u@yandex.ru>",
   "license": "MIT",
@@ -52,25 +52,25 @@
   "devDependencies": {
     "@commitlint/cli": "~19.8.1",
     "@commitlint/config-conventional": "~19.8.1",
-    "@eslint/js": "~9.26.0",
+    "@eslint/js": "~9.28.0",
     "@types/chai": "~5.2.2",
     "@types/debug": "~4.1.12",
     "@types/http-errors": "~2.0.4",
     "@types/mocha": "~10.0.10",
-    "@types/node": "~22.15.17",
+    "@types/node": "~22.15.29",
     "c8": "~10.1.3",
     "chai": "~5.2.0",
-    "esbuild": "~0.25.4",
-    "eslint": "~9.26.0",
+    "esbuild": "~0.25.5",
+    "eslint": "~9.28.0",
     "eslint-config-prettier": "~10.1.5",
     "eslint-plugin-chai-expect": "~3.1.0",
-    "eslint-plugin-mocha": "~11.0.0",
+    "eslint-plugin-mocha": "~11.1.0",
     "husky": "~9.1.7",
-    "mocha": "~11.2.2",
+    "mocha": "~11.5.0",
     "prettier": "~3.5.3",
     "rimraf": "~6.0.1",
     "tsx": "~4.19.4",
     "typescript": "~5.8.3",
-    "typescript-eslint": "~8.32.0"
+    "typescript-eslint": "~8.33.0"
   }
 }

package/src/decorators/index.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/src/decorators/request-data/request-data-decorator.ts

@@ -20,16 +20,8 @@ export type RequestDataOptions = RequestDataMetadata;
  * @param options
  */
 export function requestData<T extends object>(options: RequestDataOptions) {
-  return function (
-    target: Prototype<T>,
-    propertyKey: string,
-    indexOrDescriptor: number,
-  ) {
-    const decoratorType = getDecoratorTargetType(
-      target,
-      propertyKey,
-      indexOrDescriptor,
-    );
+  return function (target: Prototype<T>, propertyKey: string, index: number) {
+    const decoratorType = getDecoratorTargetType(target, propertyKey, index);
     if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
       throw new Error(
         '@requestData decorator is only supported ' +
@@ -38,7 +30,7 @@ export function requestData<T extends object>(options: RequestDataOptions) {
     RequestDataReflector.setMetadata(
       options,
       target.constructor as Constructor<T>,
-      indexOrDescriptor,
+      index,
       propertyKey,
     );
   };

package/src/decorators/response-body/index.ts

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

package/src/decorators/response-body/response-body-decorator.spec.ts

@@ -0,0 +1,40 @@
+import {expect} from 'chai';
+import {DataType} from '@e22m4u/ts-data-schema';
+import {responseBody} from './response-body-decorator.js';
+import {ResponseBodyReflector} from './response-body-reflector.js';
+
+describe('responseBody', function () {
+  it('does not require arguments', function () {
+    class Target {
+      @responseBody()
+      myMethod() {}
+    }
+    const res = ResponseBodyReflector.getMetadata(Target);
+    expect(res.get('myMethod')).to.be.eql({});
+  });
+
+  it('sets the given DataType to the target metadata', function () {
+    class Target {
+      @responseBody(DataType.STRING)
+      myMethod() {}
+    }
+    const res = ResponseBodyReflector.getMetadata(Target);
+    expect(res.get('myMethod')).to.be.eql({schema: {type: DataType.STRING}});
+  });
+
+  it('sets the given schema to the target metadata', function () {
+    const schema = {
+      type: DataType.OBJECT,
+      properties: {
+        foo: {type: DataType.STRING},
+        bar: {type: DataType.NUMBER},
+      },
+    };
+    class Target {
+      @responseBody(schema)
+      myMethod() {}
+    }
+    const res = ResponseBodyReflector.getMetadata(Target);
+    expect(res.get('myMethod')).to.be.eql({schema});
+  });
+});

package/src/decorators/response-body/response-body-decorator.ts

@@ -0,0 +1,43 @@
+import {Prototype} from '../../types.js';
+import {Constructor} from '../../types.js';
+import {DataType} from '@e22m4u/ts-data-schema';
+import {DataSchema} from '@e22m4u/ts-data-schema';
+import {DecoratorTargetType} from '@e22m4u/ts-reflector';
+import {getDecoratorTargetType} from '@e22m4u/ts-reflector';
+import {ResponseBodyReflector} from './response-body-reflector.js';
+
+/**
+ * Response body decorator.
+ *
+ * @param schemaOrType
+ */
+export function responseBody<T extends object>(
+  schemaOrType?: DataSchema | DataType,
+) {
+  return function (
+    target: Prototype<T>,
+    propertyKey: string,
+    descriptor: PropertyDescriptor,
+  ) {
+    const decoratorType = getDecoratorTargetType(
+      target,
+      propertyKey,
+      descriptor,
+    );
+    if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD)
+      throw new Error(
+        '@responseBody decorator is only supported on an instance method.',
+      );
+    let schema: DataSchema | undefined;
+    if (typeof schemaOrType === 'object') {
+      schema = schemaOrType;
+    } else if (typeof schemaOrType === 'string') {
+      schema = {type: schemaOrType};
+    }
+    ResponseBodyReflector.setMetadata(
+      schema ? {schema} : {},
+      target.constructor as Constructor<T>,
+      propertyKey,
+    );
+  };
+}

package/src/decorators/response-body/response-body-metadata.ts

@@ -0,0 +1,20 @@
+import {MetadataKey} from '@e22m4u/ts-reflector';
+import {DataSchema} from '@e22m4u/ts-data-schema';
+
+/**
+ * Response body metadata.
+ */
+export type ResponseBodyMetadata = {
+  schema?: DataSchema;
+};
+
+/**
+ * Response body metadata map.
+ */
+export type ResponseBodyMetadataMap = Map<string, ResponseBodyMetadata>;
+
+/**
+ * Response body metadata key.
+ */
+export const RESPONSE_BODY_METADATA_KEY =
+  new MetadataKey<ResponseBodyMetadataMap>('responseBodyMetadataKey');

package/src/decorators/response-body/response-body-reflector.spec.ts

@@ -0,0 +1,59 @@
+import {expect} from 'chai';
+import {Reflector} from '@e22m4u/ts-reflector';
+import {ResponseBodyMetadata} from './response-body-metadata.js';
+import {ResponseBodyReflector} from './response-body-reflector.js';
+import {RESPONSE_BODY_METADATA_KEY} from './response-body-metadata.js';
+
+describe('ResponseBodyReflector', function () {
+  describe('setMetadata', function () {
+    it('sets a given value as target metadata', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey1');
+      ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey2');
+      const res = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res!.get('propertyKey1')).to.be.eq(md1);
+      expect(res!.get('propertyKey2')).to.be.eq(md2);
+    });
+
+    it('overrides existing metadata', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey');
+      const res1 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res1).to.be.instanceof(Map);
+      expect(res1!.get('propertyKey')).to.be.eq(md1);
+      ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey');
+      const res2 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res2).to.be.instanceof(Map);
+      expect(res2!.get('propertyKey')).to.be.eq(md2);
+    });
+  });
+
+  describe('getMetadata', function () {
+    it('returns an existing metadata of the target', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      const mdMap = new Map<string, ResponseBodyMetadata>([
+        ['propertyKey1', md1],
+        ['propertyKey2', md2],
+      ]);
+      Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, mdMap, Target);
+      const res = ResponseBodyReflector.getMetadata(Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res!.get('propertyKey1')).to.be.eq(md1);
+      expect(res!.get('propertyKey2')).to.be.eq(md2);
+    });
+
+    it('returns an empty map if no metadata', function () {
+      class Target {}
+      const res = ResponseBodyReflector.getMetadata(Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res).to.be.empty;
+    });
+  });
+});

package/src/decorators/response-body/response-body-reflector.ts

@@ -0,0 +1,41 @@
+import {Constructor} from '../../types.js';
+import {Reflector} from '@e22m4u/ts-reflector';
+import {ResponseBodyMetadata} from './response-body-metadata.js';
+import {ResponseBodyMetadataMap} from './response-body-metadata.js';
+import {RESPONSE_BODY_METADATA_KEY} from './response-body-metadata.js';
+
+/**
+ * Response body reflector.
+ */
+export class ResponseBodyReflector {
+  /**
+   * Set metadata.
+   *
+   * @param metadata
+   * @param target
+   * @param propertyKey
+   */
+  static setMetadata(
+    metadata: ResponseBodyMetadata,
+    target: Constructor,
+    propertyKey: string,
+  ) {
+    const oldMap = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+    const newMap = new Map(oldMap);
+    newMap.set(propertyKey, metadata);
+    Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, newMap, target);
+  }
+
+  /**
+   * Get metadata.
+   *
+   * @param target
+   */
+  static getMetadata(target: Constructor): ResponseBodyMetadataMap {
+    const metadata = Reflector.getOwnMetadata(
+      RESPONSE_BODY_METADATA_KEY,
+      target,
+    );
+    return metadata ?? new Map();
+  }
+}