UNPKG

2.63 kBTypeScriptView Raw
1import { AuthVerifiableAttributeKey } from '@aws-amplify/core/internals/utils';
2import { AuthCodeDeliveryDetails, AuthMFAType, AuthResetPasswordOutput, AuthSignInOutput, AuthSignUpOutput, AuthTOTPSetupDetails, AuthUpdateUserAttributeOutput, AuthUpdateUserAttributesOutput, AuthUserAttributes } from '../../../types';
3import { AWSAuthDevice, AuthUser, UserAttributeKey } from '../types';
4export interface FetchMFAPreferenceOutput {
5 enabled?: AuthMFAType[];
6 preferred?: AuthMFAType;
7}
8/**
9 * Output type for Cognito fetchUserAttributes API.
10 */
11export type FetchUserAttributesOutput = AuthUserAttributes<UserAttributeKey>;
12/**
13 * Output type for Cognito getCurrentUser API.
14 */
15export type GetCurrentUserOutput = AuthUser;
16/**
17 * Output type for Cognito confirmSignIn API.
18 */
19export type ConfirmSignInOutput = AuthSignInOutput;
20/**
21 * Output type for Cognito confirmSignUp API.
22 */
23export type ConfirmSignUpOutput = AuthSignUpOutput<AuthVerifiableAttributeKey>;
24/**
25 * Output type for Cognito resendSignUpCode API.
26 */
27export type ResendSignUpCodeOutput = AuthCodeDeliveryDetails<AuthVerifiableAttributeKey>;
28/**
29 * Output type for Cognito resetPassword API.
30 */
31export type ResetPasswordOutput = AuthResetPasswordOutput<AuthVerifiableAttributeKey>;
32/**
33 * Output type for Cognito setUpTOTP API.
34 */
35export type SetUpTOTPOutput = AuthTOTPSetupDetails;
36/**
37 * Output type for Cognito signIn API.
38 */
39export type SignInOutput = AuthSignInOutput;
40/**
41 * Output type for Cognito signInWithCustomAuth API.
42 */
43export type SignInWithCustomAuthOutput = AuthSignInOutput;
44/**
45 * Output type for Cognito signInWithSRP API.
46 */
47export type SignInWithSRPOutput = AuthSignInOutput;
48/**
49 * Output type for Cognito signInWithUserPassword API.
50 */
51export type SignInWithUserPasswordOutput = AuthSignInOutput;
52/**
53 * Output type for Cognito signInWithCustomSRPAuth API.
54 */
55export type SignInWithCustomSRPAuthOutput = AuthSignInOutput;
56/**
57 * Output type for Cognito signUp API.
58 */
59export type SignUpOutput = AuthSignUpOutput<AuthVerifiableAttributeKey>;
60/**
61 * Output type for Cognito updateUserAttributes API.
62 */
63export type UpdateUserAttributesOutput = AuthUpdateUserAttributesOutput<UserAttributeKey>;
64/**
65 * Output type for Cognito sendUserAttributeVerificationCode API.
66 */
67export type SendUserAttributeVerificationCodeOutput = AuthCodeDeliveryDetails<AuthVerifiableAttributeKey>;
68/**
69 * Output type for Cognito updateUserAttribute API.
70 */
71export type UpdateUserAttributeOutput = AuthUpdateUserAttributeOutput<UserAttributeKey>;
72/**
73 * Output type for Cognito fetchDevices API.
74 */
75export type FetchDevicesOutput = AWSAuthDevice[];