@rjsf/utils 5.5.2 → 5.6.0

package/dist/utils.umd.development.js

@@ -1,11 +1,12 @@
 (function (global, factory) {
-  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('lodash-es/isEqualWith'), require('lodash-es/get'), require('lodash-es/isEmpty'), require('jsonpointer'), require('lodash-es/omit'), require('lodash-es/has'), require('lodash-es/isObject'), require('lodash-es/isString'), require('lodash-es/reduce'), require('lodash-es/times'), require('lodash-es/set'), require('json-schema-merge-allof'), require('lodash-es/union'), require('lodash-es/isEqual'), require('lodash-es/cloneDeep'), require('react/jsx-runtime'), require('react'), require('react-is')) :
-  typeof define === 'function' && define.amd ? define(['exports', 'lodash-es/isEqualWith', 'lodash-es/get', 'lodash-es/isEmpty', 'jsonpointer', 'lodash-es/omit', 'lodash-es/has', 'lodash-es/isObject', 'lodash-es/isString', 'lodash-es/reduce', 'lodash-es/times', 'lodash-es/set', 'json-schema-merge-allof', 'lodash-es/union', 'lodash-es/isEqual', 'lodash-es/cloneDeep', 'react/jsx-runtime', 'react', 'react-is'], factory) :
-  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["@rjsf/utils"] = {}, global.isEqualWith, global.get, global.isEmpty, global.jsonpointer, global.omit, global.has, global.isObject$1, global.isString, global.reduce, global.times, global.set, global.mergeAllOf, global.union, global.isEqual, global.cloneDeep, global.jsxRuntime, global.React, global.ReactIs));
-})(this, (function (exports, isEqualWith, get, isEmpty, jsonpointer, omit, has, isObject$1, isString, reduce, times, set, mergeAllOf, union, isEqual, cloneDeep, jsxRuntime, react, ReactIs) { 'use strict';
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('lodash-es/isPlainObject'), require('lodash-es/isEqualWith'), require('lodash-es/get'), require('lodash-es/isEmpty'), require('jsonpointer'), require('lodash-es/omit'), require('lodash-es/has'), require('lodash-es/isObject'), require('lodash-es/isString'), require('lodash-es/reduce'), require('lodash-es/times'), require('lodash-es/set'), require('json-schema-merge-allof'), require('lodash-es/union'), require('lodash-es/isEqual'), require('lodash-es/cloneDeep'), require('react/jsx-runtime'), require('react'), require('react-is'), require('lodash-es/toPath')) :
+  typeof define === 'function' && define.amd ? define(['exports', 'lodash-es/isPlainObject', 'lodash-es/isEqualWith', 'lodash-es/get', 'lodash-es/isEmpty', 'jsonpointer', 'lodash-es/omit', 'lodash-es/has', 'lodash-es/isObject', 'lodash-es/isString', 'lodash-es/reduce', 'lodash-es/times', 'lodash-es/set', 'json-schema-merge-allof', 'lodash-es/union', 'lodash-es/isEqual', 'lodash-es/cloneDeep', 'react/jsx-runtime', 'react', 'react-is', 'lodash-es/toPath'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["@rjsf/utils"] = {}, global.isPlainObject, global.isEqualWith, global.get, global.isEmpty, global.jsonpointer, global.omit, global.has, global.isObject$1, global.isString, global.reduce, global.times, global.set, global.mergeAllOf, global.union, global.isEqual, global.cloneDeep, global.jsxRuntime, global.React, global.ReactIs, global.toPath));
+})(this, (function (exports, isPlainObject, isEqualWith, get, isEmpty, jsonpointer, omit, has, isObject$1, isString, reduce, times, set, mergeAllOf, union, isEqual, cloneDeep, jsxRuntime, react, ReactIs, toPath) { 'use strict';
 
   function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+  var isPlainObject__default = /*#__PURE__*/_interopDefaultLegacy(isPlainObject);
   var isEqualWith__default = /*#__PURE__*/_interopDefaultLegacy(isEqualWith);
   var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
   var isEmpty__default = /*#__PURE__*/_interopDefaultLegacy(isEmpty);
@@ -22,6 +23,7 @@
   var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
   var cloneDeep__default = /*#__PURE__*/_interopDefaultLegacy(cloneDeep);
   var ReactIs__default = /*#__PURE__*/_interopDefaultLegacy(ReactIs);
+  var toPath__default = /*#__PURE__*/_interopDefaultLegacy(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.
@@ -173,6 +175,7 @@
   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';
@@ -238,6 +241,32 @@
     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__default["default"](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.
    *
@@ -313,10 +342,12 @@
    * @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) {
@@ -324,18 +355,26 @@
     }
     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__default["default"](option, [PROPERTIES_KEY, discriminatorField])) {
+        var value = get__default["default"](formData, discriminatorField);
+        var discriminator = get__default["default"](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]
             };
@@ -377,10 +416,12 @@
    * @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
@@ -856,16 +897,18 @@
    * @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);
@@ -1359,6 +1402,8 @@
    * @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) {
@@ -1574,7 +1619,7 @@
     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__default["default"](schema, [PROPERTIES_KEY, name]);
         var fieldId = idSchema[ID_KEY] + idSeparator + name;
@@ -1752,31 +1797,37 @@
      * @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
      *
@@ -1811,6 +1862,8 @@
      * @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);
@@ -2768,6 +2821,102 @@
     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__default["default"](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__default["default"](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__default["default"](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
@@ -2793,6 +2942,77 @@
     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__default["default"](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
@@ -2888,6 +3108,7 @@
   exports.REF_KEY = REF_KEY;
   exports.REQUIRED_KEY = REQUIRED_KEY;
   exports.RJSF_ADDITONAL_PROPERTIES_FLAG = RJSF_ADDITONAL_PROPERTIES_FLAG;
+  exports.ROOT_SCHEMA_PREFIX = ROOT_SCHEMA_PREFIX;
   exports.SUBMIT_BTN_OPTIONS_KEY = SUBMIT_BTN_OPTIONS_KEY;
   exports.UI_FIELD_KEY = UI_FIELD_KEY;
   exports.UI_GLOBAL_OPTIONS_KEY = UI_GLOBAL_OPTIONS_KEY;
@@ -2897,6 +3118,7 @@
   exports.ariaDescribedByIds = ariaDescribedByIds;
   exports.asNumber = asNumber;
   exports.canExpand = canExpand;
+  exports.createErrorHandler = createErrorHandler;
   exports.createSchemaUtils = createSchemaUtils;
   exports.dataURItoBlob = dataURItoBlob;
   exports.deepEquals = deepEquals;
@@ -2951,9 +3173,14 @@
   exports.titleId = titleId;
   exports.toConstant = toConstant;
   exports.toDateString = toDateString;
+  exports.toErrorList = toErrorList;
+  exports.toErrorSchema = toErrorSchema;
   exports.toIdSchema = toIdSchema;
   exports.toPathSchema = toPathSchema;
+  exports.unwrapErrorHandler = unwrapErrorHandler;
   exports.utcToLocal = utcToLocal;
+  exports.validationDataMerge = validationDataMerge;
+  exports.withIdRefPrefix = withIdRefPrefix;
 
   Object.defineProperty(exports, '__esModule', { value: true });