@aws-amplify/ui 3.3.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
  */
@@ -15,14 +37,14 @@ declare type FormFieldComponents = 'signIn' | 'signUp' | 'forceNewPassword' | 'c
 /**
  * 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]: FormFieldOptions;
+interface FormFields {
+    [field_name: string]: FormFieldOptions;
 }
 /**
  * Override options for each field
@@ -50,7 +72,15 @@ interface FormFieldOptions {
     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;
@@ -101,36 +131,6 @@ declare type SignInResult = string;
 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>;
@@ -181,7 +181,7 @@ interface AuthContext {
         loginMechanisms?: LoginMechanism[];
         signUpAttributes?: SignUpAttribute[];
         socialProviders?: SocialProvider[];
-        formFields?: FormFields;
+        formFields?: AuthFormFields;
         initialState?: 'signIn' | 'signUp' | 'resetPassword';
         passwordSettings?: PasswordSettings;
     };
@@ -225,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>;
@@ -233,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
@@ -311,16 +311,7 @@ declare const getActorState: (state: AuthMachineState) => AuthActorState;
  */
 declare const getActorContext: (state: AuthMachineState) => AuthActorContext;
 
-/**
- * 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.
- */
-declare const getAliasInfoFromContext: (context: AuthContext, alias?: LoginMechanism) => {
-    label: string;
-    type: string;
-    error: any;
-};
+declare const getPrimaryAlias: (state: AuthMachineState) => "email" | "phone_number" | "username";
 /**
  * Given xstate context from AuthMachine, returns the primaryAlias and
  * secondaryAliases.
@@ -393,11 +384,14 @@ declare const getServiceFacade: ({ send, state }: {
  * This file contains helpers related to forms and input attributes.
  */
 
-declare const authInputAttributes: AuthInputAttributes;
+declare const defaultFormFieldOptions: DefaultFormFieldOptions;
+
 declare const getFormDataFromEvent: (event: Event) => {
     [k: string]: FormDataEntryValue;
 };
-declare const setFormOrder: (formOverrides: FormField, fieldNames: Array<SignUpAttribute | CommonFields>) => Array<string | number>;
+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
@@ -416,6 +410,28 @@ declare const censorPhoneNumber: (val: string) => string;
  */
 declare const listenToAuthHub: (send: AuthMachineSend) => () => void;
 
+/**
+ * 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[];
 
 /**
@@ -1003,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, 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 };
+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 };