@rjsf/utils 5.0.0-beta.6 → 5.0.0-beta.9

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?: Array<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>;
+    /** 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 */
@@ -161,13 +195,13 @@ interface TemplatesType<T = any, F = any> {
         /** The template to use for the main `Submit` button  */
         SubmitButton: React.ComponentType<SubmitButtonProps<T, F>>;
         /** The template to use for the Add button used for AdditionalProperties and Array items */
-        AddButton: React.ComponentType<IconButtonProps>;
+        AddButton: React.ComponentType<IconButtonProps<T, F>>;
         /** The template to use for the Move Down button used for Array items */
-        MoveDownButton: React.ComponentType<IconButtonProps>;
+        MoveDownButton: React.ComponentType<IconButtonProps<T, F>>;
         /** The template to use for the Move Up button used for Array items */
-        MoveUpButton: React.ComponentType<IconButtonProps>;
+        MoveUpButton: React.ComponentType<IconButtonProps<T, F>>;
         /** The template to use for the Remove button used for AdditionalProperties and Array items */
-        RemoveButton: React.ComponentType<IconButtonProps>;
+        RemoveButton: React.ComponentType<IconButtonProps<T, F>>;
     };
 }
 /** The object containing the registered core, theme and custom fields and widgets as well as the root schema, form
@@ -362,6 +396,8 @@ declare type ArrayFieldTemplateItemType<T = any, F = any> = {
     readonly: boolean;
     /** A stable, unique key for the array item */
     key: string;
+    /** The uiSchema object for this field */
+    uiSchema?: UiSchema<T, F>;
     /** The `registry` object */
     registry: Registry<T, F>;
 };
@@ -498,11 +534,13 @@ declare type SubmitButtonProps<T = any, F = any> = {
     uiSchema?: UiSchema<T, F>;
 };
 /** The type that defines the props for an Icon button, extending from a basic HTML button attributes */
-declare type IconButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> & {
+declare type IconButtonProps<T = any, F = any> = React.ButtonHTMLAttributes<HTMLButtonElement> & {
     /** An alternative specification for the type of the icon button */
     iconType?: string;
     /** The name representation or actual react element implementation for the icon */
     icon?: string | React.ReactElement;
+    /** The uiSchema for this widget */
+    uiSchema?: UiSchema<T, F>;
 };
 /** The type that defines how to change the behavior of the submit button for the form */
 declare type UISchemaSubmitButtonOptions = {
@@ -1218,4 +1256,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "5.0.0-beta.6",
+  "version": "5.0.0-beta.9",
   "main": "dist/index.js",
   "module": "dist/utils.esm.js",
   "typings": "dist/index.d.ts",
@@ -75,5 +75,5 @@
     "url": "git+https://github.com/rjsf-team/react-jsonschema-form.git"
   },
   "license": "Apache-2.0",
-  "gitHead": "dfc8bbca60113fc5a78302b2ed79e3ea9b16241b"
+  "gitHead": "6a0a58190ff616344d80c558a755cda1835954f6"
 }