@rjsf/utils 6.0.0-beta.2 → 6.0.0-beta.21

package/lib/types.d.ts

@@ -133,15 +133,23 @@ 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;
 };
-/** 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 +182,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 +220,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 +227,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;
 };
@@ -276,8 +284,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 */
@@ -306,9 +318,10 @@ export type TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     } | undefined;
 };
 /** The set of UiSchema options that can be set globally and used as fallbacks at an individual template, field or
- * widget level when no field-level value of the option is provided.
+ * widget level when no field-level value of the option is provided. Extends GenericObjectType to support allowing users
+ * to provide any value they need for their customizations.
  */
-export type GlobalUISchemaOptions = {
+export type GlobalUISchemaOptions = GenericObjectType & {
     /** Flag, if set to `false`, new items cannot be added to array fields, unless overridden (defaults to true) */
     addable?: boolean;
     /** Flag, if set to `true`, array items can be copied (defaults to false) */
@@ -326,6 +339,25 @@ export type GlobalUISchemaOptions = {
     /** 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';
 };
 /** The object containing the registered core, theme and custom fields and widgets as well as the root schema, form
  * context, schema utils and templates.
@@ -335,7 +367,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>;
@@ -353,25 +385,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 */
@@ -384,20 +418,15 @@ 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[];
 }
 /** The definition of a React-based Field component */
-export type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ComponentType<FieldProps<T, S, F>>;
-/** The properties that are passed to a FieldTemplate implementation */
+export type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ComponentType<FieldProps<T, S, F>> & {
+    /** 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 */
 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;
@@ -439,8 +468,6 @@ 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 */
@@ -452,8 +479,8 @@ export type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema,
 };
 /** 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;
 };
@@ -465,6 +492,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> & {
@@ -477,20 +506,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>;
+    /** The FieldPathId of the item for which buttons are being rendered */
+    fieldPathId: FieldPathId;
     /** The className string */
     className?: string;
     /** Any optional style attributes */
@@ -547,20 +578,14 @@ export type ArrayFieldItemTemplateType<T = any, S extends StrictRJSFSchema = RJS
  * @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 */
@@ -569,12 +594,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 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;
     /** An array of strings listing all generated error messages from encountered errors for this widget */
     rawErrors?: string[];
 };
@@ -592,13 +626,9 @@ 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) */
@@ -609,22 +639,38 @@ export type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFS
     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'>> {
+/** 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
      */
