@rjsf/utils 6.5.2 → 6.6.0

package/src/removeOptionalEmptyObjects.ts

@@ -1,31 +1,6 @@
-import isNil from 'lodash/isNil';
-
 import isObject from './isObject';
+import { isValueEmpty, retrieveSchema } from './schema';
 import { FormContextType, GenericObjectType, RJSFSchema, StrictRJSFSchema, ValidatorType } from './types';
-import retrieveSchema from './schema/retrieveSchema';
-
-/** Determines whether a value is considered "empty" for the purposes of optional object pruning.
- * A value is empty if it is `undefined`, `null`, an empty string, or an object where all own
- * properties are themselves empty.
- *
- * @param value - The value to check
- * @returns True if the value is considered empty
- */
-function isValueEmpty(value: unknown): boolean {
-  if (isNil(value) || value === '') {
-    return true;
-  }
-  if (Array.isArray(value)) {
-    // An empty array is considered empty; a non-empty array is not
-    return value.length === 0;
-  }
-  if (isObject(value)) {
-    const obj = value as GenericObjectType;
-    const keys = Object.keys(obj);
-    return keys.every((key) => isValueEmpty(obj[key]));
-  }
-  return false;
-}
 
 /** Recursively removes optional objects from the `formData` that are empty (i.e., all their fields
  * are undefined, null, empty strings, or themselves empty optional objects). This solves the problem
@@ -41,7 +16,10 @@ function isValueEmpty(value: unknown): boolean {
  * @param [formData] - The current form data to prune
  * @returns - A new copy of `formData` with empty optional objects removed, or `undefined` if the
  *           entire formData was pruned
+ * @deprecated - This function will be removed in a future release. The equivalent pruning behavior
+ *   is now built into `omitExtraData` — use that instead.
  */
+// eslint-disable-next-line @typescript-eslint/no-deprecated
 export default function removeOptionalEmptyObjects<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
