@impactor/nest 3.0.0

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/dto/update-response.dto.ts"],"sourcesContent":["/**\n * a Dto for the response of the update or delete query\n */\nexport class UpdateResponseDto {\n  /**\n   * the total number of the affecter rows\n   */\n  affected: number;\n}\n"],"names":["UpdateResponseDto"],"mappings":"AAAA;;CAEC;;;;+BACYA;;;eAAAA;;;AAAN,IAAA,AAAMA,oBAAN,MAAMA;AAKb"}

package/src/decorators/controller/interceptors/query.interceptor.d.ts

@@ -0,0 +1,8 @@
+import type { ControllerOptions } from '../types';
+import { type CallHandler, type ExecutionContext, type NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+export declare class QueryInterceptor implements NestInterceptor {
+    private readonly query;
+    constructor(query: ControllerOptions['query']);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+}

package/src/decorators/controller/interceptors/query.interceptor.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "QueryInterceptor", {
+    enumerable: true,
+    get: function() {
+        return QueryInterceptor;
+    }
+});
+const _common = require("@nestjs/common");
+const _mergeanything = require("merge-anything");
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+let QueryInterceptor = class QueryInterceptor {
+    intercept(context, next) {
+        let req = context.switchToHttp().getRequest();
+        // trying to parse JSON params
+        // client-side stringify JSON params using JSON.stringify
+        // for example `?where=JSON.stringify({field: "value"})`
+        for(let key in req.query){
+            if (typeof req.query[key] === 'string' && [
+                '[',
+                '{'
+            ].includes(req.query[key][0])) {
+                try {
+                    req.query[key] = JSON.parse(req.query[key]);
+                } catch  {
+                // keep the value as string as-is
+                }
+            }
+        }
+        // req.query is `Empty <[Object: null prototype] {}>` and not merged, but replaces ths.query
+        // https://github.com/mesqueeb/merge-anything/issues/48
+        req.query = (0, _mergeanything.merge)(this.query || {}, {
+            ...req.query
+        });
+        return next.handle();
+    }
+    constructor(query){
+        this.query = query;
+    }
+};
+QueryInterceptor = _ts_decorate([
+    (0, _common.Injectable)(),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        Object
+    ])
+], QueryInterceptor);
+
+//# sourceMappingURL=query.interceptor.js.map

package/src/decorators/controller/interceptors/query.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/interceptors/query.interceptor.ts"],"sourcesContent":["import type { ControllerOptions } from '../types';\nimport {\n  type CallHandler,\n  type ExecutionContext,\n  Injectable,\n  type NestInterceptor,\n} from '@nestjs/common';\nimport { Observable } from 'rxjs';\n// @ts-ignore\nimport { merge } from 'merge-anything';\n\n/**\n * merge route query with the current request query.\n *\n * this ensures route.query{} is merged to the existing user routes too,\n * not only the routes that are generated by \\@Controller()\n */\n@Injectable()\nexport class QueryInterceptor implements NestInterceptor {\n  constructor(private readonly query: ControllerOptions['query']) {}\n\n  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {\n    let req = context.switchToHttp().getRequest();\n\n    // trying to parse JSON params\n    // client-side stringify JSON params using JSON.stringify\n    // for example `?where=JSON.stringify({field: \"value\"})`\n    for (let key in req.query) {\n      if (\n        typeof req.query[key] === 'string' &&\n        ['[', '{'].includes(req.query[key][0])\n      ) {\n        try {\n          req.query[key] = JSON.parse(req.query[key]);\n        } catch {\n          // keep the value as string as-is\n        }\n      }\n    }\n\n    // req.query is `Empty <[Object: null prototype] {}>` and not merged, but replaces ths.query\n    // https://github.com/mesqueeb/merge-anything/issues/48\n    req.query = merge(this.query || {}, { ...req.query });\n    return next.handle();\n  }\n}\n"],"names":["QueryInterceptor","intercept","context","next","req","switchToHttp","getRequest","key","query","includes","JSON","parse","merge","handle"],"mappings":";;;;+BAkBaA;;;eAAAA;;;wBAZN;+BAGe;;;;;;;;;;AASf,IAAA,AAAMA,mBAAN,MAAMA;IAGXC,UAAUC,OAAyB,EAAEC,IAAiB,EAAmB;QACvE,IAAIC,MAAMF,QAAQG,YAAY,GAAGC,UAAU;QAE3C,8BAA8B;QAC9B,yDAAyD;QACzD,wDAAwD;QACxD,IAAK,IAAIC,OAAOH,IAAII,KAAK,CAAE;YACzB,IACE,OAAOJ,IAAII,KAAK,CAACD,IAAI,KAAK,YAC1B;gBAAC;gBAAK;aAAI,CAACE,QAAQ,CAACL,IAAII,KAAK,CAACD,IAAI,CAAC,EAAE,GACrC;gBACA,IAAI;oBACFH,IAAII,KAAK,CAACD,IAAI,GAAGG,KAAKC,KAAK,CAACP,IAAII,KAAK,CAACD,IAAI;gBAC5C,EAAE,OAAM;gBACN,iCAAiC;gBACnC;YACF;QACF;QAEA,4FAA4F;QAC5F,uDAAuD;QACvDH,IAAII,KAAK,GAAGI,IAAAA,oBAAK,EAAC,IAAI,CAACJ,KAAK,IAAI,CAAC,GAAG;YAAE,GAAGJ,IAAII,KAAK;QAAC;QACnD,OAAOL,KAAKU,MAAM;IACpB;IAzBA,YAAY,AAAiBL,KAAiC,CAAE;aAAnCA,QAAAA;IAAoC;AA0BnE"}

package/src/decorators/controller/route-handler.d.ts

@@ -0,0 +1,3 @@
+import { ControllerFactory } from './controller.factory';
+import type { IRoute } from './types';
+export declare function routeHandler(route: IRoute, factory: ControllerFactory): (req: Request, query: any, ...params: any) => any;

package/src/decorators/controller/route-handler.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "routeHandler", {
+    enumerable: true,
+    get: function() {
+        return routeHandler;
+    }
+});
+const _common = require("@nestjs/common");
+function routeHandler(route, factory) {
+    let serviceName = factory.options?.serviceName || 'service';
+    // don't convert this to arrow function, so `this` here refers to the Controller class
+    // don't use factory.controller.prototype[serviceName] as service will be undefined
+    // todo: query type
+    return function(req, query, ...params) {
+        // @ts-ignore
+        let service = this[serviceName];
+        if (!service) {
+            throw new _common.HttpException(`this.${serviceName} is not defined, please inject the service`, 500);
+        }
+        if (!service[route.methodName]) {
+            throw new _common.HttpException(`the method this.${serviceName}.${route.methodName}() is not defined in the service`, 500);
+        } else if (typeof service[route.methodName] !== 'function') {
+            throw new _common.HttpException(`this.${serviceName}.${route.methodName} is not a method`, 500);
+        }
+        try {
+            // todo: send the proper params to each operation
+            // getOne(id), postOne(body), patchOne(id,body)
+            if (factory.options.maxLimit && query.take > factory.options.maxLimit) {
+                query.take = factory.options.maxLimit;
+            }
+            return service[route.methodName](...params, query, req);
+        } catch (error) {
+            // todo: get class name using Reflect
+            // eslint-disable-next-line no-console
+            console.error(`error at ${factory.controller.name}.${route.methodName}()`, error);
+            throw new _common.HttpException(error?.message || error, 500);
+        }
+    };
+}
+
+//# sourceMappingURL=route-handler.js.map

