Skip to content

Commit 70e9913

Browse files
committed
Add an exported error map const to Auth
1 parent 6ef484a commit 70e9913

File tree

3 files changed

+209
-3
lines changed

3 files changed

+209
-3
lines changed

common/api-review/auth-exp.api.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,105 @@ export interface AuthError extends FirebaseError {
126126
readonly tenantid?: string;
127127
}
128128

129+
// @public
130+
export const AuthErrorCodes: {
131+
ADMIN_ONLY_OPERATION: string;
132+
ARGUMENT_ERROR: string;
133+
APP_NOT_AUTHORIZED: string;
134+
APP_NOT_INSTALLED: string;
135+
CAPTCHA_CHECK_FAILED: string;
136+
CODE_EXPIRED: string;
137+
CORDOVA_NOT_READY: string;
138+
CORS_UNSUPPORTED: string;
139+
CREDENTIAL_ALREADY_IN_USE: string;
140+
CREDENTIAL_MISMATCH: string;
141+
CREDENTIAL_TOO_OLD_LOGIN_AGAIN: string;
142+
DEPENDENT_SDK_INIT_BEFORE_AUTH: string;
143+
DYNAMIC_LINK_NOT_ACTIVATED: string;
144+
EMAIL_CHANGE_NEEDS_VERIFICATION: string;
145+
EMAIL_EXISTS: string;
146+
EMULATOR_CONFIG_FAILED: string;
147+
EXPIRED_OOB_CODE: string;
148+
EXPIRED_POPUP_REQUEST: string;
149+
INTERNAL_ERROR: string;
150+
INVALID_API_KEY: string;
151+
INVALID_APP_CREDENTIAL: string;
152+
INVALID_APP_ID: string;
153+
INVALID_AUTH: string;
154+
INVALID_AUTH_EVENT: string;
155+
INVALID_CERT_HASH: string;
156+
INVALID_CODE: string;
157+
INVALID_CONTINUE_URI: string;
158+
INVALID_CORDOVA_CONFIGURATION: string;
159+
INVALID_CUSTOM_TOKEN: string;
160+
INVALID_DYNAMIC_LINK_DOMAIN: string;
161+
INVALID_EMAIL: string;
162+
INVALID_EMULATOR_SCHEME: string;
163+
INVALID_IDP_RESPONSE: string;
164+
INVALID_MESSAGE_PAYLOAD: string;
165+
INVALID_MFA_SESSION: string;
166+
INVALID_OAUTH_CLIENT_ID: string;
167+
INVALID_OAUTH_PROVIDER: string;
168+
INVALID_OOB_CODE: string;
169+
INVALID_ORIGIN: string;
170+
INVALID_PASSWORD: string;
171+
INVALID_PERSISTENCE: string;
172+
INVALID_PHONE_NUMBER: string;
173+
INVALID_PROVIDER_ID: string;
174+
INVALID_RECIPIENT_EMAIL: string;
175+
INVALID_SENDER: string;
176+
INVALID_SESSION_INFO: string;
177+
INVALID_TENANT_ID: string;
178+
MFA_INFO_NOT_FOUND: string;
179+
MFA_REQUIRED: string;
180+
MISSING_ANDROID_PACKAGE_NAME: string;
181+
MISSING_APP_CREDENTIAL: string;
182+
MISSING_AUTH_DOMAIN: string;
183+
MISSING_CODE: string;
184+
MISSING_CONTINUE_URI: string;
185+
MISSING_IFRAME_START: string;
186+
MISSING_IOS_BUNDLE_ID: string;
187+
MISSING_OR_INVALID_NONCE: string;
188+
MISSING_MFA_INFO: string;
189+
MISSING_MFA_SESSION: string;
190+
MISSING_PHONE_NUMBER: string;
191+
MISSING_SESSION_INFO: string;
192+
MODULE_DESTROYED: string;
193+
NEED_CONFIRMATION: string;
194+
NETWORK_REQUEST_FAILED: string;
195+
NULL_USER: string;
196+
NO_AUTH_EVENT: string;
197+
NO_SUCH_PROVIDER: string;
198+
OPERATION_NOT_ALLOWED: string;
199+
OPERATION_NOT_SUPPORTED: string;
200+
POPUP_BLOCKED: string;
201+
POPUP_CLOSED_BY_USER: string;
202+
PROVIDER_ALREADY_LINKED: string;
203+
QUOTA_EXCEEDED: string;
204+
REDIRECT_CANCELLED_BY_USER: string;
205+
REDIRECT_OPERATION_PENDING: string;
206+
REJECTED_CREDENTIAL: string;
207+
SECOND_FACTOR_ALREADY_ENROLLED: string;
208+
SECOND_FACTOR_LIMIT_EXCEEDED: string;
209+
TENANT_ID_MISMATCH: string;
210+
TIMEOUT: string;
211+
TOKEN_EXPIRED: string;
212+
TOO_MANY_ATTEMPTS_TRY_LATER: string;
213+
UNAUTHORIZED_DOMAIN: string;
214+
UNSUPPORTED_FIRST_FACTOR: string;
215+
UNSUPPORTED_PERSISTENCE: string;
216+
UNSUPPORTED_TENANT_OPERATION: string;
217+
UNVERIFIED_EMAIL: string;
218+
USER_CANCELLED: string;
219+
USER_DELETED: string;
220+
USER_DISABLED: string;
221+
USER_MISMATCH: string;
222+
USER_SIGNED_OUT: string;
223+
WEAK_PASSWORD: string;
224+
WEB_STORAGE_UNSUPPORTED: string;
225+
ALREADY_INITIALIZED: string;
226+
};
227+
129228
// @public
130229
export interface AuthErrorMap {
131230
}

