@tanstack/query-sync-storage-persister 4.0.0 → 4.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/build/stats-html.html +1 -1
  2. package/build/stats.json +45 -0
  3. package/build/types/packages/query-core/src/focusManager.d.ts +16 -0
  4. package/build/types/packages/query-core/src/hydration.d.ts +34 -0
  5. package/build/types/packages/query-core/src/index.d.ts +20 -0
  6. package/build/types/packages/query-core/src/infiniteQueryBehavior.d.ts +15 -0
  7. package/build/types/packages/query-core/src/infiniteQueryObserver.d.ts +18 -0
  8. package/build/types/packages/query-core/src/logger.d.ts +8 -0
  9. package/build/types/packages/query-core/src/mutation.d.ts +70 -0
  10. package/build/types/packages/query-core/src/mutationCache.d.ts +52 -0
  11. package/build/types/packages/query-core/src/mutationObserver.d.ts +23 -0
  12. package/build/types/packages/query-core/src/notifyManager.d.ts +18 -0
  13. package/build/types/packages/query-core/src/onlineManager.d.ts +16 -0
  14. package/build/types/packages/query-core/src/queriesObserver.d.ts +23 -0
  15. package/build/types/packages/query-core/src/query.d.ts +119 -0
  16. package/build/types/packages/query-core/src/queryCache.d.ts +59 -0
  17. package/build/types/packages/query-core/src/queryClient.d.ts +65 -0
  18. package/build/types/packages/query-core/src/queryObserver.d.ts +61 -0
  19. package/build/types/packages/query-core/src/removable.d.ts +9 -0
  20. package/build/types/packages/query-core/src/retryer.d.ts +33 -0
  21. package/build/types/packages/query-core/src/subscribable.d.ts +10 -0
  22. package/build/types/packages/query-core/src/types.d.ts +417 -0
  23. package/build/types/packages/query-core/src/utils.d.ts +99 -0
  24. package/build/types/packages/query-sync-storage-persister/src/__tests__/storageIsFull.test.d.ts +1 -0
  25. package/build/types/packages/query-sync-storage-persister/src/index.d.ts +30 -0
  26. package/build/types/packages/react-query/src/Hydrate.d.ts +10 -0
  27. package/build/types/packages/react-query/src/QueryClientProvider.d.ts +24 -0
  28. package/build/types/packages/react-query/src/QueryErrorResetBoundary.d.ts +12 -0
  29. package/build/types/packages/react-query/src/index.d.ts +17 -0
  30. package/build/types/packages/react-query/src/isRestoring.d.ts +3 -0
  31. package/build/types/packages/react-query/src/reactBatchedUpdates.d.ts +2 -0
  32. package/build/types/packages/react-query/src/setBatchUpdatesFn.d.ts +1 -0
  33. package/build/types/packages/react-query/src/types.d.ts +35 -0
  34. package/build/types/packages/react-query/src/useBaseQuery.d.ts +3 -0
  35. package/build/types/packages/react-query/src/useInfiniteQuery.d.ts +5 -0
  36. package/build/types/packages/react-query/src/useIsFetching.d.ts +7 -0
  37. package/build/types/packages/react-query/src/useIsMutating.d.ts +7 -0
  38. package/build/types/packages/react-query/src/useMutation.d.ts +6 -0
  39. package/build/types/packages/react-query/src/useQueries.d.ts +49 -0
  40. package/build/types/packages/react-query/src/useQuery.d.ts +20 -0
  41. package/build/types/packages/react-query/src/utils.d.ts +1 -0
  42. package/build/types/packages/react-query-persist-client/src/PersistQueryClientProvider.d.ts +8 -0
  43. package/build/types/packages/react-query-persist-client/src/index.d.ts +3 -0
  44. package/build/types/packages/react-query-persist-client/src/persist.d.ts +58 -0
  45. package/build/types/packages/react-query-persist-client/src/retryStrategies.d.ts +7 -0
  46. package/build/types/tests/utils.d.ts +24 -0
  47. package/package.json +2 -2
