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

useRouteContext.test-d.tsx

322 lines7.5 KB

1import { expectTypeOf, test } from 'vitest'
2import {
3 createRootRoute,
4 createRootRouteWithContext,
5 createRoute,
6 createRouter,
7 useRouteContext,
8} from '../src'
9import type { Accessor } from 'solid-js'
10​
11test('when there is no context', () => {
12 const rootRoute = createRootRoute()
13​
14 const indexRoute = createRoute({
15 getParentRoute: () => rootRoute,
16 path: '/',
17 })
18​
19 const invoicesRoute = createRoute({
20 getParentRoute: () => rootRoute,
21 path: 'invoices',
22 })
23​
24 const invoicesIndexRoute = createRoute({
25 getParentRoute: () => invoicesRoute,
26 path: '/',
27 })
28​
29 const routeTree = rootRoute.addChildren([
30 invoicesRoute.addChildren([invoicesIndexRoute]),
31 indexRoute,
32 ])
33​
34 const defaultRouter = createRouter({
35 routeTree,
36 })
37​
38 type DefaultRouter = typeof defaultRouter
39​
40 expectTypeOf(useRouteContext<DefaultRouter>)
41 .parameter(0)
42 .toHaveProperty('from')
43 .toEqualTypeOf<'/invoices' | '__root__' | '/invoices/' | '/'>()
44​
45 expectTypeOf(useRouteContext<DefaultRouter>)
46 .parameter(0)
47 .toHaveProperty('strict')
48 .toEqualTypeOf<true | undefined>()
49​
50 expectTypeOf(useRouteContext<DefaultRouter, '/'>)
51 .parameter(0)
52 .toHaveProperty('select')
53 .parameter(0)
54 .toEqualTypeOf<{}>()
55​
56 expectTypeOf(useRouteContext<DefaultRouter, '/'>)
57 .parameter(0)
58 .toHaveProperty('select')
59 .returns.toEqualTypeOf<unknown>()
60​
61 expectTypeOf(useRouteContext<DefaultRouter, '/'>).returns.toEqualTypeOf<
62 Accessor<{}>
63 >()
64​
65 expectTypeOf(
66 useRouteContext<DefaultRouter, '/', false>({
67 strict: false,
68 }),
69 ).toEqualTypeOf<Accessor<{}>>()
70})
71​
72test('when there is the root context', () => {
73 interface Context {
74 userId: string
75 }
76​
77 const rootRoute = createRootRouteWithContext<Context>()()
78​
79 const indexRoute = createRoute({
80 getParentRoute: () => rootRoute,
81 path: '/',
82 })
83​
84 const invoicesRoute = createRoute({
85 getParentRoute: () => rootRoute,
86 path: 'invoices',
87 })
88​
89 const invoicesIndexRoute = createRoute({
90 getParentRoute: () => invoicesRoute,
91 path: '/',
92 })
93​
94 const invoiceRoute = createRoute({
95 getParentRoute: () => invoicesRoute,
96 path: '$invoiceId',
97 })
98​
99 const routeTree = rootRoute.addChildren([
100 invoicesRoute.addChildren([invoicesIndexRoute, invoiceRoute]),
101 indexRoute,
102 ])
103​
104 const defaultRouter = createRouter({
105 routeTree,
106 context: { userId: 'userId' },
107 })
108​
109 type DefaultRouter = typeof defaultRouter
110​
111 expectTypeOf(useRouteContext<DefaultRouter, '/'>).returns.toEqualTypeOf<
112 Accessor<{
113 userId: string
114 }>
115 >()
116​
117 expectTypeOf(
118 useRouteContext<DefaultRouter, '/invoices/$invoiceId'>,
119 ).returns.toEqualTypeOf<Accessor<{ userId: string }>>()
120​
121 expectTypeOf(useRouteContext<DefaultRouter, '/invoices/$invoiceId'>)
122 .parameter(0)
123 .toHaveProperty('select')
124 .toEqualTypeOf<((search: { userId: string }) => unknown) | undefined>()
125​
126 expectTypeOf(
127 useRouteContext<DefaultRouter, '/invoices', false>,
128 ).returns.toEqualTypeOf<Accessor<{ userId?: string }>>()
129​
130 expectTypeOf(useRouteContext<DefaultRouter, '/invoices', false>)
131 .parameter(0)
132 .toHaveProperty('select')
133 .toEqualTypeOf<((search: { userId?: string }) => unknown) | undefined>()
134​
135 expectTypeOf(
136 useRouteContext<DefaultRouter, '/invoices', false, number>,
137 ).returns.toEqualTypeOf<Accessor<number>>()
138})
139​
140test('when there are multiple contexts', () => {
141 interface Context {
142 userId: string
143 }
144​
145 const rootRoute = createRootRouteWithContext<Context>()()
146​
147 const indexRoute = createRoute({
148 getParentRoute: () => rootRoute,
149 path: '/',
150 })
151​
152 const invoicesRoute = createRoute({
153 getParentRoute: () => rootRoute,
154 path: 'invoices',
155 })
156​
157 const invoicesIndexRoute = createRoute({
158 getParentRoute: () => invoicesRoute,
159 path: '/',
160 })
161​
162 const invoiceRoute = createRoute({
163 getParentRoute: () => invoicesRoute,
164 path: '$invoiceId',
165 })
166​
167 const postsRoute = createRoute({
168 getParentRoute: () => rootRoute,
169 path: 'posts',
170 })
171​
172 const postRoute = createRoute({
173 getParentRoute: () => postsRoute,
174 path: '$postId',
175 beforeLoad: () => ({ username: 'username' }),
176 })
177​
178 const routeTree = rootRoute.addChildren([
179 invoicesRoute.addChildren([
180 invoicesIndexRoute,
181 invoiceRoute,
182 postsRoute.addChildren([postRoute]),
183 ]),
184 indexRoute,
185 ])
186​
187 const defaultRouter = createRouter({
188 routeTree,
189 context: { userId: 'userId' },
190 })
191​
192 type DefaultRouter = typeof defaultRouter
193​
194 expectTypeOf(useRouteContext<DefaultRouter, '/'>).returns.toEqualTypeOf<
195 Accessor<{
196 userId: string
197 }>
198 >()
199​
200 expectTypeOf(
201 useRouteContext<DefaultRouter, '/invoices/$invoiceId'>,
202 ).returns.toEqualTypeOf<Accessor<{ userId: string }>>()
203​
204 expectTypeOf(useRouteContext<DefaultRouter, '/invoices/$invoiceId'>)
205 .parameter(0)
206 .toHaveProperty('select')
207 .toEqualTypeOf<((search: { userId: string }) => unknown) | undefined>()
208​
209 expectTypeOf(
210 useRouteContext<DefaultRouter, '/invoices', false>,
211 ).returns.toEqualTypeOf<Accessor<{ userId?: string; username?: string }>>()
212​
213 expectTypeOf(useRouteContext<DefaultRouter, '/invoices', false>)
214 .parameter(0)
215 .toHaveProperty('select')
216 .toEqualTypeOf<
217 ((search: { userId?: string; username?: string }) => unknown) | undefined
218 >()
219})
220​
221test('when there are overlapping contexts', () => {
222 interface Context {
223 userId: string
224 }
225​
226 const rootRoute = createRootRouteWithContext<Context>()()
227​
228 const indexRoute = createRoute({
229 getParentRoute: () => rootRoute,
230 path: '/',
231 })
232​
233 const invoicesRoute = createRoute({
234 getParentRoute: () => rootRoute,
235 path: 'invoices',
236 validateSearch: () => ({ page: 0 }),
237 })
238​
239 const invoicesIndexRoute = createRoute({
240 getParentRoute: () => invoicesRoute,
241 path: '/',
242 })
243​
244 const invoiceRoute = createRoute({
245 getParentRoute: () => invoicesRoute,
246 path: '$invoiceId',
247 beforeLoad: () => ({ username: 'username2' }) as const,
248 })
249​
250 const postsRoute = createRoute({
251 getParentRoute: () => rootRoute,
252 path: 'posts',
253 })
254​
255 const postRoute = createRoute({
256 getParentRoute: () => postsRoute,
257 path: '$postId',
258 beforeLoad: () => ({ username: 'username1' }) as const,
259 })
260​
261 const routeTree = rootRoute.addChildren([
262 invoicesRoute.addChildren([
263 invoicesIndexRoute,
264 invoiceRoute,
265 postsRoute.addChildren([postRoute]),
266 ]),
267 indexRoute,
268 ])
269​
270 const defaultRouter = createRouter({
271 routeTree,
272 context: { userId: 'userId' },
273 })
274​
275 type DefaultRouter = typeof defaultRouter
276​
277 expectTypeOf(useRouteContext<DefaultRouter, '/'>).returns.toEqualTypeOf<
278 Accessor<{
279 userId: string
280 }>
281 >
282​
283 expectTypeOf(
284 useRouteContext<DefaultRouter, '/invoices/$invoiceId'>,
285 ).returns.toEqualTypeOf<
286 Accessor<{
287 userId: string
288 readonly username: 'username2'
289 }>
290 >()
291​
292 expectTypeOf(useRouteContext<DefaultRouter, '/invoices/$invoiceId'>)
293 .parameter(0)
294 .toHaveProperty('select')
295 .toEqualTypeOf<
296 | ((search: {
297 userId: string
298 readonly username: 'username2'
299 }) => unknown)
300 | undefined
301 >()
302​
303 expectTypeOf(
304 useRouteContext<DefaultRouter, '/invoices', false>,
305 ).returns.toEqualTypeOf<
306 Accessor<{
307 userId?: string
308 username?: 'username1' | 'username2'
309 }>
310 >()
311​
312 expectTypeOf(useRouteContext<DefaultRouter, '/invoices', false>)
313 .parameter(0)
314 .toHaveProperty('select')
315 .toEqualTypeOf<
316 | ((search: {
317 userId?: string
318 username?: 'username2' | 'username1'
319 }) => unknown)
320 | undefined
321 >()
322})