@ptc-org/nestjs-query-rest 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (239) hide show
  1. package/README.md +23 -0
  2. package/package.json +58 -0
  3. package/src/auth/authorizer.d.ts +27 -0
  4. package/src/auth/authorizer.js +13 -0
  5. package/src/auth/authorizer.js.map +1 -0
  6. package/src/auth/default-crud.authorizer.d.ts +6 -0
  7. package/src/auth/default-crud.authorizer.js +68 -0
  8. package/src/auth/default-crud.authorizer.js.map +1 -0
  9. package/src/auth/index.d.ts +3 -0
  10. package/src/auth/index.js +7 -0
  11. package/src/auth/index.js.map +1 -0
  12. package/src/auth/tokens.d.ts +3 -0
  13. package/src/auth/tokens.js +8 -0
  14. package/src/auth/tokens.js.map +1 -0
  15. package/src/common/dto.utils.d.ts +14 -0
  16. package/src/common/dto.utils.js +22 -0
  17. package/src/common/dto.utils.js.map +1 -0
  18. package/src/common/index.d.ts +3 -0
  19. package/src/common/index.js +7 -0
  20. package/src/common/index.js.map +1 -0
  21. package/src/common/object.utils.d.ts +1 -0
  22. package/src/common/object.utils.js +14 -0
  23. package/src/common/object.utils.js.map +1 -0
  24. package/src/common/resolver.utils.d.ts +2 -0
  25. package/src/common/resolver.utils.js +20 -0
  26. package/src/common/resolver.utils.js.map +1 -0
  27. package/src/connection/array-connection.type.d.ts +4 -0
  28. package/src/connection/array-connection.type.js +20 -0
  29. package/src/connection/array-connection.type.js.map +1 -0
  30. package/src/connection/index.d.ts +1 -0
  31. package/src/connection/index.js +3 -0
  32. package/src/connection/index.js.map +1 -0
  33. package/src/connection/interfaces.d.ts +37 -0
  34. package/src/connection/interfaces.js +3 -0
  35. package/src/connection/interfaces.js.map +1 -0
  36. package/src/connection/offset/offset-connection.type.d.ts +4 -0
  37. package/src/connection/offset/offset-connection.type.js +49 -0
  38. package/src/connection/offset/offset-connection.type.js.map +1 -0
  39. package/src/connection/offset/offset-page-info.type.d.ts +5 -0
  40. package/src/connection/offset/offset-page-info.type.js +35 -0
  41. package/src/connection/offset/offset-page-info.type.js.map +1 -0
  42. package/src/connection/offset/pager/index.d.ts +2 -0
  43. package/src/connection/offset/pager/index.js +6 -0
  44. package/src/connection/offset/pager/index.js.map +1 -0
  45. package/src/connection/offset/pager/interfaces.d.ts +12 -0
  46. package/src/connection/offset/pager/interfaces.js +3 -0
  47. package/src/connection/offset/pager/interfaces.js.map +1 -0
  48. package/src/connection/offset/pager/pager.d.ts +12 -0
  49. package/src/connection/offset/pager/pager.js +62 -0
  50. package/src/connection/offset/pager/pager.js.map +1 -0
  51. package/src/controllers/controller.interface.d.ts +43 -0
  52. package/src/controllers/controller.interface.js +15 -0
  53. package/src/controllers/controller.interface.js.map +1 -0
  54. package/src/controllers/create.controller.d.ts +46 -0
  55. package/src/controllers/create.controller.js +118 -0
  56. package/src/controllers/create.controller.js.map +1 -0
  57. package/src/controllers/crud.controller.d.ts +51 -0
  58. package/src/controllers/crud.controller.js +68 -0
  59. package/src/controllers/crud.controller.js.map +1 -0
  60. package/src/controllers/delete.controller.d.ts +18 -0
  61. package/src/controllers/delete.controller.js +60 -0
  62. package/src/controllers/delete.controller.js.map +1 -0
  63. package/src/controllers/export.controller.d.ts +22 -0
  64. package/src/controllers/export.controller.js +88 -0
  65. package/src/controllers/export.controller.js.map +1 -0
  66. package/src/controllers/index.d.ts +7 -0
  67. package/src/controllers/index.js +16 -0
  68. package/src/controllers/index.js.map +1 -0
  69. package/src/controllers/read.controller.d.ts +23 -0
  70. package/src/controllers/read.controller.js +102 -0
  71. package/src/controllers/read.controller.js.map +1 -0
  72. package/src/controllers/update.controller.d.ts +17 -0
  73. package/src/controllers/update.controller.js +86 -0
  74. package/src/controllers/update.controller.js.map +1 -0
  75. package/src/decorators/api-schema.decorator.d.ts +6 -0
  76. package/src/decorators/api-schema.decorator.js +16 -0
  77. package/src/decorators/api-schema.decorator.js.map +1 -0
  78. package/src/decorators/authorize-filter.decorator.d.ts +4 -0
  79. package/src/decorators/authorize-filter.decorator.js +78 -0
  80. package/src/decorators/authorize-filter.decorator.js.map +1 -0
  81. package/src/decorators/authorizer.decorator.d.ts +5 -0
  82. package/src/decorators/authorizer.decorator.js +24 -0
  83. package/src/decorators/authorizer.decorator.js.map +1 -0
  84. package/src/decorators/constants.d.ts +5 -0
  85. package/src/decorators/constants.js +12 -0
  86. package/src/decorators/constants.js.map +1 -0
  87. package/src/decorators/controller-methods.decorator.d.ts +21 -0
  88. package/src/decorators/controller-methods.decorator.js +75 -0
  89. package/src/decorators/controller-methods.decorator.js.map +1 -0
  90. package/src/decorators/decorator.utils.d.ts +3 -0
  91. package/src/decorators/decorator.utils.js +20 -0
  92. package/src/decorators/decorator.utils.js.map +1 -0
  93. package/src/decorators/field.decorator.d.ts +36 -0
  94. package/src/decorators/field.decorator.js +107 -0
  95. package/src/decorators/field.decorator.js.map +1 -0
  96. package/src/decorators/filterable-field.decorator.d.ts +49 -0
  97. package/src/decorators/filterable-field.decorator.js +58 -0
  98. package/src/decorators/filterable-field.decorator.js.map +1 -0
  99. package/src/decorators/hook-args.decorator.d.ts +5 -0
  100. package/src/decorators/hook-args.decorator.js +64 -0
  101. package/src/decorators/hook-args.decorator.js.map +1 -0
  102. package/src/decorators/hook.decorator.d.ts +8 -0
  103. package/src/decorators/hook.decorator.js +33 -0
  104. package/src/decorators/hook.decorator.js.map +1 -0
  105. package/src/decorators/id-field.decorator.d.ts +27 -0
  106. package/src/decorators/id-field.decorator.js +44 -0
  107. package/src/decorators/id-field.decorator.js.map +1 -0
  108. package/src/decorators/index.d.ts +14 -0
  109. package/src/decorators/index.js +18 -0
  110. package/src/decorators/index.js.map +1 -0
  111. package/src/decorators/inject-authorizer.decorator.d.ts +2 -0
  112. package/src/decorators/inject-authorizer.decorator.js +8 -0
  113. package/src/decorators/inject-authorizer.decorator.js.map +1 -0
  114. package/src/decorators/param-args.decorator.d.ts +3 -0
  115. package/src/decorators/param-args.decorator.js +21 -0
  116. package/src/decorators/param-args.decorator.js.map +1 -0
  117. package/src/decorators/query-options.decorator.d.ts +5 -0
  118. package/src/decorators/query-options.decorator.js +16 -0
  119. package/src/decorators/query-options.decorator.js.map +1 -0
  120. package/src/decorators/resolver-method.decorator.d.ts +51 -0
  121. package/src/decorators/resolver-method.decorator.js +43 -0
  122. package/src/decorators/resolver-method.decorator.js.map +1 -0
  123. package/src/decorators/resolver-query.decorator.d.ts +4 -0
  124. package/src/decorators/resolver-query.decorator.js +3 -0
  125. package/src/decorators/resolver-query.decorator.js.map +1 -0
  126. package/src/decorators/skip-if.decorator.d.ts +8 -0
  127. package/src/decorators/skip-if.decorator.js +17 -0
  128. package/src/decorators/skip-if.decorator.js.map +1 -0
  129. package/src/hooks/default.hook.d.ts +3 -0
  130. package/src/hooks/default.hook.js +13 -0
  131. package/src/hooks/default.hook.js.map +1 -0
  132. package/src/hooks/hooks.d.ts +9 -0
  133. package/src/hooks/hooks.js +9 -0
  134. package/src/hooks/hooks.js.map +1 -0
  135. package/src/hooks/index.d.ts +4 -0
  136. package/src/hooks/index.js +10 -0
  137. package/src/hooks/index.js.map +1 -0
  138. package/src/hooks/tokens.d.ts +3 -0
  139. package/src/hooks/tokens.js +6 -0
  140. package/src/hooks/tokens.js.map +1 -0
  141. package/src/hooks/types.d.ts +10 -0
  142. package/src/hooks/types.js +15 -0
  143. package/src/hooks/types.js.map +1 -0
  144. package/src/index.d.ts +8 -0
  145. package/src/index.js +15 -0
  146. package/src/index.js.map +1 -0
  147. package/src/interceptors/authorizer.interceptor.d.ts +7 -0
  148. package/src/interceptors/authorizer.interceptor.js +30 -0
  149. package/src/interceptors/authorizer.interceptor.js.map +1 -0
  150. package/src/interceptors/hook.interceptor.d.ts +7 -0
  151. package/src/interceptors/hook.interceptor.js +41 -0
  152. package/src/interceptors/hook.interceptor.js.map +1 -0
  153. package/src/interceptors/index.d.ts +2 -0
  154. package/src/interceptors/index.js +6 -0
  155. package/src/interceptors/index.js.map +1 -0
  156. package/src/interfaces/return-type-func.d.ts +3 -0
  157. package/src/interfaces/return-type-func.js +3 -0
  158. package/src/interfaces/return-type-func.js.map +1 -0
  159. package/src/module.d.ts +26 -0
  160. package/src/module.js +45 -0
  161. package/src/module.js.map +1 -0
  162. package/src/providers/authorizer.provider.d.ts +3 -0
  163. package/src/providers/authorizer.provider.js +32 -0
  164. package/src/providers/authorizer.provider.js.map +1 -0
  165. package/src/providers/controller.provider.d.ts +20 -0
  166. package/src/providers/controller.provider.js +82 -0
  167. package/src/providers/controller.provider.js.map +1 -0
  168. package/src/providers/hook.provider.d.ts +5 -0
  169. package/src/providers/hook.provider.js +40 -0
  170. package/src/providers/hook.provider.js.map +1 -0
  171. package/src/providers/index.d.ts +3 -0
  172. package/src/providers/index.js +7 -0
  173. package/src/providers/index.js.map +1 -0
  174. package/src/types/create-one-input.type.d.ts +10 -0
  175. package/src/types/create-one-input.type.js +20 -0
  176. package/src/types/create-one-input.type.js.map +1 -0
  177. package/src/types/index.d.ts +7 -0
  178. package/src/types/index.js +11 -0
  179. package/src/types/index.js.map +1 -0
  180. package/src/types/mutation-args.type.d.ts +5 -0
  181. package/src/types/mutation-args.type.js +22 -0
  182. package/src/types/mutation-args.type.js.map +1 -0
  183. package/src/types/param-args.type.d.ts +13 -0
  184. package/src/types/param-args.type.js +50 -0
  185. package/src/types/param-args.type.js.map +1 -0
  186. package/src/types/query/buildable-query.type.d.ts +4 -0
  187. package/src/types/query/buildable-query.type.js +3 -0
  188. package/src/types/query/buildable-query.type.js.map +1 -0
  189. package/src/types/query/filter.type.d.ts +7 -0
  190. package/src/types/query/filter.type.js +80 -0
  191. package/src/types/query/filter.type.js.map +1 -0
  192. package/src/types/query/index.d.ts +2 -0
  193. package/src/types/query/index.js +6 -0
  194. package/src/types/query/index.js.map +1 -0
  195. package/src/types/query/paging/constants.d.ts +4 -0
  196. package/src/types/query/paging/constants.js +10 -0
  197. package/src/types/query/paging/constants.js.map +1 -0
  198. package/src/types/query/paging/index.d.ts +3 -0
  199. package/src/types/query/paging/index.js +8 -0
  200. package/src/types/query/paging/index.js.map +1 -0
  201. package/src/types/query/paging/interfaces.d.ts +6 -0
  202. package/src/types/query/paging/interfaces.js +3 -0
  203. package/src/types/query/paging/interfaces.js.map +1 -0
  204. package/src/types/query/paging/none-paging.type.d.ts +3 -0
  205. package/src/types/query/paging/none-paging.type.js +18 -0
  206. package/src/types/query/paging/none-paging.type.js.map +1 -0
  207. package/src/types/query/query-args/constants.d.ts +6 -0
  208. package/src/types/query/query-args/constants.js +10 -0
  209. package/src/types/query/query-args/constants.js.map +1 -0
  210. package/src/types/query/query-args/export-paging-query-args.type.d.ts +4 -0
  211. package/src/types/query/query-args/export-paging-query-args.type.js +38 -0
  212. package/src/types/query/query-args/export-paging-query-args.type.js.map +1 -0
  213. package/src/types/query/query-args/index.d.ts +2 -0
  214. package/src/types/query/query-args/index.js +6 -0
  215. package/src/types/query/query-args/index.js.map +1 -0
  216. package/src/types/query/query-args/interfaces.d.ts +51 -0
  217. package/src/types/query/query-args/interfaces.js +3 -0
  218. package/src/types/query/query-args/interfaces.js.map +1 -0
  219. package/src/types/query/query-args/none-paging-query-args.type.d.ts +4 -0
  220. package/src/types/query/query-args/none-paging-query-args.type.js +42 -0
  221. package/src/types/query/query-args/none-paging-query-args.type.js.map +1 -0
  222. package/src/types/query/query-args/offset-query-args.type.d.ts +4 -0
  223. package/src/types/query/query-args/offset-query-args.type.js +70 -0
  224. package/src/types/query/query-args/offset-query-args.type.js.map +1 -0
  225. package/src/types/query-args.type.d.ts +6 -0
  226. package/src/types/query-args.type.js +28 -0
  227. package/src/types/query-args.type.js.map +1 -0
  228. package/src/types/rest-query.type.d.ts +4 -0
  229. package/src/types/rest-query.type.js +3 -0
  230. package/src/types/rest-query.type.js.map +1 -0
  231. package/src/types/update-one-input.type.d.ts +10 -0
  232. package/src/types/update-one-input.type.js +20 -0
  233. package/src/types/update-one-input.type.js.map +1 -0
  234. package/src/types/validators/index.d.ts +1 -0
  235. package/src/types/validators/index.js +5 -0
  236. package/src/types/validators/index.js.map +1 -0
  237. package/src/types/validators/is-undefined.validator.d.ts +3 -0
  238. package/src/types/validators/is-undefined.validator.js +10 -0
  239. package/src/types/validators/is-undefined.validator.js.map +1 -0
