@tanstack/query-devtools 5.65.0 → 5.71.2

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.
package/build/index.d.cts CHANGED
@@ -18,9 +18,6 @@ declare class Subscribable<TListener extends Function> {
18
18
  }
19
19
 
20
20
  type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
21
- interface NotifyOptions {
22
- listeners?: boolean;
23
- }
24
21
  interface ObserverFetchOptions extends FetchOptions {
25
22
  throwOnError?: boolean;
26
23
  }
@@ -34,7 +31,7 @@ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData
34
31
  shouldFetchOnReconnect(): boolean;
35
32
  shouldFetchOnWindowFocus(): boolean;
36
33
  destroy(): void;
37
- setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
34
+ setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): void;
38
35
  getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
39
36
  getCurrentResult(): QueryObserverResult<TData, TError>;
40
37
  trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
@@ -44,12 +41,12 @@ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData
44
41
  fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
45
42
  protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
46
43
  protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
47
- updateResult(notifyOptions?: NotifyOptions): void;
44
+ updateResult(): void;
48
45
  onQueryUpdate(): void;
49
46
  }
50
47
 
51
48
  interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
52
- cache: QueryCache;
49
+ client: QueryClient;
53
50
  queryKey: TQueryKey;
54
51
  queryHash: string;
55
52
  options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
@@ -75,6 +72,7 @@ interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey =
75
72
  fetchOptions?: FetchOptions;
76
73
  signal: AbortSignal;
77
74
  options: QueryOptions<TQueryFnData, TError, TData, any>;
75
+ client: QueryClient;
78
76
  queryKey: TQueryKey;
79
77
  state: QueryState<TData, TError>;
80
78
  }
@@ -385,7 +383,7 @@ declare class QueryCache extends Subscribable<QueryCacheListener> {
385
383
  get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
386
384
  getAll(): Array<Query>;
387
385
  find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
388
- findAll(filters?: QueryFilters): Array<Query>;
386
+ findAll(filters?: QueryFilters<any, any, any, any>): Array<Query>;
389
387
  notify(event: QueryCacheNotifyEvent): void;
390
388
  onFocus(): void;
391
389
  onOnline(): void;
@@ -398,17 +396,24 @@ declare class QueryClient {
398
396
  unmount(): void;
399
397
  isFetching<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters): number;
400
398
  isMutating<TMutationFilters extends MutationFilters<any, any> = MutationFilters>(filters?: TMutationFilters): number;
401
- getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
399
+ /**
400
+ * Imperative (non-reactive) way to retrieve data for a QueryKey.
401
+ * Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.
402
+ *
403
+ * Hint: Do not use this function inside a component, because it won't receive updates.
404
+ * Use `useQuery` to create a `QueryObserver` that subscribes to changes.
405
+ */
406
+ getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
402
407
  ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
403
408
  getQueriesData<TQueryFnData = unknown, TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters<TQueryFnData>, TInferredQueryFnData = TQueryFilters extends QueryFilters<infer TData, any, any, any> ? TData : TQueryFnData>(filters: TQueryFilters): Array<[QueryKey, TInferredQueryFnData | undefined]>;
404
- setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
409
+ setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
405
410
  setQueriesData<TQueryFnData, TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters<TQueryFnData>, TInferredQueryFnData = TQueryFilters extends QueryFilters<infer TData, any, any, any> ? TData : TQueryFnData>(filters: TQueryFilters, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): Array<[QueryKey, TInferredQueryFnData | undefined]>;
406
- getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData, TInferredError = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
407
- removeQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters): void;
408
- resetQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters, options?: ResetOptions): Promise<void>;
409
- cancelQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters, cancelOptions?: CancelOptions): Promise<void>;
410
- invalidateQueries<TInvalidateQueryFilters extends InvalidateQueryFilters<any, any, any, any> = InvalidateQueryFilters>(filters?: TInvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
411
- refetchQueries<TRefetchQueryFilters extends RefetchQueryFilters<any, any, any, any> = RefetchQueryFilters>(filters?: TRefetchQueryFilters, options?: RefetchOptions): Promise<void>;
411
+ getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
412
+ removeQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>): void;
413
+ resetQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: ResetOptions): Promise<void>;
414
+ cancelQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, cancelOptions?: CancelOptions): Promise<void>;
415
+ invalidateQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: InvalidateQueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: InvalidateOptions): Promise<void>;
416
+ refetchQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: RefetchQueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: RefetchOptions): Promise<void>;
412
417
  fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
413
418
  prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
414
419
  fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
@@ -422,7 +427,7 @@ declare class QueryClient {
422
427
  setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
423
428
  getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
424
429
  setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): void;
425
- getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
430
+ getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
426
431
  defaultQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
427
432
  defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
428
433
  clear(): void;
@@ -433,6 +438,7 @@ interface DehydrateOptions {
433
438
  serializeData?: TransformerFn;
434
439
  shouldDehydrateMutation?: (mutation: Mutation) => boolean;
435
440
  shouldDehydrateQuery?: (query: Query) => boolean;
441
+ shouldRedactErrors?: (error: unknown) => boolean;
436
442
  }
