@aws-amplify/ui 3.0.7 → 3.0.11

package/dist/index.d.ts

@@ -16,6 +16,34 @@ declare type SignInResult = string;
 declare type Validator = (formData: AuthFormData, touchData?: AuthFormData) => ValidatorResult | Promise<ValidatorResult>;
 declare type SignInTypes = (user: string, code: string, mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA) => SignInResult | Promise<SignInResult>;
 
+declare const defaultServices: {
+    getAmplifyConfig(): Promise<{}>;
+    getCurrentUser(): Promise<any>;
+    handleSignUp(formData: any): Promise<any>;
+    handleSignIn({ username, password, }: {
+        username: string;
+        password: string;
+    }): Promise<any>;
+    handleConfirmSignIn({ user, code, mfaType, }: {
+        user: any;
+        code: string;
+        mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+    }): Promise<any>;
+    handleConfirmSignUp({ username, code, }: {
+        username: string;
+        code: string;
+    }): Promise<any>;
+    handleForgotPasswordSubmit({ username, code, password, }: {
+        username: string;
+        code: string;
+        password: string;
+    }): Promise<SignInResult>;
+    handleForgotPassword(formData: any): Promise<any>;
+    validateCustomSignUp(formData: any, touchData: any): Promise<ValidatorResult>;
+    validateConfirmPassword<Validator>(formData: any, touchData: any): Promise<ValidatorResult>;
+    validatePreferredUsername(formData: any, touchData: any): Promise<ValidatorResult>;
+};
+
 declare type AuthFormData = Record<string, string>;
 interface AuthContext {
     actorRef?: any;
@@ -23,7 +51,9 @@ interface AuthContext {
         loginMechanisms?: LoginMechanism[];
         signUpAttributes?: SignUpAttribute[];
         socialProviders?: SocialProvider[];
+        initialState?: 'signIn' | 'signUp' | 'resetPassword';
     };
+    services?: Partial<typeof defaultServices>;
     user?: CognitoUserAmplify;
     username?: string;
     password?: string;
@@ -40,6 +70,7 @@ interface ServicesContext {
 interface BaseFormContext {
     authAttributes?: Record<string, any>;
     challengeName?: string;
+    requiredAttributes?: Array<string>;
     formValues?: AuthFormData;
     touched?: AuthFormData;
     intent?: string;
@@ -87,7 +118,7 @@ interface CognitoUserAmplify extends CognitoUser {
     username?: 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' | InvokeActorEventTypes;
+declare type AuthEventTypes = 'CHANGE' | 'BLUR' | 'FEDERATED_SIGN_IN' | 'RESEND' | 'RESET_PASSWORD' | 'SIGN_IN' | 'SIGN_OUT' | 'SIGN_UP' | 'SKIP' | 'SUBMIT' | 'INIT' | InvokeActorEventTypes;
 declare enum AuthChallengeNames {
     SMS_MFA = "SMS_MFA",
     SOFTWARE_TOKEN_MFA = "SOFTWARE_TOKEN_MFA",
@@ -113,6 +144,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];
 
@@ -209,6 +241,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;
@@ -309,39 +350,10 @@ declare function translate<T = Phrase>(phrase: NoInfer<T>): string;
 declare function hasTranslation(phrase: string): boolean;
 declare const translations: Record<string, Dict>;
 
-declare const defaultServices: {
-    getAmplifyConfig(): Promise<{}>;
-    getCurrentUser(): Promise<any>;
-    handleSignUp(formData: any): Promise<any>;
-    handleSignIn({ username, password, }: {
-        username: string;
-        password: string;
-    }): Promise<any>;
-    handleConfirmSignIn({ user, code, mfaType, }: {
-        user: any;
-        code: string;
-        mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
-    }): Promise<any>;
-    handleConfirmSignUp({ username, code, }: {
-        username: string;
-        code: string;
-    }): Promise<any>;
-    handleForgotPasswordSubmit({ username, code, password, }: {
-        username: string;
-        code: string;
-        password: string;
-    }): Promise<SignInResult>;
-    handleForgotPassword(formData: any): Promise<any>;
-    validateCustomSignUp(formData: any, touchData: any): Promise<ValidatorResult>;
-    validateConfirmPassword<Validator>(formData: any, touchData: any): Promise<ValidatorResult>;
-    validatePreferredUsername(formData: any, touchData: any): Promise<ValidatorResult>;
-};
-
 declare type AuthenticatorMachineOptions = AuthContext['config'] & {
-    initialState?: 'signIn' | 'signUp' | 'resetPassword';
-    services?: Partial<typeof defaultServices>;
+    services?: AuthContext['services'];
 };
-declare function createAuthenticatorMachine({ initialState, loginMechanisms, signUpAttributes, socialProviders, services: customServices, }: AuthenticatorMachineOptions): xstate.StateMachine<AuthContext, any, AuthEvent, {
+declare function createAuthenticatorMachine(): xstate.StateMachine<AuthContext, any, AuthEvent, {
     value: any;
     context: AuthContext;
 }, xstate.ActionObject<AuthContext, AuthEvent>>;
@@ -829,4 +841,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, 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 };