@klerick/json-api-nestjs 10.0.0-beta.2

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 (351) hide show
  1. package/CHANGELOG.md +117 -0
  2. package/README.md +447 -0
  3. package/package.json +57 -0
  4. package/src/index.d.ts +9 -0
  5. package/src/index.js +32 -0
  6. package/src/index.js.map +1 -0
  7. package/src/lib/constants/constants.d.ts +9 -0
  8. package/src/lib/constants/constants.js +13 -0
  9. package/src/lib/constants/constants.js.map +1 -0
  10. package/src/lib/constants/default.d.ts +2 -0
  11. package/src/lib/constants/default.js +6 -0
  12. package/src/lib/constants/default.js.map +1 -0
  13. package/src/lib/constants/di.d.ts +14 -0
  14. package/src/lib/constants/di.js +18 -0
  15. package/src/lib/constants/di.js.map +1 -0
  16. package/src/lib/constants/index.d.ts +4 -0
  17. package/src/lib/constants/index.js +8 -0
  18. package/src/lib/constants/index.js.map +1 -0
  19. package/src/lib/constants/reflection.d.ts +2 -0
  20. package/src/lib/constants/reflection.js +6 -0
  21. package/src/lib/constants/reflection.js.map +1 -0
  22. package/src/lib/json-api.module.d.ts +5 -0
  23. package/src/lib/json-api.module.js +40 -0
  24. package/src/lib/json-api.module.js.map +1 -0
  25. package/src/lib/modules/atomic-operation/atomic-operation.module.d.ts +8 -0
  26. package/src/lib/modules/atomic-operation/atomic-operation.module.js +71 -0
  27. package/src/lib/modules/atomic-operation/atomic-operation.module.js.map +1 -0
  28. package/src/lib/modules/atomic-operation/constants/index.d.ts +5 -0
  29. package/src/lib/modules/atomic-operation/constants/index.js +9 -0
  30. package/src/lib/modules/atomic-operation/constants/index.js.map +1 -0
  31. package/src/lib/modules/atomic-operation/controllers/index.d.ts +1 -0
  32. package/src/lib/modules/atomic-operation/controllers/index.js +5 -0
  33. package/src/lib/modules/atomic-operation/controllers/index.js.map +1 -0
  34. package/src/lib/modules/atomic-operation/controllers/operation.controller.d.ts +13 -0
  35. package/src/lib/modules/atomic-operation/controllers/operation.controller.js +98 -0
  36. package/src/lib/modules/atomic-operation/controllers/operation.controller.js.map +1 -0
  37. package/src/lib/modules/atomic-operation/factory/async-iterator.d.ts +18 -0
  38. package/src/lib/modules/atomic-operation/factory/async-iterator.js +44 -0
  39. package/src/lib/modules/atomic-operation/factory/async-iterator.js.map +1 -0
  40. package/src/lib/modules/atomic-operation/factory/index.d.ts +4 -0
  41. package/src/lib/modules/atomic-operation/factory/index.js +8 -0
  42. package/src/lib/modules/atomic-operation/factory/index.js.map +1 -0
  43. package/src/lib/modules/atomic-operation/factory/map-controller-entity.d.ts +4 -0
  44. package/src/lib/modules/atomic-operation/factory/map-controller-entity.js +20 -0
  45. package/src/lib/modules/atomic-operation/factory/map-controller-entity.js.map +1 -0
  46. package/src/lib/modules/atomic-operation/factory/map-entity-name-to-entity.d.ts +4 -0
  47. package/src/lib/modules/atomic-operation/factory/map-entity-name-to-entity.js +13 -0
  48. package/src/lib/modules/atomic-operation/factory/map-entity-name-to-entity.js.map +1 -0
  49. package/src/lib/modules/atomic-operation/factory/zod-input-operation.d.ts +3 -0
  50. package/src/lib/modules/atomic-operation/factory/zod-input-operation.js +16 -0
  51. package/src/lib/modules/atomic-operation/factory/zod-input-operation.js.map +1 -0
  52. package/src/lib/modules/atomic-operation/pipes/input-operation.pipe.d.ts +7 -0
  53. package/src/lib/modules/atomic-operation/pipes/input-operation.pipe.js +31 -0
  54. package/src/lib/modules/atomic-operation/pipes/input-operation.pipe.js.map +1 -0
  55. package/src/lib/modules/atomic-operation/service/execute.service.d.ts +26 -0
  56. package/src/lib/modules/atomic-operation/service/execute.service.js +233 -0
  57. package/src/lib/modules/atomic-operation/service/execute.service.js.map +1 -0
  58. package/src/lib/modules/atomic-operation/service/explorer.service.d.ts +16 -0
  59. package/src/lib/modules/atomic-operation/service/explorer.service.js +94 -0
  60. package/src/lib/modules/atomic-operation/service/explorer.service.js.map +1 -0
  61. package/src/lib/modules/atomic-operation/service/index.d.ts +3 -0
  62. package/src/lib/modules/atomic-operation/service/index.js +7 -0
  63. package/src/lib/modules/atomic-operation/service/index.js.map +1 -0
  64. package/src/lib/modules/atomic-operation/service/swagger.service.d.ts +7 -0
  65. package/src/lib/modules/atomic-operation/service/swagger.service.js +99 -0
  66. package/src/lib/modules/atomic-operation/service/swagger.service.js.map +1 -0
  67. package/src/lib/modules/atomic-operation/types/index.d.ts +17 -0
  68. package/src/lib/modules/atomic-operation/types/index.js +3 -0
  69. package/src/lib/modules/atomic-operation/types/index.js.map +1 -0
  70. package/src/lib/modules/atomic-operation/utils/index.d.ts +1 -0
  71. package/src/lib/modules/atomic-operation/utils/index.js +5 -0
  72. package/src/lib/modules/atomic-operation/utils/index.js.map +1 -0
  73. package/src/lib/modules/atomic-operation/utils/zod/zod-helper.d.ts +751 -0
  74. package/src/lib/modules/atomic-operation/utils/zod/zod-helper.js +100 -0
  75. package/src/lib/modules/atomic-operation/utils/zod/zod-helper.js.map +1 -0
  76. package/src/lib/modules/index.d.ts +2 -0
  77. package/src/lib/modules/index.js +6 -0
  78. package/src/lib/modules/index.js.map +1 -0
  79. package/src/lib/modules/mixin/config/bindings.d.ts +3 -0
  80. package/src/lib/modules/mixin/config/bindings.js +176 -0
  81. package/src/lib/modules/mixin/config/bindings.js.map +1 -0
  82. package/src/lib/modules/mixin/controllers/index.d.ts +1 -0
  83. package/src/lib/modules/mixin/controllers/index.js +5 -0
  84. package/src/lib/modules/mixin/controllers/index.js.map +1 -0
  85. package/src/lib/modules/mixin/controllers/json-base.controller.d.ts +20 -0
  86. package/src/lib/modules/mixin/controllers/json-base.controller.js +36 -0
  87. package/src/lib/modules/mixin/controllers/json-base.controller.js.map +1 -0
  88. package/src/lib/modules/mixin/decorators/index.d.ts +2 -0
  89. package/src/lib/modules/mixin/decorators/index.js +6 -0
  90. package/src/lib/modules/mixin/decorators/index.js.map +1 -0
  91. package/src/lib/modules/mixin/decorators/inject-service/inject-service.decorator.d.ts +1 -0
  92. package/src/lib/modules/mixin/decorators/inject-service/inject-service.decorator.js +9 -0
  93. package/src/lib/modules/mixin/decorators/inject-service/inject-service.decorator.js.map +1 -0
  94. package/src/lib/modules/mixin/decorators/json-api/json-api.decorator.d.ts +3 -0
  95. package/src/lib/modules/mixin/decorators/json-api/json-api.decorator.js +14 -0
  96. package/src/lib/modules/mixin/decorators/json-api/json-api.decorator.js.map +1 -0
  97. package/src/lib/modules/mixin/factory/index.d.ts +1 -0
  98. package/src/lib/modules/mixin/factory/index.js +5 -0
  99. package/src/lib/modules/mixin/factory/index.js.map +1 -0
  100. package/src/lib/modules/mixin/factory/zod-validate.factory.d.ts +8 -0
  101. package/src/lib/modules/mixin/factory/zod-validate.factory.js +55 -0
  102. package/src/lib/modules/mixin/factory/zod-validate.factory.js.map +1 -0
  103. package/src/lib/modules/mixin/helpers/bind-controller.d.ts +3 -0
  104. package/src/lib/modules/mixin/helpers/bind-controller.js +81 -0
  105. package/src/lib/modules/mixin/helpers/bind-controller.js.map +1 -0
  106. package/src/lib/modules/mixin/helpers/create-controller.d.ts +2 -0
  107. package/src/lib/modules/mixin/helpers/create-controller.js +28 -0
  108. package/src/lib/modules/mixin/helpers/create-controller.js.map +1 -0
  109. package/src/lib/modules/mixin/helpers/index.d.ts +2 -0
  110. package/src/lib/modules/mixin/helpers/index.js +6 -0
  111. package/src/lib/modules/mixin/helpers/index.js.map +1 -0
  112. package/src/lib/modules/mixin/helpers/utils.d.ts +9 -0
  113. package/src/lib/modules/mixin/helpers/utils.js +30 -0
  114. package/src/lib/modules/mixin/helpers/utils.js.map +1 -0
  115. package/src/lib/modules/mixin/interceptors/error.interceptors.d.ts +9 -0
  116. package/src/lib/modules/mixin/interceptors/error.interceptors.js +34 -0
  117. package/src/lib/modules/mixin/interceptors/error.interceptors.js.map +1 -0
  118. package/src/lib/modules/mixin/interceptors/index.d.ts +2 -0
  119. package/src/lib/modules/mixin/interceptors/index.js +6 -0
  120. package/src/lib/modules/mixin/interceptors/index.js.map +1 -0
  121. package/src/lib/modules/mixin/interceptors/log-time.interceptors.d.ts +8 -0
  122. package/src/lib/modules/mixin/interceptors/log-time.interceptors.js +35 -0
  123. package/src/lib/modules/mixin/interceptors/log-time.interceptors.js.map +1 -0
  124. package/src/lib/modules/mixin/mixin.module.d.ts +5 -0
  125. package/src/lib/modules/mixin/mixin.module.js +51 -0
  126. package/src/lib/modules/mixin/mixin.module.js.map +1 -0
  127. package/src/lib/modules/mixin/pipe/check-item-entity/check-item-entity.pipe.d.ts +6 -0
  128. package/src/lib/modules/mixin/pipe/check-item-entity/check-item-entity.pipe.js +35 -0
  129. package/src/lib/modules/mixin/pipe/check-item-entity/check-item-entity.pipe.js.map +1 -0
  130. package/src/lib/modules/mixin/pipe/check-item-entity/index.d.ts +1 -0
  131. package/src/lib/modules/mixin/pipe/check-item-entity/index.js +5 -0
  132. package/src/lib/modules/mixin/pipe/check-item-entity/index.js.map +1 -0
  133. package/src/lib/modules/mixin/pipe/index.d.ts +14 -0
  134. package/src/lib/modules/mixin/pipe/index.js +67 -0
  135. package/src/lib/modules/mixin/pipe/index.js.map +1 -0
  136. package/src/lib/modules/mixin/pipe/parse-relationship-name/index.d.ts +1 -0
  137. package/src/lib/modules/mixin/pipe/parse-relationship-name/index.js +5 -0
  138. package/src/lib/modules/mixin/pipe/parse-relationship-name/index.js.map +1 -0
  139. package/src/lib/modules/mixin/pipe/parse-relationship-name/parse-relationship-name.pipe.d.ts +7 -0
  140. package/src/lib/modules/mixin/pipe/parse-relationship-name/parse-relationship-name.pipe.js +35 -0
  141. package/src/lib/modules/mixin/pipe/parse-relationship-name/parse-relationship-name.pipe.js.map +1 -0
  142. package/src/lib/modules/mixin/pipe/patch-input/index.d.ts +1 -0
  143. package/src/lib/modules/mixin/pipe/patch-input/index.js +5 -0
  144. package/src/lib/modules/mixin/pipe/patch-input/index.js.map +1 -0
  145. package/src/lib/modules/mixin/pipe/patch-input/patch-input.pipe.d.ts +7 -0
  146. package/src/lib/modules/mixin/pipe/patch-input/patch-input.pipe.js +30 -0
  147. package/src/lib/modules/mixin/pipe/patch-input/patch-input.pipe.js.map +1 -0
  148. package/src/lib/modules/mixin/pipe/patch-relationship/index.d.ts +1 -0
  149. package/src/lib/modules/mixin/pipe/patch-relationship/index.js +5 -0
  150. package/src/lib/modules/mixin/pipe/patch-relationship/index.js.map +1 -0
  151. package/src/lib/modules/mixin/pipe/patch-relationship/patch-relationship.pipe.d.ts +7 -0
  152. package/src/lib/modules/mixin/pipe/patch-relationship/patch-relationship.pipe.js +30 -0
  153. package/src/lib/modules/mixin/pipe/patch-relationship/patch-relationship.pipe.js.map +1 -0
  154. package/src/lib/modules/mixin/pipe/post-input/index.d.ts +1 -0
  155. package/src/lib/modules/mixin/pipe/post-input/index.js +5 -0
  156. package/src/lib/modules/mixin/pipe/post-input/index.js.map +1 -0
  157. package/src/lib/modules/mixin/pipe/post-input/post-input.pipe.d.ts +7 -0
  158. package/src/lib/modules/mixin/pipe/post-input/post-input.pipe.js +30 -0
  159. package/src/lib/modules/mixin/pipe/post-input/post-input.pipe.js.map +1 -0
  160. package/src/lib/modules/mixin/pipe/post-relationship/index.d.ts +1 -0
  161. package/src/lib/modules/mixin/pipe/post-relationship/index.js +5 -0
  162. package/src/lib/modules/mixin/pipe/post-relationship/index.js.map +1 -0
  163. package/src/lib/modules/mixin/pipe/post-relationship/post-relationship.pipe.d.ts +7 -0
  164. package/src/lib/modules/mixin/pipe/post-relationship/post-relationship.pipe.js +30 -0
  165. package/src/lib/modules/mixin/pipe/post-relationship/post-relationship.pipe.js.map +1 -0
  166. package/src/lib/modules/mixin/pipe/query/index.d.ts +1 -0
  167. package/src/lib/modules/mixin/pipe/query/index.js +5 -0
  168. package/src/lib/modules/mixin/pipe/query/index.js.map +1 -0
  169. package/src/lib/modules/mixin/pipe/query/query.pipe.d.ts +6 -0
  170. package/src/lib/modules/mixin/pipe/query/query.pipe.js +27 -0
  171. package/src/lib/modules/mixin/pipe/query/query.pipe.js.map +1 -0
  172. package/src/lib/modules/mixin/pipe/query-check-select-field/index.d.ts +1 -0
  173. package/src/lib/modules/mixin/pipe/query-check-select-field/index.js +5 -0
  174. package/src/lib/modules/mixin/pipe/query-check-select-field/index.js.map +1 -0
  175. package/src/lib/modules/mixin/pipe/query-check-select-field/query-check-select-field.d.ts +6 -0
  176. package/src/lib/modules/mixin/pipe/query-check-select-field/query-check-select-field.js +26 -0
  177. package/src/lib/modules/mixin/pipe/query-check-select-field/query-check-select-field.js.map +1 -0
  178. package/src/lib/modules/mixin/pipe/query-filed-on-include/index.d.ts +1 -0
  179. package/src/lib/modules/mixin/pipe/query-filed-on-include/index.js +5 -0
  180. package/src/lib/modules/mixin/pipe/query-filed-on-include/index.js.map +1 -0
  181. package/src/lib/modules/mixin/pipe/query-filed-on-include/query-filed-in-include.pipe.d.ts +5 -0
  182. package/src/lib/modules/mixin/pipe/query-filed-on-include/query-filed-in-include.pipe.js +59 -0
  183. package/src/lib/modules/mixin/pipe/query-filed-on-include/query-filed-in-include.pipe.js.map +1 -0
  184. package/src/lib/modules/mixin/pipe/query-input/index.d.ts +1 -0
  185. package/src/lib/modules/mixin/pipe/query-input/index.js +5 -0
  186. package/src/lib/modules/mixin/pipe/query-input/index.js.map +1 -0
  187. package/src/lib/modules/mixin/pipe/query-input/query-input.pipe.d.ts +7 -0
  188. package/src/lib/modules/mixin/pipe/query-input/query-input.pipe.js +30 -0
  189. package/src/lib/modules/mixin/pipe/query-input/query-input.pipe.js.map +1 -0
  190. package/src/lib/modules/mixin/service/entity-param-map.service.d.ts +9 -0
  191. package/src/lib/modules/mixin/service/entity-param-map.service.js +36 -0
  192. package/src/lib/modules/mixin/service/entity-param-map.service.js.map +1 -0
  193. package/src/lib/modules/mixin/service/error-format.service.d.ts +6 -0
  194. package/src/lib/modules/mixin/service/error-format.service.js +43 -0
  195. package/src/lib/modules/mixin/service/error-format.service.js.map +1 -0
  196. package/src/lib/modules/mixin/service/index.d.ts +3 -0
  197. package/src/lib/modules/mixin/service/index.js +7 -0
  198. package/src/lib/modules/mixin/service/index.js.map +1 -0
  199. package/src/lib/modules/mixin/service/json-api-transformer.service.d.ts +18 -0
  200. package/src/lib/modules/mixin/service/json-api-transformer.service.js +228 -0
  201. package/src/lib/modules/mixin/service/json-api-transformer.service.js.map +1 -0
  202. package/src/lib/modules/mixin/swagger/filter-operand-model.d.ts +26 -0
  203. package/src/lib/modules/mixin/swagger/filter-operand-model.js +113 -0
  204. package/src/lib/modules/mixin/swagger/filter-operand-model.js.map +1 -0
  205. package/src/lib/modules/mixin/swagger/index.d.ts +1 -0
  206. package/src/lib/modules/mixin/swagger/index.js +5 -0
  207. package/src/lib/modules/mixin/swagger/index.js.map +1 -0
  208. package/src/lib/modules/mixin/swagger/method/delete-one.d.ts +4 -0
  209. package/src/lib/modules/mixin/swagger/method/delete-one.js +35 -0
  210. package/src/lib/modules/mixin/swagger/method/delete-one.js.map +1 -0
  211. package/src/lib/modules/mixin/swagger/method/delete-relationship.d.ts +4 -0
  212. package/src/lib/modules/mixin/swagger/method/delete-relationship.js +54 -0
  213. package/src/lib/modules/mixin/swagger/method/delete-relationship.js.map +1 -0
  214. package/src/lib/modules/mixin/swagger/method/get-all.d.ts +4 -0
  215. package/src/lib/modules/mixin/swagger/method/get-all.js +241 -0
  216. package/src/lib/modules/mixin/swagger/method/get-all.js.map +1 -0
  217. package/src/lib/modules/mixin/swagger/method/get-one.d.ts +4 -0
  218. package/src/lib/modules/mixin/swagger/method/get-one.js +93 -0
  219. package/src/lib/modules/mixin/swagger/method/get-one.js.map +1 -0
  220. package/src/lib/modules/mixin/swagger/method/get-relationship.d.ts +4 -0
  221. package/src/lib/modules/mixin/swagger/method/get-relationship.js +48 -0
  222. package/src/lib/modules/mixin/swagger/method/get-relationship.js.map +1 -0
  223. package/src/lib/modules/mixin/swagger/method/index.d.ts +24 -0
  224. package/src/lib/modules/mixin/swagger/method/index.js +24 -0
  225. package/src/lib/modules/mixin/swagger/method/index.js.map +1 -0
  226. package/src/lib/modules/mixin/swagger/method/patch-one.d.ts +4 -0
  227. package/src/lib/modules/mixin/swagger/method/patch-one.js +43 -0
  228. package/src/lib/modules/mixin/swagger/method/patch-one.js.map +1 -0
  229. package/src/lib/modules/mixin/swagger/method/patch-relationship.d.ts +4 -0
  230. package/src/lib/modules/mixin/swagger/method/patch-relationship.js +55 -0
  231. package/src/lib/modules/mixin/swagger/method/patch-relationship.js.map +1 -0
  232. package/src/lib/modules/mixin/swagger/method/post-one.d.ts +4 -0
  233. package/src/lib/modules/mixin/swagger/method/post-one.js +35 -0
  234. package/src/lib/modules/mixin/swagger/method/post-one.js.map +1 -0
  235. package/src/lib/modules/mixin/swagger/method/post-relationship.d.ts +4 -0
  236. package/src/lib/modules/mixin/swagger/method/post-relationship.js +55 -0
  237. package/src/lib/modules/mixin/swagger/method/post-relationship.js.map +1 -0
  238. package/src/lib/modules/mixin/swagger/swagger-bind.service.d.ts +9 -0
  239. package/src/lib/modules/mixin/swagger/swagger-bind.service.js +81 -0
  240. package/src/lib/modules/mixin/swagger/swagger-bind.service.js.map +1 -0
  241. package/src/lib/modules/mixin/swagger/utils.d.ts +196 -0
  242. package/src/lib/modules/mixin/swagger/utils.js +305 -0
  243. package/src/lib/modules/mixin/swagger/utils.js.map +1 -0
  244. package/src/lib/modules/mixin/types/binding.type.d.ts +34 -0
  245. package/src/lib/modules/mixin/types/binding.type.js +3 -0
  246. package/src/lib/modules/mixin/types/binding.type.js.map +1 -0
  247. package/src/lib/modules/mixin/types/decorator-options.type.d.ts +9 -0
  248. package/src/lib/modules/mixin/types/decorator-options.type.js +3 -0
  249. package/src/lib/modules/mixin/types/decorator-options.type.js.map +1 -0
  250. package/src/lib/modules/mixin/types/index.d.ts +7 -0
  251. package/src/lib/modules/mixin/types/index.js +8 -0
  252. package/src/lib/modules/mixin/types/index.js.map +1 -0
  253. package/src/lib/modules/mixin/types/module.type.d.ts +6 -0
  254. package/src/lib/modules/mixin/types/module.type.js +3 -0
  255. package/src/lib/modules/mixin/types/module.type.js.map +1 -0
  256. package/src/lib/modules/mixin/types/orm-service.type.d.ts +13 -0
  257. package/src/lib/modules/mixin/types/orm-service.type.js +3 -0
  258. package/src/lib/modules/mixin/types/orm-service.type.js.map +1 -0
  259. package/src/lib/modules/mixin/zod/index.d.ts +7 -0
  260. package/src/lib/modules/mixin/zod/index.js +10 -0
  261. package/src/lib/modules/mixin/zod/index.js.map +1 -0
  262. package/src/lib/modules/mixin/zod/zod-input-patch-relationship-schema/index.d.ts +53 -0
  263. package/src/lib/modules/mixin/zod/zod-input-patch-relationship-schema/index.js +11 -0
  264. package/src/lib/modules/mixin/zod/zod-input-patch-relationship-schema/index.js.map +1 -0
  265. package/src/lib/modules/mixin/zod/zod-input-patch-schema/index.d.ts +17 -0
  266. package/src/lib/modules/mixin/zod/zod-input-patch-schema/index.js +23 -0
  267. package/src/lib/modules/mixin/zod/zod-input-patch-schema/index.js.map +1 -0
  268. package/src/lib/modules/mixin/zod/zod-input-post-relationship-schema/index.d.ts +59 -0
  269. package/src/lib/modules/mixin/zod/zod-input-post-relationship-schema/index.js +11 -0
  270. package/src/lib/modules/mixin/zod/zod-input-post-relationship-schema/index.js.map +1 -0
  271. package/src/lib/modules/mixin/zod/zod-input-post-schema/index.d.ts +18 -0
  272. package/src/lib/modules/mixin/zod/zod-input-post-schema/index.js +26 -0
  273. package/src/lib/modules/mixin/zod/zod-input-post-schema/index.js.map +1 -0
  274. package/src/lib/modules/mixin/zod/zod-input-query-schema/fields.d.ts +30 -0
  275. package/src/lib/modules/mixin/zod/zod-input-query-schema/fields.js +45 -0
  276. package/src/lib/modules/mixin/zod/zod-input-query-schema/fields.js.map +1 -0
  277. package/src/lib/modules/mixin/zod/zod-input-query-schema/filter.d.ts +1005 -0
  278. package/src/lib/modules/mixin/zod/zod-input-query-schema/filter.js +118 -0
  279. package/src/lib/modules/mixin/zod/zod-input-query-schema/filter.js.map +1 -0
  280. package/src/lib/modules/mixin/zod/zod-input-query-schema/include.d.ts +3 -0
  281. package/src/lib/modules/mixin/zod/zod-input-query-schema/include.js +19 -0
  282. package/src/lib/modules/mixin/zod/zod-input-query-schema/include.js.map +1 -0
  283. package/src/lib/modules/mixin/zod/zod-input-query-schema/index.d.ts +4965 -0
  284. package/src/lib/modules/mixin/zod/zod-input-query-schema/index.js +22 -0
  285. package/src/lib/modules/mixin/zod/zod-input-query-schema/index.js.map +1 -0
  286. package/src/lib/modules/mixin/zod/zod-input-query-schema/sort.d.ts +3 -0
  287. package/src/lib/modules/mixin/zod/zod-input-query-schema/sort.js +34 -0
  288. package/src/lib/modules/mixin/zod/zod-input-query-schema/sort.js.map +1 -0
  289. package/src/lib/modules/mixin/zod/zod-query-schema/fields.d.ts +15 -0
  290. package/src/lib/modules/mixin/zod/zod-query-schema/fields.js +35 -0
  291. package/src/lib/modules/mixin/zod/zod-query-schema/fields.js.map +1 -0
  292. package/src/lib/modules/mixin/zod/zod-query-schema/filter.d.ts +127 -0
  293. package/src/lib/modules/mixin/zod/zod-query-schema/filter.js +110 -0
  294. package/src/lib/modules/mixin/zod/zod-query-schema/filter.js.map +1 -0
  295. package/src/lib/modules/mixin/zod/zod-query-schema/include.d.ts +6 -0
  296. package/src/lib/modules/mixin/zod/zod-query-schema/include.js +17 -0
  297. package/src/lib/modules/mixin/zod/zod-query-schema/include.js.map +1 -0
  298. package/src/lib/modules/mixin/zod/zod-query-schema/index.d.ts +22 -0
  299. package/src/lib/modules/mixin/zod/zod-query-schema/index.js +34 -0
  300. package/src/lib/modules/mixin/zod/zod-query-schema/index.js.map +1 -0
  301. package/src/lib/modules/mixin/zod/zod-query-schema/sort.d.ts +19 -0
  302. package/src/lib/modules/mixin/zod/zod-query-schema/sort.js +35 -0
  303. package/src/lib/modules/mixin/zod/zod-query-schema/sort.js.map +1 -0
  304. package/src/lib/modules/mixin/zod/zod-share/attributes.d.ts +31 -0
  305. package/src/lib/modules/mixin/zod/zod-share/attributes.js +85 -0
  306. package/src/lib/modules/mixin/zod/zod-share/attributes.js.map +1 -0
  307. package/src/lib/modules/mixin/zod/zod-share/id.d.ts +5 -0
  308. package/src/lib/modules/mixin/zod/zod-share/id.js +14 -0
  309. package/src/lib/modules/mixin/zod/zod-share/id.js.map +1 -0
  310. package/src/lib/modules/mixin/zod/zod-share/index.d.ts +6 -0
  311. package/src/lib/modules/mixin/zod/zod-share/index.js +10 -0
  312. package/src/lib/modules/mixin/zod/zod-share/index.js.map +1 -0
  313. package/src/lib/modules/mixin/zod/zod-share/page.d.ts +12 -0
  314. package/src/lib/modules/mixin/zod/zod-share/page.js +22 -0
  315. package/src/lib/modules/mixin/zod/zod-share/page.js.map +1 -0
  316. package/src/lib/modules/mixin/zod/zod-share/rel-data.d.ts +50 -0
  317. package/src/lib/modules/mixin/zod/zod-share/rel-data.js +26 -0
  318. package/src/lib/modules/mixin/zod/zod-share/rel-data.js.map +1 -0
  319. package/src/lib/modules/mixin/zod/zod-share/relationships.d.ts +325 -0
  320. package/src/lib/modules/mixin/zod/zod-share/relationships.js +34 -0
  321. package/src/lib/modules/mixin/zod/zod-share/relationships.js.map +1 -0
  322. package/src/lib/modules/mixin/zod/zod-share/type.d.ts +8 -0
  323. package/src/lib/modules/mixin/zod/zod-share/type.js +8 -0
  324. package/src/lib/modules/mixin/zod/zod-share/type.js.map +1 -0
  325. package/src/lib/modules/mixin/zod/zod-utils.d.ts +15 -0
  326. package/src/lib/modules/mixin/zod/zod-utils.js +72 -0
  327. package/src/lib/modules/mixin/zod/zod-utils.js.map +1 -0
  328. package/src/lib/types/common-type.d.ts +5 -0
  329. package/src/lib/types/common-type.js +3 -0
  330. package/src/lib/types/common-type.js.map +1 -0
  331. package/src/lib/types/entity-param.type.d.ts +49 -0
  332. package/src/lib/types/entity-param.type.js +14 -0
  333. package/src/lib/types/entity-param.type.js.map +1 -0
  334. package/src/lib/types/error.types.d.ts +10 -0
  335. package/src/lib/types/error.types.js +3 -0
  336. package/src/lib/types/error.types.js.map +1 -0
  337. package/src/lib/types/index.d.ts +5 -0
  338. package/src/lib/types/index.js +9 -0
  339. package/src/lib/types/index.js.map +1 -0
  340. package/src/lib/types/module-options.types.d.ts +47 -0
  341. package/src/lib/types/module-options.types.js +3 -0
  342. package/src/lib/types/module-options.types.js.map +1 -0
  343. package/src/lib/types/utils-type.d.ts +12 -0
  344. package/src/lib/types/utils-type.js +3 -0
  345. package/src/lib/types/utils-type.js.map +1 -0
  346. package/src/lib/utils/index.d.ts +1 -0
  347. package/src/lib/utils/index.js +5 -0
  348. package/src/lib/utils/index.js.map +1 -0
  349. package/src/lib/utils/module-helper.d.ts +4 -0
  350. package/src/lib/utils/module-helper.js +27 -0
  351. package/src/lib/utils/module-helper.js.map +1 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,117 @@
