@react-native-firebase/auth 16.4.1 → 16.4.3

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [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
+
 ### [16.4.1](https://github.com/invertase/react-native-firebase/compare/v16.4.0...v16.4.1) (2022-11-02)
 
 **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.

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/auth",
-  "version": "16.4.1",
+  "version": "16.4.3",
   "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",
@@ -28,7 +28,7 @@
     "plist": "^3.0.5"
   },
   "peerDependencies": {
-    "@react-native-firebase/app": "16.4.1"
+    "@react-native-firebase/app": "16.4.3"
   },
   "publishConfig": {
     "access": "public"
@@ -36,5 +36,5 @@
   "devDependencies": {
     "@types/plist": "^3.0.2"
   },
-  "gitHead": "542cec866fb2e83b7fc4baf3be287bc2c3408229"
+  "gitHead": "fe9e40480d70b0eb6b2a9d4c2c117688c9abcafd"
 }