@tanstack/query-core 5.28.6 → 5.28.9

package/build/modern/types.d.ts

@@ -1,3 +1,3 @@
-export { aI as CancelOptions, v as DataTag, D as DefaultError, aH as DefaultOptions, _ as DefaultedInfiniteQueryObserverOptions, Y as DefaultedQueryObserverOptions, aq as DefinedInfiniteQueryObserverResult, ai as DefinedQueryObserverResult, a0 as EnsureQueryDataOptions, a1 as FetchInfiniteQueryOptions, a8 as FetchNextPageOptions, a9 as FetchPreviousPageOptions, $ as FetchQueryOptions, ab as FetchStatus, B as GetNextPageParamFunction, G as GetPreviousPageParamFunction, E as InfiniteData, ak as InfiniteQueryObserverBaseResult, an as InfiniteQueryObserverLoadingErrorResult, am as InfiniteQueryObserverLoadingResult, Z as InfiniteQueryObserverOptions, al as InfiniteQueryObserverPendingResult, ao as InfiniteQueryObserverRefetchErrorResult, ar as InfiniteQueryObserverResult, ap as InfiniteQueryObserverSuccessResult, O as InfiniteQueryPageParamsOptions, I as InitialDataFunction, L as InitialPageParam, a6 as InvalidateOptions, a4 as InvalidateQueryFilters, az as MutateFunction, ay as MutateOptions, av as MutationFunction, as as MutationKey, au as MutationMeta, aA as MutationObserverBaseResult, aD as MutationObserverErrorResult, aB as MutationObserverIdleResult, aC as MutationObserverLoadingResult, ax as MutationObserverOptions, aF as MutationObserverResult, aE as MutationObserverSuccessResult, aw as MutationOptions, at as MutationStatus, H as NetworkMode, N as NoInfer, aL as NotifyEvent, aK as NotifyEventType, J as NotifyOnChangeProps, X as Optional, P as PlaceholderDataFunction, z as QueriesPlaceholderDataFunction, aG as QueryClientConfig, w as QueryFunction, y as QueryFunctionContext, t as QueryKey, A as QueryKeyHashFunction, F as QueryMeta, ac as QueryObserverBaseResult, af as QueryObserverLoadingErrorResult, ae as QueryObserverLoadingResult, V as QueryObserverOptions, ad as QueryObserverPendingResult, ag as QueryObserverRefetchErrorResult, aj as QueryObserverResult, ah as QueryObserverSuccessResult, K as QueryOptions, x as QueryPersister, aa as QueryStatus, a3 as RefetchOptions, a5 as RefetchQueryFilters, R as Register, a7 as ResetOptions, a2 as ResultOptions, aJ as SetDataOptions, T as ThrowOnError, W as WithRequired, u as dataTagSymbol } from './queryClient-6vLRMq5C.js';
+export { aJ as CancelOptions, v as DataTag, D as DefaultError, aI as DefaultOptions, $ as DefaultedInfiniteQueryObserverOptions, Z as DefaultedQueryObserverOptions, ar as DefinedInfiniteQueryObserverResult, aj as DefinedQueryObserverResult, a1 as EnsureQueryDataOptions, a2 as FetchInfiniteQueryOptions, a9 as FetchNextPageOptions, aa as FetchPreviousPageOptions, a0 as FetchQueryOptions, ac as FetchStatus, B as GetNextPageParamFunction, G as GetPreviousPageParamFunction, E as InfiniteData, al as InfiniteQueryObserverBaseResult, ao as InfiniteQueryObserverLoadingErrorResult, an as InfiniteQueryObserverLoadingResult, _ as InfiniteQueryObserverOptions, am as InfiniteQueryObserverPendingResult, ap as InfiniteQueryObserverRefetchErrorResult, as as InfiniteQueryObserverResult, aq as InfiniteQueryObserverSuccessResult, T as InfiniteQueryPageParamsOptions, I as InitialDataFunction, L as InitialPageParam, a7 as InvalidateOptions, a5 as InvalidateQueryFilters, aA as MutateFunction, az as MutateOptions, aw as MutationFunction, at as MutationKey, av as MutationMeta, aB as MutationObserverBaseResult, aE as MutationObserverErrorResult, aC as MutationObserverIdleResult, aD as MutationObserverLoadingResult, ay as MutationObserverOptions, aG as MutationObserverResult, aF as MutationObserverSuccessResult, ax as MutationOptions, au as MutationStatus, H as NetworkMode, N as NoInfer, aM as NotifyEvent, aL as NotifyEventType, J as NotifyOnChangeProps, O as OmitKeyof, Y as Optional, P as PlaceholderDataFunction, z as QueriesPlaceholderDataFunction, aH as QueryClientConfig, w as QueryFunction, y as QueryFunctionContext, t as QueryKey, A as QueryKeyHashFunction, F as QueryMeta, ad as QueryObserverBaseResult, ag as QueryObserverLoadingErrorResult, af as QueryObserverLoadingResult, W as QueryObserverOptions, ae as QueryObserverPendingResult, ah as QueryObserverRefetchErrorResult, ak as QueryObserverResult, ai as QueryObserverSuccessResult, K as QueryOptions, x as QueryPersister, ab as QueryStatus, a4 as RefetchOptions, a6 as RefetchQueryFilters, R as Register, a8 as ResetOptions, a3 as ResultOptions, aK as SetDataOptions, V as ThrowOnError, X as WithRequired, u as dataTagSymbol } from './queryClient-Iu1tSaKE.js';
 import './removable.js';
 import './subscribable.js';

