import { expectTypeOf, test } from 'vitest' import { createRootRoute, createRoute, createRouter, useLoaderData, } from '../src' import type { Accessor } from 'solid-js' test('when there is no loaders', () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', }) const invoicesIndexRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '/', }) const routeTree = rootRoute.addChildren([ invoicesRoute.addChildren([invoicesIndexRoute]), indexRoute, ]) const defaultRouter = createRouter({ routeTree, }) type DefaultRouter = typeof defaultRouter expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('from') .toEqualTypeOf<'/invoices' | '__root__' | '/invoices/' | '/'>() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('strict') .toEqualTypeOf() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .parameter(0) .toMatchTypeOf() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor >() expectTypeOf(useLoaderData({ strict: false })) .toEqualTypeOf> }) test('when there is one loader', () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', loader: () => ({ data: ['element1', 'element2'] }), }) const invoicesIndexRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '/', }) const invoiceRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '$invoiceId', }) const routeTree = rootRoute.addChildren([ invoicesRoute.addChildren([invoicesIndexRoute, invoiceRoute]), indexRoute, ]) const defaultRouter = createRouter({ routeTree, context: { userId: 'userId' }, }) type DefaultRouter = typeof defaultRouter expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor<{ data: Array }> >() expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor<{ data: Array }> >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf } | undefined>>() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf>() }) test('when there is one loader that is async', () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', loader: () => Promise.resolve({ data: ['element1', 'element2'] }), }) const invoicesIndexRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '/', }) const invoiceRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '$invoiceId', }) const routeTree = rootRoute.addChildren([ invoicesRoute.addChildren([invoicesIndexRoute, invoiceRoute]), indexRoute, ]) const defaultRouter = createRouter({ routeTree, context: { userId: 'userId' }, }) type DefaultRouter = typeof defaultRouter expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor<{ data: Array }> >() expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor<{ data: Array }> >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf } | undefined>>() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf>() }) test('when there are multiple loaders', () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', loader: () => ({ data: ['invoice1', 'invoice2'] }) as const, }) const invoicesIndexRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '/', }) const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', loader: () => ({ data: ['post1', 'post2'] }) as const, }) const routeTree = rootRoute.addChildren([ invoicesRoute.addChildren([invoicesIndexRoute]), postsRoute, indexRoute, ]) const defaultRouter = createRouter({ routeTree, }) type DefaultRouter = typeof defaultRouter expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor >() expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor<{ readonly data: readonly ['invoice1', 'invoice2'] }> >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf< Accessor< | { data?: | readonly ['invoice1', 'invoice2'] | readonly ['post1', 'post2'] | undefined } | undefined > >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .parameter(0) .toEqualTypeOf< | { data?: | readonly ['invoice1', 'invoice2'] | readonly ['post1', 'post2'] | undefined } | undefined >() expectTypeOf( useLoaderData void }>, ) .parameter(0) .exclude() .toHaveProperty('select') .exclude() .returns.toEqualTypeOf<{ func: () => void }>() }) test('when there are multiple loaders of objects and primtives', () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', loader: () => ['invoice1', 'invoice2'] as const, }) const invoicesIndexRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '/', loader: () => ({ invoice: { id: 1 } }) as const, }) const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', loader: () => ['post1', 'post2'] as const, }) const routeTree = rootRoute.addChildren([ invoicesRoute.addChildren([invoicesIndexRoute]), indexRoute, postsRoute, ]) const defaultRouter = createRouter({ routeTree, }) type DefaultRouter = typeof defaultRouter expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor >() expectTypeOf(useLoaderData).returns.toEqualTypeOf< Accessor >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .returns.toEqualTypeOf() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .parameter(0) .toEqualTypeOf() expectTypeOf( useLoaderData, ).returns.toEqualTypeOf< Accessor< | readonly ['invoice1', 'invoice2'] | readonly ['post1', 'post2'] | { invoice?: | { readonly id: 1 } | undefined } | undefined > >() expectTypeOf(useLoaderData) .parameter(0) .toHaveProperty('select') .parameter(0) .toEqualTypeOf< | readonly ['invoice1', 'invoice2'] | readonly ['post1', 'post2'] | { invoice?: | { readonly id: 1 } | undefined } | undefined >() })