@tanstack/query-core 4.0.11-beta.0 → 4.1.3

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

@@ -10,11 +10,11 @@ export { notifyManager } from './notifyManager';
 export { focusManager } from './focusManager';
 export { onlineManager } from './onlineManager';
 export { hashQueryKey, isError, parseQueryArgs, parseFilterArgs, parseMutationFilterArgs, parseMutationArgs, } from './utils';
-export type { MutationFilters, QueryFilters, Updater } from './utils';
+export type { MutationFilters, QueryFilters } from './utils';
 export { isCancelledError } from './retryer';
 export { dehydrate, hydrate } from './hydration';
 export * from './types';
-export type { Query, QueryState } from './query';
+export type { Query } from './query';
 export type { Mutation } from './mutation';
 export type { Logger } from './logger';
 export type { DehydrateOptions, DehydratedState, HydrateOptions, ShouldDehydrateMutationFunction, ShouldDehydrateQueryFunction, } from './hydration';

package/build/{lib → types/packages/query-core/src}/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/{lib → types/packages/query-core/src}/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/tests/focusManager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/hydration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/infiniteQueryBehavior.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/infiniteQueryObserver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/mutationCache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/mutationObserver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/mutations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/notifyManager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/onlineManager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/queriesObserver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/query.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/queryCache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/queryClient.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/build/types/packages/query-core/src/tests/queryObserver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/packages/query-core/src/tests/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -274,7 +274,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 +334,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 +348,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/types/tests/utils.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="jest" />
+/// <reference types="node" />
+import { MutationOptions, QueryClient, QueryClientConfig } from '@tanstack/query-core';
+export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
+export declare function mockVisibilityState(value: DocumentVisibilityState): jest.SpyInstance<DocumentVisibilityState, []>;
+export declare function mockNavigatorOnLine(value: boolean): jest.SpyInstance<boolean, []>;
+export declare const mockLogger: {
+    log: jest.Mock<any, any>;
+    warn: jest.Mock<any, any>;
+    error: jest.Mock<any, any>;
+};
+export declare function queryKey(): Array<string>;
+export declare function sleep(timeout: number): Promise<void>;
+export declare function setActTimeout(fn: () => void, ms?: number): NodeJS.Timeout;
+/**
+ * Assert the parameter is of a specific type.
+ */
+export declare const expectType: <T>(_: T) => void;
+/**
+ * Assert the parameter is not typed as `any`
+ */
+export declare const expectTypeNotAny: <T>(_: 0 extends 1 & T ? never : T) => void;
+export declare const executeMutation: (queryClient: QueryClient, options: MutationOptions<any, any, any, any>) => Promise<unknown>;
+export declare function setIsServer(isServer: boolean): () => void;

package/build/umd/index.development.js

@@ -2203,6 +2203,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
@@ -2886,7 +2894,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() {