@openapi-qraft/react 1.6.0 → 1.8.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 (352) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/QraftContext.d.ts +1 -1
  3. package/dist/ServiceOperation.d.ts +21 -560
  4. package/dist/ServiceOperation.d.ts.map +1 -1
  5. package/dist/callbacks/cancelQueries.d.ts +1 -1
  6. package/dist/callbacks/cancelQueries.d.ts.map +1 -1
  7. package/dist/callbacks/fetchInfiniteQuery.d.ts +1 -1
  8. package/dist/callbacks/fetchInfiniteQuery.d.ts.map +1 -1
  9. package/dist/callbacks/fetchQuery.d.ts +1 -1
  10. package/dist/callbacks/fetchQuery.d.ts.map +1 -1
  11. package/dist/callbacks/getInfiniteQueryData.d.ts +1 -1
  12. package/dist/callbacks/getInfiniteQueryData.d.ts.map +1 -1
  13. package/dist/callbacks/getInfiniteQueryKey.d.ts +2 -2
  14. package/dist/callbacks/getInfiniteQueryKey.d.ts.map +1 -1
  15. package/dist/callbacks/getInfiniteQueryState.d.ts +1 -1
  16. package/dist/callbacks/getInfiniteQueryState.d.ts.map +1 -1
  17. package/dist/callbacks/getMutationKey.d.ts +1 -1
  18. package/dist/callbacks/getMutationKey.d.ts.map +1 -1
  19. package/dist/callbacks/getQueriesData.d.ts +1 -1
  20. package/dist/callbacks/getQueriesData.d.ts.map +1 -1
  21. package/dist/callbacks/getQueryData.d.ts +1 -1
  22. package/dist/callbacks/getQueryData.d.ts.map +1 -1
  23. package/dist/callbacks/getQueryKey.d.ts +2 -2
  24. package/dist/callbacks/getQueryKey.d.ts.map +1 -1
  25. package/dist/callbacks/getQueryState.d.ts +1 -1
  26. package/dist/callbacks/getQueryState.d.ts.map +1 -1
  27. package/dist/callbacks/invalidateQueries.d.ts +1 -1
  28. package/dist/callbacks/invalidateQueries.d.ts.map +1 -1
  29. package/dist/callbacks/isFetching.d.ts +1 -1
  30. package/dist/callbacks/isFetching.d.ts.map +1 -1
  31. package/dist/callbacks/isMutating.d.ts +1 -1
  32. package/dist/callbacks/isMutating.d.ts.map +1 -1
  33. package/dist/callbacks/mutationFn.js +2 -2
  34. package/dist/callbacks/mutationFn.js.map +1 -1
  35. package/dist/callbacks/operationInvokeFn.d.ts +9 -0
  36. package/dist/callbacks/operationInvokeFn.d.ts.map +1 -0
  37. package/dist/callbacks/operationInvokeFn.js +21 -0
  38. package/dist/callbacks/operationInvokeFn.js.map +1 -0
  39. package/dist/callbacks/prefetchInfiniteQuery.d.ts +1 -1
  40. package/dist/callbacks/prefetchInfiniteQuery.d.ts.map +1 -1
  41. package/dist/callbacks/prefetchQuery.d.ts +1 -1
  42. package/dist/callbacks/prefetchQuery.d.ts.map +1 -1
  43. package/dist/callbacks/queryFn.d.ts +1 -1
  44. package/dist/callbacks/queryFn.d.ts.map +1 -1
  45. package/dist/callbacks/queryFn.js +4 -2
  46. package/dist/callbacks/queryFn.js.map +1 -1
  47. package/dist/callbacks/refetchQueries.d.ts +2 -2
  48. package/dist/callbacks/refetchQueries.d.ts.map +1 -1
  49. package/dist/callbacks/removeQueries.d.ts +1 -1
  50. package/dist/callbacks/removeQueries.d.ts.map +1 -1
  51. package/dist/callbacks/resetQueries.d.ts +1 -1
  52. package/dist/callbacks/resetQueries.d.ts.map +1 -1
  53. package/dist/callbacks/setInfiniteQueryData.d.ts +1 -1
  54. package/dist/callbacks/setInfiniteQueryData.d.ts.map +1 -1
  55. package/dist/callbacks/setQueriesData.d.ts +1 -1
  56. package/dist/callbacks/setQueriesData.d.ts.map +1 -1
  57. package/dist/callbacks/setQueryData.d.ts +1 -1
  58. package/dist/callbacks/setQueryData.d.ts.map +1 -1
  59. package/dist/callbacks/useInfiniteQuery.d.ts +1 -1
  60. package/dist/callbacks/useInfiniteQuery.d.ts.map +1 -1
  61. package/dist/callbacks/useInfiniteQuery.js +1 -1
  62. package/dist/callbacks/useInfiniteQuery.js.map +1 -1
  63. package/dist/callbacks/useIsFetching.d.ts +1 -1
  64. package/dist/callbacks/useIsFetching.d.ts.map +1 -1
  65. package/dist/callbacks/useIsMutating.d.ts +1 -1
  66. package/dist/callbacks/useIsMutating.d.ts.map +1 -1
  67. package/dist/callbacks/useMutation.d.ts +1 -1
  68. package/dist/callbacks/useMutation.d.ts.map +1 -1
  69. package/dist/callbacks/useMutation.js.map +1 -1
  70. package/dist/callbacks/useMutationState.d.ts +1 -1
  71. package/dist/callbacks/useMutationState.d.ts.map +1 -1
  72. package/dist/callbacks/useQueries.d.ts +1 -1
  73. package/dist/callbacks/useQueries.d.ts.map +1 -1
  74. package/dist/callbacks/useQueries.js +1 -1
  75. package/dist/callbacks/useQueries.js.map +1 -1
  76. package/dist/callbacks/useQuery.d.ts +1 -1
  77. package/dist/callbacks/useQuery.d.ts.map +1 -1
  78. package/dist/callbacks/useQuery.js +1 -1
  79. package/dist/callbacks/useQuery.js.map +1 -1
  80. package/dist/callbacks/useSuspenseInfiniteQuery.d.ts +1 -1
  81. package/dist/callbacks/useSuspenseInfiniteQuery.d.ts.map +1 -1
  82. package/dist/callbacks/useSuspenseInfiniteQuery.js +1 -1
  83. package/dist/callbacks/useSuspenseInfiniteQuery.js.map +1 -1
  84. package/dist/callbacks/useSuspenseQueries.d.ts +1 -1
  85. package/dist/callbacks/useSuspenseQueries.d.ts.map +1 -1
  86. package/dist/callbacks/useSuspenseQueries.js +1 -1
  87. package/dist/callbacks/useSuspenseQueries.js.map +1 -1
  88. package/dist/callbacks/useSuspenseQuery.d.ts +1 -1
  89. package/dist/callbacks/useSuspenseQuery.d.ts.map +1 -1
  90. package/dist/callbacks/useSuspenseQuery.js +1 -1
  91. package/dist/callbacks/useSuspenseQuery.js.map +1 -1
  92. package/dist/index.d.ts +1 -1
  93. package/dist/index.d.ts.map +1 -1
  94. package/dist/index.js +1 -0
  95. package/dist/index.js.map +1 -1
  96. package/dist/lib/PartialParameters.type.d.ts +13 -0
  97. package/dist/lib/PartialParameters.type.d.ts.map +1 -0
  98. package/dist/lib/PartialParameters.type.js +2 -0
  99. package/dist/lib/PartialParameters.type.js.map +1 -0
  100. package/dist/lib/callQueryClientFetchMethod.js +3 -3
  101. package/dist/lib/callQueryClientFetchMethod.js.map +1 -1
  102. package/dist/lib/callQueryClientMethodWithMutationFilters.js +2 -2
  103. package/dist/lib/callQueryClientMethodWithMutationFilters.js.map +1 -1
  104. package/dist/lib/callQueryClientMethodWithQueryFilters.js +2 -2
  105. package/dist/lib/callQueryClientMethodWithQueryFilters.js.map +1 -1
  106. package/dist/lib/callQueryClientMethodWithQueryKey.js +1 -1
  107. package/dist/lib/callQueryClientMethodWithQueryKey.js.map +1 -1
  108. package/dist/lib/composeBaseQueryKey.d.ts +1 -1
  109. package/dist/lib/composeBaseQueryKey.d.ts.map +1 -1
  110. package/dist/lib/composeInfiniteQueryKey.d.ts +1 -1
  111. package/dist/lib/composeInfiniteQueryKey.d.ts.map +1 -1
  112. package/dist/lib/composeMutationKey.d.ts +2 -2
  113. package/dist/lib/composeMutationKey.d.ts.map +1 -1
  114. package/dist/lib/composeMutationKey.js +1 -1
  115. package/dist/lib/composeMutationKey.js.map +1 -1
  116. package/dist/lib/composeQueryKey.d.ts +1 -1
  117. package/dist/lib/composeQueryKey.d.ts.map +1 -1
  118. package/dist/lib/createRecursiveProxy.d.ts +6 -0
  119. package/dist/lib/createRecursiveProxy.d.ts.map +1 -1
  120. package/dist/lib/createRecursiveProxy.js +7 -0
  121. package/dist/lib/createRecursiveProxy.js.map +1 -1
  122. package/dist/lib/requestFn.d.ts +26 -3
  123. package/dist/lib/requestFn.d.ts.map +1 -1
  124. package/dist/lib/requestFn.js +27 -3
  125. package/dist/lib/requestFn.js.map +1 -1
  126. package/dist/lib/useComposeUseQueryOptions.js +2 -2
  127. package/dist/lib/useComposeUseQueryOptions.js.map +1 -1
  128. package/dist/lib/useQueryClient.d.ts.map +1 -1
  129. package/dist/lib/useQueryClient.js +1 -2
  130. package/dist/lib/useQueryClient.js.map +1 -1
  131. package/dist/qraftAPIClient.d.ts +4 -16
  132. package/dist/qraftAPIClient.d.ts.map +1 -1
  133. package/dist/qraftAPIClient.js +28 -9
  134. package/dist/qraftAPIClient.js.map +1 -1
  135. package/dist/service-operation/OperationInfiniteData.d.ts +4 -0
  136. package/dist/service-operation/OperationInfiniteData.d.ts.map +1 -0
  137. package/dist/service-operation/OperationInfiniteData.js +2 -0
  138. package/dist/service-operation/OperationInfiniteData.js.map +1 -0
  139. package/dist/service-operation/QueryFilters.d.ts +123 -0
  140. package/dist/service-operation/QueryFilters.d.ts.map +1 -0
  141. package/dist/service-operation/QueryFilters.js +2 -0
  142. package/dist/service-operation/QueryFilters.js.map +1 -0
  143. package/dist/service-operation/ServiceOperation.d.ts +53 -0
  144. package/dist/service-operation/ServiceOperation.d.ts.map +1 -0
  145. package/dist/service-operation/ServiceOperation.js +2 -0
  146. package/dist/service-operation/ServiceOperation.js.map +1 -0
  147. package/dist/service-operation/ServiceOperationCancelQueries.d.ts +20 -0
  148. package/dist/service-operation/ServiceOperationCancelQueries.d.ts.map +1 -0
  149. package/dist/service-operation/ServiceOperationCancelQueries.js +2 -0
  150. package/dist/service-operation/ServiceOperationCancelQueries.js.map +1 -0
  151. package/dist/service-operation/ServiceOperationFetchInfiniteQuery.d.ts +58 -0
  152. package/dist/service-operation/ServiceOperationFetchInfiniteQuery.d.ts.map +1 -0
  153. package/dist/service-operation/ServiceOperationFetchInfiniteQuery.js +2 -0
  154. package/dist/service-operation/ServiceOperationFetchInfiniteQuery.js.map +1 -0
  155. package/dist/service-operation/ServiceOperationFetchQuery.d.ts +49 -0
  156. package/dist/service-operation/ServiceOperationFetchQuery.d.ts.map +1 -0
  157. package/dist/service-operation/ServiceOperationFetchQuery.js +2 -0
  158. package/dist/service-operation/ServiceOperationFetchQuery.js.map +1 -0
  159. package/dist/service-operation/ServiceOperationGetInfiniteQueryData.d.ts +10 -0
  160. package/dist/service-operation/ServiceOperationGetInfiniteQueryData.d.ts.map +1 -0
  161. package/dist/service-operation/ServiceOperationGetInfiniteQueryData.js +2 -0
  162. package/dist/service-operation/ServiceOperationGetInfiniteQueryData.js.map +1 -0
  163. package/dist/service-operation/ServiceOperationGetQueriesData.d.ts +18 -0
  164. package/dist/service-operation/ServiceOperationGetQueriesData.d.ts.map +1 -0
  165. package/dist/service-operation/ServiceOperationGetQueriesData.js +2 -0
  166. package/dist/service-operation/ServiceOperationGetQueriesData.js.map +1 -0
  167. package/dist/service-operation/ServiceOperationGetQueryData.d.ts +9 -0
  168. package/dist/service-operation/ServiceOperationGetQueryData.d.ts.map +1 -0
  169. package/dist/service-operation/ServiceOperationGetQueryData.js +2 -0
  170. package/dist/service-operation/ServiceOperationGetQueryData.js.map +1 -0
  171. package/dist/service-operation/ServiceOperationGetQueryState.d.ts +11 -0
  172. package/dist/service-operation/ServiceOperationGetQueryState.d.ts.map +1 -0
  173. package/dist/service-operation/ServiceOperationGetQueryState.js +2 -0
  174. package/dist/service-operation/ServiceOperationGetQueryState.js.map +1 -0
  175. package/dist/service-operation/ServiceOperationInvalidateQueries.d.ts +26 -0
  176. package/dist/service-operation/ServiceOperationInvalidateQueries.d.ts.map +1 -0
  177. package/dist/service-operation/ServiceOperationInvalidateQueries.js +2 -0
  178. package/dist/service-operation/ServiceOperationInvalidateQueries.js.map +1 -0
  179. package/dist/service-operation/ServiceOperationIsFetchingQueries.d.ts +19 -0
  180. package/dist/service-operation/ServiceOperationIsFetchingQueries.d.ts.map +1 -0
  181. package/dist/service-operation/ServiceOperationIsFetchingQueries.js +2 -0
  182. package/dist/service-operation/ServiceOperationIsFetchingQueries.js.map +1 -0
  183. package/dist/service-operation/ServiceOperationIsMutatingQueries.d.ts +19 -0
  184. package/dist/service-operation/ServiceOperationIsMutatingQueries.d.ts.map +1 -0
  185. package/dist/service-operation/ServiceOperationIsMutatingQueries.js +2 -0
  186. package/dist/service-operation/ServiceOperationIsMutatingQueries.js.map +1 -0
  187. package/dist/service-operation/ServiceOperationKey.d.ts +16 -0
  188. package/dist/service-operation/ServiceOperationKey.d.ts.map +1 -0
  189. package/dist/service-operation/ServiceOperationKey.js +2 -0
  190. package/dist/service-operation/ServiceOperationKey.js.map +1 -0
  191. package/dist/service-operation/ServiceOperationMutationFn.d.ts +47 -0
  192. package/dist/service-operation/ServiceOperationMutationFn.d.ts.map +1 -0
  193. package/dist/service-operation/ServiceOperationMutationFn.js +2 -0
  194. package/dist/service-operation/ServiceOperationMutationFn.js.map +1 -0
  195. package/dist/service-operation/ServiceOperationQueryFn.d.ts +79 -0
  196. package/dist/service-operation/ServiceOperationQueryFn.d.ts.map +1 -0
  197. package/dist/service-operation/ServiceOperationQueryFn.js +2 -0
  198. package/dist/service-operation/ServiceOperationQueryFn.js.map +1 -0
  199. package/dist/service-operation/ServiceOperationRefetchQueries.d.ts +30 -0
  200. package/dist/service-operation/ServiceOperationRefetchQueries.d.ts.map +1 -0
  201. package/dist/service-operation/ServiceOperationRefetchQueries.js +2 -0
  202. package/dist/service-operation/ServiceOperationRefetchQueries.js.map +1 -0
  203. package/dist/service-operation/ServiceOperationRemoveQueries.d.ts +19 -0
  204. package/dist/service-operation/ServiceOperationRemoveQueries.d.ts.map +1 -0
  205. package/dist/service-operation/ServiceOperationRemoveQueries.js +2 -0
  206. package/dist/service-operation/ServiceOperationRemoveQueries.js.map +1 -0
  207. package/dist/service-operation/ServiceOperationResetQueries.d.ts +20 -0
  208. package/dist/service-operation/ServiceOperationResetQueries.d.ts.map +1 -0
  209. package/dist/service-operation/ServiceOperationResetQueries.js +2 -0
  210. package/dist/service-operation/ServiceOperationResetQueries.js.map +1 -0
  211. package/dist/service-operation/ServiceOperationSetInfiniteQueryData.d.ts +10 -0
  212. package/dist/service-operation/ServiceOperationSetInfiniteQueryData.d.ts.map +1 -0
  213. package/dist/service-operation/ServiceOperationSetInfiniteQueryData.js +2 -0
  214. package/dist/service-operation/ServiceOperationSetInfiniteQueryData.js.map +1 -0
  215. package/dist/service-operation/ServiceOperationSetQueriesData.d.ts +20 -0
  216. package/dist/service-operation/ServiceOperationSetQueriesData.d.ts.map +1 -0
  217. package/dist/service-operation/ServiceOperationSetQueriesData.js +2 -0
  218. package/dist/service-operation/ServiceOperationSetQueriesData.js.map +1 -0
  219. package/dist/service-operation/ServiceOperationSetQueryData.d.ts +19 -0
  220. package/dist/service-operation/ServiceOperationSetQueryData.d.ts.map +1 -0
  221. package/dist/service-operation/ServiceOperationSetQueryData.js +2 -0
  222. package/dist/service-operation/ServiceOperationSetQueryData.js.map +1 -0
  223. package/dist/service-operation/ServiceOperationUseInfiniteQuery.d.ts +14 -0
  224. package/dist/service-operation/ServiceOperationUseInfiniteQuery.d.ts.map +1 -0
  225. package/dist/service-operation/ServiceOperationUseInfiniteQuery.js +2 -0
  226. package/dist/service-operation/ServiceOperationUseInfiniteQuery.js.map +1 -0
  227. package/dist/service-operation/ServiceOperationUseIsFetchingQueries.d.ts +9 -0
  228. package/dist/service-operation/ServiceOperationUseIsFetchingQueries.d.ts.map +1 -0
  229. package/dist/service-operation/ServiceOperationUseIsFetchingQueries.js +2 -0
  230. package/dist/service-operation/ServiceOperationUseIsFetchingQueries.js.map +1 -0
  231. package/dist/service-operation/ServiceOperationUseIsMutating.d.ts +9 -0
  232. package/dist/service-operation/ServiceOperationUseIsMutating.d.ts.map +1 -0
  233. package/dist/service-operation/ServiceOperationUseIsMutating.js +2 -0
  234. package/dist/service-operation/ServiceOperationUseIsMutating.js.map +1 -0
  235. package/dist/service-operation/ServiceOperationUseMutation.d.ts +17 -0
  236. package/dist/service-operation/ServiceOperationUseMutation.d.ts.map +1 -0
  237. package/dist/service-operation/ServiceOperationUseMutation.js +2 -0
  238. package/dist/service-operation/ServiceOperationUseMutation.js.map +1 -0
  239. package/dist/service-operation/ServiceOperationUseMutationState.d.ts +46 -0
  240. package/dist/service-operation/ServiceOperationUseMutationState.d.ts.map +1 -0
  241. package/dist/service-operation/ServiceOperationUseMutationState.js +2 -0
  242. package/dist/service-operation/ServiceOperationUseMutationState.js.map +1 -0
  243. package/dist/service-operation/ServiceOperationUseQueries.d.ts +20 -0
  244. package/dist/service-operation/ServiceOperationUseQueries.d.ts.map +1 -0
  245. package/dist/service-operation/ServiceOperationUseQueries.js +2 -0
  246. package/dist/service-operation/ServiceOperationUseQueries.js.map +1 -0
  247. package/dist/service-operation/ServiceOperationUseQuery.d.ts +12 -0
  248. package/dist/service-operation/ServiceOperationUseQuery.d.ts.map +1 -0
  249. package/dist/service-operation/ServiceOperationUseQuery.js +2 -0
  250. package/dist/service-operation/ServiceOperationUseQuery.js.map +1 -0
  251. package/dist/service-operation/ServiceOperationUseSuspenseInfiniteQuery.d.ts +12 -0
  252. package/dist/service-operation/ServiceOperationUseSuspenseInfiniteQuery.d.ts.map +1 -0
  253. package/dist/service-operation/ServiceOperationUseSuspenseInfiniteQuery.js +2 -0
  254. package/dist/service-operation/ServiceOperationUseSuspenseInfiniteQuery.js.map +1 -0
  255. package/dist/service-operation/ServiceOperationUseSuspenseQueries.d.ts +18 -0
  256. package/dist/service-operation/ServiceOperationUseSuspenseQueries.d.ts.map +1 -0
  257. package/dist/service-operation/ServiceOperationUseSuspenseQueries.js +2 -0
  258. package/dist/service-operation/ServiceOperationUseSuspenseQueries.js.map +1 -0
  259. package/dist/service-operation/ServiceOperationUseSuspenseQueryQuery.d.ts +10 -0
  260. package/dist/service-operation/ServiceOperationUseSuspenseQueryQuery.d.ts.map +1 -0
  261. package/dist/service-operation/ServiceOperationUseSuspenseQueryQuery.js +2 -0
  262. package/dist/service-operation/ServiceOperationUseSuspenseQueryQuery.js.map +1 -0
  263. package/dist/service-operation/index.d.ts +2 -0
  264. package/dist/service-operation/index.d.ts.map +1 -0
  265. package/dist/service-operation/index.js +2 -0
  266. package/dist/service-operation/index.js.map +1 -0
  267. package/package.json +9 -4
  268. package/src/QraftContext.ts +1 -1
  269. package/src/ServiceOperation.ts +38 -1375
  270. package/src/callbacks/cancelQueries.ts +1 -1
  271. package/src/callbacks/fetchInfiniteQuery.ts +1 -1
  272. package/src/callbacks/fetchQuery.ts +1 -1
  273. package/src/callbacks/getInfiniteQueryData.ts +1 -1
  274. package/src/callbacks/getInfiniteQueryKey.ts +1 -1
  275. package/src/callbacks/getInfiniteQueryState.ts +1 -1
  276. package/src/callbacks/getMutationKey.ts +1 -1
  277. package/src/callbacks/getQueriesData.ts +1 -1
  278. package/src/callbacks/getQueryData.ts +1 -1
  279. package/src/callbacks/getQueryKey.ts +1 -1
  280. package/src/callbacks/getQueryState.ts +1 -1
  281. package/src/callbacks/invalidateQueries.ts +1 -1
  282. package/src/callbacks/isFetching.ts +1 -1
  283. package/src/callbacks/isMutating.ts +1 -1
  284. package/src/callbacks/mutationFn.ts +3 -3
  285. package/src/callbacks/operationInvokeFn.ts +45 -0
  286. package/src/callbacks/prefetchInfiniteQuery.ts +1 -1
  287. package/src/callbacks/prefetchQuery.ts +1 -1
  288. package/src/callbacks/queryFn.ts +12 -7
  289. package/src/callbacks/refetchQueries.ts +2 -2
  290. package/src/callbacks/removeQueries.ts +1 -1
  291. package/src/callbacks/resetQueries.ts +1 -1
  292. package/src/callbacks/setInfiniteQueryData.ts +1 -1
  293. package/src/callbacks/setQueriesData.ts +1 -1
  294. package/src/callbacks/setQueryData.ts +1 -1
  295. package/src/callbacks/useInfiniteQuery.ts +2 -2
  296. package/src/callbacks/useIsFetching.ts +1 -1
  297. package/src/callbacks/useIsMutating.ts +1 -1
  298. package/src/callbacks/useMutation.ts +2 -4
  299. package/src/callbacks/useMutationState.ts +1 -1
  300. package/src/callbacks/useQueries.ts +2 -2
  301. package/src/callbacks/useQuery.ts +2 -2
  302. package/src/callbacks/useSuspenseInfiniteQuery.ts +2 -2
  303. package/src/callbacks/useSuspenseQueries.ts +2 -2
  304. package/src/callbacks/useSuspenseQuery.ts +2 -2
  305. package/src/index.ts +1 -4
  306. package/src/lib/PartialParameters.type.ts +12 -0
  307. package/src/lib/callQueryClientFetchMethod.ts +3 -3
  308. package/src/lib/callQueryClientMethodWithMutationFilters.ts +2 -2
  309. package/src/lib/callQueryClientMethodWithQueryFilters.ts +2 -2
  310. package/src/lib/callQueryClientMethodWithQueryKey.ts +1 -1
  311. package/src/lib/composeBaseQueryKey.ts +2 -2
  312. package/src/lib/composeInfiniteQueryKey.ts +1 -1
  313. package/src/lib/composeMutationKey.ts +7 -9
  314. package/src/lib/composeQueryKey.ts +1 -1
  315. package/src/lib/createRecursiveProxy.ts +7 -0
  316. package/src/lib/requestFn.ts +31 -5
  317. package/src/lib/useComposeUseQueryOptions.ts +3 -3
  318. package/src/lib/useQueryClient.ts +3 -2
  319. package/src/qraftAPIClient.ts +39 -39
  320. package/src/service-operation/OperationInfiniteData.ts +8 -0
  321. package/src/service-operation/QueryFilters.ts +227 -0
  322. package/src/service-operation/ServiceOperation.ts +86 -0
  323. package/src/service-operation/ServiceOperationCancelQueries.ts +53 -0
  324. package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts +156 -0
  325. package/src/service-operation/ServiceOperationFetchQuery.ts +95 -0
  326. package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts +15 -0
  327. package/src/service-operation/ServiceOperationGetQueriesData.ts +37 -0
  328. package/src/service-operation/ServiceOperationGetQueryData.ts +14 -0
  329. package/src/service-operation/ServiceOperationGetQueryState.ts +28 -0
  330. package/src/service-operation/ServiceOperationInvalidateQueries.ts +62 -0
  331. package/src/service-operation/ServiceOperationIsFetchingQueries.ts +40 -0
  332. package/src/service-operation/ServiceOperationIsMutatingQueries.ts +62 -0
  333. package/src/service-operation/ServiceOperationKey.ts +20 -0
  334. package/src/service-operation/ServiceOperationMutationFn.ts +92 -0
  335. package/src/service-operation/ServiceOperationQueryFn.ts +177 -0
  336. package/src/service-operation/ServiceOperationRefetchQueries.ts +74 -0
  337. package/src/service-operation/ServiceOperationRemoveQueries.ts +40 -0
  338. package/src/service-operation/ServiceOperationResetQueries.ts +53 -0
  339. package/src/service-operation/ServiceOperationSetInfiniteQueryData.ts +25 -0
  340. package/src/service-operation/ServiceOperationSetQueriesData.ts +55 -0
  341. package/src/service-operation/ServiceOperationSetQueryData.ts +43 -0
  342. package/src/service-operation/ServiceOperationUseInfiniteQuery.ts +70 -0
  343. package/src/service-operation/ServiceOperationUseIsFetchingQueries.ts +20 -0
  344. package/src/service-operation/ServiceOperationUseIsMutating.ts +28 -0
  345. package/src/service-operation/ServiceOperationUseMutation.ts +46 -0
  346. package/src/service-operation/ServiceOperationUseMutationState.ts +112 -0
  347. package/src/service-operation/ServiceOperationUseQueries.ts +40 -0
  348. package/src/service-operation/ServiceOperationUseQuery.ts +48 -0
  349. package/src/service-operation/ServiceOperationUseSuspenseInfiniteQuery.ts +43 -0
  350. package/src/service-operation/ServiceOperationUseSuspenseQueries.ts +40 -0
  351. package/src/service-operation/ServiceOperationUseSuspenseQueryQuery.ts +28 -0
  352. package/src/service-operation/index.ts +4 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @openapi-qraft/react
