Mark appVerifier param in Phone Auth APIs as required

NhienLam · NhienLam · commit ed69ba9f2aa2 · 2024-03-27T17:43:04.000-07:00
diff --git a/common/api-review/auth.api.md b/common/api-review/auth.api.md
@@ -104,14 +104,14 @@ export class AuthCredential {
     protected constructor(
     providerId: string,
     signInMethod: string);
-    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
     // @internal (undocumented)
     _getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -293,6 +293,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
     disableWarnings: boolean;
 }): void;
 
+// @public
+export const cordovaPopupRedirectResolver: PopupRedirectResolver;
+
 // @public
 export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
 
@@ -356,7 +359,7 @@ export interface EmulatorConfig {
 
 export { ErrorFn }
 
-// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -392,6 +395,9 @@ export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<Id
 // @public
 export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
 
+// @public
+export function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
+
 // @public
 export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
 
@@ -445,7 +451,7 @@ export function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;
 export function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
 
 // @public
-export function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 
 // @public
 export function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
@@ -504,7 +510,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
 export class OAuthCredential extends AuthCredential {
     accessToken?: string;
     static fromJSON(json: string | object): OAuthCredential | null;
-    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -609,7 +615,7 @@ export class PhoneAuthCredential extends AuthCredential {
     _getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
     // @internal (undocumented)
     _linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -625,7 +631,7 @@ export class PhoneAuthProvider {
     static readonly PHONE_SIGN_IN_METHOD: 'phone';
     static readonly PROVIDER_ID: 'phone';
     readonly providerId: "phone";
-    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier?: ApplicationVerifier): Promise<string>;
+    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;
 }
 
 // @public
@@ -692,7 +698,7 @@ export interface ReactNativeAsyncStorage {
 export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
 
 // @public
-export function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 
 // @public
 export function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
@@ -706,13 +712,13 @@ export interface RecaptchaParameters {
     [key: string]: any;
 }
 
-// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class RecaptchaVerifier implements ApplicationVerifierInternal {
     constructor(authExtern: Auth, containerOrId: HTMLElement | string, parameters?: RecaptchaParameters);
     clear(): void;
-    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     readonly _recaptchaLoader: ReCaptchaLoader;
@@ -729,7 +735,7 @@ export function reload(user: User): Promise<void>;
 // @public
 export function revokeAccessToken(auth: Auth, token: string): Promise<void>;
 
-// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class SAMLAuthProvider extends FederatedAuthProvider {
@@ -778,7 +784,7 @@ export function signInWithEmailAndPassword(auth: Auth, email: string, password:
 export function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;
 
 // @public
-export function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 
 // @public
 export function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
@@ -810,13 +816,13 @@ export class TotpSecret {
     readonly codeIntervalSeconds: number;
     readonly codeLength: number;
     readonly enrollmentCompletionDeadline: string;
-    // Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     static _fromStartTotpMfaEnrollmentResponse(response: StartTotpMfaEnrollmentResponse, auth: AuthInternal): TotpSecret;
     generateQrCodeUrl(accountName?: string, issuer?: string): string;
     readonly hashingAlgorithm: string;
-    // Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _makeTotpVerificationInfo(otp: string): TotpVerificationInfo;
diff --git a/docs-devsite/auth.md b/docs-devsite/auth.md
@@ -912,7 +912,7 @@ This method does not work in a Node.js environment.
 <b>Signature:</b>
 
 ```typescript
-export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 ```
 
 ### Parameters
@@ -1278,7 +1278,7 @@ This method does not work in a Node.js environment.
 <b>Signature:</b>
 
 ```typescript
-export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 ```
 
 ### Parameters
@@ -1429,7 +1429,7 @@ This method does not work in a Node.js environment.
 <b>Signature:</b>
 
 ```typescript
-export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;
+export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 ```
 
 ### Parameters
diff --git a/docs-devsite/auth.phoneauthprovider.md b/docs-devsite/auth.phoneauthprovider.md
@@ -203,7 +203,7 @@ Starts a phone number authentication flow by sending a verification code to the
 <b>Signature:</b>
 
 ```typescript
-verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier?: ApplicationVerifier): Promise<string>;
+verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;
 ```
 
 ### Parameters
diff --git a/packages/auth/src/platform_browser/providers/phone.test.ts b/packages/auth/src/platform_browser/providers/phone.test.ts
@@ -106,49 +106,6 @@ describe('platform_browser/providers/phone', () => {
         recaptchaVersion: RecaptchaVersion.ENTERPRISE
       });
     });
-
-    it('calls the server without appVerifier when recaptcha enterprise is enabled', async () => {
-      const recaptchaConfigResponseEnforce = {
-        recaptchaKey: 'foo/bar/to/site-key',
-        recaptchaEnforcementState: [
-          {
-            provider: RecaptchaProvider.PHONE_PROVIDER,
-            enforcementState: EnforcementState.ENFORCE
-          }
-        ]
-      };
-      const recaptcha = new MockGreCAPTCHATopLevel();
-      if (typeof window === 'undefined') {
-        return;
-      }
-      window.grecaptcha = recaptcha;
-      sinon
-        .stub(recaptcha.enterprise, 'execute')
-        .returns(Promise.resolve('enterprise-token'));
-
-      mockEndpointWithParams(
-        Endpoint.GET_RECAPTCHA_CONFIG,
-        {
-          clientType: RecaptchaClientType.WEB,
-          version: RecaptchaVersion.ENTERPRISE
-        },
-        recaptchaConfigResponseEnforce
-      );
-
-      const route = mockEndpoint(Endpoint.SEND_VERIFICATION_CODE, {
-        sessionInfo: 'verification-id'
-      });
-
-      const provider = new PhoneAuthProvider(auth);
-      const result = await provider.verifyPhoneNumber('+15105550000');
-      expect(result).to.eq('verification-id');
-      expect(route.calls[0].request).to.eql({
-        phoneNumber: '+15105550000',
-        captchaResponse: 'enterprise-token',
-        clientType: RecaptchaClientType.WEB,
-        recaptchaVersion: RecaptchaVersion.ENTERPRISE
-      });
-    });
   });
 
   context('.credential', () => {
diff --git a/packages/auth/src/platform_browser/providers/phone.ts b/packages/auth/src/platform_browser/providers/phone.ts
@@ -100,11 +100,11 @@ export class PhoneAuthProvider {
    * {@link RecaptchaVerifier}.
    *
    * @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
+    applicationVerifier: ApplicationVerifier
   ): Promise<string> {
     return _verifyPhoneNumber(
       this.auth,
diff --git a/packages/auth/src/platform_browser/strategies/phone.test.ts b/packages/auth/src/platform_browser/strategies/phone.test.ts
@@ -171,7 +171,7 @@ describe('platform_browser/strategies/phone', () => {
         return;
       }
       mockRecaptchaEnterpriseEnablement(EnforcementState.ENFORCE);
-      await signInWithPhoneNumber(auth, '+15105550000');
+      await signInWithPhoneNumber(auth, '+15105550000', v2Verifier);
 
       expect(sendCodeEndpoint.calls[0].request).to.eql({
         phoneNumber: '+15105550000',
@@ -504,21 +504,6 @@ describe('platform_browser/strategies/phone', () => {
       });
     });
 
-    it('works without v2 verifier when recaptcha enterprise is enabled', async () => {
-      if (typeof window === 'undefined') {
-        return;
-      }
-      mockRecaptchaEnterpriseEnablement(EnforcementState.ENFORCE);
-      const sessionInfo = await _verifyPhoneNumber(auth, 'number');
-      expect(sessionInfo).to.eq('session-info');
-      expect(sendCodeEndpoint.calls[0].request).to.eql({
-        phoneNumber: 'number',
-        captchaResponse: RECAPTCHA_ENTERPRISE_TOKEN,
-        clientType: RecaptchaClientType.WEB,
-        recaptchaVersion: RecaptchaVersion.ENTERPRISE
-      });
-    });
-
     it('calls fallback to recaptcha v2 flow when receiving MISSING_RECAPTCHA_TOKEN error in recaptcha enterprise audit mode', async () => {
       if (typeof window === 'undefined') {
         return;
diff --git a/packages/auth/src/platform_browser/strategies/phone.ts b/packages/auth/src/platform_browser/strategies/phone.ts
@@ -124,7 +124,7 @@ class ConfirmationResultImpl implements ConfirmationResult {
 export async function signInWithPhoneNumber(
   auth: Auth,
   phoneNumber: string,
-  appVerifier?: ApplicationVerifier
+  appVerifier: ApplicationVerifier
 ): Promise<ConfirmationResult> {
   const authInternal = _castAuth(auth);
   const verificationId = await _verifyPhoneNumber(
@@ -152,7 +152,7 @@ export async function signInWithPhoneNumber(
 export async function linkWithPhoneNumber(
   user: User,
   phoneNumber: string,
-  appVerifier?: ApplicationVerifier
+  appVerifier: ApplicationVerifier
 ): Promise<ConfirmationResult> {
   const userInternal = getModularInstance(user) as UserInternal;
   await _assertLinkedStatus(false, userInternal, ProviderId.PHONE);
@@ -183,7 +183,7 @@ export async function linkWithPhoneNumber(
 export async function reauthenticateWithPhoneNumber(
   user: User,
   phoneNumber: string,
-  appVerifier?: ApplicationVerifier
+  appVerifier: ApplicationVerifier
 ): Promise<ConfirmationResult> {
   const userInternal = getModularInstance(user) as UserInternal;
   const verificationId = await _verifyPhoneNumber(
@@ -208,7 +208,7 @@ type PhoneApiCaller<TRequest, TResponse> = (
 export async function _verifyPhoneNumber(
   auth: AuthInternal,
   options: PhoneInfoOptions | string,
-  verifier?: ApplicationVerifierInternal
+  verifier: ApplicationVerifierInternal
 ): Promise<string> {
   if (!auth._getRecaptchaConfig()) {
     const enterpriseVerifier = new RecaptchaEnterpriseVerifier(auth);
@@ -258,7 +258,7 @@ export async function _verifyPhoneNumber(
             request.phoneEnrollmentInfo.captchaResponse === FAKE_TOKEN
           ) {
             _assert(
-              verifier?.type === RECAPTCHA_VERIFIER_TYPE,
+              verifier.type === RECAPTCHA_VERIFIER_TYPE,
               authInstance,
               AuthErrorCode.ARGUMENT_ERROR
             );
@@ -320,7 +320,7 @@ export async function _verifyPhoneNumber(
             request.phoneSignInInfo.captchaResponse === FAKE_TOKEN
           ) {
             _assert(
-              verifier?.type === RECAPTCHA_VERIFIER_TYPE,
+              verifier.type === RECAPTCHA_VERIFIER_TYPE,
               authInstance,
               AuthErrorCode.ARGUMENT_ERROR
             );
@@ -371,7 +371,7 @@ export async function _verifyPhoneNumber(
           request.captchaResponse === FAKE_TOKEN
         ) {
           _assert(
-            verifier?.type === RECAPTCHA_VERIFIER_TYPE,
+            verifier.type === RECAPTCHA_VERIFIER_TYPE,
             authInstance,
             AuthErrorCode.ARGUMENT_ERROR
           );
@@ -405,7 +405,7 @@ export async function _verifyPhoneNumber(
       return response.sessionInfo;
     }
   } finally {
-    verifier?._reset();
+    verifier._reset();
   }
 }
 
