[core, form] Simplify Merger type

Author: x0k

.changeset/cyan-panthers-refuse.md

@@ -0,0 +1,6 @@
+---
+"@sjsf/form": patch
+"docs": patch
+---
+
+Simplify `Merger` type

apps/docs/src/content/docs/advanced/state-transformation.mdx

@@ -25,28 +25,27 @@ It will be replaced with `@sjsf/form/omit-extra-data` import in the major releas
 
 ```svelte
 <script lang="ts">
-  import { Form, DefaultMerger } from "@sjsf/form";
+  import { defaultMerger } from '@sjsf/form/core'
+  import { Form } from "@sjsf/form";
   import { translation } from "@sjsf/form/translations/en";
   import { theme } from "@sjsf/form/basic-theme";
   import { omitExtraData2 } from "@sjsf/form/legacy-omit-extra-data";
 
   import { schema, uiSchema, initialData } from "./schema";
   import { validator } from "./validator";
   import { transform } from "./transform";
-
-  const merger = new DefaultMerger(validator, schema);
+  
   let value = $state();
 </script>
 
 <Form
   bind:value
   {...theme}
-  {merger}
   {schema}
   {uiSchema}
   {validator}
   {translation}
-  getSnapshot={() => omitExtraData2(validator, merger, schema, $state.snapshot(value))}
+  getSnapshot={() => omitExtraData2(validator, defaultMerger, schema, $state.snapshot(value))}
   onSubmit={(value) => {
     console.log("transformed", value);
   }}

apps/docs/src/content/docs/api-reference/merger.mdx

@@ -5,11 +5,14 @@ sidebar:
 ---
 
 ```typescript
