@aws-amplify/ui 3.3.0 → 3.4.0

package/dist/index.d.ts

@@ -1,1006 +0,0 @@
-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 { Interpreter, State, Sender } from 'xstate';
-import { PartialDeep } from 'type-fest';
-
-/**
- * Map of each input name to its value
- */
-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';
-/**
- * Used to customize form field attributes for each authenticator screen.
- */
-declare type FormFields = {
-    [key in FormFieldComponents]?: FormField;
-};
-/**
- * Override option for each screen. Maps each input to override options.
- */
-interface FormField {
-    [key: string]: FormFieldOptions;
-}
-/**
- * Override options for each field
- */
-interface FormFieldOptions {
-    /** Will hide the label above the input if set to true */
-    labelHidden?: boolean;
-    /** Label text */
-    label?: string;
-    /** Placeholder text */
-    placeholder?: string;
-    /**
-     * @deprecated For internal use only, please use `isRequired` instead.
-     */
-    required?: boolean;
-    /** Whether this field is required for submission */
-    isRequired?: boolean;
-    /** Default dial code value */
-    dialCode?: string;
-    /** TOTP issuer to be used in the QR setup */
-    totpIssuer?: string;
-    /** TOTP username to be used in the QR */
-    totpUsername?: string;
-    /** List of dial codes you want to show in phone number field */
-    dialCodeList?: Array<string>;
-    /** Integer that denotes where this field should be positioned in. */
-    order?: number;
-}
-declare type PasswordPolicyRules = 'REQUIRES_LOWERCASE' | 'REQUIRES_NUMBERS' | 'REQUIRES_SYMBOLS' | 'REQUIRES_UPPERCASE';
-interface PasswordSettings {
-    passwordPolicyMinLength: number;
-    passwordPolicyCharacters: Array<PasswordPolicyRules>;
-}
-
-/** Enum of known challenge names */
-declare enum AuthChallengeNames {
-    SMS_MFA = "SMS_MFA",
-    SOFTWARE_TOKEN_MFA = "SOFTWARE_TOKEN_MFA",
-    NEW_PASSWORD_REQUIRED = "NEW_PASSWORD_REQUIRED",
-    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;
-    phone_number: string;
-    [key: string]: string;
-}
-/** Cognito User Interface */
-interface CognitoUserAmplify extends CognitoUser {
-    username?: string;
-    attributes?: CognitoAttributes;
-}
-
-/**
- * Maps each input to its validation error, if any
- */
-declare type ValidationError = Record<string, 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, passwordSettings?: PasswordSettings) => ValidatorResult | Promise<ValidatorResult>;
-declare type SignInTypes = (user: string, code: string, mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA) => SignInResult | Promise<SignInResult>;
-
-/** Array of auth fields that we supply defaults with */
-declare const signUpFieldsWithDefault: readonly ["birthdate", "email", "family_name", "given_name", "middle_name", "name", "nickname", "phone_number", "preferred_username", "profile", "website"];
-/** Auth fields that we supply defaults with */
-declare type SignUpFieldsWithDefaults = typeof signUpFieldsWithDefault[number];
-/** Array of auth fields that we do not supply defaults with */
-declare const signUpFieldsWithoutDefault: readonly ["address", "gender", "locale", "picture", "updated_at", "zoneinfo"];
-/** Auth fields that we do not supply defaults with */
-declare type SignUpFieldsWithoutDefaults = typeof signUpFieldsWithoutDefault[number];
-/** All known auth fields */
-declare type SignUpAttribute = SignUpFieldsWithDefaults | SignUpFieldsWithoutDefaults;
-/** Fields that are common in all routes */
-declare type CommonFields = 'username' | 'password' | 'confirm_password';
-/** Array of known login mechanisms */
-declare const LoginMechanismArray: readonly ["username", "email", "phone_number"];
-/** Login mechanisms that can be used to sign in */
-declare type LoginMechanism = typeof LoginMechanismArray[number];
-/** List of social provider Authenticator supports */
-declare type SocialProvider = 'amazon' | 'apple' | 'facebook' | 'google';
-/** Input fields that we provide default fields with */
-declare type AuthFieldsWithDefaults = LoginMechanism | SignUpFieldsWithDefaults | 'confirmation_code' | 'password';
-/** Maps default attributes values for an input */
-interface InputAttributeDefaults {
-    label: string;
-    type: string;
-    placeholder: string;
-    autocomplete?: string;
-}
-/** Maps default attribute values for each Auth Field */
-declare type AuthInputAttributes = Record<AuthFieldsWithDefaults, InputAttributeDefaults>;
-
-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>;
-    validateFormPassword<Validator>(formData: any, touchData: any, passwordSettings: PasswordSettings): Promise<ValidatorResult>;
-    validateConfirmPassword<Validator_1>(formData: any, touchData: any): Promise<ValidatorResult>;
-    validatePreferredUsername(formData: any, touchData: any): Promise<ValidatorResult>;
-};
-
-/**
- * Data that actor returns when they are done and reach the final state
- */
-interface ActorDoneData {
-    /** Any auth form values that needs to be persisted between the actors */
-    authAttributes?: AuthFormData;
-    /** String that indicates where authMachine should next transition to */
-    intent?: string;
-    /** User returned by the actor it's done */
-    user?: CognitoUserAmplify;
-}
-/**
- * Context interface for the top-level machine
- */
-interface AuthContext {
-    /** Reference to the spawned actor */
-    actorRef?: any;
-    config?: {
-        loginMechanisms?: LoginMechanism[];
-        signUpAttributes?: SignUpAttribute[];
-        socialProviders?: SocialProvider[];
-        formFields?: FormFields;
-        initialState?: 'signIn' | 'signUp' | 'resetPassword';
-        passwordSettings?: PasswordSettings;
-    };
-    services?: Partial<typeof defaultServices>;
-    user?: CognitoUserAmplify;
-    username?: string;
-    password?: string;
-    code?: string;
-    mfaType?: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
-    actorDoneData?: Omit<ActorDoneData, 'user'>;
-}
-/**
- * Base context for all actors that have auth forms associated
- */
-interface BaseFormContext {
-    /** Any user attributes set that needs to persist between states */
-    authAttributes?: Record<string, any>;
-    /** Current challengeName issued by Cognnito */
-    challengeName?: string;
-    /** Required attributes for form submission */
-    requiredAttributes?: Array<string>;
-    /** Maps each input name to tis value */
-    formValues?: AuthFormData;
-    /** Input (names) that has been blurred at least ones */
-    touched?: AuthFormData;
-    /** String that indicates where authMachine should next transition to */
-    intent?: string;
-    /** Error returned from remote service / API */
-    remoteError?: string;
-    /** Current user inteface the actor is working with */
-    user?: CognitoUserAmplify;
-    /** Maps each input to its validation error, if any */
-    validationError?: ValidationError;
-    /** Maps each password validation rule */
-    passwordSettings?: PasswordSettings;
-    /** Denotes where a confirmation code has been sent to */
-    codeDeliveryDetails?: CodeDeliveryDetails;
-    /** Default country code for all phone number fields. */
-    country_code?: string;
-}
-interface SignInContext extends BaseFormContext {
-    loginMechanisms: Required<AuthContext>['config']['loginMechanisms'];
-    socialProviders: Required<AuthContext>['config']['socialProviders'];
-    formFields?: FormFields;
-    attributeToVerify?: string;
-    redirectIntent?: string;
-    unverifiedAttributes?: Record<string, string>;
-}
-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;
-}
-/**
- * Context for actors that have forms
- */
-declare type ActorContextWithForms = SignInContext | SignUpContext | ResetPasswordContext;
-declare type AuthActorContext = ActorContextWithForms | SignOutContext;
-
-/**
- * Events that occur when actors are done
- */
-declare type InvokeActorEventTypes = 'done.invoke.signInActor' | 'done.invoke.signUpActor' | 'done.invoke.signOutActor' | 'done.invoke.resetPasswordActor';
-/**
- * All known explicit events for xstate
- */
-declare type AuthEventTypes = 'CHANGE' | 'BLUR' | 'FEDERATED_SIGN_IN' | 'RESEND' | 'RESET_PASSWORD' | 'SIGN_IN' | 'SIGN_OUT' | 'SIGN_UP' | 'SKIP' | 'SUBMIT' | 'INIT' | InvokeActorEventTypes;
-/**
- * Data payload for auth events
- */
-declare type AuthEventData = Record<PropertyKey, any>;
-/** Top-level auth machine event interface */
-interface AuthEvent {
-    type: AuthEventTypes;
-    data?: AuthEventData;
-}
-
-/**
- * This files provides types that describe general shape of
- * authenticator machine and its intepreter.
- */
-
-/**
- * Intefrace for `authMachine` machine interpreter
- */
-declare type AuthInterpreter = Interpreter<AuthContext, any, AuthEvent>;
-/**
- * Function type for `send` in `authMachine`
- */
-declare type AuthMachineSend = AuthInterpreter['send'];
-
-declare type SignInState = State<SignInContext, AuthEvent>;
-declare type SignUpState = State<SignUpContext, AuthEvent>;
-declare type SignOutState = State<SignOutContext, AuthEvent>;
-declare type ResetPasswordState = State<ResetPasswordContext, AuthEvent>;
-declare type AuthActorState = State<AuthActorContext, AuthEvent>;
-declare type AuthMachineState = State<AuthContext, AuthEvent>;
-
-declare type NoInfer<T> = [T][T extends any ? 0 : never];
-
-/**
- * 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"
- * may be passed in to get info from context for that specific alias.
- */
-declare const getAliasInfoFromContext: (context: AuthContext, alias?: LoginMechanism) => {
-    label: string;
-    type: string;
-    error: any;
-};
-/**
- * Given xstate context from AuthMachine, returns the primaryAlias and
- * secondaryAliases.
- */
-declare const getConfiguredAliases: (context: AuthContext) => {
-    primaryAlias: "email" | "phone_number" | "username";
-    secondaryAliases: ("email" | "phone_number" | "username")[];
-};
-
-/**
- * Creates public facing auth helpers that abstracts out xstate implementation
- * detail. Each framework implementation can export these helpers so that
- * developers can send events without having to learn internals.
- *
- * ```
- * const [state, send] = useActor(...);
- * const { submit } = getSendEventAliases(send);
- * submit({ username, password})
- * ```
- */
-declare const getSendEventAliases: (send: Sender<AuthEvent>) => {
-    readonly resendCode: (data?: AuthEventData) => void;
-    readonly signOut: (data?: AuthEventData) => void;
-    readonly submitForm: (data?: AuthEventData) => void;
-    readonly updateForm: (data?: AuthEventData) => void;
-    readonly updateBlur: (data?: AuthEventData) => void;
-    readonly toFederatedSignIn: (data?: AuthEventData) => void;
-    readonly toResetPassword: (data?: AuthEventData) => void;
-    readonly toSignIn: (data?: AuthEventData) => void;
-    readonly toSignUp: (data?: AuthEventData) => void;
-    readonly skipVerification: (data?: AuthEventData) => void;
-};
-declare const getServiceContextFacade: (state: AuthMachineState) => {
-    error: string;
-    hasValidationErrors: boolean;
-    isPending: boolean;
-    route: string;
-    user: CognitoUserAmplify;
-    validationErrors: {
-        [x: string]: string | string[];
-    };
-    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
-};
-declare const getServiceFacade: ({ send, state }: {
-    send: any;
-    state: any;
-}) => {
-    error: string;
-    hasValidationErrors: boolean;
-    isPending: boolean;
-    route: string;
-    user: CognitoUserAmplify;
-    validationErrors: {
-        [x: string]: string | string[];
-    };
-    codeDeliveryDetails: amazon_cognito_identity_js.CodeDeliveryDetails;
-    resendCode: (data?: AuthEventData) => void;
-    signOut: (data?: AuthEventData) => void;
-    submitForm: (data?: AuthEventData) => void;
-    updateForm: (data?: AuthEventData) => void;
-    updateBlur: (data?: AuthEventData) => void;
-    toFederatedSignIn: (data?: AuthEventData) => void;
-    toResetPassword: (data?: AuthEventData) => void;
-    toSignIn: (data?: AuthEventData) => void;
-    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
- *
- * @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 const countryDialCodes: string[];
-
-/**
- * Contains translatable strings that authenticator provides by default. Customers
- * can use this to add custom vocabularies:
- *
- * ```
- * I18n.putVocabulariesForLanguage("en", {
- *  [DefaultTexts.SIGN_IN]: "Custom Sign In Text",
- *  [DefaultTexts.SIGN_IN_BUTTON]: "Custom Click Here to Sign In"
- * });
- * ```
- */
-declare const DefaultTexts: {
-    readonly BACK_SIGN_IN: string;
-    readonly BIRTHDATE: string;
-    readonly CHANGE_PASSWORD: string;
-    readonly CHANGING_PASSWORD: string;
-    readonly CODE: string;
-    readonly CONFIRM_PASSWORD: string;
-    readonly CONFIRM_RESET_PASSWORD_HEADING: string;
-    readonly CONFIRM_SIGNUP_HEADING: string;
-    readonly CONFIRM_SMS: string;
-    readonly CONFIRM_TOTP: string;
-    readonly CONFIRM: string;
-    readonly CONFIRMATION_CODE: string;
-    readonly CONFIRMING: string;
-    readonly CREATE_ACCOUNT: string;
-    readonly CREATING_ACCOUNT: string;
-    readonly EMAIL_ADDRESS: string;
-    readonly ENTER_CODE: string;
-    readonly ENTER_USERNAME: string;
-    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;
-    readonly MIDDLE_NAME: string;
-    readonly NAME: string;
-    readonly NICKNAME: string;
-    readonly NEW_PASSWORD: string;
-    readonly PASSWORD: string;
-    readonly PHONE_NUMBER: string;
-    readonly PREFERRED_USERNAME: string;
-    readonly PROFILE: string;
-    readonly RESEND_CODE: string;
-    readonly RESET_PASSWORD_HEADING: string;
-    readonly RESET_PASSWORD: string;
-    readonly SEND_CODE: string;
-    readonly SENDING: string;
-    readonly SETUP_TOTP: string;
-    readonly SHOW_PASSWORD: string;
-    readonly SIGN_IN_BUTTON: string;
-    readonly SIGN_IN_TAB: string;
-    readonly SIGN_IN_WITH_AMAZON: string;
-    readonly SIGN_IN_WITH_APPLE: string;
-    readonly SIGN_IN_WITH_FACEBOOK: string;
-    readonly SIGN_IN_WITH_GOOGLE: string;
-    readonly SIGN_IN: string;
-    readonly SIGN_UP_BUTTON: string;
-    readonly SIGNING_IN_BUTTON: string;
-    readonly SKIP: string;
-    readonly SUBMIT: string;
-    readonly SUBMITTING: string;
-    readonly VERIFY_CONTACT: string;
-    readonly VERIFY_HEADING: string;
-    readonly VERIFY: string;
-    readonly WEBSITE: string;
-};
-declare type Phrase = typeof DefaultTexts[keyof typeof DefaultTexts];
-/**
- * TODO: Translation keys for dictionaries can be inferred from DefaultTexts
- * by typing it to Partial<Record<Phrase, string>>.
- *
- * But this requires error string keys to be standarized as well, and can be a
- * limiting factor for custom translation keys. Marking it as TODO until we see
- * a reason to strongly type this.
- */
-declare type Dict = Record<string, string>;
-/**
- * This helper type checks that given phrase is one of the texts @aws-amplify/ui
- * provides by default. This enables vscode autocompletion to help catch typos
- * during development.
- *
- * 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 type AuthenticatorMachineOptions = AuthContext['config'] & {
-    services?: AuthContext['services'];
-};
-declare function createAuthenticatorMachine(): xstate.StateMachine<AuthContext, any, AuthEvent, {
-    value: any;
-    context: AuthContext;
-}, xstate.ActionObject<AuthContext, AuthEvent>>;
-
-/**
- * Helper function to test if something is a design token or not.
- * Used in the React component style props.
- *
- * @param arg - thing to test if it is a design token or not
- * @returns boolean
- */
-declare function isDesignToken(arg: unknown): arg is WebDesignToken;
-/**
- *
- */
-declare type DesignToken<ValueType = any> = {
-    value: ValueType;
-};
-/**
- * A fully setup design token ready to be used in web platform.
- */
-declare type WebDesignToken<ValueType = any> = {
-    /**
-     * Name of the design token
-     */
-    name: string;
-    /**
-     * Object path of the design token. Used for constructing the name
-     */
-    path: Array<string>;
-    /**
-     * Original (unresolved, untransformed) value of the design token
-     */
-    original: ValueType;
-    /**
-     * The wrapped CSS variable name of this design token, for example
-     * `var(--amplify-colors-font-primary)`
-     */
-    toString(): string;
-} & DesignToken<ValueType>;
-declare type ColorValue = string;
-declare type BorderWidthValue = string;
-declare type FontValue = string;
-declare type FontSizeValue = string;
-declare type FontWeightValue = number;
-declare type LineHeightValue = string;
-declare type OpacityValue = string;
-declare type OutlineOffsetValue = string;
-declare type OutlineWidthValue = string;
-declare type RadiusValue = string;
-declare type ShadowValue = {
-    offsetX: string;
-    offsetY: string;
-    blurRadius: string;
-    spreadRadius?: string;
-    color: string;
-};
-declare type SpaceValue = string;
-declare type TimeValue = string;
-declare type TransformValue = string;
-
-declare type BorderWidths = {
-    /**
-     * Small border, used for inputs and such
-     */
-    small: DesignToken<BorderWidthValue>;
-    /**
-     * Medium border, used for
-     */
-    medium: DesignToken<BorderWidthValue>;
-    /**
-     * Large border
-     */
-    large: DesignToken<BorderWidthValue>;
-};
-declare type WebBorderWidths = {
-    [Property in keyof BorderWidths]: WebDesignToken<BorderWidthValue>;
-};
-
-interface OrdinalScale<DesignTokenType = DesignToken<ColorValue>> {
-    primary: DesignTokenType;
-    secondary: DesignTokenType;
-    tertiary: DesignTokenType;
-}
-interface OrdinalVariation<DesignTokenType = DesignToken<ColorValue>> {
-    info: DesignTokenType;
-    warning: DesignTokenType;
-    error: DesignTokenType;
-    success: DesignTokenType;
-}
-
-declare type ScaleKeys = 10 | 20 | 40 | 60 | 80 | 90 | 100;
-declare type OverlayKeys = 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90;
-declare type ColorScale<DesignTokenType = DesignToken<ColorValue>> = {
-    [key in ScaleKeys]: DesignTokenType;
-};
-declare type OverlayColors<DesignTokenType = DesignToken<ColorValue>> = {
-    [key in OverlayKeys]: DesignTokenType;
-};
-declare type FontColors<DesignTokenType = DesignToken<ColorValue>> = {
-    inverse: DesignTokenType;
-    interactive: DesignTokenType;
-    hover: DesignTokenType;
-    focus: DesignTokenType;
-    active: DesignTokenType;
-    disabled: DesignTokenType;
-} & OrdinalScale<DesignTokenType> & OrdinalVariation<DesignTokenType>;
-declare type BackgroundColors<DesignTokenType = DesignToken<ColorValue>> = {
-    disabled: DesignTokenType;
-} & OrdinalScale<DesignTokenType> & OrdinalVariation<DesignTokenType>;
-declare type BorderColors<DesignTokenType = DesignToken<ColorValue>> = {
-    disabled: DesignTokenType;
-    focus: DesignTokenType;
-    error: DesignTokenType;
-} & OrdinalScale<DesignTokenType>;
-declare type ColorTypes<DesignTokenType = DesignToken<ColorValue>> = {
-    [key in ScaleKeys]: DesignTokenType;
-} | FontColors | BackgroundColors | DesignTokenType | BorderColors;
-declare type WebColorTypes = ColorTypes<WebDesignToken<ColorValue>>;
-declare type Colors = {
-    red: ColorScale;
-    orange: ColorScale;
-    yellow: ColorScale;
-    green: ColorScale;
-    teal: ColorScale;
-    blue: ColorScale;
-    purple: ColorScale;
-    pink: ColorScale;
-    neutral: ColorScale;
-    white: DesignToken<ColorValue>;
-    black: DesignToken<ColorValue>;
-    font: FontColors;
-    background: BackgroundColors;
-    border: BorderColors;
-    brand: {
-        primary: ColorScale;
-        secondary: ColorScale;
-    };
-    overlay: OverlayColors;
-    [key: string]: ColorTypes | Record<string, ColorTypes>;
-};
-declare type WebColors = {
-    red: ColorScale<WebDesignToken<ColorValue>>;
-    orange: ColorScale<WebDesignToken<ColorValue>>;
-    yellow: ColorScale<WebDesignToken<ColorValue>>;
-    green: ColorScale<WebDesignToken<ColorValue>>;
-    teal: ColorScale<WebDesignToken<ColorValue>>;
-    blue: ColorScale<WebDesignToken<ColorValue>>;
-    purple: ColorScale<WebDesignToken<ColorValue>>;
-    pink: ColorScale<WebDesignToken<ColorValue>>;
-    neutral: ColorScale<WebDesignToken<ColorValue>>;
-    white: WebDesignToken<ColorValue>;
-    black: WebDesignToken<ColorValue>;
-    font: FontColors<WebDesignToken<ColorValue>>;
-    background: BackgroundColors<WebDesignToken<ColorValue>>;
-    border: BorderColors<WebDesignToken<ColorValue>>;
-    brand: {
-        primary: ColorScale<WebDesignToken<ColorValue>>;
-        secondary: ColorScale<WebDesignToken<ColorValue>>;
-    };
-    overlay: OverlayColors<WebDesignToken<ColorValue>>;
-    [key: string]: WebColorTypes | Record<string, WebColorTypes>;
-};
-
-declare type Fonts = {
-    default: {
-        variable: DesignToken<FontValue>;
-        static: DesignToken<FontValue>;
-    };
-};
-interface WebFonts {
-    default: {
-        [Property in keyof Fonts['default']]: WebDesignToken<FontValue>;
-    };
-}
-
-declare type FontSizes = {
-    xxxs: DesignToken<FontSizeValue>;
-    xxs: DesignToken<FontSizeValue>;
-    xs: DesignToken<FontSizeValue>;
-    small: DesignToken<FontSizeValue>;
-    medium: DesignToken<FontSizeValue>;
-    large: DesignToken<FontSizeValue>;
-    xl: DesignToken<FontSizeValue>;
-    xxl: DesignToken<FontSizeValue>;
-    xxxl: DesignToken<FontSizeValue>;
-    xxxxl: DesignToken<FontSizeValue>;
-};
-declare type WebFontSizes = {
-    [Property in keyof FontSizes]: WebDesignToken<FontSizeValue>;
-};
-
-declare type FontWeights = {
-    hairline: DesignToken<FontWeightValue>;
-    thin: DesignToken<FontWeightValue>;
-    light: DesignToken<FontWeightValue>;
-    normal: DesignToken<FontWeightValue>;
-    medium: DesignToken<FontWeightValue>;
-    semibold: DesignToken<FontWeightValue>;
-    bold: DesignToken<FontWeightValue>;
-    extrabold: DesignToken<FontWeightValue>;
-    black: DesignToken<FontWeightValue>;
-};
-declare type WebFontWeights = {
-    [Property in keyof FontWeights]: WebDesignToken<FontWeightValue>;
-};
-
-declare type LineHeights = {
-    small: DesignToken<LineHeightValue>;
-    medium: DesignToken<LineHeightValue>;
-    large: DesignToken<LineHeightValue>;
-};
-declare type WebLineHeights = {
-    [Property in keyof LineHeights]: WebDesignToken<LineHeightValue>;
-};
-
-declare type Opacities = {
-    0: DesignToken<OpacityValue>;
-    10: DesignToken<OpacityValue>;
-    20: DesignToken<OpacityValue>;
-    30: DesignToken<OpacityValue>;
-    40: DesignToken<OpacityValue>;
-    50: DesignToken<OpacityValue>;
-    60: DesignToken<OpacityValue>;
-    70: DesignToken<OpacityValue>;
-    80: DesignToken<OpacityValue>;
-    90: DesignToken<OpacityValue>;
-    100: DesignToken<OpacityValue>;
-};
-declare type WebOpacities = {
-    [Property in keyof Opacities]: WebDesignToken<OpacityValue>;
-};
-
-declare type OutlineOffsets = {
-    small: DesignToken<OutlineOffsetValue>;
-    medium: DesignToken<OutlineOffsetValue>;
-    large: DesignToken<OutlineOffsetValue>;
-};
-declare type WebOutlineOffsets = {
-    [Property in keyof OutlineOffsets]: WebDesignToken<OutlineOffsetValue>;
-};
-
-declare type OutlineWidths = {
-    small: DesignToken<OutlineWidthValue>;
-    medium: DesignToken<OutlineWidthValue>;
-    large: DesignToken<OutlineWidthValue>;
-};
-declare type WebOutlineWidths = {
-    [Property in keyof OutlineWidths]: WebDesignToken<OutlineWidthValue>;
-};
-
-declare type Radii = {
-    xs: DesignToken<RadiusValue>;
-    small: DesignToken<RadiusValue>;
-    medium: DesignToken<RadiusValue>;
-    large: DesignToken<RadiusValue>;
-    xl: DesignToken<RadiusValue>;
-    xxl: DesignToken<RadiusValue>;
-    xxxl: DesignToken<RadiusValue>;
-};
-declare type WebRadii = {
-    [Property in keyof Radii]: WebDesignToken<RadiusValue>;
-};
-
-declare type Shadows = {
-    small: DesignToken<ShadowValue>;
-    medium: DesignToken<ShadowValue>;
-    large: DesignToken<ShadowValue>;
-};
-declare type WebShadows = {
-    [Property in keyof Shadows]: WebDesignToken<ShadowValue>;
-};
-
-declare type SpaceSizes = {
-    xxxs: DesignToken<SpaceValue>;
-    xxs: DesignToken<SpaceValue>;
-    xs: DesignToken<SpaceValue>;
-    small: DesignToken<SpaceValue>;
-    medium: DesignToken<SpaceValue>;
-    large: DesignToken<SpaceValue>;
-    xl: DesignToken<SpaceValue>;
-    xxl: DesignToken<SpaceValue>;
-    xxxl: DesignToken<SpaceValue>;
-};
-declare type Space = SpaceSizes & {
-    zero: DesignToken<SpaceValue>;
-    relative: SpaceSizes & {
-        full: DesignToken<SpaceValue>;
-    };
-};
-declare type WebSpace = {
-    [Property in keyof Omit<Space, 'relative'>]: WebDesignToken<SpaceValue>;
-} & {
-    relative: {
-        [Property in keyof Space['relative']]: WebDesignToken<SpaceValue>;
-    };
-};
-
-declare type Time = {
-    short: DesignToken<TimeValue>;
-    medium: DesignToken<TimeValue>;
-    long: DesignToken<TimeValue>;
-};
-declare type WebTime = {
-    [Property in keyof Time]: WebDesignToken<TimeValue>;
-};
-
-declare type Transforms = {
-    slideX: {
-        small: DesignToken<TransformValue>;
-        medium: DesignToken<TransformValue>;
-        large: DesignToken<TransformValue>;
-    };
-};
-declare type WebTransforms = {
-    slideX: {
-        [Property in keyof Transforms['slideX']]: WebDesignToken<TransformValue>;
-    };
-};
-
-interface Tokens {
-    components: any;
-    borderWidths: BorderWidths;
-    colors: Colors;
-    fonts: Fonts;
-    fontSizes: FontSizes;
-    fontWeights: FontWeights;
-    lineHeights: LineHeights;
-    opacities: Opacities;
-    outlineOffsets: OutlineOffsets;
-    outlineWidths: OutlineWidths;
-    radii: Radii;
-    shadows: Shadows;
-    space: Space;
-    time: Time;
-    transforms: Transforms;
-}
-/**
- * The fully setup theme tokens. It has the same shape as Tokens
- * but each token has added fields.
- */
-interface WebTokens extends Tokens {
-    borderWidths: WebBorderWidths;
-    colors: WebColors;
-    fonts: WebFonts;
-    fontSizes: WebFontSizes;
-    fontWeights: WebFontWeights;
-    lineHeights: WebLineHeights;
-    opacities: WebOpacities;
-    outlineOffsets: WebOutlineOffsets;
-    outlineWidths: WebOutlineWidths;
-    radii: WebRadii;
-    shadows: WebShadows;
-    space: WebSpace;
-    time: WebTime;
-    transform: WebTransforms;
-}
-
-interface Breakpoints {
-    values: {
-        base: number;
-        small: number;
-        medium: number;
-        large: number;
-        xl: number;
-        xxl: number;
-    };
-    defaultBreakpoint: string;
-}
-
-/**
- * An override is a set of tokens that override others
- * in certain contexts. On Android, these are like resource
- * qualifiers. On the web, these are like media queries with
- * a set of CSS variables in it. A theme should contain
- * everything it needs to render
- */
-declare type Override = SelectorOverride | MediaQueryOverride | BreakpointOverride | ColorModeOverride;
-interface BaseOverride {
-    tokens?: PartialDeep<Tokens>;
-}
-/**
- * This override takes a breakpoint name and creates a media-query for that
- * breakpoint
- * ```css
- * @media (min-width: 20em) {
- *    [data-amplify-theme] {
- *      --amplify-font-size-large: 2rem;
- *    }
- * }
- * ```
- */
-interface BreakpointOverride extends BaseOverride {
-    breakpoint: keyof Breakpoints['values'];
-}
-/**
- * ```css
- * @media (prefers-color-scheme: dark) {
- *    --amplify-colors-background-primary: black;
- *    --amplify-colors-font-primary: white;
- * }
- * ```
- */
-interface MediaQueryOverride extends BaseOverride {
-    mediaQuery: string;
-}
-/**
- * ```css
- * .disco-theme {
- *    --amplify-colors-background-primary: pink;
- * }
- * [data-my-cool-theme] {
- *    --amplify-colors-font-primary: purple;
- * }
- * ```
- */
-interface SelectorOverride extends BaseOverride {
-    selector: string;
-}
-declare type ColorMode = 'light' | 'dark';
-/**
- * This creates a color mode override, where the color mode is 'light' or 'dark'.
- * Note: there is no 'system' here.
- *
- * ```css
- * @media(prefers-color-scheme: dark) {
- *    [data-amplify-color-mode="system"] {
- *    }
- * }
- *
- * [data-amplify-color-mode="dark"] {
- *
- * }
- * ```
- */
-interface ColorModeOverride extends BaseOverride {
-    colorMode: ColorMode;
-}
-/**
- * A Theme just needs a name. This is what a user would generally deal with.
- * They can define any tokens or breakpoints they need, but they don't need a
- * complete theme with all tokens.
- */
-interface Theme {
-    /**
-     * The name of the theme. This is used to create scoped CSS to allow for
-     * multiple themes on a page.
-     */
-    name: string;
-    tokens?: PartialDeep<Tokens>;
-    breakpoints?: PartialDeep<Breakpoints>;
-    /**
-     * Overrides allow you to change design tokens in different contexts, like
-     * light and dark mode. You can also have other media query overrides as well
-     * as breakpoint overrides which correspond to the Breakpoints on a theme,
-     * and a generic selector override.
-     */
-    overrides?: Array<Override>;
-}
-/**
- * A BaseTheme has all tokens and breakpoints required
- */
-interface BaseTheme extends Theme {
-    tokens: Tokens;
-    breakpoints: Breakpoints;
-    overrides?: Array<Override>;
-}
-/**
- * WebTheme is a fully built theme that has cssText based
- * on the design tokens and all design tokens have added fields
- * to be used in Javascript/Typescript.
- */
-interface WebTheme extends BaseTheme {
-    tokens: WebTokens;
-    cssText: string;
-}
-
-/**
- * This will be used like `const myTheme = createTheme({})`
- * `myTheme` can then be passed to a Provider or the generated CSS
- * can be passed to a stylesheet at build-time or run-time.
- * const myTheme = createTheme({})
- * const myOtherTheme = createTheme({}, myTheme);
- */
-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, FormField, FormFieldComponents, FormFieldOptions, FormFields, InputAttributeDefaults, InvokeActorEventTypes, LineHeightValue, LoginMechanism, LoginMechanismArray, MediaQueryOverride, NoInfer, OpacityValue, OutlineOffsetValue, OutlineWidthValue, Override, PasswordPolicyRules, PasswordSettings, 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 };