@rjsf/utils 6.0.0-alpha.0 → 6.0.0-beta.1

package/lib/schema/getDefaultFormState.js

@@ -1,17 +1,23 @@
-import get from 'lodash/get';
-import isEmpty from 'lodash/isEmpty';
-import { ANY_OF_KEY, DEFAULT_KEY, DEPENDENCIES_KEY, PROPERTIES_KEY, ONE_OF_KEY, REF_KEY, ALL_OF_KEY, } from '../constants';
-import findSchemaDefinition from '../findSchemaDefinition';
-import getClosestMatchingOption from './getClosestMatchingOption';
-import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
-import getSchemaType from '../getSchemaType';
-import isObject from '../isObject';
-import isFixedItems from '../isFixedItems';
-import mergeDefaultsWithFormData from '../mergeDefaultsWithFormData';
-import mergeObjects from '../mergeObjects';
-import mergeSchemas from '../mergeSchemas';
-import isMultiSelect from './isMultiSelect';
-import retrieveSchema, { resolveDependencies } from './retrieveSchema';
+import get from 'lodash-es/get.js';
+import isEmpty from 'lodash-es/isEmpty.js';
+import { ALL_OF_KEY, ANY_OF_KEY, CONST_KEY, DEFAULT_KEY, DEPENDENCIES_KEY, ONE_OF_KEY, PROPERTIES_KEY, REF_KEY, } from '../constants.js';
+import findSchemaDefinition from '../findSchemaDefinition.js';
+import getClosestMatchingOption from './getClosestMatchingOption.js';
+import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema.js';
+import getSchemaType from '../getSchemaType.js';
+import isObject from '../isObject.js';
+import isFixedItems from '../isFixedItems.js';
+import mergeDefaultsWithFormData from '../mergeDefaultsWithFormData.js';
+import mergeObjects from '../mergeObjects.js';
+import mergeSchemas from '../mergeSchemas.js';
+import isMultiSelect from './isMultiSelect.js';
+import isSelect from './isSelect.js';
+import retrieveSchema, { resolveDependencies } from './retrieveSchema.js';
+import isConstant from '../isConstant.js';
+import constIsAjvDataReference from '../constIsAjvDataReference.js';
+import optionsList from '../optionsList.js';
+import deepEquals from '../deepEquals.js';
+const PRIMITIVE_TYPES = ['string', 'number', 'integer', 'boolean', 'null'];
 /** Enum that indicates how `schema.additionalItems` should be handled by the `getInnerSchemaForArrayItem()` function.
  */
 export var AdditionalItemsHandling;
