@aws-amplify/ui 3.2.1 → 3.3.0

package/dist/index.d.ts

@@ -51,6 +51,11 @@ interface FormFieldOptions {
     /** Integer that denotes where this field should be positioned in. */
     order?: number;
 }
+declare type PasswordPolicyRules = 'REQUIRES_LOWERCASE' | 'REQUIRES_NUMBERS' | 'REQUIRES_SYMBOLS' | 'REQUIRES_UPPERCASE';
+interface PasswordSettings {
+    passwordPolicyMinLength: number;
+    passwordPolicyCharacters: Array<PasswordPolicyRules>;
+}
 
 /** Enum of known challenge names */
 declare enum AuthChallengeNames {
@@ -84,7 +89,7 @@ interface CognitoUserAmplify extends CognitoUser {
 /**
  * Maps each input to its validation error, if any
  */
-declare type ValidationError = Record<string, string>;
+declare type ValidationError = Record<string, string | string[]>;
 /**
  * Return type of validator. This is `null` if there are no error, and `ValidationError` otherwise.
  */
@@ -93,7 +98,7 @@ declare type SignInResult = string;
 /**
  * Validates the given formData. This can be synchronous or asynchronous.
  */
-declare type Validator = (formData: AuthFormData, touchData?: AuthFormData) => ValidatorResult | Promise<ValidatorResult>;
+declare type Validator = (formData: AuthFormData, touchData?: AuthFormData, passwordSettings?: PasswordSettings) => ValidatorResult | Promise<ValidatorResult>;
 declare type SignInTypes = (user: string, code: string, mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA) => SignInResult | Promise<SignInResult>;
 
 /** Array of auth fields that we supply defaults with */
@@ -150,7 +155,8 @@ declare const defaultServices: {
     }): Promise<SignInResult>;
     handleForgotPassword(formData: any): Promise<any>;
     validateCustomSignUp(formData: any, touchData: any): Promise<ValidatorResult>;
-    validateConfirmPassword<Validator>(formData: any, touchData: any): Promise<ValidatorResult>;
+    validateFormPassword<Validator>(formData: any, touchData: any, passwordSettings: PasswordSettings): Promise<ValidatorResult>;
+    validateConfirmPassword<Validator_1>(formData: any, touchData: any): Promise<ValidatorResult>;
     validatePreferredUsername(formData: any, touchData: any): Promise<ValidatorResult>;
 };
 
@@ -177,6 +183,7 @@ interface AuthContext {
         socialProviders?: SocialProvider[];
         formFields?: FormFields;
         initialState?: 'signIn' | 'signUp' | 'resetPassword';
+        passwordSettings?: PasswordSettings;
     };
     services?: Partial<typeof defaultServices>;
     user?: CognitoUserAmplify;
@@ -208,6 +215,8 @@ interface BaseFormContext {
     user?: CognitoUserAmplify;
     /** Maps each input to its validation error, if any */
     validationError?: ValidationError;
+    /** Maps each password validation rule */
+    passwordSettings?: PasswordSettings;
     /** Denotes where a confirmation code has been sent to */
     codeDeliveryDetails?: CodeDeliveryDetails;
     /** Default country code for all phone number fields. */
@@ -351,7 +360,7 @@ declare const getServiceContextFacade: (state: AuthMachineState) => {
     route: string;
     user: CognitoUserAmplify;
     validationErrors: {
-        [x: string]: string;
+        [x: string]: string | string[];
     };
     codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
 };
@@ -365,7 +374,7 @@ declare const getServiceFacade: ({ send, state }: {
     route: string;
     user: CognitoUserAmplify;
     validationErrors: {
-        [x: string]: string;
+        [x: string]: string | string[];
     };
     codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
     resendCode: (data?: AuthEventData) => void;
@@ -994,4 +1003,4 @@ declare function createTheme(theme?: Theme, baseTheme?: BaseTheme): WebTheme;
 
 declare const defaultTheme: WebTheme;
 
-export { ActorContextWithForms, ActorDoneData, AuthActorContext, AuthActorState, AuthChallengeNames, AuthContext, AuthEvent, AuthEventData, AuthEventTypes, AuthFieldsWithDefaults, AuthFormData, AuthInputAttributes, AuthInterpreter, AuthMachineSend, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, CognitoAttributes, CognitoUserAmplify, ColorModeOverride, ColorValue, CommonFields, ContactMethod, DefaultTexts, DesignToken, Dict, FederatedIdentityProviders, FontSizeValue, FontValue, FontWeightValue, FormField, FormFieldComponents, FormFieldOptions, FormFields, InputAttributeDefaults, InvokeActorEventTypes, LineHeightValue, LoginMechanism, LoginMechanismArray, MediaQueryOverride, NoInfer, OpacityValue, OutlineOffsetValue, OutlineWidthValue, Override, Phrase, RadiusValue, ResetPasswordContext, ResetPasswordState, SelectorOverride, 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, getFormDataFromEvent, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, listenToAuthHub, setFormOrder, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };
+export { ActorContextWithForms, ActorDoneData, AuthActorContext, AuthActorState, AuthChallengeNames, AuthContext, AuthEvent, AuthEventData, AuthEventTypes, AuthFieldsWithDefaults, AuthFormData, AuthInputAttributes, AuthInterpreter, AuthMachineSend, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, CognitoAttributes, CognitoUserAmplify, ColorModeOverride, ColorValue, CommonFields, ContactMethod, DefaultTexts, DesignToken, Dict, FederatedIdentityProviders, FontSizeValue, FontValue, FontWeightValue, FormField, FormFieldComponents, FormFieldOptions, FormFields, InputAttributeDefaults, InvokeActorEventTypes, LineHeightValue, LoginMechanism, LoginMechanismArray, MediaQueryOverride, NoInfer, OpacityValue, OutlineOffsetValue, OutlineWidthValue, Override, PasswordPolicyRules, PasswordSettings, Phrase, RadiusValue, ResetPasswordContext, ResetPasswordState, SelectorOverride, 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, getFormDataFromEvent, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, listenToAuthHub, setFormOrder, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };