@mmb-digital/design-system-web 0.1.271 → 0.1.272

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import React__default, { ReactNode, AriaAttributes, ElementType, RefObject, MouseEvent, AriaRole, TouchEvent, ReactElement, FocusEventHandler, MouseEventHandler, KeyboardEventHandler, HTMLProps, HTMLInputAutoCompleteAttribute, FocusEvent, ChangeEvent, ComponentType, ComponentProps, TextareaHTMLAttributes, RefAttributes, HTMLAttributes, HTMLInputTypeAttribute, FC, KeyboardEvent, Key } from 'react';
+import React__default, { ReactNode, AriaAttributes, ElementType, RefObject, MouseEvent, AriaRole, TouchEvent, ReactElement, FocusEventHandler, MouseEventHandler, KeyboardEventHandler, HTMLProps, HTMLInputAutoCompleteAttribute, FocusEvent, ChangeEvent, ComponentType, ComponentProps, TextareaHTMLAttributes, RefAttributes, HTMLAttributes, HTMLInputTypeAttribute, FC, KeyboardEvent, BaseSyntheticEvent, Key } from 'react';
 import { MessageDescriptor } from 'react-intl';
 import { FormatXMLElementFn, PrimitiveType } from 'intl-messageformat';
 import * as _emotion_react from '@emotion/react';
@@ -11,7 +11,7 @@ import { Property } from 'csstype';
 import { Locale } from 'date-fns';
 import { DatePickerProps as DatePickerProps$1 } from 'react-datepicker';
 import * as react_hook_form from 'react-hook-form';
-import { RegisterOptions, FieldValues, FieldPath, UseFormProps as UseFormProps$1, UseFormReturn as UseFormReturn$1 } from 'react-hook-form';
+import { RegisterOptions, FieldValues, FieldPath, UseFormProps as UseFormProps$1, SubmitErrorHandler, UseFormReturn as UseFormReturn$1 } from 'react-hook-form';
 import { FactoryOpts } from 'imask';
 import { z } from 'zod';
 import emotionStyled from '@emotion/styled';
@@ -2344,16 +2344,6 @@ interface ComboBoxFieldProps<TItem extends ComboBoxItem> extends Omit<ComboBoxPr
 }
 declare const ComboBoxField: <TItem extends ComboBoxItem>(props: ComboBoxFieldProps<TItem>) => React__default.JSX.Element;
 