2
2
 
3
+ ## 1.8.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 7d4402e: Direct OpenAPI method invocation capability added to Qraft. Users can now perform GET, POST, and other HTTP operations on OpenAPI endpoints without using TanStack Query, specifying necessary parameters and base URLs.
8
+
9
+ ## 1.7.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 8e8ee11: `ServiceOperation` type has been moved to `/service-operation` and separated out
14
+
15
+ ### Patch Changes
16
+
17
+ - 56ea791: Added support for a non-exact Query Key in Query Filters
18
+
3
19
  ## 1.6.0
4
20
 
5
21
  ## 1.5.0
@@ -3,7 +3,7 @@ import type { QueryClient } from '@tanstack/react-query';
3
3
  import type { OperationSchema, RequestFnPayload } from './lib/requestFn.js';
4
4
  interface QraftContextValueBase {
5
5
  /**
6
- * The base URL to use for all requests.
6
+ * Base URL to use for the request
7
7
  * @example 'https://api.example.com'
8
8
  */
9
9
  baseUrl?: string;
@@ -1,583 +1,44 @@
1
- import { CancelOptions, DefaultError, FetchStatus, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, Mutation, MutationState, MutationStatus, NoInfer, QueriesPlaceholderDataFunction, Query, QueryClient, FetchQueryOptions, RefetchOptions, ResetOptions, SetDataOptions, Updater, QueryFunction, InitialPageParam, GetNextPageParamFunction, QueryState } from '@tanstack/query-core';
2
- import type { DefinedInitialDataInfiniteOptions, DefinedInitialDataOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, UndefinedInitialDataInfiniteOptions, UndefinedInitialDataOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
3
- import type { RequestFn } from './lib/requestFn.js';
4
- type ServiceOperationBaseQueryKey<S extends {
5
- url: string;
6
- method: string;
7
- }, Infinite extends boolean, T> = [S & {
8
- infinite: Infinite;
9
- }, T];
10
- export type ServiceOperationQueryKey<S extends {
11
- url: string;
12
- method: string;
13
- }, T> = ServiceOperationBaseQueryKey<S, false, T>;
14
- export type ServiceOperationInfiniteQueryKey<S extends {
15
- url: string;
16
- method: string;
17
- }, T> = ServiceOperationBaseQueryKey<S, true, T>;
18
- export type ServiceOperationMutationKey<S extends Record<'url' | 'method', string>, T extends unknown> = NonNullable<T> extends never ? [S] : [S, T];
19
- export interface ServiceOperationQuery<TSchema extends {
20
- url: string;
21
- method: string;
22
- }, TData, TParams, TError = DefaultError> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>, ServiceOperationUseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>, ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>, ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>, ServiceOperationQueryFn<TSchema, TData, TParams>, ServiceOperationFetchQuery<TSchema, TData, TParams, TError>, ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>, ServiceOperationGetQueryData<TSchema, TData, TParams>, ServiceOperationGetQueryState<TSchema, TData, TParams, TError>, ServiceOperationGetQueriesData<TSchema, TData, TParams, TError>, ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationSetQueryData<TSchema, TData, TParams>, ServiceOperationSetQueriesData<TSchema, TData, TParams, TError>, ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>, ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>, ServiceOperationCancelQueries<TSchema, TData, TParams, TError>, ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>, ServiceOperationResetQueries<TSchema, TData, TParams, TError>, ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>, ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
23
- schema: TSchema;
24
- types: {
25
- parameters: TParams;
26
- data: TData;
27
- error: TError;
28
- };
29
- }
30
- interface ServiceOperationUseQuery<TSchema extends {
31
- url: string;
32
- method: string;
33
- }, TData, TParams = {}, TError = DefaultError> {
34
- getQueryKey<QueryKeyParams extends TParams | undefined = undefined>(parameters?: QueryKeyParams): ServiceOperationQueryKey<TSchema, QueryKeyParams>;
35
- useQuery(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, options?: Omit<UndefinedInitialDataOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'>, queryClient?: QueryClient): UseQueryResult<TData, TError | Error>;
36
- useQuery(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, options: Omit<DefinedInitialDataOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'>, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError | Error>;
37
- }
38
- type FetchQueryOptionsBase<TSchema extends {
39
- url: string;
40
- method: string;
41
- }, TData, TParams = {}, TError = DefaultError> = Omit<FetchQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey' | 'queryFn'>;
42
- interface FetchQueryOptionsByQueryKey<TSchema extends {
43
- url: string;
44
- method: string;
45
- }, TData, TParams = {}, TError = DefaultError> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
46
- /**
47
- * Fetch Queries by query key
48
- */
49
- queryKey?: ServiceOperationQueryKey<TSchema, TParams>;
50
- }
51
- interface FetchQueryOptionsByParameters<TSchema extends {
52
- url: string;
53
- method: string;
54
- }, TData, TParams = {}, TError = DefaultError> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
55
- /**
56
- * Fetch Queries by parameters
57
- */
58
- parameters?: TParams;
59
- queryKey?: never;
60
- }
61
- type FetchQueryOptionsQueryFn<TSchema extends {
62
- url: string;
63
- method: string;
64
- }, TData, TParams = {}> = {
65
- queryFn?: QueryFunction<TData, ServiceOperationQueryKey<TSchema, TParams>>;
66
- } | {
67
- requestFn: RequestFn<TData>;
68
- /**
69
- * Base URL to use for the request (used in the `queryFn`)
70
- * @example 'https://api.example.com'
71
- */
72
- baseUrl: string | undefined;
73
- queryFn?: never;
74
- };
75
- interface ServiceOperationFetchQuery<TSchema extends {
76
- url: string;
77
- method: string;
78
- }, TData, TParams = {}, TError = DefaultError> {
79
- fetchQuery(options: (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<TData>;
80
- prefetchQuery(options: (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> & FetchQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<void>;
81
- }
82
- type FetchInfiniteQueryOptionsBase<TSchema extends {
83
- url: string;
84
- method: string;
85
- }, TData, TParams = {}, TPageParam = unknown, TError = DefaultError> = Omit<FetchQueryOptions<TData, TError, InfiniteData<TData, TPageParam>, ServiceOperationQueryKey<TSchema, TParams>, TPageParam>, 'queryKey'> & InitialPageParam<PartialParameters<TPageParam>> & FetchInfiniteQueryPages<TData, TPageParam>;
86
- type FetchInfiniteQueryPages<TData = unknown, TPageParam = unknown> = {
87
- pages?: never;
88
- } | {
89
- pages: number;
90
- getNextPageParam: GetNextPageParamFunction<PartialParameters<TPageParam>, TData>;
91
- };
92
- type FetchInfiniteQueryOptionsByQueryKey<TSchema extends {
93
- url: string;
94
- method: string;
95
- }, TData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TData, TParams, TPageParam, TError> & {
96
- /**
97
- * Fetch Queries by query key
98
- */
99
- queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
100
- parameters?: never;
101
- };
102
- type FetchInfiniteQueryOptionsByParameters<TSchema extends {
103
- url: string;
104
- method: string;
105
- }, TData, TParams = {}, TPageParam = {}, TError = DefaultError> = FetchInfiniteQueryOptionsBase<TSchema, TData, TParams, TPageParam, TError> & {
106
- /**
107
- * Fetch Queries by parameters
108
- */
109
- parameters?: TParams;
110
- queryKey?: never;
111
- };
112
- type FetchInfiniteQueryOptionsQueryFn<TSchema extends {
113
- url: string;
114
- method: string;
115
- }, TData, TParams = {}> = {
116
- queryFn?: QueryFunction<TData, ServiceOperationInfiniteQueryKey<TSchema, TParams>>;
117
- } | {
118
- requestFn: RequestFn<TData>;
119
- /**
120
- * Base URL to use for the request (used in the `queryFn`)
121
- * @example 'https://api.example.com'
122
- */
123
- baseUrl: string | undefined;
124
- queryFn?: never;
125
- };
126
- interface ServiceOperationFetchInfiniteQuery<TSchema extends {
127
- url: string;
128
- method: string;
129
- }, TData, TParams = {}, TError = DefaultError> {
130
- fetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<InfiniteData<TData, TPageParam>>;
131
- prefetchInfiniteQuery<TPageParam extends TParams>(options: (FetchInfiniteQueryOptionsByQueryKey<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>) | (FetchInfiniteQueryOptionsByParameters<TSchema, TData, TParams, TPageParam, TError> & FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>), queryClient: QueryClient): Promise<void>;
132
- }
133
- interface ServiceOperationUseQueries<TSchema extends {
134
- url: string;
135
- method: string;
136
- }, TData, TParams = {}, TError = DefaultError> {
137
- useQueries<TCombinedResult = Array<UseQueryResult<TData, TError>>>(options: {
138
- queries: ReadonlyArray<Omit<UseQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'placeholderData' | 'suspense' | 'queryKey'> & {
139
- placeholderData?: TData | QueriesPlaceholderDataFunction<TData>;
140
- } & ({
141
- parameters: TParams;
142
- queryKey?: never;
143
- } | {
144
- queryKey: ServiceOperationQueryKey<TSchema, TParams>;
145
- })>;
146
- combine?: (results: Array<UseQueryResult<TData, TError>>) => TCombinedResult;
147
- }, queryClient?: QueryClient): TCombinedResult;
148
- }
149
- type QueryTypeFilter = 'all' | 'active' | 'inactive';
150
- interface QueryFiltersBase<TSchema extends {
151
- url: string;
152
- method: string;
153
- }, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> {
154
- /**
155
- * Include queries matching this predicate function
156
- */
157
- predicate?: TInfinite extends true ? QueryFilterInfinitePredicate<TSchema, TData, TParams, TError> : TInfinite extends false ? QueryFilterRegularPredicate<TSchema, TData, TParams, TError> : (query: string) => boolean;
158
- /**
159
- * Filter to active queries, inactive queries or all queries
160
- */
161
- type?: QueryTypeFilter;
162
- /**
163
- * Match query key exactly
164
- */
165
- exact?: boolean;
166
- /**
167
- * Include or exclude stale queries
168
- */
169
- stale?: boolean;
170
- /**
171
- * Include queries matching their fetchStatus
172
- */
173
- fetchStatus?: FetchStatus;
174
- }
175
- interface QueryFiltersByQueryKey<TSchema extends {
176
- url: string;
177
- method: string;
178
- }, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
179
- /**
180
- * Include queries matching this query key
181
- */
182
- queryKey?: ServiceOperationBaseQueryKey<TSchema, TInfinite, TParams>;
183
- infinite?: never;
184
- parameters?: never;
185
- }
186
- interface QueryFiltersByParameters<TSchema extends {
187
- url: string;
188
- method: string;
189
- }, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
190
- /**
191
- * Is the query infinite
192
- */
193
- infinite?: TInfinite;
194
- /**
195
- * Include queries matching parameters
196
- */
197
- parameters?: TParams;
198
- queryKey?: never;
199
- }
200
- interface QueryFilterInfinitePredicate<TSchema extends {
201
- url: string;
202
- method: string;
203
- }, TData, TParams = {}, TError = DefaultError> {
204
- /**
205
- * Include queries matching this predicate function
206
- */
207
- (query: Query<InfiniteData<TData, TParams>, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>>): boolean;
208
- }
209
- interface QueryFilterRegularPredicate<TSchema extends {
210
- url: string;
211
- method: string;
212
- }, TData, TParams = {}, TError = DefaultError> {
213
- /**
214
- * Include queries matching this predicate function
215
- */
216
- (query: Query<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>): boolean;
217
- }
218
- type InvalidateQueryFilters<TSchema extends {
219
- url: string;
220
- method: string;
221
- }, TData, TInfinite extends boolean, TParams = {}, TError = DefaultError> = (QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>) & {
222
- refetchType?: QueryTypeFilter | 'none';
223
- };
224
- interface ServiceOperationInvalidateQueries<TSchema extends {
225
- url: string;
226
- method: string;
227
- }, TData, TParams = {}, TError = DefaultError> {
228
- invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>, options: InvalidateOptions, queryClient: QueryClient): Promise<void>;
229
- invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
230
- invalidateQueries(queryClient: QueryClient): Promise<void>;
231
- }
232
- /**
233
- * @internal
234
- */
235
- export interface ServiceOperationInvalidateQueriesCallback<TSchema extends {
236
- url: string;
237
- method: string;
238
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError> {
239
- invalidateQueries<TInfinite extends boolean>(filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: InvalidateOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
240
- }
241
- interface ServiceOperationCancelQueries<TSchema extends {
242
- url: string;
243
- method: string;
244
- }, TData, TParams = {}, TError = DefaultError> {
245
- cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: CancelOptions, queryClient: QueryClient): Promise<void>;
246
- cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
247
- cancelQueries(queryClient: QueryClient): Promise<void>;
248
- }
249
- /**
250
- * @internal
251
- */
252
- export interface ServiceOperationCancelQueriesCallback<TSchema extends {
253
- url: string;
254
- method: string;
255
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationCancelQueries<TSchema, TData, TParams, TError> {
256
- cancelQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: CancelOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
257
- }
258
- interface ServiceOperationRemoveQueries<TSchema extends {
259
- url: string;
260
- method: string;
261
- }, TData, TParams = {}, TError = DefaultError> {
262
- removeQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): void;
263
- removeQueries(queryClient: QueryClient): void;
264
- }
1
+ import type { DefaultError } from '@tanstack/query-core';
2
+ import type { ServiceOperationQuery as ServiceOperationQueryBase, ServiceOperationMutation as ServiceOperationMutationBase } from './service-operation/ServiceOperation.js';
3
+ import type { ServiceOperationInfiniteQueryKey as ServiceOperationInfiniteQueryKeyBase, ServiceOperationMutationKey as ServiceOperationMutationKeyBase, ServiceOperationQueryKey as ServiceOperationQueryKeyBase } from './service-operation/ServiceOperationKey.js';
4
+ import type { ServiceOperationMutationFn as ServiceOperationMutationFnBase } from './service-operation/ServiceOperationMutationFn.js';
265
5
  /**
266
- * @internal
6
+ * @deprecated Use `ServiceOperationMutationFn` from `@openapi-qraft/react/service-operation/ServiceOperationMutationFn` instead.
267
7
  */
268
- export interface ServiceOperationRemoveQueriesCallback<TSchema extends {
269
- url: string;
270
- method: string;
271
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationRemoveQueries<TSchema, TData, TParams, TError> {
272
- removeQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, queryClient?: QueryClient): void;
273
- }
274
- interface ServiceOperationResetQueries<TSchema extends {
8
+ export type ServiceOperationMutationFn<TSchema extends {
275
9
  url: string;
276
10
  method: string;
277
- }, TData, TParams = {}, TError = DefaultError> {
278
- resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: ResetOptions, queryClient: QueryClient): Promise<void>;
279
- resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
280
- resetQueries(queryClient: QueryClient): Promise<void>;
281
- }
11
+ }, TBody, TData, TParams> = ServiceOperationMutationFnBase<TSchema, TBody, TData, TParams>;
282
12
  /**
283
- * @internal
13
+ * @deprecated Use `ServiceOperationQuery` from `@openapi-qraft/react` instead.
284
14
  */
285
- export interface ServiceOperationResetQueriesCallback<TSchema extends {
286
- url: string;
287
- method: string;
288
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
289
- resetQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: ResetOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
290
- }
291
- interface ServiceOperationRefetchQueries<TSchema extends {
15
+ export type ServiceOperationQuery<TSchema extends {
292
16
  url: string;
293
17
  method: string;
294
- }, TData, TParams = {}, TError = DefaultError> {
295
- refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, options: RefetchOptions, queryClient: QueryClient): Promise<void>;
296
- refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): Promise<void>;
297
- refetchQueries(queryClient: QueryClient): Promise<void>;
298
- }
18
+ }, TData, TParams, TError = DefaultError> = ServiceOperationQueryBase<TSchema, TData, TParams, TError>;
299
19
  /**
300
- * @internal
20
+ * @deprecated Use `ServiceOperationMutation` from `@openapi-qraft/react` instead.
301
21
  */
