@tanstack/vue-query 5.0.0-beta.18 → 5.0.0-beta.22

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 (104) hide show
  1. package/build/legacy/devtools/devtools.cjs.map +1 -1
  2. package/build/legacy/devtools/devtools.js.map +1 -1
  3. package/build/legacy/mutationCache.cjs.map +1 -1
  4. package/build/legacy/mutationCache.d.cts +1 -1
  5. package/build/legacy/mutationCache.d.ts +1 -1
  6. package/build/legacy/mutationCache.js.map +1 -1
  7. package/build/legacy/queryCache.cjs.map +1 -1
  8. package/build/legacy/queryCache.d.cts +1 -1
  9. package/build/legacy/queryCache.d.ts +1 -1
  10. package/build/legacy/queryCache.js.map +1 -1
  11. package/build/legacy/queryClient.cjs.map +1 -1
  12. package/build/legacy/queryClient.d.cts +2 -2
  13. package/build/legacy/queryClient.d.ts +2 -2
  14. package/build/legacy/queryClient.js.map +1 -1
  15. package/build/legacy/useBaseQuery.cjs +7 -0
  16. package/build/legacy/useBaseQuery.cjs.map +1 -1
  17. package/build/legacy/useBaseQuery.js +8 -0
  18. package/build/legacy/useBaseQuery.js.map +1 -1
  19. package/build/legacy/useIsFetching.cjs +13 -9
  20. package/build/legacy/useIsFetching.cjs.map +1 -1
  21. package/build/legacy/useIsFetching.js +14 -10
  22. package/build/legacy/useIsFetching.js.map +1 -1
  23. package/build/legacy/useMutation.cjs +7 -0
  24. package/build/legacy/useMutation.cjs.map +1 -1
  25. package/build/legacy/useMutation.js +8 -0
  26. package/build/legacy/useMutation.js.map +1 -1
  27. package/build/legacy/useMutationState.cjs +7 -0
  28. package/build/legacy/useMutationState.cjs.map +1 -1
  29. package/build/legacy/useMutationState.js +15 -1
  30. package/build/legacy/useMutationState.js.map +1 -1
  31. package/build/legacy/useQueries.cjs +7 -0
  32. package/build/legacy/useQueries.cjs.map +1 -1
  33. package/build/legacy/useQueries.d.cts +6 -4
  34. package/build/legacy/useQueries.d.ts +6 -4
  35. package/build/legacy/useQueries.js +15 -1
  36. package/build/legacy/useQueries.js.map +1 -1
  37. package/build/legacy/useQueryClient.cjs +4 -4
  38. package/build/legacy/useQueryClient.cjs.map +1 -1
  39. package/build/legacy/useQueryClient.js +5 -5
  40. package/build/legacy/useQueryClient.js.map +1 -1
  41. package/build/legacy/utils.cjs.map +1 -1
  42. package/build/legacy/utils.d.cts +1 -1
  43. package/build/legacy/utils.d.ts +1 -1
  44. package/build/legacy/utils.js.map +1 -1
  45. package/build/modern/devtools/devtools.cjs.map +1 -1
  46. package/build/modern/devtools/devtools.js.map +1 -1
  47. package/build/modern/mutationCache.cjs.map +1 -1
  48. package/build/modern/mutationCache.d.cts +1 -1
  49. package/build/modern/mutationCache.d.ts +1 -1
  50. package/build/modern/mutationCache.js.map +1 -1
  51. package/build/modern/queryCache.cjs.map +1 -1
  52. package/build/modern/queryCache.d.cts +1 -1
  53. package/build/modern/queryCache.d.ts +1 -1
  54. package/build/modern/queryCache.js.map +1 -1
  55. package/build/modern/queryClient.cjs.map +1 -1
  56. package/build/modern/queryClient.d.cts +2 -2
  57. package/build/modern/queryClient.d.ts +2 -2
  58. package/build/modern/queryClient.js.map +1 -1
  59. package/build/modern/useBaseQuery.cjs +7 -0
  60. package/build/modern/useBaseQuery.cjs.map +1 -1
  61. package/build/modern/useBaseQuery.js +8 -0
  62. package/build/modern/useBaseQuery.js.map +1 -1
  63. package/build/modern/useIsFetching.cjs +13 -9
  64. package/build/modern/useIsFetching.cjs.map +1 -1
  65. package/build/modern/useIsFetching.js +14 -10
  66. package/build/modern/useIsFetching.js.map +1 -1
  67. package/build/modern/useMutation.cjs +7 -0
  68. package/build/modern/useMutation.cjs.map +1 -1
  69. package/build/modern/useMutation.js +8 -0
  70. package/build/modern/useMutation.js.map +1 -1
  71. package/build/modern/useMutationState.cjs +7 -0
  72. package/build/modern/useMutationState.cjs.map +1 -1
  73. package/build/modern/useMutationState.js +15 -1
  74. package/build/modern/useMutationState.js.map +1 -1
  75. package/build/modern/useQueries.cjs +7 -0
  76. package/build/modern/useQueries.cjs.map +1 -1
  77. package/build/modern/useQueries.d.cts +6 -4
  78. package/build/modern/useQueries.d.ts +6 -4
  79. package/build/modern/useQueries.js +15 -1
  80. package/build/modern/useQueries.js.map +1 -1
  81. package/build/modern/useQueryClient.cjs +4 -3
  82. package/build/modern/useQueryClient.cjs.map +1 -1
  83. package/build/modern/useQueryClient.js +5 -4
  84. package/build/modern/useQueryClient.js.map +1 -1
  85. package/build/modern/utils.cjs.map +1 -1
  86. package/build/modern/utils.d.cts +1 -1
  87. package/build/modern/utils.d.ts +1 -1
  88. package/build/modern/utils.js.map +1 -1
  89. package/package.json +6 -6
  90. package/src/__mocks__/useBaseQuery.ts +1 -1
  91. package/src/__tests__/useMutation.test.ts +3 -3
  92. package/src/__tests__/useQueryClient.test.ts +4 -4
  93. package/src/__tests__/utils.test.ts +1 -1
  94. package/src/devtools/devtools.ts +2 -2
  95. package/src/mutationCache.ts +1 -1
  96. package/src/queryCache.ts +1 -1
  97. package/src/queryClient.ts +2 -2
  98. package/src/useBaseQuery.ts +9 -0
  99. package/src/useIsFetching.ts +16 -10
  100. package/src/useMutation.ts +9 -0
  101. package/src/useMutationState.ts +17 -2
  102. package/src/useQueries.ts +49 -26
  103. package/src/useQueryClient.ts +6 -5
  104. package/src/utils.ts +1 -1
