@tanstack/query-core 5.0.0-alpha.1 → 5.0.0-alpha.2

package/build/lib/types.d.ts

@@ -6,7 +6,7 @@ import type { QueryCache } from './queryCache';
 import type { MutationCache } from './mutationCache';
 export interface Register {
 }
-export declare type RegisteredError = Register extends {
+export declare type DefaultError = Register extends {
     defaultError: infer TError;
 } ? TError : Error;
 export declare type QueryKey = readonly unknown[];
@@ -32,11 +32,11 @@ export interface InfiniteData<TData> {
     pages: TData[];
     pageParams: unknown[];
 }
-export interface QueryMeta {
-    [index: string]: unknown;
-}
+export declare type QueryMeta = Register extends {
+    queryMeta: infer TQueryMeta;
+} ? TQueryMeta extends Record<string, unknown> ? TQueryMeta : Record<string, unknown> : Record<string, unknown>;
 export declare type NetworkMode = 'online' | 'always' | 'offlineFirst';
-export interface QueryOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
+export interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
     /**
      * If `false`, failed queries will not retry by default.
      * If `true`, failed queries will retry infinitely., failureCount: num
@@ -87,7 +87,7 @@ export interface InfiniteQueryPageParamsOptions<TQueryFnData = unknown, TPagePar
     getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
 }
 export declare type ThrowErrors<TQueryFnData, TError, TQueryData, TQueryKey extends QueryKey> = boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean);
-export interface QueryObserverOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam> {
+export interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam> {
     /**
      * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
      * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
@@ -183,18 +183,18 @@ export interface QueryObserverOptions<TQueryFnData = unknown, TError = Registere
     _optimisticResults?: 'optimistic' | 'isRestoring';
 }
 export declare type WithRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-export declare type DefaultedQueryObserverOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwErrors' | 'refetchOnReconnect'>;
-export interface InfiniteQueryObserverOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData>, TQueryKey, TPageParam>, InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {
+export declare type DefaultedQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwErrors' | 'refetchOnReconnect'>;
+export interface InfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData>, TQueryKey, TPageParam>, InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {
 }
-export declare type DefaultedInfiniteQueryObserverOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwErrors' | 'refetchOnReconnect'>;
-export interface FetchQueryOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey'> {
+export declare type DefaultedInfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwErrors' | 'refetchOnReconnect'>;
+export interface FetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey'> {
     /**
      * The time in milliseconds after data is considered stale.
      * If the data is fresh it will be returned from the cache.
      */
     staleTime?: number;
 }