packages-exp/auth-exp/src/core/errors.ts

Lines changed: 109 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ import { AuthCredential } from './credentials';
2525

2626
/**
2727
* Enumeration of Firebase Auth error codes.
28-
*
29-
* @public
3028
*/
3129
export const enum AuthErrorCode {
3230
ADMIN_ONLY_OPERATION = 'admin-restricted-operation',
@@ -433,3 +431,112 @@ export const _DEFAULT_AUTH_ERROR_FACTORY = new ErrorFactory<
433431
AuthErrorCode,
434432
AuthErrorParams
435433
>('auth', 'Firebase', _prodErrorMap());
434+
435+
/**
436+
* A map of potential Auth error codes, for easier comparison with errors
437+
* thrown by the SDK.
438+
*
439+
* @remarks
440+
* Please note that you can't tree-shake individual keys
441+
* in the map, so by using the map you might substantially increase your
442+
* bundle size.
443+
*
444+
* @public
445+
*/
446+
export const AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY = {
447+
ADMIN_ONLY_OPERATION: 'auth/admin-restricted-operation',
448+
ARGUMENT_ERROR: 'auth/argument-error',
449+
APP_NOT_AUTHORIZED: 'auth/app-not-authorized',
450+
APP_NOT_INSTALLED: 'auth/app-not-installed',
451+
CAPTCHA_CHECK_FAILED: 'auth/captcha-check-failed',
452+
CODE_EXPIRED: 'auth/code-expired',
453+
CORDOVA_NOT_READY: 'auth/cordova-not-ready',
454+
CORS_UNSUPPORTED: 'auth/cors-unsupported',
455+
CREDENTIAL_ALREADY_IN_USE: 'auth/credential-already-in-use',
456+
CREDENTIAL_MISMATCH: 'auth/custom-token-mismatch',
457+
CREDENTIAL_TOO_OLD_LOGIN_AGAIN: 'auth/requires-recent-login',
458+
DEPENDENT_SDK_INIT_BEFORE_AUTH: 'auth/dependent-sdk-initialized-before-auth',
459+
DYNAMIC_LINK_NOT_ACTIVATED: 'auth/dynamic-link-not-activated',
460+
EMAIL_CHANGE_NEEDS_VERIFICATION: 'auth/email-change-needs-verification',
461+
EMAIL_EXISTS: 'auth/email-already-in-use',
462+
EMULATOR_CONFIG_FAILED: 'auth/emulator-config-failed',
463+
EXPIRED_OOB_CODE: 'auth/expired-action-code',
464+
EXPIRED_POPUP_REQUEST: 'auth/cancelled-popup-request',
465+
INTERNAL_ERROR: 'auth/internal-error',
466+
INVALID_API_KEY: 'auth/invalid-api-key',
467+
INVALID_APP_CREDENTIAL: 'auth/invalid-app-credential',
468+
INVALID_APP_ID: 'auth/invalid-app-id',
469+
INVALID_AUTH: 'auth/invalid-user-token',
470+
INVALID_AUTH_EVENT: 'auth/invalid-auth-event',
471+
INVALID_CERT_HASH: 'auth/invalid-cert-hash',
472+
INVALID_CODE: 'auth/invalid-verification-code',
473+
INVALID_CONTINUE_URI: 'auth/invalid-continue-uri',
474+
INVALID_CORDOVA_CONFIGURATION: 'auth/invalid-cordova-configuration',
475+
INVALID_CUSTOM_TOKEN: 'auth/invalid-custom-token',
476+
INVALID_DYNAMIC_LINK_DOMAIN: 'auth/invalid-dynamic-link-domain',
477+
INVALID_EMAIL: 'auth/invalid-email',
478+
INVALID_EMULATOR_SCHEME: 'auth/invalid-emulator-scheme',
479+
INVALID_IDP_RESPONSE: 'auth/invalid-credential',
480+
INVALID_MESSAGE_PAYLOAD: 'auth/invalid-message-payload',
481+
INVALID_MFA_SESSION: 'auth/invalid-multi-factor-session',
482+
INVALID_OAUTH_CLIENT_ID: 'auth/invalid-oauth-client-id',
483+
INVALID_OAUTH_PROVIDER: 'auth/invalid-oauth-provider',
484+
INVALID_OOB_CODE: 'auth/invalid-action-code',
485+
INVALID_ORIGIN: 'auth/unauthorized-domain',
486+
INVALID_PASSWORD: 'auth/wrong-password',
487+
INVALID_PERSISTENCE: 'auth/invalid-persistence-type',
488+
INVALID_PHONE_NUMBER: 'auth/invalid-phone-number',
489+
INVALID_PROVIDER_ID: 'auth/invalid-provider-id',
490+
INVALID_RECIPIENT_EMAIL: 'auth/invalid-recipient-email',
491+
INVALID_SENDER: 'auth/invalid-sender',
492+
INVALID_SESSION_INFO: 'auth/invalid-verification-id',
493+
INVALID_TENANT_ID: 'auth/invalid-tenant-id',
494+
MFA_INFO_NOT_FOUND: 'auth/multi-factor-info-not-found',
495+
MFA_REQUIRED: 'auth/multi-factor-auth-required',
496+
MISSING_ANDROID_PACKAGE_NAME: 'auth/missing-android-pkg-name',
497+
MISSING_APP_CREDENTIAL: 'auth/missing-app-credential',
498+
MISSING_AUTH_DOMAIN: 'auth/auth-domain-config-required',
499+
MISSING_CODE: 'auth/missing-verification-code',
500+
MISSING_CONTINUE_URI: 'auth/missing-continue-uri',
501+
MISSING_IFRAME_START: 'auth/missing-iframe-start',
502+
MISSING_IOS_BUNDLE_ID: 'auth/missing-ios-bundle-id',
503+
MISSING_OR_INVALID_NONCE: 'auth/missing-or-invalid-nonce',
504+
MISSING_MFA_INFO: 'auth/missing-multi-factor-info',
505+
MISSING_MFA_SESSION: 'auth/missing-multi-factor-session',
506+
MISSING_PHONE_NUMBER: 'auth/missing-phone-number',
507+
MISSING_SESSION_INFO: 'auth/missing-verification-id',
508+
MODULE_DESTROYED: 'auth/app-deleted',
509+
NEED_CONFIRMATION: 'auth/account-exists-with-different-credential',
510+
NETWORK_REQUEST_FAILED: 'auth/network-request-failed',
511+
NULL_USER: 'auth/null-user',
512+
NO_AUTH_EVENT: 'auth/no-auth-event',
513+
NO_SUCH_PROVIDER: 'auth/no-such-provider',
514+
OPERATION_NOT_ALLOWED: 'auth/operation-not-allowed',
515+
OPERATION_NOT_SUPPORTED: 'auth/operation-not-supported-in-this-environment',
516+
POPUP_BLOCKED: 'auth/popup-blocked',
517+
POPUP_CLOSED_BY_USER: 'auth/popup-closed-by-user',
518+
PROVIDER_ALREADY_LINKED: 'auth/provider-already-linked',
519+
QUOTA_EXCEEDED: 'auth/quota-exceeded',
520+
REDIRECT_CANCELLED_BY_USER: 'auth/redirect-cancelled-by-user',
521+
REDIRECT_OPERATION_PENDING: 'auth/redirect-operation-pending',
522+
REJECTED_CREDENTIAL: 'auth/rejected-credential',
523+
SECOND_FACTOR_ALREADY_ENROLLED: 'auth/second-factor-already-in-use',
524+
SECOND_FACTOR_LIMIT_EXCEEDED: 'auth/maximum-second-factor-count-exceeded',
525+
TENANT_ID_MISMATCH: 'auth/tenant-id-mismatch',
526+
TIMEOUT: 'auth/timeout',
527+
TOKEN_EXPIRED: 'auth/user-token-expired',
528+
TOO_MANY_ATTEMPTS_TRY_LATER: 'auth/too-many-requests',
529+
UNAUTHORIZED_DOMAIN: 'auth/unauthorized-continue-uri',
530+
UNSUPPORTED_FIRST_FACTOR: 'auth/unsupported-first-factor',
531+
UNSUPPORTED_PERSISTENCE: 'auth/unsupported-persistence-type',
532+
UNSUPPORTED_TENANT_OPERATION: 'auth/unsupported-tenant-operation',
533+
UNVERIFIED_EMAIL: 'auth/unverified-email',
534+
USER_CANCELLED: 'auth/user-cancelled',
535+
USER_DELETED: 'auth/user-not-found',
536+
USER_DISABLED: 'auth/user-disabled',
537+
USER_MISMATCH: 'auth/user-mismatch',
538+
USER_SIGNED_OUT: 'auth/user-signed-out',
539+
WEAK_PASSWORD: 'auth/weak-password',
540+
WEB_STORAGE_UNSUPPORTED: 'auth/web-storage-unsupported',
541+
ALREADY_INITIALIZED: 'auth/already-initialized'
542+
};

packages-exp/auth-exp/src/core/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import {
2626
Unsubscribe
2727
} from '../model/public_types';
2828

29-
export { debugErrorMap, prodErrorMap } from './errors';
29+
export { debugErrorMap, prodErrorMap, AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY as AuthErrorCodes } from './errors';
3030

3131
// Non-optional auth methods.
3232
/**

0 commit comments

Comments
 (0)