@asapjs/router 1.0.0-alpha.4 → 1.0.0-alpha.41

package/dist/decorator/AutoInject.d.ts

@@ -0,0 +1,25 @@
+import 'reflect-metadata';
+import type { Request } from 'express';
+export declare const AUTO_INJECT_METADATA_KEY = "response:autoInject";
+export interface AutoInjectEntry {
+    key: string;
+    factory: (req: Request) => any;
+}
+/**
+ * Marks a field in a Global Response DTO as auto-injected.
+ * The factory function receives the Express Request and returns the value to inject.
+ *
+ * @example
+ * class GlobalResponseDto extends ExtendableDto {
+ *   @TypeIs.INT({ comment: '응답 시각' })
+ *   @AutoInject(() => Date.now())
+ *   timestamp: number;
+ *
+ *   @TypeIs.STRING({ comment: '요청 ID' })
+ *   @AutoInject((req) => req.headers['x-request-id'] || uuid())
+ *   requestId: string;
+ * }
+ */
+export declare function AutoInject(factory: (req: Request) => any): PropertyDecorator;
+export declare function getAutoInjectEntries(DtoClass: new () => any): AutoInjectEntry[];
+//# sourceMappingURL=AutoInject.d.ts.map

package/dist/decorator/AutoInject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoInject.d.ts","sourceRoot":"","sources":["../../src/decorator/AutoInject.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,wBAAwB,wBAAwB,CAAC;AAE9D,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,GAAG,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,GAAG,GAAG,iBAAiB,CAQ5E;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,GAAG,eAAe,EAAE,CAE/E"}

package/dist/decorator/AutoInject.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUTO_INJECT_METADATA_KEY = void 0;
+exports.AutoInject = AutoInject;
+exports.getAutoInjectEntries = getAutoInjectEntries;
+require("reflect-metadata");
+exports.AUTO_INJECT_METADATA_KEY = 'response:autoInject';
+/**
+ * Marks a field in a Global Response DTO as auto-injected.
+ * The factory function receives the Express Request and returns the value to inject.
+ *
+ * @example
+ * class GlobalResponseDto extends ExtendableDto {
+ *   @TypeIs.INT({ comment: '응답 시각' })
+ *   @AutoInject(() => Date.now())
+ *   timestamp: number;
+ *
+ *   @TypeIs.STRING({ comment: '요청 ID' })
+ *   @AutoInject((req) => req.headers['x-request-id'] || uuid())
+ *   requestId: string;
+ * }
+ */
+function AutoInject(factory) {
+    return (target, propertyKey) => {
+        const key = String(propertyKey);
+        const existing = Reflect.getMetadata(exports.AUTO_INJECT_METADATA_KEY, target.constructor) || [];
+        existing.push({ key, factory });
+        Reflect.defineMetadata(exports.AUTO_INJECT_METADATA_KEY, existing, target.constructor);
+    };
+}
+function getAutoInjectEntries(DtoClass) {
+    return Reflect.getMetadata(exports.AUTO_INJECT_METADATA_KEY, DtoClass) || [];
+}
+//# sourceMappingURL=AutoInject.js.map

package/dist/decorator/AutoInject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoInject.js","sourceRoot":"","sources":["../../src/decorator/AutoInject.ts"],"names":[],"mappings":";;;AAyBA,gCAQC;AAED,oDAEC;AArCD,4BAA0B;AAGb,QAAA,wBAAwB,GAAG,qBAAqB,CAAC;AAO9D;;;;;;;;;;;;;;GAcG;AACH,SAAgB,UAAU,CAAC,OAA8B;IACxD,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,MAAM,QAAQ,GACb,OAAO,CAAC,WAAW,CAAC,gCAAwB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACzE,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAChC,OAAO,CAAC,cAAc,CAAC,gCAAwB,EAAE,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAChF,CAAC,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB,CAAC,QAAuB;IAC3D,OAAO,OAAO,CAAC,WAAW,CAAC,gCAAwB,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;AACtE,CAAC"}

package/dist/decorator/ErrorPayload.d.ts

@@ -0,0 +1,5 @@
+import 'reflect-metadata';
+export declare const ERROR_PAYLOAD_METADATA_KEY = "response:errorPayloadKey";
+export declare function ErrorPayload(): PropertyDecorator;
+export declare function getErrorPayloadKey(DtoClass: new () => any): string | undefined;
+//# sourceMappingURL=ErrorPayload.d.ts.map

