@aws-amplify/ui 3.2.0 → 3.2.1

package/dist/index.d.ts

@@ -11,23 +11,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;
+    [key in FormFieldComponents]?: FormField;
 };
 /**
  * Override option for each screen. Maps each input to override options.
  */
-interface formField {
-    [key: string]: formFieldTypes;
+interface FormField {
+    [key: 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 */
@@ -60,6 +60,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;
@@ -277,13 +286,22 @@ 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"
-}
+/**
+ * This file contains helpers that lets you easily access current actor's state
+ * and context.
+ */
+
+/**
+ * Get the state of current actor. This is useful for checking which screen
+ * to render: e.g. `getActorState(state).matches('confirmSignUp.edit').
+ */
+declare const getActorState: (state: AuthMachineState) => AuthActorState;
+/**
+ * Get the context of current actor. Useful for getting any nested context
+ * like remoteError.
+ */
+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"
@@ -302,16 +320,7 @@ 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').
- */
-declare const getActorState: (state: AuthMachineState) => AuthActorState;
-/**
- * Get the context of current actor. Useful for getting any nested context
- * like remoteError.
- */
-declare const getActorContext: (state: AuthMachineState) => AuthActorContext;
+
 /**
  * Creates public facing auth helpers that abstracts out xstate implementation
  * detail. Each framework implementation can export these helpers so that
@@ -370,6 +379,24 @@ 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 authInputAttributes: AuthInputAttributes;
+declare const getFormDataFromEvent: (event: Event) => {
+    [k: string]: FormDataEntryValue;
+};
+declare const setFormOrder: (formOverrides: FormField, fieldNames: Array<SignUpAttribute | CommonFields>) => Array<string | number>;
+
+/**
+ * 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,14 +407,6 @@ 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>;
-
 declare const countryDialCodes: string[];
 
 /**
@@ -975,4 +994,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, 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 };