@aws-amplify/ui 3.0.15 → 3.1.0

package/dist/index.d.ts

@@ -56,6 +56,7 @@ interface AuthContext {
         loginMechanisms?: LoginMechanism[];
         signUpAttributes?: SignUpAttribute[];
         socialProviders?: SocialProvider[];
+        formFields?: FormFields;
         initialState?: 'signIn' | 'signUp' | 'resetPassword';
     };
     services?: Partial<typeof defaultServices>;
@@ -89,6 +90,7 @@ interface BaseFormContext {
 interface SignInContext extends BaseFormContext {
     loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
     socialProviders: Required<AuthContext>['config']['socialProviders'];
+    formFields?: FormFields;
     attributeToVerify?: string;
     redirectIntent?: string;
     unverifiedAttributes?: Record<string, string>;
@@ -101,17 +103,20 @@ declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDef
 interface SignUpContext extends BaseFormContext {
     loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
     socialProviders: Required<AuthContext>['config']['socialProviders'];
+    formFields: FormFields;
     unverifiedAttributes?: Record<string, string>;
 }
 interface ResetPasswordContext extends BaseFormContext {
     username?: string;
     unverifiedAttributes?: Record<string, string>;
+    formFields?: FormFields;
 }
 interface SignOutContext {
     authAttributes?: Record<string, any>;
     challengeName?: string;
     unverifiedAttributes?: Record<string, string>;
     user?: CognitoUserAmplify;
+    formFields?: FormFields;
 }
 declare type ActorContextWithForms = SignInContext | SignUpContext | ResetPasswordContext;
 declare type SignInState = State<SignInContext, AuthEvent>;
@@ -145,8 +150,31 @@ interface InputAttributes {
     autocomplete?: string;
 }
 declare const LoginMechanismArray: readonly ["username", "email", "phone_number"];
+declare type CommonFields = 'username' | 'password' | 'confirm_password';
 declare type LoginMechanism = typeof LoginMechanismArray[number];
 declare type SocialProvider = 'amazon' | 'apple' | 'facebook' | 'google';
+declare type formFieldComponents = 'signIn' | 'signUp' | 'forceNewPassword' | 'confirmResetPassword' | 'confirmSignIn' | 'confirmSignUp' | 'confirmVerifyUser' | 'resetPassword' | 'setupTOTP';
+declare type FormFields = {
+    [key in formFieldComponents]?: formField;
+};
+interface formField {
+    [key: string]: formFieldTypes;
+}
+interface formFieldTypes {
+    labelHidden?: boolean;
+    label?: string;
+    placeholder?: string;
+    /**
+     * @deprecated Internal use only, please use `isRequired` instead.
+     */
+    required?: boolean;
+    isRequired?: boolean;
+    dialCode?: string;
+    totpIssuer?: string;
+    totpUsername?: string;
+    dialCodeList?: Array<string>;
+    order?: number;
+}
 declare type AuthFieldsWithDefaults = LoginMechanism | SignUpFieldsWithDefaults | 'confirmation_code' | 'password';
 declare type AuthInputAttributes = Record<AuthFieldsWithDefaults, InputAttributes>;
 declare type AuthEventData = Record<PropertyKey, any>;
@@ -269,6 +297,7 @@ 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>;
 
 declare const countryDialCodes: string[];
 
@@ -862,4 +891,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, 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, getFormDataFromEvent, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, listenToAuthHub, 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, FormFields, 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, formField, formFieldComponents, formFieldTypes, getActorContext, getActorState, getAliasInfoFromContext, getConfiguredAliases, getFormDataFromEvent, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, listenToAuthHub, setFormOrder, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };