feat(session): ✨ Updated refresh to include session and added refresh…

… hook

README.md

@@ -323,6 +323,8 @@ The following hooks are available to extend the default behavior of the OIDC mod
 - `clear` (Called before a user session is cleared)
 - `refresh` (Called before a user session is refreshed)
 
+:warning: Remember to also update the refresh hook if you modify the session, as claims and other fields would otherwise be wiped.
+
 #### Example
 
 ```ts
@@ -333,9 +335,17 @@ export default defineNitroPlugin(() => {
     // session.extended = {
     //   fromHooks: true
     // }
-    console.log('Injecting "country" claim as test')
+    console.log('Injecting "status" claim as test')
+    if (!(Object.keys(session).length === 0)) {
+      const claimToAdd = { status: 'Fetch' }
+      session.claims = { ...session.claims, ...claimToAdd }
+    }
+  })
+
+  sessionHooks.hook('refresh', async (session) => {
+    console.log('Injecting "status" claim as test on refresh')
     if (!(Object.keys(session).length === 0)) {
-      const claimToAdd = { country: 'Germany' }
+      const claimToAdd = { status: 'Refresh' }
       session.claims = { ...session.claims, ...claimToAdd }
     }
   })

playground/nuxt.config.ts

@@ -64,6 +64,8 @@ export default defineNuxtConfig({
         clientId: '',
         clientSecret: '',
         redirectUri: 'http://localhost:3000/auth/keycloak/callback',
+        exposeAccessToken: true,
+        userNameClaim: 'preferred_username',
       },
     },
     session: {

playground/package.json

@@ -17,6 +17,6 @@
     "@iconify-json/simple-icons": "^1.2.3",
     "@nuxtjs/color-mode": "^3.5.1",
     "@unocss/nuxt": "^0.62.4",
-    "nuxt-oidc-auth": "workspace:^"
+    "nuxt-oidc-auth": "latest"
   }
 }

playground/server/plugins/session.ts

@@ -6,9 +6,17 @@ export default defineNitroPlugin(() => {
     //   fromHooks: true
     // }
     // eslint-disable-next-line no-console
-    console.log('Injecting "country" claim as test')
+    console.log('Injecting "status" claim as test on fetch')
     if (!(Object.keys(session).length === 0)) {
-      const claimToAdd = { country: 'Germany' }
+      const claimToAdd = { status: 'Fetch' }
+      session.claims = { ...session.claims, ...claimToAdd }
+    }
+  })
+
+  sessionHooks.hook('refresh', async (session) => {
+    console.log('Injecting "status" claim as test on refresh')
+    if (!(Object.keys(session).length === 0)) {
+      const claimToAdd = { status: 'Refresh' }
       session.claims = { ...session.claims, ...claimToAdd }
     }
   })

src/runtime/composables/oidcAuth.ts

@@ -27,8 +27,12 @@ export function useOidcAuth() {
    * @returns {Promise<void>}
    */
   async function refresh(): Promise<void> {
-    await $fetch('/api/_auth/refresh', { method: 'POST' })
-    await fetch()
+    useSessionState().value = (await useRequestFetch()('/api/_auth/refresh', {
+      headers: {
+        Accept: 'text/json',
+      },
+      method: 'POST',
+    }).catch(() => (undefined)) as UserSession)
   }
 
   /**

src/runtime/server/api/refresh.post.ts

@@ -1,8 +1,9 @@
 import { eventHandler } from 'h3'
-import { getUserSession, refreshUserSession } from '../utils/session'
+import { getUserSession, refreshUserSession, sessionHooks } from '../utils/session'
 
 export default eventHandler(async (event) => {
   await getUserSession(event)
-  await refreshUserSession(event)
-  return { refreshed: true }
+  const session = await refreshUserSession(event)
+  await sessionHooks.callHookParallel('refresh', session, event)
+  return session
 })

src/runtime/server/utils/session.ts

@@ -89,7 +89,7 @@ export async function refreshUserSession(event: H3Event) {
   await useStorage('oidc').setItem<PersistentSession>(session.id as string, updatedPersistentSession)
   await session.update(defu(user, session.data))
 
-  return true
+  return session.data
 }
 
 // Deprecated, please use getUserSession