@rjsf/utils 6.0.0-beta.8 → 6.0.0

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { ButtonHTMLAttributes, ChangeEvent, ComponentType, HTMLAttributes, ReactElement, ReactNode, StyleHTMLAttributes } from 'react';
+import type { ButtonHTMLAttributes, ChangeEvent, ComponentType, FocusEvent, HTMLAttributes, ReactElement, ReactNode, StyleHTMLAttributes } from 'react';
 import { JSONSchema7 } from 'json-schema';
 import { TranslatableString } from './enums.js';
 /** The representation of any generic object type, usually used as an intersection on other types to make them more
@@ -20,6 +20,8 @@ export type FormContextType = GenericObjectType;
 /** The interface for the test ID proxy objects that are returned by the `getTestId` utility function.
  */
 export type TestIdShape = Record<string, string>;
+/** Function to generate HTML name attributes from path segments */
+export type NameGeneratorFunction = (path: FieldPathList, idPrefix: string, isMultiValue?: boolean) => string;
 /** Experimental feature that specifies the Array `minItems` default form state behavior
  */
 export type Experimental_ArrayMinItems = {
@@ -133,15 +135,25 @@ export type InputPropsType = Omit<RangeSpecType, 'step'> & {
     /** Specifies a filter for what file types the user can upload. */
     accept?: HTMLInputElement['accept'];
 };
-/** Type describing an id used for a field in the `IdSchema` */
-export type FieldId = {
+/** The list of path elements that represents where in the schema a field is located. When the item in the field list is
+ * a string, then it represents the name of the property within an object. When it is a number, then it represents the
+ * index within an array.
+ *
+ * For example:
+ * `[]` represents the root object of the schema
+ * `['foo', 'bar']` represents the `bar` element contained within the `foo` element of the schema
+ * `['baz', 1]` represents the second element in the list `baz` of the schema
+ */
+export type FieldPathList = (string | number)[];
+/** Type describing an id and path used for a field */
+export type FieldPathId = {
     /** The id for a field */
     $id: string;
+    /** The path for a field */
+    path: FieldPathList;
+    /** The optional HTML name attribute for a field, generated by nameGenerator if provided */
+    name?: string;
 };
-/** Type describing a recursive structure of `FieldId`s for an object with a non-empty set of keys */
-export type IdSchema<T = any> = T extends GenericObjectType ? FieldId & {
-    [key in keyof T]?: IdSchema<T[key]>;
-} : FieldId;
 /** Type describing a name used for a field in the `PathSchema` */
 export type FieldPath = {
     /** The name of a field */
@@ -174,6 +186,8 @@ export type RJSFValidationError = {
     schemaPath?: string;
     /** Full error name, for example ".name is a required property" */
     stack: string;
+    /** The title property for the failing field*/
+    title?: string;
 };
 /** The type that describes an error in a field */
 export type FieldError = string;
@@ -210,8 +224,6 @@ export type ErrorListProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
     errorSchema: ErrorSchema<T>;
     /** An array of the errors */
     errors: RJSFValidationError[];
-    /** The `formContext` object that was passed to `Form` */
-    formContext?: F;
 };
 /** The properties that are passed to an `FieldErrorTemplate` implementation */
 export type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
@@ -219,15 +231,15 @@ export type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     errorSchema?: ErrorSchema<T>;
     /** An array of the errors */
     errors?: Array<string | ReactElement>;
-    /** The tree of unique ids for every child field */
-    idSchema: IdSchema<T>;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
 };
 /** The properties that are passed to an `FieldHelpTemplate` implementation */
 export type FieldHelpProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
     /** The help information to be rendered */
     help?: string | ReactElement;
-    /** The tree of unique ids for every child field */
-    idSchema: IdSchema<T>;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
     /** Flag indicating whether there are errors associated with this field */
     hasErrors?: boolean;
 };
@@ -257,9 +269,9 @@ export type TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     /** The template to use while rendering the description for an array field */
     ArrayFieldDescriptionTemplate: ComponentType<ArrayFieldDescriptionProps<T, S, F>>;
     /** The template to use while rendering the buttons for an item in an array field */
-    ArrayFieldItemButtonsTemplate: ComponentType<ArrayFieldItemButtonsTemplateType<T, S, F>>;
+    ArrayFieldItemButtonsTemplate: ComponentType<ArrayFieldItemButtonsTemplateProps<T, S, F>>;
     /** The template to use while rendering an item in an array field */
