@rjsf/utils 6.5.1 → 6.5.2

package/lib/useDeepCompareMemo.js

@@ -1,6 +1,6 @@
 'use client';
 import { useRef } from 'react';
-import isEqual from 'lodash-es/isEqual.js';
+import deepEquals from './deepEquals.js';
 /** Hook that stores and returns a `T` value. If `newValue` is the same as the stored one, then the stored one is
  * returned to avoid having a component rerender due it being a different object. Otherwise, the `newValue` is stored
  * and returned.
@@ -10,7 +10,7 @@ import isEqual from 'lodash-es/isEqual.js';
  */
 export default function useDeepCompareMemo(newValue) {
     const valueRef = useRef(newValue);
-    if (!isEqual(newValue, valueRef.current)) {
+    if (!deepEquals(newValue, valueRef.current)) {
         valueRef.current = newValue;
     }
     return valueRef.current;

package/lib/useDeepCompareMemo.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeepCompareMemo.js","sourceRoot":"","sources":["../src/useDeepCompareMemo.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAc,QAAW;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAI,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzC,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC"}
+{"version":3,"file":"useDeepCompareMemo.js","sourceRoot":"","sources":["../src/useDeepCompareMemo.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAc,QAAW;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAI,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5C,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "6.5.1",
+  "version": "6.5.2",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -66,6 +66,7 @@
   },
   "dependencies": {
     "@x0k/json-schema-merge": "^1.0.3",
+    "fast-equals": "^6.0.0",
     "fast-uri": "^3.1.0",
     "jsonpointer": "^5.0.1",
     "lodash": "^4.18.1",

package/src/deepEquals.ts

@@ -1,19 +1,20 @@
-import isEqualWith from 'lodash/isEqualWith';
+import { createCustomEqual } from 'fast-equals';
 
-/** Implements a deep equals using the `lodash.isEqualWith` function, that provides a customized comparator that
- * assumes all functions are equivalent.
+/** Implements a deep equals using `fast-equals.createCustomEqual`. Functions
+ * are always considered equal, and circular references are tracked to avoid
+ * infinite recursion on self-referential inputs.
  *
  * @param a - The first element to compare
  * @param b - The second element to compare
  * @returns - True if the `a` and `b` are deeply equal, false otherwise
  */
-export default function deepEquals(a: any, b: any): boolean {
-  return isEqualWith(a, b, (obj: any, other: any) => {
-    if (typeof obj === 'function' && typeof other === 'function') {
-      // Assume all functions are equivalent
-      // see https://github.com/rjsf-team/react-jsonschema-form/issues/255
-      return true;
-    }
-    return undefined; // fallback to default isEquals behavior
-  });
-}
+const deepEquals = createCustomEqual({
+  circular: true,
+  createCustomConfig: () => ({
+    areFunctionsEqual(_a, b) {
+      return typeof b === 'function';
+    },
+  }),
+});
+
+export default deepEquals;

package/src/isRootSchema.ts

@@ -1,6 +1,6 @@
-import isEqual from 'lodash/isEqual';
 import omit from 'lodash/omit';
 
+import deepEquals from './deepEquals';
 import { FormContextType, Registry, RJSFSchema, StrictRJSFSchema } from './types';
 import { REF_KEY, RJSF_REF_KEY } from './constants';
 
@@ -20,12 +20,12 @@ export default function isRootSchema<T = any, S extends StrictRJSFSchema = RJSFS
   schemaToCompare: S,
 ): boolean {
   const { rootSchema, schemaUtils } = registry;
-  if (isEqual(schemaToCompare, rootSchema)) {
+  if (deepEquals(schemaToCompare, rootSchema)) {
     return true;
   }
   if (REF_KEY in rootSchema) {
     const resolvedSchema = schemaUtils.retrieveSchema(rootSchema);
-    return isEqual(schemaToCompare, omit(resolvedSchema, RJSF_REF_KEY));
+    return deepEquals(schemaToCompare, omit(resolvedSchema, RJSF_REF_KEY));
   }
   return false;
 }

package/src/schema/findSelectedOptionInXxxOf.ts

@@ -1,7 +1,7 @@
 import get from 'lodash/get';
-import isEqual from 'lodash/isEqual';
 
 import { CONST_KEY, DEFAULT_KEY, PROPERTIES_KEY } from '../constants';
+import deepEquals from '../deepEquals';
 import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import retrieveSchema from './retrieveSchema';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
@@ -42,7 +42,7 @@ export default function findSelectedOptionInXxxOf<
     const data = get(formData, selectorField);
     if (data !== undefined) {
       return xxxOfs.find((xxx) => {
-        return isEqual(
+        return deepEquals(
           get(xxx, [PROPERTIES_KEY, selectorField, DEFAULT_KEY], get(xxx, [PROPERTIES_KEY, selectorField, CONST_KEY])),
           data,
         );

package/src/schema/getDefaultFormState.ts

@@ -547,11 +547,6 @@ export function getObjectDefaults<T = any, S extends StrictRJSFSchema = RJSFSche
         : {};
 
       const keys = new Set<string>();
-      if (isObject(defaults)) {
-        Object.keys(defaults as GenericObjectType)
-          .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
-          .forEach((key) => keys.add(key));
-      }
       const formDataRequired: string[] = [];
       Object.keys(formData as GenericObjectType)
         .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
@@ -559,6 +554,14 @@ export function getObjectDefaults<T = any, S extends StrictRJSFSchema = RJSFSche
           keys.add(key);
           formDataRequired.push(key);
         });
+      // Only seed keys from schema defaults when formData has no additionalProperties of its own.
+      // If the user already has data (e.g. after a key rename), injecting default keys would
+      // re-add stale entries that no longer exist in formData.
+      if (isObject(defaults) && formDataRequired.length === 0) {
+        Object.keys(defaults as GenericObjectType)
+          .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
+          .forEach((key) => keys.add(key));
+      }
       keys.forEach((key) => {
         const computedDefault = computeDefaults(validator, additionalPropertiesSchema as S, {
           rootSchema,

package/src/useDeepCompareMemo.ts

@@ -1,7 +1,8 @@
 'use client';
 
 import { useRef } from 'react';
-import isEqual from 'lodash/isEqual';
+
+import deepEquals from './deepEquals';
 
 /** Hook that stores and returns a `T` value. If `newValue` is the same as the stored one, then the stored one is
  * returned to avoid having a component rerender due it being a different object. Otherwise, the `newValue` is stored
@@ -12,7 +13,7 @@ import isEqual from 'lodash/isEqual';
  */
 export default function useDeepCompareMemo<T = unknown>(newValue: T): T {
   const valueRef = useRef<T>(newValue);
-  if (!isEqual(newValue, valueRef.current)) {
+  if (!deepEquals(newValue, valueRef.current)) {
     valueRef.current = newValue;
   }
   return valueRef.current;