@rjsf/core 5.18.5 → 5.18.6

package/dist/core.umd.js

@@ -3030,9 +3030,22 @@
         };
         return getAllPaths(pathSchema);
       };
+      /** Returns the `formData` after filtering to remove any extra data not in a form field
+       *
+       * @param formData - The data for the `Form`
+       * @returns The `formData` after omitting extra data
+       */
+      this.omitExtraData = (formData) => {
+        const { schema, schemaUtils } = this.state;
+        const retrievedSchema = schemaUtils.retrieveSchema(schema, formData);
+        const pathSchema = schemaUtils.toPathSchema(retrievedSchema, "", formData);
+        const fieldNames = this.getFieldNames(pathSchema, formData);
+        const newFormData = this.getUsedFormData(formData, fieldNames);
+        return newFormData;
+      };
       /** Function to handle changes made to a field in the `Form`. This handler receives an entirely new copy of the
        * `formData` along with a new `ErrorSchema`. It will first update the `formData` with any missing default fields and
-       * then, if `omitExtraData` and `liveOmit` are turned on, the `formData` will be filterer to remove any extra data not
+       * then, if `omitExtraData` and `liveOmit` are turned on, the `formData` will be filtered to remove any extra data not
        * in a form field. Then, the resulting formData will be validated if required. The state will be updated with the new
        * updated (potentially filtered) `formData`, any errors that resulted from validation. Finally the `onChange`
        * callback will be called if specified with the updated state.
@@ -3051,12 +3064,8 @@
         const mustValidate = !noValidate && liveValidate;
         let state = { formData, schema };
         let newFormData = formData;
-        let _retrievedSchema;
         if (omitExtraData === true && liveOmit === true) {
-          _retrievedSchema = schemaUtils.retrieveSchema(schema, formData);
-          const pathSchema = schemaUtils.toPathSchema(_retrievedSchema, "", formData);
-          const fieldNames = this.getFieldNames(pathSchema, formData);
-          newFormData = this.getUsedFormData(formData, fieldNames);
+          newFormData = this.omitExtraData(formData);
           state = {
             formData: newFormData
           };
@@ -3087,9 +3096,6 @@
             errors: utils.toErrorList(errorSchema)
           };
         }
-        if (_retrievedSchema) {
-          state.retrievedSchema = _retrievedSchema;
-        }
         this.setState(state, () => onChange && onChange({ ...this.state, ...state }, id));
       };
       /**
@@ -3151,14 +3157,10 @@
         event.persist();
         const { omitExtraData, extraErrors, noValidate, onSubmit } = this.props;
         let { formData: newFormData } = this.state;
-        const { schema, schemaUtils } = this.state;
         if (omitExtraData === true) {
-          const retrievedSchema = schemaUtils.retrieveSchema(schema, newFormData);
-          const pathSchema = schemaUtils.toPathSchema(retrievedSchema, "", newFormData);
-          const fieldNames = this.getFieldNames(pathSchema, newFormData);
-          newFormData = this.getUsedFormData(newFormData, fieldNames);
+          newFormData = this.omitExtraData(newFormData);
         }
-        if (noValidate || this.validateForm()) {
+        if (noValidate || this.validateFormWithFormData(newFormData)) {
           const errorSchema = extraErrors || {};
           const errors = extraErrors ? utils.toErrorList(extraErrors) : [];
           this.setState(
@@ -3188,6 +3190,59 @@
           this.formElement.current.requestSubmit();
         }
       };
+      /** Validates the form using the given `formData`. For use on form submission or on programmatic validation.
+       * If `onError` is provided, then it will be called with the list of errors.
+       *
+       * @param formData - The form data to validate
+       * @returns - True if the form is valid, false otherwise.
+       */
+      this.validateFormWithFormData = (formData) => {
+        const { extraErrors, extraErrorsBlockSubmit, focusOnFirstError, onError } = this.props;
+        const { errors: prevErrors } = this.state;
+        const schemaValidation = this.validate(formData);
+        let errors = schemaValidation.errors;
+        let errorSchema = schemaValidation.errorSchema;
+        const schemaValidationErrors = errors;
+        const schemaValidationErrorSchema = errorSchema;
+        const hasError = errors.length > 0 || extraErrors && extraErrorsBlockSubmit;
+        if (hasError) {
+          if (extraErrors) {
+            const merged = utils.validationDataMerge(schemaValidation, extraErrors);
+            errorSchema = merged.errorSchema;
+            errors = merged.errors;
+          }
+          if (focusOnFirstError) {
+            if (typeof focusOnFirstError === "function") {
+              focusOnFirstError(errors[0]);
+            } else {
+              this.focusOnError(errors[0]);
+            }
+          }
+          this.setState(
+            {
+              errors,
+              errorSchema,
+              schemaValidationErrors,
+              schemaValidationErrorSchema
+            },
+            () => {
+              if (onError) {
+                onError(errors);
+              } else {
+                console.error("Form validation failed", errors);
+              }
+            }
+          );
+        } else if (prevErrors.length > 0) {
+          this.setState({
+            errors: [],
+            errorSchema: {},
+            schemaValidationErrors: [],
+            schemaValidationErrorSchema: {}
+          });
+        }
+        return !hasError;
+      };
       if (!props.validator) {
         throw new Error("A validator is required for Form functionality to work");
       }
