Extract omitExtraData functionality from Form.tsx (core) to utils

Author: MarekBodinger

packages/utils/src/createSchemaUtils.ts

@@ -27,6 +27,7 @@ import {
   sanitizeDataForNewSchema,
   toIdSchema,
   toPathSchema,
+  omitExtraData,
 } from './schema';
 
 /** The `SchemaUtils` class provides a wrapper around the publicly exported APIs in the `utils/schema` directory such
@@ -275,6 +276,10 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
   toPathSchema(schema: S, name?: string, formData?: T): PathSchema<T> {
     return toPathSchema<T, S, F>(this.validator, schema, name, this.rootSchema, formData);
   }
+
+  omitExtraData(schema: S, formData?: T): T | undefined {
+    return omitExtraData<T, S, F>(this.validator, schema, this.rootSchema, formData);
+  }
 }
 
 /** Creates a `SchemaUtilsType` interface that is based around the given `validator` and `rootSchema` parameters. The

packages/utils/src/schema/index.ts

@@ -11,6 +11,7 @@ import retrieveSchema from './retrieveSchema';
 import sanitizeDataForNewSchema from './sanitizeDataForNewSchema';
 import toIdSchema from './toIdSchema';
 import toPathSchema from './toPathSchema';
+import omitExtraData from './omitExtraData';
 
 export {
   getDefaultFormState,
@@ -22,6 +23,7 @@ export {
   isMultiSelect,
   isSelect,
   mergeValidationData,
+  omitExtraData,
   retrieveSchema,
   sanitizeDataForNewSchema,
   toIdSchema,

packages/utils/src/schema/omitExtraData.ts

@@ -0,0 +1,65 @@
+import { FormContextType, GenericObjectType, PathSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+import _pick from 'lodash/pick';
+
+import _get from 'lodash/get';
+import _isEmpty from 'lodash/isEmpty';
+import toPathSchema from './toPathSchema';
+import { NAME_KEY, RJSF_ADDITONAL_PROPERTIES_FLAG } from '../constants';
+
+export function getFieldNames<T = any>(pathSchema: PathSchema<T>, formData?: T): string[][] {
+  const getAllPaths = (_obj: GenericObjectType, acc: string[][] = [], paths: string[][] = [[]]) => {
+    Object.keys(_obj).forEach((key: string) => {
+      if (typeof _obj[key] === 'object') {
+        const newPaths = paths.map((path) => [...path, key]);
+        // If an object is marked with additionalProperties, all its keys are valid
+        if (_obj[key][RJSF_ADDITONAL_PROPERTIES_FLAG] && _obj[key][NAME_KEY] !== '') {
+          acc.push(_obj[key][NAME_KEY]);
+        } else {
+          getAllPaths(_obj[key], acc, newPaths);
+        }
+      } else if (key === NAME_KEY && _obj[key] !== '') {
+        paths.forEach((path) => {
+          const formValue = _get(formData, path);
+          // adds path to fieldNames if it points to a value
+          // or an empty object/array
+          if (
+            typeof formValue !== 'object' ||
+            _isEmpty(formValue) ||
+            (Array.isArray(formValue) && formValue.every((val) => typeof val !== 'object'))
+          ) {
+            acc.push(path);
+          }
+        });
+      }
+    });
+    return acc;
+  };
+
+  return getAllPaths(pathSchema);
+}
+
+export function getUsedFormData<T = any>(formData: T | undefined, fields: string[][]): T | undefined {
+  // For the case of a single input form
+  if (fields.length === 0 && typeof formData !== 'object') {
+    return formData;
+  }
+
+  // _pick has incorrect type definition, it works with string[][], because lodash/hasIn supports it
+  const data: GenericObjectType = _pick(formData, fields as unknown as string[]);
+  if (Array.isArray(formData)) {
+    return Object.keys(data).map((key: string) => data[key]) as unknown as T;
+  }
+
+  return data as T;
+}
+
+export default function omitExtraData<
+  T = any,
+  S extends StrictRJSFSchema = RJSFSchema,
+  F extends FormContextType = any
+>(validator: ValidatorType<T, S, F>, schema: S, rootSchema: S = {} as S, formData?: T): T | undefined {
+  const pathSchema = toPathSchema(validator, schema, '', rootSchema, formData);
+  const fieldNames = getFieldNames(pathSchema, formData);
+
+  return getUsedFormData(formData, fieldNames);
+}

packages/utils/src/types.ts

@@ -1157,4 +1157,6 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
    * @returns - The `PathSchema` object for the `schema`
    */
   toPathSchema(schema: S, name?: string, formData?: T): PathSchema<T>;
+
+  omitExtraData(schema: S, formData?: T, retrievedSchema?: S): T | undefined;
 }