feat: add flag to disable getSession after signIn on local provider (#702)

* feat: ✨ add flag to disable getSession after signIn on local provider

* feat: ✨ add flag to disable getSession after signIn on refresh provider

* docs: ✨ add flag to disable getSession after signIn on local/refresh provider

* fix: 🐛 sync refresh provider redirect external with local provider

* refactor: ♻️ rename withGetSession boolean to withSession

* docs: 📝 add example to disable getSession with signIn local provider

* feat: 🏷️ add withSession flag to SecondarySignInOptions interface

* revert: style: 🎨 remove markdownlint md034 url change

* docs: 📝 improve type documentation

Co-authored-by: Marsel Shaikhin <[email protected]>

* refactor: ♻️ rename withSession to callGetSession

---------

Co-authored-by: Marsel Shaikhin <[email protected]>

Author: bitfactory-frank-spee

docs/guide/application-side/session-access.md

@@ -210,6 +210,9 @@ await signIn(credentials, { callbackUrl: '/protected' })
 
 // Trigger a signIn with a redirect to an external page afterwards
 await signIn(credentials, { callbackUrl: 'https://nuxt.org', external: true })
+
+// Trigger a signIn without calling getSession directly. You have to manually call it to get session data.
+await signIn(credentials, { callGetSession: false })
 ```
 
 :::
@@ -321,6 +324,7 @@ setToken('new token')
 // Helper method to quickly delete the token cookie (alias for rawToken.value = null)
 clearToken()
 ```
+
 :::
 
 :::warning Local provider:

src/runtime/composables/local/useAuth.ts

@@ -55,9 +55,12 @@ const signIn: SignInFunc<Credentials, any> = async (credentials, signInOptions,
     rawRefreshToken.value = extractedRefreshToken
   }
 
-  await nextTick(getSession)
+  const { redirect = true, external, callGetSession = true } = signInOptions ?? {}
+
+  if (callGetSession) {
+    await nextTick(getSession)
+  }
 
-  const { redirect = true, external } = signInOptions ?? {}
   let { callbackUrl } = signInOptions ?? {}
   if (typeof callbackUrl === 'undefined') {
     const redirectQueryParam = useRoute()?.query?.redirect

src/runtime/types.ts

@@ -574,6 +574,12 @@ export interface SecondarySignInOptions extends Record<string, unknown> {
    * @default false
    */
   external?: boolean
+  /**
+   * Whether `getSession` needs to be called after a successful sign-in. When set to false, you can manually call `getSession` to obtain the session data.
+   *
+   * @default true
+   */
+  callGetSession?: boolean
 }
 
 export interface SignUpOptions extends SecondarySignInOptions {