302
- export interface ServiceOperationResetQueriesCallback<TSchema extends {
303
- url: string;
304
- method: string;
305
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationRefetchQueries<TSchema, TData, TParams, TError> {
306
- refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, options?: RefetchOptions | QueryClient, queryClient?: QueryClient): Promise<void>;
307
- }
308
- interface ServiceOperationIsFetchingQueries<TSchema extends {
22
+ export type ServiceOperationMutation<TSchema extends {
309
23
  url: string;
310
24
  method: string;
311
- }, TData, TParams = {}, TError = DefaultError> {
312
- isFetching<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): number;
313
- isFetching(queryClient: QueryClient): number;
314
- }
25
+ }, TBody, TData, TParams, TError = DefaultError> = ServiceOperationMutationBase<TSchema, TBody, TData, TParams, TError>;
315
26
  /**
316
- * @internal
27
+ * @deprecated Use `ServiceOperationQueryKey` from `@openapi-qraft/react/service-operation/ServiceOperationKey` instead.
317
28
  */
318
- export interface ServiceOperationIsFetchingQueriesCallback<TSchema extends {
319
- url: string;
320
- method: string;
321
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
322
- refetchQueries<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError> | QueryClient, queryClient?: QueryClient): number;
323
- }
324
- interface ServiceOperationUseIsFetchingQueries<TSchema extends {
325
- url: string;
326
- method: string;
327
- }, TData, TParams = {}, TError = DefaultError> {
328
- useIsFetching<TInfinite extends boolean>(filters?: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient?: QueryClient): number;
329
- }
330
- interface ServiceOperationUseSuspenseQueries<TSchema extends {
331
- url: string;
332
- method: string;
333
- }, TData, TParams = {}, TError = DefaultError> {
334
- useSuspenseQueries<TCombinedResult = Array<UseSuspenseQueryResult<TData, TError>>>(options: {
335
- queries: ReadonlyArray<Omit<UseSuspenseQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'> & ({
336
- parameters: TParams;
337
- queryKey?: never;
338
- } | {
339
- queryKey: ServiceOperationQueryKey<TSchema, TParams>;
340
- })>;
341
- combine?: (results: Array<UseSuspenseQueryResult<TData, TError>>) => TCombinedResult;
342
- }, queryClient?: QueryClient): TCombinedResult;
343
- }
344
- interface ServiceOperationUseInfiniteQuery<TSchema extends {
345
- url: string;
346
- method: string;
347
- }, TData, TParams = {}, TError = DefaultError> {
348
- getInfiniteQueryKey<TQueryKeyParams extends TParams>(parameters: TQueryKeyParams): ServiceOperationInfiniteQueryKey<TSchema, TQueryKeyParams>;
349
- useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UndefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
350
- useInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<DefinedInitialDataInfiniteOptions<TData, TError, InfiniteData<TData, TParams>, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): DefinedUseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
351
- }
352
- interface ServiceOperationUseSuspenseInfiniteQuery<TSchema extends {
353
- url: string;
354
- method: string;
355
- }, TData, TParams = {}, TError = DefaultError> {
356
- useSuspenseInfiniteQuery<TPageParam extends TParams>(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, options: Omit<UseSuspenseInfiniteQueryOptions<TData, TError, InfiniteData<TData, TParams>, TData, ServiceOperationInfiniteQueryKey<TSchema, TParams>, PartialParameters<TPageParam>>, 'queryKey' | 'getPreviousPageParam' | 'getNextPageParam' | 'initialPageParam'> & InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>, queryClient?: QueryClient): UseSuspenseInfiniteQueryResult<InfiniteData<TData, TParams>, TError | Error>;
357
- }
358
- interface ServiceOperationUseSuspenseQueryQuery<TSchema extends {
359
- url: string;
360
- method: string;
361
- }, TData, TParams = {}, TError = DefaultError> {
362
- useSuspenseQuery(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, options?: Omit<UseSuspenseQueryOptions<TData, TError, TData, ServiceOperationQueryKey<TSchema, TParams>>, 'queryKey'>, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError | Error>;
363
- }
364
- export interface ServiceOperationMutation<TSchema extends {
365
- url: string;
366
- method: string;
367
- }, TBody, TData, TParams, TError = DefaultError> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>, ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>, ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError>, ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
368
- schema: TSchema;
369
- types: {
370
- parameters: TParams;
371
- data: TData;
372
- error: TError;
373
- body: TBody;
374
- };
375
- }
376
- interface ServiceOperationUseMutation<TSchema extends {
377
- url: string;
378
- method: string;
379
- }, TBody, TData, TParams, TError = DefaultError> {
380
- getMutationKey<TMutationKeyParams extends TParams | undefined = undefined>(parameters?: TMutationKeyParams): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
381
- useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters?: undefined, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'> & {
382
- mutationKey?: ServiceOperationMutationKey<TSchema, TParams>;
383
- }, queryClient?: QueryClient): UseMutationResult<TData, TError | Error, TVariables, TContext>;
384
- useMutation<TVariables extends TBody, TContext = unknown>(parameters: TParams, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>, queryClient?: QueryClient): UseMutationResult<TData, TError | Error, TVariables, TContext>;
385
- }
386
- interface UseMutationStateFiltersBase<TBody, TData, TParams, TError = DefaultError, TContext = unknown> {
387
- /**
388
- * Match mutation key exactly
389
- */
390
- exact?: boolean;
391
- /**
392
- * Include mutations matching this predicate function
393
- */
394
- predicate?: (mutation: Mutation<TData, TError, MutationVariables<TBody, TParams>, TContext>) => boolean;
395
- /**
396
- * Filter by mutation status
397
- */
398
- status?: MutationStatus;
399
- }
400
- interface MutationFiltersByParameters<TBody, TData, TParams, TError = DefaultError, TContext = unknown> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
401
- /**
402
- * Include mutations matching these parameters
403
- */
404
- parameters?: PartialParameters<TParams>;
405
- mutationKey?: never;
406
- }
407
- interface MutationFiltersByMutationKey<TSchema extends {
408
- url: string;
409
- method: string;
410
- }, TBody, TData, TParams, TError = DefaultError, TContext = unknown> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
411
- /**
412
- * Include mutations matching this mutation key
413
- */
414
- mutationKey?: ServiceOperationMutationKey<TSchema, PartialParameters<TParams>>;
415
- parameters?: never;
416
- }
417
- type MutationVariables<TBody, TParams> = {
418
- body: TBody;
419
- } & (NonNullable<TParams> extends never ? {} : TParams);
420
- interface ServiceOperationUseMutationState<TSchema extends {
421
- url: string;
422
- method: string;
423
- }, TBody, TData, TParams, TError = DefaultError> {
424
- useMutationState<TContext = unknown, TResult = MutationState<TData, TError, MutationVariables<TBody, TParams>, TContext>>(options?: {
425
- filters?: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>;
426
- select?: (mutation: Mutation<TData, TError, MutationVariables<TBody, TParams>, TContext>) => TResult;
427
- }, queryClient?: QueryClient): Array<TResult>;
428
- }
429
- interface ServiceOperationUseIsMutating<TSchema extends {
430
- url: string;
431
- method: string;
432
- }, TBody, TData, TParams, TError = DefaultError> {
433
- useIsMutating<TContext = unknown>(filters?: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>, queryClient?: QueryClient): number;
434
- }
435
- interface QueryFnOptionsBase<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> {
436
- signal?: TSignal;
437
- meta?: TMeta;
438
- }
439
- interface QueryFnOptionsByParameters<TParams, TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> extends QueryFnOptionsBase<TMeta, TSignal> {
440
- parameters: TParams;
441
- queryKey?: never;
442
- }
443
- interface QueryFnOptionsByQueryKey<TSchema extends {
444
- url: string;
445
- method: string;
446
- }, TParams, TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal> extends QueryFnOptionsBase<TMeta, TSignal> {
447
- queryKey: ServiceOperationQueryKey<TSchema, TParams>;
448
- }
449
- interface ServiceOperationQueryFn<TSchema extends {
450
- url: string;
451
- method: string;
452
- }, TData, TParams> {
453
- queryFn<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal>(options: QueryFnOptionsByParameters<TParams, TMeta, TSignal> | QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>, client: (schema: TSchema, options: {
454
- parameters: TParams;
455
- signal?: TSignal;
456
- meta?: TMeta;
457
- }) => TData): TData;
458
- queryFn<TMeta extends Record<string, any>, TSignal extends AbortSignal = AbortSignal>(options: QueryFnOptionsByParameters<TParams, TMeta, TSignal> | QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>, client: (schema: TSchema, options: {
459
- parameters: TParams;
460
- signal?: TSignal;
461
- meta?: TMeta;
462
- }) => Promise<TData>): Promise<TData>;
463
- }
464
- interface ServiceOperationSetQueryData<TSchema extends {
465
- url: string;
466
- method: string;
467
- }, TData, TParams = {}> {
468
- setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions, queryClient: QueryClient): TData | undefined;
469
- setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, queryClient: QueryClient): TData | undefined;
470
- }
471
- /**
472
- * @internal
473
- */
474
- export interface ServiceOperationSetQueryDataCallback<TSchema extends {
475
- url: string;
476
- method: string;
477
- }, TData, TParams = {}> extends ServiceOperationSetQueryData<TSchema, TData, TParams> {
478
- setQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions | QueryClient, queryClient?: QueryClient): TData | undefined;
479
- }
480
- interface ServiceOperationSetQueriesData<TSchema extends {
481
- url: string;
482
- method: string;
483
- }, TData, TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
484
- TError = DefaultError> {
485
- setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions, queryClient: QueryClient): Array<TData | undefined>;
486
- setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, queryClient: QueryClient): Array<TData | undefined>;
487
- }
488
- /**
489
- * @internal
490
- */
491
- export interface ServiceOperationSetQueriesDataCallback<TSchema extends {
492
- url: string;
493
- method: string;
494
- }, TData, TParams = {}, TError = DefaultError> extends ServiceOperationSetQueriesData<TSchema, TData, TParams, TError> {
495
- setQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>, options: SetDataOptions | QueryClient, queryClient?: QueryClient): Array<TData | undefined>;
496
- }
497
- interface ServiceOperationGetQueriesData<TSchema extends {
498
- url: string;
499
- method: string;
500
- }, TData, TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
501
- TError = DefaultError> {
502
- getQueriesData<TInfinite extends boolean>(filters: QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError> | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>, queryClient: QueryClient): TInfinite extends true ? Array<[
503
- queryKey: ServiceOperationInfiniteQueryKey<TSchema, TParams>,
504
- data: NoInfer<InfiniteData<TData, TParams>> | undefined
505
- ]> : Array<[
506
- queryKey: ServiceOperationQueryKey<TSchema, TParams>,
507
- data: TData | undefined
508
- ]>;
509
- }
510
- interface ServiceOperationSetInfiniteQueryData<TSchema extends {
511
- url: string;
512
- method: string;
513
- }, TData, TParams = {}> {
514
- setInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, updater: Updater<NoInfer<InfiniteData<TData, TParams>> | undefined, NoInfer<InfiniteData<TData, TParams>> | undefined>, queryClient: QueryClient, options?: SetDataOptions): InfiniteData<TData, TParams> | undefined;
515
- }
516
- interface ServiceOperationGetQueryData<TSchema extends {
517
- url: string;
518
- method: string;
519
- }, TData, TParams = {}> {
520
- getQueryData(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, queryClient: QueryClient): TData | undefined;
521
- }
522
- interface ServiceOperationGetInfiniteQueryData<TSchema extends {
523
- url: string;
524
- method: string;
525
- }, TData, TParams = {}> {
526
- getInfiniteQueryData(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, queryClient: QueryClient): InfiniteData<TData, TParams> | undefined;
527
- }
528
- interface ServiceOperationGetQueryState<TSchema extends {
529
- url: string;
530
- method: string;
531
- }, TData, TParams = {}, TError = DefaultError> {
532
- getQueryState(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>, queryClient: QueryClient): QueryState<TData, TError> | undefined;
533
- getInfiniteQueryState(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>, queryClient: QueryClient): QueryState<InfiniteData<TData, PartialParameters<TParams>>, TError> | undefined;
534
- }
535
- export interface ServiceOperationMutationFn<TSchema extends {
536
- url: string;
537
- method: string;
538
- }, TBody, TData, TParams> {
539
- mutationFn(client: (schema: TSchema, options: {
540
- parameters: TParams;
541
- body: TBody;
542
- }) => TData, options: {
543
- parameters: TParams;
544
- body: TBody;
545
- }): TData;
546
- mutationFn(client: (schema: TSchema, options: {
547
- parameters: TParams;
548
- body: TBody;
549
- }) => Promise<TData>, options: {
550
- parameters: TParams;
551
- body: TBody;
552
- }): Promise<TData>;
553
- }
554
- interface ServiceOperationIsMutatingQueries<TSchema extends {
29
+ export type ServiceOperationQueryKey<S extends {
555
30
  url: string;
556
31
  method: string;
557
- }, TBody, TData, TParams = {}, TError = DefaultError> {
558
- isMutating<TContext>(filters: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext>, queryClient: QueryClient): number;
559
- isMutating(queryClient: QueryClient): number;
560
- }
32
+ }, T> = ServiceOperationQueryKeyBase<S, T>;
561
33
  /**
562
- * @internal
34
+ * @deprecated Use `ServiceOperationInfiniteQueryKey` from `@openapi-qraft/react/service-operation/ServiceOperationKey` instead.
563
35
  */