@@ -70,24 +76,26 @@ export function getInnerSchemaForArrayItem(schema, additionalItems = AdditionalI
  * @param requiredFields - The list of fields that are required
  * @param experimental_defaultFormStateBehavior - Optional configuration object, if provided, allows users to override
  *        default form state behavior
+ * @param isConst - Optional flag, if true, indicates that the schema has a const property defined, thus we should always return the computedDefault since it's coming from the const.
  */
-function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValues, isParentRequired, requiredFields = [], experimental_defaultFormStateBehavior = {}) {
+function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValues, isParentRequired, requiredFields = [], experimental_defaultFormStateBehavior = {}, isConst = false) {
     const { emptyObjectFields = 'populateAllDefaults' } = experimental_defaultFormStateBehavior;
-    if (includeUndefinedValues) {
+    if (includeUndefinedValues || isConst) {
+        // If includeUndefinedValues
+        // Or if the schema has a const property defined, then we should always return the computedDefault since it's coming from the const.
         obj[key] = computedDefault;
     }
     else if (emptyObjectFields !== 'skipDefaults') {
+        // If isParentRequired is undefined, then we are at the root level of the schema so defer to the requiredness of
+        // the field key itself in the `requiredField` list
+        const isSelfOrParentRequired = isParentRequired === undefined ? requiredFields.includes(key) : isParentRequired;
         if (isObject(computedDefault)) {
-            // If isParentRequired is undefined, then we are at the root level of the schema so defer to the requiredness of
-            // the field key itself in the `requiredField` list
-            const isSelfOrParentRequired = isParentRequired === undefined ? requiredFields.includes(key) : isParentRequired;
             // If emptyObjectFields 'skipEmptyDefaults' store computedDefault if it's a non-empty object(e.g. not {})
             if (emptyObjectFields === 'skipEmptyDefaults') {
                 if (!isEmpty(computedDefault)) {
                     obj[key] = computedDefault;
                 }
-            }
-            // Else store computedDefault if it's a non-empty object(e.g. not {}) and satisfies certain conditions
+            } // Else store computedDefault if it's a non-empty object(e.g. not {}) and satisfies certain conditions
             // Condition 1: If computedDefault is not empty or if the key is a required field
             // Condition 2: If the parent object is required or emptyObjectFields is not 'populateRequiredDefaults'
             else if ((!isEmpty(computedDefault) || requiredFields.includes(key)) &&
@@ -98,11 +106,12 @@ function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValu
         else if (
         // Store computedDefault if it's a defined primitive (e.g., true) and satisfies certain conditions
         // Condition 1: computedDefault is not undefined
-        // Condition 2: If emptyObjectFields is 'populateAllDefaults' or 'skipEmptyDefaults) or if the key is a required field
+        // Condition 2: If emptyObjectFields is 'populateAllDefaults' or 'skipEmptyDefaults)
+        // Or if isSelfOrParentRequired is 'true' and the key is a required field
         computedDefault !== undefined &&
             (emptyObjectFields === 'populateAllDefaults' ||
                 emptyObjectFields === 'skipEmptyDefaults' ||
-                requiredFields.includes(key))) {
+                (isSelfOrParentRequired && requiredFields.includes(key)))) {
             obj[key] = computedDefault;
         }
     }
@@ -112,33 +121,32 @@ function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValu
  *
  * @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 [props] - Optional props for this function
- * @param [props.parentDefaults] - Any defaults provided by the parent field in the schema
- * @param [props.rootSchema] - The options root schema, used to primarily to look up `$ref`s
- * @param [props.rawFormData] - The current formData, if any, onto which to provide any missing defaults
- * @param [props.includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
- *          false when computing defaults for any nested object properties.
- * @param [props._recurseList=[]] - The list of ref names currently being recursed, used to prevent infinite recursion
- * @param [props.experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
- * @param [props.required] - Optional flag, if true, indicates this schema was required in the parent schema.
+ * @param {ComputeDefaultsProps} computeDefaultsProps - Optional props for this function
  * @returns - The resulting `formData` with all the defaults provided
  */
-export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormData, rootSchema = {}, includeUndefinedValues = false, _recurseList = [], experimental_defaultFormStateBehavior = undefined, required, } = {}) {
-    var _a, _b, _c, _d;
+export function computeDefaults(validator, rawSchema, computeDefaultsProps = {}) {
+    const { parentDefaults, rawFormData, rootSchema = {}, includeUndefinedValues = false, _recurseList = [], experimental_defaultFormStateBehavior = undefined, experimental_customMergeAllOf = undefined, required, shouldMergeDefaultsIntoFormData = false, } = computeDefaultsProps;
     const formData = (isObject(rawFormData) ? rawFormData : {});
     const schema = isObject(rawSchema) ? rawSchema : {};
     // Compute the defaults recursively: give highest priority to deepest nodes.
     let defaults = parentDefaults;
     // If we get a new schema, then we need to recompute defaults again for the new schema found.
     let schemaToCompute = null;
+    let experimental_dfsb_to_compute = experimental_defaultFormStateBehavior;
     let updatedRecurseList = _recurseList;
-    if (isObject(defaults) && isObject(schema.default)) {
+    if (schema[CONST_KEY] &&
+        (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.constAsDefaults) !== 'never' &&
+        !constIsAjvDataReference(schema)) {
+        defaults = schema[CONST_KEY];
+    }
+    else if (isObject(defaults) && isObject(schema.default)) {
         // For object defaults, only override parent defaults that are defined in
         // schema.default.
         defaults = mergeObjects(defaults, schema.default);
     }
-    else if (DEFAULT_KEY in schema) {
+    else if (DEFAULT_KEY in schema && !schema[ANY_OF_KEY] && !schema[ONE_OF_KEY]) {
+        // If the schema has a default value, then we should use it as the default.
+        // And if the schema does not have anyOf or oneOf, this is done because we need to merge the defaults with the formData.
         defaults = schema.default;
     }
     else if (REF_KEY in schema) {
@@ -150,7 +158,12 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
         }
     }
     else if (DEPENDENCIES_KEY in schema) {
-        const resolvedSchema = resolveDependencies(validator, schema, rootSchema, false, [], formData);
+        // Get the default if set from properties to ensure the dependencies conditions are resolved based on it
+        const defaultFormData = {
+            ...getDefaultBasedOnSchemaType(validator, schema, computeDefaultsProps, defaults),
+            ...formData,
+        };
+        const resolvedSchema = resolveDependencies(validator, schema, rootSchema, false, [], defaultFormData, experimental_customMergeAllOf);
         schemaToCompute = resolvedSchema[0]; // pick the first element from resolve dependencies
     }
     else if (isFixedItems(schema)) {
@@ -159,9 +172,11 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
             includeUndefinedValues,
             _recurseList,
             experimental_defaultFormStateBehavior,
+            experimental_customMergeAllOf,
             parentDefaults: Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined,
             rawFormData: formData,
             required,
+            shouldMergeDefaultsIntoFormData,
         }));
     }
     else if (ONE_OF_KEY in schema) {
@@ -170,7 +185,17 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
             return undefined;
         }
         const discriminator = getDiscriminatorFieldFromSchema(schema);
-        schemaToCompute = oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, oneOf, 0, discriminator)];
+        const { type = 'null' } = remaining;
+        if (!Array.isArray(type) &&
+            PRIMITIVE_TYPES.includes(type) &&
+            (experimental_dfsb_to_compute === null || experimental_dfsb_to_compute === void 0 ? void 0 : experimental_dfsb_to_compute.constAsDefaults) === 'skipOneOf') {
+            // If we are in a oneOf of a primitive type, then we want to pass constAsDefaults as 'never' for the recursion
+            experimental_dfsb_to_compute = {
+                ...experimental_dfsb_to_compute,
+                constAsDefaults: 'never',
+            };
+        }
+        schemaToCompute = oneOf[getClosestMatchingOption(validator, rootSchema, rawFormData !== null && rawFormData !== void 0 ? rawFormData : schema.default, oneOf, 0, discriminator, experimental_customMergeAllOf)];
         schemaToCompute = mergeSchemas(remaining, schemaToCompute);
     }
     else if (ANY_OF_KEY in schema) {
@@ -179,7 +204,7 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
             return undefined;
         }
         const discriminator = getDiscriminatorFieldFromSchema(schema);
