@bombillazo/rhf-plus 7.62.0-plus.5 → 7.62.0-plus.7

package/dist/index.esm.mjs

@@ -270,6 +270,8 @@ function useFormState(props) {
     const [formState, updateFormState] = React.useState(control._formState);
     const _localProxyFormState = React.useRef({
         isDirty: false,
+        isDirtySinceSubmit: false,
+        hasBeenSubmitted: false,
         isLoading: false,
         dirtyFields: false,
         touchedFields: false,
@@ -1234,10 +1236,10 @@ var getValueAndMessage = (validationData) => isObject(validationData) && !isRege
         message: '',
     };
 
-var validateField = async (field, disabledFieldNames, formValues, validateAllFieldCriteria, shouldUseNativeValidation, isFieldArray) => {
+var validateField = async (field, skippedFieldNames, formValues, validateAllFieldCriteria, shouldUseNativeValidation, isFieldArray) => {
     const { ref, refs, required, maxLength, minLength, min, max, pattern, validate, name, valueAsNumber, mount, } = field._f;
     const inputValue = get(formValues, name);
-    if (!mount || disabledFieldNames.has(name)) {
+    if (!mount || skippedFieldNames.has(name)) {
         return {};
     }
     const inputRef = refs ? refs[0] : ref;
@@ -1426,6 +1428,7 @@ const defaultOptions = {
     mode: VALIDATION_MODE.onSubmit,
     reValidateMode: VALIDATION_MODE.onChange,
     shouldFocusError: true,
+    shouldSkipReadOnlyValidation: false,
 };
 function createFormControl(props = {}) {
     let _options = {
@@ -1436,6 +1439,8 @@ function createFormControl(props = {}) {
     let _formState = {
         submitCount: 0,
         isDirty: false,
+        isDirtySinceSubmit: false,
+        hasBeenSubmitted: false,
         isReady: false,
         isLoading: _internalLoading,
         isValidating: false,
@@ -1468,6 +1473,7 @@ function createFormControl(props = {}) {
     let _names = {
         mount: new Set(),
         disabled: new Set(),
+        readonly: new Set(),
         unMount: new Set(),
         array: new Set(),
         watch: new Set(),
@@ -1476,6 +1482,8 @@ function createFormControl(props = {}) {
     let timer = 0;
     const _proxyFormState = {
         isDirty: false,
+        isDirtySinceSubmit: false,
+        hasBeenSubmitted: false,
         dirtyFields: false,
         validatingFields: false,
         touchedFields: false,
@@ -1493,6 +1501,8 @@ function createFormControl(props = {}) {
     };
     const shouldDisplayAllAssociatedErrors = _options.criteriaMode === VALIDATION_MODE.all;
     const id = createId(props.id);
+    // Track if form was ever submitted (persists through resets)
+    let _hasBeenSubmitted = false;
     const debounce = (callback) => (wait) => {
         clearTimeout(timer);
         timer = setTimeout(callback, wait);
@@ -1616,6 +1626,20 @@ function createFormControl(props = {}) {
                             _proxySubscribeFormState.dirtyFields) &&
                             isPreviousDirty !== !isCurrentFieldPristine);
             }
+            // Set isDirtySinceSubmit to true if form was ever submitted and a field value is being changed
+            // For change events (not blur/focus), always set if form was ever submitted
+            // shouldDirty is true for onChange events, false for blur
+            if ((_formState.isSubmitted || _hasBeenSubmitted) &&
+                !_formState.isDirtySinceSubmit &&
+                !isBlurEvent &&
+                !isFocusEvent &&
+                shouldDirty) {
+                _formState.isDirtySinceSubmit = output.isDirtySinceSubmit = true;
+                shouldUpdateField =
+                    shouldUpdateField ||
+                        !!(_proxyFormState.isDirtySinceSubmit ||
+                            _proxySubscribeFormState.isDirtySinceSubmit);
+            }
             if (isBlurEvent) {
                 const isPreviousFieldTouched = get(_formState.touchedFields, name);
                 if (!isPreviousFieldTouched) {
@@ -1717,7 +1741,12 @@ function createFormControl(props = {}) {
                     if (isPromiseFunction && _proxyFormState.validatingFields) {
                         _updateIsValidating([name], true);
                     }
-                    const fieldError = await validateField(field, _names.disabled, _formValues, shouldDisplayAllAssociatedErrors, _options.shouldUseNativeValidation && !shouldOnlyCheckValid, isFieldArrayRoot);
+                    // Combine disabled and readonly field names for validation skipping
+                    const skipValidationFields = new Set([
+                        ..._names.disabled,
+                        ..._names.readonly,
+                    ]);
+                    const fieldError = await validateField(field, skipValidationFields, _formValues, shouldDisplayAllAssociatedErrors, _options.shouldUseNativeValidation && !shouldOnlyCheckValid, isFieldArrayRoot);
                     if (isPromiseFunction && _proxyFormState.validatingFields) {
                         _updateIsValidating([name]);
                     }
@@ -1811,9 +1840,15 @@ function createFormControl(props = {}) {
                 }
             }
         }
-        (options.shouldDirty || options.shouldTouch) &&
+        const isSubmittedAndDirty = (_formState.isSubmitted || _hasBeenSubmitted) &&
+            !deepEqual(get(_defaultValues, name), fieldValue);
+        // If the form was submitted, track value changes for isDirtySinceSubmit
+        // only when the value actually differs from the default value,
+        // even if shouldDirty is not explicitly set
+        const shouldTrackChange = options.shouldDirty || options.shouldTouch || isSubmittedAndDirty;
+        shouldTrackChange &&
             updateTouchAndDirty(name, fieldValue, options.shouldTouch, false, // isFocusEvent - not applicable for setValue
-            options.shouldDirty, true);
+            options.shouldDirty || isSubmittedAndDirty, true);
         options.shouldValidate && trigger(name);
     };
     const setValues = (name, value, options) => {
@@ -1845,12 +1880,25 @@ function createFormControl(props = {}) {
             if ((_proxyFormState.isDirty ||
                 _proxyFormState.dirtyFields ||
                 _proxySubscribeFormState.isDirty ||
-                _proxySubscribeFormState.dirtyFields) &&
+                _proxySubscribeFormState.dirtyFields ||
+                _proxyFormState.isDirtySinceSubmit ||
+                _proxySubscribeFormState.isDirtySinceSubmit) &&
                 options.shouldDirty) {
                 _subjects.state.next({
                     name,
                     dirtyFields: getDirtyFields(_defaultValues, _formValues),
                     isDirty: _getDirty(name, cloneValue),
+                    ...((_formState.isSubmitted || _hasBeenSubmitted) &&
+                        !_formState.isDirtySinceSubmit
+                        ? { isDirtySinceSubmit: true }
+                        : {}),
+                });
+            }
+            else if ((_formState.isSubmitted || _hasBeenSubmitted) &&
+                !_formState.isDirtySinceSubmit) {
+                _subjects.state.next({
+                    name,
+                    isDirtySinceSubmit: true,
                 });
             }
         }
@@ -1904,6 +1952,36 @@ function createFormControl(props = {}) {
                 }
                 return;
             }
+            // Check if field is readonly and should skip validation (only when flag is enabled)
+            if (_options.shouldSkipReadOnlyValidation && target && target.readOnly) {
+                // Add to readonly fields set for validation skipping
+                _names.readonly.add(name);
+                // For readonly fields, we still want to update the form values
+                // but skip validation (similar to disabled fields behavior)
+                const fieldValue = target.type
+                    ? getFieldValue(field._f)
+                    : getEventValue(event);
+                const isBlurEvent = event.type === EVENTS.BLUR || event.type === EVENTS.FOCUS_OUT;
+                const isFocusEvent = event.type === EVENTS.FOCUS || event.type === EVENTS.FOCUS_IN;
+                const watched = isWatched(name, _names, isBlurEvent || isFocusEvent);
+                // Update form values but skip validation and error handling
+                set(_formValues, name, fieldValue);
+                // Update touch and dirty state
+                const fieldState = updateTouchAndDirty(name, fieldValue, isBlurEvent, isFocusEvent, !isBlurEvent);
+                const shouldRender = !isEmptyObject(fieldState) || watched;
+                !isBlurEvent &&
+                    _subjects.state.next({
+                        name,
+                        type: event.type,
+                        values: cloneObject(_formValues),
+                    });
+                return (shouldRender &&
+                    _subjects.state.next({ name, ...(watched ? {} : fieldState) }));
+            }
+            else if (_options.shouldSkipReadOnlyValidation) {
+                // Remove from readonly fields set if not readonly anymore (only when flag is enabled)
+                _names.readonly.delete(name);
+            }
             let error;
             let isValid;
             const fieldValue = target.type
@@ -1927,7 +2005,7 @@ function createFormControl(props = {}) {
             else if (field._f.onChange) {
                 field._f.onChange(event);
             }
-            const fieldState = updateTouchAndDirty(name, fieldValue, isBlurEvent, isFocusEvent);
+            const fieldState = updateTouchAndDirty(name, fieldValue, isBlurEvent, isFocusEvent, !isBlurEvent);
             const shouldRender = !isEmptyObject(fieldState) || watched;
             !isBlurEvent &&
                 _subjects.state.next({
@@ -1963,7 +2041,12 @@ function createFormControl(props = {}) {
             }
             else {
                 _updateIsValidating([name], true);
-                error = (await validateField(field, _names.disabled, _formValues, shouldDisplayAllAssociatedErrors, _options.shouldUseNativeValidation))[name];
+                // Combine disabled and readonly field names for validation skipping
+                const skipValidationFields = new Set([
+                    ..._names.disabled,
+                    ..._names.readonly,
+                ]);
+                error = (await validateField(field, skipValidationFields, _formValues, shouldDisplayAllAssociatedErrors, _options.shouldUseNativeValidation, false))[name];
                 _updateIsValidating([name]);
                 _updateIsFieldValueUpdated(fieldValue);
                 if (isFieldValueUpdated) {
@@ -2214,6 +2297,13 @@ function createFormControl(props = {}) {
                         },
                     });
                     updateValidAndValue(name, false, undefined, fieldRef);
+                    // Check if field is readonly and should skip validation (only when flag is enabled)
+                    if (_options.shouldSkipReadOnlyValidation &&
+                        fieldRef &&
+                        'readOnly' in fieldRef &&
+                        fieldRef.readOnly) {
+                        _names.readonly.add(name);
+                    }
                 }
                 else {
                     field = get(_fields, name, {});
@@ -2311,11 +2401,14 @@ function createFormControl(props = {}) {
             _focusError();
             setTimeout(_focusError);
         }
+        _hasBeenSubmitted = true; // Mark that form was submitted at least once
         _subjects.state.next({
             isSubmitted: true,
             isSubmitting: false,
             isSubmitSuccessful: isEmptyObject(_formState.errors) && !onValidError,
             submitCount: _formState.submitCount + 1,
+            isDirtySinceSubmit: false,
+            hasBeenSubmitted: _hasBeenSubmitted,
             errors: _formState.errors,
         });
         if (onValidError) {
@@ -2378,7 +2471,7 @@ function createFormControl(props = {}) {
                             if (isHTMLElement(fieldReference)) {
                                 const form = fieldReference.closest('form');
                                 if (form) {
-                                    form.reset();
+                                    HTMLFormElement.prototype.reset.call(form);
                                     break;
                                 }
                             }
@@ -2411,6 +2504,7 @@ function createFormControl(props = {}) {
             unMount: new Set(),
             array: new Set(),
             disabled: new Set(),
+            readonly: new Set(),
             watch: new Set(),
             watchAll: false,
             focus: '',
@@ -2430,6 +2524,8 @@ function createFormControl(props = {}) {
                     ? _formState.isDirty
                     : !!(keepStateOptions.keepDefaultValues &&
                         !deepEqual(formValues, _defaultValues)),
+            isDirtySinceSubmit: false,
+            hasBeenSubmitted: _hasBeenSubmitted, // Persist the hasBeenSubmitted flag
             isSubmitted: keepStateOptions.keepIsSubmitted
                 ? _formState.isSubmitted
                 : false,
@@ -2508,6 +2604,28 @@ function createFormControl(props = {}) {
             });
         }
     };
+    const _updateReadonlyFieldTracking = () => {
+        // Re-evaluate all registered fields and update readonly tracking
+        // based on current shouldSkipReadOnlyValidation flag and field readonly state
+        Object.keys(_fields).forEach((fieldName) => {
+            const field = get(_fields, fieldName);
+            if (field && field._f) {
+                // Get the actual DOM element reference
+                const fieldRef = field._f.refs ? field._f.refs[0] : field._f.ref;
+                if (fieldRef && 'readOnly' in fieldRef) {
+                    const isFieldReadonly = Boolean(fieldRef.readOnly);
+                    const shouldTrackAsReadonly = _options.shouldSkipReadOnlyValidation && isFieldReadonly;
+                    // Update readonly tracking set
+                    if (shouldTrackAsReadonly) {
+                        _names.readonly.add(fieldName);
+                    }
+                    else {
+                        _names.readonly.delete(fieldName);
+                    }
+                }
+            }
+        });
+    };
     const setMetadata = (metadata) => {
         let _metadata;
         if (!metadata) {
@@ -2552,6 +2670,7 @@ function createFormControl(props = {}) {
             _removeUnmounted,
             _disableForm,
             _updateIsLoading,
+            _updateReadonlyFieldTracking,
             _subjects,
             _proxyFormState,
             get _fields() {
@@ -2955,6 +3074,8 @@ function useForm(props = {}) {
     const _values = React.useRef(undefined);
     const [formState, updateFormState] = React.useState({
         isDirty: false,
+        isDirtySinceSubmit: false,
+        hasBeenSubmitted: false,
         isValidating: false,
         isLoading: props.isLoading || isFunction(props.defaultValues),
         isSubmitted: false,
@@ -3012,6 +3133,11 @@ function useForm(props = {}) {
         return sub;
     }, [control]);
     React.useEffect(() => control._disableForm(props.disabled), [control, props.disabled]);
+    // Handle shouldSkipReadOnlyValidation flag changes
+    React.useEffect(() => {
+        // Re-evaluate readonly field tracking when the flag changes
+        control._updateReadonlyFieldTracking();
+    }, [control, props.shouldSkipReadOnlyValidation]);
     React.useEffect(() => {
         control._updateIsLoading(props.isLoading);
     }, [control, props.isLoading]);