@firebase/auth 0.21.6 → 0.22.0-canary.1d6771eb3

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @firebase/auth
 
+## 0.22.0
+
+### Minor Changes
+
+- [`965396d52`](https://github.com/firebase/firebase-js-sdk/commit/965396d522243fcc17b63558823ad761c87ae1ba) [#7177](https://github.com/firebase/firebase-js-sdk/pull/7177) - Fixed error message for missing password case.
+
+### Patch Changes
+
+- [`bd51cecba`](https://github.com/firebase/firebase-js-sdk/commit/bd51cecba5cfc1b1c1ca46bf94e65320da3da609) [#7179](https://github.com/firebase/firebase-js-sdk/pull/7179) (fixes [#7174](https://github.com/firebase/firebase-js-sdk/issues/7174)) - Fix typings for `TotpMultiFactorGenerator`. This fixes a reversion in 9.19.0.
+
 ## 0.21.6
 
 ### Patch Changes

package/README.md

@@ -40,6 +40,11 @@ commands also run various tests:
   * `yarn test:webdriver` — Executes only the Selenium WebDriver
     integration tests
 
+Note - The webdriver tests require the Chrome webdriver to match the version of Chrome running locally.
+In the CI environment, this is ensured using the environment variable [here.](https://github.com/firebase/firebase-js-sdk/blob/6e80a678fe0c31046860554cec0459a2be34d22b/.github/workflows/test-changed-auth.yml#L7)
+When running locally, change the chromedriver version in [package.json](https://github.com/firebase/firebase-js-sdk/blob/6e80a678fe0c31046860554cec0459a2be34d22b/packages/auth/package.json#L124) to match your local Chrome version and run `yarn install`.
+
+
 For example, to run all integration and WebDriver tests against the emulator,
 you would simply execute the following command:
 

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";
 };
 
 /**
@@ -1157,8 +1165,6 @@ export declare const FactorId: {
     readonly TOTP: "totp";
 };
 
-/* Excluded from this release type: FactorId_2 */
-
 /**
  * The base class for all Federated providers (OAuth (including OIDC), SAML).
  *
@@ -1281,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.
  *
@@ -1561,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'.
  *
@@ -2135,6 +2173,7 @@ export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObs
  *
  * @remarks
  * This includes sign-in, sign-out, and token refresh events.
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
  *
  * @param auth - The {@link Auth} instance.
  * @param nextOrObserver - callback triggered on change.
@@ -2640,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 */
 
 /**
@@ -3222,7 +3278,7 @@ export declare class TotpMultiFactorGenerator {
     /**
      * The identifier of the TOTP second factor: `totp`.
      */
-    static FACTOR_ID: FactorId_2;
+    static FACTOR_ID: 'totp';
 }
 
 /**

package/dist/auth.d.ts

@@ -575,6 +575,7 @@ declare const enum AuthErrorCode {
     MISSING_MFA_INFO = "missing-multi-factor-info",
     MISSING_MFA_SESSION = "missing-multi-factor-session",
     MISSING_PHONE_NUMBER = "missing-phone-number",
+    MISSING_PASSWORD = "missing-password",
     MISSING_SESSION_INFO = "missing-verification-id",
     MODULE_DESTROYED = "app-deleted",
     NEED_CONFIRMATION = "account-exists-with-different-credential",
@@ -609,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"
 }
 
 /**
@@ -719,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";
 };
 
 /**
@@ -827,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;
@@ -841,9 +860,11 @@ 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>>;
+    _getAppCheckToken(): Promise<string | undefined>;
     readonly name: AppName;
     readonly config: ConfigInternal;
     languageCode: string | null;
@@ -852,6 +873,7 @@ declare interface AuthInternal extends Auth {
     _errorFactory: ErrorFactory<AuthErrorCode, AuthErrorParams>;
     useDeviceLanguage(): void;
     signOut(): Promise<void>;
+    initializeRecaptchaConfig(): Promise<void>;
 }
 
 declare class AuthPopup {
@@ -1423,17 +1445,6 @@ export declare const FactorId: {
     readonly TOTP: "totp";
 };
 
-/**
- * An enum of factors that may be used for multifactor authentication.
- *
- * @internal
- */
-declare const enum FactorId_2 {
-    /** Phone as second factor */
-    PHONE = "phone",
-    TOTP = "totp"
-}
-
 /**
  * The base class for all Federated providers (OAuth (including OIDC), SAML).
  *
@@ -1568,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.
  *
@@ -1891,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'.
  *
@@ -2469,6 +2512,7 @@ export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObs
  *
  * @remarks
  * This includes sign-in, sign-out, and token refresh events.
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
  *
  * @param auth - The {@link Auth} instance.
  * @param nextOrObserver - callback triggered on change.
@@ -3038,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.
@@ -3681,7 +3742,7 @@ export declare class TotpMultiFactorGenerator {
     /**
      * The identifier of the TOTP second factor: `totp`.
      */
-    static FACTOR_ID: FactorId_2;
+    static FACTOR_ID: 'totp';
 }
 
 /**