@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
@@ -2669,7 +2669,7 @@ var drawChart = (function (exports) {
2669
2669
  </script>
2670
2670
  <script>
2671
2671
  /*<!--*/
2672
- const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.production.js","children":[{"name":"packages/query-sync-storage-persister/src/index.ts","uid":"9f45-143"}]}],"isRoot":true},"nodeParts":{"9f45-143":{"renderedLength":1715,"gzipLength":628,"brotliLength":0,"mainUid":"9f45-142"}},"nodeMetas":{"9f45-142":{"id":"/packages/query-sync-storage-persister/src/index.ts","moduleParts":{"index.production.js":"9f45-143"},"imported":[],"importedBy":[],"isEntry":true}},"env":{"rollup":"2.76.0"},"options":{"gzip":true,"brotli":false,"sourcemap":false}};
2672
+ const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.production.js","children":[{"name":"packages/query-sync-storage-persister/src/index.ts","uid":"f3f3-143"}]}],"isRoot":true},"nodeParts":{"f3f3-143":{"renderedLength":1715,"gzipLength":628,"brotliLength":0,"mainUid":"f3f3-142"}},"nodeMetas":{"f3f3-142":{"id":"/packages/query-sync-storage-persister/src/index.ts","moduleParts":{"index.production.js":"f3f3-143"},"imported":[],"importedBy":[],"isEntry":true}},"env":{"rollup":"2.76.0"},"options":{"gzip":true,"brotli":false,"sourcemap":false}};
2673
2673
 
2674
2674
  const run = () => {
2675
2675
  const width = window.innerWidth;
@@ -0,0 +1,45 @@
1
+ {
2
+ "version": 2,
3
+ "tree": {
4
+ "name": "root",
5
+ "children": [
6
+ {
7
+ "name": "index.production.js",
8
+ "children": [
9
+ {
10
+ "name": "packages/query-sync-storage-persister/src/index.ts",
11
+ "uid": "f3f3-145"
12
+ }
13
+ ]
14
+ }
15
+ ],
16
+ "isRoot": true
17
+ },
18
+ "nodeParts": {
19
+ "f3f3-145": {
20
+ "renderedLength": 1715,
21
+ "gzipLength": 628,
22
+ "brotliLength": 0,
23
+ "mainUid": "f3f3-144"
24
+ }
25
+ },
26
+ "nodeMetas": {
27
+ "f3f3-144": {
28
+ "id": "/packages/query-sync-storage-persister/src/index.ts",
29
+ "moduleParts": {
30
+ "index.production.js": "f3f3-145"
31
+ },
32
+ "imported": [],
33
+ "importedBy": [],
34
+ "isEntry": true
35
+ }
36
+ },
37
+ "env": {
38
+ "rollup": "2.76.0"
39
+ },
40
+ "options": {
41
+ "gzip": true,
42
+ "brotli": false,
43
+ "sourcemap": false
44
+ }
45
+ }
@@ -0,0 +1,16 @@
1
+ import { Subscribable } from './subscribable';
2
+ declare type SetupFn = (setFocused: (focused?: boolean) => void) => (() => void) | undefined;
3
+ export declare class FocusManager extends Subscribable {
4
+ private focused?;
5
+ private cleanup?;
6
+ private setup;
7
+ constructor();
8
+ protected onSubscribe(): void;
9
+ protected onUnsubscribe(): void;
10
+ setEventListener(setup: SetupFn): void;
11
+ setFocused(focused?: boolean): void;
12
+ onFocus(): void;
13
+ isFocused(): boolean;
14
+ }
15
+ export declare const focusManager: FocusManager;
16
+ export {};
@@ -0,0 +1,34 @@
1
+ import type { QueryClient } from './queryClient';
2
+ import type { Query, QueryState } from './query';
3
+ import type { MutationKey, MutationOptions, QueryKey, QueryOptions } from './types';
4
+ import type { Mutation, MutationState } from './mutation';
5
+ export interface DehydrateOptions {
6
+ dehydrateMutations?: boolean;
7
+ dehydrateQueries?: boolean;
8
+ shouldDehydrateMutation?: ShouldDehydrateMutationFunction;
9
+ shouldDehydrateQuery?: ShouldDehydrateQueryFunction;
10
+ }
11
+ export interface HydrateOptions {
12
+ defaultOptions?: {
13
+ queries?: QueryOptions;
14
+ mutations?: MutationOptions;
15
+ };
16
+ }
17
+ interface DehydratedMutation {
18
+ mutationKey?: MutationKey;
19
+ state: MutationState;
20
+ }
21
+ interface DehydratedQuery {
22
+ queryHash: string;
23
+ queryKey: QueryKey;
24
+ state: QueryState;
25
+ }
26
+ export interface DehydratedState {
27
+ mutations: DehydratedMutation[];
28
+ queries: DehydratedQuery[];
29
+ }
30
+ export declare type ShouldDehydrateQueryFunction = (query: Query) => boolean;
31
+ export declare type ShouldDehydrateMutationFunction = (mutation: Mutation) => boolean;
32
+ export declare function dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState;
33
+ export declare function hydrate(client: QueryClient, dehydratedState: unknown, options?: HydrateOptions): void;
34
+ export {};
@@ -0,0 +1,20 @@
1
+ export { CancelledError } from './retryer';
2
+ export { QueryCache } from './queryCache';
3
+ export { QueryClient } from './queryClient';
4
+ export { QueryObserver } from './queryObserver';
5
+ export { QueriesObserver } from './queriesObserver';
6
+ export { InfiniteQueryObserver } from './infiniteQueryObserver';
7
+ export { MutationCache } from './mutationCache';
8
+ export { MutationObserver } from './mutationObserver';
9
+ export { notifyManager } from './notifyManager';
10
+ export { focusManager } from './focusManager';
11
+ export { onlineManager } from './onlineManager';
12
+ export { hashQueryKey, isError, parseQueryArgs, parseFilterArgs, parseMutationFilterArgs, parseMutationArgs, } from './utils';
13
+ export type { MutationFilters, QueryFilters } from './utils';
14
+ export { isCancelledError } from './retryer';
15
+ export { dehydrate, hydrate } from './hydration';
16
+ export * from './types';
17
+ export type { Query } from './query';
18
+ export type { Mutation } from './mutation';
19
+ export type { Logger } from './logger';
20
+ export type { DehydrateOptions, DehydratedState, HydrateOptions, ShouldDehydrateMutationFunction, ShouldDehydrateQueryFunction, } from './hydration';
@@ -0,0 +1,15 @@
1
+ import type { QueryBehavior } from './query';
2
+ import type { InfiniteData, QueryOptions } from './types';
3
+ export declare function infiniteQueryBehavior<TQueryFnData, TError, TData>(): QueryBehavior<TQueryFnData, TError, InfiniteData<TData>>;
4
+ export declare function getNextPageParam(options: QueryOptions<any, any>, pages: unknown[]): unknown | undefined;
5
+ export declare function getPreviousPageParam(options: QueryOptions<any, any>, pages: unknown[]): unknown | undefined;
6
+ /**
7
+ * Checks if there is a next page.
8
+ * Returns `undefined` if it cannot be determined.
9
+ */
10
+ export declare function hasNextPage(options: QueryOptions<any, any, any, any>, pages?: unknown): boolean | undefined;
11
+ /**
12
+ * Checks if there is a previous page.
13
+ * Returns `undefined` if it cannot be determined.
14
+ */
15
+ export declare function hasPreviousPage(options: QueryOptions<any, any, any, any>, pages?: unknown): boolean | undefined;
@@ -0,0 +1,18 @@
1
+ import type { DefaultedInfiniteQueryObserverOptions, FetchNextPageOptions, FetchPreviousPageOptions, InfiniteData, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, QueryKey } from './types';
2
+ import type { QueryClient } from './queryClient';
3
+ import { NotifyOptions, ObserverFetchOptions, QueryObserver } from './queryObserver';
4
+ import { Query } from './query';
5
+ declare type InfiniteQueryObserverListener<TData, TError> = (result: InfiniteQueryObserverResult<TData, TError>) => void;
6
+ export declare class InfiniteQueryObserver<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserver<TQueryFnData, TError, InfiniteData<TData>, InfiniteData<TQueryData>, TQueryKey> {
7
+ subscribe: (listener?: InfiniteQueryObserverListener<TData, TError>) => () => void;
8
+ getCurrentResult: () => InfiniteQueryObserverResult<TData, TError>;
9
+ protected fetch: (fetchOptions: ObserverFetchOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
10
+ constructor(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
11
+ protected bindMethods(): void;
12
+ setOptions(options?: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
13
+ getOptimisticResult(options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): InfiniteQueryObserverResult<TData, TError>;
14
+ fetchNextPage({ pageParam, ...options }?: FetchNextPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
15
+ fetchPreviousPage({ pageParam, ...options }?: FetchPreviousPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
16
+ protected createResult(query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): InfiniteQueryObserverResult<TData, TError>;
17
+ }
18
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface Logger {
2
+ log: LogFunction;
3
+ warn: LogFunction;
4
+ error: LogFunction;
5
+ }
6
+ declare type LogFunction = (...args: any[]) => void;
7
+ export declare const defaultLogger: Logger;
8
+ export {};
@@ -0,0 +1,70 @@
1
+ import type { MutationOptions, MutationStatus, MutationMeta } from './types';
2
+ import type { MutationCache } from './mutationCache';
3
+ import type { MutationObserver } from './mutationObserver';
4
+ import { Logger } from './logger';
5
+ import { Removable } from './removable';
6
+ interface MutationConfig<TData, TError, TVariables, TContext> {
7
+ mutationId: number;
8
+ mutationCache: MutationCache;
9
+ options: MutationOptions<TData, TError, TVariables, TContext>;
10
+ logger?: Logger;
11
+ defaultOptions?: MutationOptions<TData, TError, TVariables, TContext>;
12
+ state?: MutationState<TData, TError, TVariables, TContext>;
13
+ meta?: MutationMeta;
14
+ }
15
+ export interface MutationState<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> {
16
+ context: TContext | undefined;
17
+ data: TData | undefined;
18
+ error: TError | null;
19
+ failureCount: number;
20
+ isPaused: boolean;
21
+ status: MutationStatus;
22
+ variables: TVariables | undefined;
23
+ }
24
+ interface FailedAction {
25
+ type: 'failed';
26
+ }
27
+ interface LoadingAction<TVariables, TContext> {
28
+ type: 'loading';
29
+ variables?: TVariables;
30
+ context?: TContext;
31
+ }
32
+ interface SuccessAction<TData> {
33
+ type: 'success';
34
+ data: TData;
35
+ }
36
+ interface ErrorAction<TError> {
37
+ type: 'error';
38
+ error: TError;
39
+ }
40
+ interface PauseAction {
41
+ type: 'pause';
42
+ }
43
+ interface ContinueAction {
44
+ type: 'continue';
45
+ }
46
+ interface SetStateAction<TData, TError, TVariables, TContext> {
47
+ type: 'setState';
48
+ state: MutationState<TData, TError, TVariables, TContext>;
49
+ }
50
+ export declare type Action<TData, TError, TVariables, TContext> = ContinueAction | ErrorAction<TError> | FailedAction | LoadingAction<TVariables, TContext> | PauseAction | SetStateAction<TData, TError, TVariables, TContext> | SuccessAction<TData>;
51
+ export declare class Mutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends Removable {
52
+ state: MutationState<TData, TError, TVariables, TContext>;
53
+ options: MutationOptions<TData, TError, TVariables, TContext>;
54
+ mutationId: number;
55
+ meta: MutationMeta | undefined;
56
+ private observers;
57
+ private mutationCache;
58
+ private logger;
59
+ private retryer?;
60
+ constructor(config: MutationConfig<TData, TError, TVariables, TContext>);
61
+ setState(state: MutationState<TData, TError, TVariables, TContext>): void;
62
+ addObserver(observer: MutationObserver<any, any, any, any>): void;
63
+ removeObserver(observer: MutationObserver<any, any, any, any>): void;
64
+ protected optionalRemove(): void;
65
+ continue(): Promise<TData>;
66
+ execute(): Promise<TData>;
67
+ private dispatch;
68
+ }
69
+ export declare function getDefaultState<TData, TError, TVariables, TContext>(): MutationState<TData, TError, TVariables, TContext>;
70
+ export {};
@@ -0,0 +1,52 @@
1
+ import { MutationObserver } from './mutationObserver';
2
+ import type { MutationOptions } from './types';
3
+ import type { QueryClient } from './queryClient';
4
+ import { Action, Mutation, MutationState } from './mutation';
5
+ import { MutationFilters } from './utils';
6
+ import { Subscribable } from './subscribable';
7
+ interface MutationCacheConfig {
8
+ onError?: (error: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => void;
9
+ onSuccess?: (data: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => void;
10
+ onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown, unknown>) => void;
11
+ }
12
+ interface NotifyEventMutationAdded {
13
+ type: 'added';
14
+ mutation: Mutation<any, any, any, any>;
15
+ }
16
+ interface NotifyEventMutationRemoved {
17
+ type: 'removed';
18
+ mutation: Mutation<any, any, any, any>;
19
+ }
20
+ interface NotifyEventMutationObserverAdded {
21
+ type: 'observerAdded';
22
+ mutation: Mutation<any, any, any, any>;
23
+ observer: MutationObserver<any, any, any>;
24
+ }
25
+ interface NotifyEventMutationObserverRemoved {
26
+ type: 'observerRemoved';
27
+ mutation: Mutation<any, any, any, any>;
28
+ observer: MutationObserver<any, any, any>;
29
+ }
30
+ interface NotifyEventMutationUpdated {
31
+ type: 'updated';
32
+ mutation: Mutation<any, any, any, any>;
33
+ action: Action<any, any, any, any>;
34
+ }
35
+ declare type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationUpdated;
36
+ declare type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
37
+ export declare class MutationCache extends Subscribable<MutationCacheListener> {
38
+ config: MutationCacheConfig;
39
+ private mutations;
40
+ private mutationId;
41
+ constructor(config?: MutationCacheConfig);
42
+ build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>;
43
+ add(mutation: Mutation<any, any, any, any>): void;
44
+ remove(mutation: Mutation<any, any, any, any>): void;
45
+ clear(): void;
46
+ getAll(): Mutation[];
47
+ find<TData = unknown, TError = unknown, TVariables = any, TContext = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext> | undefined;
48
+ findAll(filters: MutationFilters): Mutation[];
49
+ notify(event: MutationCacheNotifyEvent): void;
50
+ resumePausedMutations(): Promise<void>;
51
+ }
52
+ export {};
@@ -0,0 +1,23 @@
1
+ import { Action } from './mutation';
2
+ import type { QueryClient } from './queryClient';
3
+ import { Subscribable } from './subscribable';
4
+ import type { MutateOptions, MutationObserverResult, MutationObserverOptions } from './types';
5
+ declare type MutationObserverListener<TData, TError, TVariables, TContext> = (result: MutationObserverResult<TData, TError, TVariables, TContext>) => void;
6
+ export declare class MutationObserver<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>> {
7
+ options: MutationObserverOptions<TData, TError, TVariables, TContext>;
8
+ private client;
9
+ private currentResult;
10
+ private currentMutation?;
11
+ private mutateOptions?;
12
+ constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TContext>);
13
+ protected bindMethods(): void;
14
+ setOptions(options?: MutationObserverOptions<TData, TError, TVariables, TContext>): void;
15
+ protected onUnsubscribe(): void;
16
+ onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void;
17
+ getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TContext>;
18
+ reset(): void;
19
+ mutate(variables?: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>;
20
+ private updateResult;
21
+ private notify;
22
+ }
23
+ export {};
@@ -0,0 +1,18 @@
1
+ declare type NotifyCallback = () => void;
2
+ declare type NotifyFunction = (callback: () => void) => void;
3
+ declare type BatchNotifyFunction = (callback: () => void) => void;
4
+ export declare function createNotifyManager(): {
5
+ readonly batch: <T>(callback: () => T) => T;
6
+ readonly batchCalls: <T_1 extends Function>(callback: T_1) => T_1;
7
+ readonly schedule: (callback: NotifyCallback) => void;
8
+ readonly setNotifyFunction: (fn: NotifyFunction) => void;
9
+ readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
10
+ };
11
+ export declare const notifyManager: {
12
+ readonly batch: <T>(callback: () => T) => T;
13
+ readonly batchCalls: <T_1 extends Function>(callback: T_1) => T_1;
14
+ readonly schedule: (callback: NotifyCallback) => void;
15
+ readonly setNotifyFunction: (fn: NotifyFunction) => void;
16
+ readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
17
+ };
18
+ export {};
@@ -0,0 +1,16 @@
1
+ import { Subscribable } from './subscribable';
2
+ declare type SetupFn = (setOnline: (online?: boolean) => void) => (() => void) | undefined;
3
+ export declare class OnlineManager extends Subscribable {
4
+ private online?;
5
+ private cleanup?;
6
+ private setup;
7
+ constructor();
8
+ protected onSubscribe(): void;
9
+ protected onUnsubscribe(): void;
10
+ setEventListener(setup: SetupFn): void;
11
+ setOnline(online?: boolean): void;
12
+ onOnline(): void;
13
+ isOnline(): boolean;
14
+ }
15
+ export declare const onlineManager: OnlineManager;
16
+ export {};
@@ -0,0 +1,23 @@
1
+ import type { QueryObserverOptions, QueryObserverResult } from './types';
2
+ import type { QueryClient } from './queryClient';
3
+ import { NotifyOptions } from './queryObserver';
4
+ import { Subscribable } from './subscribable';
5
+ declare type QueriesObserverListener = (result: QueryObserverResult[]) => void;
6
+ export declare class QueriesObserver extends Subscribable<QueriesObserverListener> {
7
+ private client;
8
+ private result;
9
+ private queries;
10
+ private observers;
11
+ private observersMap;
12
+ constructor(client: QueryClient, queries?: QueryObserverOptions[]);
13
+ protected onSubscribe(): void;
14
+ protected onUnsubscribe(): void;
15
+ destroy(): void;
16
+ setQueries(queries: QueryObserverOptions[], notifyOptions?: NotifyOptions): void;
17
+ getCurrentResult(): QueryObserverResult[];
18
+ getOptimisticResult(queries: QueryObserverOptions[]): QueryObserverResult[];
19
+ private findMatchingObservers;
20
+ private onUpdate;
21
+ private notify;
22
+ }
23
+ export {};
@@ -0,0 +1,119 @@
1
+ import type { QueryKey, QueryOptions, QueryStatus, QueryMeta, CancelOptions, SetDataOptions, FetchStatus } from './types';
2
+ import type { QueryCache } from './queryCache';
3
+ import type { QueryObserver } from './queryObserver';
4
+ import { Logger } from './logger';
5
+ import { Removable } from './removable';
6
+ interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
7
+ cache: QueryCache;
8
+ queryKey: TQueryKey;
9
+ queryHash: string;
10
+ logger?: Logger;
11
+ options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
12
+ defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
13
+ state?: QueryState<TData, TError>;
14
+ meta: QueryMeta | undefined;
15
+ }
16
+ export interface QueryState<TData = unknown, TError = unknown> {
17
+ data: TData | undefined;
18
+ dataUpdateCount: number;
19
+ dataUpdatedAt: number;
20
+ error: TError | null;
21
+ errorUpdateCount: number;
22
+ errorUpdatedAt: number;
23
+ fetchFailureCount: number;
24
+ fetchMeta: any;
25
+ isInvalidated: boolean;
26
+ status: QueryStatus;
27
+ fetchStatus: FetchStatus;
28
+ }
29
+ export interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
30
+ fetchFn: () => unknown | Promise<unknown>;
31
+ fetchOptions?: FetchOptions;
32
+ signal?: AbortSignal;
33
+ options: QueryOptions<TQueryFnData, TError, TData, any>;
34
+ queryKey: TQueryKey;
35
+ state: QueryState<TData, TError>;
36
+ meta: QueryMeta | undefined;
37
+ }
38
+ export interface QueryBehavior<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
39
+ onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>) => void;
40
+ }
41
+ export interface FetchOptions {
42
+ cancelRefetch?: boolean;
43
+ meta?: any;
44
+ }
45
+ interface FailedAction {
46
+ type: 'failed';
47
+ }
48
+ interface FetchAction {
49
+ type: 'fetch';
50
+ meta?: any;
51
+ }
52
+ interface SuccessAction<TData> {
53
+ data: TData | undefined;
54
+ type: 'success';
55
+ dataUpdatedAt?: number;
56
+ manual?: boolean;
57
+ }
58
+ interface ErrorAction<TError> {
59
+ type: 'error';
60
+ error: TError;
61
+ }
62
+ interface InvalidateAction {
63
+ type: 'invalidate';
64
+ }
65
+ interface PauseAction {
66
+ type: 'pause';
67
+ }
68
+ interface ContinueAction {
69
+ type: 'continue';
70
+ }
71
+ interface SetStateAction<TData, TError> {
72
+ type: 'setState';
73
+ state: QueryState<TData, TError>;
74
+ setStateOptions?: SetStateOptions;
75
+ }
76
+ export declare type Action<TData, TError> = ContinueAction | ErrorAction<TError> | FailedAction | FetchAction | InvalidateAction | PauseAction | SetStateAction<TData, TError> | SuccessAction<TData>;
77
+ export interface SetStateOptions {
78
+ meta?: any;
79
+ }
80
+ export declare class Query<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
81
+ queryKey: TQueryKey;
82
+ queryHash: string;
83
+ options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
84
+ initialState: QueryState<TData, TError>;
85
+ revertState?: QueryState<TData, TError>;
86
+ state: QueryState<TData, TError>;
87
+ meta: QueryMeta | undefined;
88
+ isFetchingOptimistic?: boolean;
89
+ private cache;
90
+ private logger;
91
+ private promise?;
92
+ private retryer?;
93
+ private observers;
94
+ private defaultOptions?;
95
+ private abortSignalConsumed;
96
+ constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
97
+ private setOptions;
98
+ protected optionalRemove(): void;
99
+ setData(newData: TData, options?: SetDataOptions & {
100
+ manual: boolean;
101
+ }): TData;
102
+ setState(state: QueryState<TData, TError>, setStateOptions?: SetStateOptions): void;
103
+ cancel(options?: CancelOptions): Promise<void>;
104
+ destroy(): void;
105
+ reset(): void;
106
+ isActive(): boolean;
107
+ isDisabled(): boolean;
108
+ isStale(): boolean;
109
+ isStaleByTime(staleTime?: number): boolean;
110
+ onFocus(): void;
111
+ onOnline(): void;
112
+ addObserver(observer: QueryObserver<any, any, any, any, any>): void;
113
+ removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
114
+ getObserversCount(): number;
115
+ invalidate(): void;
116
+ fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>;
117
+ private dispatch;
118
+ }
119
+ export {};
@@ -0,0 +1,59 @@
1
+ import { QueryFilters } from './utils';
2
+ import { Action, Query, QueryState } from './query';
3
+ import type { QueryKey, QueryOptions } from './types';
4
+ import type { QueryClient } from './queryClient';
5
+ import { Subscribable } from './subscribable';
6
+ import { QueryObserver } from './queryObserver';
7
+ interface QueryCacheConfig {
8
+ onError?: (error: unknown, query: Query<unknown, unknown, unknown>) => void;
9
+ onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
10
+ }
11
+ interface NotifyEventQueryAdded {
12
+ type: 'added';
13
+ query: Query<any, any, any, any>;
14
+ }
15
+ interface NotifyEventQueryRemoved {
16
+ type: 'removed';
17
+ query: Query<any, any, any, any>;
18
+ }
19
+ interface NotifyEventQueryUpdated {
20
+ type: 'updated';
21
+ query: Query<any, any, any, any>;
22
+ action: Action<any, any>;
23
+ }
24
+ interface NotifyEventQueryObserverAdded {
25
+ type: 'observerAdded';
26
+ query: Query<any, any, any, any>;
27
+ observer: QueryObserver<any, any, any, any, any>;
28
+ }
29
+ interface NotifyEventQueryObserverRemoved {
30
+ type: 'observerRemoved';
31
+ query: Query<any, any, any, any>;
32
+ observer: QueryObserver<any, any, any, any, any>;
33
+ }
34
+ interface NotifyEventQueryObserverResultsUpdated {
35
+ type: 'observerResultsUpdated';
36
+ query: Query<any, any, any, any>;
37
+ }
38
+ declare type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated;
39
+ declare type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
40
+ export declare class QueryCache extends Subscribable<QueryCacheListener> {
41
+ config: QueryCacheConfig;
42
+ private queries;
43
+ private queriesMap;
44
+ constructor(config?: QueryCacheConfig);
45
+ build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
46
+ add(query: Query<any, any, any, any>): void;
47
+ remove(query: Query<any, any, any, any>): void;
48
+ clear(): void;
49
+ get<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueyKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueyKey> | undefined;
50
+ getAll(): Query[];
51
+ find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(arg1: QueryKey, arg2?: QueryFilters): Query<TQueryFnData, TError, TData> | undefined;
52
+ findAll(queryKey?: QueryKey, filters?: QueryFilters): Query[];
53
+ findAll(filters?: QueryFilters): Query[];
54
+ findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query[];
55
+ notify(event: QueryCacheNotifyEvent): void;
56
+ onFocus(): void;
57
+ onOnline(): void;
58
+ }
59
+ export {};
@@ -0,0 +1,65 @@
1
+ import { QueryFilters, Updater, MutationFilters } from './utils';
2
+ import type { QueryClientConfig, DefaultOptions, FetchInfiniteQueryOptions, FetchQueryOptions, InfiniteData, InvalidateOptions, InvalidateQueryFilters, MutationKey, MutationObserverOptions, MutationOptions, QueryFunction, QueryKey, QueryObserverOptions, RefetchOptions, RefetchQueryFilters, ResetOptions, ResetQueryFilters, SetDataOptions } from './types';
3
+ import type { QueryState } from './query';
4
+ import { QueryCache } from './queryCache';
5
+ import { MutationCache } from './mutationCache';
6
+ import { CancelOptions, DefaultedQueryObserverOptions } from './types';
7
+ import { Logger } from './logger';
8
+ export declare class QueryClient {
9
+ private queryCache;
10
+ private mutationCache;
11
+ private logger;
12
+ private defaultOptions;
13
+ private queryDefaults;
14
+ private mutationDefaults;
15
+ private unsubscribeFocus?;
16
+ private unsubscribeOnline?;
17
+ constructor(config?: QueryClientConfig);
18
+ mount(): void;
19
+ unmount(): void;
20
+ isFetching(filters?: QueryFilters): number;
21
+ isFetching(queryKey?: QueryKey, filters?: QueryFilters): number;
22
+ isMutating(filters?: MutationFilters): number;
23
+ getQueryData<TData = unknown>(queryKey: QueryKey, filters?: QueryFilters): TData | undefined;
24
+ getQueriesData<TData = unknown>(queryKey: QueryKey): [QueryKey, TData][];
25
+ getQueriesData<TData = unknown>(filters: QueryFilters): [QueryKey, TData][];
26
+ setQueryData<TData>(queryKey: QueryKey, updater: Updater<TData | undefined, TData | undefined>, options?: SetDataOptions): TData | undefined;
27
+ setQueriesData<TData>(queryKey: QueryKey, updater: Updater<TData | undefined, TData | undefined>, options?: SetDataOptions): [QueryKey, TData | undefined][];
28
+ setQueriesData<TData>(filters: QueryFilters, updater: Updater<TData | undefined, TData | undefined>, options?: SetDataOptions): [QueryKey, TData | undefined][];
29
+ getQueryState<TData = unknown, TError = undefined>(queryKey: QueryKey, filters?: QueryFilters): QueryState<TData, TError> | undefined;
30
+ removeQueries(filters?: QueryFilters): void;
31
+ removeQueries(queryKey?: QueryKey, filters?: QueryFilters): void;
32
+ resetQueries<TPageData = unknown>(filters?: ResetQueryFilters<TPageData>, options?: ResetOptions): Promise<void>;
33
+ resetQueries<TPageData = unknown>(queryKey?: QueryKey, filters?: ResetQueryFilters<TPageData>, options?: ResetOptions): Promise<void>;
34
+ cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>;
35
+ cancelQueries(queryKey?: QueryKey, filters?: QueryFilters, options?: CancelOptions): Promise<void>;
36
+ invalidateQueries<TPageData = unknown>(filters?: InvalidateQueryFilters<TPageData>, options?: InvalidateOptions): Promise<void>;
37
+ invalidateQueries<TPageData = unknown>(queryKey?: QueryKey, filters?: InvalidateQueryFilters<TPageData>, options?: InvalidateOptions): Promise<void>;
38
+ refetchQueries<TPageData = unknown>(filters?: RefetchQueryFilters<TPageData>, options?: RefetchOptions): Promise<void>;
39
+ refetchQueries<TPageData = unknown>(queryKey?: QueryKey, filters?: RefetchQueryFilters<TPageData>, options?: RefetchOptions): Promise<void>;
40
+ fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
41
+ fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
42
+ fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
43
+ prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
44
+ prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
45
+ prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
46
+ fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<InfiniteData<TData>>;
47
+ fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<InfiniteData<TData>>;
48
+ fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<InfiniteData<TData>>;
49
+ prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
50
+ prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
51
+ prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
52
+ resumePausedMutations(): Promise<void>;
53
+ getQueryCache(): QueryCache;
54
+ getMutationCache(): MutationCache;
55
+ getLogger(): Logger;
56
+ getDefaultOptions(): DefaultOptions;
57
+ setDefaultOptions(options: DefaultOptions): void;
58
+ setQueryDefaults(queryKey: QueryKey, options: QueryObserverOptions<unknown, any, any, any>): void;
59
+ getQueryDefaults(queryKey?: QueryKey): QueryObserverOptions<any, any, any, any, any> | undefined;
60
+ setMutationDefaults(mutationKey: MutationKey, options: MutationObserverOptions<any, any, any, any>): void;
61
+ getMutationDefaults(mutationKey?: MutationKey): MutationObserverOptions<any, any, any, any> | undefined;
62
+ defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
63
+ defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
64
+ clear(): void;
65
+ }