-
Notifications
You must be signed in to change notification settings - Fork 7
/
AuthEventData.ts
122 lines (117 loc) · 2.85 KB
/
AuthEventData.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/**
* Copyright 2020 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
*
* https://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.
*/
/**
* The data within all Firebase Auth events.
*/
export interface AuthEventData {
/**
* User's custom claims, typically used to define user roles and propagated
* to an authenticated user's ID token.
*/
customClaims?: CustomClaims;
/**
* Whether the user is disabled.
*/
disabled?: boolean;
/**
* The user's display name.
*/
displayName?: string;
/**
* The user's primary email, if set.
*/
email?: string;
/**
* Whether or not the user's primary email is verified.
*/
emailVerified?: boolean;
/**
* Additional metadata about the user.
*/
metadata?: Metadata;
/**
* The user's phone number.
*/
phoneNumber?: string;
/**
* The user's photo URL.
*/
photoUrl?: string;
/**
* User's info at the providers
*/
providerData?: ProviderDatum[];
/**
* The user identifier in the Firebase app.
*/
uid?: string;
}
/**
* User's custom claims, typically used to define user roles and propagated
* to an authenticated user's ID token.
*/
export interface CustomClaims {
/**
* Unordered map of dynamically typed values.
*/
fields?: { [key: string]: { [key: string]: any } };
}
/**
* Additional metadata about the user.
*/
export interface Metadata {
/**
* The date the user was created.
*/
createdAt?: Date;
/**
* The date the user last signed in.
*/
lastSignedInAt?: Date;
}
/**
* User's info at the identity provider
*/
export interface ProviderDatum {
/**
* The display name for the linked provider.
*/
displayName?: string;
/**
* The email for the linked provider.
*/
email?: string;
/**
* The photo URL for the linked provider.
*/
photoUrl?: string;
/**
* The linked provider ID (e.g. "google.com" for the Google provider).
*/
providerId?: string;
/**
* The user identifier for the linked provider.
*/
uid?: string;
}
/**
* Cast a raw JSON object to a typed event (useful for IDE autocompletion).
* @param {object} json The JSON object
* @return {AuthEventData} The object with type annotations
*/
export const toAuthEventData = (json: object) => {
return json as AuthEventData;
};