@react-native-firebase/auth 16.4.2 → 16.4.4

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [16.4.4](https://github.com/invertase/react-native-firebase/compare/v16.4.3...v16.4.4) (2022-11-14)
+
+### Bug Fixes
+
+- **auth, multifactor:** put multiFactor and getMultiFactorResolver on auth() ([357094e](https://github.com/invertase/react-native-firebase/commit/357094e4b7504165081ffda0c4105569480f5b79))
+
+### [16.4.3](https://github.com/invertase/react-native-firebase/compare/v16.4.2...v16.4.3) (2022-11-06)
+
+### Bug Fixes
+
+- **auth, types:** augment multi-factor auth types ([5f183c4](https://github.com/invertase/react-native-firebase/commit/5f183c45301c0a5727a45688e69d0944c04e102a))
+
 ### [16.4.2](https://github.com/invertase/react-native-firebase/compare/v16.4.1...v16.4.2) (2022-11-04)
 
 **Note:** Version bump only for package @react-native-firebase/auth

package/lib/index.d.ts

@@ -194,6 +194,11 @@ export namespace FirebaseAuthTypes {
     ERROR: 'error';
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface MultiFactorSession {
+    // this is has no documented contents, it is simply returned from some APIs and passed to others
+  }
+
   export interface PhoneMultiFactorGenerator {
     /**
      * Identifies second factors of type phone.
@@ -417,6 +422,22 @@ export namespace FirebaseAuthTypes {
     secret: string;
   }
 
+  export interface PhoneMultiFactorEnrollInfoOptions {
+    phoneNumber: string;
+    session: MultiFactorSession;
+  }
+
+  export interface PhoneMultiFactorSignInInfoOptions {
+    multiFactorHint?: MultiFactorInfo;
+
+    /**
+     * Unused in react-native-firebase ipmlementation
+     */
+    multiFactorUid?: string;
+
+    session: MultiFactorSession;
+  }
+
   /**
    * Facilitates the recovery when a user needs to provide a second factor to sign-in.
    */
@@ -428,12 +449,12 @@ export namespace FirebaseAuthTypes {
     /**
      * Serialized session this resolver belongs to.
      */
-    session: string;
+    session: MultiFactorSession;
 
     /**
      * For testing purposes only
      */
-    _auth: FirebaseAuthTypes.Module;
+    _auth?: FirebaseAuthTypes.Module;
 
     /**
      * Resolve the multi factor flow.
@@ -473,9 +494,9 @@ export namespace FirebaseAuthTypes {
     enrolledFactors: MultiFactorInfo[];
 
     /**
-     * Return the session id for this user.
+     * Return the session for this user.
      */
-    getSession(): Promise<string>;
+    getSession(): Promise<MultiFactorSession>;
 
     /**
      * Enroll an additional factor. Provide an optional display name that can be shown to the user.
@@ -1566,7 +1587,18 @@ export namespace FirebaseAuthTypes {
     /**
      * Obtain a verification id to complete the multi-factor sign-in flow.
      */
-    verifyPhoneNumberWithMultiFactorInfo(hint: MultiFactorInfo, session: string): Promise<string>;
+    verifyPhoneNumberWithMultiFactorInfo(
+      hint: MultiFactorInfo,
+      session: MultiFactorSession,
+    ): Promise<string>;
+
+    /**
+     * Send an SMS to the user for verification of second factor
+     * @param phoneInfoOptions the phone number and session to use during enrollment
+     */
+    verifyPhoneNumberForMultiFactor(
+      phoneInfoOptions: PhoneMultiFactorEnrollInfoOptions,
+    ): Promise<string>;
 
     /**
      * Creates a new user with an email and password.
@@ -1839,6 +1871,19 @@ export namespace FirebaseAuthTypes {
      * @param url: emulator URL, must have host and port (eg, 'http://localhost:9099')
      */
     useEmulator(url: string): void;
+    /**
+     * Provides a MultiFactorResolver suitable for completion of a multi-factor flow.
+     *
+     * @param error: The MultiFactorError raised during a sign-in, or reauthentication operation.
+     */
+    getMultiFactorResolver(error: MultiFactorError): MultiFactorResolver;
+    /**
+     * The MultiFactorUser corresponding to the user.
+     *
+     * This is used to access all multi-factor properties and operations related to the user.
+     * @param user The user.
+     */
+    multiFactor(user: User): MultiFactorUser;
   }
 }
 

package/lib/index.js

@@ -42,7 +42,7 @@ import Settings from './Settings';
 import User from './User';
 import version from './version';
 import { getMultiFactorResolver } from './getMultiFactorResolver';
-import { multiFactor } from './multiFactor';
+import { multiFactor, MultiFactorUser } from './multiFactor';
 
 const statics = {
   AppleAuthProvider,
@@ -414,6 +414,17 @@ class FirebaseAuthModule extends FirebaseModule {
     this.native.useEmulator(host, port);
     return [host, port]; // undocumented return, useful for unit testing
   }
+
+  getMultiFactorResolver(error) {
+    return getMultiFactorResolver(this, error);
+  }
+
+  multiFactor(user) {
+    if (user.userId !== this.currentUser.userId) {
+      throw new Error('firebase.auth().multiFactor() only operates on currentUser');
+    }
+    return new MultiFactorUser(this, user);
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/auth';

package/lib/multiFactor.js

@@ -2,14 +2,19 @@
  * Return a MultiFactorUser instance the gateway to multi-factor operations.
  */
 export function multiFactor(auth) {
+  // eslint-disable-next-line no-console
+  console.warn('This method is deprecated. Please use auth().multiFactor(user) instead');
   return new MultiFactorUser(auth);
 }
 
 export class MultiFactorUser {
-  constructor(auth) {
+  constructor(auth, user) {
     this._auth = auth;
-    this._user = auth.currentUser;
-    this.enrolledFactor = auth.currentUser.multiFactor.enrolledFactors;
+    if (user === undefined) {
+      user = auth.currentUser;
+    }
+    this._user = user;
+    this.enrolledFactor = user.multiFactor.enrolledFactors;
   }
 
   getSession() {

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '16.4.2';
+module.exports = '16.4.4';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/auth",
-  "version": "16.4.2",
+  "version": "16.4.4",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - The authentication module provides an easy-to-use API to integrate an authentication workflow into new and existing applications. React Native Firebase provides access to all Firebase authentication methods and identity providers.",
   "main": "lib/index.js",
@@ -24,11 +24,11 @@
     "auth"
   ],
   "dependencies": {
-    "@expo/config-plugins": "^5.0.1",
+    "@expo/config-plugins": "^5.0.4",
     "plist": "^3.0.5"
   },
   "peerDependencies": {
-    "@react-native-firebase/app": "16.4.2"
+    "@react-native-firebase/app": "16.4.4"
   },
   "publishConfig": {
     "access": "public"
@@ -36,5 +36,5 @@
   "devDependencies": {
     "@types/plist": "^3.0.2"
   },
-  "gitHead": "f6cd1236f02d5f2f806e95532ef8a11f2c9f17f8"
+  "gitHead": "09c047ac956a44696199df0c52665c0b4446e463"
 }