@rjsf/utils 5.0.0-beta.5 → 5.0.0-beta.8

package/README.md

@@ -8,13 +8,13 @@
 <br />
 <p align="center">
   <a href="https://github.com/rjsf-team/react-jsonschema-form">
-    <img src="https://raw.githubusercontent.com/rjsf-team/react-jsonschema-form/59a8206e148474bea854bbb004f624143fbcbac8/packages/utils/logo.png" alt="Logo" width="120" height="120">
+    <img src="https://raw.githubusercontent.com/rjsf-team/react-jsonschema-form/7ebc86621d8df8c21f0c39bcca6d476f6f7a2051/packages/utils/logo.png" alt="Logo" width="120" height="120">
   </a>
 
   <h3 align="center">@rjsf/utils</h3>
 
   <p align="center">
-  AJV-6 based validator plugin for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
+  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>
     <br />
@@ -46,12 +46,11 @@
 
 ## About The Project
 
-Exports `utils` plugin for `react-jsonschema-form`.
+Exports `utils` functions for `react-jsonschema-form`.
 
 ### Built With
 
 - [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form/)
-- [AJV](https://github.com/ajv-validator/ajv/)
 - [TypeScript](https://www.typescriptlang.org/)
 
 <!-- GETTING STARTED -->
@@ -72,6 +71,10 @@ yarn add @rjsf/utils
 import * as Utils from '@rjsf/utils';
 ```
 
+## Documentation
+
+[Utility function documentation](https://react-jsonschema-form.readthedocs.io/en/stable/api-reference/utility-functions/)
+
 <!-- ROADMAP -->
 
 ## Roadmap
@@ -101,8 +104,7 @@ GitHub repository: [https://github.com/rjsf-team/react-jsonschema-form](https://
 [contributors-url]: https://github.com/rjsf-team/react-jsonschema-form/graphs/contributors
 [license-shield]: https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square
 [license-url]: https://choosealicense.com/licenses/apache-2.0/
-[npm-shield]: https://img.shields.io/npm/v/@rjsf/material-ui/latest.svg?style=flat-square
-[npm-url]: https://www.npmjs.com/package/@rjsf/material-ui
-[npm-dl-shield]: https://img.shields.io/npm/dm/@rjsf/material-ui.svg?style=flat-square
-[npm-dl-url]: https://www.npmjs.com/package/@rjsf/material-ui
-[product-screenshot]: https://raw.githubusercontent.com/rjsf-team/react-jsonschema-form/e2e1181d1020f18cad0c80c661ddae28edb9794e/packages/material-ui/screenshot5.png
+[npm-shield]: https://img.shields.io/npm/v/@rjsf/utils/latest.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@rjsf/utils
+[npm-dl-shield]: https://img.shields.io/npm/dm/@rjsf/utils.svg?style=flat-square
+[npm-dl-url]: https://www.npmjs.com/package/@rjsf/utils

package/dist/index.d.ts

@@ -109,7 +109,7 @@ declare type FieldValidation = FieldErrors & {
 declare type FormValidation<T = any> = FieldValidation & {
     [key in keyof T]?: FormValidation<T[key]>;
 };
-/** The properties that are passed to an `ErrorList` implementation */
+/** The properties that are passed to an `ErrorListTemplate` implementation */
 declare type ErrorListProps<T = any, F = any> = {
     /** The errorSchema constructed by `Form` */
     errorSchema: ErrorSchema<T>;
@@ -122,6 +122,36 @@ declare type ErrorListProps<T = any, F = any> = {
     /** The uiSchema that was passed to `Form` */
     uiSchema?: UiSchema<T, F>;
 };
+/** The properties that are passed to an `FieldErrorTemplate` implementation */
+declare type FieldErrorProps<T = any, F = any> = {
+    /** The errorSchema constructed by `Form` */
+    errorSchema?: ErrorSchema<T>;
+    /** An array of the errors */
+    errors?: string[];
+    /** The tree of unique ids for every child field */
+    idSchema: IdSchema<T>;
+    /** The schema that was passed to field */
+    schema: RJSFSchema;
+    /** The uiSchema that was passed to field */
+    uiSchema?: UiSchema<T, F>;
+    /** The `registry` object */
+    registry: Registry<T, F>;
+};
+/** The properties that are passed to an `FieldHelpTemplate` implementation */
+declare type FieldHelpProps<T = any, F = any> = {
+    /** The help information to be rendered */
+    help?: string | React.ReactElement;
+    /** The tree of unique ids for every child field */
+    idSchema: IdSchema<T>;
+    /** The schema that was passed to field */
+    schema: RJSFSchema;
+    /** The uiSchema that was passed to field */
+    uiSchema?: UiSchema<T, F>;
+    /** Flag indicating whether there are errors associated with this field */
+    hasErrors?: boolean;
+    /** The `registry` object */
+    registry: Registry<T, F>;
+};
 /** The set of `Fields` stored in the `Registry` */
 declare type RegistryFieldsType<T = any, F = any> = {
     /** A `Field` indexed by `name` */
@@ -146,8 +176,12 @@ interface TemplatesType<T = any, F = any> {
     BaseInputTemplate: React.ComponentType<WidgetProps<T, F>>;
     /** The template to use for rendering the description of a field */
     DescriptionFieldTemplate: React.ComponentType<DescriptionFieldProps<T, F>>;
-    /** The template to use while rendering form errors */
+    /** The template to use while rendering the errors for the whole form */
     ErrorListTemplate: React.ComponentType<ErrorListProps<T, F>>;
+    /** The template to use while rendering the errors for a single field */
+    FieldErrorTemplate: React.ComponentType<FieldErrorProps<T, F>>;
+    /** The template to use while rendering the errors for a single field */
+    FieldHelpTemplate: React.ComponentType<FieldHelpProps<T, F>>;
     /** The template to use while rendering a field */
     FieldTemplate: React.ComponentType<FieldTemplateProps<T, F>>;
     /** The template to use while rendering an object */
@@ -1218,4 +1252,4 @@ declare function toIdSchema<T = any>(validator: ValidatorType, schema: RJSFSchem
  */
 declare function toPathSchema<T = any>(validator: ValidatorType, schema: RJSFSchema, name?: string, rootSchema?: RJSFSchema, formData?: T): PathSchema<T>;
 
-export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, CONST_KEY, CustomValidator, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, DateObject, DescriptionFieldProps, ENUM_KEY, ERRORS_KEY, EnumOptionsType, ErrorListProps, ErrorSchema, ErrorTransformer, Field, FieldError, FieldErrors, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFSchemaDefinition, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, SubmitButtonProps, TemplatesType, TitleFieldProps, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, allowAdditionalItems, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, findSchemaDefinition, getDefaultFormState, getDisplayLabel, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionsList, orderProperties, pad, parseDateString, processSelectValue, rangeSpec, retrieveSchema, schemaRequiresTrueValue, shouldRender, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };
+export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, CONST_KEY, CustomValidator, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, DateObject, DescriptionFieldProps, ENUM_KEY, ERRORS_KEY, EnumOptionsType, ErrorListProps, ErrorSchema, ErrorTransformer, Field, FieldError, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFSchemaDefinition, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, SubmitButtonProps, TemplatesType, TitleFieldProps, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, allowAdditionalItems, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, findSchemaDefinition, getDefaultFormState, getDisplayLabel, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionsList, orderProperties, pad, parseDateString, processSelectValue, rangeSpec, retrieveSchema, schemaRequiresTrueValue, shouldRender, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };

package/dist/utils.cjs.development.js

@@ -4,12 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var isEqualWith = require('lodash/isEqualWith');
 var get = require('lodash/get');
+var isEmpty = require('lodash/isEmpty');
 var jsonpointer = require('jsonpointer');
 var omit = require('lodash/omit');
 var set = require('lodash/set');
 var mergeAllOf = require('json-schema-merge-allof');
 var union = require('lodash/union');
-var isEmpty = require('lodash/isEmpty');
 var React = require('react');
 var ReactIs = require('react-is');
 
@@ -17,12 +17,12 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var isEqualWith__default = /*#__PURE__*/_interopDefaultLegacy(isEqualWith);
 var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
+var isEmpty__default = /*#__PURE__*/_interopDefaultLegacy(isEmpty);
 var jsonpointer__default = /*#__PURE__*/_interopDefaultLegacy(jsonpointer);
 var omit__default = /*#__PURE__*/_interopDefaultLegacy(omit);
 var set__default = /*#__PURE__*/_interopDefaultLegacy(set);
 var mergeAllOf__default = /*#__PURE__*/_interopDefaultLegacy(mergeAllOf);
 var union__default = /*#__PURE__*/_interopDefaultLegacy(union);
-var isEmpty__default = /*#__PURE__*/_interopDefaultLegacy(isEmpty);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var ReactIs__default = /*#__PURE__*/_interopDefaultLegacy(ReactIs);
 
@@ -991,7 +991,7 @@ function getInnerSchemaForArrayItem(schema, additionalItems, idx) {
   return {};
 }
 /** Computes the defaults for the current `schema` given the `rawFormData` and `parentDefaults` if any. This drills into
- * the each level of the schema, recursively, to fill out every level of defaults provided by the schema.
+ * 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
@@ -1031,9 +1031,9 @@ function computeDefaults(validator, schema, parentDefaults, rootSchema, rawFormD
   } else if (isFixedItems(schema)) {
     defaults = schema.items.map((itemSchema, idx) => computeDefaults(validator, itemSchema, Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined, rootSchema, formData, includeUndefinedValues));
   } else if (ONE_OF_KEY in schema) {
-    schema = schema.oneOf[getMatchingOption(validator, undefined, schema.oneOf, rootSchema)];
+    schema = schema.oneOf[getMatchingOption(validator, isEmpty__default["default"](formData) ? undefined : formData, schema.oneOf, rootSchema)];
   } else if (ANY_OF_KEY in schema) {
-    schema = schema.anyOf[getMatchingOption(validator, undefined, schema.anyOf, rootSchema)];
+    schema = schema.anyOf[getMatchingOption(validator, isEmpty__default["default"](formData) ? undefined : formData, schema.anyOf, rootSchema)];
   } // Not defaults defined for this node, fallback to generic typed ones.