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

docs/content/3.application-side/2.session-access-and-management.md

@@ -4,6 +4,7 @@
 
 The `useAuth` composable is your main gateway to accessing and manipulating session-state and data. Here's the main methods you can use:
 ::code-group
+
 ```ts [authjs]
 const {
   status,
@@ -52,6 +53,7 @@ await signOut()
 // Trigger a sign-out and send the user to the sign-out page afterwards
 await signOut({ callbackUrl: '/signout' })
 ```
+
 ```ts [local]
 const {
   status,
@@ -103,12 +105,16 @@ await signIn(credentials, { callbackUrl: '/protected' })
 // Trigger a sign-in with a redirect afterwards to an external page (if set, this will cause a hard refresh of the page)
 await signIn(credentials, { callbackUrl: 'https://sidebase.io', external: true })
 
+// Trigger a sign-in without calling getSession directly. You have to manually call it to get session data.
+await signIn(credentials, { withGetSession: false })
+
 // Trigger a sign-out
 await signOut()
 
 // Trigger a sign-out and send the user to the sign-out page afterwards
 await signOut({ callbackUrl: '/signout' })
 ```
+
 ```ts [refresh]
 const {
   status,
@@ -150,6 +156,9 @@ await signIn(credentials, { callbackUrl: '/protected' })
 // Trigger a sign-in with a redirect afterwards to an external page (if set, this will cause a hard refresh of the page)
 await signIn(credentials, { callbackUrl: 'https://sidebase.io', external: true })
 
+// Trigger a sign-in without calling getSession directly. You have to manually call it to get session data.
+await signIn(credentials, { withGetSession: false })
+
 // Trigger a refresh, this will set token to new value
 await refresh()
 
@@ -159,17 +168,20 @@ await signOut()
 // Trigger a sign-out and send the user to the sign-out page afterwards
 await signOut({ callbackUrl: '/signout' })
 ```
+
 ::
 
 ## `SessionData`
 
 As described above you can use:
+
 ```ts
 const { data } = useAuth()
 ```
 
 to access the session-data of the currently logged in user. Depending on the provider you use, this data will be typed differently:
 ::code-group
+
 ```ts [authjs]
 interface SessionData {
   user?: {
@@ -180,6 +192,7 @@ interface SessionData {
   expires: ISODateString;
 }
 ```
+
 ```ts [local]
 // Option A: No explicit configuration
 inferface SessionData { 
@@ -194,6 +207,7 @@ inferface SessionData {
   role: 'admin' | 'guest' | 'account'
 }
 ```
+
 ::
 
 ### About `auth.provider.sessionDataType`
@@ -208,10 +222,12 @@ Calling `getSession` will by default **only** refetch the current session if the
 Passing the `{ force: true }` option will always update the current session:
 
 ::code-group
+
 ```ts [local]
 // force update the current session
 await getSession({ force: true })
 ```
+
 ::
 
 ## Automatic session refreshing
@@ -223,13 +239,15 @@ You can also pass the `callbackUrl` option to both the `signIn`, the `signOut` a
 
 You can use it like:
 ::code-group
+
 ```ts [authjs]
 await signIn(undefined, { callbackUrl: '/protected' })
 
 await signOut({ callbackUrl: '/protected' })
 
 await getSession({ callbackUrl: '/protected' })
 ```
+
 ```ts [local]
 const credentials = { username: 'bernd', password: 'hunter2' }
 await signIn(credentials, { callbackUrl: '/protected' })
@@ -238,6 +256,7 @@ await signOut(credentials, { callbackUrl: '/protected' })
 
 await getSession(credentials, { callbackUrl: '/protected' })
 ```
+
 ```ts [refresh]
 const credentials = { username: 'bernd', password: 'hunter2' }
 await signIn(credentials, { callbackUrl: '/protected' })
@@ -246,13 +265,15 @@ await signOut(credentials, { callbackUrl: '/protected' })
 
 await getSession(credentials, { callbackUrl: '/protected' })
 ```
+
 ::
 
 ## `useAuthState` Composable
 
 The `useAuthState` composable is the underlying storage layer to access the session-state and data. Here's the main methods and properties you can use:
 
 ::code-group
+
 ```ts [authjs]
 const {
   status,
@@ -273,6 +294,7 @@ data.value
 // Time at which the session was last refreshed, either `undefined` if no refresh was attempted or a `Date`-object of the time the refresh happened
 lastRefreshedAt.value
 ```
+
 ```ts [local]
 const {
   status,
@@ -354,6 +376,7 @@ setToken('new token')
 // Helper method to quickly delete the token and refresh Token cookie (alias for rawToken.value = null and rawRefreshToken.value = null)
 clearToken()
 ```
+
 ::
 
 ::alert{type="warning"}

src/runtime/composables/local/useAuth.ts

@@ -35,9 +35,12 @@ const signIn: SignInFunc<Credentials, any> = async (credentials, signInOptions,
   const { rawToken } = useAuthState()
   rawToken.value = extractedToken
 
-  await nextTick(getSession)
+  const { callbackUrl, redirect = true, external, withGetSession = true } = signInOptions ?? {}
+
+  if (withGetSession) {
+    await nextTick(getSession)
+  }
 
-  const { callbackUrl, redirect = true, external } = signInOptions ?? {}
   if (redirect) {
     const urlToNavigateTo = callbackUrl ?? await getRequestURLWN(nuxt)
     return navigateTo(urlToNavigateTo, { external })

src/runtime/composables/refresh/useAuth.ts

@@ -66,12 +66,15 @@ const signIn: ReturnType<typeof useLocalAuth>['signIn'] = async (
   rawToken.value = extractedToken
   rawRefreshToken.value = extractedRefreshToken
 
-  await nextTick(getSession)
+  const { callbackUrl, redirect = true, external, withGetSession = true } = signInOptions ?? {}
+
+  if (withGetSession) {
+    await nextTick(getSession)
+  }
 
-  const { callbackUrl, redirect = true } = signInOptions ?? {}
   if (redirect) {
     const urlToNavigateTo = callbackUrl ?? (await getRequestURLWN(nuxt))
-    return navigateTo(urlToNavigateTo)
+    return navigateTo(urlToNavigateTo, { external })
   }
 }