@rjsf/utils 5.5.2 → 5.6.0

package/dist/utils.esm.js

@@ -1,3 +1,4 @@
+import isPlainObject from 'lodash-es/isPlainObject';
 import isEqualWith from 'lodash-es/isEqualWith';
 import get from 'lodash-es/get';
 import isEmpty from 'lodash-es/isEmpty';
@@ -16,6 +17,7 @@ import cloneDeep from 'lodash-es/cloneDeep';
 import { jsx } from 'react/jsx-runtime';
 import { createElement } from 'react';
 import ReactIs from 'react-is';
+import toPath from 'lodash-es/toPath';
 
 /** Determines whether a `thing` is an object for the purposes of RSJF. In this case, `thing` is an object if it has
  * the type `object` but is NOT null, an array or a File.
@@ -167,6 +169,7 @@ var REQUIRED_KEY = 'required';
 var SUBMIT_BTN_OPTIONS_KEY = 'submitButtonOptions';
 var REF_KEY = '$ref';
 var RJSF_ADDITONAL_PROPERTIES_FLAG = '__rjsf_additionalProperties';
+var ROOT_SCHEMA_PREFIX = '__rjsf_rootSchema';
 var UI_FIELD_KEY = 'ui:field';
 var UI_WIDGET_KEY = 'ui:widget';
 var UI_OPTIONS_KEY = 'ui:options';
@@ -232,6 +235,32 @@ function canExpand(schema, uiSchema, formData) {
   return true;
 }
 
+/** Given a `formData` object, recursively creates a `FormValidation` error handling structure around it
+ *
+ * @param formData - The form data around which the error handler is created
+ * @returns - A `FormValidation` object based on the `formData` structure
+ */
+function createErrorHandler(formData) {
+  var _handler;
+  var handler = (_handler = {}, _handler[ERRORS_KEY] = [], _handler.addError = function addError(message) {
+    this[ERRORS_KEY].push(message);
+  }, _handler);
+  if (Array.isArray(formData)) {
+    return formData.reduce(function (acc, value, key) {
+      var _extends2;
+      return _extends({}, acc, (_extends2 = {}, _extends2[key] = createErrorHandler(value), _extends2));
+    }, handler);
+  }
+  if (isPlainObject(formData)) {
+    var formObject = formData;
+    return Object.keys(formObject).reduce(function (acc, key) {
+      var _extends3;
+      return _extends({}, acc, (_extends3 = {}, _extends3[key] = createErrorHandler(formObject[key]), _extends3));
+    }, handler);
+  }
+  return handler;
+}
+
 /** Implements a deep equals using the `lodash.isEqualWith` function, that provides a customized comparator that
  * assumes all functions are equivalent.
  *
@@ -307,10 +336,12 @@ function findSchemaDefinition($ref, rootSchema) {
  * @param formData - The current formData, if any, used to figure out a match
  * @param options - The list of options to find a matching options from
  * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
  * @returns - The index of the matched option or 0 if none is available
  * @deprecated
  */
