narrow withAuth type to User when ensureSignedIn is true (#185)

When ensureEignedIn is true, the user will either be returned or next will throw a `NEXT_REDIRECT` to redirect to log in.
workos · Jan 21, 2025 · a21db78 · a21db78
1 parent b059722
commit a21db78
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/session.ts b/src/session.ts
@@ -351,12 +351,13 @@ async function redirectToSignIn() {
   redirect(await getAuthorizationUrl({ returnPathname, screenHint }));
 }
 
-async function withAuth(options?: { ensureSignedIn?: boolean }): Promise<UserInfo | NoUserInfo>;
-async function withAuth({ ensureSignedIn = false }: { ensureSignedIn?: boolean } = {}): Promise<UserInfo | NoUserInfo> {
+async function withAuth(options: { ensureSignedIn: true }): Promise<UserInfo>;
+async function withAuth(options?: { ensureSignedIn?: true | false }): Promise<UserInfo | NoUserInfo>;
+async function withAuth(options?: { ensureSignedIn?: boolean }): Promise<UserInfo | NoUserInfo> {
   const session = await getSessionFromHeader();
 
   if (!session) {
-    if (ensureSignedIn) {
+    if (options?.ensureSignedIn) {
       await redirectToSignIn();
     }
     return { user: null };