@@ -3431,57 +3486,19 @@
         field.focus();
       }
     }
-    /** Programmatically validate the form. If `onError` is provided, then it will be called with the list of errors the
+    /** Programmatically validate the form.  If `omitExtraData` is true, the `formData` will first be filtered to remove
+     * any extra data not in a form field. If `onError` is provided, then it will be called with the list of errors the
      * same way as would happen on form submission.
      *
      * @returns - True if the form is valid, false otherwise.
      */
     validateForm() {
-      const { extraErrors, extraErrorsBlockSubmit, focusOnFirstError, onError } = this.props;
-      const { formData, errors: prevErrors } = this.state;
-      const schemaValidation = this.validate(formData);
-      let errors = schemaValidation.errors;
-      let errorSchema = schemaValidation.errorSchema;
-      const schemaValidationErrors = errors;
-      const schemaValidationErrorSchema = errorSchema;
-      const hasError = errors.length > 0 || extraErrors && extraErrorsBlockSubmit;
-      if (hasError) {
-        if (extraErrors) {
-          const merged = utils.validationDataMerge(schemaValidation, extraErrors);
-          errorSchema = merged.errorSchema;
-          errors = merged.errors;
-        }
-        if (focusOnFirstError) {
-          if (typeof focusOnFirstError === "function") {
-            focusOnFirstError(errors[0]);
-          } else {
-            this.focusOnError(errors[0]);
-          }
-        }
-        this.setState(
-          {
-            errors,
-            errorSchema,
-            schemaValidationErrors,
-            schemaValidationErrorSchema
-          },
-          () => {
-            if (onError) {
-              onError(errors);
-            } else {
-              console.error("Form validation failed", errors);
-            }
-          }
-        );
-      } else if (prevErrors.length > 0) {
-        this.setState({
-          errors: [],
-          errorSchema: {},
-          schemaValidationErrors: [],
-          schemaValidationErrorSchema: {}
-        });
+      const { omitExtraData } = this.props;
+      let { formData: newFormData } = this.state;
+      if (omitExtraData === true) {
+        newFormData = this.omitExtraData(newFormData);
       }
-      return !hasError;
+      return this.validateFormWithFormData(newFormData);
     }
     /** Renders the `Form` fields inside the <form> | `tagName` or `_internalFormWrapper`, rendering any errors if
      * needed along with the submit button or any children of the form.

package/dist/index.esm.js

@@ -3379,9 +3379,22 @@ var Form = class extends Component5 {
       };
       return getAllPaths(pathSchema);
     };
+    /** Returns the `formData` after filtering to remove any extra data not in a form field
+     *
+     * @param formData - The data for the `Form`
+     * @returns The `formData` after omitting extra data
+     */
+    this.omitExtraData = (formData) => {
+      const { schema, schemaUtils } = this.state;
+      const retrievedSchema = schemaUtils.retrieveSchema(schema, formData);
+      const pathSchema = schemaUtils.toPathSchema(retrievedSchema, "", formData);
+      const fieldNames = this.getFieldNames(pathSchema, formData);
+      const newFormData = this.getUsedFormData(formData, fieldNames);
+      return newFormData;
+    };
     /** Function to handle changes made to a field in the `Form`. This handler receives an entirely new copy of the
      * `formData` along with a new `ErrorSchema`. It will first update the `formData` with any missing default fields and
-     * then, if `omitExtraData` and `liveOmit` are turned on, the `formData` will be filterer to remove any extra data not
+     * then, if `omitExtraData` and `liveOmit` are turned on, the `formData` will be filtered to remove any extra data not
      * in a form field. Then, the resulting formData will be validated if required. The state will be updated with the new
      * updated (potentially filtered) `formData`, any errors that resulted from validation. Finally the `onChange`
      * callback will be called if specified with the updated state.
@@ -3402,10 +3415,7 @@ var Form = class extends Component5 {
       let newFormData = formData;
       let _retrievedSchema;
       if (omitExtraData === true && liveOmit === true) {
-        _retrievedSchema = schemaUtils.retrieveSchema(schema, formData);
-        const pathSchema = schemaUtils.toPathSchema(_retrievedSchema, "", formData);
-        const fieldNames = this.getFieldNames(pathSchema, formData);
-        newFormData = this.getUsedFormData(formData, fieldNames);
+        newFormData = this.omitExtraData(formData);
         state = {
           formData: newFormData
         };
@@ -3500,14 +3510,10 @@ var Form = class extends Component5 {
       event.persist();
       const { omitExtraData, extraErrors, noValidate, onSubmit } = this.props;
       let { formData: newFormData } = this.state;
-      const { schema, schemaUtils } = this.state;
       if (omitExtraData === true) {
-        const retrievedSchema = schemaUtils.retrieveSchema(schema, newFormData);
-        const pathSchema = schemaUtils.toPathSchema(retrievedSchema, "", newFormData);
-        const fieldNames = this.getFieldNames(pathSchema, newFormData);
-        newFormData = this.getUsedFormData(newFormData, fieldNames);
+        newFormData = this.omitExtraData(newFormData);
       }
-      if (noValidate || this.validateForm()) {
+      if (noValidate || this.validateFormWithFormData(newFormData)) {
         const errorSchema = extraErrors || {};
         const errors = extraErrors ? toErrorList(extraErrors) : [];
         this.setState(
@@ -3537,6 +3543,59 @@ var Form = class extends Component5 {
         this.formElement.current.requestSubmit();
       }
     };
+    /** Validates the form using the given `formData`. For use on form submission or on programmatic validation.
+     * If `onError` is provided, then it will be called with the list of errors.
+     *
+     * @param formData - The form data to validate
+     * @returns - True if the form is valid, false otherwise.
+     */
+    this.validateFormWithFormData = (formData) => {
+      const { extraErrors, extraErrorsBlockSubmit, focusOnFirstError, onError } = this.props;
+      const { errors: prevErrors } = this.state;
+      const schemaValidation = this.validate(formData);
+      let errors = schemaValidation.errors;
+      let errorSchema = schemaValidation.errorSchema;
+      const schemaValidationErrors = errors;
+      const schemaValidationErrorSchema = errorSchema;
+      const hasError = errors.length > 0 || extraErrors && extraErrorsBlockSubmit;
+      if (hasError) {
+        if (extraErrors) {
+          const merged = validationDataMerge(schemaValidation, extraErrors);
+          errorSchema = merged.errorSchema;
+          errors = merged.errors;
+        }
+        if (focusOnFirstError) {
+          if (typeof focusOnFirstError === "function") {
+            focusOnFirstError(errors[0]);
+          } else {
+            this.focusOnError(errors[0]);
+          }
+        }
+        this.setState(
+          {
+            errors,
+            errorSchema,
+            schemaValidationErrors,
+            schemaValidationErrorSchema
+          },
+          () => {
+            if (onError) {
+              onError(errors);
+            } else {
+              console.error("Form validation failed", errors);
+            }
+          }
+        );
+      } else if (prevErrors.length > 0) {
+        this.setState({
+          errors: [],
+          errorSchema: {},
+          schemaValidationErrors: [],
+          schemaValidationErrorSchema: {}
+        });
+      }
+      return !hasError;
+    };
     if (!props.validator) {
       throw new Error("A validator is required for Form functionality to work");
     }
@@ -3780,57 +3839,19 @@ var Form = class extends Component5 {
       field.focus();
     }
   }
