@tanstack/react-query-persist-client 4.0.8 → 4.2.1

package/build/stats.json

@@ -11,25 +11,25 @@
             "children": [
               {
                 "name": "query-core/build/esm/index.js",
-                "uid": "f3bc-263"
+                "uid": "0a90-217"
               },
               {
                 "name": "react-query-persist-client/src",
                 "children": [
                   {
-                    "uid": "f3bc-265",
+                    "uid": "0a90-219",
                     "name": "persist.ts"
                   },
                   {
-                    "uid": "f3bc-269",
+                    "uid": "0a90-223",
                     "name": "PersistQueryClientProvider.tsx"
                   },
                   {
-                    "uid": "f3bc-271",
+                    "uid": "0a90-225",
                     "name": "retryStrategies.ts"
                   },
                   {
-                    "uid": "f3bc-273",
+                    "uid": "0a90-227",
                     "name": "index.ts"
                   }
                 ]
@@ -37,7 +37,7 @@
             ]
           },
           {
-            "uid": "f3bc-267",
+            "uid": "0a90-221",
             "name": "\u0000rollupPluginBabelHelpers.js"
           }
         ]
@@ -46,161 +46,161 @@
     "isRoot": true
   },
   "nodeParts": {
-    "f3bc-263": {
+    "0a90-217": {
       "renderedLength": 7950,
       "gzipLength": 1867,
       "brotliLength": 0,
-      "mainUid": "f3bc-262"
+      "mainUid": "0a90-216"
     },
-    "f3bc-265": {
+    "0a90-219": {
       "renderedLength": 2704,
       "gzipLength": 803,
       "brotliLength": 0,
-      "mainUid": "f3bc-264"
+      "mainUid": "0a90-218"
     },
-    "f3bc-267": {
+    "0a90-221": {
       "renderedLength": 431,
       "gzipLength": 240,
       "brotliLength": 0,
-      "mainUid": "f3bc-266"
+      "mainUid": "0a90-220"
     },
-    "f3bc-269": {
+    "0a90-223": {
       "renderedLength": 1168,
       "gzipLength": 430,
       "brotliLength": 0,
-      "mainUid": "f3bc-268"
+      "mainUid": "0a90-222"
     },
-    "f3bc-271": {
+    "0a90-225": {
       "renderedLength": 687,
       "gzipLength": 306,
       "brotliLength": 0,
-      "mainUid": "f3bc-270"
+      "mainUid": "0a90-224"
     },
-    "f3bc-273": {
+    "0a90-227": {
       "renderedLength": 0,
       "gzipLength": 0,
       "brotliLength": 0,
-      "mainUid": "f3bc-272"
+      "mainUid": "0a90-226"
     }
   },
   "nodeMetas": {
-    "f3bc-262": {
+    "0a90-216": {
       "id": "/packages/query-core/build/esm/index.js",
       "moduleParts": {
-        "index.production.js": "f3bc-263"
+        "index.production.js": "0a90-217"
       },
       "imported": [],
       "importedBy": [
         {
-          "uid": "f3bc-264"
+          "uid": "0a90-218"
         }
       ]
     },
-    "f3bc-264": {
+    "0a90-218": {
       "id": "/packages/react-query-persist-client/src/persist.ts",
       "moduleParts": {
-        "index.production.js": "f3bc-265"
+        "index.production.js": "0a90-219"
       },
       "imported": [
         {
-          "uid": "f3bc-262"
+          "uid": "0a90-216"
         }
       ],
       "importedBy": [
         {
-          "uid": "f3bc-272"
+          "uid": "0a90-226"
         },
         {
-          "uid": "f3bc-268"
+          "uid": "0a90-222"
         }
       ]
     },
-    "f3bc-266": {
+    "0a90-220": {
       "id": "\u0000rollupPluginBabelHelpers.js",
       "moduleParts": {
-        "index.production.js": "f3bc-267"
+        "index.production.js": "0a90-221"
       },
       "imported": [],
       "importedBy": [
         {
-          "uid": "f3bc-268"
+          "uid": "0a90-222"
         }
       ]
     },
-    "f3bc-268": {
+    "0a90-222": {
       "id": "/packages/react-query-persist-client/src/PersistQueryClientProvider.tsx",
       "moduleParts": {
-        "index.production.js": "f3bc-269"
+        "index.production.js": "0a90-223"
       },
       "imported": [
         {
-          "uid": "f3bc-266"
+          "uid": "0a90-220"
         },
         {
-          "uid": "f3bc-274"
+          "uid": "0a90-228"
         },
         {
-          "uid": "f3bc-264"
+          "uid": "0a90-218"
         },
         {
-          "uid": "f3bc-275"
+          "uid": "0a90-229"
         }
       ],
       "importedBy": [
         {
-          "uid": "f3bc-272"
+          "uid": "0a90-226"
         }
       ]
     },
-    "f3bc-270": {
+    "0a90-224": {
       "id": "/packages/react-query-persist-client/src/retryStrategies.ts",
       "moduleParts": {
-        "index.production.js": "f3bc-271"
+        "index.production.js": "0a90-225"
       },
       "imported": [],
       "importedBy": [
         {
-          "uid": "f3bc-272"
+          "uid": "0a90-226"
         }
       ]
     },
-    "f3bc-272": {
+    "0a90-226": {
       "id": "/packages/react-query-persist-client/src/index.ts",
       "moduleParts": {
-        "index.production.js": "f3bc-273"
+        "index.production.js": "0a90-227"
       },
       "imported": [
         {
-          "uid": "f3bc-264"
+          "uid": "0a90-218"
         },
         {
-          "uid": "f3bc-268"
+          "uid": "0a90-222"
         },
         {
-          "uid": "f3bc-270"
+          "uid": "0a90-224"
         }
       ],
       "importedBy": [],
       "isEntry": true
     },
-    "f3bc-274": {
+    "0a90-228": {
       "id": "react",
       "moduleParts": {},
       "imported": [],
       "importedBy": [
         {
-          "uid": "f3bc-268"
+          "uid": "0a90-222"
         }
       ],
       "isExternal": true
     },
-    "f3bc-275": {
+    "0a90-229": {
       "id": "@tanstack/react-query",
       "moduleParts": {},
       "imported": [],
       "importedBy": [
         {
-          "uid": "f3bc-268"
+          "uid": "0a90-222"
         }
       ],
       "isExternal": true

package/build/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/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/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/types/packages/react-query/src/types.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutationObserverResult, QueryObserverOptions, QueryObserverResult, QueryKey, MutationObserverOptions, MutateFunction } from '@tanstack/query-core';
+import { InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutationObserverResult, QueryObserverOptions, QueryObserverResult, QueryKey, MutationObserverOptions, MutateFunction, DefinedQueryObserverResult } from '@tanstack/query-core';
 import type { QueryClient } from '@tanstack/query-core';
 export interface ContextOptions {
     /**
@@ -15,9 +15,8 @@ export interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknow
 }
 export declare type UseBaseQueryResult<TData = unknown, TError = unknown> = QueryObserverResult<TData, TError>;
 export declare type UseQueryResult<TData = unknown, TError = unknown> = UseBaseQueryResult<TData, TError>;
-export declare type DefinedUseQueryResult<TData = unknown, TError = unknown> = Omit<UseQueryResult<TData, TError>, 'data'> & {
-    data: TData;
-};
+export declare type DefinedUseBaseQueryResult<TData = unknown, TError = unknown> = DefinedQueryObserverResult<TData, TError>;
+export declare type DefinedUseQueryResult<TData = unknown, TError = unknown> = DefinedUseBaseQueryResult<TData, TError>;
 export declare type UseInfiniteQueryResult<TData = unknown, TError = unknown> = InfiniteQueryObserverResult<TData, TError>;
 export interface UseMutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends ContextOptions, Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'> {
 }

package/build/types/packages/react-query/src/useQuery.d.ts

@@ -6,15 +6,18 @@ export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData
 export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
     initialData: TQueryFnData | (() => TQueryFnData);
 }): DefinedUseQueryResult<TData, TError>;
+export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>;
 export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
     initialData?: () => undefined;
 }): UseQueryResult<TData, TError>;
 export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
     initialData: TQueryFnData | (() => TQueryFnData);
 }): DefinedUseQueryResult<TData, TError>;
+export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>): UseQueryResult<TData, TError>;
 export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
     initialData?: () => undefined;
 }): UseQueryResult<TData, TError>;
 export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
     initialData: TQueryFnData | (() => TQueryFnData);
 }): DefinedUseQueryResult<TData, TError>;
+export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>): UseQueryResult<TData, TError>;