@bolttech/form-engine 3.0.0-beta.16 → 3.0.0-beta.18

package/src/types/index.d.ts

@@ -1,46 +1,20 @@
 import { TFieldEvent } from '@bolttech/form-engine-core';
 /**
- * @type TFieldWrapper
- * Represents the wrapper for a form field, including the component,
- * event handlers, and other properties related to form management.
+ * Represents a field wrapper containing the name of the field and its index in the form.
  *
- * @property {string} index - The index of the field in the form.
- * @property {ElementType} Component - The component to be rendered.
- * @property {(event: unknown) => unknown} [valueChangeEvent] - Function to handle value change events.
- * @property {string} formKey - The key of the form.
- * @property {string} [onBlur] - Function to handle the blur event.
- * @property {string} [onChange] - Function to handle the change event.
- * @property {string} [onFocus] - Function to handle the focus event.
- * @property {string} [onClick] - Function to handle the click event.
- * @property {string} [onKeyUp] - Function to handle the keyup event.
- * @property {string} [onKeyDown] - Function to handle the keydown event.
- * @property {unknown} [onValue] - The current value of the field.
- * @property {string} [onErrorMessage] - error message prop name to set message string
- *
- * @example
- * ```typescript
- * const fieldWrapper: TFieldWrapper = {
- *   index: '1',
- *   Component: MyComponent,
- *   valueChangeEvent: (event) => {
- *     const newValue = (event as React.ChangeEvent<HTMLInputElement>).target.value;
- *     return newValue;
- *   },
- *   formKey: 'myForm',
- *   onBlur: 'handleBlur',
- *   onChange: 'handleChange',
- *   onFocus: 'handleFocus',
- *   onClick: 'handleClick',
- *   onKeyUp: 'handleKeyUp',
- *   onKeyDown: 'handleKeyDown',
- *   onValue: 'value'
- * };
- * ```
+ * @property {string} name - The name of the field.
+ * @property {string} formIndex - The index of the field within the form.
  */
 type TFieldWrapper = {
     name: string;
     formIndex: string;
 };
-type eventProps = 'onChange' | 'onBlur' | 'onFocus' | 'onKeyDown' | 'onKeyUp' | 'onMount' | 'onApiResponse' | 'onClick';
-type TEventsCallbackProps = Partial<Record<eventProps, ((payload: TFieldEvent) => void) | null | undefined>>;
-export { TFieldWrapper, eventProps, TEventsCallbackProps };
+/**
+ * Represents the possible event properties for form fields callbacks.
+ */
+type TEventProps = 'onChange' | 'onBlur' | 'onFocus' | 'onKeyDown' | 'onKeyUp' | 'onMount' | 'onApiResponse' | 'onClick' | 'onSubmit';
+/**
+* Represents a mapping of event properties to their corresponding callback functions.
+*/
+type TEventsCallbackProps = Partial<Record<TEventProps, ((payload: TFieldEvent) => void) | null | undefined>>;
+export { TFieldWrapper, TEventProps, TEventsCallbackProps };