@impactor/nest 3.0.0 → 5.0.0

package/src/decorators/controller/utils/reflect.js

@@ -1,53 +1,33 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get applyDecorators () {
-        return applyDecorators;
-    },
-    get get () {
-        return get;
-    },
-    get getAll () {
-        return getAll;
-    },
-    get getKeys () {
-        return getKeys;
-    },
-    get has () {
-        return has;
-    },
-    get set () {
-        return set;
-    }
-});
-const _common = require("@nestjs/common");
-function has(property, factory, route) {
+import { UseInterceptors } from "@nestjs/common";
+/**
+ * Check if the class or a method has a metadata property
+ * @param property the metadata property to be checked
+ * @param factory the class
+ * @param route if provided, the method's metadata is checked, otherwise the class's metadata is checked
+ * @returns
+ */ export function has(property, factory, route) {
     if (route && !route.methodName) {
         throw new Error(`route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`);
     }
     return route ? Reflect.hasMetadata(property, factory.controller.prototype[route.methodName]) : Reflect.hasMetadata(property, factory.controller.prototype) || Reflect.hasMetadata(property, factory.controller);
 }
-function get(property, factory, route) {
+export function get(property, factory, route) {
     if (route && !route.methodName) {
         throw new Error(`route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`);
     }
     return route ? Reflect.getMetadata(property, factory.controller.prototype[route.methodName]) : Reflect.getMetadata(property, factory.controller.prototype) || Reflect.getMetadata(property, factory.controller);
 }
-function set(property, value, factory, route) {
+export function set(property, value, factory, route) {
     if (route && !route.methodName) {
         throw new Error(`route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`);
     }
     return route ? Reflect.defineMetadata(property, value, factory.controller.prototype[route.methodName]) : Reflect.defineMetadata(property, value, factory.controller.prototype);
 }
-function getKeys(factory, route) {
+/**
+ * get all metadata keys
+ * @param factory
+ * @param route
+ */ export function getKeys(factory, route) {
     if (route && !route.methodName) {
         throw new Error(`route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`);
     }
@@ -58,7 +38,11 @@ function getKeys(factory, route) {
         ])
     ];
 }
-function getAll(factory, route) {
+/**
+ * get all metadata key-value pairs
+ * @param factory
+ * @param route
+ */ export function getAll(factory, route) {
     let keys = getKeys(factory, route);
     let map = {};
     for (let key of keys){
@@ -66,7 +50,9 @@ function getAll(factory, route) {
     }
     return map;
 }
-function applyDecorators(factory) {
+/**
+ * apply the provided decorators to the method
+ */ export function applyDecorators(factory) {
     if (factory.decorators?.length) {
         Reflect.decorate(factory.decorators, factory.controller);
     }
@@ -76,7 +62,7 @@ function applyDecorators(factory) {
             Reflect.decorate(route.decorators, factory.controller.prototype, route.methodName, Reflect.getOwnPropertyDescriptor(factory.controller.prototype, route.methodName));
             if (route.interceptors?.length) {
                 Reflect.decorate([
-                    (0, _common.UseInterceptors)(...route.interceptors)
+                    UseInterceptors(...route.interceptors)
                 ], factory.controller.prototype, route.methodName, Reflect.getOwnPropertyDescriptor(factory.controller.prototype, route.methodName));
             }
         }

package/src/decorators/controller/utils/reflect.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/decorators/controller/utils/reflect.ts"],"sourcesContent":["import { UseInterceptors } from '@nestjs/common';\nimport { ControllerFactory } from '../controller.factory';\nimport { IRoute } from '../types';\n\n/**\n * Check if the class or a method has a metadata property\n * @param property the metadata property to be checked\n * @param factory the class\n * @param route if provided, the method's metadata is checked, otherwise the class's metadata is checked\n * @returns\n */\nexport function has(\n  property: string,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.hasMetadata(\n        property,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.hasMetadata(property, factory.controller.prototype) ||\n        Reflect.hasMetadata(property, factory.controller);\n}\n\nexport function get(\n  property: string,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.getMetadata(\n        property,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.getMetadata(property, factory.controller.prototype) ||\n        Reflect.getMetadata(property, factory.controller);\n}\n\nexport function set<T extends Object>(\n  property: string,\n  value: T,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.defineMetadata(\n        property,\n        value,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.defineMetadata(property, value, factory.controller.prototype);\n}\n\n/**\n * get all metadata keys\n * @param factory\n * @param route\n */\nexport function getKeys(factory: ControllerFactory, route?: IRoute) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.getMetadataKeys(factory.controller.prototype[route.methodName])\n    : [\n        ...new Set([\n          ...Reflect.getMetadataKeys(factory.controller.prototype),\n          ...Reflect.getMetadataKeys(factory.controller),\n        ]),\n      ];\n}\n\n/**\n * get all metadata key-value pairs\n * @param factory\n * @param route\n */\nexport function getAll(factory: ControllerFactory, route?: IRoute) {\n  let keys = getKeys(factory, route);\n  let map: { [key: string]: unknown } = {};\n\n  for (let key of keys) {\n    map[key] = get(key, factory, route);\n  }\n\n  return map;\n}\n\n/**\n * apply the provided decorators to the method\n */\nexport function applyDecorators(factory: ControllerFactory) {\n  if (factory.decorators?.length) {\n    Reflect.decorate(factory.decorators, factory.controller);\n  }\n\n  for (let route of factory.options.routes) {\n    // without reflect-metadata use: `decorator(target, method, descriptor)`\n    if (route.decorators?.length) {\n      Reflect.decorate(\n        route.decorators,\n        factory.controller.prototype,\n        route.methodName,\n        Reflect.getOwnPropertyDescriptor(\n          factory.controller.prototype,\n          route.methodName,\n        ),\n      );\n\n      if (route.interceptors?.length) {\n        Reflect.decorate(\n          [UseInterceptors(...route.interceptors)],\n          factory.controller.prototype,\n          route.methodName,\n          Reflect.getOwnPropertyDescriptor(\n            factory.controller.prototype,\n            route.methodName,\n          ),\n        );\n      }\n    }\n  }\n}\n"],"names":["applyDecorators","get","getAll","getKeys","has","set","property","factory","route","methodName","Error","httpMethod","toUpperCase","path","Reflect","hasMetadata","controller","prototype","getMetadata","value","defineMetadata","getMetadataKeys","Set","keys","map","key","decorators","length","decorate","options","routes","getOwnPropertyDescriptor","interceptors","UseInterceptors"],"mappings":";;;;;;;;;;;QAiHgBA;eAAAA;;QAlFAC;eAAAA;;QAoEAC;eAAAA;;QAtBAC;eAAAA;;QAlEAC;eAAAA;;QAwCAC;eAAAA;;;wBAnDgB;AAWzB,SAASD,IACdE,QAAgB,EAChBC,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQC,WAAW,CACjBT,UACAC,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQC,WAAW,CAACT,UAAUC,QAAQS,UAAU,CAACC,SAAS,KACxDH,QAAQC,WAAW,CAACT,UAAUC,QAAQS,UAAU;AACxD;AAEO,SAASf,IACdK,QAAgB,EAChBC,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQI,WAAW,CACjBZ,UACAC,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQI,WAAW,CAACZ,UAAUC,QAAQS,UAAU,CAACC,SAAS,KACxDH,QAAQI,WAAW,CAACZ,UAAUC,QAAQS,UAAU;AACxD;AAEO,SAASX,IACdC,QAAgB,EAChBa,KAAQ,EACRZ,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQM,cAAc,CACpBd,UACAa,OACAZ,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQM,cAAc,CAACd,UAAUa,OAAOZ,QAAQS,UAAU,CAACC,SAAS;AAC1E;AAOO,SAASd,QAAQI,OAA0B,EAAEC,KAAc;IAChE,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQO,eAAe,CAACd,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IACtE;WACK,IAAIa,IAAI;eACNR,QAAQO,eAAe,CAACd,QAAQS,UAAU,CAACC,SAAS;eACpDH,QAAQO,eAAe,CAACd,QAAQS,UAAU;SAC9C;KACF;AACP;AAOO,SAASd,OAAOK,OAA0B,EAAEC,KAAc;IAC/D,IAAIe,OAAOpB,QAAQI,SAASC;IAC5B,IAAIgB,MAAkC,CAAC;IAEvC,KAAK,IAAIC,OAAOF,KAAM;QACpBC,GAAG,CAACC,IAAI,GAAGxB,IAAIwB,KAAKlB,SAASC;IAC/B;IAEA,OAAOgB;AACT;AAKO,SAASxB,gBAAgBO,OAA0B;IACxD,IAAIA,QAAQmB,UAAU,EAAEC,QAAQ;QAC9Bb,QAAQc,QAAQ,CAACrB,QAAQmB,UAAU,EAAEnB,QAAQS,UAAU;IACzD;IAEA,KAAK,IAAIR,SAASD,QAAQsB,OAAO,CAACC,MAAM,CAAE;QACxC,wEAAwE;QACxE,IAAItB,MAAMkB,UAAU,EAAEC,QAAQ;YAC5Bb,QAAQc,QAAQ,CACdpB,MAAMkB,UAAU,EAChBnB,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU,EAChBK,QAAQiB,wBAAwB,CAC9BxB,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU;YAIpB,IAAID,MAAMwB,YAAY,EAAEL,QAAQ;gBAC9Bb,QAAQc,QAAQ,CACd;oBAACK,IAAAA,uBAAe,KAAIzB,MAAMwB,YAAY;iBAAE,EACxCzB,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU,EAChBK,QAAQiB,wBAAwB,CAC9BxB,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU;YAGtB;QACF;IACF;AACF"}
+{"version":3,"sources":["../../../../../src/decorators/controller/utils/reflect.ts"],"sourcesContent":["import { UseInterceptors } from '@nestjs/common';\nimport { ControllerFactory } from '../controller.factory.js';\nimport { IRoute } from '../types/index.js';\n\n/**\n * Check if the class or a method has a metadata property\n * @param property the metadata property to be checked\n * @param factory the class\n * @param route if provided, the method's metadata is checked, otherwise the class's metadata is checked\n * @returns\n */\nexport function has(\n  property: string,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.hasMetadata(\n        property,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.hasMetadata(property, factory.controller.prototype) ||\n        Reflect.hasMetadata(property, factory.controller);\n}\n\nexport function get(\n  property: string,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.getMetadata(\n        property,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.getMetadata(property, factory.controller.prototype) ||\n        Reflect.getMetadata(property, factory.controller);\n}\n\nexport function set<T extends Object>(\n  property: string,\n  value: T,\n  factory: ControllerFactory,\n  route?: IRoute,\n) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.defineMetadata(\n        property,\n        value,\n        factory.controller.prototype[route.methodName],\n      )\n    : Reflect.defineMetadata(property, value, factory.controller.prototype);\n}\n\n/**\n * get all metadata keys\n * @param factory\n * @param route\n */\nexport function getKeys(factory: ControllerFactory, route?: IRoute) {\n  if (route && !route.methodName) {\n    throw new Error(\n      `route's methodName is not provided (${route.httpMethod?.toUpperCase()} ${route.path})`,\n    );\n  }\n\n  return route\n    ? Reflect.getMetadataKeys(factory.controller.prototype[route.methodName])\n    : [\n        ...new Set([\n          ...Reflect.getMetadataKeys(factory.controller.prototype),\n          ...Reflect.getMetadataKeys(factory.controller),\n        ]),\n      ];\n}\n\n/**\n * get all metadata key-value pairs\n * @param factory\n * @param route\n */\nexport function getAll(factory: ControllerFactory, route?: IRoute) {\n  let keys = getKeys(factory, route);\n  let map: { [key: string]: unknown } = {};\n\n  for (let key of keys) {\n    map[key] = get(key, factory, route);\n  }\n\n  return map;\n}\n\n/**\n * apply the provided decorators to the method\n */\nexport function applyDecorators(factory: ControllerFactory) {\n  if (factory.decorators?.length) {\n    Reflect.decorate(factory.decorators, factory.controller);\n  }\n\n  for (let route of factory.options.routes) {\n    // without reflect-metadata use: `decorator(target, method, descriptor)`\n    if (route.decorators?.length) {\n      Reflect.decorate(\n        route.decorators,\n        factory.controller.prototype,\n        route.methodName,\n        Reflect.getOwnPropertyDescriptor(\n          factory.controller.prototype,\n          route.methodName,\n        ),\n      );\n\n      if (route.interceptors?.length) {\n        Reflect.decorate(\n          [UseInterceptors(...route.interceptors)],\n          factory.controller.prototype,\n          route.methodName,\n          Reflect.getOwnPropertyDescriptor(\n            factory.controller.prototype,\n            route.methodName,\n          ),\n        );\n      }\n    }\n  }\n}\n"],"names":["UseInterceptors","has","property","factory","route","methodName","Error","httpMethod","toUpperCase","path","Reflect","hasMetadata","controller","prototype","get","getMetadata","set","value","defineMetadata","getKeys","getMetadataKeys","Set","getAll","keys","map","key","applyDecorators","decorators","length","decorate","options","routes","getOwnPropertyDescriptor","interceptors"],"mappings":"AAAA,SAASA,eAAe,QAAQ,iBAAiB;AAIjD;;;;;;CAMC,GACD,OAAO,SAASC,IACdC,QAAgB,EAChBC,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQC,WAAW,CACjBT,UACAC,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQC,WAAW,CAACT,UAAUC,QAAQS,UAAU,CAACC,SAAS,KACxDH,QAAQC,WAAW,CAACT,UAAUC,QAAQS,UAAU;AACxD;AAEA,OAAO,SAASE,IACdZ,QAAgB,EAChBC,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQK,WAAW,CACjBb,UACAC,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQK,WAAW,CAACb,UAAUC,QAAQS,UAAU,CAACC,SAAS,KACxDH,QAAQK,WAAW,CAACb,UAAUC,QAAQS,UAAU;AACxD;AAEA,OAAO,SAASI,IACdd,QAAgB,EAChBe,KAAQ,EACRd,OAA0B,EAC1BC,KAAc;IAEd,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQQ,cAAc,CACpBhB,UACAe,OACAd,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IAEhDK,QAAQQ,cAAc,CAAChB,UAAUe,OAAOd,QAAQS,UAAU,CAACC,SAAS;AAC1E;AAEA;;;;CAIC,GACD,OAAO,SAASM,QAAQhB,OAA0B,EAAEC,KAAc;IAChE,IAAIA,SAAS,CAACA,MAAMC,UAAU,EAAE;QAC9B,MAAM,IAAIC,MACR,CAAC,oCAAoC,EAAEF,MAAMG,UAAU,EAAEC,cAAc,CAAC,EAAEJ,MAAMK,IAAI,CAAC,CAAC,CAAC;IAE3F;IAEA,OAAOL,QACHM,QAAQU,eAAe,CAACjB,QAAQS,UAAU,CAACC,SAAS,CAACT,MAAMC,UAAU,CAAC,IACtE;WACK,IAAIgB,IAAI;eACNX,QAAQU,eAAe,CAACjB,QAAQS,UAAU,CAACC,SAAS;eACpDH,QAAQU,eAAe,CAACjB,QAAQS,UAAU;SAC9C;KACF;AACP;AAEA;;;;CAIC,GACD,OAAO,SAASU,OAAOnB,OAA0B,EAAEC,KAAc;IAC/D,IAAImB,OAAOJ,QAAQhB,SAASC;IAC5B,IAAIoB,MAAkC,CAAC;IAEvC,KAAK,IAAIC,OAAOF,KAAM;QACpBC,GAAG,CAACC,IAAI,GAAGX,IAAIW,KAAKtB,SAASC;IAC/B;IAEA,OAAOoB;AACT;AAEA;;CAEC,GACD,OAAO,SAASE,gBAAgBvB,OAA0B;IACxD,IAAIA,QAAQwB,UAAU,EAAEC,QAAQ;QAC9BlB,QAAQmB,QAAQ,CAAC1B,QAAQwB,UAAU,EAAExB,QAAQS,UAAU;IACzD;IAEA,KAAK,IAAIR,SAASD,QAAQ2B,OAAO,CAACC,MAAM,CAAE;QACxC,wEAAwE;QACxE,IAAI3B,MAAMuB,UAAU,EAAEC,QAAQ;YAC5BlB,QAAQmB,QAAQ,CACdzB,MAAMuB,UAAU,EAChBxB,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU,EAChBK,QAAQsB,wBAAwB,CAC9B7B,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU;YAIpB,IAAID,MAAM6B,YAAY,EAAEL,QAAQ;gBAC9BlB,QAAQmB,QAAQ,CACd;oBAAC7B,mBAAmBI,MAAM6B,YAAY;iBAAE,EACxC9B,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU,EAChBK,QAAQsB,wBAAwB,CAC9B7B,QAAQS,UAAU,CAACC,SAAS,EAC5BT,MAAMC,UAAU;YAGtB;QACF;IACF;AACF"}

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

@@ -0,0 +1,6 @@
+import { EntityOptions } from 'typeorm';
+export interface IEntityOptions extends EntityOptions {
+    name?: string;
+}
+export declare function Entity(name?: string, options?: EntityOptions): ClassDecorator;
+export declare function Hide(): PropertyDecorator;

package/src/decorators/entity.decorator.js

@@ -0,0 +1,73 @@
+import { registerEntities } from "../register-entities.js";
+import { Entity as TypeORMEntity, getMetadataArgsStorage } from "typeorm";
+import { snakeCase } from "typeorm/util/StringUtils.js";
+/**
+ * Define a class as a TypeORM entity
+ * - add Swagger decorators to all columns
+ *
+ * note: currently, this decorator ignores `@ApiHideProperty()`
+ * use `@Hide()` instead
+ * https://github.com/nestjs/swagger/issues/3711
+ */ // todo: add basic columns such as id, created_at, updated_at
+// this has a downside, that TS cannot detect props that are defined dynamically
+// i.e. `Model.id` will cause a TS error
+// todo: add class validator decorators from column definition
+// for instance `@Column(type: 'varchar', length: 200)` -> `@IsString() @MaxLength(200)`
+// note that we cannot access uninitialized classes properties,
+// so `this.model[col.propertyName]` is always undefined,
+// also Reflect methods cannot be used to decorate those properties as they are not existing
+// otherwise use a property decorator to work with each property separately
+// todo: create `@Column()` decorator to apply these steps on property-level
+// this has a downside: it'll use the property name rather than the final column name,
+// because TypeORM may rename the column using a naming strategy
+// so, we need to access the naming strategy to apply it on each prop
+export function Entity(name, options) {
+    return (target)=>{
+        new EntityFactory(target, {
+            name,
+            ...options
+        });
+    };
+}
+let EntityFactory = class EntityFactory {
+    constructor(model, options){
+        this.model = model;
+        this.options = options;
+        /**
+   * contains all TypeORM metadata for all entities
+   */ this.storage = getMetadataArgsStorage();
+        this.addEntity();
+        this.addSwaggerDecorators();
+    }
+    /**
+   * decorate the class with TypeORM `@Entity()`
+   */ addEntity() {
+        // TypeORM's `@Entity()` adds the class to storage.tables
+        if (!this.storage.tables.some((el)=>el.target === this.model)) {
+            Reflect.decorate([
+                TypeORMEntity(this.options?.name || // todo: generate plural names
+                snakeCase(this.model.name.replace(/(Entity|DTO|Model)$/i, '') + 's'), this.options)
+            ], this.model);
+        }
+    }
+    /**
+   * add Swagger decorators to all the model fields
+   */ addSwaggerDecorators() {
+        // todo: also get the class that this.model extends, if any.
+        registerEntities([
+            this.model
+        ]);
+    }
+};
+/**
+ * add `@Hide()` to properties that you don't want to hide in Swagger
+ * Using `@ApiHideProperty()` from `@nestjs/swagger` is not supported
+ * `@ApiHideProperty()` doesn't add a metadata -> use `@Hide()`
+ *  https://github.com/nestjs/swagger/blob/master/lib/decorators/api-hide-property.decorator.ts
+ */ export function Hide() {
+    return (target, key)=>{
+        Reflect.defineMetadata('swagger/apiModelProperties', false, target, key);
+    };
+}
+
+//# sourceMappingURL=entity.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/decorators/entity.decorator.ts"],"sourcesContent":["import { registerEntities } from '../register-entities.js';\nimport {\n  Entity as TypeORMEntity,\n  EntityOptions,\n  getMetadataArgsStorage,\n} from 'typeorm';\nimport { MetadataArgsStorage } from 'typeorm/metadata-args/MetadataArgsStorage.js';\nimport { snakeCase } from 'typeorm/util/StringUtils.js';\n\nexport interface IEntityOptions extends EntityOptions {\n  name?: string;\n}\n\n/**\n * Define a class as a TypeORM entity\n * - add Swagger decorators to all columns\n *\n * note: currently, this decorator ignores `@ApiHideProperty()`\n * use `@Hide()` instead\n * https://github.com/nestjs/swagger/issues/3711\n */\n// todo: add basic columns such as id, created_at, updated_at\n// this has a downside, that TS cannot detect props that are defined dynamically\n// i.e. `Model.id` will cause a TS error\n// todo: add class validator decorators from column definition\n// for instance `@Column(type: 'varchar', length: 200)` -> `@IsString() @MaxLength(200)`\n// note that we cannot access uninitialized classes properties,\n// so `this.model[col.propertyName]` is always undefined,\n// also Reflect methods cannot be used to decorate those properties as they are not existing\n// otherwise use a property decorator to work with each property separately\n// todo: create `@Column()` decorator to apply these steps on property-level\n// this has a downside: it'll use the property name rather than the final column name,\n// because TypeORM may rename the column using a naming strategy\n// so, we need to access the naming strategy to apply it on each prop\nexport function Entity(name?: string, options?: EntityOptions): ClassDecorator {\n  return (target: Function) => {\n    new EntityFactory(target, { name, ...options });\n  };\n}\n\nclass EntityFactory {\n  /**\n   * contains all TypeORM metadata for all entities\n   */\n  private storage: MetadataArgsStorage = getMetadataArgsStorage();\n\n  constructor(\n    private model: Function,\n    private options?: IEntityOptions,\n  ) {\n    this.addEntity();\n    this.addSwaggerDecorators();\n  }\n\n  /**\n   * decorate the class with TypeORM `@Entity()`\n   */\n  addEntity() {\n    // TypeORM's `@Entity()` adds the class to storage.tables\n    if (!this.storage.tables.some((el) => el.target === this.model)) {\n      Reflect.decorate(\n        [\n          TypeORMEntity(\n            this.options?.name ||\n              // todo: generate plural names\n              snakeCase(\n                this.model.name.replace(/(Entity|DTO|Model)$/i, '') + 's',\n              ),\n            this.options,\n          ),\n        ],\n        this.model,\n      );\n    }\n  }\n\n  /**\n   * add Swagger decorators to all the model fields\n   */\n  addSwaggerDecorators() {\n    // todo: also get the class that this.model extends, if any.\n    registerEntities([this.model]);\n  }\n}\n\n/**\n * add `@Hide()` to properties that you don't want to hide in Swagger\n * Using `@ApiHideProperty()` from `@nestjs/swagger` is not supported\n * `@ApiHideProperty()` doesn't add a metadata -> use `@Hide()`\n *  https://github.com/nestjs/swagger/blob/master/lib/decorators/api-hide-property.decorator.ts\n */\nexport function Hide(): PropertyDecorator {\n  return (target: Object, key: string | symbol) => {\n    Reflect.defineMetadata('swagger/apiModelProperties', false, target, key);\n  };\n}\n"],"names":["registerEntities","Entity","TypeORMEntity","getMetadataArgsStorage","snakeCase","name","options","target","EntityFactory","model","storage","addEntity","addSwaggerDecorators","tables","some","el","Reflect","decorate","replace","Hide","key","defineMetadata"],"mappings":"AAAA,SAASA,gBAAgB,QAAQ,0BAA0B;AAC3D,SACEC,UAAUC,aAAa,EAEvBC,sBAAsB,QACjB,UAAU;AAEjB,SAASC,SAAS,QAAQ,8BAA8B;AAMxD;;;;;;;CAOC,GACD,6DAA6D;AAC7D,gFAAgF;AAChF,wCAAwC;AACxC,8DAA8D;AAC9D,wFAAwF;AACxF,+DAA+D;AAC/D,yDAAyD;AACzD,4FAA4F;AAC5F,2EAA2E;AAC3E,4EAA4E;AAC5E,sFAAsF;AACtF,gEAAgE;AAChE,qEAAqE;AACrE,OAAO,SAASH,OAAOI,IAAa,EAAEC,OAAuB;IAC3D,OAAO,CAACC;QACN,IAAIC,cAAcD,QAAQ;YAAEF;YAAM,GAAGC,OAAO;QAAC;IAC/C;AACF;AAEA,IAAA,AAAME,gBAAN,MAAMA;IAMJ,YACE,AAAQC,KAAe,EACvB,AAAQH,OAAwB,CAChC;aAFQG,QAAAA;aACAH,UAAAA;QAPV;;GAEC,QACOI,UAA+BP;QAMrC,IAAI,CAACQ,SAAS;QACd,IAAI,CAACC,oBAAoB;IAC3B;IAEA;;GAEC,GACDD,YAAY;QACV,yDAAyD;QACzD,IAAI,CAAC,IAAI,CAACD,OAAO,CAACG,MAAM,CAACC,IAAI,CAAC,CAACC,KAAOA,GAAGR,MAAM,KAAK,IAAI,CAACE,KAAK,GAAG;YAC/DO,QAAQC,QAAQ,CACd;gBACEf,cACE,IAAI,CAACI,OAAO,EAAED,QACZ,8BAA8B;gBAC9BD,UACE,IAAI,CAACK,KAAK,CAACJ,IAAI,CAACa,OAAO,CAAC,wBAAwB,MAAM,MAE1D,IAAI,CAACZ,OAAO;aAEf,EACD,IAAI,CAACG,KAAK;QAEd;IACF;IAEA;;GAEC,GACDG,uBAAuB;QACrB,4DAA4D;QAC5DZ,iBAAiB;YAAC,IAAI,CAACS,KAAK;SAAC;IAC/B;AACF;AAEA;;;;;CAKC,GACD,OAAO,SAASU;IACd,OAAO,CAACZ,QAAgBa;QACtBJ,QAAQK,cAAc,CAAC,8BAA8B,OAAOd,QAAQa;IACtE;AACF"}

package/src/decorators/prop.decorator.js

@@ -1,56 +1,97 @@
-/* eslint unicorn/prevent-abbreviations: 0 */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get Prop () {
-        return Prop;
-    },
-    get Uuid () {
-        return Uuid;
-    },
-    get UuidApi () {
-        return UuidApi;
-    }
-});
-const _common = require("@nestjs/common");
-const _swagger = require("@nestjs/swagger");
-const _microservices = require("@nestjs/microservices");
-const _websockets = require("@nestjs/websockets");
-function Prop(name, scope = 'params', pipes = []) {
+/* eslint unicorn/prevent-abbreviations: 0 */ import { BadRequestException, Body, Param, Query, createParamDecorator } from "@nestjs/common";
+import { ParseUUIDPipe } from "@nestjs/common";
+import { ApiParam } from "@nestjs/swagger";
+import { Payload } from "@nestjs/microservices";
+import { MessageBody } from "@nestjs/websockets";
+/**
+ * a param decorator that extracts a field from the request
+ * and validates it using pipes
+ * and add the suitable Swagger's docs
+ *
+ * @param name the field's name
+ * @param scope the scope where the prop is defined in
+ *
+ * @example
+ * extract userId from params
+ * ```
+ * @Get(':userId')
+ * findUserById(@Prop('userId') userId: string){
+ *  this.service.findUserById(userId);
+ * }
+ * ```
+ *
+ * @example
+ * extract the id from the query string
+ * ```
+ * @Get()
+ * filterByTenant(@Prop('tenantId', 'query') tenantId: string){ ... }
+ * ```
+ *
+ * @example
+ * extract the product id from the request's body
+ * ```
+ * @Post()
+ * createOrder(@Prop('productId','body') productId: string){ ... }
+ * ```
+ *
+ * @example
+ * manipulate the swagger's docs: make the id optional
+ * ```
+ * @Get('id')
+ * find(@Prop('id', 'params', <any>{ required: false }) id?: string){
+ *   return id?: this.service.findById(id) : this.service.find()
+ * }
+ * ```
+ *
+ * @returns the field value
+ * @throws BadRequestException
+ */ export function Prop(name, scope = 'params', pipes = []) {
     return (target, propertyKey, parameterIndex)=>{
         if (scope === 'payload') {
-            return (0, _microservices.Payload)(name, ...pipes)(target, propertyKey, parameterIndex);
+            return Payload(name, ...pipes)(target, propertyKey, parameterIndex);
         } else if (scope === 'messageBody') {
-            return (0, _websockets.MessageBody)(name, ...pipes)(target, propertyKey, parameterIndex);
+            return MessageBody(name, ...pipes)(target, propertyKey, parameterIndex);
         } else if (scope === 'params') {
-            return (0, _common.Param)(name, ...pipes)(target, propertyKey, parameterIndex);
+            return Param(name, ...pipes)(target, propertyKey, parameterIndex);
         } else if (scope === 'query') {
-            return (0, _common.Query)(name, ...pipes)(target, propertyKey, parameterIndex);
+            return Query(name, ...pipes)(target, propertyKey, parameterIndex);
         } else if (scope === 'body') {
-            return (0, _common.Body)(name, ...pipes)(target, propertyKey, parameterIndex);
+            return Body(name, ...pipes)(target, propertyKey, parameterIndex);
         }
     };
 }
-function Uuid(name = 'id', scope = 'params', pipes) {
+/**
+ * apply @prop() to extract the id field and validate its value as uuid *
+ * to customize the Swagger's docs use uuidApi()
+ * @returns the UUID value
+ * @throws BadRequestException
+ */ export function Uuid(name = 'id', scope = 'params', pipes) {
     return Prop(name, scope, pipes || [
-        new _common.ParseUUIDPipe()
+        new ParseUUIDPipe()
     ]);
 }
-function UuidApi(name = 'id', scope = 'params', // TODO: accept options based on the scope's value
+/**
+ * same as Uuid() but can provide additional options for Swagger's docs
+ *
+ * @example
+ * if the prop name is id, it is optional
+ * ```
+ * @Get('id)
+ * findById(@Uuid() id: string){}
+ * ```
+ *
+ * @param name
+ * @param scope
+ * @param apiOptions additional options for swagger's docs
+ * @returns
+ */ export function UuidApi(name = 'id', scope = 'params', // TODO: accept options based on the scope's value
 // TODO: allow swapping between scope and apiOptions
 apiOptions) {
     return (target, propertyKey, parameterIndex)=>{
         // TODO: add swagger docs for other scopes
         // TODO: auto detect if the property is optional -> `@Uuid() id?: string`
         if (scope === 'params') {
-            (0, _swagger.ApiParam)({
+            ApiParam({
                 name,
                 type: 'string',
                 format: 'uuid',
@@ -58,13 +99,13 @@ apiOptions) {
                 ...apiOptions
             })(target.constructor, propertyKey, Object.getOwnPropertyDescriptor(target, propertyKey));
         }
-        let IdParamDecorator = (0, _common.createParamDecorator)((opts, ctx)=>{
+        let IdParamDecorator = createParamDecorator((opts, ctx)=>{
             let { name = 'id', scope = 'params' } = opts;
             let req = ctx.switchToHttp().getRequest();
             let id = req[scope][name];
-            if (!id) throw new _common.BadRequestException(`${name} is required`);
+            if (!id) throw new BadRequestException(`${name} is required`);
             // Use ParseUUIDPipe to validate the UUID
-            let parseUUIDPipe = new _common.ParseUUIDPipe();
+            let parseUUIDPipe = new ParseUUIDPipe();
             return parseUUIDPipe.transform(id, {
                 type: 'param',
                 metatype: String

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/decorators/prop.decorator.ts"],"sourcesContent":["/* eslint unicorn/prevent-abbreviations: 0 */\nimport {\n  BadRequestException,\n  Body,\n  type ExecutionContext,\n  Param,\n  type PipeTransform,\n  Query,\n  type Type,\n  createParamDecorator,\n} from '@nestjs/common';\nimport { ParseUUIDPipe } from '@nestjs/common';\nimport { ApiParam, type ApiParamOptions } from '@nestjs/swagger';\nimport { Payload } from '@nestjs/microservices';\nimport { MessageBody } from '@nestjs/websockets';\n\nexport interface IdParamDecoratorOptions {\n  /**\n   * The property that is wanted to be extracted\n   */\n  name?: string;\n  /**\n   * The scope to extract the property from\n   * @example @Params('id')\n   * @example @Payload('id')\n   */\n  scope?: 'params' | 'query' | 'body' | 'payload' | 'messageBody';\n}\n\n/**\n * a param decorator that extracts a field from the request\n * and validates it using pipes\n * and add the suitable Swagger's docs\n *\n * @param name the field's name\n * @param scope the scope where the prop is defined in\n *\n * @example\n * extract userId from params\n * ```\n * @Get(':userId')\n * findUserById(@Prop('userId') userId: string){\n *  this.service.findUserById(userId);\n * }\n * ```\n *\n * @example\n * extract the id from the query string\n * ```\n * @Get()\n * filterByTenant(@Prop('tenantId', 'query') tenantId: string){ ... }\n * ```\n *\n * @example\n * extract the product id from the request's body\n * ```\n * @Post()\n * createOrder(@Prop('productId','body') productId: string){ ... }\n * ```\n *\n * @example\n * manipulate the swagger's docs: make the id optional\n * ```\n * @Get('id')\n * find(@Prop('id', 'params', <any>{ required: false }) id?: string){\n *   return id?: this.service.findById(id) : this.service.find()\n * }\n * ```\n *\n * @returns the field value\n * @throws BadRequestException\n */\nexport function Prop(\n  name: string,\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  pipes: (Type<PipeTransform> | PipeTransform)[] = [],\n): ParameterDecorator {\n  return (\n    target: Object,\n    propertyKey: string | symbol | undefined,\n    parameterIndex: number,\n  ) => {\n    if (scope === 'payload') {\n      return Payload(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'messageBody') {\n      return MessageBody(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'params') {\n      return Param(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'query') {\n      return Query(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'body') {\n      return Body(name, ...pipes)(target, propertyKey, parameterIndex);\n    }\n  };\n}\n\n/**\n * apply @prop() to extract the id field and validate its value as uuid *\n * to customize the Swagger's docs use uuidApi()\n * @returns the UUID value\n * @throws BadRequestException\n */\nexport function Uuid(\n  name = 'id',\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  pipes?: (Type<PipeTransform> | PipeTransform)[],\n): ParameterDecorator {\n  return Prop(name, scope, pipes || [new ParseUUIDPipe()]);\n}\n\n/**\n * same as Uuid() but can provide additional options for Swagger's docs\n *\n * @example\n * if the prop name is id, it is optional\n * ```\n * @Get('id)\n * findById(@Uuid() id: string){}\n * ```\n *\n * @param name\n * @param scope\n * @param apiOptions additional options for swagger's docs\n * @returns\n */\nexport function UuidApi(\n  name = 'id',\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  // TODO: accept options based on the scope's value\n  // TODO: allow swapping between scope and apiOptions\n  apiOptions?: ApiParamOptions,\n): ParameterDecorator {\n  return (\n    target: Object,\n    propertyKey: string | symbol | undefined,\n    parameterIndex: number,\n  ) => {\n    // TODO: add swagger docs for other scopes\n    // TODO: auto detect if the property is optional -> `@Uuid() id?: string`\n    if (scope === 'params') {\n      ApiParam({\n        name,\n        type: 'string',\n        format: 'uuid',\n        example: '4eae7b32-9065-42b0-a025-5cb967011e65',\n        ...apiOptions,\n      })(\n        target.constructor,\n        propertyKey as string,\n        Object.getOwnPropertyDescriptor(target, propertyKey!)!,\n      );\n    }\n\n    let IdParamDecorator = createParamDecorator(\n      (opts: IdParamDecoratorOptions, ctx: ExecutionContext) => {\n        let { name = 'id', scope = 'params' } = opts;\n\n        let req = ctx.switchToHttp().getRequest();\n        let id = req[scope][name];\n\n        if (!id) throw new BadRequestException(`${name} is required`);\n\n        // Use ParseUUIDPipe to validate the UUID\n        let parseUUIDPipe = new ParseUUIDPipe();\n        return parseUUIDPipe.transform(id, {\n          type: 'param',\n          metatype: String,\n        });\n      },\n    );\n\n    return IdParamDecorator({ name, scope })(\n      target,\n      propertyKey,\n      parameterIndex,\n    );\n  };\n}\n"],"names":["Prop","Uuid","UuidApi","name","scope","pipes","target","propertyKey","parameterIndex","Payload","MessageBody","Param","Query","Body","ParseUUIDPipe","apiOptions","ApiParam","type","format","example","Object","getOwnPropertyDescriptor","IdParamDecorator","createParamDecorator","opts","ctx","req","switchToHttp","getRequest","id","BadRequestException","parseUUIDPipe","transform","metatype","String"],"mappings":"AAAA,2CAA2C;;;;;;;;;;;QAwE3BA;eAAAA;;QA8BAC;eAAAA;;QAuBAC;eAAAA;;;wBAnHT;yBAEwC;+BACvB;4BACI;AA0DrB,SAASF,KACdG,IAAY,EACZC,QAA0C,QAAQ,EAClDC,QAAiD,EAAE;IAEnD,OAAO,CACLC,QACAC,aACAC;QAEA,IAAIJ,UAAU,WAAW;YACvB,OAAOK,IAAAA,sBAAO,EAACN,SAASE,OAAOC,QAAQC,aAAaC;QACtD,OAAO,IAAIJ,UAAU,eAAe;YAClC,OAAOM,IAAAA,uBAAW,EAACP,SAASE,OAAOC,QAAQC,aAAaC;QAC1D,OAAO,IAAIJ,UAAU,UAAU;YAC7B,OAAOO,IAAAA,aAAK,EAACR,SAASE,OAAOC,QAAQC,aAAaC;QACpD,OAAO,IAAIJ,UAAU,SAAS;YAC5B,OAAOQ,IAAAA,aAAK,EAACT,SAASE,OAAOC,QAAQC,aAAaC;QACpD,OAAO,IAAIJ,UAAU,QAAQ;YAC3B,OAAOS,IAAAA,YAAI,EAACV,SAASE,OAAOC,QAAQC,aAAaC;QACnD;IACF;AACF;AAQO,SAASP,KACdE,OAAO,IAAI,EACXC,QAA0C,QAAQ,EAClDC,KAA+C;IAE/C,OAAOL,KAAKG,MAAMC,OAAOC,SAAS;QAAC,IAAIS,qBAAa;KAAG;AACzD;AAiBO,SAASZ,QACdC,OAAO,IAAI,EACXC,QAA0C,QAAQ,EAClD,kDAAkD;AAClD,oDAAoD;AACpDW,UAA4B;IAE5B,OAAO,CACLT,QACAC,aACAC;QAEA,0CAA0C;QAC1C,yEAAyE;QACzE,IAAIJ,UAAU,UAAU;YACtBY,IAAAA,iBAAQ,EAAC;gBACPb;gBACAc,MAAM;gBACNC,QAAQ;gBACRC,SAAS;gBACT,GAAGJ,UAAU;YACf,GACET,OAAO,WAAW,EAClBC,aACAa,OAAOC,wBAAwB,CAACf,QAAQC;QAE5C;QAEA,IAAIe,mBAAmBC,IAAAA,4BAAoB,EACzC,CAACC,MAA+BC;YAC9B,IAAI,EAAEtB,OAAO,IAAI,EAAEC,QAAQ,QAAQ,EAAE,GAAGoB;YAExC,IAAIE,MAAMD,IAAIE,YAAY,GAAGC,UAAU;YACvC,IAAIC,KAAKH,GAAG,CAACtB,MAAM,CAACD,KAAK;YAEzB,IAAI,CAAC0B,IAAI,MAAM,IAAIC,2BAAmB,CAAC,GAAG3B,KAAK,YAAY,CAAC;YAE5D,yCAAyC;YACzC,IAAI4B,gBAAgB,IAAIjB,qBAAa;YACrC,OAAOiB,cAAcC,SAAS,CAACH,IAAI;gBACjCZ,MAAM;gBACNgB,UAAUC;YACZ;QACF;QAGF,OAAOZ,iBAAiB;YAAEnB;YAAMC;QAAM,GACpCE,QACAC,aACAC;IAEJ;AACF"}
+{"version":3,"sources":["../../../src/decorators/prop.decorator.ts"],"sourcesContent":["/* eslint unicorn/prevent-abbreviations: 0 */\nimport {\n  BadRequestException,\n  Body,\n  type ExecutionContext,\n  Param,\n  type PipeTransform,\n  Query,\n  type Type,\n  createParamDecorator,\n} from '@nestjs/common';\nimport { ParseUUIDPipe } from '@nestjs/common';\nimport { ApiParam, type ApiParamOptions } from '@nestjs/swagger';\nimport { Payload } from '@nestjs/microservices';\nimport { MessageBody } from '@nestjs/websockets';\n\nexport interface IdParamDecoratorOptions {\n  /**\n   * The property that is wanted to be extracted\n   */\n  name?: string;\n  /**\n   * The scope to extract the property from\n   * @example @Params('id')\n   * @example @Payload('id')\n   */\n  scope?: 'params' | 'query' | 'body' | 'payload' | 'messageBody';\n}\n\n/**\n * a param decorator that extracts a field from the request\n * and validates it using pipes\n * and add the suitable Swagger's docs\n *\n * @param name the field's name\n * @param scope the scope where the prop is defined in\n *\n * @example\n * extract userId from params\n * ```\n * @Get(':userId')\n * findUserById(@Prop('userId') userId: string){\n *  this.service.findUserById(userId);\n * }\n * ```\n *\n * @example\n * extract the id from the query string\n * ```\n * @Get()\n * filterByTenant(@Prop('tenantId', 'query') tenantId: string){ ... }\n * ```\n *\n * @example\n * extract the product id from the request's body\n * ```\n * @Post()\n * createOrder(@Prop('productId','body') productId: string){ ... }\n * ```\n *\n * @example\n * manipulate the swagger's docs: make the id optional\n * ```\n * @Get('id')\n * find(@Prop('id', 'params', <any>{ required: false }) id?: string){\n *   return id?: this.service.findById(id) : this.service.find()\n * }\n * ```\n *\n * @returns the field value\n * @throws BadRequestException\n */\nexport function Prop(\n  name: string,\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  pipes: (Type<PipeTransform> | PipeTransform)[] = [],\n): ParameterDecorator {\n  return (\n    target: Object,\n    propertyKey: string | symbol | undefined,\n    parameterIndex: number,\n  ) => {\n    if (scope === 'payload') {\n      return Payload(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'messageBody') {\n      return MessageBody(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'params') {\n      return Param(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'query') {\n      return Query(name, ...pipes)(target, propertyKey, parameterIndex);\n    } else if (scope === 'body') {\n      return Body(name, ...pipes)(target, propertyKey, parameterIndex);\n    }\n  };\n}\n\n/**\n * apply @prop() to extract the id field and validate its value as uuid *\n * to customize the Swagger's docs use uuidApi()\n * @returns the UUID value\n * @throws BadRequestException\n */\nexport function Uuid(\n  name = 'id',\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  pipes?: (Type<PipeTransform> | PipeTransform)[],\n): ParameterDecorator {\n  return Prop(name, scope, pipes || [new ParseUUIDPipe()]);\n}\n\n/**\n * same as Uuid() but can provide additional options for Swagger's docs\n *\n * @example\n * if the prop name is id, it is optional\n * ```\n * @Get('id)\n * findById(@Uuid() id: string){}\n * ```\n *\n * @param name\n * @param scope\n * @param apiOptions additional options for swagger's docs\n * @returns\n */\nexport function UuidApi(\n  name = 'id',\n  scope: IdParamDecoratorOptions['scope'] = 'params',\n  // TODO: accept options based on the scope's value\n  // TODO: allow swapping between scope and apiOptions\n  apiOptions?: ApiParamOptions,\n): ParameterDecorator {\n  return (\n    target: Object,\n    propertyKey: string | symbol | undefined,\n    parameterIndex: number,\n  ) => {\n    // TODO: add swagger docs for other scopes\n    // TODO: auto detect if the property is optional -> `@Uuid() id?: string`\n    if (scope === 'params') {\n      ApiParam({\n        name,\n        type: 'string',\n        format: 'uuid',\n        example: '4eae7b32-9065-42b0-a025-5cb967011e65',\n        ...apiOptions,\n      })(\n        target.constructor,\n        propertyKey as string,\n        Object.getOwnPropertyDescriptor(target, propertyKey!)!,\n      );\n    }\n\n    let IdParamDecorator = createParamDecorator(\n      (opts: IdParamDecoratorOptions, ctx: ExecutionContext) => {\n        let { name = 'id', scope = 'params' } = opts;\n\n        let req = ctx.switchToHttp().getRequest();\n        let id = req[scope][name];\n\n        if (!id) throw new BadRequestException(`${name} is required`);\n\n        // Use ParseUUIDPipe to validate the UUID\n        let parseUUIDPipe = new ParseUUIDPipe();\n        return parseUUIDPipe.transform(id, {\n          type: 'param',\n          metatype: String,\n        });\n      },\n    );\n\n    return IdParamDecorator({ name, scope })(\n      target,\n      propertyKey,\n      parameterIndex,\n    );\n  };\n}\n"],"names":["BadRequestException","Body","Param","Query","createParamDecorator","ParseUUIDPipe","ApiParam","Payload","MessageBody","Prop","name","scope","pipes","target","propertyKey","parameterIndex","Uuid","UuidApi","apiOptions","type","format","example","Object","getOwnPropertyDescriptor","IdParamDecorator","opts","ctx","req","switchToHttp","getRequest","id","parseUUIDPipe","transform","metatype","String"],"mappings":"AAAA,2CAA2C,GAC3C,SACEA,mBAAmB,EACnBC,IAAI,EAEJC,KAAK,EAELC,KAAK,EAELC,oBAAoB,QACf,iBAAiB;AACxB,SAASC,aAAa,QAAQ,iBAAiB;AAC/C,SAASC,QAAQ,QAA8B,kBAAkB;AACjE,SAASC,OAAO,QAAQ,wBAAwB;AAChD,SAASC,WAAW,QAAQ,qBAAqB;AAejD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CC,GACD,OAAO,SAASC,KACdC,IAAY,EACZC,QAA0C,QAAQ,EAClDC,QAAiD,EAAE;IAEnD,OAAO,CACLC,QACAC,aACAC;QAEA,IAAIJ,UAAU,WAAW;YACvB,OAAOJ,QAAQG,SAASE,OAAOC,QAAQC,aAAaC;QACtD,OAAO,IAAIJ,UAAU,eAAe;YAClC,OAAOH,YAAYE,SAASE,OAAOC,QAAQC,aAAaC;QAC1D,OAAO,IAAIJ,UAAU,UAAU;YAC7B,OAAOT,MAAMQ,SAASE,OAAOC,QAAQC,aAAaC;QACpD,OAAO,IAAIJ,UAAU,SAAS;YAC5B,OAAOR,MAAMO,SAASE,OAAOC,QAAQC,aAAaC;QACpD,OAAO,IAAIJ,UAAU,QAAQ;YAC3B,OAAOV,KAAKS,SAASE,OAAOC,QAAQC,aAAaC;QACnD;IACF;AACF;AAEA;;;;;CAKC,GACD,OAAO,SAASC,KACdN,OAAO,IAAI,EACXC,QAA0C,QAAQ,EAClDC,KAA+C;IAE/C,OAAOH,KAAKC,MAAMC,OAAOC,SAAS;QAAC,IAAIP;KAAgB;AACzD;AAEA;;;;;;;;;;;;;;CAcC,GACD,OAAO,SAASY,QACdP,OAAO,IAAI,EACXC,QAA0C,QAAQ,EAClD,kDAAkD;AAClD,oDAAoD;AACpDO,UAA4B;IAE5B,OAAO,CACLL,QACAC,aACAC;QAEA,0CAA0C;QAC1C,yEAAyE;QACzE,IAAIJ,UAAU,UAAU;YACtBL,SAAS;gBACPI;gBACAS,MAAM;gBACNC,QAAQ;gBACRC,SAAS;gBACT,GAAGH,UAAU;YACf,GACEL,OAAO,WAAW,EAClBC,aACAQ,OAAOC,wBAAwB,CAACV,QAAQC;QAE5C;QAEA,IAAIU,mBAAmBpB,qBACrB,CAACqB,MAA+BC;YAC9B,IAAI,EAAEhB,OAAO,IAAI,EAAEC,QAAQ,QAAQ,EAAE,GAAGc;YAExC,IAAIE,MAAMD,IAAIE,YAAY,GAAGC,UAAU;YACvC,IAAIC,KAAKH,GAAG,CAAChB,MAAM,CAACD,KAAK;YAEzB,IAAI,CAACoB,IAAI,MAAM,IAAI9B,oBAAoB,GAAGU,KAAK,YAAY,CAAC;YAE5D,yCAAyC;YACzC,IAAIqB,gBAAgB,IAAI1B;YACxB,OAAO0B,cAAcC,SAAS,CAACF,IAAI;gBACjCX,MAAM;gBACNc,UAAUC;YACZ;QACF;QAGF,OAAOV,iBAAiB;YAAEd;YAAMC;QAAM,GACpCE,QACAC,aACAC;IAEJ;AACF"}

package/src/exceptions/rpc-bad-request.exception.d.ts

@@ -1,4 +1,4 @@
-import { RpcBaseException } from './rpc-base.exception';
+import { RpcBaseException } from './rpc-base.exception.js';
 export declare class RpcBadRequestException extends RpcBaseException {
     constructor(message?: string);
 }

package/src/exceptions/rpc-bad-request.exception.js

@@ -1,19 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "RpcBadRequestException", {
-    enumerable: true,
-    get: function() {
-        return RpcBadRequestException;
-    }
-});
-const _common = require("@nestjs/common");
-const _rpcbaseexception = require("./rpc-base.exception");
-let RpcBadRequestException = class RpcBadRequestException extends _rpcbaseexception.RpcBaseException {
+import { HttpStatus } from "@nestjs/common";
+import { RpcBaseException } from "./rpc-base.exception.js";
+export class RpcBadRequestException extends RpcBaseException {
     constructor(message = 'Bad request'){
-        super(message, _common.HttpStatus.BAD_REQUEST);
+        super(message, HttpStatus.BAD_REQUEST);
     }
-};
+}
 
 //# sourceMappingURL=rpc-bad-request.exception.js.map

package/src/exceptions/rpc-bad-request.exception.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/exceptions/rpc-bad-request.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception';\n\nexport class RpcBadRequestException extends RpcBaseException {\n  constructor(message = 'Bad request') {\n    super(message, HttpStatus.BAD_REQUEST);\n  }\n}\n"],"names":["RpcBadRequestException","RpcBaseException","message","HttpStatus","BAD_REQUEST"],"mappings":";;;;+BAGaA;;;eAAAA;;;wBAHc;kCACM;AAE1B,IAAA,AAAMA,yBAAN,MAAMA,+BAA+BC,kCAAgB;IAC1D,YAAYC,UAAU,aAAa,CAAE;QACnC,KAAK,CAACA,SAASC,kBAAU,CAACC,WAAW;IACvC;AACF"}
+{"version":3,"sources":["../../../src/exceptions/rpc-bad-request.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception.js';\n\nexport class RpcBadRequestException extends RpcBaseException {\n  constructor(message = 'Bad request') {\n    super(message, HttpStatus.BAD_REQUEST);\n  }\n}\n"],"names":["HttpStatus","RpcBaseException","RpcBadRequestException","message","BAD_REQUEST"],"mappings":"AAAA,SAASA,UAAU,QAAQ,iBAAiB;AAC5C,SAASC,gBAAgB,QAAQ,0BAA0B;AAE3D,OAAO,MAAMC,+BAA+BD;IAC1C,YAAYE,UAAU,aAAa,CAAE;QACnC,KAAK,CAACA,SAASH,WAAWI,WAAW;IACvC;AACF"}

package/src/exceptions/rpc-base.exception.js

@@ -1,22 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "RpcBaseException", {
-    enumerable: true,
-    get: function() {
-        return RpcBaseException;
-    }
-});
-const _microservices = require("@nestjs/microservices");
-const _common = require("@nestjs/common");
-let RpcBaseException = class RpcBaseException extends _microservices.RpcException {
-    constructor(message, statusCode = _common.HttpStatus.INTERNAL_SERVER_ERROR){
+import { RpcException } from "@nestjs/microservices";
+import { HttpStatus } from "@nestjs/common";
+/**
+ * Base Error class for RPC exceptions.
+ * This exception resembles the behavior of HTTP exceptions, but for RPC errors.
+ */ // todo: use `RpcException(new BadRequestException(message))` instead of creating custom RPC exceptions
+// https://stackoverflow.com/a/75335979
+export class RpcBaseException extends RpcException {
+    constructor(message, statusCode = HttpStatus.INTERNAL_SERVER_ERROR){
         super({
             message
         });
         this.statusCode = statusCode;
     }
-};
+}
 
 //# sourceMappingURL=rpc-base.exception.js.map

package/src/exceptions/rpc-base.exception.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/exceptions/rpc-base.exception.ts"],"sourcesContent":["import { RpcException } from '@nestjs/microservices';\nimport { HttpStatus } from '@nestjs/common';\n\n/**\n * Base Error class for RPC exceptions.\n * This exception resembles the behavior of HTTP exceptions, but for RPC errors.\n */\n// todo: use `RpcException(new BadRequestException(message))` instead of creating custom RPC exceptions\n// https://stackoverflow.com/a/75335979\nexport class RpcBaseException extends RpcException {\n  statusCode: HttpStatus;\n\n  constructor(\n    message: string,\n    statusCode: HttpStatus = HttpStatus.INTERNAL_SERVER_ERROR,\n  ) {\n    super({ message });\n    this.statusCode = statusCode;\n  }\n}\n"],"names":["RpcBaseException","RpcException","message","statusCode","HttpStatus","INTERNAL_SERVER_ERROR"],"mappings":";;;;+BASaA;;;eAAAA;;;+BATgB;wBACF;AAQpB,IAAA,AAAMA,mBAAN,MAAMA,yBAAyBC,2BAAY;IAGhD,YACEC,OAAe,EACfC,aAAyBC,kBAAU,CAACC,qBAAqB,CACzD;QACA,KAAK,CAAC;YAAEH;QAAQ;QAChB,IAAI,CAACC,UAAU,GAAGA;IACpB;AACF"}
+{"version":3,"sources":["../../../src/exceptions/rpc-base.exception.ts"],"sourcesContent":["import { RpcException } from '@nestjs/microservices';\nimport { HttpStatus } from '@nestjs/common';\n\n/**\n * Base Error class for RPC exceptions.\n * This exception resembles the behavior of HTTP exceptions, but for RPC errors.\n */\n// todo: use `RpcException(new BadRequestException(message))` instead of creating custom RPC exceptions\n// https://stackoverflow.com/a/75335979\nexport class RpcBaseException extends RpcException {\n  statusCode: HttpStatus;\n\n  constructor(\n    message: string,\n    statusCode: HttpStatus = HttpStatus.INTERNAL_SERVER_ERROR,\n  ) {\n    super({ message });\n    this.statusCode = statusCode;\n  }\n}\n"],"names":["RpcException","HttpStatus","RpcBaseException","message","statusCode","INTERNAL_SERVER_ERROR"],"mappings":"AAAA,SAASA,YAAY,QAAQ,wBAAwB;AACrD,SAASC,UAAU,QAAQ,iBAAiB;AAE5C;;;CAGC,GACD,uGAAuG;AACvG,uCAAuC;AACvC,OAAO,MAAMC,yBAAyBF;IAGpC,YACEG,OAAe,EACfC,aAAyBH,WAAWI,qBAAqB,CACzD;QACA,KAAK,CAAC;YAAEF;QAAQ;QAChB,IAAI,CAACC,UAAU,GAAGA;IACpB;AACF"}

package/src/exceptions/rpc-conflict.exception.d.ts

@@ -1,4 +1,4 @@
-import { RpcBaseException } from './rpc-base.exception';
+import { RpcBaseException } from './rpc-base.exception.js';
 export declare class RpcConflictException extends RpcBaseException {
     constructor(message?: string);
 }

package/src/exceptions/rpc-conflict.exception.js

@@ -1,19 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "RpcConflictException", {
-    enumerable: true,
-    get: function() {
-        return RpcConflictException;
-    }
-});
-const _common = require("@nestjs/common");
-const _rpcbaseexception = require("./rpc-base.exception");
-let RpcConflictException = class RpcConflictException extends _rpcbaseexception.RpcBaseException {
+import { HttpStatus } from "@nestjs/common";
+import { RpcBaseException } from "./rpc-base.exception.js";
+export class RpcConflictException extends RpcBaseException {
     constructor(message = 'Conflict'){
-        super(message, _common.HttpStatus.CONFLICT);
+        super(message, HttpStatus.CONFLICT);
     }
-};
+}
 
 //# sourceMappingURL=rpc-conflict.exception.js.map

package/src/exceptions/rpc-conflict.exception.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/exceptions/rpc-conflict.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception';\n\nexport class RpcConflictException extends RpcBaseException {\n  constructor(message = 'Conflict') {\n    super(message, HttpStatus.CONFLICT);\n  }\n}\n"],"names":["RpcConflictException","RpcBaseException","message","HttpStatus","CONFLICT"],"mappings":";;;;+BAGaA;;;eAAAA;;;wBAHc;kCACM;AAE1B,IAAA,AAAMA,uBAAN,MAAMA,6BAA6BC,kCAAgB;IACxD,YAAYC,UAAU,UAAU,CAAE;QAChC,KAAK,CAACA,SAASC,kBAAU,CAACC,QAAQ;IACpC;AACF"}
+{"version":3,"sources":["../../../src/exceptions/rpc-conflict.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception.js';\n\nexport class RpcConflictException extends RpcBaseException {\n  constructor(message = 'Conflict') {\n    super(message, HttpStatus.CONFLICT);\n  }\n}\n"],"names":["HttpStatus","RpcBaseException","RpcConflictException","message","CONFLICT"],"mappings":"AAAA,SAASA,UAAU,QAAQ,iBAAiB;AAC5C,SAASC,gBAAgB,QAAQ,0BAA0B;AAE3D,OAAO,MAAMC,6BAA6BD;IACxC,YAAYE,UAAU,UAAU,CAAE;QAChC,KAAK,CAACA,SAASH,WAAWI,QAAQ;IACpC;AACF"}

package/src/exceptions/rpc-internal-server-error.exception.d.ts

@@ -1,4 +1,4 @@
-import { RpcBaseException } from './rpc-base.exception';
+import { RpcBaseException } from './rpc-base.exception.js';
 export declare class RpcInternalServerErrorException extends RpcBaseException {
     constructor(message?: string);
 }

package/src/exceptions/rpc-internal-server-error.exception.js

@@ -1,19 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "RpcInternalServerErrorException", {
-    enumerable: true,
-    get: function() {
-        return RpcInternalServerErrorException;
-    }
-});
-const _common = require("@nestjs/common");
-const _rpcbaseexception = require("./rpc-base.exception");
-let RpcInternalServerErrorException = class RpcInternalServerErrorException extends _rpcbaseexception.RpcBaseException {
+import { HttpStatus } from "@nestjs/common";
+import { RpcBaseException } from "./rpc-base.exception.js";
+export class RpcInternalServerErrorException extends RpcBaseException {
     constructor(message = 'Internal server error'){
-        super(message, _common.HttpStatus.INTERNAL_SERVER_ERROR);
+        super(message, HttpStatus.INTERNAL_SERVER_ERROR);
     }
-};
+}
 
 //# sourceMappingURL=rpc-internal-server-error.exception.js.map

package/src/exceptions/rpc-internal-server-error.exception.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/exceptions/rpc-internal-server-error.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception';\n\nexport class RpcInternalServerErrorException extends RpcBaseException {\n  constructor(message = 'Internal server error') {\n    super(message, HttpStatus.INTERNAL_SERVER_ERROR);\n  }\n}\n"],"names":["RpcInternalServerErrorException","RpcBaseException","message","HttpStatus","INTERNAL_SERVER_ERROR"],"mappings":";;;;+BAGaA;;;eAAAA;;;wBAHc;kCACM;AAE1B,IAAA,AAAMA,kCAAN,MAAMA,wCAAwCC,kCAAgB;IACnE,YAAYC,UAAU,uBAAuB,CAAE;QAC7C,KAAK,CAACA,SAASC,kBAAU,CAACC,qBAAqB;IACjD;AACF"}
+{"version":3,"sources":["../../../src/exceptions/rpc-internal-server-error.exception.ts"],"sourcesContent":["import { HttpStatus } from '@nestjs/common';\nimport { RpcBaseException } from './rpc-base.exception.js';\n\nexport class RpcInternalServerErrorException extends RpcBaseException {\n  constructor(message = 'Internal server error') {\n    super(message, HttpStatus.INTERNAL_SERVER_ERROR);\n  }\n}\n"],"names":["HttpStatus","RpcBaseException","RpcInternalServerErrorException","message","INTERNAL_SERVER_ERROR"],"mappings":"AAAA,SAASA,UAAU,QAAQ,iBAAiB;AAC5C,SAASC,gBAAgB,QAAQ,0BAA0B;AAE3D,OAAO,MAAMC,wCAAwCD;IACnD,YAAYE,UAAU,uBAAuB,CAAE;QAC7C,KAAK,CAACA,SAASH,WAAWI,qBAAqB;IACjD;AACF"}

package/src/exceptions/rpc-method-not-allowed.exception.d.ts

@@ -1,4 +1,4 @@
-import { RpcBaseException } from './rpc-base.exception';
+import { RpcBaseException } from './rpc-base.exception.js';
 export declare class RpcMethodNotAllowedException extends RpcBaseException {
     constructor(message?: string);
 }

package/src/exceptions/rpc-method-not-allowed.exception.js

@@ -1,19 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "RpcMethodNotAllowedException", {
-    enumerable: true,
-    get: function() {
-        return RpcMethodNotAllowedException;
-    }
-});
-const _common = require("@nestjs/common");
-const _rpcbaseexception = require("./rpc-base.exception");
-let RpcMethodNotAllowedException = class RpcMethodNotAllowedException extends _rpcbaseexception.RpcBaseException {
+import { HttpStatus } from "@nestjs/common";
+import { RpcBaseException } from "./rpc-base.exception.js";
+export class RpcMethodNotAllowedException extends RpcBaseException {
     constructor(message = 'Method not allowed'){
-        super(message, _common.HttpStatus.METHOD_NOT_ALLOWED);
+        super(message, HttpStatus.METHOD_NOT_ALLOWED);
     }
-};
+}
 
 //# sourceMappingURL=rpc-method-not-allowed.exception.js.map