Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

serverRoute.ts

474 lines10.1 KB

1import type {
2 AnyContext,
3 AnyRoute,
4 Assign,
5 Constrain,
6 Expand,
7 ResolveParams,
8 UnionToIntersection,
9} from '@tanstack/router-core'
10import type {
11 AnyRequestMiddleware,
12 AssignAllServerRequestContext,
13} from './createMiddleware'
14​
15declare module '@tanstack/router-core' {
16 interface FilebaseRouteOptionsInterface<
17 TRegister,
18 TParentRoute extends AnyRoute = AnyRoute,
19 TId extends string = string,
20 TPath extends string = string,
21 TSearchValidator = undefined,
22 TParams = {},
23 TLoaderDeps extends Record<string, any> = {},
24 TLoaderFn = undefined,
25 TRouterContext = {},
26 TRouteContextFn = AnyContext,
27 TBeforeLoadFn = AnyContext,
28 TRemountDepsFn = AnyContext,
29 TSSR = unknown,
30 TServerMiddlewares = unknown,
31 THandlers = undefined,
32 > {
33 server?: RouteServerOptions<
34 TRegister,
35 AnyRoute,
36 TPath,
37 TParams,
38 TLoaderDeps,
39 TLoaderFn,
40 TRouterContext,
41 TRouteContextFn,
42 TBeforeLoadFn,
43 TServerMiddlewares,
44 THandlers
45 >
46 }
47​
48 interface RouteTypes<
49 in out TRegister,
50 in out TParentRoute extends AnyRoute,
51 in out TPath extends string,
52 in out TFullPath extends string,
53 in out TCustomId extends string,
54 in out TId extends string,
55 in out TSearchValidator,
56 in out TParams,
57 in out TRouterContext,
58 in out TRouteContextFn,
59 in out TBeforeLoadFn,
60 in out TLoaderDeps,
61 in out TLoaderFn,
62 in out TChildren,
63 in out TFileRouteTypes,
64 in out TSSR,
65 in out TServerMiddlewares,
66 in out THandlers,
67 > {
68 middleware: TServerMiddlewares
69 allServerContext: ResolveAllServerContext<
70 TRegister,
71 TParentRoute,
72 TServerMiddlewares
73 >
74 }
75​
76 interface BeforeLoadContextOptions<
77 in out TRegister,
78 in out TParentRoute extends AnyRoute,
79 in out TSearchValidator,
80 in out TParams,
81 in out TRouterContext,
82 in out TRouteContextFn,
83 in out TServerMiddlewares,
84 in out THandlers,
85 > {
86 serverContext?: Expand<
87 Assign<
88 ResolveAllServerContext<TRegister, TParentRoute, TServerMiddlewares>,
89 ExtractHandlersContext<THandlers>
90 >
91 >
92 }
93​
94 interface LoaderFnContext<
95 in out TRegister,
96 in out TParentRoute extends AnyRoute = AnyRoute,
97 in out TId extends string = string,
98 in out TParams = {},
99 in out TLoaderDeps = {},
100 in out TRouterContext = {},
101 in out TRouteContextFn = AnyContext,
102 in out TBeforeLoadFn = AnyContext,
103 in out TServerMiddlewares = unknown,
104 in out THandlers = undefined,
105 > {
106 serverContext?: Expand<
107 Assign<
108 ResolveAllServerContext<TRegister, TParentRoute, TServerMiddlewares>,
109 ExtractHandlersContext<THandlers>
110 >
111 >
112 }
114​
115type ExtractHandlersContext<THandlers> = THandlers extends (
116 ...args: any
117) => CustomHandlerFunctionsRecord<any, any, any, any, any, infer TServerContext>
118 ? UnionToIntersection<TServerContext>
119 : THandlers extends Record<
120 string,
121 RouteMethodHandler<any, any, any, any, any, infer TServerContext>
122 >
123 ? UnionToIntersection<TServerContext>
124 : undefined
125​
126export interface RouteServerOptions<
127 TRegister,
128 TParentRoute extends AnyRoute,
129 TPath extends string,
130 TParams,
131 TLoaderDeps,
132 TLoaderFn,
133 TRouterContext,
134 TRouteContextFn,
135 TBeforeLoadFn,
136 TServerMiddlewares,
137 THandlers,
138> {
139 middleware?: Constrain<
140 TServerMiddlewares,
141 ReadonlyArray<AnyRequestMiddleware>
142 >
143​
144 handlers?: Constrain<
145 THandlers,
146 | Partial<
147 Record<
148 RouteMethod,
149 RouteMethodHandlerFn<
150 TRegister,
151 TParentRoute,
152 TPath,
153 TServerMiddlewares,
154 any,
155 any
156 >
157 >
158 >
159 | ((
160 opts: HandlersFnOpts<
161 TRegister,
162 TParentRoute,
163 TPath,
164 TServerMiddlewares
165 >,
166 ) => CustomHandlerFunctionsRecord<
167 TRegister,
168 TParentRoute,
169 TPath,
170 TServerMiddlewares,
171 any,
172 any
173 >)
174 >
175 test?: (test: Expand<ExtractHandlersContext<THandlers>>) => void
177​
178declare const createHandlersSymbol: unique symbol
179​
180type CustomHandlerFunctionsRecord<
181 TRegister,
182 TParentRoute extends AnyRoute,
183 TPath extends string,
184 TServerMiddlewares,
185 TMethodMiddlewares,
186 TServerContext,
187> = {
188 [createHandlersSymbol]: true
189} & Partial<
190 Record<
191 RouteMethod,
192 RouteMethodHandler<
193 TRegister,
194 TParentRoute,
195 TPath,
196 TServerMiddlewares,
197 TMethodMiddlewares,
198 TServerContext
199 >
200 >
202​
203export interface HandlersFnOpts<
204 TRegister,
205 TParentRoute extends AnyRoute,
206 TPath extends string,
207 TServerMiddlewares,
208> {
209 createHandlers: CreateHandlersFn<
210 TRegister,
211 TParentRoute,
212 TPath,
213 TServerMiddlewares
214 >
216​
217export type CreateHandlersFn<
218 TRegister,
219 TParentRoute extends AnyRoute,
220 TPath extends string,
221 TServerMiddlewares,
222> = <
223 const TMethodAllMiddlewares,
224 const TMethodGetMiddlewares,
225 const TMethodPostMiddlewares,
226 const TMethodPutMiddlewares,
227 const TMethodPatchMiddlewares,
228 const TMethodDeleteMiddlewares,
229 const TMethodOptionsMiddlewares,
230 const TMethodHeadMiddlewares,
231 TServerContext,
232>(
233 opts: CreateMethodFnOpts<
234 TRegister,
235 TParentRoute,
236 TPath,
237 TServerMiddlewares,
238 TMethodAllMiddlewares,
239 TMethodGetMiddlewares,
240 TMethodPostMiddlewares,
241 TMethodPutMiddlewares,
242 TMethodPatchMiddlewares,
243 TMethodDeleteMiddlewares,
244 TMethodOptionsMiddlewares,
245 TMethodHeadMiddlewares,
246 TServerContext
247 >,
248) => CustomHandlerFunctionsRecord<
249 TRegister,
250 TParentRoute,
251 TPath,
252 TServerMiddlewares,
253 any,
254 TServerContext
256​
257export interface CreateMethodFnOpts<
258 TRegister,
259 TParentRoute extends AnyRoute,
260 TPath extends string,
261 TServerMiddlewares,
262 TMethodAllMiddlewares,
263 TMethodGetMiddlewares,
264 TMethodPostMiddlewares,
265 TMethodPutMiddlewares,
266 TMethodPatchMiddlewares,
267 TMethodDeleteMiddlewares,
268 TMethodOptionsMiddlewares,
269 TMethodHeadMiddlewares,
270 TServerContext,
271> {
272 ALL?: RouteMethodHandler<
273 TRegister,
274 TParentRoute,
275 TPath,
276 TServerMiddlewares,
277 TMethodAllMiddlewares,
278 TServerContext
279 >
280 GET?: RouteMethodHandler<
281 TRegister,
282 TParentRoute,
283 TPath,
284 TServerMiddlewares,
285 TMethodGetMiddlewares,
286 TServerContext
287 >
288 POST?: RouteMethodHandler<
289 TRegister,
290 TParentRoute,
291 TPath,
292 TServerMiddlewares,
293 TMethodPostMiddlewares,
294 TServerContext
295 >
296 PUT?: RouteMethodHandler<
297 TRegister,
298 TParentRoute,
299 TPath,
300 TServerMiddlewares,
301 TMethodPutMiddlewares,
302 TServerContext
303 >
304 PATCH?: RouteMethodHandler<
305 TRegister,
306 TParentRoute,
307 TPath,
308 TServerMiddlewares,
309 TMethodPatchMiddlewares,
310 TServerContext
311 >
312 DELETE?: RouteMethodHandler<
313 TRegister,
314 TParentRoute,
315 TPath,
316 TServerMiddlewares,
317 TMethodDeleteMiddlewares,
318 TServerContext
319 >
320 OPTIONS?: RouteMethodHandler<
321 TRegister,
322 TParentRoute,
323 TPath,
324 TServerMiddlewares,
325 TMethodOptionsMiddlewares,
326 TServerContext
327 >
328 HEAD?: RouteMethodHandler<
329 TRegister,
330 TParentRoute,
331 TPath,
332 TServerMiddlewares,
333 TMethodHeadMiddlewares,
334 TServerContext
335 >
337​
338export type RouteMethodHandler<
339 TRegister,
340 TParentRoute extends AnyRoute,
341 TPath extends string,
342 TServerMiddlewares,
343 TMethodMiddlewares,
344 TServerContext,
345> =
346 | RouteMethodHandlerFn<
347 TRegister,
348 TParentRoute,
349 TPath,
350 TServerMiddlewares,
351 TMethodMiddlewares,
352 TServerContext
353 >
354 | RouteMethodBuilderOptions<
355 TRegister,
356 TParentRoute,
357 TPath,
358 TServerMiddlewares,
359 TMethodMiddlewares,
360 TServerContext
361 >
362​
363export interface RouteMethodBuilderOptions<
364 TRegister,
365 TParentRoute extends AnyRoute,
366 TFullPath extends string,
367 TServerMiddlewares,
368 TMethodMiddlewares,
369 TResponse,
370> {
371 handler?: RouteMethodHandlerFn<
372 TRegister,
373 TParentRoute,
374 TFullPath,
375 TServerMiddlewares,
376 TMethodMiddlewares,
377 TResponse
378 >
379 middleware?: Constrain<
380 TMethodMiddlewares,
381 ReadonlyArray<AnyRequestMiddleware>
382 >
384​
385export type ResolveAllServerContext<
386 TRegister,
387 TParentRoute extends AnyRoute,
388 TServerMiddlewares,
389> = unknown extends TParentRoute
390 ? AssignAllServerRequestContext<TRegister, TServerMiddlewares, {}>
391 : Assign<
392 TParentRoute['types']['allServerContext'],
393 AssignAllServerRequestContext<TRegister, TServerMiddlewares, {}>
394 >
395​
396export type RouteMethod =
397 | 'ALL'
398 | 'GET'
399 | 'POST'
400 | 'PUT'
401 | 'PATCH'
402 | 'DELETE'
403 | 'OPTIONS'
404 | 'HEAD'
405​
406export type RouteMethodHandlerFn<
407 TRegister,
408 TParentRoute extends AnyRoute,
409 TFullPath extends string,
410 TServerMiddlewares,
411 TMethodMiddlewares,
412 TServerContext,
413> = (
414 ctx: RouteMethodHandlerCtx<
415 TRegister,
416 TParentRoute,
417 TFullPath,
418 TServerMiddlewares,
419 TMethodMiddlewares
420 >,
421) =>
422 | RouteMethodResult<TServerContext>
423 | Promise<RouteMethodResult<TServerContext>>
424​
425export type RouteMethodResult<TContext> =
426 | Response
427 | undefined
428 | RouteMethodNextResult<TContext>
429​
430export type RouteMethodNextResult<TContext> = {
431 isNext: true
432 context: TContext
434​
435export interface RouteMethodHandlerCtx<
436 in out TRegister,
437 in out TParentRoute extends AnyRoute,
438 in out TFullPath extends string,
439 in out TServerMiddlewares,
440 in out TMethodMiddlewares,
441> {
442 context: Expand<
443 AssignAllMethodContext<
444 TRegister,
445 TParentRoute,
446 TServerMiddlewares,
447 TMethodMiddlewares
448 >
449 >
450 request: Request
451 params: Expand<ResolveParams<TFullPath>>
452 pathname: TFullPath
453 next: <TContext = undefined>(options?: {
454 context?: TContext
455 }) => RouteMethodNextResult<TContext>
457​
458export type MergeMethodMiddlewares<TServerMiddlewares, TMethodMiddlewares> =
459 TServerMiddlewares extends ReadonlyArray<any>
460 ? TMethodMiddlewares extends ReadonlyArray<any>
461 ? readonly [...TServerMiddlewares, ...TMethodMiddlewares]
462 : TServerMiddlewares
463 : TMethodMiddlewares
464​
465export type AssignAllMethodContext<
466 TRegister,
467 TParentRoute extends AnyRoute,
468 TServerMiddlewares,
469 TMethodMiddlewares,
470> = ResolveAllServerContext<
471 TRegister,
472 TParentRoute,
473 MergeMethodMiddlewares<TServerMiddlewares, TMethodMiddlewares>