package/build/modern/utils.d.cts

@@ -1,3 +1,3 @@
-export { g as MutationFilters, j as QueryFilters, aP as QueryTypeFilter, S as SkipToken, U as Updater, a$ as addToEnd, b0 as addToStart, aR as functionalUpdate, h as hashKey, aU as hashQueryKeyByOptions, aX as isPlainArray, aY as isPlainObject, i as isServer, aS as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, aQ as noop, aV as partialMatchKey, a_ as replaceData, r as replaceEqualDeep, aW as shallowEqualObjects, s as skipToken, aZ as sleep, aT as timeUntilStale } from './queryClient-C_S9rQE6.cjs';
+export { g as MutationFilters, j as QueryFilters, aQ as QueryTypeFilter, S as SkipToken, U as Updater, b0 as addToEnd, b1 as addToStart, aS as functionalUpdate, h as hashKey, aV as hashQueryKeyByOptions, aY as isPlainArray, aZ as isPlainObject, i as isServer, aT as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, aR as noop, aW as partialMatchKey, a$ as replaceData, r as replaceEqualDeep, aX as shallowEqualObjects, s as skipToken, a_ as sleep, aU as timeUntilStale } from './queryClient-nKFaeeO2.cjs';
 import './removable.cjs';
 import './subscribable.cjs';

package/build/modern/utils.d.ts

@@ -1,3 +1,3 @@
-export { g as MutationFilters, j as QueryFilters, aP as QueryTypeFilter, S as SkipToken, U as Updater, a$ as addToEnd, b0 as addToStart, aR as functionalUpdate, h as hashKey, aU as hashQueryKeyByOptions, aX as isPlainArray, aY as isPlainObject, i as isServer, aS as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, aQ as noop, aV as partialMatchKey, a_ as replaceData, r as replaceEqualDeep, aW as shallowEqualObjects, s as skipToken, aZ as sleep, aT as timeUntilStale } from './queryClient-6vLRMq5C.js';
+export { g as MutationFilters, j as QueryFilters, aQ as QueryTypeFilter, S as SkipToken, U as Updater, b0 as addToEnd, b1 as addToStart, aS as functionalUpdate, h as hashKey, aV as hashQueryKeyByOptions, aY as isPlainArray, aZ as isPlainObject, i as isServer, aT as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, aR as noop, aW as partialMatchKey, a$ as replaceData, r as replaceEqualDeep, aX as shallowEqualObjects, s as skipToken, a_ as sleep, aU as timeUntilStale } from './queryClient-Iu1tSaKE.js';
 import './removable.js';
 import './subscribable.js';