@@ -0,0 +1,107 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Field = Field;
4
+ const common_1 = require("@nestjs/common");
5
+ const swagger_1 = require("@nestjs/swagger");
6
+ const class_transformer_1 = require("class-transformer");
7
+ const class_validator_1 = require("class-validator");
8
+ const OPENAPI_METADATA_FACTORY = '_OPENAPI_METADATA_FACTORY';
9
+ function Field(returnTypeFuncOrOptions, maybeOptions) {
10
+ let returnTypeFunc;
11
+ let advancedOptions;
12
+ if (typeof returnTypeFuncOrOptions === 'function') {
13
+ returnTypeFunc = returnTypeFuncOrOptions;
14
+ advancedOptions = maybeOptions;
15
+ }
16
+ else if (typeof returnTypeFuncOrOptions === 'object') {
17
+ advancedOptions = returnTypeFuncOrOptions;
18
+ }
19
+ else if (typeof maybeOptions === 'object') {
20
+ advancedOptions = maybeOptions;
21
+ }
22
+ return (target, propertyKey, descriptor) => {
23
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
24
+ const metadataType = target?.constructor?.[OPENAPI_METADATA_FACTORY]?.()[propertyKey]?.type;
25
+ const returnedType = !returnTypeFunc
26
+ ? (metadataType?.() ?? Reflect.getMetadata('design:type', target, propertyKey))
27
+ : returnTypeFunc();
28
+ const isArray = returnedType && Array.isArray(returnedType);
29
+ const type = isArray ? returnedType[0] : returnedType;
30
+ const options = {
31
+ required: !advancedOptions?.nullable && advancedOptions?.default === undefined,
32
+ example: advancedOptions?.default,
33
+ ...advancedOptions
34
+ };
35
+ // Remove non-valid options
36
+ delete options.forceArray;
37
+ delete options.skipIsEnum;
38
+ delete options.skipRequired;
39
+ const decorators = [
40
+ (0, class_transformer_1.Expose)({ name: advancedOptions?.name }),
41
+ (0, swagger_1.ApiProperty)({
42
+ type: metadataType ?? type,
43
+ isArray: metadataType ? undefined : isArray,
44
+ ...options
45
+ })
46
+ ];
47
+ if (isArray) {
48
+ decorators.push((0, class_validator_1.IsArray)());
49
+ }
50
+ if (isArray && options.maxItems !== undefined) {
51
+ decorators.push((0, class_validator_1.ArrayMaxSize)(options.maxItems));
52
+ }
53
+ if (isArray && options.minItems !== undefined) {
54
+ decorators.push((0, class_validator_1.ArrayMinSize)(options.minItems));
55
+ }
56
+ if (isArray && advancedOptions?.forceArray) {
57
+ decorators.push((0, class_transformer_1.Transform)(({ value }) => (value == null || Array.isArray(value) ? value : [value])));
58
+ }
59
+ if (!advancedOptions?.skipRequired) {
60
+ if (options.required) {
61
+ decorators.push((0, class_validator_1.IsNotEmpty)());
62
+ }
63
+ else {
64
+ decorators.push((0, class_validator_1.IsOptional)());
65
+ }
66
+ }
67
+ if (options.minLength !== undefined) {
68
+ decorators.push((0, class_validator_1.MinLength)(options.minLength));
69
+ }
70
+ if (options.maxLength !== undefined) {
71
+ decorators.push((0, class_validator_1.MaxLength)(options.maxLength));
72
+ }
73
+ if (options.minimum !== undefined) {
74
+ decorators.push((0, class_validator_1.Min)(options.minimum));
75
+ }
76
+ if (options.maximum !== undefined) {
77
+ decorators.push((0, class_validator_1.Max)(options.maximum));
78
+ }
79
+ if (type && type !== Boolean) {
80
+ decorators.push((0, class_transformer_1.Type)(() => type));
81
+ }
82
+ if (type === String) {
83
+ decorators.push((0, class_validator_1.IsString)({ each: isArray }));
84
+ }
85
+ else if (type === Number) {
86
+ decorators.push((0, class_validator_1.IsNumber)({}, { each: isArray }));
87
+ }
88
+ else if (type === Date) {
89
+ decorators.push((0, class_validator_1.IsDate)({ each: isArray }));
90
+ }
91
+ else if (type === Boolean) {
92
+ // Boolean('false') is true, so parse HTTP query parameter values explicitly.
93
+ decorators.push((0, class_transformer_1.Transform)(({ value }) => (value === 'true' ? true : value === 'false' ? false : value)), (0, class_validator_1.IsBoolean)({ each: isArray }));
94
+ }
95
+ else if ((returnTypeFunc || metadataType) && typeof type === 'function') {
96
+ decorators.push((0, class_validator_1.ValidateNested)({ each: isArray }));
97
+ if (!isArray) {
98
+ decorators.push((0, class_validator_1.IsObject)());
99
+ }
100
+ }
101
+ if (options.enum && !advancedOptions?.skipIsEnum) {
102
+ decorators.push((0, class_validator_1.IsEnum)(options.enum, { each: isArray }));
103
+ }
104
+ return (0, common_1.applyDecorators)(...decorators)(target, propertyKey, descriptor);
105
+ };
106
+ }
107
+ //# sourceMappingURL=field.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"field.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/field.decorator.ts"],"names":[],"mappings":";;AA8DA,sBAmHC;AAjLD,2CAAgD;AAChD,6CAAiE;AACjE,yDAA2D;AAC3D,qDAiBwB;AAIxB,MAAM,wBAAwB,GAAG,2BAA2B,CAAA;AAsC5D,SAAgB,KAAK,CACnB,uBAAuD,EACvD,YAA2B;IAE3B,IAAI,cAA0C,CAAA;IAC9C,IAAI,eAAyC,CAAA;IAC7C,IAAI,OAAO,uBAAuB,KAAK,UAAU,EAAE,CAAC;QAClD,cAAc,GAAG,uBAAuB,CAAA;QACxC,eAAe,GAAG,YAAY,CAAA;IAChC,CAAC;SAAM,IAAI,OAAO,uBAAuB,KAAK,QAAQ,EAAE,CAAC;QACvD,eAAe,GAAG,uBAAuB,CAAA;IAC3C,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC5C,eAAe,GAAG,YAAY,CAAA;IAChC,CAAC;IAED,OAAO,CAAI,MAAc,EAAE,WAAmB,EAAE,UAAsC,EAAE,EAAE;QACxF,yGAAyG;QACzG,MAAM,YAAY,GAAG,MAAM,EAAE,WAAW,EAAE,CAAC,wBAAwB,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,IAAkC,CAAA;QACzH,MAAM,YAAY,GAAG,CAAC,cAAc;YAClC,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,IAAI,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YAC/E,CAAC,CAAC,cAAc,EAAE,CAAA;QAEpB,MAAM,OAAO,GAAG,YAAY,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAC3D,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAA;QAErD,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,CAAC,eAAe,EAAE,QAAQ,IAAI,eAAe,EAAE,OAAO,KAAK,SAAS;YAC9E,OAAO,EAAE,eAAe,EAAE,OAAO;YACjC,GAAG,eAAe;SACnB,CAAA;QAED,2BAA2B;QAC3B,OAAO,OAAO,CAAC,UAAU,CAAA;QACzB,OAAO,OAAO,CAAC,UAAU,CAAA;QACzB,OAAO,OAAO,CAAC,YAAY,CAAA;QAE3B,MAAM,UAAU,GAA6B;YAC3C,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;YACvC,IAAA,qBAAW,EAAC;gBACV,IAAI,EAAE,YAAY,IAAI,IAAI;gBAC1B,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;gBAC3C,GAAI,OAA8B;aACnC,CAAC;SACH,CAAA;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,CAAC,IAAI,CAAC,IAAA,yBAAO,GAAE,CAAC,CAAA;QAC5B,CAAC;QAED,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC9C,UAAU,CAAC,IAAI,CAAC,IAAA,8BAAY,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;QACjD,CAAC;QAED,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC9C,UAAU,CAAC,IAAI,CAAC,IAAA,8BAAY,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;QACjD,CAAC;QAED,IAAI,OAAO,IAAI,eAAe,EAAE,UAAU,EAAE,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAc,CAAC,CAAC,CAAA;QACnH,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,YAAY,EAAE,CAAC;YACnC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,UAAU,CAAC,IAAI,CAAC,IAAA,4BAAU,GAAE,CAAC,CAAA;YAC/B,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC,IAAA,4BAAU,GAAE,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAA,2BAAS,EAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAA,2BAAS,EAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,IAAA,qBAAG,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;QACvC,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,IAAA,qBAAG,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;QACvC,CAAC;QAED,IAAI,IAAI,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,UAAU,CAAC,IAAI,CAAC,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAa,CAAC,CAAC,CAAA;QAC5C,CAAC;QAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,UAAU,CAAC,IAAI,CAAC,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAC9C,CAAC;aAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,UAAU,CAAC,IAAI,CAAC,IAAA,0BAAQ,EAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAClD,CAAC;aAAM,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,CAAC,IAAA,wBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAC5C,CAAC;aAAM,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YAC5B,6EAA6E;YAC7E,UAAU,CAAC,IAAI,CACb,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAsB,EAAW,EAAE,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EACpH,IAAA,2BAAS,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAC7B,CAAA;QACH,CAAC;aAAM,IAAI,CAAC,cAAc,IAAI,YAAY,CAAC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YAC1E,UAAU,CAAC,IAAI,CAAC,IAAA,gCAAc,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;YAElD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,UAAU,CAAC,IAAI,CAAC,IAAA,0BAAQ,GAAE,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;YACjD,UAAU,CAAC,IAAI,CAAC,IAAA,wBAAM,EAAC,OAAO,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,IAAA,wBAAe,EAAC,GAAG,UAAU,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;IACxE,CAAC,CAAA;AACH,CAAC"}
@@ -0,0 +1,49 @@
1
+ import { Class } from '@ptc-org/nestjs-query-core';
2
+ import { ReturnTypeFunc, ReturnTypeFuncValue } from '../interfaces/return-type-func';
3
+ import { FieldOptions } from './field.decorator';
4
+ export type FilterableFieldOptions = {
5
+ allowedComparisons?: ['=', '!='];
6
+ filterRequired?: boolean;
7
+ filterOnly?: boolean;
8
+ filterDecorators?: PropertyDecorator[];
9
+ } & FieldOptions;
10
+ export interface FilterableFieldDescriptor {
11
+ propertyName: string;
12
+ schemaName: string;
13
+ target: Class<unknown>;
14
+ returnTypeFunc?: ReturnTypeFunc<ReturnTypeFuncValue>;
15
+ advancedOptions?: FilterableFieldOptions;
16
+ }
17
+ export declare function filterableFieldOptionsToField(advancedOptions?: FilterableFieldOptions): FieldOptions;
18
+ /**
19
+ * Decorator for fields that should be filterable through a [[FilterType]].
20
+ *
21
+ * @example
22
+ *
23
+ * In the following DTO `id`, `title` and `completed` are filterable.
24
+ *
25
+ * ```ts
26
+ * import { FilterableField, Field } from '@ptc-org/nestjs-query-rest'
27
+ *
28
+ * export class TodoItemDTO {
29
+ * @FilterableField()
30
+ * id!: string
31
+ *
32
+ * @FilterableField()
33
+ * title!: string
34
+ *
35
+ * @FilterableField()
36
+ * completed!: boolean
37
+ *
38
+ * @Field()
39
+ * created!: Date
40
+ *
41
+ * @Field()
42
+ * updated!: Date
43
+ * }
44
+ * ```
45
+ */
46
+ export declare function FilterableField(): PropertyDecorator & MethodDecorator;
47
+ export declare function FilterableField(options: FilterableFieldOptions): PropertyDecorator & MethodDecorator;
48
+ export declare function FilterableField(returnTypeFunction?: ReturnTypeFunc, options?: FilterableFieldOptions): PropertyDecorator & MethodDecorator;
49
+ export declare function getFilterableFields<DTO>(DTOClass: Class<DTO>): FilterableFieldDescriptor[];
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.filterableFieldOptionsToField = filterableFieldOptionsToField;
4
+ exports.FilterableField = FilterableField;
5
+ exports.getFilterableFields = getFilterableFields;
6
+ const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
7
+ const constants_1 = require("./constants");
8
+ const field_decorator_1 = require("./field.decorator");
9
+ const reflector = new nestjs_query_core_1.ArrayReflector(constants_1.FILTERABLE_FIELD_KEY);
10
+ function filterableFieldOptionsToField(advancedOptions = {}) {
11
+ // Remove fields that are not needed in the Field decorator
12
+ const { filterRequired, filterDecorators, filterOnly, ...fieldOptions } = advancedOptions;
13
+ return fieldOptions;
14
+ }
15
+ function FilterableField(returnTypeFuncOrOptions, maybeOptions) {
16
+ let returnTypeFunc;
17
+ let advancedOptions;
18
+ if (typeof returnTypeFuncOrOptions === 'function') {
19
+ returnTypeFunc = returnTypeFuncOrOptions;
20
+ advancedOptions = maybeOptions;
21
+ }
22
+ else if (typeof returnTypeFuncOrOptions === 'object') {
23
+ advancedOptions = returnTypeFuncOrOptions;
24
+ }
25
+ else if (typeof maybeOptions === 'object') {
26
+ advancedOptions = maybeOptions;
27
+ }
28
+ return (target, propertyName, descriptor) => {
29
+ const Ctx = Reflect.getMetadata('design:type', target, propertyName);
30
+ const rt = returnTypeFunc ?? (() => Ctx);
31
+ reflector.append(target.constructor, {
32
+ propertyName: propertyName.toString(),
33
+ schemaName: propertyName.toString(),
34
+ target: Ctx,
35
+ returnTypeFunc: rt,
36
+ advancedOptions
37
+ });
38
+ if (advancedOptions?.filterOnly) {
39
+ return undefined;
40
+ }
41
+ if (returnTypeFunc) {
42
+ return (0, field_decorator_1.Field)(returnTypeFunc, filterableFieldOptionsToField(advancedOptions))(target, propertyName, descriptor);
43
+ }
44
+ if (advancedOptions) {
45
+ return (0, field_decorator_1.Field)(filterableFieldOptionsToField(advancedOptions))(target, propertyName, descriptor);
46
+ }
47
+ return (0, field_decorator_1.Field)()(target, propertyName, descriptor);
48
+ };
49
+ }
50
+ function getFilterableFields(DTOClass) {
51
+ return (0, nestjs_query_core_1.getPrototypeChain)(DTOClass).reduce((fields, Cls) => {
52
+ const existingFieldNames = fields.map((t) => t.propertyName);
53
+ const typeFields = reflector.get(Cls) ?? [];
54
+ const newFields = typeFields.filter((t) => !existingFieldNames.includes(t.propertyName));
55
+ return [...newFields, ...fields];
56
+ }, []);
57
+ }
58
+ //# sourceMappingURL=filterable-field.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"filterable-field.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/filterable-field.decorator.ts"],"names":[],"mappings":";;AAsBA,sEAKC;AAoCD,0CAyCC;AAED,kDAOC;AAjHD,kEAAqF;AAGrF,2CAAkD;AAClD,uDAAuD;AAEvD,MAAM,SAAS,GAAG,IAAI,kCAAc,CAAC,gCAAoB,CAAC,CAAA;AAgB1D,SAAgB,6BAA6B,CAAC,kBAA0C,EAAE;IACxF,2DAA2D;IAC3D,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,eAAe,CAAA;IAEzF,OAAO,YAAY,CAAA;AACrB,CAAC;AAoCD,SAAgB,eAAe,CAC7B,uBAAiE,EACjE,YAAqC;IAErC,IAAI,cAA0C,CAAA;IAC9C,IAAI,eAAmD,CAAA;IACvD,IAAI,OAAO,uBAAuB,KAAK,UAAU,EAAE,CAAC;QAClD,cAAc,GAAG,uBAAuB,CAAA;QACxC,eAAe,GAAG,YAAY,CAAA;IAChC,CAAC;SAAM,IAAI,OAAO,uBAAuB,KAAK,QAAQ,EAAE,CAAC;QACvD,eAAe,GAAG,uBAAuB,CAAA;IAC3C,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC5C,eAAe,GAAG,YAAY,CAAA;IAChC,CAAC;IACD,OAAO,CACL,MAAc,EACd,YAA6B,EAC7B,UAAsC,EACH,EAAE;QACrC,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,CAAmB,CAAA;QACtF,MAAM,EAAE,GAAG,cAAc,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;QACxC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,WAA6B,EAAE;YACrD,YAAY,EAAE,YAAY,CAAC,QAAQ,EAAE;YACrC,UAAU,EAAE,YAAY,CAAC,QAAQ,EAAE;YACnC,MAAM,EAAE,GAAG;YACX,cAAc,EAAE,EAAE;YAClB,eAAe;SAChB,CAAC,CAAA;QAEF,IAAI,eAAe,EAAE,UAAU,EAAE,CAAC;YAChC,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,IAAA,uBAAK,EAAC,cAAc,EAAE,6BAA6B,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;QAChH,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,IAAA,uBAAK,EAAC,6BAA6B,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;QAChG,CAAC;QACD,OAAO,IAAA,uBAAK,GAAE,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;IAClD,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,mBAAmB,CAAM,QAAoB;IAC3D,OAAO,IAAA,qCAAiB,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACxD,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAC5D,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAqC,GAAG,CAAC,IAAI,EAAE,CAAA;QAC/E,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QACxF,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,MAAM,CAAC,CAAA;IAClC,CAAC,EAAE,EAAiC,CAAC,CAAA;AACvC,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { MutationArgsType } from '../types';
2
+ import { BuildableQueryType } from '../types/query/buildable-query.type';
3
+ export declare const ParamHookArgs: <DTO, T extends BuildableQueryType<DTO>>() => ParameterDecorator;
4
+ export declare const QueryHookArgs: <DTO, T extends BuildableQueryType<DTO>>() => ParameterDecorator;
5
+ export declare const BodyHookArgs: <T extends MutationArgsType<unknown>>() => ParameterDecorator;
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BodyHookArgs = exports.QueryHookArgs = exports.ParamHookArgs = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const common_1 = require("@nestjs/common");
6
+ const core_1 = require("@nestjs/core");
7
+ const class_transformer_1 = require("class-transformer");
8
+ class HooksTransformer {
9
+ async transform(value, metadata) {
10
+ const transformedValue = this.transformValue(value, metadata.metatype);
11
+ if (metadata.type === 'param') {
12
+ return transformedValue;
13
+ }
14
+ else if (metadata.type === 'query') {
15
+ return this.runQueryHooks(transformedValue);
16
+ }
17
+ return this.runMutationHooks(transformedValue);
18
+ }
19
+ transformValue(value, type) {
20
+ if (!type || value instanceof type) {
21
+ return value;
22
+ }
23
+ return (0, class_transformer_1.plainToInstance)(type, value, { excludeExtraneousValues: true });
24
+ }
25
+ async runMutationHooks(data) {
26
+ const hooks = this.request.hooks;
27
+ if (hooks && hooks.length > 0) {
28
+ let hookedArgs = { input: data };
29
+ for (const hook of hooks) {
30
+ hookedArgs = (await hook.run(hookedArgs, this.request));
31
+ }
32
+ return hookedArgs;
33
+ }
34
+ return { input: data };
35
+ }
36
+ async runQueryHooks(data) {
37
+ const hooks = this.request.hooks;
38
+ let hookedArgs = data.buildQuery();
39
+ if (hooks && hooks.length > 0) {
40
+ for (const hook of hooks) {
41
+ hookedArgs = (await hook.run(hookedArgs, this.request));
42
+ }
43
+ return hookedArgs;
44
+ }
45
+ return hookedArgs;
46
+ }
47
+ }
48
+ tslib_1.__decorate([
49
+ (0, common_1.Inject)(core_1.REQUEST),
50
+ tslib_1.__metadata("design:type", Request)
51
+ ], HooksTransformer.prototype, "request", void 0);
52
+ const ParamHookArgs = () => {
53
+ return (0, common_1.Param)((HooksTransformer));
54
+ };
55
+ exports.ParamHookArgs = ParamHookArgs;
56
+ const QueryHookArgs = () => {
57
+ return (0, common_1.Query)((HooksTransformer));
58
+ };
59
+ exports.QueryHookArgs = QueryHookArgs;
60
+ const BodyHookArgs = () => {
61
+ return (0, common_1.Body)((HooksTransformer));
62
+ };
63
+ exports.BodyHookArgs = BodyHookArgs;
64
+ //# sourceMappingURL=hook-args.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hook-args.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/hook-args.decorator.ts"],"names":[],"mappings":";;;;AAAA,2CAAkI;AAClI,uCAAsC;AAEtC,yDAAmD;AAOnD,MAAM,gBAAgB;IAGb,KAAK,CAAC,SAAS,CAAC,KAAQ,EAAE,QAA0B;QACzD,MAAM,gBAAgB,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAEtE,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC9B,OAAO,gBAAkD,CAAA;QAC3D,CAAC;aAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAyC,CAAC,CAAA;QACtE,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,gBAAqB,CAAC,CAAA;IACrD,CAAC;IAEO,cAAc,CAAI,KAAQ,EAAE,IAAe;QACjD,IAAI,CAAC,IAAI,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACnC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,IAAA,mCAAe,EAAa,IAAI,EAAE,KAAK,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAA;IACpF,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,IAAO;QACpC,MAAM,KAAK,GAAI,IAAI,CAAC,OAAsC,CAAC,KAAK,CAAA;QAChE,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,UAAU,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,UAAU,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAwB,CAAA;YAChF,CAAC;YAED,OAAO,UAAU,CAAA;QACnB,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;IACxB,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,IAA2B;QACrD,MAAM,KAAK,GAAI,IAAI,CAAC,OAAsC,CAAC,KAAK,CAAA;QAChE,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;QAElC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,UAAU,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAa,CAAA;YACrE,CAAC;YAED,OAAO,UAAU,CAAA;QACnB,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;CACF;AAlDqC;IAAnC,IAAA,eAAM,EAAC,cAAO,CAAC;sCAA6B,OAAO;iDAAA;AAoD/C,MAAM,aAAa,GAAG,GAA+D,EAAE;IAC5F,OAAO,IAAA,cAAS,EAAC,CAAA,gBAAmB,CAAA,CAAC,CAAA;AACvC,CAAC,CAAA;AAFY,QAAA,aAAa,iBAEzB;AAEM,MAAM,aAAa,GAAG,GAA+D,EAAE;IAC5F,OAAO,IAAA,cAAS,EAAC,CAAA,gBAAmB,CAAA,CAAC,CAAA;AACvC,CAAC,CAAA;AAFY,QAAA,aAAa,iBAEzB;AAEM,MAAM,YAAY,GAAG,GAA4D,EAAE;IACxF,OAAO,IAAA,aAAQ,EAAC,CAAA,gBAAmB,CAAA,CAAC,CAAA;AACtC,CAAC,CAAA;AAFY,QAAA,YAAY,gBAExB"}
@@ -0,0 +1,8 @@
1
+ import { Class, MetaValue } from '@ptc-org/nestjs-query-core';
2
+ import { BeforeCreateOneHook, BeforeQueryManyHook, BeforeUpdateOneHook, Hook, HookTypes } from '../hooks';
3
+ export type HookMetaValue<H extends Hook<unknown>> = MetaValue<Class<H>[]>;
4
+ export type HookDecoratorArg<H extends Hook<unknown>> = Class<H> | H['run'];
5
+ export declare const BeforeCreateOne: (...data: HookDecoratorArg<BeforeCreateOneHook<any>>[]) => (target: Function) => void;
6
+ export declare const BeforeUpdateOne: (...data: HookDecoratorArg<BeforeUpdateOneHook<any>>[]) => (target: Function) => void;
7
+ export declare const BeforeQueryMany: (...data: HookDecoratorArg<BeforeQueryManyHook<any>>[]) => (target: Function) => void;
8
+ export declare const getHooksForType: <H extends Hook<unknown>>(hookType: HookTypes, DTOClass: Class<unknown>) => HookMetaValue<H>;
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getHooksForType = exports.BeforeQueryMany = exports.BeforeUpdateOne = exports.BeforeCreateOne = void 0;
4
+ /* eslint-disable @typescript-eslint/no-explicit-any */
5
+ const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
6
+ const hooks_1 = require("../hooks");
7
+ const hookMetaDataKey = (hookType) => `nestjs-query:${hookType}`;
8
+ const hookDecorator = (hookType) => {
9
+ const key = hookMetaDataKey(hookType);
10
+ const getHook = (hook) => {
11
+ if ((0, hooks_1.isHookClass)(hook)) {
12
+ return hook;
13
+ }
14
+ return (0, hooks_1.createDefaultHook)(hook);
15
+ };
16
+ // eslint-disable-next-line @typescript-eslint/ban-types
17
+ return (...data) =>
18
+ // eslint-disable-next-line @typescript-eslint/ban-types
19
+ (target) => {
20
+ return Reflect.defineMetadata(key, data.map((d) => getHook(d)), target);
21
+ };
22
+ };
23
+ exports.BeforeCreateOne = hookDecorator(hooks_1.HookTypes.BEFORE_CREATE_ONE);
24
+ // export const BeforeCreateMany = hookDecorator<BeforeCreateManyHook<any>>(HookTypes.BEFORE_CREATE_MANY)
25
+ exports.BeforeUpdateOne = hookDecorator(hooks_1.HookTypes.BEFORE_UPDATE_ONE);
26
+ // export const BeforeUpdateMany = hookDecorator<BeforeUpdateManyHook<any, any>>(HookTypes.BEFORE_UPDATE_MANY)
27
+ // export const BeforeDeleteOne = hookDecorator<BeforeDeleteOneHook>(HookTypes.BEFORE_DELETE_ONE)
28
+ // export const BeforeDeleteMany = hookDecorator<BeforeDeleteManyHook<any>>(HookTypes.BEFORE_DELETE_MANY)
29
+ exports.BeforeQueryMany = hookDecorator(hooks_1.HookTypes.BEFORE_QUERY_MANY);
30
+ // export const BeforeFindOne = hookDecorator<BeforeFindOneHook>(HookTypes.BEFORE_FIND_ONE)
31
+ const getHooksForType = (hookType, DTOClass) => (0, nestjs_query_core_1.getClassMetadata)(DTOClass, hookMetaDataKey(hookType), true);
32
+ exports.getHooksForType = getHooksForType;
33
+ //# sourceMappingURL=hook.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hook.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/hook.decorator.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,kEAA+E;AAE/E,oCAeiB;AAMjB,MAAM,eAAe,GAAG,CAAC,QAAmB,EAAU,EAAE,CAAC,gBAAgB,QAAQ,EAAE,CAAA;AAEnF,MAAM,aAAa,GAAG,CAA0B,QAAmB,EAAE,EAAE;IACrE,MAAM,GAAG,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,OAAO,GAAG,CAAC,IAAyB,EAAE,EAAE;QAC5C,IAAI,IAAA,mBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,IAAA,yBAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC,CAAA;IAED,wDAAwD;IACxD,OAAO,CAAC,GAAG,IAA2B,EAAE,EAAE;IACxC,wDAAwD;IACxD,CAAC,MAAgB,EAAQ,EAAE;QACzB,OAAO,OAAO,CAAC,cAAc,CAC3B,GAAG,EACH,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAC3B,MAAM,CACP,CAAA;IACH,CAAC,CAAA;AACL,CAAC,CAAA;AAEY,QAAA,eAAe,GAAG,aAAa,CAA2B,iBAAS,CAAC,iBAAiB,CAAC,CAAA;AACnG,yGAAyG;AAC5F,QAAA,eAAe,GAAG,aAAa,CAA2B,iBAAS,CAAC,iBAAiB,CAAC,CAAA;AACnG,8GAA8G;AAC9G,iGAAiG;AACjG,yGAAyG;AAC5F,QAAA,eAAe,GAAG,aAAa,CAA2B,iBAAS,CAAC,iBAAiB,CAAC,CAAA;AACnG,2FAA2F;AAEpF,MAAM,eAAe,GAAG,CAA0B,QAAmB,EAAE,QAAwB,EAAoB,EAAE,CAC1H,IAAA,oCAAgB,EAAC,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAA;AADhD,QAAA,eAAe,mBACiC"}
@@ -0,0 +1,27 @@
1
+ import { Class, MetaValue } from '@ptc-org/nestjs-query-core';
2
+ import { FieldOptions } from '../index';
3
+ export type IDFieldOptions = FieldOptions & {
4
+ idOnly?: boolean;
5
+ };
6
+ export interface IDFieldDescriptor {
7
+ propertyName: string;
8
+ idOnly: boolean;
9
+ }
10
+ /**
11
+ * Decorator for Fields that should be filterable through a [[FilterType]]
12
+ *
13
+ * @example
14
+ *
15
+ * In the following DTO `id`, `title` and `completed` are filterable.
16
+ *
17
+ * ```ts
18
+ * import { IDField } from '@ptc-org/nestjs-query-rest';
19
+ *
20
+ * export class TodoItemDTO {
21
+ * @IDField()
22
+ * id!: string;
23
+ * }
24
+ * ```
25
+ */
26
+ export declare function IDField(options?: IDFieldOptions): PropertyDecorator & MethodDecorator;
27
+ export declare function getIDFields<DTO>(DTOClass: Class<DTO>): MetaValue<IDFieldDescriptor[]>;
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.IDField = IDField;
4
+ exports.getIDFields = getIDFields;
5
+ const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
6
+ const index_1 = require("../index");
7
+ const constants_1 = require("./constants");
8
+ const reflector = new nestjs_query_core_1.ArrayReflector(constants_1.ID_FIELD_KEY);
9
+ /**
10
+ * Decorator for Fields that should be filterable through a [[FilterType]]
11
+ *
12
+ * @example
13
+ *
14
+ * In the following DTO `id`, `title` and `completed` are filterable.
15
+ *
16
+ * ```ts
17
+ * import { IDField } from '@ptc-org/nestjs-query-rest';
18
+ *
19
+ * export class TodoItemDTO {
20
+ * @IDField()
21
+ * id!: string;
22
+ * }
23
+ * ```
24
+ */
25
+ function IDField(options) {
26
+ return (target, propertyName, descriptor) => {
27
+ reflector.append(target.constructor, {
28
+ propertyName: propertyName.toString(),
29
+ idOnly: options?.idOnly ?? false
30
+ });
31
+ delete options?.idOnly;
32
+ if (descriptor) {
33
+ return (0, index_1.Field)(options)(target, propertyName, descriptor);
34
+ }
35
+ return (0, index_1.Field)(options)(target, propertyName);
36
+ };
37
+ }
38
+ function getIDFields(DTOClass) {
39
+ return (0, nestjs_query_core_1.getPrototypeChain)(DTOClass).reduce((fields, Cls) => {
40
+ const typeFields = reflector.get(Cls) ?? [];
41
+ return [...typeFields, ...fields];
42
+ }, []);
43
+ }
44
+ //# sourceMappingURL=id-field.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"id-field.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/id-field.decorator.ts"],"names":[],"mappings":";;AAgCA,0BAkBC;AAED,kCAMC;AA1DD,kEAAgG;AAEhG,oCAA8C;AAC9C,2CAA0C;AAE1C,MAAM,SAAS,GAAG,IAAI,kCAAc,CAAC,wBAAY,CAAC,CAAA;AAWlD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,OAAO,CAAC,OAAwB;IAC9C,OAAO,CACL,MAAc,EACd,YAA6B,EAC7B,UAAuC,EACJ,EAAE;QACrC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,WAA6B,EAAE;YACrD,YAAY,EAAE,YAAY,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;SACjC,CAAC,CAAA;QAEF,OAAO,OAAO,EAAE,MAAM,CAAA;QAEtB,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAC7C,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,WAAW,CAAM,QAAoB;IACnD,OAAO,IAAA,qCAAiB,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACxD,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAA6B,GAAG,CAAC,IAAI,EAAE,CAAA;QAEvE,OAAO,CAAC,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC,CAAA;IACnC,CAAC,EAAE,EAAyB,CAAC,CAAA;AAC/B,CAAC"}
@@ -0,0 +1,14 @@
1
+ export * from './api-schema.decorator';
2
+ export * from './authorize-filter.decorator';
3
+ export * from './authorizer.decorator';
4
+ export * from './controller-methods.decorator';
5
+ export * from './field.decorator';
6
+ export * from './filterable-field.decorator';
7
+ export * from './hook.decorator';
8
+ export * from './hook-args.decorator';
9
+ export * from './id-field.decorator';
10
+ export * from './inject-authorizer.decorator';
11
+ export * from './query-options.decorator';
12
+ export * from './resolver-method.decorator';
13
+ export * from './resolver-query.decorator';
14
+ export * from './skip-if.decorator';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./api-schema.decorator"), exports);
5
+ tslib_1.__exportStar(require("./authorize-filter.decorator"), exports);
6
+ tslib_1.__exportStar(require("./authorizer.decorator"), exports);
7
+ tslib_1.__exportStar(require("./controller-methods.decorator"), exports);
8
+ tslib_1.__exportStar(require("./field.decorator"), exports);
9
+ tslib_1.__exportStar(require("./filterable-field.decorator"), exports);
10
+ tslib_1.__exportStar(require("./hook.decorator"), exports);
11
+ tslib_1.__exportStar(require("./hook-args.decorator"), exports);
12
+ tslib_1.__exportStar(require("./id-field.decorator"), exports);
13
+ tslib_1.__exportStar(require("./inject-authorizer.decorator"), exports);
14
+ tslib_1.__exportStar(require("./query-options.decorator"), exports);
15
+ tslib_1.__exportStar(require("./resolver-method.decorator"), exports);
16
+ tslib_1.__exportStar(require("./resolver-query.decorator"), exports);
17
+ tslib_1.__exportStar(require("./skip-if.decorator"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/index.ts"],"names":[],"mappings":";;;AAAA,iEAAsC;AACtC,uEAA4C;AAC5C,iEAAsC;AACtC,yEAA8C;AAC9C,4DAAiC;AACjC,uEAA4C;AAC5C,2DAAgC;AAChC,gEAAqC;AACrC,+DAAoC;AACpC,wEAA6C;AAC7C,oEAAyC;AACzC,sEAA2C;AAC3C,qEAA0C;AAC1C,8DAAmC"}
@@ -0,0 +1,2 @@
1
+ import { Class } from '@ptc-org/nestjs-query-core';
2
+ export declare const InjectAuthorizer: <DTO>(DTOClass: Class<DTO>) => ParameterDecorator;
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.InjectAuthorizer = void 0;
4
+ const common_1 = require("@nestjs/common");
5
+ const auth_1 = require("../auth");
6
+ const InjectAuthorizer = (DTOClass) => (0, common_1.Inject)((0, auth_1.getAuthorizerToken)(DTOClass));
7
+ exports.InjectAuthorizer = InjectAuthorizer;
8
+ //# sourceMappingURL=inject-authorizer.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-authorizer.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/inject-authorizer.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAGvC,kCAA4C;AAErC,MAAM,gBAAgB,GAAG,CAAM,QAAoB,EAAsB,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,yBAAkB,EAAC,QAAQ,CAAC,CAAC,CAAA;AAA1G,QAAA,gBAAgB,oBAA0F"}
@@ -0,0 +1,3 @@
1
+ import { Class } from '@ptc-org/nestjs-query-core';
2
+ import { ParamArgsType } from '../types';
3
+ export declare const ParamArgs: <T extends Class<ParamArgsType>>() => ParameterDecorator;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ParamArgs = void 0;
4
+ const common_1 = require("@nestjs/common");
5
+ const class_transformer_1 = require("class-transformer");
6
+ class ParamTransformer {
7
+ transform(value, metadata) {
8
+ return this.transformValue(value, metadata.metatype);
9
+ }
10
+ transformValue(value, type) {
11
+ if (!type || value instanceof type) {
12
+ return value;
13
+ }
14
+ return (0, class_transformer_1.plainToInstance)(type, value, { excludeExtraneousValues: true });
15
+ }
16
+ }
17
+ const ParamArgs = () => {
18
+ return (0, common_1.Param)((ParamTransformer));
19
+ };
20
+ exports.ParamArgs = ParamArgs;
21
+ //# sourceMappingURL=param-args.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"param-args.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/param-args.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAoF;AAEpF,yDAAmD;AAInD,MAAM,gBAAgB;IACb,SAAS,CAAC,KAAQ,EAAE,QAA0B;QACnD,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAmC,CAAA;IACxF,CAAC;IAEO,cAAc,CAAI,KAAQ,EAAE,IAAe;QACjD,IAAI,CAAC,IAAI,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACnC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,IAAA,mCAAe,EAAa,IAAI,EAAE,KAAK,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAA;IACpF,CAAC;CACF;AAEM,MAAM,SAAS,GAAG,GAAuD,EAAE;IAChF,OAAO,IAAA,cAAS,EAAC,CAAA,gBAAmB,CAAA,CAAC,CAAA;AACvC,CAAC,CAAA;AAFY,QAAA,SAAS,aAErB"}
@@ -0,0 +1,5 @@
1
+ import { Class, MetaValue } from '@ptc-org/nestjs-query-core';
2
+ import { QueryArgsTypeOpts } from '../types/query';
3
+ export type QueryOptionsDecoratorOpts<DTO> = QueryArgsTypeOpts<DTO>;
4
+ export declare function QueryOptions(opts: QueryOptionsDecoratorOpts<any>): (target: Class<unknown>) => void;
5
+ export declare const getQueryOptions: <DTO>(DTOClass: Class<DTO>) => MetaValue<QueryOptionsDecoratorOpts<DTO>>;
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getQueryOptions = void 0;
4
+ exports.QueryOptions = QueryOptions;
5
+ const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
6
+ const constants_1 = require("./constants");
7
+ const valueReflector = new nestjs_query_core_1.ValueReflector(constants_1.QUERY_OPTIONS_KEY);
8
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
9
+ function QueryOptions(opts) {
10
+ return (target) => {
11
+ valueReflector.set(target, opts);
12
+ };
13
+ }
14
+ const getQueryOptions = (DTOClass) => valueReflector.get(DTOClass);
15
+ exports.getQueryOptions = getQueryOptions;
16
+ //# sourceMappingURL=query-options.decorator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"query-options.decorator.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/decorators/query-options.decorator.ts"],"names":[],"mappings":";;;AAUA,oCAIC;AAdD,kEAA6E;AAG7E,2CAA+C;AAE/C,MAAM,cAAc,GAAG,IAAI,kCAAc,CAAC,6BAAiB,CAAC,CAAA;AAI5D,8DAA8D;AAC9D,SAAgB,YAAY,CAAC,IAAoC;IAC/D,OAAO,CAAC,MAAsB,EAAQ,EAAE;QACtC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC,CAAA;AACH,CAAC;AAEM,MAAM,eAAe,GAAG,CAAM,QAAoB,EAA6C,EAAE,CACtG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;AADjB,QAAA,eAAe,mBACE"}
@@ -0,0 +1,51 @@
1
+ import { CanActivate, ExceptionFilter, NestInterceptor, PipeTransform } from '@nestjs/common';
2
+ import { Class } from '@ptc-org/nestjs-query-core';
3
+ export interface BaseResolverOptions {
4
+ /** An array of `nestjs` guards to apply to a endpoint */
5
+ guards?: (Class<CanActivate> | CanActivate)[];
6
+ /** An array of `nestjs` interceptors to apply to a endpoint */
7
+ interceptors?: Class<NestInterceptor<any, any>>[];
8
+ /** An array of `nestjs` pipes to apply to a endpoint */
9
+ pipes?: Class<PipeTransform<any, any>>[];
10
+ /** An array of `nestjs` error filters to apply to a endpoint */
11
+ filters?: Class<ExceptionFilter<any>>[];
12
+ /** An array of additional decorators to apply to the endpoint * */
13
+ decorators?: (PropertyDecorator | MethodDecorator)[];
14
+ /**
15
+ * Tags to register for the endpoint
16
+ */
17
+ tags?: string[];
18
+ }
19
+ /**
20
+ * Options for resolver methods.
21
+ */
22
+ export interface ResolverMethodOpts extends BaseResolverOptions {
23
+ /** Set to true to disable the endpoint */
24
+ disabled?: boolean;
25
+ }
26
+ /**
27
+ * Options for relation resolver methods.
28
+ */
29
+ export interface ResolverRelationMethodOpts extends BaseResolverOptions {
30
+ /** Set to true to enable the endpoint */
31
+ enabled?: boolean;
32
+ }
33
+ /**
34
+ * @internal
35
+ * Returns true if any of the [[ResolverMethodOpts]] are disabled.
36
+ * @param opts - The array of [[ResolverMethodOpts]] to check.
37
+ */
38
+ export declare function isDisabled(opts: ResolverMethodOpts[]): boolean;
39
+ /**
40
+ * @internal
41
+ * Returns true if any of the [[ResolverRelationMethodOpts]] are disabled.
42
+ * @param opts - The array of [[ResolverRelationMethodOpts]] to check.
43
+ */
44
+ export declare function isEnabled(opts: ResolverRelationMethodOpts[]): boolean;
45
+ /**
46
+ * @internal
47
+ * Decorator for all ResolverMethods
48
+ *
49
+ * @param opts - the [[ResolverMethodOpts]] to apply.
50
+ */
51
+ export declare function ResolverMethod(...opts: ResolverMethodOpts[]): MethodDecorator;