@aws-amplify/ui 3.2.0 → 3.3.1

package/dist/index.d.ts

@@ -4,6 +4,28 @@ import * as xstate from 'xstate';
 import { Interpreter, State, Sender } from 'xstate';
 import { PartialDeep } from 'type-fest';
 
+/** Array of auth fields that we supply defaults with */
+declare const signUpFieldsWithDefault: readonly ["birthdate", "email", "family_name", "given_name", "middle_name", "name", "nickname", "phone_number", "preferred_username", "profile", "website"];
+/** Auth fields that we supply defaults with */
+declare type SignUpFieldsWithDefaults = typeof signUpFieldsWithDefault[number];
+/** Array of auth fields that we do not supply defaults with */
+declare const signUpFieldsWithoutDefault: readonly ["address", "gender", "locale", "picture", "updated_at", "zoneinfo"];
+/** Auth fields that we do not supply defaults with */
+declare type SignUpFieldsWithoutDefaults = typeof signUpFieldsWithoutDefault[number];
+/** All known auth fields */
+declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDefaults;
+/** Fields that are common in all routes */
+declare type CommonFields = 'username' | 'password' | 'confirm_password';
+/** Array of known login mechanisms */
+declare const LoginMechanismArray: readonly ["username", "email", "phone_number"];
+/** Login mechanisms that can be used to sign in */
+declare type LoginMechanism = typeof LoginMechanismArray[number];
+/** List of social provider Authenticator supports */
+declare type SocialProvider = 'amazon' | 'apple' | 'facebook' | 'google';
+declare const authFieldsWithDefaults: readonly ["username", "email", "phone_number", "birthdate", "email", "family_name", "given_name", "middle_name", "name", "nickname", "phone_number", "preferred_username", "profile", "website", "confirmation_code", "password", "confirm_password"];
+/** Input fields that we provide default fields with */
+declare type AuthFieldsWithDefaults = typeof authFieldsWithDefaults[number];
+
 /**
  * Map of each input name to its value
  */
@@ -11,23 +33,23 @@ declare type AuthFormData = Record<string, string>;
 /**
  * List of routes that support custom formFields
  */
-declare type formFieldComponents = 'signIn' | 'signUp' | 'forceNewPassword' | 'confirmResetPassword' | 'confirmSignIn' | 'confirmSignUp' | 'confirmVerifyUser' | 'resetPassword' | 'setupTOTP';
+declare type FormFieldComponents = 'signIn' | 'signUp' | 'forceNewPassword' | 'confirmResetPassword' | 'confirmSignIn' | 'confirmSignUp' | 'confirmVerifyUser' | 'resetPassword' | 'setupTOTP';
 /**
  * Used to customize form field attributes for each authenticator screen.
  */