package/src/decorators/controller/route-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/decorators/controller/route-handler.ts"],"sourcesContent":["import { ControllerFactory } from './controller.factory';\nimport type { IRoute } from './types';\nimport { HttpException } from '@nestjs/common';\n\n/**\n * returns a route handler that receives the Request object as its first arg\n */\nexport function routeHandler(route: IRoute, factory: ControllerFactory) {\n  let serviceName = factory.options?.serviceName || 'service';\n  // don't convert this to arrow function, so `this` here refers to the Controller class\n  // don't use factory.controller.prototype[serviceName] as service will be undefined\n  // todo: query type\n  return function (req: Request, query: any, ...params: any) {\n    // @ts-ignore\n    let service = this[serviceName];\n\n    if (!service) {\n      throw new HttpException(\n        `this.${serviceName} is not defined, please inject the service`,\n        500,\n      );\n    }\n\n    if (!service[route.methodName]) {\n      throw new HttpException(\n        `the method this.${serviceName}.${route.methodName}() is not defined in the service`,\n        500,\n      );\n    } else if (typeof service[route.methodName] !== 'function') {\n      throw new HttpException(\n        `this.${serviceName}.${route.methodName} is not a method`,\n        500,\n      );\n    }\n\n    try {\n      // todo: send the proper params to each operation\n      // getOne(id), postOne(body), patchOne(id,body)\n      if (factory.options.maxLimit && query.take > factory.options.maxLimit) {\n        query.take = factory.options.maxLimit;\n      }\n      return service[route.methodName](...params, query, req);\n    } catch (error: any) {\n      // todo: get class name using Reflect\n      // eslint-disable-next-line no-console\n      console.error(\n        `error at ${factory.controller.name}.${route.methodName}()`,\n        error,\n      );\n      throw new HttpException(error?.message || error, 500);\n    }\n  };\n}\n"],"names":["routeHandler","route","factory","serviceName","options","req","query","params","service","HttpException","methodName","maxLimit","take","error","console","controller","name","message"],"mappings":";;;;+BAOgBA;;;eAAAA;;;wBALc;AAKvB,SAASA,aAAaC,KAAa,EAAEC,OAA0B;IACpE,IAAIC,cAAcD,QAAQE,OAAO,EAAED,eAAe;IAClD,sFAAsF;IACtF,mFAAmF;IACnF,mBAAmB;IACnB,OAAO,SAAUE,GAAY,EAAEC,KAAU,EAAE,GAAGC,MAAW;QACvD,aAAa;QACb,IAAIC,UAAU,IAAI,CAACL,YAAY;QAE/B,IAAI,CAACK,SAAS;YACZ,MAAM,IAAIC,qBAAa,CACrB,CAAC,KAAK,EAAEN,YAAY,0CAA0C,CAAC,EAC/D;QAEJ;QAEA,IAAI,CAACK,OAAO,CAACP,MAAMS,UAAU,CAAC,EAAE;YAC9B,MAAM,IAAID,qBAAa,CACrB,CAAC,gBAAgB,EAAEN,YAAY,CAAC,EAAEF,MAAMS,UAAU,CAAC,gCAAgC,CAAC,EACpF;QAEJ,OAAO,IAAI,OAAOF,OAAO,CAACP,MAAMS,UAAU,CAAC,KAAK,YAAY;YAC1D,MAAM,IAAID,qBAAa,CACrB,CAAC,KAAK,EAAEN,YAAY,CAAC,EAAEF,MAAMS,UAAU,CAAC,gBAAgB,CAAC,EACzD;QAEJ;QAEA,IAAI;YACF,iDAAiD;YACjD,+CAA+C;YAC/C,IAAIR,QAAQE,OAAO,CAACO,QAAQ,IAAIL,MAAMM,IAAI,GAAGV,QAAQE,OAAO,CAACO,QAAQ,EAAE;gBACrEL,MAAMM,IAAI,GAAGV,QAAQE,OAAO,CAACO,QAAQ;YACvC;YACA,OAAOH,OAAO,CAACP,MAAMS,UAAU,CAAC,IAAIH,QAAQD,OAAOD;QACrD,EAAE,OAAOQ,OAAY;YACnB,qCAAqC;YACrC,sCAAsC;YACtCC,QAAQD,KAAK,CACX,CAAC,SAAS,EAAEX,QAAQa,UAAU,CAACC,IAAI,CAAC,CAAC,EAAEf,MAAMS,UAAU,CAAC,EAAE,CAAC,EAC3DG;YAEF,MAAM,IAAIJ,qBAAa,CAACI,OAAOI,WAAWJ,OAAO;QACnD;IACF;AACF"}

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

@@ -0,0 +1,2 @@
+import { InitRoute } from './types';
+export declare function Route(route?: InitRoute): MethodDecorator;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Route", {
+    enumerable: true,
+    get: function() {
+        return Route;
+    }
+});
+function Route(route) {
+    return (target, property)=>{
+        Reflect.defineMetadata('routeOptions', route, target, property);
+    };
+}
+
+//# sourceMappingURL=route.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/decorators/controller/route.decorator.ts"],"sourcesContent":["import { InitRoute } from './types';\n\n/**\n * add route options to the method to override the options set by `@Controller()`\n *\n * @example\n * ```\n * \\@Route({httpMethod: 'GET', many: true})\n *  getAllUsers(){\n *   return this.service.getAllUsers();\n *  }\n * ```\n */\nexport function Route(route?: InitRoute): MethodDecorator {\n  return (target: Object, property: string | symbol) => {\n    Reflect.defineMetadata('routeOptions', route, target, property);\n  };\n}\n"],"names":["Route","route","target","property","Reflect","defineMetadata"],"mappings":";;;;+BAagBA;;;eAAAA;;;AAAT,SAASA,MAAMC,KAAiB;IACrC,OAAO,CAACC,QAAgBC;QACtBC,QAAQC,cAAc,CAAC,gBAAgBJ,OAAOC,QAAQC;IACxD;AACF"}

package/src/decorators/controller/services/crud-typeorm.service.d.ts

