@aws-amplify/ui 3.0.9 → 3.0.13

package/dist/index.d.ts

@@ -70,6 +70,7 @@ interface ServicesContext {
 interface BaseFormContext {
     authAttributes?: Record<string, any>;
     challengeName?: string;
+    requiredAttributes?: Array<string>;
     formValues?: AuthFormData;
     touched?: AuthFormData;
     intent?: string;
@@ -115,6 +116,12 @@ declare type AuthActorContext = ActorContextWithForms | SignOutContext;
 declare type AuthActorState = State<AuthActorContext, AuthEvent>;
 interface CognitoUserAmplify extends CognitoUser {
     username?: string;
+    attributes?: CognitoAttributes;
+}
+interface CognitoAttributes {
+    email: string;
+    phone_number: string;
+    [key: string]: string;
 }
 declare type InvokeActorEventTypes = 'done.invoke.signInActor' | 'done.invoke.signUpActor' | 'done.invoke.signOutActor' | 'done.invoke.resetPasswordActor';
 declare type AuthEventTypes = 'CHANGE' | 'BLUR' | 'FEDERATED_SIGN_IN' | 'RESEND' | 'RESET_PASSWORD' | 'SIGN_IN' | 'SIGN_OUT' | 'SIGN_UP' | 'SKIP' | 'SUBMIT' | 'INIT' | InvokeActorEventTypes;
@@ -143,6 +150,7 @@ interface AuthEvent {
 }
 declare type AuthMachineState = State<AuthContext, AuthEvent>;
 declare type AuthInterpreter = Interpreter<AuthContext, any, AuthEvent>;
+declare type AuthMachineSend = AuthInterpreter['send'];
 
 declare type NoInfer<T> = [T][T extends any ? 0 : never];
 
@@ -239,6 +247,15 @@ declare const getServiceFacade: ({ send, state }: {
     toSignUp: (data?: AuthEventData) => void;
     skipVerification: (data?: AuthEventData) => void;
 };
+/**
+ * Listens to external auth Hub events and sends corresponding event to
+ * the `authService` of interest
+ *
+ * @param send - `send` function associated with the `authService` of interest
+ *
+ * @returns function that unsubscribes to the hub evenmt
+ */
+declare const listenToAuthHub: (send: AuthMachineSend) => () => void;
 
 declare type ContactMethod = 'Email' | 'Phone Number';
 declare const censorAllButFirstAndLast: (value: string) => string;
@@ -830,4 +847,4 @@ declare function createTheme(theme?: Theme, baseTheme?: BaseTheme): WebTheme;
 
 declare const defaultTheme: WebTheme;
 
-export { ActorContextWithForms, AuthActorContext, AuthActorState, AuthChallengeNames, AuthContext, AuthEvent, AuthEventData, AuthEventTypes, AuthFieldsWithDefaults, AuthFormData, AuthInputAttributes, AuthInterpreter, AuthMachineState, AuthenticatorMachineOptions, BaseTheme, BorderWidthValue, 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, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };
+export { ActorContextWithForms, 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, getSendEventAliases, getServiceContextFacade, getServiceFacade, hasTranslation, isDesignToken, listenToAuthHub, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };