diff --git a/.changeset/fix-recaptcha-examples.md b/.changeset/fix-recaptcha-examples.md new file mode 100644 index 0000000000..4e64c666ea --- /dev/null +++ b/.changeset/fix-recaptcha-examples.md @@ -0,0 +1,6 @@ +--- +'@firebase/auth': patch +'firebase': patch +--- + +Fix missing authExtern parameter in RecaptchaVerifier example diff --git a/docs-devsite/auth.md b/docs-devsite/auth.md index 0325212915..678728af7d 100644 --- a/docs-devsite/auth.md +++ b/docs-devsite/auth.md @@ -975,7 +975,7 @@ Promise<[ConfirmationResult](./auth.confirmationresult.md#confirmationresult_ ```javascript // 'recaptcha-container' is the ID of an element in the DOM. -const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container'); +const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); // Obtain a verificationCode from the user. const credential = await confirmationResult.confirm(verificationCode); @@ -1745,7 +1745,7 @@ Promise<void> ``` // 'recaptcha-container' is the ID of an element in the DOM. -const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); +const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); const provider = new PhoneAuthProvider(auth); const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); // Obtain the verificationCode from the user. diff --git a/docs-devsite/auth.phoneauthprovider.md b/docs-devsite/auth.phoneauthprovider.md index e09e0b51ca..45c77b4e17 100644 --- a/docs-devsite/auth.phoneauthprovider.md +++ b/docs-devsite/auth.phoneauthprovider.md @@ -247,7 +247,7 @@ const userCredential = confirmationResult.confirm(verificationCode); ```javascript // 'recaptcha-container' is the ID of an element in the DOM. -const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); +const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); const provider = new PhoneAuthProvider(auth); const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); // Obtain the verificationCode from the user. diff --git a/packages/auth/src/platform_browser/providers/phone.ts b/packages/auth/src/platform_browser/providers/phone.ts index f67d82e179..b94a355c8b 100644 --- a/packages/auth/src/platform_browser/providers/phone.ts +++ b/packages/auth/src/platform_browser/providers/phone.ts @@ -43,7 +43,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * @example * ```javascript * // 'recaptcha-container' is the ID of an element in the DOM. - * const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); + * const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); * const provider = new PhoneAuthProvider(auth); * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); * // Obtain the verificationCode from the user. diff --git a/packages/auth/src/platform_browser/strategies/phone.ts b/packages/auth/src/platform_browser/strategies/phone.ts index ebbad499ad..0518053d21 100644 --- a/packages/auth/src/platform_browser/strategies/phone.ts +++ b/packages/auth/src/platform_browser/strategies/phone.ts @@ -117,7 +117,7 @@ class ConfirmationResultImpl implements ConfirmationResult { * @example * ```javascript * // 'recaptcha-container' is the ID of an element in the DOM. - * const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container'); + * const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); * // Obtain a verificationCode from the user. * const credential = await confirmationResult.confirm(verificationCode); @@ -435,7 +435,7 @@ export async function _verifyPhoneNumber( * @example * ``` * // 'recaptcha-container' is the ID of an element in the DOM. - * const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); + * const applicationVerifier = new RecaptchaVerifier(auth, 'recaptcha-container'); * const provider = new PhoneAuthProvider(auth); * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); * // Obtain the verificationCode from the user.