@@ -0,0 +1,46 @@
+import { type FindManyOptions, type ObjectLiteral, Repository } from 'typeorm';
+import type { DeepPartial } from 'typeorm/common/DeepPartial';
+export interface IQuery<Entity = any> extends Omit<FindManyOptions<Entity>, 'where' | 'relations'> {
+    where?: FindManyOptions['where'] | string;
+    relations?: FindManyOptions['relations'] | string;
+}
+export declare class CrudTypeOrmService<Entity extends ObjectLiteral> {
+    protected repo: Repository<Entity>;
+    constructor(repo: Repository<Entity>);
+    createQuery<Entity>(query?: IQuery<Entity>, primaryKeyValue?: string | number, primaryKeyName?: string): FindManyOptions<Entity>;
+    getOne(id: any, query?: any, _req?: Request): Promise<Entity | null>;
+    getMany(query?: any, _req?: Request): Promise<{
+        data: Entity[];
+        count: number;
+    }>;
+    getManyByRelation(field: string, value: any, query?: any, primaryKeyName?: string, req?: Request): Promise<{
+        data: Entity[];
+        count: number;
+    }>;
+    post(body: DeepPartial<Entity>, _query?: any, _req?: Request): Promise<DeepPartial<Entity> & Entity>;
+    patchOne(body: DeepPartial<Entity>, primaryKey?: string | number | {
+        [key: string]: any;
+    }, _req?: Request): Promise<(Entity & {
+        id: any;
+    }) | ((Entity extends (infer U)[] ? DeepPartial<U>[] : Entity extends Map<infer K, infer V> ? Map<DeepPartial<K>, DeepPartial<V>> : Entity extends Set<infer M> ? Set<DeepPartial<M>> : Entity extends object ? { [K_1 in keyof Entity]?: DeepPartial<Entity[K_1]> | undefined; } : Entity) & {
+        id: any;
+    } & Entity)>;
+    patchMany(body: DeepPartial<Entity>, query?: any, _req?: Request): Promise<((Entity & {
+        id: any;
+    }) | ((Entity extends (infer U)[] ? DeepPartial<U>[] : Entity extends Map<infer K, infer V> ? Map<DeepPartial<K>, DeepPartial<V>> : Entity extends Set<infer M> ? Set<DeepPartial<M>> : Entity extends object ? { [K_1 in keyof Entity]?: DeepPartial<Entity[K_1]> | undefined; } : Entity) & {
+        id: any;
+    } & Entity))[]>;
+    putOne(): void;
+    putMany(): void;
+    deleteOne(primaryKeyOrCondition: string | number | {
+        [key: string]: any;
+    }, query?: any, req?: Request): Promise<{
+        affected: number | null | undefined;
+    }>;
+    deleteMany(query?: any, _req?: Request): Promise<{
+        affected: number | null | undefined;
+    }>;
+    clear(): Promise<void>;
+    toArray(value?: any, delimiter?: string): any;
+    toObject(value?: any, defaultValue?: any): any;
+}

