@aws-amplify/ui-react 5.0.3 → 5.0.5

package/dist/styles.css

@@ -397,6 +397,7 @@
   --amplify-components-fieldcontrol-disabled-border-color: var(--amplify-colors-transparent);
   --amplify-components-fieldcontrol-disabled-background-color: var(--amplify-colors-background-disabled);
   --amplify-components-fieldcontrol-error-border-color: var(--amplify-colors-border-error);
+  --amplify-components-fieldcontrol-error-color: var(--amplify-colors-font-error);
   --amplify-components-fieldcontrol-error-focus-box-shadow: 0px 0px 0px 1px var(--amplify-colors-border-error);
   --amplify-components-fieldgroup-gap: var(--amplify-space-zero);
   --amplify-components-fieldgroup-vertical-align-items: center;
@@ -2893,10 +2894,14 @@ html[dir=rtl] .amplify-field-group__inner-start {
 
 .amplify-liveness-toast {
   background-color: var(--amplify-colors-background-primary);
+  padding: var(--amplify-space-small);
+  border-radius: var(--amplify-radii-medium);
 }
 
 .amplify-liveness-toast__message {
   color: var(--amplify-colors-font-primary);
+  text-align: center;
+  flex-direction: column;
 }
 
 .amplify-liveness-toast--large {
@@ -2908,6 +2913,14 @@ html[dir=rtl] .amplify-field-group__inner-start {
 }
 .amplify-liveness-toast--primary .amplify-liveness-toast__message {
   color: var(--amplify-colors-font-inverse);
+  text-align: center;
+  flex-direction: column;
+}
+
+.amplify-liveness-toast__container {
+  gap: var(--amplify-space-xs);
+  flex-direction: column;
+  align-items: center;
 }
 
 .amplify-liveness-toast--error {
@@ -3023,6 +3036,117 @@ html[dir=rtl] .amplify-field-group__inner-start {
   top: 0;
 }
 
+.amplify-liveness-landscape-error-modal {
+  background-color: var(--amplify-colors-background-primary);
+  direction: column;
+  text-align: center;
+  align-items: center;
+  justify-content: center;
+  width: 100%;
+}
+
+.amplify-liveness-landscape-error-modal__header {
+  font-size: large;
+  font-weight: var(--amplify-font-weights-bold);
+}
+
+.amplify-liveness-landscape-error-modal__button {
+  justify-content: center;
+}
+
+.amplify-liveness-start-screen-header {
+  display: flex;
+  flex-direction: column;
+}
+
+.amplify-liveness-start-screen-header__heading {
+  color: var(--amplify-colors-font-primary);
+  font-weight: var(--amplify-font-weights-bold);
+}
+
+.amplify-liveness-start-screen-header__body {
+  color: var(--amplify-colors-font-primary);
+}
+
+.amplify-liveness-start-screen-warning {
+  color: var(--amplify-colors-orange-80);
+  background-color: var(--amplify-colors-orange-20);
+  align-items: center;
+}
+
+.amplify-liveness-start-screen-instructions__heading {
+  color: var(--amplify-colors-font-primary);
+  font-weight: var(--amplify-font-weights-bold);
+}
+
+.amplify-liveness-overlay-opaque {
+  background-color: var(--amplify-colors-overlay-40);
+}
+
+.amplify-liveness-overlay {
+  flex-direction: column;
+  position: absolute;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 100%;
+  padding: var(--amplify-space-xl);
+}
+
+.amplify-liveness-error-modal {
+  gap: var(--amplify-space-xs);
+  align-items: center;
+  justify-content: center;
+  color: var(--amplify-colors-font-error);
+}
+
+.amplify-liveness-error-modal__heading {
+  font-weight: var(--amplify-font-weights-bold);
+}
+
+.amplify-liveness-hint__text {
+  align-items: center;
+  gap: var(--amplify-space-xs);
+}
+
+.amplify-liveness-popover {
+  position: relative;
+  cursor: pointer;
+}
+
+.amplify-liveness-popover__anchor {
+  position: absolute;
+  top: 26px;
+  left: 3px;
+  z-index: 3;
+  border-style: solid;
+  border-width: 0 9px 9px 9px;
+  border-color: transparent transparent var(--amplify-colors-background-primary) transparent;
+}
+
+.amplify-liveness-popover__anchor-secondary {
+  position: absolute;
+  top: 24px;
+  left: 2px;
+  z-index: 2;
+  border-style: solid;
+  border-width: 0 10px 10px 10px;
+  border-color: transparent transparent var(--amplify-colors-border-secondary) transparent;
+}
+
+.amplify-liveness-popover__container {
+  position: absolute;
+  background-color: var(--amplify-colors-background-primary);
+  color: var(--amplify-colors-font-primary);
+  flex-direction: row;
+  font-size: var(--amplify-font-sizes-xs);
+  padding: var(--amplify-space-small);
+  top: 33px;
+  width: 240px;
+  border: 1px solid var(--amplify-colors-border-secondary);
+  border-radius: 2px;
+}
+
 .amplify-fileuploader__dropzone {
   background-color: var(--amplify-components-fileuploader-dropzone-background-color);
   border-color: var(--amplify-components-fileuploader-dropzone-border-color);
@@ -3323,6 +3447,11 @@ html[dir=rtl] .amplify-field-group__inner-start {
   );
 }
 
+.amplify-field__show-password--error {
+  color: var(--amplify-components-fieldcontrol-error-color);
+  border-color: var(--amplify-components-fieldcontrol-error-border-color);
+}
+
 .amplify-phonenumberfield select:not(:focus) {
   border-right: none;
 }

package/dist/types/components/Authenticator/Authenticator.d.ts

@@ -31,6 +31,8 @@ export declare namespace Authenticator {
     var SignUp: typeof import("./SignUp").SignUp;
     var ForceNewPassword: {
         ({ className, variation, }: import("./RouteContainer").RouteProps): JSX.Element;
-        FormFields(): JSX.Element;
+        FormFields(): JSX.Element | null;
+        Header(): JSX.Element | null;
+        Footer(): JSX.Element | null;
     };
 }

package/dist/types/components/Authenticator/ForceNewPassword/ForceNewPassword.d.ts

@@ -2,5 +2,7 @@
 import { RouteProps } from '../RouteContainer';
 export declare const ForceNewPassword: {
     ({ className, variation, }: RouteProps): JSX.Element;
-    FormFields(): JSX.Element;
+    FormFields(): JSX.Element | null;
+    Header(): JSX.Element | null;
+    Footer(): JSX.Element | null;
 };

package/dist/types/components/Authenticator/hooks/useCustomComponents/defaultComponents.d.ts

@@ -1,15 +1,15 @@
 /// <reference types="react" />
 interface Components {
-    Footer?: () => JSX.Element;
-    FormFields?: () => JSX.Element;
-    Header?: () => JSX.Element;
+    Footer?: () => JSX.Element | null;
+    FormFields?: () => JSX.Element | null;
+    Header?: () => JSX.Element | null;
 }
 export interface DefaultComponents extends Omit<Components, 'FormFields'> {
     ConfirmSignIn?: Omit<Components, 'FormFields'>;
     ConfirmSignUp?: Omit<Components, 'FormFields'>;
     ConfirmResetPassword?: Omit<Components, 'FormFields'>;
     ConfirmVerifyUser?: Omit<Components, 'FormFields'>;
-    ForceNewPassword?: Pick<Components, 'FormFields'>;
+    ForceNewPassword?: Components;
     ResetPassword?: Omit<Components, 'FormFields'>;
     SetupTOTP?: Omit<Components, 'FormFields'>;
     SignIn?: Omit<Components, 'FormFields'>;

package/dist/types/hooks/useStorageURL.d.ts

@@ -1,13 +1,13 @@
 import { S3ProviderGetConfig } from '@aws-amplify/storage';
-export interface UseStorageURLResult {
-    url?: string;
-    error?: Error;
-    isLoading: boolean;
+interface UseStorageURLParams {
+    key: string;
+    options?: S3ProviderGetConfig;
+    fallbackURL?: string;
+    onStorageGetError?: (error: Error) => void;
 }
 /**
  * Computes a public URL for an Amplify Storage file
  * @internal
  */
-export declare const useStorageURL: (key: string, options?: S3ProviderGetConfig) => UseStorageURLResult & {
-    fetch: () => () => void;
-};
+export declare const useStorageURL: ({ key, options, fallbackURL, onStorageGetError, }: UseStorageURLParams) => string | undefined;
+export {};

package/dist/types/primitives/FieldGroupIcon/FieldGroupIcon.d.ts

@@ -1,2 +1,2 @@
 import { BaseFieldGroupIconProps, ForwardRefPrimitive } from '../types';
-export declare const FieldGroupIcon: ForwardRefPrimitive<BaseFieldGroupIconProps, 'button' | 'div'>;
+export declare const FieldGroupIcon: ForwardRefPrimitive<BaseFieldGroupIconProps, 'div'>;

package/dist/types/primitives/RadioGroupField/RadioGroupField.d.ts

@@ -2,4 +2,4 @@ import { BaseRadioGroupFieldProps, ForwardRefPrimitive } from '../types';
 /**
  * [📖 Docs](https://ui.docs.amplify.aws/react/components/radiogroupfield)
  */
-export declare const RadioGroupField: ForwardRefPrimitive<BaseRadioGroupFieldProps, 'div'>;
+export declare const RadioGroupField: ForwardRefPrimitive<BaseRadioGroupFieldProps, 'fieldset'>;

package/dist/types/primitives/StepperField/useStepper.d.ts

@@ -16,7 +16,7 @@ interface UseStepper extends Required<Pick<StepperFieldProps, 'step' | 'value'>>
     shouldDisableDecreaseButton: boolean;
     shouldDisableIncreaseButton: boolean;
 }
-export declare const useStepper: ({ defaultValue, value: controlledValue, step, max, min, isDisabled, isReadOnly, onChange, onDecrease, onIncrease, onStepChange, }: Omit<import("..").PrimitivePropsWithAs<import("../types/stepperField").BaseStepperFieldProps, "input">, "ref"> & React.RefAttributes<HTMLInputElement> & Omit<Pick<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "key" | keyof React.InputHTMLAttributes<HTMLInputElement>>, "as" | keyof React.RefAttributes<HTMLInputElement> | keyof import("../types/stepperField").BaseStepperFieldProps> & {
+export declare const useStepper: ({ defaultValue, value: controlledValue, step, max, min, isDisabled, isReadOnly, onChange, onDecrease, onIncrease, onStepChange, }: Omit<import("..").PrimitivePropsWithAs<import("../types/stepperField").BaseStepperFieldProps, "input">, "ref"> & React.RefAttributes<HTMLInputElement> & Omit<Pick<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "key" | keyof React.InputHTMLAttributes<HTMLInputElement>>, "as" | keyof React.RefAttributes<React.ComponentRef<Element_1>> | keyof import("../types/stepperField").BaseStepperFieldProps> & {
     onChange?: ChangeHandler | undefined;
 }) => UseStepper;
 export {};

package/dist/types/primitives/shared/types.d.ts

@@ -1,6 +1,6 @@
 import { ComponentClassName } from '@aws-amplify/ui';
-type ComponentNameKey = 'Alert' | 'Autocomplete' | 'Badge' | 'Button' | 'Button' | 'Card' | 'Checkbox' | 'CheckboxField' | 'Collection' | 'PhoneNumberField' | 'Divider' | 'Expander' | 'FileUploader' | 'Flex' | 'Grid' | 'Heading' | 'HighlightMatch' | 'Icon' | 'Image' | 'Link' | 'Loader' | 'Menu' | 'Pagination' | 'PasswordField' | 'PhoneNumberField' | 'Placeholder' | 'Radio' | 'RadioGroupField' | 'Rating' | 'ScrollView' | 'SearchField' | 'Select' | 'SliderField' | 'SelectField' | 'StepperField' | 'StorageManager' | 'SwitchField' | 'Table' | 'Tabs' | 'Text' | 'TextAreaField' | 'TextField' | 'ToggleButton' | 'ToggleButtonGroup' | 'VisuallyHidden';
-type ComponentClassNameKey = 'Alert' | 'AlertIcon' | 'AlertHeading' | 'AlertBody' | 'AlertDismiss' | 'Autocomplete' | 'AutocompleteMenu' | 'AutocompleteMenuEmpty' | 'AutocompleteMenuFooter' | 'AutocompleteMenuHeader' | 'AutocompleteMenuLoading' | 'AutocompleteMenuOption' | 'AutocompleteMenuOptions' | 'Badge' | 'Button' | 'ButtonGroup' | 'ButtonLoaderWrapper' | 'Card' | 'Checkbox' | 'CheckboxButton' | 'CheckboxIcon' | 'CheckboxInput' | 'CheckboxLabel' | 'CheckboxField' | 'Collection' | 'CollectionItems' | 'CollectionSearch' | 'CollectionPagination' | 'CountryCodeSelect' | 'DialCodeSelect' | 'Divider' | 'DividerLabel' | 'Expander' | 'ExpanderContent' | 'ExpanderContentText' | 'ExpanderHeader' | 'ExpanderIcon' | 'ExpanderItem' | 'ExpanderTrigger' | 'Field' | 'FieldDescription' | 'FieldErrorMessage' | 'FieldGroup' | 'FieldGroupControl' | 'FieldGroupOuterEnd' | 'FieldGroupOuterStart' | 'FieldGroupInnerEnd' | 'FieldGroupInnerStart' | 'FieldGroupIcon' | 'FieldGroupIconButton' | 'FieldGroupHasInnerEnd' | 'FieldGroupHasInnerStart' | 'FieldShowPassword' | 'FieldGroupFieldWrapper' | 'FileUploaderDropZone' | 'FileUploaderDropZoneIcon' | 'FileUploaderDropZoneText' | 'FileUploaderDropZoneButton' | 'FileUploaderFile' | 'FileUploaderFileWrapper' | 'FileUploaderFileName' | 'FileUploaderFileSize' | 'FileUploaderFileInfo' | 'FileUploaderFileStatus' | 'FileUploaderFileImage' | 'FileUploaderFileMain' | 'FileUploaderLoader' | 'FileUploaderPreviewer' | 'FileUploaderPreviewerText' | 'FileUploaderPreviewerBody' | 'FileUploaderPreviewerFooter' | 'FileUploaderPreviewerFooterActions' | 'Flex' | 'Grid' | 'Heading' | 'HighlightMatch' | 'HighlightMatchHighlighted' | 'Icon' | 'Image' | 'Input' | 'Label' | 'Link' | 'Loader' | 'LoaderDeterminate' | 'LoaderPercentageText' | 'MenuContent' | 'MenuContentWrapper' | 'MenuItem' | 'MenuTrigger' | 'Pagination' | 'PaginationItemButton' | 'PaginationItemCurrent' | 'PaginationItemEllipsis' | 'PasswordField' | 'PhoneNumberField' | 'Placeholder' | 'Radio' | 'RadioButton' | 'RadioInput' | 'RadioLabel' | 'RadioGroupField' | 'RadioGroup' | 'Rating' | 'ScrollView' | 'SearchField' | 'SearchFieldClear' | 'SearchFieldSearch' | 'Select' | 'SelectField' | 'SelectWrapper' | 'SelectIconWrapper' | 'SliderField' | 'SliderFieldGroup' | 'SliderFieldLabel' | 'SliderFieldRange' | 'SliderFieldRoot' | 'SliderFieldThumb' | 'SliderFieldTrack' | 'StepperField' | 'StepperFieldButtonDecrease' | 'StepperFieldButtonIncrease' | 'StepperFieldInput' | 'StorageManager' | 'StorageManagerDropZone' | 'StorageManagerDropZoneIcon' | 'StorageManagerDropZoneText' | 'StorageManagerFilePicker' | 'StorageManagerFile' | 'StorageManagerFileWrapper' | 'StorageManagerFileList' | 'StorageManagerFileName' | 'StorageManagerFileSize' | 'StorageManagerFileInfo' | 'StorageManagerFileStatus' | 'StorageManagerFileImage' | 'StorageManagerFileMain' | 'StorageManagerLoader' | 'StorageManagerPreviewer' | 'StorageManagerPreviewerText' | 'SwitchField' | 'SwitchLabel' | 'SwitchThumb' | 'SwitchTrack' | 'SwitchWrapper' | 'Table' | 'TableCaption' | 'TableBody' | 'TableTd' | 'TableTh' | 'TableFoot' | 'TableHead' | 'TableRow' | 'Tabs' | 'TabItems' | 'Text' | 'Textarea' | 'TextAreaField' | 'TextField' | 'ToggleButton' | 'ToggleButtonGroup' | 'VisuallyHidden';
+type ComponentNameKey = 'Alert' | 'Autocomplete' | 'Badge' | 'Button' | 'Button' | 'Card' | 'Checkbox' | 'CheckboxField' | 'Collection' | 'PhoneNumberField' | 'Divider' | 'Expander' | 'FileUploader' | 'Flex' | 'Grid' | 'Heading' | 'HighlightMatch' | 'Icon' | 'Image' | 'Link' | 'Loader' | 'Menu' | 'Pagination' | 'PasswordField' | 'PhoneNumberField' | 'Placeholder' | 'Radio' | 'RadioGroupField' | 'Rating' | 'ScrollView' | 'SearchField' | 'Select' | 'SliderField' | 'SelectField' | 'StepperField' | 'StorageImage' | 'StorageManager' | 'SwitchField' | 'Table' | 'Tabs' | 'Text' | 'TextAreaField' | 'TextField' | 'ToggleButton' | 'ToggleButtonGroup' | 'VisuallyHidden';
+type ComponentClassNameKey = 'Alert' | 'AlertIcon' | 'AlertHeading' | 'AlertBody' | 'AlertDismiss' | 'Autocomplete' | 'AutocompleteMenu' | 'AutocompleteMenuEmpty' | 'AutocompleteMenuFooter' | 'AutocompleteMenuHeader' | 'AutocompleteMenuLoading' | 'AutocompleteMenuOption' | 'AutocompleteMenuOptions' | 'Badge' | 'Button' | 'ButtonGroup' | 'ButtonLoaderWrapper' | 'Card' | 'Checkbox' | 'CheckboxButton' | 'CheckboxIcon' | 'CheckboxInput' | 'CheckboxLabel' | 'CheckboxField' | 'Collection' | 'CollectionItems' | 'CollectionSearch' | 'CollectionPagination' | 'CountryCodeSelect' | 'DialCodeSelect' | 'Divider' | 'DividerLabel' | 'Expander' | 'ExpanderContent' | 'ExpanderContentText' | 'ExpanderHeader' | 'ExpanderIcon' | 'ExpanderItem' | 'ExpanderTrigger' | 'Field' | 'FieldDescription' | 'FieldErrorMessage' | 'FieldGroup' | 'FieldGroupControl' | 'FieldGroupOuterEnd' | 'FieldGroupOuterStart' | 'FieldGroupInnerEnd' | 'FieldGroupInnerStart' | 'FieldGroupIcon' | 'FieldGroupIconButton' | 'FieldGroupHasInnerEnd' | 'FieldGroupHasInnerStart' | 'FieldShowPassword' | 'FieldGroupFieldWrapper' | 'FileUploaderDropZone' | 'FileUploaderDropZoneIcon' | 'FileUploaderDropZoneText' | 'FileUploaderDropZoneButton' | 'FileUploaderFile' | 'FileUploaderFileWrapper' | 'FileUploaderFileName' | 'FileUploaderFileSize' | 'FileUploaderFileInfo' | 'FileUploaderFileStatus' | 'FileUploaderFileImage' | 'FileUploaderFileMain' | 'FileUploaderLoader' | 'FileUploaderPreviewer' | 'FileUploaderPreviewerText' | 'FileUploaderPreviewerBody' | 'FileUploaderPreviewerFooter' | 'FileUploaderPreviewerFooterActions' | 'Flex' | 'Grid' | 'Heading' | 'HighlightMatch' | 'HighlightMatchHighlighted' | 'Icon' | 'Image' | 'Input' | 'Label' | 'Link' | 'Loader' | 'LoaderDeterminate' | 'LoaderPercentageText' | 'MenuContent' | 'MenuContentWrapper' | 'MenuItem' | 'MenuTrigger' | 'Pagination' | 'PaginationItemButton' | 'PaginationItemCurrent' | 'PaginationItemEllipsis' | 'PasswordField' | 'PhoneNumberField' | 'Placeholder' | 'Radio' | 'RadioButton' | 'RadioInput' | 'RadioLabel' | 'RadioGroupField' | 'RadioGroup' | 'Rating' | 'ScrollView' | 'SearchField' | 'SearchFieldClear' | 'SearchFieldSearch' | 'Select' | 'SelectField' | 'SelectWrapper' | 'SelectIconWrapper' | 'SliderField' | 'SliderFieldGroup' | 'SliderFieldLabel' | 'SliderFieldRange' | 'SliderFieldRoot' | 'SliderFieldThumb' | 'SliderFieldTrack' | 'StepperField' | 'StepperFieldButtonDecrease' | 'StepperFieldButtonIncrease' | 'StepperFieldInput' | 'StorageImage' | 'StorageManager' | 'StorageManagerDropZone' | 'StorageManagerDropZoneIcon' | 'StorageManagerDropZoneText' | 'StorageManagerFilePicker' | 'StorageManagerFile' | 'StorageManagerFileWrapper' | 'StorageManagerFileList' | 'StorageManagerFileName' | 'StorageManagerFileSize' | 'StorageManagerFileInfo' | 'StorageManagerFileStatus' | 'StorageManagerFileImage' | 'StorageManagerFileMain' | 'StorageManagerLoader' | 'StorageManagerPreviewer' | 'StorageManagerPreviewerText' | 'SwitchField' | 'SwitchLabel' | 'SwitchThumb' | 'SwitchTrack' | 'SwitchWrapper' | 'Table' | 'TableCaption' | 'TableBody' | 'TableTd' | 'TableTh' | 'TableFoot' | 'TableHead' | 'TableRow' | 'Tabs' | 'TabItems' | 'Text' | 'Textarea' | 'TextAreaField' | 'TextField' | 'ToggleButton' | 'ToggleButtonGroup' | 'VisuallyHidden';
 interface ComponentClassNameMetadata {
     className: ComponentClassName;
     components?: ComponentNameKey[];

package/dist/types/primitives/types/alert.d.ts

@@ -2,6 +2,7 @@ import * as React from 'react';
 import { BaseFlexProps } from './flex';
 import { ElementType, PrimitiveProps } from './view';
 export type AlertVariations = 'info' | 'error' | 'warning' | 'success';
+/** @deprecated For internal use only */
 export interface BaseAlertProps extends BaseFlexProps {
     /**
      * @description

package/dist/types/primitives/types/autocomplete.d.ts

@@ -23,6 +23,7 @@ export interface ComboBoxOption {
      */
     label: string;
 }
+/** @deprecated For internal use only */
 export interface BaseAutocompleteOptionProps extends BaseViewProps {
     /**
      * React node that will be wrapped inside a li element
@@ -35,6 +36,7 @@ export interface BaseAutocompleteOptionProps extends BaseViewProps {
     isActive: boolean;
 }
 export type AutocompleteOptionProps<Element extends ElementType = 'li'> = PrimitiveProps<BaseAutocompleteOptionProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseAutocompleteMenuProps extends BaseViewProps {
     /**
      * @description
@@ -80,6 +82,7 @@ export interface BaseAutocompleteMenuProps extends BaseViewProps {
     listboxId: string;
 }
 export type AutocompleteMenuProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseAutocompleteMenuProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseAutocompleteProps extends BaseSearchFieldProps {
     /**
      * @description

package/dist/types/primitives/types/badge.d.ts

@@ -2,6 +2,7 @@ import { Sizes } from './base';
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 export type BadgeVariations = 'info' | 'error' | 'warning' | 'success';
 export type BadgeSizes = Sizes;
+/** @deprecated For internal use only */
 export interface BaseBadgeProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/button.d.ts

@@ -5,6 +5,7 @@ import { FlexContainerStyleProps } from './flex';
 export type ButtonSizes = Sizes;
 export type ButtonTypes = 'button' | 'reset' | 'submit';
 export type ButtonVariations = 'primary' | 'link' | 'menu' | 'warning' | 'destructive';
+/** @deprecated For internal use only */
 export interface BaseButtonProps extends BaseViewProps, FlexContainerStyleProps {
     /**
      * @description

package/dist/types/primitives/types/buttonGroup.d.ts

@@ -4,6 +4,7 @@ import { BaseStyleProps } from './style';
 import { BaseButtonProps } from './button';
 import { BaseFlexProps } from './flex';
 import { ElementType, PrimitiveProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseButtonGroupProps extends AriaProps, BaseStyleProps, BaseFlexProps, Pick<BaseButtonProps, 'size' | 'variation'> {
     children: React.ReactNode;
 }

package/dist/types/primitives/types/card.d.ts

@@ -1,5 +1,6 @@
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 export type CardVariations = 'outlined' | 'elevated';
+/** @deprecated For internal use only */
 export interface BaseCardProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/checkbox.d.ts

@@ -4,6 +4,7 @@ import { BaseInputProps } from './input';
 import { FieldProps, LabelPositions } from './field';
 import { BaseStyleProps } from './style';
 import { ElementType, PrimitiveProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseCheckboxProps extends BaseFlexProps, BaseInputProps {
     /**
      * @description

package/dist/types/primitives/types/checkboxField.d.ts

@@ -1,6 +1,7 @@
 import { BaseCheckboxProps } from './checkbox';
 import { BaseFieldProps } from './field';
 import { ElementType, PrimitiveProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseCheckboxFieldProps extends BaseCheckboxProps, BaseFieldProps {
 }
 export type CheckboxFieldProps<Element extends ElementType = 'input'> = PrimitiveProps<BaseCheckboxFieldProps, Element>;

package/dist/types/primitives/types/collection.d.ts

@@ -73,6 +73,7 @@ export type GridCollectionProps<Item> = BaseGridProps & CollectionBaseProps<Item
  * and replaces with `CollectionChildren`
  */
 type ReplaceChildren<T, Item> = Omit<T, 'children'> & CollectionChildren<Item>;
+/** @deprecated For internal use only */
 export type BaseCollectionProps<Item, Element extends ElementType> = PrimitivePropsWithAs<CollectionWrapperProps, Element> & (ReplaceChildren<{
     type: 'list';
 } & ListCollectionProps<Item>, Item> | ReplaceChildren<{

package/dist/types/primitives/types/divider.d.ts

@@ -23,6 +23,7 @@ export interface DividerOptions {
      */
     label?: string;
 }
+/** @deprecated For internal use only */
 export interface BaseDividerProps extends BaseViewProps, DividerOptions {
 }
 export type DividerProps<Element extends ElementType = 'hr'> = PrimitiveProps<BaseDividerProps, Element>;

package/dist/types/primitives/types/expander.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { ElementType, PrimitiveProps, BaseViewProps } from '../types/view';
 type ExpanderType = 'single' | 'multiple';
+/** @deprecated For internal use only */
 export interface BaseExpanderProps extends BaseViewProps {
     /**
      * @description
@@ -33,6 +34,7 @@ export interface BaseExpanderProps extends BaseViewProps {
     onValueChange?: (value?: string | string[]) => void;
 }
 export type ExpanderProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseExpanderProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseExpanderItemProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/field.d.ts

@@ -6,6 +6,7 @@ import { BaseStyleProps } from './style';
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 /**
  * Shared type across all field types
+ * @deprecated For internal use only
  */
 export interface BaseFieldProps extends BaseViewProps {
     /**
@@ -38,12 +39,15 @@ export interface BaseFieldProps extends BaseViewProps {
     inputStyles?: BaseStyleProps;
 }
 export type FieldProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseFieldProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseFieldClearButtonProps extends Partial<BaseFieldGroupIconButtonProps> {
 }
 export type FieldClearButtonProps<Element extends ElementType = 'button'> = PrimitiveProps<BaseFieldClearButtonProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseFieldDescriptionProps extends BaseTextProps, Pick<BaseFieldProps, 'descriptiveText' | 'labelHidden'> {
 }
 export type FieldDescriptionProps<Element extends ElementType = 'p'> = PrimitiveProps<BaseFieldDescriptionProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseFieldErrorMessageProps extends BaseTextProps, Pick<BaseFieldProps, 'errorMessage'>, Pick<BaseInputProps, 'hasError'> {
 }
 export type FieldErrorMessageProps<Element extends ElementType = 'p'> = PrimitiveProps<BaseFieldErrorMessageProps, Element>;

package/dist/types/primitives/types/fieldGroup.d.ts

@@ -3,6 +3,7 @@ import { BaseFlexProps } from './flex';
 import { FieldVariations } from './field';
 import { ElementType, PrimitiveProps } from './view';
 export type FieldGroupOrientation = 'horizontal' | 'vertical';
+/** @deprecated For internal use only */
 export interface BaseFieldGroupOptions extends BaseFlexProps {
     children?: React.ReactNode;
     orientation?: FieldGroupOrientation;

package/dist/types/primitives/types/fieldGroupIcon.d.ts

@@ -1,5 +1,6 @@
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 import { BaseButtonProps } from './button';
+/** @deprecated For internal use only */
 export interface BaseFieldGroupIconProps extends BaseViewProps {
     /**
      * @description
@@ -14,6 +15,7 @@ export interface BaseFieldGroupIconProps extends BaseViewProps {
     excludeFromTabOrder?: boolean;
 }
 export type FieldGroupIconProps<Element extends ElementType = 'button' | 'div'> = PrimitiveProps<BaseFieldGroupIconProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseFieldGroupIconButtonProps extends BaseFieldGroupIconProps, Pick<BaseButtonProps, 'onClick' | 'variation' | 'size' | 'type'> {
 }
 export type FieldGroupIconButtonProps<Element extends ElementType = 'button'> = PrimitiveProps<BaseFieldGroupIconButtonProps, Element>;

package/dist/types/primitives/types/flex.d.ts

@@ -19,6 +19,7 @@ export interface FlexContainerStyleProps extends CSSLayoutStyleProps {
      */
     wrap?: ResponsiveStyle<Property.FlexWrap>;
 }
+/** @deprecated For internal use only */
 export interface BaseFlexProps extends BaseViewProps, FlexContainerStyleProps {
 }
 export type FlexProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseFlexProps, Element>;

package/dist/types/primitives/types/grid.d.ts

@@ -105,6 +105,7 @@ export interface GridItemStyleProps {
      */
     rowStart?: ResponsiveStyle<Property.GridRowStart>;
 }
+/** @deprecated For internal use only */
 export interface BaseGridProps extends GridContainerStyleProps, BaseViewProps {
 }
 export type GridProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseGridProps, Element>;

package/dist/types/primitives/types/heading.d.ts

@@ -2,6 +2,7 @@ import { BaseTextProps } from './text';
 import { ElementType, PrimitiveProps } from './view';
 export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
 export type HeadingTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+/** @deprecated For internal use only */
 export interface BaseHeadingProps extends BaseTextProps {
     /**
      * @description

package/dist/types/primitives/types/highlightMatch.d.ts

@@ -1,4 +1,5 @@
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseHighlightMatchProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/icon.d.ts

@@ -9,6 +9,7 @@ export type ViewBox = {
     height?: number;
 };
 export type IconSize = Sizes;
+/** @deprecated For internal use only */
 export interface BaseIconProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/image.d.ts

@@ -3,6 +3,11 @@ import { Property } from 'csstype';
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 import { ResponsiveStyle } from './style';
 export interface ImageStyleProps {
+    /**
+     * @description
+     * Sets a preferred aspect ratio for the selected replaced element's box
+     */
+    aspectRatio?: ResponsiveStyle<Property.AspectRatio>;
     /**
      * @description
      *  Sets how the content of an <img> should be resized to fit its container
@@ -52,6 +57,7 @@ export interface ImageOptions extends ImageStyleProps {
      */
     onError?(error: string | React.SyntheticEvent<HTMLImageElement, Event>): void;
 }
+/** @deprecated For internal use only */
 export interface BaseImageProps extends BaseViewProps, ImageOptions {
 }
 export type ImageProps<Element extends ElementType = 'img'> = PrimitiveProps<BaseImageProps, Element>;

package/dist/types/primitives/types/input.d.ts

@@ -5,6 +5,7 @@ import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 export type EnterKeyHint = 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
 export type InputMode = 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
 export type InputSizes = Sizes;
+/** @deprecated For internal use only */
 export interface BaseInputProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/label.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseLabelProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/link.d.ts

@@ -15,6 +15,7 @@ export interface LinkOptions {
      */
     href?: string;
 }
+/** @deprecated For internal use only */
 export interface BaseLinkProps extends BaseViewProps, LinkOptions {
     /**
      * @description

package/dist/types/primitives/types/loader.d.ts

@@ -4,6 +4,7 @@ import { Sizes } from './base';
 import { StyleToken } from './style';
 export type LoaderSizes = Sizes;
 export type LoaderVariations = 'linear';
+/** @deprecated For internal use only */
 export interface BaseLoaderProps extends BaseViewProps {
     /**
      * @description

package/dist/types/primitives/types/menu.d.ts

@@ -3,6 +3,7 @@ import { BaseButtonProps } from './button';
 import { BaseFlexProps } from './flex';
 import { Sizes } from './base';
 import { ElementType, PrimitiveProps } from './view';
+/** @deprecated For internal use only */
 export interface BaseMenuProps extends BaseFlexProps {
     /**
      * @description
@@ -43,6 +44,7 @@ export interface BaseMenuProps extends BaseFlexProps {
     triggerClassName?: string;
 }
 export type MenuProps<Element extends ElementType = 'div'> = PrimitiveProps<BaseMenuProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseMenuItemProps extends BaseButtonProps {
     /**
      * @description

package/dist/types/primitives/types/pagination.d.ts

@@ -4,6 +4,7 @@ import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 export type PaginationItemType = 'page' | 'next' | 'previous' | 'ellipsis';
 export type PaginationCallbackType = 'onNext' | 'onPrevious' | 'onChange';
 export type PaginationLabelType = 'pageLabel' | 'currentPageLabel' | 'previousLabel' | 'nextLabel';
+/** @deprecated For internal use only */
 export interface BasePaginationProps extends BaseViewProps {
     /**
      * @description
@@ -77,6 +78,7 @@ export interface UsePaginationProps extends Omit<BasePaginationProps, Pagination
 }
 export interface UsePaginationResult extends Required<Omit<BasePaginationProps, PaginationLabelType | keyof BaseViewProps>> {
 }
+/** @deprecated For internal use only */
 export interface BasePaginationItemProps extends BaseComponentProps, BaseStyleProps, AriaProps {
     /**
      * @description

package/dist/types/primitives/types/passwordField.d.ts

@@ -2,6 +2,8 @@ import * as React from 'react';
 import { BaseButtonProps } from './button';
 import { BaseTextFieldProps } from './textField';
 import { ElementType, PrimitiveProps } from './view';
+import { BaseInputProps } from './input';
+/** @deprecated For internal use only */
 export interface BasePasswordFieldProps extends BaseTextFieldProps {
     /**
      * @description
@@ -54,7 +56,8 @@ export interface BasePasswordFieldProps extends BaseTextFieldProps {
 }
 export type PasswordFieldProps<Element extends ElementType = 'input'> = PrimitiveProps<BasePasswordFieldProps, Element>;
 export type PasswordFieldType = 'password' | 'text';
-export interface BaseShowPasswordButtonProps extends BaseButtonProps {
+/** @deprecated For internal use only */
+export interface BaseShowPasswordButtonProps extends BaseButtonProps, Pick<BaseInputProps, 'hasError'> {
     /**
      * @description
      * Determines whether the input is hidden or displayed. Options include 'password' or 'text'

package/dist/types/primitives/types/phoneNumberField.d.ts

@@ -92,8 +92,10 @@ interface DialCodeRequired extends optionalPhoneNumberFieldProps {
      */
     defaultDialCode: string;
 }
+/** @deprecated For internal use only */
 export type BasePhoneNumberFieldProps = CountryCodeRequired | DialCodeRequired;
 export type PhoneNumberFieldProps<Element extends ElementType = 'input'> = PrimitiveProps<BasePhoneNumberFieldProps, Element>;
+/** @deprecated For internal use only */
 export interface BaseDialCodeSelectProps extends BaseSelectFieldProps {
     defaultValue?: string;
     dialCodeList?: Array<string>;

package/dist/types/primitives/types/placeholder.d.ts

@@ -1,6 +1,7 @@
 import { Sizes } from './base';
 import { ElementType, PrimitiveProps, BaseViewProps } from './view';
 export type PlaceholderSizes = Sizes;
+/** @deprecated For internal use only */
 export interface BasePlaceholderProps extends BaseViewProps {
     /**
      * @description