-  /** Programmatically validate the form. If `onError` is provided, then it will be called with the list of errors the
+  /** Programmatically validate the form.  If `omitExtraData` is true, the `formData` will first be filtered to remove
+   * any extra data not in a form field. If `onError` is provided, then it will be called with the list of errors the
    * same way as would happen on form submission.
    *
    * @returns - True if the form is valid, false otherwise.
    */
   validateForm() {
-    const { extraErrors, extraErrorsBlockSubmit, focusOnFirstError, onError } = this.props;
-    const { formData, errors: prevErrors } = this.state;
-    const schemaValidation = this.validate(formData);
-    let errors = schemaValidation.errors;
-    let errorSchema = schemaValidation.errorSchema;
-    const schemaValidationErrors = errors;
-    const schemaValidationErrorSchema = errorSchema;
-    const hasError = errors.length > 0 || extraErrors && extraErrorsBlockSubmit;
-    if (hasError) {
-      if (extraErrors) {
-        const merged = validationDataMerge(schemaValidation, extraErrors);
-        errorSchema = merged.errorSchema;
-        errors = merged.errors;
-      }
-      if (focusOnFirstError) {
-        if (typeof focusOnFirstError === "function") {
-          focusOnFirstError(errors[0]);
-        } else {
-          this.focusOnError(errors[0]);
-        }
-      }
-      this.setState(
-        {
-          errors,
-          errorSchema,
-          schemaValidationErrors,
-          schemaValidationErrorSchema
-        },
-        () => {
-          if (onError) {
-            onError(errors);
-          } else {
-            console.error("Form validation failed", errors);
-          }
-        }
-      );
-    } else if (prevErrors.length > 0) {
-      this.setState({
-        errors: [],
-        errorSchema: {},
-        schemaValidationErrors: [],
-        schemaValidationErrorSchema: {}
-      });
+    const { omitExtraData } = this.props;
+    let { formData: newFormData } = this.state;
+    if (omitExtraData === true) {
+      newFormData = this.omitExtraData(newFormData);
     }
-    return !hasError;
+    return this.validateFormWithFormData(newFormData);
   }
   /** Renders the `Form` fields inside the <form> | `tagName` or `_internalFormWrapper`, rendering any errors if
    * needed along with the submit button or any children of the form.