@delightui/components 0.1.162-alpha.2 → 0.1.162-alpha.4

package/dist/index.d.ts

@@ -244,6 +244,32 @@ type FieldValidationFunction<TValue = FieldValue> = (value: TValue) => string |
  * Returns error message string if invalid, undefined if valid
  */
 type AsyncFieldValidationFunction<TValue = FieldValue> = (value: TValue) => Promise<string | undefined>;
+/**
+ * @deprecated This type is deprecated and maintained for backwards compatibility only.
+ * Use the new FieldValidationFunction signature that returns error messages instead.
+ *
+ * Type representing a validation function for a form field
+ * It takes an error setter function and the field value (optional) and returns a boolean indicating if the value is valid
+ * @example
+ * ```typescript
+ * const nameValidator: LegacyFieldValidationFunction = (setError, value) => {
+ *   if (!value) {
+ *     setError('Name is required');
+ *     return false;
+ *   }
+ *   return true;
+ * };
+ * ```
+ */
+type LegacyFieldValidationFunction<T extends FieldValue = FieldValue> = (setError: (message: string) => void, value?: T) => boolean;
+/**
+ * @deprecated This type is deprecated and maintained for backwards compatibility only.
+ * Use the new AsyncFieldValidationFunction signature that returns error messages instead.
+ *
+ * Type representing an async validation function for a form field
+ * It takes an error setter function and the field value (optional) and returns a Promise<boolean> indicating if the value is valid
+ */
+type LegacyAsyncFieldValidationFunction<T extends FieldValue = FieldValue> = (setError: (message: string) => void, value?: T) => Promise<boolean>;
 /**
  * FormField component props for use within a Form
  */
@@ -261,10 +287,10 @@ type FormFieldProps<TFieldValues extends FieldValues = FieldValues, TName extend
     children: ReactNode;
     /** Field is required */
     required?: boolean;
-    /** Sync validation function */
-    validate?: FieldValidationFunction<PathValue<TFieldValues, TName>>;
-    /** Async validation function */
-    asyncValidate?: AsyncFieldValidationFunction<PathValue<TFieldValues, TName>>;
+    /** Sync validation function (supports both new and legacy signatures) */
+    validate?: FieldValidationFunction<PathValue<TFieldValues, TName>> | LegacyFieldValidationFunction<PathValue<TFieldValues, TName>>;
+    /** Async validation function (supports both new and legacy signatures) */
+    asyncValidate?: AsyncFieldValidationFunction<PathValue<TFieldValues, TName>> | LegacyAsyncFieldValidationFunction<PathValue<TFieldValues, TName>>;
     /** Default value for this field */
     defaultValue?: PathValue<TFieldValues, TName>;
     /** Info message to display */
@@ -283,7 +309,7 @@ type FormFieldProps<TFieldValues extends FieldValues = FieldValues, TName extend
 /**
  * Standalone FormField props (works without Form context)
  */
