Merge branch 'main' into react-query/prefetch/queryClient-param

TanStack · Sep 6, 2024 · e9d8529 · e9d8529
2 parents d16287b + 6799b82
commit e9d8529
Show file tree

Hide file tree

Showing 37 changed files with 160 additions and 124 deletions.
diff --git a/examples/solid/astro/package.json b/examples/solid/astro/package.json
@@ -15,8 +15,8 @@
     "@astrojs/solid-js": "^4.4.0",
     "@astrojs/tailwind": "^5.1.0",
     "@astrojs/vercel": "^7.7.2",
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "astro": "^4.12.2",
     "solid-js": "^1.8.19",
     "tailwindcss": "^3.4.7",

diff --git a/examples/solid/basic-graphql-request/package.json b/examples/solid/basic-graphql-request/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "graphql": "^16.9.0",
     "graphql-request": "^7.1.0",
     "solid-js": "^1.8.19"

diff --git a/examples/solid/basic/package.json b/examples/solid/basic/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "solid-js": "^1.8.19"
   },
   "devDependencies": {

diff --git a/examples/solid/default-query-function/package.json b/examples/solid/default-query-function/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "solid-js": "^1.8.19"
   },
   "devDependencies": {

diff --git a/examples/solid/simple/package.json b/examples/solid/simple/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "solid-js": "^1.8.19"
   },
   "devDependencies": {

diff --git a/examples/solid/solid-start-streaming/package.json b/examples/solid/solid-start-streaming/package.json
@@ -12,8 +12,8 @@
     "@solidjs/meta": "^0.29.4",
     "@solidjs/router": "^0.14.1",
     "@solidjs/start": "^1.0.6",
-    "@tanstack/solid-query": "^5.54.1",
-    "@tanstack/solid-query-devtools": "^5.54.1",
+    "@tanstack/solid-query": "^5.54.2",
+    "@tanstack/solid-query-devtools": "^5.54.2",
     "solid-js": "^1.8.19",
     "vinxi": "^0.4.1"
   },

diff --git a/examples/svelte/auto-refetching/package.json b/examples/svelte/auto-refetching/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/basic/package.json b/examples/svelte/basic/package.json
@@ -10,9 +10,9 @@
   },
   "dependencies": {
     "@tanstack/query-sync-storage-persister": "^5.54.1",
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1",
-    "@tanstack/svelte-query-persist-client": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2",
+    "@tanstack/svelte-query-persist-client": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/load-more-infinite-scroll/package.json b/examples/svelte/load-more-infinite-scroll/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/optimistic-updates/package.json b/examples/svelte/optimistic-updates/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/playground/package.json b/examples/svelte/playground/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/simple/package.json b/examples/svelte/simple/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^3.1.1",

diff --git a/examples/svelte/ssr/package.json b/examples/svelte/ssr/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/svelte/star-wars/package.json b/examples/svelte/star-wars/package.json
@@ -9,8 +9,8 @@
     "test:types": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   },
   "dependencies": {
-    "@tanstack/svelte-query": "^5.54.1",
-    "@tanstack/svelte-query-devtools": "^5.54.1"
+    "@tanstack/svelte-query": "^5.54.2",
+    "@tanstack/svelte-query-devtools": "^5.54.2"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.2.2",

diff --git a/examples/vue/2.6-basic/package.json b/examples/vue/2.6-basic/package.json
@@ -8,7 +8,7 @@
     "_preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
     "@vue/composition-api": "1.7.2",
     "vue": "2.6.14",
     "vue-template-compiler": "2.6.14"

diff --git a/examples/vue/2.7-basic/package.json b/examples/vue/2.7-basic/package.json
@@ -8,7 +8,7 @@
     "_serve": "vite preview"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
     "vue": "2.7.16",
     "vue-template-compiler": "2.7.16"
   },

diff --git a/examples/vue/basic/package.json b/examples/vue/basic/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1",
-    "@tanstack/vue-query-devtools": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
+    "@tanstack/vue-query-devtools": "^5.54.2",
     "vue": "^3.4.27"
   },
   "devDependencies": {

diff --git a/examples/vue/dependent-queries/package.json b/examples/vue/dependent-queries/package.json
@@ -8,7 +8,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
     "vue": "^3.4.27"
   },
   "devDependencies": {

diff --git a/examples/vue/nuxt3/package.json b/examples/vue/nuxt3/package.json
@@ -7,7 +7,7 @@
     "_start": "node .output/server/index.mjs"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1"
+    "@tanstack/vue-query": "^5.54.2"
   },
   "devDependencies": {
     "nuxt": "^3.12.4"

diff --git a/examples/vue/persister/package.json b/examples/vue/persister/package.json
@@ -11,7 +11,7 @@
     "@tanstack/query-core": "^5.54.1",
     "@tanstack/query-persist-client-core": "^5.54.1",
     "@tanstack/query-sync-storage-persister": "^5.54.1",
-    "@tanstack/vue-query": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
     "idb-keyval": "^6.2.1",
     "vue": "^3.4.27"
   },