-    ArrayFieldItemTemplate: ComponentType<ArrayFieldItemTemplateType<T, S, F>>;
+    ArrayFieldItemTemplate: ComponentType<ArrayFieldItemTemplateProps<T, S, F>>;
     /** The template to use while rendering the title for an array field */
     ArrayFieldTitleTemplate: ComponentType<ArrayFieldTitleProps<T, S, F>>;
     /** The template to use while rendering the standard html input */
@@ -268,6 +280,8 @@ export type TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     DescriptionFieldTemplate: ComponentType<DescriptionFieldProps<T, S, F>>;
     /** The template to use while rendering the errors for the whole form */
     ErrorListTemplate: ComponentType<ErrorListProps<T, S, F>>;
+    /** The template to use while rendering a fallback field for schemas that have an empty or unknown 'type' */
+    FallbackFieldTemplate: ComponentType<FallbackFieldTemplateProps<T, S, F>>;
     /** The template to use while rendering the errors for a single field */
     FieldErrorTemplate: ComponentType<FieldErrorProps<T, S, F>>;
     /** The template to use while rendering the errors for a single field */
@@ -276,8 +290,12 @@ export type TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     FieldTemplate: ComponentType<FieldTemplateProps<T, S, F>>;
     /** The template to use to render a Grid element */
     GridTemplate: ComponentType<GridTemplateProps>;
+    /** The template to use while rendering a multi-schema field (i.e. anyOf, oneOf) */
+    MultiSchemaFieldTemplate: ComponentType<MultiSchemaFieldTemplateProps<T, S, F>>;
     /** The template to use while rendering an object */
     ObjectFieldTemplate: ComponentType<ObjectFieldTemplateProps<T, S, F>>;
+    /** The template to use while rendering the Optional Data field controls */
+    OptionalDataControlsTemplate: ComponentType<OptionalDataControlsTemplateProps<T, S, F>>;
     /** The template to use for rendering the title of a field */
     TitleFieldTemplate: ComponentType<TitleFieldProps<T, S, F>>;
     /** The template to use for rendering information about an unsupported field type in the schema */
@@ -327,6 +345,35 @@ export type GlobalUISchemaOptions = GenericObjectType & {
     /** Enables the displaying of description text that contains markdown
      */
     enableMarkdownInDescription?: boolean;
+    /** Enables the rendering of the Optional Data Field UI for specific types of schemas, either `object`, `array` or
+     * both. To disable the Optional Data Field UI for a specific field, provide an empty array within the UI schema.
+     */
+    enableOptionalDataFieldForType?: ('object' | 'array')[];
+};
+/** The set of options from the `Form` that will be available on the `Registry` for use in everywhere the `registry` is
+ * available.
+ */
+export type GlobalFormOptions = {
+    /** To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids;
+     * Default is `root`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
+     */
+    readonly 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 `_`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
+     */
+    readonly idSeparator: string;
+    /** The component update strategy used by the Form and its fields for performance optimization */
+    readonly experimental_componentUpdateStrategy?: 'customDeep' | 'shallow' | 'always';
+    /** Optional function to generate custom HTML name attributes for form elements. Receives the field path segments
+     * and element type (object or array), and returns a custom name string. This allows backends like PHP/Rails
+     * (`root[tasks][0][title]`) or Django (`root__tasks-0__title`) to receive form data in their expected format.
+     */
+    readonly nameGenerator?: NameGeneratorFunction;
+    /**
+     * Boolean flag that, when set to true, will cause the form to use a fallback UI when encountering a schema type that
+     * is not supported by RJSF or a custom field. When false, the UnsupportedField error component will be shown instead.
+     */
+    readonly useFallbackUiForUnsupportedType?: boolean;
 };
 /** The object containing the registered core, theme and custom fields and widgets as well as the root schema, form
  * context, schema utils and templates.
@@ -336,7 +383,7 @@ export interface Registry<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      * registered fields
      */
     fields: RegistryFieldsType<T, S, F>;
-    /** The set of templates used by the `Form`. Includes templates from `core`, theme-specific fields and any custom
+    /** The set of templates used by the `Form`. Includes templates from `core`, theme-specific templates and any custom
      * registered templates
      */
     templates: TemplatesType<T, S, F>;