564
- export interface ServiceOperationIsMutatingQueriesCallback<TSchema extends {
36
+ export type ServiceOperationInfiniteQueryKey<S extends {
565
37
  url: string;
566
38
  method: string;
567
- }, TBody, TData, TParams = {}, TError = DefaultError> extends ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError> {
568
- isMutating<TContext>(filters: MutationFiltersByParameters<TBody, TData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TData, TParams, TError, TContext> | QueryClient, queryClient?: QueryClient): number;
569
- }
39
+ }, T> = ServiceOperationInfiniteQueryKeyBase<S, T>;
570
40
  /**
571
- * Shallow partial 'parameters'.
572
- * @example
573
- * ```ts
574
- * {query?: {page: number, nested: {still: 'not_partial'}}}
575
- * // =>
576
- * {query?: {page?: number, nested?: {still: 'not_partial'}}}
577
- * ```
41
+ * @deprecated Use `ServiceOperationMutationKey` from `@openapi-qraft/react/service-operation/ServiceOperationKey` instead.
578
42
  */
579
- type PartialParameters<T> = T extends object ? {
580
- [K in keyof T]?: T[K] extends object ? Partial<T[K]> : T[K];
581
- } : T;
582
- export {};
43
+ export type ServiceOperationMutationKey<S extends Record<'url' | 'method', string>, T> = ServiceOperationMutationKeyBase<S, T>;
583
44
  //# sourceMappingURL=ServiceOperation.d.ts.map