@tanstack/query-core 4.0.8 → 4.0.11-beta.1

package/build/{types/packages/query-core/src → lib}/mutationCache.d.ts

@@ -27,12 +27,17 @@ interface NotifyEventMutationObserverRemoved {
     mutation: Mutation<any, any, any, any>;
     observer: MutationObserver<any, any, any>;
 }
+interface NotifyEventMutationObserverOptionsUpdated {
+    type: 'observerOptionsUpdated';
+    mutation?: Mutation<any, any, any, any>;
+    observer: MutationObserver<any, any, any, any>;
+}
 interface NotifyEventMutationUpdated {
     type: 'updated';
     mutation: Mutation<any, any, any, any>;
     action: Action<any, any, any, any>;
 }
-declare type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationUpdated;
+declare type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationObserverOptionsUpdated | NotifyEventMutationUpdated;
 declare type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
 export declare class MutationCache extends Subscribable<MutationCacheListener> {
     config: MutationCacheConfig;

package/build/{types/packages/query-core/src → lib}/queryCache.d.ts

@@ -35,7 +35,12 @@ interface NotifyEventQueryObserverResultsUpdated {
     type: 'observerResultsUpdated';
     query: Query<any, any, any, any>;
 }
-declare type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated;
+interface NotifyEventQueryObserverOptionsUpdated {
+    type: 'observerOptionsUpdated';
+    query: Query<any, any, any, any>;
+    observer: QueryObserver<any, any, any, any, any>;
+}
+declare type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
 declare type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
 export declare class QueryCache extends Subscribable<QueryCacheListener> {
     config: QueryCacheConfig;

package/build/{types/packages/query-core/src → lib}/types.d.ts

@@ -45,9 +45,10 @@ export interface QueryOptions<TQueryFnData = unknown, TError = unknown, TData =
     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`.
@@ -274,7 +275,8 @@ export interface QueryObserverSuccessResult<TData = unknown, TError = unknown> e
     isSuccess: true;
     status: 'success';
 }
-export declare type QueryObserverResult<TData = unknown, TError = unknown> = QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
+export declare type DefinedQueryObserverResult<TData = unknown, TError = unknown> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
+export declare type QueryObserverResult<TData = unknown, TError = unknown> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError>;
 export interface InfiniteQueryObserverBaseResult<TData = unknown, TError = unknown> extends QueryObserverBaseResult<InfiniteData<TData>, TError> {
     fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
     fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
@@ -333,9 +335,9 @@ export interface MutationOptions<TData = unknown, TError = unknown, TVariables =
     mutationKey?: MutationKey;
     variables?: TVariables;
     onMutate?: (variables: TVariables) => Promise<TContext | undefined> | TContext | undefined;
-    onSuccess?: (data: TData, variables: TVariables, context: TContext | undefined) => Promise<unknown> | void;
-    onError?: (error: TError, variables: TVariables, context: TContext | undefined) => Promise<unknown> | void;
-    onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => Promise<unknown> | void;
+    onSuccess?: (data: TData, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
+    onError?: (error: TError, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
+    onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
     retry?: RetryValue<TError>;
     retryDelay?: RetryDelayValue<TError>;
     networkMode?: NetworkMode;
@@ -347,9 +349,9 @@ export interface MutationObserverOptions<TData = unknown, TError = unknown, TVar
     useErrorBoundary?: boolean | ((error: TError) => boolean);
 }
 export interface MutateOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> {
-    onSuccess?: (data: TData, variables: TVariables, context: TContext) => Promise<unknown> | void;
-    onError?: (error: TError, variables: TVariables, context: TContext | undefined) => Promise<unknown> | void;
-    onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => Promise<unknown> | void;
+    onSuccess?: (data: TData, variables: TVariables, context: TContext) => Promise<unknown> | unknown;
+    onError?: (error: TError, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
+    onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
 }
 export declare type MutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>;
 export interface MutationObserverBaseResult<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends MutationState<TData, TError, TVariables, TContext> {

package/build/umd/index.development.js

@@ -347,6 +347,8 @@
     // Use prev data if an isDataEqual function is defined and returns `true`
     if (options.isDataEqual != null && options.isDataEqual(prevData, data)) {
       return prevData;
+    } 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);
@@ -2063,9 +2065,7 @@
         const matchingDefaults = this.queryDefaults.filter(x => partialMatchKey(queryKey, x.queryKey)); // It is ok not having defaults, but it is error prone to have more than 1 default for a given key
 
         if (matchingDefaults.length > 1) {
-          {
-            this.logger.error("[QueryClient] Several query defaults match with key '" + JSON.stringify(queryKey) + "'. The first matching query defaults are used. Please check how query defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydefaults.");
-          }
+          this.logger.error("[QueryClient] Several query defaults match with key '" + JSON.stringify(queryKey) + "'. The first matching query defaults are used. Please check how query defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydefaults.");
         }
       }
 
@@ -2098,9 +2098,7 @@
         const matchingDefaults = this.mutationDefaults.filter(x => partialMatchKey(mutationKey, x.mutationKey)); // It is ok not having defaults, but it is error prone to have more than 1 default for a given key
 
         if (matchingDefaults.length > 1) {
-          {
-            this.logger.error("[QueryClient] Several mutation defaults match with key '" + JSON.stringify(mutationKey) + "'. The first matching mutation defaults are used. Please check how mutation defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetmutationdefaults.");
-          }
+          this.logger.error("[QueryClient] Several mutation defaults match with key '" + JSON.stringify(mutationKey) + "'. The first matching mutation defaults are used. Please check how mutation defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetmutationdefaults.");
         }
       }
 
@@ -2207,6 +2205,14 @@
       const prevQuery = this.currentQuery;
       this.options = this.client.defaultQueryOptions(options);
 
+      if (!shallowEqualObjects(prevOptions, this.options)) {
+        this.client.getQueryCache().notify({
+          type: 'observerOptionsUpdated',
+          query: this.currentQuery,
+          observer: this
+        });
+      }
+
       if (typeof this.options.enabled !== 'undefined' && typeof this.options.enabled !== 'boolean') {
         throw new Error('Expected enabled to be a boolean');
       } // Keep previous query key if the user does not supply one
@@ -2890,7 +2896,16 @@
     }
 
     setOptions(options) {
+      const prevOptions = this.options;
       this.options = this.client.defaultMutationOptions(options);
+
+      if (!shallowEqualObjects(prevOptions, this.options)) {
+        this.client.getMutationCache().notify({
+          type: 'observerOptionsUpdated',
+          mutation: this.currentMutation,
+          observer: this
+        });
+      }
     }
 
     onUnsubscribe() {