@openapi-qraft/react 1.3.2 → 1.5.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 (84) hide show
  1. package/CHANGELOG.md +25 -1
  2. package/README.md +17 -17
  3. package/dist/ServiceOperation.d.ts +146 -40
  4. package/dist/ServiceOperation.d.ts.map +1 -1
  5. package/dist/callbacks/getInfiniteQueryState.d.ts +5 -0
  6. package/dist/callbacks/getInfiniteQueryState.d.ts.map +1 -0
  7. package/dist/callbacks/getInfiniteQueryState.js +5 -0
  8. package/dist/callbacks/getInfiniteQueryState.js.map +1 -0
  9. package/dist/callbacks/getQueriesData.d.ts +5 -0
  10. package/dist/callbacks/getQueriesData.d.ts.map +1 -0
  11. package/dist/callbacks/getQueriesData.js +5 -0
  12. package/dist/callbacks/getQueriesData.js.map +1 -0
  13. package/dist/callbacks/getQueryState.d.ts +5 -0
  14. package/dist/callbacks/getQueryState.d.ts.map +1 -0
  15. package/dist/callbacks/getQueryState.js +5 -0
  16. package/dist/callbacks/getQueryState.js.map +1 -0
  17. package/dist/callbacks/isMutating.d.ts +5 -0
  18. package/dist/callbacks/isMutating.d.ts.map +1 -0
  19. package/dist/callbacks/isMutating.js +5 -0
  20. package/dist/callbacks/isMutating.js.map +1 -0
  21. package/dist/callbacks/removeQueries.d.ts +5 -0
  22. package/dist/callbacks/removeQueries.d.ts.map +1 -0
  23. package/dist/callbacks/removeQueries.js +5 -0
  24. package/dist/callbacks/removeQueries.js.map +1 -0
  25. package/dist/callbacks/setQueriesData.d.ts +5 -0
  26. package/dist/callbacks/setQueriesData.d.ts.map +1 -0
  27. package/dist/callbacks/setQueriesData.js +5 -0
  28. package/dist/callbacks/setQueriesData.js.map +1 -0
  29. package/dist/callbacks/useIsFetching.js.map +1 -1
  30. package/dist/callbacks/useIsMutating.d.ts +7 -0
  31. package/dist/callbacks/useIsMutating.d.ts.map +1 -0
  32. package/dist/callbacks/useIsMutating.js +9 -0
  33. package/dist/callbacks/useIsMutating.js.map +1 -0
  34. package/dist/callbacks/useMutationState.d.ts.map +1 -1
  35. package/dist/callbacks/useMutationState.js +2 -15
  36. package/dist/callbacks/useMutationState.js.map +1 -1
  37. package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts +11 -0
  38. package/dist/lib/callQueryClientMethodWithMutationFilters.d.ts.map +1 -0
  39. package/dist/lib/callQueryClientMethodWithMutationFilters.js +18 -0
  40. package/dist/lib/callQueryClientMethodWithMutationFilters.js.map +1 -0
  41. package/dist/lib/callQueryClientMethodWithQueryFilters.js +1 -1
  42. package/dist/lib/callQueryClientMethodWithQueryFilters.js.map +1 -1
  43. package/dist/lib/callQueryClientMethodWithQueryKey.js +1 -1
  44. package/dist/lib/callQueryClientMethodWithQueryKey.js.map +1 -1
  45. package/dist/lib/composeBaseQueryKey.d.ts +6 -0
  46. package/dist/lib/composeBaseQueryKey.d.ts.map +1 -0
  47. package/dist/lib/composeBaseQueryKey.js +7 -0
  48. package/dist/lib/composeBaseQueryKey.js.map +1 -0
  49. package/dist/lib/composeInfiniteQueryKey.d.ts.map +1 -1
  50. package/dist/lib/composeInfiniteQueryKey.js +2 -1
  51. package/dist/lib/composeInfiniteQueryKey.js.map +1 -1
  52. package/dist/lib/composeMutationFilters.d.ts +11 -0
  53. package/dist/lib/composeMutationFilters.d.ts.map +1 -0
  54. package/dist/lib/composeMutationFilters.js +32 -0
  55. package/dist/lib/composeMutationFilters.js.map +1 -0
  56. package/dist/lib/composeMutationKey.js +1 -1
  57. package/dist/lib/composeMutationKey.js.map +1 -1
  58. package/dist/lib/composeQueryFilters.d.ts +5 -2
  59. package/dist/lib/composeQueryFilters.d.ts.map +1 -1
  60. package/dist/lib/composeQueryFilters.js +17 -11
  61. package/dist/lib/composeQueryFilters.js.map +1 -1
  62. package/dist/lib/composeQueryKey.d.ts.map +1 -1
  63. package/dist/lib/composeQueryKey.js +2 -1
  64. package/dist/lib/composeQueryKey.js.map +1 -1
  65. package/package.json +4 -3
  66. package/src/ServiceOperation.ts +344 -84
  67. package/src/callbacks/getInfiniteQueryState.ts +23 -0
  68. package/src/callbacks/getQueriesData.ts +18 -0
  69. package/src/callbacks/getQueryState.ts +19 -0
  70. package/src/callbacks/isMutating.ts +22 -0
  71. package/src/callbacks/removeQueries.ts +22 -0
  72. package/src/callbacks/setQueriesData.ts +22 -0
  73. package/src/callbacks/useIsFetching.ts +1 -1
  74. package/src/callbacks/useIsMutating.ts +42 -0
  75. package/src/callbacks/useMutationState.ts +2 -27
  76. package/src/lib/callQueryClientMethodWithMutationFilters.ts +37 -0
  77. package/src/lib/callQueryClientMethodWithQueryFilters.ts +1 -1
  78. package/src/lib/callQueryClientMethodWithQueryKey.ts +1 -1
  79. package/src/lib/composeBaseQueryKey.ts +34 -0
  80. package/src/lib/composeInfiniteQueryKey.ts +2 -1
  81. package/src/lib/composeMutationFilters.ts +44 -0
  82. package/src/lib/composeMutationKey.ts +1 -1
  83. package/src/lib/composeQueryFilters.ts +24 -16
  84. package/src/lib/composeQueryKey.ts +2 -1
