@rjsf/utils 5.0.0-beta.16 → 5.0.0-beta.17

package/dist/utils.umd.development.js

@@ -1,8 +1,8 @@
 (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/set'), require('json-schema-merge-allof'), require('lodash-es/union'), require('lodash-es/cloneDeep'), 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/set', 'json-schema-merge-allof', 'lodash-es/union', 'lodash-es/cloneDeep', '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.set, global.mergeAllOf, global.union, global.cloneDeep, global.React, global.ReactIs));
-})(this, (function (exports, isEqualWith, get, isEmpty, jsonpointer, omit, set, mergeAllOf, union, cloneDeep, React, ReactIs) { 'use strict';
+  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/set'), require('json-schema-merge-allof'), require('lodash-es/union'), require('lodash-es/cloneDeep'), require('react'), require('react-is'), require('lodash-es/isString')) :
+  typeof define === 'function' && define.amd ? define(['exports', 'lodash-es/isEqualWith', 'lodash-es/get', 'lodash-es/isEmpty', 'jsonpointer', 'lodash-es/omit', 'lodash-es/set', 'json-schema-merge-allof', 'lodash-es/union', 'lodash-es/cloneDeep', 'react', 'react-is', 'lodash-es/isString'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["@rjsf/utils"] = {}, global.isEqualWith, global.get, global.isEmpty, global.jsonpointer, global.omit, global.set, global.mergeAllOf, global.union, global.cloneDeep, global.React, global.ReactIs, global.isString));
+})(this, (function (exports, isEqualWith, get, isEmpty, jsonpointer, omit, set, mergeAllOf, union, cloneDeep, React, ReactIs, isString) { 'use strict';
 
   function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -17,6 +17,7 @@
   var cloneDeep__default = /*#__PURE__*/_interopDefaultLegacy(cloneDeep);
   var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
   var ReactIs__default = /*#__PURE__*/_interopDefaultLegacy(ReactIs);
+  var isString__default = /*#__PURE__*/_interopDefaultLegacy(isString);
 
   /** 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.
@@ -89,7 +90,7 @@
       descriptor.enumerable = descriptor.enumerable || false;
       descriptor.configurable = true;
       if ("value" in descriptor) descriptor.writable = true;
-      Object.defineProperty(target, descriptor.key, descriptor);
+      Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor);
     }
   }
   function _createClass(Constructor, protoProps, staticProps) {
@@ -129,6 +130,20 @@
     }
     return target;
   }
+  function _toPrimitive(input, hint) {
+    if (typeof input !== "object" || input === null) return input;
+    var prim = input[Symbol.toPrimitive];
+    if (prim !== undefined) {
+      var res = prim.call(input, hint || "default");
+      if (typeof res !== "object") return res;
+      throw new TypeError("@@toPrimitive must return a primitive value.");
+    }
+    return (hint === "string" ? String : Number)(input);
+  }
+  function _toPropertyKey(arg) {
+    var key = _toPrimitive(arg, "string");
+    return typeof key === "symbol" ? key : String(key);
+  }
 
   /** Below are the list of all the keys into various elements of a RJSFSchema or UiSchema that are used by the various
    * utility functions. In addition to those keys, there are the special `ADDITIONAL_PROPERTY_FLAG` and
@@ -1418,6 +1433,43 @@
     };
   }
 
+  /** Removes the `value` from the currently `selected` list of values
+   *
+   * @param value - The value to be removed from the selected list
+   * @param selected - The current list of selected values
+   * @returns - The updated `selected` list with the `value` removed from it
+   */
+  function enumOptionsDeselectValue(value, selected) {
+    return selected.filter(function (v) {
+      return v !== value;
+    });
+  }
+
+  /** Add the `value` to the list of `selected` values in the proper order as defined by `allEnumOptions`
+   *
+   * @param value - The value that should be selected
+   * @param selected - The current list of selected values
+   * @param allEnumOptions - The list of all the known enumOptions
+   * @returns - The updated list of selected enum values with `value` added to it in the proper location
+   */
+  function enumOptionsSelectValue(value, selected, allEnumOptions) {
+    if (allEnumOptions === void 0) {
+      allEnumOptions = [];
+    }
+    var all = allEnumOptions.map(function (_ref) {
+      var value = _ref.value;
+      return value;
+    });
+    var at = all.indexOf(value);
+    // If location of the value is not in the list of all enum values, just put it at the end
+    var updated = at === -1 ? selected.concat(value) : selected.slice(0, at).concat(value, selected.slice(at));
+    // As inserting values at predefined index positions doesn't work with empty
+    // arrays, we need to reorder the updated selection to match the initial order
+    return updated.sort(function (a, b) {
+      return Number(all.indexOf(a) > all.indexOf(b));
+    });
+  }
+
   /** The `ErrorSchemaBuilder<T>` is used to build an `ErrorSchema<T>` since the definition of the `ErrorSchema` type is
    * designed for reading information rather than writing it. Use this class to add, replace or clear errors in an error
    * schema by using either dotted path or an array of path names. Once you are done building the `ErrorSchema`, you can
@@ -1777,6 +1829,80 @@
     }
   }
 
+  /** Generates a consistent `id` pattern for a given `id` and a `suffix`
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @param suffix - The suffix to append to the id
+   */
+  function idGenerator(id, suffix) {
+    var theId = isString__default["default"](id) ? id : id[ID_KEY];
+    return theId + "__" + suffix;
+  }
+  /** Return a consistent `id` for the field description element
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @returns - The consistent id for the field description element from the given `id`
+   */
+  function descriptionId(id) {
+    return idGenerator(id, "description");
+  }
+  /** Return a consistent `id` for the field error element
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @returns - The consistent id for the field error element from the given `id`
+   */
+  function errorId(id) {
+    return idGenerator(id, "error");
+  }
+  /** Return a consistent `id` for the field examples element
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @returns - The consistent id for the field examples element from the given `id`
+   */
+  function examplesId(id) {
+    return idGenerator(id, "examples");
+  }
+  /** Return a consistent `id` for the field help element
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @returns - The consistent id for the field help element from the given `id`
+   */
+  function helpId(id) {
+    return idGenerator(id, "help");
+  }
+  /** Return a consistent `id` for the field title element
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @returns - The consistent id for the field title element from the given `id`
+   */
+  function titleId(id) {
+    return idGenerator(id, "title");
+  }
+  /** Return a list of element ids that contain additional information about the field that can be used to as the aria
+   * description of the field. This is correctly omitting `titleId` which would be "labeling" rather than "describing" the
+   * element.
+   *
+   * @param id - Either simple string id or an IdSchema from which to extract it
+   * @param [includeExamples=false] - Optional flag, if true, will add the `examplesId` into the list
+   * @returns - The string containing the list of ids for use in an `aria-describedBy` attribute
+   */
+  function ariaDescribedByIds(id, includeExamples) {
+    if (includeExamples === void 0) {
+      includeExamples = false;
+    }
+    var examples = includeExamples ? " " + examplesId(id) : "";
+    return errorId(id) + " " + descriptionId(id) + " " + helpId(id) + examples;
+  }
+  /** Return a consistent `id` for the `option`s of a `Radio` or `Checkboxes` widget
+   *
+   * @param id - The id of the parent component for the option
+   * @param option - The option for which the id is desired
+   * @returns - An id for the option based on the parent `id`
+   */
+  function optionId(id, option) {
+    return id + "-" + option.value;
+  }
+
   /** Converts a local Date string into a UTC date string
    *
    * @param dateString - The string representation of a date as accepted by the `Date()` constructor
@@ -2102,11 +2228,17 @@
   exports.UI_OPTIONS_KEY = UI_OPTIONS_KEY;
   exports.UI_WIDGET_KEY = UI_WIDGET_KEY;
   exports.allowAdditionalItems = allowAdditionalItems;
+  exports.ariaDescribedByIds = ariaDescribedByIds;
   exports.asNumber = asNumber;
   exports.canExpand = canExpand;
   exports.createSchemaUtils = createSchemaUtils;
   exports.dataURItoBlob = dataURItoBlob;
   exports.deepEquals = deepEquals;
+  exports.descriptionId = descriptionId;
+  exports.enumOptionsDeselectValue = enumOptionsDeselectValue;
+  exports.enumOptionsSelectValue = enumOptionsSelectValue;
+  exports.errorId = errorId;
+  exports.examplesId = examplesId;
   exports.findSchemaDefinition = findSchemaDefinition;
   exports.getDefaultFormState = getDefaultFormState;
   exports.getDisplayLabel = getDisplayLabel;
@@ -2119,6 +2251,7 @@
   exports.getWidget = getWidget;
   exports.guessType = guessType;
   exports.hasWidget = hasWidget;
+  exports.helpId = helpId;
   exports.isConstant = isConstant;
   exports.isCustomWidget = isCustomWidget;
   exports.isFilesArray = isFilesArray;
@@ -2131,6 +2264,7 @@
   exports.mergeObjects = mergeObjects;
   exports.mergeSchemas = mergeSchemas;
   exports.mergeValidationData = mergeValidationData;
+  exports.optionId = optionId;
   exports.optionsList = optionsList;
   exports.orderProperties = orderProperties;
   exports.pad = pad;
@@ -2140,6 +2274,7 @@
   exports.retrieveSchema = retrieveSchema;
   exports.schemaRequiresTrueValue = schemaRequiresTrueValue;
   exports.shouldRender = shouldRender;
+  exports.titleId = titleId;
   exports.toConstant = toConstant;
   exports.toDateString = toDateString;
   exports.toIdSchema = toIdSchema;