@impactor/nest 3.0.0 → 5.0.0

package/src/decorators/controller/add-decorators/add-swagger-operation.js

@@ -1,21 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "addSwaggerOperation", {
-    enumerable: true,
-    get: function() {
-        return addSwaggerOperation;
-    }
-});
-const _reflect = require("../utils/reflect");
-const _swagger = require("@nestjs/swagger");
-function addSwaggerOperation(route, factory) {
-    if ((0, _reflect.has)('swagger/apiOperation', factory, route)) return;
+import { has } from "../utils/reflect.js";
+import { ApiOperation } from "@nestjs/swagger";
+/**
+ * add Swagger's \@ApiOperation()
+ * @param route
+ */ export function addSwaggerOperation(route, factory) {
+    if (has('swagger/apiOperation', factory, route)) return;
     // remove "path" or add "prefix" metadata to it from the constructor
     // to prevent displaying the path without the controller prefix in Swagger docs
     let { path, ...operation } = route;
-    route.decorators.push((0, _swagger.ApiOperation)(operation));
+    route.decorators.push(ApiOperation(operation));
 }
 
 //# sourceMappingURL=add-swagger-operation.js.map

package/src/decorators/controller/add-decorators/add-swagger-operation.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-operation.ts"],"sourcesContent":["import { has } from '../utils/reflect';\nimport { ControllerFactory } from '../controller.factory';\nimport type { IRoute } from '../types';\nimport { ApiOperation } from '@nestjs/swagger';\n\n/**\n * add Swagger's \\@ApiOperation()\n * @param route\n */\nexport function addSwaggerOperation(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiOperation', factory, route)) return;\n\n  // remove \"path\" or add \"prefix\" metadata to it from the constructor\n  // to prevent displaying the path without the controller prefix in Swagger docs\n  let { path, ...operation } = route;\n  route.decorators.push(ApiOperation(operation));\n}\n"],"names":["addSwaggerOperation","route","factory","has","path","operation","decorators","push","ApiOperation"],"mappings":";;;;+BASgBA;;;eAAAA;;;yBATI;yBAGS;AAMtB,SAASA,oBAAoBC,KAAa,EAAEC,OAA0B;IAC3E,IAAIC,IAAAA,YAAG,EAAC,wBAAwBD,SAASD,QAAQ;IAEjD,oEAAoE;IACpE,+EAA+E;IAC/E,IAAI,EAAEG,IAAI,EAAE,GAAGC,WAAW,GAAGJ;IAC7BA,MAAMK,UAAU,CAACC,IAAI,CAACC,IAAAA,qBAAY,EAACH;AACrC"}
+{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-operation.ts"],"sourcesContent":["import { has } from '../utils/reflect.js';\nimport { ControllerFactory } from '../controller.factory.js';\nimport type { IRoute } from '../types/index.js';\nimport { ApiOperation } from '@nestjs/swagger';\n\n/**\n * add Swagger's \\@ApiOperation()\n * @param route\n */\nexport function addSwaggerOperation(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiOperation', factory, route)) return;\n\n  // remove \"path\" or add \"prefix\" metadata to it from the constructor\n  // to prevent displaying the path without the controller prefix in Swagger docs\n  let { path, ...operation } = route;\n  route.decorators.push(ApiOperation(operation));\n}\n"],"names":["has","ApiOperation","addSwaggerOperation","route","factory","path","operation","decorators","push"],"mappings":"AAAA,SAASA,GAAG,QAAQ,sBAAsB;AAG1C,SAASC,YAAY,QAAQ,kBAAkB;AAE/C;;;CAGC,GACD,OAAO,SAASC,oBAAoBC,KAAa,EAAEC,OAA0B;IAC3E,IAAIJ,IAAI,wBAAwBI,SAASD,QAAQ;IAEjD,oEAAoE;IACpE,+EAA+E;IAC/E,IAAI,EAAEE,IAAI,EAAE,GAAGC,WAAW,GAAGH;IAC7BA,MAAMI,UAAU,CAACC,IAAI,CAACP,aAAaK;AACrC"}

package/src/decorators/controller/add-decorators/add-swagger-params.d.ts

@@ -1,3 +1,3 @@
-import { ControllerFactory } from '../controller.factory';
-import type { IRoute } from '../types';
+import { ControllerFactory } from '../controller.factory.js';
+import type { IRoute } from '../types/index.js';
 export declare function addSwaggerParams(route: IRoute, factory: ControllerFactory): void;

package/src/decorators/controller/add-decorators/add-swagger-params.js

@@ -1,17 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "addSwaggerParams", {
-    enumerable: true,
-    get: function() {
-        return addSwaggerParams;
-    }
-});
-const _reflect = require("../utils/reflect");
-const _swagger = require("@nestjs/swagger");
-function addSwaggerParams(route, factory) {
-    if ((0, _reflect.has)('swagger/apiParameters', factory, route)) return;
+import { has } from "../utils/reflect.js";
+import { ApiParam, ApiQuery } from "@nestjs/swagger";
+/**
+ * add Swagger's \@ApiQuery() and \ApiParam() for each param
+ * @param route
+ */ export function addSwaggerParams(route, factory) {
+    if (has('swagger/apiParameters', factory, route)) return;
     let queryParams = route.queryParams || factory.options?.queryParams;
     queryParams?.map((param)=>{
         // exclude params that doesn't match the route
@@ -42,9 +35,9 @@ function addSwaggerParams(route, factory) {
         }
         // if param.required not provided, set it to false
         param.required = !!param.required;
-        route.decorators.push((0, _swagger.ApiQuery)(param));
+        route.decorators.push(ApiQuery(param));
     });
-    route.pathParams?.map((param)=>route.decorators.push((0, _swagger.ApiParam)(param)));
+    route.pathParams?.map((param)=>route.decorators.push(ApiParam(param)));
 }
 
 //# sourceMappingURL=add-swagger-params.js.map

package/src/decorators/controller/add-decorators/add-swagger-params.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-params.ts"],"sourcesContent":["import { has } from '../utils/reflect';\nimport { ControllerFactory } from '../controller.factory';\nimport type { IRoute } from '../types';\nimport { ApiParam, ApiQuery } from '@nestjs/swagger';\n\n/**\n * add Swagger's \\@ApiQuery() and \\ApiParam() for each param\n * @param route\n */\nexport function addSwaggerParams(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiParameters', factory, route)) return;\n\n  let queryParams = route.queryParams || factory.options?.queryParams;\n  queryParams?.map((param) => {\n    // exclude params that doesn't match the route\n    if (param.many === false && route.many) return;\n    if (param.many === true && !route.many) return;\n\n    if (param.httpMethods && !param.httpMethods.includes(route.httpMethod))\n      return;\n\n    if (!param.type && ['number', 'string'].includes(typeof param.example))\n      param.type = typeof param.example;\n    else if (\n      param.type === 'array' ||\n      (Array.isArray(param?.example) && !param.type && !param.schema)\n    ) {\n      param = {\n        schema: {\n          type: 'array',\n          items: {\n            type: 'string',\n          },\n        },\n        // add items as array to prevent sending items as v1%2Cv2 instead of v1,v2\n        // converts the array into ?key=v1,v2,...\n        style: 'form',\n        // don't generate separate params for each item\n        // i.e. ?key=v1&key=v2\n        explode: false,\n        ...param,\n      };\n\n      delete param.type;\n    }\n\n    // if param.required not provided, set it to false\n    param.required = !!param.required;\n\n    route.decorators.push(ApiQuery(param));\n  });\n\n  route.pathParams?.map((param) => route.decorators.push(ApiParam(param)));\n}\n"],"names":["addSwaggerParams","route","factory","has","queryParams","options","map","param","many","httpMethods","includes","httpMethod","type","example","Array","isArray","schema","items","style","explode","required","decorators","push","ApiQuery","pathParams","ApiParam"],"mappings":";;;;+BASgBA;;;eAAAA;;;yBATI;yBAGe;AAM5B,SAASA,iBAAiBC,KAAa,EAAEC,OAA0B;IACxE,IAAIC,IAAAA,YAAG,EAAC,yBAAyBD,SAASD,QAAQ;IAElD,IAAIG,cAAcH,MAAMG,WAAW,IAAIF,QAAQG,OAAO,EAAED;IACxDA,aAAaE,IAAI,CAACC;QAChB,8CAA8C;QAC9C,IAAIA,MAAMC,IAAI,KAAK,SAASP,MAAMO,IAAI,EAAE;QACxC,IAAID,MAAMC,IAAI,KAAK,QAAQ,CAACP,MAAMO,IAAI,EAAE;QAExC,IAAID,MAAME,WAAW,IAAI,CAACF,MAAME,WAAW,CAACC,QAAQ,CAACT,MAAMU,UAAU,GACnE;QAEF,IAAI,CAACJ,MAAMK,IAAI,IAAI;YAAC;YAAU;SAAS,CAACF,QAAQ,CAAC,OAAOH,MAAMM,OAAO,GACnEN,MAAMK,IAAI,GAAG,OAAOL,MAAMM,OAAO;aAC9B,IACHN,MAAMK,IAAI,KAAK,WACdE,MAAMC,OAAO,CAACR,OAAOM,YAAY,CAACN,MAAMK,IAAI,IAAI,CAACL,MAAMS,MAAM,EAC9D;YACAT,QAAQ;gBACNS,QAAQ;oBACNJ,MAAM;oBACNK,OAAO;wBACLL,MAAM;oBACR;gBACF;gBACA,0EAA0E;gBAC1E,yCAAyC;gBACzCM,OAAO;gBACP,+CAA+C;gBAC/C,sBAAsB;gBACtBC,SAAS;gBACT,GAAGZ,KAAK;YACV;YAEA,OAAOA,MAAMK,IAAI;QACnB;QAEA,kDAAkD;QAClDL,MAAMa,QAAQ,GAAG,CAAC,CAACb,MAAMa,QAAQ;QAEjCnB,MAAMoB,UAAU,CAACC,IAAI,CAACC,IAAAA,iBAAQ,EAAChB;IACjC;IAEAN,MAAMuB,UAAU,EAAElB,IAAI,CAACC,QAAUN,MAAMoB,UAAU,CAACC,IAAI,CAACG,IAAAA,iBAAQ,EAAClB;AAClE"}
+{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-params.ts"],"sourcesContent":["import { has } from '../utils/reflect.js';\nimport { ControllerFactory } from '../controller.factory.js';\nimport type { IRoute } from '../types/index.js';\nimport { ApiParam, ApiQuery } from '@nestjs/swagger';\n\n/**\n * add Swagger's \\@ApiQuery() and \\ApiParam() for each param\n * @param route\n */\nexport function addSwaggerParams(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiParameters', factory, route)) return;\n\n  let queryParams = route.queryParams || factory.options?.queryParams;\n  queryParams?.map((param) => {\n    // exclude params that doesn't match the route\n    if (param.many === false && route.many) return;\n    if (param.many === true && !route.many) return;\n\n    if (param.httpMethods && !param.httpMethods.includes(route.httpMethod))\n      return;\n\n    if (!param.type && ['number', 'string'].includes(typeof param.example))\n      param.type = typeof param.example;\n    else if (\n      param.type === 'array' ||\n      (Array.isArray(param?.example) && !param.type && !param.schema)\n    ) {\n      param = {\n        schema: {\n          type: 'array',\n          items: {\n            type: 'string',\n          },\n        },\n        // add items as array to prevent sending items as v1%2Cv2 instead of v1,v2\n        // converts the array into ?key=v1,v2,...\n        style: 'form',\n        // don't generate separate params for each item\n        // i.e. ?key=v1&key=v2\n        explode: false,\n        ...param,\n      };\n\n      delete param.type;\n    }\n\n    // if param.required not provided, set it to false\n    param.required = !!param.required;\n\n    route.decorators.push(ApiQuery(param));\n  });\n\n  route.pathParams?.map((param) => route.decorators.push(ApiParam(param)));\n}\n"],"names":["has","ApiParam","ApiQuery","addSwaggerParams","route","factory","queryParams","options","map","param","many","httpMethods","includes","httpMethod","type","example","Array","isArray","schema","items","style","explode","required","decorators","push","pathParams"],"mappings":"AAAA,SAASA,GAAG,QAAQ,sBAAsB;AAG1C,SAASC,QAAQ,EAAEC,QAAQ,QAAQ,kBAAkB;AAErD;;;CAGC,GACD,OAAO,SAASC,iBAAiBC,KAAa,EAAEC,OAA0B;IACxE,IAAIL,IAAI,yBAAyBK,SAASD,QAAQ;IAElD,IAAIE,cAAcF,MAAME,WAAW,IAAID,QAAQE,OAAO,EAAED;IACxDA,aAAaE,IAAI,CAACC;QAChB,8CAA8C;QAC9C,IAAIA,MAAMC,IAAI,KAAK,SAASN,MAAMM,IAAI,EAAE;QACxC,IAAID,MAAMC,IAAI,KAAK,QAAQ,CAACN,MAAMM,IAAI,EAAE;QAExC,IAAID,MAAME,WAAW,IAAI,CAACF,MAAME,WAAW,CAACC,QAAQ,CAACR,MAAMS,UAAU,GACnE;QAEF,IAAI,CAACJ,MAAMK,IAAI,IAAI;YAAC;YAAU;SAAS,CAACF,QAAQ,CAAC,OAAOH,MAAMM,OAAO,GACnEN,MAAMK,IAAI,GAAG,OAAOL,MAAMM,OAAO;aAC9B,IACHN,MAAMK,IAAI,KAAK,WACdE,MAAMC,OAAO,CAACR,OAAOM,YAAY,CAACN,MAAMK,IAAI,IAAI,CAACL,MAAMS,MAAM,EAC9D;YACAT,QAAQ;gBACNS,QAAQ;oBACNJ,MAAM;oBACNK,OAAO;wBACLL,MAAM;oBACR;gBACF;gBACA,0EAA0E;gBAC1E,yCAAyC;gBACzCM,OAAO;gBACP,+CAA+C;gBAC/C,sBAAsB;gBACtBC,SAAS;gBACT,GAAGZ,KAAK;YACV;YAEA,OAAOA,MAAMK,IAAI;QACnB;QAEA,kDAAkD;QAClDL,MAAMa,QAAQ,GAAG,CAAC,CAACb,MAAMa,QAAQ;QAEjClB,MAAMmB,UAAU,CAACC,IAAI,CAACtB,SAASO;IACjC;IAEAL,MAAMqB,UAAU,EAAEjB,IAAI,CAACC,QAAUL,MAAMmB,UAAU,CAACC,IAAI,CAACvB,SAASQ;AAClE"}

package/src/decorators/controller/add-decorators/add-swagger-response.d.ts

@@ -1,3 +1,3 @@
-import { ControllerFactory } from '../controller.factory';
-import type { IRoute } from '../types';
+import { ControllerFactory } from '../controller.factory.js';
+import type { IRoute } from '../types/index.js';
 export declare function addSwaggerResponse(route: IRoute, factory: ControllerFactory): void;

package/src/decorators/controller/add-decorators/add-swagger-response.js

@@ -1,33 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "addSwaggerResponse", {
-    enumerable: true,
-    get: function() {
-        return addSwaggerResponse;
-    }
-});
-const _reflect = require("../utils/reflect");
-const _common = require("@nestjs/common");
-const _swagger = require("@nestjs/swagger");
-function addSwaggerResponse(route, factory) {
-    if ((0, _reflect.has)('swagger/apiResponse', factory, route)) return;
+import { has } from "../utils/reflect.js";
+import { HttpStatus } from "@nestjs/common";
+import { ApiResponse } from "@nestjs/swagger";
+export function addSwaggerResponse(route, factory) {
+    if (has('swagger/apiResponse', factory, route)) return;
     let responseModel = route.responseModel || route.model || factory.options?.model;
     // todo: add other status responses
     // todo: add options.responseModels[status] -> example: response models for 200, 401, 500, ...
-    route.decorators.push((0, _swagger.ApiResponse)({
-        status: _common.HttpStatus.OK,
+    route.decorators.push(ApiResponse({
+        status: HttpStatus.OK,
         type: route.many ? [
             responseModel
         ] : responseModel
-    }), (0, _swagger.ApiResponse)({
-        status: _common.HttpStatus.INTERNAL_SERVER_ERROR,
+    }), ApiResponse({
+        status: HttpStatus.INTERNAL_SERVER_ERROR,
         type: route.errorResponseModel || factory.options?.errorResponseModel
     }), ...[
         ...factory.options?.responseModels || [],
         ...route.responseModels || []
-    ].map((model)=>(0, _swagger.ApiResponse)(model)));
+    ].map((model)=>ApiResponse(model)));
 }
 
 //# sourceMappingURL=add-swagger-response.js.map

package/src/decorators/controller/add-decorators/add-swagger-response.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-response.ts"],"sourcesContent":["import { has } from '../utils/reflect';\nimport { ControllerFactory } from '../controller.factory';\nimport type { IRoute } from '../types';\nimport { HttpStatus } from '@nestjs/common';\nimport { ApiResponse } from '@nestjs/swagger';\n\nexport function addSwaggerResponse(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiResponse', factory, route)) return;\n\n  let responseModel =\n    route.responseModel || route.model || factory.options?.model;\n\n  // todo: add other status responses\n  // todo: add options.responseModels[status] -> example: response models for 200, 401, 500, ...\n  route.decorators.push(\n    ApiResponse({\n      status: HttpStatus.OK,\n      type: route.many ? [responseModel] : responseModel,\n    }),\n    ApiResponse({\n      status: HttpStatus.INTERNAL_SERVER_ERROR,\n      type: route.errorResponseModel || factory.options?.errorResponseModel,\n    }),\n    ...[\n      ...(factory.options?.responseModels || []),\n      ...(route.responseModels || []),\n    ].map((model) => ApiResponse(model)),\n  );\n}\n"],"names":["addSwaggerResponse","route","factory","has","responseModel","model","options","decorators","push","ApiResponse","status","HttpStatus","OK","type","many","INTERNAL_SERVER_ERROR","errorResponseModel","responseModels","map"],"mappings":";;;;+BAMgBA;;;eAAAA;;;yBANI;wBAGO;yBACC;AAErB,SAASA,mBAAmBC,KAAa,EAAEC,OAA0B;IAC1E,IAAIC,IAAAA,YAAG,EAAC,uBAAuBD,SAASD,QAAQ;IAEhD,IAAIG,gBACFH,MAAMG,aAAa,IAAIH,MAAMI,KAAK,IAAIH,QAAQI,OAAO,EAAED;IAEzD,mCAAmC;IACnC,8FAA8F;IAC9FJ,MAAMM,UAAU,CAACC,IAAI,CACnBC,IAAAA,oBAAW,EAAC;QACVC,QAAQC,kBAAU,CAACC,EAAE;QACrBC,MAAMZ,MAAMa,IAAI,GAAG;YAACV;SAAc,GAAGA;IACvC,IACAK,IAAAA,oBAAW,EAAC;QACVC,QAAQC,kBAAU,CAACI,qBAAqB;QACxCF,MAAMZ,MAAMe,kBAAkB,IAAId,QAAQI,OAAO,EAAEU;IACrD,OACG;WACGd,QAAQI,OAAO,EAAEW,kBAAkB,EAAE;WACrChB,MAAMgB,cAAc,IAAI,EAAE;KAC/B,CAACC,GAAG,CAAC,CAACb,QAAUI,IAAAA,oBAAW,EAACJ;AAEjC"}
+{"version":3,"sources":["../../../../../src/decorators/controller/add-decorators/add-swagger-response.ts"],"sourcesContent":["import { has } from '../utils/reflect.js';\nimport { ControllerFactory } from '../controller.factory.js';\nimport type { IRoute } from '../types/index.js';\nimport { HttpStatus } from '@nestjs/common';\nimport { ApiResponse } from '@nestjs/swagger';\n\nexport function addSwaggerResponse(route: IRoute, factory: ControllerFactory) {\n  if (has('swagger/apiResponse', factory, route)) return;\n\n  let responseModel =\n    route.responseModel || route.model || factory.options?.model;\n\n  // todo: add other status responses\n  // todo: add options.responseModels[status] -> example: response models for 200, 401, 500, ...\n  route.decorators.push(\n    ApiResponse({\n      status: HttpStatus.OK,\n      type: route.many ? [responseModel] : responseModel,\n    }),\n    ApiResponse({\n      status: HttpStatus.INTERNAL_SERVER_ERROR,\n      type: route.errorResponseModel || factory.options?.errorResponseModel,\n    }),\n    ...[\n      ...(factory.options?.responseModels || []),\n      ...(route.responseModels || []),\n    ].map((model) => ApiResponse(model)),\n  );\n}\n"],"names":["has","HttpStatus","ApiResponse","addSwaggerResponse","route","factory","responseModel","model","options","decorators","push","status","OK","type","many","INTERNAL_SERVER_ERROR","errorResponseModel","responseModels","map"],"mappings":"AAAA,SAASA,GAAG,QAAQ,sBAAsB;AAG1C,SAASC,UAAU,QAAQ,iBAAiB;AAC5C,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,OAAO,SAASC,mBAAmBC,KAAa,EAAEC,OAA0B;IAC1E,IAAIL,IAAI,uBAAuBK,SAASD,QAAQ;IAEhD,IAAIE,gBACFF,MAAME,aAAa,IAAIF,MAAMG,KAAK,IAAIF,QAAQG,OAAO,EAAED;IAEzD,mCAAmC;IACnC,8FAA8F;IAC9FH,MAAMK,UAAU,CAACC,IAAI,CACnBR,YAAY;QACVS,QAAQV,WAAWW,EAAE;QACrBC,MAAMT,MAAMU,IAAI,GAAG;YAACR;SAAc,GAAGA;IACvC,IACAJ,YAAY;QACVS,QAAQV,WAAWc,qBAAqB;QACxCF,MAAMT,MAAMY,kBAAkB,IAAIX,QAAQG,OAAO,EAAEQ;IACrD,OACG;WACGX,QAAQG,OAAO,EAAES,kBAAkB,EAAE;WACrCb,MAAMa,cAAc,IAAI,EAAE;KAC/B,CAACC,GAAG,CAAC,CAACX,QAAUL,YAAYK;AAEjC"}

package/src/decorators/controller/controller.decorator.d.ts

@@ -1,2 +1,2 @@
-import type { ControllerOptions, InitControllerOptions } from './types';
+import type { ControllerOptions, InitControllerOptions } from './types/index.js';
 export declare function Controller(options?: InitControllerOptions | ((defaultOptions: ControllerOptions) => ControllerOptions)): ClassDecorator;

package/src/decorators/controller/controller.decorator.js

@@ -1,17 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "Controller", {
-    enumerable: true,
-    get: function() {
-        return Controller;
-    }
-});
-const _controllerfactory = require("./controller.factory");
-function Controller(options) {
+import { ControllerFactory } from "./controller.factory.js";
+/**
+ * Mark a class as a controller and automatically generate its crud routes, and add swagger decorators
+ * This decorator must be placed before other decorators to avoid overriding their values
+ * otherwise, you can disable any functionality by setting it to `null`
+ * for instance `@ApiTags("users"); @Controller("my-users")`
+ * may cause that the value of `ApiTags` to be replaced
+ * either place `@Controller()` first, or use `@Controller({tags: null})`
+ * @param options
+ * @returns
+ */ export function Controller(options) {
     return (target)=>{
-        new _controllerfactory.ControllerFactory(target, options);
+        new ControllerFactory(target, options);
     };
 }
 

package/src/decorators/controller/controller.decorator.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/decorators/controller/controller.decorator.ts"],"sourcesContent":["import { ControllerFactory } from './controller.factory';\nimport type { ControllerOptions, InitControllerOptions } from './types';\n\n/**\n * Mark a class as a controller and automatically generate its crud routes, and add swagger decorators\n * This decorator must be placed before other decorators to avoid overriding their values\n * otherwise, you can disable any functionality by setting it to `null`\n * for instance `@ApiTags(\"users\"); @Controller(\"my-users\")`\n * may cause that the value of `ApiTags` to be replaced\n * either place `@Controller()` first, or use `@Controller({tags: null})`\n * @param options\n * @returns\n */\nexport function Controller(\n  options?:\n    | InitControllerOptions\n    | ((defaultOptions: ControllerOptions) => ControllerOptions),\n): ClassDecorator {\n  return (target: Function) => {\n    new ControllerFactory(target, options);\n  };\n}\n"],"names":["Controller","options","target","ControllerFactory"],"mappings":";;;;+BAagBA;;;eAAAA;;;mCAbkB;AAa3B,SAASA,WACdC,OAE8D;IAE9D,OAAO,CAACC;QACN,IAAIC,oCAAiB,CAACD,QAAQD;IAChC;AACF"}
+{"version":3,"sources":["../../../../src/decorators/controller/controller.decorator.ts"],"sourcesContent":["import { ControllerFactory } from './controller.factory.js';\nimport type {\n  ControllerOptions,\n  InitControllerOptions,\n} from './types/index.js';\n\n/**\n * Mark a class as a controller and automatically generate its crud routes, and add swagger decorators\n * This decorator must be placed before other decorators to avoid overriding their values\n * otherwise, you can disable any functionality by setting it to `null`\n * for instance `@ApiTags(\"users\"); @Controller(\"my-users\")`\n * may cause that the value of `ApiTags` to be replaced\n * either place `@Controller()` first, or use `@Controller({tags: null})`\n * @param options\n * @returns\n */\nexport function Controller(\n  options?:\n    | InitControllerOptions\n    | ((defaultOptions: ControllerOptions) => ControllerOptions),\n): ClassDecorator {\n  return (target: Function) => {\n    new ControllerFactory(target, options);\n  };\n}\n"],"names":["ControllerFactory","Controller","options","target"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,0BAA0B;AAM5D;;;;;;;;;CASC,GACD,OAAO,SAASC,WACdC,OAE8D;IAE9D,OAAO,CAACC;QACN,IAAIH,kBAAkBG,QAAQD;IAChC;AACF"}

package/src/decorators/controller/controller.factory.d.ts

@@ -1,4 +1,4 @@
-import type { ControllerOptions, InitControllerOptions, InitRoute } from './types';
+import type { ControllerOptions, InitControllerOptions, InitRoute } from './types/index.js';
 export declare class ControllerFactory {
     controller: Function;
     options: ControllerOptions;

package/src/decorators/controller/controller.factory.js

@@ -1,28 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "ControllerFactory", {
-    enumerable: true,
-    get: function() {
-        return ControllerFactory;
+import { Body, Param, Query, Req } from "@nestjs/common";
+import { addHttpMethod } from "./add-decorators/add-http-method.js";
+import { addSwaggerParams } from "./add-decorators/add-swagger-params.js";
+import { routeHandler } from "./route-handler.js";
+import { addSwaggerOperation } from "./add-decorators/add-swagger-operation.js";
+import { addSwaggerBody } from "./add-decorators/add-swagger-body.js";
+import { addSwaggerResponse } from "./add-decorators/add-swagger-response.js";
+import { QueryInterceptor } from "./interceptors/query.interceptor.js";
+import { defaultOptions } from "./default-options.js";
+import { mergeOptions } from "./utils/merge-options.js";
+import { addControllerTags } from "./add-decorators/add-controller-tags.js";
+import { merge, mergeByKey, removeValues } from "@impactor/javascript";
+import { applyDecorators } from "./utils/reflect.js";
+import { addControllerPath } from "./add-decorators/add-controller-path.js";
+import { toKebabCase } from "@impactor/javascript";
+// import 'reflect-metadata';
+export class ControllerFactory {
+    constructor(controller, //  if options is provided as a function, the consumer has to maintain the merge strategy
+    options){
+        this.controller = controller;
+        this.decorators = [];
+        this.options = typeof options === 'function' ? // we'll need to call it again after receiving the user options to adjust its routes
+        options(this.adjustRoutes(defaultOptions)) : mergeOptions(defaultOptions, options || {});
+        this.options = this.adjustRoutes({
+            ...this.options,
+            // todo: merge matched routes instead of overriding them
+            // i.e. routes with the same methodName, httpMethod, and path
+            routes: [
+                ...this.options.routes || [],
+                ...this.getExistingMethods()
+            ]
+        });
+        // if path is not provided, use the class name, without the suffix `Controller`,
+        // after converting it into url-friendly kebab-case
+        if (this.options.path === undefined) {
+            this.options.path = toKebabCase(this.controller.name.replace(/Controller$/, ''));
+        }
+        this.createRoutes();
+        this.mergeRoutes();
+        addControllerPath(this);
+        addControllerTags(this);
+        applyDecorators(this);
     }
-});
-const _common = require("@nestjs/common");
-const _addhttpmethod = require("./add-decorators/add-http-method");
-const _addswaggerparams = require("./add-decorators/add-swagger-params");
-const _routehandler = require("./route-handler");
-const _addswaggeroperation = require("./add-decorators/add-swagger-operation");
-const _addswaggerbody = require("./add-decorators/add-swagger-body");
-const _addswaggerresponse = require("./add-decorators/add-swagger-response");
-const _queryinterceptor = require("./interceptors/query.interceptor");
-const _defaultoptions = require("./default-options");
-const _mergeoptions = require("./utils/merge-options");
-const _addcontrollertags = require("./add-decorators/add-controller-tags");
-const _javascript = require("@impactor/javascript");
-const _reflect = require("./utils/reflect");
-const _addcontrollerpath = require("./add-decorators/add-controller-path");
-let ControllerFactory = class ControllerFactory {
     getExistingMethods() {
         let proto = this.controller.prototype;
         return Reflect.ownKeys(proto).filter((key)=>typeof proto[key] === 'function')// convert symbol to string
@@ -113,10 +131,10 @@ let ControllerFactory = class ControllerFactory {
                 // todo: we may need to exclude other keys that have a class value such as errorResponseModel
                 let { routes, model, ...otherOptions } = opts;
                 // todo: use merge()?
-                route = (0, _javascript.merge)([
+                route = merge([
                     otherOptions || {},
                     route || {}
-                ].map((el)=>(0, _javascript.removeValues)(el, [
+                ].map((el)=>removeValues(el, [
                         undefined,
                         null
                     ])));
@@ -139,7 +157,7 @@ let ControllerFactory = class ControllerFactory {
                 //       opts[key as keyof typeof opts] || [];
                 //   }
                 // });
-                route.interceptors.push(new _queryinterceptor.QueryInterceptor((0, _javascript.merge)([
+                route.interceptors.push(new QueryInterceptor(merge([
                     opts.query || {},
                     route.query || {}
                 ])));
@@ -155,22 +173,22 @@ let ControllerFactory = class ControllerFactory {
             // create a route method and add it to the controller
             // todo: use interceptor to create ParsedRequest
             if (!controller[route.methodName]) {
-                controller[route.methodName] = (0, _routehandler.routeHandler)(route, this);
+                controller[route.methodName] = routeHandler(route, this);
                 // inject the required params
                 // similar to patchOne(@Req() req: Request, @Query() query, @Body() dto: MyEntity, @Param("id") id:string)
                 // we can get other info such as body and params from req
                 // without the need to inject @Body() and @Query()
                 // todo: route.primary || getPrimaryKeyFromEntity(opts.model) || "id"
                 let paramKey = route.primaryKey || 'id';
-                (0, _common.Req)()(this.controller.prototype, route.methodName, 0);
-                (0, _common.Query)()(this.controller.prototype, route.methodName, 1);
+                Req()(this.controller.prototype, route.methodName, 0);
+                Query()(this.controller.prototype, route.methodName, 1);
                 if ([
                     'GET',
                     'DELETE'
                 ].includes(route.httpMethod) && !route.many) {
-                    (0, _common.Param)(paramKey)(this.controller.prototype, route.methodName, 2);
+                    Param(paramKey)(this.controller.prototype, route.methodName, 2);
                 } else if (route.httpMethod === 'POST') {
-                    (0, _common.Body)()(this.controller.prototype, route.methodName, 2);
+                    Body()(this.controller.prototype, route.methodName, 2);
                     // add 'design:paramtypes' to define the types of each param
                     // for instance, the param `@Body()` should be defined as `this.options.model`,
                     // so `ValidationPipe()` can work fine.
@@ -187,7 +205,7 @@ let ControllerFactory = class ControllerFactory {
                     'PATCH',
                     'PUT'
                 ].includes(route.httpMethod)) {
-                    (0, _common.Body)()(this.controller.prototype, route.methodName, 2);
+                    Body()(this.controller.prototype, route.methodName, 2);
                     if (route.many) {
                         Reflect.defineMetadata('design:paramtypes', [
                             Object,
@@ -199,7 +217,7 @@ let ControllerFactory = class ControllerFactory {
                         // todo: accept list of pipes for each param -> `Param(paramName, ...pipes)(...)`
                         // to accept only string or number -> add a validation in routerHandler i.e. `if(! typeof params[paramKey]) throw ...`,
                         // as class-validator will not validate its type because it is not a DTO i.e. `getOne(@param() params: ParamsDTO)`
-                        (0, _common.Param)(paramKey)(this.controller.prototype, route.methodName, 3);
+                        Param(paramKey)(this.controller.prototype, route.methodName, 3);
                         Reflect.defineMetadata('design:paramtypes', [
                             Object,
                             Object,
@@ -216,46 +234,20 @@ let ControllerFactory = class ControllerFactory {
             // if the method is not listed and doesn't has @Route(), the annotations will not be added
             // if no http decorator already applied such as @GET()
             // when adding @Get(), nest adds "method" and "path" metadata
-            (0, _addhttpmethod.addHttpMethod)(route, this);
-            (0, _addswaggeroperation.addSwaggerOperation)(route, this);
-            (0, _addswaggerparams.addSwaggerParams)(route, this);
-            (0, _addswaggerbody.addSwaggerBody)(route, this);
-            (0, _addswaggerresponse.addSwaggerResponse)(route, this);
+            addHttpMethod(route, this);
+            addSwaggerOperation(route, this);
+            addSwaggerParams(route, this);
+            addSwaggerBody(route, this);
+            addSwaggerResponse(route, this);
         }
     }
     /**
    * Merges routes that share the same methodName.
    */ mergeRoutes() {
-        this.options.routes = (0, _javascript.mergeByKey)(this.options.routes, 'methodName', {
+        this.options.routes = mergeByKey(this.options.routes, 'methodName', {
             deep: true
         });
     }
-    constructor(controller, //  if options is provided as a function, the consumer has to maintain the merge strategy
-    options){
-        this.controller = controller;
-        this.decorators = [];
-        this.options = typeof options === 'function' ? // we'll need to call it again after receiving the user options to adjust its routes
-        options(this.adjustRoutes(_defaultoptions.defaultOptions)) : (0, _mergeoptions.mergeOptions)(_defaultoptions.defaultOptions, options || {});
-        this.options = this.adjustRoutes({
-            ...this.options,
-            // todo: merge matched routes instead of overriding them
-            // i.e. routes with the same methodName, httpMethod, and path
-            routes: [
-                ...this.options.routes || [],
-                ...this.getExistingMethods()
-            ]
-        });
-        // if path is not provided, use the class name, without the suffix `Controller`,
-        // after converting it into url-friendly kebab-case
-        if (this.options.path === undefined) {
-            this.options.path = (0, _javascript.toKebabCase)(this.controller.name.replace(/Controller$/, ''));
-        }
-        this.createRoutes();
-        this.mergeRoutes();
-        (0, _addcontrollerpath.addControllerPath)(this);
-        (0, _addcontrollertags.addControllerTags)(this);
-        (0, _reflect.applyDecorators)(this);
-    }
-};
+}
 
 //# sourceMappingURL=controller.factory.js.map

package/src/decorators/controller/controller.factory.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/decorators/controller/controller.factory.ts"],"sourcesContent":["import { Body, Param, Query, Req } from '@nestjs/common';\nimport type {\n  ControllerOptions,\n  HttpMethod,\n  InitControllerOptions,\n  InitRoute,\n  IRoute,\n} from './types';\nimport { addHttpMethod } from './add-decorators/add-http-method';\nimport { addSwaggerParams } from './add-decorators/add-swagger-params';\nimport { routeHandler } from './route-handler';\nimport { addSwaggerOperation } from './add-decorators/add-swagger-operation';\nimport { addSwaggerBody } from './add-decorators/add-swagger-body';\nimport { addSwaggerResponse } from './add-decorators/add-swagger-response';\nimport { QueryInterceptor } from './interceptors/query.interceptor';\nimport { defaultOptions } from './default-options';\nimport { mergeOptions } from './utils/merge-options';\nimport { addControllerTags } from './add-decorators/add-controller-tags';\nimport { merge, mergeByKey, removeValues } from '@impactor/javascript';\nimport { applyDecorators } from './utils/reflect';\nimport { addControllerPath } from './add-decorators/add-controller-path';\nimport { toKebabCase } from '@impactor/javascript';\n// import 'reflect-metadata';\n\nexport class ControllerFactory {\n  public options: ControllerOptions;\n  public decorators: ClassDecorator[] = [];\n\n  constructor(\n    public controller: Function,\n    //  if options is provided as a function, the consumer has to maintain the merge strategy\n    options?:\n      | InitControllerOptions\n      | ((defaultOptions: ControllerOptions) => ControllerOptions),\n  ) {\n    this.options =\n      typeof options === 'function'\n        ? // The consumer should receive the adjusted routes, so we need to call `adjustRoutes()` here\n          // we'll need to call it again after receiving the user options to adjust its routes\n          options(this.adjustRoutes(defaultOptions))\n        : mergeOptions(defaultOptions, options || {});\n\n    this.options = this.adjustRoutes({\n      ...this.options,\n      // todo: merge matched routes instead of overriding them\n      // i.e. routes with the same methodName, httpMethod, and path\n      routes: [...(this.options.routes || []), ...this.getExistingMethods()],\n    });\n\n    // if path is not provided, use the class name, without the suffix `Controller`,\n    // after converting it into url-friendly kebab-case\n    if (this.options.path === undefined) {\n      this.options.path = toKebabCase(\n        this.controller.name.replace(/Controller$/, ''),\n      );\n    }\n\n    this.createRoutes();\n    this.mergeRoutes();\n\n    addControllerPath(this);\n    addControllerTags(this);\n\n    applyDecorators(this);\n  }\n\n  getExistingMethods() {\n    let proto = this.controller.prototype;\n\n    return (\n      Reflect.ownKeys(proto)\n        .filter((key) => typeof proto[key] === 'function')\n        // convert symbol to string\n        .map(String)\n        .filter(\n          (key) =>\n            key !== 'constructor' &&\n            // a method can be excluded from being handling by this factory, by adding `@Route(false)`\n            Reflect.getMetadata('routeOptions', proto, key) !== false &&\n            // skip methods that are already included in routes[]\n            !this.options.routes?.some((route) => route.methodName === key),\n        )\n        // convert method to InitRoute{}\n        .map((methodName) => {\n          let routeOptions: InitRoute = Reflect.getMetadata(\n            'routeOptions',\n            proto,\n            methodName,\n          );\n\n          return {\n            methodName,\n            path: Reflect.getMetadata('path', proto[methodName]),\n            ...routeOptions,\n          } as InitRoute;\n        })\n    );\n  }\n  /**\n   * add all missing props to each route, uch as the HTTP method, primaryKey, and operationId .\n   * @param opts\n   * @returns\n   */\n  adjustRoutes(opts: InitControllerOptions = this.options): ControllerOptions {\n    return <ControllerOptions>{\n      ...opts,\n      routes: opts?.routes?.map((el) => {\n        let route = { ...el };\n\n        // NestJs request methods\n        let requestMethods = [\n          'GET',\n          'POST',\n          'PUT',\n          'DELETE',\n          'PATCH',\n          'ALL',\n          'OPTIONS',\n          'HEAD',\n          'SEARCH',\n        ];\n        // capitalize route.httpMethod to much the HttpMethod type\n        route.httpMethod = <HttpMethod>(\n          (typeof route.httpMethod === 'number'\n            ? requestMethods[route.httpMethod]\n            : (<HttpMethod>route.httpMethod)?.toUpperCase() || 'GET')\n        );\n        route.primaryKey = route.primaryKey || opts.primaryKey || 'id';\n\n        // generate the default methodName from path\n        // examples\n        //   - {path: \"users/:id\"} -> \"getOneUserById\"\n        //   - {path: \"users/:userId/profiles/:profileId/posts\", many:true} -> \"getManyUsersByUserIdProfilesProfileIdPosts\"\n        route.methodName =\n          route.methodName ||\n          route.httpMethod.toLowerCase() +\n            (route.httpMethod === 'POST' ? '' : route.many ? 'Many' : 'One');\n\n        route.operationId =\n          route.operationId ||\n          `${this.controller.name}_${String(route.methodName)}`;\n\n        if (!route.path) {\n          // for \"*One()\" operations, add /:id path param\n          // example: GET /users/:id\n          route.path =\n            route.many || ['POST'].includes(route.httpMethod)\n              ? '/'\n              : `/:${route.primaryKey}`;\n        }\n\n        route.pathParams = route.pathParams\n          ? route.pathParams.map((param) =>\n              typeof param === 'string'\n                ? { name: param, schema: { type: 'string' }, required: true }\n                : param,\n            )\n          : // generate path params from route.path\n            // matches `:id`, `/:id` and `other/:id/:userId`\n            [...route.path.matchAll(/^\\/?:([^/]+)/g)].map((match) => ({\n              name: match[1],\n              schema: { type: 'string' },\n              required: true,\n            }));\n\n        // todo: generate the corresponding service methods\n        //  +route.path\n        //     // remove the leading \"/\"\n        //     .replace(/^\\//, '')\n        //     .replace(/^:/,'By')\n        //     // replace \"/:id\" with \"ById\"\n        //     .replaceAll(/\\/:/g, '/By')\n        //     .split('/')\n        //     // convert parts to camel case\n        //     // example: \"users/profiles\" -> \"usersProfiles\"\n        //     .map((el, idx) =>\n        //       idx === 0 ? el : el.charAt(0).toUpperCase() + el.slice(1),\n        //     )\n        //     .join('');\n\n        // override options per route\n        // for example: route.primaryKey = route.primaryKey || opts.primaryKey\n        // when opts.model is a class that extends another class, an exception is thrown `OtherClass is not defined`\n        // todo: we may need to exclude other keys that have a class value such as errorResponseModel\n        let { routes, model, ...otherOptions } = opts;\n        // todo: use merge()?\n        route = <IRoute>(\n          merge(\n            [otherOptions || {}, route || {}].map((el) =>\n              removeValues(el, [undefined, null]),\n            ),\n          )\n        );\n\n        // merge arrays\n        // todo: use mergeArray()?\n        ['decorators', 'interceptors'].map((key) => {\n          route[key as keyof typeof route] = [\n            ...(opts[key as keyof typeof opts] || []),\n            ...(route[key as keyof typeof route] || []),\n          ];\n        });\n\n        // merge empty arrays\n        // for example if route.interceptors=[] but opts.interceptors has values, opts.interceptors is used\n        // Object.keys(opts).map((key) => {\n        //   if (Array.isArray(key) && !route[key as keyof typeof route]?.length) {\n        //     route[key as keyof typeof route] =\n        //       opts[key as keyof typeof opts] || [];\n        //   }\n        // });\n\n        route.interceptors!.push(\n          new QueryInterceptor(\n            merge([opts.query || {}, route.query || {}]) as {\n              [key: string]: any;\n            },\n          ),\n        );\n\n        return route;\n      }),\n    };\n  }\n\n  /**\n   * add options.routes[] as class methods\n   */\n  createRoutes() {\n    let routes = this.options.routes?.filter(\n        (route) => route.disabled === undefined || !route.disabled,\n      ),\n      controller = this.controller.prototype;\n\n    for (let route of routes) {\n      // create a route method and add it to the controller\n      // todo: use interceptor to create ParsedRequest\n      if (!controller[route.methodName]) {\n        controller[route.methodName] = routeHandler(route, this);\n\n        // inject the required params\n        // similar to patchOne(@Req() req: Request, @Query() query, @Body() dto: MyEntity, @Param(\"id\") id:string)\n        // we can get other info such as body and params from req\n        // without the need to inject @Body() and @Query()\n        // todo: route.primary || getPrimaryKeyFromEntity(opts.model) || \"id\"\n        let paramKey = route.primaryKey || 'id';\n        Req()(this.controller.prototype, route.methodName, 0);\n        Query()(this.controller.prototype, route.methodName, 1);\n\n        if (['GET', 'DELETE'].includes(route.httpMethod) && !route.many) {\n          Param(paramKey)(this.controller.prototype, route.methodName, 2);\n        } else if (route.httpMethod === 'POST') {\n          Body()(this.controller.prototype, route.methodName, 2);\n          // add 'design:paramtypes' to define the types of each param\n          // for instance, the param `@Body()` should be defined as `this.options.model`,\n          // so `ValidationPipe()` can work fine.\n          // without it, wrong body will bypass class-validator and class-transformer decorators such as `@IsString()`\n          Reflect.defineMetadata(\n            'design:paramtypes',\n            // 0: `@Req() req: Request`\n            // 1: `@Query() query: any` -> todo: add type definition\n            // 2: `@Body() body: Model`\n            [Request, Object, this.options.model],\n            this.controller.prototype,\n            route.methodName,\n          );\n        } else if (['PATCH', 'PUT'].includes(route.httpMethod)) {\n          Body()(this.controller.prototype, route.methodName, 2);\n          if (route.many) {\n            Reflect.defineMetadata(\n              'design:paramtypes',\n              [Object, Object, this.options.model],\n              this.controller.prototype,\n              route.methodName,\n            );\n          } else {\n            // todo: or use `Param()` without `paramKey`, then use it like param[paramKey]\n            // todo: accept list of pipes for each param -> `Param(paramName, ...pipes)(...)`\n            // to accept only string or number -> add a validation in routerHandler i.e. `if(! typeof params[paramKey]) throw ...`,\n            // as class-validator will not validate its type because it is not a DTO i.e. `getOne(@param() params: ParamsDTO)`\n            Param(paramKey)(this.controller.prototype, route.methodName, 3);\n            Reflect.defineMetadata(\n              'design:paramtypes',\n              [Object, Object, this.options.model, Object],\n              this.controller.prototype,\n              route.methodName,\n            );\n          }\n        }\n      }\n\n      // add decorators to the route\n      // annotations are added only if:\n      // - the method listed in this.options.routes[] and doesn't has @Route(false)\n      // - the method is not listed and has @Route(options?)\n      // if the method is not listed and doesn't has @Route(), the annotations will not be added\n      // if no http decorator already applied such as @GET()\n      // when adding @Get(), nest adds \"method\" and \"path\" metadata\n      addHttpMethod(route, this);\n      addSwaggerOperation(route, this);\n      addSwaggerParams(route, this);\n      addSwaggerBody(route, this);\n      addSwaggerResponse(route, this);\n    }\n  }\n\n  /**\n   * Merges routes that share the same methodName.\n   */\n  mergeRoutes() {\n    this.options.routes = mergeByKey<IRoute>(\n      this.options.routes,\n      'methodName',\n      {\n        deep: true,\n      },\n    );\n  }\n}\n"],"names":["ControllerFactory","getExistingMethods","proto","controller","prototype","Reflect","ownKeys","filter","key","map","String","getMetadata","options","routes","some","route","methodName","routeOptions","path","adjustRoutes","opts","el","requestMethods","httpMethod","toUpperCase","primaryKey","toLowerCase","many","operationId","name","includes","pathParams","param","schema","type","required","matchAll","match","model","otherOptions","merge","removeValues","undefined","interceptors","push","QueryInterceptor","query","createRoutes","disabled","routeHandler","paramKey","Req","Query","Param","Body","defineMetadata","Request","Object","addHttpMethod","addSwaggerOperation","addSwaggerParams","addSwaggerBody","addSwaggerResponse","mergeRoutes","mergeByKey","deep","decorators","defaultOptions","mergeOptions","toKebabCase","replace","addControllerPath","addControllerTags","applyDecorators"],"mappings":";;;;+BAwBaA;;;eAAAA;;;wBAxB2B;+BAQV;kCACG;8BACJ;qCACO;gCACL;oCACI;kCACF;gCACF;8BACF;mCACK;4BACc;yBAChB;mCACE;AAI3B,IAAA,AAAMA,oBAAN,MAAMA;IA0CXC,qBAAqB;QACnB,IAAIC,QAAQ,IAAI,CAACC,UAAU,CAACC,SAAS;QAErC,OACEC,QAAQC,OAAO,CAACJ,OACbK,MAAM,CAAC,CAACC,MAAQ,OAAON,KAAK,CAACM,IAAI,KAAK,WACvC,2BAA2B;SAC1BC,GAAG,CAACC,QACJH,MAAM,CACL,CAACC,MACCA,QAAQ,iBACR,0FAA0F;YAC1FH,QAAQM,WAAW,CAAC,gBAAgBT,OAAOM,SAAS,SACpD,qDAAqD;YACrD,CAAC,IAAI,CAACI,OAAO,CAACC,MAAM,EAAEC,KAAK,CAACC,QAAUA,MAAMC,UAAU,KAAKR,KAE/D,gCAAgC;SAC/BC,GAAG,CAAC,CAACO;YACJ,IAAIC,eAA0BZ,QAAQM,WAAW,CAC/C,gBACAT,OACAc;YAGF,OAAO;gBACLA;gBACAE,MAAMb,QAAQM,WAAW,CAAC,QAAQT,KAAK,CAACc,WAAW;gBACnD,GAAGC,YAAY;YACjB;QACF;IAEN;IACA;;;;GAIC,GACDE,aAAaC,OAA8B,IAAI,CAACR,OAAO,EAAqB;QAC1E,OAA0B;YACxB,GAAGQ,IAAI;YACPP,QAAQO,MAAMP,QAAQJ,IAAI,CAACY;gBACzB,IAAIN,QAAQ;oBAAE,GAAGM,EAAE;gBAAC;gBAEpB,yBAAyB;gBACzB,IAAIC,iBAAiB;oBACnB;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;iBACD;gBACD,0DAA0D;gBAC1DP,MAAMQ,UAAU,GACb,OAAOR,MAAMQ,UAAU,KAAK,WACzBD,cAAc,CAACP,MAAMQ,UAAU,CAAC,GAChC,AAAaR,MAAMQ,UAAU,EAAGC,iBAAiB;gBAEvDT,MAAMU,UAAU,GAAGV,MAAMU,UAAU,IAAIL,KAAKK,UAAU,IAAI;gBAE1D,4CAA4C;gBAC5C,WAAW;gBACX,8CAA8C;gBAC9C,mHAAmH;gBACnHV,MAAMC,UAAU,GACdD,MAAMC,UAAU,IAChBD,MAAMQ,UAAU,CAACG,WAAW,KACzBX,CAAAA,MAAMQ,UAAU,KAAK,SAAS,KAAKR,MAAMY,IAAI,GAAG,SAAS,KAAI;gBAElEZ,MAAMa,WAAW,GACfb,MAAMa,WAAW,IACjB,GAAG,IAAI,CAACzB,UAAU,CAAC0B,IAAI,CAAC,CAAC,EAAEnB,OAAOK,MAAMC,UAAU,GAAG;gBAEvD,IAAI,CAACD,MAAMG,IAAI,EAAE;oBACf,+CAA+C;oBAC/C,0BAA0B;oBAC1BH,MAAMG,IAAI,GACRH,MAAMY,IAAI,IAAI;wBAAC;qBAAO,CAACG,QAAQ,CAACf,MAAMQ,UAAU,IAC5C,MACA,CAAC,EAAE,EAAER,MAAMU,UAAU,EAAE;gBAC/B;gBAEAV,MAAMgB,UAAU,GAAGhB,MAAMgB,UAAU,GAC/BhB,MAAMgB,UAAU,CAACtB,GAAG,CAAC,CAACuB,QACpB,OAAOA,UAAU,WACb;wBAAEH,MAAMG;wBAAOC,QAAQ;4BAAEC,MAAM;wBAAS;wBAAGC,UAAU;oBAAK,IAC1DH,SAGN,gDAAgD;gBAChD;uBAAIjB,MAAMG,IAAI,CAACkB,QAAQ,CAAC;iBAAiB,CAAC3B,GAAG,CAAC,CAAC4B,QAAW,CAAA;wBACxDR,MAAMQ,KAAK,CAAC,EAAE;wBACdJ,QAAQ;4BAAEC,MAAM;wBAAS;wBACzBC,UAAU;oBACZ,CAAA;gBAEJ,mDAAmD;gBACnD,eAAe;gBACf,gCAAgC;gBAChC,0BAA0B;gBAC1B,0BAA0B;gBAC1B,oCAAoC;gBACpC,iCAAiC;gBACjC,kBAAkB;gBAClB,qCAAqC;gBACrC,sDAAsD;gBACtD,wBAAwB;gBACxB,mEAAmE;gBACnE,QAAQ;gBACR,iBAAiB;gBAEjB,6BAA6B;gBAC7B,sEAAsE;gBACtE,4GAA4G;gBAC5G,6FAA6F;gBAC7F,IAAI,EAAEtB,MAAM,EAAEyB,KAAK,EAAE,GAAGC,cAAc,GAAGnB;gBACzC,qBAAqB;gBACrBL,QACEyB,IAAAA,iBAAK,EACH;oBAACD,gBAAgB,CAAC;oBAAGxB,SAAS,CAAC;iBAAE,CAACN,GAAG,CAAC,CAACY,KACrCoB,IAAAA,wBAAY,EAACpB,IAAI;wBAACqB;wBAAW;qBAAK;gBAKxC,eAAe;gBACf,0BAA0B;gBAC1B;oBAAC;oBAAc;iBAAe,CAACjC,GAAG,CAAC,CAACD;oBAClCO,KAAK,CAACP,IAA0B,GAAG;2BAC7BY,IAAI,CAACZ,IAAyB,IAAI,EAAE;2BACpCO,KAAK,CAACP,IAA0B,IAAI,EAAE;qBAC3C;gBACH;gBAEA,qBAAqB;gBACrB,mGAAmG;gBACnG,mCAAmC;gBACnC,2EAA2E;gBAC3E,yCAAyC;gBACzC,8CAA8C;gBAC9C,MAAM;gBACN,MAAM;gBAENO,MAAM4B,YAAY,CAAEC,IAAI,CACtB,IAAIC,kCAAgB,CAClBL,IAAAA,iBAAK,EAAC;oBAACpB,KAAK0B,KAAK,IAAI,CAAC;oBAAG/B,MAAM+B,KAAK,IAAI,CAAC;iBAAE;gBAM/C,OAAO/B;YACT;QACF;IACF;IAEA;;GAEC,GACDgC,eAAe;QACb,IAAIlC,SAAS,IAAI,CAACD,OAAO,CAACC,MAAM,EAAEN,OAC9B,CAACQ,QAAUA,MAAMiC,QAAQ,KAAKN,aAAa,CAAC3B,MAAMiC,QAAQ,GAE5D7C,aAAa,IAAI,CAACA,UAAU,CAACC,SAAS;QAExC,KAAK,IAAIW,SAASF,OAAQ;YACxB,qDAAqD;YACrD,gDAAgD;YAChD,IAAI,CAACV,UAAU,CAACY,MAAMC,UAAU,CAAC,EAAE;gBACjCb,UAAU,CAACY,MAAMC,UAAU,CAAC,GAAGiC,IAAAA,0BAAY,EAAClC,OAAO,IAAI;gBAEvD,6BAA6B;gBAC7B,0GAA0G;gBAC1G,yDAAyD;gBACzD,kDAAkD;gBAClD,qEAAqE;gBACrE,IAAImC,WAAWnC,MAAMU,UAAU,IAAI;gBACnC0B,IAAAA,WAAG,IAAG,IAAI,CAAChD,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;gBACnDoC,IAAAA,aAAK,IAAG,IAAI,CAACjD,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;gBAErD,IAAI;oBAAC;oBAAO;iBAAS,CAACc,QAAQ,CAACf,MAAMQ,UAAU,KAAK,CAACR,MAAMY,IAAI,EAAE;oBAC/D0B,IAAAA,aAAK,EAACH,UAAU,IAAI,CAAC/C,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;gBAC/D,OAAO,IAAID,MAAMQ,UAAU,KAAK,QAAQ;oBACtC+B,IAAAA,YAAI,IAAG,IAAI,CAACnD,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;oBACpD,4DAA4D;oBAC5D,+EAA+E;oBAC/E,uCAAuC;oBACvC,4GAA4G;oBAC5GX,QAAQkD,cAAc,CACpB,qBACA,2BAA2B;oBAC3B,wDAAwD;oBACxD,2BAA2B;oBAC3B;wBAACC;wBAASC;wBAAQ,IAAI,CAAC7C,OAAO,CAAC0B,KAAK;qBAAC,EACrC,IAAI,CAACnC,UAAU,CAACC,SAAS,EACzBW,MAAMC,UAAU;gBAEpB,OAAO,IAAI;oBAAC;oBAAS;iBAAM,CAACc,QAAQ,CAACf,MAAMQ,UAAU,GAAG;oBACtD+B,IAAAA,YAAI,IAAG,IAAI,CAACnD,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;oBACpD,IAAID,MAAMY,IAAI,EAAE;wBACdtB,QAAQkD,cAAc,CACpB,qBACA;4BAACE;4BAAQA;4BAAQ,IAAI,CAAC7C,OAAO,CAAC0B,KAAK;yBAAC,EACpC,IAAI,CAACnC,UAAU,CAACC,SAAS,EACzBW,MAAMC,UAAU;oBAEpB,OAAO;wBACL,8EAA8E;wBAC9E,iFAAiF;wBACjF,uHAAuH;wBACvH,kHAAkH;wBAClHqC,IAAAA,aAAK,EAACH,UAAU,IAAI,CAAC/C,UAAU,CAACC,SAAS,EAAEW,MAAMC,UAAU,EAAE;wBAC7DX,QAAQkD,cAAc,CACpB,qBACA;4BAACE;4BAAQA;4BAAQ,IAAI,CAAC7C,OAAO,CAAC0B,KAAK;4BAAEmB;yBAAO,EAC5C,IAAI,CAACtD,UAAU,CAACC,SAAS,EACzBW,MAAMC,UAAU;oBAEpB;gBACF;YACF;YAEA,8BAA8B;YAC9B,iCAAiC;YACjC,6EAA6E;YAC7E,sDAAsD;YACtD,0FAA0F;YAC1F,sDAAsD;YACtD,6DAA6D;YAC7D0C,IAAAA,4BAAa,EAAC3C,OAAO,IAAI;YACzB4C,IAAAA,wCAAmB,EAAC5C,OAAO,IAAI;YAC/B6C,IAAAA,kCAAgB,EAAC7C,OAAO,IAAI;YAC5B8C,IAAAA,8BAAc,EAAC9C,OAAO,IAAI;YAC1B+C,IAAAA,sCAAkB,EAAC/C,OAAO,IAAI;QAChC;IACF;IAEA;;GAEC,GACDgD,cAAc;QACZ,IAAI,CAACnD,OAAO,CAACC,MAAM,GAAGmD,IAAAA,sBAAU,EAC9B,IAAI,CAACpD,OAAO,CAACC,MAAM,EACnB,cACA;YACEoD,MAAM;QACR;IAEJ;IAjSA,YACE,AAAO9D,UAAoB,EAC3B,yFAAyF;IACzFS,OAE8D,CAC9D;aALOT,aAAAA;aAHF+D,aAA+B,EAAE;QAStC,IAAI,CAACtD,OAAO,GACV,OAAOA,YAAY,aAEf,oFAAoF;QACpFA,QAAQ,IAAI,CAACO,YAAY,CAACgD,8BAAc,KACxCC,IAAAA,0BAAY,EAACD,8BAAc,EAAEvD,WAAW,CAAC;QAE/C,IAAI,CAACA,OAAO,GAAG,IAAI,CAACO,YAAY,CAAC;YAC/B,GAAG,IAAI,CAACP,OAAO;YACf,wDAAwD;YACxD,6DAA6D;YAC7DC,QAAQ;mBAAK,IAAI,CAACD,OAAO,CAACC,MAAM,IAAI,EAAE;mBAAM,IAAI,CAACZ,kBAAkB;aAAG;QACxE;QAEA,gFAAgF;QAChF,mDAAmD;QACnD,IAAI,IAAI,CAACW,OAAO,CAACM,IAAI,KAAKwB,WAAW;YACnC,IAAI,CAAC9B,OAAO,CAACM,IAAI,GAAGmD,IAAAA,uBAAW,EAC7B,IAAI,CAAClE,UAAU,CAAC0B,IAAI,CAACyC,OAAO,CAAC,eAAe;QAEhD;QAEA,IAAI,CAACvB,YAAY;QACjB,IAAI,CAACgB,WAAW;QAEhBQ,IAAAA,oCAAiB,EAAC,IAAI;QACtBC,IAAAA,oCAAiB,EAAC,IAAI;QAEtBC,IAAAA,wBAAe,EAAC,IAAI;IACtB;AA8PF"}
+{"version":3,"sources":["../../../../src/decorators/controller/controller.factory.ts"],"sourcesContent":["import { Body, Param, Query, Req } from '@nestjs/common';\nimport type {\n  ControllerOptions,\n  HttpMethod,\n  InitControllerOptions,\n  InitRoute,\n  IRoute,\n} from './types/index.js';\nimport { addHttpMethod } from './add-decorators/add-http-method.js';\nimport { addSwaggerParams } from './add-decorators/add-swagger-params.js';\nimport { routeHandler } from './route-handler.js';\nimport { addSwaggerOperation } from './add-decorators/add-swagger-operation.js';\nimport { addSwaggerBody } from './add-decorators/add-swagger-body.js';\nimport { addSwaggerResponse } from './add-decorators/add-swagger-response.js';\nimport { QueryInterceptor } from './interceptors/query.interceptor.js';\nimport { defaultOptions } from './default-options.js';\nimport { mergeOptions } from './utils/merge-options.js';\nimport { addControllerTags } from './add-decorators/add-controller-tags.js';\nimport { merge, mergeByKey, removeValues } from '@impactor/javascript';\nimport { applyDecorators } from './utils/reflect.js';\nimport { addControllerPath } from './add-decorators/add-controller-path.js';\nimport { toKebabCase } from '@impactor/javascript';\n// import 'reflect-metadata';\n\nexport class ControllerFactory {\n  public options: ControllerOptions;\n  public decorators: ClassDecorator[] = [];\n\n  constructor(\n    public controller: Function,\n    //  if options is provided as a function, the consumer has to maintain the merge strategy\n    options?:\n      | InitControllerOptions\n      | ((defaultOptions: ControllerOptions) => ControllerOptions),\n  ) {\n    this.options =\n      typeof options === 'function'\n        ? // The consumer should receive the adjusted routes, so we need to call `adjustRoutes()` here\n          // we'll need to call it again after receiving the user options to adjust its routes\n          options(this.adjustRoutes(defaultOptions))\n        : mergeOptions(defaultOptions, options || {});\n\n    this.options = this.adjustRoutes({\n      ...this.options,\n      // todo: merge matched routes instead of overriding them\n      // i.e. routes with the same methodName, httpMethod, and path\n      routes: [...(this.options.routes || []), ...this.getExistingMethods()],\n    });\n\n    // if path is not provided, use the class name, without the suffix `Controller`,\n    // after converting it into url-friendly kebab-case\n    if (this.options.path === undefined) {\n      this.options.path = toKebabCase(\n        this.controller.name.replace(/Controller$/, ''),\n      );\n    }\n\n    this.createRoutes();\n    this.mergeRoutes();\n\n    addControllerPath(this);\n    addControllerTags(this);\n\n    applyDecorators(this);\n  }\n\n  getExistingMethods() {\n    let proto = this.controller.prototype;\n\n    return (\n      Reflect.ownKeys(proto)\n        .filter((key) => typeof proto[key] === 'function')\n        // convert symbol to string\n        .map(String)\n        .filter(\n          (key) =>\n            key !== 'constructor' &&\n            // a method can be excluded from being handling by this factory, by adding `@Route(false)`\n            Reflect.getMetadata('routeOptions', proto, key) !== false &&\n            // skip methods that are already included in routes[]\n            !this.options.routes?.some((route) => route.methodName === key),\n        )\n        // convert method to InitRoute{}\n        .map((methodName) => {\n          let routeOptions: InitRoute = Reflect.getMetadata(\n            'routeOptions',\n            proto,\n            methodName,\n          );\n\n          return {\n            methodName,\n            path: Reflect.getMetadata('path', proto[methodName]),\n            ...routeOptions,\n          } as InitRoute;\n        })\n    );\n  }\n  /**\n   * add all missing props to each route, uch as the HTTP method, primaryKey, and operationId .\n   * @param opts\n   * @returns\n   */\n  adjustRoutes(opts: InitControllerOptions = this.options): ControllerOptions {\n    return <ControllerOptions>{\n      ...opts,\n      routes: opts?.routes?.map((el) => {\n        let route = { ...el };\n\n        // NestJs request methods\n        let requestMethods = [\n          'GET',\n          'POST',\n          'PUT',\n          'DELETE',\n          'PATCH',\n          'ALL',\n          'OPTIONS',\n          'HEAD',\n          'SEARCH',\n        ];\n        // capitalize route.httpMethod to much the HttpMethod type\n        route.httpMethod = <HttpMethod>(\n          (typeof route.httpMethod === 'number'\n            ? requestMethods[route.httpMethod]\n            : (<HttpMethod>route.httpMethod)?.toUpperCase() || 'GET')\n        );\n        route.primaryKey = route.primaryKey || opts.primaryKey || 'id';\n\n        // generate the default methodName from path\n        // examples\n        //   - {path: \"users/:id\"} -> \"getOneUserById\"\n        //   - {path: \"users/:userId/profiles/:profileId/posts\", many:true} -> \"getManyUsersByUserIdProfilesProfileIdPosts\"\n        route.methodName =\n          route.methodName ||\n          route.httpMethod.toLowerCase() +\n            (route.httpMethod === 'POST' ? '' : route.many ? 'Many' : 'One');\n\n        route.operationId =\n          route.operationId ||\n          `${this.controller.name}_${String(route.methodName)}`;\n\n        if (!route.path) {\n          // for \"*One()\" operations, add /:id path param\n          // example: GET /users/:id\n          route.path =\n            route.many || ['POST'].includes(route.httpMethod)\n              ? '/'\n              : `/:${route.primaryKey}`;\n        }\n\n        route.pathParams = route.pathParams\n          ? route.pathParams.map((param) =>\n              typeof param === 'string'\n                ? { name: param, schema: { type: 'string' }, required: true }\n                : param,\n            )\n          : // generate path params from route.path\n            // matches `:id`, `/:id` and `other/:id/:userId`\n            [...route.path.matchAll(/^\\/?:([^/]+)/g)].map((match) => ({\n              name: match[1],\n              schema: { type: 'string' },\n              required: true,\n            }));\n\n        // todo: generate the corresponding service methods\n        //  +route.path\n        //     // remove the leading \"/\"\n        //     .replace(/^\\//, '')\n        //     .replace(/^:/,'By')\n        //     // replace \"/:id\" with \"ById\"\n        //     .replaceAll(/\\/:/g, '/By')\n        //     .split('/')\n        //     // convert parts to camel case\n        //     // example: \"users/profiles\" -> \"usersProfiles\"\n        //     .map((el, idx) =>\n        //       idx === 0 ? el : el.charAt(0).toUpperCase() + el.slice(1),\n        //     )\n        //     .join('');\n\n        // override options per route\n        // for example: route.primaryKey = route.primaryKey || opts.primaryKey\n        // when opts.model is a class that extends another class, an exception is thrown `OtherClass is not defined`\n        // todo: we may need to exclude other keys that have a class value such as errorResponseModel\n        let { routes, model, ...otherOptions } = opts;\n        // todo: use merge()?\n        route = <IRoute>(\n          merge(\n            [otherOptions || {}, route || {}].map((el) =>\n              removeValues(el, [undefined, null]),\n            ),\n          )\n        );\n\n        // merge arrays\n        // todo: use mergeArray()?\n        ['decorators', 'interceptors'].map((key) => {\n          route[key as keyof typeof route] = [\n            ...(opts[key as keyof typeof opts] || []),\n            ...(route[key as keyof typeof route] || []),\n          ];\n        });\n\n        // merge empty arrays\n        // for example if route.interceptors=[] but opts.interceptors has values, opts.interceptors is used\n        // Object.keys(opts).map((key) => {\n        //   if (Array.isArray(key) && !route[key as keyof typeof route]?.length) {\n        //     route[key as keyof typeof route] =\n        //       opts[key as keyof typeof opts] || [];\n        //   }\n        // });\n\n        route.interceptors!.push(\n          new QueryInterceptor(\n            merge([opts.query || {}, route.query || {}]) as {\n              [key: string]: any;\n            },\n          ),\n        );\n\n        return route;\n      }),\n    };\n  }\n\n  /**\n   * add options.routes[] as class methods\n   */\n  createRoutes() {\n    let routes = this.options.routes?.filter(\n        (route) => route.disabled === undefined || !route.disabled,\n      ),\n      controller = this.controller.prototype;\n\n    for (let route of routes) {\n      // create a route method and add it to the controller\n      // todo: use interceptor to create ParsedRequest\n      if (!controller[route.methodName]) {\n        controller[route.methodName] = routeHandler(route, this);\n\n        // inject the required params\n        // similar to patchOne(@Req() req: Request, @Query() query, @Body() dto: MyEntity, @Param(\"id\") id:string)\n        // we can get other info such as body and params from req\n        // without the need to inject @Body() and @Query()\n        // todo: route.primary || getPrimaryKeyFromEntity(opts.model) || \"id\"\n        let paramKey = route.primaryKey || 'id';\n        Req()(this.controller.prototype, route.methodName, 0);\n        Query()(this.controller.prototype, route.methodName, 1);\n\n        if (['GET', 'DELETE'].includes(route.httpMethod) && !route.many) {\n          Param(paramKey)(this.controller.prototype, route.methodName, 2);\n        } else if (route.httpMethod === 'POST') {\n          Body()(this.controller.prototype, route.methodName, 2);\n          // add 'design:paramtypes' to define the types of each param\n          // for instance, the param `@Body()` should be defined as `this.options.model`,\n          // so `ValidationPipe()` can work fine.\n          // without it, wrong body will bypass class-validator and class-transformer decorators such as `@IsString()`\n          Reflect.defineMetadata(\n            'design:paramtypes',\n            // 0: `@Req() req: Request`\n            // 1: `@Query() query: any` -> todo: add type definition\n            // 2: `@Body() body: Model`\n            [Request, Object, this.options.model],\n            this.controller.prototype,\n            route.methodName,\n          );\n        } else if (['PATCH', 'PUT'].includes(route.httpMethod)) {\n          Body()(this.controller.prototype, route.methodName, 2);\n          if (route.many) {\n            Reflect.defineMetadata(\n              'design:paramtypes',\n              [Object, Object, this.options.model],\n              this.controller.prototype,\n              route.methodName,\n            );\n          } else {\n            // todo: or use `Param()` without `paramKey`, then use it like param[paramKey]\n            // todo: accept list of pipes for each param -> `Param(paramName, ...pipes)(...)`\n            // to accept only string or number -> add a validation in routerHandler i.e. `if(! typeof params[paramKey]) throw ...`,\n            // as class-validator will not validate its type because it is not a DTO i.e. `getOne(@param() params: ParamsDTO)`\n            Param(paramKey)(this.controller.prototype, route.methodName, 3);\n            Reflect.defineMetadata(\n              'design:paramtypes',\n              [Object, Object, this.options.model, Object],\n              this.controller.prototype,\n              route.methodName,\n            );\n          }\n        }\n      }\n\n      // add decorators to the route\n      // annotations are added only if:\n      // - the method listed in this.options.routes[] and doesn't has @Route(false)\n      // - the method is not listed and has @Route(options?)\n      // if the method is not listed and doesn't has @Route(), the annotations will not be added\n      // if no http decorator already applied such as @GET()\n      // when adding @Get(), nest adds \"method\" and \"path\" metadata\n      addHttpMethod(route, this);\n      addSwaggerOperation(route, this);\n      addSwaggerParams(route, this);\n      addSwaggerBody(route, this);\n      addSwaggerResponse(route, this);\n    }\n  }\n\n  /**\n   * Merges routes that share the same methodName.\n   */\n  mergeRoutes() {\n    this.options.routes = mergeByKey<IRoute>(\n      this.options.routes,\n      'methodName',\n      {\n        deep: true,\n      },\n    );\n  }\n}\n"],"names":["Body","Param","Query","Req","addHttpMethod","addSwaggerParams","routeHandler","addSwaggerOperation","addSwaggerBody","addSwaggerResponse","QueryInterceptor","defaultOptions","mergeOptions","addControllerTags","merge","mergeByKey","removeValues","applyDecorators","addControllerPath","toKebabCase","ControllerFactory","controller","options","decorators","adjustRoutes","routes","getExistingMethods","path","undefined","name","replace","createRoutes","mergeRoutes","proto","prototype","Reflect","ownKeys","filter","key","map","String","getMetadata","some","route","methodName","routeOptions","opts","el","requestMethods","httpMethod","toUpperCase","primaryKey","toLowerCase","many","operationId","includes","pathParams","param","schema","type","required","matchAll","match","model","otherOptions","interceptors","push","query","disabled","paramKey","defineMetadata","Request","Object","deep"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,EAAEC,KAAK,EAAEC,GAAG,QAAQ,iBAAiB;AAQzD,SAASC,aAAa,QAAQ,sCAAsC;AACpE,SAASC,gBAAgB,QAAQ,yCAAyC;AAC1E,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SAASC,mBAAmB,QAAQ,4CAA4C;AAChF,SAASC,cAAc,QAAQ,uCAAuC;AACtE,SAASC,kBAAkB,QAAQ,2CAA2C;AAC9E,SAASC,gBAAgB,QAAQ,sCAAsC;AACvE,SAASC,cAAc,QAAQ,uBAAuB;AACtD,SAASC,YAAY,QAAQ,2BAA2B;AACxD,SAASC,iBAAiB,QAAQ,0CAA0C;AAC5E,SAASC,KAAK,EAAEC,UAAU,EAAEC,YAAY,QAAQ,uBAAuB;AACvE,SAASC,eAAe,QAAQ,qBAAqB;AACrD,SAASC,iBAAiB,QAAQ,0CAA0C;AAC5E,SAASC,WAAW,QAAQ,uBAAuB;AACnD,6BAA6B;AAE7B,OAAO,MAAMC;IAIX,YACE,AAAOC,UAAoB,EAC3B,yFAAyF;IACzFC,OAE8D,CAC9D;aALOD,aAAAA;aAHFE,aAA+B,EAAE;QAStC,IAAI,CAACD,OAAO,GACV,OAAOA,YAAY,aAEf,oFAAoF;QACpFA,QAAQ,IAAI,CAACE,YAAY,CAACb,mBAC1BC,aAAaD,gBAAgBW,WAAW,CAAC;QAE/C,IAAI,CAACA,OAAO,GAAG,IAAI,CAACE,YAAY,CAAC;YAC/B,GAAG,IAAI,CAACF,OAAO;YACf,wDAAwD;YACxD,6DAA6D;YAC7DG,QAAQ;mBAAK,IAAI,CAACH,OAAO,CAACG,MAAM,IAAI,EAAE;mBAAM,IAAI,CAACC,kBAAkB;aAAG;QACxE;QAEA,gFAAgF;QAChF,mDAAmD;QACnD,IAAI,IAAI,CAACJ,OAAO,CAACK,IAAI,KAAKC,WAAW;YACnC,IAAI,CAACN,OAAO,CAACK,IAAI,GAAGR,YAClB,IAAI,CAACE,UAAU,CAACQ,IAAI,CAACC,OAAO,CAAC,eAAe;QAEhD;QAEA,IAAI,CAACC,YAAY;QACjB,IAAI,CAACC,WAAW;QAEhBd,kBAAkB,IAAI;QACtBL,kBAAkB,IAAI;QAEtBI,gBAAgB,IAAI;IACtB;IAEAS,qBAAqB;QACnB,IAAIO,QAAQ,IAAI,CAACZ,UAAU,CAACa,SAAS;QAErC,OACEC,QAAQC,OAAO,CAACH,OACbI,MAAM,CAAC,CAACC,MAAQ,OAAOL,KAAK,CAACK,IAAI,KAAK,WACvC,2BAA2B;SAC1BC,GAAG,CAACC,QACJH,MAAM,CACL,CAACC,MACCA,QAAQ,iBACR,0FAA0F;YAC1FH,QAAQM,WAAW,CAAC,gBAAgBR,OAAOK,SAAS,SACpD,qDAAqD;YACrD,CAAC,IAAI,CAAChB,OAAO,CAACG,MAAM,EAAEiB,KAAK,CAACC,QAAUA,MAAMC,UAAU,KAAKN,KAE/D,gCAAgC;SAC/BC,GAAG,CAAC,CAACK;YACJ,IAAIC,eAA0BV,QAAQM,WAAW,CAC/C,gBACAR,OACAW;YAGF,OAAO;gBACLA;gBACAjB,MAAMQ,QAAQM,WAAW,CAAC,QAAQR,KAAK,CAACW,WAAW;gBACnD,GAAGC,YAAY;YACjB;QACF;IAEN;IACA;;;;GAIC,GACDrB,aAAasB,OAA8B,IAAI,CAACxB,OAAO,EAAqB;QAC1E,OAA0B;YACxB,GAAGwB,IAAI;YACPrB,QAAQqB,MAAMrB,QAAQc,IAAI,CAACQ;gBACzB,IAAIJ,QAAQ;oBAAE,GAAGI,EAAE;gBAAC;gBAEpB,yBAAyB;gBACzB,IAAIC,iBAAiB;oBACnB;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;oBACA;iBACD;gBACD,0DAA0D;gBAC1DL,MAAMM,UAAU,GACb,OAAON,MAAMM,UAAU,KAAK,WACzBD,cAAc,CAACL,MAAMM,UAAU,CAAC,GAChC,AAAaN,MAAMM,UAAU,EAAGC,iBAAiB;gBAEvDP,MAAMQ,UAAU,GAAGR,MAAMQ,UAAU,IAAIL,KAAKK,UAAU,IAAI;gBAE1D,4CAA4C;gBAC5C,WAAW;gBACX,8CAA8C;gBAC9C,mHAAmH;gBACnHR,MAAMC,UAAU,GACdD,MAAMC,UAAU,IAChBD,MAAMM,UAAU,CAACG,WAAW,KACzBT,CAAAA,MAAMM,UAAU,KAAK,SAAS,KAAKN,MAAMU,IAAI,GAAG,SAAS,KAAI;gBAElEV,MAAMW,WAAW,GACfX,MAAMW,WAAW,IACjB,GAAG,IAAI,CAACjC,UAAU,CAACQ,IAAI,CAAC,CAAC,EAAEW,OAAOG,MAAMC,UAAU,GAAG;gBAEvD,IAAI,CAACD,MAAMhB,IAAI,EAAE;oBACf,+CAA+C;oBAC/C,0BAA0B;oBAC1BgB,MAAMhB,IAAI,GACRgB,MAAMU,IAAI,IAAI;wBAAC;qBAAO,CAACE,QAAQ,CAACZ,MAAMM,UAAU,IAC5C,MACA,CAAC,EAAE,EAAEN,MAAMQ,UAAU,EAAE;gBAC/B;gBAEAR,MAAMa,UAAU,GAAGb,MAAMa,UAAU,GAC/Bb,MAAMa,UAAU,CAACjB,GAAG,CAAC,CAACkB,QACpB,OAAOA,UAAU,WACb;wBAAE5B,MAAM4B;wBAAOC,QAAQ;4BAAEC,MAAM;wBAAS;wBAAGC,UAAU;oBAAK,IAC1DH,SAGN,gDAAgD;gBAChD;uBAAId,MAAMhB,IAAI,CAACkC,QAAQ,CAAC;iBAAiB,CAACtB,GAAG,CAAC,CAACuB,QAAW,CAAA;wBACxDjC,MAAMiC,KAAK,CAAC,EAAE;wBACdJ,QAAQ;4BAAEC,MAAM;wBAAS;wBACzBC,UAAU;oBACZ,CAAA;gBAEJ,mDAAmD;gBACnD,eAAe;gBACf,gCAAgC;gBAChC,0BAA0B;gBAC1B,0BAA0B;gBAC1B,oCAAoC;gBACpC,iCAAiC;gBACjC,kBAAkB;gBAClB,qCAAqC;gBACrC,sDAAsD;gBACtD,wBAAwB;gBACxB,mEAAmE;gBACnE,QAAQ;gBACR,iBAAiB;gBAEjB,6BAA6B;gBAC7B,sEAAsE;gBACtE,4GAA4G;gBAC5G,6FAA6F;gBAC7F,IAAI,EAAEnC,MAAM,EAAEsC,KAAK,EAAE,GAAGC,cAAc,GAAGlB;gBACzC,qBAAqB;gBACrBH,QACE7B,MACE;oBAACkD,gBAAgB,CAAC;oBAAGrB,SAAS,CAAC;iBAAE,CAACJ,GAAG,CAAC,CAACQ,KACrC/B,aAAa+B,IAAI;wBAACnB;wBAAW;qBAAK;gBAKxC,eAAe;gBACf,0BAA0B;gBAC1B;oBAAC;oBAAc;iBAAe,CAACW,GAAG,CAAC,CAACD;oBAClCK,KAAK,CAACL,IAA0B,GAAG;2BAC7BQ,IAAI,CAACR,IAAyB,IAAI,EAAE;2BACpCK,KAAK,CAACL,IAA0B,IAAI,EAAE;qBAC3C;gBACH;gBAEA,qBAAqB;gBACrB,mGAAmG;gBACnG,mCAAmC;gBACnC,2EAA2E;gBAC3E,yCAAyC;gBACzC,8CAA8C;gBAC9C,MAAM;gBACN,MAAM;gBAENK,MAAMsB,YAAY,CAAEC,IAAI,CACtB,IAAIxD,iBACFI,MAAM;oBAACgC,KAAKqB,KAAK,IAAI,CAAC;oBAAGxB,MAAMwB,KAAK,IAAI,CAAC;iBAAE;gBAM/C,OAAOxB;YACT;QACF;IACF;IAEA;;GAEC,GACDZ,eAAe;QACb,IAAIN,SAAS,IAAI,CAACH,OAAO,CAACG,MAAM,EAAEY,OAC9B,CAACM,QAAUA,MAAMyB,QAAQ,KAAKxC,aAAa,CAACe,MAAMyB,QAAQ,GAE5D/C,aAAa,IAAI,CAACA,UAAU,CAACa,SAAS;QAExC,KAAK,IAAIS,SAASlB,OAAQ;YACxB,qDAAqD;YACrD,gDAAgD;YAChD,IAAI,CAACJ,UAAU,CAACsB,MAAMC,UAAU,CAAC,EAAE;gBACjCvB,UAAU,CAACsB,MAAMC,UAAU,CAAC,GAAGtC,aAAaqC,OAAO,IAAI;gBAEvD,6BAA6B;gBAC7B,0GAA0G;gBAC1G,yDAAyD;gBACzD,kDAAkD;gBAClD,qEAAqE;gBACrE,IAAI0B,WAAW1B,MAAMQ,UAAU,IAAI;gBACnChD,MAAM,IAAI,CAACkB,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;gBACnD1C,QAAQ,IAAI,CAACmB,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;gBAErD,IAAI;oBAAC;oBAAO;iBAAS,CAACW,QAAQ,CAACZ,MAAMM,UAAU,KAAK,CAACN,MAAMU,IAAI,EAAE;oBAC/DpD,MAAMoE,UAAU,IAAI,CAAChD,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;gBAC/D,OAAO,IAAID,MAAMM,UAAU,KAAK,QAAQ;oBACtCjD,OAAO,IAAI,CAACqB,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;oBACpD,4DAA4D;oBAC5D,+EAA+E;oBAC/E,uCAAuC;oBACvC,4GAA4G;oBAC5GT,QAAQmC,cAAc,CACpB,qBACA,2BAA2B;oBAC3B,wDAAwD;oBACxD,2BAA2B;oBAC3B;wBAACC;wBAASC;wBAAQ,IAAI,CAAClD,OAAO,CAACyC,KAAK;qBAAC,EACrC,IAAI,CAAC1C,UAAU,CAACa,SAAS,EACzBS,MAAMC,UAAU;gBAEpB,OAAO,IAAI;oBAAC;oBAAS;iBAAM,CAACW,QAAQ,CAACZ,MAAMM,UAAU,GAAG;oBACtDjD,OAAO,IAAI,CAACqB,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;oBACpD,IAAID,MAAMU,IAAI,EAAE;wBACdlB,QAAQmC,cAAc,CACpB,qBACA;4BAACE;4BAAQA;4BAAQ,IAAI,CAAClD,OAAO,CAACyC,KAAK;yBAAC,EACpC,IAAI,CAAC1C,UAAU,CAACa,SAAS,EACzBS,MAAMC,UAAU;oBAEpB,OAAO;wBACL,8EAA8E;wBAC9E,iFAAiF;wBACjF,uHAAuH;wBACvH,kHAAkH;wBAClH3C,MAAMoE,UAAU,IAAI,CAAChD,UAAU,CAACa,SAAS,EAAES,MAAMC,UAAU,EAAE;wBAC7DT,QAAQmC,cAAc,CACpB,qBACA;4BAACE;4BAAQA;4BAAQ,IAAI,CAAClD,OAAO,CAACyC,KAAK;4BAAES;yBAAO,EAC5C,IAAI,CAACnD,UAAU,CAACa,SAAS,EACzBS,MAAMC,UAAU;oBAEpB;gBACF;YACF;YAEA,8BAA8B;YAC9B,iCAAiC;YACjC,6EAA6E;YAC7E,sDAAsD;YACtD,0FAA0F;YAC1F,sDAAsD;YACtD,6DAA6D;YAC7DxC,cAAcuC,OAAO,IAAI;YACzBpC,oBAAoBoC,OAAO,IAAI;YAC/BtC,iBAAiBsC,OAAO,IAAI;YAC5BnC,eAAemC,OAAO,IAAI;YAC1BlC,mBAAmBkC,OAAO,IAAI;QAChC;IACF;IAEA;;GAEC,GACDX,cAAc;QACZ,IAAI,CAACV,OAAO,CAACG,MAAM,GAAGV,WACpB,IAAI,CAACO,OAAO,CAACG,MAAM,EACnB,cACA;YACEgD,MAAM;QACR;IAEJ;AACF"}

package/src/decorators/controller/default-options.d.ts

@@ -1,2 +1,2 @@
-import type { InitControllerOptions } from './types';
+import type { InitControllerOptions } from './types/index.js';
 export declare const defaultOptions: Partial<InitControllerOptions>;

package/src/decorators/controller/default-options.js

@@ -1,15 +1,8 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "defaultOptions", {
-    enumerable: true,
-    get: function() {
-        return defaultOptions;
-    }
-});
-const defaultOptions = {
+// todo: add opts.maxTake to limit ?take=
+/**
+ * the default options for \@Controller()
+ */ export const defaultOptions = {
     // todo: allow sub routes, such as `/:field`
     routes: [
         {
@@ -74,8 +67,7 @@ const defaultOptions = {
         },
         {
             name: 'skip',
-            description: 'skip rows.',
-            example: 2,
+            description: 'skip rows. example: `2`',
             many: true,
             httpMethods: [
                 'GET',
@@ -98,21 +90,16 @@ const defaultOptions = {
         },
         {
             name: 'relations',
-            description: 'add joined relational objects, supports nested relations',
-            example: [
-                'user.profile:name,age'
-            ],
+            description: 'add joined relational objects, supports nested relations. example: `["age", "user.profile:name"]`',
             httpMethods: [
                 'GET'
             ]
         },
         {
             name: 'where',
-            description: 'add where condition. to use sql statement, start the value with `>`.\n to search in an array column, put the value in an array. see <a href="https://orkhan.gitbook.io/typeorm/docs/find-options#advanced-options" target="_blank">see advanced options</a>',
-            example: {
-                name: 'john',
-                email: ">Like '%john%'"
-            },
+            description: 'add where condition. to use sql statement, start the value with `>`.\n to search in an array column, put the value in an array. see <a href="https://orkhan.gitbook.io/typeorm/docs/find-options#advanced-options" target="_blank">see advanced options</a>\n example: `{ name: "john", email: ">Like \'%john@%\'" }`',
+            // when adding an example here, Swagger adds it to the query by default, causing the query to has properties may not be defined in the entity
+            // example: { name: 'john', email: ">Like '%john@%'" },
             many: true,
             httpMethods: [
                 'GET',
@@ -124,10 +111,8 @@ const defaultOptions = {
         {
             name: 'order',
             // or 'name,id:DESC'
-            example: {
-                name: 'ASC',
-                id: 'DESC'
-            },
+            // example: { name: 'ASC', id: 'DESC' },
+            description: "example: `{ name: 'ASC', id: 'DESC' }`",
             many: true,
             httpMethods: [
                 'GET',