@firebase/auth 1.7.9 → 1.8.0

package/dist/rn/src/api/account_management/mfa.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { SignInWithPhoneNumberRequest } from '../authentication/sms';
 import { FinalizeMfaResponse } from '../authentication/mfa';
 import { AuthInternal } from '../../model/auth';
@@ -44,7 +45,10 @@ export interface StartPhoneMfaEnrollmentRequest {
     idToken: string;
     phoneEnrollmentInfo: {
         phoneNumber: string;
-        recaptchaToken: string;
+        recaptchaToken?: string;
+        captchaResponse?: string;
+        clientType?: RecaptchaClientType;
+        recaptchaVersion?: RecaptchaVersion;
     };
     tenantId?: string;
 }

package/dist/rn/src/api/authentication/mfa.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { Auth } from '../../model/public_types';
 import { IdTokenResponse } from '../../model/id_token';
 import { MfaEnrollment } from '../account_management/mfa';
@@ -34,7 +35,10 @@ export interface StartPhoneMfaSignInRequest {
     mfaPendingCredential: string;
     mfaEnrollmentId: string;
     phoneSignInInfo: {
-        recaptchaToken: string;
+        recaptchaToken?: string;
+        captchaResponse?: string;
+        clientType?: RecaptchaClientType;
+        recaptchaVersion?: RecaptchaVersion;
     };
     tenantId?: string;
 }

package/dist/rn/src/api/authentication/sms.d.ts

