@react-native-firebase/auth 18.3.2 → 18.5.0

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.
 
+## [18.5.0](https://github.com/invertase/react-native-firebase/compare/v18.4.0...v18.5.0) (2023-09-22)
+
+### Features
+
+- **auth:** Expose modular API that matches the Firebase web JS SDK v9 API ([e3a93bc](https://github.com/invertase/react-native-firebase/commit/e3a93bcd478ee48829d14e3016cafcd22edbd4d4))
+
+## [18.4.0](https://github.com/invertase/react-native-firebase/compare/v18.3.2...v18.4.0) (2023-09-11)
+
+**Note:** Version bump only for package @react-native-firebase/auth
+
 ## [18.3.2](https://github.com/invertase/react-native-firebase/compare/v18.3.1...v18.3.2) (2023-09-02)
 
 **Note:** Version bump only for package @react-native-firebase/auth

package/lib/index.js

@@ -18,17 +18,23 @@
 import {
   isAndroid,
   isBoolean,
-  isString,
   isNull,
+  isString,
   isValidUrl,
 } from '@react-native-firebase/app/lib/common';
 import {
-  createModuleNamespace,
   FirebaseModule,
+  createModuleNamespace,
   getFirebaseRoot,
 } from '@react-native-firebase/app/lib/internal';
 import ConfirmationResult from './ConfirmationResult';
 import PhoneAuthListener from './PhoneAuthListener';
+import PhoneMultiFactorGenerator from './PhoneMultiFactorGenerator';
+import Settings from './Settings';
+import User from './User';
+import { getMultiFactorResolver } from './getMultiFactorResolver';
+import { MultiFactorUser, multiFactor } from './multiFactor';
+import AppleAuthProvider from './providers/AppleAuthProvider';
 import EmailAuthProvider from './providers/EmailAuthProvider';
 import FacebookAuthProvider from './providers/FacebookAuthProvider';
 import GithubAuthProvider from './providers/GithubAuthProvider';
@@ -36,14 +42,77 @@ import GoogleAuthProvider from './providers/GoogleAuthProvider';
 import OAuthProvider from './providers/OAuthProvider';
 import OIDCAuthProvider from './providers/OIDCAuthProvider';
 import PhoneAuthProvider from './providers/PhoneAuthProvider';
-import PhoneMultiFactorGenerator from './PhoneMultiFactorGenerator';
 import TwitterAuthProvider from './providers/TwitterAuthProvider';
-import AppleAuthProvider from './providers/AppleAuthProvider';
-import Settings from './Settings';
-import User from './User';
 import version from './version';
-import { getMultiFactorResolver } from './getMultiFactorResolver';
-import { multiFactor, MultiFactorUser } from './multiFactor';
+
+export {
+  applyActionCode,
+  beforeAuthStateChanged,
+  checkActionCode,
+  confirmPasswordReset,
+  connectAuthEmulator,
+  createUserWithEmailAndPassword,
+  deleteUser,
+  fetchSignInMethodsForEmail,
+  getAdditionalUserInfo,
+  getAuth,
+  getIdToken,
+  getIdTokenResult,
+  getMultiFactorResolver,
+  getRedirectResult,
+  initializeAuth,
+  isSignInWithEmailLink,
+  linkWithCredential,
+  linkWithPhoneNumber,
+  linkWithPopup,
+  linkWithRedirect,
+  multiFactor,
+  onAuthStateChanged,
+  onIdTokenChanged,
+  parseActionCodeURL,
+  reauthenticateWithCredential,
+  reauthenticateWithPhoneNumber,
+  reauthenticateWithPopup,
+  reauthenticateWithRedirect,
+  reload,
+  sendEmailVerification,
+  sendPasswordResetEmail,
+  sendSignInLinkToEmail,
+  setPersistence,
+  signInAnonymously,
+  signInWithCredential,
+  signInWithCustomToken,
+  signInWithEmailAndPassword,
+  signInWithEmailLink,
+  signInWithPhoneNumber,
+  signInWithPopup,
+  signInWithRedirect,
+  signOut,
+  unlink,
+  updateCurrentUser,
+  updateEmail,
+  updatePassword,
+  updatePhoneNumber,
+  updateProfile,
+  useDeviceLanguage,
+  useUserAccessGroup,
+  verifyBeforeUpdateEmail,
+  verifyPasswordResetCode,
+  verifyPhoneNumber,
+} from './modular/index';
+// For modular imports
+export {
+  AppleAuthProvider,
+  EmailAuthProvider,
+  PhoneAuthProvider,
+  GoogleAuthProvider,
+  GithubAuthProvider,
+  TwitterAuthProvider,
+  FacebookAuthProvider,
+  PhoneMultiFactorGenerator,
+  OAuthProvider,
+  OIDCAuthProvider,
+};
 
 const statics = {
   AppleAuthProvider,

package/lib/modular/index.js

@@ -0,0 +1,467 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { isString } from '@react-native-firebase/app/lib/common';
+import { firebase } from '..';
+
+/*
+ * Returns the Auth instance associated with the provided FirebaseApp.
+ */
+class Auth {
+  constructor(app) {
+    this.app = app ? firebase.app(app.name) : firebase.app();
+    this._languageCode = this.app.auth().languageCode;
+  }
+
+  get config() {
+    return this.app.auth().config;
+  }
+
+  get currentUser() {
+    return this.app.auth().currentUser;
+  }
+
+  get languageCode() {
+    return this._languageCode;
+  }
+
+  set languageCode(code) {
+    if (code === null || isString(code)) {
+      this._languageCode = code;
+      this.app.auth().languageCode = code;
+      return;
+    }
+    throw new Error("expected 'languageCode' to be a string or null value");
+  }
+
+  get settings() {
+    return this.app.auth().settings;
+  }
+
+  get tenantId() {
+    return this.app.auth().tenantId;
+  }
+}
+
+/*
+ * Returns the Auth instance associated with the provided FirebaseApp.
+ *
+ * If no instance exists, initializes an Auth instance with platform-specific default dependencies.
+ */
+export function getAuth(app) {
+  return new Auth(app);
+}
+
+function _getUnderlyingAuth(auth) {
+  return auth.app.auth();
+}
+
+/*
+ * This function allows more control over the Auth instance than getAuth().
+ *
+ * getAuth uses platform-specific defaults to supply the Dependencies.
+ * In general, getAuth is the easiest way to initialize Auth and works for most use cases.
+ * Use initializeAuth if you need control over which persistence layer is used, or to minimize bundle size
+ * if you're not using either signInWithPopup or signInWithRedirect.
+ */
+export function initializeAuth(app, deps) {
+  return getAuth(app);
+}
+
+/*
+ * Applies a verification code sent to the user by email or other out-of-band mechanism.
+ *
+ * Returns a promise that resolves when the code is applied successfully.
+ */
+export async function applyActionCode(auth, oobCode) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.applyActionCode(oobCode);
+}
+
+/*
+ * Adds a blocking callback that runs before an auth state change sets a new user.
+ */
+export function beforeAuthStateChanged(auth, callback, onAbort) {
+  throw new Error('beforeAuthStateChanged is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Checks a verification code sent to the user by email or other out-of-band mechanism.
+ */
+export async function checkActionCode(auth, oobCode) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.checkActionCode(oobCode);
+}
+
+/*
+ * Completes the password reset process, given a confirmation code and new password.
+ */
+export async function confirmPasswordReset(auth, oobCode, newPassword) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.confirmPasswordReset(oobCode, newPassword);
+}
+
+/*
+ * Changes the Auth instance to communicate with the Firebase Auth Emulator, instead of production Firebase Auth services.
+ *
+ * This must be called synchronously immediately following the first call to initializeAuth(). Do not use with production credentials as emulator traffic is not encrypted.
+ */
+export function connectAuthEmulator(auth, url, options) {
+  const _auth = _getUnderlyingAuth(auth);
+  _auth.useEmulator(url, options);
+}
+
+/*
+ * Creates a new user account associated with the specified email address and password.
+ */
+export async function createUserWithEmailAndPassword(auth, email, password) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.createUserWithEmailAndPassword(email, password);
+}
+
+/*
+ * Gets the list of possible sign in methods for the given email address.
+ */
+export async function fetchSignInMethodsForEmail(auth, email) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.fetchSignInMethodsForEmail(email);
+}
+
+/*
+ * Provides a MultiFactorResolver suitable for completion of a multi-factor flow.
+ */
+export function getMultiFactorResolver(auth, error) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.getMultiFactorResolver(error);
+}
+
+/*
+ * Returns a UserCredential from the redirect-based sign-in flow.
+ */
+export async function getRedirectResult(auth, resolver) {
+  throw new Error('getRedirectResult is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink().
+ */
+export function isSignInWithEmailLink(auth, emailLink) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.isSignInWithEmailLink(emailLink);
+}
+
+/*
+ * Adds an observer for changes to the user's sign-in state.
+ */
+export function onAuthStateChanged(auth, nextOrObserver) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.onAuthStateChanged(nextOrObserver);
+}
+
+/*
+ * Adds an observer for changes to the signed-in user's ID token.
+ */
+export function onIdTokenChanged(auth, nextOrObserver) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.onIdTokenChanged(nextOrObserver);
+}
+
+/*
+ * Sends a password reset email to the given email address.
+ */
+export async function sendPasswordResetEmail(auth, email, actionCodeSettings) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.sendPasswordResetEmail(email, actionCodeSettings);
+}
+
+/*
+ * Sends a sign-in email link to the user with the specified email.
+ */
+export async function sendSignInLinkToEmail(auth, email, actionCodeSettings) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.sendSignInLinkToEmail(email, actionCodeSettings);
+}
+
+/*
+ * Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.
+ */
+export async function setPersistence(auth, persistence) {
+  throw new Error('setPersistence is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Asynchronously signs in as an anonymous user.
+ */
+export async function signInAnonymously(auth) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInAnonymously();
+}
+
+/*
+ * Asynchronously signs in with the given credentials.
+ */
+export async function signInWithCredential(auth, credential) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInWithCredential(credential);
+}
+
+/*
+ * Asynchronously signs in using a custom token.
+ */
+export async function signInWithCustomToken(auth, customToken) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInWithCustomToken(customToken);
+}
+
+/*
+ * Asynchronously signs in using an email and password.
+ */
+export async function signInWithEmailAndPassword(auth, email, password) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInWithEmailAndPassword(email, password);
+}
+
+/*
+ * Asynchronously signs in using an email and sign-in email link.
+ */
+export async function signInWithEmailLink(auth, email, emailLink) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInWithEmailLink(email, emailLink);
+}
+
+/*
+ * Asynchronously signs in using a phone number.
+ */
+export async function signInWithPhoneNumber(auth, phoneNumber, appVerifier) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signInWithPhoneNumber(phoneNumber);
+}
+
+/*
+ * Asynchronously signs in using a phone number.
+ */
+export function verifyPhoneNumber(auth, phoneNumber, autoVerifyTimeoutOrForceResend, forceResend) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.verifyPhoneNumber(phoneNumber, autoVerifyTimeoutOrForceResend, forceResend);
+}
+
+/*
+Authenticates a Firebase client using a popup-based OAuth authentication flow.
+*/
+export async function signInWithPopup(auth, provider, resolver) {
+  throw new Error('signInWithPopup is unsupported by the native Firebase SDKs');
+}
+
+/*
+Authenticates a Firebase client using a full-page redirect flow.
+*/
+export async function signInWithRedirect(auth, provider, resolver) {
+  throw new Error('signInWithRedirect is unsupported by the native Firebase SDKs');
+}
+
+/*
+Signs out the current user.
+*/
+export async function signOut(auth) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.signOut();
+}
+
+/*
+Asynchronously sets the provided user as Auth.currentUser on the Auth instance.
+*/
+export async function updateCurrentUser(auth, user) {
+  throw new Error('updateCurrentUser is unsupported by the native Firebase SDKs');
+}
+
+/*
+Sets the current language to the default device/browser preference.
+*/
+export function useDeviceLanguage(auth) {
+  throw new Error('useDeviceLanguage is unsupported by the native Firebase SDKs');
+}
+
+/*
+ Sets the current language to the default device/browser preference.
+*/
+export function useUserAccessGroup(auth, userAccessGroup) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.useUserAccessGroup(userAccessGroup);
+}
+
+/*
+Verifies the password reset code sent to the user by email or other out-of-band mechanism.
+*/
+export async function verifyPasswordResetCode(auth, code) {
+  const _auth = _getUnderlyingAuth(auth);
+  return _auth.verifyPasswordResetCode(code);
+}
+
+/*
+ * Parses the email action link string and returns an ActionCodeURL if the link is valid, otherwise returns null.
+ */
+export function parseActionCodeURL(link) {
+  throw new Error('parseActionCodeURL is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Deletes and signs out the user.
+ */
+export async function deleteUser(user) {
+  return user.delete();
+}
+
+/*
+ * Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.
+ */
+export async function getIdToken(user, forceRefresh) {
+  return user.getIdToken(forceRefresh);
+}
+
+/*
+ * Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.
+ */
+export async function getIdTokenResult(user, forceRefresh) {
+  return user.getIdTokenResult(forceRefresh);
+}
+
+/*
+ * Links the user account with the given credentials.
+ */
+export async function linkWithCredential(user, credential) {
+  return user.linkWithCredential(credential);
+}
+
+/*
+ * Links the user account with the given phone number.
+ */
+export async function linkWithPhoneNumber(user, phoneNumber, appVerifier) {
+  throw new Error('linkWithPhoneNumber is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Links the authenticated provider to the user account using a pop-up based OAuth flow.
+ */
+export async function linkWithPopup(user, provider, resolver) {
+  throw new Error('linkWithPopup is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Links the OAuthProvider to the user account using a full-page redirect flow.
+ */
+export async function linkWithRedirect(user, provider, resolver) {
+  throw new Error('linkWithRedirect is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * The MultiFactorUser corresponding to the user.
+ */
+export function multiFactor(user) {
+  return user._auth.multiFactor(user);
+}
+
+/*
+ * Re-authenticates a user using a fresh credential.
+ */
+export async function reauthenticateWithCredential(user, credential) {
+  return user.reauthenticateWithCredential(credential);
+}
+
+/*
+ * Re-authenticates a user using a fresh phone credential.
+ */
+export async function reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) {
+  throw new Error('reauthenticateWithPhoneNumber is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Reauthenticates the current user with the specified OAuthProvider using a pop-up based OAuth flow.
+ */
+export async function reauthenticateWithPopup(user, provider, resolver) {
+  throw new Error('reauthenticateWithPopup is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Reauthenticates the current user with the specified OAuthProvider using a full-page redirect flow.
+ */
+export async function reauthenticateWithRedirect(user, provider, resolver) {
+  throw new Error('reauthenticateWithRedirect is unsupported by the native Firebase SDKs');
+}
+
+/*
+ * Reloads user account data, if signed in.
+ */
+export async function reload(user) {
+  return user.reload();
+}
+
+/*
+ * Sends a verification email to a user.
+ */
+export async function sendEmailVerification(user, actionCodeSettings) {
+  return user.sendEmailVerification(actionCodeSettings);
+}
+
+/*
+ * Unlinks a provider from a user account.
+ */
+export async function unlink(user, providerId) {
+  return user.unlink(providerId);
+}
+
+/*
+ * Updates the user's email address.
+ */
+export async function updateEmail(user, newEmail) {
+  return user.updateEmail(newEmail);
+}
+
+/*
+ * Updates the user's password.
+ */
+export async function updatePassword(user, newPassword) {
+  return user.updatePassword(newPassword);
+}
+
+/*
+ * Updates the user's phone number.
+ */
+export async function updatePhoneNumber(user, credential) {
+  return user.updatePhoneNumber(credential);
+}
+
+/*
+ * Updates a user's profile data.
+ */
+export async function updateProfile(user, { displayName, photoURL: photoUrl }) {
+  return user.updateProfile({ displayName, photoURL: photoUrl });
+}
+
+/*
+ * Sends a verification email to a new email address.
+ */
+export async function verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) {
+  return user.verifyBeforeUpdateEmail(newEmail, actionCodeSettings);
+}
+
+/*
+ * Extracts provider specific AdditionalUserInfo for the given credential.
+ */
+export function getAdditionalUserInfo(userCredential) {
+  return userCredential.additionalUserInfo;
+}

package/lib/providers/PhoneAuthProvider.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
@@ -18,8 +19,11 @@
 const providerId = 'phone';
 
 export default class PhoneAuthProvider {
-  constructor() {
-    throw new Error('`new PhoneAuthProvider()` is not supported on the native Firebase SDKs.');
+  constructor(auth) {
+    if (auth === undefined) {
+      throw new Error('`new PhoneAuthProvider()` is not supported on the native Firebase SDKs.');
+    }
+    this._auth = auth;
   }
 
   static get PROVIDER_ID() {
@@ -33,4 +37,16 @@ export default class PhoneAuthProvider {
       providerId,
     };
   }
+
+  verifyPhoneNumber(phoneInfoOptions, appVerifier) {
+    if (phoneInfoOptions.multiFactorHint) {
+      return this._auth.app
+        .auth()
+        .verifyPhoneNumberWithMultiFactorInfo(
+          phoneInfoOptions.multiFactorHint,
+          phoneInfoOptions.session,
+        );
+    }
+    return this._auth.app.auth().verifyPhoneNumberForMultiFactor(phoneInfoOptions);
+  }
 }

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/auth",
-  "version": "18.3.2",
+  "version": "18.5.0",
   "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",
@@ -27,7 +27,7 @@
     "plist": "^3.1.0"
   },
   "peerDependencies": {
-    "@react-native-firebase/app": "18.3.2",
+    "@react-native-firebase/app": "18.5.0",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f323891622441c9d59a25ef37b19534db512b372"
+  "gitHead": "c9b695aa8fd75d5a1d070ecbb6bb9ac4e9ff062e"
 }