-function getMatchingOption(validator, formData, options, rootSchema) {
+function getMatchingOption(validator, formData, options, rootSchema, discriminatorField) {
   // For performance, skip validating subschemas if formData is undefined. We just
   // want to get the first option in that case.
   if (formData === undefined) {
@@ -318,18 +349,26 @@ function getMatchingOption(validator, formData, options, rootSchema) {
   }
   for (var i = 0; i < options.length; i++) {
     var option = options[i];
-    // If the schema describes an object then we need to add slightly more
-    // strict matching to the schema, because unless the schema uses the
-    // "requires" keyword, an object will match the schema as long as it
-    // doesn't have matching keys with a conflicting type. To do this we use an
-    // "anyOf" with an array of requires. This augmentation expresses that the
-    // schema should match if any of the keys in the schema are present on the
-    // object and pass validation.
-    if (option.properties) {
+    // If we have a discriminator field, then we will use this to make the determination
+    if (discriminatorField && has(option, [PROPERTIES_KEY, discriminatorField])) {
+      var value = get(formData, discriminatorField);
+      var discriminator = get(option, [PROPERTIES_KEY, discriminatorField], {});
+      if (validator.isValid(discriminator, value, rootSchema)) {
+        return i;
+      }
+    } else if (option[PROPERTIES_KEY]) {
+      // If the schema describes an object then we need to add slightly more
+      // strict matching to the schema, because unless the schema uses the
+      // "requires" keyword, an object will match the schema as long as it
+      // doesn't have matching keys with a conflicting type. To do this we use an
+      // "anyOf" with an array of requires. This augmentation expresses that the
+      // schema should match if any of the keys in the schema are present on the
+      // object and pass validation.
+      //
       // Create an "anyOf" schema that requires at least one of the keys in the
       // "properties" object
       var requiresAnyOf = {
-        anyOf: Object.keys(option.properties).map(function (key) {
+        anyOf: Object.keys(option[PROPERTIES_KEY]).map(function (key) {
           return {
             required: [key]
           };
@@ -371,10 +410,12 @@ function getMatchingOption(validator, formData, options, rootSchema) {
  * @param formData - The current formData, if any, used to figure out a match
  * @param options - The list of options to find a matching options from
  * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
  * @returns - The index of the first matched option or 0 if none is available
  */
-function getFirstMatchingOption(validator, formData, options, rootSchema) {
-  return getMatchingOption(validator, formData, options, rootSchema);
+function getFirstMatchingOption(validator, formData, options, rootSchema, discriminatorField) {
+  return getMatchingOption(validator, formData, options, rootSchema, discriminatorField);
 }
 
 /** Given a specific `value` attempts to guess the type of a schema element. In the case where we have to implicitly
@@ -850,16 +891,18 @@ function calculateIndexScore(validator, rootSchema, schema, formData) {
  * @param formData - The form data associated with the schema
  * @param options - The list of options that can be selected from
  * @param [selectedOption=-1] - The index of the currently selected option, defaulted to -1 if not specified
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
  * @returns - The index of the option that is the closest match to the `formData` or the `selectedOption` if no match
  */
-function getClosestMatchingOption(validator, rootSchema, formData, options, selectedOption) {
+function getClosestMatchingOption(validator, rootSchema, formData, options, selectedOption, discriminatorField) {
   if (selectedOption === void 0) {
     selectedOption = -1;
   }
   // 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 testOptions = [JUNK_OPTION, option];
-    var match = getFirstMatchingOption(validator, formData, testOptions, rootSchema);
+    var match = getFirstMatchingOption(validator, formData, testOptions, rootSchema, discriminatorField);
     // The match is the real option, so add its index to list of valid indexes
     if (match === 1) {
       validList.push(index);
@@ -1353,6 +1396,8 @@ function getDisplayLabel(validator, schema, uiSchema, rootSchema, globalOptions)
  * @param validationData - The current `ValidationData` into which to merge the additional errors
  * @param [additionalErrorSchema] - The additional set of errors in an `ErrorSchema`
  * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
+ * @deprecated - Use the `validationDataMerge()` function exported from `@rjsf/utils` instead. This function will be
+ *        removed in the next major release.
  */
 function mergeValidationData(validator, validationData, additionalErrorSchema) {
   if (!additionalErrorSchema) {
@@ -1568,7 +1613,7 @@ function toIdSchemaInternal(validator, schema, idPrefix, idSeparator, id, rootSc
   var idSchema = {
     $id: $id
   };
-  if (schema.type === 'object' && PROPERTIES_KEY in schema) {
+  if (getSchemaType(schema) === 'object' && PROPERTIES_KEY in schema) {
     for (var name in schema.properties) {
       var field = get(schema, [PROPERTIES_KEY, name]);
       var fieldId = idSchema[ID_KEY] + idSeparator + name;
@@ -1746,31 +1791,37 @@ var SchemaUtils = /*#__PURE__*/function () {
    * @param formData - The form data associated with the schema
    * @param options - The list of options that can be selected from
    * @param [selectedOption] - The index of the currently selected option, defaulted to -1 if not specified
+   * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+   *          determine which option is selected
    * @returns - The index of the option that is the closest match to the `formData` or the `selectedOption` if no match
    */;
-  _proto.getClosestMatchingOption = function getClosestMatchingOption$1(formData, options, selectedOption) {
-    return getClosestMatchingOption(this.validator, this.rootSchema, formData, options, selectedOption);
+  _proto.getClosestMatchingOption = function getClosestMatchingOption$1(formData, options, selectedOption, discriminatorField) {
+    return getClosestMatchingOption(this.validator, this.rootSchema, formData, options, selectedOption, discriminatorField);
   }
   /** Given the `formData` and list of `options`, attempts to find the index of the first option that matches the data.
    * Always returns the first option if there is nothing that matches.
    *
    * @param formData - The current formData, if any, used to figure out a match
    * @param options - The list of options to find a matching options from
+   * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+   *          determine which option is selected
    * @returns - The firstindex of the matched option or 0 if none is available
    */;
-  _proto.getFirstMatchingOption = function getFirstMatchingOption$1(formData, options) {
-    return getFirstMatchingOption(this.validator, formData, options, this.rootSchema);
+  _proto.getFirstMatchingOption = function getFirstMatchingOption$1(formData, options, discriminatorField) {
+    return getFirstMatchingOption(this.validator, formData, options, this.rootSchema, discriminatorField);
   }
   /** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
    * Deprecated, use `getFirstMatchingOption()` instead.
    *
    * @param formData - The current formData, if any, onto which to provide any missing defaults
    * @param options - The list of options to find a matching options from
+   * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+   *          determine which option is selected
    * @returns - The index of the matched option or 0 if none is available
    * @deprecated
    */;
-  _proto.getMatchingOption = function getMatchingOption$1(formData, options) {
-    return getMatchingOption(this.validator, formData, options, this.rootSchema);
+  _proto.getMatchingOption = function getMatchingOption$1(formData, options, discriminatorField) {
+    return getMatchingOption(this.validator, formData, options, this.rootSchema, discriminatorField);
   }
   /** Checks to see if the `schema` and `uiSchema` combination represents an array of files
    *
@@ -1805,6 +1856,8 @@ var SchemaUtils = /*#__PURE__*/function () {
    * @param validationData - The current `ValidationData` into which to merge the additional errors
    * @param [additionalErrorSchema] - The additional set of errors
    * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
+   * @deprecated - Use the `validationDataMerge()` function exported from `@rjsf/utils` instead. This function will be
+   *        removed in the next major release.
    */;
   _proto.mergeValidationData = function mergeValidationData$1(validationData, additionalErrorSchema) {
     return mergeValidationData(this.validator, validationData, additionalErrorSchema);
@@ -2762,6 +2815,102 @@ function toDateString(dateObject, time) {
   return time ? datetime : datetime.slice(0, 10);
 }
 
+/** Converts an `errorSchema` into a list of `RJSFValidationErrors`
+ *
+ * @param errorSchema - The `ErrorSchema` instance to convert
+ * @param [fieldPath=[]] - The current field path, defaults to [] if not specified
+ * @returns - The list of `RJSFValidationErrors` extracted from the `errorSchema`
+ */
+function toErrorList(errorSchema, fieldPath) {
+  if (fieldPath === void 0) {
+    fieldPath = [];
+  }
+  if (!errorSchema) {
+    return [];
+  }
+  var errorList = [];
+  if (ERRORS_KEY in errorSchema) {
+    errorList = errorList.concat(errorSchema[ERRORS_KEY].map(function (message) {
+      var property = "." + fieldPath.join('.');
+      return {
+        property: property,
+        message: message,
+        stack: property + " " + message
+      };
+    }));
+  }
+  return Object.keys(errorSchema).reduce(function (acc, key) {
+    if (key !== ERRORS_KEY) {
+      var childSchema = errorSchema[key];
+      if (isPlainObject(childSchema)) {
+        acc = acc.concat(toErrorList(childSchema, [].concat(fieldPath, [key])));
+      }
+    }
+    return acc;
+  }, errorList);
+}
+
+/** Transforms a rjsf validation errors list:
+ * [
+ *   {property: '.level1.level2[2].level3', message: 'err a'},
+ *   {property: '.level1.level2[2].level3', message: 'err b'},
+ *   {property: '.level1.level2[4].level3', message: 'err b'},
+ * ]
+ * Into an error tree:
+ * {
+ *   level1: {
+ *     level2: {
+ *       2: {level3: {errors: ['err a', 'err b']}},
+ *       4: {level3: {errors: ['err b']}},
+ *     }
+ *   }
+ * };
+ *
+ * @param errors - The list of RJSFValidationError objects
+ * @returns - The `ErrorSchema` built from the list of `RJSFValidationErrors`
+ */
+function toErrorSchema(errors) {
+  var builder = new ErrorSchemaBuilder();
+  if (errors.length) {
+    errors.forEach(function (error) {
+      var property = error.property,
+        message = error.message;
+      // When the property is the root element, just use an empty array for the path
+      var path = property === '.' ? [] : toPath(property);
+      // If the property is at the root (.level1) then toPath creates
+      // an empty array element at the first index. Remove it.
+      if (path.length > 0 && path[0] === '') {
+        path.splice(0, 1);
+      }
+      if (message) {
+        builder.addErrors(message, path);
+      }
+    });
+  }
+  return builder.ErrorSchema;
+}
+
+/** Unwraps the `errorHandler` structure into the associated `ErrorSchema`, stripping the `addError()` functions from it
+ *
+ * @param errorHandler - The `FormValidation` error handling structure
+ * @returns - The `ErrorSchema` resulting from the stripping of the `addError()` function
+ */
+function unwrapErrorHandler(errorHandler) {
+  return Object.keys(errorHandler).reduce(function (acc, key) {
+    if (key === 'addError') {
+      return acc;
+    } else {
+      var _extends3;
+      var childSchema = errorHandler[key];
+      if (isPlainObject(childSchema)) {
+        var _extends2;
+        return _extends({}, acc, (_extends2 = {}, _extends2[key] = unwrapErrorHandler(childSchema), _extends2));
+      }
+      return _extends({}, acc, (_extends3 = {}, _extends3[key] = childSchema, _extends3));
+    }
+  }, {});
+}
+
 /** Converts a UTC date string into a local Date format
  *
  * @param jsonDate - A UTC date string
@@ -2787,6 +2936,77 @@ function utcToLocal(jsonDate) {
   return yyyy + "-" + MM + "-" + dd + "T" + hh + ":" + mm + ":" + ss + "." + SSS;
 }
 
+/** Merges the errors in `additionalErrorSchema` into the existing `validationData` by combining the hierarchies in the
+ * two `ErrorSchema`s and then appending the error list from the `additionalErrorSchema` obtained by calling
+ * `toErrorList()` on the `errors` in the `validationData`. If no `additionalErrorSchema` is passed, then
+ * `validationData` is returned.
+ *
+ * @param validationData - The current `ValidationData` into which to merge the additional errors
+ * @param [additionalErrorSchema] - The optional additional set of errors in an `ErrorSchema`
+ * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
+ */
+function validationDataMerge(validationData, additionalErrorSchema) {
+  if (!additionalErrorSchema) {
+    return validationData;
+  }
+  var oldErrors = validationData.errors,
+    oldErrorSchema = validationData.errorSchema;
+  var errors = toErrorList(additionalErrorSchema);
+  var errorSchema = additionalErrorSchema;
+  if (!isEmpty(oldErrorSchema)) {
+    errorSchema = mergeObjects(oldErrorSchema, additionalErrorSchema, true);
+    errors = [].concat(oldErrors).concat(errors);
+  }
+  return {
+    errorSchema: errorSchema,
+    errors: errors
+  };
+}
+
+/** Takes a `node` object and transforms any contained `$ref` node variables with a prefix, recursively calling
+ * `withIdRefPrefix` for any other elements.
+ *
+ * @param node - The object node to which a ROOT_SCHEMA_PREFIX is added when a REF_KEY is part of it
+ */
+function withIdRefPrefixObject(node) {
+  for (var key in node) {
+    var realObj = node;
+    var value = realObj[key];
+    if (key === REF_KEY && typeof value === 'string' && value.startsWith('#')) {
+      realObj[key] = ROOT_SCHEMA_PREFIX + value;
+    } else {
+      realObj[key] = withIdRefPrefix(value);
+    }
+  }
+  return node;
+}
+/** Takes a `node` object list and transforms any contained `$ref` node variables with a prefix, recursively calling
+ * `withIdRefPrefix` for any other elements.
+ *
+ * @param node - The list of object nodes to which a ROOT_SCHEMA_PREFIX is added when a REF_KEY is part of it
+ */
+function withIdRefPrefixArray(node) {
+  for (var i = 0; i < node.length; i++) {
+    node[i] = withIdRefPrefix(node[i]);
+  }
+  return node;
+}
+/** Recursively prefixes all `$ref`s in a schema with the value of the `ROOT_SCHEMA_PREFIX` constant.
+ * This is used in isValid to make references to the rootSchema
+ *
+ * @param schemaNode - The object node to which a ROOT_SCHEMA_PREFIX is added when a REF_KEY is part of it
+ * @returns - A copy of the `schemaNode` with updated `$ref`s
+ */
+function withIdRefPrefix(schemaNode) {
+  if (schemaNode.constructor === Object) {
+    return withIdRefPrefixObject(_extends({}, schemaNode));
+  }
+  if (Array.isArray(schemaNode)) {
+    return withIdRefPrefixArray([].concat(schemaNode));
+  }
+  return schemaNode;
+}
+
 /** An enumeration of all the translatable strings used by `@rjsf/core` and its themes. The value of each of the
  * enumeration keys is expected to be the actual english string. Some strings contain replaceable parameter values
  * as indicated by `%1`, `%2`, etc. The number after the `%` indicates the order of the parameter. The ordering of
@@ -2863,5 +3083,5 @@ var TranslatableString;
   TranslatableString["FilesInfo"] = "<strong>%1</strong> (%2, %3 bytes)";
 })(TranslatableString || (TranslatableString = {}));
 
-export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, CONST_KEY, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, ENUM_KEY, ERRORS_KEY, ErrorSchemaBuilder, ID_KEY, ITEMS_KEY, NAME_KEY, ONE_OF_KEY, PROPERTIES_KEY, REF_KEY, REQUIRED_KEY, RJSF_ADDITONAL_PROPERTIES_FLAG, SUBMIT_BTN_OPTIONS_KEY, TranslatableString, UI_FIELD_KEY, UI_GLOBAL_OPTIONS_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, labelValue, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };
+export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, CONST_KEY, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, ENUM_KEY, ERRORS_KEY, ErrorSchemaBuilder, ID_KEY, ITEMS_KEY, NAME_KEY, ONE_OF_KEY, PROPERTIES_KEY, REF_KEY, REQUIRED_KEY, RJSF_ADDITONAL_PROPERTIES_FLAG, ROOT_SCHEMA_PREFIX, SUBMIT_BTN_OPTIONS_KEY, TranslatableString, UI_FIELD_KEY, UI_GLOBAL_OPTIONS_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createErrorHandler, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, labelValue, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toErrorList, toErrorSchema, toIdSchema, toPathSchema, unwrapErrorHandler, utcToLocal, validationDataMerge, withIdRefPrefix };
 //# sourceMappingURL=utils.esm.js.map