reactjrx 1.82.0 → 1.86.0

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 (31) hide show
  1. package/README.md +2 -2
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.js +1058 -1047
  4. package/dist/lib/binding/useSubject.d.ts +2 -2
  5. package/dist/lib/queries/client/QueryClient.d.ts +7 -7
  6. package/dist/lib/queries/client/keys/matchKey.d.ts +1 -1
  7. package/dist/lib/queries/client/mutations/mutation/Mutation.d.ts +5 -0
  8. package/dist/lib/queries/client/mutations/runner/MutationRunner.d.ts +4 -1
  9. package/dist/lib/queries/client/mutations/{defaultMutationState.d.ts → utils/defaultMutationState.d.ts} +1 -1
  10. package/dist/lib/queries/client/mutations/utils/distinctUntilStateChanged.d.ts +4 -0
  11. package/dist/lib/queries/client/mutations/{filters.d.ts → utils/filters.d.ts} +2 -2
  12. package/dist/lib/queries/client/queries/cache/QueryCache.d.ts +1 -1
  13. package/dist/lib/queries/client/queries/observer/QueryObserver.d.ts +3 -3
  14. package/dist/lib/queries/client/queries/observer/types.d.ts +2 -2
  15. package/dist/lib/queries/client/queries/query/delayOnNetworkMode.d.ts +1 -1
  16. package/dist/lib/queries/client/queries/query/execution/executeQuery.d.ts +1 -1
  17. package/dist/lib/queries/client/queries/query/operators.d.ts +1 -1
  18. package/dist/lib/queries/client/queries/query/types.d.ts +2 -0
  19. package/dist/lib/queries/client/queries/types.d.ts +5 -4
  20. package/dist/lib/queries/client/queries/utils.d.ts +3 -1
  21. package/dist/lib/queries/client/types.d.ts +1 -1
  22. package/dist/lib/queries/react/mutations/useIsMutating.d.ts +1 -1
  23. package/dist/lib/queries/react/queries/QueryOptions.rq.types.typeTest.d.ts +1 -0
  24. package/dist/lib/queries/react/queries/isRestoring.d.ts +1 -1
  25. package/dist/lib/queries/react/queries/queryOptions.d.ts +3 -3
  26. package/dist/lib/queries/react/queries/types.d.ts +3 -3
  27. package/dist/lib/state/persistance/adapters/createLocalStorageAdapter.d.ts +1 -1
  28. package/dist/lib/state/persistance/usePersistSignals.d.ts +4 -4
  29. package/dist/lib/utils/types.d.ts +3 -2
  30. package/package.json +2 -2
  31. /package/dist/lib/queries/{react/queries/QueryOptions.rq.types.test.d.ts → client/QueryClient.rq.test.d.ts} +0 -0
@@ -5,8 +5,8 @@ import { Subject } from 'rxjs';
5
5
  * useBehaviorSubject
6
6
  */
7
7
  export declare const useSubject: <S>({ onBeforeComplete, completeOnUnmount }?: {
8
- onBeforeComplete?: () => void;
9
- completeOnUnmount?: boolean;
8
+ onBeforeComplete?: (() => void) | undefined;
9
+ completeOnUnmount?: boolean | undefined;
10
10
  }) => {
11
11
  current: Subject<S>;
12
12
  };
@@ -1,6 +1,6 @@
1
1
  import { CancelOptions } from './queries/retryer/types';
2
2
  import { QueryState } from './queries/query/types';
3
- import { NoInfer } from '../../utils/types';
3
+ import { NoInfer, OmitKeyof } from '../../utils/types';
4
4
  import { DefaultedQueryObserverOptions, QueryObserverOptions } from './queries/observer/types';
5
5
  import { QueryKey } from './keys/types';
6
6
  import { RefetchQueryFilters, DefaultError, InvalidateOptions, InvalidateQueryFilters, ResetOptions } from './types';
@@ -12,7 +12,7 @@ import { MutationCache } from './mutations/cache/MutationCache';
12
12
  import { MutationKey } from './mutations/types';
13
13
 
14
14
  export interface DefaultOptions<TError = DefaultError> {
15
- queries?: Omit<QueryObserverOptions<unknown, TError>, "suspense">;
15
+ queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, "suspense" | "queryKey">;
16
16
  mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>;
17
17
  }
