@rjsf/utils 5.8.2 → 5.10.0

package/dist/utils.esm.js

@@ -523,11 +523,12 @@ function mergeSchemas(obj1, obj2) {
   }, acc);
 }
 
-var _excluded$1 = ["if", "then", "else"],
-  _excluded2 = ["$ref"],
+var _excluded$2 = ["if", "then", "else"],
+  _excluded2$1 = ["$ref"],
   _excluded3 = ["allOf"],
-  _excluded4 = ["dependencies"],
-  _excluded5 = ["oneOf"];
+  _excluded4 = ["oneOf", "anyOf"],
+  _excluded5 = ["dependencies"],
+  _excluded6 = ["oneOf"];
 /** Retrieves an expanded schema that has had all of its conditions, additional properties, references and dependencies
  * resolved and merged into the `schema` given a `validator`, `rootSchema` and `rawFormData` that is used to do the
  * potentially recursive resolution.
@@ -560,7 +561,7 @@ function resolveCondition(validator, schema, rootSchema, expandAllBranches, form
   var expression = schema["if"],
     then = schema.then,
     otherwise = schema["else"],
-    resolvedSchemaLessConditional = _objectWithoutPropertiesLoose(schema, _excluded$1);
+    resolvedSchemaLessConditional = _objectWithoutPropertiesLoose(schema, _excluded$2);
   var conditionValue = validator.isValid(expression, formData || {}, rootSchema);
   var resolvedSchemas = [resolvedSchemaLessConditional];
   var schemas = [];
@@ -670,7 +671,7 @@ function resolveSchema(validator, schema, rootSchema, expandAllBranches, formDat
 function resolveReference(validator, schema, rootSchema, expandAllBranches, formData) {
   // Drop the $ref property of the source schema.
   var $ref = schema.$ref,
-    localSchema = _objectWithoutPropertiesLoose(schema, _excluded2);
+    localSchema = _objectWithoutPropertiesLoose(schema, _excluded2$1);
   // Retrieve the referenced schema definition.
   var refSchema = findSchemaDefinition($ref, rootSchema);
   // Update referenced schema definition with local schema properties.
@@ -752,9 +753,9 @@ function retrieveSchemaInternal(validator, schema, rootSchema, rawFormData, expa
     if (IF_KEY in resolvedSchema) {
       return resolveCondition(validator, resolvedSchema, rootSchema, expandAllBranches, rawFormData);
     }
-    if (ALL_OF_KEY in schema) {
+    if (ALL_OF_KEY in resolvedSchema) {
       try {
-        resolvedSchema = mergeAllOf(s, {
+        resolvedSchema = mergeAllOf(resolvedSchema, {
           deep: false
         });
       } catch (e) {
@@ -789,10 +790,14 @@ function retrieveSchemaInternal(validator, schema, rootSchema, rawFormData, expa
  */
 function resolveAnyOrOneOfSchemas(validator, schema, rootSchema, expandAllBranches, rawFormData) {
   var anyOrOneOf;
-  if (Array.isArray(schema.oneOf)) {
-    anyOrOneOf = schema.oneOf;
-  } else if (Array.isArray(schema.anyOf)) {
-    anyOrOneOf = schema.anyOf;
+  var _schema = schema,
+    oneOf = _schema.oneOf,
+    anyOf = _schema.anyOf,
+    remaining = _objectWithoutPropertiesLoose(_schema, _excluded4);
+  if (Array.isArray(oneOf)) {
+    anyOrOneOf = oneOf;
+  } else if (Array.isArray(anyOf)) {
+    anyOrOneOf = anyOf;
   }
   if (anyOrOneOf) {
     // Ensure that during expand all branches we pass an object rather than undefined so that all options are interrogated
@@ -808,9 +813,11 @@ function resolveAnyOrOneOfSchemas(validator, schema, rootSchema, expandAllBranch
     // Call this to trigger the set of isValid() calls that the schema parser will need
     var option = getFirstMatchingOption(validator, formData, anyOrOneOf, rootSchema, discriminator);
     if (expandAllBranches) {
-      return anyOrOneOf;
+      return anyOrOneOf.map(function (item) {
+        return _extends({}, remaining, item);
+      });
     }
-    schema = anyOrOneOf[option];
+    schema = _extends({}, remaining, anyOrOneOf[option]);
   }
   return [schema];
 }
@@ -828,7 +835,7 @@ function resolveAnyOrOneOfSchemas(validator, schema, rootSchema, expandAllBranch
 function resolveDependencies(validator, schema, rootSchema, expandAllBranches, formData) {
   // Drop the dependencies from the source schema.
   var dependencies = schema.dependencies,
-    remainingSchema = _objectWithoutPropertiesLoose(schema, _excluded4);
+    remainingSchema = _objectWithoutPropertiesLoose(schema, _excluded5);
   var resolvedSchemas = resolveAnyOrOneOfSchemas(validator, remainingSchema, rootSchema, expandAllBranches, formData);
   return resolvedSchemas.flatMap(function (resolvedSchema) {
     return processDependencies(validator, dependencies, resolvedSchema, rootSchema, expandAllBranches, formData);
@@ -911,7 +918,7 @@ function withDependentSchema(validator, schema, rootSchema, dependencyKey, depen
   var dependentSchemas = retrieveSchemaInternal(validator, dependencyValue, rootSchema, formData, expandAllBranches);
   return dependentSchemas.flatMap(function (dependent) {
     var oneOf = dependent.oneOf,
-      dependentSchema = _objectWithoutPropertiesLoose(dependent, _excluded5);
+      dependentSchema = _objectWithoutPropertiesLoose(dependent, _excluded6);
     schema = mergeSchemas(schema, dependentSchema);
     // Since it does not contain oneOf, we return the original schema.
     if (oneOf === undefined) {
@@ -1026,8 +1033,10 @@ function calculateIndexScore(validator, rootSchema, schema, formData) {
           var newSchema = retrieveSchema(validator, value, rootSchema, formValue);
           return score + calculateIndexScore(validator, rootSchema, newSchema, formValue || {});
         }
-        if (has(value, ONE_OF_KEY) && formValue) {
-          return score + getClosestMatchingOption(validator, rootSchema, formValue, get(value, ONE_OF_KEY));
+        if ((has(value, ONE_OF_KEY) || has(value, ANY_OF_KEY)) && formValue) {
+          var _key = has(value, ONE_OF_KEY) ? ONE_OF_KEY : ANY_OF_KEY;
+          var discriminator = getDiscriminatorFieldFromSchema(value);
+          return score + getClosestMatchingOption(validator, rootSchema, formValue, get(value, _key), -1, discriminator);
         }
         if (value.type === 'object') {
           return score + calculateIndexScore(validator, rootSchema, value, formValue || {});
@@ -1081,8 +1090,15 @@ function getClosestMatchingOption(validator, rootSchema, formData, options, sele
   if (selectedOption === void 0) {
     selectedOption = -1;
   }
+  // First resolve any refs in the options
+  var resolvedOptions = options.map(function (option) {
+    if (has(option, REF_KEY)) {
+      return retrieveSchema(validator, option, rootSchema, formData);
+    }
+    return option;
+  });
   // Reduce the array of options down to a list of the indexes that are considered matching options
-  var allValidIndexes = options.reduce(function (validList, option, index) {
+  var allValidIndexes = resolvedOptions.reduce(function (validList, option, index) {
     var testOptions = [JUNK_OPTION, option];
     var match = getFirstMatchingOption(validator, formData, testOptions, rootSchema, discriminatorField);
     // The match is the real option, so add its index to list of valid indexes
@@ -1097,7 +1113,7 @@ function getClosestMatchingOption(validator, rootSchema, formData, options, sele
   }
   if (!allValidIndexes.length) {
     // No indexes were valid, so we'll score all the options, add all the indexes
-    times(options.length, function (i) {
+    times(resolvedOptions.length, function (i) {
       return allValidIndexes.push(i);
     });
   }
@@ -1105,10 +1121,7 @@ function getClosestMatchingOption(validator, rootSchema, formData, options, sele
   // Score all the options in the list of valid indexes and return the index with the best score
   var _allValidIndexes$redu = allValidIndexes.reduce(function (scoreData, index) {
       var bestScore = scoreData.bestScore;
-      var option = options[index];
-      if (has(option, REF_KEY)) {
-        option = retrieveSchema(validator, option, rootSchema, formData);
-      }
+      var option = resolvedOptions[index];
       var score = calculateIndexScore(validator, rootSchema, option, formData);
       scoreCount.add(score);
       if (score > bestScore) {
@@ -1148,29 +1161,38 @@ function isFixedItems(schema) {
  * - objects are deeply merged
  * - arrays are merged in such a way that:
  *   - when the array is set in form data, only array entries set in form data
- *     are deeply merged; additional entries from the defaults are ignored
+ *     are deeply merged; additional entries from the defaults are ignored unless `mergeExtraArrayDefaults` is true, in
+ *     which case the extras are appended onto the end of the form data
  *   - when the array is not set in form data, the default is copied over
  * - scalars are overwritten/set by form data
  *
  * @param [defaults] - The defaults to merge
  * @param [formData] - The form data into which the defaults will be merged
+ * @param [mergeExtraArrayDefaults=false] - If true, any additional default array entries are appended onto the formData
  * @returns - The resulting merged form data with defaults
  */
-function mergeDefaultsWithFormData(defaults, formData) {
+function mergeDefaultsWithFormData(defaults, formData, mergeExtraArrayDefaults) {
+  if (mergeExtraArrayDefaults === void 0) {
+    mergeExtraArrayDefaults = false;
+  }
   if (Array.isArray(formData)) {
     var defaultsArray = Array.isArray(defaults) ? defaults : [];
     var mapped = formData.map(function (value, idx) {
       if (defaultsArray[idx]) {
-        return mergeDefaultsWithFormData(defaultsArray[idx], value);
+        return mergeDefaultsWithFormData(defaultsArray[idx], value, mergeExtraArrayDefaults);
       }
       return value;
     });
+    // Merge any extra defaults when mergeExtraArrayDefaults is true
+    if (mergeExtraArrayDefaults && mapped.length < defaultsArray.length) {
+      mapped.push.apply(mapped, defaultsArray.slice(mapped.length));
+    }
     return mapped;
   }
   if (isObject(formData)) {
     var acc = Object.assign({}, defaults); // Prevent mutation of source object.
     return Object.keys(formData).reduce(function (acc, key) {
-      acc[key] = mergeDefaultsWithFormData(defaults ? get(defaults, key) : {}, get(formData, key));
+      acc[key] = mergeDefaultsWithFormData(defaults ? get(defaults, key) : {}, get(formData, key), mergeExtraArrayDefaults);
       return acc;
     }, acc);
   }
@@ -1261,6 +1283,8 @@ function isMultiSelect(validator, schema, rootSchema) {
   return isSelect(validator, schema.items, rootSchema);
 }
 
+var _excluded$1 = ["oneOf"],
+  _excluded2 = ["anyOf"];
 /** Enum that indicates how `schema.additionalItems` should be handled by the `getInnerSchemaForArrayItem()` function.
  */
 var AdditionalItemsHandling;
@@ -1339,10 +1363,13 @@ function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValu
     obj[key] = computedDefault;
   } else if (emptyObjectFields !== 'skipDefaults') {
     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
+      var isSelfOrParentRequired = isParentRequired === undefined ? requiredFields.includes(key) : isParentRequired;
       // 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'
-      if ((!isEmpty(computedDefault) || requiredFields.includes(key)) && (isParentRequired || emptyObjectFields !== 'populateRequiredDefaults')) {
+      if ((!isEmpty(computedDefault) || requiredFields.includes(key)) && (isSelfOrParentRequired || emptyObjectFields !== 'populateRequiredDefaults')) {
         obj[key] = computedDefault;
       }
     } else if (
@@ -1383,8 +1410,7 @@ function computeDefaults(validator, rawSchema, _temp) {
     _recurseList = _ref$_recurseList === void 0 ? [] : _ref$_recurseList,
     _ref$experimental_def = _ref.experimental_defaultFormStateBehavior,
     experimental_defaultFormStateBehavior = _ref$experimental_def === void 0 ? undefined : _ref$experimental_def,
-    _ref$required = _ref.required,
-    required = _ref$required === void 0 ? false : _ref$required;
+    required = _ref.required;
   var formData = isObject(rawFormData) ? rawFormData : {};
   var schema = isObject(rawSchema) ? rawSchema : {};
   // Compute the defaults recursively: give highest priority to deepest nodes.
@@ -1416,21 +1442,28 @@ function computeDefaults(validator, rawSchema, _temp) {
         _recurseList: _recurseList,
         experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior,
         parentDefaults: Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined,
-        rawFormData: formData
+        rawFormData: formData,
+        required: required
       });
     });
   } else if (ONE_OF_KEY in schema) {
-    if (schema.oneOf.length === 0) {
+    var oneOf = schema.oneOf,
+      remaining = _objectWithoutPropertiesLoose(schema, _excluded$1);
+    if (oneOf.length === 0) {
       return undefined;
     }
     var discriminator = getDiscriminatorFieldFromSchema(schema);
-    schemaToCompute = schema.oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, schema.oneOf, 0, discriminator)];
+    schemaToCompute = oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, oneOf, 0, discriminator)];
+    schemaToCompute = _extends({}, remaining, schemaToCompute);
   } else if (ANY_OF_KEY in schema) {
-    if (schema.anyOf.length === 0) {
+    var anyOf = schema.anyOf,
+      _remaining = _objectWithoutPropertiesLoose(schema, _excluded2);
+    if (anyOf.length === 0) {
       return undefined;
     }
     var _discriminator = getDiscriminatorFieldFromSchema(schema);
-    schemaToCompute = schema.anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, schema.anyOf, 0, _discriminator)];
+    schemaToCompute = anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, anyOf, 0, _discriminator)];
+    schemaToCompute = _extends({}, _remaining, schemaToCompute);
   }
   if (schemaToCompute) {
     return computeDefaults(validator, schemaToCompute, {
@@ -1439,7 +1472,8 @@ function computeDefaults(validator, rawSchema, _temp) {
       _recurseList: updatedRecurseList,
       experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior,
       parentDefaults: defaults,
-      rawFormData: formData
+      rawFormData: formData,
+      required: required
     });
   }
   // No defaults defined for this node, fallback to generic typed ones.
@@ -1506,6 +1540,7 @@ function computeDefaults(validator, rawSchema, _temp) {
       }
     case 'array':
       {
+        var _experimental_default3;
         // Inject defaults into existing array defaults
         if (Array.isArray(defaults)) {
           defaults = defaults.map(function (item, idx) {
@@ -1514,7 +1549,8 @@ function computeDefaults(validator, rawSchema, _temp) {
               rootSchema: rootSchema,
               _recurseList: _recurseList,
               experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior,
-              parentDefaults: item
+              parentDefaults: item,
+              required: required
             });
           });
         }
@@ -1527,11 +1563,12 @@ function computeDefaults(validator, rawSchema, _temp) {
               _recurseList: _recurseList,
               experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior,
               rawFormData: item,
-              parentDefaults: get(defaults, [idx])
+              parentDefaults: get(defaults, [idx]),
+              required: required
             });
           });
         }
-        var ignoreMinItemsFlagSet = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === 'requiredOnly';
+        var ignoreMinItemsFlagSet = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : (_experimental_default3 = experimental_defaultFormStateBehavior.arrayMinItems) === null || _experimental_default3 === void 0 ? void 0 : _experimental_default3.populate) === 'requiredOnly';
         if (ignoreMinItemsFlagSet && !required) {
           // If no form data exists or defaults are set leave the field empty/non-existent, otherwise
           // return form data/defaults
@@ -1549,7 +1586,8 @@ function computeDefaults(validator, rawSchema, _temp) {
           parentDefaults: fillerDefault,
           rootSchema: rootSchema,
           _recurseList: _recurseList,
-          experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior
+          experimental_defaultFormStateBehavior: experimental_defaultFormStateBehavior,
+          required: required
         }));
         // then fill up the rest with either the item default or empty, up to minItems
         return defaultEntries.concat(fillerEntries);
@@ -1588,11 +1626,13 @@ function getDefaultFormState(validator, theSchema, formData, rootSchema, include
     // No form data? Use schema defaults.
     return defaults;
   }
+  var _ref2 = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) || {},
+    mergeExtraDefaults = _ref2.mergeExtraDefaults;
   if (isObject(formData)) {
-    return mergeDefaultsWithFormData(defaults, formData);
+    return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
   }
   if (Array.isArray(formData)) {
-    return mergeDefaultsWithFormData(defaults, formData);
+    return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
   }
   return formData;
 }