@aws-amplify/ui 3.0.3 → 3.0.7

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import * as amazon_cognito_identity_js from 'amazon-cognito-identity-js';
+import { CognitoUser, CodeDeliveryDetails } from 'amazon-cognito-identity-js';
 import * as xstate from 'xstate';
 import { State, Interpreter, Sender } from 'xstate';
-import { CognitoUser } from 'amazon-cognito-identity-js';
 import { PartialDeep } from 'type-fest';
 
 declare type ValidationError = Record<string, string>;
@@ -8,10 +9,12 @@ declare type ValidationError = Record<string, string>;
  * Return type of validator. This is `null` if there are no error, and `ValidationError` otherwise.
  */
 declare type ValidatorResult = void | null | ValidationError;
+declare type SignInResult = string;
 /**
  * Validates the given formData. This can be synchronous or asynchronous.
  */
 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 type AuthFormData = Record<string, string>;
 interface AuthContext {
@@ -22,6 +25,17 @@ interface AuthContext {
         socialProviders?: SocialProvider[];
     };
     user?: CognitoUserAmplify;
+    username?: string;
+    password?: string;
+    code?: string;
+    mfaType?: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+}
+interface ServicesContext {
+    username?: string;
+    password?: string;
+    user?: string;
+    code?: string;
+    mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
 }
 interface BaseFormContext {
     authAttributes?: Record<string, any>;
@@ -32,11 +46,12 @@ interface BaseFormContext {
     remoteError?: string;
     user?: CognitoUserAmplify;
     validationError?: ValidationError;
+    codeDeliveryDetails?: CodeDeliveryDetails;
     country_code?: string;
 }
 interface SignInContext extends BaseFormContext {
-    loginMechanisms: AuthContext['config']['loginMechanisms'];
-    socialProviders: AuthContext['config']['socialProviders'];
+    loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
+    socialProviders: Required<AuthContext>['config']['socialProviders'];
     attributeToVerify?: string;
     redirectIntent?: string;
     unverifiedAttributes?: Record<string, string>;
@@ -47,8 +62,8 @@ declare type SignUpFieldsWithDefaults = typeof signUpFieldsWithDefault[number];
 declare type SignUpFieldsWithoutDefaults = typeof signUpFieldsWithoutDefault[number];
 declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDefaults;
 interface SignUpContext extends BaseFormContext {
-    loginMechanisms: AuthContext['config']['loginMechanisms'];
-    socialProviders: AuthContext['config']['socialProviders'];
+    loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
+    socialProviders: Required<AuthContext>['config']['socialProviders'];
     unverifiedAttributes?: Record<string, string>;
 }
 interface ResetPasswordContext extends BaseFormContext {
@@ -168,6 +183,7 @@ declare const getServiceContextFacade: (state: AuthMachineState) => {
     validationErrors: {
         [x: string]: string;
     };
+    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
 };
 declare const getServiceFacade: ({ send, state }: {
     send: any;
@@ -181,6 +197,7 @@ declare const getServiceFacade: ({ send, state }: {
     validationErrors: {
         [x: string]: string;
     };
+    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
     resendCode: (data?: AuthEventData) => void;
     signOut: (data?: AuthEventData) => void;
     submitForm: (data?: AuthEventData) => void;
@@ -232,6 +249,7 @@ declare const DefaultTexts: {
     readonly FAMILY_NAME: string;
     readonly GIVEN_NAME: string;
     readonly FORGOT_YOUR_PASSWORD: string;
+    readonly FORGOT_YOUR_PASSWORD_LEGACY: string;
     readonly HIDE_PASSWORD: string;
     readonly LOADING: string;
     readonly LOGIN_NAME: string;
@@ -285,11 +303,35 @@ declare type Dict = Record<string, string>;
  * You can also use translate<string> to handle custom strings or dynamic content.
  */
 declare function translate<T = Phrase>(phrase: NoInfer<T>): string;
+/**
+ * Whether I18n has a translation entry for given phrase
+ */
+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>;
@@ -666,7 +708,6 @@ interface Breakpoints {
         xl: number;
         xxl: number;
     };
-    unit: string;
     defaultBreakpoint: string;
 }
 
@@ -788,4 +829,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, ShadowValue, SignInContext, SignInState, 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, isDesignToken, signUpFieldsWithDefault, signUpFieldsWithoutDefault, translate, translations };
+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 };