-export interface Merger {
+interface Merger2 {
   /**
    * Merges schema and its `allOf` schemas into a single schema
    */
   mergeAllOf(schema: Schema): Schema;
+}
+
+interface FormMerger extends Merger2 {
   /**
    * Merges defaults of `schema` into `formData`
    */

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

@@ -1,20 +1,19 @@
-import mergeAllOf, { type Options } from "json-schema-merge-allof";
-
-import type { Merger } from "./merger.js";
+import { defaultMerger, type Merger } from "./merger.js";
 import type { Schema, SchemaValue } from "./schema.js";
 import type { Validator } from "./validator.js";
 import { getDefaultFormState2 } from "./default-state.js";
 
+/**
+ * @deprecated use `DefaultFormMerger` from `@sjsf/form`
+ */
 export class DefaultMerger implements Merger {
   constructor(
     protected readonly validator: Validator,
     protected readonly rootSchema: Schema
   ) {}
 
   mergeAllOf(schema: Schema): Schema {
-    return mergeAllOf(schema, {
-      deep: false,
-    } as Options) as Schema;
+    return defaultMerger.mergeAllOf(schema);
   }
 
   mergeFormDataAndSchemaDefaults(

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

@@ -22,15 +22,12 @@ import { RECURSIVE_REF, RECURSIVE_REF_ALLOF } from "./fixtures/test-data.js";
 import type { Validator } from "./validator.js";
 import type { Schema } from "./schema.js";
 import { makeTestValidator } from "./test-validator.js";
-import { DefaultMerger } from './default-merger.js';
-import type { Merger } from './merger.js';
+import { defaultMerger } from './merger.js';
 
 let testValidator: Validator;
-let defaultMerger: Merger
 
 beforeEach(() => {
   testValidator = makeTestValidator();
-  defaultMerger = new DefaultMerger(testValidator, {});
 });
 
 describe("getDefaultFormState2()", () => {

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

@@ -25,8 +25,8 @@ import {
 import { getSimpleSchemaType } from "./type.js";
 import { isMultiSelect2 } from "./is-select.js";
 import { getClosestMatchingOption2 } from "./matching.js";
-import { DefaultMerger } from './default-merger.js';
-import type { Merger } from './merger.js';
+import { defaultMerger } from './merger.js';
+import type { Merger2 } from './merger.js';
 
 export function getDefaultValueForType(type: SchemaType) {
   switch (type) {
@@ -59,7 +59,7 @@ export function getDefaultFormState(
   rootSchema?: Schema,
   includeUndefinedValues: boolean | "excludeObjectChildren" = false,
   experimental_defaultFormStateBehavior?: Experimental_DefaultFormStateBehavior,
-  merger: Merger = new DefaultMerger(validator, rootSchema ?? theSchema)
+  merger: Merger2 = defaultMerger
 ): SchemaValue | undefined {
   return getDefaultFormState2(
     validator,
@@ -74,7 +74,7 @@ export function getDefaultFormState(
 
 export function getDefaultFormState2(
   validator: Validator,
-  merger: Merger,
+  merger: Merger2,
   theSchema: Schema,
   formData?: SchemaValue,
   rootSchema?: Schema,
@@ -188,7 +188,7 @@ export function computeDefaults<T extends SchemaValue>(
   validator: Validator,
   rawSchema: Schema,
   computeDefaultsProps?: ComputeDefaultsProps,
-  merger: Merger = new DefaultMerger(validator, rawSchema)
+  merger = defaultMerger
 ): SchemaValue | undefined {
   return computeDefaults2<T>(
     validator,
@@ -200,7 +200,7 @@ export function computeDefaults<T extends SchemaValue>(
 
 export function computeDefaults2<T extends SchemaValue>(
   validator: Validator,
-  merger: Merger,
+  merger: Merger2,
   rawSchema: Schema,
   {
     parentDefaults,

packages/form/src/core/is-file-schema.ts

@@ -2,8 +2,8 @@
 // Licensed under the Apache License, Version 2.0.
 // Modifications made by Roman Krasilnikov.
 
-import { DefaultMerger } from './default-merger.js';
-import type { Merger } from './merger.js';
+import { defaultMerger } from './merger.js';
+import type { Merger2 } from './merger.js';
 import { retrieveSchema2 } from "./resolve.js";
 import { DATA_URL_FORMAT, isNormalArrayItems, type Schema } from "./schema.js";
 import type { Validator } from "./validator.js";
@@ -19,14 +19,14 @@ export function isFilesArray(
   validator: Validator,
   schema: Schema,
   rootSchema?: Schema,
-  merger: Merger = new DefaultMerger(validator, rootSchema ?? schema)
+  merger = defaultMerger,
 ) {
   return isFilesArray2(validator, merger, schema, rootSchema);
 }
 
 export function isFilesArray2(
   validator: Validator,
-  merger: Merger,
+  merger: Merger2,
   schema: Schema,
   rootSchema?: Schema
 ) {

packages/form/src/core/is-select.test.ts

@@ -8,15 +8,12 @@ import type { Schema } from "./schema.js";
 import type { Validator } from "./validator.js";
 import { isMultiSelect2, isSelect2 } from "./is-select.js";
 import { makeTestValidator } from "./test-validator.js";
-import { DefaultMerger } from './default-merger.js';
-import type { Merger } from './merger.js';
+import { defaultMerger } from './merger.js';
 
 let testValidator: Validator;
-let defaultMerger: Merger
 
 beforeEach(() => {
   testValidator = makeTestValidator();
-  defaultMerger = new DefaultMerger(testValidator, {});
 });
 
 describe("isSelect2()", () => {

packages/form/src/core/is-select.ts

@@ -6,8 +6,7 @@ import type { Schema } from "./schema.js";
 import type { Validator } from "./validator.js";
 import { retrieveSchema2 } from "./resolve.js";
 import { isSchemaOfConstantValue } from "./constant-schema.js";
-import type { Merger } from "./merger.js";
-import { DefaultMerger } from "./default-merger.js";
+import { defaultMerger, type Merger2 } from "./merger.js";
 
 /**
  * @deprecated use `isSelect2`
@@ -16,14 +15,14 @@ export function isSelect(
   validator: Validator,
   theSchema: Schema,
   rootSchema: Schema,
-  merger: Merger = new DefaultMerger(validator, rootSchema)
+  merger = defaultMerger
 ) {
   return isSelect2(validator, merger, theSchema, rootSchema);
 }
 
 export function isSelect2(
   validator: Validator,
-  merger: Merger,
+  merger: Merger2,
   theSchema: Schema,
   rootSchema: Schema
 ) {
@@ -48,14 +47,14 @@ export function isMultiSelect(
   validator: Validator,
   schema: Schema,
   rootSchema: Schema,
-  merger: Merger = new DefaultMerger(validator, rootSchema)
+  merger = defaultMerger
 ) {
   return isMultiSelect2(validator, merger, schema, rootSchema);
 }
 
 export function isMultiSelect2(
   validator: Validator,
-  merger: Merger,
+  merger: Merger2,
   schema: Schema,
   rootSchema: Schema
 ) {

packages/form/src/core/matching.test.ts

@@ -17,18 +17,15 @@ import { calculateIndexScore2, getClosestMatchingOption2 } from "./matching.js";
 import { beforeEach, describe, expect, it } from "vitest";
 import type { Validator } from "./validator.js";
 import { makeTestValidator } from "./test-validator.js";
-import { DefaultMerger } from "./default-merger.js";
-import type { Merger } from './merger.js';
+import { defaultMerger } from './merger.js';
 
 const firstOption = oneOfSchema.definitions!.first_option_def as Schema;
 const secondOption = oneOfSchema.definitions!.second_option_def as Schema;
 
 let testValidator: Validator;
-let defaultMerger: Merger
 
 beforeEach(() => {
   testValidator = makeTestValidator();
-  defaultMerger = new DefaultMerger(testValidator, oneOfSchema);
 });
 
 describe("calculateIndexScore", () => {