package/dist/decorator/ErrorPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorPayload.d.ts","sourceRoot":"","sources":["../../src/decorator/ErrorPayload.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,eAAO,MAAM,0BAA0B,6BAA6B,CAAC;AAErE,wBAAgB,YAAY,IAAI,iBAAiB,CAKhD;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,GAAG,MAAM,GAAG,SAAS,CAE9E"}

package/dist/decorator/ErrorPayload.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_PAYLOAD_METADATA_KEY = void 0;
+exports.ErrorPayload = ErrorPayload;
+exports.getErrorPayloadKey = getErrorPayloadKey;
+require("reflect-metadata");
+exports.ERROR_PAYLOAD_METADATA_KEY = 'response:errorPayloadKey';
+function ErrorPayload() {
+    return (target, propertyKey) => {
+        const key = String(propertyKey);
+        Reflect.defineMetadata(exports.ERROR_PAYLOAD_METADATA_KEY, key, target.constructor);
+    };
+}
+function getErrorPayloadKey(DtoClass) {
+    return Reflect.getMetadata(exports.ERROR_PAYLOAD_METADATA_KEY, DtoClass);
+}
+//# sourceMappingURL=ErrorPayload.js.map

package/dist/decorator/ErrorPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorPayload.js","sourceRoot":"","sources":["../../src/decorator/ErrorPayload.ts"],"names":[],"mappings":";;;AAIA,oCAKC;AAED,gDAEC;AAbD,4BAA0B;AAEb,QAAA,0BAA0B,GAAG,0BAA0B,CAAC;AAErE,SAAgB,YAAY;IAC3B,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO,CAAC,cAAc,CAAC,kCAA0B,EAAE,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7E,CAAC,CAAC;AACH,CAAC;AAED,SAAgB,kBAAkB,CAAC,QAAuB;IACzD,OAAO,OAAO,CAAC,WAAW,CAAC,kCAA0B,EAAE,QAAQ,CAAC,CAAC;AAClE,CAAC"}

package/dist/decorator/ResponsePayload.d.ts

@@ -0,0 +1,20 @@
+import 'reflect-metadata';
+export declare const RESPONSE_PAYLOAD_METADATA_KEY = "response:payloadKey";
+/**
+ * Marks a field in a Global Response DTO as the slot where each route's response DTO will be placed.
+ * If no field is marked with @ResponsePayload(), the Global DTO operates in "spread" mode:
+ * the route DTO's fields are merged at the top level using OpenAPI allOf.
+ *
+ * @example
+ * class DefaultResponseDto extends ExtendableDto {
+ *   @TypeIs.INT()
+ *   @AutoInject(() => Date.now())
+ *   timestamp: number;
+ *
+ *   @ResponsePayload()
+ *   result: any;  // route DTO goes here
+ * }
+ */
+export declare function ResponsePayload(): PropertyDecorator;
+export declare function getResponsePayloadKey(DtoClass: new () => any): string | undefined;
+//# sourceMappingURL=ResponsePayload.d.ts.map

package/dist/decorator/ResponsePayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponsePayload.d.ts","sourceRoot":"","sources":["../../src/decorator/ResponsePayload.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AAEnE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,IAAI,iBAAiB,CAKnD;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,UAAU,GAAG,GAAG,MAAM,GAAG,SAAS,CAEjF"}

package/dist/decorator/ResponsePayload.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESPONSE_PAYLOAD_METADATA_KEY = void 0;
+exports.ResponsePayload = ResponsePayload;
+exports.getResponsePayloadKey = getResponsePayloadKey;
+require("reflect-metadata");
+exports.RESPONSE_PAYLOAD_METADATA_KEY = 'response:payloadKey';
+/**
+ * Marks a field in a Global Response DTO as the slot where each route's response DTO will be placed.
+ * If no field is marked with @ResponsePayload(), the Global DTO operates in "spread" mode:
+ * the route DTO's fields are merged at the top level using OpenAPI allOf.
+ *
+ * @example
+ * class DefaultResponseDto extends ExtendableDto {
+ *   @TypeIs.INT()
+ *   @AutoInject(() => Date.now())
+ *   timestamp: number;
+ *
+ *   @ResponsePayload()
+ *   result: any;  // route DTO goes here
+ * }
+ */
+function ResponsePayload() {
+    return (target, propertyKey) => {
+        const key = String(propertyKey);
+        Reflect.defineMetadata(exports.RESPONSE_PAYLOAD_METADATA_KEY, key, target.constructor);
+    };
+}
+function getResponsePayloadKey(DtoClass) {
+    return Reflect.getMetadata(exports.RESPONSE_PAYLOAD_METADATA_KEY, DtoClass);
+}
+//# sourceMappingURL=ResponsePayload.js.map