437
443
  interface HydrateOptions {
438
444
  defaultOptions?: {
@@ -466,11 +472,14 @@ type DataTag<TType, TValue, TError = UnsetMarker> = TType extends AnyDataTag ? T
466
472
  [dataTagSymbol]: TValue;
467
473
  [dataTagErrorSymbol]: TError;
468
474
  };
475
+ type InferDataFromTag<TQueryFnData, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData;
476
+ type InferErrorFromTag<TError, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError;
469
477
  type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
470
478
  type StaleTime<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = number | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => number);
471
479
  type Enabled<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = boolean | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean);
472
480
  type QueryPersister<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? (queryFn: QueryFunction<T, TQueryKey, never>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T> : (queryFn: QueryFunction<T, TQueryKey, TPageParam>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T>;
473
481
  type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? {
482
+ client: QueryClient;
474
483
  queryKey: TQueryKey;
475
484
  signal: AbortSignal;
476
485
  meta: QueryMeta | undefined;
@@ -481,6 +490,7 @@ type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = ne
481
490
  */
482
491
  direction?: unknown;
483
492
  } : {
493
+ client: QueryClient;
484
494
  queryKey: TQueryKey;
485
495
  signal: AbortSignal;
486
496
  pageParam: TPageParam;
package/build/index.d.ts CHANGED
@@ -18,9 +18,6 @@ declare class Subscribable<TListener extends Function> {
18
18
  }
19
19
 
20
20
  type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
21
- interface NotifyOptions {
22
- listeners?: boolean;
23
- }
24
21
  interface ObserverFetchOptions extends FetchOptions {
25
22
  throwOnError?: boolean;
26
23
  }
@@ -34,7 +31,7 @@ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData
34
31
  shouldFetchOnReconnect(): boolean;
35
32
  shouldFetchOnWindowFocus(): boolean;
36
33
  destroy(): void;
37
- setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
34
+ setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): void;
38
35
  getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
39
36
  getCurrentResult(): QueryObserverResult<TData, TError>;
40
37
  trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
@@ -44,12 +41,12 @@ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData
44
41
  fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
45
42
  protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
46
43
  protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
47
- updateResult(notifyOptions?: NotifyOptions): void;
44
+ updateResult(): void;
48
45
  onQueryUpdate(): void;
49
46
  }
50
47
 
51
48
  interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
52
- cache: QueryCache;
49
+ client: QueryClient;
53
50
  queryKey: TQueryKey;
54
51
  queryHash: string;
55
52
  options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
@@ -75,6 +72,7 @@ interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey =
75
72
  fetchOptions?: FetchOptions;
76
73
  signal: AbortSignal;
77
74
  options: QueryOptions<TQueryFnData, TError, TData, any>;
75
+ client: QueryClient;
78
76
  queryKey: TQueryKey;
79
77
  state: QueryState<TData, TError>;
80
78
  }
@@ -385,7 +383,7 @@ declare class QueryCache extends Subscribable<QueryCacheListener> {
385
383
  get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
386
384
  getAll(): Array<Query>;
387
385
  find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
388
- findAll(filters?: QueryFilters): Array<Query>;
386
+ findAll(filters?: QueryFilters<any, any, any, any>): Array<Query>;
389
387
  notify(event: QueryCacheNotifyEvent): void;
390
388
  onFocus(): void;
391
389
  onOnline(): void;
@@ -398,17 +396,24 @@ declare class QueryClient {
398
396
  unmount(): void;
399
397
  isFetching<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters): number;
400
398
  isMutating<TMutationFilters extends MutationFilters<any, any> = MutationFilters>(filters?: TMutationFilters): number;
401
- getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
399
+ /**
400
+ * Imperative (non-reactive) way to retrieve data for a QueryKey.
401
+ * Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.
402
+ *
403
+ * Hint: Do not use this function inside a component, because it won't receive updates.
404
+ * Use `useQuery` to create a `QueryObserver` that subscribes to changes.
405
+ */
406
+ getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
402
407
  ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
403
408
  getQueriesData<TQueryFnData = unknown, TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters<TQueryFnData>, TInferredQueryFnData = TQueryFilters extends QueryFilters<infer TData, any, any, any> ? TData : TQueryFnData>(filters: TQueryFilters): Array<[QueryKey, TInferredQueryFnData | undefined]>;
404
- setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
409
+ setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
405
410
  setQueriesData<TQueryFnData, TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters<TQueryFnData>, TInferredQueryFnData = TQueryFilters extends QueryFilters<infer TData, any, any, any> ? TData : TQueryFnData>(filters: TQueryFilters, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): Array<[QueryKey, TInferredQueryFnData | undefined]>;
406
- getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData, TInferredError = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
407
- removeQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters): void;
408
- resetQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters, options?: ResetOptions): Promise<void>;
409
- cancelQueries<TQueryFilters extends QueryFilters<any, any, any, any> = QueryFilters>(filters?: TQueryFilters, cancelOptions?: CancelOptions): Promise<void>;
410
- invalidateQueries<TInvalidateQueryFilters extends InvalidateQueryFilters<any, any, any, any> = InvalidateQueryFilters>(filters?: TInvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
411
- refetchQueries<TRefetchQueryFilters extends RefetchQueryFilters<any, any, any, any> = RefetchQueryFilters>(filters?: TRefetchQueryFilters, options?: RefetchOptions): Promise<void>;
411
+ getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
412
+ removeQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>): void;
413
+ resetQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: ResetOptions): Promise<void>;
414
+ cancelQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: QueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, cancelOptions?: CancelOptions): Promise<void>;
415
+ invalidateQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: InvalidateQueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: InvalidateOptions): Promise<void>;
416
+ refetchQueries<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(filters?: RefetchQueryFilters<TInferredQueryFnData, TInferredError, TInferredQueryFnData, TTaggedQueryKey>, options?: RefetchOptions): Promise<void>;
412
417
  fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