-interface FormErrorOutcomeProps extends DesignSystemBaseProps {
-}
-declare const FormErrorOutcome: (props: FormErrorOutcomeProps) => React__default.JSX.Element | null;
-
-interface FormErrorSummaryProps extends DesignSystemBaseProps {
-    order?: string[];
-    title: ReactElement | string;
-}
-declare const FormErrorSummary: (props: FormErrorSummaryProps) => React__default.JSX.Element;
-
 interface ThrownFieldLevelError {
     code: string;
     fieldName: string;
@@ -2370,21 +2360,62 @@ interface ThrownFormErrors {
     fieldLevelErrors: ThrownFieldLevelError[];
     formLevelErrors: ThrownFormLevelError[];
 }
+interface ReCaptchaV3Config {
+    isEnterprise: boolean;
+    siteKey: string;
+}
+declare enum ReCaptchaType {
+    v3 = "v3"
+}
 interface FormConfig {
+    reCaptchaV3Config?: ReCaptchaV3Config;
     resolveThrownFormErrors?: (error: unknown) => ThrownFormErrors;
     thrownFieldLevelErrorFormatter?: Formatter<ThrownFieldLevelError, ReactNode, string>;
     thrownFormLevelErrorFormatter?: Formatter<ThrownFormLevelError, ReactNode, string>;
 }
+type SubmitHandler<TFieldValues extends FieldValues, TUseReCaptcha extends boolean> = (data: TFieldValues, extraParams: TUseReCaptcha extends true ? {
+    captchaToken: string;
+} : undefined, event?: BaseSyntheticEvent) => Promise<unknown> | unknown;
+
+declare const FormConfigContext: React__default.Context<FormConfig>;
+interface FormConfigProviderProps {
+    children: ReactNode;
+    config: FormConfig;
+}
+declare const FormConfigProvider: (props: FormConfigProviderProps) => React__default.JSX.Element;
 
+interface FormErrorOutcomeProps extends DesignSystemBaseProps {
+}
+declare const FormErrorOutcome: (props: FormErrorOutcomeProps) => React__default.JSX.Element | null;
+
+interface FormErrorSummaryProps extends DesignSystemBaseProps {
+    order?: string[];
+    title: ReactElement | string;
+}
+declare const FormErrorSummary: (props: FormErrorSummaryProps) => React__default.JSX.Element;
+
+interface UseFormReCaptchaProp {
+    action: string;
+    recaptchaType?: ReCaptchaType;
+}
 interface UseFormProps<TFieldValues extends FieldValues> extends UseFormProps$1<TFieldValues> {
     schema?: z.Schema;
     /** Used e.g. for updating field names when there's a discrepancy between React Hook Form and API fields. */
     updateThrownFormErrors?: (thrownFormErrors: ThrownFormErrors) => ThrownFormErrors;
 }
-interface UseFormReturn<TFieldValues extends FieldValues> extends UseFormReturn$1<TFieldValues> {
+type UseFormHandleSubmit<TFieldValues extends FieldValues, TUseReCaptcha extends boolean> = (onValid: SubmitHandler<TFieldValues, TUseReCaptcha>, onInvalid?: SubmitErrorHandler<TFieldValues>) => (event?: BaseSyntheticEvent) => Promise<void>;
+type UseFormReturn<TFieldValues extends FieldValues, TUseReCaptcha extends boolean = false> = Omit<UseFormReturn$1<TFieldValues>, 'handleSubmit'> & {
+    handleSubmit: UseFormHandleSubmit<TFieldValues, TUseReCaptcha>;
     thrownFormErrors: ThrownFormErrors;
-}
-declare const useForm: <TFieldValues extends FieldValues = FieldValues>(props?: UseFormProps<TFieldValues>) => UseFormReturn<TFieldValues>;
+};
+/**
+ * If enabled using the `reCaptcha` prop, automatically performs Google reCAPTCHA verification when submitting a form.
+ * The reCAPTCHA token is passed to the submit handler.
+ */
+declare function useForm<TFieldValues extends FieldValues>(props?: UseFormProps<TFieldValues>): UseFormReturn<TFieldValues, false>;
+declare function useForm<TFieldValues extends FieldValues>(props: UseFormProps<TFieldValues> & {
+    reCaptcha: UseFormReCaptchaProp;
+}): UseFormReturn<TFieldValues, true>;
 
 interface FormProviderProps<TFieldValues extends FieldValues = FieldValues> {
     children: ReactNode;
@@ -2392,13 +2423,6 @@ interface FormProviderProps<TFieldValues extends FieldValues = FieldValues> {
 }
 declare const FormProvider: <TFieldValues extends FieldValues = FieldValues>(props: FormProviderProps<TFieldValues>) => React__default.JSX.Element;
 
-declare const FormConfigContext: React__default.Context<FormConfig>;
-interface FormConfigProviderProps {
-    children: ReactNode;
-    config: FormConfig;
-}
-declare const FormConfigProvider: (props: FormConfigProviderProps) => React__default.JSX.Element;
-
 interface FormSuccessOutcomeProps extends DesignSystemBaseProps {
     children: ReactNode;
     onHide: () => void;
@@ -2526,4 +2550,4 @@ declare const useMessageFormatter: <TInput extends unknown>(getMessage: (value:
 
 declare const styled: typeof emotionStyled;
 
-export { Accordion, AccordionContent, type AccordionContentType, AccordionItem, type AccordionItemProps, type AccordionItemType, AccordionKeyValue, type AccordionKeyValueProps, type AccordionProps, AccordionVariant, BorderRadius, Button, type ButtonProps, ButtonSize, ButtonStyle, ButtonType, ButtonsLayout, ButtonsLayoutAlign, ButtonsLayoutDirection, type ButtonsLayoutProps, CalculatorResult, type CalculatorResultBodyItem, type CalculatorResultHeader, CalculatorResultInfoPosition, type CalculatorResultMain, type CalculatorResultModalDescriptor, type CalculatorResultProps, Checkbox, CheckboxControl, type CheckboxControlProps, CheckboxField, type CheckboxFieldProps, CheckboxPosition, type CheckboxProps, type ChooseColor, CircularProgressBar, type CircularProgressBarProps, type ColorObject, ColorScheme, ColorSchemeProvider, type ColorSchemeProviderProps, ComboBox, ComboBoxControl, type ComboBoxControlProps, ComboBoxField, type ComboBoxFieldProps, type ComboBoxItem, type ComboBoxItemOrder, ComboBoxItemOrderSource, type ComboBoxProps, type CreateTooltipInfoDescriptor, type CreateTooltipInfoDescriptorParam, DatePicker, DatePickerControl, type DatePickerControlProps, DatePickerField, type DatePickerFieldProps, type DatePickerProps, type DesignSystemBaseProps, DesignSystemProvider, type DesignSystemProviderProps, EmailInput, EmailInputField, type EmailInputFieldProps, type EmailInputProps, ErrorBox, type ErrorBoxItem, type ErrorBoxProps, type FieldAddon, FieldAddonPosition, type FieldConfig, FieldConfigProvider, type FieldConfigProviderProps, type FieldControlProps, FieldLabelStoreProvider, type FieldLabelStoreProviderProps, FieldOptionality, FieldWrapper, FieldWrapperLayout, type FieldWrapperProps, FileInput, FileInputControl, type FileInputControlProps, type FileInputDropzoneDragFilesHereComponent, type FileInputDropzoneDragOrSelectFilesComponent, type FileInputDropzoneSelectFilesComponent, FileInputErrorCode, FileInputField, type FileInputFieldProps, type FileInputLimitDescriptionComponent, type FileInputProps, type FileInputRemoveButtonTextComponent, type FileInputSettings, type FileInputUploadErrorReasonComponent, type FileInputUploadFailedComponent, FlexWrap, FontWeight, type FormConfig, FormConfigContext, FormConfigProvider, type FormConfigProviderProps, FormErrorOutcome, type FormErrorOutcomeProps, FormErrorSummary, type FormErrorSummaryProps, FormProvider, type FormProviderProps, FormSuccessOutcome, type FormSuccessOutcomeProps, FormatAmountCurrencyDisplay, FormatAmountGrouping, FormattedAmount$1 as FormattedAmount, type FormattedAmountProps$1 as FormattedAmountProps, FormattedHtmlMessage, type FormattedHtmlMessageProps, FormattedMessage, type FormattedMessageProps, _default as FormattedPercentage, type GetColor, IconProduct, type IconProductProps, IconProductSize, IconProductType, IconProductVariant, IconSystem, type IconSystemProps, IconSystemSize, IconSystemType, Infobox, type InfoboxProps, InfoboxSize, type InfoboxTextContent, InfoboxVariant, InputBase, type InputBaseProps, InputLabel, type InputLabelPassthroughProps, type InputLabelProps, InputLabelSize, InputSize, InputTextAlign, LabelTooltipPosition, Loader, LoaderOverlayBox, type LoaderOverlayBoxProps, type LoaderProps, LoaderSize, MaskedInput, MaskedInputBase, type MaskedInputBaseProps, MaskedInputField, type MaskedInputFieldProps, type MaskedInputProps, MediaType, MediaTypeProvider, type MediaTypeProviderProps, type MessageDescriptorWithPrimitiveValues, type MessageDescriptorWithValues, type MessageValues, Modal, type ModalOnClose, type ModalProps, ModalVerticalPosition, ModalWidthType, FormattedAmount as NextFormattedAmount, type FormattedAmountProps as NextFormattedAmountProps, NumberInput, NumberInputField, type NumberInputFieldProps, type NumberInputProps, Overflow, Paper, type PaperProps, PaperShadow, PhoneInput, PhoneInputField, type PhoneInputFieldProps, type PhoneInputProps, type PrimitiveMessageValues, ProgressPaper, type ProgressPaperProps, Radio, RadioButton, RadioButtonGroup, RadioButtonGroupControl, type RadioButtonGroupControlProps, RadioButtonGroupField, type RadioButtonGroupFieldProps, type RadioButtonGroupItem, RadioButtonGroupLayout, type RadioButtonGroupProps, type RadioButtonLabel, type RadioButtonProps, RadioControl, type RadioControlProps, RadioField, type RadioFieldProps, RadioGroup, RadioGroupControl, type RadioGroupControlProps, RadioGroupDirection, RadioGroupField, type RadioGroupFieldProps, type RadioGroupItem, type RadioGroupProps, RadioPosition, type RadioProps, ReasonForClosing, SearchInput, type SearchInputProps, Select, SelectControl, type SelectControlProps, SelectField, type SelectFieldProps, type SelectItem, type SelectItemOrder, SelectItemOrderSource, type SelectProps, SelectVariant, Slider, type SliderAriaValueTextFormatter, type SliderAriaValueTextFormatterDataContext, type SliderBreakpoint, SliderInput, SliderInputField, type SliderInputFieldProps, type SliderInputLimitExceededLiveTextFormatter, type SliderInputLimitExceededLiveTextFormatterDataContext, type SliderInputProps, SliderInputRoundingType, type SliderMinMaxLabels, type SliderProps, SliderStepType, type SliderSteps, Spacing, SpanButton, type SpanButtonProps, Stack, StackDirection, type StackProps, type TabItemType, Table, TableBody, type TableBodyProps, TableData, type TableDataProps, TableHead, TableHeadData, type TableHeadDataProps, type TableHeadProps, type TableProps, TableRow, type TableRowProps, TableTextAlign, TableVariant, Tabs, TabsActiveTabDefaultPosition, TabsItem, type TabsItemProps, type TabsProps, TabsSize, type TabsType, TabsVariant, Tag, TagIconPosition, type TagProps, TagSize, TagTextTransform, TagType, TextArea, TextAreaField, type TextAreaFieldProps, type TextAreaProps, TextDecoration, TextInput, TextInputField, type TextInputFieldProps, type TextInputProps, type Theme, type ThrownFieldLevelError, type ThrownFormErrors, type ThrownFormLevelError, ThrownFormLevelErrorType, Toggle, type ToggleProps, TooltipCloseReason, type TooltipDescriptor, TooltipGeneral, type TooltipGeneralProps, TooltipInfo, TooltipInfoConditional, type TooltipInfoConditionalProps, type TooltipInfoDescriptor, TooltipInfoDisplayMethod, TooltipInfoDisplayableCheck, type TooltipInfoDisplayableCheckProps, type TooltipInfoProps, TooltipPlacement, type TooltipRenderParent, TrailingTextInput, type TrailingTextInputProps, Typography, type TypographyProps, TypographyTextAlign, TypographyVariant, type UseColorSchemeOptions, type UseColorSchemeParam, type UseDesignSystemOptions, type UseDesignSystemParam, type UseFormProps, type UseFormReturn, type UseFormSuccessOutcomeManagerReturn, type UseFormatAmountParam, type UseMediaTypeOptions, type UseMediaTypeParam, VisuallyHidden, type VisuallyHiddenProps, datePickerValueFormat, getColor, getTextDecorationStyle, identityFormatter, isRenderable, jsonFormatter, resolveBorderRadiusValue, resolveFlexWrapValue, resolveFontWeightValue, resolveOverflowValue, resolveSpacingValue, resolveTextDecorationValue, styled, theme, useChooseColor, useColorScheme, useCreateTooltipInfoDescriptor, useDesignSystem, useFieldConfig, useFieldLabels, useForm, useFormContext, useFormSuccessOutcomeManager, useFormatAmount$1 as useFormatAmount, useFormattedPercentage, useGetFormattedHtmlMessageIfDisplayable, useIsMessageDisplayable, useMediaType, useMessageFormatter, useFormatAmount as useNextFormatAmount, useRegisterFieldLabel, withFieldWrapper, withMaskedInputField };
+export { Accordion, AccordionContent, type AccordionContentType, AccordionItem, type AccordionItemProps, type AccordionItemType, AccordionKeyValue, type AccordionKeyValueProps, type AccordionProps, AccordionVariant, BorderRadius, Button, type ButtonProps, ButtonSize, ButtonStyle, ButtonType, ButtonsLayout, ButtonsLayoutAlign, ButtonsLayoutDirection, type ButtonsLayoutProps, CalculatorResult, type CalculatorResultBodyItem, type CalculatorResultHeader, CalculatorResultInfoPosition, type CalculatorResultMain, type CalculatorResultModalDescriptor, type CalculatorResultProps, Checkbox, CheckboxControl, type CheckboxControlProps, CheckboxField, type CheckboxFieldProps, CheckboxPosition, type CheckboxProps, type ChooseColor, CircularProgressBar, type CircularProgressBarProps, type ColorObject, ColorScheme, ColorSchemeProvider, type ColorSchemeProviderProps, ComboBox, ComboBoxControl, type ComboBoxControlProps, ComboBoxField, type ComboBoxFieldProps, type ComboBoxItem, type ComboBoxItemOrder, ComboBoxItemOrderSource, type ComboBoxProps, type CreateTooltipInfoDescriptor, type CreateTooltipInfoDescriptorParam, DatePicker, DatePickerControl, type DatePickerControlProps, DatePickerField, type DatePickerFieldProps, type DatePickerProps, type DesignSystemBaseProps, DesignSystemProvider, type DesignSystemProviderProps, EmailInput, EmailInputField, type EmailInputFieldProps, type EmailInputProps, ErrorBox, type ErrorBoxItem, type ErrorBoxProps, type FieldAddon, FieldAddonPosition, type FieldConfig, FieldConfigProvider, type FieldConfigProviderProps, type FieldControlProps, FieldLabelStoreProvider, type FieldLabelStoreProviderProps, FieldOptionality, FieldWrapper, FieldWrapperLayout, type FieldWrapperProps, FileInput, FileInputControl, type FileInputControlProps, type FileInputDropzoneDragFilesHereComponent, type FileInputDropzoneDragOrSelectFilesComponent, type FileInputDropzoneSelectFilesComponent, FileInputErrorCode, FileInputField, type FileInputFieldProps, type FileInputLimitDescriptionComponent, type FileInputProps, type FileInputRemoveButtonTextComponent, type FileInputSettings, type FileInputUploadErrorReasonComponent, type FileInputUploadFailedComponent, FlexWrap, FontWeight, type FormConfig, FormConfigContext, FormConfigProvider, type FormConfigProviderProps, FormErrorOutcome, type FormErrorOutcomeProps, FormErrorSummary, type FormErrorSummaryProps, FormProvider, type FormProviderProps, FormSuccessOutcome, type FormSuccessOutcomeProps, FormatAmountCurrencyDisplay, FormatAmountGrouping, FormattedAmount$1 as FormattedAmount, type FormattedAmountProps$1 as FormattedAmountProps, FormattedHtmlMessage, type FormattedHtmlMessageProps, FormattedMessage, type FormattedMessageProps, _default as FormattedPercentage, type GetColor, IconProduct, type IconProductProps, IconProductSize, IconProductType, IconProductVariant, IconSystem, type IconSystemProps, IconSystemSize, IconSystemType, Infobox, type InfoboxProps, InfoboxSize, type InfoboxTextContent, InfoboxVariant, InputBase, type InputBaseProps, InputLabel, type InputLabelPassthroughProps, type InputLabelProps, InputLabelSize, InputSize, InputTextAlign, LabelTooltipPosition, Loader, LoaderOverlayBox, type LoaderOverlayBoxProps, type LoaderProps, LoaderSize, MaskedInput, MaskedInputBase, type MaskedInputBaseProps, MaskedInputField, type MaskedInputFieldProps, type MaskedInputProps, MediaType, MediaTypeProvider, type MediaTypeProviderProps, type MessageDescriptorWithPrimitiveValues, type MessageDescriptorWithValues, type MessageValues, Modal, type ModalOnClose, type ModalProps, ModalVerticalPosition, ModalWidthType, FormattedAmount as NextFormattedAmount, type FormattedAmountProps as NextFormattedAmountProps, NumberInput, NumberInputField, type NumberInputFieldProps, type NumberInputProps, Overflow, Paper, type PaperProps, PaperShadow, PhoneInput, PhoneInputField, type PhoneInputFieldProps, type PhoneInputProps, type PrimitiveMessageValues, ProgressPaper, type ProgressPaperProps, Radio, RadioButton, RadioButtonGroup, RadioButtonGroupControl, type RadioButtonGroupControlProps, RadioButtonGroupField, type RadioButtonGroupFieldProps, type RadioButtonGroupItem, RadioButtonGroupLayout, type RadioButtonGroupProps, type RadioButtonLabel, type RadioButtonProps, RadioControl, type RadioControlProps, RadioField, type RadioFieldProps, RadioGroup, RadioGroupControl, type RadioGroupControlProps, RadioGroupDirection, RadioGroupField, type RadioGroupFieldProps, type RadioGroupItem, type RadioGroupProps, RadioPosition, type RadioProps, ReCaptchaType, type ReCaptchaV3Config, ReasonForClosing, SearchInput, type SearchInputProps, Select, SelectControl, type SelectControlProps, SelectField, type SelectFieldProps, type SelectItem, type SelectItemOrder, SelectItemOrderSource, type SelectProps, SelectVariant, Slider, type SliderAriaValueTextFormatter, type SliderAriaValueTextFormatterDataContext, type SliderBreakpoint, SliderInput, SliderInputField, type SliderInputFieldProps, type SliderInputLimitExceededLiveTextFormatter, type SliderInputLimitExceededLiveTextFormatterDataContext, type SliderInputProps, SliderInputRoundingType, type SliderMinMaxLabels, type SliderProps, SliderStepType, type SliderSteps, Spacing, SpanButton, type SpanButtonProps, Stack, StackDirection, type StackProps, type SubmitHandler, type TabItemType, Table, TableBody, type TableBodyProps, TableData, type TableDataProps, TableHead, TableHeadData, type TableHeadDataProps, type TableHeadProps, type TableProps, TableRow, type TableRowProps, TableTextAlign, TableVariant, Tabs, TabsActiveTabDefaultPosition, TabsItem, type TabsItemProps, type TabsProps, TabsSize, type TabsType, TabsVariant, Tag, TagIconPosition, type TagProps, TagSize, TagTextTransform, TagType, TextArea, TextAreaField, type TextAreaFieldProps, type TextAreaProps, TextDecoration, TextInput, TextInputField, type TextInputFieldProps, type TextInputProps, type Theme, type ThrownFieldLevelError, type ThrownFormErrors, type ThrownFormLevelError, ThrownFormLevelErrorType, Toggle, type ToggleProps, TooltipCloseReason, type TooltipDescriptor, TooltipGeneral, type TooltipGeneralProps, TooltipInfo, TooltipInfoConditional, type TooltipInfoConditionalProps, type TooltipInfoDescriptor, TooltipInfoDisplayMethod, TooltipInfoDisplayableCheck, type TooltipInfoDisplayableCheckProps, type TooltipInfoProps, TooltipPlacement, type TooltipRenderParent, TrailingTextInput, type TrailingTextInputProps, Typography, type TypographyProps, TypographyTextAlign, TypographyVariant, type UseColorSchemeOptions, type UseColorSchemeParam, type UseDesignSystemOptions, type UseDesignSystemParam, type UseFormHandleSubmit, type UseFormProps, type UseFormReCaptchaProp, type UseFormReturn, type UseFormSuccessOutcomeManagerReturn, type UseFormatAmountParam, type UseMediaTypeOptions, type UseMediaTypeParam, VisuallyHidden, type VisuallyHiddenProps, datePickerValueFormat, getColor, getTextDecorationStyle, identityFormatter, isRenderable, jsonFormatter, resolveBorderRadiusValue, resolveFlexWrapValue, resolveFontWeightValue, resolveOverflowValue, resolveSpacingValue, resolveTextDecorationValue, styled, theme, useChooseColor, useColorScheme, useCreateTooltipInfoDescriptor, useDesignSystem, useFieldConfig, useFieldLabels, useForm, useFormContext, useFormSuccessOutcomeManager, useFormatAmount$1 as useFormatAmount, useFormattedPercentage, useGetFormattedHtmlMessageIfDisplayable, useIsMessageDisplayable, useMediaType, useMessageFormatter, useFormatAmount as useNextFormatAmount, useRegisterFieldLabel, withFieldWrapper, withMaskedInputField };