package/dist/decorator/ResponsePayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponsePayload.js","sourceRoot":"","sources":["../../src/decorator/ResponsePayload.ts"],"names":[],"mappings":";;;AAmBA,0CAKC;AAED,sDAEC;AA5BD,4BAA0B;AAEb,QAAA,6BAA6B,GAAG,qBAAqB,CAAC;AAEnE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe;IAC9B,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO,CAAC,cAAc,CAAC,qCAA6B,EAAE,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAChF,CAAC,CAAC;AACH,CAAC;AAED,SAAgB,qBAAqB,CAAC,QAAuB;IAC5D,OAAO,OAAO,CAAC,WAAW,CAAC,qCAA6B,EAAE,QAAQ,CAAC,CAAC;AACrE,CAAC"}

package/dist/decorator/index.d.ts

@@ -1,6 +1,12 @@
-import RouterController, { IPreference } from '../express/router';
 import { ErrorCreator } from '@asapjs/error';
-export interface IOptions extends Omit<IPreference, 'path' | 'excute'> {
+import RouterController, { IPreference } from '../express/router';
+export { AutoInject, getAutoInjectEntries } from './AutoInject';
+export type { AutoInjectEntry } from './AutoInject';
+export { ResponsePayload, getResponsePayloadKey } from './ResponsePayload';
+export { ErrorPayload, getErrorPayloadKey } from './ErrorPayload';
+export interface GlobalRouteOptions {
+}
+export interface IOptions extends Omit<IPreference, 'path' | 'excute'>, GlobalRouteOptions {
     errors?: ErrorCreator[];
 }
 export declare function Get(path: string, options: IOptions): (target: InstanceType<typeof RouterController>, propertyKey: string) => void;

package/dist/decorator/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,EAAE,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,QAAS,SAAQ,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpE,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACzB;AAkBD,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAfxB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAiBpF;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAnBzB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAqBpF;AAED,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAvBxB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAyBpF;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YA3B3B,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UA6BpF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,gBAAgB,EAAE,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAE9E,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAChE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGlE,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,QAAS,SAAQ,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAC,EAAE,kBAAkB;IACxF,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACzB;AAiBD,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAdxB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAgBpF;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAlBzB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAoBpF;AAED,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YAtBxB,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UAwBpF;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,YA1B3B,YAAY,CAAC,OAAO,gBAAgB,CAAC,eAAe,MAAM,UA4BpF"}

package/dist/decorator/index.js

@@ -1,18 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorPayloadKey = exports.ErrorPayload = exports.getResponsePayloadKey = exports.ResponsePayload = exports.getAutoInjectEntries = exports.AutoInject = void 0;
 exports.Get = Get;
 exports.Post = Post;
 exports.Put = Put;
 exports.Delete = Delete;
+var AutoInject_1 = require("./AutoInject");
+Object.defineProperty(exports, "AutoInject", { enumerable: true, get: function () { return AutoInject_1.AutoInject; } });
+Object.defineProperty(exports, "getAutoInjectEntries", { enumerable: true, get: function () { return AutoInject_1.getAutoInjectEntries; } });
+var ResponsePayload_1 = require("./ResponsePayload");
+Object.defineProperty(exports, "ResponsePayload", { enumerable: true, get: function () { return ResponsePayload_1.ResponsePayload; } });
+Object.defineProperty(exports, "getResponsePayloadKey", { enumerable: true, get: function () { return ResponsePayload_1.getResponsePayloadKey; } });
+var ErrorPayload_1 = require("./ErrorPayload");
+Object.defineProperty(exports, "ErrorPayload", { enumerable: true, get: function () { return ErrorPayload_1.ErrorPayload; } });
+Object.defineProperty(exports, "getErrorPayloadKey", { enumerable: true, get: function () { return ErrorPayload_1.getErrorPayloadKey; } });
 function Route(path, method, options) {
     return function (target, propertyKey) {
         if (!target.routes) {
             target.routes = [];
         }
         target.routes.push(Object.assign(Object.assign({ method,
-            path }, options), { 
-            // Don't try to access the method here. Just save the method name.
-            methodName: propertyKey }));
+            path }, options), { methodName: propertyKey }));
     };
 }
 function Get(path, options) {

package/dist/decorator/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":";;AAuBA,kBAEC;AAED,oBAEC;AAED,kBAEC;AAED,wBAEC;AA9BD,SAAS,KAAK,CAAC,IAAY,EAAE,MAAkB,EAAE,OAAiB;IAChE,OAAO,UAAU,MAA6C,EAAE,WAAmB;QACjF,IAAI,CAAE,MAAc,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAc,CAAC,MAAM,GAAG,EAAE,CAAC;QAC9B,CAAC;QAEA,MAAc,CAAC,MAAM,CAAC,IAAI,+BACzB,MAAM;YACN,IAAI,IACD,OAAO;YACV,kEAAkE;YAClE,UAAU,EAAE,WAAW,IACvB,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,GAAG,CAAC,IAAY,EAAE,OAAiB;IACjD,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,IAAI,CAAC,IAAY,EAAE,OAAiB;IAClD,OAAO,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,SAAgB,GAAG,CAAC,IAAY,EAAE,OAAiB;IACjD,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,MAAM,CAAC,IAAY,EAAE,OAAiB;IACpD,OAAO,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":";;;AA8BA,kBAEC;AAED,oBAEC;AAED,kBAEC;AAED,wBAEC;AAzCD,2CAAgE;AAAvD,wGAAA,UAAU,OAAA;AAAE,kHAAA,oBAAoB,OAAA;AAEzC,qDAA2E;AAAlE,kHAAA,eAAe,OAAA;AAAE,wHAAA,qBAAqB,OAAA;AAC/C,+CAAkE;AAAzD,4GAAA,YAAY,OAAA;AAAE,kHAAA,kBAAkB,OAAA;AASzC,SAAS,KAAK,CAAC,IAAY,EAAE,MAAkB,EAAE,OAAiB;IAChE,OAAO,UAAU,MAA6C,EAAE,WAAmB;QACjF,IAAI,CAAE,MAAc,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAc,CAAC,MAAM,GAAG,EAAE,CAAC;QAC9B,CAAC;QAEA,MAAc,CAAC,MAAM,CAAC,IAAI,+BACzB,MAAM;YACN,IAAI,IACD,OAAO,KACV,UAAU,EAAE,WAAW,IACvB,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,GAAG,CAAC,IAAY,EAAE,OAAiB;IACjD,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,IAAI,CAAC,IAAY,EAAE,OAAiB;IAClD,OAAO,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,SAAgB,GAAG,CAAC,IAAY,EAAE,OAAiB;IACjD,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,MAAM,CAAC,IAAY,EAAE,OAAiB;IACpD,OAAO,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/express/router.d.ts

@@ -1,14 +1,18 @@
+import { type ErrorCreator } from '@asapjs/error';
+import { type DtoOrTypeIs } from '@asapjs/types';
 import { Router as ExpressRouter } from 'express';
-import { DtoOrTypeIs } from '@asapjs/types';
-import { ErrorCreator } from '@asapjs/error';
 type BodyContentType = 'application/json' | 'multipart/form-data';
+export interface RouteExample {
+    name: string;
+    summary?: string;
+    value: unknown;
+}
 export interface IPreference {
     path: string;
     title?: string;
     description?: string;
     deprecated?: boolean;
     summary?: string;
-    auth?: boolean;
     body?: DtoOrTypeIs;
     bodyContentType?: BodyContentType;
     query?: DtoOrTypeIs;
@@ -16,6 +20,8 @@ export interface IPreference {
     errors?: ErrorCreator[];
     middleware?: any[];
     excute: any;
+    requestExamples?: RouteExample[];
+    responseExamples?: RouteExample[];
 }
 export type MethodType = 'get' | 'post' | 'put' | 'delete';
 export interface IDecoratorPreference extends IPreference {
@@ -24,11 +30,15 @@ export interface IDecoratorPreference extends IPreference {
 }
 export default class RouterController {
     basePath: string;
+    responseDto?: (new () => any) | null;
     expressRouter: ExpressRouter;
     constructor();
     protected registerRoutes(): void;
     private generateRequestBody;
     private generateResponseBody;
+    private getEffectiveResponseDto;
+    private getResponseSchemaSuffix;
+    private buildGlobalResponseSchema;
     private generateDtoScheme;
     private generateTypeScheme;
     private generateErrorSchemes;

package/dist/express/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/express/router.ts"],"names":[],"mappings":"AAAA,OAAU,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,WAAW,EAA0B,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,YAAY,EAAkB,MAAM,eAAe,CAAC;AAS7D,KAAK,eAAe,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;AAClE,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;IACnB,MAAM,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACxD,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACnB;AAUD,MAAM,CAAC,OAAO,OAAO,gBAAgB;IAC7B,QAAQ,SAAO;IAEf,aAAa,EAAE,aAAa,CAAC;;IAMpC,SAAS,CAAC,cAAc;IAaxB,OAAO,CAAC,mBAAmB,CAOxB;IAEH,OAAO,CAAC,oBAAoB,CASzB;IAEH,OAAO,CAAC,iBAAiB,CAmBvB;IAEF,OAAO,CAAC,kBAAkB,CAkBxB;IAEF,OAAO,CAAC,oBAAoB,CAuE1B;IAEF,OAAO,CAAC,0BAA0B,CA2IhC;IAEK,MAAM,GAAI,QAAQ,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,MAAM,SAAS,WAAW,UA+BlF;IAEK,MAAM;uBAjC4D,WAAW;wBAAX,WAAW;uBAAX,WAAW;0BAAX,WAAW;MAsClF;CACF;AAED,UAAU,aAAa,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC;CACV;AAED,KAAK,qBAAqB,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9C,KAAK,oBAAoB,GACtB;IACA,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,GAAG,CAAC;CACT,GACD,SAAS,GACT,IAAI,CAAC;AAER,KAAK,cAAc,GAAG,MAAM,oBAAoB,CAAC;AAyBjD,eAAO,MAAM,WAAW,QApBlB,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,cAClB,qBAAqB,YACvB,OAAO,KACb,cAiB2C,CAAC;AACjD,eAAO,MAAM,YAAY,QArBnB,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,cAClB,qBAAqB,YACvB,OAAO,KACb,cAkB6C,CAAC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/express/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAkB,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,WAAW,EAAqD,MAAM,eAAe,CAAC;AACpG,OAAU,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AAYrD,KAAK,eAAe,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;AAElE,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;IACnB,MAAM,EAAE,GAAG,CAAC;IACZ,eAAe,CAAC,EAAE,YAAY,EAAE,CAAC;IACjC,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAC;CAClC;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACxD,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACnB;AAUD,MAAM,CAAC,OAAO,OAAO,gBAAgB;IAC7B,QAAQ,SAAO;IACf,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC;IAErC,aAAa,EAAE,aAAa,CAAC;;IAMpC,SAAS,CAAC,cAAc;IAaxB,OAAO,CAAC,mBAAmB,CAgBzB;IAEF,OAAO,CAAC,oBAAoB,CAkB1B;IAEF,OAAO,CAAC,uBAAuB;IAa/B,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,yBAAyB;IA4BjC,OAAO,CAAC,iBAAiB,CAuBvB;IAEF,OAAO,CAAC,kBAAkB,CAiBxB;IAEF,OAAO,CAAC,oBAAoB,CAuH1B;IAEF,OAAO,CAAC,0BAA0B,CAkJhC;IAEK,MAAM,GAAI,QAAQ,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,MAAM,SAAS,WAAW,UAmDlF;IAEK,MAAM;uBArD4D,WAAW;wBAAX,WAAW;uBAAX,WAAW;0BAAX,WAAW;MA0DlF;CACF;AAED,UAAU,aAAa,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC;CACV;AAED,KAAK,qBAAqB,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9C,KAAK,oBAAoB,GACtB;IACA,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,GAAG,CAAC;CACT,GACD,SAAS,GACT,IAAI,CAAC;AAER,KAAK,cAAc,GAAG,MAAM,oBAAoB,CAAC;AAyBjD,eAAO,MAAM,WAAW,QApBlB,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,cAClB,qBAAqB,YACvB,OAAO,KACb,cAiB2C,CAAC;AACjD,eAAO,MAAM,YAAY,QArBnB,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,cAClB,qBAAqB,YACvB,OAAO,KACb,cAkB6C,CAAC"}