@firebase/auth 0.22.0-canary.ea3849fff → 0.22.0-canary.ecb4454c3

package/dist/auth-public.d.ts

@@ -588,6 +588,14 @@ export declare const AuthErrorCodes: {
     readonly WEAK_PASSWORD: "auth/weak-password";
     readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
     readonly ALREADY_INITIALIZED: "auth/already-initialized";
+    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
+    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
+    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
+    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
+    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
+    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
+    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
+    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
 };
 
 /**
@@ -1279,6 +1287,11 @@ export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Pr
  */
 export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
 
+declare interface GetRecaptchaConfigResponse {
+    recaptchaKey: string;
+    recaptchaEnforcementState: RecaptchaEnforcementState[];
+}
+
 /**
  * Returns a {@link UserCredential} from the redirect-based sign-in flow.
  *
@@ -1559,6 +1572,33 @@ export declare const indexedDBLocalPersistence: Persistence;
  */
 export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;
 
+/**
+ * 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
+ * initializeRecaptchaConfig(auth);
+ * ```
+ *
+ * @param auth - The {@link Auth} instance.
+ *
+ * @public
+ */
+export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;
+
 /**
  * An implementation of {@link Persistence} of type 'NONE'.
  *
@@ -2639,6 +2679,23 @@ declare interface Recaptcha {
     reset: (id: number) => unknown;
 }
 
+declare class RecaptchaConfig {
+    /**
+     * The reCAPTCHA site key.
+     */
+    siteKey: string;
+    /**
+     * The reCAPTCHA enablement status of the {@link EmailAuthProvider} for the current tenant.
+     */
+    emailPasswordEnabled: boolean;
+    constructor(response: GetRecaptchaConfigResponse);
+}
+
+declare interface RecaptchaEnforcementState {
+    provider: string;
+    enforcementState: string;
+}
+
 /* Excluded from this release type: ReCaptchaLoader */
 
 /**

package/dist/auth.d.ts

@@ -610,7 +610,15 @@ declare const enum AuthErrorCode {
     USER_SIGNED_OUT = "user-signed-out",
     WEAK_PASSWORD = "weak-password",
     WEB_STORAGE_UNSUPPORTED = "web-storage-unsupported",
-    ALREADY_INITIALIZED = "already-initialized"
+    ALREADY_INITIALIZED = "already-initialized",
+    RECAPTCHA_NOT_ENABLED = "recaptcha-not-enabled",
+    MISSING_RECAPTCHA_TOKEN = "missing-recaptcha-token",
+    INVALID_RECAPTCHA_TOKEN = "invalid-recaptcha-token",
+    INVALID_RECAPTCHA_ACTION = "invalid-recaptcha-action",
+    MISSING_CLIENT_TYPE = "missing-client-type",
+    MISSING_RECAPTCHA_VERSION = "missing-recaptcha-version",
+    INVALID_RECAPTCHA_VERSION = "invalid-recaptcha-version",
+    INVALID_REQ_TYPE = "invalid-req-type"
 }
 
 /**
@@ -720,6 +728,14 @@ export declare const AuthErrorCodes: {
     readonly WEAK_PASSWORD: "auth/weak-password";
     readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
     readonly ALREADY_INITIALIZED: "auth/already-initialized";
+    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
+    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
+    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
+    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
+    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
+    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
+    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
+    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
 };
 
 /**
@@ -828,6 +844,8 @@ declare const enum AuthEventType {
 declare interface AuthInternal extends Auth {
     currentUser: User | null;
     emulatorConfig: EmulatorConfig | null;
+    _agentRecaptchaConfig: RecaptchaConfig | null;
+    _tenantRecaptchaConfigs: Record<string, RecaptchaConfig>;
     _canInitEmulator: boolean;
     _isInitialized: boolean;
     _initializationPromise: Promise<void> | null;
@@ -842,6 +860,7 @@ declare interface AuthInternal extends Auth {
     _startProactiveRefresh(): void;
     _stopProactiveRefresh(): void;
     _getPersistence(): string;
+    _getRecaptchaConfig(): RecaptchaConfig | null;
     _logFramework(framework: string): void;
     _getFrameworks(): readonly string[];
     _getAdditionalHeaders(): Promise<Record<string, string>>;
@@ -854,6 +873,7 @@ declare interface AuthInternal extends Auth {
     _errorFactory: ErrorFactory<AuthErrorCode, AuthErrorParams>;
     useDeviceLanguage(): void;
     signOut(): Promise<void>;
+    initializeRecaptchaConfig(): Promise<void>;
 }
 
 declare class AuthPopup {
@@ -1559,6 +1579,11 @@ export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Pr
  */
 export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
 
+declare interface GetRecaptchaConfigResponse {
+    recaptchaKey: string;
+    recaptchaEnforcementState: RecaptchaEnforcementState[];
+}
+
 /**
  * Returns a {@link UserCredential} from the redirect-based sign-in flow.
  *
@@ -1882,6 +1907,33 @@ export declare const indexedDBLocalPersistence: Persistence;
  */
 export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;
 
+/**
+ * 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
+ * initializeRecaptchaConfig(auth);
+ * ```
+ *
+ * @param auth - The {@link Auth} instance.
+ *
+ * @public
+ */
+export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;
+
 /**
  * An implementation of {@link Persistence} of type 'NONE'.
  *
@@ -3030,6 +3082,23 @@ declare interface Recaptcha {
     reset: (id: number) => unknown;
 }
 
+declare class RecaptchaConfig {
+    /**
+     * The reCAPTCHA site key.
+     */
+    siteKey: string;
+    /**
+     * The reCAPTCHA enablement status of the {@link EmailAuthProvider} for the current tenant.
+     */
+    emailPasswordEnabled: boolean;
+    constructor(response: GetRecaptchaConfigResponse);
+}
+
+declare interface RecaptchaEnforcementState {
+    provider: string;
+    enforcementState: string;
+}
+
 /**
  * We need to mark this interface as internal explicitly to exclude it in the public typings, because
  * it references AuthInternal which has a circular dependency with UserInternal.