package/src/decorators/controller/services/crud-typeorm.service.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "CrudTypeOrmService", {
+    enumerable: true,
+    get: function() {
+        return CrudTypeOrmService;
+    }
+});
+const _common = require("@nestjs/common");
+const _typeorm = require("typeorm");
+const _mergeanything = require("merge-anything");
+let CrudTypeOrmService = class CrudTypeOrmService {
+    /**
+   * create a TypeORM Query object
+   * @param query
+   * @param primaryKey the primary key value, for "*One" operations
+   * @param primaryKeyName the primary key field name, default: "id"
+   */ // todo: enforce the return type
+    // todo: `T extends FindOneOptions | FindManyOptions | ...`
+    createQuery(query, primaryKeyValue, primaryKeyName = 'id') {
+        query = {
+            ...query,
+            // for "one" operations, include deleted records by default
+            withDeleted: primaryKeyValue ? query?.withDeleted !== false : query?.withDeleted,
+            // todo: nested relations "users.profiles"
+            // todo: relation fields "users:name,email"
+            // todo: relations may be an object rather than an array
+            relations: this.toArray(query?.relations),
+            select: this.toArray(query?.select),
+            order: this.toObject(query?.order, 'ASC')
+        };
+        if (query.where) {
+            // convert query.where to object
+            if (typeof query.where === 'string' && // json format
+            (query.where.startsWith('{') || // query.where can be a string, i.e. "primaryKey"
+            // if its format is not `key:value, key2` keep it string
+            // if it is a single text value, consider it as primaryKey value
+            // matches: `a:1, b:2, c` and `a,b` but not `id`
+            // todo: deprecate inline k-v syntax, use explicit object
+            // eslint-disable-next-line regexp/optimal-quantifier-concatenation
+            /(.+:.+(,.+)?)|(.+,.+)/.test(query.where))) {
+                query.where = this.toObject(query.where);
+            }
+            // todo: if isObject()
+            if (typeof query.where !== 'string' && !Array.isArray(query.where)) {
+                Object.keys(query.where).map((key)=>{
+                    // @ts-ignore
+                    let value = query.where[key];
+                    if (Array.isArray(value)) {
+                        // check if the array column contains the value
+                        // todo: use the entity to check if the field type is an array
+                        // @ts-ignore
+                        query.where[key] = (0, _typeorm.ArrayContains)(value.map((el)=>el?.trim()));
+                    } else if (typeof value === 'string') {
+                        value = value?.trim();
+                        // if the value starts with ">", consider it as a raw sql statement
+                        // convert `{key: value}` to `{key: Raw(field=>value)}`
+                        // to enable sql syntax and find operations
+                        // such as: `Like '%test%'`
+                        // todo: check for sql injection of the user's input
+                        // todo: if it includes a find operation such as `Like` (can be a part of the value)
+                        // example `{key: "> {field} > 0"}`
+                        if (value?.startsWith?.('>')) {
+                            // @ts-ignore
+                            query.where[key] = (0, _typeorm.Raw)((field)=>`${value.slice(1)}`.replaceAll('{field}', field));
+                        }
+                    }
+                });
+                // add primaryKey to the condition
+                if (primaryKeyValue && primaryKeyName) {
+                    query.where = {
+                        [primaryKeyName]: primaryKeyValue,
+                        ...query.where
+                    };
+                }
+            }
+        } else if (primaryKeyValue) {
+            query.where = {
+                [primaryKeyName]: primaryKeyValue
+            };
+        }
+        return query;
+    }
+    // todo: rename to getOneById() or getOneBy${primaryParam}
+    // todo: route.paramKey{name, type:String|Number}
+    // todo: types
+    // todo: parse query params, and add type ControllerOptions.QueryParams
+    getOne(id, query, _req) {
+        return this.repo.findOne(this.createQuery(query, id));
+    }
+    // todo: handle operations, example: `{where: {email: "like %john%"} }`
+    getMany(query, _req) {
+        return this.repo.findAndCount(this.createQuery(query)).then((res)=>({
+                data: res[0],
+                count: res[1]
+            }));
+    }
+    /**
+   * get records by a relation field
+   * @param field the relationship field name
+   * @param value
+   * @param query
+   * @param primaryKeyName
+   * @param req
+   * @returns
+   * @example
+   *  if the table posts has a relation with users,
+   *  we can get all posts by the user by `getManyByRelation("user", 1)`
+   */ // todo: merge options.query{}
+    // for example the following route should inherit options from @Controller()
+    // @Controller(options)
+    // class MyController{
+    //   @Get('/users/:userId/posts')
+    //   getUserPosts(){
+    //      return this.service.getManyByRelation(...) // options.query from @Controller() should be merged here
+    // }
+    // }
+    getManyByRelation(field, value, query, primaryKeyName = 'id', req) {
+        return this.getMany((0, _mergeanything.merge)(query || {}, {
+            where: {
+                [field]: {
+                    [primaryKeyName]: value
+                }
+            }
+        }), req);
+    }
+    post(body, _query, _req) {
+        // .save() automatically saves the manyToMany relations if cascade=true
+        // or this.repo.insert(body).then((res) => (Array.isArray(body) ? res?.raw : res?.raw[0]))
+        return this.repo.save(body);
+    }
+    /**
+   * update a record by its primary key
+   */ patchOne(// todo: add type opts.model
+    body, primaryKey = 'id', _req) {
+        return this.getOne(primaryKey).then((res)=>{
+            if (!res?.id) throw new Error(`not found`);
+            // .save() automatically modifies the ManyToMany relations
+            // but requires fetching the items to be modified to add the id of each item
+            // otherwise it will create a new item if it doesn't have an id
+            return this.repo.save({
+                ...body,
+                id: res.id
+            });
+        });
+    }
+    patchMany(body, query, _req) {
+        return this.repo.find(query).then((res)=>res.map((el)=>({
+                    ...body,
+                    id: el.id
+                }))).then((res)=>this.repo.save(res));
+    // .update() doesn't save ManyToMany relation automatically
+    // but .save() doesn't have where condition (each item has to specify id)
+    // and has no limit option (it relies on the number of the items being updated)
+    // use .save() see patchOne(), it meeds merging body[] with existing ids of the items to be updated
+    // or create a route to save (insert or update) items `POST /save`
+    // return this.repo
+    //   .update(query.where, body)
+    //   .then((res) => ({ affected: res.affected }));
+    }
+    putOne() {
+        throw new _common.NotImplementedException();
+    }
+    putMany() {
+        throw new _common.NotImplementedException();
+    }
+    deleteOne(primaryKeyOrCondition, query = {}, req) {
+        query.where = [
+            'string',
+            'number'
+        ].includes(typeof primaryKeyOrCondition) ? primaryKeyOrCondition : {
+            ...query.where,
+            ...primaryKeyOrCondition
+        };
+        return this.deleteMany(query, req);
+    }
+    deleteMany(query, _req) {
+        // todo: softDelete() vs softRemove()
+        let deleteQuery;
+        // repo.delete({}) no longer allowed by TypeORM, in this case we'll use QueryBuilder to provide a fake criteria
+        if (query.where) {
+            deleteQuery = query.softDelete === false ? this.repo.delete(query.where) : this.repo.softDelete(query.where);
+        } else {
+            let builder = this.repo.createQueryBuilder();
+            deleteQuery = query.softDelete === false ? builder.delete().where('1 = 1').execute() : builder.softDelete().where('1 = 1').execute();
+        }
+        return deleteQuery.then((res)=>({
+                affected: res?.affected
+            }));
+    }
+    /**
+   * delete all data using `TRUNCATE` instead of `DELETE`
+   */ // todo: add a route to clear (truncate) the data, for instance `DELETE <entity>/clear`
+    clear() {
+        return this.repo.clear();
+    }
+    /**
+   * convert delimited string int array items and remove empty items
+   * @example 'a,b,c' => ['a', 'b', 'c']
+   */ toArray(value, delimiter = ',') {
+        return typeof value === 'string' ? value?.split?.(delimiter)?.filter((el)=>el && el.trim() !== '') : value;
+    }
+    /**
+   * convert JSON string or delimited string into a plain object
+   * @example `{"a": 1}` => `{a: 1}`
+   * @example `a:1, b:2, c` => `{a: 1, b: 2, c: defaultValue}`
+   */ toObject(value, defaultValue = true) {
+        if (!value) return;
+        if (typeof value !== 'string') return value;
+        // todo: if isObject(value) return value
+        try {
+            return JSON.parse(value);
+        } catch  {
+            return value?.split?.(',')?.reduce?.((acc, el)=>{
+                let [key, value = defaultValue] = el.split(':');
+                return {
+                    ...acc,
+                    [key.trim()]: value.trim()
+                };
+            }, {});
+        }
+    }
+    constructor(// todo: inject repo using Entity
+    // @InjectRepository(Dto) private repo: Repository<Entity>,
+    repo){
+        this.repo = repo;
+    }
+};
+
+//# sourceMappingURL=crud-typeorm.service.js.map

