feat: allow disabling session auto-loading

See #309

Author: fredericDelaporte

src/module.ts

@@ -50,6 +50,7 @@ declare module 'nuxt/schema' {
      * Session configuration
      */
     session: SessionConfig
+    disableAuthAutoLoad?: boolean
   }
 }
 
@@ -495,5 +496,10 @@ export default defineNuxtModule<ModuleOptions>({
       tokenURL: '',
       userURL: '',
     })
+
+    // Publicly expose disableAuthAutoLoad if needed
+    if (runtimeConfig.disableAuthAutoLoad && runtimeConfig.public.disableAuthAutoLoad === undefined) {
+      runtimeConfig.public.disableAuthAutoLoad = runtimeConfig.disableAuthAutoLoad
+    }
   },
 })

src/runtime/app/plugins/session.client.ts

@@ -3,14 +3,16 @@ import {} from 'nuxt/app'
 import { defineNuxtPlugin, useUserSession, useError } from '#imports'
 
 export default defineNuxtPlugin(async (nuxtApp) => {
-  if (!nuxtApp.payload.serverRendered) {
-    await useUserSession().fetch()
-  }
-  else if (Boolean(nuxtApp.payload.prerenderedAt) || Boolean(nuxtApp.payload.isCached)) {
-    // To avoid hydration mismatch
-    nuxtApp.hook('app:mounted', async () => {
+  if (!nuxtApp.$config.public.disableAuthAutoLoad) {
+    if (!nuxtApp.payload.serverRendered) {
       await useUserSession().fetch()
-    })
+    }
+    else if (Boolean(nuxtApp.payload.prerenderedAt) || Boolean(nuxtApp.payload.isCached)) {
+      // To avoid hydration mismatch
+      nuxtApp.hook('app:mounted', async () => {
+        await useUserSession().fetch()
+      })
+    }
   }
 
   if (localStorage.getItem('temp-nuxt-auth-utils-popup')) {

src/runtime/app/plugins/session.server.ts

@@ -8,7 +8,7 @@ export default defineNuxtPlugin({
   async setup(nuxtApp) {
     // Flag if request is cached
     nuxtApp.payload.isCached = Boolean(useRequestEvent()?.context.cache)
-    if (nuxtApp.payload.serverRendered && !nuxtApp.payload.prerenderedAt && !nuxtApp.payload.isCached) {
+    if (nuxtApp.payload.serverRendered && !nuxtApp.payload.prerenderedAt && !nuxtApp.payload.isCached && !nuxtApp.$config.disableAuthAutoLoad) {
       await useUserSession().fetch()
     }
   },