@@ -65,6 +43,7 @@ export default function removeOptionalEmptyObjects<
       if (Array.isArray(itemsSchema)) {
         itemSchema = itemsSchema[index] || (resolvedSchema.additionalItems as S) || ({} as S);
       }
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
       const cleaned = removeOptionalEmptyObjects<T, S, F>(validator, itemSchema, rootSchema, item);
       if (cleaned !== item) {
         hasChanges = true;
@@ -97,6 +76,7 @@ export default function removeOptionalEmptyObjects<
 
     if ((isObj || isArr) && properties[key]) {
       // Recursively process nested objects and arrays
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
       const cleaned = removeOptionalEmptyObjects<T, S, F>(validator, propertySchema, rootSchema, value as T);
 
       if (!isRequired && isValueEmpty(cleaned)) {
@@ -106,10 +86,8 @@ export default function removeOptionalEmptyObjects<
 
       result[key] = cleaned;
       hasAnyValue = true;
-    } else if (!isRequired && isValueEmpty(value) && properties[key]) {
-      // Optional scalar property that is empty — omit it
-      continue;
-    } else {
+    } else if (isRequired || !isValueEmpty(value) || !properties[key]) {
+      // Keep: required, non-empty, or not schema-defined; skip optional empty scalars silently
       result[key] = value;
       if (!isValueEmpty(value)) {
         hasAnyValue = true;

package/src/schema/findFieldInSchema.ts

@@ -1,17 +1,18 @@
 import get from 'lodash/get';
 import has from 'lodash/has';
 
-import findSelectedOptionInXxxOf from './findSelectedOptionInXxxOf';
-import getFromSchema from './getFromSchema';
 import { ANY_OF_KEY, ONE_OF_KEY, PROPERTIES_KEY, REQUIRED_KEY } from '../constants';
 import {
   Experimental_CustomMergeAllOf,
   FormContextType,
   FoundFieldType,
   RJSFSchema,
+  SchemaFieldPath,
   StrictRJSFSchema,
   ValidatorType,
 } from '../types';
+import findSelectedOptionInXxxOf from './findSelectedOptionInXxxOf';
+import getFromSchema from './getFromSchema';
 
 /** Unique schema that represents no schema was found, exported for testing purposes */
 export const NOT_FOUND_SCHEMA = { title: '!@#$_UNKNOWN_$#@!' };
@@ -37,7 +38,7 @@ export default function findFieldInSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   formData: T = {} as T,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): FoundFieldType<S> {
@@ -46,6 +47,7 @@ export default function findFieldInSchema<
 
   // store the desired field into a variable and removing it from the `pathList`
   const fieldName = pathList.pop()!;
+  const fieldNameKey = String(fieldName);
 
   if (pathList.length) {
     // drilling into the schema for each sub-path and taking into account of the any/oneOfs
@@ -64,7 +66,7 @@ export default function findFieldInSchema<
           validator,
           rootSchema,
           parentField,
-          fieldName,
+          fieldNameKey,
           ONE_OF_KEY,
           get(formData, subPath),
           experimental_customMergeAllOf,
@@ -75,7 +77,7 @@ export default function findFieldInSchema<
           validator,
           rootSchema,
           parentField,
-          fieldName,
+          fieldNameKey,
           ANY_OF_KEY,
           get(formData, subPath),
           experimental_customMergeAllOf,
@@ -90,7 +92,7 @@ export default function findFieldInSchema<
       validator,
       rootSchema,
       parentField,
-      fieldName,
+      fieldNameKey,
       ONE_OF_KEY,
       formData,
       experimental_customMergeAllOf,
@@ -101,7 +103,7 @@ export default function findFieldInSchema<
       validator,
       rootSchema,
       parentField,
-      fieldName,
+      fieldNameKey,
       ANY_OF_KEY,
       formData,
       experimental_customMergeAllOf,
@@ -131,7 +133,7 @@ export default function findFieldInSchema<
   );
   let isRequired: boolean | undefined;
   if (field && Array.isArray(requiredArray)) {
-    isRequired = requiredArray.includes(fieldName);
+    isRequired = requiredArray.includes(fieldNameKey);
   }
 
   return { field, isRequired };

package/src/schema/findSelectedOptionInXxxOf.ts

@@ -2,9 +2,9 @@ import get from 'lodash/get';
 
 import { CONST_KEY, DEFAULT_KEY, PROPERTIES_KEY } from '../constants';
 import deepEquals from '../deepEquals';
+import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import retrieveSchema from './retrieveSchema';
-import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 
 /** Finds the option inside the `schema['any/oneOf']` list which has the `properties[selectorField].default` or
  * `properties[selectorField].const` that matches the `formData[selectorField]` value. For the purposes of this

package/src/schema/getClosestMatchingOption.ts

@@ -6,13 +6,13 @@ import isString from 'lodash/isString';
 import reduce from 'lodash/reduce';
 import times from 'lodash/times';
 
-import getFirstMatchingOption from './getFirstMatchingOption';
-import retrieveSchema, { resolveAllReferences } from './retrieveSchema';
 import { ONE_OF_KEY, REF_KEY, JUNK_OPTION_ID, ANY_OF_KEY } from '../constants';
-import guessType from '../guessType';
-import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 import getOptionMatchingSimpleDiscriminator from '../getOptionMatchingSimpleDiscriminator';
+import guessType from '../guessType';
+import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+import getFirstMatchingOption from './getFirstMatchingOption';
+import retrieveSchema, { resolveAllReferences } from './retrieveSchema';
 
 /** A junk option used to determine when the getFirstMatchingOption call really matches an option rather than returning
  * the first item

package/src/schema/getDefaultFormState.ts

@@ -1,6 +1,6 @@
+import { JSONSchema7Object } from 'json-schema';
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
-import { JSONSchema7Object } from 'json-schema';
 
 import {
   ALL_OF_KEY,
@@ -13,15 +13,18 @@ import {
   PROPERTIES_KEY,
   REF_KEY,
 } from '../constants';
+import constIsAjvDataReference from '../constIsAjvDataReference';
+import deepEquals from '../deepEquals';
 import findSchemaDefinition from '../findSchemaDefinition';
-import getClosestMatchingOption from './getClosestMatchingOption';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 import getSchemaType from '../getSchemaType';
-import isObject from '../isObject';
+import isConstant from '../isConstant';
 import isFixedItems from '../isFixedItems';
+import isObject from '../isObject';
 import mergeDefaultsWithFormData from '../mergeDefaultsWithFormData';
 import mergeObjects from '../mergeObjects';
 import mergeSchemas from '../mergeSchemas';
+import optionsList from '../optionsList';
 import {
   Experimental_CustomMergeAllOf,
   Experimental_DefaultFormStateBehavior,
@@ -31,13 +34,10 @@ import {
   StrictRJSFSchema,
   ValidatorType,
 } from '../types';
+import getClosestMatchingOption from './getClosestMatchingOption';
 import isMultiSelect from './isMultiSelect';
 import isSelect from './isSelect';
 import retrieveSchema, { resolveDependencies } from './retrieveSchema';
-import isConstant from '../isConstant';
-import constIsAjvDataReference from '../constIsAjvDataReference';
-import optionsList from '../optionsList';
-import deepEquals from '../deepEquals';
 
 const PRIMITIVE_TYPES = ['string', 'number', 'integer', 'boolean', 'null'];
 
@@ -218,7 +218,7 @@ interface ComputeDefaultsProps<T = any, S extends StrictRJSFSchema = RJSFSchema>
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
  * @param rawSchema - The schema for which the default state is desired
- * @param {ComputeDefaultsProps} computeDefaultsProps - Optional props for this function
+ * @param computeDefaultsProps - Optional props for this function
  * @returns - The resulting `formData` with all the defaults provided
  */
 export function computeDefaults<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
@@ -465,7 +465,7 @@ export function ensureFormDataMatchingSchema<
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
  * @param rawSchema - The schema for which the default state is desired
- * @param {ComputeDefaultsProps} computeDefaultsProps - Optional props for this function
+ * @param computeDefaultsProps - Optional props for this function
  * @param defaults - Optional props for this function
  * @returns - The default value based on the schema type if they are defined for object or array schemas.
  */
@@ -594,7 +594,7 @@ export function getObjectDefaults<T = any, S extends StrictRJSFSchema = RJSFSche
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
  * @param rawSchema - The schema for which the default state is desired
- * @param {ComputeDefaultsProps} computeDefaultsProps - Optional props for this function
+ * @param computeDefaultsProps - Optional props for this function
  * @param defaults - Optional props for this function
  * @returns - The default value based on the schema type if they are defined for object or array schemas.
  */
@@ -673,19 +673,13 @@ export function getArrayDefaults<T = any, S extends StrictRJSFSchema = RJSFSchem
     }
   }
 
-  // Check if the schema has a const property defined AND we are supporting const as defaults, then we should always
-  // return the computedDefault since it's coming from the const.
-  const hasConst =
-    isObject(schema) && CONST_KEY in schema && experimental_defaultFormStateBehavior?.constAsDefaults !== 'never';
-  if (hasConst === false) {
-    if (neverPopulate) {
-      return defaults ?? emptyDefault;
-    }
-    if (ignoreMinItemsFlagSet && !required) {
-      // If no form data exists or defaults are set leave the field empty/non-existent, otherwise
-      // return form data/defaults
-      return defaults ? defaults : undefined;
-    }
+  if (neverPopulate) {
+    return defaults ?? emptyDefault;
+  }
+  if (ignoreMinItemsFlagSet && !required) {
+    // If no form data exists or defaults are set leave the field empty/non-existent, otherwise
+    // return form data/defaults
+    return defaults ? defaults : undefined;
   }
 
   let arrayDefault: T[] | undefined;
@@ -726,7 +720,7 @@ export function getArrayDefaults<T = any, S extends StrictRJSFSchema = RJSFSchem
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
  * @param rawSchema - The schema for which the default state is desired
- * @param {ComputeDefaultsProps} computeDefaultsProps - Optional props for this function
+ * @param computeDefaultsProps - Optional props for this function
  * @param defaults - Optional props for this function
  * @returns - The default value based on the schema type if they are defined for object or array schemas.
  */

package/src/schema/getFromSchema.ts

@@ -2,9 +2,16 @@ import get from 'lodash/get';
 import has from 'lodash/has';
 import isEmpty from 'lodash/isEmpty';
 
-import retrieveSchema from './retrieveSchema';
-import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import { REF_KEY } from '../constants';
+import {
+  Experimental_CustomMergeAllOf,
+  FormContextType,
+  RJSFSchema,
+  SchemaFieldPath,
+  StrictRJSFSchema,
+  ValidatorType,
+} from '../types';
+import retrieveSchema from './retrieveSchema';
 
 /** Internal helper function that acts like lodash's `get` but additionally retrieves `$ref`s as needed to get the path
  * for schemas containing potentially nested `$ref`s.
@@ -20,7 +27,7 @@ function getFromSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T | S | undefined {
   let fieldSchema = schema;
@@ -30,9 +37,9 @@ function getFromSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
   if (isEmpty(path)) {
     return fieldSchema;
   }
-  const pathList = Array.isArray(path) ? path : path.split('.');
+  const pathList = Array.isArray(path) ? [...path] : path.split('.');
   const [part, ...nestedPath] = pathList;
-  if (part && has(fieldSchema, part)) {
+  if (part !== undefined && part !== '' && has(fieldSchema, part)) {
     fieldSchema = get(fieldSchema, part) as S;
     return getFromSchemaInternal<T, S, F>(
       validator,
@@ -64,7 +71,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: T,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T;
@@ -76,7 +83,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: S,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): S;
@@ -88,7 +95,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: T | S,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T | S {

package/src/schema/index.ts

@@ -1,15 +1,15 @@
 import findFieldInSchema from './findFieldInSchema';
 import findSelectedOptionInXxxOf from './findSelectedOptionInXxxOf';
+import getClosestMatchingOption from './getClosestMatchingOption';
 import getDefaultFormState from './getDefaultFormState';
 import getDisplayLabel from './getDisplayLabel';
-import getClosestMatchingOption from './getClosestMatchingOption';
 import getFirstMatchingOption from './getFirstMatchingOption';
 import getFromSchema from './getFromSchema';
 import isFilesArray from './isFilesArray';
 import isMultiSelect from './isMultiSelect';
 import isSelect from './isSelect';
-import omitExtraData, { getUsedFormData, getFieldNames } from './omitExtraData';
-import retrieveSchema from './retrieveSchema';
+import omitExtraData, { getUsedFormData, getFieldNames, isValueEmpty } from './omitExtraData';
+import retrieveSchema, { relaxOptionsForScoring } from './retrieveSchema';
 import sanitizeDataForNewSchema from './sanitizeDataForNewSchema';
 import toPathSchema from './toPathSchema';
 
@@ -26,7 +26,9 @@ export {
   isFilesArray,
   isMultiSelect,
   isSelect,
+  isValueEmpty,
   omitExtraData,
+  relaxOptionsForScoring,
   retrieveSchema,
   sanitizeDataForNewSchema,
   toPathSchema,

package/src/schema/isMultiSelect.ts

@@ -1,5 +1,4 @@
 import { FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType, Experimental_CustomMergeAllOf } from '../types';
-
 import isSelect from './isSelect';
 
 /** Checks to see if the `schema` combination represents a multi-select