@rjsf/utils 5.0.1 → 5.1.0

package/README.md

@@ -16,7 +16,7 @@
   <p align="center">
   Utility functions for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -73,7 +73,7 @@ import * as Utils from '@rjsf/utils';
 
 ## Documentation
 
-[Utility function documentation](https://react-jsonschema-form.readthedocs.io/en/stable/api-reference/utility-functions/)
+[Utility function documentation](https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/utility-functions/)
 
 <!-- ROADMAP -->
 
@@ -85,7 +85,7 @@ See the [open issues](https://github.com/rjsf-team/react-jsonschema-form/issues)
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/stable/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.
 
 <!-- CONTACT -->
 

package/dist/index.d.ts

@@ -265,6 +265,16 @@ interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     required?: boolean;
     /** The unique name of the field, usually derived from the name of the property in the JSONSchema */
     name: string;
+    /** To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids;
+     * Default is `root`
+     */
+    idPrefix?: string;
+    /** To avoid using a path separator that is present in field names, it is possible to change the separator used for
+     * ids (Default is `_`)
+     */
+    idSeparator?: string;
+    /** An array of strings listing all generated error messages from encountered errors for this field */
+    rawErrors?: string[];
     /** The `registry` object */
     registry: Registry<T, S, F>;
 }
@@ -766,8 +776,8 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      * @param schema - The schema for which the default state is desired
      * @param [formData] - The current formData, if any, onto which to provide any missing defaults
      * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
-     *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
-     *          object properties.
+     *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+     *          false when computing defaults for any nested object properties.
      * @returns - The resulting `formData` with all the defaults provided
      */
     getDefaultFormState(schema: S, formData?: T, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;
@@ -1396,8 +1406,8 @@ declare const UI_OPTIONS_KEY = "ui:options";
  * @param [formData] - The current formData, if any, onto which to provide any missing defaults
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
- *          object properties.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
 declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, theSchema: S, formData?: T, rootSchema?: S, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;

package/dist/utils.cjs.development.js

@@ -1095,17 +1095,48 @@ function getInnerSchemaForArrayItem(schema, additionalItems, idx) {
   }
   return {};
 }
+/** Either add `computedDefault` at `key` into `obj` or not add it based on its value and the value of
+ * `includeUndefinedValues`. Generally undefined `computedDefault` values are added only when `includeUndefinedValues`
+ * is either true or "excludeObjectChildren". If `includeUndefinedValues` is false, then non-undefined and
+ * non-empty-object values will be added.
+ *
+ * @param obj - The object into which the computed default may be added
+ * @param key - The key into the object at which the computed default may be added
+ * @param computedDefault - The computed default value that maybe should be added to the obj
+ * @param includeUndefinedValues - 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. If "allowEmptyObject", prevents undefined
+ *          values in this object while allow the object itself to be empty and passing `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
+ * @param requiredFields - The list of fields that are required
+ */
+function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValues, requiredFields) {
+  if (requiredFields === void 0) {
+    requiredFields = [];
+  }
+  if (includeUndefinedValues) {
+    obj[key] = computedDefault;
+  } else if (isObject(computedDefault)) {
+    // Store computedDefault if it's a non-empty object (e.g. not {})
+    if (!isEmpty__default["default"](computedDefault) || requiredFields.includes(key)) {
+      obj[key] = computedDefault;
+    }
+  } else if (computedDefault !== undefined) {
+    // Store computedDefault if it's a defined primitive (e.g. true)
+    obj[key] = computedDefault;
+  }
+}
 /** Computes the defaults for the current `schema` given the `rawFormData` and `parentDefaults` if any. This drills into
  * each level of the schema, recursively, to fill out every level of defaults provided by the schema.
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
- * @param schema - The schema for which the default state is desired
+ * @param rawSchema - The schema for which the default state is desired
  * @param [parentDefaults] - Any defaults provided by the parent field in the schema
  * @param [rootSchema] - The options root schema, used to primarily to look up `$ref`s
  * @param [rawFormData] - The current formData, if any, onto which to provide any missing defaults
  * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
- *          object properties.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
 function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFormData, includeUndefinedValues) {
@@ -1137,8 +1168,14 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
       return computeDefaults(validator, itemSchema, Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined, rootSchema, formData, includeUndefinedValues);
     });
   } else if (ONE_OF_KEY in schema) {
+    if (schema.oneOf.length === 0) {
+      return undefined;
+    }
     schema = schema.oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty__default["default"](formData) ? undefined : formData, schema.oneOf, 0)];
   } else if (ANY_OF_KEY in schema) {
+    if (schema.anyOf.length === 0) {
+      return undefined;
+    }
     schema = schema.anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty__default["default"](formData) ? undefined : formData, schema.anyOf, 0)];
   }
   // Not defaults defined for this node, fallback to generic typed ones.
@@ -1148,23 +1185,25 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
   switch (getSchemaType(schema)) {
     // We need to recur for object schema inner default values.
     case "object":
-      return Object.keys(schema.properties || {}).reduce(function (acc, key) {
-        // Compute the defaults for this node, with the parent defaults we might
-        // have from a previous run: defaults[key].
-        var computedDefault = computeDefaults(validator, get__default["default"](schema, [PROPERTIES_KEY, key]), get__default["default"](defaults, [key]), rootSchema, get__default["default"](formData, [key]), includeUndefinedValues === "excludeObjectChildren" ? false : includeUndefinedValues);
-        if (includeUndefinedValues) {
-          acc[key] = computedDefault;
-        } else if (isObject(computedDefault)) {
-          // Store computedDefault if it's a non-empty object (e.g. not {})
-          if (!isEmpty__default["default"](computedDefault)) {
-            acc[key] = computedDefault;
-          }
-        } else if (computedDefault !== undefined) {
-          // Store computedDefault if it's a defined primitive (e.g. true)
-          acc[key] = computedDefault;
+      {
+        var objectDefaults = Object.keys(schema.properties || {}).reduce(function (acc, key) {
+          // Compute the defaults for this node, with the parent defaults we might
+          // have from a previous run: defaults[key].
+          var computedDefault = computeDefaults(validator, get__default["default"](schema, [PROPERTIES_KEY, key]), get__default["default"](defaults, [key]), rootSchema, get__default["default"](formData, [key]), includeUndefinedValues === true);
+          maybeAddDefaultToObject(acc, key, computedDefault, includeUndefinedValues, schema.required);
+          return acc;
+        }, {});
+        if (schema.additionalProperties && isObject(defaults)) {
+          var additionalPropertiesSchema = isObject(schema.additionalProperties) ? schema.additionalProperties : {}; // as per spec additionalProperties may be either schema or boolean
+          Object.keys(defaults).filter(function (key) {
+            return !schema.properties || !schema.properties[key];
+          }).forEach(function (key) {
+            var computedDefault = computeDefaults(validator, additionalPropertiesSchema, get__default["default"](defaults, [key]), rootSchema, get__default["default"](formData, [key]), includeUndefinedValues === true);
+            maybeAddDefaultToObject(objectDefaults, key, computedDefault, includeUndefinedValues);
+          });
         }
-        return acc;
-      }, {});
+        return objectDefaults;
+      }
     case "array":
       // Inject defaults into existing array defaults
       if (Array.isArray(defaults)) {
@@ -1206,8 +1245,8 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
  * @param [formData] - The current formData, if any, onto which to provide any missing defaults
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
- *          object properties.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
 function getDefaultFormState(validator, theSchema, formData, rootSchema, includeUndefinedValues) {