Make Auth.initializeRecaptchaConfig() internal

Author: renkelvin

common/api-review/auth.api.md

@@ -85,7 +85,6 @@ export interface Auth {
     readonly config: Config;
     readonly currentUser: User | null;
     readonly emulatorConfig: EmulatorConfig | null;
-    initializeRecaptchaConfig(): Promise<void>;
     languageCode: string | null;
     readonly name: string;
     onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

docs-devsite/auth.auth.md

@@ -38,7 +38,6 @@ export interface Auth
 |  Method | Description |
 |  --- | --- |
 |  [beforeAuthStateChanged(callback, onAbort)](./auth.auth.md#authbeforeauthstatechanged) | Adds a blocking callback that runs before an auth state change sets a new user. |
-|  [initializeRecaptchaConfig()](./auth.auth.md#authinitializerecaptchaconfig) | Loads the reCAPTCHA configuration into the <code>Auth</code> instance. |
 |  [onAuthStateChanged(nextOrObserver, error, completed)](./auth.auth.md#authonauthstatechanged) | Adds an observer for changes to the user's sign-in state. |
 |  [onIdTokenChanged(nextOrObserver, error, completed)](./auth.auth.md#authonidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. |
 |  [setPersistence(persistence)](./auth.auth.md#authsetpersistence) | Changes the type of persistence on the <code>Auth</code> instance. |
@@ -166,33 +165,6 @@ beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, on
 
 [Unsubscribe](./util.md#unsubscribe)
 
-## Auth.initializeRecaptchaConfig()
-
-Loads the reCAPTCHA configuration into the `Auth` instance.
-
-This will load the reCAPTCHA config, which indicates whether the reCAPTCHA verification flow should be triggered for each auth provider, into the current Auth session.
-
-If initializeRecaptchaConfig() is not invoked, the auth flow will always start without reCAPTCHA verification. If the provider is configured to require reCAPTCHA verification, the SDK will transparently load the reCAPTCHA config and restart the auth flows.
-
-Thus, by calling this optional method, you will reduce the latency of future auth flows. Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
-
-<b>Signature:</b>
-
-```typescript
-initializeRecaptchaConfig(): Promise<void>;
-```
-<b>Returns:</b>
-
-Promise&lt;void&gt;
-
-### Example
-
-
-```javascript
-auth.initializeRecaptchaConfig();
-
-```
-
 ## Auth.onAuthStateChanged()
 
 Adds an observer for changes to the user's sign-in state.

packages/auth/src/core/index.ts

@@ -25,6 +25,7 @@ import {
   ErrorFn,
   Unsubscribe
 } from '../model/public_types';
+import { _castAuth } from '../core/auth/auth_impl';
 
 export {
   debugErrorMap,
@@ -87,7 +88,8 @@ export function setPersistence(
  * @public
  */
 export function initializeRecaptchaConfig(auth: Auth): Promise<void> {
-  return getModularInstance(auth).initializeRecaptchaConfig();
+  const authInternal = _castAuth(auth);
+  return authInternal.initializeRecaptchaConfig();
 }
 
 /**

packages/auth/src/model/auth.ts

@@ -97,4 +97,5 @@ export interface AuthInternal extends Auth {
 
   useDeviceLanguage(): void;
   signOut(): Promise<void>;
+  initializeRecaptchaConfig(): Promise<void>;
 }

packages/auth/src/model/public_types.ts

@@ -202,28 +202,6 @@ export interface Auth {
    * @param persistence - The {@link Persistence} to use.
    */
   setPersistence(persistence: Persistence): Promise<void>;
-  /**
-   * Loads the reCAPTCHA configuration into the `Auth` instance.
-   *
-   * @remarks
-   * This will load the reCAPTCHA config, which indicates whether the reCAPTCHA
-   * verification flow should be triggered for each auth provider, into the
-   * current Auth session.
-   *
-   * If initializeRecaptchaConfig() is not invoked, the auth flow will always start
-   * without reCAPTCHA verification. If the provider is configured to require reCAPTCHA
-   * verification, the SDK will transparently load the reCAPTCHA config and restart the
-   * auth flows.
-   *
-   * Thus, by calling this optional method, you will reduce the latency of future auth flows.
-   * Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
-   *
-   * @example
-   * ```javascript
-   * auth.initializeRecaptchaConfig();
-   * ```
-   */
-  initializeRecaptchaConfig(): Promise<void>;
   /**
    * The {@link Auth} instance's language code.
    *