package/package.json

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

package/src/__tests__/OmitKeyof.test-d.ts

@@ -0,0 +1,59 @@
+import { describe, expectTypeOf, it } from 'vitest'
+import type { OmitKeyof } from '..'
+
+describe('OmitKeyof', () => {
+  it("'s type check", () => {
+    type A = {
+      x: string
+      y: number
+    }
+
+    type ExpectedType = {
+      x: string
+    }
+
+    // Bad point
+    // 1. original Omit can use 'z' as type parameter with no type error
+    // 2. original Omit have no auto complete for 2nd type parameter
+    expectTypeOf<Omit<A, 'z' | 'y'>>().toEqualTypeOf<ExpectedType>()
+
+    // Solution
+
+    // 1. strictly
+    expectTypeOf<
+      OmitKeyof<
+        A,
+        // OmitKeyof can't use 'z' as type parameter with type error because A don't have key 'z'
+        // @ts-expect-error Type does not satisfy the constraint keyof A
+        'z' | 'y'
+      >
+    >().toEqualTypeOf<ExpectedType>
+    expectTypeOf<
+      OmitKeyof<
+        A,
+        // OmitKeyof can't use 'z' as type parameter with type error because A don't have key 'z'
+        // @ts-expect-error Type does not satisfy the constraint keyof A
+        'z' | 'y',
+        'strictly'
+      >
+    >().toEqualTypeOf<ExpectedType>
+
+    // 2. safely
+    expectTypeOf<
+      OmitKeyof<
+        A,
+        // OmitKeyof can't use 'z' as type parameter type error with strictly parameter or default parameter
+        // @ts-expect-error Type does not satisfy the constraint keyof A
+        'z' | 'y'
+      >
+    >().toEqualTypeOf<ExpectedType>
+    expectTypeOf<
+      OmitKeyof<
+        A,
+        // With 'safely', OmitKeyof can use 'z' as type parameter like original Omit but This support autocomplete too yet for DX.
+        'z' | 'y',
+        'safely'
+      >
+    >().toEqualTypeOf<ExpectedType>
+  })
+})

package/src/infiniteQueryBehavior.ts

@@ -3,6 +3,7 @@ import type { QueryBehavior } from './query'
 import type {
   InfiniteData,
   InfiniteQueryPageParamsOptions,
+  OmitKeyof,
   QueryFunctionContext,
   QueryKey,
 } from './types'
@@ -67,7 +68,7 @@ export function infiniteQueryBehavior<TQueryFnData, TError, TData, TPageParam>(
             return Promise.resolve(data)
           }
 
