Invalid type of `SignInResult` when using `redirect: false`

[mubaidr]

Environment

Nuxt project info:

------------------------------
- Operating System: Windows_NT
- Node Version:     v20.4.0
- Nuxt Version:     3.6.5
- Nitro Version:    2.5.2
- Package Manager:  pnpm@8.6.8
- Builder:          vite
- User Config:      runtimeConfig, ssr, app, telemetry, imports, modules, vite, build, postcss, typescript, vue, experimental, nitro
- Runtime Modules:  vuetify-nuxt-module@0.5.3, @sidebase/nuxt-auth@0.6.0-beta.3, @sidebase/nuxt-session@0.2.7, @pinia/nuxt@0.4.11, @vueuse/nuxt@10.2.1, nuxt-security@0.14.2, @nuxt/devtools@0.7.1
- Build Modules:    -
------------------------------

Reproduction

• install module
• try signin using redirect: false
• result of signin is untyped.

Describe the bug

Typescript does not recognize type of SignInResult type, therefore unabel to extract error or url from result without specifying // @ts-ignore

Additional context

const { error, url } = await useAuth().signIn('credentials', {
      username: username.value,
      password: password.value,
      redirect: false,
    })

Logs

No response

P.S. Great job on this module! This was the missing puzzle piece for Nuxt 3. 🥳

[Frallen]

@mubaidr In my case error is always undefined, but request is 200. Do you have the same?

[mubaidr]

@mubaidr In my case error is always undefined, but request is 200. Do you have the same?

The issue is about types not result. Result is fine.

[mathiasrando]

Is there any progress on this? The issue is still present in the newest version even if redirect is true.

[zoey-kaiser]

The issue currently consists of the signIn function returning either:

{ error: string | null, status: number, ok: boolean, url: any } or void, based on the input variables.

Ideally, I would like to type the return of the function, based on the input values. However this causes some more issues:

• If a provider is given that is not configured void is returned (this cannot be known when the input is given)
• If a provider does not support return, void is returned (also don't know this when the input is given)

One "dirty" way to ensure we have better type support is to always return { error: string | null, status: number, ok: boolean, url: any }, but keep the values undefined, in the case a void would be returned. I had a look at Conditional Types, to make it more pretty, but I feel like our setup is too complex to properly integrate conditional types to support all possible returns.

The current ways this issue impacts developer is:

const result = await signIn('credentials', {
    callbackUrl: '/',
    username: 'jsmith',
    password: 'hunter2',
    redirect: false,
})

• No Autocomplete on result
• You cannot spread the result of the signIn function, with proper types (const { error } = signIn() -> error is typed as any, even though we define it as a string or null)

This does pose some problems, when trying to further manage the result

[BracketJohn]

What's the second solution to this you mentioned in our talk?

and: which solution do you prefer? (:

[zoey-kaiser]

What's the second solution to this you mentioned in our talk?

The two solutions were:

• Use Conditional types to always type the return perfectly (I don't even know if this is possible)
• Use a dirty method, where we always return the object, just with nullable values instead of returning void. (I prefer this, as it is more straightfoward)

[FollowJack]

Could you please provide an example of how to get the proper type here when using the signIn method?

That void gets to me.