package/src/decorators/controller/services/crud-typeorm.service.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/services/crud-typeorm.service.ts"],"sourcesContent":["import { NotImplementedException } from '@nestjs/common';\nimport {\n  ArrayContains,\n  DeleteResult,\n  type FindManyOptions,\n  type ObjectLiteral,\n  Raw,\n  Repository,\n  UpdateResult,\n} from 'typeorm';\nimport type { DeepPartial } from 'typeorm/common/DeepPartial';\n// @ts-ignore\nimport { merge } from 'merge-anything';\n\n/**\n * find options but some props accepts string format that parsed internally into the correct format\n * for example { where: \"age>30,name='john'\" }\n */\nexport interface IQuery<Entity = any> extends Omit<\n  FindManyOptions<Entity>,\n  'where' | 'relations'\n> {\n  where?: FindManyOptions['where'] | string;\n  relations?: FindManyOptions['relations'] | string;\n}\n\n/**\n * The CRUD implementation service for TypeORM\n * it adds methods such as `getOne()`, `getMany()`, and `post()` that ue TypeORM repo\n * to work with the data model\n */\n// todo: add pipes, example: `update(@Param('id', ParseUUIDPipe) id: string, body){}`\nexport class CrudTypeOrmService<Entity extends ObjectLiteral> {\n  constructor(\n    // todo: inject repo using Entity\n    // @InjectRepository(Dto) private repo: Repository<Entity>,\n    protected repo: Repository<Entity>,\n  ) {}\n\n  /**\n   * create a TypeORM Query object\n   * @param query\n   * @param primaryKey the primary key value, for \"*One\" operations\n   * @param primaryKeyName the primary key field name, default: \"id\"\n   */\n  // todo: enforce the return type\n  // todo: `T extends FindOneOptions | FindManyOptions | ...`\n  createQuery<Entity>(\n    query?: IQuery<Entity>,\n    primaryKeyValue?: string | number,\n    primaryKeyName = 'id', // FindManyOptions already extends FindOneOptions\n  ): FindManyOptions<Entity> {\n    query = {\n      ...query,\n      // for \"one\" operations, include deleted records by default\n      withDeleted: primaryKeyValue\n        ? query?.withDeleted !== false\n        : query?.withDeleted,\n      // todo: nested relations \"users.profiles\"\n      // todo: relation fields \"users:name,email\"\n      // todo: relations may be an object rather than an array\n      relations: this.toArray(query?.relations),\n      select: this.toArray(query?.select),\n      order: this.toObject(query?.order, 'ASC'),\n    };\n\n    if (query.where) {\n      // convert query.where to object\n      if (\n        typeof query.where === 'string' &&\n        // json format\n        (query.where.startsWith('{') ||\n          // query.where can be a string, i.e. \"primaryKey\"\n          // if its format is not `key:value, key2` keep it string\n          // if it is a single text value, consider it as primaryKey value\n          // matches: `a:1, b:2, c` and `a,b` but not `id`\n          // todo: deprecate inline k-v syntax, use explicit object\n          // eslint-disable-next-line regexp/optimal-quantifier-concatenation\n          /(.+:.+(,.+)?)|(.+,.+)/.test(query.where))\n      ) {\n        query.where = this.toObject(query.where);\n      }\n\n      // todo: if isObject()\n      if (typeof query.where !== 'string' && !Array.isArray(query.where)) {\n        Object.keys(query.where!).map((key) => {\n          // @ts-ignore\n          let value = query.where[key];\n          if (Array.isArray(value)) {\n            // check if the array column contains the value\n            // todo: use the entity to check if the field type is an array\n            // @ts-ignore\n            query.where[key] = ArrayContains(value.map((el) => el?.trim()));\n          } else if (typeof value === 'string') {\n            value = value?.trim();\n\n            // if the value starts with \">\", consider it as a raw sql statement\n            // convert `{key: value}` to `{key: Raw(field=>value)}`\n            // to enable sql syntax and find operations\n            // such as: `Like '%test%'`\n            // todo: check for sql injection of the user's input\n            // todo: if it includes a find operation such as `Like` (can be a part of the value)\n            // example `{key: \"> {field} > 0\"}`\n            if (value?.startsWith?.('>')) {\n              // @ts-ignore\n              query.where[key] = Raw((field: string) =>\n                `${value.slice(1)}`.replaceAll('{field}', field),\n              );\n            }\n          }\n        });\n\n        // add primaryKey to the condition\n        if (primaryKeyValue && primaryKeyName) {\n          query.where = {\n            [primaryKeyName]: primaryKeyValue,\n            ...query.where,\n          };\n        }\n      }\n    } else if (primaryKeyValue) {\n      query.where = { [primaryKeyName]: primaryKeyValue };\n    }\n\n    return <FindManyOptions<Entity>>query;\n  }\n\n  // todo: rename to getOneById() or getOneBy${primaryParam}\n  // todo: route.paramKey{name, type:String|Number}\n  // todo: types\n  // todo: parse query params, and add type ControllerOptions.QueryParams\n  getOne(id: any, query?: any, _req?: Request) {\n    return this.repo.findOne(this.createQuery(query, id));\n  }\n\n  // todo: handle operations, example: `{where: {email: \"like %john%\"} }`\n  getMany(query?: any, _req?: Request) {\n    return this.repo\n      .findAndCount(this.createQuery(query))\n      .then((res) => ({ data: res[0], count: res[1] }));\n  }\n\n  /**\n   * get records by a relation field\n   * @param field the relationship field name\n   * @param value\n   * @param query\n   * @param primaryKeyName\n   * @param req\n   * @returns\n   * @example\n   *  if the table posts has a relation with users,\n   *  we can get all posts by the user by `getManyByRelation(\"user\", 1)`\n   */\n  // todo: merge options.query{}\n  // for example the following route should inherit options from @Controller()\n  // @Controller(options)\n  // class MyController{\n  //   @Get('/users/:userId/posts')\n  //   getUserPosts(){\n  //      return this.service.getManyByRelation(...) // options.query from @Controller() should be merged here\n  // }\n  // }\n  getManyByRelation(\n    field: string,\n    value: any,\n    query?: any,\n    primaryKeyName = 'id',\n    req?: Request,\n  ) {\n    return this.getMany(\n      merge(query || {}, { where: { [field]: { [primaryKeyName]: value } } }),\n      req,\n    );\n  }\n\n  post(body: DeepPartial<Entity>, _query?: any, _req?: Request) {\n    // .save() automatically saves the manyToMany relations if cascade=true\n    // or this.repo.insert(body).then((res) => (Array.isArray(body) ? res?.raw : res?.raw[0]))\n    return this.repo.save(body);\n  }\n\n  /**\n   * update a record by its primary key\n   */\n  patchOne(\n    // todo: add type opts.model\n    body: DeepPartial<Entity>,\n    primaryKey: string | number | { [key: string]: any } = 'id',\n    _req?: Request,\n  ) {\n    return this.getOne(primaryKey).then((res) => {\n      if (!res?.id) throw new Error(`not found`);\n      // .save() automatically modifies the ManyToMany relations\n      // but requires fetching the items to be modified to add the id of each item\n      // otherwise it will create a new item if it doesn't have an id\n      return this.repo.save({ ...body, id: res.id });\n    });\n  }\n\n  patchMany(body: DeepPartial<Entity>, query?: any, _req?: Request) {\n    return this.repo\n      .find(query)\n      .then((res) => res.map((el) => ({ ...body, id: el.id })))\n      .then((res) => this.repo.save(res));\n\n    // .update() doesn't save ManyToMany relation automatically\n    // but .save() doesn't have where condition (each item has to specify id)\n    // and has no limit option (it relies on the number of the items being updated)\n    // use .save() see patchOne(), it meeds merging body[] with existing ids of the items to be updated\n    // or create a route to save (insert or update) items `POST /save`\n\n    // return this.repo\n    //   .update(query.where, body)\n    //   .then((res) => ({ affected: res.affected }));\n  }\n\n  putOne() {\n    throw new NotImplementedException();\n  }\n\n  putMany() {\n    throw new NotImplementedException();\n  }\n\n  deleteOne(\n    primaryKeyOrCondition: string | number | { [key: string]: any },\n    query: any = {},\n    req?: Request,\n  ) {\n    query.where = ['string', 'number'].includes(typeof primaryKeyOrCondition)\n      ? primaryKeyOrCondition\n      : { ...query.where, ...(<{ [key: string]: any }>primaryKeyOrCondition) };\n    return this.deleteMany(query, req);\n  }\n\n  deleteMany(query?: any, _req?: Request) {\n    // todo: softDelete() vs softRemove()\n\n    let deleteQuery: Promise<DeleteResult | UpdateResult>;\n    // repo.delete({}) no longer allowed by TypeORM, in this case we'll use QueryBuilder to provide a fake criteria\n    if (query.where) {\n      deleteQuery =\n        query.softDelete === false\n          ? this.repo.delete(query.where)\n          : this.repo.softDelete(query.where);\n    } else {\n      let builder = this.repo.createQueryBuilder();\n      deleteQuery =\n        query.softDelete === false\n          ? builder.delete().where('1 = 1').execute()\n          : builder.softDelete().where('1 = 1').execute();\n    }\n    return deleteQuery.then((res) => ({ affected: res?.affected }));\n  }\n\n  /**\n   * delete all data using `TRUNCATE` instead of `DELETE`\n   */\n  // todo: add a route to clear (truncate) the data, for instance `DELETE <entity>/clear`\n  clear() {\n    return this.repo.clear();\n  }\n\n  /**\n   * convert delimited string int array items and remove empty items\n   * @example 'a,b,c' => ['a', 'b', 'c']\n   */\n  toArray(value?: any, delimiter = ',') {\n    return typeof value === 'string'\n      ? value\n          ?.split?.(delimiter)\n          // remove empty elements\n          ?.filter((el) => el && el.trim() !== '')\n      : value;\n  }\n\n  /**\n   * convert JSON string or delimited string into a plain object\n   * @example `{\"a\": 1}` => `{a: 1}`\n   * @example `a:1, b:2, c` => `{a: 1, b: 2, c: defaultValue}`\n   */\n  toObject(value?: any, defaultValue: any = true) {\n    if (!value) return;\n    if (typeof value !== 'string') return value;\n    // todo: if isObject(value) return value\n\n    try {\n      return JSON.parse(value);\n    } catch {\n      return value?.split?.(',')?.reduce?.(\n        (acc, el) => {\n          let [key, value = defaultValue] = el.split(':');\n          return { ...acc, [key.trim()]: value.trim() };\n        },\n        <{ [key: string]: any }>{},\n      );\n    }\n  }\n}\n"],"names":["CrudTypeOrmService","createQuery","query","primaryKeyValue","primaryKeyName","withDeleted","relations","toArray","select","order","toObject","where","startsWith","test","Array","isArray","Object","keys","map","key","value","ArrayContains","el","trim","Raw","field","slice","replaceAll","getOne","id","_req","repo","findOne","getMany","findAndCount","then","res","data","count","getManyByRelation","req","merge","post","body","_query","save","patchOne","primaryKey","Error","patchMany","find","putOne","NotImplementedException","putMany","deleteOne","primaryKeyOrCondition","includes","deleteMany","deleteQuery","softDelete","delete","builder","createQueryBuilder","execute","affected","clear","delimiter","split","filter","defaultValue","JSON","parse","reduce","acc"],"mappings":";;;;+BAgCaA;;;eAAAA;;;wBAhC2B;yBASjC;+BAGe;AAoBf,IAAA,AAAMA,qBAAN,MAAMA;IAOX;;;;;GAKC,GACD,gCAAgC;IAChC,2DAA2D;IAC3DC,YACEC,KAAsB,EACtBC,eAAiC,EACjCC,iBAAiB,IAAI,EACI;QACzBF,QAAQ;YACN,GAAGA,KAAK;YACR,2DAA2D;YAC3DG,aAAaF,kBACTD,OAAOG,gBAAgB,QACvBH,OAAOG;YACX,0CAA0C;YAC1C,2CAA2C;YAC3C,wDAAwD;YACxDC,WAAW,IAAI,CAACC,OAAO,CAACL,OAAOI;YAC/BE,QAAQ,IAAI,CAACD,OAAO,CAACL,OAAOM;YAC5BC,OAAO,IAAI,CAACC,QAAQ,CAACR,OAAOO,OAAO;QACrC;QAEA,IAAIP,MAAMS,KAAK,EAAE;YACf,gCAAgC;YAChC,IACE,OAAOT,MAAMS,KAAK,KAAK,YACvB,cAAc;YACbT,CAAAA,MAAMS,KAAK,CAACC,UAAU,CAAC,QACtB,iDAAiD;YACjD,wDAAwD;YACxD,gEAAgE;YAChE,gDAAgD;YAChD,yDAAyD;YACzD,mEAAmE;YACnE,wBAAwBC,IAAI,CAACX,MAAMS,KAAK,CAAA,GAC1C;gBACAT,MAAMS,KAAK,GAAG,IAAI,CAACD,QAAQ,CAACR,MAAMS,KAAK;YACzC;YAEA,sBAAsB;YACtB,IAAI,OAAOT,MAAMS,KAAK,KAAK,YAAY,CAACG,MAAMC,OAAO,CAACb,MAAMS,KAAK,GAAG;gBAClEK,OAAOC,IAAI,CAACf,MAAMS,KAAK,EAAGO,GAAG,CAAC,CAACC;oBAC7B,aAAa;oBACb,IAAIC,QAAQlB,MAAMS,KAAK,CAACQ,IAAI;oBAC5B,IAAIL,MAAMC,OAAO,CAACK,QAAQ;wBACxB,+CAA+C;wBAC/C,8DAA8D;wBAC9D,aAAa;wBACblB,MAAMS,KAAK,CAACQ,IAAI,GAAGE,IAAAA,sBAAa,EAACD,MAAMF,GAAG,CAAC,CAACI,KAAOA,IAAIC;oBACzD,OAAO,IAAI,OAAOH,UAAU,UAAU;wBACpCA,QAAQA,OAAOG;wBAEf,mEAAmE;wBACnE,uDAAuD;wBACvD,2CAA2C;wBAC3C,2BAA2B;wBAC3B,oDAAoD;wBACpD,oFAAoF;wBACpF,mCAAmC;wBACnC,IAAIH,OAAOR,aAAa,MAAM;4BAC5B,aAAa;4BACbV,MAAMS,KAAK,CAACQ,IAAI,GAAGK,IAAAA,YAAG,EAAC,CAACC,QACtB,GAAGL,MAAMM,KAAK,CAAC,IAAI,CAACC,UAAU,CAAC,WAAWF;wBAE9C;oBACF;gBACF;gBAEA,kCAAkC;gBAClC,IAAItB,mBAAmBC,gBAAgB;oBACrCF,MAAMS,KAAK,GAAG;wBACZ,CAACP,eAAe,EAAED;wBAClB,GAAGD,MAAMS,KAAK;oBAChB;gBACF;YACF;QACF,OAAO,IAAIR,iBAAiB;YAC1BD,MAAMS,KAAK,GAAG;gBAAE,CAACP,eAAe,EAAED;YAAgB;QACpD;QAEA,OAAgCD;IAClC;IAEA,0DAA0D;IAC1D,iDAAiD;IACjD,cAAc;IACd,uEAAuE;IACvE0B,OAAOC,EAAO,EAAE3B,KAAW,EAAE4B,IAAc,EAAE;QAC3C,OAAO,IAAI,CAACC,IAAI,CAACC,OAAO,CAAC,IAAI,CAAC/B,WAAW,CAACC,OAAO2B;IACnD;IAEA,uEAAuE;IACvEI,QAAQ/B,KAAW,EAAE4B,IAAc,EAAE;QACnC,OAAO,IAAI,CAACC,IAAI,CACbG,YAAY,CAAC,IAAI,CAACjC,WAAW,CAACC,QAC9BiC,IAAI,CAAC,CAACC,MAAS,CAAA;gBAAEC,MAAMD,GAAG,CAAC,EAAE;gBAAEE,OAAOF,GAAG,CAAC,EAAE;YAAC,CAAA;IAClD;IAEA;;;;;;;;;;;GAWC,GACD,8BAA8B;IAC9B,4EAA4E;IAC5E,uBAAuB;IACvB,sBAAsB;IACtB,iCAAiC;IACjC,oBAAoB;IACpB,4GAA4G;IAC5G,IAAI;IACJ,IAAI;IACJG,kBACEd,KAAa,EACbL,KAAU,EACVlB,KAAW,EACXE,iBAAiB,IAAI,EACrBoC,GAAa,EACb;QACA,OAAO,IAAI,CAACP,OAAO,CACjBQ,IAAAA,oBAAK,EAACvC,SAAS,CAAC,GAAG;YAAES,OAAO;gBAAE,CAACc,MAAM,EAAE;oBAAE,CAACrB,eAAe,EAAEgB;gBAAM;YAAE;QAAE,IACrEoB;IAEJ;IAEAE,KAAKC,IAAyB,EAAEC,MAAY,EAAEd,IAAc,EAAE;QAC5D,uEAAuE;QACvE,0FAA0F;QAC1F,OAAO,IAAI,CAACC,IAAI,CAACc,IAAI,CAACF;IACxB;IAEA;;GAEC,GACDG,SACE,4BAA4B;IAC5BH,IAAyB,EACzBI,aAAuD,IAAI,EAC3DjB,IAAc,EACd;QACA,OAAO,IAAI,CAACF,MAAM,CAACmB,YAAYZ,IAAI,CAAC,CAACC;YACnC,IAAI,CAACA,KAAKP,IAAI,MAAM,IAAImB,MAAM,CAAC,SAAS,CAAC;YACzC,0DAA0D;YAC1D,4EAA4E;YAC5E,+DAA+D;YAC/D,OAAO,IAAI,CAACjB,IAAI,CAACc,IAAI,CAAC;gBAAE,GAAGF,IAAI;gBAAEd,IAAIO,IAAIP,EAAE;YAAC;QAC9C;IACF;IAEAoB,UAAUN,IAAyB,EAAEzC,KAAW,EAAE4B,IAAc,EAAE;QAChE,OAAO,IAAI,CAACC,IAAI,CACbmB,IAAI,CAAChD,OACLiC,IAAI,CAAC,CAACC,MAAQA,IAAIlB,GAAG,CAAC,CAACI,KAAQ,CAAA;oBAAE,GAAGqB,IAAI;oBAAEd,IAAIP,GAAGO,EAAE;gBAAC,CAAA,IACpDM,IAAI,CAAC,CAACC,MAAQ,IAAI,CAACL,IAAI,CAACc,IAAI,CAACT;IAEhC,2DAA2D;IAC3D,yEAAyE;IACzE,+EAA+E;IAC/E,mGAAmG;IACnG,kEAAkE;IAElE,mBAAmB;IACnB,+BAA+B;IAC/B,kDAAkD;IACpD;IAEAe,SAAS;QACP,MAAM,IAAIC,+BAAuB;IACnC;IAEAC,UAAU;QACR,MAAM,IAAID,+BAAuB;IACnC;IAEAE,UACEC,qBAA+D,EAC/DrD,QAAa,CAAC,CAAC,EACfsC,GAAa,EACb;QACAtC,MAAMS,KAAK,GAAG;YAAC;YAAU;SAAS,CAAC6C,QAAQ,CAAC,OAAOD,yBAC/CA,wBACA;YAAE,GAAGrD,MAAMS,KAAK;YAAE,GAA4B4C,qBAAqB;QAAE;QACzE,OAAO,IAAI,CAACE,UAAU,CAACvD,OAAOsC;IAChC;IAEAiB,WAAWvD,KAAW,EAAE4B,IAAc,EAAE;QACtC,qCAAqC;QAErC,IAAI4B;QACJ,+GAA+G;QAC/G,IAAIxD,MAAMS,KAAK,EAAE;YACf+C,cACExD,MAAMyD,UAAU,KAAK,QACjB,IAAI,CAAC5B,IAAI,CAAC6B,MAAM,CAAC1D,MAAMS,KAAK,IAC5B,IAAI,CAACoB,IAAI,CAAC4B,UAAU,CAACzD,MAAMS,KAAK;QACxC,OAAO;YACL,IAAIkD,UAAU,IAAI,CAAC9B,IAAI,CAAC+B,kBAAkB;YAC1CJ,cACExD,MAAMyD,UAAU,KAAK,QACjBE,QAAQD,MAAM,GAAGjD,KAAK,CAAC,SAASoD,OAAO,KACvCF,QAAQF,UAAU,GAAGhD,KAAK,CAAC,SAASoD,OAAO;QACnD;QACA,OAAOL,YAAYvB,IAAI,CAAC,CAACC,MAAS,CAAA;gBAAE4B,UAAU5B,KAAK4B;YAAS,CAAA;IAC9D;IAEA;;GAEC,GACD,uFAAuF;IACvFC,QAAQ;QACN,OAAO,IAAI,CAAClC,IAAI,CAACkC,KAAK;IACxB;IAEA;;;GAGC,GACD1D,QAAQa,KAAW,EAAE8C,YAAY,GAAG,EAAE;QACpC,OAAO,OAAO9C,UAAU,WACpBA,OACI+C,QAAQD,YAERE,OAAO,CAAC9C,KAAOA,MAAMA,GAAGC,IAAI,OAAO,MACvCH;IACN;IAEA;;;;GAIC,GACDV,SAASU,KAAW,EAAEiD,eAAoB,IAAI,EAAE;QAC9C,IAAI,CAACjD,OAAO;QACZ,IAAI,OAAOA,UAAU,UAAU,OAAOA;QACtC,wCAAwC;QAExC,IAAI;YACF,OAAOkD,KAAKC,KAAK,CAACnD;QACpB,EAAE,OAAM;YACN,OAAOA,OAAO+C,QAAQ,MAAMK,SAC1B,CAACC,KAAKnD;gBACJ,IAAI,CAACH,KAAKC,QAAQiD,YAAY,CAAC,GAAG/C,GAAG6C,KAAK,CAAC;gBAC3C,OAAO;oBAAE,GAAGM,GAAG;oBAAE,CAACtD,IAAII,IAAI,GAAG,EAAEH,MAAMG,IAAI;gBAAG;YAC9C,GACwB,CAAC;QAE7B;IACF;IAzQA,YACE,iCAAiC;IACjC,2DAA2D;IACjDQ,IAAwB,CAClC;aADUA,OAAAA;IACT;AAsQL"}

