forked from aws-amplify/amplify-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Auth.ts
216 lines (187 loc) · 4.77 KB
/
Auth.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*
* Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file 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.
*/
import {
ICookieStorageData,
ICognitoStorage,
CognitoUserAttribute,
} from 'amazon-cognito-identity-js';
/**
* Parameters for user sign up
*/
export interface SignUpParams {
username: string;
password: string;
attributes?: object;
validationData?: CognitoUserAttribute[];
clientMetadata?: { [key: string]: string };
}
export interface AuthCache {
setItem();
getItem();
removeItem();
}
/**
* Auth instance options
*/
export interface AuthOptions {
userPoolId?: string;
userPoolWebClientId?: string;
identityPoolId?: string;
region?: string;
mandatorySignIn?: boolean;
cookieStorage?: ICookieStorageData;
oauth?: OAuthOpts;
refreshHandlers?: object;
storage?: ICognitoStorage;
authenticationFlowType?: string;
identityPoolRegion?: string;
clientMetadata?: any;
}
export enum CognitoHostedUIIdentityProvider {
Cognito = 'COGNITO',
Google = 'Google',
Facebook = 'Facebook',
Amazon = 'LoginWithAmazon',
}
export type LegacyProvider =
| 'google'
| 'facebook'
| 'amazon'
| 'developer'
| string;
export type FederatedSignInOptions = {
provider: CognitoHostedUIIdentityProvider;
customState?: string;
};
export type FederatedSignInOptionsCustom = {
customProvider: string;
customState?: string;
};
export function isFederatedSignInOptions(
obj: any
): obj is FederatedSignInOptions {
const keys: (keyof FederatedSignInOptions)[] = ['provider', 'customState'];
return obj && !!keys.find(k => obj.hasOwnProperty(k));
}
export function isFederatedSignInOptionsCustom(
obj: any
): obj is FederatedSignInOptionsCustom {
const keys: (keyof FederatedSignInOptionsCustom)[] = [
'customProvider',
'customState',
];
return obj && !!keys.find(k => obj.hasOwnProperty(k));
}
/**
* Details for multi-factor authentication
*/
export interface MfaRequiredDetails {
challengeName: any;
challengeParameters: any;
}
/**
* interface for federatedResponse
*/
export interface FederatedResponse {
// access token
token: string;
// identity id
identity_id?: string;
// the universal time when token expired
expires_at: number;
}
/**
* interface for federatedUser
*/
export interface FederatedUser {
name: string;
email?: string;
picture?: string;
}
export interface AwsCognitoOAuthOpts {
domain: string;
scope: Array<string>;
redirectSignIn: string;
redirectSignOut: string;
responseType: string;
options?: object;
urlOpener?: (url: string, redirectUrl: string) => Promise<any>;
}
export function isCognitoHostedOpts(
oauth: OAuthOpts
): oauth is AwsCognitoOAuthOpts {
return (<AwsCognitoOAuthOpts>oauth).redirectSignIn !== undefined;
}
export interface Auth0OAuthOpts {
domain: string;
clientID: string;
scope: string;
redirectUri: string;
audience: string;
responseType: string;
returnTo: string;
urlOpener?: (url: string, redirectUrl: string) => Promise<any>;
}
// Replacing to fix typings
// export interface OAuth {
// awsCognito?: awsCognitoOAuthOpts,
// auth0?: any
// }
export type OAuthOpts = AwsCognitoOAuthOpts | Auth0OAuthOpts;
export interface ConfirmSignUpOptions {
forceAliasCreation?: boolean;
clientMetadata?: ClientMetaData;
}
export interface SignOutOpts {
global?: boolean;
}
export interface CurrentUserOpts {
bypassCache: boolean;
}
export interface GetPreferredMFAOpts {
bypassCache: boolean;
}
export type UsernamePasswordOpts = {
username: string;
password: string;
validationData?: { [key: string]: any };
};
export enum AuthErrorTypes {
NoConfig = 'noConfig',
MissingAuthConfig = 'missingAuthConfig',
EmptyUsername = 'emptyUsername',
InvalidUsername = 'invalidUsername',
EmptyPassword = 'emptyPassword',
EmptyCode = 'emptyCode',
SignUpError = 'signUpError',
NoMFA = 'noMFA',
InvalidMFA = 'invalidMFA',
EmptyChallengeResponse = 'emptyChallengeResponse',
NoUserSession = 'noUserSession',
Default = 'default',
}
export type AuthErrorMessages = { [key in AuthErrorTypes]: AuthErrorMessage };
export interface AuthErrorMessage {
message: string;
log?: string;
}
// We can extend this in the future if needed
export type SignInOpts = UsernamePasswordOpts;
export type ClientMetaData =
| {
[key: string]: string;
}
| undefined;
export function isUsernamePasswordOpts(obj: any): obj is UsernamePasswordOpts {
return !!(obj as UsernamePasswordOpts).username;
}