package/build/modern/useQueries.d.cts CHANGED
@@ -43,13 +43,15 @@ type GetResults<T> = T extends {
43
43
  /**
44
44
  * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
45
45
  */
46
- type UseQueriesOptions<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
46
+ type UseQueriesOptions<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryOptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : Array<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
47
47
  /**
48
48
  * UseQueriesResults reducer recursively maps type param to results
49
49
  */
50
- type UseQueriesResults<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>[] ? QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[] : QueryObserverResult[];
51
- type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>];
52
- declare function useQueries<T extends any[], TCombinedResult = UseQueriesResults<T>>({ queries, ...options }: {
50
+ type UseQueriesResults<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<QueryObserverResult> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>> ? Array<QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>> : Array<QueryObserverResult>;
51
+ type UseQueriesOptionsArg<T extends Array<any>> = readonly [
52
+ ...UseQueriesOptions<T>
53
+ ];
54
+ declare function useQueries<T extends Array<any>, TCombinedResult = UseQueriesResults<T>>({ queries, ...options }: {
53
55
  queries: MaybeRefDeep<UseQueriesOptionsArg<T>>;
54
56
  combine?: (result: UseQueriesResults<T>) => TCombinedResult;
55
57
  }, queryClient?: QueryClient): Readonly<Ref<TCombinedResult>>;
package/build/modern/useQueries.d.ts CHANGED
@@ -43,13 +43,15 @@ type GetResults<T> = T extends {
43
43
  /**
44
44
  * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
45
45
  */
46
- type UseQueriesOptions<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
46
+ type UseQueriesOptions<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryOptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : Array<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
47
47
  /**
48
48
  * UseQueriesResults reducer recursively maps type param to results
49
49
  */
50
- type UseQueriesResults<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>[] ? QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[] : QueryObserverResult[];
51
- type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>];
52
- declare function useQueries<T extends any[], TCombinedResult = UseQueriesResults<T>>({ queries, ...options }: {
50
+ type UseQueriesResults<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<QueryObserverResult> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>> ? Array<QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>> : Array<QueryObserverResult>;
51
+ type UseQueriesOptionsArg<T extends Array<any>> = readonly [
52
+ ...UseQueriesOptions<T>
53
+ ];
54
+ declare function useQueries<T extends Array<any>, TCombinedResult = UseQueriesResults<T>>({ queries, ...options }: {
53
55
  queries: MaybeRefDeep<UseQueriesOptionsArg<T>>;
54
56
  combine?: (result: UseQueriesResults<T>) => TCombinedResult;
55
57
  }, queryClient?: QueryClient): Readonly<Ref<TCombinedResult>>;
package/build/modern/useQueries.js CHANGED
@@ -1,12 +1,26 @@
1
1
  // src/useQueries.ts
2
2
  import { QueriesObserver } from "@tanstack/query-core";
3
- import { computed, onScopeDispose, readonly, ref, watch } from "vue-demi";
3
+ import {
4
+ computed,
5
+ getCurrentScope,
6
+ onScopeDispose,
7
+ readonly,
8
+ ref,
9
+ watch
10
+ } from "vue-demi";
4
11
  import { useQueryClient } from "./useQueryClient.js";
5
12
  import { cloneDeepUnref } from "./utils.js";
6
13
  function useQueries({
7
14
  queries,
8
15
  ...options
9
16
  }, queryClient) {
17
+ if (process.env.NODE_ENV === "development") {
18
+ if (!getCurrentScope()) {
19
+ console.warn(
20
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.'
21
+ );
22
+ }
23
+ }
10
24
  const client = queryClient || useQueryClient();
11
25
  const defaultedQueries = computed(
12
26
  () => cloneDeepUnref(queries).map((queryOptions) => {
package/build/modern/useQueries.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/useQueries.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { QueriesObserver } from '@tanstack/query-core'\nimport { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'\n\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type { Ref } from 'vue-demi'\nimport type {\n QueriesObserverOptions,\n QueriesPlaceholderDataFunction,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './useQuery'\nimport type { QueryClient } from './queryClient'\nimport type { DistributiveOmit, MaybeRefDeep } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = DistributiveOmit<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'placeholderData'\n> & {\n placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>\n}\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select: (data: any) => infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, Error, TData, TQueryKey>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> }\n ? UseQueryOptionsForUseQueries<TQueryFnData, Error, TQueryFnData, TQueryKey>\n : // Fallback\n UseQueryOptionsForUseQueries\n\ntype GetResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? QueryObserverResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? QueryObserverResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? QueryObserverResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? QueryObserverResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? QueryObserverResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? QueryObserverResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<unknown, any>\n select: (data: any) => infer TData\n }\n ? QueryObserverResult<TData>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, any> }\n ? QueryObserverResult<TQueryFnData>\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends any[],\n Result extends any[] = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? UseQueryOptionsForUseQueries[]\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>\n : unknown[] extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >[]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[]\n : // Fallback\n UseQueryOptionsForUseQueries[]\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends any[],\n Result extends any[] = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? QueryObserverResult[]\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>\n : T extends UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >[]\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[]\n : // Fallback\n QueryObserverResult[]\n\ntype UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>]\n\nexport function useQueries<\n T extends any[],\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: {\n queries: MaybeRefDeep<UseQueriesOptionsArg<T>>\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() =>\n cloneDeepUnref(queries).map((queryOptions) => {\n const defaulted = client.defaultQueryOptions(queryOptions)\n defaulted._optimisticResults = client.isRestoring.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n }),\n )\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n const [, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n const state = ref(getCombinedResult()) as Ref<TCombinedResult>\n\n let unsubscribe = () => {\n // noop\n }\n\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n const [, getCombinedResultRestoring] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultRestoring()\n })\n // Subscription would not fire for persisted results\n const [, getCombinedResultPersisted] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultPersisted()\n }\n },\n { immediate: true },\n )\n\n watch(defaultedQueries, () => {\n observer.setQueries(\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n const [, getCombinedResultPersisted] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultPersisted()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return readonly(state) as Readonly<Ref<TCombinedResult>>\n}\n"],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,UAAU,gBAAgB,UAAU,KAAK,aAAa;AAE/D,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AA+IxB,SAAS,WAId;AAAA,EACE;AAAA,EACA,GAAG;AACL,GAIA,aACgC;AAChC,QAAM,SAAS,eAAe,eAAe;AAE7C,QAAM,mBAAmB;AAAA,IAAS,MAChC,eAAe,OAAO,EAAE,IAAI,CAAC,iBAAiB;AAC5C,YAAM,YAAY,OAAO,oBAAoB,YAAY;AACzD,gBAAU,qBAAqB,OAAO,YAAY,QAC9C,gBACA;AAEJ,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,IAAI;AAAA,IACnB;AAAA,IACA,iBAAiB;AAAA,IACjB;AAAA,EACF;AACA,QAAM,CAAC,EAAE,iBAAiB,IAAI,SAAS;AAAA,IACrC,iBAAiB;AAAA,EACnB;AACA,QAAM,QAAQ,IAAI,kBAAkB,CAAC;AAErC,MAAI,cAAc,MAAM;AAAA,EAExB;AAEA;AAAA,IACE,OAAO;AAAA,IACP,CAAC,gBAAgB;AACf,UAAI,CAAC,aAAa;AAChB,oBAAY;AACZ,sBAAc,SAAS,UAAU,MAAM;AACrC,gBAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,YAC9C,iBAAiB;AAAA,UACnB;AACA,gBAAM,QAAQ,2BAA2B;AAAA,QAC3C,CAAC;AAED,cAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,UAC9C,iBAAiB;AAAA,QACnB;AACA,cAAM,QAAQ,2BAA2B;AAAA,MAC3C;AAAA,IACF;AAAA,IACA,EAAE,WAAW,KAAK;AAAA,EACpB;AAEA,QAAM,kBAAkB,MAAM;AAC5B,aAAS;AAAA,MACP,iBAAiB;AAAA,MACjB;AAAA,IACF;AACA,UAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,MAC9C,iBAAiB;AAAA,IACnB;AACA,UAAM,QAAQ,2BAA2B;AAAA,EAC3C,CAAC;AAED,iBAAe,MAAM;AACnB,gBAAY;AAAA,EACd,CAAC;AAED,SAAO,SAAS,KAAK;AACvB;","names":[]}
1
+ {"version":3,"sources":["../../src/useQueries.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { QueriesObserver } from '@tanstack/query-core'\nimport {\n computed,\n getCurrentScope,\n onScopeDispose,\n readonly,\n ref,\n watch,\n} from 'vue-demi'\n\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type { Ref } from 'vue-demi'\nimport type {\n QueriesObserverOptions,\n QueriesPlaceholderDataFunction,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './useQuery'\nimport type { QueryClient } from './queryClient'\nimport type { DistributiveOmit, MaybeRefDeep } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = DistributiveOmit<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'placeholderData'\n> & {\n placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>\n}\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select: (data: any) => infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, Error, TData, TQueryKey>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> }\n ? UseQueryOptionsForUseQueries<TQueryFnData, Error, TQueryFnData, TQueryKey>\n : // Fallback\n UseQueryOptionsForUseQueries\n\ntype GetResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? QueryObserverResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? QueryObserverResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? QueryObserverResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? QueryObserverResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? QueryObserverResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? QueryObserverResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<unknown, any>\n select: (data: any) => infer TData\n }\n ? QueryObserverResult<TData>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, any> }\n ? QueryObserverResult<TQueryFnData>\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends Array<any>,\n Result extends Array<any> = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? Array<UseQueryOptionsForUseQueries>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseQueryOptionsForUseQueries>\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends Array<any>,\n Result extends Array<any> = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? Array<QueryObserverResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>\n : T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >\n >\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<\n QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>\n >\n : // Fallback\n Array<QueryObserverResult>\n\ntype UseQueriesOptionsArg<T extends Array<any>> = readonly [\n ...UseQueriesOptions<T>,\n]\n\nexport function useQueries<\n T extends Array<any>,\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: {\n queries: MaybeRefDeep<UseQueriesOptionsArg<T>>\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n if (process.env.NODE_ENV === 'development') {\n if (!getCurrentScope()) {\n console.warn(\n 'vue-query composables like \"uesQuery()\" should only be used inside a \"setup()\" function or a running effect scope. They might otherwise lead to memory leaks.',\n )\n }\n }\n\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() =>\n cloneDeepUnref(queries).map((queryOptions) => {\n const defaulted = client.defaultQueryOptions(queryOptions)\n defaulted._optimisticResults = client.isRestoring.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n }),\n )\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n const [, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n const state = ref(getCombinedResult()) as Ref<TCombinedResult>\n\n let unsubscribe = () => {\n // noop\n }\n\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n const [, getCombinedResultRestoring] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultRestoring()\n })\n // Subscription would not fire for persisted results\n const [, getCombinedResultPersisted] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultPersisted()\n }\n },\n { immediate: true },\n )\n\n watch(defaultedQueries, () => {\n observer.setQueries(\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n const [, getCombinedResultPersisted] = observer.getOptimisticResult(\n defaultedQueries.value,\n )\n state.value = getCombinedResultPersisted()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return readonly(state) as Readonly<Ref<TCombinedResult>>\n}\n"],"mappings":";AACA,SAAS,uBAAuB;AAChC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAuJxB,SAAS,WAId;AAAA,EACE;AAAA,EACA,GAAG;AACL,GAIA,aACgC;AAChC,MAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,QAAI,CAAC,gBAAgB,GAAG;AACtB,cAAQ;AAAA,QACN;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAS,eAAe,eAAe;AAE7C,QAAM,mBAAmB;AAAA,IAAS,MAChC,eAAe,OAAO,EAAE,IAAI,CAAC,iBAAiB;AAC5C,YAAM,YAAY,OAAO,oBAAoB,YAAY;AACzD,gBAAU,qBAAqB,OAAO,YAAY,QAC9C,gBACA;AAEJ,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,IAAI;AAAA,IACnB;AAAA,IACA,iBAAiB;AAAA,IACjB;AAAA,EACF;AACA,QAAM,CAAC,EAAE,iBAAiB,IAAI,SAAS;AAAA,IACrC,iBAAiB;AAAA,EACnB;AACA,QAAM,QAAQ,IAAI,kBAAkB,CAAC;AAErC,MAAI,cAAc,MAAM;AAAA,EAExB;AAEA;AAAA,IACE,OAAO;AAAA,IACP,CAAC,gBAAgB;AACf,UAAI,CAAC,aAAa;AAChB,oBAAY;AACZ,sBAAc,SAAS,UAAU,MAAM;AACrC,gBAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,YAC9C,iBAAiB;AAAA,UACnB;AACA,gBAAM,QAAQ,2BAA2B;AAAA,QAC3C,CAAC;AAED,cAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,UAC9C,iBAAiB;AAAA,QACnB;AACA,cAAM,QAAQ,2BAA2B;AAAA,MAC3C;AAAA,IACF;AAAA,IACA,EAAE,WAAW,KAAK;AAAA,EACpB;AAEA,QAAM,kBAAkB,MAAM;AAC5B,aAAS;AAAA,MACP,iBAAiB;AAAA,MACjB;AAAA,IACF;AACA,UAAM,CAAC,EAAE,0BAA0B,IAAI,SAAS;AAAA,MAC9C,iBAAiB;AAAA,IACnB;AACA,UAAM,QAAQ,2BAA2B;AAAA,EAC3C,CAAC;AAED,iBAAe,MAAM;AACnB,gBAAY;AAAA,EACd,CAAC;AAED,SAAO,SAAS,KAAK;AACvB;","names":[]}
package/build/modern/useQueryClient.cjs CHANGED
@@ -26,9 +26,10 @@ module.exports = __toCommonJS(useQueryClient_exports);
26
26
  var import_vue_demi = require("vue-demi");
27
27
  var import_utils = require("./utils.cjs");
28
28
  function useQueryClient(id = "") {
29
- const vm = (0, import_vue_demi.getCurrentInstance)()?.proxy;
30
- if (!vm) {
31
- throw new Error("vue-query hooks can only be used inside setup() function.");
29
+ if (!(0, import_vue_demi.hasInjectionContext)()) {
30
+ throw new Error(
31
+ "vue-query hooks can only be used inside setup() function or functions that support injection context."
32
+ );
32
33
  }
33
34
  const key = (0, import_utils.getClientKey)(id);
34
35
  const queryClient = (0, import_vue_demi.inject)(key);
package/build/modern/useQueryClient.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/useQueryClient.ts"],"sourcesContent":["import { getCurrentInstance, inject } from 'vue-demi'\n\nimport { getClientKey } from './utils'\nimport type { QueryClient } from './queryClient'\n\nexport function useQueryClient(id = ''): QueryClient {\n const vm = getCurrentInstance()?.proxy\n\n if (!vm) {\n throw new Error('vue-query hooks can only be used inside setup() function.')\n }\n\n const key = getClientKey(id)\n const queryClient = inject<QueryClient>(key)\n\n if (!queryClient) {\n throw new Error(\n \"No 'queryClient' found in Vue context, use 'VueQueryPlugin' to properly initialize the library.\",\n )\n }\n\n return queryClient\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAA2C;AAE3C,mBAA6B;AAGtB,SAAS,eAAe,KAAK,IAAiB;AACnD,QAAM,SAAK,oCAAmB,GAAG;AAEjC,MAAI,CAAC,IAAI;AACP,UAAM,IAAI,MAAM,2DAA2D;AAAA,EAC7E;AAEA,QAAM,UAAM,2BAAa,EAAE;AAC3B,QAAM,kBAAc,wBAAoB,GAAG;AAE3C,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/useQueryClient.ts"],"sourcesContent":["import { hasInjectionContext, inject } from 'vue-demi'\n\nimport { getClientKey } from './utils'\nimport type { QueryClient } from './queryClient'\n\nexport function useQueryClient(id = ''): QueryClient {\n // ensures that `inject()` can be used\n if (!hasInjectionContext()) {\n throw new Error(\n 'vue-query hooks can only be used inside setup() function or functions that support injection context.',\n )\n }\n\n const key = getClientKey(id)\n const queryClient = inject<QueryClient>(key)\n\n if (!queryClient) {\n throw new Error(\n \"No 'queryClient' found in Vue context, use 'VueQueryPlugin' to properly initialize the library.\",\n )\n }\n\n return queryClient\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAA4C;AAE5C,mBAA6B;AAGtB,SAAS,eAAe,KAAK,IAAiB;AAEnD,MAAI,KAAC,qCAAoB,GAAG;AAC1B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,UAAM,2BAAa,EAAE;AAC3B,QAAM,kBAAc,wBAAoB,GAAG;AAE3C,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
package/build/modern/useQueryClient.js CHANGED
@@ -1,10 +1,11 @@
1
1
  // src/useQueryClient.ts
2
- import { getCurrentInstance, inject } from "vue-demi";
2
+ import { hasInjectionContext, inject } from "vue-demi";
3
3
  import { getClientKey } from "./utils.js";
4
4
  function useQueryClient(id = "") {
5
- const vm = getCurrentInstance()?.proxy;
6
- if (!vm) {
7
- throw new Error("vue-query hooks can only be used inside setup() function.");
5
+ if (!hasInjectionContext()) {
6
+ throw new Error(
7
+ "vue-query hooks can only be used inside setup() function or functions that support injection context."
8
+ );
8
9
  }
9
10
  const key = getClientKey(id);
10
11
  const queryClient = inject(key);
package/build/modern/useQueryClient.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/useQueryClient.ts"],"sourcesContent":["import { getCurrentInstance, inject } from 'vue-demi'\n\nimport { getClientKey } from './utils'\nimport type { QueryClient } from './queryClient'\n\nexport function useQueryClient(id = ''): QueryClient {\n const vm = getCurrentInstance()?.proxy\n\n if (!vm) {\n throw new Error('vue-query hooks can only be used inside setup() function.')\n }\n\n const key = getClientKey(id)\n const queryClient = inject<QueryClient>(key)\n\n if (!queryClient) {\n throw new Error(\n \"No 'queryClient' found in Vue context, use 'VueQueryPlugin' to properly initialize the library.\",\n )\n }\n\n return queryClient\n}\n"],"mappings":";AAAA,SAAS,oBAAoB,cAAc;AAE3C,SAAS,oBAAoB;AAGtB,SAAS,eAAe,KAAK,IAAiB;AACnD,QAAM,KAAK,mBAAmB,GAAG;AAEjC,MAAI,CAAC,IAAI;AACP,UAAM,IAAI,MAAM,2DAA2D;AAAA,EAC7E;AAEA,QAAM,MAAM,aAAa,EAAE;AAC3B,QAAM,cAAc,OAAoB,GAAG;AAE3C,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/useQueryClient.ts"],"sourcesContent":["import { hasInjectionContext, inject } from 'vue-demi'\n\nimport { getClientKey } from './utils'\nimport type { QueryClient } from './queryClient'\n\nexport function useQueryClient(id = ''): QueryClient {\n // ensures that `inject()` can be used\n if (!hasInjectionContext()) {\n throw new Error(\n 'vue-query hooks can only be used inside setup() function or functions that support injection context.',\n )\n }\n\n const key = getClientKey(id)\n const queryClient = inject<QueryClient>(key)\n\n if (!queryClient) {\n throw new Error(\n \"No 'queryClient' found in Vue context, use 'VueQueryPlugin' to properly initialize the library.\",\n )\n }\n\n return queryClient\n}\n"],"mappings":";AAAA,SAAS,qBAAqB,cAAc;AAE5C,SAAS,oBAAoB;AAGtB,SAAS,eAAe,KAAK,IAAiB;AAEnD,MAAI,CAAC,oBAAoB,GAAG;AAC1B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,MAAM,aAAa,EAAE;AAC3B,QAAM,cAAc,OAAoB,GAAG;AAE3C,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
package/build/modern/utils.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import { isRef, unref } from 'vue-demi'\nimport type { MaybeRefDeep } from './types'\n\nexport const VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'\n\nexport function getClientKey(key?: string) {\n const suffix = key ? `:${key}` : ''\n return `${VUE_QUERY_CLIENT}${suffix}`\n}\n\nexport function updateState(\n state: Record<string, unknown>,\n update: Record<string, any>,\n): void {\n Object.keys(state).forEach((key) => {\n state[key] = update[key]\n })\n}\n\nexport function cloneDeep<T>(\n value: MaybeRefDeep<T>,\n customizer?: (val: MaybeRefDeep<T>) => T | undefined,\n): T {\n if (customizer) {\n const result = customizer(value)\n // If it's a ref of undefined, return undefined\n if (result === undefined && isRef(value)) {\n return result as T\n }\n if (result !== undefined) {\n return result\n }\n }\n\n if (Array.isArray(value)) {\n return value.map((val) => cloneDeep(val, customizer)) as unknown as T\n }\n\n if (typeof value === 'object' && isPlainObject(value)) {\n const entries = Object.entries(value).map(([key, val]) => [\n key,\n cloneDeep(val, customizer),\n ])\n return Object.fromEntries(entries)\n }\n\n return value as T\n}\n\nexport function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T {\n return cloneDeep(obj, (val) => {\n if (isRef(val)) {\n return cloneDeepUnref(unref(val))\n }\n\n return undefined\n })\n}\n\nfunction isPlainObject(value: unknown): value is Object {\n if (Object.prototype.toString.call(value) !== '[object Object]') {\n return false\n }\n\n const prototype = Object.getPrototypeOf(value)\n return prototype === null || prototype === Object.prototype\n}\n\nexport function shouldThrowError<T extends (...args: any[]) => boolean>(\n throwOnError: boolean | T | undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwOnError function to override throwing behavior on a per-error basis\n if (typeof throwOnError === 'function') {\n return throwOnError(...params)\n }\n\n return !!throwOnError\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAA6B;AAGtB,IAAM,mBAAmB;AAEzB,SAAS,aAAa,KAAc;AACzC,QAAM,SAAS,MAAM,IAAI,GAAG,KAAK;AACjC,SAAO,GAAG,gBAAgB,GAAG,MAAM;AACrC;AAEO,SAAS,YACd,OACA,QACM;AACN,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAClC,UAAM,GAAG,IAAI,OAAO,GAAG;AAAA,EACzB,CAAC;AACH;AAEO,SAAS,UACd,OACA,YACG;AACH,MAAI,YAAY;AACd,UAAM,SAAS,WAAW,KAAK;AAE/B,QAAI,WAAW,cAAa,uBAAM,KAAK,GAAG;AACxC,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,WAAO,MAAM,IAAI,CAAC,QAAQ,UAAU,KAAK,UAAU,CAAC;AAAA,EACtD;AAEA,MAAI,OAAO,UAAU,YAAY,cAAc,KAAK,GAAG;AACrD,UAAM,UAAU,OAAO,QAAQ,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM;AAAA,MACxD;AAAA,MACA,UAAU,KAAK,UAAU;AAAA,IAC3B,CAAC;AACD,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAEA,SAAO;AACT;AAEO,SAAS,eAAkB,KAAyB;AACzD,SAAO,UAAU,KAAK,CAAC,QAAQ;AAC7B,YAAI,uBAAM,GAAG,GAAG;AACd,aAAO,mBAAe,uBAAM,GAAG,CAAC;AAAA,IAClC;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEA,SAAS,cAAc,OAAiC;AACtD,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,mBAAmB;AAC/D,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,SAAO,cAAc,QAAQ,cAAc,OAAO;AACpD;AAEO,SAAS,iBACd,cACA,QACS;AAET,MAAI,OAAO,iBAAiB,YAAY;AACtC,WAAO,aAAa,GAAG,MAAM;AAAA,EAC/B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import { isRef, unref } from 'vue-demi'\nimport type { MaybeRefDeep } from './types'\n\nexport const VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'\n\nexport function getClientKey(key?: string) {\n const suffix = key ? `:${key}` : ''\n return `${VUE_QUERY_CLIENT}${suffix}`\n}\n\nexport function updateState(\n state: Record<string, unknown>,\n update: Record<string, any>,\n): void {\n Object.keys(state).forEach((key) => {\n state[key] = update[key]\n })\n}\n\nexport function cloneDeep<T>(\n value: MaybeRefDeep<T>,\n customizer?: (val: MaybeRefDeep<T>) => T | undefined,\n): T {\n if (customizer) {\n const result = customizer(value)\n // If it's a ref of undefined, return undefined\n if (result === undefined && isRef(value)) {\n return result as T\n }\n if (result !== undefined) {\n return result\n }\n }\n\n if (Array.isArray(value)) {\n return value.map((val) => cloneDeep(val, customizer)) as unknown as T\n }\n\n if (typeof value === 'object' && isPlainObject(value)) {\n const entries = Object.entries(value).map(([key, val]) => [\n key,\n cloneDeep(val, customizer),\n ])\n return Object.fromEntries(entries)\n }\n\n return value as T\n}\n\nexport function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T {\n return cloneDeep(obj, (val) => {\n if (isRef(val)) {\n return cloneDeepUnref(unref(val))\n }\n\n return undefined\n })\n}\n\nfunction isPlainObject(value: unknown): value is Object {\n if (Object.prototype.toString.call(value) !== '[object Object]') {\n return false\n }\n\n const prototype = Object.getPrototypeOf(value)\n return prototype === null || prototype === Object.prototype\n}\n\nexport function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n throwOnError: boolean | T | undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwOnError function to override throwing behavior on a per-error basis\n if (typeof throwOnError === 'function') {\n return throwOnError(...params)\n }\n\n return !!throwOnError\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAA6B;AAGtB,IAAM,mBAAmB;AAEzB,SAAS,aAAa,KAAc;AACzC,QAAM,SAAS,MAAM,IAAI,GAAG,KAAK;AACjC,SAAO,GAAG,gBAAgB,GAAG,MAAM;AACrC;AAEO,SAAS,YACd,OACA,QACM;AACN,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAClC,UAAM,GAAG,IAAI,OAAO,GAAG;AAAA,EACzB,CAAC;AACH;AAEO,SAAS,UACd,OACA,YACG;AACH,MAAI,YAAY;AACd,UAAM,SAAS,WAAW,KAAK;AAE/B,QAAI,WAAW,cAAa,uBAAM,KAAK,GAAG;AACxC,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,WAAO,MAAM,IAAI,CAAC,QAAQ,UAAU,KAAK,UAAU,CAAC;AAAA,EACtD;AAEA,MAAI,OAAO,UAAU,YAAY,cAAc,KAAK,GAAG;AACrD,UAAM,UAAU,OAAO,QAAQ,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM;AAAA,MACxD;AAAA,MACA,UAAU,KAAK,UAAU;AAAA,IAC3B,CAAC;AACD,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAEA,SAAO;AACT;AAEO,SAAS,eAAkB,KAAyB;AACzD,SAAO,UAAU,KAAK,CAAC,QAAQ;AAC7B,YAAI,uBAAM,GAAG,GAAG;AACd,aAAO,mBAAe,uBAAM,GAAG,CAAC;AAAA,IAClC;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEA,SAAS,cAAc,OAAiC;AACtD,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,mBAAmB;AAC/D,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,SAAO,cAAc,QAAQ,cAAc,OAAO;AACpD;AAEO,SAAS,iBACd,cACA,QACS;AAET,MAAI,OAAO,iBAAiB,YAAY;AACtC,WAAO,aAAa,GAAG,MAAM;AAAA,EAC/B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
package/build/modern/utils.d.cts CHANGED
@@ -6,6 +6,6 @@ declare function getClientKey(key?: string): string;
6
6
  declare function updateState(state: Record<string, unknown>, update: Record<string, any>): void;
7
7
  declare function cloneDeep<T>(value: MaybeRefDeep<T>, customizer?: (val: MaybeRefDeep<T>) => T | undefined): T;
8
8
  declare function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T;
9
- declare function shouldThrowError<T extends (...args: any[]) => boolean>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;
9
+ declare function shouldThrowError<T extends (...args: Array<any>) => boolean>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;
10
10
 
11
11
  export { VUE_QUERY_CLIENT, cloneDeep, cloneDeepUnref, getClientKey, shouldThrowError, updateState };
package/build/modern/utils.d.ts CHANGED
@@ -6,6 +6,6 @@ declare function getClientKey(key?: string): string;
6
6
  declare function updateState(state: Record<string, unknown>, update: Record<string, any>): void;
7
7
  declare function cloneDeep<T>(value: MaybeRefDeep<T>, customizer?: (val: MaybeRefDeep<T>) => T | undefined): T;
8
8
  declare function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T;
9
- declare function shouldThrowError<T extends (...args: any[]) => boolean>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;
9
+ declare function shouldThrowError<T extends (...args: Array<any>) => boolean>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;
10
10
 
11
11
  export { VUE_QUERY_CLIENT, cloneDeep, cloneDeepUnref, getClientKey, shouldThrowError, updateState };
package/build/modern/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import { isRef, unref } from 'vue-demi'\nimport type { MaybeRefDeep } from './types'\n\nexport const VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'\n\nexport function getClientKey(key?: string) {\n const suffix = key ? `:${key}` : ''\n return `${VUE_QUERY_CLIENT}${suffix}`\n}\n\nexport function updateState(\n state: Record<string, unknown>,\n update: Record<string, any>,\n): void {\n Object.keys(state).forEach((key) => {\n state[key] = update[key]\n })\n}\n\nexport function cloneDeep<T>(\n value: MaybeRefDeep<T>,\n customizer?: (val: MaybeRefDeep<T>) => T | undefined,\n): T {\n if (customizer) {\n const result = customizer(value)\n // If it's a ref of undefined, return undefined\n if (result === undefined && isRef(value)) {\n return result as T\n }\n if (result !== undefined) {\n return result\n }\n }\n\n if (Array.isArray(value)) {\n return value.map((val) => cloneDeep(val, customizer)) as unknown as T\n }\n\n if (typeof value === 'object' && isPlainObject(value)) {\n const entries = Object.entries(value).map(([key, val]) => [\n key,\n cloneDeep(val, customizer),\n ])\n return Object.fromEntries(entries)\n }\n\n return value as T\n}\n\nexport function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T {\n return cloneDeep(obj, (val) => {\n if (isRef(val)) {\n return cloneDeepUnref(unref(val))\n }\n\n return undefined\n })\n}\n\nfunction isPlainObject(value: unknown): value is Object {\n if (Object.prototype.toString.call(value) !== '[object Object]') {\n return false\n }\n\n const prototype = Object.getPrototypeOf(value)\n return prototype === null || prototype === Object.prototype\n}\n\nexport function shouldThrowError<T extends (...args: any[]) => boolean>(\n throwOnError: boolean | T | undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwOnError function to override throwing behavior on a per-error basis\n if (typeof throwOnError === 'function') {\n return throwOnError(...params)\n }\n\n return !!throwOnError\n}\n"],"mappings":";AAAA,SAAS,OAAO,aAAa;AAGtB,IAAM,mBAAmB;AAEzB,SAAS,aAAa,KAAc;AACzC,QAAM,SAAS,MAAM,IAAI,GAAG,KAAK;AACjC,SAAO,GAAG,gBAAgB,GAAG,MAAM;AACrC;AAEO,SAAS,YACd,OACA,QACM;AACN,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAClC,UAAM,GAAG,IAAI,OAAO,GAAG;AAAA,EACzB,CAAC;AACH;AAEO,SAAS,UACd,OACA,YACG;AACH,MAAI,YAAY;AACd,UAAM,SAAS,WAAW,KAAK;AAE/B,QAAI,WAAW,UAAa,MAAM,KAAK,GAAG;AACxC,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,WAAO,MAAM,IAAI,CAAC,QAAQ,UAAU,KAAK,UAAU,CAAC;AAAA,EACtD;AAEA,MAAI,OAAO,UAAU,YAAY,cAAc,KAAK,GAAG;AACrD,UAAM,UAAU,OAAO,QAAQ,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM;AAAA,MACxD;AAAA,MACA,UAAU,KAAK,UAAU;AAAA,IAC3B,CAAC;AACD,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAEA,SAAO;AACT;AAEO,SAAS,eAAkB,KAAyB;AACzD,SAAO,UAAU,KAAK,CAAC,QAAQ;AAC7B,QAAI,MAAM,GAAG,GAAG;AACd,aAAO,eAAe,MAAM,GAAG,CAAC;AAAA,IAClC;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEA,SAAS,cAAc,OAAiC;AACtD,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,mBAAmB;AAC/D,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,SAAO,cAAc,QAAQ,cAAc,OAAO;AACpD;AAEO,SAAS,iBACd,cACA,QACS;AAET,MAAI,OAAO,iBAAiB,YAAY;AACtC,WAAO,aAAa,GAAG,MAAM;AAAA,EAC/B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
1
+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import { isRef, unref } from 'vue-demi'\nimport type { MaybeRefDeep } from './types'\n\nexport const VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'\n\nexport function getClientKey(key?: string) {\n const suffix = key ? `:${key}` : ''\n return `${VUE_QUERY_CLIENT}${suffix}`\n}\n\nexport function updateState(\n state: Record<string, unknown>,\n update: Record<string, any>,\n): void {\n Object.keys(state).forEach((key) => {\n state[key] = update[key]\n })\n}\n\nexport function cloneDeep<T>(\n value: MaybeRefDeep<T>,\n customizer?: (val: MaybeRefDeep<T>) => T | undefined,\n): T {\n if (customizer) {\n const result = customizer(value)\n // If it's a ref of undefined, return undefined\n if (result === undefined && isRef(value)) {\n return result as T\n }\n if (result !== undefined) {\n return result\n }\n }\n\n if (Array.isArray(value)) {\n return value.map((val) => cloneDeep(val, customizer)) as unknown as T\n }\n\n if (typeof value === 'object' && isPlainObject(value)) {\n const entries = Object.entries(value).map(([key, val]) => [\n key,\n cloneDeep(val, customizer),\n ])\n return Object.fromEntries(entries)\n }\n\n return value as T\n}\n\nexport function cloneDeepUnref<T>(obj: MaybeRefDeep<T>): T {\n return cloneDeep(obj, (val) => {\n if (isRef(val)) {\n return cloneDeepUnref(unref(val))\n }\n\n return undefined\n })\n}\n\nfunction isPlainObject(value: unknown): value is Object {\n if (Object.prototype.toString.call(value) !== '[object Object]') {\n return false\n }\n\n const prototype = Object.getPrototypeOf(value)\n return prototype === null || prototype === Object.prototype\n}\n\nexport function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n throwOnError: boolean | T | undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwOnError function to override throwing behavior on a per-error basis\n if (typeof throwOnError === 'function') {\n return throwOnError(...params)\n }\n\n return !!throwOnError\n}\n"],"mappings":";AAAA,SAAS,OAAO,aAAa;AAGtB,IAAM,mBAAmB;AAEzB,SAAS,aAAa,KAAc;AACzC,QAAM,SAAS,MAAM,IAAI,GAAG,KAAK;AACjC,SAAO,GAAG,gBAAgB,GAAG,MAAM;AACrC;AAEO,SAAS,YACd,OACA,QACM;AACN,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAClC,UAAM,GAAG,IAAI,OAAO,GAAG;AAAA,EACzB,CAAC;AACH;AAEO,SAAS,UACd,OACA,YACG;AACH,MAAI,YAAY;AACd,UAAM,SAAS,WAAW,KAAK;AAE/B,QAAI,WAAW,UAAa,MAAM,KAAK,GAAG;AACxC,aAAO;AAAA,IACT;AACA,QAAI,WAAW,QAAW;AACxB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,WAAO,MAAM,IAAI,CAAC,QAAQ,UAAU,KAAK,UAAU,CAAC;AAAA,EACtD;AAEA,MAAI,OAAO,UAAU,YAAY,cAAc,KAAK,GAAG;AACrD,UAAM,UAAU,OAAO,QAAQ,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM;AAAA,MACxD;AAAA,MACA,UAAU,KAAK,UAAU;AAAA,IAC3B,CAAC;AACD,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAEA,SAAO;AACT;AAEO,SAAS,eAAkB,KAAyB;AACzD,SAAO,UAAU,KAAK,CAAC,QAAQ;AAC7B,QAAI,MAAM,GAAG,GAAG;AACd,aAAO,eAAe,MAAM,GAAG,CAAC;AAAA,IAClC;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AAEA,SAAS,cAAc,OAAiC;AACtD,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,mBAAmB;AAC/D,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,SAAO,cAAc,QAAQ,cAAc,OAAO;AACpD;AAEO,SAAS,iBACd,cACA,QACS;AAET,MAAI,OAAO,iBAAiB,YAAY;AACtC,WAAO,aAAa,GAAG,MAAM;AAAA,EAC/B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/vue-query",
3
- "version": "5.0.0-beta.18",
3
+ "version": "5.0.0-beta.22",
4
4
  "description": "Hooks for managing, caching and syncing asynchronous and remote data in Vue",
5
5
  "author": "Damian Osipiuk",
6
6
  "license": "MIT",
@@ -48,18 +48,18 @@
48
48
  "dependencies": {
49
49
  "@tanstack/match-sorter-utils": "^8.8.4",
50
50
  "@vue/devtools-api": "^6.5.0",
51
- "vue-demi": "^0.13.11",
52
- "@tanstack/query-core": "5.0.0-beta.18"
51
+ "vue-demi": "^0.14.6",
52
+ "@tanstack/query-core": "5.0.0-beta.20"
53
53
  },
54
54
  "devDependencies": {
55
- "@vue/composition-api": "1.7.1",
56
- "vue": "^3.2.47",
55
+ "@vue/composition-api": "1.7.2",
56
+ "vue": "^3.3.0",
57
57
  "vue2": "npm:vue@2.6",
58
58
  "vue2.7": "npm:vue@2.7"
59
59
  },
60
60
  "peerDependencies": {
61
61
  "@vue/composition-api": "^1.1.2",
62
- "vue": "^2.5.0 || ^3.0.0"
62
+ "vue": "^2.6.0 || ^3.3.0"
63
63
  },
64
64
  "peerDependenciesMeta": {
65
65
  "@vue/composition-api": {
package/src/__mocks__/useBaseQuery.ts CHANGED
@@ -5,5 +5,5 @@ const { useBaseQuery: originImpl, unrefQueryArgs: originalParse } =
5
5
  // @ts-expect-error - vitest uses esmodules; tsconfig is not set to use them
6
6
  (await vi.importActual('../useBaseQuery')) as any
7
7
 
8
- export const useBaseQuery: Mock<any[], any> = vi.fn(originImpl)
8
+ export const useBaseQuery: Mock<Array<any>, any> = vi.fn(originImpl)
9
9
  export const unrefQueryArgs = originalParse
package/src/__tests__/useMutation.test.ts CHANGED
@@ -99,7 +99,7 @@ describe('useMutation', () => {
99
99
  name: string
100
100
  }
101
101
  }
102
- const mutationKey = ref<MutationKeyTest[]>([
102
+ const mutationKey = ref<Array<MutationKeyTest>>([
103
103
  {
104
104
  entity: 'test',
105
105
  otherObject: { name: 'objectName' },
@@ -128,13 +128,13 @@ describe('useMutation', () => {
128
128
  })
129
129
 
130
130
  expect(
131
- (relevantMutation?.options.mutationKey as MutationKeyTest[])[0]
131
+ (relevantMutation?.options.mutationKey as Array<MutationKeyTest>)[0]
132
132
  ?.otherObject.name === 'someOtherObjectName',
133
133
  )
134
134
  })
135
135
 
136
136
  test('should allow for non-options object (mutationFn or mutationKey) passed as arg1 & arg2 to trigger reactive updates', async () => {
137
- const mutationKey = ref<string[]>(['foo2'])
137
+ const mutationKey = ref<Array<string>>(['foo2'])
138
138
  const mutationFn = ref((params: string) => successMutator(params))
139
139
  const queryClient = useQueryClient()
140
140
  const mutationCache = queryClient.getMutationCache()
package/src/__tests__/useQueryClient.test.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { getCurrentInstance, inject } from 'vue-demi'
1
+ import { hasInjectionContext, inject } from 'vue-demi'
2
2
  import { vi } from 'vitest'
3
3
  import { useQueryClient } from '../useQueryClient'
4
4
  import { VUE_QUERY_CLIENT } from '../utils'
@@ -6,7 +6,7 @@ import type { Mock } from 'vitest'
6
6
 
7
7
  describe('useQueryClient', () => {
8
8
  const injectSpy = inject as Mock
9
- const getCurrentInstanceSpy = getCurrentInstance as Mock
9
+ const hasInjectionContextSpy = hasInjectionContext as Mock
10
10
 
11
11
  beforeEach(() => {
12
12
  vi.restoreAllMocks()
@@ -32,10 +32,10 @@ describe('useQueryClient', () => {
32
32
  })
33
33
 
34
34
  test('should throw an error when used outside of setup function', () => {
35
- getCurrentInstanceSpy.mockReturnValueOnce(undefined)
35
+ hasInjectionContextSpy.mockReturnValueOnce(false)
36
36
 
37
37
  expect(useQueryClient).toThrowError()
38
- expect(getCurrentInstanceSpy).toHaveBeenCalledTimes(1)
38
+ expect(hasInjectionContextSpy).toHaveBeenCalledTimes(1)
39
39
  })
40
40
 
41
41
  test('should call inject with a custom key as a suffix', () => {
package/src/__tests__/utils.test.ts CHANGED
@@ -79,7 +79,7 @@ describe('utils', () => {
79
79
  expect(cp).not.toBe(val)
80
80
  expect(cp[3]).toBe(val[3]) // Set([3, 4])
81
81
  expect(cp[4]).not.toBe(val[4]) // [5, 6, { a: 1 }]
82
- expect((cp[4] as number[])[2]).not.toBe((val[4] as number[])[2]) // { a : 1 }
82
+ expect((cp[4] as Array<number>)[2]).not.toBe((val[4] as Array<number>)[2]) // { a : 1 }
83
83
  })
84
84
 
85
85
  test('should deeply copy object', () => {
package/src/devtools/devtools.ts CHANGED
@@ -146,7 +146,7 @@ export function setupDevtools(app: any, queryClient: QueryClient) {
146
146
  api.sendInspectorTree(pluginId)
147
147
  api.sendInspectorState(pluginId)
148
148
 
149
- const queryEvents: QueryCacheNotifyEvent['type'][] = [
149
+ const queryEvents: Array<QueryCacheNotifyEvent['type']> = [
150
150
  'added',
151
151
  'removed',
152
152
  'updated',
@@ -189,7 +189,7 @@ export function setupDevtools(app: any, queryClient: QueryClient) {
189
189
  (a, b) => sortFns[settings.sortFn]!(a, b) * settings.baseSort,
190
190
  )
191
191
 
192
- const nodes: CustomInspectorNode[] = sorted.map((query) => {
192
+ const nodes: Array<CustomInspectorNode> = sorted.map((query) => {
193
193
  const stateLabel = getQueryStateLabel(query)
194
194
 
195
195
  return {
package/src/mutationCache.ts CHANGED
@@ -19,7 +19,7 @@ export class MutationCache extends MC {
19
19
  return super.find(cloneDeepUnref(filters))
20
20
  }
21
21
 
22
- findAll(filters: MaybeRefDeep<MutationFilters> = {}): Mutation[] {
22
+ findAll(filters: MaybeRefDeep<MutationFilters> = {}): Array<Mutation> {
23
23
  return super.findAll(cloneDeepUnref(filters))
24
24
  }
25
25
  }
package/src/queryCache.ts CHANGED
@@ -15,7 +15,7 @@ export class QueryCache extends QC {
15
15
  return super.find(cloneDeepUnref(filters))
16
16
  }
17
17
 
18
- findAll(filters: MaybeRefDeep<QueryFilters> = {}): Query[] {
18
+ findAll(filters: MaybeRefDeep<QueryFilters> = {}): Array<Query> {
19
19
  return super.findAll(cloneDeepUnref(filters))
20
20
  }
21
21
  }
package/src/queryClient.ts CHANGED
@@ -57,7 +57,7 @@ export class QueryClient extends QC {
57
57
 
58
58
  getQueriesData<TData = unknown>(
59
59
  filters: MaybeRefDeep<QueryFilters>,
60
- ): [QueryKey, TData | undefined][] {
60
+ ): Array<[QueryKey, TData | undefined]> {
61
61
  return super.getQueriesData(cloneDeepUnref(filters))
62
62
  }
63
63
 
@@ -77,7 +77,7 @@ export class QueryClient extends QC {
77
77
  filters: MaybeRefDeep<QueryFilters>,
78
78
  updater: Updater<TData | undefined, TData | undefined>,
79
79
  options: MaybeRefDeep<SetDataOptions> = {},
80
- ): [QueryKey, TData | undefined][] {
80
+ ): Array<[QueryKey, TData | undefined]> {
81
81
  return super.setQueriesData(
82
82
  cloneDeepUnref(filters),
83
83
  updater,
package/src/useBaseQuery.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import {
2
2
  computed,
3
+ getCurrentScope,
3
4
  onScopeDispose,
4
5
  reactive,
5
6
  readonly,
@@ -64,6 +65,14 @@ export function useBaseQuery<
64
65
  >,
65
66
  queryClient?: QueryClient,
66
67
  ): UseBaseQueryReturnType<TData, TError> {
68
+ if (process.env.NODE_ENV === 'development') {
69
+ if (!getCurrentScope()) {
70
+ console.warn(
71
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
72
+ )
73
+ }
74
+ }
75
+
67
76
  const client = queryClient || useQueryClient()
68
77
 
69
78
  const defaultedOptions = computed(() => {
package/src/useIsFetching.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { computed, onScopeDispose, ref, watch } from 'vue-demi'
1
+ import { getCurrentScope, onScopeDispose, ref, watchSyncEffect } from 'vue-demi'
2
2
  import { useQueryClient } from './useQueryClient'
3
- import { cloneDeepUnref } from './utils'
4
3
  import type { Ref } from 'vue-demi'
5
4
  import type { QueryFilters as QF } from '@tanstack/query-core'
6
5
  import type { MaybeRefDeep } from './types'
@@ -12,18 +11,25 @@ export function useIsFetching(
12
11
  fetchingFilters: MaybeRefDeep<QF> = {},
13
12
  queryClient?: QueryClient,
14
13
  ): Ref<number> {
15
- const filters = computed(() => cloneDeepUnref(fetchingFilters))
14
+ if (process.env.NODE_ENV === 'development') {
15
+ if (!getCurrentScope()) {
16
+ console.warn(
17
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
18
+ )
19
+ }
20
+ }
21
+
16
22
  const client = queryClient || useQueryClient()
17
23
 
18
- const isFetching = ref(client.isFetching(filters))
24
+ const isFetching = ref()
19
25
 
20
- const unsubscribe = client.getQueryCache().subscribe(() => {
21
- isFetching.value = client.isFetching(filters)
22
- })
26
+ const listener = () => {
27
+ isFetching.value = client.isFetching(fetchingFilters)
28
+ }
23
29
 
24
- watch(filters, () => {
25
- isFetching.value = client.isFetching(filters)
26
- })
30
+ const unsubscribe = client.getQueryCache().subscribe(listener)
31
+
32
+ watchSyncEffect(listener)
27
33
 
28
34
  onScopeDispose(() => {
29
35
  unsubscribe()
package/src/useMutation.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import {
2
2
  computed,
3
+ getCurrentScope,
3
4
  onScopeDispose,
4
5
  reactive,
5
6
  readonly,
@@ -64,6 +65,14 @@ export function useMutation<
64
65
  >,
65
66
  queryClient?: QueryClient,
66
67
  ): UseMutationReturnType<TData, TError, TVariables, TContext> {
68
+ if (process.env.NODE_ENV === 'development') {
69
+ if (!getCurrentScope()) {
70
+ console.warn(
71
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
72
+ )
73
+ }
74
+ }
75
+
67
76
  const client = queryClient || useQueryClient()
68
77
  const options = computed(() => {
69
78
  return client.defaultMutationOptions(cloneDeepUnref(mutationOptions))
package/src/useMutationState.ts CHANGED
@@ -1,4 +1,11 @@
1
- import { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'
1
+ import {
2
+ computed,
3
+ getCurrentScope,
4
+ onScopeDispose,
5
+ readonly,
6
+ ref,
7
+ watch,
8
+ } from 'vue-demi'
2
9
  import { useQueryClient } from './useQueryClient'
3
10
  import { cloneDeepUnref } from './utils'
4
11
  import type { DeepReadonly, Ref } from 'vue-demi'
@@ -18,6 +25,14 @@ export function useIsMutating(
18
25
  filters: MutationFilters = {},
19
26
  queryClient?: QueryClient,
20
27
  ): Ref<number> {
28
+ if (process.env.NODE_ENV === 'development') {
29
+ if (!getCurrentScope()) {
30
+ console.warn(
31
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
32
+ )
33
+ }
34
+ }
35
+
21
36
  const client = queryClient || useQueryClient()
22
37
  const unreffedFilters = computed(() => ({
23
38
  ...cloneDeepUnref(filters),
@@ -59,7 +74,7 @@ export function useMutationState<TResult = MutationState>(
59
74
  ): DeepReadonly<Ref<Array<TResult>>> {
60
75
  const filters = computed(() => cloneDeepUnref(options.filters))
61
76
  const mutationCache = (queryClient || useQueryClient()).getMutationCache()
62
- const state = ref(getResult(mutationCache, options)) as Ref<TResult[]>
77
+ const state = ref(getResult(mutationCache, options)) as Ref<Array<TResult>>
63
78
  const unsubscribe = mutationCache.subscribe(() => {
64
79
  const result = getResult(mutationCache, options)
65
80
  state.value = result