@impactor/nest 3.0.0

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

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

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

@@ -0,0 +1,33 @@
+"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;
+    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,
+        type: route.many ? [
+            responseModel
+        ] : responseModel
+    }), (0, _swagger.ApiResponse)({
+        status: _common.HttpStatus.INTERNAL_SERVER_ERROR,
+        type: route.errorResponseModel || factory.options?.errorResponseModel
+    }), ...[
+        ...factory.options?.responseModels || [],
+        ...route.responseModels || []
+    ].map((model)=>(0, _swagger.ApiResponse)(model)));
+}
+
+//# sourceMappingURL=add-swagger-response.js.map

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

@@ -0,0 +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"}

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

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

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

@@ -0,0 +1,18 @@
+"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) {
+    return (target)=>{
+        new _controllerfactory.ControllerFactory(target, options);
+    };
+}
+
+//# sourceMappingURL=controller.decorator.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,11 @@
+import type { ControllerOptions, InitControllerOptions, InitRoute } from './types';
+export declare class ControllerFactory {
+    controller: Function;
+    options: ControllerOptions;
+    decorators: ClassDecorator[];
+    constructor(controller: Function, options?: InitControllerOptions | ((defaultOptions: ControllerOptions) => ControllerOptions));
+    getExistingMethods(): InitRoute[];
+    adjustRoutes(opts?: InitControllerOptions): ControllerOptions;
+    createRoutes(): void;
+    mergeRoutes(): void;
+}

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