1
+ ## 10.0.0-beta.0 (2025-05-21)
2
+
3
+ ### 🚀 Features
4
+
5
+ - ⚠️ **json-api-nestjs:** remove module and refactoring ([f202ebc](https://github.com/klerick/nestjs-json-api/commit/f202ebc))
6
+
7
+ ### 🩹 Fixes
8
+
9
+ - **json-api-nestjs:** Some fix for swagger ([9a0f190](https://github.com/klerick/nestjs-json-api/commit/9a0f190))
10
+ - **json-api-nestjs:** Use correct options for check is debug or not ([e52cc92](https://github.com/klerick/nestjs-json-api/commit/e52cc92))
11
+ - **json-api-nestjs:** fix type in some place ([61f45e6](https://github.com/klerick/nestjs-json-api/commit/61f45e6))
12
+
13
+ ### ⚠️ Breaking Changes
14
+
15
+ - **json-api-nestjs:** Change type signature, rename npm package
16
+
17
+ ### ❤️ Thank You
18
+
19
+ - Alex H
20
+
21
+ # 9.0.0 (2025-02-12)
22
+
23
+ ### 🚀 Features
24
+
25
+ - **json-api-nestjs:** Microro orm ([4696f51](https://github.com/klerick/nestjs-json-api/commit/4696f51))
26
+ - **json-api-nestjs:** Microro orm ([18f4a0c](https://github.com/klerick/nestjs-json-api/commit/18f4a0c))
27
+
28
+ ### 🩹 Fixes
29
+
30
+ - **json-api-nestjs:** Fix circular type for query obkect ([e492cd1](https://github.com/klerick/nestjs-json-api/commit/e492cd1))
31
+
32
+ ### ❤️ Thank You
33
+
34
+ - Alex H
35
+
36
+ # 8.0.0 (2024-12-18)
37
+
38
+ ### 🚀 Features
39
+
40
+ - **json-api-nestjs:** Return meta info in atomic operation ([1b61fb3](https://github.com/klerick/nestjs-json-api/commit/1b61fb3))
41
+ - **json-api-nestjs:** Allow set id from request for postOne ([6202c22](https://github.com/klerick/nestjs-json-api/commit/6202c22))
42
+ - **json-api-nestjs:** Extend validate for array, json and datetime, use nullable if possible ([a8c6f83](https://github.com/klerick/nestjs-json-api/commit/a8c6f83))
43
+ - **json-api-nestjs:** Allow call interceptor for each operation in atomic endpoint ([9e0f066](https://github.com/klerick/nestjs-json-api/commit/9e0f066))
44
+ - **json-api-nestjs:** Add wrapper transaction options ([8e498a8](https://github.com/klerick/nestjs-json-api/commit/8e498a8))
45
+ - **nestjs-json-rpc:** Add support soft delete ([c3b9322](https://github.com/klerick/nestjs-json-api/commit/c3b9322))
46
+
47
+ ### ❤️ Thank You
48
+
49
+ - Alex H
50
+
51
+ ## 7.0.4 (2024-10-27)
52
+
53
+
54
+ ### 🩹 Fixes
55
+
56
+ - **json-api-nestjs:** Add filter by null ([3af99ff](https://github.com/klerick/nestjs-json-api/commit/3af99ff))
57
+
58
+
59
+ ### ❤️ Thank You
60
+
61
+ - Alex H
62
+
63
+ ## 7.0.3 (2024-05-15)
64
+
65
+
66
+ ### 🩹 Fixes
67
+
68
+ - **json-api-nestjs:** Resource Relationship not allowing data key. ([f648422](https://github.com/klerick/nestjs-json-api/commit/f648422))
69
+
70
+
71
+ ### ❤️ Thank You
72
+
73
+ - Alex H
74
+
75
+ ## 7.0.2 (2024-04-21)
76
+
77
+
78
+ ### 🩹 Fixes
79
+
80
+ - **json-api-nestjs:** Fix validation ([e5e9936](https://github.com/klerick/nestjs-json-api/commit/e5e9936))
81
+
82
+ - **json-api-nestjs:** Fix validate for patch method ([40b0303](https://github.com/klerick/nestjs-json-api/commit/40b0303))
83
+
84
+ - **json-api-nestjs:** Fix validate for patch method ([2caa2d8](https://github.com/klerick/nestjs-json-api/commit/2caa2d8))
85
+
86
+
87
+ ### ❤️ Thank You
88
+
89
+ - Alex H
90
+
91
+ ## 7.0.1 (2024-04-06)
92
+
93
+
94
+ ### 🩹 Fixes
95
+
96
+ - **json-api-nestjs:** Fix validation ([1d048a8](https://github.com/klerick/nestjs-json-api/commit/1d048a8))
97
+
98
+
99
+ ### ❤️ Thank You
100
+
101
+ - Alex H
102
+
103
+ # 7.0.0 (2024-03-08)
104
+
105
+
106
+ ### 🚀 Features
107
+
108
+ - ⚠️ **json-api-nestjs:** new version json-api ([66076a3](https://github.com/klerick/nestjs-json-api/commit/66076a3))
109
+
110
+
111
+ #### ⚠️ Breaking Changes
112
+
113
+ - **json-api-nestjs:** - remove ajv and use zod for validation
114
+
115
+ ### ❤️ Thank You
116
+
117
+ - Alex H
package/README.md ADDED
@@ -0,0 +1,447 @@
1
+ <p align='center'>
2
+ <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/v/json-api-nestjs.svg" alt="NPM Version" /></a>
3
+ <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/l/json-api-nestjs.svg" alt="Package License" /></a>
4
+ <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/dm/json-api-nestjs.svg" alt="NPM Downloads" /></a>
5
+ <a href="http://commitizen.github.io/cz-cli/" target="_blank"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" /></a>
6
+ <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/klerick/02a4c98cf7008fea2af70dc2d50f4cb7/raw/json-api-nestjs.json" alt="Coverage Badge" />
7
+ </p>
8
+
9
+ # json-api-nestjs
10
+
11
+ This plugin works upon **TypeOrm** or **MicroOrm** library, which is used as the main database abstraction layer tool. The module
12
+ automatically generates an API according to JSON API specification from the database structure (**TypeOrm** or **MicroOrm** entities). It
13
+ supports features such as requests validation based on database fields types, request filtering, endpoints extending,
14
+ data relations control and much more. Our module significantly reduces the development time of REST services by removing
15
+ the need to negotiate the mechanism of client-server interaction and implementing automatic API generation without the
16
+ need to write any code.
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ $ npm install @klerick/json-api-nestjs
22
+ ```
23
+
24
+ ## Example
25
+
26
+ Once the installation process is complete, we can import the **JsonApiModule** into the root **AppModule**.
27
+ ### TypeOrm
28
+ ```typescript
29
+ import {Module} from '@nestjs/common';
30
+ import {JsonApiModule} from '@klerick/json-api-nestjs';
31
+ import {TypeOrmJsonApiModule} from '@klerick/json-api-nestjs-typeorm';
32
+ import {Users} from 'type-orm/database';
33
+
34
+ @Module({
35
+ imports: [
36
+ JsonApiModule.forRoot(TypeOrmJsonApiModule, {
37
+ entities: [Users]
38
+ }),
39
+ ],
40
+ })
41
+ export class AppModule {
42
+ }
43
+ ```
44
+
45
+ ### MicroOrm
46
+ ```typescript
47
+ import {Module} from '@nestjs/common';
48
+ import {JsonApiModule} from '@klerick/json-api-nestjs';
49
+ import {MicroOrmJsonApiModule} from '@klerick/json-api-nestjs-microorm';
50
+ import {Users} from 'micro-orm/database';
51
+
52
+ @Module({
53
+ imports: [
54
+ JsonApiModule.forRoot(MicroOrmJsonApiModule, {
55
+ entities: [Users]
56
+ }),
57
+ ],
58
+ })
59
+ export class AppModule {
60
+ }
61
+ ```
62
+
63
+ After this, you have to prepare CRUDs with ready-to-use endpoints:
64
+
65
+ - GET /users
66
+ - POST /users
67
+ - GET /users/:id
68
+ - PATCH /users/:id
69
+ - DELETE /users/:id
70
+ - GET /users/{id}/relationships/{relName}
71
+ - POST /users/{id}/relationships/{relName}
72
+ - PATCH /users/{id}/relationships/{relName}
73
+ - DELETE /users/{id}/relationships/{relName}
74
+
75
+ ## Configuration params
76
+
77
+ The following interface is using for the configuration:
78
+
79
+ ```typescript
80
+ export interface ModuleOptions {
81
+ entities: Entity[]; // List of typeOrm Entity
82
+ controllers?: NestController[]; // List of controller, if you need extend default present
83
+ connectionName?: string; // Type orm connection name: "default" is default name
84
+ providers?: NestProvider[]; // List of addition provider for useing in custom controller
85
+ imports?: NestImport[]; // List of addition module for useing in custom controller
86
+ options?: {
87
+ requiredSelectField?: boolean; // Need list of select field in get endpoint, try is default
88
+ debug?: boolean; // Debug info in result object, like error message
89
+ pipeForId?: Type<PipeTransform> // Nestjs pipe for validate id params, by default ParseIntPipe
90
+ operationUrl?: string // Url for atomic operation https://jsonapi.org/ext/atomic/
91
+ // You can add params for MicroOrm or TypeOrm adapter
92
+ } ;
93
+ }
94
+ ```
95
+
96
+ You can extend the default controller:
97
+
98
+ ```typescript
99
+ import {Get, Param, Inject, BadRequestException} from '@nestjs/common';
100
+
101
+ import {Users} from 'database';
102
+ import {
103
+ JsonApi,
104
+ excludeMethod,
105
+ JsonBaseController,
106
+ InjectService,
107
+ JsonApiService,
108
+ Query,
109
+ } from '@klerick/json-api-nestjs';
110
+ import {
111
+ ResourceObjectRelationships,
112
+ } from '@klerick/json-api-nestjs-shared';
113
+ import {ExampleService} from '../../service/example/example.service';
114
+
115
+ @JsonApi(Users, {
116
+ allowMethod: excludeMethod(['deleteRelationship']),
117
+ requiredSelectField: true,
118
+ overrideRoute: 'user',
119
+ })
120
+ export class ExtendUserController extends JsonBaseController<Users, 'id'> {
121
+ @InjectService() public service: JsonApiService<Users>;
122
+ @Inject(ExampleService) protected exampleService: ExampleService;
123
+
124
+ public override getAll(query: Query<Users, 'id'>): Promise<ResourceObject<Users, 'array'>> {
125
+ if (!this.exampleService.someCheck(query)) {
126
+ throw new BadRequestException({});
127
+ }
128
+ return this.service.getAll(query);// OR call parent method: super.getAll(query);
129
+ }
130
+
131
+ public override patchRelationship<Rel extends EntityRelation<Users>>(
132
+ id: string | number,
133
+ relName: Rel,
134
+ input: PatchRelationshipData
135
+ ): Promise<ResourceObjectRelationships<Users, 'id', Rel>> {
136
+ return super.patchRelationship(id, relName, input);
137
+ }
138
+
139
+ @Get(':id/example')
140
+ testOne(@Param('id') id: string): string {
141
+ return this.exampleService.testMethode(id);
142
+ }
143
+ }
144
+ ```
145
+
146
+ You can overwrite the default config for the current controller using options in the decorator **JsonAPi**.
147
+ Also you can specify an API method necessary for you, using **allowMethod**
148
+ Defulat validation check only simple type and database structure.
149
+ If you need custom pipe validation you can your owner pipe like this:
150
+
151
+ ```typescript
152
+
153
+ import { Query } from '@nestjs/common';
154
+ import {
155
+ JsonApi,
156
+ excludeMethod,
157
+ JsonBaseController,
158
+ InjectService,
159
+ JsonApiService,
160
+ Query as QueryType,
161
+ } from 'json-api-nestjs';
162
+
163
+ @JsonApi(Users, {
164
+ allowMethod: excludeMethod(['deleteRelationship']),
165
+ requiredSelectField: true,
166
+ overrideRoute: 'user',
167
+ })
168
+ export class ExtendUserController extends JsonBaseController<Users, 'id'> {
169
+ @InjectService() public service: JsonApiService<Users>;
170
+ @Inject(ExampleService) protected exampleService: ExampleService;
171
+
172
+ public override getAll(
173
+ @Query(ExamplePipe) query: QueryType<Users, 'id'>
174
+ ): Promise<ResourceObject<Users, 'array'>> {
175
+ return super.getAll(query);
176
+ }
177
+ }
178
+ ```
179
+
180
+ ```typescript
181
+ import { ArgumentMetadata, PipeTransform } from '@nestjs/common';
182
+
183
+ import { Query } from 'json-api-nestjs';
184
+ import { Users } from 'database';
185
+
186
+ export class ExamplePipe implements PipeTransform<Query<Users, 'id'>, Query<Users, 'id'>> {
187
+ transform(value: Query<Users, 'id'>, metadata: ArgumentMetadata): Query<Users, 'id'> {
188
+ return value;
189
+ }
190
+ }
191
+ ```
192
+
193
+ ## Swagger UI
194
+
195
+ For using swagger, you should only add [@nestjs/swagger](https://docs.nestjs.com/openapi/introduction) and configure it
196
+ ```typescript
197
+ const app = await NestFactory.create(AppModule);
198
+
199
+ const config = new DocumentBuilder()
200
+ .setOpenAPIVersion('3.1.0')
201
+ .setTitle('JSON API swagger example')
202
+ .setDescription('The JSON API list example')
203
+ .setVersion('1.0')
204
+ .build();
205
+
206
+ SwaggerModule.setup(
207
+ 'swagger',
208
+ app,
209
+ () => SwaggerModule.createDocument(app, config), // !!!Important: document as factory
210
+ {}
211
+ );
212
+
213
+ ```
214
+
215
+ ## Available endpoint method
216
+
217
+ Using **Users** entity and relation **Roles** entity as example
218
+
219
+ ### List item of Users
220
+
221
+ ```
222
+ GET /users
223
+ ```
224
+
225
+ Available query params:
226
+
227
+ - **include** - you can extend result with relations (aka join)
228
+ ```
229
+ GET /users?include=roles
230
+ ```
231
+ result of request will have role relation for each **Users** item
232
+
233
+ - **fields** - you can specify required fields of result query
234
+
235
+ ```
236
+ GET /users?fields[target]=login,lastName&fileds[roles]=name,key
237
+ ```
238
+ The "target" is **Users** entity
239
+ The "roles" is **Roles** entity
240
+ So, result of request will be have only fields *login* and *lastName* for **Users** entity and fields *name* and *
241
+ key* for **Roles** entity
242
+ - **sort** - you can sort result of the request
243
+
244
+ ```
245
+ GET /users?sort=target.name,-roles.key
246
+ ```
247
+ The "target" is **Users** entity
248
+ The "roles" is **Roles** entity
249
+ So, result of the request will be sorted by field *name* of **Users** by *ASC* and field *key* of **Roles** entity
250
+ by **DESC**.
251
+ - **page** - pagination for you request
252
+
253
+ ```
254
+ GET /users?page[number]=1page[size]=20
255
+ ```
256
+ - **filter** - filter for query
257
+
258
+ ```
259
+ GET /users?filter[name][eq]=1&filter[roles.name][ne]=test&filter[roles.status][eq]=true
260
+ ```
261
+ The "name" is a field of **Users** entity
262
+ The "roles.name" is *name* field of **Roles** entity
263
+ The "eq", "ne" is *[Filter operand](#filter-operand)*
264
+
265
+ So, this query will be transformed like sql:
266
+ ```sql
267
+ WHERE users.name = 1 AND roles.name <> 'test' AND roles.status = true
268
+ ```
269
+
270
+ ## Filter operand
271
+
272
+ ```typescript
273
+ type FilterOperand
274
+ {
275
+ in:string[] // is equal to the conditional of query "WHERE 'attribute_name' IN ('value1', 'value2')"
276
+ nin: string[] // is equal to the conditional of query "WHERE 'attribute_name' NOT IN ('value1', 'value1')"
277
+ eq: string // is equal to the conditional of query "WHERE 'attribute_name' = 'value1'
278
+ ne: string // is equal to the conditional of query "WHERE 'attribute_name' <> 'value1'
279
+ gte: string // is equal to the conditional of query "WHERE 'attribute_name' >= 'value1'
280
+ gt: string // is equal to the conditional of query "WHERE 'attribute_name' > 'value1'
281
+ lt: string // is equal to the conditional of query "WHERE 'attribute_name' < 'value1'
282
+ lte:string // is equal to the conditional of query "WHERE 'attribute_name' <= 'value1'
283
+ regexp: string // is equal to the conditional of query "WHERE 'attribute_name' ~* value1
284
+ some: string // is equal to the conditional of query "WHERE 'attribute_name' && [value1]
285
+ }
286
+ ```
287
+
288
+ ### Get item of Users
289
+
290
+ ```
291
+ GET /users/:id
292
+ ```
293
+ - **include** - you can extend result with relations (aka join)
294
+ ```
295
+ GET /users?include=roles
296
+ ```
297
+ result of request will have role relation for each **Users** item
298
+
299
+ - **fields** - you can specify required fields of result query
300
+
301
+ ```
302
+ GET /users?fields[target]=login,lastName&fileds[roles]=name,key
303
+ ```
304
+ The "target" is **Users** entity
305
+ The "roles" is **Roles** entity
306
+ So, result of request will be have only fields *login* and *lastName* for **Users** entity and fields *name* and *
307
+ key* for **Roles** entity
308
+
309
+ ### Create item of Users
310
+ ```
311
+ POST /users
312
+ ```
313
+
314
+ - **body** - Create new User and add link to address
315
+
316
+ ```json
317
+ {
318
+ "data": {
319
+ "type": "users",
320
+ "attributes": {
321
+ "id": 0,
322
+ "login": "string",
323
+ "firstName": "string",
324
+ "lastName": "string",
325
+ "isActive": true,
326
+ "createdAt": "2023-12-08T10:32:27.352Z",
327
+ "updatedAt": "2023-12-08T10:32:27.352Z"
328
+ },
329
+ "relationships": {
330
+ "addresses": {
331
+ "id": "1",
332
+ "type": "addresses"
333
+ }
334
+ }
335
+ }
336
+ }
337
+ ```
338
+ ### Update item of Users
339
+ ```
340
+ PATCH /users/:id
341
+ ```
342
+
343
+ - **body** - Update User with id 1 and update link to address and manager
344
+
345
+ ```json
346
+ {
347
+ "data": {
348
+ "id": "1",
349
+ "type": "users",
350
+ "attributes": {
351
+ "id": 0,
352
+ "login": "string",
353
+ "firstName": "string",
354
+ "lastName": "string",
355
+ "isActive": true,
356
+ "createdAt": "2023-12-08T10:34:57.752Z",
357
+ "updatedAt": "2023-12-08T10:34:57.752Z"
358
+ },
359
+ "relationships": {
360
+ "addresses": {
361
+ "id": "2",
362
+ "type": "addresses"
363
+ },
364
+ "manager": {
365
+ "id": "2",
366
+ "type": "users"
367
+ }
368
+ }
369
+ }
370
+ }
371
+
372
+ ```
373
+
374
+ ### Atomic operation
375
+ You can more information find [here](https://jsonapi.org/ext/atomic/)
376
+ But you have additinal feature.
377
+ For example: you will need create new **Roles**, then - create new **Users** and assign new **Roles** to new **Users**.
378
+ If use native json api you need send 3 http request:
379
+ - POST /roles
380
+ - POST /users
381
+
382
+ but [Atomic operation](https://jsonapi.org/ext/atomic/) allow for one request.
383
+ ```json
384
+
385
+ {
386
+ "atomic:operations":[
387
+ {
388
+ "op":"add",
389
+ "ref":{
390
+ "type":"roles",
391
+ "tmpId":10000
392
+ },
393
+ "data":{
394
+ "type":"roles",
395
+ "attributes":{
396
+ "name":"testRolesAgain",
397
+ "key":"testRolesAgain"
398
+ }
399
+ }
400
+ },
401
+ {
402
+ "op":"add",
403
+ "ref":{
404
+ "type":"users"
405
+ },
406
+ "data":{
407
+ "type":"users",
408
+ "attributes":{
409
+ "login":"newLogin"
410
+ },
411
+ "relationships":{
412
+ "addresses":{
413
+ "type":"addresses",
414
+ "id":"1"
415
+ },
416
+ "roles":[
417
+ {
418
+ "type":"roles",
419
+ "id":"10000"
420
+ }
421
+ ]
422
+ }
423
+ }
424
+ }
425
+ ]
426
+ }
427
+
428
+ ```
429
+ **tmpId** - is params for operation **add**, should be unique for all operations.
430
+
431
+ If you have Interceptor you can check call it from **AtomicOperation**
432
+
433
+
434
+
435
+ ```ts
436
+ @Injectable()
437
+ export class AtomicInterceptor<T> implements NestInterceptor {
438
+ intercept(context: ExecutionContext, next: CallHandler<T>): Observable<T> {
439
+ const isAtomic = context.getArgByIndex(3)
440
+ if (isAtomic) {
441
+ console.log('call from atomic operation')
442
+ }
443
+ return next.handle();
444
+ }
445
+ }
446
+ ```
447
+ **isAtomic** - is array of params of method
package/package.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "name": "@klerick/json-api-nestjs",
3
+ "version": "10.0.0-beta.2",
4
+ "type": "commonjs",
5
+ "description": "JsonApi Plugin for NestJs",
6
+ "keywords": [
7
+ "nestjs",
8
+ "nest",
9
+ "jsonapi",
10
+ "json-api",
11
+ "typeorm",
12
+ "microorm",
13
+ "CRUD"
14
+ ],
15
+ "dependencies": {
16
+ "@anatine/zod-openapi": "^2.2.3",
17
+ "@nestjs/common": "^11.1.0",
18
+ "@nestjs/core": "^11.1.0",
19
+ "@nestjs/swagger": "^11.2.0",
20
+ "change-case-commonjs": "^5.4.4",
21
+ "reflect-metadata": "^0.1.12 || ^0.2.0",
22
+ "rxjs": "^7.1.0",
23
+ "ts-toolbelt": "^9.6.0",
24
+ "tslib": ">2.3.0",
25
+ "zod": "^3.24.1",
26
+ "zod-validation-error": "^3.4.0"
27
+ },
28
+ "exports": {
29
+ "./package.json": "./package.json",
30
+ ".": {
31
+ "types": "./src/index.d.ts",
32
+ "default": "./src/index.js"
33
+ }
34
+ },
35
+ "types": "./src/index.d.ts",
36
+ "main": "./src/index.js",
37
+ "license": "MIT",
38
+ "contributors": [
39
+ {
40
+ "email": "klerick666@gmain.com",
41
+ "name": "Aleksandr Kharkovey"
42
+ }
43
+ ],
44
+ "repository": {
45
+ "type": "git",
46
+ "url": "https://github.com/klerick/nestjs-json-api.git"
47
+ },
48
+ "engines": {
49
+ "node": ">= 20.0.0"
50
+ },
51
+ "files": [
52
+ "**/*"
53
+ ],
54
+ "publishConfig": {
55
+ "access": "public"
56
+ }
57
+ }
package/src/index.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ export { JsonApiModule } from './lib/json-api.module';
2
+ export { JsonBaseController } from './lib/modules/mixin/controllers/json-base.controller';
3
+ export { JsonApi, InjectService } from './lib/modules/mixin/decorators';
4
+ export { entityForClass, excludeMethod, } from './lib/modules/mixin/helpers/utils';
5
+ export { PrepareParams, NestProvider, ValidateQueryError, UnionToTuple, EntityParam, TypeField, } from './lib/types';
6
+ export { JsonApiTransformerService, ErrorFormatService, } from './lib/modules/mixin/service';
7
+ export { MODULE_OPTIONS_TOKEN, CONTROLLER_OPTIONS_TOKEN, ASC, DESC, FIND_ONE_ROW_ENTITY, CHECK_RELATION_NAME, RUN_IN_TRANSACTION_FUNCTION, ORM_SERVICE, ENTITY_PARAM_MAP, DEFAULT_PAGE_SIZE, DEFAULT_QUERY_PAGE, CURRENT_ENTITY, } from './lib/constants';
8
+ export { OrmService, OrmService as JsonApiService, EntityControllerParam, CheckRelationName, FindOneRowEntity, RunInTransaction, EntityParamMap, } from './lib/modules/mixin/types';
9
+ export { PatchData, PatchRelationshipData, PostData, PostRelationshipData, Query, QueryOne, SortQuery, Relationships, } from './lib/modules/mixin/zod';
package/src/index.js ADDED
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CURRENT_ENTITY = exports.DEFAULT_QUERY_PAGE = exports.DEFAULT_PAGE_SIZE = exports.ENTITY_PARAM_MAP = exports.ORM_SERVICE = exports.RUN_IN_TRANSACTION_FUNCTION = exports.CHECK_RELATION_NAME = exports.FIND_ONE_ROW_ENTITY = exports.DESC = exports.ASC = exports.CONTROLLER_OPTIONS_TOKEN = exports.MODULE_OPTIONS_TOKEN = exports.ErrorFormatService = exports.JsonApiTransformerService = exports.TypeField = exports.excludeMethod = exports.entityForClass = exports.InjectService = exports.JsonApi = exports.JsonBaseController = exports.JsonApiModule = void 0;
4
+ var json_api_module_1 = require("./lib/json-api.module");
5
+ Object.defineProperty(exports, "JsonApiModule", { enumerable: true, get: function () { return json_api_module_1.JsonApiModule; } });
6
+ var json_base_controller_1 = require("./lib/modules/mixin/controllers/json-base.controller");
7
+ Object.defineProperty(exports, "JsonBaseController", { enumerable: true, get: function () { return json_base_controller_1.JsonBaseController; } });
8
+ var decorators_1 = require("./lib/modules/mixin/decorators");
9
+ Object.defineProperty(exports, "JsonApi", { enumerable: true, get: function () { return decorators_1.JsonApi; } });
10
+ Object.defineProperty(exports, "InjectService", { enumerable: true, get: function () { return decorators_1.InjectService; } });
11
+ var utils_1 = require("./lib/modules/mixin/helpers/utils");
12
+ Object.defineProperty(exports, "entityForClass", { enumerable: true, get: function () { return utils_1.entityForClass; } });
13
+ Object.defineProperty(exports, "excludeMethod", { enumerable: true, get: function () { return utils_1.excludeMethod; } });
14
+ var types_1 = require("./lib/types");
15
+ Object.defineProperty(exports, "TypeField", { enumerable: true, get: function () { return types_1.TypeField; } });
16
+ var service_1 = require("./lib/modules/mixin/service");
17
+ Object.defineProperty(exports, "JsonApiTransformerService", { enumerable: true, get: function () { return service_1.JsonApiTransformerService; } });
18
+ Object.defineProperty(exports, "ErrorFormatService", { enumerable: true, get: function () { return service_1.ErrorFormatService; } });
19
+ var constants_1 = require("./lib/constants");
20
+ Object.defineProperty(exports, "MODULE_OPTIONS_TOKEN", { enumerable: true, get: function () { return constants_1.MODULE_OPTIONS_TOKEN; } });
21
+ Object.defineProperty(exports, "CONTROLLER_OPTIONS_TOKEN", { enumerable: true, get: function () { return constants_1.CONTROLLER_OPTIONS_TOKEN; } });
22
+ Object.defineProperty(exports, "ASC", { enumerable: true, get: function () { return constants_1.ASC; } });
23
+ Object.defineProperty(exports, "DESC", { enumerable: true, get: function () { return constants_1.DESC; } });
24
+ Object.defineProperty(exports, "FIND_ONE_ROW_ENTITY", { enumerable: true, get: function () { return constants_1.FIND_ONE_ROW_ENTITY; } });
25
+ Object.defineProperty(exports, "CHECK_RELATION_NAME", { enumerable: true, get: function () { return constants_1.CHECK_RELATION_NAME; } });
26
+ Object.defineProperty(exports, "RUN_IN_TRANSACTION_FUNCTION", { enumerable: true, get: function () { return constants_1.RUN_IN_TRANSACTION_FUNCTION; } });
27
+ Object.defineProperty(exports, "ORM_SERVICE", { enumerable: true, get: function () { return constants_1.ORM_SERVICE; } });
28
+ Object.defineProperty(exports, "ENTITY_PARAM_MAP", { enumerable: true, get: function () { return constants_1.ENTITY_PARAM_MAP; } });
29
+ Object.defineProperty(exports, "DEFAULT_PAGE_SIZE", { enumerable: true, get: function () { return constants_1.DEFAULT_PAGE_SIZE; } });
30
+ Object.defineProperty(exports, "DEFAULT_QUERY_PAGE", { enumerable: true, get: function () { return constants_1.DEFAULT_QUERY_PAGE; } });
31
+ Object.defineProperty(exports, "CURRENT_ENTITY", { enumerable: true, get: function () { return constants_1.CURRENT_ENTITY; } });
32
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/json-api/json-api-nestjs/src/index.ts"],"names":[],"mappings":";;;AAAA,yDAAsD;AAA7C,gHAAA,aAAa,OAAA;AAEtB,6FAA0F;AAAjF,0HAAA,kBAAkB,OAAA;AAC3B,6DAAwE;AAA/D,qGAAA,OAAO,OAAA;AAAE,2GAAA,aAAa,OAAA;AAC/B,2DAG2C;AAFzC,uGAAA,cAAc,OAAA;AACd,sGAAA,aAAa,OAAA;AAEf,qCAOqB;AADnB,kGAAA,SAAS,OAAA;AAEX,uDAGqC;AAFnC,oHAAA,yBAAyB,OAAA;AACzB,6GAAA,kBAAkB,OAAA;AAEpB,6CAayB;AAZvB,iHAAA,oBAAoB,OAAA;AACpB,qHAAA,wBAAwB,OAAA;AACxB,gGAAA,GAAG,OAAA;AACH,iGAAA,IAAI,OAAA;AACJ,gHAAA,mBAAmB,OAAA;AACnB,gHAAA,mBAAmB,OAAA;AACnB,wHAAA,2BAA2B,OAAA;AAC3B,wGAAA,WAAW,OAAA;AACX,6GAAA,gBAAgB,OAAA;AAChB,8GAAA,iBAAiB,OAAA;AACjB,+GAAA,kBAAkB,OAAA;AAClB,2GAAA,cAAc,OAAA"}
@@ -0,0 +1,9 @@
1
+ export declare const JSON_API_CONTROLLER_POSTFIX = "JsonApiController";
2
+ export declare const JSON_API_MODULE_POSTFIX = "JsonApiModule";
3
+ export declare const DEFAULT_CONNECTION_NAME = "default";
4
+ export declare const ORM_SERVICE_PROPS: unique symbol;
5
+ export declare const PARAMS_RESOURCE_ID = "id";
6
+ export declare const PARAMS_RELATION_NAME = "relName";
7
+ export declare const DESC = "DESC";
8
+ export declare const ASC = "ASC";
9
+ export declare const SORT_TYPE: readonly ["DESC", "ASC"];