UNPKG

3.16 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2021 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 */
17/**
18 * An enum of factors that may be used for multifactor authentication.
19 *
20 * @public
21 */
22export declare const FactorId: {
23 /** Phone as second factor */
24 readonly PHONE: "phone";
25};
26/**
27 * Enumeration of supported providers.
28 *
29 * @public
30 */
31export declare const ProviderId: {
32 /** Facebook provider ID */
33 readonly FACEBOOK: "facebook.com";
34 /** GitHub provider ID */
35 readonly GITHUB: "github.com";
36 /** Google provider ID */
37 readonly GOOGLE: "google.com";
38 /** Password provider */
39 readonly PASSWORD: "password";
40 /** Phone provider */
41 readonly PHONE: "phone";
42 /** Twitter provider ID */
43 readonly TWITTER: "twitter.com";
44};
45/**
46 * Enumeration of supported sign-in methods.
47 *
48 * @public
49 */
50export declare const SignInMethod: {
51 /** Email link sign in method */
52 readonly EMAIL_LINK: "emailLink";
53 /** Email/password sign in method */
54 readonly EMAIL_PASSWORD: "password";
55 /** Facebook sign in method */
56 readonly FACEBOOK: "facebook.com";
57 /** GitHub sign in method */
58 readonly GITHUB: "github.com";
59 /** Google sign in method */
60 readonly GOOGLE: "google.com";
61 /** Phone sign in method */
62 readonly PHONE: "phone";
63 /** Twitter sign in method */
64 readonly TWITTER: "twitter.com";
65};
66/**
67 * Enumeration of supported operation types.
68 *
69 * @public
70 */
71export declare const OperationType: {
72 /** Operation involving linking an additional provider to an already signed-in user. */
73 readonly LINK: "link";
74 /** Operation involving using a provider to reauthenticate an already signed-in user. */
75 readonly REAUTHENTICATE: "reauthenticate";
76 /** Operation involving signing in a user. */
77 readonly SIGN_IN: "signIn";
78};
79/**
80 * An enumeration of the possible email action types.
81 *
82 * @public
83 */
84export declare const ActionCodeOperation: {
85 /** The email link sign-in action. */
86 readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
87 /** The password reset action. */
88 readonly PASSWORD_RESET: "PASSWORD_RESET";
89 /** The email revocation action. */
90 readonly RECOVER_EMAIL: "RECOVER_EMAIL";
91 /** The revert second factor addition email action. */
92 readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
93 /** The revert second factor addition email action. */
94 readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
95 /** The email verification action. */
96 readonly VERIFY_EMAIL: "VERIFY_EMAIL";
97};