@@ -354,25 +401,27 @@ export interface Registry<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     schemaUtils: SchemaUtilsType<T, S>;
     /** The string translation function to use when displaying any of the RJSF strings in templates, fields or widgets */
     translateString: (stringKey: TranslatableString, params?: string[]) => string;
+    /** The global Form Options that are available for all templates, fields and widgets to access */
+    readonly globalFormOptions: GlobalFormOptions;
     /** The optional global UI Options that are available for all templates, fields and widgets to access */
     globalUiOptions?: GlobalUISchemaOptions;
 }
-/** The properties that are passed to a Field implementation */
+/** The properties that are passed to a `Field` implementation */
 export interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, RJSFBaseProps<T, S, F>, Pick<HTMLAttributes<HTMLElement>, Exclude<keyof HTMLAttributes<HTMLElement>, 'onBlur' | 'onFocus' | 'onChange'>> {
-    /** The tree of unique ids for every child field */
-    idSchema: IdSchema<T>;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
     /** The data for this field */
     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 | undefined, es?: ErrorSchema<T>, id?: string) => any;
+    /** The field change event handler; called with the updated field value, the change path for the value
+     * (defaults to an empty array), an optional ErrorSchema and the optional id of the field being changed
+     */
+    onChange: (newValue: T | undefined, path: FieldPathList, es?: ErrorSchema<T>, id?: string) => void;
     /** 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 */
     onFocus: (id: string, value: any) => void;
-    /** The `formContext` object that you passed to `Form` */
-    formContext?: F;
     /** A boolean value stating if the field should autofocus */
     autofocus?: boolean;
     /** A boolean value stating if the field is disabled */
@@ -385,14 +434,6 @@ export interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     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[];
 }
@@ -401,7 +442,7 @@ export type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
     /** The optional TEST_IDS block that some fields contain, exported for testing purposes */
     TEST_IDS?: TestIdShape;
 };
-/** The properties that are passed to a FieldTemplate implementation */
+/** The properties that are passed to a `FieldTemplate` implementation */
 export type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
     /** The id of the field in the hierarchy. You can use it to render a label targeting the wrapped widget */
     id: string;
@@ -443,21 +484,37 @@ export type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema,
      * you don't want to clutter the UI
      */
     displayLabel?: boolean;
-    /** The `formContext` object that was passed to `Form` */
-    formContext?: F;
     /** The formData for this field */
     formData?: T;
     /** The value change event handler; Can be called with a new value to change the value for this field */
     onChange: FieldProps<T, S, F>['onChange'];
-    /** The key change event handler; Called when the key associated with a field is changed for an additionalProperty */
-    onKeyChange: (value: string) => () => void;
-    /** The property drop/removal event handler; Called when a field is removed in an additionalProperty context */
-    onDropPropertyClick: (value: string) => () => void;
+    /** Callback used to handle the changing of an additional property key's name with the new value
+     */
+    onKeyRename: (newKey: string) => void;
+    /** Callback used to handle the changing of an additional property key's name when the input is blurred. The event's
+     * target's value will be used as the new value. Its a wrapper callback around `onKeyRename`
+     */
+    onKeyRenameBlur: (event: FocusEvent<HTMLInputElement>) => void;
+    /** Callback used to handle the removal of the additionalProperty */
+    onRemoveProperty: () => void;
+};
+/**
+ * The properties that are passed to a `FallbackField` implementation
+ */
+export type FallbackFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = FieldProps<T, S, F>;
+/**
+ * The properties that are passed to a `FallbackFieldTemplate` implementation
+ */
+export type FallbackFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
+    /** A ReactNode that allows the selecting a different type for the field */
+    typeSelector: ReactNode;
+    /** A ReactNode that renders the field with the present formData and matches the selected type */
+    schemaField: ReactNode;
 };
 /** The properties that are passed to the `UnsupportedFieldTemplate` implementation */
 export type UnsupportedFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
-    /** The tree of unique ids for every child field */
-    idSchema?: IdSchema<T>;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
     /** The reason why the schema field has an unsupported type */
     reason: string;
 };
@@ -469,6 +526,8 @@ export type TitleFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     title: string;
     /** A boolean value stating if the field is required */
     required?: boolean;
