@firebase/auth 0.17.1 → 0.17.2-canary.07b88e6e8

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @firebase/auth
 
+## 0.17.2
+
+### Patch Changes
+
+- [`08ec55d6d`](https://github.com/firebase/firebase-js-sdk/commit/08ec55d6dfcc85207fbdcdde77d6508f27998603) [#5423](https://github.com/firebase/firebase-js-sdk/pull/5423) - Fix bug where custom errors from blocking functions were being dropped.
+
+* [`271303f3c`](https://github.com/firebase/firebase-js-sdk/commit/271303f3ca6fa47c646177a41d7a3e3f31e1d296) [#5460](https://github.com/firebase/firebase-js-sdk/pull/5460) - Remove `const enum`s from the public typing file.
+
 ## 0.17.1
 
 ### Patch Changes

package/dist/auth-public.d.ts

@@ -462,106 +462,7 @@ export declare interface AuthError extends FirebaseError {
     readonly tenantid?: string;
 }
 
-/**
- * Enumeration of Firebase Auth error codes.
- */
-declare const enum AuthErrorCode {
-    ADMIN_ONLY_OPERATION = "admin-restricted-operation",
-    ARGUMENT_ERROR = "argument-error",
-    APP_NOT_AUTHORIZED = "app-not-authorized",
-    APP_NOT_INSTALLED = "app-not-installed",
-    CAPTCHA_CHECK_FAILED = "captcha-check-failed",
-    CODE_EXPIRED = "code-expired",
-    CORDOVA_NOT_READY = "cordova-not-ready",
-    CORS_UNSUPPORTED = "cors-unsupported",
-    CREDENTIAL_ALREADY_IN_USE = "credential-already-in-use",
-    CREDENTIAL_MISMATCH = "custom-token-mismatch",
-    CREDENTIAL_TOO_OLD_LOGIN_AGAIN = "requires-recent-login",
-    DEPENDENT_SDK_INIT_BEFORE_AUTH = "dependent-sdk-initialized-before-auth",
-    DYNAMIC_LINK_NOT_ACTIVATED = "dynamic-link-not-activated",
-    EMAIL_CHANGE_NEEDS_VERIFICATION = "email-change-needs-verification",
-    EMAIL_EXISTS = "email-already-in-use",
-    EMULATOR_CONFIG_FAILED = "emulator-config-failed",
-    EXPIRED_OOB_CODE = "expired-action-code",
-    EXPIRED_POPUP_REQUEST = "cancelled-popup-request",
-    INTERNAL_ERROR = "internal-error",
-    INVALID_API_KEY = "invalid-api-key",
-    INVALID_APP_CREDENTIAL = "invalid-app-credential",
-    INVALID_APP_ID = "invalid-app-id",
-    INVALID_AUTH = "invalid-user-token",
-    INVALID_AUTH_EVENT = "invalid-auth-event",
-    INVALID_CERT_HASH = "invalid-cert-hash",
-    INVALID_CODE = "invalid-verification-code",
-    INVALID_CONTINUE_URI = "invalid-continue-uri",
-    INVALID_CORDOVA_CONFIGURATION = "invalid-cordova-configuration",
-    INVALID_CUSTOM_TOKEN = "invalid-custom-token",
-    INVALID_DYNAMIC_LINK_DOMAIN = "invalid-dynamic-link-domain",
-    INVALID_EMAIL = "invalid-email",
-    INVALID_EMULATOR_SCHEME = "invalid-emulator-scheme",
-    INVALID_IDP_RESPONSE = "invalid-credential",
-    INVALID_MESSAGE_PAYLOAD = "invalid-message-payload",
-    INVALID_MFA_SESSION = "invalid-multi-factor-session",
-    INVALID_OAUTH_CLIENT_ID = "invalid-oauth-client-id",
-    INVALID_OAUTH_PROVIDER = "invalid-oauth-provider",
-    INVALID_OOB_CODE = "invalid-action-code",
-    INVALID_ORIGIN = "unauthorized-domain",
-    INVALID_PASSWORD = "wrong-password",
-    INVALID_PERSISTENCE = "invalid-persistence-type",
-    INVALID_PHONE_NUMBER = "invalid-phone-number",
-    INVALID_PROVIDER_ID = "invalid-provider-id",
-    INVALID_RECIPIENT_EMAIL = "invalid-recipient-email",
-    INVALID_SENDER = "invalid-sender",
-    INVALID_SESSION_INFO = "invalid-verification-id",
-    INVALID_TENANT_ID = "invalid-tenant-id",
-    MFA_INFO_NOT_FOUND = "multi-factor-info-not-found",
-    MFA_REQUIRED = "multi-factor-auth-required",
-    MISSING_ANDROID_PACKAGE_NAME = "missing-android-pkg-name",
-    MISSING_APP_CREDENTIAL = "missing-app-credential",
-    MISSING_AUTH_DOMAIN = "auth-domain-config-required",
-    MISSING_CODE = "missing-verification-code",
-    MISSING_CONTINUE_URI = "missing-continue-uri",
-    MISSING_IFRAME_START = "missing-iframe-start",
-    MISSING_IOS_BUNDLE_ID = "missing-ios-bundle-id",
-    MISSING_OR_INVALID_NONCE = "missing-or-invalid-nonce",
-    MISSING_MFA_INFO = "missing-multi-factor-info",
-    MISSING_MFA_SESSION = "missing-multi-factor-session",
-    MISSING_PHONE_NUMBER = "missing-phone-number",
-    MISSING_SESSION_INFO = "missing-verification-id",
-    MODULE_DESTROYED = "app-deleted",
-    NEED_CONFIRMATION = "account-exists-with-different-credential",
-    NETWORK_REQUEST_FAILED = "network-request-failed",
-    NULL_USER = "null-user",
-    NO_AUTH_EVENT = "no-auth-event",
-    NO_SUCH_PROVIDER = "no-such-provider",
-    OPERATION_NOT_ALLOWED = "operation-not-allowed",
-    OPERATION_NOT_SUPPORTED = "operation-not-supported-in-this-environment",
-    POPUP_BLOCKED = "popup-blocked",
-    POPUP_CLOSED_BY_USER = "popup-closed-by-user",
-    PROVIDER_ALREADY_LINKED = "provider-already-linked",
-    QUOTA_EXCEEDED = "quota-exceeded",
-    REDIRECT_CANCELLED_BY_USER = "redirect-cancelled-by-user",
-    REDIRECT_OPERATION_PENDING = "redirect-operation-pending",
-    REJECTED_CREDENTIAL = "rejected-credential",
-    SECOND_FACTOR_ALREADY_ENROLLED = "second-factor-already-in-use",
-    SECOND_FACTOR_LIMIT_EXCEEDED = "maximum-second-factor-count-exceeded",
-    TENANT_ID_MISMATCH = "tenant-id-mismatch",
-    TIMEOUT = "timeout",
-    TOKEN_EXPIRED = "user-token-expired",
-    TOO_MANY_ATTEMPTS_TRY_LATER = "too-many-requests",
-    UNAUTHORIZED_DOMAIN = "unauthorized-continue-uri",
-    UNSUPPORTED_FIRST_FACTOR = "unsupported-first-factor",
-    UNSUPPORTED_PERSISTENCE = "unsupported-persistence-type",
-    UNSUPPORTED_TENANT_OPERATION = "unsupported-tenant-operation",
-    UNVERIFIED_EMAIL = "unverified-email",
-    USER_CANCELLED = "user-cancelled",
-    USER_DELETED = "user-not-found",
-    USER_DISABLED = "user-disabled",
-    USER_MISMATCH = "user-mismatch",
-    USER_SIGNED_OUT = "user-signed-out",
-    WEAK_PASSWORD = "weak-password",
-    WEB_STORAGE_UNSUPPORTED = "web-storage-unsupported",
-    ALREADY_INITIALIZED = "already-initialized"
-}
+/* Excluded from this release type: AuthErrorCode */
 
 /**
  * A map of potential `Auth` error codes, for easier comparison with errors
@@ -694,64 +595,18 @@ export declare const AuthErrorCodes: {
 export declare interface AuthErrorMap {
 }
 
-declare interface AuthErrorParams extends GenericAuthErrorParams {
-    [AuthErrorCode.ARGUMENT_ERROR]: {
-        appName?: AppName;
-    };
-    [AuthErrorCode.DEPENDENT_SDK_INIT_BEFORE_AUTH]: {
-        appName?: AppName;
-    };
-    [AuthErrorCode.INTERNAL_ERROR]: {
-        appName?: AppName;
-    };
-    [AuthErrorCode.OPERATION_NOT_SUPPORTED]: {
-        appName?: AppName;
-    };
-    [AuthErrorCode.NO_AUTH_EVENT]: {
-        appName?: AppName;
-    };
-    [AuthErrorCode.MFA_REQUIRED]: {
-        appName: AppName;
-        serverResponse: IdTokenMfaResponse;
-    };
-    [AuthErrorCode.INVALID_CORDOVA_CONFIGURATION]: {
-        appName: AppName;
-        missingPlugin?: string;
-    };
-}
+/* Excluded from this release type: AuthErrorParams */
 
-declare interface AuthEvent {
-    type: AuthEventType;
-    eventId: string | null;
-    urlResponse: string | null;
-    sessionId: string | null;
-    postBody: string | null;
-    tenantId: string | null;
-    error?: AuthEventError;
-}
+/* Excluded from this release type: AuthEvent */
 
-declare interface AuthEventConsumer {
-    readonly filter: AuthEventType[];
-    eventId: string | null;
-    onAuthEvent(event: AuthEvent): unknown;
-    onError(error: FirebaseError): unknown;
-}
+/* Excluded from this release type: AuthEventConsumer */
 
 declare interface AuthEventError extends Error {
     code: string;
     message: string;
 }
 
-declare const enum AuthEventType {
-    LINK_VIA_POPUP = "linkViaPopup",
-    LINK_VIA_REDIRECT = "linkViaRedirect",
-    REAUTH_VIA_POPUP = "reauthViaPopup",
-    REAUTH_VIA_REDIRECT = "reauthViaRedirect",
-    SIGN_IN_VIA_POPUP = "signInViaPopup",
-    SIGN_IN_VIA_REDIRECT = "signInViaRedirect",
-    UNKNOWN = "unknown",
-    VERIFY_APP = "verifyApp"
-}
+/* Excluded from this release type: AuthEventType */
 
 /* Excluded from this release type: AuthInternal */
 
@@ -862,13 +717,7 @@ export declare const browserSessionPersistence: Persistence;
  */
 export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;
 
-declare const enum ClientPlatform {
-    BROWSER = "Browser",
-    NODE = "Node",
-    REACT_NATIVE = "ReactNative",
-    CORDOVA = "Cordova",
-    WORKER = "Worker"
-}
+/* Excluded from this release type: ClientPlatform */
 export { CompleteFn }
 
 /**
@@ -903,18 +752,7 @@ export declare interface Config {
     authDomain?: string;
 }
 
-declare interface ConfigInternal extends Config {
-    /**
-     * @readonly
-     */
-    emulator?: {
-        url: string;
-    };
-    /**
-     * @readonly
-     */
-    clientPlatform: ClientPlatform;
-}
+/* Excluded from this release type: ConfigInternal */
 
 /**
  * A result from a phone number sign-in, link, or reauthenticate call.
@@ -1203,10 +1041,7 @@ export declare interface EmulatorConfig {
 }
 export { ErrorFn }
 
-declare interface EventManager {
-    registerConsumer(authEventConsumer: AuthEventConsumer): void;
-    unregisterConsumer(authEventConsumer: AuthEventConsumer): void;
-}
+/* Excluded from this release type: EventManager */
 
 /**
  * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.FACEBOOK.
@@ -1353,13 +1188,7 @@ declare interface FinalizeMfaResponse {
     refreshToken: string;
 }
 
-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;
-        email?: string;
-        phoneNumber?: string;
-    };
-};
+/* Excluded from this release type: GenericAuthErrorParams */
 
 /**
  * Extracts provider specific {@link AdditionalUserInfo} for the given credential.
@@ -1614,49 +1443,11 @@ export declare class GoogleAuthProvider extends BaseOAuthProvider {
  */
 declare type IdToken = string;
 
-declare interface IdTokenMfaResponse extends IdTokenResponse {
-    mfaPendingCredential?: string;
-    mfaInfo?: MfaEnrollment[];
-}
+/* Excluded from this release type: IdTokenMfaResponse */
 
-/**
- * IdToken as returned by the API
- *
- */
-declare interface IdTokenResponse {
-    localId: string;
-    idToken?: IdToken;
-    refreshToken?: string;
-    expiresIn?: string;
-    providerId?: string;
-    displayName?: string | null;
-    isNewUser?: boolean;
-    kind?: IdTokenResponseKind;
-    photoUrl?: string | null;
-    rawUserInfo?: string;
-    screenName?: string | null;
-}
+/* Excluded from this release type: IdTokenResponse */
 
-/**
- * The possible types of the `IdTokenResponse`
- *
- */
-declare const enum IdTokenResponseKind {
-    CreateAuthUri = "identitytoolkit#CreateAuthUriResponse",
-    DeleteAccount = "identitytoolkit#DeleteAccountResponse",
-    DownloadAccount = "identitytoolkit#DownloadAccountResponse",
-    EmailLinkSignin = "identitytoolkit#EmailLinkSigninResponse",
-    GetAccountInfo = "identitytoolkit#GetAccountInfoResponse",
-    GetOobConfirmationCode = "identitytoolkit#GetOobConfirmationCodeResponse",
-    GetRecaptchaParam = "identitytoolkit#GetRecaptchaParamResponse",
-    ResetPassword = "identitytoolkit#ResetPasswordResponse",
-    SetAccountInfo = "identitytoolkit#SetAccountInfoResponse",
-    SignupNewUser = "identitytoolkit#SignupNewUserResponse",
-    UploadAccount = "identitytoolkit#UploadAccountResponse",
-    VerifyAssertion = "identitytoolkit#VerifyAssertionResponse",
-    VerifyCustomToken = "identitytoolkit#VerifyCustomTokenResponse",
-    VerifyPassword = "identitytoolkit#VerifyPasswordResponse"
-}
+/* Excluded from this release type: IdTokenResponseKind */
 
 /**
  * Interface representing ID token result obtained from {@link User.getIdTokenResult}.
@@ -2580,6 +2371,10 @@ export declare class PhoneMultiFactorGenerator {
      * {@link MultiFactorResolver.resolveSignIn}
      */
     static assertion(credential: PhoneAuthCredential): PhoneMultiFactorAssertion;
+    /**
+     * The identifier of the phone second factor: `phone`.
+     */
+    static FACTOR_ID: string;
 }
 
 /**
@@ -2604,7 +2399,7 @@ export declare interface PhoneMultiFactorSignInInfoOptions {
     session: MultiFactorSession;
 }
 
-declare type PhoneOrOauthTokenResponse = SignInWithPhoneNumberResponse | SignInWithIdpResponse | IdTokenResponse;
+/* Excluded from this release type: PhoneOrOauthTokenResponse */
 
 /**
  * Options used for single-factor sign-in.
@@ -2656,43 +2451,7 @@ export declare const ProviderId: {
     readonly TWITTER: "twitter.com";
 };
 
-/**
- * @license
- * Copyright 2021 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Enumeration of supported providers.
- *
- */
-declare const enum ProviderId_2 {
-    /* Excluded from this release type: ANONYMOUS */
-    /* Excluded from this release type: CUSTOM */
-    /** Facebook provider ID */
-    FACEBOOK = "facebook.com",
-    /* Excluded from this release type: FIREBASE */
-    /** GitHub provider ID */
-    GITHUB = "github.com",
-    /** Google provider ID */
-    GOOGLE = "google.com",
-    /** Password provider */
-    PASSWORD = "password",
-    /** Phone provider */
-    PHONE = "phone",
-    /** Twitter provider ID */
-    TWITTER = "twitter.com"
-}
+/* Excluded from this release type: ProviderId_2 */
 
 declare interface ProviderUserInfo {
     providerId: string;
@@ -3215,13 +2974,7 @@ export declare function signInWithEmailAndPassword(auth: Auth, email: string, pa
  */
 export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;
 
-declare interface SignInWithIdpResponse extends IdTokenResponse {
-    oauthAccessToken?: string;
-    oauthTokenSecret?: string;
-    nonce?: string;
-    oauthIdToken?: string;
-    pendingToken?: string;
-}
+/* Excluded from this release type: SignInWithIdpResponse */
 
 /**
  * Asynchronously signs in using a phone number.
@@ -3252,18 +3005,9 @@ declare interface SignInWithIdpResponse extends IdTokenResponse {
  */
 export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 
-declare interface SignInWithPhoneNumberRequest {
-    temporaryProof?: string;
-    phoneNumber?: string;
-    sessionInfo?: string;
-    code?: string;
-    tenantId?: string;
-}
+/* Excluded from this release type: SignInWithPhoneNumberRequest */
 
-declare interface SignInWithPhoneNumberResponse extends IdTokenResponse {
-    temporaryProof?: string;
-    phoneNumber?: string;
-}
+/* Excluded from this release type: SignInWithPhoneNumberResponse */
 
 /**
  * Authenticates a Firebase client using a popup-based OAuth authentication flow.

package/dist/auth.d.ts

@@ -493,6 +493,8 @@ export declare interface AuthError extends FirebaseError {
 
 /**
  * Enumeration of Firebase Auth error codes.
+ *
+ * @internal
  */
 declare const enum AuthErrorCode {
     ADMIN_ONLY_OPERATION = "admin-restricted-operation",
@@ -723,6 +725,9 @@ export declare const AuthErrorCodes: {
 export declare interface AuthErrorMap {
 }
 
+/**
+ * @internal
+ */
 declare interface AuthErrorParams extends GenericAuthErrorParams {
     [AuthErrorCode.ARGUMENT_ERROR]: {
         appName?: AppName;
@@ -749,6 +754,9 @@ declare interface AuthErrorParams extends GenericAuthErrorParams {
     };
 }
 
+/**
+ * @internal
+ */
 declare interface AuthEvent {
     type: AuthEventType;
     eventId: string | null;
@@ -759,6 +767,9 @@ declare interface AuthEvent {
     error?: AuthEventError;
 }
 
+/**
+ * @internal
+ */
 declare interface AuthEventConsumer {
     readonly filter: AuthEventType[];
     eventId: string | null;
@@ -771,6 +782,9 @@ declare interface AuthEventError extends Error {
     message: string;
 }
 
+/**
+ * @internal
+ */
 declare const enum AuthEventType {
     LINK_VIA_POPUP = "linkViaPopup",
     LINK_VIA_REDIRECT = "linkViaRedirect",
@@ -926,6 +940,9 @@ export declare const browserSessionPersistence: Persistence;
  */
 export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;
 
+/**
+ * @internal
+ */
 declare const enum ClientPlatform {
     BROWSER = "Browser",
     NODE = "Node",
@@ -967,6 +984,9 @@ export declare interface Config {
     authDomain?: string;
 }
 
+/**
+ * @internal
+ */
 declare interface ConfigInternal extends Config {
     /**
      * @readonly
@@ -1276,6 +1296,9 @@ export declare interface EmulatorConfig {
 }
 export { ErrorFn }
 
+/**
+ * @internal
+ */
 declare interface EventManager {
     registerConsumer(authEventConsumer: AuthEventConsumer): void;
     unregisterConsumer(authEventConsumer: AuthEventConsumer): void;
@@ -1428,6 +1451,9 @@ declare interface FinalizeMfaResponse {
     refreshToken: string;
 }
 
+/**
+ * @internal
+ */
 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;
@@ -1689,6 +1715,9 @@ export declare class GoogleAuthProvider extends BaseOAuthProvider {
  */
 declare type IdToken = string;
 
+/**
+ * @internal
+ */
 declare interface IdTokenMfaResponse extends IdTokenResponse {
     mfaPendingCredential?: string;
     mfaInfo?: MfaEnrollment[];
@@ -1697,6 +1726,7 @@ declare interface IdTokenMfaResponse extends IdTokenResponse {
 /**
  * IdToken as returned by the API
  *
+ * @internal
  */
 declare interface IdTokenResponse {
     localId: string;
@@ -1715,6 +1745,7 @@ declare interface IdTokenResponse {
 /**
  * The possible types of the `IdTokenResponse`
  *
+ * @internal
  */
 declare const enum IdTokenResponseKind {
     CreateAuthUri = "identitytoolkit#CreateAuthUriResponse",
@@ -2666,6 +2697,10 @@ export declare class PhoneMultiFactorGenerator {
      * {@link MultiFactorResolver.resolveSignIn}
      */
     static assertion(credential: PhoneAuthCredential): PhoneMultiFactorAssertion;
+    /**
+     * The identifier of the phone second factor: `phone`.
+     */
+    static FACTOR_ID: string;
 }
 
 /**
@@ -2690,6 +2725,9 @@ export declare interface PhoneMultiFactorSignInInfoOptions {
     session: MultiFactorSession;
 }
 
+/**
+ * @internal
+ */
 declare type PhoneOrOauthTokenResponse = SignInWithPhoneNumberResponse | SignInWithIdpResponse | IdTokenResponse;
 
 /**
@@ -2775,7 +2813,7 @@ export declare const ProviderId: {
  */
 /**
  * Enumeration of supported providers.
- *
+ * @internal
  */
 declare const enum ProviderId_2 {
     /** @internal */
@@ -3330,6 +3368,9 @@ export declare function signInWithEmailAndPassword(auth: Auth, email: string, pa
  */
 export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;
 
+/**
+ * @internal
+ */
 declare interface SignInWithIdpResponse extends IdTokenResponse {
     oauthAccessToken?: string;
     oauthTokenSecret?: string;
@@ -3367,6 +3408,9 @@ declare interface SignInWithIdpResponse extends IdTokenResponse {
  */
 export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
 
+/**
+ * @internal
+ */
 declare interface SignInWithPhoneNumberRequest {
     temporaryProof?: string;
     phoneNumber?: string;
@@ -3375,6 +3419,9 @@ declare interface SignInWithPhoneNumberRequest {
     tenantId?: string;
 }
 
+/**
+ * @internal
+ */
 declare interface SignInWithPhoneNumberResponse extends IdTokenResponse {
     temporaryProof?: string;
     phoneNumber?: string;