@rjsf/utils 6.0.0-beta.20 → 6.0.0-beta.22

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 = {
@@ -149,6 +151,8 @@ export type FieldPathId = {
     $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 name used for a field in the `PathSchema` */
 export type FieldPath = {
@@ -265,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 */
@@ -288,6 +292,8 @@ export type TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
     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 */
@@ -337,6 +343,10 @@ 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.
@@ -352,6 +362,11 @@ export type GlobalFormOptions = {
     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;
 };
 /** The object containing the registered core, theme and custom fields and widgets as well as the root schema, form
  * context, schema utils and templates.
@@ -466,10 +481,15 @@ export type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema,
     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 the `UnsupportedFieldTemplate` implementation */
 export type UnsupportedFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = RJSFBaseProps<T, S, F> & {
@@ -486,6 +506,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> & {
@@ -500,6 +522,8 @@ export type ArrayFieldTitleProps<T = any, S extends StrictRJSFSchema = RJSFSchem
     title?: string;
     /** 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'> & {
@@ -509,7 +533,7 @@ export type ArrayFieldDescriptionProps<T = any, S extends StrictRJSFSchema = RJS
     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> & {
+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 */
@@ -532,23 +556,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 */
@@ -562,26 +588,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;
     /** The FieldPathId of the field in the hierarchy */
     fieldPathId: FieldPathId;
-    /** 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;
     /** A boolean value stating if the array is read-only */
     readonly?: boolean;
     /** A boolean value stating if the array is required */
@@ -592,8 +612,19 @@ export type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSc
     title: string;
     /** 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[];
 };
@@ -611,17 +642,15 @@ 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 */
@@ -635,11 +664,22 @@ export type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFS
     /** The form data for the object */
     formData?: T;
 };
+/** 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'>;
+} & 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 */
@@ -694,6 +734,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>>;
@@ -965,9 +1007,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.
      *
@@ -1037,9 +1080,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

package/lib/useDeepCompareMemo.d.ts

@@ -0,0 +1,8 @@
+/** Hook that stores and returns a `T` value. If `newValue` is the same as the stored one, then the stored one is
+ * returned to avoid having a component rerender due it being a different object. Otherwise, the `newValue` is stored
+ * and returned.
+ *
+ * @param newValue - The potential new `T` value
+ * @returns - The latest stored `T` value
+ */
+export default function useDeepCompareMemo<T = unknown>(newValue: T): T;

package/lib/useDeepCompareMemo.js

@@ -0,0 +1,17 @@
+import { useRef } from 'react';
+import isEqual from 'lodash-es/isEqual.js';
+/** Hook that stores and returns a `T` value. If `newValue` is the same as the stored one, then the stored one is
+ * returned to avoid having a component rerender due it being a different object. Otherwise, the `newValue` is stored
+ * and returned.
+ *
+ * @param newValue - The potential new `T` value
+ * @returns - The latest stored `T` value
+ */
+export default function useDeepCompareMemo(newValue) {
+    const valueRef = useRef(newValue);
+    if (!isEqual(newValue, valueRef.current)) {
+        valueRef.current = newValue;
+    }
+    return valueRef.current;
+}
+//# sourceMappingURL=useDeepCompareMemo.js.map

package/lib/useDeepCompareMemo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDeepCompareMemo.js","sourceRoot":"","sources":["../src/useDeepCompareMemo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAc,QAAW;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAI,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzC,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC"}

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.20",
+  "version": "6.0.0-beta.22",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",

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/createSchemaUtils.ts

@@ -165,12 +165,14 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
    * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
    *          If "excludeObjectChildren", 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' = false,
+    initialDefaultsGenerated?: boolean,
   ): T | T[] | undefined {
     return getDefaultFormState<T, S, F>(
       this.validator,
@@ -180,6 +182,7 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
       includeUndefinedValues,
       this.experimental_defaultFormStateBehavior,
       this.experimental_customMergeAllOf,
+      initialDefaultsGenerated,
     );
   }
 
@@ -301,15 +304,17 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
    *
    * @param schema - The schema for which retrieving a schema is desired
    * @param [rawFormData] - 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, rawFormData?: T) {
+  retrieveSchema(schema: S, rawFormData?: T, resolveAnyOfOrOneOfRefs?: boolean) {
     return retrieveSchema<T, S, F>(
       this.validator,
       schema,
       this.rootSchema,
       rawFormData,
       this.experimental_customMergeAllOf,
+      resolveAnyOfOrOneOfRefs,
     );
   }
 

package/src/enums.ts

@@ -45,6 +45,12 @@ export enum TranslatableString {
   DecrementAriaLabel = 'Decrease value by 1',
   /** Increment button aria label, used by UpDownWidget */
   IncrementAriaLabel = 'Increase value by 1',
+  /** The label for the Add button in for an optional object field */
+  OptionalObjectAdd = 'Add data for optional field',
+  /** The label for the Remove button in for an optional object field */
+  OptionalObjectRemove = 'Remove data for optional field',
+  /** The label for when displaying a non-editable form with missing optional field data */
+  OptionalObjectEmptyMsg = 'No data for optional field',
   // Strings with replaceable parameters
   /** Unknown field type reason, where %1 will be replaced with the type as provided by SchemaField */
   UnknownFieldType = 'Unknown field type %1',

package/src/idGenerators.ts

@@ -82,10 +82,20 @@ export function optionId(id: string, optionIndex: number) {
 
 /** Return a consistent `id` for the `btn` button element
  *
- * @param id - Either simple string id or an FieldPathId from which to extract it
+ * @param id - The id of the parent component for the option
  * @param btn - The button type for which to generate the id
  * @returns - The consistent id for the button from the given `id` and `btn` type
  */
 export function buttonId(id: FieldPathId | string, btn: 'add' | 'copy' | 'moveDown' | 'moveUp' | 'remove') {
   return idGenerator(id, btn);
 }
+
+/** Return a consistent `id` for the optional data controls `element`
+ *
+ * @param id - The id of the parent component for the option
+ * @param element - The element type for which to generate the id
+ * @returns - The consistent id for the optional data controls element from the given `id` and `element` type
+ */
+export function optionalControlsId(id: FieldPathId | string, element: 'Add' | 'Msg' | 'Remove') {
+  return idGenerator(id, `optional${element}`);
+}

package/src/index.ts

@@ -15,9 +15,11 @@ import enumOptionsSelectValue from './enumOptionsSelectValue';
 import enumOptionsValueForIndex from './enumOptionsValueForIndex';
 import ErrorSchemaBuilder from './ErrorSchemaBuilder';
 import findSchemaDefinition from './findSchemaDefinition';
+import getChangedFields from './getChangedFields';
 import getDateElementProps, { type DateElementFormat } from './getDateElementProps';
 import getDiscriminatorFieldFromSchema from './getDiscriminatorFieldFromSchema';
 import getInputProps from './getInputProps';
+import getOptionMatchingSimpleDiscriminator from './getOptionMatchingSimpleDiscriminator';
 import getSchemaType from './getSchemaType';
 import getSubmitButtonOptions from './getSubmitButtonOptions';
 import getTemplate from './getTemplate';
@@ -34,13 +36,16 @@ import {
   errorId,
   examplesId,
   helpId,
+  optionalControlsId,
   optionId,
   titleId,
 } from './idGenerators';
 import isConstant from './isConstant';
 import isCustomWidget from './isCustomWidget';
 import isFixedItems from './isFixedItems';
+import isFormDataAvailable from './isFormDataAvailable';
 import isObject from './isObject';
+import isRootSchema from './isRootSchema';
 import labelValue from './labelValue';
 import localToUTC from './localToUTC';
 import lookupFromFormContext from './lookupFromFormContext';
@@ -55,17 +60,18 @@ import rangeSpec from './rangeSpec';
 import replaceStringParameters from './replaceStringParameters';
 import schemaRequiresTrueValue from './schemaRequiresTrueValue';
 import shouldRender from './shouldRender';
+import shouldRenderOptionalField from './shouldRenderOptionalField';
 import toConstant from './toConstant';
 import toDateString from './toDateString';
 import toErrorList from './toErrorList';
 import toErrorSchema from './toErrorSchema';
 import toFieldPathId from './toFieldPathId';
 import unwrapErrorHandler from './unwrapErrorHandler';
+import useDeepCompareMemo from './useDeepCompareMemo';
 import utcToLocal from './utcToLocal';
 import validationDataMerge from './validationDataMerge';
 import withIdRefPrefix from './withIdRefPrefix';
-import getOptionMatchingSimpleDiscriminator from './getOptionMatchingSimpleDiscriminator';
-import getChangedFields from './getChangedFields';
+import { bracketNameGenerator, dotNotationNameGenerator } from './nameGenerators';
 
 export * from './types';
 export * from './enums';
@@ -117,13 +123,16 @@ export {
   isConstant,
   isCustomWidget,
   isFixedItems,
+  isFormDataAvailable,
   isObject,
+  isRootSchema,
   labelValue,
   localToUTC,
   lookupFromFormContext,
   mergeDefaultsWithFormData,
   mergeObjects,
   mergeSchemas,
+  optionalControlsId,
   optionId,
   optionsList,
   orderProperties,
@@ -134,6 +143,7 @@ export {
   schemaRequiresTrueValue,
   shallowEquals,
   shouldRender,
+  shouldRenderOptionalField,
   sortedJSONStringify,
   titleId,
   toConstant,
@@ -142,9 +152,12 @@ export {
   toErrorSchema,
   toFieldPathId,
   unwrapErrorHandler,
+  useDeepCompareMemo,
   utcToLocal,
   validationDataMerge,
   withIdRefPrefix,
+  bracketNameGenerator,
+  dotNotationNameGenerator,
 };
 
 export type { ComponentUpdateStrategy } from './shouldRender';

package/src/isFormDataAvailable.ts

@@ -0,0 +1,13 @@
+import isNil from 'lodash/isNil';
+import isEmpty from 'lodash/isEmpty';
+import isObject from 'lodash/isObject';
+
+/** Determines whether the given `formData` represents valid form data, such as a primitive type, an array, or a
+ * non-empty object.
+ *
+ * @param formData - The data to check
+ * @returns - True if `formData` is not undefined, null, a primitive type or an array or an empty object
+ */
+export default function isFormDataAvailable<T = any>(formData?: T): boolean {
+  return !isNil(formData) && (!isObject(formData) || Array.isArray(formData) || !isEmpty(formData));
+}

package/src/isRootSchema.ts

@@ -0,0 +1,30 @@
+import isEqual from 'lodash/isEqual';
+
+import { FormContextType, Registry, RJSFSchema, StrictRJSFSchema } from './types';
+import { REF_KEY } from './constants';
+
+/** Helper to check whether a JSON schema object is the root schema. The schema is a root schema with root `properties`
+ * key or a root `$ref` key. If the `schemaToCompare` has a root `oneOf` property, the function will
+ * return false. Else if `schemaToCompare` and `rootSchema` are the same object or equal, the function will return
+ * `true`. Else if the `rootSchema` has a $ref, it will be resolved using `schemaUtils.resolveSchema` utility. If the
+ * resolved schema matches the `schemaToCompare` the function will return `true`. Otherwise, it will return false.
+ *
+ * @param registry - The `Registry` used to get the `rootSchema` and `schemaUtils`
+ * @param schemaToCompare - The JSON schema object to check. If `schemaToCompare` is an root schema, the
+ *        function will return true.
+ * @returns - Flag indicating whether the `schemaToCompare` is the root schema
+ */
+export default function isRootSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
+  registry: Registry<T, S, F>,
+  schemaToCompare: S,
+): boolean {
+  const { rootSchema, schemaUtils } = registry;
+  if (isEqual(schemaToCompare, rootSchema)) {
+    return true;
+  }
+  if (REF_KEY in rootSchema) {
+    const resolvedSchema = schemaUtils.retrieveSchema(rootSchema);
+    return isEqual(schemaToCompare, resolvedSchema);
+  }
+  return false;
+}

package/src/nameGenerators.ts

@@ -0,0 +1,43 @@
+import { NameGeneratorFunction, FieldPathList } from './types';
+
+/**
+ * Generates bracketed names
+ * Example: root[tasks][0][title]
+ * For multi-value fields (checkboxes, multi-select): root[hobbies][]
+ */
+export const bracketNameGenerator: NameGeneratorFunction = (
+  path: FieldPathList,
+  idPrefix: string,
+  isMultiValue?: boolean,
+): string => {
+  if (!path || path.length === 0) {
+    return idPrefix;
+  }
+
+  const baseName = path.reduce<string>((acc, pathUnit, index) => {
+    if (index === 0) {
+      return `${idPrefix}[${String(pathUnit)}]`;
+    }
+    return `${acc}[${String(pathUnit)}]`;
+  }, '');
+
+  // For multi-value fields, append [] to allow multiple values with the same name
+  return isMultiValue ? `${baseName}[]` : baseName;
+};
+
+/**
+ * Generates dot-notation names
+ * Example: root.tasks.0.title
+ * Multi-value fields are handled the same as single-value fields in dot notation
+ */
+export const dotNotationNameGenerator: NameGeneratorFunction = (
+  path: FieldPathList,
+  idPrefix: string,
+  _isMultiValue?: boolean,
+): string => {
+  if (!path || path.length === 0) {
+    return idPrefix;
+  }
+
+  return `${idPrefix}.${path.map(String).join('.')}`;
+};