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

serverRoute.test-d.ts

288 lines7.0 KB

1import { test } from 'vitest'
2​
3test('dummy', () => {})
4/*
5import { expectTypeOf, test } from 'vitest'
6import '../../start-client-core/src/serverRoute'
7import { createMiddleware } from '../../start-client-core/src/createMiddleware'
8import { createFileRoute as defaultCreateFileRoute } from '../../react-router/src/fileRoute'
9import type { CreateFileRoute } from '../../router-core/src/fileRoute'
10​
11test('createServerFileRoute with methods with no middleware', () => {
12 type Path = '$detailId'
13 const createFileRoute: CreateFileRoute<Path, any, Path, Path, Path> =
14 defaultCreateFileRoute as never
15​
16 const options: Parameters<typeof createFileRoute>[0] = {
17 methods: {
18 GET: (ctx) => {
19 expectTypeOf(ctx).toEqualTypeOf<{
20 context: undefined
21 params: { detailId: string }
22 pathname: '$detailId'
23 request: Request
24 }>()
25 },
26 },
27 }
28​
29 const fileRoute = createFileRoute()
30​
31 expectTypeOf(fileRoute.methods).toBeFunction()
32 expectTypeOf(fileRoute.middleware).toBeFunction()
33​
34 fileRoute.methods({
35 GET: (ctx) => {
36 expectTypeOf(ctx).toEqualTypeOf<{
37 context: undefined
38 params: { detailId: string }
39 pathname: '$detailId'
40 request: Request
41 }>()
42​
43 return Response.json({
44 test: 'test',
45 })
46 },
47 })
48​
49 fileRoute.methods((r) => ({
50 GET: r.handler((ctx) => {
51 expectTypeOf(ctx).toEqualTypeOf<{
52 context: undefined
53 params: { detailId: string }
54 pathname: '$detailId'
55 request: Request
56 }>()
57​
58 return Response.json({
59 test: 'test',
60 })
61 }),
62 }))
63})
64​
65test('createServerFileRoute with methods and route middleware context', () => {
66 type Path = '$detailId'
67 const createFileRoute: CreateFileRoute<Path, any, Path, Path, Path> =
68 defaultCreateFileRoute as never
69​
70 const routeMiddleware = createMiddleware({ type: 'request' }).server(
71 ({ next }) => next({ context: { a: 'a' } }),
72 )
73​
74 const serverFileRoute = createFileRoute().middleware([routeMiddleware])
75​
76 fileRoute.methods({
77 GET: (ctx) => {
78 expectTypeOf(ctx).toEqualTypeOf<{
79 context: { a: string }
80 params: { detailId: string }
81 pathname: '$detailId'
82 request: Request
83 }>()
84​
85 return Response.json({
86 test: 'test',
87 })
88 },
89 })
90​
91 fileRoute.methods((r) => ({
92 GET: r.handler((ctx) => {
93 expectTypeOf(ctx).toEqualTypeOf<{
94 context: { a: string }
95 params: { detailId: string }
96 pathname: '$detailId'
97 request: Request
98 }>()
99​
100 return Response.json({
101 test: 'test',
102 })
103 }),
104 }))
105})
106​
107test('createServerFileRoute with methods middleware and route middleware', () => {
108 type Path = '$detailId'
109 const createFileRoute: CreateFileRoute<Path, any, Path, Path, Path> =
110 defaultCreateFileRoute as never
111​
112 const routeMiddleware = createMiddleware({ type: 'request' }).server(
113 ({ next }) => next({ context: { a: 'a' } }),
114 )
115​
116 const fileRoute = createFileRoute().middleware([routeMiddleware])
117​
118 const methodMiddleware = createMiddleware({ type: 'request' }).server(
119 ({ next }) => next({ context: { b: 'b' } }),
120 )
121​
122 fileRoute.methods((r) => ({
123 GET: r.middleware([methodMiddleware]).handler((ctx) => {
124 expectTypeOf(ctx).toEqualTypeOf<{
125 context: { a: string; b: string }
126 params: { detailId: string }
127 pathname: '$detailId'
128 request: Request
129 }>()
130​
131 return Response.json({
132 test: 'test',
133 })
134 }),
135 }))
136})
137​
138test('createServerFileRoute with a parent middleware context', () => {
139 const createDetailsFileRoute: CreateFileRoute<
140 'details',
141 any,
142 'details',
143 'details',
144 'details'
145 > = defaultCreateFileRoute as never
146​
147 const routeMiddleware1 = createMiddleware({ type: 'request' }).server(
148 ({ next }) => {
149 return next({ context: { a: 'a' } })
150 },
151 )
152​
153 const _detailsRoute = createDetailsFileRoute().middleware([routeMiddleware1])
154​
155 const createDetailFileRoute: CreateFileRoute<
156 'details/$detailId',
157 typeof _detailsRoute,
158 '$detailId',
159 'details/$detailId',
160 'details/$detailId'
161 > = defaultCreateFileRoute as never
162​
163 const routeMiddleware2 = createMiddleware({ type: 'request' }).server(
164 ({ next }) => {
165 return next({ context: { b: 'b' } })
166 },
167 )
168​
169 createDetailFileRoute()
170 .middleware([routeMiddleware2])
171 .methods({
172 GET: (ctx) => {
173 expectTypeOf(ctx).toEqualTypeOf<{
174 context: { a: string; b: string }
175 params: { detailId: string }
176 pathname: 'details/$detailId'
177 request: Request
178 }>()
179​
180 return Response.json({ test: 'test' })
181 },
182 })
183​
184 const methodMiddleware = createMiddleware({ type: 'request' }).server(
185 ({ next }) => {
186 return next({ context: { c: 'c' } })
187 },
188 )
189​
190 createDetailFileRoute()
191 .middleware([routeMiddleware2])
192 .methods((r) => ({
193 GET: r.middleware([methodMiddleware]).handler((ctx) => {
194 expectTypeOf(ctx).toEqualTypeOf<{
195 context: { a: string; b: string; c: string }
196 params: { detailId: string }
197 pathname: 'details/$detailId'
198 request: Request
199 }>()
200​
201 return Response.json({ test: 'test' })
202 }),
203 }))
204})
205​
206test('createServerFileRoute with parent middleware params', () => {
207 const createDetailsFileRoute: CreateFileRoute<
208 '$userId',
209 any,
210 '$userId',
211 '$userId',
212 '$userId'
213 > = defaultCreateFileRoute as never
214​
215 const _detailsServerRoute = createDetailsFileRoute()
216​
217 const createDetailFileRoute: CreateFileRoute<
218 '$userId/$detailId',
219 typeof _detailsServerRoute,
220 '$detailId',
221 '$userId/$detailId',
222 '$userId/$detailId'
223 > = defaultCreateFileRoute as never
224​
225 createDetailFileRoute().methods({
226 GET: (ctx) => {
227 expectTypeOf(ctx).toEqualTypeOf<{
228 context: undefined
229 params: { userId: string; detailId: string }
230 pathname: '$userId/$detailId'
231 request: Request
232 }>()
233​
234 return Response.json({ test: 'test' })
235 },
236 })
237​
238 createDetailFileRoute().methods((r) => ({
239 GET: r.handler((ctx) => {
240 expectTypeOf(ctx).toEqualTypeOf<{
241 context: undefined
242 params: { userId: string; detailId: string }
243 pathname: '$userId/$detailId'
244 request: Request
245 }>()
246​
247 return Response.json({ test: 'test' })
248 }),
249 }))
250})
251​
252test('createServerFileRoute with no params', () => {
253 const createDetailsFileRoute: CreateFileRoute<
254 'details',
255 any,
256 'details',
257 'details',
258 'details'
259 > = defaultCreateFileRoute as never
260​
261 createDetailsFileRoute().methods({
262 GET: (ctx) => {
263 expectTypeOf(ctx).toEqualTypeOf<{
264 context: undefined
265 params: {}
266 pathname: 'details'
267 request: Request
268 }>()
269​
270 return Response.json({ test: 'test' })
271 },
272 })
273​
274 createDetailsFileRoute().methods((r) => ({
275 GET: r.handler((ctx) => {
276 expectTypeOf(ctx).toEqualTypeOf<{
277 context: undefined
278 params: {}
279 pathname: 'details'
280 request: Request
281 }>()
282​
283 return Response.json({ test: 'test' })
284 }),
285 }))
286})
287​
288*/