fix: UserSession secure type augmentation (#181)

* fix: UserSession secure type augmentation * docs: add readme example
atinux · Sep 19, 2024 · 125ea11 · 125ea11
1 parent 23ccd4c
commit 125ea11
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -156,6 +156,10 @@ declare module '#auth-utils' {
   interface UserSession {
     // Add your own fields
   }
+
+  interface SecureSessionData {
+    // Add your own fields
+  }
 }
 
 export {}

diff --git a/src/runtime/types/index.ts b/src/runtime/types/index.ts
@@ -1,2 +1,2 @@
-export type { User, UserSession, UserSessionRequired, UserSessionComposable } from './session'
+export type { User, UserSession, UserSessionRequired, UserSessionComposable, SecureSessionData } from './session'
 export type { OAuthConfig, OAuthProvider, OnError } from './oauth-config'
diff --git a/src/runtime/types/session.ts b/src/runtime/types/session.ts
@@ -3,6 +3,9 @@ import type { ComputedRef, Ref } from 'vue'
 export interface User {
 }
 
+export interface SecureSessionData {
+}
+
 export interface UserSession {
   /**
    * User session data, available on client and server
@@ -11,7 +14,7 @@ export interface UserSession {
   /**
    * Private session data, only available on server/ code
    */
-  secure?: Record<string, unknown>
+  secure?: SecureSessionData
   /**
    * Extra session data, available on client and server
    */