@@ -0,0 +1,10 @@
1
+ import * as React from 'react';
2
+ import { HydrateOptions } from '@tanstack/query-core';
3
+ import { ContextOptions } from './types';
4
+ export declare function useHydrate(state: unknown, options?: HydrateOptions & ContextOptions): void;
5
+ export interface HydrateProps {
6
+ state?: unknown;
7
+ options?: HydrateOptions;
8
+ children?: React.ReactNode;
9
+ }
10
+ export declare const Hydrate: ({ children, options, state }: HydrateProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
@@ -0,0 +1,24 @@
1
+ import * as React from 'react';
2
+ import { QueryClient } from '@tanstack/query-core';
3
+ import { ContextOptions } from './types';
4
+ declare global {
5
+ interface Window {
6
+ ReactQueryClientContext?: React.Context<QueryClient | undefined>;
7
+ }
8
+ }
9
+ export declare const defaultContext: React.Context<QueryClient | undefined>;
10
+ export declare const useQueryClient: ({ context }?: ContextOptions) => QueryClient;
11
+ declare type QueryClientProviderPropsBase = {
12
+ client: QueryClient;
13
+ children?: React.ReactNode;
14
+ };
15
+ declare type QueryClientProviderPropsWithContext = ContextOptions & {
16
+ contextSharing?: never;
17
+ } & QueryClientProviderPropsBase;
18
+ declare type QueryClientProviderPropsWithContextSharing = {
19
+ context?: never;
20
+ contextSharing?: boolean;
21
+ } & QueryClientProviderPropsBase;
22
+ export declare type QueryClientProviderProps = QueryClientProviderPropsWithContext | QueryClientProviderPropsWithContextSharing;
23
+ export declare const QueryClientProvider: ({ client, children, context, contextSharing, }: QueryClientProviderProps) => JSX.Element;
24
+ export {};
@@ -0,0 +1,12 @@
1
+ import * as React from 'react';
2
+ interface QueryErrorResetBoundaryValue {
3
+ clearReset: () => void;
4
+ isReset: () => boolean;
5
+ reset: () => void;
6
+ }
7
+ export declare const useQueryErrorResetBoundary: () => QueryErrorResetBoundaryValue;
8
+ export interface QueryErrorResetBoundaryProps {
9
+ children: ((value: QueryErrorResetBoundaryValue) => React.ReactNode) | React.ReactNode;
10
+ }
11
+ export declare const QueryErrorResetBoundary: ({ children, }: QueryErrorResetBoundaryProps) => JSX.Element;
12
+ export {};
@@ -0,0 +1,17 @@
1
+ import './setBatchUpdatesFn';
2
+ export * from '@tanstack/query-core';
3
+ export * from './types';
4
+ export { useQueries } from './useQueries';
5
+ export type { QueriesResults, QueriesOptions } from './useQueries';
6
+ export { useQuery } from './useQuery';
7
+ export { defaultContext, QueryClientProvider, useQueryClient, } from './QueryClientProvider';
8
+ export type { QueryClientProviderProps } from './QueryClientProvider';
9
+ export type { QueryErrorResetBoundaryProps } from './QueryErrorResetBoundary';
10
+ export { useHydrate, Hydrate } from './Hydrate';
11
+ export type { HydrateProps } from './Hydrate';
12
+ export { QueryErrorResetBoundary, useQueryErrorResetBoundary, } from './QueryErrorResetBoundary';
13
+ export { useIsFetching } from './useIsFetching';
14
+ export { useIsMutating } from './useIsMutating';
15
+ export { useMutation } from './useMutation';
16
+ export { useInfiniteQuery } from './useInfiniteQuery';
17
+ export { useIsRestoring, IsRestoringProvider } from './isRestoring';
@@ -0,0 +1,3 @@
1
+ import * as React from 'react';
2
+ export declare const useIsRestoring: () => boolean;
3
+ export declare const IsRestoringProvider: React.Provider<boolean>;
@@ -0,0 +1,2 @@
1
+ import * as ReactDOM from 'react-dom';
2
+ export declare const unstable_batchedUpdates: typeof ReactDOM.unstable_batchedUpdates;
@@ -0,0 +1,35 @@
1
+ import * as React from 'react';
2
+ import { InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutationObserverResult, QueryObserverOptions, QueryObserverResult, QueryKey, MutationObserverOptions, MutateFunction } from '@tanstack/query-core';
3
+ import type { QueryClient } from '@tanstack/query-core';
4
+ export interface ContextOptions {
5
+ /**
6
+ * Use this to pass your React Query context. Otherwise, `defaultContext` will be used.
7
+ */
8
+ context?: React.Context<QueryClient | undefined>;
9
+ }
10
+ export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
11
+ }
12
+ export interface UseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
13
+ }
14
+ export interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
15
+ }
16
+ export declare type UseBaseQueryResult<TData = unknown, TError = unknown> = QueryObserverResult<TData, TError>;
17
+ export declare type UseQueryResult<TData = unknown, TError = unknown> = UseBaseQueryResult<TData, TError>;
18
+ export declare type DefinedUseQueryResult<TData = unknown, TError = unknown> = Omit<UseQueryResult<TData, TError>, 'data'> & {
19
+ data: TData;
20
+ };
21
+ export declare type UseInfiniteQueryResult<TData = unknown, TError = unknown> = InfiniteQueryObserverResult<TData, TError>;
22
+ export interface UseMutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends ContextOptions, Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'> {
23
+ }
24
+ export declare type UseMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
25
+ export declare type UseMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
26
+ export declare type UseBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
27
+ mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
28
+ }> & {
29
+ mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
30
+ };
31
+ export declare type UseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
32
+ declare type Override<A, B> = {
33
+ [K in keyof A]: K extends keyof B ? B[K] : A[K];
34
+ };
35
+ export {};
@@ -0,0 +1,3 @@
1
+ import { QueryKey, QueryObserver } from '@tanstack/query-core';
2
+ import { UseBaseQueryOptions } from './types';
3
+ export declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, Observer: typeof QueryObserver): import("@tanstack/query-core").QueryObserverResult<TData, TError>;
@@ -0,0 +1,5 @@
1
+ import { QueryFunction, QueryKey } from '@tanstack/query-core';
2
+ import { UseInfiniteQueryOptions, UseInfiniteQueryResult } from './types';
3
+ export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>): UseInfiniteQueryResult<TData, TError>;
4
+ export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey'>): UseInfiniteQueryResult<TData, TError>;
5
+ export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey' | 'queryFn'>): UseInfiniteQueryResult<TData, TError>;
@@ -0,0 +1,7 @@
1
+ import { QueryKey, QueryFilters } from '@tanstack/query-core';
2
+ import { ContextOptions } from './types';
3
+ interface Options extends ContextOptions {
4
+ }
5
+ export declare function useIsFetching(filters?: QueryFilters, options?: Options): number;
6
+ export declare function useIsFetching(queryKey?: QueryKey, filters?: QueryFilters, options?: Options): number;
7
+ export {};
@@ -0,0 +1,7 @@
1
+ import { MutationKey, MutationFilters } from '@tanstack/query-core';
2
+ import { ContextOptions } from './types';
3
+ interface Options extends ContextOptions {
4
+ }
5
+ export declare function useIsMutating(filters?: MutationFilters, options?: Options): number;
6
+ export declare function useIsMutating(mutationKey?: MutationKey, filters?: Omit<MutationFilters, 'mutationKey'>, options?: Options): number;
7
+ export {};
@@ -0,0 +1,6 @@
1
+ import { MutationFunction, MutationKey } from '@tanstack/query-core';
2
+ import { UseMutationOptions, UseMutationResult } from './types';
3
+ export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>): UseMutationResult<TData, TError, TVariables, TContext>;
4
+ export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): UseMutationResult<TData, TError, TVariables, TContext>;
5
+ export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): UseMutationResult<TData, TError, TVariables, TContext>;
6
+ export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): UseMutationResult<TData, TError, TVariables, TContext>;
@@ -0,0 +1,49 @@
1
+ import { QueryKey, QueryFunction } from '@tanstack/query-core';
2
+ import { UseQueryOptions, UseQueryResult } from './types';
3
+ declare type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'context'>;
4
+ declare type MAXIMUM_DEPTH = 20;
5
+ declare type GetOptions<T> = T extends {
6
+ queryFnData: infer TQueryFnData;
7
+ error?: infer TError;
8
+ data: infer TData;
9
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends {
10
+ queryFnData: infer TQueryFnData;
11
+ error?: infer TError;
12
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends {
13
+ data: infer TData;
14
+ error?: infer TError;
15
+ } ? UseQueryOptionsForUseQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryOptionsForUseQueries<TQueryFnData> : T extends {
16
+ queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
17
+ select: (data: any) => infer TData;
18
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, unknown, TData, TQueryKey> : T extends {
19
+ queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
20
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, unknown, TQueryFnData, TQueryKey> : UseQueryOptionsForUseQueries;
21
+ declare type GetResults<T> = T extends {
22
+ queryFnData: any;
23
+ error?: infer TError;
24
+ data: infer TData;
25
+ } ? UseQueryResult<TData, TError> : T extends {
26
+ queryFnData: infer TQueryFnData;
27
+ error?: infer TError;
28
+ } ? UseQueryResult<TQueryFnData, TError> : T extends {
29
+ data: infer TData;
30
+ error?: infer TError;
31
+ } ? UseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryResult<TQueryFnData> : T extends {
32
+ queryFn?: QueryFunction<unknown, any>;
33
+ select: (data: any) => infer TData;
34
+ } ? UseQueryResult<TData> : T extends {
35
+ queryFn?: QueryFunction<infer TQueryFnData, any>;
36
+ } ? UseQueryResult<TQueryFnData> : UseQueryResult;
37
+ /**
38
+ * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
39
+ */
40
+ export declare type QueriesOptions<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
41
+ /**
42
+ * QueriesResults reducer recursively maps type param to results
43
+ */
44
+ export declare type QueriesResults<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>[] ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>[] : UseQueryResult[];
45
+ export declare function useQueries<T extends any[]>({ queries, context, }: {
46
+ queries: readonly [...QueriesOptions<T>];
47
+ context?: UseQueryOptions['context'];
48
+ }): QueriesResults<T>;
49
+ export {};
@@ -0,0 +1,20 @@
1
+ import { QueryFunction, QueryKey } from '@tanstack/query-core';
2
+ import { DefinedUseQueryResult, UseQueryOptions, UseQueryResult } from './types';
3
+ export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
4
+ initialData?: () => undefined;
5
+ }): UseQueryResult<TData, TError>;
6
+ export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
7
+ initialData: TQueryFnData | (() => TQueryFnData);
8
+ }): DefinedUseQueryResult<TData, TError>;
9
+ 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'> & {
10
+ initialData?: () => undefined;
11
+ }): UseQueryResult<TData, TError>;
12
+ 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'> & {
13
+ initialData: TQueryFnData | (() => TQueryFnData);
14
+ }): DefinedUseQueryResult<TData, TError>;
15
+ 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'> & {
16
+ initialData?: () => undefined;
17
+ }): UseQueryResult<TData, TError>;
18
+ 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'> & {
19
+ initialData: TQueryFnData | (() => TQueryFnData);
20
+ }): DefinedUseQueryResult<TData, TError>;
@@ -0,0 +1 @@
1
+ export declare function shouldThrowError<T extends (...args: any[]) => boolean>(_useErrorBoundary: boolean | T | undefined, params: Parameters<T>): boolean;
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { PersistQueryClientOptions } from './persist';
3
+ import { QueryClientProviderProps } from '@tanstack/react-query';
4
+ export declare type PersistQueryClientProviderProps = QueryClientProviderProps & {
5
+ persistOptions: Omit<PersistQueryClientOptions, 'queryClient'>;
6
+ onSuccess?: () => void;
7
+ };
8
+ export declare const PersistQueryClientProvider: ({ client, children, persistOptions, onSuccess, ...props }: PersistQueryClientProviderProps) => JSX.Element;
@@ -0,0 +1,3 @@
1
+ export * from './persist';
2
+ export * from './PersistQueryClientProvider';
3
+ export * from './retryStrategies';
@@ -0,0 +1,58 @@
1
+ import { QueryClient, DehydratedState, DehydrateOptions, HydrateOptions } from '@tanstack/query-core';
2
+ export declare type Promisable<T> = T | PromiseLike<T>;
3
+ export interface Persister {
4
+ persistClient(persistClient: PersistedClient): Promisable<void>;
5
+ restoreClient(): Promisable<PersistedClient | undefined>;
6
+ removeClient(): Promisable<void>;
7
+ }
8
+ export interface PersistedClient {
9
+ timestamp: number;
10
+ buster: string;
11
+ clientState: DehydratedState;
12
+ }
13
+ export interface PersistQueryClienRootOptions {
14
+ /** The QueryClient to persist */
15
+ queryClient: QueryClient;
16
+ /** The Persister interface for storing and restoring the cache
17
+ * to/from a persisted location */
18
+ persister: Persister;
19
+ /** A unique string that can be used to forcefully
20
+ * invalidate existing caches if they do not share the same buster string */
21
+ buster?: string;
22
+ }
23
+ export interface PersistedQueryClientRestoreOptions extends PersistQueryClienRootOptions {
24
+ /** The max-allowed age of the cache in milliseconds.
25
+ * If a persisted cache is found that is older than this
26
+ * time, it will be discarded */
27
+ maxAge?: number;
28
+ /** The options passed to the hydrate function */
29
+ hydrateOptions?: HydrateOptions;
30
+ }
31
+ export interface PersistedQueryClientSaveOptions extends PersistQueryClienRootOptions {
32
+ /** The options passed to the dehydrate function */
33
+ dehydrateOptions?: DehydrateOptions;
34
+ }
35
+ export interface PersistQueryClientOptions extends PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, PersistQueryClienRootOptions {
36
+ }
37
+ /**
38
+ * Restores persisted data to the QueryCache
39
+ * - data obtained from persister.restoreClient
40
+ * - data is hydrated using hydrateOptions
41
+ * If data is expired, busted, empty, or throws, it runs persister.removeClient
42
+ */
43
+ export declare function persistQueryClientRestore({ queryClient, persister, maxAge, buster, hydrateOptions, }: PersistedQueryClientRestoreOptions): Promise<void>;
44
+ /**
45
+ * Persists data from the QueryCache
46
+ * - data dehydrated using dehydrateOptions
47
+ * - data is persisted using persister.persistClient
48
+ */
49
+ export declare function persistQueryClientSave({ queryClient, persister, buster, dehydrateOptions, }: PersistedQueryClientSaveOptions): Promise<void>;
50
+ /**
51
+ * Subscribe to QueryCache and MutationCache updates (for persisting)
52
+ * @returns an unsubscribe function (to discontinue monitoring)
53
+ */
54
+ export declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOptions): () => void;
55
+ /**
56
+ * Restores persisted data to QueryCache and persists further changes.
57
+ */
58
+ export declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
@@ -0,0 +1,7 @@
1
+ import { PersistedClient } from './persist';
2
+ export declare type PersistRetryer = (props: {
3
+ persistedClient: PersistedClient;
4
+ error: Error;
5
+ errorCount: number;
6
+ }) => PersistedClient | undefined;
7
+ export declare const removeOldestQuery: PersistRetryer;
@@ -0,0 +1,24 @@
1
+ /// <reference types="jest" />
2
+ /// <reference types="node" />
3
+ import { MutationOptions, QueryClient, QueryClientConfig } from '@tanstack/query-core';
4
+ export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
5
+ export declare function mockVisibilityState(value: DocumentVisibilityState): jest.SpyInstance<DocumentVisibilityState, []>;
6
+ export declare function mockNavigatorOnLine(value: boolean): jest.SpyInstance<boolean, []>;
7
+ export declare const mockLogger: {
8
+ log: jest.Mock<any, any>;
9
+ warn: jest.Mock<any, any>;
10
+ error: jest.Mock<any, any>;
11
+ };
12
+ export declare function queryKey(): Array<string>;
13
+ export declare function sleep(timeout: number): Promise<void>;
14
+ export declare function setActTimeout(fn: () => void, ms?: number): NodeJS.Timeout;
15
+ /**
16
+ * Assert the parameter is of a specific type.
17
+ */
18
+ export declare const expectType: <T>(_: T) => void;
19
+ /**
20
+ * Assert the parameter is not typed as `any`
21
+ */
22
+ export declare const expectTypeNotAny: <T>(_: 0 extends 1 & T ? never : T) => void;
23
+ export declare const executeMutation: (queryClient: QueryClient, options: MutationOptions<any, any, any, any>) => Promise<unknown>;
24
+ export declare function setIsServer(isServer: boolean): () => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/query-sync-storage-persister",
3
- "version": "4.0.0",
3
+ "version": "4.0.5",
4
4
  "description": "TODO",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -15,7 +15,7 @@
15
15
  "browser": "build/umd/index.production.js",
16
16
  "types": "build/types/packages/query-sync-storage-persister/src/index.d.ts",
17
17
  "files": [
18
- "build",
18
+ "build/*",
19
19
  "src"
20
20
  ],
21
21
  "scripts": {