+    /** Add optional data control */
+    optionalDataControl?: ReactNode;
 };
 /** The properties that are passed to a `DescriptionFieldTemplate` implementation */
 export type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
@@ -481,20 +540,22 @@ export type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSche
 export 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 FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
+    /** Add optional data control */
+    optionalDataControl?: ReactNode;
 };
 /** The properties that are passed to a `ArrayFieldDescriptionTemplate` implementation */
 export 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 | ReactElement;
-    /** The idSchema of the field in the hierarchy */
-    idSchema: IdSchema<T>;
+    /** An object containing the id and path for this field */
+    fieldPathId: FieldPathId;
 };
 /** The properties of the buttons to render for each element in the ArrayFieldTemplateProps.items array */
-export type ArrayFieldItemButtonsTemplateType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
-    /** The idSchema of the item for which buttons are being rendered */
-    idSchema: IdSchema<T>;
+export type ArrayFieldItemButtonsTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
+    /** The FieldPathId of the item for which buttons are being rendered */
+    fieldPathId: FieldPathId;
     /** The className string */
     className?: string;
     /** Any optional style attributes */
@@ -515,23 +576,25 @@ export type ArrayFieldItemButtonsTemplateType<T = any, S extends StrictRJSFSchem
     index: number;
     /** A number stating the total number `items` in the array */
     totalItems: number;
-    /** Returns a function that adds a new item at `index` */
-    onAddIndexClick: (index: number) => (event?: any) => void;
-    /** Returns a function that copies the item at `index` into the position at `index + 1` */
-    onCopyIndexClick: (index: number) => (event?: any) => void;
-    /** Returns a function that removes the item at `index` */
-    onDropIndexClick: (index: number) => (event?: any) => void;
-    /** Returns a function that swaps the items at `index` with `newIndex` */
-    onReorderClick: (index: number, newIndex: number) => (event?: any) => void;
+    /** Callback function that adds a new item below this item */
+    onAddItem: (event?: any) => void;
+    /** Callback function that copies this item below itself */
+    onCopyItem: (event?: any) => void;
+    /** Callback function that moves the item up one spot in the list */
+    onMoveUpItem: (event?: any) => void;
+    /** Callback function that moves the item down one spot in the list */
+    onMoveDownItem: (event?: any) => void;
+    /** Callback function that removes the item from the list */
+    onRemoveItem: (event?: any) => void;
     /** A boolean value stating if the array item is read-only */
     readonly?: boolean;
 };
-/** The properties of each element in the ArrayFieldTemplateProps.items array */
-export type ArrayFieldItemTemplateType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
+/** The properties used to render the ArrayFieldItemTemplate */
+export type ArrayFieldItemTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
     /** The html for the item's content */
     children: ReactNode;
     /** The props to pass to the `ArrayFieldItemButtonTemplate` */
-    buttonsProps: ArrayFieldItemButtonsTemplateType<T, S, F>;
+    buttonsProps: ArrayFieldItemButtonsTemplateProps<T, S, F>;
     /** The className string */
     className: string;
     /** A boolean value stating if the array item is disabled */
@@ -545,26 +608,20 @@ export type ArrayFieldItemTemplateType<T = any, S extends StrictRJSFSchema = RJS
     /** A boolean value stating if the array item is read-only */
     readonly?: boolean;
     /** A stable, unique key for the array item */
-    key: string;
+    itemKey: string;
+    /** The UI schema of the array item's parent array field used for
+     * customization in some themes
+     */
+    parentUiSchema?: UiSchema<T, S, F>;
 };
-/**
- * @deprecated - Use `ArrayFieldItemTemplateType` instead
- */
-export type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ArrayFieldItemTemplateType<T, S, F>;
-/** The properties that are passed to an ArrayFieldTemplate implementation */
-export type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
-    /** A boolean value stating whether new elements can be added to the array */
-    canAdd?: boolean;
+/** The common properties of the two container templates: `ArrayFieldTemplateProps` and `ObjectFieldTemplateProps` */
+export type ContainerFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
     /** The className string */
     className?: string;
     /** A boolean value stating if the array is disabled */
     disabled?: boolean;