-declare type FormFields = {
-    [key in formFieldComponents]?: formField;
+declare type AuthFormFields = {
+    [key in FormFieldComponents]?: FormFields;
 };
 /**
  * Override option for each screen. Maps each input to override options.
  */
-interface formField {
-    [key: string]: formFieldTypes;
+interface FormFields {
+    [field_name: string]: FormFieldOptions;
 }
 /**
  * Override options for each field
  */
-interface formFieldTypes {
+interface FormFieldOptions {
     /** Will hide the label above the input if set to true */
     labelHidden?: boolean;
     /** Label text */
@@ -50,6 +72,19 @@ interface formFieldTypes {
     dialCodeList?: Array<string>;
     /** Integer that denotes where this field should be positioned in. */
     order?: number;
+    /** Desired HTML input type */
+    type?: string;
+    /** Desired autocomplete HTML attribute */
+    autocomplete?: string;
+}
+/** Default formField values for each supported auth field */
+declare type DefaultFormFieldOptions = Record<AuthFieldsWithDefaults, FormFieldOptions>;
+/** Ordered list of formFields */
+declare type FormFieldsArray = Array<[string, FormFieldOptions]>;
+declare type PasswordPolicyRules = 'REQUIRES_LOWERCASE' | 'REQUIRES_NUMBERS' | 'REQUIRES_SYMBOLS' | 'REQUIRES_UPPERCASE';
+interface PasswordSettings {
+    passwordPolicyMinLength: number;
+    passwordPolicyCharacters: Array<PasswordPolicyRules>;
 }
 
 /** Enum of known challenge names */
@@ -60,6 +95,15 @@ declare enum AuthChallengeNames {
     RESET_REQUIRED = "RESET_REQUIRED",
     MFA_SETUP = "MFA_SETUP"
 }
+/** Contact destinations that we can send user confirmation code to */
+declare type ContactMethod = 'Email' | 'Phone Number';
+/** Federated IDPs that Authenticator supports */
+declare enum FederatedIdentityProviders {
+    Apple = "SignInWithApple",
+    Amazon = "LoginWithAmazon",
+    Facebook = "Facebook",
+    Google = "Google"
+}
 /** Known cognito user attributes */
 interface CognitoAttributes {
     email: string;
@@ -75,7 +119,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.
  */
@@ -84,39 +128,9 @@ 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 */
-declare const signUpFieldsWithDefault: readonly ["birthdate", "email", "family_name", "given_name", "middle_name", "name", "nickname", "phone_number", "preferred_username", "profile", "website"];
-/** Auth fields that we supply defaults with */
-declare type SignUpFieldsWithDefaults = typeof signUpFieldsWithDefault[number];
-/** Array of auth fields that we do not supply defaults with */
-declare const signUpFieldsWithoutDefault: readonly ["address", "gender", "locale", "picture", "updated_at", "zoneinfo"];
-/** Auth fields that we do not supply defaults with */
-declare type SignUpFieldsWithoutDefaults = typeof signUpFieldsWithoutDefault[number];
-/** All known auth fields */
-declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDefaults;
-/** Fields that are common in all routes */
-declare type CommonFields = 'username' | 'password' | 'confirm_password';
-/** Array of known login mechanisms */
-declare const LoginMechanismArray: readonly ["username", "email", "phone_number"];
-/** Login mechanisms that can be used to sign in */
-declare type LoginMechanism = typeof LoginMechanismArray[number];
-/** List of social provider Authenticator supports */
-declare type SocialProvider = 'amazon' | 'apple' | 'facebook' | 'google';
-/** Input fields that we provide default fields with */
-declare type AuthFieldsWithDefaults = LoginMechanism | SignUpFieldsWithDefaults | 'confirmation_code' | 'password';
-/** Maps default attributes values for an input */
-interface InputAttributeDefaults {
-    label: string;
-    type: string;
-    placeholder: string;
-    autocomplete?: string;
-}
-/** Maps default attribute values for each Auth Field */
-declare type AuthInputAttributes = Record<AuthFieldsWithDefaults, InputAttributeDefaults>;
-
 declare const defaultServices: {
     getAmplifyConfig(): Promise<{}>;
     getCurrentUser(): Promise<any>;
@@ -141,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>;
 };
 
@@ -166,8 +181,9 @@ interface AuthContext {
         loginMechanisms?: LoginMechanism[];
         signUpAttributes?: SignUpAttribute[];
         socialProviders?: SocialProvider[];
-        formFields?: FormFields;
+        formFields?: AuthFormFields;
         initialState?: 'signIn' | 'signUp' | 'resetPassword';
+        passwordSettings?: PasswordSettings;
     };
     services?: Partial<typeof defaultServices>;
     user?: CognitoUserAmplify;
@@ -199,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. */
@@ -207,7 +225,7 @@ interface BaseFormContext {
 interface SignInContext extends BaseFormContext {
     loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
     socialProviders: Required<AuthContext>['config']['socialProviders'];
-    formFields?: FormFields;
+    formFields?: AuthFormFields;
     attributeToVerify?: string;
     redirectIntent?: string;
     unverifiedAttributes?: Record<string, string>;
@@ -215,20 +233,20 @@ interface SignInContext extends BaseFormContext {
 interface SignUpContext extends BaseFormContext {
     loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
     socialProviders: Required<AuthContext>['config']['socialProviders'];
-    formFields: FormFields;
+    formFields: AuthFormFields;
     unverifiedAttributes?: Record<string, string>;
 }
 interface ResetPasswordContext extends BaseFormContext {
     username?: string;
     unverifiedAttributes?: Record<string, string>;
-    formFields?: FormFields;
+    formFields?: AuthFormFields;
 }
 interface SignOutContext {
     authAttributes?: Record<string, any>;
     challengeName?: string;
     unverifiedAttributes?: Record<string, string>;
     user?: CognitoUserAmplify;
-    formFields?: FormFields;
+    formFields?: AuthFormFields;
 }
 /**
  * Context for actors that have forms
@@ -277,31 +295,11 @@ declare type AuthMachineState = State<AuthContext, AuthEvent>;
 
 declare type NoInfer<T> = [T][T extends any ? 0 : never];
 
-declare const authInputAttributes: AuthInputAttributes;
-declare enum FederatedIdentityProviders {
-    Apple = "SignInWithApple",
-    Amazon = "LoginWithAmazon",
-    Facebook = "Facebook",
-    Google = "Google"
-}
 /**
- * Given xstate context from AuthMachine, this returns the input label, type,
- * and error attributes of the configured login_mechanisms. An optional "alias"
- * may be passed in to get info from context for that specific alias.
+ * This file contains helpers that lets you easily access current actor's state
+ * and context.
  */
-declare const getAliasInfoFromContext: (context: AuthContext, alias?: LoginMechanism) => {
-    label: string;
-    type: string;
-    error: any;
-};
-/**
- * Given xstate context from AuthMachine, returns the primaryAlias and
- * secondaryAliases.
- */
-declare const getConfiguredAliases: (context: AuthContext) => {
-    primaryAlias: "email" | "phone_number" | "username";
-    secondaryAliases: ("email" | "phone_number" | "username")[];
-};
+
 /**
  * Get the state of current actor. This is useful for checking which screen
  * to render: e.g. `getActorState(state).matches('confirmSignUp.edit').
@@ -312,6 +310,17 @@ declare const getActorState: (state: AuthMachineState) => AuthActorState;
  * like remoteError.
  */
 declare const getActorContext: (state: AuthMachineState) => AuthActorContext;
+
+declare const getPrimaryAlias: (state: AuthMachineState) => "email" | "phone_number" | "username";
+/**
+ * Given xstate context from AuthMachine, returns the primaryAlias and
+ * secondaryAliases.
+ */
+declare const getConfiguredAliases: (context: AuthContext) => {
+    primaryAlias: "email" | "phone_number" | "username";
+    secondaryAliases: ("email" | "phone_number" | "username")[];
+};
+
 /**
  * Creates public facing auth helpers that abstracts out xstate implementation
  * detail. Each framework implementation can export these helpers so that
@@ -342,7 +351,7 @@ declare const getServiceContextFacade: (state: AuthMachineState) => {
     route: string;
     user: CognitoUserAmplify;
     validationErrors: {
-        [x: string]: string;
+        [x: string]: string | string[];
     };
     codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
 };
@@ -356,7 +365,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;
@@ -370,6 +379,27 @@ declare const getServiceFacade: ({ send, state }: {
     toSignUp: (data?: AuthEventData) => void;
     skipVerification: (data?: AuthEventData) => void;
 };
+
+/**
+ * This file contains helpers related to forms and input attributes.
+ */
+
+declare const defaultFormFieldOptions: DefaultFormFieldOptions;
+
+declare const getFormDataFromEvent: (event: Event) => {
+    [k: string]: FormDataEntryValue;
+};
+declare const setFormOrder: (formOverrides: FormFields, fieldNames: Array<SignUpAttribute | CommonFields>) => Array<string | number>;
+declare const isAuthFieldWithDefaults: (field: string) => field is "birthdate" | "email" | "family_name" | "given_name" | "middle_name" | "name" | "nickname" | "phone_number" | "preferred_username" | "profile" | "website" | "username" | "password" | "confirm_password" | "confirmation_code";
+declare const getErrors: (errors: string | string[]) => string[];
+
+/**
+ * This file contains general helpers that state machine or authenticator
+ * implementations can use.
+ */
+
+declare const censorAllButFirstAndLast: (value: string) => string;
+declare const censorPhoneNumber: (val: string) => string;
 /**
  * Listens to external auth Hub events and sends corresponding event to
  * the `authService` of interest
@@ -380,13 +410,27 @@ declare const getServiceFacade: ({ send, state }: {
  */
 declare const listenToAuthHub: (send: AuthMachineSend) => () => void;
 
-declare type ContactMethod = 'Email' | 'Phone Number';
-declare const censorAllButFirstAndLast: (value: string) => string;
-declare const censorPhoneNumber: (val: string) => string;
-declare const getFormDataFromEvent: (event: Event) => {
-    [k: string]: FormDataEntryValue;
-};
-declare const setFormOrder: (formOverrides: formField, fieldNames: Array<SignUpAttribute | CommonFields>) => Array<string | number>;
+/**
+ * This file contains helpers that generate default form fields, given the
+ * current Authenticator / Zero Config configuration.
+ */
+
+/** Gets the default formFields for given route/route */
+declare const getDefaultFormFields: (route: FormFieldComponents, state: AuthMachineState) => FormFields;
+/** Gets default formFields, then merges custom formFields into it */
+declare const getFormFields: (route: FormFieldComponents, state: AuthMachineState) => FormFields;
+/** Calls `getFormFields` above, then sorts it into an indexed array */
+declare const getSortedFormFields: (route: FormFieldComponents, state: AuthMachineState) => FormFieldsArray;
+
+/** Collect all the defaultFormFields getters */
+declare const defaultFormFieldsGetters: Record<FormFieldComponents, (state: AuthMachineState) => FormFields>;
+
+/** Applies translations to label and placeholder */
+declare const applyTranslation: (formFields: FormFields) => FormFields;
+/** Sorts formFields according to their `order`.  */
+declare const sortFormFields: (formFields: FormFields) => FormFieldsArray;
+/** Applies defaultFormFields value into customFormFields */
+declare const applyDefaults: (defaultFormFields: FormFields, customFormFields?: FormFields) => FormFields;
 
 declare const countryDialCodes: string[];
 
@@ -975,4 +1019,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, 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, formField, formFieldComponents, formFieldTypes, 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, AuthFormFields, AuthInterpreter, AuthMachineSend, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, CognitoAttributes, CognitoUserAmplify, ColorModeOverride, ColorValue, CommonFields, ContactMethod, DefaultFormFieldOptions, DefaultTexts, DesignToken, Dict, FederatedIdentityProviders, FontSizeValue, FontValue, FontWeightValue, FormFieldComponents, FormFieldOptions, FormFields, FormFieldsArray, 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, applyDefaults, applyTranslation, authFieldsWithDefaults, censorAllButFirstAndLast, censorPhoneNumber, countryDialCodes, createAuthenticatorMachine, createTheme, defaultFormFieldOptions, defaultFormFieldsGetters, defaultTheme, getActorContext, getActorState, getConfiguredAliases, getDefaultFormFields, getErrors, getFormDataFromEvent, getFormFields, getPrimaryAlias, getSendEventAliases, getServiceContextFacade, getServiceFacade, getSortedFormFields, hasTranslation, isAuthFieldWithDefaults, isDesignToken, listenToAuthHub, setFormOrder, signUpFieldsWithDefault, signUpFieldsWithoutDefault, sortFormFields, translate, translations };