-        schemaToCompute = anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, anyOf, 0, discriminator)];
+        schemaToCompute = anyOf[getClosestMatchingOption(validator, rootSchema, rawFormData !== null && rawFormData !== void 0 ? rawFormData : schema.default, anyOf, 0, discriminator, experimental_customMergeAllOf)];
         schemaToCompute = mergeSchemas(remaining, schemaToCompute);
     }
     if (schemaToCompute) {
@@ -187,144 +212,253 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
             rootSchema,
             includeUndefinedValues,
             _recurseList: updatedRecurseList,
-            experimental_defaultFormStateBehavior,
+            experimental_defaultFormStateBehavior: experimental_dfsb_to_compute,
+            experimental_customMergeAllOf,
             parentDefaults: defaults,
             rawFormData: formData,
             required,
+            shouldMergeDefaultsIntoFormData,
         });
     }
     // No defaults defined for this node, fallback to generic typed ones.
     if (defaults === undefined) {
         defaults = schema.default;
     }
-    switch (getSchemaType(schema)) {
-        // We need to recurse for object schema inner default values.
-        case 'object': {
-            // This is a custom addition that fixes this issue:
-            // https://github.com/rjsf-team/react-jsonschema-form/issues/3832
-            const retrievedSchema = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.allOf) === 'populateDefaults' && ALL_OF_KEY in schema
-                ? retrieveSchema(validator, schema, rootSchema, formData)
-                : schema;
-            const objectDefaults = Object.keys(retrievedSchema.properties || {}).reduce((acc, key) => {
+    const defaultBasedOnSchemaType = getDefaultBasedOnSchemaType(validator, schema, computeDefaultsProps, defaults);
+    let defaultsWithFormData = defaultBasedOnSchemaType !== null && defaultBasedOnSchemaType !== void 0 ? defaultBasedOnSchemaType : defaults;
+    // if shouldMergeDefaultsIntoFormData is true, then merge the defaults into the formData.
+    if (shouldMergeDefaultsIntoFormData) {
+        const { arrayMinItems = {} } = experimental_defaultFormStateBehavior || {};
+        const { mergeExtraDefaults } = arrayMinItems;
+        const matchingFormData = ensureFormDataMatchingSchema(validator, schema, rootSchema, rawFormData, experimental_defaultFormStateBehavior, experimental_customMergeAllOf);
+        if (!isObject(rawFormData) || ALL_OF_KEY in schema) {
+            // If the formData is not an object which means it's a primitive field, then we need to merge the defaults into the formData.
+            // Or if the schema has allOf, we need to merge the defaults into the formData because we don't compute the defaults for allOf.
+            defaultsWithFormData = mergeDefaultsWithFormData(defaultsWithFormData, matchingFormData, mergeExtraDefaults, true);
+        }
+    }
+    return defaultsWithFormData;
+}
+/**
+ * Ensure that the formData matches the given schema. If it's not matching in the case of a selectField, we change it to match the schema.
+ *
+ * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
+ * @param schema - The schema for which the formData state is desired
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param formData - The current formData
+ * @param [experimental_defaultFormStateBehavior] - Optional configuration object, if provided, allows users to override default form state behavior
+ * @param [experimental_customMergeAllOf] - Optional function that allows for custom merging of `allOf` schemas
+ * @returns - valid formData that matches schema
+ */
+export function ensureFormDataMatchingSchema(validator, schema, rootSchema, formData, experimental_defaultFormStateBehavior, experimental_customMergeAllOf) {
+    const isSelectField = !isConstant(schema) && isSelect(validator, schema, rootSchema, experimental_customMergeAllOf);
+    let validFormData = formData;
+    if (isSelectField) {
+        const getOptionsList = optionsList(schema);
+        const isValid = getOptionsList === null || getOptionsList === void 0 ? void 0 : getOptionsList.some((option) => deepEquals(option.value, formData));
+        validFormData = isValid ? formData : undefined;
+    }
+    // Override the formData with the const if the constAsDefaults is set to always
+    const constTakesPrecedence = schema[CONST_KEY] && (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.constAsDefaults) === 'always';
+    if (constTakesPrecedence) {
+        validFormData = schema.const;
+    }
+    return validFormData;
+}
+/** Computes the default value for objects.
+ *
+ * @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 defaults - Optional props for this function
+ * @returns - The default value based on the schema type if they are defined for object or array schemas.
+ */
+export function getObjectDefaults(validator, rawSchema, { rawFormData, rootSchema = {}, includeUndefinedValues = false, _recurseList = [], experimental_defaultFormStateBehavior = undefined, experimental_customMergeAllOf = undefined, required, shouldMergeDefaultsIntoFormData, } = {}, defaults) {
+    {
+        const formData = (isObject(rawFormData) ? rawFormData : {});
+        const schema = rawSchema;
+        // This is a custom addition that fixes this issue:
+        // https://github.com/rjsf-team/react-jsonschema-form/issues/3832
+        const retrievedSchema = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.allOf) === 'populateDefaults' && ALL_OF_KEY in schema
+            ? retrieveSchema(validator, schema, rootSchema, formData, experimental_customMergeAllOf)
+            : schema;
+        const parentConst = retrievedSchema[CONST_KEY];
+        const objectDefaults = Object.keys(retrievedSchema.properties || {}).reduce((acc, key) => {
+            var _a;
+            const propertySchema = get(retrievedSchema, [PROPERTIES_KEY, key], {});
+            // Check if the parent 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 hasParentConst = isObject(parentConst) && parentConst[key] !== undefined;
+            const hasConst = ((isObject(propertySchema) && CONST_KEY in propertySchema) || hasParentConst) &&
+                (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.constAsDefaults) !== 'never' &&
+                !constIsAjvDataReference(propertySchema);
+            // Compute the defaults for this node, with the parent defaults we might
+            // have from a previous run: defaults[key].
+            const computedDefault = computeDefaults(validator, propertySchema, {
+                rootSchema,
+                _recurseList,
+                experimental_defaultFormStateBehavior,
+                experimental_customMergeAllOf,
+                includeUndefinedValues: includeUndefinedValues === true,
+                parentDefaults: get(defaults, [key]),
+                rawFormData: get(formData, [key]),
+                required: (_a = retrievedSchema.required) === null || _a === void 0 ? void 0 : _a.includes(key),
+                shouldMergeDefaultsIntoFormData,
+            });
+            maybeAddDefaultToObject(acc, key, computedDefault, includeUndefinedValues, required, retrievedSchema.required, experimental_defaultFormStateBehavior, hasConst);
+            return acc;
+        }, {});
+        if (retrievedSchema.additionalProperties) {
+            // as per spec additionalProperties may be either schema or boolean
+            const additionalPropertiesSchema = isObject(retrievedSchema.additionalProperties)
+                ? retrievedSchema.additionalProperties
+                : {};
+            const keys = new Set();
+            if (isObject(defaults)) {
+                Object.keys(defaults)
+                    .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
+                    .forEach((key) => keys.add(key));
+            }
+            const formDataRequired = [];
+            Object.keys(formData)
+                .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
+                .forEach((key) => {
+                keys.add(key);
+                formDataRequired.push(key);
+            });
+            keys.forEach((key) => {
                 var _a;
-                // Compute the defaults for this node, with the parent defaults we might
-                // have from a previous run: defaults[key].
-                const computedDefault = computeDefaults(validator, get(retrievedSchema, [PROPERTIES_KEY, key]), {
+                const computedDefault = computeDefaults(validator, additionalPropertiesSchema, {
                     rootSchema,
                     _recurseList,
                     experimental_defaultFormStateBehavior,
+                    experimental_customMergeAllOf,
                     includeUndefinedValues: includeUndefinedValues === true,
                     parentDefaults: get(defaults, [key]),
                     rawFormData: get(formData, [key]),
                     required: (_a = retrievedSchema.required) === null || _a === void 0 ? void 0 : _a.includes(key),
+                    shouldMergeDefaultsIntoFormData,
                 });
-                maybeAddDefaultToObject(acc, key, computedDefault, includeUndefinedValues, required, retrievedSchema.required, experimental_defaultFormStateBehavior);
-                return acc;
-            }, {});
-            if (retrievedSchema.additionalProperties) {
-                // as per spec additionalProperties may be either schema or boolean
-                const additionalPropertiesSchema = isObject(retrievedSchema.additionalProperties)
-                    ? retrievedSchema.additionalProperties
-                    : {};
-                const keys = new Set();
-                if (isObject(defaults)) {
-                    Object.keys(defaults)
-                        .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
-                        .forEach((key) => keys.add(key));
-                }
-                const formDataRequired = [];
-                Object.keys(formData)
-                    .filter((key) => !retrievedSchema.properties || !retrievedSchema.properties[key])
-                    .forEach((key) => {
-                    keys.add(key);
-                    formDataRequired.push(key);
-                });
-                keys.forEach((key) => {
-                    var _a;
-                    const computedDefault = computeDefaults(validator, additionalPropertiesSchema, {
-                        rootSchema,
-                        _recurseList,
-                        experimental_defaultFormStateBehavior,
-                        includeUndefinedValues: includeUndefinedValues === true,
-                        parentDefaults: get(defaults, [key]),
-                        rawFormData: get(formData, [key]),
-                        required: (_a = retrievedSchema.required) === null || _a === void 0 ? void 0 : _a.includes(key),
-                    });
-                    // Since these are additional properties we don't need to add the `experimental_defaultFormStateBehavior` prop
-                    maybeAddDefaultToObject(objectDefaults, key, computedDefault, includeUndefinedValues, required, formDataRequired);
-                });
-            }
-            return objectDefaults;
+                // Since these are additional properties we don't need to add the `experimental_defaultFormStateBehavior` prop
+                maybeAddDefaultToObject(objectDefaults, key, computedDefault, includeUndefinedValues, required, formDataRequired);
+            });
         }
-        case 'array': {
-            const neverPopulate = ((_a = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === null || _a === void 0 ? void 0 : _a.populate) === 'never';
-            const ignoreMinItemsFlagSet = ((_b = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === null || _b === void 0 ? void 0 : _b.populate) === 'requiredOnly';
-            const isSkipEmptyDefaults = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.emptyObjectFields) === 'skipEmptyDefaults';
-            const computeSkipPopulate = (_d = (_c = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === null || _c === void 0 ? void 0 : _c.computeSkipPopulate) !== null && _d !== void 0 ? _d : (() => false);
-            const emptyDefault = isSkipEmptyDefaults ? undefined : [];
-            // Inject defaults into existing array defaults
-            if (Array.isArray(defaults)) {
-                defaults = defaults.map((item, idx) => {
-                    const schemaItem = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Fallback, idx);
-                    return computeDefaults(validator, schemaItem, {
-                        rootSchema,
-                        _recurseList,
-                        experimental_defaultFormStateBehavior,
-                        parentDefaults: item,
-                        required,
-                    });
-                });
-            }
-            // Deeply inject defaults into already existing form data
-            if (Array.isArray(rawFormData)) {
-                const schemaItem = getInnerSchemaForArrayItem(schema);
-                if (neverPopulate) {
-                    defaults = rawFormData;
-                }
-                else {
-                    defaults = rawFormData.map((item, idx) => {
-                        return computeDefaults(validator, schemaItem, {
-                            rootSchema,
-                            _recurseList,
-                            experimental_defaultFormStateBehavior,
-                            rawFormData: item,
-                            parentDefaults: get(defaults, [idx]),
-                            required,
-                        });
-                    });
-                }
-            }
-            if (neverPopulate) {
-                return defaults !== null && defaults !== void 0 ? 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;
-            }
-            const defaultsLength = Array.isArray(defaults) ? defaults.length : 0;
-            if (!schema.minItems ||
-                isMultiSelect(validator, schema, rootSchema) ||
-                computeSkipPopulate(validator, schema, rootSchema) ||
-                schema.minItems <= defaultsLength) {
-                return defaults ? defaults : emptyDefault;
-            }
-            const defaultEntries = (defaults || []);
-            const fillerSchema = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Invert);
-            const fillerDefault = fillerSchema.default;
-            // Calculate filler entries for remaining items (minItems - existing raw data/defaults)
-            const fillerEntries = new Array(schema.minItems - defaultsLength).fill(computeDefaults(validator, fillerSchema, {
-                parentDefaults: fillerDefault,
+        return objectDefaults;
+    }
+}
+/** Computes the default value for arrays.
+ *
+ * @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 defaults - Optional props for this function
+ * @returns - The default value based on the schema type if they are defined for object or array schemas.
+ */
+export function getArrayDefaults(validator, rawSchema, { rawFormData, rootSchema = {}, _recurseList = [], experimental_defaultFormStateBehavior = undefined, experimental_customMergeAllOf = undefined, required, shouldMergeDefaultsIntoFormData, } = {}, defaults) {
+    var _a, _b;
+    const schema = rawSchema;
+    const arrayMinItemsStateBehavior = (_a = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) !== null && _a !== void 0 ? _a : {};
+    const { populate: arrayMinItemsPopulate, mergeExtraDefaults: arrayMergeExtraDefaults } = arrayMinItemsStateBehavior;
+    const neverPopulate = arrayMinItemsPopulate === 'never';
+    const ignoreMinItemsFlagSet = arrayMinItemsPopulate === 'requiredOnly';
+    const isPopulateAll = arrayMinItemsPopulate === 'all' || (!neverPopulate && !ignoreMinItemsFlagSet);
+    const computeSkipPopulate = (_b = arrayMinItemsStateBehavior === null || arrayMinItemsStateBehavior === void 0 ? void 0 : arrayMinItemsStateBehavior.computeSkipPopulate) !== null && _b !== void 0 ? _b : (() => false);
+    const isSkipEmptyDefaults = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.emptyObjectFields) === 'skipEmptyDefaults';
+    const emptyDefault = isSkipEmptyDefaults ? undefined : [];
+    // Inject defaults into existing array defaults
+    if (Array.isArray(defaults)) {
+        defaults = defaults.map((item, idx) => {
+            const schemaItem = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Fallback, idx);
+            return computeDefaults(validator, schemaItem, {
                 rootSchema,
                 _recurseList,
                 experimental_defaultFormStateBehavior,
+                experimental_customMergeAllOf,
+                parentDefaults: item,
                 required,
-            }));
-            // then fill up the rest with either the item default or empty, up to minItems
-            return defaultEntries.concat(fillerEntries);
+                shouldMergeDefaultsIntoFormData,
+            });
+        });
+    }
+    // Deeply inject defaults into already existing form data
+    if (Array.isArray(rawFormData)) {
+        const schemaItem = getInnerSchemaForArrayItem(schema);
+        if (neverPopulate) {
+            defaults = rawFormData;
+        }
+        else {
+            const itemDefaults = rawFormData.map((item, idx) => {
+                return computeDefaults(validator, schemaItem, {
+                    rootSchema,
+                    _recurseList,
+                    experimental_defaultFormStateBehavior,
+                    experimental_customMergeAllOf,
+                    rawFormData: item,
+                    parentDefaults: get(defaults, [idx]),
+                    required,
+                    shouldMergeDefaultsIntoFormData,
+                });
+            });
+            // If the populate 'requiredOnly' flag is set then we only merge and include extra defaults if they are required.
+            // Or if populate 'all' is set we merge and include extra defaults.
+            const mergeExtraDefaults = ((ignoreMinItemsFlagSet && required) || isPopulateAll) && arrayMergeExtraDefaults;
+            defaults = mergeDefaultsWithFormData(defaults, itemDefaults, mergeExtraDefaults);
+        }
+    }
+    // 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 === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.constAsDefaults) !== 'never';
+    if (hasConst === false) {
+        if (neverPopulate) {
+            return defaults !== null && defaults !== void 0 ? 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;
+        }
+    }
+    const defaultsLength = Array.isArray(defaults) ? defaults.length : 0;
+    if (!schema.minItems ||
+        isMultiSelect(validator, schema, rootSchema, experimental_customMergeAllOf) ||
+        computeSkipPopulate(validator, schema, rootSchema) ||
+        schema.minItems <= defaultsLength) {
+        return defaults ? defaults : emptyDefault;
+    }
+    const defaultEntries = (defaults || []);
+    const fillerSchema = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Invert);
+    const fillerDefault = fillerSchema.default;
+    // Calculate filler entries for remaining items (minItems - existing raw data/defaults)
+    const fillerEntries = new Array(schema.minItems - defaultsLength).fill(computeDefaults(validator, fillerSchema, {
+        parentDefaults: fillerDefault,
+        rootSchema,
+        _recurseList,
+        experimental_defaultFormStateBehavior,
+        experimental_customMergeAllOf,
+        required,
+        shouldMergeDefaultsIntoFormData,
+    }));
+    // then fill up the rest with either the item default or empty, up to minItems
+    return defaultEntries.concat(fillerEntries);
+}
+/** Computes the default value based on the schema type.
+ *
+ * @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 defaults - Optional props for this function
+ * @returns - The default value based on the schema type if they are defined for object or array schemas.
+ */
+export function getDefaultBasedOnSchemaType(validator, rawSchema, computeDefaultsProps = {}, defaults) {
+    switch (getSchemaType(rawSchema)) {
+        // We need to recurse for object schema inner default values.
+        case 'object': {
+            return getObjectDefaults(validator, rawSchema, computeDefaultsProps, defaults);
+        }
+        case 'array': {
+            return getArrayDefaults(validator, rawSchema, computeDefaultsProps, defaults);
         }
     }
-    return defaults;
 }
 /** Returns the superset of `formData` that includes the given set updated to include any missing fields that have
  * computed to have defaults provided in the `schema`.
@@ -337,30 +471,34 @@ export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormD
  *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
  *          false when computing defaults for any nested object properties.
  * @param [experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
+ * @param [experimental_customMergeAllOf] - Optional function that allows for custom merging of `allOf` schemas
  * @returns - The resulting `formData` with all the defaults provided
  */