-    /** An object containing the id for this object & ids for its properties */
-    idSchema: IdSchema<T>;
-    /** An array of objects representing the items in the array */
-    items: ArrayFieldItemTemplateType<T, S, F>[];
-    /** A function that adds a new item to the array */
-    onAddClick: (event?: any) => void;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
     /** A boolean value stating if the array is read-only */
     readonly?: boolean;
     /** A boolean value stating if the array is required */
@@ -573,12 +630,21 @@ export type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSc
     hideError?: boolean;
     /** A string value containing the title for the array */
     title: string;
-    /** The `formContext` object that was passed to Form */
-    formContext?: F;
     /** The formData for this array */
     formData?: T;
-    /** The tree of errors for this field and its children */
+    /** The optional validation errors in the form of an `ErrorSchema` */
     errorSchema?: ErrorSchema<T>;
+    /** The optional data control node to render within the ObjectFieldTemplate that controls */
+    optionalDataControl?: ReactNode;
+};
+/** The properties that are passed to an `ArrayFieldTemplate` implementation */
+export type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ContainerFieldTemplateProps<T, S, F> & {
+    /** A boolean value stating whether new elements can be added to the array */
+    canAdd?: boolean;
+    /** An array of React elements representing the items in the array */
+    items: ReactElement[];
+    /** A function that adds a new item to the end of the array */
+    onAddClick: (event?: any) => void;
     /** An array of strings listing all generated error messages from encountered errors for this widget */
     rawErrors?: string[];
 };
@@ -596,39 +662,53 @@ export type ObjectFieldTemplatePropertyType = {
     hidden: boolean;
 };
 /** The properties that are passed to an ObjectFieldTemplate implementation */
-export type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
-    /** A string value containing the title for the object */
-    title: string;
+export type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ContainerFieldTemplateProps<T, S, F> & {
     /** A string value containing the description for the object */
     description?: string | ReactElement;
-    /** A boolean value stating if the object is disabled */
-    disabled?: boolean;
     /** An array of objects representing the properties in the object */
     properties: ObjectFieldTemplatePropertyType[];
-    /** Returns a function that adds a new property to the object (to be used with additionalProperties) */
-    onAddClick: (schema: S) => () => void;
+    /** Callback to use in order to add an new additionalProperty to the object field  (to be used with
+     * additionalProperties and patternProperties)
+     */
+    onAddProperty: () => void;
     /** A boolean value stating if the object is read-only */
     readonly?: boolean;
     /** A boolean value stating if the object is required */
     required?: boolean;
     /** A boolean value stating if the field is hiding its errors */
     hideError?: boolean;
-    /** An object containing the id for this object & ids for its properties */
-    idSchema: IdSchema<T>;
+    /** The FieldPathId of the field in the hierarchy */
+    fieldPathId: FieldPathId;
     /** The optional validation errors in the form of an `ErrorSchema` */
     errorSchema?: ErrorSchema<T>;
     /** The form data for the object */
     formData?: T;
-    /** The `formContext` object that was passed to Form */
-    formContext?: F;
+};
+/** The properties that are passed to a OptionalDataControlsTemplate implementation */
+export type OptionalDataControlsTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
+    /** The generated id for this Optional Data Control instance */
+    id: string;
+    /** The label to use for the Optional Data Control */
+    label: string;
+    /** Optional callback to call when clicking on the Optional Data Control to add data */
+    onRemoveClick?: () => void;
+    /** Optional callback to call when clicking on the Optional Data Control to remove data */
+    onAddClick?: () => void;
 };
 /** The properties that are passed to a WrapIfAdditionalTemplate implementation */
 export type WrapIfAdditionalTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
     /** The field or widget component instance for this field row */
     children: ReactNode;