@@ -1,3 +1,5 @@
1
+ import { composeBaseQueryKey } from './composeBaseQueryKey.js';
2
+ import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
1
3
  import { composeQueryKey } from './composeQueryKey.js';
2
4
  /**
3
5
  * Replaces the `parameters` field in the filters with a `queryKey` field based on the schema.
@@ -8,25 +10,29 @@ import { composeQueryKey } from './composeQueryKey.js';
8
10
  export function composeQueryFilters(schema, filters) {
9
11
  if (!filters) {
10
12
  return {
11
- queryKey: composeQueryKey(schema, undefined),
13
+ queryKey: composeBaseQueryKey(schema, undefined, undefined),
12
14
  };
13
15
  }
14
- if (filters && 'queryKey' in filters && 'parameters' in filters) {
16
+ if ('queryKey' in filters && 'parameters' in filters) {
15
17
  throw new Error(`'composeQueryFilters': 'queryKey' and 'parameters' cannot be used together`);
16
18
  }
17
- if ('queryKey' in filters) {
18
- return filters;
19
+ const { infinite, parameters, ...filtersRest } = filters;
20
+ if ('queryKey' in filtersRest) {
21
+ return filtersRest;
19
22
  }
20
- if ('parameters' in filters) {
21
- const { parameters, ...filtersWithoutParameters } = filters;
22
- Object.assign(filtersWithoutParameters, {
23
- queryKey: composeQueryKey(schema, parameters),
23
+ if (parameters) {
24
+ Object.assign(filtersRest, {
25
+ queryKey: infinite
26
+ ? composeInfiniteQueryKey(schema, parameters)
27
+ : composeQueryKey(schema, parameters),
24
28
  });
25
- return filtersWithoutParameters;
29
+ return filtersRest;
26
30
  }
27
31
  return {
28
- ...filters,
29
- queryKey: composeQueryKey(schema, undefined),
32
+ ...filtersRest,
33
+ queryKey: infinite
34
+ ? composeInfiniteQueryKey(schema, undefined)
35
+ : composeQueryKey(schema, undefined),
30
36
  };
31
37
  }
32
38
  //# sourceMappingURL=composeQueryFilters.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"composeQueryFilters.js","sourceRoot":"","sources":["../../src/lib/composeQueryFilters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAuB,EACvB,OAA4B;IAE5B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;YACL,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,IAAI,UAAU,IAAI,OAAO,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,EAAE,UAAU,EAAE,GAAG,wBAAwB,EAAE,GAAG,OAAO,CAAC;QAE5D,MAAM,CAAC,MAAM,CAAC,wBAAwB,EAAE;YACtC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC;SAC9C,CAAC,CAAC;QAEH,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,OAAO;QACL,GAAG,OAAO;QACV,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;KAC7C,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"composeQueryFilters.js","sourceRoot":"","sources":["../../src/lib/composeQueryFilters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAKjC,MAAuB,EAAE,OAA4B;IACrD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;YACL,QAAQ,EAAE,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC;SAC5D,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,IAAI,OAAO,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IAEzD,IAAI,UAAU,IAAI,WAAW,EAAE,CAAC;QAC9B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;YACzB,QAAQ,EAAE,QAAQ;gBAChB,CAAC,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,CAAC;gBAC7C,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC;SACxC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO;QACL,GAAG,WAAW;QACd,QAAQ,EAAE,QAAQ;YAChB,CAAC,CAAC,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC;YAC5C,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;KACvC,CAAC;AACJ,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"composeQueryKey.d.ts","sourceRoot":"","sources":["../../src/lib/composeQueryKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD,wBAAgB,eAAe,CAAC,OAAO,SAAS,eAAe,EAAE,OAAO,EACtE,MAAM,EAAE,OAAO,EACf,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAE5C"}
1
+ {"version":3,"file":"composeQueryKey.d.ts","sourceRoot":"","sources":["../../src/lib/composeQueryKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAEvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD,wBAAgB,eAAe,CAAC,OAAO,SAAS,eAAe,EAAE,OAAO,EACtE,MAAM,EAAE,OAAO,EACf,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAE5C"}
@@ -1,4 +1,5 @@
1
+ import { composeBaseQueryKey } from './composeBaseQueryKey.js';
1
2
  export function composeQueryKey(schema, parameters) {
2
- return [schema, parameters ?? {}];
3
+ return composeBaseQueryKey(schema, parameters, false);
3
4
  }
4
5
  //# sourceMappingURL=composeQueryKey.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"composeQueryKey.js","sourceRoot":"","sources":["../../src/lib/composeQueryKey.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,eAAe,CAC7B,MAAe,EACf,UAA+B;IAE/B,OAAO,CAAC,MAAM,EAAE,UAAU,IAAK,EAAc,CAAC,CAAC;AACjD,CAAC"}
1
+ {"version":3,"file":"composeQueryKey.js","sourceRoot":"","sources":["../../src/lib/composeQueryKey.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAG/D,MAAM,UAAU,eAAe,CAC7B,MAAe,EACf,UAA+B;IAE/B,OAAO,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openapi-qraft/react",
3
- "version": "1.3.2",
3
+ "version": "1.5.0",
4
4
  "description": "API client for React, providing type-safe requests and dynamic Tanstack Query React Hooks via a modular, Proxy-based architecture.",
5
5
  "scripts": {
6
6
  "build": "rimraf dist/ && tsc --project tsconfig.build.json",
@@ -14,7 +14,7 @@
14
14
  "type": "module",
15
15
  "sideEffects": false,
16
16
  "devDependencies": {
17
- "@openapi-qraft/cli": "~1.3.2",
17
+ "@openapi-qraft/cli": "~1.5.0",
18
18
  "@openapi-qraft/openapi-typescript": "^1.0.0",
19
19
  "@tanstack/react-query": "^5.17.3",
20
20
  "@testing-library/jest-dom": "^5.17.0",
@@ -29,7 +29,7 @@
29
29
  "query-string": "^8.1.0",
30
30
  "react": "^18.2.0",
31
31
  "rimraf": "^5.0.5",
32
- "vitest": "^1.1.3"
32
+ "vitest": "^1.4.0"
33
33
  },
34
34
  "peerDependencies": {
35
35
  "@tanstack/query-core": "^5.0.0",
@@ -62,6 +62,7 @@
62
62
  "bugs": {
63
63
  "url": "https://github.com/OpenAPI-Qraft/openapi-qraft/issues"
64
64
  },
65
+ "homepage": "https://openapi-qraft.github.io/openapi-qraft/",
65
66
  "keywords": [
66
67
  "openapi",
67
68
  "swagger",