Skip to content

fix(react-router): Correct types for data() usage in callback #4853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 8, 2025
Merged

fix(react-router): Correct types for data() usage in callback #4853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
092e8f5
initial
LekoArts Jan 8, 2025
b6eb0bb
do not assume data shape
LekoArts Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/large-phones-peel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/react-router': patch
---

Previously, when the `data()` utility was used inside the callback of `rootAuthLoader()` type errors were thrown. These issues should be fixed now.
10 changes: 8 additions & 2 deletions packages/react-router/src/ssr/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type {
SignUpFallbackRedirectUrl,
SignUpForceRedirectUrl,
} from '@clerk/types';
import type { LoaderFunction } from 'react-router';
import type { LoaderFunction, UNSAFE_DataWithResponseInit } from 'react-router';
import type { CreateServerLoaderArgs } from 'react-router/route-module';

type Func = (...args: any[]) => unknown;
Expand Down Expand Up @@ -97,7 +97,13 @@ type ObjectLike = Record<string, unknown> | null;
*
* In the case of `null`, we will return an object containing only the authentication state.
*/
export type RootAuthLoaderCallbackReturn = Promise<Response> | Response | Promise<ObjectLike> | ObjectLike;
type RootAuthLoaderCallbackReturn =
| Promise<Response>
| Response
| Promise<ObjectLike>
| ObjectLike
| UNSAFE_DataWithResponseInit<unknown>
| Promise<UNSAFE_DataWithResponseInit<unknown>>;

// TODO: Figure out how to use the Route.LoaderArgs from userland code
export type LoaderFunctionArgs = CreateServerLoaderArgs<RouteInfo>;
Expand Down
Loading