@aws-amplify/ui 3.0.2 → 3.0.6

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import * as amazon_cognito_identity_js from 'amazon-cognito-identity-js';
+import { CognitoUser, CodeDeliveryDetails } from 'amazon-cognito-identity-js';
 import * as xstate from 'xstate';
 import { State, Interpreter, Sender } from 'xstate';
-import { CognitoUser } from 'amazon-cognito-identity-js';
 import { PartialDeep } from 'type-fest';
 
 declare type ValidationError = Record<string, string>;
@@ -8,10 +9,12 @@ declare type ValidationError = Record<string, string>;
  * Return type of validator. This is `null` if there are no error, and `ValidationError` otherwise.
  */
 declare type ValidatorResult = void | null | ValidationError;
+declare type SignInResult = string;
 /**
  * Validates the given formData. This can be synchronous or asynchronous.
  */
-declare type Validator = (formData: AuthFormData) => ValidatorResult | Promise<ValidatorResult>;
+declare type Validator = (formData: AuthFormData, touchData?: AuthFormData) => ValidatorResult | Promise<ValidatorResult>;
+declare type SignInTypes = (user: string, code: string, mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA) => SignInResult | Promise<SignInResult>;
 
 declare type AuthFormData = Record<string, string>;
 interface AuthContext {
@@ -22,20 +25,33 @@ interface AuthContext {
         socialProviders?: SocialProvider[];
     };
     user?: CognitoUserAmplify;
+    username?: string;
+    password?: string;
+    code?: string;
+    mfaType?: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+}
+interface ServicesContext {
+    username?: string;
+    password?: string;
+    user?: string;
+    code?: string;
+    mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
 }
 interface BaseFormContext {
     authAttributes?: Record<string, any>;
     challengeName?: string;
     formValues?: AuthFormData;
+    touched?: AuthFormData;
     intent?: string;
     remoteError?: string;
     user?: CognitoUserAmplify;
     validationError?: ValidationError;
+    codeDeliveryDetails?: CodeDeliveryDetails;
     country_code?: string;
 }
 interface SignInContext extends BaseFormContext {
-    loginMechanisms: AuthContext['config']['loginMechanisms'];
-    socialProviders: AuthContext['config']['socialProviders'];
+    loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
+    socialProviders: Required<AuthContext>['config']['socialProviders'];
     attributeToVerify?: string;
     redirectIntent?: string;
     unverifiedAttributes?: Record<string, string>;
@@ -46,8 +62,8 @@ declare type SignUpFieldsWithDefaults = typeof signUpFieldsWithDefault[number];
 declare type SignUpFieldsWithoutDefaults = typeof signUpFieldsWithoutDefault[number];
 declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDefaults;
 interface SignUpContext extends BaseFormContext {
-    loginMechanisms: AuthContext['config']['loginMechanisms'];
-    socialProviders: AuthContext['config']['socialProviders'];
+    loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
+    socialProviders: Required<AuthContext>['config']['socialProviders'];
     unverifiedAttributes?: Record<string, string>;
 }
 interface ResetPasswordContext extends BaseFormContext {
@@ -71,7 +87,7 @@ interface CognitoUserAmplify extends CognitoUser {
     username?: string;
 }
 declare type InvokeActorEventTypes = 'done.invoke.signInActor' | 'done.invoke.signUpActor' | 'done.invoke.signOutActor' | 'done.invoke.resetPasswordActor';
-declare type AuthEventTypes = 'CHANGE' | 'FEDERATED_SIGN_IN' | 'RESEND' | 'RESET_PASSWORD' | 'SIGN_IN' | 'SIGN_OUT' | 'SIGN_UP' | 'SKIP' | 'SUBMIT' | InvokeActorEventTypes;
+declare type AuthEventTypes = 'CHANGE' | 'BLUR' | 'FEDERATED_SIGN_IN' | 'RESEND' | 'RESET_PASSWORD' | 'SIGN_IN' | 'SIGN_OUT' | 'SIGN_UP' | 'SKIP' | 'SUBMIT' | InvokeActorEventTypes;
 declare enum AuthChallengeNames {
     SMS_MFA = "SMS_MFA",
     SOFTWARE_TOKEN_MFA = "SOFTWARE_TOKEN_MFA",
@@ -151,6 +167,7 @@ declare const getSendEventAliases: (send: Sender<AuthEvent>) => {
     readonly signOut: (data?: AuthEventData) => void;
     readonly submitForm: (data?: AuthEventData) => void;
     readonly updateForm: (data?: AuthEventData) => void;
+    readonly updateBlur: (data?: AuthEventData) => void;
     readonly toFederatedSignIn: (data?: AuthEventData) => void;
     readonly toResetPassword: (data?: AuthEventData) => void;
     readonly toSignIn: (data?: AuthEventData) => void;
@@ -166,6 +183,7 @@ declare const getServiceContextFacade: (state: AuthMachineState) => {
     validationErrors: {
         [x: string]: string;
     };
+    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
 };
 declare const getServiceFacade: ({ send, state }: {
     send: any;
@@ -179,10 +197,12 @@ declare const getServiceFacade: ({ send, state }: {
     validationErrors: {
         [x: string]: string;
     };
+    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
     resendCode: (data?: AuthEventData) => void;
     signOut: (data?: AuthEventData) => void;
     submitForm: (data?: AuthEventData) => void;
     updateForm: (data?: AuthEventData) => void;
+    updateBlur: (data?: AuthEventData) => void;
     toFederatedSignIn: (data?: AuthEventData) => void;
     toResetPassword: (data?: AuthEventData) => void;
     toSignIn: (data?: AuthEventData) => void;
@@ -287,9 +307,29 @@ declare const translations: Record<string, Dict>;
 declare const defaultServices: {
     getAmplifyConfig(): Promise<{}>;
     getCurrentUser(): Promise<any>;
-    validateCustomSignUp(formData: any): Promise<ValidatorResult>;
-    validateConfirmPassword<Validator>(formData: any): Promise<ValidatorResult>;
-    validatePreferredUsername(formData: any): Promise<ValidatorResult>;
+    handleSignUp(formData: any): Promise<any>;
+    handleSignIn({ username, password, }: {
+        username: string;
+        password: string;
+    }): Promise<any>;
+    handleConfirmSignIn({ user, code, mfaType, }: {
+        user: any;
+        code: string;
+        mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+    }): Promise<any>;
+    handleConfirmSignUp({ username, code, }: {
+        username: string;
+        code: string;
+    }): Promise<any>;
+    handleForgotPasswordSubmit({ username, code, password, }: {
+        username: string;
+        code: string;
+        password: string;
+    }): Promise<SignInResult>;
+    handleForgotPassword(formData: any): Promise<any>;
+    validateCustomSignUp(formData: any, touchData: any): Promise<ValidatorResult>;
+    validateConfirmPassword<Validator>(formData: any, touchData: any): Promise<ValidatorResult>;
+    validatePreferredUsername(formData: any, touchData: any): Promise<ValidatorResult>;
 };
 
 declare type AuthenticatorMachineOptions = AuthContext['config'] & {
@@ -785,4 +825,4 @@ declare function createTheme(theme?: Theme, baseTheme?: BaseTheme): WebTheme;
 
 declare const defaultTheme: WebTheme;
 
-export { ActorContextWithForms, AuthActorContext, AuthActorState, AuthChallengeNames, AuthContext, AuthEvent, AuthEventData, AuthEventTypes, AuthFieldsWithDefaults, AuthFormData, AuthInputAttributes, AuthInterpreter, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, CognitoUserAmplify, ColorModeOverride, ColorValue, ContactMethod, DefaultTexts, DesignToken, Dict, FederatedIdentityProviders, FontSizeValue, FontValue, FontWeightValue, InputAttributes, InvokeActorEventTypes, LineHeightValue, LoginMechanism, LoginMechanismArray, MediaQueryOverride, NoInfer, OpacityValue, OutlineOffsetValue, OutlineWidthValue, Override, Phrase, RadiusValue, ResetPasswordContext, ResetPasswordState, SelectorOverride, ShadowValue, SignInContext, SignInState, SignOutContext, SignOutState, SignUpAttribute, SignUpContext, SignUpFieldsWithDefaults, SignUpFieldsWithoutDefaults, SignUpState, SocialProvider, SpaceValue, Theme, TimeValue, TransformValue, ValidationError, Validator, ValidatorResult, WebDesignToken, WebTheme, authInputAttributes, censorAllButFirstAndLast, censorPhoneNumber, countryDialCodes, createAuthenticatorMachine, createTheme, defaultTheme, getActorContext, getActorState, getAliasInfoFromContext, getConfiguredAliases, getSendEventAliases, getServiceContextFacade, getServiceFacade, isDesignToken, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };
+export { ActorContextWithForms, AuthActorContext, AuthActorState, AuthChallengeNames, AuthContext, AuthEvent, AuthEventData, AuthEventTypes, AuthFieldsWithDefaults, AuthFormData, AuthInputAttributes, AuthInterpreter, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, CognitoUserAmplify, ColorModeOverride, ColorValue, ContactMethod, DefaultTexts, DesignToken, Dict, FederatedIdentityProviders, FontSizeValue, FontValue, FontWeightValue, InputAttributes, InvokeActorEventTypes, LineHeightValue, LoginMechanism, LoginMechanismArray, MediaQueryOverride, NoInfer, OpacityValue, OutlineOffsetValue, OutlineWidthValue, Override, Phrase, RadiusValue, ResetPasswordContext, ResetPasswordState, SelectorOverride, ServicesContext, ShadowValue, SignInContext, SignInResult, SignInState, SignInTypes, SignOutContext, SignOutState, SignUpAttribute, SignUpContext, SignUpFieldsWithDefaults, SignUpFieldsWithoutDefaults, SignUpState, SocialProvider, SpaceValue, Theme, TimeValue, TransformValue, ValidationError, Validator, ValidatorResult, WebDesignToken, WebTheme, authInputAttributes, censorAllButFirstAndLast, censorPhoneNumber, countryDialCodes, createAuthenticatorMachine, createTheme, defaultTheme, getActorContext, getActorState, getAliasInfoFromContext, getConfiguredAliases, getSendEventAliases, getServiceContextFacade, getServiceFacade, isDesignToken, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };