Invalid types returned from Auth.signIn

[TeoTN]

Describe the bug
The type returned from Auth.signIn method is Promise<CognitoUser | any> which literally gives no type safety.

From what I see, internally (e.g. here ) the user is assigned dynamically a property that is not in its interface (challengeName).

Expected behavior
I expect types in the library to be precise and correct, and challengeName to be typed as well.

I'd suggest following typing:

export type UserChallenge =
  'CUSTOM_CHALLENGE' |
  'NEW_PASSWORD_REQUIRED' |
  'SMS_MFA' |
  'SOFTWARE_TOKEN_MFA' |
  'MFA_SETUP' |
  undefined;

export interface ISignInResult extends CognitoUser {
  challengeName: UserChallenge;
}

[MichalOsadowski]

Is anyone looking into this?

[micksatana]

Is anyone looking into this?

I've a fix on the PR above. It'll resolve 3 related issues in the PR.

[abdallahshaban557]

This issue has been resolved! Appreciate you fixing this @micksatana !

[github-actions]

This issue has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server amplify-help forum.