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

serverRoute.ts

509 lines10.5 KB

1import type {
2 AnyContext,
3 AnyRoute,
4 Assign,
5 Constrain,
6 Expand,
7 ResolveAllParamsFromParent,
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 TParentRoute,
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 TRouteId,
84 in out TServerMiddlewares,
85 in out THandlers,
86 > {
87 serverContext?: Expand<
88 Assign<
89 ResolveAllServerContext<TRegister, TParentRoute, TServerMiddlewares>,
90 ExtractHandlersContext<THandlers>
91 >
92 >
93 }
94​
95 interface LoaderFnContext<
96 in out TRegister,
97 in out TParentRoute extends AnyRoute = AnyRoute,
98 in out TId extends string = string,
99 in out TParams = {},
100 in out TLoaderDeps = {},
101 in out TRouterContext = {},
102 in out TRouteContextFn = AnyContext,
103 in out TBeforeLoadFn = AnyContext,
104 in out TServerMiddlewares = unknown,
105 in out THandlers = undefined,
106 > {
107 serverContext?: Expand<
108 Assign<
109 ResolveAllServerContext<TRegister, TParentRoute, TServerMiddlewares>,
110 ExtractHandlersContext<THandlers>
111 >
112 >
113 }
115​
116type ExtractHandlersContext<THandlers> = THandlers extends (
117 ...args: any
118) => CustomHandlerFunctionsRecord<
119 any,
120 any,
121 any,
122 any,
123 any,
124 any,
125 infer TServerContext
127 ? UnionToIntersection<TServerContext>
128 : THandlers extends Record<
129 string,
130 RouteMethodHandler<any, any, any, any, any, any, infer TServerContext>
131 >
132 ? UnionToIntersection<TServerContext>
133 : undefined
134​
135export interface RouteServerOptions<
136 TRegister,
137 TParentRoute extends AnyRoute,
138 TFullPath extends string,
139 TParams,
140 TLoaderDeps,
141 TLoaderFn,
142 TRouterContext,
143 TRouteContextFn,
144 TBeforeLoadFn,
145 TServerMiddlewares,
146 THandlers,
147> {
148 middleware?: Constrain<
149 TServerMiddlewares,
150 ReadonlyArray<AnyRequestMiddleware>
151 >
152​
153 handlers?: Constrain<
154 THandlers,
155 | Partial<
156 Record<
157 RouteMethod,
158 RouteMethodHandlerFn<
159 TRegister,
160 TParentRoute,
161 TFullPath,
162 TParams,
163 TServerMiddlewares,
164 any,
165 any
166 >
167 >
168 >
169 | ((
170 opts: HandlersFnOpts<
171 TRegister,
172 TParentRoute,
173 TFullPath,
174 TParams,
175 TServerMiddlewares
176 >,
177 ) => CustomHandlerFunctionsRecord<
178 TRegister,
179 TParentRoute,
180 TFullPath,
181 TParams,
182 TServerMiddlewares,
183 any,
184 any
185 >)
186 >
188​
189declare const createHandlersSymbol: unique symbol
190​
191type CustomHandlerFunctionsRecord<
192 TRegister,
193 TParentRoute extends AnyRoute,
194 TFullPath extends string,
195 TParams,
196 TServerMiddlewares,
197 TMethodMiddlewares,
198 TServerContext,
199> = {
200 [createHandlersSymbol]: true
201} & Partial<
202 Record<
203 RouteMethod,
204 RouteMethodHandler<
205 TRegister,
206 TParentRoute,
207 TFullPath,
208 TParams,
209 TServerMiddlewares,
210 TMethodMiddlewares,
211 TServerContext
212 >
213 >
215​
216export interface HandlersFnOpts<
217 TRegister,
218 TParentRoute extends AnyRoute,
219 TFullPath extends string,
220 TParams,
221 TServerMiddlewares,
222> {
223 createHandlers: CreateHandlersFn<
224 TRegister,
225 TParentRoute,
226 TFullPath,
227 TParams,
228 TServerMiddlewares
229 >
231​
232export type CreateHandlersFn<
233 TRegister,
234 TParentRoute extends AnyRoute,
235 TFullPath extends string,
236 TParams,
237 TServerMiddlewares,
238> = <
239 const TMethodAllMiddlewares,
240 const TMethodGetMiddlewares,
241 const TMethodPostMiddlewares,
242 const TMethodPutMiddlewares,
243 const TMethodPatchMiddlewares,
244 const TMethodDeleteMiddlewares,
245 const TMethodOptionsMiddlewares,
246 const TMethodHeadMiddlewares,
247 TServerContext,
248>(
249 opts: CreateMethodFnOpts<
250 TRegister,
251 TParentRoute,
252 TFullPath,
253 TParams,
254 TServerMiddlewares,
255 TMethodAllMiddlewares,
256 TMethodGetMiddlewares,
257 TMethodPostMiddlewares,
258 TMethodPutMiddlewares,
259 TMethodPatchMiddlewares,
260 TMethodDeleteMiddlewares,
261 TMethodOptionsMiddlewares,
262 TMethodHeadMiddlewares,
263 TServerContext
264 >,
265) => CustomHandlerFunctionsRecord<
266 TRegister,
267 TParentRoute,
268 TFullPath,
269 TParams,
270 TServerMiddlewares,
271 any,
272 TServerContext
274​
275export interface CreateMethodFnOpts<
276 TRegister,
277 TParentRoute extends AnyRoute,
278 TFullPath extends string,
279 TParams,
280 TServerMiddlewares,
281 TMethodAllMiddlewares,
282 TMethodGetMiddlewares,
283 TMethodPostMiddlewares,
284 TMethodPutMiddlewares,
285 TMethodPatchMiddlewares,
286 TMethodDeleteMiddlewares,
287 TMethodOptionsMiddlewares,
288 TMethodHeadMiddlewares,
289 TServerContext,
290> {
291 ANY?: RouteMethodHandler<
292 TRegister,
293 TParentRoute,
294 TFullPath,
295 TParams,
296 TServerMiddlewares,
297 TMethodAllMiddlewares,
298 TServerContext
299 >
300 GET?: RouteMethodHandler<
301 TRegister,
302 TParentRoute,
303 TFullPath,
304 TParams,
305 TServerMiddlewares,
306 TMethodGetMiddlewares,
307 TServerContext
308 >
309 POST?: RouteMethodHandler<
310 TRegister,
311 TParentRoute,
312 TFullPath,
313 TParams,
314 TServerMiddlewares,
315 TMethodPostMiddlewares,
316 TServerContext
317 >
318 PUT?: RouteMethodHandler<
319 TRegister,
320 TParentRoute,
321 TFullPath,
322 TParams,
323 TServerMiddlewares,
324 TMethodPutMiddlewares,
325 TServerContext
326 >
327 PATCH?: RouteMethodHandler<
328 TRegister,
329 TParentRoute,
330 TFullPath,
331 TParams,
332 TServerMiddlewares,
333 TMethodPatchMiddlewares,
334 TServerContext
335 >
336 DELETE?: RouteMethodHandler<
337 TRegister,
338 TParentRoute,
339 TFullPath,
340 TParams,
341 TServerMiddlewares,
342 TMethodDeleteMiddlewares,
343 TServerContext
344 >
345 OPTIONS?: RouteMethodHandler<
346 TRegister,
347 TParentRoute,
348 TFullPath,
349 TParams,
350 TServerMiddlewares,
351 TMethodOptionsMiddlewares,
352 TServerContext
353 >
354 HEAD?: RouteMethodHandler<
355 TRegister,
356 TParentRoute,
357 TFullPath,
358 TParams,
359 TServerMiddlewares,
360 TMethodHeadMiddlewares,
361 TServerContext
362 >
364​
365export type RouteMethodHandler<
366 TRegister,
367 TParentRoute extends AnyRoute,
368 TFullPath extends string,
369 TParams,
370 TServerMiddlewares,
371 TMethodMiddlewares,
372 TServerContext,
373> =
374 | RouteMethodHandlerFn<
375 TRegister,
376 TParentRoute,
377 TFullPath,
378 TParams,
379 TServerMiddlewares,
380 TMethodMiddlewares,
381 TServerContext
382 >
383 | RouteMethodBuilderOptions<
384 TRegister,
385 TParentRoute,
386 TFullPath,
387 TParams,
388 TServerMiddlewares,
389 TMethodMiddlewares,
390 TServerContext
391 >
392​
393export interface RouteMethodBuilderOptions<
394 TRegister,
395 TParentRoute extends AnyRoute,
396 TFullPath extends string,
397 TParams,
398 TServerMiddlewares,
399 TMethodMiddlewares,
400 TResponse,
401> {
402 handler?: RouteMethodHandlerFn<
403 TRegister,
404 TParentRoute,
405 TFullPath,
406 TParams,
407 TServerMiddlewares,
408 TMethodMiddlewares,
409 TResponse
410 >
411 middleware?: Constrain<
412 TMethodMiddlewares,
413 ReadonlyArray<AnyRequestMiddleware>
414 >
416​
417export type ResolveAllServerContext<
418 TRegister,
419 TParentRoute extends AnyRoute,
420 TServerMiddlewares,
421> = unknown extends TParentRoute
422 ? AssignAllServerRequestContext<TRegister, TServerMiddlewares, {}>
423 : Assign<
424 TParentRoute['types']['allServerContext'],
425 AssignAllServerRequestContext<TRegister, TServerMiddlewares, {}>
426 >
427​
428export type RouteMethod =
429 | 'ANY'
430 | 'GET'
431 | 'POST'
432 | 'PUT'
433 | 'PATCH'
434 | 'DELETE'
435 | 'OPTIONS'
436 | 'HEAD'
437​
438export type RouteMethodHandlerFn<
439 TRegister,
440 TParentRoute extends AnyRoute,
441 TFullPath extends string,
442 TParams,
443 TServerMiddlewares,
444 TMethodMiddlewares,
445 TServerContext,
446> = (
447 ctx: RouteMethodHandlerCtx<
448 TRegister,
449 TParentRoute,
450 TFullPath,
451 TParams,
452 TServerMiddlewares,
453 TMethodMiddlewares
454 >,
455) =>
456 | RouteMethodResult<TServerContext>
457 | Promise<RouteMethodResult<TServerContext>>
458​
459export type RouteMethodResult<TContext> =
460 | Response
461 | undefined
462 | RouteMethodNextResult<TContext>
463​
464export type RouteMethodNextResult<TContext> = {
465 isNext: true
466 context: TContext
468​
469export interface RouteMethodHandlerCtx<
470 in out TRegister,
471 in out TParentRoute extends AnyRoute,
472 in out TFullPath extends string,
473 in out TParams,
474 in out TServerMiddlewares,
475 in out TMethodMiddlewares,
476> {
477 context: Expand<
478 AssignAllMethodContext<
479 TRegister,
480 TParentRoute,
481 TServerMiddlewares,
482 TMethodMiddlewares
483 >
484 >
485 request: Request
486 params: Expand<ResolveAllParamsFromParent<TParentRoute, TParams>>
487 pathname: TFullPath
488 next: <TContext = undefined>(options?: {
489 context?: TContext
490 }) => RouteMethodNextResult<TContext>
492​
493export type MergeMethodMiddlewares<TServerMiddlewares, TMethodMiddlewares> =
494 TServerMiddlewares extends ReadonlyArray<any>
495 ? TMethodMiddlewares extends ReadonlyArray<any>
496 ? readonly [...TServerMiddlewares, ...TMethodMiddlewares]
497 : TServerMiddlewares
498 : TMethodMiddlewares
499​
500export type AssignAllMethodContext<
501 TRegister,
502 TParentRoute extends AnyRoute,
503 TServerMiddlewares,
504 TMethodMiddlewares,
505> = ResolveAllServerContext<
506 TRegister,
507 TParentRoute,
508 MergeMethodMiddlewares<TServerMiddlewares, TMethodMiddlewares>