413
418
  prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
414
419
  fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
@@ -422,7 +427,7 @@ declare class QueryClient {
422
427
  setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
423
428
  getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
424
429
  setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): void;
425
- getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
430
+ getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
426
431
  defaultQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
427
432
  defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
428
433
  clear(): void;
@@ -433,6 +438,7 @@ interface DehydrateOptions {
433
438
  serializeData?: TransformerFn;
434
439
  shouldDehydrateMutation?: (mutation: Mutation) => boolean;
435
440
  shouldDehydrateQuery?: (query: Query) => boolean;
441
+ shouldRedactErrors?: (error: unknown) => boolean;
436
442
  }
437
443
  interface HydrateOptions {
438
444
  defaultOptions?: {
@@ -466,11 +472,14 @@ type DataTag<TType, TValue, TError = UnsetMarker> = TType extends AnyDataTag ? T
466
472
  [dataTagSymbol]: TValue;
467
473
  [dataTagErrorSymbol]: TError;
468
474
  };
475
+ type InferDataFromTag<TQueryFnData, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData;
476
+ type InferErrorFromTag<TError, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError;
469
477
  type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
470
478
  type StaleTime<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = number | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => number);
471
479
  type Enabled<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = boolean | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean);
472
480
  type QueryPersister<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? (queryFn: QueryFunction<T, TQueryKey, never>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T> : (queryFn: QueryFunction<T, TQueryKey, TPageParam>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T>;
473
481
  type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? {
482
+ client: QueryClient;
474
483
  queryKey: TQueryKey;
475
484
  signal: AbortSignal;
476
485
  meta: QueryMeta | undefined;
@@ -481,6 +490,7 @@ type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = ne
481
490
  */
482
491
  direction?: unknown;
483
492
  } : {
493
+ client: QueryClient;
484
494
  queryKey: TQueryKey;
485
495
  signal: AbortSignal;
486
496
  pageParam: TPageParam;
package/build/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import { createSignal, render, lazy, setupStyleSheet, createComponent, mergeProps } from './chunk/JAANZ2TG.js';
1
+ import { createSignal, render, lazy, setupStyleSheet, createComponent, mergeProps } from './chunk/KMI5VYOH.js';
2
2
 
3
3
  // src/TanstackQueryDevtools.tsx
4
4
  var TanstackQueryDevtools = class {
@@ -69,7 +69,7 @@ var TanstackQueryDevtools = class {
69
69
  if (this.#Component) {
70
70
  Devtools = this.#Component;
71
71
  } else {
72
- Devtools = lazy(() => import('./DevtoolsComponent/HO4MOOFI.js'));
72
+ Devtools = lazy(() => import('./DevtoolsComponent/BOZWRHTN.js'));
73
73
  this.#Component = Devtools;
74
74
  }
75
75
  setupStyleSheet(this.#styleNonce, this.#shadowDOMTarget);
@@ -192,7 +192,7 @@ var TanstackQueryDevtoolsPanel = class {
192
192
  if (this.#Component) {
193
193
  Devtools = this.#Component;
194
194
  } else {
195
- Devtools = lazy(() => import('./DevtoolsPanelComponent/HUY7CZI3.js'));
195
+ Devtools = lazy(() => import('./DevtoolsPanelComponent/U2DVUOLY.js'));
196
196
  this.#Component = Devtools;
197
197
  }
198
198
  setupStyleSheet(this.#styleNonce, this.#shadowDOMTarget);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/query-devtools",
3
- "version": "5.65.0",
3
+ "version": "5.71.2",
4
4
  "description": "Developer tools to interact with and visualize the TanStack Query cache",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -51,12 +51,12 @@
51
51
  "clsx": "^2.1.1",
52
52
  "goober": "^2.1.16",
53
53
  "npm-run-all": "^4.1.5",
54
- "solid-js": "^1.9.3",
54
+ "solid-js": "^1.9.5",
55
55
  "solid-transition-group": "^0.2.3",
56
56
  "superjson": "^2.2.1",
57
57
  "tsup-preset-solid": "^2.2.0",
58
- "vite-plugin-solid": "^2.10.2",
59
- "@tanstack/query-core": "5.65.0"
58
+ "vite-plugin-solid": "^2.11.6",
59
+ "@tanstack/query-core": "5.71.1"
60
60
  },
61
61
  "scripts": {}
62
62
  }