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

package/dist/index.d.ts

@@ -1,23 +1,23 @@
-import React from 'react';
+import React, { StyleHTMLAttributes } from 'react';
 import * as json_schema from 'json-schema';
 import { JSONSchema7 } from 'json-schema';
 
 /** The representation of any generic object type, usually used as an intersection on other types to make them more
  * flexible in the properties they support (i.e. anything else)
  */
-declare type GenericObjectType = {
+type GenericObjectType = {
     [name: string]: any;
 };
 /** Map the JSONSchema7 to our own type so that we can easily bump to a more recent version at some future date and only
  * have to update this one type.
  */
-declare type StrictRJSFSchema = JSONSchema7;
+type StrictRJSFSchema = JSONSchema7;
 /** Allow for more flexible schemas (i.e. draft-2019) than the strict JSONSchema7
  */
-declare type RJSFSchema = StrictRJSFSchema & GenericObjectType;
+type RJSFSchema = StrictRJSFSchema & GenericObjectType;
 /** Alias GenericObjectType as FormContextType to allow us to remap this at some future date
  */
-declare type FormContextType = GenericObjectType;
+type FormContextType = GenericObjectType;
 /** The interface representing a Date object that contains an optional time */
 interface DateObject {
     /** The year of the Date */
@@ -34,7 +34,7 @@ interface DateObject {
     second?: number;
 }
 /** Properties describing a Range specification in terms of attribute that can be added to the `HTML` `<input>` */
-declare type RangeSpecType = {
+type RangeSpecType = {
     /** Specifies the interval between legal numbers in an input field */
     step?: number;
     /** Specifies a minimum value for an <input> element */
@@ -43,7 +43,7 @@ declare type RangeSpecType = {
     max?: number;
 };
 /** Properties describing a Range specification in terms of attribute that can be added to the `HTML` `<input>` */
-declare type InputPropsType = Omit<RangeSpecType, "step"> & {
+type InputPropsType = Omit<RangeSpecType, "step"> & {
     /** Specifies the type of the <input> element */
     type: string;
     /** Specifies the interval between legal numbers in an input field or "any" */
@@ -52,25 +52,25 @@ declare type InputPropsType = Omit<RangeSpecType, "step"> & {
     autoComplete?: HTMLInputElement["autocomplete"];
 };
 /** Type describing an id used for a field in the `IdSchema` */
-declare type FieldId = {
+type FieldId = {
     /** The id for a field */
     $id: string;
 };
 /** Type describing a recursive structure of `FieldId`s for an object with a non-empty set of keys */
-declare type IdSchema<T = any> = FieldId & {
+type IdSchema<T = any> = FieldId & {
     [key in keyof T]?: IdSchema<T[key]>;
 };
 /** Type describing a name used for a field in the `PathSchema` */
-declare type FieldPath = {
+type FieldPath = {
     /** The name of a field */
     $name: string;
 };
 /** Type describing a recursive structure of `FieldPath`s for an object with a non-empty set of keys */
-declare type PathSchema<T = any> = FieldPath & {
+type PathSchema<T = any> = FieldPath & {
     [key in keyof T]?: PathSchema<T[key]>;
 };
 /** The type for error produced by RJSF schema validation */
-declare type RJSFValidationError = {
+type RJSFValidationError = {
     /** Name of the error, for example, "required" or "minLength" */
     name?: string;
     /** Message, for example, "is a required property" or "should NOT be shorter than 3 characters" */
@@ -92,27 +92,27 @@ declare type RJSFValidationError = {
     stack: string;
 };
 /** The type that describes an error in a field */
-declare type FieldError = string;
+type FieldError = string;
 /** The type that describes the list of errors for a field */
-declare type FieldErrors = {
+type FieldErrors = {
     /** The list of errors for the field */
     __errors?: FieldError[];
 };
 /** Type describing a recursive structure of `FieldErrors`s for an object with a non-empty set of keys */
-declare type ErrorSchema<T = any> = FieldErrors & {
+type ErrorSchema<T = any> = FieldErrors & {
     [key in keyof T]?: ErrorSchema<T[key]>;
 };
 /** Type that describes the list of errors for a field being actively validated by a custom validator */
-declare type FieldValidation = FieldErrors & {
+type FieldValidation = FieldErrors & {
     /** Function that will add a new `message` to the list of errors */
     addError: (message: string) => void;
 };
 /** Type describing a recursive structure of `FieldValidation`s for an object with a non-empty set of keys */
-declare type FormValidation<T = any> = FieldValidation & {
+type FormValidation<T = any> = FieldValidation & {
     [key in keyof T]?: FormValidation<T[key]>;
 };
 /** The properties that are passed to an `ErrorListTemplate` implementation */
-declare type ErrorListProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type ErrorListProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The errorSchema constructed by `Form` */
     errorSchema: ErrorSchema<T>;
     /** An array of the errors */
@@ -125,7 +125,7 @@ declare type ErrorListProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     uiSchema?: UiSchema<T, S, F>;
 };
 /** The properties that are passed to an `FieldErrorTemplate` implementation */
-declare type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The errorSchema constructed by `Form` */
     errorSchema?: ErrorSchema<T>;
     /** An array of the errors */
@@ -140,7 +140,7 @@ declare type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to an `FieldHelpTemplate` implementation */
-declare type FieldHelpProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type FieldHelpProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The help information to be rendered */
     help?: string | React.ReactElement;
     /** The tree of unique ids for every child field */
@@ -155,12 +155,12 @@ declare type FieldHelpProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     registry: Registry<T, S, F>;
 };
 /** The set of `Fields` stored in the `Registry` */
-declare type RegistryFieldsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type RegistryFieldsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** A `Field` indexed by `name` */
     [name: string]: Field<T, S, F>;
 };
 /** The set of `Widgets` stored in the `Registry` */
-declare type RegistryWidgetsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type RegistryWidgetsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** A `Widget` indexed by `name` */
     [name: string]: Widget<T, S, F>;
 };
@@ -242,11 +242,11 @@ interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** The tree of unique ids for every child field */
     idSchema: IdSchema<T>;
     /** The data for this field */
-    formData: T;
+    formData?: T;
     /** The tree of errors for this field and its children */
     errorSchema?: ErrorSchema<T>;
     /** The field change event handler; called with the updated form data and an optional `ErrorSchema` */
-    onChange: (newFormData: T, es?: ErrorSchema<T>, id?: string) => any;
+    onChange: (newFormData: T | undefined, es?: ErrorSchema<T>, id?: string) => any;
     /** The input blur event handler; call it with the field id and value */
     onBlur: (id: string, value: any) => void;
     /** The input focus event handler; call it with the field id and value */
@@ -269,13 +269,15 @@ interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     registry: Registry<T, S, F>;
 }
 /** The definition of a React-based Field component */
-declare type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<FieldProps<T, S, F>>;
+type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<FieldProps<T, S, F>>;
 /** The properties that are passed to a FieldTemplate implementation */
-declare type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The id of the field in the hierarchy. You can use it to render a label targeting the wrapped widget */
     id: string;
     /** A string containing the base CSS classes, merged with any custom ones defined in your uiSchema */
     classNames?: string;
+    /** An object containing the style as defined in the `uiSchema` */
+    style?: StyleHTMLAttributes<any>;
     /** The computed label for this field, as a string */
     label: string;
     /** A component instance rendering the field description, if one is defined (this will use any custom
@@ -317,7 +319,7 @@ declare type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema
     /** The `formContext` object that was passed to `Form` */
     formContext?: F;
     /** The formData for this field */
-    formData: T;
+    formData?: T;
     /** The value change event handler; Can be called with a new value to change the value for this field */
     onChange: FieldProps["onChange"];
     /** The key change event handler; Called when the key associated with a field is changed for an additionalProperty */
@@ -328,7 +330,7 @@ declare type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to the `UnsupportedFieldTemplate` implementation */
-declare type UnsupportedFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type UnsupportedFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The schema object for this field */
     schema: S;
     /** The tree of unique ids for every child field */
@@ -339,7 +341,7 @@ declare type UnsupportedFieldProps<T = any, S extends StrictRJSFSchema = RJSFSch
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to a `TitleFieldTemplate` implementation */
-declare type TitleFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type TitleFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The id of the field title in the hierarchy */
     id: string;
     /** The title for the field being rendered */
@@ -354,7 +356,7 @@ declare type TitleFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to a `DescriptionFieldTemplate` implementation */
-declare type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The id of the field description in the hierarchy */
     id: string;
     /** The schema object for the field being described */
@@ -367,21 +369,21 @@ declare type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSch
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to a `ArrayFieldTitleTemplate` implementation */
-declare type ArrayFieldTitleProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<TitleFieldProps<T, S, F>, "id" | "title"> & {
+type ArrayFieldTitleProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<TitleFieldProps<T, S, F>, "id" | "title"> & {
     /** The title for the field being rendered */
     title?: string;
     /** The idSchema of the field in the hierarchy */
     idSchema: IdSchema<T>;
 };
 /** The properties that are passed to a `ArrayFieldDescriptionTemplate` implementation */
-declare type ArrayFieldDescriptionProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<DescriptionFieldProps<T, S, F>, "id" | "description"> & {
+type ArrayFieldDescriptionProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<DescriptionFieldProps<T, S, F>, "id" | "description"> & {
     /** The description of the field being rendered */
     description?: string | React.ReactElement;
     /** The idSchema of the field in the hierarchy */
     idSchema: IdSchema<T>;
 };
 /** The properties of each element in the ArrayFieldTemplateProps.items array */
-declare type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The html for the item's content */
     children: React.ReactElement;
     /** The className string */
@@ -420,7 +422,7 @@ declare type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJ
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to an ArrayFieldTemplate implementation */
-declare type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** A boolean value stating whether new elements can be added to the array */
     canAdd?: boolean;
     /** The className string */
@@ -448,14 +450,14 @@ declare type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFS
     /** The `formContext` object that was passed to Form */
     formContext?: F;
     /** The formData for this array */
-    formData: T;
+    formData?: T;
     /** An array of strings listing all generated error messages from encountered errors for this widget */
     rawErrors?: string[];
     /** The `registry` object */
     registry: Registry<T, S, F>;
 };
 /** The properties of each element in the ObjectFieldTemplateProps.properties array */
-declare type ObjectFieldTemplatePropertyType = {
+type ObjectFieldTemplatePropertyType = {
     /** The html for the property's content */
     content: React.ReactElement;
     /** A string representing the property name */
@@ -468,7 +470,7 @@ declare type ObjectFieldTemplatePropertyType = {
     hidden: boolean;
 };
 /** The properties that are passed to an ObjectFieldTemplate implementation */
-declare type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** A string value containing the title for the object */
     title: string;
     /** A string value containing the description for the object */
@@ -492,17 +494,17 @@ declare type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSF
     /** An object containing the id for this object & ids for its properties */
     idSchema: IdSchema<T>;
     /** The form data for the object */
-    formData: T;
+    formData?: T;
     /** The `formContext` object that was passed to Form */
     formContext?: F;
     /** The `registry` object */
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to a WrapIfAdditionalTemplate implementation */
-declare type WrapIfAdditionalTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type WrapIfAdditionalTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The field or widget component instance for this field row */
     children: React.ReactNode;
-} & Pick<FieldTemplateProps<T, S, F>, "id" | "classNames" | "label" | "required" | "readonly" | "disabled" | "schema" | "uiSchema" | "onKeyChange" | "onDropPropertyClick" | "registry">;
+} & Pick<FieldTemplateProps<T, S, F>, "id" | "classNames" | "style" | "label" | "required" | "readonly" | "disabled" | "schema" | "uiSchema" | "onKeyChange" | "onDropPropertyClick" | "registry">;
 /** The properties that are passed to a Widget implementation */
 interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<React.HTMLAttributes<HTMLElement>, Exclude<keyof React.HTMLAttributes<HTMLElement>, "onBlur" | "onFocus">> {
     /** The generated id for this widget */
@@ -550,16 +552,16 @@ interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
     registry: Registry<T, S, F>;
 }
 /** The definition of a React-based Widget component */
-declare type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<WidgetProps<T, S, F>>;
+type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<WidgetProps<T, S, F>>;
 /** The type that defines the props used by the Submit button */
-declare type SubmitButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
+type SubmitButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The uiSchema for this widget */
     uiSchema?: UiSchema<T, S, F>;
     /** The `registry` object */
     registry: Registry<T, S, F>;
 };
 /** The type that defines the props for an Icon button, extending from a basic HTML button attributes */
-declare type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ButtonHTMLAttributes<HTMLButtonElement> & {
+type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = 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 */
@@ -570,7 +572,7 @@ declare type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     registry: Registry<T, S, F>;
 };
 /** The type that defines how to change the behavior of the submit button for the form */
-declare type UISchemaSubmitButtonOptions = {
+type UISchemaSubmitButtonOptions = {
     /** The text of the submit button. Set to "Submit" by default */
     submitText?: string;
     /** Flag, if `true`, removes the submit button completely from the form */
@@ -584,7 +586,7 @@ declare type UISchemaSubmitButtonOptions = {
     };
 };
 /** This type represents an element used to render an enum option */
-declare type EnumOptionsType<S extends StrictRJSFSchema = RJSFSchema> = {
+type EnumOptionsType<S extends StrictRJSFSchema = RJSFSchema> = {
     /** The value for the enum option */
     value: any;
     /** The label for the enum options */
@@ -593,15 +595,17 @@ declare type EnumOptionsType<S extends StrictRJSFSchema = RJSFSchema> = {
     schema?: S;
 };
 /** This type remaps the keys of `Type` to prepend `ui:` onto them. As a result it does not need to be exported */
-declare type MakeUIType<Type> = {
+type MakeUIType<Type> = {
     [Property in keyof Type as `ui:${string & Property}`]: Type[Property];
 };
 /** This type represents all the known supported options in the `ui:options` property, kept separate in order to
  * remap the keys. It also contains all the properties, optionally, of `TemplatesType` except "ButtonTemplates"
  */
-declare type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Partial<Omit<TemplatesType<T, S, F>, "ButtonTemplates">> & {
+type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Partial<Omit<TemplatesType<T, S, F>, "ButtonTemplates">> & {
     /** Any classnames that the user wants to be applied to a field in the ui */
     classNames?: string;
+    /** Any custom style that the user wants to apply to a field in the ui, applied on the same element as classNames */
+    style?: StyleHTMLAttributes<any>;
     /** We know that for title, it will be a string, if it is provided */
     title?: string;
     /** We know that for description, it will be a string, if it is provided */
@@ -654,14 +658,14 @@ declare type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema,
     duplicateKeySuffixSeparator?: string;
 };
 /** The type that represents the Options potentially provided by `ui:options` */
-declare type UIOptionsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = UIOptionsBaseType<T, S, F> & {
+type UIOptionsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = UIOptionsBaseType<T, S, F> & {
     /** Anything else will be one of these types */
     [key: string]: boolean | number | string | object | any[] | null | undefined;
 };
 /** Type describing the well-known properties of the `UiSchema` while also supporting all user defined properties,
  * starting with `ui:`.
  */
-declare type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = GenericObjectType & MakeUIType<UIOptionsBaseType<T, S, F>> & {
+type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = GenericObjectType & MakeUIType<UIOptionsBaseType<T, S, F>> & {
     /** Allows the form to generate a unique prefix for the `Form`'s root prefix */
     "ui:rootFieldId"?: string;
     /** Allows RJSF to override the default field implementation by specifying either the name of a field that is used
@@ -674,13 +678,13 @@ declare type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
 /** A `CustomValidator` function takes in a `formData`, `errors` and `uiSchema` objects and returns the given `errors`
  * object back, while potentially adding additional messages to the `errors`
  */
-declare type CustomValidator<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (formData: T, errors: FormValidation<T>, uiSchema?: UiSchema<T, S, F>) => FormValidation<T>;
+type CustomValidator<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (formData: T | undefined, errors: FormValidation<T>, uiSchema?: UiSchema<T, S, F>) => FormValidation<T>;
 /** An `ErrorTransformer` function will take in a list of `errors` & a `uiSchema` and potentially return a
  * transformation of those errors in what ever way it deems necessary
  */
-declare type ErrorTransformer<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (errors: RJSFValidationError[], uiSchema?: UiSchema<T, S, F>) => RJSFValidationError[];
+type ErrorTransformer<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (errors: RJSFValidationError[], uiSchema?: UiSchema<T, S, F>) => RJSFValidationError[];
 /** The type that describes the data that is returned from the `ValidatorType.validateFormData()` function */
-declare type ValidationData<T> = {
+type ValidationData<T> = {
     /** The validation errors as a list of `RJSFValidationError` objects */
     errors: RJSFValidationError[];
     /** The validation errors in the form of an `ErrorSchema` */
@@ -716,7 +720,7 @@ interface ValidatorType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exte
      * @param formData - The form data to validate
      * @param rootSchema - The root schema used to provide $ref resolutions
      */
-    isValid(schema: S, formData: T, rootSchema: S): boolean;
+    isValid(schema: S, formData: T | undefined, rootSchema: S): boolean;
     /** Runs the pure validation of the `schema` and `formData` without any of the RJSF functionality. Provided for use
      * by the playground. Returns the `errors` from the validation
      *
@@ -767,13 +771,35 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      * @returns - True if the label should be displayed or false if it should not
      */
     getDisplayLabel(schema: S, uiSchema?: UiSchema<T, S, F>): boolean;
+    /** Determines which of the given `options` provided most closely matches the `formData`.
+     * Returns the index of the option that is valid and is the closest match, or 0 if there is no match.
+     *
+     * The closest match is determined using the number of matching properties, and more heavily favors options with
+     * matching readOnly, default, or const values.
+     *
+     * @param formData - The form data associated with the schema
+     * @param options - The list of options that can be selected from
+     * @param [selectedOption] - The index of the currently selected option, defaulted to -1 if not specified
+     * @returns - The index of the option that is the closest match to the `formData` or the `selectedOption` if no match
+     */
+    getClosestMatchingOption(formData: T | undefined, options: S[], selectedOption?: number): number;
+    /** Given the `formData` and list of `options`, attempts to find the index of the first option that matches the data.
+     * Always returns the first option if there is nothing that matches.
+     *
+     * @param formData - The current formData, if any, used to figure out a match
+     * @param options - The list of options to find a matching options from
+     * @returns - The firstindex of the matched option or 0 if none is available
+     */
+    getFirstMatchingOption(formData: T | undefined, options: S[]): number;
     /** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
+     * Deprecated, use `getFirstMatchingOption()` instead.
      *
      * @param formData - The current formData, if any, onto which to provide any missing defaults
      * @param options - The list of options to find a matching options from
      * @returns - The index of the matched option or 0 if none is available
+     * @deprecated
      */
-    getMatchingOption(formData: T, options: S[]): number;
+    getMatchingOption(formData: T | undefined, options: S[]): number;
     /** Checks to see if the `schema` and `uiSchema` combination represents an array of files
      *
      * @param schema - The schema for which check for array of files flag is desired
@@ -812,6 +838,18 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      * @returns - The schema having its conditions, additional properties, references and dependencies resolved
      */
     retrieveSchema(schema: S, formData?: T): S;
+    /** Sanitize the `data` associated with the `oldSchema` so it is considered appropriate for the `newSchema`. If the
+     * new schema does not contain any properties, then `undefined` is returned to clear all the form data. Due to the
+     * nature of schemas, this sanitization happens recursively for nested objects of data. Also, any properties in the
+     * old schema that are non-existent in the new schema are set to `undefined`.
+     *
+     * @param [newSchema] - The new schema for which the data is being sanitized
+     * @param [oldSchema] - The old schema from which the data originated
+     * @param [data={}] - The form data associated with the schema, defaulting to an empty object when undefined
+     * @returns - The new form data, with all of the fields uniquely associated with the old schema set
+     *      to `undefined`. Will return `undefined` if the new schema is not an object containing properties.
+     */
+    sanitizeDataForNewSchema(newSchema?: S, oldSchema?: S, data?: any): T;
     /** Generates an `IdSchema` object for the `schema`, recursively
      *
      * @param schema - The schema for which the display label flag is desired
@@ -891,6 +929,23 @@ declare function dataURItoBlob(dataURI: string): {
  */
 declare function deepEquals(a: any, b: any): boolean;
 
+/** 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
+ */
+declare function enumOptionsDeselectValue<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>["value"], selected: EnumOptionsType<S>["value"][]): any[];
+
+/** 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
+ */
+declare function enumOptionsSelectValue<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>["value"], selected: EnumOptionsType<S>["value"][], allEnumOptions?: EnumOptionsType<S>[]): any[];
+
 /** 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
@@ -1041,6 +1096,53 @@ declare function guessType(value: any): "array" | "string" | "null" | "boolean"
  */
 declare function hasWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(schema: RJSFSchema, widget: Widget<T, S, F> | string, registeredWidgets?: RegistryWidgetsType<T, S, F>): boolean;
 
+/** 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`
+ */
+declare function descriptionId<T = any>(id: IdSchema<T> | string): string;
+/** 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`
+ */
+declare function errorId<T = any>(id: IdSchema<T> | string): string;
+/** 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`
+ */
+declare function examplesId<T = any>(id: IdSchema<T> | string): string;
+/** 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`
+ */
+declare function helpId<T = any>(id: IdSchema<T> | string): string;
+/** 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`
+ */
+declare function titleId<T = any>(id: IdSchema<T> | string): string;
+/** 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
+ */
+declare function ariaDescribedByIds<T = any>(id: IdSchema<T> | string, includeExamples?: boolean): string;
+/** 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`
+ */
+declare function optionId<S extends StrictRJSFSchema = RJSFSchema>(id: string, option: EnumOptionsType<S>): string;
+
 /** This function checks if the given `schema` matches a single constant value. This happens when either the schema has
  * an `enum` array with a single value or there is a `const` defined.
  *
@@ -1089,11 +1191,11 @@ declare function localToUTC(dateString: string): string | undefined;
  *   - when the array is not set in form data, the default is copied over
  * - scalars are overwritten/set by form data
  *
- * @param defaults - The defaults to merge
- * @param formData - The form data into which the defaults will be merged
+ * @param [defaults] - The defaults to merge
+ * @param [formData] - The form data into which the defaults will be merged
  * @returns - The resulting merged form data with defaults
  */
-declare function mergeDefaultsWithFormData<T = any>(defaults: T, formData: T): T;
+declare function mergeDefaultsWithFormData<T = any>(defaults?: T, formData?: T): T | undefined;
 
 /** Recursively merge deeply nested objects.
  *
@@ -1273,13 +1375,48 @@ declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFS
  */
 declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
 
+/** Determines which of the given `options` provided most closely matches the `formData`. Using
+ * `getFirstMatchingOption()` to match two schemas that differ only by the readOnly, default or const value of a field
+ * based on the `formData` and returns 0 when there is no match. Rather than passing in all the `options` at once to
+ * this utility, instead an array of valid option indexes is created by iterating over the list of options, call
+ * `getFirstMatchingOptions` with a list of one junk option and one good option, seeing if the good option is considered
+ * matched.
+ *
+ * Once the list of valid indexes is created, if there is only one valid index, just return it. Otherwise, if there are
+ * no valid indexes, then fill the valid indexes array with the indexes of all the options. Next, the index of the
+ * option with the highest score is determined by iterating over the list of valid options, calling
+ * `calculateIndexScore()` on each, comparing it against the current best score, and returning the index of the one that
+ * eventually has the best score.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param rootSchema - The root JSON schema of the entire form
+ * @param formData - The form data associated with the schema
+ * @param options - The list of options that can be selected from
+ * @param [selectedOption=-1] - The index of the currently selected option, defaulted to -1 if not specified
+ * @returns - The index of the option that is the closest match to the `formData` or the `selectedOption` if no match
+ */
+declare function getClosestMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S, formData: T | undefined, options: S[], selectedOption?: number): number;
+
+/** Given the `formData` and list of `options`, attempts to find the index of the first option that matches the data.
+ * Always returns the first option if there is nothing that matches.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param formData - The current formData, if any, used to figure out a match
+ * @param options - The list of options to find a matching options from
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @returns - The index of the first matched option or 0 if none is available
+ */
+declare function getFirstMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, formData: T | undefined, options: S[], rootSchema: S): number;
+
 /** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
+ * Deprecated, use `getFirstMatchingOption()` instead.
  *
  * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
  * @param formData - The current formData, if any, used to figure out a match
  * @param options - The list of options to find a matching options from
  * @param rootSchema - The root schema, used to primarily to look up `$ref`s
  * @returns - The index of the matched option or 0 if none is available
+ * @deprecated
  */
 declare function getMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, formData: T | undefined, options: S[], rootSchema: S): number;
 
@@ -1335,6 +1472,55 @@ declare function mergeValidationData<T = any, S extends StrictRJSFSchema = RJSFS
  */
 declare function retrieveSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, rootSchema?: S, rawFormData?: T): S;
 
+/** Sanitize the `data` associated with the `oldSchema` so it is considered appropriate for the `newSchema`. If the new
+ * schema does not contain any properties, then `undefined` is returned to clear all the form data. Due to the nature
+ * of schemas, this sanitization happens recursively for nested objects of data. Also, any properties in the old schema
+ * that are non-existent in the new schema are set to `undefined`. The data sanitization process has the following flow:
+ *
+ * - If the new schema is an object that contains a `properties` object then:
+ *   - Create a `removeOldSchemaData` object, setting each key in the `oldSchema.properties` having `data` to undefined
+ *   - Create an empty `nestedData` object for use in the key filtering below:
+ *   - Iterate over each key in the `newSchema.properties` as follows:
+ *     - Get the `formValue` of the key from the `data`
+ *     - Get the `oldKeySchema` and `newKeyedSchema` for the key, defaulting to `{}` when it doesn't exist
+ *     - Retrieve the schema for any refs within each `oldKeySchema` and/or `newKeySchema`
+ *     - Get the types of the old and new keyed schemas and if the old doesn't exist or the old & new are the same then:
+ *       - If `removeOldSchemaData` has an entry for the key, delete it since the new schema has the same property
+ *       - If type of the key in the new schema is `object`:
+ *         - Store the value from the recursive `sanitizeDataForNewSchema` call in `nestedData[key]`
+ *       - Otherwise, check for default or const values:
+ *         - Get the old and new `default` values from the schema and check:
+ *           - If the new `default` value does not match the form value:
+ *             - If the old `default` value DOES match the form value, then:
+ *               - Replace `removeOldSchemaData[key]` with the new `default`
+ *               - Otherwise, if the new schema is `readOnly` then replace `removeOldSchemaData[key]` with undefined
+ *         - Get the old and new `const` values from the schema and check:
+ *           - If the new `const` value does not match the form value:
+ *           - If the old `const` value DOES match the form value, then:
+ *             - Replace `removeOldSchemaData[key]` with the new `const`
+ *             - Otherwise, replace `removeOldSchemaData[key]` with undefined
+ *   - Once all keys have been processed, return an object built as follows:
+ *     - `{ ...removeOldSchemaData, ...nestedData, ...pick(data, keysToKeep) }`
+ * - If the new and old schema types are array and the `data` is an array then:
+ *   - If the type of the old and new schema `items` are a non-array objects:
+ *     - Retrieve the schema for any refs within each `oldKeySchema.items` and/or `newKeySchema.items`
+ *     - If the `type`s of both items are the same (or the old does not have a type):
+ *       - If the type is "object", then:
+ *         - For each element in the `data` recursively sanitize the data, stopping at `maxItems` if specified
+ *       - Otherwise, just return the `data` removing any values after `maxItems` if it is set
+ *   - If the type of the old and new schema `items` are booleans of the same value, return `data` as is
+ * - Otherwise return `undefined`
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param rootSchema - The root JSON schema of the entire form
+ * @param [newSchema] - The new schema for which the data is being sanitized
+ * @param [oldSchema] - The old schema from which the data originated
+ * @param [data={}] - The form data associated with the schema, defaulting to an empty object when undefined
+ * @returns - The new form data, with all the fields uniquely associated with the old schema set
+ *      to `undefined`. Will return `undefined` if the new schema is not an object containing properties.
+ */
+declare function sanitizeDataForNewSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S, newSchema?: S, oldSchema?: S, data?: any): T;
+
 /** Generates an `IdSchema` object for the `schema`, recursively
  *
  * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
@@ -1359,4 +1545,4 @@ declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F
  */
 declare function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, 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, 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 };
+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, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, enumOptionsDeselectValue, enumOptionsSelectValue, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, processSelectValue, rangeSpec, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };