fix(auth): add deprecated signInDetails type to AuthTokens type

[ashwinkumar6]

Description of changes

fetchAuthSession API returns "signInDetails", example

const session = await fetchAuthSession();
session.tokens?.signInDetails

However the return type of this API (AuthSession) does not have this type resulting a signInDetails does not exist on type error

Solution:

• Encourage the use of getCurrentUser API to obtain signInDetails
• Add deprecated type to fetchAuthSession to avoid type error

Issue #, if available

#12868

Description of how you validated changes

Before

After

Checklist

• PR description included
• yarn test passes
• Tests are changed or added
• Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[israx]

The introduction of signInDetails into the getCurrentUser API ended up affecting the output of fetchAuthSession, both APIs consume the same underlying functionality from the Amplify singleton, and it was a miss to detect that in our tests.

The solution to the fix is actually introducing a deprecation warning, which seems totally fine to me. However we are modifying a public interface, which means that we might need to have a follow up with a BR and product.

Other than fixing this issue, ideally we might want to prevent this from happening again. So as an action item, we could add tests to detect the right number of keys expected by a given output.

[josefaidt]

This change looks good to me!

[palpatim]

Seems reasonable to me, as long as we document it on our API spec. Please ping @haverchuck as well.

[haverchuck]

Looks good to me as well. API doc will be updated.

[israx]

LGTM