-export interface FetchInfiniteQueryOptions<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData>, TQueryKey, TPageParam>, DefaultPageParam<TPageParam> {
+export interface FetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData>, TQueryKey, TPageParam>, DefaultPageParam<TPageParam> {
 }
 export interface ResultOptions {
     throwOnError?: boolean;
@@ -219,7 +219,7 @@ export interface FetchPreviousPageOptions extends ResultOptions {
 }
 export declare type QueryStatus = 'pending' | 'error' | 'success';
 export declare type FetchStatus = 'fetching' | 'paused' | 'idle';
-export interface QueryObserverBaseResult<TData = unknown, TError = RegisteredError> {
+export interface QueryObserverBaseResult<TData = unknown, TError = DefaultError> {
     data: TData | undefined;
     dataUpdatedAt: number;
     error: TError | null;
@@ -249,7 +249,7 @@ export interface QueryObserverBaseResult<TData = unknown, TError = RegisteredErr
     status: QueryStatus;
     fetchStatus: FetchStatus;
 }
-export interface QueryObserverLoadingResult<TData = unknown, TError = RegisteredError> extends QueryObserverBaseResult<TData, TError> {
+export interface QueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
     data: undefined;
     error: null;
     isError: false;
@@ -259,7 +259,7 @@ export interface QueryObserverLoadingResult<TData = unknown, TError = Registered
     isSuccess: false;
     status: 'pending';
 }
-export interface QueryObserverLoadingErrorResult<TData = unknown, TError = RegisteredError> extends QueryObserverBaseResult<TData, TError> {
+export interface QueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
     data: undefined;
     error: TError;
     isError: true;
@@ -269,7 +269,7 @@ export interface QueryObserverLoadingErrorResult<TData = unknown, TError = Regis
     isSuccess: false;
     status: 'error';
 }
-export interface QueryObserverRefetchErrorResult<TData = unknown, TError = RegisteredError> extends QueryObserverBaseResult<TData, TError> {
+export interface QueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
     data: TData;
     error: TError;
     isError: true;
@@ -279,7 +279,7 @@ export interface QueryObserverRefetchErrorResult<TData = unknown, TError = Regis
     isSuccess: false;
     status: 'error';
 }
-export interface QueryObserverSuccessResult<TData = unknown, TError = RegisteredError> extends QueryObserverBaseResult<TData, TError> {
+export interface QueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
     data: TData;
     error: null;
     isError: false;
@@ -289,9 +289,9 @@ export interface QueryObserverSuccessResult<TData = unknown, TError = Registered
     isSuccess: true;
     status: 'success';
 }
-export declare type DefinedQueryObserverResult<TData = unknown, TError = RegisteredError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
-export declare type QueryObserverResult<TData = unknown, TError = RegisteredError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError>;
-export interface InfiniteQueryObserverBaseResult<TData = unknown, TError = RegisteredError> extends QueryObserverBaseResult<TData, TError> {
+export declare type DefinedQueryObserverResult<TData = unknown, TError = DefaultError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
+export declare type QueryObserverResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError>;
+export interface InfiniteQueryObserverBaseResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
     fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
     fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
     hasNextPage: boolean;
@@ -299,7 +299,7 @@ export interface InfiniteQueryObserverBaseResult<TData = unknown, TError = Regis
     isFetchingNextPage: boolean;
     isFetchingPreviousPage: boolean;
 }
-export interface InfiniteQueryObserverLoadingResult<TData = unknown, TError = RegisteredError> extends InfiniteQueryObserverBaseResult<TData, TError> {
+export interface InfiniteQueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
     data: undefined;
     error: null;
     isError: false;
@@ -309,7 +309,7 @@ export interface InfiniteQueryObserverLoadingResult<TData = unknown, TError = Re
     isSuccess: false;
     status: 'pending';
 }
-export interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError = RegisteredError> extends InfiniteQueryObserverBaseResult<TData, TError> {
+export interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
     data: undefined;
     error: TError;
     isError: true;
@@ -319,7 +319,7 @@ export interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError
     isSuccess: false;
     status: 'error';
 }
-export interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError = RegisteredError> extends InfiniteQueryObserverBaseResult<TData, TError> {
+export interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
     data: TData;
     error: TError;
     isError: true;
@@ -329,7 +329,7 @@ export interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError
     isSuccess: false;
     status: 'error';
 }
-export interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = RegisteredError> extends InfiniteQueryObserverBaseResult<TData, TError> {
+export interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
     data: TData;
     error: null;
     isError: false;
@@ -339,14 +339,14 @@ export interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = Re
     isSuccess: true;
     status: 'success';
 }
-export declare type InfiniteQueryObserverResult<TData = unknown, TError = RegisteredError> = InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>;
+export declare type InfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>;
 export declare type MutationKey = readonly unknown[];
 export declare type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
-export interface MutationMeta {
-    [index: string]: unknown;
-}
+export declare type MutationMeta = Register extends {
+    mutationMeta: infer TMutationMeta;
+} ? TMutationMeta : Record<string, unknown>;
 export declare type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData>;
-export interface MutationOptions<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> {
+export interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
     mutationFn?: MutationFunction<TData, TVariables>;
     mutationKey?: MutationKey;
     onMutate?: (variables: TVariables) => Promise<TContext | undefined> | TContext | undefined;
@@ -360,16 +360,16 @@ export interface MutationOptions<TData = unknown, TError = RegisteredError, TVar
     _defaulted?: boolean;
     meta?: MutationMeta;
 }
-export interface MutationObserverOptions<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationOptions<TData, TError, TVariables, TContext> {
+export interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationOptions<TData, TError, TVariables, TContext> {
     throwErrors?: boolean | ((error: TError) => boolean);
 }
-export interface MutateOptions<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> {
+export interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
     onSuccess?: (data: TData, variables: TVariables, context: TContext) => void;
     onError?: (error: TError, variables: TVariables, context: TContext | undefined) => void;
     onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => void;
 }
-export declare type MutateFunction<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>;
-export interface MutationObserverBaseResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationState<TData, TError, TVariables, TContext> {
+export declare type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>;
+export interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationState<TData, TError, TVariables, TContext> {
     isError: boolean;
     isIdle: boolean;
     isPending: boolean;
@@ -377,7 +377,7 @@ export interface MutationObserverBaseResult<TData = unknown, TError = Registered
     mutate: MutateFunction<TData, TError, TVariables, TContext>;
     reset: () => void;
 }
-export interface MutationObserverIdleResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
+export interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
     data: undefined;
     variables: undefined;
     error: null;
@@ -387,7 +387,7 @@ export interface MutationObserverIdleResult<TData = unknown, TError = Registered
     isSuccess: false;
     status: 'idle';
 }
-export interface MutationObserverLoadingResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
+export interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
     data: undefined;
     variables: TVariables;
     error: null;
@@ -397,7 +397,7 @@ export interface MutationObserverLoadingResult<TData = unknown, TError = Registe
     isSuccess: false;
     status: 'pending';
 }
-export interface MutationObserverErrorResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
+export interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
     data: undefined;
     error: TError;
     variables: TVariables;
@@ -407,7 +407,7 @@ export interface MutationObserverErrorResult<TData = unknown, TError = Registere
     isSuccess: false;
     status: 'error';
 }
-export interface MutationObserverSuccessResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
+export interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
     data: TData;
     error: null;
     variables: TVariables;
@@ -417,13 +417,13 @@ export interface MutationObserverSuccessResult<TData = unknown, TError = Registe
     isSuccess: true;
     status: 'success';
 }
-export declare type MutationObserverResult<TData = unknown, TError = RegisteredError, TVariables = void, TContext = unknown> = MutationObserverIdleResult<TData, TError, TVariables, TContext> | MutationObserverLoadingResult<TData, TError, TVariables, TContext> | MutationObserverErrorResult<TData, TError, TVariables, TContext> | MutationObserverSuccessResult<TData, TError, TVariables, TContext>;
+export declare type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutationObserverIdleResult<TData, TError, TVariables, TContext> | MutationObserverLoadingResult<TData, TError, TVariables, TContext> | MutationObserverErrorResult<TData, TError, TVariables, TContext> | MutationObserverSuccessResult<TData, TError, TVariables, TContext>;
 export interface QueryClientConfig {
     queryCache?: QueryCache;
     mutationCache?: MutationCache;
     defaultOptions?: DefaultOptions;
 }
-export interface DefaultOptions<TError = RegisteredError> {
+export interface DefaultOptions<TError = DefaultError> {
     queries?: QueryObserverOptions<unknown, TError>;
     mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>;
 }

package/build/umd/index.development.js

@@ -889,6 +889,7 @@
         if (!isCancelledError(error)) {
           // Notify cache callback
           this.#cache.config.onError?.(error, this);
+          this.#cache.config.onSettled?.(this.state.data, error, this);
         }
         if (!this.isFetchingOptimistic) {
           // Schedule query gc after fetching
@@ -913,6 +914,7 @@
 
           // Notify cache callback
           this.#cache.config.onSuccess?.(data, this);
+          this.#cache.config.onSettled?.(data, this.state.error, this);
           if (!this.isFetchingOptimistic) {
             // Schedule query gc after fetching
             this.scheduleGc();
@@ -1258,6 +1260,9 @@
         // Notify cache callback
         await this.#mutationCache.config.onSuccess?.(data, variables, this.state.context, this);
         await this.options.onSuccess?.(data, variables, this.state.context);
+
+        // Notify cache callback
+        await this.#mutationCache.config.onSettled?.(data, null, this.state.variables, this.state.context, this);
         await this.options.onSettled?.(data, null, variables, this.state.context);
         this.#dispatch({
           type: 'success',
@@ -1269,6 +1274,9 @@
           // Notify cache callback
           await this.#mutationCache.config.onError?.(error, variables, this.state.context, this);
           await this.options.onError?.(error, variables, this.state.context);
+
+          // Notify cache callback
+          await this.#mutationCache.config.onSettled?.(undefined, error, this.state.variables, this.state.context, this);
           await this.options.onSettled?.(undefined, error, variables, this.state.context);
           throw error;
         } finally {
@@ -2266,14 +2274,12 @@
     #result;
     #queries;
     #observers;
-    #observersMap;
     constructor(client, queries) {
       super();
       this.#client = client;
       this.#queries = [];
       this.#result = [];
       this.#observers = [];
-      this.#observersMap = {};
       if (queries) {
         this.setQueries(queries);
       }
@@ -2307,14 +2313,12 @@
         // set options for the new observers to notify of changes
         newObserverMatches.forEach(match => match.observer.setOptions(match.defaultedQueryOptions, notifyOptions));
         const newObservers = newObserverMatches.map(match => match.observer);
-        const newObserversMap = Object.fromEntries(newObservers.map(observer => [observer.options.queryHash, observer]));
         const newResult = newObservers.map(observer => observer.getCurrentResult());
         const hasIndexChange = newObservers.some((observer, index) => observer !== prevObservers[index]);
         if (prevObservers.length === newObservers.length && !hasIndexChange) {
           return;
         }
         this.#observers = newObservers;
-        this.#observersMap = newObserversMap;
         this.#result = newResult;
         if (!this.hasListeners()) {
           return;
@@ -2359,7 +2363,7 @@
       const unmatchedQueries = defaultedQueryOptions.filter(defaultedOptions => !matchedQueryHashes.includes(defaultedOptions.queryHash));
       const getObserver = options => {
         const defaultedOptions = this.#client.defaultQueryOptions(options);
-        const currentObserver = this.#observersMap[defaultedOptions.queryHash];
+        const currentObserver = this.#observers.find(o => o.options.queryHash === defaultedOptions.queryHash);
         return currentObserver ?? new QueryObserver(this.#client, defaultedOptions);
       };
       const newOrReusedObservers = unmatchedQueries.map(options => {
@@ -2660,6 +2664,7 @@
   exports.isCancelledError = isCancelledError;
   exports.isServer = isServer;
   exports.keepPreviousData = keepPreviousData;
+  exports.matchQuery = matchQuery;
   exports.notifyManager = notifyManager;
   exports.onlineManager = onlineManager;
   exports.replaceEqualDeep = replaceEqualDeep;