-} & Pick<FieldTemplateProps<T, S, F>, 'id' | 'classNames' | 'hideError' | 'rawErrors' | 'style' | 'label' | 'required' | 'readonly' | 'disabled' | 'schema' | 'uiSchema' | 'onKeyChange' | 'onDropPropertyClick' | 'registry'>;
-/** The properties that are passed to a Widget implementation */
-export interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, RJSFBaseProps<T, S, F>, Pick<HTMLAttributes<HTMLElement>, Exclude<keyof HTMLAttributes<HTMLElement>, 'onBlur' | 'onFocus'>> {
+} & Pick<FieldTemplateProps<T, S, F>, 'id' | 'classNames' | 'hideError' | 'rawErrors' | 'style' | 'label' | 'required' | 'readonly' | 'disabled' | 'schema' | 'uiSchema' | 'onKeyRename' | 'onKeyRenameBlur' | 'onRemoveProperty' | 'registry'>;
+/** The properties that are passed to a MultiSchemaFieldTemplate implementation */
+export interface MultiSchemaFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends RJSFBaseProps<T, S, F> {
+    /** The rendered widget used to select a schema option */
+    selector: ReactNode;
+    /** The rendered SchemaField for the selected schema option */
+    optionSchemaField: ReactNode;
+}
+/** The properties that are passed to a `Widget` implementation */
+export interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, RJSFBaseProps<T, S, F>, Pick<HTMLAttributes<HTMLElement>, Exclude<keyof HTMLAttributes<HTMLElement>, 'onBlur' | 'onFocus' | 'onChange'>> {
     /** The generated id for this widget, used to provide unique `name`s and `id`s for the HTML field elements rendered by
      * widgets
      */
@@ -658,8 +738,6 @@ export interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
         /** The enum options list for a type that supports them */
         enumOptions?: EnumOptionsType<S>[];
     };
-    /** The `formContext` object that you passed to `Form` */
-    formContext?: F;
     /** The input blur event handler; call it with the widget id and value */
     onBlur: (id: string, value: any) => void;
     /** The value change event handler; call it with the new value every time it changes */
@@ -676,6 +754,8 @@ export interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     multiple?: boolean;
     /** An array of strings listing all generated error messages from encountered errors for this widget */
     rawErrors?: string[];
+    /** The optional custom HTML name attribute generated by the nameGenerator function, if provided */
+    htmlName?: string;
 }
 /** The definition of a React-based Widget component */
 export type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ComponentType<WidgetProps<T, S, F>>;
@@ -792,6 +872,12 @@ export type UIOptionsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     /** Anything else will be one of these types */
     [key: string]: boolean | number | string | object | any[] | null | undefined;
 };
+/**
+ * A utility type that extracts the element type from an array type.
+ * If the type is not an array, it returns the type itself as a safe fallback.
+ * Handles both standard arrays and readonly arrays.
+ */
+export type ArrayElement<A> = A extends readonly (infer E)[] ? E : A;
 /** Type describing the well-known properties of the `UiSchema` while also supporting all user defined properties,
  * starting with `ui:`.
  */
@@ -800,7 +886,10 @@ export type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
      * Registry for use everywhere.
      */
     'ui:globalOptions'?: GlobalUISchemaOptions;
-    /** Allows the form to generate a unique prefix for the `Form`'s root prefix  */
+    /** Allows the form to generate a unique prefix for the `Form`'s root prefix
+     *
+     * @deprecated - use `Form.idPrefix` instead, will be removed in a future major version
+     */
     'ui:rootFieldId'?: string;
     /** By default, any field that is rendered for an `anyOf`/`oneOf` schema will be wrapped inside the `AnyOfField` or
      * `OneOfField` component. This default behavior may be undesirable if your custom field already handles behavior
@@ -812,6 +901,11 @@ export type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     'ui:fieldReplacesAnyOrOneOf'?: boolean;
     /** An object that contains all the potential UI options in a single object */
     'ui:options'?: UIOptionsType<T, S, F>;
+    /** The uiSchema for items in an array. Can be an object for a uniform uiSchema across all items (current behavior),
+     * or a function that returns a dynamic uiSchema based on the item's data and index.
+     * When using a function, it receives the item data, index, and optionally the form context as parameters.
+     */
+    items?: UiSchema<ArrayElement<T>, S, F> | ((itemData: ArrayElement<T>, index: number, formContext?: F) => UiSchema<ArrayElement<T>, S, F>);
 };
 /** 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`
@@ -882,6 +976,11 @@ export interface FoundFieldType<S extends StrictRJSFSchema = RJSFSchema> {
  * set of APIs to the `@rjsf/core` components and the various themes as well.
  */
 export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
+    /** Returns the `rootSchema` in the `SchemaUtilsType`
+     *
+     * @returns - The rootSchema
+     */
+    getRootSchema(): S;
     /** Returns the `ValidatorType` in the `SchemaUtilsType`
      *
      * @returns - The `ValidatorType`
@@ -928,9 +1027,10 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
      * @param [includeUndefinedValues=false] - 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.
+     * @param initialDefaultsGenerated - Indicates whether or not initial defaults have been generated
      * @returns - The resulting `formData` with all the defaults provided
      */
