@tanstack/query-core 4.29.23 → 4.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.29.23",
+  "version": "4.30.0",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/infiniteQueryObserver.ts

@@ -1,3 +1,9 @@
+import { QueryObserver } from './queryObserver'
+import {
+  hasNextPage,
+  hasPreviousPage,
+  infiniteQueryBehavior,
+} from './infiniteQueryBehavior'
 import type {
   DefaultedInfiniteQueryObserverOptions,
   FetchNextPageOptions,
@@ -9,12 +15,6 @@ import type {
 } from './types'
 import type { QueryClient } from './queryClient'
 import type { NotifyOptions, ObserverFetchOptions } from './queryObserver'
-import { QueryObserver } from './queryObserver'
-import {
-  hasNextPage,
-  hasPreviousPage,
-  infiniteQueryBehavior,
-} from './infiniteQueryBehavior'
 import type { Query } from './query'
 
 type InfiniteQueryObserverListener<TData, TError> = (

package/src/mutation.ts

@@ -1,12 +1,12 @@
-import type { MutationOptions, MutationStatus, MutationMeta } from './types'
-import type { MutationCache } from './mutationCache'
-import type { MutationObserver } from './mutationObserver'
-import type { Logger } from './logger'
 import { defaultLogger } from './logger'
 import { notifyManager } from './notifyManager'
 import { Removable } from './removable'
-import type { Retryer } from './retryer'
 import { canFetch, createRetryer } from './retryer'
+import type { MutationMeta, MutationOptions, MutationStatus } from './types'
+import type { MutationCache } from './mutationCache'
+import type { MutationObserver } from './mutationObserver'
+import type { Logger } from './logger'
+import type { Retryer } from './retryer'
 
 // TYPES
 

package/src/mutationCache.ts

@@ -1,12 +1,12 @@
+import { notifyManager } from './notifyManager'
+import { Mutation } from './mutation'
+import { matchMutation, noop } from './utils'
+import { Subscribable } from './subscribable'
 import type { MutationObserver } from './mutationObserver'
 import type { MutationOptions, NotifyEvent } from './types'
 import type { QueryClient } from './queryClient'
-import { notifyManager } from './notifyManager'
 import type { Action, MutationState } from './mutation'
-import { Mutation } from './mutation'
 import type { MutationFilters } from './utils'
-import { matchMutation, noop } from './utils'
-import { Subscribable } from './subscribable'
 
 // TYPES
 

package/src/mutationObserver.ts

@@ -1,15 +1,15 @@
-import type { Action, Mutation } from './mutation'
 import { getDefaultState } from './mutation'
 import { notifyManager } from './notifyManager'
-import type { QueryClient } from './queryClient'
 import { Subscribable } from './subscribable'
+import { shallowEqualObjects } from './utils'
+import type { QueryClient } from './queryClient'
 import type {
   MutateOptions,
   MutationObserverBaseResult,
-  MutationObserverResult,
   MutationObserverOptions,
+  MutationObserverResult,
 } from './types'
-import { shallowEqualObjects } from './utils'
+import type { Action, Mutation } from './mutation'
 
 // TYPES
 

package/src/queriesObserver.ts

@@ -1,14 +1,14 @@
 import { difference, replaceAt } from './utils'
 import { notifyManager } from './notifyManager'
+import { QueryObserver } from './queryObserver'
+import { Subscribable } from './subscribable'
 import type {
+  DefaultedQueryObserverOptions,
   QueryObserverOptions,
   QueryObserverResult,
-  DefaultedQueryObserverOptions,
 } from './types'
 import type { QueryClient } from './queryClient'
 import type { NotifyOptions } from './queryObserver'
-import { QueryObserver } from './queryObserver'
-import { Subscribable } from './subscribable'
 
 type QueriesObserverListener = (result: QueryObserverResult[]) => void
 

package/src/query.ts

@@ -1,23 +1,23 @@
 import { getAbortController, noop, replaceData, timeUntilStale } from './utils'
+import { defaultLogger } from './logger'
+import { notifyManager } from './notifyManager'
+import { canFetch, createRetryer, isCancelledError } from './retryer'
+import { Removable } from './removable'
 import type {
+  CancelOptions,
+  FetchStatus,
   InitialDataFunction,
+  QueryFunctionContext,
   QueryKey,
+  QueryMeta,
   QueryOptions,
   QueryStatus,
-  QueryFunctionContext,
-  QueryMeta,
-  CancelOptions,
   SetDataOptions,
-  FetchStatus,
 } from './types'
 import type { QueryCache } from './queryCache'
 import type { QueryObserver } from './queryObserver'
 import type { Logger } from './logger'
-import { defaultLogger } from './logger'
-import { notifyManager } from './notifyManager'
 import type { Retryer } from './retryer'
-import { isCancelledError, canFetch, createRetryer } from './retryer'
-import { Removable } from './removable'
 
 // TYPES
 

package/src/queryCache.ts

@@ -1,11 +1,11 @@
-import type { QueryFilters } from './utils'
 import { hashQueryKeyByOptions, matchQuery, parseFilterArgs } from './utils'
-import type { Action, QueryState } from './query'
 import { Query } from './query'
-import type { NotifyEvent, QueryKey, QueryOptions } from './types'
 import { notifyManager } from './notifyManager'
-import type { QueryClient } from './queryClient'
 import { Subscribable } from './subscribable'
+import type { QueryFilters } from './utils'
+import type { Action, QueryState } from './query'
+import type { NotifyEvent, QueryKey, QueryOptions } from './types'
+import type { QueryClient } from './queryClient'
 import type { QueryObserver } from './queryObserver'
 
 // TYPES

package/src/queryClient.ts

@@ -1,15 +1,23 @@
-import type { QueryFilters, Updater, MutationFilters } from './utils'
 import {
+  functionalUpdate,
   hashQueryKey,
+  hashQueryKeyByOptions,
   noop,
   parseFilterArgs,
   parseQueryArgs,
   partialMatchKey,
-  hashQueryKeyByOptions,
-  functionalUpdate,
 } from './utils'
+import { QueryCache } from './queryCache'
+import { MutationCache } from './mutationCache'
+import { focusManager } from './focusManager'
+import { onlineManager } from './onlineManager'
+import { notifyManager } from './notifyManager'
+import { infiniteQueryBehavior } from './infiniteQueryBehavior'
+import { defaultLogger } from './logger'
+import type { CancelOptions, DefaultedQueryObserverOptions } from './types'
+import type { Logger } from './logger'
+import type { QueryState } from './query'
 import type {
-  QueryClientConfig,
   DefaultOptions,
   FetchInfiniteQueryOptions,
   FetchQueryOptions,
@@ -19,6 +27,7 @@ import type {
   MutationKey,
   MutationObserverOptions,
   MutationOptions,
+  QueryClientConfig,
   QueryFunction,
   QueryKey,
   QueryObserverOptions,
@@ -30,16 +39,7 @@ import type {
   SetDataOptions,
   WithRequired,
 } from './types'
-import type { QueryState } from './query'
-import { QueryCache } from './queryCache'
-import { MutationCache } from './mutationCache'
-import { focusManager } from './focusManager'
-import { onlineManager } from './onlineManager'
-import { notifyManager } from './notifyManager'
-import { infiniteQueryBehavior } from './infiniteQueryBehavior'
-import type { CancelOptions, DefaultedQueryObserverOptions } from './types'
-import type { Logger } from './logger'
-import { defaultLogger } from './logger'
+import type { MutationFilters, QueryFilters, Updater } from './utils'
 
 // TYPES
 

package/src/queryObserver.ts

@@ -1,4 +1,3 @@
-import type { DefaultedQueryObserverOptions, RefetchPageFilters } from './types'
 import {
   isServer,
   isValidTimeout,
@@ -8,6 +7,9 @@ import {
   timeUntilStale,
 } from './utils'
 import { notifyManager } from './notifyManager'
+import { focusManager } from './focusManager'
+import { Subscribable } from './subscribable'
+import { canFetch, isCancelledError } from './retryer'
 import type {
   PlaceholderDataFunction,
   QueryKey,
@@ -17,11 +19,9 @@ import type {
   QueryOptions,
   RefetchOptions,
 } from './types'
-import type { Query, QueryState, Action, FetchOptions } from './query'
+import type { Action, FetchOptions, Query, QueryState } from './query'
 import type { QueryClient } from './queryClient'
-import { focusManager } from './focusManager'
-import { Subscribable } from './subscribable'
-import { canFetch, isCancelledError } from './retryer'
+import type { DefaultedQueryObserverOptions, RefetchPageFilters } from './types'
 
 type QueryObserverListener<TData, TError> = (
   result: QueryObserverResult<TData, TError>,
@@ -637,15 +637,21 @@ export class QueryObserver<
       }
 
       const { notifyOnChangeProps } = this.options
+      const notifyOnChangePropsValue =
+        typeof notifyOnChangeProps === 'function'
+          ? notifyOnChangeProps()
+          : notifyOnChangeProps
 
       if (
-        notifyOnChangeProps === 'all' ||
-        (!notifyOnChangeProps && !this.trackedProps.size)
+        notifyOnChangePropsValue === 'all' ||
+        (!notifyOnChangePropsValue && !this.trackedProps.size)
       ) {
         return true
       }
 
-      const includedProps = new Set(notifyOnChangeProps ?? this.trackedProps)
+      const includedProps = new Set(
+        notifyOnChangePropsValue ?? this.trackedProps,
+      )
 
       if (this.options.useErrorBoundary) {
         includedProps.add('error')

package/src/tests/hydration.test.tsx

@@ -1,11 +1,11 @@
+import { QueryCache } from '../queryCache'
+import { dehydrate, hydrate } from '../hydration'
 import {
   createQueryClient,
   executeMutation,
   mockNavigatorOnLine,
   sleep,
 } from './utils'
-import { QueryCache } from '../queryCache'
-import { dehydrate, hydrate } from '../hydration'
 
 async function fetchData<TData>(value: TData, ms?: number): Promise<TData> {
   await sleep(ms || 0)

package/src/tests/infiniteQueryBehavior.test.tsx

@@ -1,11 +1,11 @@
 import { waitFor } from '@testing-library/react'
+import { InfiniteQueryObserver } from '@tanstack/query-core'
+import { createQueryClient, queryKey } from './utils'
 import type {
-  QueryClient,
   InfiniteQueryObserverResult,
   QueryCache,
+  QueryClient,
 } from '@tanstack/query-core'
-import { InfiniteQueryObserver } from '@tanstack/query-core'
-import { createQueryClient, queryKey } from './utils'
 
 describe('InfiniteQueryBehavior', () => {
   let queryClient: QueryClient

package/src/tests/infiniteQueryObserver.test.tsx

@@ -1,6 +1,6 @@
+import { InfiniteQueryObserver } from '..'
 import { createQueryClient, queryKey, sleep } from './utils'
 import type { QueryClient } from '..'
-import { InfiniteQueryObserver } from '..'
 
 describe('InfiniteQueryObserver', () => {
   let queryClient: QueryClient

package/src/tests/mutationCache.test.tsx

@@ -1,6 +1,6 @@
 import { waitFor } from '@testing-library/react'
-import { queryKey, sleep, executeMutation, createQueryClient } from './utils'
 import { MutationCache, MutationObserver } from '..'
+import { createQueryClient, executeMutation, queryKey, sleep } from './utils'
 
 describe('mutationCache', () => {
   describe('MutationCacheConfig error callbacks', () => {

package/src/tests/mutationObserver.test.tsx

@@ -1,7 +1,7 @@
 import { waitFor } from '@testing-library/react'
+import { MutationObserver } from '..'
 import { createQueryClient, sleep } from './utils'
 import type { QueryClient } from '..'
-import { MutationObserver } from '..'
 
 describe('mutationObserver', () => {
   let queryClient: QueryClient

package/src/tests/mutations.test.tsx

@@ -1,8 +1,8 @@
-import type { QueryClient } from '..'
+import { waitFor } from '@testing-library/react'
+import { MutationObserver } from '../mutationObserver'
 import { createQueryClient, executeMutation, queryKey, sleep } from './utils'
+import type { QueryClient } from '..'
 import type { MutationState } from '../mutation'
-import { MutationObserver } from '../mutationObserver'
-import { waitFor } from '@testing-library/react'
 
 describe('mutations', () => {
   let queryClient: QueryClient

package/src/tests/queriesObserver.test.tsx

@@ -1,7 +1,7 @@
 import { waitFor } from '@testing-library/react'
-import { sleep, queryKey, createQueryClient, mockLogger } from './utils'
-import type { QueryClient, QueryObserverResult } from '..'
 import { QueriesObserver, QueryObserver } from '..'
+import { createQueryClient, mockLogger, queryKey, sleep } from './utils'
+import type { QueryClient, QueryObserverResult } from '..'
 import type { QueryKey } from '..'
 
 describe('queriesObserver', () => {

package/src/tests/query.test.tsx

@@ -1,9 +1,11 @@
+import { waitFor } from '@testing-library/react'
+import { QueryObserver, isCancelledError, isError, onlineManager } from '..'
 import {
-  sleep,
-  queryKey,
-  mockVisibilityState,
-  mockLogger,
   createQueryClient,
+  mockLogger,
+  mockVisibilityState,
+  queryKey,
+  sleep,
 } from './utils'
 import type {
   QueryCache,
@@ -11,8 +13,6 @@ import type {
   QueryFunctionContext,
   QueryObserverResult,
 } from '..'
-import { QueryObserver, isCancelledError, isError, onlineManager } from '..'
-import { waitFor } from '@testing-library/react'
 
 describe('query', () => {
   let queryClient: QueryClient

package/src/tests/queryCache.test.tsx

@@ -1,8 +1,8 @@
-import { sleep, queryKey, createQueryClient } from './utils'
-import type { QueryClient } from '..'
+import { waitFor } from '@testing-library/react'
 import { QueryCache, QueryObserver } from '..'
+import { createQueryClient, queryKey, sleep } from './utils'
+import type { QueryClient } from '..'
 import type { Query } from '.././query'
-import { waitFor } from '@testing-library/react'
 
 describe('queryCache', () => {
   let queryClient: QueryClient

package/src/tests/queryClient.test.tsx

@@ -1,16 +1,16 @@
 import { waitFor } from '@testing-library/react'
 import '@testing-library/jest-dom'
 
-import { sleep, queryKey, mockLogger, createQueryClient } from './utils'
+import { InfiniteQueryObserver, MutationObserver, QueryObserver } from '..'
+import { focusManager, onlineManager } from '..'
+import { noop } from '../utils'
+import { createQueryClient, mockLogger, queryKey, sleep } from './utils'
 import type {
   QueryCache,
   QueryClient,
   QueryFunction,
   QueryObserverOptions,
 } from '..'
-import { InfiniteQueryObserver, MutationObserver, QueryObserver } from '..'
-import { focusManager, onlineManager } from '..'
-import { noop } from '../utils'
 
 describe('queryClient', () => {
   let queryClient: QueryClient

package/src/tests/queryObserver.test.tsx

@@ -1,12 +1,12 @@
+import { QueryObserver, focusManager } from '..'
 import {
-  sleep,
-  queryKey,
+  createQueryClient,
   expectType,
   mockLogger,
-  createQueryClient,
+  queryKey,
+  sleep,
 } from './utils'
 import type { QueryClient, QueryObserverResult } from '..'
-import { QueryObserver, focusManager } from '..'
 
 describe('queryObserver', () => {
   let queryClient: QueryClient

package/src/tests/utils.test.tsx

@@ -1,12 +1,12 @@
 import {
-  replaceEqualDeep,
-  partialDeepEqual,
+  isPlainArray,
   isPlainObject,
-  parseMutationArgs,
   matchMutation,
+  parseMutationArgs,
+  partialDeepEqual,
+  replaceEqualDeep,
   scheduleMicrotask,
   sleep,
-  isPlainArray,
 } from '../utils'
 import { Mutation } from '../mutation'
 import { createQueryClient } from './utils'

package/src/tests/utils.ts

@@ -1,8 +1,8 @@
 import { act } from '@testing-library/react'
 
-import type { MutationOptions, QueryClientConfig } from '@tanstack/query-core'
 import { QueryClient } from '@tanstack/query-core'
 import * as utils from '../utils'
+import type { MutationOptions, QueryClientConfig } from '@tanstack/query-core'
 
 export function createQueryClient(config?: QueryClientConfig): QueryClient {
   jest.spyOn(console, 'error').mockImplementation(() => undefined)

package/src/types.ts

@@ -1,8 +1,8 @@
 /* istanbul ignore file */
 
 import type { MutationState } from './mutation'
-import type { QueryBehavior, Query } from './query'
-import type { RetryValue, RetryDelayValue } from './retryer'
+import type { Query, QueryBehavior } from './query'
+import type { RetryDelayValue, RetryValue } from './retryer'
 import type { QueryFilters, QueryTypeFilter } from './utils'
 import type { QueryCache } from './queryCache'
 import type { MutationCache } from './mutationCache'
@@ -55,6 +55,11 @@ export interface QueryMeta {
 
 export type NetworkMode = 'online' | 'always' | 'offlineFirst'
 
+export type NotifyOnChangeProps =
+  | Array<keyof InfiniteQueryObserverResult>
+  | 'all'
+  | (() => Array<keyof InfiniteQueryObserverResult> | 'all')
+
 export interface QueryOptions<
   TQueryFnData = unknown,
   TError = unknown,
@@ -200,9 +205,10 @@ export interface QueryObserverOptions<
    * If set, the component will only re-render if any of the listed properties change.
    * When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change.
    * When set to `'all'`, the component will re-render whenever a query is updated.
+   * When set to a function, the function will be executed to compute the list of properties.
    * By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
    */
-  notifyOnChangeProps?: Array<keyof InfiniteQueryObserverResult> | 'all'
+  notifyOnChangeProps?: NotifyOnChangeProps
   /**
    * This callback will fire any time the query successfully fetches new data.
    *