reactjrx 4.0.6 → 4.0.8

package/dist/lib/queries/createObservableQueryFn.d.ts

@@ -14,4 +14,4 @@ export type ObservableQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey
  * fetch in progress (a refetch replacing it, the last observer unmounting,
  * `cancelQueries`, the query leaving the cache) stops the stream.
  */
-export declare function createObservableQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(queryFn: ObservableQueryFn<TQueryFnData, TQueryKey> | undefined): typeof skipToken | ((context: QueryFunctionContext<TQueryKey>) => Promise<TQueryFnData>) | undefined;
+export declare function createObservableQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(queryFn: ObservableQueryFn<TQueryFnData, TQueryKey>): typeof skipToken | ((context: QueryFunctionContext<TQueryKey>) => Promise<TQueryFnData>);

package/dist/lib/queries/mutationOptions.d.ts

@@ -1,25 +1,6 @@
-import { UseMutationOptions } from '@tanstack/react-query';
 import { Observable } from 'rxjs';
 /**
  * Resolves the public `mutationFn` option — an Observable or a function
  * returning one — to its source Observable for the given variables.
  */
 export declare function resolveMutationFnSource<TData, TVariables>(mutationFn: ((variables: TVariables) => Observable<TData>) | Observable<TData>, variables: TVariables): Observable<TData>;
-type MutationCallbacks<TData, TError, TVariables, TOnMutateResult> = Pick<UseMutationOptions<TData, TError, TVariables, TOnMutateResult>, "onMutate" | "onSuccess" | "onError" | "onSettled">;
-/**
- * Same callbacks, but keyed as required so that spreading the adapted
- * callbacks after `...options` overrides (rather than unions with) the
- * raw-variables callbacks still present in `options`.
- */
-type AdaptedMutationCallbacks<TData, TError, TVariables, TOnMutateResult> = {
-    [K in "onMutate" | "onSuccess" | "onError" | "onSettled"]: MutationCallbacks<TData, TError, {
-        variables: TVariables;
-    }, TOnMutateResult>[K] | undefined;
-};
-/**
- * `useSwitchMutation$` runs its inner mutation with the user variables
- * wrapped in an envelope (`{ variables, abort }`). This adapts the
- * user-facing callbacks, which expect the raw variables, to that envelope.
- */
-export declare function adaptCallbacksToWrappedVariables<TData, TError, TVariables, TOnMutateResult>({ onMutate, onSuccess, onError, onSettled, }: MutationCallbacks<TData, TError, TVariables, TOnMutateResult>): AdaptedMutationCallbacks<TData, TError, TVariables, TOnMutateResult>;
-export {};

package/dist/lib/queries/useSwitchMutation$.d.ts

@@ -3,13 +3,24 @@ import { UseMutation$Options } from './useMutation$';
 export declare class SwitchMutationCancelError extends Error {
     constructor(message?: string);
 }
+type SwitchVariables<TVariables> = {
+    variables: TVariables;
+    abort: AbortSignal;
+};
+/**
+ * Runs a mutation, and cancels the call still running when a new one starts.
+ * A cancelled call fails with `SwitchMutationCancelError` and is not retried.
+ * A call cancelled while TanStack waits to retry it settles once that wait
+ * ends.
+ *
+ * The callbacks, the client's defaults included, receive the variables given
+ * to `mutate`. A `MutationCache`, `result.variables` and `useMutationState`
+ * see the `{ variables, abort }` the hook runs the mutation with.
+ */
 export declare function useSwitchMutation$<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>({ mutationFn, ...options }: UseMutation$Options<TData | null, TError, TVariables, TOnMutateResult>, queryClient?: QueryClient): {
     mutate: (variables: TVariables) => void;
     mutateAsync: (variables: TVariables) => Promise<TData | null>;
-    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, {
-        variables: TVariables;
-        abort: AbortSignal;
-    }, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
+    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, SwitchVariables<TVariables>, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
     data: undefined;
     variables: undefined;
     error: null;
@@ -27,15 +38,9 @@ export declare function useSwitchMutation$<TData = unknown, TError = DefaultErro
 } | {
     mutate: (variables: TVariables) => void;
     mutateAsync: (variables: TVariables) => Promise<TData | null>;
-    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, {
-        variables: TVariables;
-        abort: AbortSignal;
-    }, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
+    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, SwitchVariables<TVariables>, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
     data: undefined;
-    variables: {
-        variables: TVariables;
-        abort: AbortSignal;
-    };
+    variables: SwitchVariables<TVariables>;
     error: null;
     isError: false;
     isIdle: false;
@@ -51,16 +56,10 @@ export declare function useSwitchMutation$<TData = unknown, TError = DefaultErro
 } | {
     mutate: (variables: TVariables) => void;
     mutateAsync: (variables: TVariables) => Promise<TData | null>;
-    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, {
-        variables: TVariables;
-        abort: AbortSignal;
-    }, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
+    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, SwitchVariables<TVariables>, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
     data: undefined;
     error: TError;
-    variables: {
-        variables: TVariables;
-        abort: AbortSignal;
-    };
+    variables: SwitchVariables<TVariables>;
     isError: true;
     isIdle: false;
     isPending: false;
@@ -75,16 +74,10 @@ export declare function useSwitchMutation$<TData = unknown, TError = DefaultErro
 } | {
     mutate: (variables: TVariables) => void;
     mutateAsync: (variables: TVariables) => Promise<TData | null>;
-    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, {
-        variables: TVariables;
-        abort: AbortSignal;
-    }, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
+    state$: import('rxjs').BehaviorSubject<Pick<import('@tanstack/react-query').UseMutationResult<TData | null, TError, SwitchVariables<TVariables>, TOnMutateResult>, "status" | "isPending" | "isError" | "isSuccess" | "isIdle">>;
     data: TData | null;
     error: null;
-    variables: {
-        variables: TVariables;
-        abort: AbortSignal;
-    };
+    variables: SwitchVariables<TVariables>;
     isError: false;
     isIdle: false;
     isPending: false;
@@ -97,3 +90,4 @@ export declare function useSwitchMutation$<TData = unknown, TError = DefaultErro
     isPaused: boolean;
     submittedAt: number;
 };
+export {};

package/dist/lib/utils/shouldRetry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Whether to retry after `attempt` retries (0 before the first one): a
+ * function decides, a number caps the retries, `true` never stops, and no
+ * value never retries. TanStack Query reads a mutation's `retry` the same
+ * way, in a check it does not export.
+ */
+export declare const shouldRetry: <TError>(retry: boolean | number | ((attempt: number, error: TError) => boolean) | undefined, attempt: number, error: TError) => boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "reactjrx",
   "private": false,
-  "version": "4.0.6",
+  "version": "4.0.8",
   "type": "module",
   "files": [
     "dist"