-    getDefaultFormState(schema: S, formData?: T, includeUndefinedValues?: boolean | 'excludeObjectChildren'): T | T[] | undefined;
+    getDefaultFormState(schema: S, formData?: T, includeUndefinedValues?: boolean | 'excludeObjectChildren', initialDefaultsGenerated?: boolean): T | T[] | undefined;
     /** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
      * should be displayed in a UI.
      *
@@ -1000,9 +1100,10 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
      *
      * @param schema - The schema for which retrieving a schema is desired
      * @param [formData] - The current formData, if any, to assist retrieving a schema
+     * @param [resolveAnyOfOrOneOfRefs] - Optional flag indicating whether to resolved refs in anyOf/oneOf lists
      * @returns - The schema having its conditions, additional properties, references and dependencies resolved
      */
-    retrieveSchema(schema: S, formData?: T): S;
+    retrieveSchema(schema: S, formData?: T, resolveAnyOfOrOneOfRefs?: boolean): 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
@@ -1015,16 +1116,6 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
      *      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
-     * @param [id] - The base id for the schema
-     * @param [formData] - The current formData, if any, onto which to provide any missing defaults
-     * @param [idPrefix='root'] - The prefix to use for the id
-     * @param [idSeparator='_'] - The separator to use for the path segments in the id
-     * @returns - The `IdSchema` object for the `schema`
-     */
-    toIdSchema(schema: S, id?: string, formData?: T, idPrefix?: string, idSeparator?: string): IdSchema<T>;
     /** Generates an `PathSchema` object for the `schema`, recursively
      *
      * @param schema - The schema for which the display label flag is desired

package/lib/useAltDateWidgetProps.d.ts

@@ -0,0 +1,39 @@
+import { MouseEvent } from 'react';
+import { DateElementProp } from './getDateElementProps.js';
+import { DateObject, FormContextType, RJSFSchema, StrictRJSFSchema, WidgetProps } from './types.js';
+/** The Props for the `DateElement` component */
+export type DateElementProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Pick<WidgetProps<T, S, F>, 'value' | 'name' | 'disabled' | 'readonly' | 'autofocus' | 'registry' | 'onBlur' | 'onFocus' | 'className'> & {
+    /** The root id of the field */
+    rootId: string;
+    /** The selector function for a specific prop within the `DateObject`, for a value */
+    select: (property: keyof DateObject, value: any) => void;
+    /** The type of the date element */
+    type: DateElementProp['type'];
+    /** The range for the date element */
+    range: DateElementProp['range'];
+};
+/** The `DateElement` component renders one of the 6 date element selectors for an `AltDateWidget`, using the `select`
+ * widget from the registry.
+ *
+ * @param props - The `DateElementProps` for the date element
+ */
+export declare function DateElement<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(props: DateElementProps<T, S, F>): import("react/jsx-runtime").JSX.Element;
+/** The result of a call to the `useAltDateWidgetProps()` hook */
+export type UseAltDateWidgetResult = {
+    /** The list of `DateElementProp` data to render for the `AltDateWidget` */
+    elements: DateElementProp[];
+    /** The callback that handles the changing of DateElement components */
+    handleChange: (property: keyof DateObject, value?: string) => void;
+    /** The callback that will clear the `AltDateWidget` when a button is clicked */
+    handleClear: (event: MouseEvent) => void;
+    /** The callback that will set the `AltDateWidget` to NOW when a button is clicked */
+    handleSetNow: (event: MouseEvent) => void;
+};
+/** Hook which encapsulates the logic needed to render an `AltDateWidget` with optional `time` elements. It contains
+ * the `state` of the current date(/time) selections in the widget. It returns a `UseAltDateWidgetResult` object
+ * that contains the `elements: DateElementProp[]` and three callbacks needed to change one of the rendered `elements`,
+ * and to handle the clicking of the `clear` and `setNow` buttons.
+ *
+ * @param props - The `WidgetProps` for the `AltDateWidget`
+ */
+export default function useAltDateWidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(props: WidgetProps<T, S, F>): UseAltDateWidgetResult;