fix(auth, types): verifyPasswordResetCode returns Promise<string> with email address

[ShaneZhengNZ]

Function verifyPasswordResetCode does return the email address string if valid, therefore, update the TypeScript definition to match.

Description

verifyPasswordResetCode does return string result, without the correct typing, we are forced to ignore the linting warning.

Related issues

n/a

Release Summary

n/a

Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • Yes
• My change supports the following platforms;
  • Android
  • iOS
• My change includes tests;
  • e2e tests added or updated in packages/\*\*/e2e
  • jest tests added or updated in packages/\*\*/__tests__
• I have updated TypeScript types that are affected by my change.
• This is a breaking change;
  • Yes
  • No

Test Plan

---

Think react-native-firebase is great? Please consider supporting the project with any of the below:

• 👉 Star this repo on GitHub ⭐️
• 👉 Follow React Native Firebase and Invertase on Twitter

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
react-native-firebase	✅ Ready (Inspect)	Visit Preview	Sep 15, 2022 at 3:09AM (UTC)

1 Ignored Deployment

Name	Status	Preview	Updated
react-native-firebase-next	⬜️ Ignored (Inspect)		Sep 15, 2022 at 3:09AM (UTC)

[codecov]

Codecov Report

Merging #6537 (08b528b) into main (dc74643) will decrease coverage by 0.40%.
The diff coverage is 100.00%.

❗ Current head 08b528b differs from pull request most recent head 1b8c655. Consider uploading reports for the commit 1b8c655 to get more accurate results

@@             Coverage Diff              @@
##               main    #6537      +/-   ##
============================================
- Coverage     54.90%   54.50%   -0.39%     
+ Complexity      689      679      -10     
============================================
  Files           208      208              
  Lines         10358    10358              
  Branches       1645     1645              
============================================
- Hits           5686     5645      -41     
- Misses         4371     4432      +61     
+ Partials        301      281      -20     

[mikehardy]

Indeed it does - good catch
JS SDK has it in the api (here's v8, but v9 too) https://firebase.google.com/docs/reference/js/v8/firebase.auth.Auth#verifypasswordresetcode
iOS returns it https://github.com/invertase/react-native-firebase/blob/main/packages/auth/ios/RNFBAuth/RNFBAuthModule.m#L934
android https://firebase.google.com/docs/reference/android/com/google/firebase/auth/FirebaseAuth#public-taskstring-verifypasswordresetcode-string-code

💥 nice