package/src/decorators/controller/types/index.d.ts

@@ -0,0 +1,54 @@
+import { HttpStatus, type NestInterceptor, type Type } from '@nestjs/common';
+import type { ApiOperationOptions, ApiParamOptions } from '@nestjs/swagger';
+import type { ParameterObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import type { SwaggerEnumType } from '@nestjs/swagger/dist/types/swagger-enum.type';
+type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+export interface ControllerOptions extends MakeRequired<InitControllerOptions, 'serviceName' | 'routes'> {
+    routes: IRoute[];
+}
+export interface IRoute extends MakeRequired<InitRoute, 'methodName' | 'httpMethod' | 'decorators' | 'interceptors'> {
+}
+export interface InitControllerOptions {
+    path?: string;
+    routes?: InitRoute[];
+    queryParams?: QueryParam[];
+    serviceName?: string;
+    model?: any;
+    responseModel?: InitControllerOptions['model'];
+    errorResponseModel?: InitControllerOptions['model'];
+    responseModels?: Array<{
+        status: HttpStatus;
+        type: InitControllerOptions['model'];
+    }>;
+    primaryKey?: string;
+    maxLimit?: number;
+    decorators?: (MethodDecorator | PropertyDecorator)[];
+    interceptors?: (NestInterceptor | Function)[];
+    query?: {
+        [key: string]: any;
+    };
+    tags?: string | string | null;
+}
+export interface InitRoute extends ApiOperationOptions, Omit<InitControllerOptions, 'routes' | 'tags'> {
+    httpMethod?: HttpMethod;
+    path?: string;
+    methodName?: string;
+    many?: boolean;
+    methodFactory?: () => any;
+    description?: string;
+    pathParams?: ApiParamOptions[];
+    disabled?: boolean;
+}
+export interface QueryParam extends ParameterOptions {
+    name?: string;
+    type?: Type<unknown> | Function | [Function] | string;
+    isArray?: boolean;
+    enum?: SwaggerEnumType;
+    enumName?: string;
+    many?: boolean;
+    httpMethods?: HttpMethod[];
+}
+type ParameterOptions = Omit<ParameterObject, 'in' | 'name'>;
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+export type RouteHandler = (req: Request, query: any, ...params: any[]) => any;
+export {};

package/src/decorators/controller/types/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=index.js.map

package/src/decorators/controller/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/types/index.ts"],"names":[],"mappings":""}

package/src/decorators/controller/utils/merge-options.d.ts

@@ -0,0 +1,2 @@
+import { ControllerOptions, InitControllerOptions } from '../types';
+export declare function mergeOptions(...options: InitControllerOptions[]): ControllerOptions;

package/src/decorators/controller/utils/merge-options.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "mergeOptions", {
+    enumerable: true,
+    get: function() {
+        return mergeOptions;
+    }
+});
+const _javascript = require("@impactor/javascript");
+function mergeOptions(...options) {
+    let opts = (0, _javascript.merge)(options.map((el)=>(0, _javascript.removeValues)(el, [
+            undefined,
+            null
+        ]) || {}), {
+        deep: true
+    });
+    // todo: merge matched routes (by methodNam, path, and httpMethod) and queryParams (by name)
+    // the later override the previous one
+    // opts.queryParams?.map((param) => {
+    //   let existingQueryParam = opts.queryParams!.findIndex(
+    //     (el) => el.name === param.name,
+    //   );
+    //   opts.queryParams!.push(
+    //     existingQueryParam > -1
+    //       ? {
+    //           ...opts.queryParams![existingQueryParam],
+    //           ...param,
+    //         }
+    //       : param,
+    //   );
+    // });
+    return opts;
+}
+
+//# sourceMappingURL=merge-options.js.map

