@trpc/tanstack-react-query 11.25.3-canary.13.g1341462e1 → 11.25.3-canary.16.g524856b27
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/dist/unstable-handles/index.cjs +8 -3
- package/dist/unstable-handles/index.d.cts +22 -12
- package/dist/unstable-handles/index.d.cts.map +1 -1
- package/dist/unstable-handles/index.d.mts +22 -12
- package/dist/unstable-handles/index.d.mts.map +1 -1
- package/dist/unstable-handles/index.mjs +9 -4
- package/dist/unstable-handles/index.mjs.map +1 -1
- package/package.json +5 -5
- package/skills/react-query-classic-migration/SKILL.md +1 -1
- package/skills/react-query-setup/SKILL.md +1 -1
- package/src/unstable-handles/handles.ts +37 -16
- package/src/unstable-handles/index.ts +1 -0
|
@@ -71,7 +71,7 @@ function createEntry(state) {
|
|
|
71
71
|
}
|
|
72
72
|
function readEntry(key, entry) {
|
|
73
73
|
const state = entry === null || entry === void 0 ? void 0 : entry[entryState];
|
|
74
|
-
if (!state) throw new Error(`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\` for "${key}", got ${JSON.stringify(entry)}`);
|
|
74
|
+
if (!state) throw new Error(`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\`, or \`skipToken\`, for "${key}", got ${JSON.stringify(entry)}`);
|
|
75
75
|
return state;
|
|
76
76
|
}
|
|
77
77
|
function startEntry(queryClient, state) {
|
|
@@ -108,10 +108,11 @@ function settleLoad(promise) {
|
|
|
108
108
|
}
|
|
109
109
|
async function startEntries(opts) {
|
|
110
110
|
const { queryClient, entries } = opts;
|
|
111
|
-
const loads = Object.entries(entries).
|
|
111
|
+
const loads = Object.entries(entries).flatMap(([key, entry]) => {
|
|
112
|
+
if (entry === _tanstack_react_query.skipToken) return [];
|
|
112
113
|
const state = readEntry(key, entry);
|
|
113
114
|
if (state.queryClient !== queryClient) throw new Error(`The entry for "${key}" was built with a proxy for another QueryClient than the root proxy that loads it`);
|
|
114
|
-
return [key, state];
|
|
115
|
+
return [[key, state]];
|
|
115
116
|
}).map(([key, state]) => ({
|
|
116
117
|
key,
|
|
117
118
|
state,
|
|
@@ -211,6 +212,9 @@ function isTRPCEntryError(error, procedure) {
|
|
|
211
212
|
* a handle for every entry, and the data of the fetch and ensure entries. Rejects as
|
|
212
213
|
* soon as a fetch or ensure entry fails. Prefetch entries never make it reject.
|
|
213
214
|
*
|
|
215
|
+
* Put TanStack Query's `skipToken` in place of an entry to start nothing for that
|
|
216
|
+
* key: its handle is `undefined`, and `data` has no key for it.
|
|
217
|
+
*
|
|
214
218
|
* Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.
|
|
215
219
|
* Call it in a route loader, a server component or an event handler, not during
|
|
216
220
|
* render: every render would start the entries again.
|
|
@@ -219,6 +223,7 @@ function isTRPCEntryError(error, procedure) {
|
|
|
219
223
|
* const [handles, data] = await loadHandles(trpc, {
|
|
220
224
|
* comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),
|
|
221
225
|
* post: ensureEntry(trpc.post.byId, { id }),
|
|
226
|
+
* draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,
|
|
222
227
|
* });
|
|
223
228
|
* if (!data.post.published) throw notFound();
|
|
224
229
|
* return handles;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { A as FeatureFlags, F as TRPCInfiniteData, P as ResolverDef, T as UnusedSkipTokenTRPCInfiniteQueryOptionsOut, a as DecorateRouterKeyable, b as UnusedSkipTokenTRPCQueryOptionsIn, i as DecorateQueryProcedure, k as ExtractCursorType, t as DecorateInfiniteQueryProcedure, w as UnusedSkipTokenTRPCInfiniteQueryOptionsIn, x as UnusedSkipTokenTRPCQueryOptionsOut, z as TRPCQueryBaseOptions } from "../createOptionsProxy-CSjaFTcE.cjs";
|
|
2
|
-
import { FetchQueryOptions, GetNextPageParamFunction } from "@tanstack/react-query";
|
|
2
|
+
import { FetchQueryOptions, GetNextPageParamFunction, skipToken } from "@tanstack/react-query";
|
|
3
3
|
import { TRPCClientErrorLike } from "@trpc/client";
|
|
4
4
|
import { TRPCError, TRPC_ERROR_CODE_KEY } from "@trpc/server";
|
|
5
5
|
type ErrorOf<TDef extends ResolverDef> = TRPCClientErrorLike<{
|
|
@@ -111,9 +111,15 @@ interface TRPCInfiniteQueryEntry<TDef extends ResolverDef = ResolverDef, TKind e
|
|
|
111
111
|
}
|
|
112
112
|
/** Any query or infinite query entry. */
|
|
113
113
|
type AnyTRPCEntry = TRPCQueryEntry<any, any> | TRPCInfiniteQueryEntry<any, any>;
|
|
114
|
-
|
|
114
|
+
/**
|
|
115
|
+
* What `loadHandles()` takes per key: an entry, or TanStack Query's
|
|
116
|
+
* `skipToken` to start nothing for that key.
|
|
117
|
+
* @see https://trpc.io/docs/client/tanstack-react-query/handles#conditional-queries
|
|
118
|
+
*/
|
|
119
|
+
type TRPCLoadEntries = Record<string, AnyTRPCEntry | typeof skipToken>;
|
|
120
|
+
type HandleOfEntry<TEntry> = TEntry extends TRPCQueryEntry<infer TDef, any> ? TRPCQueryHandle<TDef> : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any> ? TRPCInfiniteQueryHandle<TDef> : TEntry extends typeof skipToken ? undefined : never;
|
|
115
121
|
type DataOfEntry<TEntry> = TEntry extends TRPCQueryEntry<infer TDef, any> ? TDef['output'] : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any> ? TRPCInfiniteData<TDef['input'], TDef['output']> : never;
|
|
116
|
-
type HandlesOf<TEntries extends
|
|
122
|
+
type HandlesOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries]: HandleOfEntry<TEntries[TKey]>; };
|
|
117
123
|
type DefOfEntry<TEntry> = TEntry extends {
|
|
118
124
|
readonly [entryDef]: {
|
|
119
125
|
def: infer TDef extends ResolverDef;
|
|
@@ -125,8 +131,8 @@ type WaitedKey<TEntries, TKey extends keyof TEntries> = TEntries[TKey] extends {
|
|
|
125
131
|
kind: 'fetch' | 'ensure';
|
|
126
132
|
};
|
|
127
133
|
} ? TKey : never;
|
|
128
|
-
type DataOf<TEntries extends
|
|
129
|
-
type ResultsOf<TEntries extends
|
|
134
|
+
type DataOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: DataOfEntry<TEntries[TKey]>; };
|
|
135
|
+
type ResultsOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: TRPCEntryResult<DefOfEntry<TEntries[TKey]>, DataOfEntry<TEntries[TKey]>>; };
|
|
130
136
|
/**
|
|
131
137
|
* What `loadHandlesSettled()` has for a fetch or ensure entry: its data, or
|
|
132
138
|
* the error it failed with.
|
|
@@ -141,17 +147,17 @@ type TRPCEntryResult<TDef extends ResolverDef, TData> = {
|
|
|
141
147
|
};
|
|
142
148
|
/**
|
|
143
149
|
* What `loadHandles()` resolves to: `[handles, data]`. `handles` has a handle
|
|
144
|
-
* for every entry, by the entry's key
|
|
145
|
-
* every fetch and ensure entry, by the entry's key.
|
|
150
|
+
* for every entry, by the entry's key, and `undefined` for a `skipToken`; return them
|
|
151
|
+
* from the loader. `data` has the data of every fetch and ensure entry, by the entry's key.
|
|
146
152
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#loader-data
|
|
147
153
|
*/
|
|
148
|
-
type TRPCLoadedHandles<TEntries extends
|
|
154
|
+
type TRPCLoadedHandles<TEntries extends TRPCLoadEntries> = readonly [handles: HandlesOf<TEntries>, data: DataOf<TEntries>];
|
|
149
155
|
/**
|
|
150
156
|
* What `loadHandlesSettled()` resolves to: `[handles, results]`. `results`
|
|
151
157
|
* has a `TRPCEntryResult` for every fetch and ensure entry, by the entry's key.
|
|
152
158
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values
|
|
153
159
|
*/
|
|
154
|
-
type TRPCSettledHandles<TEntries extends
|
|
160
|
+
type TRPCSettledHandles<TEntries extends TRPCLoadEntries> = readonly [handles: HandlesOf<TEntries>, results: ResultsOf<TEntries>];
|
|
155
161
|
/** Options for an entry */
|
|
156
162
|
interface TRPCEntryOptions extends Pick<FetchQueryOptions, 'staleTime' | 'retry' | 'retryDelay' | 'gcTime' | 'meta'>, TRPCQueryBaseOptions {}
|
|
157
163
|
type HandleGetNextPageParam<TDef extends ResolverDef> = GetNextPageParamFunction<NonNullable<ExtractCursorType<TDef['input']>> | null, TDef['output']>;
|
|
@@ -213,6 +219,9 @@ export declare function isTRPCEntryError(error: unknown): error is TRPCEntryErro
|
|
|
213
219
|
* a handle for every entry, and the data of the fetch and ensure entries. Rejects as
|
|
214
220
|
* soon as a fetch or ensure entry fails. Prefetch entries never make it reject.
|
|
215
221
|
*
|
|
222
|
+
* Put TanStack Query's `skipToken` in place of an entry to start nothing for that
|
|
223
|
+
* key: its handle is `undefined`, and `data` has no key for it.
|
|
224
|
+
*
|
|
216
225
|
* Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.
|
|
217
226
|
* Call it in a route loader, a server component or an event handler, not during
|
|
218
227
|
* render: every render would start the entries again.
|
|
@@ -221,13 +230,14 @@ export declare function isTRPCEntryError(error: unknown): error is TRPCEntryErro
|
|
|
221
230
|
* const [handles, data] = await loadHandles(trpc, {
|
|
222
231
|
* comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),
|
|
223
232
|
* post: ensureEntry(trpc.post.byId, { id }),
|
|
233
|
+
* draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,
|
|
224
234
|
* });
|
|
225
235
|
* if (!data.post.published) throw notFound();
|
|
226
236
|
* return handles;
|
|
227
237
|
* ```
|
|
228
238
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles
|
|
229
239
|
*/
|
|
230
|
-
export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries extends
|
|
240
|
+
export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries extends TRPCLoadEntries>(trpc: DecorateRouterKeyable<TFeatureFlags>, entries: TEntries): Promise<TRPCLoadedHandles<TEntries>>;
|
|
231
241
|
/**
|
|
232
242
|
* Like `loadHandles()`, but it waits for every fetch and ensure entry to
|
|
233
243
|
* settle and never rejects because one failed. Resolves to `[handles, results]`:
|
|
@@ -248,7 +258,7 @@ export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries
|
|
|
248
258
|
* ```
|
|
249
259
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values
|
|
250
260
|
*/
|
|
251
|
-
export declare function loadHandlesSettled<TFeatureFlags extends FeatureFlags, TEntries extends
|
|
261
|
+
export declare function loadHandlesSettled<TFeatureFlags extends FeatureFlags, TEntries extends TRPCLoadEntries>(trpc: DecorateRouterKeyable<TFeatureFlags>, entries: TEntries): Promise<TRPCSettledHandles<TEntries>>;
|
|
252
262
|
/**
|
|
253
263
|
* An entry for `loadHandles()` that starts the query without waiting, like
|
|
254
264
|
* `queryClient.prefetchQuery`. It never makes the load reject: errors surface where
|
|
@@ -295,5 +305,5 @@ export declare function ensureInfiniteEntry<TDef extends ResolverDef>(procedure:
|
|
|
295
305
|
*/
|
|
296
306
|
export declare function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>, handle: TRPCQueryHandle<TDef>, opts?: UnusedSkipTokenTRPCQueryOptionsIn<NoInfer<TDef['output']>, TData, ErrorOf<TDef>, TDef['featureFlags']>): UnusedSkipTokenTRPCQueryOptionsOut<TDef['output'], TData, ErrorOf<TDef>, TDef['featureFlags']>;
|
|
297
307
|
export declare function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>, handle: TRPCInfiniteQueryHandle<TDef>, opts: UnusedSkipTokenTRPCInfiniteQueryOptionsIn<TDef['input'], NoInfer<TDef['output']>, TData, ErrorOf<TDef>, TDef['featureFlags']>): UnusedSkipTokenTRPCInfiniteQueryOptionsOut<TDef['input'], TDef['output'], TData, ErrorOf<TDef>, TDef['featureFlags']>;
|
|
298
|
-
export type { AnyTRPCEntry, AnyTRPCHandle, TRPCEntryKind, TRPCEntryOptions, TRPCEntryResult, TRPCInfiniteEntryOptions, TRPCInfiniteQueryEntry, TRPCInfiniteQueryHandle, TRPCLoadedHandles, TRPCQueryEntry, TRPCQueryHandle, TRPCSettledHandles, inferInfiniteQueryHandle, inferQueryHandle };
|
|
308
|
+
export type { AnyTRPCEntry, AnyTRPCHandle, TRPCEntryKind, TRPCEntryOptions, TRPCEntryResult, TRPCInfiniteEntryOptions, TRPCInfiniteQueryEntry, TRPCInfiniteQueryHandle, TRPCLoadEntries, TRPCLoadedHandles, TRPCQueryEntry, TRPCQueryHandle, TRPCSettledHandles, inferInfiniteQueryHandle, inferQueryHandle };
|
|
299
309
|
//# sourceMappingURL=index.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"mappings":";;;;KAMY,QAAQ,aAAa,eAAe;EAC9C,aAAa;EACb,YAAY;;;;;;;qBAQD,eACX,aAAa,cAAc,qBACnB;;WAEC;;WAEA;;WAEA,MAAM;;;;;WAOU,OAAO,QAAQ,QAAQ;EAEhD,YAAY;IACV;IACA;IACA,MAAM;IACN,OAAO,QAAQ,QAAQ;;;cCJb;cACA;KAET,oBAAoB,UAAU,wBAC/B,KAAK,kCACL;;;;;KAMC,eACH,aAAa,aACb,QACA,sCACE,kDACC,kBAAkB,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;MAClE,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;;;;;;UAMpC,gBAAgB,aAAa,cAAc;;;;;YAKhD,YAAY;IAAS;;WACtB,UAAU,eAAe,MAAM;;WAE/B,OAAO;;;;;;UAOD,wBACf,aAAa,cAAc;;;;;YAMjB,YAAY;IAAS;;WACtB,UAAU,eACjB,MACA,oBAAoB;;WAIb,OAAO,oBAAoB;WAC3B,gBAAgB,YAAY,kBAAkB;;;KAI7C,gBAAgB,uBAAuB;;;;;KAMvC;;;;;;UAOK,eACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;;;;UAOhC,uBACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;KAIrC,eACR,2BACA;
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"mappings":";;;;KAMY,QAAQ,aAAa,eAAe;EAC9C,aAAa;EACb,YAAY;;;;;;;qBAQD,eACX,aAAa,cAAc,qBACnB;;WAEC;;WAEA;;WAEA,MAAM;;;;;WAOU,OAAO,QAAQ,QAAQ;EAEhD,YAAY;IACV;IACA;IACA,MAAM;IACN,OAAO,QAAQ,QAAQ;;;cCJb;cACA;KAET,oBAAoB,UAAU,wBAC/B,KAAK,kCACL;;;;;KAMC,eACH,aAAa,aACb,QACA,sCACE,kDACC,kBAAkB,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;MAClE,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;;;;;;UAMpC,gBAAgB,aAAa,cAAc;;;;;YAKhD,YAAY;IAAS;;WACtB,UAAU,eAAe,MAAM;;WAE/B,OAAO;;;;;;UAOD,wBACf,aAAa,cAAc;;;;;YAMjB,YAAY;IAAS;;WACtB,UAAU,eACjB,MACA,oBAAoB;;WAIb,OAAO,oBAAoB;WAC3B,gBAAgB,YAAY,kBAAkB;;;KAI7C,gBAAgB,uBAAuB;;;;;KAMvC;;;;;;UAOK,eACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;;;;UAOhC,uBACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;KAIrC,eACR,2BACA;;;;;;KAOQ,kBAAkB,eAAe,sBAAsB;KAE9D,cAAc,UACjB,eAAe,qBAAqB,aAChC,gBAAgB,QAChB,eAAe,6BAA6B,aAC1C,wBAAwB,QACxB,sBAAsB;KAIzB,YAAY,UACf,eAAe,qBAAqB,aAChC,iBACA,eAAe,6BAA6B,aAC1C,iBAAiB,eAAe;KAGnC,UAAU,iBAAiB,sBAC7B,cAAc,WAAW,cAAc,SAAS;KAG9C,WAAW,UAAU;YACd;IAAa,WAAW,aAAa;;IAE7C;;KAIC,UAAU,UAAU,mBAAmB,YAAY,SAAS;YACrD;IAAa;;IAErB;KAGC,OAAO,iBAAiB,sBAC1B,cAAc,YAAY,UAAU,UAAU,QAAQ,YACrD,SAAS;KAIR,UAAU,iBAAiB,sBAC7B,cAAc,YAAY,UAAU,UAAU,QAAQ,gBACrD,WAAW,SAAS,QACpB,YAAY,SAAS;;;;;;KASb,gBAAgB,aAAa,aAAa;WACvC;WAA4B,MAAM;;WAClC;WAA0B,OAAO,eAAe;;;;;;;;KAQnD,kBAAkB,iBAAiB,6BAC7C,SAAS,UAAU,WACnB,MAAM,OAAO;;;;;;KAQH,mBAAmB,iBAAiB,6BAC9C,SAAS,UAAU,WACnB,SAAS,UAAU;;UAIJ,yBAEb,KACE,8EAGF;KAEC,uBAAuB,aAAa,eACvC,yBACE,YAAY,kBAAkB,wBAC9B;;;;;;KAQQ,yBAAyB,aAAa,eAChD;EACE,gBAAgB,YAAY,kBAAkB;;EAGxC;;;;;EAKA,mBAAmB,uBAAuB;;;EAI1C;EACA,kBAAkB,uBAAuB;;KAI9C,UAAU,aAAa,iCAAiC,iBACxD,QAAQ,eAAe,OAAO,qBAC9B,OAAO,eAAe,OAAO;;;;;;;;;KAUtB,iBAAiB,mBAAmB,+BAC9C,mBAAmB,6BAA6B,QAC5C,gBAAgB;;;;;KAOV,yBACV,mBAAmB,uCAEnB,mBAAmB,qCAAqC,QACpD,wBAAwB;;;;;;;;;;;;;;;;;wBAoWd,iBAAiB,aAAa,aAC5C,gBACA,WAAW,uBAAuB,QACjC,SAAS,eAAe;wBACX,iBAAiB,iBAAiB,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;wBAmC3C,YACd,sBAAsB,cACtB,iBAAiB,iBAEjB,MAAM,sBAAsB,gBAC5B,SAAS,WACR,QAAQ,kBAAkB;;;;;;;;;;;;;;;;;;;;;wBA4Bb,mBACd,sBAAsB,cACtB,iBAAiB,iBAEjB,MAAM,sBAAsB,gBAC5B,SAAS,WACR,QAAQ,mBAAmB;;;;;;;wBAcd,cAAc,aAAa,aACzC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;;;wBAsBF,WAAW,aAAa,aACtC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;;;;wBAuBF,YAAY,aAAa,aACvC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;wBAoBF,sBAAsB,aAAa,aACjD,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;wBAeV,mBAAmB,aAAa,aAC9C,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;wBAeV,oBAAoB,aAAa,aAC/C,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;;;;wBAkBV,WAAW,aAAa,aAAa,QAAQ,gBAC3D,MAAM,sBAAsB,QAAQ,wBACpC,QAAQ,gBAAgB,OACxB,OAAO,kCACL,QAAQ,iBACR,OACA,QAAQ,OACR,wBAED,mCACD,gBACA,OACA,QAAQ,OACR;wBAEc,WAAW,aAAa,aAAa,QAAQ,gBAC3D,MAAM,sBAAsB,QAAQ,wBACpC,QAAQ,wBAAwB,OAChC,MAAM,0CACJ,eACA,QAAQ,iBACR,OACA,QAAQ,OACR,wBAED,2CACD,eACA,gBACA,OACA,QAAQ,OACR"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { A as FeatureFlags, F as TRPCInfiniteData, P as ResolverDef, T as UnusedSkipTokenTRPCInfiniteQueryOptionsOut, a as DecorateRouterKeyable, b as UnusedSkipTokenTRPCQueryOptionsIn, i as DecorateQueryProcedure, k as ExtractCursorType, t as DecorateInfiniteQueryProcedure, w as UnusedSkipTokenTRPCInfiniteQueryOptionsIn, x as UnusedSkipTokenTRPCQueryOptionsOut, z as TRPCQueryBaseOptions } from "../createOptionsProxy-DrOxGLOk.mjs";
|
|
2
2
|
import { TRPCClientErrorLike } from "@trpc/client";
|
|
3
3
|
import { TRPCError, TRPC_ERROR_CODE_KEY } from "@trpc/server";
|
|
4
|
-
import { FetchQueryOptions, GetNextPageParamFunction } from "@tanstack/react-query";
|
|
4
|
+
import { FetchQueryOptions, GetNextPageParamFunction, skipToken } from "@tanstack/react-query";
|
|
5
5
|
type ErrorOf<TDef extends ResolverDef> = TRPCClientErrorLike<{
|
|
6
6
|
transformer: TDef['transformer'];
|
|
7
7
|
errorShape: TDef['errorShape'];
|
|
@@ -111,9 +111,15 @@ interface TRPCInfiniteQueryEntry<TDef extends ResolverDef = ResolverDef, TKind e
|
|
|
111
111
|
}
|
|
112
112
|
/** Any query or infinite query entry. */
|
|
113
113
|
type AnyTRPCEntry = TRPCQueryEntry<any, any> | TRPCInfiniteQueryEntry<any, any>;
|
|
114
|
-
|
|
114
|
+
/**
|
|
115
|
+
* What `loadHandles()` takes per key: an entry, or TanStack Query's
|
|
116
|
+
* `skipToken` to start nothing for that key.
|
|
117
|
+
* @see https://trpc.io/docs/client/tanstack-react-query/handles#conditional-queries
|
|
118
|
+
*/
|
|
119
|
+
type TRPCLoadEntries = Record<string, AnyTRPCEntry | typeof skipToken>;
|
|
120
|
+
type HandleOfEntry<TEntry> = TEntry extends TRPCQueryEntry<infer TDef, any> ? TRPCQueryHandle<TDef> : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any> ? TRPCInfiniteQueryHandle<TDef> : TEntry extends typeof skipToken ? undefined : never;
|
|
115
121
|
type DataOfEntry<TEntry> = TEntry extends TRPCQueryEntry<infer TDef, any> ? TDef['output'] : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any> ? TRPCInfiniteData<TDef['input'], TDef['output']> : never;
|
|
116
|
-
type HandlesOf<TEntries extends
|
|
122
|
+
type HandlesOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries]: HandleOfEntry<TEntries[TKey]>; };
|
|
117
123
|
type DefOfEntry<TEntry> = TEntry extends {
|
|
118
124
|
readonly [entryDef]: {
|
|
119
125
|
def: infer TDef extends ResolverDef;
|
|
@@ -125,8 +131,8 @@ type WaitedKey<TEntries, TKey extends keyof TEntries> = TEntries[TKey] extends {
|
|
|
125
131
|
kind: 'fetch' | 'ensure';
|
|
126
132
|
};
|
|
127
133
|
} ? TKey : never;
|
|
128
|
-
type DataOf<TEntries extends
|
|
129
|
-
type ResultsOf<TEntries extends
|
|
134
|
+
type DataOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: DataOfEntry<TEntries[TKey]>; };
|
|
135
|
+
type ResultsOf<TEntries extends TRPCLoadEntries> = { [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: TRPCEntryResult<DefOfEntry<TEntries[TKey]>, DataOfEntry<TEntries[TKey]>>; };
|
|
130
136
|
/**
|
|
131
137
|
* What `loadHandlesSettled()` has for a fetch or ensure entry: its data, or
|
|
132
138
|
* the error it failed with.
|
|
@@ -141,17 +147,17 @@ type TRPCEntryResult<TDef extends ResolverDef, TData> = {
|
|
|
141
147
|
};
|
|
142
148
|
/**
|
|
143
149
|
* What `loadHandles()` resolves to: `[handles, data]`. `handles` has a handle
|
|
144
|
-
* for every entry, by the entry's key
|
|
145
|
-
* every fetch and ensure entry, by the entry's key.
|
|
150
|
+
* for every entry, by the entry's key, and `undefined` for a `skipToken`; return them
|
|
151
|
+
* from the loader. `data` has the data of every fetch and ensure entry, by the entry's key.
|
|
146
152
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#loader-data
|
|
147
153
|
*/
|
|
148
|
-
type TRPCLoadedHandles<TEntries extends
|
|
154
|
+
type TRPCLoadedHandles<TEntries extends TRPCLoadEntries> = readonly [handles: HandlesOf<TEntries>, data: DataOf<TEntries>];
|
|
149
155
|
/**
|
|
150
156
|
* What `loadHandlesSettled()` resolves to: `[handles, results]`. `results`
|
|
151
157
|
* has a `TRPCEntryResult` for every fetch and ensure entry, by the entry's key.
|
|
152
158
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values
|
|
153
159
|
*/
|
|
154
|
-
type TRPCSettledHandles<TEntries extends
|
|
160
|
+
type TRPCSettledHandles<TEntries extends TRPCLoadEntries> = readonly [handles: HandlesOf<TEntries>, results: ResultsOf<TEntries>];
|
|
155
161
|
/** Options for an entry */
|
|
156
162
|
interface TRPCEntryOptions extends Pick<FetchQueryOptions, 'staleTime' | 'retry' | 'retryDelay' | 'gcTime' | 'meta'>, TRPCQueryBaseOptions {}
|
|
157
163
|
type HandleGetNextPageParam<TDef extends ResolverDef> = GetNextPageParamFunction<NonNullable<ExtractCursorType<TDef['input']>> | null, TDef['output']>;
|
|
@@ -213,6 +219,9 @@ export declare function isTRPCEntryError(error: unknown): error is TRPCEntryErro
|
|
|
213
219
|
* a handle for every entry, and the data of the fetch and ensure entries. Rejects as
|
|
214
220
|
* soon as a fetch or ensure entry fails. Prefetch entries never make it reject.
|
|
215
221
|
*
|
|
222
|
+
* Put TanStack Query's `skipToken` in place of an entry to start nothing for that
|
|
223
|
+
* key: its handle is `undefined`, and `data` has no key for it.
|
|
224
|
+
*
|
|
216
225
|
* Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.
|
|
217
226
|
* Call it in a route loader, a server component or an event handler, not during
|
|
218
227
|
* render: every render would start the entries again.
|
|
@@ -221,13 +230,14 @@ export declare function isTRPCEntryError(error: unknown): error is TRPCEntryErro
|
|
|
221
230
|
* const [handles, data] = await loadHandles(trpc, {
|
|
222
231
|
* comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),
|
|
223
232
|
* post: ensureEntry(trpc.post.byId, { id }),
|
|
233
|
+
* draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,
|
|
224
234
|
* });
|
|
225
235
|
* if (!data.post.published) throw notFound();
|
|
226
236
|
* return handles;
|
|
227
237
|
* ```
|
|
228
238
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles
|
|
229
239
|
*/
|
|
230
|
-
export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries extends
|
|
240
|
+
export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries extends TRPCLoadEntries>(trpc: DecorateRouterKeyable<TFeatureFlags>, entries: TEntries): Promise<TRPCLoadedHandles<TEntries>>;
|
|
231
241
|
/**
|
|
232
242
|
* Like `loadHandles()`, but it waits for every fetch and ensure entry to
|
|
233
243
|
* settle and never rejects because one failed. Resolves to `[handles, results]`:
|
|
@@ -248,7 +258,7 @@ export declare function loadHandles<TFeatureFlags extends FeatureFlags, TEntries
|
|
|
248
258
|
* ```
|
|
249
259
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values
|
|
250
260
|
*/
|
|
251
|
-
export declare function loadHandlesSettled<TFeatureFlags extends FeatureFlags, TEntries extends
|
|
261
|
+
export declare function loadHandlesSettled<TFeatureFlags extends FeatureFlags, TEntries extends TRPCLoadEntries>(trpc: DecorateRouterKeyable<TFeatureFlags>, entries: TEntries): Promise<TRPCSettledHandles<TEntries>>;
|
|
252
262
|
/**
|
|
253
263
|
* An entry for `loadHandles()` that starts the query without waiting, like
|
|
254
264
|
* `queryClient.prefetchQuery`. It never makes the load reject: errors surface where
|
|
@@ -295,5 +305,5 @@ export declare function ensureInfiniteEntry<TDef extends ResolverDef>(procedure:
|
|
|
295
305
|
*/
|
|
296
306
|
export declare function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>, handle: TRPCQueryHandle<TDef>, opts?: UnusedSkipTokenTRPCQueryOptionsIn<NoInfer<TDef['output']>, TData, ErrorOf<TDef>, TDef['featureFlags']>): UnusedSkipTokenTRPCQueryOptionsOut<TDef['output'], TData, ErrorOf<TDef>, TDef['featureFlags']>;
|
|
297
307
|
export declare function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>, handle: TRPCInfiniteQueryHandle<TDef>, opts: UnusedSkipTokenTRPCInfiniteQueryOptionsIn<TDef['input'], NoInfer<TDef['output']>, TData, ErrorOf<TDef>, TDef['featureFlags']>): UnusedSkipTokenTRPCInfiniteQueryOptionsOut<TDef['input'], TDef['output'], TData, ErrorOf<TDef>, TDef['featureFlags']>;
|
|
298
|
-
export type { AnyTRPCEntry, AnyTRPCHandle, TRPCEntryKind, TRPCEntryOptions, TRPCEntryResult, TRPCInfiniteEntryOptions, TRPCInfiniteQueryEntry, TRPCInfiniteQueryHandle, TRPCLoadedHandles, TRPCQueryEntry, TRPCQueryHandle, TRPCSettledHandles, inferInfiniteQueryHandle, inferQueryHandle };
|
|
308
|
+
export type { AnyTRPCEntry, AnyTRPCHandle, TRPCEntryKind, TRPCEntryOptions, TRPCEntryResult, TRPCInfiniteEntryOptions, TRPCInfiniteQueryEntry, TRPCInfiniteQueryHandle, TRPCLoadEntries, TRPCLoadedHandles, TRPCQueryEntry, TRPCQueryHandle, TRPCSettledHandles, inferInfiniteQueryHandle, inferQueryHandle };
|
|
299
309
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"mappings":";;;;KAMY,QAAQ,aAAa,eAAe;EAC9C,aAAa;EACb,YAAY;;;;;;;qBAQD,eACX,aAAa,cAAc,qBACnB;;WAEC;;WAEA;;WAEA,MAAM;;;;;WAOU,OAAO,QAAQ,QAAQ;EAEhD,YAAY;IACV;IACA;IACA,MAAM;IACN,OAAO,QAAQ,QAAQ;;;cCJb;cACA;KAET,oBAAoB,UAAU,wBAC/B,KAAK,kCACL;;;;;KAMC,eACH,aAAa,aACb,QACA,sCACE,kDACC,kBAAkB,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;MAClE,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;;;;;;UAMpC,gBAAgB,aAAa,cAAc;;;;;YAKhD,YAAY;IAAS;;WACtB,UAAU,eAAe,MAAM;;WAE/B,OAAO;;;;;;UAOD,wBACf,aAAa,cAAc;;;;;YAMjB,YAAY;IAAS;;WACtB,UAAU,eACjB,MACA,oBAAoB;;WAIb,OAAO,oBAAoB;WAC3B,gBAAgB,YAAY,kBAAkB;;;KAI7C,gBAAgB,uBAAuB;;;;;KAMvC;;;;;;UAOK,eACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;;;;UAOhC,uBACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;KAIrC,eACR,2BACA;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"mappings":";;;;KAMY,QAAQ,aAAa,eAAe;EAC9C,aAAa;EACb,YAAY;;;;;;;qBAQD,eACX,aAAa,cAAc,qBACnB;;WAEC;;WAEA;;WAEA,MAAM;;;;;WAOU,OAAO,QAAQ,QAAQ;EAEhD,YAAY;IACV;IACA;IACA,MAAM;IACN,OAAO,QAAQ,QAAQ;;;cCJb;cACA;KAET,oBAAoB,UAAU,wBAC/B,KAAK,kCACL;;;;;KAMC,eACH,aAAa,aACb,QACA,sCACE,kDACC,kBAAkB,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;MAClE,gBAAgB;EAAS,QAAQ;EAAQ,OAAO;;;;;;UAMpC,gBAAgB,aAAa,cAAc;;;;;YAKhD,YAAY;IAAS;;WACtB,UAAU,eAAe,MAAM;;WAE/B,OAAO;;;;;;UAOD,wBACf,aAAa,cAAc;;;;;YAMjB,YAAY;IAAS;;WACtB,UAAU,eACjB,MACA,oBAAoB;;WAIb,OAAO,oBAAoB;WAC3B,gBAAgB,YAAY,kBAAkB;;;KAI7C,gBAAgB,uBAAuB;;;;;KAMvC;;;;;;UAOK,eACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;;;;UAOhC,uBACf,aAAa,cAAc,aAC3B,cAAc,gBAAgB;;YAGpB;IAAa,KAAK;IAAM,MAAM;IAAO;;;;KAIrC,eACR,2BACA;;;;;;KAOQ,kBAAkB,eAAe,sBAAsB;KAE9D,cAAc,UACjB,eAAe,qBAAqB,aAChC,gBAAgB,QAChB,eAAe,6BAA6B,aAC1C,wBAAwB,QACxB,sBAAsB;KAIzB,YAAY,UACf,eAAe,qBAAqB,aAChC,iBACA,eAAe,6BAA6B,aAC1C,iBAAiB,eAAe;KAGnC,UAAU,iBAAiB,sBAC7B,cAAc,WAAW,cAAc,SAAS;KAG9C,WAAW,UAAU;YACd;IAAa,WAAW,aAAa;;IAE7C;;KAIC,UAAU,UAAU,mBAAmB,YAAY,SAAS;YACrD;IAAa;;IAErB;KAGC,OAAO,iBAAiB,sBAC1B,cAAc,YAAY,UAAU,UAAU,QAAQ,YACrD,SAAS;KAIR,UAAU,iBAAiB,sBAC7B,cAAc,YAAY,UAAU,UAAU,QAAQ,gBACrD,WAAW,SAAS,QACpB,YAAY,SAAS;;;;;;KASb,gBAAgB,aAAa,aAAa;WACvC;WAA4B,MAAM;;WAClC;WAA0B,OAAO,eAAe;;;;;;;;KAQnD,kBAAkB,iBAAiB,6BAC7C,SAAS,UAAU,WACnB,MAAM,OAAO;;;;;;KAQH,mBAAmB,iBAAiB,6BAC9C,SAAS,UAAU,WACnB,SAAS,UAAU;;UAIJ,yBAEb,KACE,8EAGF;KAEC,uBAAuB,aAAa,eACvC,yBACE,YAAY,kBAAkB,wBAC9B;;;;;;KAQQ,yBAAyB,aAAa,eAChD;EACE,gBAAgB,YAAY,kBAAkB;;EAGxC;;;;;EAKA,mBAAmB,uBAAuB;;;EAI1C;EACA,kBAAkB,uBAAuB;;KAI9C,UAAU,aAAa,iCAAiC,iBACxD,QAAQ,eAAe,OAAO,qBAC9B,OAAO,eAAe,OAAO;;;;;;;;;KAUtB,iBAAiB,mBAAmB,+BAC9C,mBAAmB,6BAA6B,QAC5C,gBAAgB;;;;;KAOV,yBACV,mBAAmB,uCAEnB,mBAAmB,qCAAqC,QACpD,wBAAwB;;;;;;;;;;;;;;;;;wBAoWd,iBAAiB,aAAa,aAC5C,gBACA,WAAW,uBAAuB,QACjC,SAAS,eAAe;wBACX,iBAAiB,iBAAiB,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;wBAmC3C,YACd,sBAAsB,cACtB,iBAAiB,iBAEjB,MAAM,sBAAsB,gBAC5B,SAAS,WACR,QAAQ,kBAAkB;;;;;;;;;;;;;;;;;;;;;wBA4Bb,mBACd,sBAAsB,cACtB,iBAAiB,iBAEjB,MAAM,sBAAsB,gBAC5B,SAAS,WACR,QAAQ,mBAAmB;;;;;;;wBAcd,cAAc,aAAa,aACzC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;;;wBAsBF,WAAW,aAAa,aACtC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;;;;wBAuBF,YAAY,aAAa,aACvC,WAAW,uBAAuB,UAC/B,MAAM,UAAU,QAClB,eAAe;;;;;wBAoBF,sBAAsB,aAAa,aACjD,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;wBAeV,mBAAmB,aAAa,aAC9C,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;wBAeV,oBAAoB,aAAa,aAC/C,WAAW,+BAA+B,OAC1C,OAAO,eACP,OAAO,yBAAyB,QAC/B,uBAAuB;;;;;;;;wBAkBV,WAAW,aAAa,aAAa,QAAQ,gBAC3D,MAAM,sBAAsB,QAAQ,wBACpC,QAAQ,gBAAgB,OACxB,OAAO,kCACL,QAAQ,iBACR,OACA,QAAQ,OACR,wBAED,mCACD,gBACA,OACA,QAAQ,OACR;wBAEc,WAAW,aAAa,aAAa,QAAQ,gBAC3D,MAAM,sBAAsB,QAAQ,wBACpC,QAAQ,wBAAwB,OAChC,MAAM,0CACJ,eACA,QAAQ,iBACR,OACA,QAAQ,OACR,wBAED,2CACD,eACA,gBACA,OACA,QAAQ,OACR"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { c as _objectSpread2, l as _defineProperty, o as readQueryKey } from "../utils-B9ZCP47f.mjs";
|
|
2
2
|
import { isTRPCClientError } from "@trpc/client";
|
|
3
|
-
import { hashKey, isCancelledError } from "@tanstack/react-query";
|
|
3
|
+
import { hashKey, isCancelledError, skipToken } from "@tanstack/react-query";
|
|
4
4
|
import { getTRPCErrorFromUnknown } from "@trpc/server/unstable-core-do-not-import";
|
|
5
5
|
// src/unstable-handles/entryError.ts
|
|
6
6
|
/**
|
|
@@ -70,7 +70,7 @@ function createEntry(state) {
|
|
|
70
70
|
}
|
|
71
71
|
function readEntry(key, entry) {
|
|
72
72
|
const state = entry === null || entry === void 0 ? void 0 : entry[entryState];
|
|
73
|
-
if (!state) throw new Error(`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\` for "${key}", got ${JSON.stringify(entry)}`);
|
|
73
|
+
if (!state) throw new Error(`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\`, or \`skipToken\`, for "${key}", got ${JSON.stringify(entry)}`);
|
|
74
74
|
return state;
|
|
75
75
|
}
|
|
76
76
|
function startEntry(queryClient, state) {
|
|
@@ -107,10 +107,11 @@ function settleLoad(promise) {
|
|
|
107
107
|
}
|
|
108
108
|
async function startEntries(opts) {
|
|
109
109
|
const { queryClient, entries } = opts;
|
|
110
|
-
const loads = Object.entries(entries).
|
|
110
|
+
const loads = Object.entries(entries).flatMap(([key, entry]) => {
|
|
111
|
+
if (entry === skipToken) return [];
|
|
111
112
|
const state = readEntry(key, entry);
|
|
112
113
|
if (state.queryClient !== queryClient) throw new Error(`The entry for "${key}" was built with a proxy for another QueryClient than the root proxy that loads it`);
|
|
113
|
-
return [key, state];
|
|
114
|
+
return [[key, state]];
|
|
114
115
|
}).map(([key, state]) => ({
|
|
115
116
|
key,
|
|
116
117
|
state,
|
|
@@ -210,6 +211,9 @@ function isTRPCEntryError(error, procedure) {
|
|
|
210
211
|
* a handle for every entry, and the data of the fetch and ensure entries. Rejects as
|
|
211
212
|
* soon as a fetch or ensure entry fails. Prefetch entries never make it reject.
|
|
212
213
|
*
|
|
214
|
+
* Put TanStack Query's `skipToken` in place of an entry to start nothing for that
|
|
215
|
+
* key: its handle is `undefined`, and `data` has no key for it.
|
|
216
|
+
*
|
|
213
217
|
* Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.
|
|
214
218
|
* Call it in a route loader, a server component or an event handler, not during
|
|
215
219
|
* render: every render would start the entries again.
|
|
@@ -218,6 +222,7 @@ function isTRPCEntryError(error, procedure) {
|
|
|
218
222
|
* const [handles, data] = await loadHandles(trpc, {
|
|
219
223
|
* comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),
|
|
220
224
|
* post: ensureEntry(trpc.post.byId, { id }),
|
|
225
|
+
* draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,
|
|
221
226
|
* });
|
|
222
227
|
* if (!data.post.published) throw notFound();
|
|
223
228
|
* return handles;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"sourcesContent":["import type { TRPCClientErrorLike } from '@trpc/client';\nimport { isTRPCClientError } from '@trpc/client';\nimport type { TRPC_ERROR_CODE_KEY, TRPCError } from '@trpc/server';\nimport { getTRPCErrorFromUnknown } from '@trpc/server/unstable-core-do-not-import';\nimport type { ResolverDef } from '../internals/types';\n\nexport type ErrorOf<TDef extends ResolverDef> = TRPCClientErrorLike<{\n transformer: TDef['transformer'];\n errorShape: TDef['errorShape'];\n}>;\n\n/**\n * What `loadHandles()` rejects with when a fetch or ensure entry fails. It\n * names the entry, and keeps the request's error as `cause`.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-ensure\n */\nexport class TRPCEntryError<\n TDef extends ResolverDef = ResolverDef,\n> extends Error {\n /** The entry's key in the object passed to `loadHandles()` */\n readonly key: string;\n /** The procedure's path, such as `post.byId` */\n readonly path: string;\n /** The tRPC error code, such as `NOT_FOUND`, when the error has one */\n readonly code: TRPC_ERROR_CODE_KEY | undefined;\n // oxlint-disable-next-line typescript/ban-ts-comment\n // @ts-ignore `override` fails where the `lib` has no `Error.cause`\n /**\n * The request's error: a `TRPCError` on a proxy created with `router`, a\n * `TRPCClientError` on one created with `client`.\n */\n public override readonly cause: ErrorOf<TDef> | TRPCError;\n\n constructor(opts: {\n key: string;\n path: string;\n code: TRPC_ERROR_CODE_KEY | undefined;\n cause: ErrorOf<TDef> | TRPCError;\n }) {\n super(`Entry \"${opts.key}\" (${opts.path}) failed: ${opts.cause.message}`);\n this.name = 'TRPCEntryError';\n this.cause = opts.cause;\n this.key = opts.key;\n this.path = opts.path;\n this.code = opts.code;\n }\n}\n\nfunction codeOfShape(data: unknown): TRPC_ERROR_CODE_KEY | undefined {\n const code = (data as { code?: unknown } | null | undefined)?.code;\n return typeof code === 'string' ? (code as TRPC_ERROR_CODE_KEY) : undefined;\n}\n\nexport function entryCause(error: unknown) {\n if (isTRPCClientError(error)) {\n return { cause: error, code: codeOfShape(error.data) };\n }\n const cause = getTRPCErrorFromUnknown(error);\n return { cause, code: cause.code };\n}\n","import type {\n FetchQueryOptions,\n GetNextPageParamFunction,\n QueryClient,\n QueryFunction,\n} from '@tanstack/react-query';\nimport { hashKey, isCancelledError } from '@tanstack/react-query';\nimport { isTRPCClientError } from '@trpc/client';\nimport type {\n DecorateInfiniteQueryProcedure,\n DecorateQueryProcedure,\n DecorateRouterKeyable,\n} from '../internals/createOptionsProxy';\nimport type {\n UnusedSkipTokenTRPCInfiniteQueryOptionsIn,\n UnusedSkipTokenTRPCInfiniteQueryOptionsOut,\n} from '../internals/infiniteQueryOptions';\nimport type {\n UnusedSkipTokenTRPCQueryOptionsIn,\n UnusedSkipTokenTRPCQueryOptionsOut,\n} from '../internals/queryOptions';\nimport type {\n ExtractCursorType,\n FeatureFlags,\n ResolverDef,\n TRPCInfiniteData,\n TRPCQueryBaseOptions,\n TRPCQueryKey,\n} from '../internals/types';\nimport { readQueryKey } from '../internals/utils';\nimport type { ErrorOf } from './entryError';\nimport { entryCause, TRPCEntryError } from './entryError';\n\ndeclare const handleDef: unique symbol;\ndeclare const entryDef: unique symbol;\n\ntype InfiniteHandleInput<TInput> = TInput extends object\n ? Omit<TInput, 'cursor' | 'direction'>\n : TInput;\n\n/**\n * A plain tuple typed with the procedure's input. TanStack Router's serializability check\n * rejects `unknown` inputs and `DataTag`-ged keys, so handles in `beforeLoad` need this shape.\n */\ntype HandleQueryKey<\n TDef extends ResolverDef,\n TInput,\n TType extends 'query' | 'infinite',\n> = TDef['featureFlags']['keyPrefix'] extends true\n ? [prefix: string[], path: string[], opts?: { input?: TInput; type?: TType }]\n : [path: string[], opts?: { input?: TInput; type?: TType }];\n\n/**\n * A serializable reference to a query, from `loadHandles()`.\n * Pass it to a component and read it with `fromHandle(trpc, handle)`.\n */\nexport interface TRPCQueryHandle<TDef extends ResolverDef = ResolverDef> {\n /**\n * Type-only: never present at runtime. Required, so only\n * `loadHandles` creates handles.\n */\n readonly [handleDef]: TDef & { kind: 'query' };\n readonly queryKey: HandleQueryKey<TDef, TDef['input'], 'query'>;\n /** The query's input. The key is absent when the input is `undefined`. */\n readonly input: TDef['input'];\n}\n\n/**\n * A serializable reference to an infinite query, from `loadHandles()`.\n * Read it with `fromHandle(trpc, handle, { getNextPageParam })`.\n */\nexport interface TRPCInfiniteQueryHandle<\n TDef extends ResolverDef = ResolverDef,\n> {\n /**\n * Type-only: never present at runtime. Required, so only\n * `loadHandles` creates handles.\n */\n readonly [handleDef]: TDef & { kind: 'infinite' };\n readonly queryKey: HandleQueryKey<\n TDef,\n InfiniteHandleInput<TDef['input']>,\n 'infinite'\n >;\n /** The query's input, without `cursor` and `direction` */\n readonly input: InfiniteHandleInput<TDef['input']>;\n readonly initialCursor?: NonNullable<ExtractCursorType<TDef['input']>> | null;\n}\n\n/** Any query or infinite query handle. */\nexport type AnyTRPCHandle = TRPCQueryHandle<any> | TRPCInfiniteQueryHandle<any>;\n\n/**\n * How `loadHandles` starts an entry's query, named after the\n * `QueryClient` method it calls: `prefetchQuery`, `fetchQuery` or `ensureQueryData`.\n */\nexport type TRPCEntryKind = 'prefetch' | 'fetch' | 'ensure';\n\n/**\n * A query for `loadHandles()` to start, from `prefetchEntry`, `fetchEntry` or\n * `ensureEntry`.\n * Creating it starts nothing.\n */\nexport interface TRPCQueryEntry<\n TDef extends ResolverDef = ResolverDef,\n TKind extends TRPCEntryKind = TRPCEntryKind,\n> {\n /** Type-only: never present at runtime. */\n readonly [entryDef]: { def: TDef; kind: TKind; type: 'query' };\n}\n\n/**\n * An infinite query for `loadHandles()` to start, from `prefetchInfiniteEntry`,\n * `fetchInfiniteEntry` or `ensureInfiniteEntry`. Creating it starts nothing.\n */\nexport interface TRPCInfiniteQueryEntry<\n TDef extends ResolverDef = ResolverDef,\n TKind extends TRPCEntryKind = TRPCEntryKind,\n> {\n /** Type-only: never present at runtime. */\n readonly [entryDef]: { def: TDef; kind: TKind; type: 'infinite' };\n}\n\n/** Any query or infinite query entry. */\nexport type AnyTRPCEntry =\n | TRPCQueryEntry<any, any>\n | TRPCInfiniteQueryEntry<any, any>;\n\ntype HandleOfEntry<TEntry> =\n TEntry extends TRPCQueryEntry<infer TDef, any>\n ? TRPCQueryHandle<TDef>\n : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any>\n ? TRPCInfiniteQueryHandle<TDef>\n : never;\n\ntype DataOfEntry<TEntry> =\n TEntry extends TRPCQueryEntry<infer TDef, any>\n ? TDef['output']\n : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any>\n ? TRPCInfiniteData<TDef['input'], TDef['output']>\n : never;\n\ntype HandlesOf<TEntries extends Record<string, AnyTRPCEntry>> = {\n [TKey in keyof TEntries]: HandleOfEntry<TEntries[TKey]>;\n};\n\ntype DefOfEntry<TEntry> = TEntry extends {\n readonly [entryDef]: { def: infer TDef extends ResolverDef };\n}\n ? TDef\n : never;\n\n/** Only fetch and ensure entries are waited for, so only they have data */\ntype WaitedKey<TEntries, TKey extends keyof TEntries> = TEntries[TKey] extends {\n readonly [entryDef]: { kind: 'fetch' | 'ensure' };\n}\n ? TKey\n : never;\n\ntype DataOf<TEntries extends Record<string, AnyTRPCEntry>> = {\n [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: DataOfEntry<\n TEntries[TKey]\n >;\n};\n\ntype ResultsOf<TEntries extends Record<string, AnyTRPCEntry>> = {\n [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: TRPCEntryResult<\n DefOfEntry<TEntries[TKey]>,\n DataOfEntry<TEntries[TKey]>\n >;\n};\n\n/**\n * What `loadHandlesSettled()` has for a fetch or ensure entry: its data, or\n * the error it failed with.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport type TRPCEntryResult<TDef extends ResolverDef, TData> =\n | { readonly status: 'success'; readonly data: TData }\n | { readonly status: 'error'; readonly error: TRPCEntryError<TDef> };\n\n/**\n * What `loadHandles()` resolves to: `[handles, data]`. `handles` has a handle\n * for every entry, by the entry's key; return them from the loader. `data` has the data of\n * every fetch and ensure entry, by the entry's key.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#loader-data\n */\nexport type TRPCLoadedHandles<TEntries extends Record<string, AnyTRPCEntry>> =\n readonly [handles: HandlesOf<TEntries>, data: DataOf<TEntries>];\n\n/**\n * What `loadHandlesSettled()` resolves to: `[handles, results]`. `results`\n * has a `TRPCEntryResult` for every fetch and ensure entry, by the entry's key.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport type TRPCSettledHandles<TEntries extends Record<string, AnyTRPCEntry>> =\n readonly [handles: HandlesOf<TEntries>, results: ResultsOf<TEntries>];\n\n/** Options for an entry */\nexport interface TRPCEntryOptions\n extends\n Pick<\n FetchQueryOptions,\n 'staleTime' | 'retry' | 'retryDelay' | 'gcTime' | 'meta'\n >,\n TRPCQueryBaseOptions {}\n\ntype HandleGetNextPageParam<TDef extends ResolverDef> =\n GetNextPageParamFunction<\n NonNullable<ExtractCursorType<TDef['input']>> | null,\n TDef['output']\n >;\n\n/**\n * Options for an infinite query entry. Pass `pages` and `getNextPageParam`\n * to load several pages up front.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport type TRPCInfiniteEntryOptions<TDef extends ResolverDef> =\n TRPCEntryOptions & {\n initialCursor?: NonNullable<ExtractCursorType<TDef['input']>> | null;\n } & (\n | {\n pages?: never;\n /**\n * Without it, refetching a cached query with more than one page\n * fails on the second page.\n */\n getNextPageParam?: HandleGetNextPageParam<TDef>;\n }\n | {\n /** Number of pages to load up front */\n pages: number;\n getNextPageParam: HandleGetNextPageParam<TDef>;\n }\n );\n\ntype EntryArgs<TDef extends ResolverDef> = undefined extends TDef['input']\n ? [input?: TDef['input'], opts?: TRPCEntryOptions]\n : [input: TDef['input'], opts?: TRPCEntryOptions];\n\n/**\n * The handle type of a query procedure, for typing props.\n * @example\n * ```ts\n * type PostHandle = inferQueryHandle<TRPC['post']['byId']>;\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#typing-props\n */\nexport type inferQueryHandle<TProcedure extends DecorateQueryProcedure<any>> =\n TProcedure extends DecorateQueryProcedure<infer TDef>\n ? TRPCQueryHandle<TDef>\n : never;\n\n/**\n * The handle type of an infinite query procedure, for typing props.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#typing-props\n */\nexport type inferInfiniteQueryHandle<\n TProcedure extends DecorateInfiniteQueryProcedure<any>,\n> =\n TProcedure extends DecorateInfiniteQueryProcedure<infer TDef>\n ? TRPCInfiniteQueryHandle<TDef>\n : never;\n\nconst notAHandle = 'Expected a tRPC handle from `loadHandles()`';\n\nfunction readHandle(handle: AnyTRPCHandle, prefix: string | undefined) {\n const queryKey = handle?.queryKey as unknown as TRPCQueryKey<any> | undefined;\n if (!Array.isArray(queryKey)) {\n throw new Error(`${notAHandle}, got ${JSON.stringify(handle)}`);\n }\n const data = readQueryKey(queryKey);\n const type = data.args?.type;\n if (type !== 'query' && type !== 'infinite') {\n throw new Error(\n `${notAHandle}, got a key of type ${String(type)} for \"${data.path.join('.')}\"`,\n );\n }\n if ((data.prefix?.[0] ?? undefined) !== prefix) {\n throw new Error(\n `The handle for \"${data.path.join('.')}\" was created with keyPrefix ${JSON.stringify(data.prefix?.[0])}, but this proxy uses ${JSON.stringify(prefix)}`,\n );\n }\n return {\n type,\n path: data.path,\n input: data.args?.input,\n queryKey,\n };\n}\n\ntype HandleType = 'query' | 'infinite';\n\nfunction toHandle(options: any, type: HandleType) {\n const input = readQueryKey(options.queryKey).args?.input;\n // Next.js rejects `undefined` in `getServerSideProps` / `getStaticProps` props\n const handle: Record<string, unknown> = {\n queryKey: options.queryKey,\n ...(input !== undefined && { input }),\n };\n if (type === 'infinite' && options.initialPageParam != null) {\n handle['initialCursor'] = options.initialPageParam;\n }\n return handle;\n}\n\nconst entryState = Symbol('trpc.handleEntry');\n\ninterface EntryState {\n kind: TRPCEntryKind;\n type: HandleType;\n options: any;\n /** The `QueryClient` of the proxy that built the entry */\n queryClient: QueryClient;\n}\n\nfunction createEntry(state: EntryState) {\n return { [entryState]: state };\n}\n\nfunction readEntry(key: string, entry: unknown): EntryState {\n const state = (entry as { [entryState]?: EntryState } | null)?.[entryState];\n if (!state) {\n throw new Error(\n `Expected an entry from \\`prefetchEntry()\\`, \\`fetchEntry()\\` or \\`ensureEntry()\\` for \"${key}\", got ${JSON.stringify(entry)}`,\n );\n }\n return state;\n}\n\nfunction startEntry(queryClient: QueryClient, state: EntryState) {\n const { options } = state;\n if (state.type === 'infinite') {\n switch (state.kind) {\n case 'prefetch':\n return queryClient.prefetchInfiniteQuery(options);\n case 'ensure':\n return queryClient.ensureInfiniteQueryData({\n ...options,\n revalidateIfStale: true,\n });\n case 'fetch':\n return queryClient.fetchInfiniteQuery(options);\n }\n }\n switch (state.kind) {\n case 'prefetch':\n return queryClient.prefetchQuery(options);\n case 'ensure':\n return queryClient.ensureQueryData({\n ...options,\n revalidateIfStale: true,\n });\n case 'fetch':\n return queryClient.fetchQuery(options);\n }\n}\n\nfunction toEntryError(key: string, state: EntryState, error: unknown) {\n if (isCancelledError(error)) {\n return error;\n }\n return new TRPCEntryError({\n key,\n path: readQueryKey(state.options.queryKey).path.join('.'),\n ...entryCause(error),\n });\n}\n\nfunction settleLoad(promise: Promise<unknown>) {\n return promise.then(\n (data) => ({ status: 'success', data }),\n (error: unknown) => {\n if (error instanceof TRPCEntryError) {\n return { status: 'error', error };\n }\n throw error;\n },\n );\n}\n\nasync function startEntries(opts: {\n queryClient: QueryClient;\n entries: Record<string, unknown>;\n /** Resolve each waited entry to a `TRPCEntryResult` instead of rejecting */\n settle: boolean;\n}) {\n const { queryClient, entries } = opts;\n const states = Object.entries(entries).map(([key, entry]) => {\n const state = readEntry(key, entry);\n if (state.queryClient !== queryClient) {\n throw new Error(\n `The entry for \"${key}\" was built with a proxy for another QueryClient than the root proxy that loads it`,\n );\n }\n return [key, state] as const;\n });\n const loads = states.map(([key, state]) => ({\n key,\n state,\n promise: startEntry(queryClient, state).catch((error: unknown) => {\n throw toEntryError(key, state, error);\n }),\n }));\n const waited = loads.filter((load) => load.state.kind !== 'prefetch');\n const results = await Promise.all(\n waited.map((load) =>\n opts.settle ? settleLoad(load.promise) : load.promise,\n ),\n );\n\n const handles = Object.fromEntries(\n loads.map((load) => [\n load.key,\n toHandle(load.state.options, load.state.type),\n ]),\n );\n const data = Object.fromEntries(\n waited.map((load, index) => [load.key, results[index]]),\n );\n return [handles, data] as const;\n}\n\nfunction isServerEnvironment() {\n return typeof window === 'undefined' || 'Deno' in globalThis;\n}\n\nconst warnedNotHydrated = new Set<string>();\n\nfunction warnIfNotHydrated(\n path: readonly string[],\n queryFn: QueryFunction<any, any, any>,\n): QueryFunction<any, any, any> {\n return (context) => {\n if (isServerEnvironment()) {\n const queryHash = hashKey(context.queryKey);\n if (!warnedNotHydrated.has(queryHash)) {\n warnedNotHydrated.add(queryHash);\n // oxlint-disable-next-line no-console\n console.warn(\n `[@trpc/tanstack-react-query] The handle for \"${path.join('.')}\" is being fetched again during server rendering. ` +\n `Unless its data is stale, the query it refers to isn't in this QueryClient. ` +\n `Render the reading component inside <HydrateClient> or <HydrationBoundary>, and don't return handles from server functions or server actions. ` +\n `See https://trpc.io/docs/client/tanstack-react-query/handles#where-handles-dont-work`,\n );\n }\n }\n return queryFn(context);\n };\n}\n\nconst watchedHydrations = new WeakSet<Promise<unknown>>();\n\n/**\n * A query dehydrated as pending that later rejects reaches the browser as a\n * redacted error, before any `retry` from `fromHandle()` applies. Refetch such\n * a query once so error boundaries see a `TRPCClientError` from this client.\n */\nfunction refetchRejectedHydration(\n queryClient: QueryClient,\n type: HandleType,\n options: any,\n) {\n const enabled =\n typeof options.enabled === 'function'\n ? options.enabled\n : () => options.enabled;\n if (isServerEnvironment()) {\n return;\n }\n const query = queryClient\n .getQueryCache()\n .find({ queryKey: options.queryKey, exact: true });\n const promise = query?.promise;\n if (\n !query ||\n !promise ||\n query.state.data !== undefined ||\n query.state.fetchStatus === 'idle' ||\n enabled(query) === false ||\n watchedHydrations.has(promise)\n ) {\n return;\n }\n watchedHydrations.add(promise);\n promise.catch((error: unknown) => {\n if (\n isTRPCClientError(error) ||\n isCancelledError(error) ||\n query.state.fetchStatus !== 'idle' ||\n enabled(query) === false\n ) {\n return;\n }\n const defaulted = queryClient.defaultQueryOptions(options);\n // Older query-core versions take the infinite behavior from the fetch's\n // options, so `query.fetch` would store a bare page there.\n // `fetchInfiniteQuery` skips retries unless asked, unlike a query's fetch\n // in the browser, which retries 3 times by default.\n const refetch =\n type === 'infinite'\n ? queryClient.fetchInfiniteQuery({\n ...options,\n retry: defaulted.retry ?? 3,\n })\n : query.fetch(defaulted);\n refetch.catch(() => {\n // surfaces through the query's state\n });\n });\n}\n\nfunction prepareHandleRead<TOptions extends { queryFn?: unknown }>(opts: {\n queryClient: QueryClient;\n handle: ReturnType<typeof readHandle>;\n options: TOptions;\n}): TOptions {\n const { options } = opts;\n if (\n globalThis.process?.env?.['NODE_ENV'] !== 'production' &&\n typeof options.queryFn === 'function'\n ) {\n options.queryFn = warnIfNotHydrated(\n opts.handle.path,\n options.queryFn as QueryFunction<any, any, any>,\n );\n }\n refetchRejectedHydration(opts.queryClient, opts.handle.type, options);\n return options;\n}\n\ninterface ProxyContext {\n proxy: any;\n path: string[];\n prefix: string | undefined;\n}\n\nfunction readProxy(proxy: unknown, fn: string): ProxyContext {\n const queryKey = (proxy as { queryKey?: unknown } | null)?.queryKey;\n if (Array.isArray(queryKey)) {\n throw new Error(\n `\\`${fn}()\\` expects a tRPC options proxy or one of its procedures, got a handle for \\`${readQueryKey(queryKey as TRPCQueryKey<any>).path.join('.')}\\``,\n );\n }\n if (typeof queryKey !== 'function') {\n throw new Error(\n `\\`${fn}()\\` expects a tRPC options proxy or one of its procedures, got ${String(proxy)}`,\n );\n }\n const key = readQueryKey(queryKey());\n return {\n proxy,\n path: key.path,\n prefix: key.prefix?.[0],\n };\n}\n\nfunction queryClientOf(ctx: ProxyContext): QueryClient {\n return ctx.proxy['~queryClient']();\n}\n\nfunction optionsOf(\n procedure: any,\n type: HandleType,\n): (input: unknown, opts: unknown) => any {\n return type === 'infinite'\n ? procedure.infiniteQueryOptions\n : procedure.queryOptions;\n}\n\nfunction readRoot(trpc: unknown, fn: string) {\n const ctx = readProxy(trpc, fn);\n if (ctx.path.length > 0) {\n throw new Error(\n `\\`${fn}()\\` takes the root proxy, \\`trpc\\`, got \\`trpc.${ctx.path.join('.')}\\``,\n );\n }\n return ctx;\n}\n\nfunction entry(opts: {\n fn: string;\n type: HandleType;\n kind: TRPCEntryKind;\n procedure: unknown;\n input: unknown;\n opts: unknown;\n}) {\n const ctx = readProxy(opts.procedure, opts.fn);\n return createEntry({\n type: opts.type,\n kind: opts.kind,\n options: optionsOf(ctx.proxy, opts.type)(opts.input, opts.opts),\n queryClient: queryClientOf(ctx),\n });\n}\n\n/**\n * Whether `error` is a failed entry from `loadHandles()`. Pass a procedure to\n * check that the entry was for it, which types `error.cause` with its errors.\n * @example\n * ```ts\n * const [handles] = await loadHandles(trpc, {\n * post: ensureEntry(trpc.post.byId, { id }),\n * }).catch((error: unknown) => {\n * if (isTRPCEntryError(error, trpc.post.byId) && error.code === 'NOT_FOUND') {\n * throw notFound();\n * }\n * throw error;\n * });\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-ensure\n */\nexport function isTRPCEntryError<TDef extends ResolverDef>(\n error: unknown,\n procedure: DecorateQueryProcedure<TDef>,\n): error is TRPCEntryError<TDef>;\nexport function isTRPCEntryError(error: unknown): error is TRPCEntryError;\nexport function isTRPCEntryError(error: unknown, procedure?: unknown) {\n if (!(error instanceof TRPCEntryError)) {\n return false;\n }\n return (\n procedure === undefined ||\n error.path === readProxy(procedure, 'isTRPCEntryError').path.join('.')\n );\n}\n\n/**\n * Starts every entry before it waits for any, so the order of the entries doesn't\n * matter. Resolves to `[handles, data]` once every fetch and ensure entry has data:\n * a handle for every entry, and the data of the fetch and ensure entries. Rejects as\n * soon as a fetch or ensure entry fails. Prefetch entries never make it reject.\n *\n * Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.\n * Call it in a route loader, a server component or an event handler, not during\n * render: every render would start the entries again.\n * @example\n * ```ts\n * const [handles, data] = await loadHandles(trpc, {\n * comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),\n * post: ensureEntry(trpc.post.byId, { id }),\n * });\n * if (!data.post.published) throw notFound();\n * return handles;\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles\n */\nexport function loadHandles<\n TFeatureFlags extends FeatureFlags,\n TEntries extends Record<string, AnyTRPCEntry>,\n>(\n trpc: DecorateRouterKeyable<TFeatureFlags>,\n entries: TEntries,\n): Promise<TRPCLoadedHandles<TEntries>> {\n return startEntries({\n queryClient: queryClientOf(readRoot(trpc, 'loadHandles')),\n entries,\n settle: false,\n }) as Promise<any>;\n}\n\n/**\n * Like `loadHandles()`, but it waits for every fetch and ensure entry to\n * settle and never rejects because one failed. Resolves to `[handles, results]`:\n * `results` has `{ status: 'success', data }` or `{ status: 'error', error }`,\n * with a `TRPCEntryError`, for every fetch and ensure entry.\n *\n * A cancelled query still rejects, as it does with `loadHandles()`.\n * @example\n * ```ts\n * const [handles, results] = await loadHandlesSettled(trpc, {\n * post: ensureEntry(trpc.post.byId, { id }),\n * comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),\n * });\n * if (results.post.status === 'error') {\n * if (results.post.error.code === 'NOT_FOUND') throw notFound();\n * throw results.post.error;\n * }\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport function loadHandlesSettled<\n TFeatureFlags extends FeatureFlags,\n TEntries extends Record<string, AnyTRPCEntry>,\n>(\n trpc: DecorateRouterKeyable<TFeatureFlags>,\n entries: TEntries,\n): Promise<TRPCSettledHandles<TEntries>> {\n return startEntries({\n queryClient: queryClientOf(readRoot(trpc, 'loadHandlesSettled')),\n entries,\n settle: true,\n }) as Promise<any>;\n}\n\n/**\n * An entry for `loadHandles()` that starts the query without waiting, like\n * `queryClient.prefetchQuery`. It never makes the load reject: errors surface where\n * the handle is read. Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#prefetch\n */\nexport function prefetchEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'prefetch'>;\nexport function prefetchEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'prefetchEntry',\n type: 'query',\n kind: 'prefetch',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * An entry for `loadHandles()` that waits for fresh data, like `queryClient.fetchQuery`:\n * cached data is used only if it isn't stale. The load rejects if the request fails.\n * Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#fetch\n */\nexport function fetchEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'fetch'>;\nexport function fetchEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'fetchEntry',\n type: 'query',\n kind: 'fetch',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * An entry for `loadHandles()` that uses any cached data, even stale, like\n * `queryClient.ensureQueryData({ revalidateIfStale: true })`. It fetches and waits only\n * when the cache has no data, and the load rejects if that request fails. Stale data is\n * refetched in the background. Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#ensure\n */\nexport function ensureEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'ensure'>;\nexport function ensureEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'ensureEntry',\n type: 'query',\n kind: 'ensure',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * Like `prefetchEntry`, for an infinite query. Loads the first page unless `pages` is set.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function prefetchInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'prefetch'> {\n return entry({\n fn: 'prefetchInfiniteEntry',\n type: 'infinite',\n kind: 'prefetch',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Like `fetchEntry`, for an infinite query.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function fetchInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'fetch'> {\n return entry({\n fn: 'fetchInfiniteEntry',\n type: 'infinite',\n kind: 'fetch',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Like `ensureEntry`, for an infinite query.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function ensureInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'ensure'> {\n return entry({\n fn: 'ensureInfiniteEntry',\n type: 'infinite',\n kind: 'ensure',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Options for a handle: the same options `trpc.<path>.queryOptions(input)` or\n * `trpc.<path>.infiniteQueryOptions(input, opts)` return for the handle's procedure and\n * input. Pass them to `useQuery`, `useSuspenseQuery`, `useSuspenseInfiniteQuery`, etc.\n * `trpc` is the proxy or a router on the handle's path, usually `useTRPC()`.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#reading-a-handle\n */\nexport function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(\n trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>,\n handle: TRPCQueryHandle<TDef>,\n opts?: UnusedSkipTokenTRPCQueryOptionsIn<\n NoInfer<TDef['output']>,\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n >,\n): UnusedSkipTokenTRPCQueryOptionsOut<\n TDef['output'],\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n>;\nexport function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(\n trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>,\n handle: TRPCInfiniteQueryHandle<TDef>,\n opts: UnusedSkipTokenTRPCInfiniteQueryOptionsIn<\n TDef['input'],\n NoInfer<TDef['output']>,\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n >,\n): UnusedSkipTokenTRPCInfiniteQueryOptionsOut<\n TDef['input'],\n TDef['output'],\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n>;\nexport function fromHandle(\n trpc: unknown,\n rawHandle: AnyTRPCHandle,\n opts?: object,\n): unknown {\n const ctx = readProxy(trpc, 'fromHandle');\n const handle = readHandle(rawHandle, ctx.prefix);\n if (!ctx.path.every((segment, index) => handle.path[index] === segment)) {\n throw new Error(\n `\\`fromHandle(trpc.${ctx.path.join('.')}, handle)\\` got a handle for \\`${handle.path.join('.')}\\`, which isn't in \\`${ctx.path.join('.')}\\`. Pass the root proxy, \\`trpc\\``,\n );\n }\n const procedure = handle.path\n .slice(ctx.path.length)\n .reduce((level, segment) => level[segment], ctx.proxy);\n const options = optionsOf(procedure, handle.type)(\n handle.input,\n handle.type === 'infinite'\n ? {\n initialCursor: (rawHandle as TRPCInfiniteQueryHandle).initialCursor,\n ...opts,\n }\n : opts,\n );\n return prepareHandleRead({\n queryClient: queryClientOf(ctx),\n handle,\n options,\n });\n}\n"],"mappings":";;;;;;;;;;AAgBA,IAAa,iBAAb,cAEU,MAAM;CAed,YAAY,MAKT;EACD,MAAM,UAAU,KAAK,IAAI,KAAK,KAAK,KAAK,YAAY,KAAK,MAAM,SAAS;EAnBjE,gBAAA,MAAA,OAAA,KAAA,CAAA;EAEA,gBAAA,MAAA,QAAA,KAAA,CAAA;EAEA,gBAAA,MAAA,QAAA,KAAA,CAAA;EAOgB,gBAAA,MAAA,SAAA,KAAA,CAAA;EASvB,KAAK,OAAO;EACZ,KAAK,QAAQ,KAAK;EAClB,KAAK,MAAM,KAAK;EAChB,KAAK,OAAO,KAAK;EACjB,KAAK,OAAO,KAAK;CACnB;AACF;AAEA,SAAS,YAAY,MAAgD;CACnE,MAAM,OAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAQ,KAAgD;CAC9D,OAAO,OAAO,SAAS,WAAY,OAA+B,KAAA;AACpE;AAEA,SAAgB,WAAW,OAAgB;CACzC,IAAI,kBAAkB,KAAK,GACzB,OAAO;EAAE,OAAO;EAAO,MAAM,YAAY,MAAM,IAAI;CAAE;CAEvD,MAAM,QAAQ,wBAAwB,KAAK;CAC3C,OAAO;EAAE;EAAO,MAAM,MAAM;CAAK;AACnC;;AC8MA,MAAM,aAAa;AAEnB,SAAS,WAAW,QAAuB,QAA4B;;CACrE,MAAM,WAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAW,OAAQ;CACzB,IAAI,CAAC,MAAM,QAAQ,QAAQ,GACzB,MAAM,IAAI,MAAM,GAAG,WAAW,QAAQ,KAAK,UAAU,MAAM,GAAG;CAEhE,MAAM,OAAO,aAAa,QAAQ;CAClC,MAAM,QAAA,aAAO,KAAK,UAAA,QAAA,eAAA,KAAA,IAAA,KAAA,IAAA,WAAM;CACxB,IAAI,SAAS,WAAW,SAAS,YAC/B,MAAM,IAAI,MACR,GAAG,WAAW,sBAAsB,OAAO,IAAI,EAAE,QAAQ,KAAK,KAAK,KAAK,GAAG,EAAE,EAC/E;CAEF,MAAA,iBAAA,eAAK,KAAK,YAAA,QAAA,iBAAA,KAAA,IAAA,KAAA,IAAA,aAAS,QAAA,QAAA,kBAAA,KAAA,IAAA,gBAAM,KAAA,OAAe,QAAQ;;EAC9C,MAAM,IAAI,MACR,mBAAmB,KAAK,KAAK,KAAK,GAAG,EAAE,+BAA+B,KAAK,WAAA,gBAAU,KAAK,YAAA,QAAA,kBAAA,KAAA,IAAA,KAAA,IAAA,cAAS,EAAE,EAAE,wBAAwB,KAAK,UAAU,MAAM,GACtJ;CACF;CACA,OAAO;EACL;EACA,MAAM,KAAK;EACX,QAAA,cAAO,KAAK,UAAA,QAAA,gBAAA,KAAA,IAAA,KAAA,IAAA,YAAM;EAClB;CACF;AACF;AAIA,SAAS,SAAS,SAAc,MAAkB;;CAChD,MAAM,SAAA,qBAAQ,aAAa,QAAQ,QAAQ,CAAC,CAAC,UAAA,QAAA,uBAAA,KAAA,IAAA,KAAA,IAAA,mBAAM;CAEnD,MAAM,SAAA,eAAA,EACJ,UAAU,QAAQ,SAAA,GACd,UAAU,KAAA,KAAa,EAAE,MAAM,CACrC;CACA,IAAI,SAAS,cAAc,QAAQ,oBAAoB,MACrD,OAAO,mBAAmB,QAAQ;CAEpC,OAAO;AACT;AAEA,MAAM,aAAa,OAAO,kBAAkB;AAU5C,SAAS,YAAY,OAAmB;CACtC,OAAO,GAAG,aAAa,MAAM;AAC/B;AAEA,SAAS,UAAU,KAAa,OAA4B;CAC1D,MAAM,QAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAS,MAAiD;CAChE,IAAI,CAAC,OACH,MAAM,IAAI,MACR,0FAA0F,IAAI,SAAS,KAAK,UAAU,KAAK,GAC7H;CAEF,OAAO;AACT;AAEA,SAAS,WAAW,aAA0B,OAAmB;CAC/D,MAAM,EAAE,YAAY;CACpB,IAAI,MAAM,SAAS,YACjB,QAAQ,MAAM,MAAd;EACE,KAAK,YACH,OAAO,YAAY,sBAAsB,OAAO;EAClD,KAAK,UACH,OAAO,YAAY,wBAAA,eAAA,eAAA,CAAA,GACd,OAAA,GAAA,CAAA,GAAA,EACH,mBAAmB,KAAA,CACrB,CAAC;EACH,KAAK,SACH,OAAO,YAAY,mBAAmB,OAAO;CACjD;CAEF,QAAQ,MAAM,MAAd;EACE,KAAK,YACH,OAAO,YAAY,cAAc,OAAO;EAC1C,KAAK,UACH,OAAO,YAAY,gBAAA,eAAA,eAAA,CAAA,GACd,OAAA,GAAA,CAAA,GAAA,EACH,mBAAmB,KAAA,CACrB,CAAC;EACH,KAAK,SACH,OAAO,YAAY,WAAW,OAAO;CACzC;AACF;AAEA,SAAS,aAAa,KAAa,OAAmB,OAAgB;CACpE,IAAI,iBAAiB,KAAK,GACxB,OAAO;CAET,OAAO,IAAI,eAAA,eAAA;EACT;EACA,MAAM,aAAa,MAAM,QAAQ,QAAQ,CAAC,CAAC,KAAK,KAAK,GAAG;CACrD,GAAA,WAAW,KAAK,CACrB,CAAC;AACH;AAEA,SAAS,WAAW,SAA2B;CAC7C,OAAO,QAAQ,MACZ,UAAU;EAAE,QAAQ;EAAW;CAAK,KACpC,UAAmB;EAClB,IAAI,iBAAiB,gBACnB,OAAO;GAAE,QAAQ;GAAS;EAAM;EAElC,MAAM;CACR,CACF;AACF;AAEA,eAAe,aAAa,MAKzB;CACD,MAAM,EAAE,aAAa,YAAY;CAUjC,MAAM,QATS,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW;EAC3D,MAAM,QAAQ,UAAU,KAAK,KAAK;EAClC,IAAI,MAAM,gBAAgB,aACxB,MAAM,IAAI,MACR,kBAAkB,IAAI,mFACxB;EAEF,OAAO,CAAC,KAAK,KAAK;CACpB,CACmB,CAAC,CAAC,KAAK,CAAC,KAAK,YAAY;EAC1C;EACA;EACA,SAAS,WAAW,aAAa,KAAK,CAAC,CAAC,OAAO,UAAmB;GAChE,MAAM,aAAa,KAAK,OAAO,KAAK;EACtC,CAAC;CACH,EAAE;CACF,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,MAAM,SAAS,UAAU;CACpE,MAAM,UAAU,MAAM,QAAQ,IAC5B,OAAO,KAAK,SACV,KAAK,SAAS,WAAW,KAAK,OAAO,IAAI,KAAK,OAChD,CACF;CAWA,OAAO,CATS,OAAO,YACrB,MAAM,KAAK,SAAS,CAClB,KAAK,KACL,SAAS,KAAK,MAAM,SAAS,KAAK,MAAM,IAAI,CAC9C,CAAC,CAKW,GAHD,OAAO,YAClB,OAAO,KAAK,MAAM,UAAU,CAAC,KAAK,KAAK,QAAQ,MAAM,CAAC,CAEpC,CAAC;AACvB;AAEA,SAAS,sBAAsB;CAC7B,OAAO,OAAO,WAAW,eAAe,UAAU;AACpD;AAEA,MAAM,oCAAoB,IAAI,IAAY;AAE1C,SAAS,kBACP,MACA,SAC8B;CAC9B,QAAQ,YAAY;EAClB,IAAI,oBAAoB,GAAG;GACzB,MAAM,YAAY,QAAQ,QAAQ,QAAQ;GAC1C,IAAI,CAAC,kBAAkB,IAAI,SAAS,GAAG;IACrC,kBAAkB,IAAI,SAAS;IAE/B,QAAQ,KACN,gDAAgD,KAAK,KAAK,GAAG,EAAE,iWAIjE;GACF;EACF;EACA,OAAO,QAAQ,OAAO;CACxB;AACF;AAEA,MAAM,oCAAoB,IAAI,QAA0B;;;;;;AAOxD,SAAS,yBACP,aACA,MACA,SACA;CACA,MAAM,UACJ,OAAO,QAAQ,YAAY,aACvB,QAAQ,gBACF,QAAQ;CACpB,IAAI,oBAAoB,GACtB;CAEF,MAAM,QAAQ,YACX,cAAc,CAAC,CACf,KAAK;EAAE,UAAU,QAAQ;EAAU,OAAO;CAAK,CAAC;CACnD,MAAM,UAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAU,MAAO;CACvB,IACE,CAAC,SACD,CAAC,WACD,MAAM,MAAM,SAAS,KAAA,KACrB,MAAM,MAAM,gBAAgB,UAC5B,QAAQ,KAAK,MAAM,SACnB,kBAAkB,IAAI,OAAO,GAE7B;CAEF,kBAAkB,IAAI,OAAO;CAC7B,QAAQ,OAAO,UAAmB;;EAChC,IACE,kBAAkB,KAAK,KACvB,iBAAiB,KAAK,KACtB,MAAM,MAAM,gBAAgB,UAC5B,QAAQ,KAAK,MAAM,OAEnB;EAEF,MAAM,YAAY,YAAY,oBAAoB,OAAO;EAYzD,CANE,SAAS,aACL,YAAY,mBAAA,eAAA,eAAA,CAAA,GACP,OAAA,GAAA,CAAA,GAAA,EACH,QAAA,mBAAO,UAAU,WAAA,QAAA,qBAAA,KAAA,IAAA,mBAAS,EAAA,CAC5B,CAAC,IACD,MAAM,MAAM,SAAS,EAAA,CACnB,YAAY,CAEpB,CAAC;CACH,CAAC;AACH;AAEA,SAAS,kBAA0D,MAItD;;CACX,MAAM,EAAE,YAAY;CACpB,MAAA,sBACE,WAAW,aAAA,QAAA,wBAAA,KAAA,MAAA,sBAAA,oBAAS,SAAA,QAAA,wBAAA,KAAA,IAAA,KAAA,IAAA,oBAAM,iBAAgB,gBAC1C,OAAO,QAAQ,YAAY,YAE3B,QAAQ,UAAU,kBAChB,KAAK,OAAO,MACZ,QAAQ,OACV;CAEF,yBAAyB,KAAK,aAAa,KAAK,OAAO,MAAM,OAAO;CACpE,OAAO;AACT;AAQA,SAAS,UAAU,OAAgB,IAA0B;;CAC3D,MAAM,WAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAY,MAAyC;CAC3D,IAAI,MAAM,QAAQ,QAAQ,GACxB,MAAM,IAAI,MACR,KAAK,GAAG,iFAAiF,aAAa,QAA6B,CAAC,CAAC,KAAK,KAAK,GAAG,EAAE,GACtJ;CAEF,IAAI,OAAO,aAAa,YACtB,MAAM,IAAI,MACR,KAAK,GAAG,kEAAkE,OAAO,KAAK,GACxF;CAEF,MAAM,MAAM,aAAa,SAAS,CAAC;CACnC,OAAO;EACL;EACA,MAAM,IAAI;EACV,SAAA,cAAQ,IAAI,YAAA,QAAA,gBAAA,KAAA,IAAA,KAAA,IAAA,YAAS;CACvB;AACF;AAEA,SAAS,cAAc,KAAgC;CACrD,OAAO,IAAI,MAAM,eAAe,CAAC;AACnC;AAEA,SAAS,UACP,WACA,MACwC;CACxC,OAAO,SAAS,aACZ,UAAU,uBACV,UAAU;AAChB;AAEA,SAAS,SAAS,MAAe,IAAY;CAC3C,MAAM,MAAM,UAAU,MAAM,EAAE;CAC9B,IAAI,IAAI,KAAK,SAAS,GACpB,MAAM,IAAI,MACR,KAAK,GAAG,kDAAkD,IAAI,KAAK,KAAK,GAAG,EAAE,GAC/E;CAEF,OAAO;AACT;AAEA,SAAS,MAAM,MAOZ;CACD,MAAM,MAAM,UAAU,KAAK,WAAW,KAAK,EAAE;CAC7C,OAAO,YAAY;EACjB,MAAM,KAAK;EACX,MAAM,KAAK;EACX,SAAS,UAAU,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,KAAK,OAAO,KAAK,IAAI;EAC9D,aAAa,cAAc,GAAG;CAChC,CAAC;AACH;AAuBA,SAAgB,iBAAiB,OAAgB,WAAqB;CACpE,IAAI,EAAE,iBAAiB,iBACrB,OAAO;CAET,OACE,cAAc,KAAA,KACd,MAAM,SAAS,UAAU,WAAW,kBAAkB,CAAC,CAAC,KAAK,KAAK,GAAG;AAEzE;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,YAId,MACA,SACsC;CACtC,OAAO,aAAa;EAClB,aAAa,cAAc,SAAS,MAAM,aAAa,CAAC;EACxD;EACA,QAAQ;CACV,CAAC;AACH;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,mBAId,MACA,SACuC;CACvC,OAAO,aAAa;EAClB,aAAa,cAAc,SAAS,MAAM,oBAAoB,CAAC;EAC/D;EACA,QAAQ;CACV,CAAC;AACH;AAYA,SAAgB,cACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAYA,SAAgB,WACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAaA,SAAgB,YACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,sBACd,WACA,OACA,MAC0C;CAC1C,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,mBACd,WACA,OACA,MACuC;CACvC,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,oBACd,WACA,OACA,MACwC;CACxC,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAyCA,SAAgB,WACd,MACA,WACA,MACS;CACT,MAAM,MAAM,UAAU,MAAM,YAAY;CACxC,MAAM,SAAS,WAAW,WAAW,IAAI,MAAM;CAC/C,IAAI,CAAC,IAAI,KAAK,OAAO,SAAS,UAAU,OAAO,KAAK,WAAW,OAAO,GACpE,MAAM,IAAI,MACR,qBAAqB,IAAI,KAAK,KAAK,GAAG,EAAE,iCAAiC,OAAO,KAAK,KAAK,GAAG,EAAE,uBAAuB,IAAI,KAAK,KAAK,GAAG,EAAE,kCAC3I;CAKF,MAAM,UAAU,UAHE,OAAO,KACtB,MAAM,IAAI,KAAK,MAAM,CAAC,CACtB,QAAQ,OAAO,YAAY,MAAM,UAAU,IAAI,KAChB,GAAG,OAAO,IAAI,CAAC,CAC/C,OAAO,OACP,OAAO,SAAS,aAAA,eAAA,EAEV,eAAgB,UAAsC,cAAA,GACnD,IACL,IACA,IACN;CACA,OAAO,kBAAkB;EACvB,aAAa,cAAc,GAAG;EAC9B;EACA;CACF,CAAC;AACH"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/unstable-handles/entryError.ts","../../src/unstable-handles/handles.ts"],"sourcesContent":["import type { TRPCClientErrorLike } from '@trpc/client';\nimport { isTRPCClientError } from '@trpc/client';\nimport type { TRPC_ERROR_CODE_KEY, TRPCError } from '@trpc/server';\nimport { getTRPCErrorFromUnknown } from '@trpc/server/unstable-core-do-not-import';\nimport type { ResolverDef } from '../internals/types';\n\nexport type ErrorOf<TDef extends ResolverDef> = TRPCClientErrorLike<{\n transformer: TDef['transformer'];\n errorShape: TDef['errorShape'];\n}>;\n\n/**\n * What `loadHandles()` rejects with when a fetch or ensure entry fails. It\n * names the entry, and keeps the request's error as `cause`.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-ensure\n */\nexport class TRPCEntryError<\n TDef extends ResolverDef = ResolverDef,\n> extends Error {\n /** The entry's key in the object passed to `loadHandles()` */\n readonly key: string;\n /** The procedure's path, such as `post.byId` */\n readonly path: string;\n /** The tRPC error code, such as `NOT_FOUND`, when the error has one */\n readonly code: TRPC_ERROR_CODE_KEY | undefined;\n // oxlint-disable-next-line typescript/ban-ts-comment\n // @ts-ignore `override` fails where the `lib` has no `Error.cause`\n /**\n * The request's error: a `TRPCError` on a proxy created with `router`, a\n * `TRPCClientError` on one created with `client`.\n */\n public override readonly cause: ErrorOf<TDef> | TRPCError;\n\n constructor(opts: {\n key: string;\n path: string;\n code: TRPC_ERROR_CODE_KEY | undefined;\n cause: ErrorOf<TDef> | TRPCError;\n }) {\n super(`Entry \"${opts.key}\" (${opts.path}) failed: ${opts.cause.message}`);\n this.name = 'TRPCEntryError';\n this.cause = opts.cause;\n this.key = opts.key;\n this.path = opts.path;\n this.code = opts.code;\n }\n}\n\nfunction codeOfShape(data: unknown): TRPC_ERROR_CODE_KEY | undefined {\n const code = (data as { code?: unknown } | null | undefined)?.code;\n return typeof code === 'string' ? (code as TRPC_ERROR_CODE_KEY) : undefined;\n}\n\nexport function entryCause(error: unknown) {\n if (isTRPCClientError(error)) {\n return { cause: error, code: codeOfShape(error.data) };\n }\n const cause = getTRPCErrorFromUnknown(error);\n return { cause, code: cause.code };\n}\n","import type {\n FetchQueryOptions,\n GetNextPageParamFunction,\n QueryClient,\n QueryFunction,\n} from '@tanstack/react-query';\nimport { hashKey, isCancelledError, skipToken } from '@tanstack/react-query';\nimport { isTRPCClientError } from '@trpc/client';\nimport type {\n DecorateInfiniteQueryProcedure,\n DecorateQueryProcedure,\n DecorateRouterKeyable,\n} from '../internals/createOptionsProxy';\nimport type {\n UnusedSkipTokenTRPCInfiniteQueryOptionsIn,\n UnusedSkipTokenTRPCInfiniteQueryOptionsOut,\n} from '../internals/infiniteQueryOptions';\nimport type {\n UnusedSkipTokenTRPCQueryOptionsIn,\n UnusedSkipTokenTRPCQueryOptionsOut,\n} from '../internals/queryOptions';\nimport type {\n ExtractCursorType,\n FeatureFlags,\n ResolverDef,\n TRPCInfiniteData,\n TRPCQueryBaseOptions,\n TRPCQueryKey,\n} from '../internals/types';\nimport { readQueryKey } from '../internals/utils';\nimport type { ErrorOf } from './entryError';\nimport { entryCause, TRPCEntryError } from './entryError';\n\ndeclare const handleDef: unique symbol;\ndeclare const entryDef: unique symbol;\n\ntype InfiniteHandleInput<TInput> = TInput extends object\n ? Omit<TInput, 'cursor' | 'direction'>\n : TInput;\n\n/**\n * A plain tuple typed with the procedure's input. TanStack Router's serializability check\n * rejects `unknown` inputs and `DataTag`-ged keys, so handles in `beforeLoad` need this shape.\n */\ntype HandleQueryKey<\n TDef extends ResolverDef,\n TInput,\n TType extends 'query' | 'infinite',\n> = TDef['featureFlags']['keyPrefix'] extends true\n ? [prefix: string[], path: string[], opts?: { input?: TInput; type?: TType }]\n : [path: string[], opts?: { input?: TInput; type?: TType }];\n\n/**\n * A serializable reference to a query, from `loadHandles()`.\n * Pass it to a component and read it with `fromHandle(trpc, handle)`.\n */\nexport interface TRPCQueryHandle<TDef extends ResolverDef = ResolverDef> {\n /**\n * Type-only: never present at runtime. Required, so only\n * `loadHandles` creates handles.\n */\n readonly [handleDef]: TDef & { kind: 'query' };\n readonly queryKey: HandleQueryKey<TDef, TDef['input'], 'query'>;\n /** The query's input. The key is absent when the input is `undefined`. */\n readonly input: TDef['input'];\n}\n\n/**\n * A serializable reference to an infinite query, from `loadHandles()`.\n * Read it with `fromHandle(trpc, handle, { getNextPageParam })`.\n */\nexport interface TRPCInfiniteQueryHandle<\n TDef extends ResolverDef = ResolverDef,\n> {\n /**\n * Type-only: never present at runtime. Required, so only\n * `loadHandles` creates handles.\n */\n readonly [handleDef]: TDef & { kind: 'infinite' };\n readonly queryKey: HandleQueryKey<\n TDef,\n InfiniteHandleInput<TDef['input']>,\n 'infinite'\n >;\n /** The query's input, without `cursor` and `direction` */\n readonly input: InfiniteHandleInput<TDef['input']>;\n readonly initialCursor?: NonNullable<ExtractCursorType<TDef['input']>> | null;\n}\n\n/** Any query or infinite query handle. */\nexport type AnyTRPCHandle = TRPCQueryHandle<any> | TRPCInfiniteQueryHandle<any>;\n\n/**\n * How `loadHandles` starts an entry's query, named after the\n * `QueryClient` method it calls: `prefetchQuery`, `fetchQuery` or `ensureQueryData`.\n */\nexport type TRPCEntryKind = 'prefetch' | 'fetch' | 'ensure';\n\n/**\n * A query for `loadHandles()` to start, from `prefetchEntry`, `fetchEntry` or\n * `ensureEntry`.\n * Creating it starts nothing.\n */\nexport interface TRPCQueryEntry<\n TDef extends ResolverDef = ResolverDef,\n TKind extends TRPCEntryKind = TRPCEntryKind,\n> {\n /** Type-only: never present at runtime. */\n readonly [entryDef]: { def: TDef; kind: TKind; type: 'query' };\n}\n\n/**\n * An infinite query for `loadHandles()` to start, from `prefetchInfiniteEntry`,\n * `fetchInfiniteEntry` or `ensureInfiniteEntry`. Creating it starts nothing.\n */\nexport interface TRPCInfiniteQueryEntry<\n TDef extends ResolverDef = ResolverDef,\n TKind extends TRPCEntryKind = TRPCEntryKind,\n> {\n /** Type-only: never present at runtime. */\n readonly [entryDef]: { def: TDef; kind: TKind; type: 'infinite' };\n}\n\n/** Any query or infinite query entry. */\nexport type AnyTRPCEntry =\n | TRPCQueryEntry<any, any>\n | TRPCInfiniteQueryEntry<any, any>;\n\n/**\n * What `loadHandles()` takes per key: an entry, or TanStack Query's\n * `skipToken` to start nothing for that key.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#conditional-queries\n */\nexport type TRPCLoadEntries = Record<string, AnyTRPCEntry | typeof skipToken>;\n\ntype HandleOfEntry<TEntry> =\n TEntry extends TRPCQueryEntry<infer TDef, any>\n ? TRPCQueryHandle<TDef>\n : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any>\n ? TRPCInfiniteQueryHandle<TDef>\n : TEntry extends typeof skipToken\n ? undefined\n : never;\n\ntype DataOfEntry<TEntry> =\n TEntry extends TRPCQueryEntry<infer TDef, any>\n ? TDef['output']\n : TEntry extends TRPCInfiniteQueryEntry<infer TDef, any>\n ? TRPCInfiniteData<TDef['input'], TDef['output']>\n : never;\n\ntype HandlesOf<TEntries extends TRPCLoadEntries> = {\n [TKey in keyof TEntries]: HandleOfEntry<TEntries[TKey]>;\n};\n\ntype DefOfEntry<TEntry> = TEntry extends {\n readonly [entryDef]: { def: infer TDef extends ResolverDef };\n}\n ? TDef\n : never;\n\n/** Only fetch and ensure entries are waited for, so only they have data */\ntype WaitedKey<TEntries, TKey extends keyof TEntries> = TEntries[TKey] extends {\n readonly [entryDef]: { kind: 'fetch' | 'ensure' };\n}\n ? TKey\n : never;\n\ntype DataOf<TEntries extends TRPCLoadEntries> = {\n [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: DataOfEntry<\n TEntries[TKey]\n >;\n};\n\ntype ResultsOf<TEntries extends TRPCLoadEntries> = {\n [TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: TRPCEntryResult<\n DefOfEntry<TEntries[TKey]>,\n DataOfEntry<TEntries[TKey]>\n >;\n};\n\n/**\n * What `loadHandlesSettled()` has for a fetch or ensure entry: its data, or\n * the error it failed with.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport type TRPCEntryResult<TDef extends ResolverDef, TData> =\n | { readonly status: 'success'; readonly data: TData }\n | { readonly status: 'error'; readonly error: TRPCEntryError<TDef> };\n\n/**\n * What `loadHandles()` resolves to: `[handles, data]`. `handles` has a handle\n * for every entry, by the entry's key, and `undefined` for a `skipToken`; return them\n * from the loader. `data` has the data of every fetch and ensure entry, by the entry's key.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#loader-data\n */\nexport type TRPCLoadedHandles<TEntries extends TRPCLoadEntries> = readonly [\n handles: HandlesOf<TEntries>,\n data: DataOf<TEntries>,\n];\n\n/**\n * What `loadHandlesSettled()` resolves to: `[handles, results]`. `results`\n * has a `TRPCEntryResult` for every fetch and ensure entry, by the entry's key.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport type TRPCSettledHandles<TEntries extends TRPCLoadEntries> = readonly [\n handles: HandlesOf<TEntries>,\n results: ResultsOf<TEntries>,\n];\n\n/** Options for an entry */\nexport interface TRPCEntryOptions\n extends\n Pick<\n FetchQueryOptions,\n 'staleTime' | 'retry' | 'retryDelay' | 'gcTime' | 'meta'\n >,\n TRPCQueryBaseOptions {}\n\ntype HandleGetNextPageParam<TDef extends ResolverDef> =\n GetNextPageParamFunction<\n NonNullable<ExtractCursorType<TDef['input']>> | null,\n TDef['output']\n >;\n\n/**\n * Options for an infinite query entry. Pass `pages` and `getNextPageParam`\n * to load several pages up front.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport type TRPCInfiniteEntryOptions<TDef extends ResolverDef> =\n TRPCEntryOptions & {\n initialCursor?: NonNullable<ExtractCursorType<TDef['input']>> | null;\n } & (\n | {\n pages?: never;\n /**\n * Without it, refetching a cached query with more than one page\n * fails on the second page.\n */\n getNextPageParam?: HandleGetNextPageParam<TDef>;\n }\n | {\n /** Number of pages to load up front */\n pages: number;\n getNextPageParam: HandleGetNextPageParam<TDef>;\n }\n );\n\ntype EntryArgs<TDef extends ResolverDef> = undefined extends TDef['input']\n ? [input?: TDef['input'], opts?: TRPCEntryOptions]\n : [input: TDef['input'], opts?: TRPCEntryOptions];\n\n/**\n * The handle type of a query procedure, for typing props.\n * @example\n * ```ts\n * type PostHandle = inferQueryHandle<TRPC['post']['byId']>;\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#typing-props\n */\nexport type inferQueryHandle<TProcedure extends DecorateQueryProcedure<any>> =\n TProcedure extends DecorateQueryProcedure<infer TDef>\n ? TRPCQueryHandle<TDef>\n : never;\n\n/**\n * The handle type of an infinite query procedure, for typing props.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#typing-props\n */\nexport type inferInfiniteQueryHandle<\n TProcedure extends DecorateInfiniteQueryProcedure<any>,\n> =\n TProcedure extends DecorateInfiniteQueryProcedure<infer TDef>\n ? TRPCInfiniteQueryHandle<TDef>\n : never;\n\nconst notAHandle = 'Expected a tRPC handle from `loadHandles()`';\n\nfunction readHandle(handle: AnyTRPCHandle, prefix: string | undefined) {\n const queryKey = handle?.queryKey as unknown as TRPCQueryKey<any> | undefined;\n if (!Array.isArray(queryKey)) {\n throw new Error(`${notAHandle}, got ${JSON.stringify(handle)}`);\n }\n const data = readQueryKey(queryKey);\n const type = data.args?.type;\n if (type !== 'query' && type !== 'infinite') {\n throw new Error(\n `${notAHandle}, got a key of type ${String(type)} for \"${data.path.join('.')}\"`,\n );\n }\n if ((data.prefix?.[0] ?? undefined) !== prefix) {\n throw new Error(\n `The handle for \"${data.path.join('.')}\" was created with keyPrefix ${JSON.stringify(data.prefix?.[0])}, but this proxy uses ${JSON.stringify(prefix)}`,\n );\n }\n return {\n type,\n path: data.path,\n input: data.args?.input,\n queryKey,\n };\n}\n\ntype HandleType = 'query' | 'infinite';\n\nfunction toHandle(options: any, type: HandleType) {\n const input = readQueryKey(options.queryKey).args?.input;\n // Next.js rejects `undefined` in `getServerSideProps` / `getStaticProps` props\n const handle: Record<string, unknown> = {\n queryKey: options.queryKey,\n ...(input !== undefined && { input }),\n };\n if (type === 'infinite' && options.initialPageParam != null) {\n handle['initialCursor'] = options.initialPageParam;\n }\n return handle;\n}\n\nconst entryState = Symbol('trpc.handleEntry');\n\ninterface EntryState {\n kind: TRPCEntryKind;\n type: HandleType;\n options: any;\n /** The `QueryClient` of the proxy that built the entry */\n queryClient: QueryClient;\n}\n\nfunction createEntry(state: EntryState) {\n return { [entryState]: state };\n}\n\nfunction readEntry(key: string, entry: unknown): EntryState {\n const state = (entry as { [entryState]?: EntryState } | null)?.[entryState];\n if (!state) {\n throw new Error(\n `Expected an entry from \\`prefetchEntry()\\`, \\`fetchEntry()\\` or \\`ensureEntry()\\`, or \\`skipToken\\`, for \"${key}\", got ${JSON.stringify(entry)}`,\n );\n }\n return state;\n}\n\nfunction startEntry(queryClient: QueryClient, state: EntryState) {\n const { options } = state;\n if (state.type === 'infinite') {\n switch (state.kind) {\n case 'prefetch':\n return queryClient.prefetchInfiniteQuery(options);\n case 'ensure':\n return queryClient.ensureInfiniteQueryData({\n ...options,\n revalidateIfStale: true,\n });\n case 'fetch':\n return queryClient.fetchInfiniteQuery(options);\n }\n }\n switch (state.kind) {\n case 'prefetch':\n return queryClient.prefetchQuery(options);\n case 'ensure':\n return queryClient.ensureQueryData({\n ...options,\n revalidateIfStale: true,\n });\n case 'fetch':\n return queryClient.fetchQuery(options);\n }\n}\n\nfunction toEntryError(key: string, state: EntryState, error: unknown) {\n if (isCancelledError(error)) {\n return error;\n }\n return new TRPCEntryError({\n key,\n path: readQueryKey(state.options.queryKey).path.join('.'),\n ...entryCause(error),\n });\n}\n\nfunction settleLoad(promise: Promise<unknown>) {\n return promise.then(\n (data) => ({ status: 'success', data }),\n (error: unknown) => {\n if (error instanceof TRPCEntryError) {\n return { status: 'error', error };\n }\n throw error;\n },\n );\n}\n\nasync function startEntries(opts: {\n queryClient: QueryClient;\n entries: Record<string, unknown>;\n /** Resolve each waited entry to a `TRPCEntryResult` instead of rejecting */\n settle: boolean;\n}) {\n const { queryClient, entries } = opts;\n const states = Object.entries(entries).flatMap(([key, entry]) => {\n if (entry === skipToken) {\n return [];\n }\n const state = readEntry(key, entry);\n if (state.queryClient !== queryClient) {\n throw new Error(\n `The entry for \"${key}\" was built with a proxy for another QueryClient than the root proxy that loads it`,\n );\n }\n return [[key, state] as const];\n });\n const loads = states.map(([key, state]) => ({\n key,\n state,\n promise: startEntry(queryClient, state).catch((error: unknown) => {\n throw toEntryError(key, state, error);\n }),\n }));\n const waited = loads.filter((load) => load.state.kind !== 'prefetch');\n const results = await Promise.all(\n waited.map((load) =>\n opts.settle ? settleLoad(load.promise) : load.promise,\n ),\n );\n\n // A skipped key is absent rather than `undefined`: Next.js rejects `undefined` in props\n const handles = Object.fromEntries(\n loads.map((load) => [\n load.key,\n toHandle(load.state.options, load.state.type),\n ]),\n );\n const data = Object.fromEntries(\n waited.map((load, index) => [load.key, results[index]]),\n );\n return [handles, data] as const;\n}\n\nfunction isServerEnvironment() {\n return typeof window === 'undefined' || 'Deno' in globalThis;\n}\n\nconst warnedNotHydrated = new Set<string>();\n\nfunction warnIfNotHydrated(\n path: readonly string[],\n queryFn: QueryFunction<any, any, any>,\n): QueryFunction<any, any, any> {\n return (context) => {\n if (isServerEnvironment()) {\n const queryHash = hashKey(context.queryKey);\n if (!warnedNotHydrated.has(queryHash)) {\n warnedNotHydrated.add(queryHash);\n // oxlint-disable-next-line no-console\n console.warn(\n `[@trpc/tanstack-react-query] The handle for \"${path.join('.')}\" is being fetched again during server rendering. ` +\n `Unless its data is stale, the query it refers to isn't in this QueryClient. ` +\n `Render the reading component inside <HydrateClient> or <HydrationBoundary>, and don't return handles from server functions or server actions. ` +\n `See https://trpc.io/docs/client/tanstack-react-query/handles#where-handles-dont-work`,\n );\n }\n }\n return queryFn(context);\n };\n}\n\nconst watchedHydrations = new WeakSet<Promise<unknown>>();\n\n/**\n * A query dehydrated as pending that later rejects reaches the browser as a\n * redacted error, before any `retry` from `fromHandle()` applies. Refetch such\n * a query once so error boundaries see a `TRPCClientError` from this client.\n */\nfunction refetchRejectedHydration(\n queryClient: QueryClient,\n type: HandleType,\n options: any,\n) {\n const enabled =\n typeof options.enabled === 'function'\n ? options.enabled\n : () => options.enabled;\n if (isServerEnvironment()) {\n return;\n }\n const query = queryClient\n .getQueryCache()\n .find({ queryKey: options.queryKey, exact: true });\n const promise = query?.promise;\n if (\n !query ||\n !promise ||\n query.state.data !== undefined ||\n query.state.fetchStatus === 'idle' ||\n enabled(query) === false ||\n watchedHydrations.has(promise)\n ) {\n return;\n }\n watchedHydrations.add(promise);\n promise.catch((error: unknown) => {\n if (\n isTRPCClientError(error) ||\n isCancelledError(error) ||\n query.state.fetchStatus !== 'idle' ||\n enabled(query) === false\n ) {\n return;\n }\n const defaulted = queryClient.defaultQueryOptions(options);\n // Older query-core versions take the infinite behavior from the fetch's\n // options, so `query.fetch` would store a bare page there.\n // `fetchInfiniteQuery` skips retries unless asked, unlike a query's fetch\n // in the browser, which retries 3 times by default.\n const refetch =\n type === 'infinite'\n ? queryClient.fetchInfiniteQuery({\n ...options,\n retry: defaulted.retry ?? 3,\n })\n : query.fetch(defaulted);\n refetch.catch(() => {\n // surfaces through the query's state\n });\n });\n}\n\nfunction prepareHandleRead<TOptions extends { queryFn?: unknown }>(opts: {\n queryClient: QueryClient;\n handle: ReturnType<typeof readHandle>;\n options: TOptions;\n}): TOptions {\n const { options } = opts;\n if (\n globalThis.process?.env?.['NODE_ENV'] !== 'production' &&\n typeof options.queryFn === 'function'\n ) {\n options.queryFn = warnIfNotHydrated(\n opts.handle.path,\n options.queryFn as QueryFunction<any, any, any>,\n );\n }\n refetchRejectedHydration(opts.queryClient, opts.handle.type, options);\n return options;\n}\n\ninterface ProxyContext {\n proxy: any;\n path: string[];\n prefix: string | undefined;\n}\n\nfunction readProxy(proxy: unknown, fn: string): ProxyContext {\n const queryKey = (proxy as { queryKey?: unknown } | null)?.queryKey;\n if (Array.isArray(queryKey)) {\n throw new Error(\n `\\`${fn}()\\` expects a tRPC options proxy or one of its procedures, got a handle for \\`${readQueryKey(queryKey as TRPCQueryKey<any>).path.join('.')}\\``,\n );\n }\n if (typeof queryKey !== 'function') {\n throw new Error(\n `\\`${fn}()\\` expects a tRPC options proxy or one of its procedures, got ${String(proxy)}`,\n );\n }\n const key = readQueryKey(queryKey());\n return {\n proxy,\n path: key.path,\n prefix: key.prefix?.[0],\n };\n}\n\nfunction queryClientOf(ctx: ProxyContext): QueryClient {\n return ctx.proxy['~queryClient']();\n}\n\nfunction optionsOf(\n procedure: any,\n type: HandleType,\n): (input: unknown, opts: unknown) => any {\n return type === 'infinite'\n ? procedure.infiniteQueryOptions\n : procedure.queryOptions;\n}\n\nfunction readRoot(trpc: unknown, fn: string) {\n const ctx = readProxy(trpc, fn);\n if (ctx.path.length > 0) {\n throw new Error(\n `\\`${fn}()\\` takes the root proxy, \\`trpc\\`, got \\`trpc.${ctx.path.join('.')}\\``,\n );\n }\n return ctx;\n}\n\nfunction entry(opts: {\n fn: string;\n type: HandleType;\n kind: TRPCEntryKind;\n procedure: unknown;\n input: unknown;\n opts: unknown;\n}) {\n const ctx = readProxy(opts.procedure, opts.fn);\n return createEntry({\n type: opts.type,\n kind: opts.kind,\n options: optionsOf(ctx.proxy, opts.type)(opts.input, opts.opts),\n queryClient: queryClientOf(ctx),\n });\n}\n\n/**\n * Whether `error` is a failed entry from `loadHandles()`. Pass a procedure to\n * check that the entry was for it, which types `error.cause` with its errors.\n * @example\n * ```ts\n * const [handles] = await loadHandles(trpc, {\n * post: ensureEntry(trpc.post.byId, { id }),\n * }).catch((error: unknown) => {\n * if (isTRPCEntryError(error, trpc.post.byId) && error.code === 'NOT_FOUND') {\n * throw notFound();\n * }\n * throw error;\n * });\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-ensure\n */\nexport function isTRPCEntryError<TDef extends ResolverDef>(\n error: unknown,\n procedure: DecorateQueryProcedure<TDef>,\n): error is TRPCEntryError<TDef>;\nexport function isTRPCEntryError(error: unknown): error is TRPCEntryError;\nexport function isTRPCEntryError(error: unknown, procedure?: unknown) {\n if (!(error instanceof TRPCEntryError)) {\n return false;\n }\n return (\n procedure === undefined ||\n error.path === readProxy(procedure, 'isTRPCEntryError').path.join('.')\n );\n}\n\n/**\n * Starts every entry before it waits for any, so the order of the entries doesn't\n * matter. Resolves to `[handles, data]` once every fetch and ensure entry has data:\n * a handle for every entry, and the data of the fetch and ensure entries. Rejects as\n * soon as a fetch or ensure entry fails. Prefetch entries never make it reject.\n *\n * Put TanStack Query's `skipToken` in place of an entry to start nothing for that\n * key: its handle is `undefined`, and `data` has no key for it.\n *\n * Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.\n * Call it in a route loader, a server component or an event handler, not during\n * render: every render would start the entries again.\n * @example\n * ```ts\n * const [handles, data] = await loadHandles(trpc, {\n * comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),\n * post: ensureEntry(trpc.post.byId, { id }),\n * draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,\n * });\n * if (!data.post.published) throw notFound();\n * return handles;\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles\n */\nexport function loadHandles<\n TFeatureFlags extends FeatureFlags,\n TEntries extends TRPCLoadEntries,\n>(\n trpc: DecorateRouterKeyable<TFeatureFlags>,\n entries: TEntries,\n): Promise<TRPCLoadedHandles<TEntries>> {\n return startEntries({\n queryClient: queryClientOf(readRoot(trpc, 'loadHandles')),\n entries,\n settle: false,\n }) as Promise<any>;\n}\n\n/**\n * Like `loadHandles()`, but it waits for every fetch and ensure entry to\n * settle and never rejects because one failed. Resolves to `[handles, results]`:\n * `results` has `{ status: 'success', data }` or `{ status: 'error', error }`,\n * with a `TRPCEntryError`, for every fetch and ensure entry.\n *\n * A cancelled query still rejects, as it does with `loadHandles()`.\n * @example\n * ```ts\n * const [handles, results] = await loadHandlesSettled(trpc, {\n * post: ensureEntry(trpc.post.byId, { id }),\n * comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),\n * });\n * if (results.post.status === 'error') {\n * if (results.post.error.code === 'NOT_FOUND') throw notFound();\n * throw results.post.error;\n * }\n * ```\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values\n */\nexport function loadHandlesSettled<\n TFeatureFlags extends FeatureFlags,\n TEntries extends TRPCLoadEntries,\n>(\n trpc: DecorateRouterKeyable<TFeatureFlags>,\n entries: TEntries,\n): Promise<TRPCSettledHandles<TEntries>> {\n return startEntries({\n queryClient: queryClientOf(readRoot(trpc, 'loadHandlesSettled')),\n entries,\n settle: true,\n }) as Promise<any>;\n}\n\n/**\n * An entry for `loadHandles()` that starts the query without waiting, like\n * `queryClient.prefetchQuery`. It never makes the load reject: errors surface where\n * the handle is read. Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#prefetch\n */\nexport function prefetchEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'prefetch'>;\nexport function prefetchEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'prefetchEntry',\n type: 'query',\n kind: 'prefetch',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * An entry for `loadHandles()` that waits for fresh data, like `queryClient.fetchQuery`:\n * cached data is used only if it isn't stale. The load rejects if the request fails.\n * Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#fetch\n */\nexport function fetchEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'fetch'>;\nexport function fetchEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'fetchEntry',\n type: 'query',\n kind: 'fetch',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * An entry for `loadHandles()` that uses any cached data, even stale, like\n * `queryClient.ensureQueryData({ revalidateIfStale: true })`. It fetches and waits only\n * when the cache has no data, and the load rejects if that request fails. Stale data is\n * refetched in the background. Creating the entry starts nothing.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#ensure\n */\nexport function ensureEntry<TDef extends ResolverDef>(\n procedure: DecorateQueryProcedure<TDef>,\n ...args: EntryArgs<TDef>\n): TRPCQueryEntry<TDef, 'ensure'>;\nexport function ensureEntry(\n procedure: unknown,\n input?: unknown,\n opts?: unknown,\n): unknown {\n return entry({\n fn: 'ensureEntry',\n type: 'query',\n kind: 'ensure',\n procedure,\n input,\n opts,\n });\n}\n\n/**\n * Like `prefetchEntry`, for an infinite query. Loads the first page unless `pages` is set.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function prefetchInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'prefetch'> {\n return entry({\n fn: 'prefetchInfiniteEntry',\n type: 'infinite',\n kind: 'prefetch',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Like `fetchEntry`, for an infinite query.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function fetchInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'fetch'> {\n return entry({\n fn: 'fetchInfiniteEntry',\n type: 'infinite',\n kind: 'fetch',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Like `ensureEntry`, for an infinite query.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#infinite-queries\n */\nexport function ensureInfiniteEntry<TDef extends ResolverDef>(\n procedure: DecorateInfiniteQueryProcedure<TDef>,\n input: TDef['input'],\n opts?: TRPCInfiniteEntryOptions<TDef>,\n): TRPCInfiniteQueryEntry<TDef, 'ensure'> {\n return entry({\n fn: 'ensureInfiniteEntry',\n type: 'infinite',\n kind: 'ensure',\n procedure,\n input,\n opts,\n }) as any;\n}\n\n/**\n * Options for a handle: the same options `trpc.<path>.queryOptions(input)` or\n * `trpc.<path>.infiniteQueryOptions(input, opts)` return for the handle's procedure and\n * input. Pass them to `useQuery`, `useSuspenseQuery`, `useSuspenseInfiniteQuery`, etc.\n * `trpc` is the proxy or a router on the handle's path, usually `useTRPC()`.\n * @see https://trpc.io/docs/client/tanstack-react-query/handles#reading-a-handle\n */\nexport function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(\n trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>,\n handle: TRPCQueryHandle<TDef>,\n opts?: UnusedSkipTokenTRPCQueryOptionsIn<\n NoInfer<TDef['output']>,\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n >,\n): UnusedSkipTokenTRPCQueryOptionsOut<\n TDef['output'],\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n>;\nexport function fromHandle<TDef extends ResolverDef, TData = TDef['output']>(\n trpc: DecorateRouterKeyable<NoInfer<TDef['featureFlags']>>,\n handle: TRPCInfiniteQueryHandle<TDef>,\n opts: UnusedSkipTokenTRPCInfiniteQueryOptionsIn<\n TDef['input'],\n NoInfer<TDef['output']>,\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n >,\n): UnusedSkipTokenTRPCInfiniteQueryOptionsOut<\n TDef['input'],\n TDef['output'],\n TData,\n ErrorOf<TDef>,\n TDef['featureFlags']\n>;\nexport function fromHandle(\n trpc: unknown,\n rawHandle: AnyTRPCHandle,\n opts?: object,\n): unknown {\n const ctx = readProxy(trpc, 'fromHandle');\n const handle = readHandle(rawHandle, ctx.prefix);\n if (!ctx.path.every((segment, index) => handle.path[index] === segment)) {\n throw new Error(\n `\\`fromHandle(trpc.${ctx.path.join('.')}, handle)\\` got a handle for \\`${handle.path.join('.')}\\`, which isn't in \\`${ctx.path.join('.')}\\`. Pass the root proxy, \\`trpc\\``,\n );\n }\n const procedure = handle.path\n .slice(ctx.path.length)\n .reduce((level, segment) => level[segment], ctx.proxy);\n const options = optionsOf(procedure, handle.type)(\n handle.input,\n handle.type === 'infinite'\n ? {\n initialCursor: (rawHandle as TRPCInfiniteQueryHandle).initialCursor,\n ...opts,\n }\n : opts,\n );\n return prepareHandleRead({\n queryClient: queryClientOf(ctx),\n handle,\n options,\n });\n}\n"],"mappings":";;;;;;;;;;AAgBA,IAAa,iBAAb,cAEU,MAAM;CAed,YAAY,MAKT;EACD,MAAM,UAAU,KAAK,IAAI,KAAK,KAAK,KAAK,YAAY,KAAK,MAAM,SAAS;EAnBjE,gBAAA,MAAA,OAAA,KAAA,CAAA;EAEA,gBAAA,MAAA,QAAA,KAAA,CAAA;EAEA,gBAAA,MAAA,QAAA,KAAA,CAAA;EAOgB,gBAAA,MAAA,SAAA,KAAA,CAAA;EASvB,KAAK,OAAO;EACZ,KAAK,QAAQ,KAAK;EAClB,KAAK,MAAM,KAAK;EAChB,KAAK,OAAO,KAAK;EACjB,KAAK,OAAO,KAAK;CACnB;AACF;AAEA,SAAS,YAAY,MAAgD;CACnE,MAAM,OAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAQ,KAAgD;CAC9D,OAAO,OAAO,SAAS,WAAY,OAA+B,KAAA;AACpE;AAEA,SAAgB,WAAW,OAAgB;CACzC,IAAI,kBAAkB,KAAK,GACzB,OAAO;EAAE,OAAO;EAAO,MAAM,YAAY,MAAM,IAAI;CAAE;CAEvD,MAAM,QAAQ,wBAAwB,KAAK;CAC3C,OAAO;EAAE;EAAO,MAAM,MAAM;CAAK;AACnC;;AC2NA,MAAM,aAAa;AAEnB,SAAS,WAAW,QAAuB,QAA4B;;CACrE,MAAM,WAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAW,OAAQ;CACzB,IAAI,CAAC,MAAM,QAAQ,QAAQ,GACzB,MAAM,IAAI,MAAM,GAAG,WAAW,QAAQ,KAAK,UAAU,MAAM,GAAG;CAEhE,MAAM,OAAO,aAAa,QAAQ;CAClC,MAAM,QAAA,aAAO,KAAK,UAAA,QAAA,eAAA,KAAA,IAAA,KAAA,IAAA,WAAM;CACxB,IAAI,SAAS,WAAW,SAAS,YAC/B,MAAM,IAAI,MACR,GAAG,WAAW,sBAAsB,OAAO,IAAI,EAAE,QAAQ,KAAK,KAAK,KAAK,GAAG,EAAE,EAC/E;CAEF,MAAA,iBAAA,eAAK,KAAK,YAAA,QAAA,iBAAA,KAAA,IAAA,KAAA,IAAA,aAAS,QAAA,QAAA,kBAAA,KAAA,IAAA,gBAAM,KAAA,OAAe,QAAQ;;EAC9C,MAAM,IAAI,MACR,mBAAmB,KAAK,KAAK,KAAK,GAAG,EAAE,+BAA+B,KAAK,WAAA,gBAAU,KAAK,YAAA,QAAA,kBAAA,KAAA,IAAA,KAAA,IAAA,cAAS,EAAE,EAAE,wBAAwB,KAAK,UAAU,MAAM,GACtJ;CACF;CACA,OAAO;EACL;EACA,MAAM,KAAK;EACX,QAAA,cAAO,KAAK,UAAA,QAAA,gBAAA,KAAA,IAAA,KAAA,IAAA,YAAM;EAClB;CACF;AACF;AAIA,SAAS,SAAS,SAAc,MAAkB;;CAChD,MAAM,SAAA,qBAAQ,aAAa,QAAQ,QAAQ,CAAC,CAAC,UAAA,QAAA,uBAAA,KAAA,IAAA,KAAA,IAAA,mBAAM;CAEnD,MAAM,SAAA,eAAA,EACJ,UAAU,QAAQ,SAAA,GACd,UAAU,KAAA,KAAa,EAAE,MAAM,CACrC;CACA,IAAI,SAAS,cAAc,QAAQ,oBAAoB,MACrD,OAAO,mBAAmB,QAAQ;CAEpC,OAAO;AACT;AAEA,MAAM,aAAa,OAAO,kBAAkB;AAU5C,SAAS,YAAY,OAAmB;CACtC,OAAO,GAAG,aAAa,MAAM;AAC/B;AAEA,SAAS,UAAU,KAAa,OAA4B;CAC1D,MAAM,QAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAS,MAAiD;CAChE,IAAI,CAAC,OACH,MAAM,IAAI,MACR,6GAA6G,IAAI,SAAS,KAAK,UAAU,KAAK,GAChJ;CAEF,OAAO;AACT;AAEA,SAAS,WAAW,aAA0B,OAAmB;CAC/D,MAAM,EAAE,YAAY;CACpB,IAAI,MAAM,SAAS,YACjB,QAAQ,MAAM,MAAd;EACE,KAAK,YACH,OAAO,YAAY,sBAAsB,OAAO;EAClD,KAAK,UACH,OAAO,YAAY,wBAAA,eAAA,eAAA,CAAA,GACd,OAAA,GAAA,CAAA,GAAA,EACH,mBAAmB,KAAA,CACrB,CAAC;EACH,KAAK,SACH,OAAO,YAAY,mBAAmB,OAAO;CACjD;CAEF,QAAQ,MAAM,MAAd;EACE,KAAK,YACH,OAAO,YAAY,cAAc,OAAO;EAC1C,KAAK,UACH,OAAO,YAAY,gBAAA,eAAA,eAAA,CAAA,GACd,OAAA,GAAA,CAAA,GAAA,EACH,mBAAmB,KAAA,CACrB,CAAC;EACH,KAAK,SACH,OAAO,YAAY,WAAW,OAAO;CACzC;AACF;AAEA,SAAS,aAAa,KAAa,OAAmB,OAAgB;CACpE,IAAI,iBAAiB,KAAK,GACxB,OAAO;CAET,OAAO,IAAI,eAAA,eAAA;EACT;EACA,MAAM,aAAa,MAAM,QAAQ,QAAQ,CAAC,CAAC,KAAK,KAAK,GAAG;CACrD,GAAA,WAAW,KAAK,CACrB,CAAC;AACH;AAEA,SAAS,WAAW,SAA2B;CAC7C,OAAO,QAAQ,MACZ,UAAU;EAAE,QAAQ;EAAW;CAAK,KACpC,UAAmB;EAClB,IAAI,iBAAiB,gBACnB,OAAO;GAAE,QAAQ;GAAS;EAAM;EAElC,MAAM;CACR,CACF;AACF;AAEA,eAAe,aAAa,MAKzB;CACD,MAAM,EAAE,aAAa,YAAY;CAajC,MAAM,QAZS,OAAO,QAAQ,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EAC/D,IAAI,UAAU,WACZ,OAAO,CAAC;EAEV,MAAM,QAAQ,UAAU,KAAK,KAAK;EAClC,IAAI,MAAM,gBAAgB,aACxB,MAAM,IAAI,MACR,kBAAkB,IAAI,mFACxB;EAEF,OAAO,CAAC,CAAC,KAAK,KAAK,CAAU;CAC/B,CACmB,CAAC,CAAC,KAAK,CAAC,KAAK,YAAY;EAC1C;EACA;EACA,SAAS,WAAW,aAAa,KAAK,CAAC,CAAC,OAAO,UAAmB;GAChE,MAAM,aAAa,KAAK,OAAO,KAAK;EACtC,CAAC;CACH,EAAE;CACF,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,MAAM,SAAS,UAAU;CACpE,MAAM,UAAU,MAAM,QAAQ,IAC5B,OAAO,KAAK,SACV,KAAK,SAAS,WAAW,KAAK,OAAO,IAAI,KAAK,OAChD,CACF;CAYA,OAAO,CATS,OAAO,YACrB,MAAM,KAAK,SAAS,CAClB,KAAK,KACL,SAAS,KAAK,MAAM,SAAS,KAAK,MAAM,IAAI,CAC9C,CAAC,CAKW,GAHD,OAAO,YAClB,OAAO,KAAK,MAAM,UAAU,CAAC,KAAK,KAAK,QAAQ,MAAM,CAAC,CAEpC,CAAC;AACvB;AAEA,SAAS,sBAAsB;CAC7B,OAAO,OAAO,WAAW,eAAe,UAAU;AACpD;AAEA,MAAM,oCAAoB,IAAI,IAAY;AAE1C,SAAS,kBACP,MACA,SAC8B;CAC9B,QAAQ,YAAY;EAClB,IAAI,oBAAoB,GAAG;GACzB,MAAM,YAAY,QAAQ,QAAQ,QAAQ;GAC1C,IAAI,CAAC,kBAAkB,IAAI,SAAS,GAAG;IACrC,kBAAkB,IAAI,SAAS;IAE/B,QAAQ,KACN,gDAAgD,KAAK,KAAK,GAAG,EAAE,iWAIjE;GACF;EACF;EACA,OAAO,QAAQ,OAAO;CACxB;AACF;AAEA,MAAM,oCAAoB,IAAI,QAA0B;;;;;;AAOxD,SAAS,yBACP,aACA,MACA,SACA;CACA,MAAM,UACJ,OAAO,QAAQ,YAAY,aACvB,QAAQ,gBACF,QAAQ;CACpB,IAAI,oBAAoB,GACtB;CAEF,MAAM,QAAQ,YACX,cAAc,CAAC,CACf,KAAK;EAAE,UAAU,QAAQ;EAAU,OAAO;CAAK,CAAC;CACnD,MAAM,UAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAU,MAAO;CACvB,IACE,CAAC,SACD,CAAC,WACD,MAAM,MAAM,SAAS,KAAA,KACrB,MAAM,MAAM,gBAAgB,UAC5B,QAAQ,KAAK,MAAM,SACnB,kBAAkB,IAAI,OAAO,GAE7B;CAEF,kBAAkB,IAAI,OAAO;CAC7B,QAAQ,OAAO,UAAmB;;EAChC,IACE,kBAAkB,KAAK,KACvB,iBAAiB,KAAK,KACtB,MAAM,MAAM,gBAAgB,UAC5B,QAAQ,KAAK,MAAM,OAEnB;EAEF,MAAM,YAAY,YAAY,oBAAoB,OAAO;EAYzD,CANE,SAAS,aACL,YAAY,mBAAA,eAAA,eAAA,CAAA,GACP,OAAA,GAAA,CAAA,GAAA,EACH,QAAA,mBAAO,UAAU,WAAA,QAAA,qBAAA,KAAA,IAAA,mBAAS,EAAA,CAC5B,CAAC,IACD,MAAM,MAAM,SAAS,EAAA,CACnB,YAAY,CAEpB,CAAC;CACH,CAAC;AACH;AAEA,SAAS,kBAA0D,MAItD;;CACX,MAAM,EAAE,YAAY;CACpB,MAAA,sBACE,WAAW,aAAA,QAAA,wBAAA,KAAA,MAAA,sBAAA,oBAAS,SAAA,QAAA,wBAAA,KAAA,IAAA,KAAA,IAAA,oBAAM,iBAAgB,gBAC1C,OAAO,QAAQ,YAAY,YAE3B,QAAQ,UAAU,kBAChB,KAAK,OAAO,MACZ,QAAQ,OACV;CAEF,yBAAyB,KAAK,aAAa,KAAK,OAAO,MAAM,OAAO;CACpE,OAAO;AACT;AAQA,SAAS,UAAU,OAAgB,IAA0B;;CAC3D,MAAM,WAAA,UAAA,QAAA,UAAA,KAAA,IAAA,KAAA,IAAY,MAAyC;CAC3D,IAAI,MAAM,QAAQ,QAAQ,GACxB,MAAM,IAAI,MACR,KAAK,GAAG,iFAAiF,aAAa,QAA6B,CAAC,CAAC,KAAK,KAAK,GAAG,EAAE,GACtJ;CAEF,IAAI,OAAO,aAAa,YACtB,MAAM,IAAI,MACR,KAAK,GAAG,kEAAkE,OAAO,KAAK,GACxF;CAEF,MAAM,MAAM,aAAa,SAAS,CAAC;CACnC,OAAO;EACL;EACA,MAAM,IAAI;EACV,SAAA,cAAQ,IAAI,YAAA,QAAA,gBAAA,KAAA,IAAA,KAAA,IAAA,YAAS;CACvB;AACF;AAEA,SAAS,cAAc,KAAgC;CACrD,OAAO,IAAI,MAAM,eAAe,CAAC;AACnC;AAEA,SAAS,UACP,WACA,MACwC;CACxC,OAAO,SAAS,aACZ,UAAU,uBACV,UAAU;AAChB;AAEA,SAAS,SAAS,MAAe,IAAY;CAC3C,MAAM,MAAM,UAAU,MAAM,EAAE;CAC9B,IAAI,IAAI,KAAK,SAAS,GACpB,MAAM,IAAI,MACR,KAAK,GAAG,kDAAkD,IAAI,KAAK,KAAK,GAAG,EAAE,GAC/E;CAEF,OAAO;AACT;AAEA,SAAS,MAAM,MAOZ;CACD,MAAM,MAAM,UAAU,KAAK,WAAW,KAAK,EAAE;CAC7C,OAAO,YAAY;EACjB,MAAM,KAAK;EACX,MAAM,KAAK;EACX,SAAS,UAAU,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,KAAK,OAAO,KAAK,IAAI;EAC9D,aAAa,cAAc,GAAG;CAChC,CAAC;AACH;AAuBA,SAAgB,iBAAiB,OAAgB,WAAqB;CACpE,IAAI,EAAE,iBAAiB,iBACrB,OAAO;CAET,OACE,cAAc,KAAA,KACd,MAAM,SAAS,UAAU,WAAW,kBAAkB,CAAC,CAAC,KAAK,KAAK,GAAG;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAgB,YAId,MACA,SACsC;CACtC,OAAO,aAAa;EAClB,aAAa,cAAc,SAAS,MAAM,aAAa,CAAC;EACxD;EACA,QAAQ;CACV,CAAC;AACH;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,mBAId,MACA,SACuC;CACvC,OAAO,aAAa;EAClB,aAAa,cAAc,SAAS,MAAM,oBAAoB,CAAC;EAC/D;EACA,QAAQ;CACV,CAAC;AACH;AAYA,SAAgB,cACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAYA,SAAgB,WACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAaA,SAAgB,YACd,WACA,OACA,MACS;CACT,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,sBACd,WACA,OACA,MAC0C;CAC1C,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,mBACd,WACA,OACA,MACuC;CACvC,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;;;;;AAMA,SAAgB,oBACd,WACA,OACA,MACwC;CACxC,OAAO,MAAM;EACX,IAAI;EACJ,MAAM;EACN,MAAM;EACN;EACA;EACA;CACF,CAAC;AACH;AAyCA,SAAgB,WACd,MACA,WACA,MACS;CACT,MAAM,MAAM,UAAU,MAAM,YAAY;CACxC,MAAM,SAAS,WAAW,WAAW,IAAI,MAAM;CAC/C,IAAI,CAAC,IAAI,KAAK,OAAO,SAAS,UAAU,OAAO,KAAK,WAAW,OAAO,GACpE,MAAM,IAAI,MACR,qBAAqB,IAAI,KAAK,KAAK,GAAG,EAAE,iCAAiC,OAAO,KAAK,KAAK,GAAG,EAAE,uBAAuB,IAAI,KAAK,KAAK,GAAG,EAAE,kCAC3I;CAKF,MAAM,UAAU,UAHE,OAAO,KACtB,MAAM,IAAI,KAAK,MAAM,CAAC,CACtB,QAAQ,OAAO,YAAY,MAAM,UAAU,IAAI,KAChB,GAAG,OAAO,IAAI,CAAC,CAC/C,OAAO,OACP,OAAO,SAAS,aAAA,eAAA,EAEV,eAAgB,UAAsC,cAAA,GACnD,IACL,IACA,IACN;CACA,OAAO,kBAAkB;EACvB,aAAa,cAAc,GAAG;EAC9B;EACA;CACF,CAAC;AACH"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trpc/tanstack-react-query",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "11.25.3-canary.
|
|
4
|
+
"version": "11.25.3-canary.16.g524856b27",
|
|
5
5
|
"description": "TanStack React Query Integration for tRPC",
|
|
6
6
|
"author": "juliusmarminge",
|
|
7
7
|
"license": "MIT",
|
|
@@ -59,16 +59,16 @@
|
|
|
59
59
|
],
|
|
60
60
|
"peerDependencies": {
|
|
61
61
|
"@tanstack/react-query": "^5.80.3",
|
|
62
|
-
"@trpc/client": "11.25.3-canary.
|
|
63
|
-
"@trpc/server": "11.25.3-canary.
|
|
62
|
+
"@trpc/client": "11.25.3-canary.16.g524856b27",
|
|
63
|
+
"@trpc/server": "11.25.3-canary.16.g524856b27",
|
|
64
64
|
"react": ">=18.2.0",
|
|
65
65
|
"typescript": ">=5.7.2"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
68
|
"@tanstack/intent": "0.5.6",
|
|
69
69
|
"@tanstack/react-query": "^5.107.1",
|
|
70
|
-
"@trpc/client": "11.25.3-canary.
|
|
71
|
-
"@trpc/server": "11.25.3-canary.
|
|
70
|
+
"@trpc/client": "11.25.3-canary.16.g524856b27",
|
|
71
|
+
"@trpc/server": "11.25.3-canary.16.g524856b27",
|
|
72
72
|
"@types/node": "^24.19.2",
|
|
73
73
|
"@types/react": "^19.3.0",
|
|
74
74
|
"event-source-polyfill": "^1.0.31",
|
|
@@ -8,7 +8,7 @@ sources:
|
|
|
8
8
|
metadata:
|
|
9
9
|
type: lifecycle
|
|
10
10
|
library: trpc
|
|
11
|
-
library_version: 11.25.3-canary.
|
|
11
|
+
library_version: 11.25.3-canary.16.g524856b27
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
<!-- Generated from www/v11/docs/client/tanstack-react-query/migrating.md by www/build/skills.ts. Edit the docs instead. -->
|
|
@@ -11,7 +11,7 @@ sources:
|
|
|
11
11
|
metadata:
|
|
12
12
|
type: framework
|
|
13
13
|
library: trpc
|
|
14
|
-
library_version: 11.25.3-canary.
|
|
14
|
+
library_version: 11.25.3-canary.16.g524856b27
|
|
15
15
|
---
|
|
16
16
|
|
|
17
17
|
<!-- Generated from www/v11/docs/client/tanstack-react-query/setup.md by www/build/skills.ts. Edit the docs instead. -->
|
|
@@ -4,7 +4,7 @@ import type {
|
|
|
4
4
|
QueryClient,
|
|
5
5
|
QueryFunction,
|
|
6
6
|
} from '@tanstack/react-query';
|
|
7
|
-
import { hashKey, isCancelledError } from '@tanstack/react-query';
|
|
7
|
+
import { hashKey, isCancelledError, skipToken } from '@tanstack/react-query';
|
|
8
8
|
import { isTRPCClientError } from '@trpc/client';
|
|
9
9
|
import type {
|
|
10
10
|
DecorateInfiniteQueryProcedure,
|
|
@@ -126,12 +126,21 @@ export type AnyTRPCEntry =
|
|
|
126
126
|
| TRPCQueryEntry<any, any>
|
|
127
127
|
| TRPCInfiniteQueryEntry<any, any>;
|
|
128
128
|
|
|
129
|
+
/**
|
|
130
|
+
* What `loadHandles()` takes per key: an entry, or TanStack Query's
|
|
131
|
+
* `skipToken` to start nothing for that key.
|
|
132
|
+
* @see https://trpc.io/docs/client/tanstack-react-query/handles#conditional-queries
|
|
133
|
+
*/
|
|
134
|
+
export type TRPCLoadEntries = Record<string, AnyTRPCEntry | typeof skipToken>;
|
|
135
|
+
|
|
129
136
|
type HandleOfEntry<TEntry> =
|
|
130
137
|
TEntry extends TRPCQueryEntry<infer TDef, any>
|
|
131
138
|
? TRPCQueryHandle<TDef>
|
|
132
139
|
: TEntry extends TRPCInfiniteQueryEntry<infer TDef, any>
|
|
133
140
|
? TRPCInfiniteQueryHandle<TDef>
|
|
134
|
-
:
|
|
141
|
+
: TEntry extends typeof skipToken
|
|
142
|
+
? undefined
|
|
143
|
+
: never;
|
|
135
144
|
|
|
136
145
|
type DataOfEntry<TEntry> =
|
|
137
146
|
TEntry extends TRPCQueryEntry<infer TDef, any>
|
|
@@ -140,7 +149,7 @@ type DataOfEntry<TEntry> =
|
|
|
140
149
|
? TRPCInfiniteData<TDef['input'], TDef['output']>
|
|
141
150
|
: never;
|
|
142
151
|
|
|
143
|
-
type HandlesOf<TEntries extends
|
|
152
|
+
type HandlesOf<TEntries extends TRPCLoadEntries> = {
|
|
144
153
|
[TKey in keyof TEntries]: HandleOfEntry<TEntries[TKey]>;
|
|
145
154
|
};
|
|
146
155
|
|
|
@@ -157,13 +166,13 @@ type WaitedKey<TEntries, TKey extends keyof TEntries> = TEntries[TKey] extends {
|
|
|
157
166
|
? TKey
|
|
158
167
|
: never;
|
|
159
168
|
|
|
160
|
-
type DataOf<TEntries extends
|
|
169
|
+
type DataOf<TEntries extends TRPCLoadEntries> = {
|
|
161
170
|
[TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: DataOfEntry<
|
|
162
171
|
TEntries[TKey]
|
|
163
172
|
>;
|
|
164
173
|
};
|
|
165
174
|
|
|
166
|
-
type ResultsOf<TEntries extends
|
|
175
|
+
type ResultsOf<TEntries extends TRPCLoadEntries> = {
|
|
167
176
|
[TKey in keyof TEntries as WaitedKey<TEntries, TKey>]: TRPCEntryResult<
|
|
168
177
|
DefOfEntry<TEntries[TKey]>,
|
|
169
178
|
DataOfEntry<TEntries[TKey]>
|
|
@@ -181,20 +190,24 @@ export type TRPCEntryResult<TDef extends ResolverDef, TData> =
|
|
|
181
190
|
|
|
182
191
|
/**
|
|
183
192
|
* What `loadHandles()` resolves to: `[handles, data]`. `handles` has a handle
|
|
184
|
-
* for every entry, by the entry's key
|
|
185
|
-
* every fetch and ensure entry, by the entry's key.
|
|
193
|
+
* for every entry, by the entry's key, and `undefined` for a `skipToken`; return them
|
|
194
|
+
* from the loader. `data` has the data of every fetch and ensure entry, by the entry's key.
|
|
186
195
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#loader-data
|
|
187
196
|
*/
|
|
188
|
-
export type TRPCLoadedHandles<TEntries extends
|
|
189
|
-
|
|
197
|
+
export type TRPCLoadedHandles<TEntries extends TRPCLoadEntries> = readonly [
|
|
198
|
+
handles: HandlesOf<TEntries>,
|
|
199
|
+
data: DataOf<TEntries>,
|
|
200
|
+
];
|
|
190
201
|
|
|
191
202
|
/**
|
|
192
203
|
* What `loadHandlesSettled()` resolves to: `[handles, results]`. `results`
|
|
193
204
|
* has a `TRPCEntryResult` for every fetch and ensure entry, by the entry's key.
|
|
194
205
|
* @see https://trpc.io/docs/client/tanstack-react-query/handles#errors-as-values
|
|
195
206
|
*/
|
|
196
|
-
export type TRPCSettledHandles<TEntries extends
|
|
197
|
-
|
|
207
|
+
export type TRPCSettledHandles<TEntries extends TRPCLoadEntries> = readonly [
|
|
208
|
+
handles: HandlesOf<TEntries>,
|
|
209
|
+
results: ResultsOf<TEntries>,
|
|
210
|
+
];
|
|
198
211
|
|
|
199
212
|
/** Options for an entry */
|
|
200
213
|
export interface TRPCEntryOptions
|
|
@@ -323,7 +336,7 @@ function readEntry(key: string, entry: unknown): EntryState {
|
|
|
323
336
|
const state = (entry as { [entryState]?: EntryState } | null)?.[entryState];
|
|
324
337
|
if (!state) {
|
|
325
338
|
throw new Error(
|
|
326
|
-
`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\` for "${key}", got ${JSON.stringify(entry)}`,
|
|
339
|
+
`Expected an entry from \`prefetchEntry()\`, \`fetchEntry()\` or \`ensureEntry()\`, or \`skipToken\`, for "${key}", got ${JSON.stringify(entry)}`,
|
|
327
340
|
);
|
|
328
341
|
}
|
|
329
342
|
return state;
|
|
@@ -387,14 +400,17 @@ async function startEntries(opts: {
|
|
|
387
400
|
settle: boolean;
|
|
388
401
|
}) {
|
|
389
402
|
const { queryClient, entries } = opts;
|
|
390
|
-
const states = Object.entries(entries).
|
|
403
|
+
const states = Object.entries(entries).flatMap(([key, entry]) => {
|
|
404
|
+
if (entry === skipToken) {
|
|
405
|
+
return [];
|
|
406
|
+
}
|
|
391
407
|
const state = readEntry(key, entry);
|
|
392
408
|
if (state.queryClient !== queryClient) {
|
|
393
409
|
throw new Error(
|
|
394
410
|
`The entry for "${key}" was built with a proxy for another QueryClient than the root proxy that loads it`,
|
|
395
411
|
);
|
|
396
412
|
}
|
|
397
|
-
return [key, state] as const;
|
|
413
|
+
return [[key, state] as const];
|
|
398
414
|
});
|
|
399
415
|
const loads = states.map(([key, state]) => ({
|
|
400
416
|
key,
|
|
@@ -410,6 +426,7 @@ async function startEntries(opts: {
|
|
|
410
426
|
),
|
|
411
427
|
);
|
|
412
428
|
|
|
429
|
+
// A skipped key is absent rather than `undefined`: Next.js rejects `undefined` in props
|
|
413
430
|
const handles = Object.fromEntries(
|
|
414
431
|
loads.map((load) => [
|
|
415
432
|
load.key,
|
|
@@ -633,6 +650,9 @@ export function isTRPCEntryError(error: unknown, procedure?: unknown) {
|
|
|
633
650
|
* a handle for every entry, and the data of the fetch and ensure entries. Rejects as
|
|
634
651
|
* soon as a fetch or ensure entry fails. Prefetch entries never make it reject.
|
|
635
652
|
*
|
|
653
|
+
* Put TanStack Query's `skipToken` in place of an entry to start nothing for that
|
|
654
|
+
* key: its handle is `undefined`, and `data` has no key for it.
|
|
655
|
+
*
|
|
636
656
|
* Takes the root of an options proxy, from `createTRPCOptionsProxy` or `useTRPC()`.
|
|
637
657
|
* Call it in a route loader, a server component or an event handler, not during
|
|
638
658
|
* render: every render would start the entries again.
|
|
@@ -641,6 +661,7 @@ export function isTRPCEntryError(error: unknown, procedure?: unknown) {
|
|
|
641
661
|
* const [handles, data] = await loadHandles(trpc, {
|
|
642
662
|
* comments: prefetchInfiniteEntry(trpc.post.comments, { postId: id }),
|
|
643
663
|
* post: ensureEntry(trpc.post.byId, { id }),
|
|
664
|
+
* draft: viewer.isAdmin ? prefetchEntry(trpc.post.draftById, { id }) : skipToken,
|
|
644
665
|
* });
|
|
645
666
|
* if (!data.post.published) throw notFound();
|
|
646
667
|
* return handles;
|
|
@@ -649,7 +670,7 @@ export function isTRPCEntryError(error: unknown, procedure?: unknown) {
|
|
|
649
670
|
*/
|
|
650
671
|
export function loadHandles<
|
|
651
672
|
TFeatureFlags extends FeatureFlags,
|
|
652
|
-
TEntries extends
|
|
673
|
+
TEntries extends TRPCLoadEntries,
|
|
653
674
|
>(
|
|
654
675
|
trpc: DecorateRouterKeyable<TFeatureFlags>,
|
|
655
676
|
entries: TEntries,
|
|
@@ -683,7 +704,7 @@ export function loadHandles<
|
|
|
683
704
|
*/
|
|
684
705
|
export function loadHandlesSettled<
|
|
685
706
|
TFeatureFlags extends FeatureFlags,
|
|
686
|
-
TEntries extends
|
|
707
|
+
TEntries extends TRPCLoadEntries,
|
|
687
708
|
>(
|
|
688
709
|
trpc: DecorateRouterKeyable<TFeatureFlags>,
|
|
689
710
|
entries: TEntries,
|