-type StandaloneFieldProps<TValue = FieldValue> = Omit<HTMLAttributes<HTMLDivElement>, 'id' | 'children' | 'onChange'> & {
+type StandaloneFieldProps<TValue extends FieldValue = FieldValue> = Omit<HTMLAttributes<HTMLDivElement>, 'id' | 'children' | 'onChange'> & {
     /** Field name */
     name: string;
     /** Field label */
@@ -294,10 +320,10 @@ type StandaloneFieldProps<TValue = FieldValue> = Omit<HTMLAttributes<HTMLDivElem
     children: ReactNode;
     /** Field is required */
     required?: boolean;
-    /** Sync validation function */
-    validate?: FieldValidationFunction<TValue>;
-    /** Async validation function */
-    asyncValidate?: AsyncFieldValidationFunction<TValue>;
+    /** Sync validation function (supports both new and legacy signatures) */
+    validate?: FieldValidationFunction<TValue> | LegacyFieldValidationFunction<TValue>;
+    /** Async validation function (supports both new and legacy signatures) */
+    asyncValidate?: AsyncFieldValidationFunction<TValue> | LegacyAsyncFieldValidationFunction<TValue>;
     /** Controlled value */
     value?: TValue;
     /** Controlled onChange */
@@ -1794,14 +1820,75 @@ declare const RadioGroup: (props: RadioGroupProps) => react_jsx_runtime.JSX.Elem
  * Form submission handler
  */
 type FormSubmitHandler<TFormValues extends FieldValues = FieldValues> = (values: TFormValues) => void | Promise<void>;
+/**
+ * @deprecated This type is deprecated and maintained for backwards compatibility only.
+ * Use the new FormSubmitHandler signature without setError instead.
+ *
+ * Type representing a function that handles form submission.
+ * It takes updated form state and a function to set error messages for specific fields.
+ *
+ * @template T - The type of the form state, defaulting to FieldValues.
+ *
+ * @param {T} values - The updated form state values.
+ * @param {(field: keyof T, errorMessage: string) => void} setError - A function to set error messages for specific fields.
+ *
+ * @example
+ * ```typescript
+ * const handleFormSubmit: LegacyFormSubmitHandler = (values, setError) => {
+ *   // Submit form data
+ *   console.log(values);
+ * };
+ * ```
+ */
+type LegacyFormSubmitHandler<T extends FieldValues = FieldValues> = (values: T, setError: (field: keyof T, errorMessage: string) => void) => void | Promise<void>;
+/**
+ * @deprecated This type is deprecated and maintained for backwards compatibility only.
+ * Use React Hook Form's built-in validation or field-level validation instead.
+ *
+ * Type representing a function that handles form state changes
+ * It takes the new form state and an error setter function and doesn't return anything
+ * @example
+ * ```typescript
+ * const handleFormStateChange: FormStateChangeHandler = (state, setError) => {
+ *   // Validate form state and set errors
+ *   if (!state.name) {
+ *     setError('name', 'Name is required');
+ *   }
+ * };
+ * ```
+ */
+type FormStateChangeHandler<T extends FieldValues = FieldValues> = (state: T, setError: (field: keyof T, errorMessage: string) => void) => void;
+/**
+ * @deprecated This type is deprecated and maintained for backwards compatibility only.
+ * Use React Hook Form's resolver or field-level validation instead.
+ *
+ * Type representing a function that validates the entire form
+ * It takes the form values and an error setter function and returns a boolean indicating if the form is valid
+ * @example
+ * ```typescript
+ * const validateForm: FormValidator = (state, setError) => {
+ *   let isValid = true;
+ *   if (!state.name) {
+ *     setError('name', 'Name is required');
+ *     isValid = false;
+ *   }
+ *   if (!state.age || typeof state.age !== 'number') {
+ *     setError('age', 'Age must be a number');
+ *     isValid = false;
+ *   }
+ *   return isValid;
+ * };
+ * ```
+ */
+type FormValidator<T extends FieldValues = FieldValues> = (state: T, setError: (field: keyof T, errorMessage: string) => void) => boolean;
 /**
  * Form component props
  */
 type FormProps<TFormValues extends FieldValues = FieldValues> = Omit<FormHTMLAttributes<HTMLFormElement>, 'onSubmit' | 'ref'> & {
     /** Initial form values (uncontrolled mode) */
     defaultValues?: UseFormProps<TFormValues>['defaultValues'];
-    /** Form submission handler - receives typed form values */
-    onSubmit?: FormSubmitHandler<TFormValues>;
+    /** Form submission handler - receives typed form values (supports both new and legacy signatures) */
+    onSubmit?: FormSubmitHandler<TFormValues> | LegacyFormSubmitHandler<TFormValues>;
     /** Enable autosave functionality */
     autosave?: boolean;
     /** Autosave debounce delay in milliseconds */
@@ -1812,6 +1899,23 @@ type FormProps<TFormValues extends FieldValues = FieldValues> = Omit<FormHTMLAtt
     formOptions?: Omit<UseFormProps<TFormValues>, 'defaultValues' | 'mode'>;
     /** Ref to the form element */
     formRef?: React.Ref<HTMLFormElement>;
+    /**
+     * @deprecated Use defaultValues instead. This prop is maintained for backwards compatibility only.
+     * Alias for defaultValues - initial form values
+     */
+    formState?: UseFormProps<TFormValues>['defaultValues'];
+    /**
+     * @deprecated Use React Hook Form's useWatch hook or field-level validation instead.
+     * This prop is maintained for backwards compatibility only.
+     * Callback fired whenever form values change
+     */
+    onFormStateChange?: FormStateChangeHandler<TFormValues>;
+    /**
+     * @deprecated Use React Hook Form's resolver or field-level validation instead.
+     * This prop is maintained for backwards compatibility only.
+     * Custom validator function for the entire form
+     */
+    formValidator?: FormValidator<TFormValues>;
 };
 /**
  * @deprecated Use FormProps instead
@@ -2790,4 +2894,4 @@ declare const NotificationContext: React__default.Context<NotificationContextVal
 declare const NotificationProvider: React__default.FC<NotificationProviderProps>;
 declare const useNotification: () => NotificationContextValue;
 
-export { type AccessibilityActions, type AccessibilityProps, Accordion, AccordionDetails, AccordionGroup, AccordionSummary, ActionCard, type ActionCardProps, ActionImage, type ActionImageProps, type AsyncFieldValidationFunction, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Breakpoint, type BreakpointProps, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, Card, type CardProps, Checkbox, CheckboxItem, type CheckboxItemProps, type CheckboxLabelAlignmentEnum, type CheckboxProps, type CheckboxSizeEnum, type CheckboxTypeEnum, Chip, ChipInput, type ChipInputProps, type ChipProps, ConditionalView, type ConditionalViewProps, ContextMenu, type ContextMenuProps, type ControlledFormComponentProps, type CustomTimePickerConfig, CustomToggle, type CustomToggleProps, DateInput, type DateInputProps, DatePicker, type DatePickerProps, SortableItem as DraggableItem, SortableTrigger as DraggableItemTrigger, Dropzone, DropzoneClear, DropzoneContent, type DropzoneContentProps, type DropzoneContentTypeEnum, DropzoneFilename, DropzoneFilename as DropzonePreview, type DropzoneProps, DropzoneSupportedFormats as DropzoneReject, DropzoneTrigger as DropzoneRoot, DropzoneSupportedFormats, DropzoneTrigger, type FieldValidationFunction, type FieldValue, Form, FormField, type FormFieldProps, type FormProps, type FormProviderProps, type FormSubmitHandler, Grid, GridItem, type GridItemProps, GridList, type GridListProps, type GridProps, Icon, IconButton, type IconButtonProps, type IconButtonStyleEnum, type IconProps, type IconSizeEnum, type IconStyleEnum, Image, type ImageFitEnum, type ImageProps, Input, type InputProps, type InputTypeEnum, List, ListItem, type ListItemProps$1 as ListItemProps, type ListProps, Modal, type ModalComponentProps, ModalFooter, type ModalFooterProps, ModalHeader, type ModalHeaderProps, type ModalProps, ModalProvider, type ModalProviderProps, Nav, NavItem, type NavItemProps, NavLink, type NavLinkProps, type NavProps, type Notification, type NotificationContainerProps, NotificationContext, type NotificationOffset, type NotificationPosition, NotificationProvider, type NotificationTrigger, Option, type OptionLike, type OptionLikeKey, type OptionProps, type OverlayDirectionEnum, Pagination, PaginationNumberField, type PaginationNumberFieldProps, type PaginationProps, Password, Popover, type PopoverHandle, type PopoverProps, ProgressBar, type ProgressBarProps, RadioButton, RadioButtonItem, type RadioButtonItemProps, type RadioButtonLabelAlignmentEnum, type RadioButtonProps, type RadioButtonSizeEnum, RadioGroup, type RadioGroupProps, RenderStateView, type RenderStateViewProps, RepeaterList, type RepeaterListProps, ResponsiveComponent, type ResponsiveComponentProps, Search, type SearchCallback, type SearchStyleEnum as SearchModeEnum, type SearchProps, Select, SelectListItem, type SelectListItemProps, type SelectProps, SelectProvider, SlideOutPanel, type SlideOutPanelDirectionEnum, type SlideOutPanelProps, type SlideOutPanelSizeEnum, Slider, type SliderProps, Spinner, type SpinnerProps, type StandaloneFieldProps, TabContent, type TabContentProps, TabItem, type TabItemProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableHeader, TableHeaderCell, type TableHeaderCellProps, type TableHeaderProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Text, TextArea, type TextAreaProps, type TextDecorationEnum, type TextProps, type TextTypeEnum, type TextWeightEnum, ThemeContext, type ThemeContextType, ThemeProvider, type ThemeProviderProps, Toggle, ToggleButton, type ToggleButtonProps, type ToggleLabelAlignmentEnum, type ToggleProps, Tooltip, type TooltipProps, type TriggerNotificationPayload, type UploadedFileMetadata, type UseModalReturn, WrapTextNodes, type WrapTextNodesProps, applyPropsToChildren, getClickAccessibilityProps, mergeRefs, useAutosave, useDebounce, useDropzoneContext, useInflateView, useModal, useNotification, useSelectContext, useTab };
+export { type AccessibilityActions, type AccessibilityProps, Accordion, AccordionDetails, AccordionGroup, AccordionSummary, ActionCard, type ActionCardProps, ActionImage, type ActionImageProps, type AsyncFieldValidationFunction, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Breakpoint, type BreakpointProps, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, Card, type CardProps, Checkbox, CheckboxItem, type CheckboxItemProps, type CheckboxLabelAlignmentEnum, type CheckboxProps, type CheckboxSizeEnum, type CheckboxTypeEnum, Chip, ChipInput, type ChipInputProps, type ChipProps, ConditionalView, type ConditionalViewProps, ContextMenu, type ContextMenuProps, type ControlledFormComponentProps, type CustomTimePickerConfig, CustomToggle, type CustomToggleProps, DateInput, type DateInputProps, DatePicker, type DatePickerProps, SortableItem as DraggableItem, SortableTrigger as DraggableItemTrigger, Dropzone, DropzoneClear, DropzoneContent, type DropzoneContentProps, type DropzoneContentTypeEnum, DropzoneFilename, DropzoneFilename as DropzonePreview, type DropzoneProps, DropzoneSupportedFormats as DropzoneReject, DropzoneTrigger as DropzoneRoot, DropzoneSupportedFormats, DropzoneTrigger, type FieldValidationFunction, type FieldValue, Form, FormField, type FormFieldProps, type FormProps, type FormProviderProps, type FormStateChangeHandler, type FormSubmitHandler, type FormValidator, Grid, GridItem, type GridItemProps, GridList, type GridListProps, type GridProps, Icon, IconButton, type IconButtonProps, type IconButtonStyleEnum, type IconProps, type IconSizeEnum, type IconStyleEnum, Image, type ImageFitEnum, type ImageProps, Input, type InputProps, type InputTypeEnum, type LegacyAsyncFieldValidationFunction, type LegacyFieldValidationFunction, type LegacyFormSubmitHandler, List, ListItem, type ListItemProps$1 as ListItemProps, type ListProps, Modal, type ModalComponentProps, ModalFooter, type ModalFooterProps, ModalHeader, type ModalHeaderProps, type ModalProps, ModalProvider, type ModalProviderProps, Nav, NavItem, type NavItemProps, NavLink, type NavLinkProps, type NavProps, type Notification, type NotificationContainerProps, NotificationContext, type NotificationOffset, type NotificationPosition, NotificationProvider, type NotificationTrigger, Option, type OptionLike, type OptionLikeKey, type OptionProps, type OverlayDirectionEnum, Pagination, PaginationNumberField, type PaginationNumberFieldProps, type PaginationProps, Password, Popover, type PopoverHandle, type PopoverProps, ProgressBar, type ProgressBarProps, RadioButton, RadioButtonItem, type RadioButtonItemProps, type RadioButtonLabelAlignmentEnum, type RadioButtonProps, type RadioButtonSizeEnum, RadioGroup, type RadioGroupProps, RenderStateView, type RenderStateViewProps, RepeaterList, type RepeaterListProps, ResponsiveComponent, type ResponsiveComponentProps, Search, type SearchCallback, type SearchStyleEnum as SearchModeEnum, type SearchProps, Select, SelectListItem, type SelectListItemProps, type SelectProps, SelectProvider, SlideOutPanel, type SlideOutPanelDirectionEnum, type SlideOutPanelProps, type SlideOutPanelSizeEnum, Slider, type SliderProps, Spinner, type SpinnerProps, type StandaloneFieldProps, TabContent, type TabContentProps, TabItem, type TabItemProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableHeader, TableHeaderCell, type TableHeaderCellProps, type TableHeaderProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Text, TextArea, type TextAreaProps, type TextDecorationEnum, type TextProps, type TextTypeEnum, type TextWeightEnum, ThemeContext, type ThemeContextType, ThemeProvider, type ThemeProviderProps, Toggle, ToggleButton, type ToggleButtonProps, type ToggleLabelAlignmentEnum, type ToggleProps, Tooltip, type TooltipProps, type TriggerNotificationPayload, type UploadedFileMetadata, type UseModalReturn, WrapTextNodes, type WrapTextNodesProps, applyPropsToChildren, getClickAccessibilityProps, mergeRefs, useAutosave, useDebounce, useDropzoneContext, useInflateView, useModal, useNotification, useSelectContext, useTab };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@delightui/components",
-  "version": "0.1.162-alpha.2",
+  "version": "0.1.162-alpha.4",
   "private": false,
   "scripts": {
     "start": "vite",