18
18
  export interface QueryClientConfig {
@@ -28,18 +28,18 @@ export declare class QueryClient {
28
28
  getMutationCache(): MutationCache;
29
29
  getQueryCache(): QueryCache;
30
30
  defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
31
- 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>;
32
- fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
31
+ defaultQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
32
+ fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> | FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
33
33
  prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
34
34
  resetQueries(filters?: QueryFilters, options?: ResetOptions): Promise<void>;
35
35
  refetchQueries(filters?: RefetchQueryFilters, options?: RefetchOptions): Promise<void>;
36
36
  getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
37
- setQueryData<TQueryFnData = unknown, TaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
37
+ setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
38
38
  getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
39
- getQueryState<TQueryFnData = unknown, TError = DefaultError>(queryKey: QueryKey): QueryState<TQueryFnData, TError> | undefined;
39
+ getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TError> | undefined;
40
40
  setMutationDefaults(mutationKey: MutationKey, options: Omit<MutationObserverOptions<any, any, any, any>, "mutationKey">): void;
41
41
  setQueryDefaults(queryKey: QueryKey, options: Partial<Omit<QueryObserverOptions<unknown, any, any, any>, "queryKey">>): void;
42
- getQueryDefaults(queryKey: QueryKey): QueryObserverOptions<any, any, any, any, any>;
42
+ getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">;
43
43
  removeQueries(filters?: QueryFilters): void;
44
44
  cancelQueries(filters?: QueryFilters, cancelOptions?: CancelOptions): Promise<void>;
45
45
  invalidateQueries(filters?: InvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
@@ -1,5 +1,5 @@
1
1
  import { QueryKey } from './types';
2
2
 
3
3
  export declare const matchKey: (keyA: QueryKey, keyB: QueryKey, { exact }?: {
4
- exact?: boolean;
4
+ exact?: boolean | undefined;
5
5
  }) => boolean;
@@ -26,6 +26,11 @@ export declare class Mutation<TData = unknown, TError = DefaultError, TVariables
26
26
  */
27
27
  execute(variables: TVariables): Observable<MutationState<TData, TError, TVariables, TContext>>;
28
28
  continue(): Observable<MutationState<TData, TError, TVariables, TContext>>;
29
+ /**
30
+ * Cancel if needed and finalize the mutation.
31
+ * The mutation will be garbage collected automatically
32
+ * when no more observers are listening
33
+ */
29
34
  cancel(): void;
30
35
  }
31
36
  export {};
@@ -11,7 +11,10 @@ interface TriggerSubject<TData, TError = DefaultError, TVariables = void, TConte
11
11
  }
12
12
  export declare class MutationRunner<TData, TError = DefaultError, TVariables = void, TContext = unknown> {
13
13
  #private;
14
- state$: Observable<MutationState<TData, TError, TVariables, TContext>>;
14
+ state$: Observable<{
15
+ state: MutationState<TData, TError, TVariables, TContext>;
16
+ mutation: Mutation<TData, TError, TVariables, TContext>;
17
+ }>;
15
18
  constructor({ __queryFinalizeHook }?: MutationObserverOptions<TData, TError, TVariables, TContext>);
16
19
  trigger({ args, options, mutation }: TriggerSubject<TData, TError, TVariables, TContext>): void;
17
20
  }
@@ -1,3 +1,3 @@
1
- import { MutationState } from './mutation/types';
1
+ import { MutationState } from '../mutation/types';
2
2
 
3
3
  export declare const getDefaultMutationState: <TData = unknown, TError = unknown, TVariables = void, TContext = unknown>() => MutationState<TData, TError, TVariables, TContext>;
@@ -0,0 +1,4 @@
1
+ import { MutationState } from '../mutation/types';
2
+ import { Observable } from 'rxjs';
3
+
4
+ export declare const distinctUntilStateChanged: <State extends MutationState<any, any, any, any>>(stream: Observable<State>) => Observable<State>;
@@ -1,3 +1,3 @@
1
- import { MutationFilters } from './types';
1
+ import { MutationFilters } from '../types';
2
2
 
3
- export declare const createPredicateForFilters: <TData = unknown, TError = Error, TVariables = any, TContext = unknown>({ mutationKey, status, predicate, exact }?: MutationFilters<TData, TError, TVariables, TContext>) => (mutation: import('./mutation/Mutation').Mutation<TData, TError, TVariables, TContext>) => boolean;
3
+ export declare const createPredicateForFilters: <TData = unknown, TError = Error, TVariables = any, TContext = unknown>({ mutationKey, status, predicate, exact }?: MutationFilters<TData, TError, TVariables, TContext>) => (mutation: import('../mutation/Mutation').Mutation<TData, TError, TVariables, TContext>) => boolean;
@@ -24,7 +24,7 @@ export declare class QueryCache {
24
24
  observeIsFetching(filters?: QueryFilters): import('rxjs').Observable<number>;
25
25
  getAll(): Query[];
26
26
  findAll(filters?: QueryFilters): Query[];
27
- build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
27
+ build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
28
28
  add(query: Query<any, any, any, any>): void;
29
29
  get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
30
30
  find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, "queryKey">): Query<TQueryFnData, TError, TData> | undefined;
@@ -35,12 +35,12 @@ export declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError
35
35
  }>;
