Skip to content

[Auth] Add exported const map for error codes #5182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 29, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions common/api-review/auth-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,105 @@ export interface AuthError extends FirebaseError {
readonly tenantid?: string;
}

// @public
export const AuthErrorCodes: {
ADMIN_ONLY_OPERATION: string;
ARGUMENT_ERROR: string;
APP_NOT_AUTHORIZED: string;
APP_NOT_INSTALLED: string;
CAPTCHA_CHECK_FAILED: string;
CODE_EXPIRED: string;
CORDOVA_NOT_READY: string;
CORS_UNSUPPORTED: string;
CREDENTIAL_ALREADY_IN_USE: string;
CREDENTIAL_MISMATCH: string;
CREDENTIAL_TOO_OLD_LOGIN_AGAIN: string;
DEPENDENT_SDK_INIT_BEFORE_AUTH: string;
DYNAMIC_LINK_NOT_ACTIVATED: string;
EMAIL_CHANGE_NEEDS_VERIFICATION: string;
EMAIL_EXISTS: string;
EMULATOR_CONFIG_FAILED: string;
EXPIRED_OOB_CODE: string;
EXPIRED_POPUP_REQUEST: string;
INTERNAL_ERROR: string;
INVALID_API_KEY: string;
INVALID_APP_CREDENTIAL: string;
INVALID_APP_ID: string;
INVALID_AUTH: string;
INVALID_AUTH_EVENT: string;
INVALID_CERT_HASH: string;
INVALID_CODE: string;
INVALID_CONTINUE_URI: string;
INVALID_CORDOVA_CONFIGURATION: string;
INVALID_CUSTOM_TOKEN: string;
INVALID_DYNAMIC_LINK_DOMAIN: string;
INVALID_EMAIL: string;
INVALID_EMULATOR_SCHEME: string;
INVALID_IDP_RESPONSE: string;
INVALID_MESSAGE_PAYLOAD: string;
INVALID_MFA_SESSION: string;
INVALID_OAUTH_CLIENT_ID: string;
INVALID_OAUTH_PROVIDER: string;
INVALID_OOB_CODE: string;
INVALID_ORIGIN: string;
INVALID_PASSWORD: string;
INVALID_PERSISTENCE: string;
INVALID_PHONE_NUMBER: string;
INVALID_PROVIDER_ID: string;
INVALID_RECIPIENT_EMAIL: string;
INVALID_SENDER: string;
INVALID_SESSION_INFO: string;
INVALID_TENANT_ID: string;
MFA_INFO_NOT_FOUND: string;
MFA_REQUIRED: string;
MISSING_ANDROID_PACKAGE_NAME: string;
MISSING_APP_CREDENTIAL: string;
MISSING_AUTH_DOMAIN: string;
MISSING_CODE: string;
MISSING_CONTINUE_URI: string;
MISSING_IFRAME_START: string;
MISSING_IOS_BUNDLE_ID: string;
MISSING_OR_INVALID_NONCE: string;
MISSING_MFA_INFO: string;
MISSING_MFA_SESSION: string;
MISSING_PHONE_NUMBER: string;
MISSING_SESSION_INFO: string;
MODULE_DESTROYED: string;
NEED_CONFIRMATION: string;
NETWORK_REQUEST_FAILED: string;
NULL_USER: string;
NO_AUTH_EVENT: string;
NO_SUCH_PROVIDER: string;
OPERATION_NOT_ALLOWED: string;
OPERATION_NOT_SUPPORTED: string;
POPUP_BLOCKED: string;
POPUP_CLOSED_BY_USER: string;
PROVIDER_ALREADY_LINKED: string;
QUOTA_EXCEEDED: string;
REDIRECT_CANCELLED_BY_USER: string;
REDIRECT_OPERATION_PENDING: string;
REJECTED_CREDENTIAL: string;
SECOND_FACTOR_ALREADY_ENROLLED: string;
SECOND_FACTOR_LIMIT_EXCEEDED: string;
TENANT_ID_MISMATCH: string;
TIMEOUT: string;
TOKEN_EXPIRED: string;
TOO_MANY_ATTEMPTS_TRY_LATER: string;
UNAUTHORIZED_DOMAIN: string;
UNSUPPORTED_FIRST_FACTOR: string;
UNSUPPORTED_PERSISTENCE: string;
UNSUPPORTED_TENANT_OPERATION: string;
UNVERIFIED_EMAIL: string;
USER_CANCELLED: string;
USER_DELETED: string;
USER_DISABLED: string;
USER_MISMATCH: string;
USER_SIGNED_OUT: string;
WEAK_PASSWORD: string;
WEB_STORAGE_UNSUPPORTED: string;
ALREADY_INITIALIZED: string;
};