@@ -654,8 +700,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 */
@@ -788,6 +832,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:`.
  */
@@ -796,7 +846,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
@@ -808,6 +861,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`
@@ -878,6 +936,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`
@@ -924,9 +987,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.
      *
@@ -996,9 +1060,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
@@ -1011,16 +1076,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/validationDataMerge.d.ts

@@ -6,6 +6,7 @@ import { ErrorSchema, ValidationData } from './types.js';
  *
  * @param validationData - The current `ValidationData` into which to merge the additional errors
  * @param [additionalErrorSchema] - The optional additional set of errors in an `ErrorSchema`
+ * @param [preventDuplicates=false] - Optional flag, if true, will call `mergeObjects()` with `preventDuplicates`
  * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
  */
-export default function validationDataMerge<T = any>(validationData: ValidationData<T>, additionalErrorSchema?: ErrorSchema<T>): ValidationData<T>;
+export default function validationDataMerge<T = any>(validationData: ValidationData<T>, additionalErrorSchema?: ErrorSchema<T>, preventDuplicates?: boolean): ValidationData<T>;

package/lib/validationDataMerge.js

@@ -8,9 +8,10 @@ import toErrorList from './toErrorList.js';
  *
  * @param validationData - The current `ValidationData` into which to merge the additional errors
  * @param [additionalErrorSchema] - The optional additional set of errors in an `ErrorSchema`
+ * @param [preventDuplicates=false] - Optional flag, if true, will call `mergeObjects()` with `preventDuplicates`
  * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
  */
-export default function validationDataMerge(validationData, additionalErrorSchema) {
+export default function validationDataMerge(validationData, additionalErrorSchema, preventDuplicates = false) {
     if (!additionalErrorSchema) {
         return validationData;
     }
@@ -18,7 +19,7 @@ export default function validationDataMerge(validationData, additionalErrorSchem
     let errors = toErrorList(additionalErrorSchema);
     let errorSchema = additionalErrorSchema;
     if (!isEmpty(oldErrorSchema)) {
-        errorSchema = mergeObjects(oldErrorSchema, additionalErrorSchema, true);
+        errorSchema = mergeObjects(oldErrorSchema, additionalErrorSchema, preventDuplicates ? 'preventDuplicates' : true);
         errors = [...oldErrors].concat(errors);
     }
     return { errorSchema, errors };

package/lib/validationDataMerge.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationDataMerge.js","sourceRoot":"","sources":["../src/validationDataMerge.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,WAAW,MAAM,eAAe,CAAC;AAGxC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CACzC,cAAiC,EACjC,qBAAsC;IAEtC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,cAAc,CAAC;IAC1E,IAAI,MAAM,GAAG,WAAW,CAAC,qBAAqB,CAAC,CAAC;IAChD,IAAI,WAAW,GAAG,qBAAqB,CAAC;IACxC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAC7B,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,qBAAqB,EAAE,IAAI,CAAmB,CAAC;QAC1F,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AACjC,CAAC"}
+{"version":3,"file":"validationDataMerge.js","sourceRoot":"","sources":["../src/validationDataMerge.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,WAAW,MAAM,eAAe,CAAC;AAGxC;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CACzC,cAAiC,EACjC,qBAAsC,EACtC,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,cAAc,CAAC;IAC1E,IAAI,MAAM,GAAG,WAAW,CAAC,qBAAqB,CAAC,CAAC;IAChD,IAAI,WAAW,GAAG,qBAAqB,CAAC;IACxC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAC7B,WAAW,GAAG,YAAY,CACxB,cAAc,EACd,qBAAqB,EACrB,iBAAiB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAC7B,CAAC;QACpB,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AACjC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "6.0.0-beta.2",
+  "version": "6.0.0-beta.21",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -9,27 +9,27 @@
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
-      "require": "./dist/index.js",
+      "require": "./dist/index.cjs",
       "import": "./lib/index.js"
     },
     "./lib": {
       "types": "./lib/index.d.ts",
-      "require": "./dist/index.js",
+      "require": "./dist/index.cjs",
       "import": "./lib/index.js"
     },
     "./lib/*.js": {
       "types": "./lib/*.d.ts",
-      "require": "./dist/*.js",
+      "require": "./dist/*.cjs",
       "import": "./lib/*.js"
     },
     "./dist": {
       "types": "./lib/index.d.ts",
-      "require": "./dist/index.js",
+      "require": "./dist/index.cjs",
       "import": "./lib/index.js"
     },
-    "./dist/*.js": {
+    "./dist/*.cjs": {
       "types": "./lib/*.d.ts",
-      "require": "./dist/*.js",
+      "require": "./dist/*.cjs",
       "import": "./lib/*.js"
     }
   },
@@ -45,7 +45,7 @@
   "scripts": {
     "compileReplacer": "tsc -p tsconfig.replacer.json && move-file lodashReplacer.js lodashReplacer.cjs",
     "build:ts": "npm run compileReplacer && rimraf ./lib && tsc -b tsconfig.build.json && tsc-alias -p tsconfig.build.json",
-    "build:cjs": "esbuild ./src/index.ts --bundle --outfile=dist/index.js --sourcemap --packages=external --format=cjs",
+    "build:cjs": "esbuild ./src/index.ts --bundle --outfile=dist/index.cjs --sourcemap --packages=external --format=cjs",
     "build:esm": "esbuild ./src/index.ts --bundle --outfile=dist/utils.esm.js --sourcemap --packages=external --format=esm",
     "build:umd": "rollup dist/utils.esm.js --format=umd --file=dist/utils.umd.js --name=@rjsf/utils",
     "build": "npm run build:ts && npm run build:cjs && npm run build:esm && npm run build:umd",
@@ -65,20 +65,19 @@
     "react": ">=18"
   },
   "dependencies": {
-    "fast-uri": "^3.0.6",
+    "fast-uri": "^3.1.0",
     "json-schema-merge-allof": "^0.8.1",
     "jsonpointer": "^5.0.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
-    "nanoid": "^5.1.5",
-    "react-is": "^18.2.0"
+    "react-is": "^18.3.1"
   },
   "devDependencies": {
     "@types/json-schema": "^7.0.15",
     "@types/json-schema-merge-allof": "^0.6.5",
-    "@types/react-is": "^18.2.4",
-    "deep-freeze-es6": "^1.4.1",
-    "eslint": "^8.56.0"
+    "@types/react-is": "^18.3.1",
+    "deep-freeze-es6": "^4.0.1",
+    "eslint": "^8.57.1"
   },
   "publishConfig": {
     "access": "public"

package/src/ErrorSchemaBuilder.ts

@@ -3,13 +3,13 @@ import get from 'lodash/get';
 import set from 'lodash/set';
 import setWith from 'lodash/setWith';
 
-import { ErrorSchema } from './types';
+import { ErrorSchema, FieldPathList } from './types';
 import { ERRORS_KEY } from './constants';
 
 /** Represents the type of the path which can be a string of dotted path values or a list of string or numbers where
  * numbers represent array indexes/
  */
-export type PathType = string | (string | number)[];
+export type PathType = string | FieldPathList;
 
 /** 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

package/src/constants.ts

@@ -26,6 +26,8 @@ export const REQUIRED_KEY = 'required';
 export const SUBMIT_BTN_OPTIONS_KEY = 'submitButtonOptions';
 export const REF_KEY = '$ref';
 export const SCHEMA_KEY = '$schema';
+export const DEFAULT_ID_PREFIX = 'root';
+export const DEFAULT_ID_SEPARATOR = '_';
 /** The path of the discriminator value returned by the schema endpoint.
  * The discriminator is the value in a `oneOf` that determines which option is selected.
  */
@@ -46,4 +48,5 @@ export const UI_GLOBAL_OPTIONS_KEY = 'ui:globalOptions';
 
 /** The JSON Schema version strings
  */
+export const JSON_SCHEMA_DRAFT_2019_09 = 'https://json-schema.org/draft/2019-09/schema';
 export const JSON_SCHEMA_DRAFT_2020_12 = 'https://json-schema.org/draft/2020-12/schema';