Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | import type { UseTRPCMutationOptions } from "@trpc/react-query/shared";
import type { TFunction } from "i18next";
import type {
TRPCError,
TRPCMutationInput,
TRPCMutationKey,
TRPCMutationOutput,
} from "~app/trpc";
import type { ArrayOf, MaybeAddElementToArray } from "~utils/types";
import type { ControllerContext } from "./types";
export type TRPCMutationOptions<
Path extends TRPCMutationKey,
LifecycleContext = unknown,
> = UseTRPCMutationOptions<
TRPCMutationInput<Path>,
TRPCError,
TRPCMutationOutput<Path>,
LifecycleContext
>;
/*
Context passed around in query hooks is complicated.
There is `outerContext` which represents data from the component that uses the hook.
E.g.: while updating a debt, we need to know what the previous debt was.
There is `lifecycleContext` which represents data passed as the result of mutation to success / error fns.
E.g.: while adding a debt, we created a random id for it, on success we need to find that debt and replace the id to a proper one.
There is `controllerContext` which is the object with `queryClient` and `trpcUtils` included.
E.g.: while updating a peer, we need `trpcUtils` to optimistically update that peer's data in the query cache.
There is `internalContext` which is the actual lifecycle context object that is passed around.
It includes `controllerContext`, `outerContext`, `lifecycleContext`
as well as possible update functions (the ones we need to run in success / error hooks to revert or finalize the data)
as well as toast data (the id of the toast we need to update).
There is `toastContext` which is the object passed to a batched toast options
E.g.: calculating translations in toasts
*/
type ControllerContextWith<OuterContext = undefined> = MaybeAddElementToArray<
[ControllerContext],
OuterContext
>;
export type LifecycleContextWithUpdateFns<LifecycleContext = unknown> = {
revertFn?: () => void;
finalizeFn?: () => void;
context?: LifecycleContext;
};
export type ToastContext = {
t: TFunction;
};
export type ToastObject = { id: string; count: number };
export type InternalContext<
OuterContext = undefined,
LifecycleContext = unknown,
> = LifecycleContextWithUpdateFns<LifecycleContext> & {
toastObject?: ToastObject;
controllerContext: ControllerContext;
outerContext: OuterContext;
};
type ToastArgs<OuterContext> = MaybeAddElementToArray<[], OuterContext>;
export type ToastOptions = {
text: string;
};
export type UseContextedMutationOptions<
Path extends TRPCMutationKey,
OuterContext = undefined,
LifecycleContext = unknown,
Options extends TRPCMutationOptions<Path, LifecycleContext> =
TRPCMutationOptions<Path, LifecycleContext>,
MutationOptionsWithUpdateFns extends TRPCMutationOptions<
Path,
LifecycleContextWithUpdateFns<LifecycleContext>
> = TRPCMutationOptions<
Path,
LifecycleContextWithUpdateFns<LifecycleContext>
>,
> = {
mutateToastOptions?: (
context: ToastContext,
...contextArgs: ArrayOf<ToastArgs<OuterContext>>
) => (
...args: ArrayOf<
Parameters<NonNullable<MutationOptionsWithUpdateFns["onMutate"]>>
>
) => ToastOptions;
onMutate?: (
...args: ControllerContextWith<OuterContext>
) => NonNullable<MutationOptionsWithUpdateFns["onMutate"]>;
errorToastOptions: (
context: ToastContext,
...contextArgs: ArrayOf<ToastArgs<OuterContext>>
) => (
...args: ArrayOf<Parameters<NonNullable<Options["onError"]>>>
) => ToastOptions;
onError?: (
...args: ControllerContextWith<OuterContext>
) => NonNullable<Options["onError"]>;
successToastOptions?: (
context: ToastContext,
...contextArgs: ArrayOf<ToastArgs<OuterContext>>
) => (
...args: ArrayOf<Parameters<NonNullable<Options["onSuccess"]>>>
) => ToastOptions;
onSuccess?: (
...args: ControllerContextWith<OuterContext>
) => NonNullable<Options["onSuccess"]>;
onSettled?: (
...args: ControllerContextWith<OuterContext>
) => NonNullable<Options["onSettled"]>;
mutationKey: Path;
};
|