@@ -0,0 +1,261 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "ControllerFactory", {
+    enumerable: true,
+    get: function() {
+        return ControllerFactory;
+    }
+});
+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
+        .map(String).filter((key)=>key !== 'constructor' && // a method can be excluded from being handling by this factory, by adding `@Route(false)`
+            Reflect.getMetadata('routeOptions', proto, key) !== false && // skip methods that are already included in routes[]
+            !this.options.routes?.some((route)=>route.methodName === key))// convert method to InitRoute{}
+        .map((methodName)=>{
+            let routeOptions = Reflect.getMetadata('routeOptions', proto, methodName);
+            return {
+                methodName,
+                path: Reflect.getMetadata('path', proto[methodName]),
+                ...routeOptions
+            };
+        });
+    }
+    /**
+   * add all missing props to each route, uch as the HTTP method, primaryKey, and operationId .
+   * @param opts
+   * @returns
+   */ adjustRoutes(opts = this.options) {
+        return {
+            ...opts,
+            routes: opts?.routes?.map((el)=>{
+                let route = {
+                    ...el
+                };
+                // NestJs request methods
+                let requestMethods = [
+                    'GET',
+                    'POST',
+                    'PUT',
+                    'DELETE',
+                    'PATCH',
+                    'ALL',
+                    'OPTIONS',
+                    'HEAD',
+                    'SEARCH'
+                ];
+                // capitalize route.httpMethod to much the HttpMethod type
+                route.httpMethod = typeof route.httpMethod === 'number' ? requestMethods[route.httpMethod] : route.httpMethod?.toUpperCase() || 'GET';
+                route.primaryKey = route.primaryKey || opts.primaryKey || 'id';
+                // generate the default methodName from path
+                // examples
+                //   - {path: "users/:id"} -> "getOneUserById"
+                //   - {path: "users/:userId/profiles/:profileId/posts", many:true} -> "getManyUsersByUserIdProfilesProfileIdPosts"
+                route.methodName = route.methodName || route.httpMethod.toLowerCase() + (route.httpMethod === 'POST' ? '' : route.many ? 'Many' : 'One');
+                route.operationId = route.operationId || `${this.controller.name}_${String(route.methodName)}`;
+                if (!route.path) {
+                    // for "*One()" operations, add /:id path param
+                    // example: GET /users/:id
+                    route.path = route.many || [
+                        'POST'
+                    ].includes(route.httpMethod) ? '/' : `/:${route.primaryKey}`;
+                }
+                route.pathParams = route.pathParams ? route.pathParams.map((param)=>typeof param === 'string' ? {
+                        name: param,
+                        schema: {
+                            type: 'string'
+                        },
+                        required: true
+                    } : param) : // matches `:id`, `/:id` and `other/:id/:userId`
+                [
+                    ...route.path.matchAll(/^\/?:([^/]+)/g)
+                ].map((match)=>({
+                        name: match[1],
+                        schema: {
+                            type: 'string'
+                        },
+                        required: true
+                    }));
+                // todo: generate the corresponding service methods
+                //  +route.path
+                //     // remove the leading "/"
+                //     .replace(/^\//, '')
+                //     .replace(/^:/,'By')
+                //     // replace "/:id" with "ById"
+                //     .replaceAll(/\/:/g, '/By')
+                //     .split('/')
+                //     // convert parts to camel case
+                //     // example: "users/profiles" -> "usersProfiles"
+                //     .map((el, idx) =>
+                //       idx === 0 ? el : el.charAt(0).toUpperCase() + el.slice(1),
+                //     )
+                //     .join('');
+                // override options per route
+                // for example: route.primaryKey = route.primaryKey || opts.primaryKey
+                // when opts.model is a class that extends another class, an exception is thrown `OtherClass is not defined`
+                // 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)([
+                    otherOptions || {},
+                    route || {}
+                ].map((el)=>(0, _javascript.removeValues)(el, [
+                        undefined,
+                        null
+                    ])));
+                // merge arrays
+                // todo: use mergeArray()?
+                [
+                    'decorators',
+                    'interceptors'
+                ].map((key)=>{
+                    route[key] = [
+                        ...opts[key] || [],
+                        ...route[key] || []
+                    ];
+                });
+                // merge empty arrays
+                // for example if route.interceptors=[] but opts.interceptors has values, opts.interceptors is used
+                // Object.keys(opts).map((key) => {
+                //   if (Array.isArray(key) && !route[key as keyof typeof route]?.length) {
+                //     route[key as keyof typeof route] =
+                //       opts[key as keyof typeof opts] || [];
+                //   }
+                // });
+                route.interceptors.push(new _queryinterceptor.QueryInterceptor((0, _javascript.merge)([
+                    opts.query || {},
+                    route.query || {}
+                ])));
+                return route;
+            })
+        };
+    }
+    /**
+   * add options.routes[] as class methods
+   */ createRoutes() {
+        let routes = this.options.routes?.filter((route)=>route.disabled === undefined || !route.disabled), controller = this.controller.prototype;
+        for (let route of routes){
+            // 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);
+                // 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);
+                if ([
+                    'GET',
+                    'DELETE'
+                ].includes(route.httpMethod) && !route.many) {
+                    (0, _common.Param)(paramKey)(this.controller.prototype, route.methodName, 2);
+                } else if (route.httpMethod === 'POST') {
+                    (0, _common.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.
+                    // without it, wrong body will bypass class-validator and class-transformer decorators such as `@IsString()`
+                    Reflect.defineMetadata('design:paramtypes', // 0: `@Req() req: Request`
+                    // 1: `@Query() query: any` -> todo: add type definition
+                    // 2: `@Body() body: Model`
+                    [
+                        Request,
+                        Object,
+                        this.options.model
+                    ], this.controller.prototype, route.methodName);
+                } else if ([
+                    'PATCH',
+                    'PUT'
+                ].includes(route.httpMethod)) {
+                    (0, _common.Body)()(this.controller.prototype, route.methodName, 2);
+                    if (route.many) {
+                        Reflect.defineMetadata('design:paramtypes', [
+                            Object,
+                            Object,
+                            this.options.model
+                        ], this.controller.prototype, route.methodName);
+                    } else {
+                        // todo: or use `Param()` without `paramKey`, then use it like param[paramKey]
+                        // 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);
+                        Reflect.defineMetadata('design:paramtypes', [
+                            Object,
+                            Object,
+                            this.options.model,
+                            Object
+                        ], this.controller.prototype, route.methodName);
+                    }
+                }
+            }
+            // add decorators to the route
+            // annotations are added only if:
+            // - the method listed in this.options.routes[] and doesn't has @Route(false)
+            // - the method is not listed and has @Route(options?)
+            // 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);
+        }
+    }
+    /**
+   * Merges routes that share the same methodName.
+   */ mergeRoutes() {
+        this.options.routes = (0, _javascript.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

@@ -0,0 +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"}

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

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

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

@@ -0,0 +1,181 @@
+// 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: allow sub routes, such as `/:field`
+    routes: [
+        {
+            httpMethod: 'GET',
+            // todo: `retrieve a single ${entity.name || "record"}`
+            summary: 'retrieve a single record'
+        },
+        {
+            httpMethod: 'GET',
+            many: true,
+            // todo: change to "retrieve multiple $entity records"
+            summary: 'retrieve multiple records',
+            description: 'see <a href="https://typeorm.io/docs/working-with-entity-manager/find-options" target="_blank">TypeOrm find options</a>'
+        },
+        {
+            httpMethod: 'POST',
+            summary: 'create a single or multiple records'
+        },
+        {
+            httpMethod: 'PATCH',
+            summary: 'update a single record by primary key'
+        },
+        {
+            httpMethod: 'PATCH',
+            summary: 'update multiple records',
+            many: true
+        },
+        {
+            httpMethod: 'PUT',
+            summary: 'replace a single record'
+        },
+        {
+            httpMethod: 'PUT',
+            summary: 'replace multiple records',
+            many: true
+        },
+        {
+            httpMethod: 'DELETE',
+            summary: 'delete a record by primary key'
+        },
+        {
+            httpMethod: 'DELETE',
+            summary: 'delete multiple records',
+            many: true
+        }
+    ],
+    // query params should be similar to typeOrm methods, such as findOne({relations, withDeleted, ...})
+    // so query params should be ?relations&withDeleted
+    // https://orkhan.gitbook.io/typeorm/docs/find-options
+    queryParams: [
+        {
+            name: 'take',
+            description: 'limit resource count.',
+            example: 50,
+            many: true,
+            httpMethods: [
+                'GET',
+                'DELETE',
+                'PATCH',
+                'PUT'
+            ]
+        },
+        {
+            name: 'skip',
+            description: 'skip rows.',
+            example: 2,
+            many: true,
+            httpMethods: [
+                'GET',
+                'DELETE',
+                'PATCH',
+                'PUT'
+            ]
+        },
+        {
+            name: 'select',
+            description: `Selects resource fields.`,
+            example: [
+                'name',
+                'email'
+            ],
+            required: false,
+            httpMethods: [
+                'GET'
+            ]
+        },
+        {
+            name: 'relations',
+            description: 'add joined relational objects, supports nested relations',
+            example: [
+                'user.profile:name,age'
+            ],
+            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%'"
+            },
+            many: true,
+            httpMethods: [
+                'GET',
+                'PATCH',
+                'PUT',
+                'DELETE'
+            ]
+        },
+        {
+            name: 'order',
+            // or 'name,id:DESC'
+            example: {
+                name: 'ASC',
+                id: 'DESC'
+            },
+            many: true,
+            httpMethods: [
+                'GET',
+                'PATCH',
+                'PUT',
+                'DELETE'
+            ]
+        },
+        {
+            name: 'cache',
+            description: 'Enables or disables query result caching',
+            type: 'boolean',
+            httpMethods: [
+                'GET'
+            ]
+        },
+        {
+            name: 'withDeleted',
+            // todo:"default:${route.many ? 'false' : 'true'}"
+            description: `include soft deleted records`,
+            type: 'boolean',
+            httpMethods: [
+                'GET'
+            ]
+        },
+        {
+            name: 'softDelete',
+            description: 'whether to perform a soft or hard delete, the default is true',
+            type: 'boolean',
+            httpMethods: [
+                'DELETE'
+            ]
+        },
+        {
+            name: 'lock',
+            description: 'Enables locking mechanism for query',
+            httpMethods: [
+                'GET'
+            ],
+            many: false,
+            example: {
+                mode: 'optimistic',
+                version: 1
+            }
+        }
+    ],
+    serviceName: 'service',
+    primaryKey: 'id'
+};
+
+//# sourceMappingURL=default-options.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/decorators/controller/default-options.ts"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\nimport { UpdateResponseDto } from './dto/update-response.dto';\nimport type { InitControllerOptions } from './types';\n// todo: add opts.maxTake to limit ?take=\n\n/**\n * the default options for \\@Controller()\n */\nexport const defaultOptions: Partial<InitControllerOptions> = {\n  // todo: allow sub routes, such as `/:field`\n  routes: [\n    {\n      httpMethod: 'GET',\n      // todo: `retrieve a single ${entity.name || \"record\"}`\n      summary: 'retrieve a single record',\n    },\n    {\n      httpMethod: 'GET',\n      many: true,\n      // todo: change to \"retrieve multiple $entity records\"\n      summary: 'retrieve multiple records',\n      description:\n        'see <a href=\"https://typeorm.io/docs/working-with-entity-manager/find-options\" target=\"_blank\">TypeOrm find options</a>',\n    },\n    {\n      httpMethod: 'POST',\n      summary: 'create a single or multiple records',\n    },\n    {\n      httpMethod: 'PATCH',\n      summary: 'update a single record by primary key',\n      // todo: this causes an error in swagger UI\n      // `swagger-ui-init.js:1597 Uncaught ReferenceError: __name is not defined`\n      // https://chat.deepseek.com/a/chat/s/e76e6f76-1a5e-4c49-a63f-6d44ce619906\n      //  responseModel: UpdateResponseDto,\n    },\n    {\n      httpMethod: 'PATCH',\n      summary: 'update multiple records',\n      many: true,\n      //  responseModel: UpdateResponseDto,\n    },\n    {\n      httpMethod: 'PUT',\n      summary: 'replace a single record',\n      //  responseModel: UpdateResponseDto,\n    },\n    {\n      httpMethod: 'PUT',\n      summary: 'replace multiple records',\n      many: true,\n      //  responseModel: UpdateResponseDto,\n    },\n    {\n      httpMethod: 'DELETE',\n      summary: 'delete a record by primary key',\n      //  responseModel: UpdateResponseDto,\n    },\n    {\n      httpMethod: 'DELETE',\n      summary: 'delete multiple records',\n      many: true,\n      //  responseModel: UpdateResponseDto,\n    },\n    // todo: add update multiple records\n  ],\n  // query params should be similar to typeOrm methods, such as findOne({relations, withDeleted, ...})\n  // so query params should be ?relations&withDeleted\n  // https://orkhan.gitbook.io/typeorm/docs/find-options\n  queryParams: [\n    {\n      name: 'take',\n      description: 'limit resource count.',\n      example: 50,\n      many: true,\n      httpMethods: ['GET', 'DELETE', 'PATCH', 'PUT'],\n    },\n    {\n      name: 'skip',\n      description: 'skip rows.',\n      example: 2,\n      many: true,\n      httpMethods: ['GET', 'DELETE', 'PATCH', 'PUT'],\n    },\n    {\n      name: 'select',\n      description: `Selects resource fields.`,\n      example: ['name', 'email'],\n      required: false,\n      httpMethods: ['GET'],\n    },\n    {\n      name: 'relations',\n      description: 'add joined relational objects, supports nested relations',\n      example: ['user.profile:name,age'],\n      httpMethods: ['GET'],\n    },\n    {\n      name: 'where',\n      description:\n        '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%'\" },\n      many: true,\n      httpMethods: ['GET', 'PATCH', 'PUT', 'DELETE'],\n    },\n    {\n      name: 'order',\n      // or 'name,id:DESC'\n      example: { name: 'ASC', id: 'DESC' },\n      many: true,\n      httpMethods: ['GET', 'PATCH', 'PUT', 'DELETE'],\n    },\n    {\n      name: 'cache',\n      description: 'Enables or disables query result caching',\n      type: 'boolean',\n      httpMethods: ['GET'],\n    },\n    {\n      name: 'withDeleted',\n      // todo:\"default:${route.many ? 'false' : 'true'}\"\n      description: `include soft deleted records`,\n      type: 'boolean',\n      httpMethods: ['GET'],\n    },\n    {\n      name: 'softDelete',\n      description:\n        'whether to perform a soft or hard delete, the default is true',\n      type: 'boolean',\n      httpMethods: ['DELETE'],\n    },\n    {\n      name: 'lock',\n      description: 'Enables locking mechanism for query',\n      httpMethods: ['GET'],\n      many: false,\n      example: { mode: 'optimistic', version: 1 },\n    },\n  ],\n  serviceName: 'service',\n  primaryKey: 'id',\n};\n"],"names":["defaultOptions","routes","httpMethod","summary","many","description","queryParams","name","example","httpMethods","required","email","id","type","mode","version","serviceName","primaryKey"],"mappings":"AAAA,6DAA6D;;;;;+BAQhDA;;;eAAAA;;;AAAN,MAAMA,iBAAiD;IAC5D,4CAA4C;IAC5CC,QAAQ;QACN;YACEC,YAAY;YACZ,uDAAuD;YACvDC,SAAS;QACX;QACA;YACED,YAAY;YACZE,MAAM;YACN,sDAAsD;YACtDD,SAAS;YACTE,aACE;QACJ;QACA;YACEH,YAAY;YACZC,SAAS;QACX;QACA;YACED,YAAY;YACZC,SAAS;QAKX;QACA;YACED,YAAY;YACZC,SAAS;YACTC,MAAM;QAER;QACA;YACEF,YAAY;YACZC,SAAS;QAEX;QACA;YACED,YAAY;YACZC,SAAS;YACTC,MAAM;QAER;QACA;YACEF,YAAY;YACZC,SAAS;QAEX;QACA;YACED,YAAY;YACZC,SAAS;YACTC,MAAM;QAER;KAED;IACD,oGAAoG;IACpG,mDAAmD;IACnD,sDAAsD;IACtDE,aAAa;QACX;YACEC,MAAM;YACNF,aAAa;YACbG,SAAS;YACTJ,MAAM;YACNK,aAAa;gBAAC;gBAAO;gBAAU;gBAAS;aAAM;QAChD;QACA;YACEF,MAAM;YACNF,aAAa;YACbG,SAAS;YACTJ,MAAM;YACNK,aAAa;gBAAC;gBAAO;gBAAU;gBAAS;aAAM;QAChD;QACA;YACEF,MAAM;YACNF,aAAa,CAAC,wBAAwB,CAAC;YACvCG,SAAS;gBAAC;gBAAQ;aAAQ;YAC1BE,UAAU;YACVD,aAAa;gBAAC;aAAM;QACtB;QACA;YACEF,MAAM;YACNF,aAAa;YACbG,SAAS;gBAAC;aAAwB;YAClCC,aAAa;gBAAC;aAAM;QACtB;QACA;YACEF,MAAM;YACNF,aACE;YACFG,SAAS;gBAAED,MAAM;gBAAQI,OAAO;YAAiB;YACjDP,MAAM;YACNK,aAAa;gBAAC;gBAAO;gBAAS;gBAAO;aAAS;QAChD;QACA;YACEF,MAAM;YACN,oBAAoB;YACpBC,SAAS;gBAAED,MAAM;gBAAOK,IAAI;YAAO;YACnCR,MAAM;YACNK,aAAa;gBAAC;gBAAO;gBAAS;gBAAO;aAAS;QAChD;QACA;YACEF,MAAM;YACNF,aAAa;YACbQ,MAAM;YACNJ,aAAa;gBAAC;aAAM;QACtB;QACA;YACEF,MAAM;YACN,kDAAkD;YAClDF,aAAa,CAAC,4BAA4B,CAAC;YAC3CQ,MAAM;YACNJ,aAAa;gBAAC;aAAM;QACtB;QACA;YACEF,MAAM;YACNF,aACE;YACFQ,MAAM;YACNJ,aAAa;gBAAC;aAAS;QACzB;QACA;YACEF,MAAM;YACNF,aAAa;YACbI,aAAa;gBAAC;aAAM;YACpBL,MAAM;YACNI,SAAS;gBAAEM,MAAM;gBAAcC,SAAS;YAAE;QAC5C;KACD;IACDC,aAAa;IACbC,YAAY;AACd"}

