UNPKG

5.13 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import { AuthErrorCode } from '../core/errors';
18/**
19 * Errors that can be returned by the backend
20 */
21export declare const enum ServerError {
22 ADMIN_ONLY_OPERATION = "ADMIN_ONLY_OPERATION",
23 BLOCKING_FUNCTION_ERROR_RESPONSE = "BLOCKING_FUNCTION_ERROR_RESPONSE",
24 CAPTCHA_CHECK_FAILED = "CAPTCHA_CHECK_FAILED",
25 CORS_UNSUPPORTED = "CORS_UNSUPPORTED",
26 CREDENTIAL_MISMATCH = "CREDENTIAL_MISMATCH",
27 CREDENTIAL_TOO_OLD_LOGIN_AGAIN = "CREDENTIAL_TOO_OLD_LOGIN_AGAIN",
28 DYNAMIC_LINK_NOT_ACTIVATED = "DYNAMIC_LINK_NOT_ACTIVATED",
29 EMAIL_CHANGE_NEEDS_VERIFICATION = "EMAIL_CHANGE_NEEDS_VERIFICATION",
30 EMAIL_EXISTS = "EMAIL_EXISTS",
31 EMAIL_NOT_FOUND = "EMAIL_NOT_FOUND",
32 EXPIRED_OOB_CODE = "EXPIRED_OOB_CODE",
33 FEDERATED_USER_ID_ALREADY_LINKED = "FEDERATED_USER_ID_ALREADY_LINKED",
34 INVALID_APP_CREDENTIAL = "INVALID_APP_CREDENTIAL",
35 INVALID_APP_ID = "INVALID_APP_ID",
36 INVALID_CERT_HASH = "INVALID_CERT_HASH",
37 INVALID_CODE = "INVALID_CODE",
38 INVALID_CONTINUE_URI = "INVALID_CONTINUE_URI",
39 INVALID_CUSTOM_TOKEN = "INVALID_CUSTOM_TOKEN",
40 INVALID_DYNAMIC_LINK_DOMAIN = "INVALID_DYNAMIC_LINK_DOMAIN",
41 INVALID_EMAIL = "INVALID_EMAIL",
42 INVALID_ID_TOKEN = "INVALID_ID_TOKEN",
43 INVALID_IDP_RESPONSE = "INVALID_IDP_RESPONSE",
44 INVALID_IDENTIFIER = "INVALID_IDENTIFIER",
45 INVALID_MESSAGE_PAYLOAD = "INVALID_MESSAGE_PAYLOAD",
46 INVALID_MFA_PENDING_CREDENTIAL = "INVALID_MFA_PENDING_CREDENTIAL",
47 INVALID_OAUTH_CLIENT_ID = "INVALID_OAUTH_CLIENT_ID",
48 INVALID_OOB_CODE = "INVALID_OOB_CODE",
49 INVALID_PASSWORD = "INVALID_PASSWORD",
50 INVALID_PENDING_TOKEN = "INVALID_PENDING_TOKEN",
51 INVALID_PHONE_NUMBER = "INVALID_PHONE_NUMBER",
52 INVALID_PROVIDER_ID = "INVALID_PROVIDER_ID",
53 INVALID_RECIPIENT_EMAIL = "INVALID_RECIPIENT_EMAIL",
54 INVALID_SENDER = "INVALID_SENDER",
55 INVALID_SESSION_INFO = "INVALID_SESSION_INFO",
56 INVALID_TEMPORARY_PROOF = "INVALID_TEMPORARY_PROOF",
57 INVALID_TENANT_ID = "INVALID_TENANT_ID",
58 MFA_ENROLLMENT_NOT_FOUND = "MFA_ENROLLMENT_NOT_FOUND",
59 MISSING_ANDROID_PACKAGE_NAME = "MISSING_ANDROID_PACKAGE_NAME",
60 MISSING_APP_CREDENTIAL = "MISSING_APP_CREDENTIAL",
61 MISSING_CODE = "MISSING_CODE",
62 MISSING_CONTINUE_URI = "MISSING_CONTINUE_URI",
63 MISSING_CUSTOM_TOKEN = "MISSING_CUSTOM_TOKEN",
64 MISSING_IOS_BUNDLE_ID = "MISSING_IOS_BUNDLE_ID",
65 MISSING_MFA_ENROLLMENT_ID = "MISSING_MFA_ENROLLMENT_ID",
66 MISSING_MFA_PENDING_CREDENTIAL = "MISSING_MFA_PENDING_CREDENTIAL",
67 MISSING_OOB_CODE = "MISSING_OOB_CODE",
68 MISSING_OR_INVALID_NONCE = "MISSING_OR_INVALID_NONCE",
69 MISSING_PASSWORD = "MISSING_PASSWORD",
70 MISSING_REQ_TYPE = "MISSING_REQ_TYPE",
71 MISSING_PHONE_NUMBER = "MISSING_PHONE_NUMBER",
72 MISSING_SESSION_INFO = "MISSING_SESSION_INFO",
73 OPERATION_NOT_ALLOWED = "OPERATION_NOT_ALLOWED",
74 PASSWORD_LOGIN_DISABLED = "PASSWORD_LOGIN_DISABLED",
75 QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
76 RESET_PASSWORD_EXCEED_LIMIT = "RESET_PASSWORD_EXCEED_LIMIT",
77 REJECTED_CREDENTIAL = "REJECTED_CREDENTIAL",
78 SECOND_FACTOR_EXISTS = "SECOND_FACTOR_EXISTS",
79 SECOND_FACTOR_LIMIT_EXCEEDED = "SECOND_FACTOR_LIMIT_EXCEEDED",
80 SESSION_EXPIRED = "SESSION_EXPIRED",
81 TENANT_ID_MISMATCH = "TENANT_ID_MISMATCH",
82 TOKEN_EXPIRED = "TOKEN_EXPIRED",
83 TOO_MANY_ATTEMPTS_TRY_LATER = "TOO_MANY_ATTEMPTS_TRY_LATER",
84 UNSUPPORTED_FIRST_FACTOR = "UNSUPPORTED_FIRST_FACTOR",
85 UNSUPPORTED_TENANT_OPERATION = "UNSUPPORTED_TENANT_OPERATION",
86 UNAUTHORIZED_DOMAIN = "UNAUTHORIZED_DOMAIN",
87 UNVERIFIED_EMAIL = "UNVERIFIED_EMAIL",
88 USER_CANCELLED = "USER_CANCELLED",
89 USER_DISABLED = "USER_DISABLED",
90 USER_NOT_FOUND = "USER_NOT_FOUND",
91 WEAK_PASSWORD = "WEAK_PASSWORD"
92}
93/**
94 * API Response in the event of an error
95 */
96export interface JsonError {
97 error: {
98 code: number;
99 message: string;
100 errors?: [
101 {
102 message: ServerError;
103 domain: string;
104 reason: string;
105 }
106 ];
107 };
108}
109/**
110 * Type definition for a map from server errors to developer visible errors
111 */
112export declare type ServerErrorMap<ApiError extends string> = {
113 readonly [K in ApiError]: AuthErrorCode;
114};
115/**
116 * Map from errors returned by the server to errors to developer visible errors
117 */
118export declare const SERVER_ERROR_MAP: Partial<ServerErrorMap<ServerError>>;