@firebase/auth 0.19.12 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @firebase/auth
 
+## 0.20.0
+
+### Minor Changes
+
+- [`1ac3c9d41`](https://github.com/firebase/firebase-js-sdk/commit/1ac3c9d41e8f69a94c64c6e0caf5f1a159b7dc3c) [#6151](https://github.com/firebase/firebase-js-sdk/pull/6151) - Add `beforeAuthStateChanged()` middleware function which allows the user to provide callbacks that are run before an auth state change
+  sets a new user.
+
+### Patch Changes
+
+- Updated dependencies [[`9c5c9c36d`](https://github.com/firebase/firebase-js-sdk/commit/9c5c9c36da80b98b73cfd60ef2e2965087e9f801)]:
+  - @firebase/util@1.6.0
+  - @firebase/component@0.5.14
+
 ## 0.19.12
 
 ### Patch Changes

package/dist/auth-public.d.ts

@@ -362,6 +362,16 @@ export declare interface Auth {
      * @param completed - callback triggered when observer is removed.
      */
     onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
+    /**
+     * Adds a blocking callback that runs before an auth state change
+     * sets a new user.
+     *
+     * @param callback - callback triggered before new user value is set.
+     *   If this throws, it blocks the user from being set.
+     * @param onAbort - callback triggered if a later `beforeAuthStateChanged()`
+     *   callback throws, allowing you to undo any side effects.
+     */
+    beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
     /**
      * Adds an observer for changes to the signed-in user's ID token.
      *
@@ -684,6 +694,18 @@ declare abstract class BaseOAuthProvider extends FederatedAuthProvider implement
     getScopes(): string[];
 }
 
+/**
+ * Adds a blocking callback that runs before an auth state change
+ * sets a new user.
+ *
+ * @param auth - The {@link Auth} instance.
+ * @param callback - callback triggered before new user value is set.
+ *   If this throws, it blocks the user from being set.
+ * @param onAbort - callback triggered if a later `beforeAuthStateChanged()`
+ *   callback throws, allowing you to undo any side effects.
+ */
+export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
+
 /**
  * An implementation of {@link Persistence} of type `LOCAL` using `localStorage`
  * for the underlying storage.
@@ -3111,6 +3133,10 @@ export declare function signOut(auth: Auth): Promise<void>;
 
 /* Excluded from this release type: StsTokenManager */
 
+declare interface TaggedWithTokenResponse {
+    _tokenResponse?: PhoneOrOauthTokenResponse;
+}
+
 /**
  * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.TWITTER.
  *
@@ -3399,6 +3425,10 @@ export declare interface UserCredential {
     operationType: typeof OperationType[keyof typeof OperationType];
 }
 
+declare interface UserCredentialInternal extends UserCredential, TaggedWithTokenResponse {
+    user: UserInternal;
+}
+
 /**
  * User profile information, visible only to the Firebase project's apps.
  *

package/dist/auth.d.ts

@@ -371,6 +371,16 @@ export declare interface Auth {
      * @param completed - callback triggered when observer is removed.
      */
     onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
+    /**
+     * Adds a blocking callback that runs before an auth state change
+     * sets a new user.
+     *
+     * @param callback - callback triggered before new user value is set.
+     *   If this throws, it blocks the user from being set.
+     * @param onAbort - callback triggered if a later `beforeAuthStateChanged()`
+     *   callback throws, allowing you to undo any side effects.
+     */
+    beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
     /**
      * Adds an observer for changes to the signed-in user's ID token.
      *
@@ -547,6 +557,7 @@ declare const enum AuthErrorCode {
     INVALID_SENDER = "invalid-sender",
     INVALID_SESSION_INFO = "invalid-verification-id",
     INVALID_TENANT_ID = "invalid-tenant-id",
+    LOGIN_BLOCKED = "login-blocked",
     MFA_INFO_NOT_FOUND = "multi-factor-info-not-found",
     MFA_REQUIRED = "multi-factor-auth-required",
     MISSING_ANDROID_PACKAGE_NAME = "missing-android-pkg-name",
@@ -741,6 +752,10 @@ declare interface AuthErrorParams extends GenericAuthErrorParams {
     [AuthErrorCode.INTERNAL_ERROR]: {
         appName?: AppName;
     };
+    [AuthErrorCode.LOGIN_BLOCKED]: {
+        appName?: AppName;
+        originalMessage?: string;
+    };
     [AuthErrorCode.OPERATION_NOT_SUPPORTED]: {
         appName?: AppName;
     };
@@ -907,6 +922,18 @@ declare abstract class BaseOAuthProvider extends FederatedAuthProvider implement
     getScopes(): string[];
 }
 
+/**
+ * Adds a blocking callback that runs before an auth state change
+ * sets a new user.
+ *
+ * @param auth - The {@link Auth} instance.
+ * @param callback - callback triggered before new user value is set.
+ *   If this throws, it blocks the user from being set.
+ * @param onAbort - callback triggered if a later `beforeAuthStateChanged()`
+ *   callback throws, allowing you to undo any side effects.
+ */
+export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
+
 /**
  * An implementation of {@link Persistence} of type `LOCAL` using `localStorage`
  * for the underlying storage.
@@ -1459,9 +1486,10 @@ declare interface FinalizeMfaResponse {
  */
 declare type GenericAuthErrorParams = {
     [key in Exclude<AuthErrorCode, AuthErrorCode.ARGUMENT_ERROR | AuthErrorCode.DEPENDENT_SDK_INIT_BEFORE_AUTH | AuthErrorCode.INTERNAL_ERROR | AuthErrorCode.MFA_REQUIRED | AuthErrorCode.NO_AUTH_EVENT | AuthErrorCode.OPERATION_NOT_SUPPORTED>]: {
-        appName: AppName;
+        appName?: AppName;
         email?: string;
         phoneNumber?: string;
+        message?: string;
     };
 };
 
@@ -2779,6 +2807,7 @@ declare interface PopupRedirectResolverInternal extends PopupRedirectResolver {
     _redirectPersistence: Persistence;
     _originValidation(auth: Auth): Promise<void>;
     _completeRedirectFn: (auth: Auth, resolver: PopupRedirectResolver, bypassAuthState: boolean) => Promise<UserCredential | null>;
+    _overrideRedirectResult: (auth: AuthInternal, resultGetter: () => Promise<UserCredentialInternal | null>) => void;
 }
 
 /**
@@ -3549,6 +3578,10 @@ declare class StsTokenManager {
     _performRefresh(): never;
 }
 
+declare interface TaggedWithTokenResponse {
+    _tokenResponse?: PhoneOrOauthTokenResponse;
+}
+
 /**
  * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.TWITTER.
  *
@@ -3837,6 +3870,10 @@ export declare interface UserCredential {
     operationType: typeof OperationType[keyof typeof OperationType];
 }
 
+declare interface UserCredentialInternal extends UserCredential, TaggedWithTokenResponse {
+    user: UserInternal;
+}
+
 /**
  * User profile information, visible only to the Firebase project's apps.
  *

package/dist/cordova/index.js

@@ -1,6 +1,6 @@
 import { getApp, _getProvider } from '@firebase/app';
-import { _ as _signInWithRedirect, a as _reauthenticateWithRedirect, b as _linkWithRedirect, r as registerAuth, i as initializeAuth, c as indexedDBLocalPersistence, d as cordovaPopupRedirectResolver } from './popup_redirect-fd81f644.js';
-export { A as ActionCodeOperation, a2 as ActionCodeURL, t as AuthCredential, n as AuthErrorCodes, E as EmailAuthCredential, y as EmailAuthProvider, z as FacebookAuthProvider, F as FactorId, B as GithubAuthProvider, G as GoogleAuthProvider, v as OAuthCredential, C as OAuthProvider, O as OperationType, w as PhoneAuthCredential, P as ProviderId, D as SAMLAuthProvider, S as SignInMethod, T as TwitterAuthProvider, Q as applyActionCode, e as browserLocalPersistence, f as browserSessionPersistence, R as checkActionCode, N as confirmPasswordReset, q as connectAuthEmulator, d as cordovaPopupRedirectResolver, V as createUserWithEmailAndPassword, m as debugErrorMap, l as deleteUser, $ as fetchSignInMethodsForEmail, aa as getAdditionalUserInfo, a7 as getIdToken, a8 as getIdTokenResult, ac as getMultiFactorResolver, g as getRedirectResult, x as inMemoryPersistence, c as indexedDBLocalPersistence, i as initializeAuth, Y as isSignInWithEmailLink, J as linkWithCredential, ad as multiFactor, h as onAuthStateChanged, o as onIdTokenChanged, a3 as parseActionCodeURL, p as prodErrorMap, K as reauthenticateWithCredential, ab as reload, a0 as sendEmailVerification, M as sendPasswordResetEmail, X as sendSignInLinkToEmail, s as setPersistence, H as signInAnonymously, I as signInWithCredential, L as signInWithCustomToken, W as signInWithEmailAndPassword, Z as signInWithEmailLink, k as signOut, a9 as unlink, j as updateCurrentUser, a5 as updateEmail, a6 as updatePassword, a4 as updateProfile, u as useDeviceLanguage, a1 as verifyBeforeUpdateEmail, U as verifyPasswordResetCode } from './popup_redirect-fd81f644.js';
+import { _ as _signInWithRedirect, a as _reauthenticateWithRedirect, b as _linkWithRedirect, r as registerAuth, i as initializeAuth, c as indexedDBLocalPersistence, d as cordovaPopupRedirectResolver } from './popup_redirect-1228b67a.js';
+export { A as ActionCodeOperation, a3 as ActionCodeURL, v as AuthCredential, q as AuthErrorCodes, E as EmailAuthCredential, z as EmailAuthProvider, B as FacebookAuthProvider, F as FactorId, C as GithubAuthProvider, G as GoogleAuthProvider, w as OAuthCredential, D as OAuthProvider, O as OperationType, x as PhoneAuthCredential, P as ProviderId, H as SAMLAuthProvider, S as SignInMethod, T as TwitterAuthProvider, R as applyActionCode, h as beforeAuthStateChanged, e as browserLocalPersistence, f as browserSessionPersistence, U as checkActionCode, Q as confirmPasswordReset, t as connectAuthEmulator, d as cordovaPopupRedirectResolver, W as createUserWithEmailAndPassword, n as debugErrorMap, m as deleteUser, a0 as fetchSignInMethodsForEmail, ab as getAdditionalUserInfo, a8 as getIdToken, a9 as getIdTokenResult, ad as getMultiFactorResolver, g as getRedirectResult, y as inMemoryPersistence, c as indexedDBLocalPersistence, i as initializeAuth, Z as isSignInWithEmailLink, K as linkWithCredential, ae as multiFactor, j as onAuthStateChanged, o as onIdTokenChanged, a4 as parseActionCodeURL, p as prodErrorMap, L as reauthenticateWithCredential, ac as reload, a1 as sendEmailVerification, N as sendPasswordResetEmail, Y as sendSignInLinkToEmail, s as setPersistence, I as signInAnonymously, J as signInWithCredential, M as signInWithCustomToken, X as signInWithEmailAndPassword, $ as signInWithEmailLink, l as signOut, aa as unlink, k as updateCurrentUser, a6 as updateEmail, a7 as updatePassword, a5 as updateProfile, u as useDeviceLanguage, a2 as verifyBeforeUpdateEmail, V as verifyPasswordResetCode } from './popup_redirect-1228b67a.js';
 import 'tslib';
 import '@firebase/util';
 import '@firebase/component';

package/dist/cordova/internal/index.d.ts

@@ -35,6 +35,7 @@ export { TaggedWithTokenResponse } from '../src/model/id_token';
 export { _fail, _assert } from '../src/core/util/assert';
 export { AuthPopup } from '../src/platform_browser/util/popup';
 export { _getRedirectResult } from '../src/platform_browser/strategies/redirect';
+export { _overrideRedirectResult } from '../src/core/strategies/redirect';
 export { cordovaPopupRedirectResolver } from '../src/platform_cordova/popup_redirect/popup_redirect';
 export { FetchProvider } from '../src/core/util/fetch_provider';
 export { SAMLAuthCredential } from '../src/core/credentials/saml';

package/dist/cordova/internal.js

@@ -1,5 +1,5 @@
-import { ae as _performApiRequest, af as _addTidIfNecessary, ag as _createError, ah as _assert, ai as Delay, aj as _window, ak as _isHttpOrHttps, al as _isWorker, am as _castAuth, I as signInWithCredential, an as sendPhoneVerificationCode, ao as startEnrollPhoneMfa, J as linkWithCredential, ap as _assertLinkedStatus, K as reauthenticateWithCredential, aq as _link, w as PhoneAuthCredential, ar as debugAssert, as as _generateEventId, at as AbstractPopupRedirectOperation, au as _assertInstanceOf, av as _withDefaultResolver, aw as FederatedAuthProvider, ax as _fail, ay as _getProjectConfig, az as _getCurrentUrl, aA as _emulatorUrl, aB as _isChromeIOS, aC as _isFirefox, aD as _isIOSStandalone, aE as _isMobileBrowser, aF as _isSafari, aG as _isIOS, f as browserSessionPersistence, aH as _getRedirectResult, aI as _getRedirectUrl, aJ as _setWindowLocation, aK as AuthEventManager, aL as debugFail, aM as finalizeEnrollPhoneMfa, r as registerAuth, i as initializeAuth, c as indexedDBLocalPersistence, e as browserLocalPersistence } from './popup_redirect-fd81f644.js';
-export { A as ActionCodeOperation, a2 as ActionCodeURL, t as AuthCredential, n as AuthErrorCodes, aQ as AuthImpl, E as EmailAuthCredential, y as EmailAuthProvider, z as FacebookAuthProvider, F as FactorId, aS as FetchProvider, B as GithubAuthProvider, G as GoogleAuthProvider, v as OAuthCredential, C as OAuthProvider, O as OperationType, w as PhoneAuthCredential, P as ProviderId, aT as SAMLAuthCredential, D as SAMLAuthProvider, S as SignInMethod, T as TwitterAuthProvider, aO as UserImpl, ah as _assert, am as _castAuth, ax as _fail, as as _generateEventId, aR as _getClientVersion, aP as _getInstance, aH as _getRedirectResult, aN as _persistenceKeyName, Q as applyActionCode, e as browserLocalPersistence, f as browserSessionPersistence, R as checkActionCode, N as confirmPasswordReset, q as connectAuthEmulator, d as cordovaPopupRedirectResolver, V as createUserWithEmailAndPassword, m as debugErrorMap, l as deleteUser, $ as fetchSignInMethodsForEmail, aa as getAdditionalUserInfo, a7 as getIdToken, a8 as getIdTokenResult, ac as getMultiFactorResolver, g as getRedirectResult, x as inMemoryPersistence, c as indexedDBLocalPersistence, i as initializeAuth, Y as isSignInWithEmailLink, J as linkWithCredential, aV as linkWithRedirect, ad as multiFactor, h as onAuthStateChanged, o as onIdTokenChanged, a3 as parseActionCodeURL, p as prodErrorMap, K as reauthenticateWithCredential, aW as reauthenticateWithRedirect, ab as reload, a0 as sendEmailVerification, M as sendPasswordResetEmail, X as sendSignInLinkToEmail, s as setPersistence, H as signInAnonymously, I as signInWithCredential, L as signInWithCustomToken, W as signInWithEmailAndPassword, Z as signInWithEmailLink, aU as signInWithRedirect, k as signOut, a9 as unlink, j as updateCurrentUser, a5 as updateEmail, a6 as updatePassword, a4 as updateProfile, u as useDeviceLanguage, a1 as verifyBeforeUpdateEmail, U as verifyPasswordResetCode } from './popup_redirect-fd81f644.js';
+import { af as _performApiRequest, ag as _addTidIfNecessary, ah as _createError, ai as _assert, aj as Delay, ak as _window, al as _isHttpOrHttps, am as _isWorker, an as _castAuth, J as signInWithCredential, ao as sendPhoneVerificationCode, ap as startEnrollPhoneMfa, K as linkWithCredential, aq as _assertLinkedStatus, L as reauthenticateWithCredential, ar as _link, x as PhoneAuthCredential, as as debugAssert, at as _generateEventId, au as AbstractPopupRedirectOperation, av as _assertInstanceOf, aw as _withDefaultResolver, ax as FederatedAuthProvider, ay as _fail, az as _getProjectConfig, aA as _getCurrentUrl, aB as _emulatorUrl, aC as _isChromeIOS, aD as _isFirefox, aE as _isIOSStandalone, aF as _isMobileBrowser, aG as _isSafari, aH as _isIOS, f as browserSessionPersistence, aI as _getRedirectResult, aJ as _overrideRedirectResult, aK as _getRedirectUrl, aL as _setWindowLocation, aM as AuthEventManager, aN as debugFail, aO as finalizeEnrollPhoneMfa, r as registerAuth, i as initializeAuth, c as indexedDBLocalPersistence, e as browserLocalPersistence } from './popup_redirect-1228b67a.js';
+export { A as ActionCodeOperation, a3 as ActionCodeURL, v as AuthCredential, q as AuthErrorCodes, aS as AuthImpl, E as EmailAuthCredential, z as EmailAuthProvider, B as FacebookAuthProvider, F as FactorId, aU as FetchProvider, C as GithubAuthProvider, G as GoogleAuthProvider, w as OAuthCredential, D as OAuthProvider, O as OperationType, x as PhoneAuthCredential, P as ProviderId, aV as SAMLAuthCredential, H as SAMLAuthProvider, S as SignInMethod, T as TwitterAuthProvider, aQ as UserImpl, ai as _assert, an as _castAuth, ay as _fail, at as _generateEventId, aT as _getClientVersion, aR as _getInstance, aI as _getRedirectResult, aJ as _overrideRedirectResult, aP as _persistenceKeyName, R as applyActionCode, h as beforeAuthStateChanged, e as browserLocalPersistence, f as browserSessionPersistence, U as checkActionCode, Q as confirmPasswordReset, t as connectAuthEmulator, d as cordovaPopupRedirectResolver, W as createUserWithEmailAndPassword, n as debugErrorMap, m as deleteUser, a0 as fetchSignInMethodsForEmail, ab as getAdditionalUserInfo, a8 as getIdToken, a9 as getIdTokenResult, ad as getMultiFactorResolver, g as getRedirectResult, y as inMemoryPersistence, c as indexedDBLocalPersistence, i as initializeAuth, Z as isSignInWithEmailLink, K as linkWithCredential, aX as linkWithRedirect, ae as multiFactor, j as onAuthStateChanged, o as onIdTokenChanged, a4 as parseActionCodeURL, p as prodErrorMap, L as reauthenticateWithCredential, aY as reauthenticateWithRedirect, ac as reload, a1 as sendEmailVerification, N as sendPasswordResetEmail, Y as sendSignInLinkToEmail, s as setPersistence, I as signInAnonymously, J as signInWithCredential, M as signInWithCustomToken, X as signInWithEmailAndPassword, $ as signInWithEmailLink, aW as signInWithRedirect, l as signOut, aa as unlink, k as updateCurrentUser, a6 as updateEmail, a7 as updatePassword, a5 as updateProfile, u as useDeviceLanguage, a2 as verifyBeforeUpdateEmail, V as verifyPasswordResetCode } from './popup_redirect-1228b67a.js';
 import { __awaiter, __generator, __assign, __extends, __spreadArray } from 'tslib';
 import { querystring, getModularInstance, getUA } from '@firebase/util';
 import { SDK_VERSION, getApp, _getProvider } from '@firebase/app';
@@ -1666,6 +1666,7 @@ var BrowserPopupRedirectResolver = /** @class */ (function () {
         this.originValidationPromises = {};
         this._redirectPersistence = browserSessionPersistence;
         this._completeRedirectFn = _getRedirectResult;
+        this._overrideRedirectResult = _overrideRedirectResult;
     }
     // Wrapping in async even though we don't await anywhere in order
     // to make sure errors are raised as promise rejections