[core] Port rjsf-team/react-jsonschema-form#4637

Author: x0k

.changeset/early-wings-tell.md

@@ -0,0 +1,5 @@
+---
+"@sjsf/form": patch
+---
+
+Port https://github.com/rjsf-team/react-jsonschema-form/pull/4637

packages/form/src/core/default-state.test.ts

@@ -1807,6 +1807,32 @@ describe("getDefaultFormState2()", () => {
       });
     });
 
+    describe("an object with a valid formData and enum property with default value", () => {
+      test("getDefaultFormState", () => {
+        const schema: Schema = {
+          type: "object",
+          properties: {
+            test: {
+              type: "string",
+              enum: [
+                { label: "a", value: "a" },
+                { label: "b", value: "b" },
+              ],
+              default: { label: "a", value: "a" },
+            },
+          },
+        };
+
+        expect(
+          getDefaultFormState(testValidator, defaultMerger, schema, {
+            test: { label: "b", value: "b" },
+          })
+        ).toEqual({
+          test: { label: "b", value: "b" },
+        });
+      });
+    });
+
     describe("oneOf with const values", () => {
       const schema: Schema = {
         type: "object",
@@ -2549,6 +2575,26 @@ describe("getDefaultFormState2()", () => {
         )
       ).toEqual("a");
     });
+    it("Test schema with valid formData with an enum and its default value", () => {
+      schema = {
+        type: "string",
+        enum: [
+          { label: "a", value: "a" },
+          { label: "b", value: "b" },
+        ],
+        default: { label: "a", value: "a" },
+      };
+
+      expect(
+        getDefaultFormState(testValidator, defaultMerger, schema, {
+          label: "b",
+          value: "b",
+        })
+      ).toEqual({
+        label: "b",
+        value: "b",
+      });
+    });
   });
 
   // NOTE: We don't support AJV `$data` property
@@ -3926,7 +3972,7 @@ describe("getDefaultFormState2()", () => {
               ],
             },
             value: { leaf1: "a" },
-            result: true
+            result: true,
           },
         ],
       });

packages/form/src/core/default-state.ts

@@ -86,6 +86,20 @@ export function getDefaultFormState(
     shouldMergeDefaultsIntoFormData: true,
   });
 
+  // WARN: How about fixed arrays?
+  if (
+    schema.type !== "object" &&
+    isSchemaObjectValue(schema.default) &&
+    // CHANGED: Added those conditions for typesafety, while original intentions is unknown
+    (defaults === undefined || typeof defaults === "object") &&
+    (formData === undefined || typeof formData === "object")
+  ) {
+    return {
+      ...defaults,
+      ...formData,
+    };
+  }
+
   // If the formData is an object or an array, add additional properties from formData and override formData with
   // defaults since the defaults are already merged with formData.
   if (isSchemaObjectValue(formData) || Array.isArray(formData)) {

packages/form/src/core/merge.ts

@@ -166,10 +166,6 @@ export function mergeDefaultsWithFormData<T = any>(
   defaultsSupersedesUndefined = false,
   overrideFormDataWithDefaults = false
 ): T | undefined {
-  // NOTE: I missed the PR where this line was removed, but it is not present in 5.24.0
-  // if (formData === undefined && defaultsSupersedesUndefined) {
-  //   return defaults;
-  // }
   if (Array.isArray(formData)) {
     const defaultsArray = Array.isArray(defaults) ? defaults : [];
 
@@ -210,7 +206,20 @@ export function mergeDefaultsWithFormData<T = any>(
       : {};
     for (const [key, value] of Object.entries(formData)) {
       const keyExistsInDefaults = key in defaultsObject;
-      const keyExistsInFormData = key in formData;
+      const keyDefault = defaultsObject[key];
+
+      // NOTE: This code is bad, but maintaining compatibility with RSJF > "good" code
+      if (
+        isSchemaObjectValue(keyDefault) &&
+        isSchemaObjectValue(value) &&
+        !Object.values(keyDefault).some(isSchemaObjectValue)
+      ) {
+        acc[key as keyof T] = {
+          ...keyDefault,
+          ...value,
+        };
+        continue;
+      }
 
       acc[key as keyof T] = mergeDefaultsWithFormData(
         defaultsObject[key],
@@ -219,8 +228,10 @@ export function mergeDefaultsWithFormData<T = any>(
         defaultsSupersedesUndefined,
         // overrideFormDataWithDefaults can be true only when the key value exists in defaults
         // Or if the key value doesn't exist in formData
-        overrideFormDataWithDefaults &&
-          (keyExistsInDefaults || !keyExistsInFormData)
+        // CHANGED: key is always in form data, maybe this condition should be value === undefined
+        // overrideFormDataWithDefaults &&
+        //   (keyExistsInDefaults || !keyExistsInFormData)
+        overrideFormDataWithDefaults && keyExistsInDefaults
       );
     }
     return acc;