-export default function getDefaultFormState(validator, theSchema, formData, rootSchema, includeUndefinedValues = false, experimental_defaultFormStateBehavior) {
+export default function getDefaultFormState(validator, theSchema, formData, rootSchema, includeUndefinedValues = false, experimental_defaultFormStateBehavior, experimental_customMergeAllOf) {
     if (!isObject(theSchema)) {
         throw new Error('Invalid schema: ' + theSchema);
     }
-    const schema = retrieveSchema(validator, theSchema, rootSchema, formData);
+    const schema = retrieveSchema(validator, theSchema, rootSchema, formData, experimental_customMergeAllOf);
+    // Get the computed defaults with 'shouldMergeDefaultsIntoFormData' set to true to merge defaults into formData.
+    // This is done when for example the value from formData does not exist in the schema 'enum' property, in such
+    // cases we take the value from the defaults because the value from the formData is not valid.
     const defaults = computeDefaults(validator, schema, {
         rootSchema,
         includeUndefinedValues,
         experimental_defaultFormStateBehavior,
+        experimental_customMergeAllOf,
         rawFormData: formData,
+        shouldMergeDefaultsIntoFormData: true,
     });
-    if (formData === undefined || formData === null || (typeof formData === 'number' && isNaN(formData))) {
-        // No form data? Use schema defaults.
-        return defaults;
-    }
-    const { mergeExtraDefaults } = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) || {};
-    if (isObject(formData)) {
-        return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
+    // 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 (isObject(formData) || Array.isArray(formData)) {
+        const { mergeDefaultsIntoFormData } = experimental_defaultFormStateBehavior || {};
+        const defaultSupercedesUndefined = mergeDefaultsIntoFormData === 'useDefaultIfFormDataUndefined';
+        const result = mergeDefaultsWithFormData(defaults, formData, true, // set to true to add any additional default array entries.
+        defaultSupercedesUndefined, true);
+        return result;
     }
-    if (Array.isArray(formData)) {
-        return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
-    }
-    return formData;
+    return defaults;
 }
 //# sourceMappingURL=getDefaultFormState.js.map