fix: UserSession user type augmentation (#54)

* feat: create User interface for module augmentation * fix: user is no longer possibly undefined when using `requireUserSession` * chore: update docs --------- Co-authored-by: Sébastien Chopin <[email protected]>
atinux · Feb 16, 2024 · 1b99533 · 1b99533
1 parent 58268d7
commit 1b99533
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -116,10 +116,15 @@ You can define the type for your user session by creating a type declaration fil
 
 ```ts
 declare module '#auth-utils' {
+  interface User {
+    // Add your own fields
+  }
+
   interface UserSession {
-    // define the type here
+    // Add your own fields
   }
 }
+
 export {}
 ```
 

diff --git a/playground/auth.d.ts b/playground/auth.d.ts
@@ -1,17 +1,18 @@
 declare module '#auth-utils' {
+  interface User {
+    spotify?: any
+    github?: any
+    google?: any
+    twitch?: any
+    auth0?: any
+    microsoft?: any;
+    discord?: any
+    battledotnet?: any
+    keycloak?: any
+    linkedin?: any
+  }
+
   interface UserSession {
-    user: {
-      spotify?: any
-      github?: any
-      google?: any
-      twitch?: any
-      auth0?: any
-      microsoft?: any;
-      discord?: any
-      battledotnet?: any
-      keycloak?: any
-      linkedin?: any
-    }
     extended?: any
     loggedInAt: number
   }

diff --git a/src/runtime/server/utils/session.ts b/src/runtime/server/utils/session.ts
@@ -3,7 +3,7 @@ import { useSession, createError } from 'h3'
 import { defu } from 'defu'
 import { createHooks } from 'hookable'
 import { useRuntimeConfig } from '#imports'
-import type { UserSession } from '#auth-utils'
+import type { User, UserSession } from '#auth-utils'
 
 export interface SessionHooks {
   /**
@@ -69,7 +69,7 @@ export async function requireUserSession(event: H3Event) {
     })
   }
 
-  return userSession
+  return userSession as UserSession & { user: User }
 }
 
 let sessionConfig: SessionConfig

diff --git a/src/runtime/types/index.ts b/src/runtime/types/index.ts
@@ -1,2 +1,2 @@
-export type { UserSession } from './session'
+export type { UserSession, User } from './session'
 export type { OAuthConfig } from './oauth-config'
diff --git a/src/runtime/types/session.ts b/src/runtime/types/session.ts
@@ -1,3 +1,6 @@
+export interface User {
+}
+
 export interface UserSession {
-  user?: {}
+  user?: User
 }