CompleteNewPassword requiredAttributes is not optional

[joeltio]

Describe the bug
The Auth.completeNewPassword should only require two arguments: user and password but the types do not reflect so. The signature of the function is:

completeNewPassword(user: CognitoUser | any, password: string, requiredAttributes: any, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>

Notice how requiredAttributes is not optional. However, the docs say that it is optional.

To Reproduce
Steps to reproduce the behavior:

1. Create a typescript-enabled project
2. Import the Auth package
3. Type Auth.completeNewPassword('', '')
4. See error

Expected behavior
There should not be an error reported by typescript.

Code Snippet

import Auth from '@aws-amplify/auth';
Auth.completeNewPassword('', '');

[elorzafe]

Thanks @joeltio I will send a PR to fix this

[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 *-help channels or Discussions for those types of questions.