@@ -14,12 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { IdTokenResponse } from '../../model/id_token';
 import { Auth } from '../../model/public_types';
 export interface SendPhoneVerificationCodeRequest {
     phoneNumber: string;
-    recaptchaToken: string;
+    recaptchaToken?: string;
     tenantId?: string;
+    captchaResponse?: string;
+    clientType?: RecaptchaClientType;
+    recaptchaVersion?: RecaptchaVersion;
 }
 export interface SendPhoneVerificationCodeResponse {
     sessionInfo: string;

package/dist/rn/src/api/index.d.ts

@@ -69,7 +69,10 @@ export declare const enum RecaptchaVersion {
 export declare const enum RecaptchaActionName {
     SIGN_IN_WITH_PASSWORD = "signInWithPassword",
     GET_OOB_CODE = "getOobCode",
-    SIGN_UP_PASSWORD = "signUpPassword"
+    SIGN_UP_PASSWORD = "signUpPassword",
+    SEND_VERIFICATION_CODE = "sendVerificationCode",
+    MFA_SMS_ENROLLMENT = "mfaSmsEnrollment",
+    MFA_SMS_SIGNIN = "mfaSmsSignIn"
 }
 export declare const enum EnforcementState {
     ENFORCE = "ENFORCE",
@@ -77,8 +80,9 @@ export declare const enum EnforcementState {
     OFF = "OFF",
     ENFORCEMENT_STATE_UNSPECIFIED = "ENFORCEMENT_STATE_UNSPECIFIED"
 }
-export declare const enum RecaptchaProvider {
-    EMAIL_PASSWORD_PROVIDER = "EMAIL_PASSWORD_PROVIDER"
+export declare const enum RecaptchaAuthProvider {
+    EMAIL_PASSWORD_PROVIDER = "EMAIL_PASSWORD_PROVIDER",
+    PHONE_PROVIDER = "PHONE_PROVIDER"
 }
 export declare const DEFAULT_API_TIMEOUT_MS: Delay;
 export declare function _addTidIfNecessary<T extends {

package/dist/rn/src/platform_browser/providers/phone.d.ts

@@ -74,14 +74,16 @@ export declare class PhoneAuthProvider {
      *
      * @param phoneInfoOptions - The user's {@link PhoneInfoOptions}. The phone number should be in
      * E.164 format (e.g. +16505550101).
-     * @param applicationVerifier - For abuse prevention, this method also requires a
-     * {@link ApplicationVerifier}. This SDK includes a reCAPTCHA-based implementation,
-     * {@link RecaptchaVerifier}.
+     * @param applicationVerifier - An {@link ApplicationVerifier}, which prevents
+     * requests from unauthorized clients. This SDK includes an implementation
+     * based on reCAPTCHA v2, {@link RecaptchaVerifier}. If you've enabled
+     * reCAPTCHA Enterprise bot protection in Enforce mode, this parameter is
+     * optional; in all other configurations, the parameter is required.
      *
      * @returns A Promise for a verification ID that can be passed to
-     * {@link PhoneAuthProvider.credential} to identify this flow..
+     * {@link PhoneAuthProvider.credential} to identify this flow.
      */
-    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;
+    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier?: ApplicationVerifier): Promise<string>;
     /**
      * Creates a phone auth credential, given the verification ID from
      * {@link PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's

package/dist/rn/src/platform_browser/recaptcha/recaptcha.d.ts

@@ -68,4 +68,11 @@ export declare class RecaptchaConfig {
      * @returns Whether or not reCAPTCHA Enterprise protection is enabled for the given provider.
      */
     isProviderEnabled(providerStr: string): boolean;
+    /**
+     * Returns true if reCAPTCHA Enterprise protection is enabled in at least one provider, otherwise
+     * returns false.
+     *
+     * @returns Whether or not reCAPTCHA Enterprise protection is enabled for at least one provider.
+     */
+    isAnyProviderEnabled(): boolean;
 }

package/dist/rn/src/platform_browser/recaptcha/recaptcha_enterprise_verifier.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { RecaptchaActionName } from '../../api';
+import { RecaptchaActionName, RecaptchaAuthProvider } from '../../api';
 import { Auth } from '../../model/public_types';
 import { AuthInternal } from '../../model/auth';
 export declare const RECAPTCHA_ENTERPRISE_VERIFIER_TYPE = "recaptcha-enterprise";
@@ -38,8 +38,8 @@ export declare class RecaptchaEnterpriseVerifier {
      */
     verify(action?: string, forceRefresh?: boolean): Promise<string>;
 }
-export declare function injectRecaptchaFields<T>(auth: AuthInternal, request: T, action: RecaptchaActionName, captchaResp?: boolean): Promise<T>;
-declare type ActionMethod<TRequest, TResponse> = (auth: Auth, request: TRequest) => Promise<TResponse>;
-export declare function handleRecaptchaFlow<TRequest, TResponse>(authInstance: AuthInternal, request: TRequest, actionName: RecaptchaActionName, actionMethod: ActionMethod<TRequest, TResponse>): Promise<TResponse>;
+export declare function injectRecaptchaFields<T>(auth: AuthInternal, request: T, action: RecaptchaActionName, isCaptchaResp?: boolean, isFakeToken?: boolean): Promise<T>;
+declare type ActionMethod<TRequest, TResponse> = (auth: AuthInternal, request: TRequest) => Promise<TResponse>;
+export declare function handleRecaptchaFlow<TRequest, TResponse>(authInstance: AuthInternal, request: TRequest, actionName: RecaptchaActionName, actionMethod: ActionMethod<TRequest, TResponse>, recaptchaAuthProvider: RecaptchaAuthProvider): Promise<TResponse>;
 export declare function _initializeRecaptchaConfig(auth: Auth): Promise<void>;
 export {};

package/dist/rn/src/platform_browser/strategies/phone.d.ts

@@ -27,12 +27,15 @@ import { AuthInternal } from '../../model/auth';
  * provides the code sent to their phone, call {@link ConfirmationResult.confirm}
  * with the code to sign the user in.
  *
- * For abuse prevention, this method also requires a {@link ApplicationVerifier}.
- * This SDK includes a reCAPTCHA-based implementation, {@link RecaptchaVerifier}.
+ * For abuse prevention, this method requires a {@link ApplicationVerifier}.
+ * This SDK includes an implementation based on reCAPTCHA v2, {@link RecaptchaVerifier}.
  * This function can work on other platforms that do not support the
  * {@link RecaptchaVerifier} (like React Native), but you need to use a
  * third-party {@link ApplicationVerifier} implementation.
  *
+ * If you've enabled project-level reCAPTCHA Enterprise bot protection in
+ * Enforce mode, you can omit the {@link ApplicationVerifier}.
+ *
  * This method does not work in a Node.js environment or with {@link Auth} instances created with a
  * {@link @firebase/app#FirebaseServerApp}.
  *
@@ -51,7 +54,7 @@ import { AuthInternal } from '../../model/auth';
  *
  * @public
  */
-export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Links the user account with the given phone number.
  *
@@ -64,7 +67,7 @@ export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, a
  *
  * @public
  */
-export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Re-authenticates a user using a fresh phone credential.
  *
@@ -80,12 +83,12 @@ export declare function linkWithPhoneNumber(user: User, phoneNumber: string, app
  *
  * @public
  */
-export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Returns a verification ID to be used in conjunction with the SMS code that is sent.
  *
  */
-export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInfoOptions | string, verifier: ApplicationVerifierInternal): Promise<string>;
+export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInfoOptions | string, verifier?: ApplicationVerifierInternal): Promise<string>;
 /**
  * Updates the user's phone number.
  *
@@ -110,3 +113,4 @@ export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInf
  * @public
  */
 export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;
+export declare function injectRecaptchaV2Token<T>(auth: AuthInternal, request: T, recaptchaV2Verifier: ApplicationVerifierInternal): Promise<T>;

package/dist/rn/test/integration/flows/recaptcha_enterprise.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ */
+export {};

package/dist/src/api/account_management/mfa.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { SignInWithPhoneNumberRequest } from '../authentication/sms';
 import { FinalizeMfaResponse } from '../authentication/mfa';
 import { AuthInternal } from '../../model/auth';
@@ -44,7 +45,10 @@ export interface StartPhoneMfaEnrollmentRequest {
     idToken: string;
     phoneEnrollmentInfo: {
         phoneNumber: string;
-        recaptchaToken: string;
+        recaptchaToken?: string;
+        captchaResponse?: string;
+        clientType?: RecaptchaClientType;
+        recaptchaVersion?: RecaptchaVersion;
     };
     tenantId?: string;
 }

package/dist/src/api/authentication/mfa.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { Auth } from '../../model/public_types';
 import { IdTokenResponse } from '../../model/id_token';
 import { MfaEnrollment } from '../account_management/mfa';
@@ -34,7 +35,10 @@ export interface StartPhoneMfaSignInRequest {
     mfaPendingCredential: string;
     mfaEnrollmentId: string;
     phoneSignInInfo: {
-        recaptchaToken: string;
+        recaptchaToken?: string;
+        captchaResponse?: string;
+        clientType?: RecaptchaClientType;
+        recaptchaVersion?: RecaptchaVersion;
     };
     tenantId?: string;
 }

package/dist/src/api/authentication/sms.d.ts

@@ -14,12 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { RecaptchaClientType, RecaptchaVersion } from '../index';
 import { IdTokenResponse } from '../../model/id_token';
 import { Auth } from '../../model/public_types';
 export interface SendPhoneVerificationCodeRequest {
     phoneNumber: string;
-    recaptchaToken: string;
+    recaptchaToken?: string;
     tenantId?: string;
+    captchaResponse?: string;
+    clientType?: RecaptchaClientType;
+    recaptchaVersion?: RecaptchaVersion;
 }
 export interface SendPhoneVerificationCodeResponse {
     sessionInfo: string;

package/dist/src/api/index.d.ts

@@ -69,7 +69,10 @@ export declare const enum RecaptchaVersion {
 export declare const enum RecaptchaActionName {
     SIGN_IN_WITH_PASSWORD = "signInWithPassword",
     GET_OOB_CODE = "getOobCode",
-    SIGN_UP_PASSWORD = "signUpPassword"
+    SIGN_UP_PASSWORD = "signUpPassword",
+    SEND_VERIFICATION_CODE = "sendVerificationCode",
+    MFA_SMS_ENROLLMENT = "mfaSmsEnrollment",
+    MFA_SMS_SIGNIN = "mfaSmsSignIn"
 }
 export declare const enum EnforcementState {
     ENFORCE = "ENFORCE",
@@ -77,8 +80,9 @@ export declare const enum EnforcementState {
     OFF = "OFF",
     ENFORCEMENT_STATE_UNSPECIFIED = "ENFORCEMENT_STATE_UNSPECIFIED"
 }
-export declare const enum RecaptchaProvider {
-    EMAIL_PASSWORD_PROVIDER = "EMAIL_PASSWORD_PROVIDER"
+export declare const enum RecaptchaAuthProvider {
+    EMAIL_PASSWORD_PROVIDER = "EMAIL_PASSWORD_PROVIDER",
+    PHONE_PROVIDER = "PHONE_PROVIDER"
 }
 export declare const DEFAULT_API_TIMEOUT_MS: Delay;
 export declare function _addTidIfNecessary<T extends {

package/dist/src/platform_browser/providers/phone.d.ts

@@ -74,14 +74,16 @@ export declare class PhoneAuthProvider {
      *
      * @param phoneInfoOptions - The user's {@link PhoneInfoOptions}. The phone number should be in
      * E.164 format (e.g. +16505550101).
-     * @param applicationVerifier - For abuse prevention, this method also requires a
-     * {@link ApplicationVerifier}. This SDK includes a reCAPTCHA-based implementation,
-     * {@link RecaptchaVerifier}.
+     * @param applicationVerifier - An {@link ApplicationVerifier}, which prevents
+     * requests from unauthorized clients. This SDK includes an implementation
+     * based on reCAPTCHA v2, {@link RecaptchaVerifier}. If you've enabled
+     * reCAPTCHA Enterprise bot protection in Enforce mode, this parameter is
+     * optional; in all other configurations, the parameter is required.
      *
      * @returns A Promise for a verification ID that can be passed to
-     * {@link PhoneAuthProvider.credential} to identify this flow..
+     * {@link PhoneAuthProvider.credential} to identify this flow.
      */
-    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;
+    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier?: ApplicationVerifier): Promise<string>;
     /**
      * Creates a phone auth credential, given the verification ID from
      * {@link PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's

package/dist/src/platform_browser/recaptcha/recaptcha.d.ts

@@ -68,4 +68,11 @@ export declare class RecaptchaConfig {
      * @returns Whether or not reCAPTCHA Enterprise protection is enabled for the given provider.
      */
     isProviderEnabled(providerStr: string): boolean;
+    /**
+     * Returns true if reCAPTCHA Enterprise protection is enabled in at least one provider, otherwise
+     * returns false.
+     *
+     * @returns Whether or not reCAPTCHA Enterprise protection is enabled for at least one provider.
+     */
+    isAnyProviderEnabled(): boolean;
 }

package/dist/src/platform_browser/recaptcha/recaptcha_enterprise_verifier.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { RecaptchaActionName } from '../../api';
+import { RecaptchaActionName, RecaptchaAuthProvider } from '../../api';
 import { Auth } from '../../model/public_types';
 import { AuthInternal } from '../../model/auth';
 export declare const RECAPTCHA_ENTERPRISE_VERIFIER_TYPE = "recaptcha-enterprise";
@@ -38,8 +38,8 @@ export declare class RecaptchaEnterpriseVerifier {
      */
     verify(action?: string, forceRefresh?: boolean): Promise<string>;
 }
-export declare function injectRecaptchaFields<T>(auth: AuthInternal, request: T, action: RecaptchaActionName, captchaResp?: boolean): Promise<T>;
-declare type ActionMethod<TRequest, TResponse> = (auth: Auth, request: TRequest) => Promise<TResponse>;
-export declare function handleRecaptchaFlow<TRequest, TResponse>(authInstance: AuthInternal, request: TRequest, actionName: RecaptchaActionName, actionMethod: ActionMethod<TRequest, TResponse>): Promise<TResponse>;
+export declare function injectRecaptchaFields<T>(auth: AuthInternal, request: T, action: RecaptchaActionName, isCaptchaResp?: boolean, isFakeToken?: boolean): Promise<T>;
+declare type ActionMethod<TRequest, TResponse> = (auth: AuthInternal, request: TRequest) => Promise<TResponse>;
+export declare function handleRecaptchaFlow<TRequest, TResponse>(authInstance: AuthInternal, request: TRequest, actionName: RecaptchaActionName, actionMethod: ActionMethod<TRequest, TResponse>, recaptchaAuthProvider: RecaptchaAuthProvider): Promise<TResponse>;
 export declare function _initializeRecaptchaConfig(auth: Auth): Promise<void>;
 export {};

package/dist/src/platform_browser/strategies/phone.d.ts

@@ -27,12 +27,15 @@ import { AuthInternal } from '../../model/auth';
  * provides the code sent to their phone, call {@link ConfirmationResult.confirm}
  * with the code to sign the user in.
  *
- * For abuse prevention, this method also requires a {@link ApplicationVerifier}.
- * This SDK includes a reCAPTCHA-based implementation, {@link RecaptchaVerifier}.
+ * For abuse prevention, this method requires a {@link ApplicationVerifier}.
+ * This SDK includes an implementation based on reCAPTCHA v2, {@link RecaptchaVerifier}.
  * This function can work on other platforms that do not support the
  * {@link RecaptchaVerifier} (like React Native), but you need to use a
  * third-party {@link ApplicationVerifier} implementation.
  *
+ * If you've enabled project-level reCAPTCHA Enterprise bot protection in
+ * Enforce mode, you can omit the {@link ApplicationVerifier}.
+ *
  * This method does not work in a Node.js environment or with {@link Auth} instances created with a
  * {@link @firebase/app#FirebaseServerApp}.
  *
@@ -51,7 +54,7 @@ import { AuthInternal } from '../../model/auth';
  *
  * @public
  */
-export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Links the user account with the given phone number.
  *
@@ -64,7 +67,7 @@ export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, a
  *
  * @public
  */
-export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Re-authenticates a user using a fresh phone credential.
  *
@@ -80,12 +83,12 @@ export declare function linkWithPhoneNumber(user: User, phoneNumber: string, app
  *
  * @public
  */
-export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
 /**
  * Returns a verification ID to be used in conjunction with the SMS code that is sent.
  *
  */
-export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInfoOptions | string, verifier: ApplicationVerifierInternal): Promise<string>;
+export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInfoOptions | string, verifier?: ApplicationVerifierInternal): Promise<string>;
 /**
  * Updates the user's phone number.
  *
@@ -110,3 +113,4 @@ export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInf
  * @public
  */
 export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;
+export declare function injectRecaptchaV2Token<T>(auth: AuthInternal, request: T, recaptchaV2Verifier: ApplicationVerifierInternal): Promise<T>;

package/dist/test/integration/flows/recaptcha_enterprise.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ */
+export {};

package/dist/web-extension-cjs/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var register = require('./register-674a8250.js');
+var register = require('./register-17c71bd5.js');
 var app = require('@firebase/app');
 var util = require('@firebase/util');
 require('tslib');