diff --git a/examples/vue/simple/package.json b/examples/vue/simple/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.54.1",
-    "@tanstack/vue-query-devtools": "^5.54.1",
+    "@tanstack/vue-query": "^5.54.2",
+    "@tanstack/vue-query-devtools": "^5.54.2",
     "vue": "^3.4.27"
   },
   "devDependencies": {

diff --git a/packages/solid-query-devtools/package.json b/packages/solid-query-devtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query-devtools",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Developer tools to interact with and visualize the TanStack/solid-query Query cache",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/solid-query-persist-client/package.json b/packages/solid-query-persist-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query-persist-client",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Solid.js bindings to work with persisters in TanStack/solid-query",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/solid-query/package.json b/packages/solid-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/svelte-query-devtools/package.json b/packages/svelte-query-devtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-query-devtools",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Developer tools to interact with and visualize the TanStack/svelte-query cache",
   "author": "Lachlan Collins",
   "license": "MIT",

diff --git a/packages/svelte-query-persist-client/package.json b/packages/svelte-query-persist-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-query-persist-client",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Svelte bindings to work with persisters in TanStack/svelte-query",
   "author": "Lachlan Collins",
   "license": "MIT",

diff --git a/packages/svelte-query/package.json b/packages/svelte-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-query",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
   "author": "Lachlan Collins",
   "license": "MIT",

diff --git a/packages/vue-query-devtools/package.json b/packages/vue-query-devtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/vue-query-devtools",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Developer tools to interact with and visualize the TanStack/vue-query cache",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/vue-query/package.json b/packages/vue-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/vue-query",
-  "version": "5.54.1",
+  "version": "5.54.2",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in Vue",
   "author": "Damian Osipiuk",
   "license": "MIT",

diff --git a/packages/vue-query/src/useBaseQuery.ts b/packages/vue-query/src/useBaseQuery.ts
@@ -2,8 +2,9 @@ import {
   computed,
   getCurrentScope,
   onScopeDispose,
-  reactive,
   readonly,
+  shallowReactive,
+  shallowReadonly,
   toRefs,
   watch,
 } from 'vue-demi'
@@ -105,7 +106,7 @@ export function useBaseQuery<
   })
 
   const observer = new Observer(client, defaultedOptions.value)
-  const state = reactive(observer.getCurrentResult())
+  const state = shallowReactive(observer.getCurrentResult())
 
   let unsubscribe = () => {
     // noop
@@ -201,7 +202,15 @@ export function useBaseQuery<
     },
   )
 
-  const object: any = toRefs(readonly(state))
+  const readonlyState =
+    process.env.NODE_ENV === 'production'
+      ? state
+      : // @ts-expect-error
+        defaultedOptions.value.shallow
+        ? shallowReadonly(state)
+        : readonly(state)
+
+  const object: any = toRefs(readonlyState)
   for (const key in state) {
     if (typeof state[key as keyof typeof state] === 'function') {
       object[key] = state[key as keyof typeof state]

diff --git a/packages/vue-query/src/useInfiniteQuery.ts b/packages/vue-query/src/useInfiniteQuery.ts
@@ -49,6 +49,8 @@ export type UseInfiniteQueryOptions<
           TPageParam
         >[Property]
       >
+} & {
+  shallow?: boolean
 }
 
 export type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<

diff --git a/packages/vue-query/src/useMutation.ts b/packages/vue-query/src/useMutation.ts
@@ -2,8 +2,9 @@ import {
   computed,
   getCurrentScope,
   onScopeDispose,
-  reactive,
   readonly,
+  shallowReactive,
+  shallowReadonly,
   toRefs,
   watch,
 } from 'vue-demi'
@@ -26,12 +27,17 @@ type MutationResult<TData, TError, TVariables, TContext> = DistributiveOmit<
   'mutate' | 'reset'
 >
 
+type UseMutationOptionsBase<TData, TError, TVariables, TContext> =
+  MutationObserverOptions<TData, TError, TVariables, TContext> & {
+    shallow?: boolean
+  }
+
 export type UseMutationOptions<
   TData = unknown,
   TError = DefaultError,
   TVariables = void,
   TContext = unknown,
-> = MaybeRefDeep<MutationObserverOptions<TData, TError, TVariables, TContext>>
+> = MaybeRefDeep<UseMutationOptionsBase<TData, TError, TVariables, TContext>>
 
 type MutateSyncFunction<
   TData = unknown,
@@ -61,7 +67,7 @@ export function useMutation<
   TContext = unknown,
 >(
   mutationOptions: MaybeRefDeep<
-    MutationObserverOptions<TData, TError, TVariables, TContext>
+    UseMutationOptionsBase<TData, TError, TVariables, TContext>
   >,
   queryClient?: QueryClient,
 ): UseMutationReturnType<TData, TError, TVariables, TContext> {
@@ -78,7 +84,7 @@ export function useMutation<
     return client.defaultMutationOptions(cloneDeepUnref(mutationOptions))
   })
   const observer = new MutationObserver(client, options.value)
-  const state = reactive(observer.getCurrentResult())
+  const state = shallowReactive(observer.getCurrentResult())
 
   const unsubscribe = observer.subscribe((result) => {
     updateState(state, result)
@@ -101,7 +107,14 @@ export function useMutation<
     unsubscribe()
   })
 
-  const resultRefs = toRefs(readonly(state)) as unknown as ToRefs<
+  const readonlyState =
+    process.env.NODE_ENV === 'production'
+      ? state
+      : options.value.shallow
+        ? shallowReadonly(state)
+        : readonly(state)
+
+  const resultRefs = toRefs(readonlyState) as ToRefs<
     Readonly<MutationResult<TData, TError, TVariables, TContext>>
   >