// @public
export interface AuthErrorMap {
}
Expand Down
111 changes: 109 additions & 2 deletions packages-exp/auth-exp/src/core/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ import { AuthCredential } from './credentials';

/**
* Enumeration of Firebase Auth error codes.
*
* @public
*/
export const enum AuthErrorCode {
ADMIN_ONLY_OPERATION = 'admin-restricted-operation',
Expand Down Expand Up @@ -433,3 +431,112 @@ export const _DEFAULT_AUTH_ERROR_FACTORY = new ErrorFactory<
AuthErrorCode,
AuthErrorParams
>('auth', 'Firebase', _prodErrorMap());

/**
* A map of potential Auth error codes, for easier comparison with errors
* thrown by the SDK.
*
* @remarks
* Please note that you can't tree-shake individual keys
* in the map, so by using the map you might substantially increase your
* bundle size.
*
* @public
*/
export const AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY = {
ADMIN_ONLY_OPERATION: 'auth/admin-restricted-operation',
ARGUMENT_ERROR: 'auth/argument-error',
APP_NOT_AUTHORIZED: 'auth/app-not-authorized',
APP_NOT_INSTALLED: 'auth/app-not-installed',
CAPTCHA_CHECK_FAILED: 'auth/captcha-check-failed',
CODE_EXPIRED: 'auth/code-expired',
CORDOVA_NOT_READY: 'auth/cordova-not-ready',
CORS_UNSUPPORTED: 'auth/cors-unsupported',
CREDENTIAL_ALREADY_IN_USE: 'auth/credential-already-in-use',
CREDENTIAL_MISMATCH: 'auth/custom-token-mismatch',
CREDENTIAL_TOO_OLD_LOGIN_AGAIN: 'auth/requires-recent-login',
DEPENDENT_SDK_INIT_BEFORE_AUTH: 'auth/dependent-sdk-initialized-before-auth',
DYNAMIC_LINK_NOT_ACTIVATED: 'auth/dynamic-link-not-activated',
EMAIL_CHANGE_NEEDS_VERIFICATION: 'auth/email-change-needs-verification',
EMAIL_EXISTS: 'auth/email-already-in-use',
EMULATOR_CONFIG_FAILED: 'auth/emulator-config-failed',
EXPIRED_OOB_CODE: 'auth/expired-action-code',
EXPIRED_POPUP_REQUEST: 'auth/cancelled-popup-request',
INTERNAL_ERROR: 'auth/internal-error',
INVALID_API_KEY: 'auth/invalid-api-key',
INVALID_APP_CREDENTIAL: 'auth/invalid-app-credential',
INVALID_APP_ID: 'auth/invalid-app-id',
INVALID_AUTH: 'auth/invalid-user-token',
INVALID_AUTH_EVENT: 'auth/invalid-auth-event',
INVALID_CERT_HASH: 'auth/invalid-cert-hash',
INVALID_CODE: 'auth/invalid-verification-code',
INVALID_CONTINUE_URI: 'auth/invalid-continue-uri',
INVALID_CORDOVA_CONFIGURATION: 'auth/invalid-cordova-configuration',
INVALID_CUSTOM_TOKEN: 'auth/invalid-custom-token',
INVALID_DYNAMIC_LINK_DOMAIN: 'auth/invalid-dynamic-link-domain',
INVALID_EMAIL: 'auth/invalid-email',
INVALID_EMULATOR_SCHEME: 'auth/invalid-emulator-scheme',
INVALID_IDP_RESPONSE: 'auth/invalid-credential',
INVALID_MESSAGE_PAYLOAD: 'auth/invalid-message-payload',
INVALID_MFA_SESSION: 'auth/invalid-multi-factor-session',
INVALID_OAUTH_CLIENT_ID: 'auth/invalid-oauth-client-id',
INVALID_OAUTH_PROVIDER: 'auth/invalid-oauth-provider',
INVALID_OOB_CODE: 'auth/invalid-action-code',
INVALID_ORIGIN: 'auth/unauthorized-domain',
INVALID_PASSWORD: 'auth/wrong-password',
INVALID_PERSISTENCE: 'auth/invalid-persistence-type',
INVALID_PHONE_NUMBER: 'auth/invalid-phone-number',
INVALID_PROVIDER_ID: 'auth/invalid-provider-id',
INVALID_RECIPIENT_EMAIL: 'auth/invalid-recipient-email',
INVALID_SENDER: 'auth/invalid-sender',
INVALID_SESSION_INFO: 'auth/invalid-verification-id',
INVALID_TENANT_ID: 'auth/invalid-tenant-id',
MFA_INFO_NOT_FOUND: 'auth/multi-factor-info-not-found',
MFA_REQUIRED: 'auth/multi-factor-auth-required',
MISSING_ANDROID_PACKAGE_NAME: 'auth/missing-android-pkg-name',
MISSING_APP_CREDENTIAL: 'auth/missing-app-credential',
MISSING_AUTH_DOMAIN: 'auth/auth-domain-config-required',
MISSING_CODE: 'auth/missing-verification-code',
MISSING_CONTINUE_URI: 'auth/missing-continue-uri',
MISSING_IFRAME_START: 'auth/missing-iframe-start',
MISSING_IOS_BUNDLE_ID: 'auth/missing-ios-bundle-id',
MISSING_OR_INVALID_NONCE: 'auth/missing-or-invalid-nonce',
MISSING_MFA_INFO: 'auth/missing-multi-factor-info',
MISSING_MFA_SESSION: 'auth/missing-multi-factor-session',
MISSING_PHONE_NUMBER: 'auth/missing-phone-number',
MISSING_SESSION_INFO: 'auth/missing-verification-id',
MODULE_DESTROYED: 'auth/app-deleted',
NEED_CONFIRMATION: 'auth/account-exists-with-different-credential',
NETWORK_REQUEST_FAILED: 'auth/network-request-failed',
NULL_USER: 'auth/null-user',
NO_AUTH_EVENT: 'auth/no-auth-event',
NO_SUCH_PROVIDER: 'auth/no-such-provider',
OPERATION_NOT_ALLOWED: 'auth/operation-not-allowed',
OPERATION_NOT_SUPPORTED: 'auth/operation-not-supported-in-this-environment',
POPUP_BLOCKED: 'auth/popup-blocked',
POPUP_CLOSED_BY_USER: 'auth/popup-closed-by-user',
PROVIDER_ALREADY_LINKED: 'auth/provider-already-linked',
QUOTA_EXCEEDED: 'auth/quota-exceeded',
REDIRECT_CANCELLED_BY_USER: 'auth/redirect-cancelled-by-user',
REDIRECT_OPERATION_PENDING: 'auth/redirect-operation-pending',
REJECTED_CREDENTIAL: 'auth/rejected-credential',
SECOND_FACTOR_ALREADY_ENROLLED: 'auth/second-factor-already-in-use',
SECOND_FACTOR_LIMIT_EXCEEDED: 'auth/maximum-second-factor-count-exceeded',
TENANT_ID_MISMATCH: 'auth/tenant-id-mismatch',
TIMEOUT: 'auth/timeout',
TOKEN_EXPIRED: 'auth/user-token-expired',
TOO_MANY_ATTEMPTS_TRY_LATER: 'auth/too-many-requests',
UNAUTHORIZED_DOMAIN: 'auth/unauthorized-continue-uri',
UNSUPPORTED_FIRST_FACTOR: 'auth/unsupported-first-factor',
UNSUPPORTED_PERSISTENCE: 'auth/unsupported-persistence-type',
UNSUPPORTED_TENANT_OPERATION: 'auth/unsupported-tenant-operation',
UNVERIFIED_EMAIL: 'auth/unverified-email',
USER_CANCELLED: 'auth/user-cancelled',
USER_DELETED: 'auth/user-not-found',
USER_DISABLED: 'auth/user-disabled',
USER_MISMATCH: 'auth/user-mismatch',
USER_SIGNED_OUT: 'auth/user-signed-out',
WEAK_PASSWORD: 'auth/weak-password',
WEB_STORAGE_UNSUPPORTED: 'auth/web-storage-unsupported',
ALREADY_INITIALIZED: 'auth/already-initialized'
};
6 changes: 5 additions & 1 deletion packages-exp/auth-exp/src/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ import {
Unsubscribe
} from '../model/public_types';

export { debugErrorMap, prodErrorMap } from './errors';
export {
debugErrorMap,
prodErrorMap,
AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY as AuthErrorCodes
} from './errors';

// Non-optional auth methods.
/**
Expand Down