-          const queryFnContext: Omit<
+          const queryFnContext: OmitKeyof<
             QueryFunctionContext<QueryKey, unknown>,
             'signal'
           > = {

package/src/query.ts

@@ -7,6 +7,7 @@ import type {
   DefaultError,
   FetchStatus,
   InitialDataFunction,
+  OmitKeyof,
   QueryFunctionContext,
   QueryKey,
   QueryMeta,
@@ -370,7 +371,10 @@ export class Query<
     const abortController = new AbortController()
 
     // Create query function context
-    const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
+    const queryFnContext: OmitKeyof<
+      QueryFunctionContext<TQueryKey>,
+      'signal'
+    > = {
       queryKey: this.queryKey,
       meta: this.meta,
     }
@@ -421,7 +425,7 @@ export class Query<
     }
 
     // Trigger behavior hook
-    const context: Omit<
+    const context: OmitKeyof<
       FetchContext<TQueryFnData, TError, TData, TQueryKey>,
       'signal'
     > = {

package/src/queryClient.ts

@@ -12,7 +12,7 @@ import { focusManager } from './focusManager'
 import { onlineManager } from './onlineManager'
 import { notifyManager } from './notifyManager'
 import { infiniteQueryBehavior } from './infiniteQueryBehavior'
-import type { DataTag, NoInfer } from './types'
+import type { DataTag, NoInfer, OmitKeyof } from './types'
 import type { QueryState } from './query'
 import type {
   CancelOptions,
@@ -43,7 +43,7 @@ import type { MutationFilters, QueryFilters, Updater } from './utils'
 
 interface QueryDefaults {
   queryKey: QueryKey
-  defaultOptions: Omit<QueryOptions<any, any, any>, 'queryKey'>
+  defaultOptions: OmitKeyof<QueryOptions<any, any, any>, 'queryKey'>
 }
 
 interface MutationDefaults {
@@ -154,12 +154,10 @@ export class QueryClient {
   getQueriesData<TQueryFnData = unknown>(
     filters: QueryFilters,
   ): Array<[QueryKey, TQueryFnData | undefined]> {
-    return this.getQueryCache()
-      .findAll(filters)
-      .map(({ queryKey, state }) => {
-        const data = state.data as TQueryFnData | undefined
-        return [queryKey, data]
-      })
+    return this.#queryCache.findAll(filters).map(({ queryKey, state }) => {
+      const data = state.data as TQueryFnData | undefined
+      return [queryKey, data]
+    })
   }
 
   setQueryData<
@@ -208,7 +206,7 @@ export class QueryClient {
     options?: SetDataOptions,
   ): Array<[QueryKey, TQueryFnData | undefined]> {
     return notifyManager.batch(() =>
-      this.getQueryCache()
+      this.#queryCache
         .findAll(filters)
         .map(({ queryKey }) => [
           queryKey,
@@ -429,7 +427,7 @@ export class QueryClient {
   setQueryDefaults(
     queryKey: QueryKey,
     options: Partial<
-      Omit<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>
+      OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>
     >,
   ): void {
     this.#queryDefaults.set(hashKey(queryKey), {
@@ -440,10 +438,10 @@ export class QueryClient {
 
   getQueryDefaults(
     queryKey: QueryKey,
-  ): Omit<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {
+  ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {
     const defaults = [...this.#queryDefaults.values()]
 
-    let result: Omit<
+    let result: OmitKeyof<
       QueryObserverOptions<any, any, any, any, any>,
       'queryKey'
     > = {}
@@ -458,7 +456,10 @@ export class QueryClient {
 
   setMutationDefaults(
     mutationKey: MutationKey,
-    options: Omit<MutationObserverOptions<any, any, any, any>, 'mutationKey'>,
+    options: OmitKeyof<
+      MutationObserverOptions<any, any, any, any>,
+      'mutationKey'
+    >,
   ): void {
     this.#mutationDefaults.set(hashKey(mutationKey), {
       mutationKey,

package/src/types.ts

@@ -7,6 +7,14 @@ import type { QueryFilters, QueryTypeFilter, SkipToken } from './utils'
 import type { QueryCache } from './queryCache'
 import type { MutationCache } from './mutationCache'
 
+export type OmitKeyof<
+  TObject,
+  TKey extends TStrictly extends 'safely'
+    ? keyof TObject | (string & Record<never, never>)
+    : keyof TObject,
+  TStrictly extends 'strictly' | 'safely' = 'strictly',
+> = Omit<TObject, TKey>
+
 export type NoInfer<T> = [T][T extends any ? 0 : never]
 
 export interface Register {
@@ -341,7 +349,7 @@ export type Optional<TTarget, TKey extends keyof TTarget> = Pick<
   Partial<TTarget>,
   TKey
 > &
-  Omit<TTarget, TKey>
+  OmitKeyof<TTarget, TKey>
 
 export type DefaultedQueryObserverOptions<
   TQueryFnData = unknown,
@@ -889,7 +897,10 @@ export interface QueryClientConfig {
 }
 
 export interface DefaultOptions<TError = DefaultError> {
-  queries?: Omit<QueryObserverOptions<unknown, TError>, 'suspense' | 'queryKey'>
+  queries?: OmitKeyof<
+    QueryObserverOptions<unknown, TError>,
+    'suspense' | 'queryKey'
+  >
   mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>
 }