36
36
  constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
37
37
  protected bindMethods(): void;
38
- setOptions(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
39
- protected buildQuery(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
38
+ setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Query<TQueryFnData, TError, TQueryData, TQueryKey & {}>;
39
+ protected buildQuery(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Query<TQueryFnData, TError, TQueryData, TQueryKey & {}>;
40
40
  protected getObserverResultFromQuery: ({ options, query, optimisticResult, prevResult: { result: prevResult, options: prevResultOptions, state: prevResultState, select: prevSelect, selectError: prevSelectError, selectResult: prevSelectResult } }: {
41
41
  query: Query<TQueryFnData, TError, TQueryData, TQueryKey>;
42
42
  options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
43
- optimisticResult?: boolean;
43
+ optimisticResult?: boolean | undefined;
44
44
  prevResult: Partial<LastResult<TQueryFnData, TError, TData, TQueryData, TQueryKey>>;
45
45
  }) => {
46
46
  result: QueryObserverResult<TData, TError>;
@@ -4,7 +4,7 @@ import { DefaultError } from '../../types';
4
4
  import { QueryKey } from '../../keys/types';
5
5
  import { NonFunctionGuard, WithRequired } from '../../../../utils/types';
6
6
 
7
- export interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam> {
7
+ export interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>, "queryKey"> {
8
8
  /**
9
9
  * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
10
10
  * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
@@ -45,7 +45,7 @@ export interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultEr
45
45
  refetchOnReconnect?: boolean | "idle" | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always");
46
46
  /**
47
47
  * If set to `true`, the query will refetch on mount if the data is stale.
48
- * If set to `false`, will disable additional instances of a query to trigger background refetches.
48
+ * If set to `false`, will disable additional instances of a query to trigger background refetch.
49
49
  * If set to `'always'`, the query will always refetch on mount.
50
50
  * If set to `'always'`, the query will always refetch on mount if idle.
51
51
  * If set to a function, the function will be executed with the latest data and query to compute the value
@@ -3,5 +3,5 @@ import { QueryOptions } from '../types';
3
3
  import { Observable } from 'rxjs';
4
4
 
5
5
  type Result<TData, TError> = Partial<QueryState<TData, TError>>;
6
- export declare const delayOnNetworkMode: <TData, TError>(options: Pick<QueryOptions, "networkMode">) => (source: Observable<Result<TData, TError>>) => Observable<Result<TData, TError>>;
6
+ export declare const delayOnNetworkMode: <TData, TError>(options: Pick<QueryOptions, "networkMode">) => (source: Observable<Partial<QueryState<TData, TError>>>) => Observable<Partial<QueryState<TData, TError>>>;
7
7
  export {};
@@ -3,7 +3,7 @@ import { QueryState } from '../types';
3
3
  import { QueryKey } from '../../../keys/types';
4
4
  import { Observable } from 'rxjs';
5
5
 
6
- export declare const executeQuery: <TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
6
+ export declare const executeQuery: <TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, never> & {
7
7
  queryKey: TQueryKey;
8
8
  onSignalConsumed: () => void;
9
9
  observers$: Observable<number>;
@@ -5,7 +5,7 @@ import { Observable } from 'rxjs';
5
5
  export declare const reduceState: <TQueryFnData = unknown, TError = Error, TData = TQueryFnData>({ getOptions, getState, initialState }: {
6
6
  initialState: QueryState<TData, TError>;
7
7
  getState: () => QueryState<TData, TError>;
8
- getOptions: () => QueryOptions<TQueryFnData, TError, TData, any>;
8
+ getOptions: () => QueryOptions<TQueryFnData, TError, TData, any, never>;
9
9
  }) => (source: Observable<{
10
10
  command: "invalidate" | "cancel" | "reset" | "setData" | "execute";
11
11
  state: Partial<QueryState<TData, TError>>;
@@ -29,6 +29,8 @@ export type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPagePar
29
29
  queryKey: TQueryKey;
30
30
  signal: AbortSignal;
31
31
  meta: QueryMeta | undefined;
32
+ pageParam?: unknown;
33
+ direction?: "forward" | "backward";
32
34
  } : {
33
35
  queryKey: TQueryKey;
34
36
  signal: AbortSignal;
@@ -1,3 +1,4 @@
1
+ import { SkipToken } from './utils';
1
2
  import { QueryMeta, QueryFunction, QueryFunctionContext, QueryBehavior } from './query/types';
2
3
  import { Query } from './query/Query';
3
4
  import { InfiniteQueryObserverResult } from './observer/types';
@@ -6,8 +7,8 @@ import { QueryKey } from '../keys/types';
6
7
  import { NoInfer, WithRequired } from '../../../utils/types';
7
8
 
8
9
  export declare const dataTagSymbol: unique symbol;
9
- export type DataTag<Type, Value> = Type & {
10
- [dataTagSymbol]: Value;
10
+ export type DataTag<TType, TValue> = TType & {
11
+ [dataTagSymbol]: TValue;
11
12
  };
12
13
  export type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput);
13
14
  export interface SetDataOptions {
@@ -50,7 +51,7 @@ export interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
50
51
  * Setting it to `Infinity` will disable garbage collection.
51
52
  */
52
53
  gcTime?: number;
53
- queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;
54
+ queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken;
54
55
  persister?: QueryPersister<NoInfer<TQueryFnData>, NoInfer<TQueryKey>, NoInfer<TPageParam>>;
55
56
  queryHash?: string;
56
57
  queryKey?: TQueryKey;
@@ -63,7 +64,7 @@ export interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
63
64
  * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
64
65
  * Defaults to `true`.
65
66
  */
66
- structuralSharing?: boolean | (<T>(oldData: T | undefined, newData: T) => T);
67
+ structuralSharing?: boolean | ((oldData: unknown | undefined, newData: unknown) => unknown);
67
68
  _defaulted?: boolean;
68
69
  /**
69
70
  * Additional payload to be stored on each query.
@@ -2,8 +2,10 @@ import { QueryOptions, QueryFilters, Updater } from './types';
2
2
  import { Query } from './query/Query';
3
3
  import { QueryKey } from '../keys/types';
4
4
 
5
- export declare function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: QueryOptions<any, any, any, TQueryKey>): string;
5
+ export declare function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Pick<QueryOptions<any, any, any, any>, "queryKeyHashFn">): string;
6
6
  export declare function matchQuery(filters: QueryFilters, query: Query<any, any, any, any>): boolean;
7
7
  export declare function timeUntilStale(updatedAt: number, staleTime?: number): number;
8
8
  export declare function functionalUpdate<TInput, TOutput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
9
9
  export declare function replaceData<TData, TOptions extends QueryOptions<any, any, any, any>>(prevData: TData | undefined, data: TData, options: TOptions): TData;
10
+ export declare const skipToken: unique symbol;
11
+ export type SkipToken = typeof skipToken;
@@ -75,7 +75,7 @@ export interface RefetchOptions extends ResultOptions {
75
75
  cancelRefetch?: boolean;
76
76
  }
77
77
  export interface InvalidateQueryFilters extends QueryFilters {
78
- refetchType?: QueryTypeFilter | 'none';
78
+ refetchType?: QueryTypeFilter | "none";
79
79
  }
80
80
  export interface InvalidateOptions extends RefetchOptions {
81
81
  }
@@ -1,4 +1,4 @@
1
1
  import { QueryClient } from '../../client/QueryClient';
2
2
  import { MutationFilters } from '../../client/mutations/types';
3
3
 
4
- export declare const useIsMutating: <TData>(filters?: MutationFilters<TData>, queryClient?: QueryClient) => number;
4
+ export declare const useIsMutating: <TData>(filters?: MutationFilters<TData, Error, any, unknown>, queryClient?: QueryClient) => number;
@@ -1,3 +1,3 @@
1
- import * as React from 'react';
1
+ import * as React from "react";
2
2
  export declare const useIsRestoring: () => boolean;
3
3
  export declare const IsRestoringProvider: React.Provider<boolean>;
@@ -3,17 +3,17 @@ import { DefaultError } from '../../client/types';
3
3
  import { DataTag } from '../../client/queries/types';
4
4
  import { QueryKey } from '../../client/keys/types';
5
5
 
6
- export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
6
+ export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
7
7
  initialData?: undefined;
8
8
  };
9
9
  type NonUndefinedGuard<T> = T extends undefined ? never : T;
10
10
  export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11
11
  initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
12
12
  };
13
- export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
13
+ export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
14
14
  queryKey: DataTag<TQueryKey, TQueryFnData>;
15
15
  };
16
- export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
16
+ export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
17
17
  queryKey: DataTag<TQueryKey, TQueryFnData>;
18
18
  };
19
19
  export {};
@@ -1,12 +1,12 @@
1
1
  import { DefaultError } from '../../client/types';
2
2
  import { QueryObserverResult, DefinedQueryObserverResult, QueryObserverOptions } from '../../client/queries/observer/types';
3
3
  import { QueryKey } from '../../client/keys/types';
4
- import { WithRequired } from '../../../utils/types';
4
+ import { OmitKeyof } from '../../../utils/types';
5
5
 
6
6
  export type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
7
- export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, "queryKey"> {
7
+ export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> {
8
8
  }
9
- export interface UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Omit<WithRequired<UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, "queryKey">, "suspense"> {
9
+ export interface UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends OmitKeyof<UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, "suspense"> {
10
10
  }
11
11
  export type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
12
12
  export type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
@@ -1,5 +1,5 @@
1
1
  import { Adapter } from '../types';
2
2
 
3
3
  export declare const createLocalStorageAdapter: ({ key }?: {
4
- key?: string;
4
+ key?: string | undefined;
5
5
  }) => Adapter;
@@ -2,17 +2,17 @@ import { Signal } from '../signal';
2
2
  import { Adapter } from './types';
3
3
 
4
4
  export declare const usePersistSignals: ({ entries, onReady, adapter }: {
5
- entries?: Array<{
5
+ entries?: {
6
6
  version: number;
7
7
  signal: Signal<any, any, string>;
8
- }>;
9
- onReady?: () => void;
8
+ }[] | undefined;
9
+ onReady?: (() => void) | undefined;
10
10
  /**
11
11
  * Requires a stable instance otherwise the hydration
12
12
  * process will start again. This is useful when you
13
13
  * need to change adapter during runtime.
14
14
  */
15
- adapter?: Adapter;
15
+ adapter?: Adapter | undefined;
16
16
  }) => {
17
17
  isHydrated: boolean;
18
18
  };
@@ -1,7 +1,8 @@
1
- export type WithRequired<T, K extends keyof T> = T & {
2
- [_ in K]: {};
1
+ export type WithRequired<TTarget, TKey extends keyof TTarget> = TTarget & {
2
+ [_ in TKey]: {};
3
3
  };
4
4
  export type NonFunctionGuard<T> = T extends Function ? never : T;
5
5
  export type NoInfer<T> = [T][T extends any ? 0 : never];
6
6
  export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
7
7
  export type Expect<T extends true> = T;
8
+ export type OmitKeyof<TObject, TKey extends TStrictly extends "safely" ? keyof TObject | (string & Record<never, never>) : keyof TObject, TStrictly extends "strictly" | "safely" = "strictly"> = Omit<TObject, TKey>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "reactjrx",
3
3
  "private": false,
4
- "version": "1.82.0",
4
+ "version": "1.86.0",
5
5
  "type": "module",
6
6
  "files": [
7
7
  "dist"
@@ -60,7 +60,7 @@
60
60
  "rollup-plugin-node-externals": "^7.0.1",
61
61
  "rxjs": "^7.8.0",
62
62
  "semantic-release": "^23.0.2",
63
- "typescript": "^5.0.4",
63
+ "typescript": "5.2.2",
64
64
  "vite": "^5.1.3",
65
65
  "vite-plugin-dts": "^3.6.3",
66
66
  "vitest": "^1.3.0"