feat: include phoneNumber from PhoneMultiFactorInfo

this is useful for indicating to users which phone number they have enrolled, and distinguishing between factors if there are multiple phone factors enrolled.
invertase · May 20, 2024 · 5acdfb3 · 5acdfb3
1 parent a6805bc
commit 5acdfb3
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 6 deletions.
diff --git a/.../auth/android/src/main/java/io/invertase/firebase/auth/ReactNativeFirebaseAuthModule.java b/.../auth/android/src/main/java/io/invertase/firebase/auth/ReactNativeFirebaseAuthModule.java
@@ -2553,6 +2553,10 @@ private WritableMap multiFactorInfoToMap(MultiFactorInfo hint) {
     hintMap.putString("factorId", hint.getFactorId());
     hintMap.putString("uid", hint.getUid());
 
+    if (hint.getFactorId().equals(PhoneMultiFactorGenerator.FACTOR_ID)) {
+      hintMap.putString("phoneNumber", ((PhoneMultiFactorInfo) hint).getPhoneNumber());
+    }
+
     return hintMap;
   }
 

diff --git a/packages/auth/e2e/multiFactor.e2e.js b/packages/auth/e2e/multiFactor.e2e.js
@@ -547,6 +547,7 @@ describe('multi-factor modular', function () {
           this.skip();
         }
         const { phoneNumber, email, password } = await createUserWithMultiFactor();
+        const maskedNumber = '+********' + phoneNumber.substring(phoneNumber.length - 4);
 
         const { signInWithEmailAndPassword, getAuth, getMultiFactorResolver } = authModular;
 
@@ -562,6 +563,9 @@ describe('multi-factor modular', function () {
           multiFactorResolver.should.be.an.Object();
           multiFactorResolver.hints.should.be.an.Array();
           multiFactorResolver.hints.length.should.equal(1);
+          multiFactorResolver.hints[0].factorId.should.equal('phone');
+          multiFactorResolver.hints[0].phoneNumber.should.equal(maskedNumber);
+
           multiFactorResolver.session.should.be.a.String();
 
           const verificationId = await new firebase.auth.PhoneAuthProvider(
@@ -575,7 +579,6 @@ describe('multi-factor modular', function () {
           let verificationCode = await getLastSmsCode(phoneNumber);
           if (verificationCode == null) {
             // iOS simulator uses a masked phone number
-            const maskedNumber = '+********' + phoneNumber.substring(phoneNumber.length - 4);
             verificationCode = await getLastSmsCode(maskedNumber);
           }
           const phoneAuthCredential = new firebase.auth.PhoneAuthProvider.credential(
@@ -591,6 +594,8 @@ describe('multi-factor modular', function () {
               user.email.should.equal('[email protected]');
               user.multiFactor.should.be.an.Object();
               user.multiFactor.enrolledFactors.length.should.equal(1);
+              user.multiFactor.enrolledFactors[0].factorId.should.equal('phone');
+              user.multiFactor.enrolledFactors[0].phoneNumber.should.equal(phoneNumber);
               return Promise.resolve();
             })
             .catch(e => {

diff --git a/packages/auth/ios/RNFBAuth/RNFBAuthModule.m b/packages/auth/ios/RNFBAuth/RNFBAuthModule.m
@@ -1695,6 +1695,8 @@ - (NSDictionary *)firebaseUserToDict:(FIRUser *)user {
       @"enrollmentTime" : enrollmentTime,
       // @deprecated enrollmentDate kept for backwards compatibility, please use enrollmentTime
       @"enrollmentDate" : enrollmentTime,
+      // phoneNumber only present on FIRPhoneMultiFactorInfo
+      @"phoneNumber" : hint.phoneNumber == nil ? [NSNull null] : hint.phoneNumber,
     }];
   }
   return enrolledFactors;

diff --git a/packages/auth/lib/index.d.ts b/packages/auth/lib/index.d.ts
@@ -472,7 +472,21 @@ export namespace FirebaseAuthTypes {
   /**
    * Contains information about a second factor.
    */
-  export interface MultiFactorInfo {
+  export type MultiFactorInfo = PhoneMultiFactorInfo | TotpMultiFactorInfo;
+
+  export interface PhoneMultiFactorInfo extends MultiFactorInfoCommon {
+    factorId: 'phone';
+    /**
+     * The phone number used for this factor.
+     */
+    phoneNumber: string;
+  }
+
+  export interface TotpMultiFactorInfo extends MultiFactorInfoCommon {
+    factorId: 'totp';
+  }
+
+  export interface MultiFactorInfoCommon {
     /**
      * User friendly name for this factor.
      */
@@ -481,10 +495,6 @@ export namespace FirebaseAuthTypes {
      * Time the second factor was enrolled, in UTC.
      */
     enrollmentTime: string;
-    /**
-     * Type of factor.
-     */
-    factorId: FactorId;
     /**
      * Unique id for this factor.
      */