fix: improve mfa.enroll return types

[aloisklink]

What kind of change does this PR introduce?

Bug fix for the TypeScript types.

What is the current behavior?

• Fixes mfa.enroll's return type has a TypeScript breaking change in v2.65.0 #955

What is the new behavior?

Use TypeScript's function overloading to return

• TOTP data when mfa.enroll was passed factorType: 'totp',
• phone data when mfa.enroll was passed factorType: 'phone'.

This fixes a breaking change in the types in b957c30.

Additional context

This PR would also expose the new following types:

• MFAEnrollTOTPParams
• MFAEnrollPhoneParams
• AuthMFAEnrollTOTPResponse
• AuthMFAEnrollPhoneResponse
• AuthMFAEnrollErrorResponse (it might be better to roll this type in with the other two).

It might be better to keep these types private, since once they're exposed, you can't easily remove them again without creating a breaking change.

[J0]

It might be better to keep these types private, since once they're exposed, you can't easily remove them again without creating a breaking change.

Would agree with this

Thanks for the PR! Looks great so far

[J0]

Will follow up with the corresponding PR for challengeParams and verifyParams (if they are at all needed)

Upd: shouldn't be needed, except in relation to MFA (WebAuthn).

[aloisklink]

It might be better to keep these types private, since once they're exposed, you can't easily remove them again without creating a breaking change.

Would agree with this

If you are still interested in this, I think the easiest way to do this would be to make a new file called something like src/lib/internal-types.ts that isn't exported outside of the package using export * from './lib/types'.

Then, src/GoTrueClient.ts and src/lib/types.ts could both import types from this file.

(the hardest thing would be picking the right conventional commit prefix 😆, since this PR has already been merged, but not released, so it's not yet a breaking change)

Will follow up with the corresponding PR for challengeParams and verifyParams (if they are at all needed)

Upd: shouldn't be needed, except in relation to MFA (WebAuthn).

Yep, we use both supabase.auth.mfa.challenge and supabase.auth.mfa.verify in our code (based of the example in https://github.com/supabase/supabase/blob/10ba4999cd33f796e89c50a0821e46b3d346eb7c/apps/docs/content/guides/auth/auth-mfa/totp.mdx?plain=1#L245-L261), and v2.65.0 works fine in those cases!

And I'm excited to see WebAuthn support!

[J0]

@aloisklink, thanks for the update.

I think an internal-types file would work. Let me do that shortly. Thanks!