@tanstack/query-core 4.1.2 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.1.2",
+  "version": "4.2.1",
   "description": "TODO",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/tests/queryClient.test.tsx

@@ -13,6 +13,7 @@ import {
   QueryClient,
   QueryFunction,
   QueryObserver,
+  QueryObserverOptions,
 } from '..'
 import { focusManager, onlineManager } from '..'
 
@@ -357,6 +358,38 @@ describe('queryClient', () => {
       expect(queryCache.find(key)!.state.data).toBe(newData)
     })
 
+    test('should apply a custom structuralSharing function when provided', () => {
+      const key = queryKey()
+
+      const queryObserverOptions = {
+        structuralSharing: (
+          prevData: { value: Date } | undefined,
+          newData: { value: Date },
+        ) => {
+          if (!prevData) {
+            return newData
+          }
+          return newData.value.getTime() === prevData.value.getTime()
+            ? prevData
+            : newData
+        },
+      } as QueryObserverOptions
+
+      queryClient.setDefaultOptions({ queries: queryObserverOptions })
+
+      const oldData = { value: new Date(2022, 6, 19) }
+      const newData = { value: new Date(2022, 6, 19) }
+      queryClient.setQueryData(key, oldData)
+      queryClient.setQueryData(key, newData)
+
+      expect(queryCache.find(key)!.state.data).toBe(oldData)
+
+      const distinctData = { value: new Date(2021, 11, 25) }
+      queryClient.setQueryData(key, distinctData)
+
+      expect(queryCache.find(key)!.state.data).toBe(distinctData)
+    })
+
     test('should not set isFetching to false', async () => {
       const key = queryKey()
       queryClient.prefetchQuery(key, async () => {

package/src/types.ts

@@ -76,9 +76,12 @@ export interface QueryOptions<
   behavior?: QueryBehavior<TQueryFnData, TError, TData>
   /**
    * Set this to `false` to disable structural sharing between query results.
+   * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
    * Defaults to `true`.
    */
-  structuralSharing?: boolean
+  structuralSharing?:
+    | boolean
+    | ((oldData: TData | undefined, newData: TData) => TData)
   /**
    * This function can be set to automatically get the previous cursor for infinite queries.
    * The result will also be used to determine the value of `hasPreviousPage`.
@@ -425,11 +428,14 @@ export interface QueryObserverSuccessResult<TData = unknown, TError = unknown>
   status: 'success'
 }
 
+export type DefinedQueryObserverResult<TData = unknown, TError = unknown> =
+  | QueryObserverRefetchErrorResult<TData, TError>
+  | QueryObserverSuccessResult<TData, TError>
+
 export type QueryObserverResult<TData = unknown, TError = unknown> =
+  | DefinedQueryObserverResult<TData, TError>
   | QueryObserverLoadingErrorResult<TData, TError>
   | QueryObserverLoadingResult<TData, TError>
-  | QueryObserverRefetchErrorResult<TData, TError>
-  | QueryObserverSuccessResult<TData, TError>
 
 export interface InfiniteQueryObserverBaseResult<
   TData = unknown,

package/src/utils.ts

@@ -427,6 +427,8 @@ export function replaceData<
   // Use prev data if an isDataEqual function is defined and returns `true`
   if (options.isDataEqual?.(prevData, data)) {
     return prevData as TData
+  } else if (typeof options.structuralSharing === 'function') {
+    return options.structuralSharing(prevData, data)
   } else if (options.structuralSharing !== false) {
     // Structurally share data between prev and new data if needed
     return replaceEqualDeep(prevData, data)