feat: allow users to define custom session factory + types (#2)

* feat: allow users to define custom session factory + types

* refactor: allow user to overwrite `#auth-utils-session`

* chore: update type

* chore: update augment

Author: danielroe

.github/workflows/ci.yml

@@ -65,8 +65,8 @@ jobs:
       - name: Run test suite
         run: pnpm test
 
-      # - name: Test types
-      #   run: pnpm test:types
+      - name: Test types
+        run: pnpm test:types
 
       # - name: Test playground types
       #   run: pnpm test:types:playground

README.md

@@ -107,6 +107,16 @@ await clearUserSession(event)
 const session = await requireUserSession(event)
 ```
 
+You can define the type for your user session by creating a type declaration file (for example, `auth.d.ts`) in your project:
+
+```ts
+declare module '#auth-utils' {
+  interface UserSession {
+    // define the type here
+  }
+}
+```
+
 ### OAuth Event Handlers
 
 All helpers are exposed from the `oauth` global variable and can be used in your server routes or API routes.

playground/auth.d.ts

@@ -0,0 +1,9 @@
+declare module '#auth-utils' {
+  interface UserSession {
+    user: {
+      spotify?: any
+      github?: any
+    }
+    loggedInAt: number
+  }
+}

playground/server/routes/auth/github.get.ts

@@ -3,7 +3,8 @@ export default oauth.githubEventHandler({
     await setUserSession(event, {
       user: {
         github: user,
-      }
+      },
+      loggedInAt: Date.now()
     })
 
     return sendRedirect(event, '/')

playground/server/routes/auth/spotify.get.ts

@@ -3,7 +3,8 @@ export default oauth.spotifyEventHandler({
     await setUserSession(event, {
       user: {
         spotify: user,
-      }
+      },
+      loggedInAt: Date.now()
     })
 
     return sendRedirect(event, '/')

src/module.ts

@@ -24,6 +24,8 @@ export default defineNuxtModule<ModuleOptions>({
       }
     }
 
+    nuxt.options.alias['#auth-utils'] = resolver.resolve('./runtime/types/auth-utils-session')
+
     // App
     addImportsDir(resolver.resolve('./runtime/composables'))
     addPlugin(resolver.resolve('./runtime/plugins/session.server'))

src/runtime/composables/session.ts

@@ -1,6 +1,5 @@
 import { useState, computed, useRequestFetch } from '#imports'
-// import { UserSession } from '../server/utils/session'
-interface UserSession {}
+import type { UserSession } from '#auth-utils'
 
 const useSessionState = () => useState<UserSession>('nuxt-session', () => ({}))
 

src/runtime/server/utils/session.ts

@@ -2,11 +2,7 @@ import type { H3Event } from 'h3'
 import { useSession, createError } from 'h3'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
-
-export interface UserSession {
-  user?: any
-  [key: string]: any
-}
+import type { UserSession } from '#auth-utils'
 
 export async function getUserSession (event: H3Event) {
   return (await _useSession(event)).data as UserSession

src/runtime/types/auth-utils-session.ts

@@ -0,0 +1,3 @@
+export interface UserSession {
+  user?: {}
+}