@rjsf/utils 5.0.0-beta.14 → 5.0.0-beta.15

package/dist/index.d.ts

@@ -408,7 +408,9 @@ declare type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJ
     readonly: boolean;
     /** A stable, unique key for the array item */
     key: string;
-    /** The uiSchema object for this field */
+    /** The schema object for this array item */
+    schema: S;
+    /** The uiSchema object for this array item */
     uiSchema?: UiSchema<T, S, F>;
     /** The `registry` object */
     registry: Registry<T, S, F>;
@@ -880,6 +882,66 @@ declare function dataURItoBlob(dataURI: string): {
  */
 declare function deepEquals(a: any, b: any): boolean;
 
+/** 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
+ * get the result and/or reset all the errors back to an initial set and start again.
+ */
+declare class ErrorSchemaBuilder<T = any> {
+    /** The error schema being built
+     *
+     * @private
+     */
+    private errorSchema;
+    /** Construct an `ErrorSchemaBuilder` with an optional initial set of errors in an `ErrorSchema`.
+     *
+     * @param [initialSchema] - The optional set of initial errors, that will be cloned into the class
+     */
+    constructor(initialSchema?: ErrorSchema<T>);
+    /** Returns the `ErrorSchema` that has been updated by the methods of the `ErrorSchemaBuilder`
+     */
+    get ErrorSchema(): ErrorSchema<T>;
+    /** Will get an existing `ErrorSchema` at the specified `pathOfError` or create and return one.
+     *
+     * @param [pathOfError] - The optional path into the `ErrorSchema` at which to add the error(s)
+     * @returns - The error block for the given `pathOfError` or the root if not provided
+     * @private
+     */
+    private getOrCreateErrorBlock;
+    /** Resets all errors in the `ErrorSchemaBuilder` back to the `initialSchema` if provided, otherwise an empty set.
+     *
+     * @param [initialSchema] - The optional set of initial errors, that will be cloned into the class
+     * @returns - The `ErrorSchemaBuilder` object for chaining purposes
+     */
+    resetAllErrors(initialSchema?: ErrorSchema<T>): this;
+    /** Adds the `errorOrList` to the list of errors in the `ErrorSchema` at either the root level or the location within
+     * the schema described by the `pathOfError`. For more information about how to specify the path see the
+     * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md).
+     *
+     * @param errorOrList - The error or list of errors to add into the `ErrorSchema`
+     * @param [pathOfError] - The optional path into the `ErrorSchema` at which to add the error(s)
+     * @returns - The `ErrorSchemaBuilder` object for chaining purposes
+     */
+    addErrors(errorOrList: string | string[], pathOfError?: string | string[]): this;
+    /** Sets/replaces the `errorOrList` as the error(s) in the `ErrorSchema` at either the root level or the location
+     * within the schema described by the `pathOfError`. For more information about how to specify the path see the
+     * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md).
+     *
+     * @param errorOrList - The error or list of errors to set into the `ErrorSchema`
+     * @param [pathOfError] - The optional path into the `ErrorSchema` at which to set the error(s)
+     * @returns - The `ErrorSchemaBuilder` object for chaining purposes
+     */
+    setErrors(errorOrList: string | string[], pathOfError?: string | string[]): this;
+    /** Clears the error(s) in the `ErrorSchema` at either the root level or the location within the schema described by
+     * the `pathOfError`. For more information about how to specify the path see the
+     * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md).
+     *
+     * @param [pathOfError] - The optional path into the `ErrorSchema` at which to clear the error(s)
+     * @returns - The `ErrorSchemaBuilder` object for chaining purposes
+     */
+    clearErrors(pathOfError?: string | string[]): this;
+}
+
 /** Given the name of a `$ref` from within a schema, using the `rootSchema`, look up and return the sub-schema using the
  * path provided by that reference. If `#` is not the first character of the reference, or the path does not exist in
  * the schema, then throw an Error. Otherwise return the sub-schema. Also deals with nested `$ref`s in the sub-schema.
@@ -1288,4 +1350,4 @@ declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(va
  */
 declare function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, schema: S, name?: string, rootSchema?: S, 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, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormContextType, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, StrictRJSFSchema, SubmitButtonProps, TemplatesType, TitleFieldProps, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, 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, ErrorSchemaBuilder, ErrorTransformer, Field, FieldError, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormContextType, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, StrictRJSFSchema, SubmitButtonProps, TemplatesType, TitleFieldProps, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, 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 };