package/src/decorators/controller/utils/merge-options.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/decorators/controller/utils/merge-options.ts"],"sourcesContent":["import { ControllerOptions, InitControllerOptions } from '../types';\nimport { merge, removeValues } from '@impactor/javascript';\n\nexport function mergeOptions(\n  ...options: InitControllerOptions[]\n): ControllerOptions {\n  let opts = <ControllerOptions>merge(\n    options.map((el) => removeValues(el, [undefined, null]) || {}),\n    { deep: true },\n  );\n\n  // todo: merge matched routes (by methodNam, path, and httpMethod) and queryParams (by name)\n  // the later override the previous one\n  // opts.queryParams?.map((param) => {\n  //   let existingQueryParam = opts.queryParams!.findIndex(\n  //     (el) => el.name === param.name,\n  //   );\n\n  //   opts.queryParams!.push(\n  //     existingQueryParam > -1\n  //       ? {\n  //           ...opts.queryParams![existingQueryParam],\n  //           ...param,\n  //         }\n  //       : param,\n  //   );\n  // });\n\n  return opts;\n}\n"],"names":["mergeOptions","options","opts","merge","map","el","removeValues","undefined","deep"],"mappings":";;;;+BAGgBA;;;eAAAA;;;4BAFoB;AAE7B,SAASA,aACd,GAAGC,OAAgC;IAEnC,IAAIC,OAA0BC,IAAAA,iBAAK,EACjCF,QAAQG,GAAG,CAAC,CAACC,KAAOC,IAAAA,wBAAY,EAACD,IAAI;YAACE;YAAW;SAAK,KAAK,CAAC,IAC5D;QAAEC,MAAM;IAAK;IAGf,4FAA4F;IAC5F,sCAAsC;IACtC,qCAAqC;IACrC,0DAA0D;IAC1D,sCAAsC;IACtC,OAAO;IAEP,4BAA4B;IAC5B,8BAA8B;IAC9B,YAAY;IACZ,sDAAsD;IACtD,sBAAsB;IACtB,YAAY;IACZ,iBAAiB;IACjB,OAAO;IACP,MAAM;IAEN,OAAON;AACT"}

package/src/decorators/controller/utils/reflect.d.ts

@@ -0,0 +1,10 @@
+import { ControllerFactory } from '../controller.factory';
+import { IRoute } from '../types';
+export declare function has(property: string, factory: ControllerFactory, route?: IRoute): boolean;
+export declare function get(property: string, factory: ControllerFactory, route?: IRoute): any;
+export declare function set<T extends Object>(property: string, value: T, factory: ControllerFactory, route?: IRoute): void;
+export declare function getKeys(factory: ControllerFactory, route?: IRoute): any[];
+export declare function getAll(factory: ControllerFactory, route?: IRoute): {
+    [key: string]: unknown;
+};
+export declare function applyDecorators(factory: ControllerFactory): void;