[form] Refactor field default state generation

Author: x0k

.changeset/ten-lines-prove.md

@@ -0,0 +1,6 @@
+---
+"@sjsf/form": major
+---
+
+- Reuse merger options definition in `getDefaultFieldState` parameters
+- Move `includeUndefinedValues` option from merger instance to `mergeFormDataAndSchemaDefaults` method options

packages/form/src/fields/array/context.svelte.ts

@@ -118,7 +118,7 @@ function createItems<T>({
         return;
       }
       keyed.push(
-        getDefaultFieldState(ctx, schema, undefined) ??
+        getDefaultFieldState(ctx, { schema, formData: undefined }) ??
           getDefaultValueForType(getSimpleSchemaType(schema))
       );
       onChange();

packages/form/src/fields/combination.svelte

@@ -100,13 +100,14 @@
         previousSelectedOption !== undefined
           ? retrievedOptions[previousSelectedOption]
           : undefined;
-      return getDefaultFieldState(
-        ctx,
-        nextSchema,
-        oldSchema !== undefined
-          ? sanitizeDataForNewSchema(ctx, nextSchema, oldSchema, value)
-          : value
-      );
+      return getDefaultFieldState(ctx, {
+        schema: nextSchema,
+        formData:
+          oldSchema !== undefined
+            ? sanitizeDataForNewSchema(ctx, nextSchema, oldSchema, value)
+            : value,
+        includeUndefinedValues: "excludeObjectChildren",
+      });
     });
     previousSelectedOption = nextSelected;
   });

packages/form/src/fields/object/context.svelte.ts

@@ -54,7 +54,7 @@ export interface ObjectContext {
     property: string,
     isAdditional: boolean
   ) => Config;
-};
+}
 
 export const [getObjectContext, setObjectContext] =
   createContext<ObjectContext>();
@@ -208,7 +208,10 @@ export function createObjectContext<T>({
         : additionalPropertyKey(newKeyPrefix, 0);
       const additionalPropertySchema = getAdditionalPropertySchema(val, newKey);
       const propValue =
-        getDefaultFieldState(ctx, additionalPropertySchema, undefined) ??
+        getDefaultFieldState(ctx, {
+          schema: additionalPropertySchema,
+          formData: undefined,
+        }) ??
         getDefaultValueForType(getSimpleSchemaType(additionalPropertySchema));
       if (val) {
         val[newKey] = propValue;

packages/form/src/form/create-form.svelte.ts

@@ -311,7 +311,6 @@ export function createForm<T>(options: FormOptions<T>): FormState<T> {
           merger.mergeFormDataAndSchemaDefaults({
             formData: options.initialValue as FormValue,
             schema: options.schema,
-            initialDefaultsGenerated: false,
           })
         )
   );
@@ -519,7 +518,6 @@ export function createForm<T>(options: FormOptions<T>): FormState<T> {
     valueRef.current = merger.mergeFormDataAndSchemaDefaults({
       formData: options.initialValue as FormValue,
       schema: options.schema,
-      initialDefaultsGenerated: false,
     });
     options.onReset?.(e);
   }

packages/form/src/form/merger.ts

@@ -3,7 +3,14 @@ import type { Merger, Schema, SchemaValue } from "@/core/index.js";
 export interface MergeFormDataAndSchemaDefaultsOptions {
   schema: Schema;
   formData: SchemaValue | undefined;
-  initialDefaultsGenerated: boolean;
+  /**
+   * @default false
+   */
+  initialDefaultsGenerated?: boolean;
+  /**
+   * @default false
+   */
+  includeUndefinedValues?: boolean | "excludeObjectChildren";
 }
 
 export interface FormMerger extends Merger {

packages/form/src/form/state/schema.ts

@@ -9,6 +9,7 @@ import {
   getClosestMatchingOption as getClosestMatchingOptionInternal,
 } from "@/core/index.js";
 
+import type { MergeFormDataAndSchemaDefaultsOptions } from "../merger.js";
 import {
   FORM_MARK_SCHEMA_CHANGE,
   FORM_MERGER,
@@ -115,14 +116,9 @@ export function getClosestMatchingOption<T>(
  */
 export function getDefaultFieldState<T>(
   ctx: FormState<T>,
-  schema: Schema,
-  formData: SchemaValue | undefined
+  options: MergeFormDataAndSchemaDefaultsOptions
 ) {
-  return ctx[FORM_MERGER].mergeFormDataAndSchemaDefaults({
-    formData,
-    schema,
-    initialDefaultsGenerated: false,
-  });
+  return ctx[FORM_MERGER].mergeFormDataAndSchemaDefaults(options);
 }
 
 export function markSchemaChange<T>(ctx: FormState<T>) {

packages/form/src/mergers/legacy.ts

@@ -174,7 +174,6 @@ export function createMerger(): Merger {
 export type FormMergerOptions = Experimental_DefaultFormStateBehavior & {
   validator: Validator;
   schema: Schema;
-  includeUndefinedValues?: boolean | "excludeObjectChildren";
 };
 
 export function createFormMerger(options: FormMergerOptions): FormMerger {
@@ -184,15 +183,16 @@ export function createFormMerger(options: FormMergerOptions): FormMerger {
     mergeFormDataAndSchemaDefaults({
       formData,
       schema,
-      initialDefaultsGenerated,
+      initialDefaultsGenerated = false,
+      includeUndefinedValues = false
     }) {
       return getDefaultFormState(
         options.validator,
         merger,
         schema,
         formData,
         options.schema,
-        options.includeUndefinedValues,
+        includeUndefinedValues,
         options,
         initialDefaultsGenerated
       );

packages/form/src/mergers/modern.ts

@@ -37,7 +37,6 @@ export interface FormMergerOptions
     MergerOptions {
   validator: Validator;
   schema: Schema;
-  includeUndefinedValues?: boolean | "excludeObjectChildren";
 }
 
 export function createFormMerger(options: FormMergerOptions): FormMerger {
@@ -47,15 +46,16 @@ export function createFormMerger(options: FormMergerOptions): FormMerger {
     mergeFormDataAndSchemaDefaults({
       formData,
       schema,
-      initialDefaultsGenerated,
+      initialDefaultsGenerated = false,
+      includeUndefinedValues = false
     }) {
       return getDefaultFormState(
         options.validator,
         merger,
         schema,
         formData,
         options.schema,
-        options.includeUndefinedValues,
+        includeUndefinedValues,
         options,
         initialDefaultsGenerated
       );