package/src/decorators/controller/dto/empty.dto.d.ts

@@ -0,0 +1,2 @@
+export declare class EmptyDto {
+}

package/src/decorators/controller/dto/empty.dto.js

@@ -0,0 +1,18 @@
+/**
+ * an empty DTO
+ * can be used with routes that don't need to receive any data in its body
+ * or when the response is intended to be an empty object
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "EmptyDto", {
+    enumerable: true,
+    get: function() {
+        return EmptyDto;
+    }
+});
+let EmptyDto = class EmptyDto {
+};
+
+//# sourceMappingURL=empty.dto.js.map

package/src/decorators/controller/dto/empty.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/dto/empty.dto.ts"],"sourcesContent":["/**\n * an empty DTO\n * can be used with routes that don't need to receive any data in its body\n * or when the response is intended to be an empty object\n */\nexport class EmptyDto {}\n"],"names":["EmptyDto"],"mappings":"AAAA;;;;CAIC;;;;+BACYA;;;eAAAA;;;AAAN,IAAA,AAAMA,WAAN,MAAMA;AAAU"}

package/src/decorators/controller/dto/update-response.dto.d.ts

@@ -0,0 +1,3 @@
+export declare class UpdateResponseDto {
+    affected: number;
+}

package/src/decorators/controller/dto/update-response.dto.js

@@ -0,0 +1,16 @@
+/**
+ * a Dto for the response of the update or delete query
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "UpdateResponseDto", {
+    enumerable: true,
+    get: function() {
+        return UpdateResponseDto;
+    }
+});
+let UpdateResponseDto = class UpdateResponseDto {
+};
+
+//# sourceMappingURL=update-response.dto.js.map