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

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 */
@@ -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;
 };
@@ -335,13 +343,13 @@ export type GlobalUISchemaOptions = GenericObjectType & {
  */
 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 `toIdSchema()` function within the RJSF field implementations.
+     * Default is `root`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
      */
-    readonly idPrefix?: string;
+    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 `toIdSchema()` function within the RJSF field implementations.
+     * ids; Default is `_`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
      */
-    readonly idSeparator?: string;
+    readonly idSeparator: string;
     /** The component update strategy used by the Form and its fields for performance optimization */
     readonly experimental_componentUpdateStrategy?: 'customDeep' | 'shallow' | 'always';
 };
@@ -378,16 +386,16 @@ export interface Registry<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
 }
 /** 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 field value, the optional change path for the value
+    /** 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?: (number | string)[], es?: ErrorSchema<T>, id?: string) => void;
+    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 */
@@ -465,8 +473,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;
 };
@@ -490,20 +498,20 @@ 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;
 };
 /** 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 */
@@ -568,8 +576,8 @@ export type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSc
     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>;
+    /** 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 */
@@ -620,8 +628,8 @@ 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 */
@@ -816,7 +824,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
@@ -1041,16 +1052,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "6.0.0-beta.19",
+  "version": "6.0.0-beta.20",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",

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.
  */

package/src/createSchemaUtils.ts

@@ -5,7 +5,6 @@ import {
   FormContextType,
   FoundFieldType,
   GlobalUISchemaOptions,
-  IdSchema,
   PathSchema,
   RJSFSchema,
   SchemaUtilsType,
@@ -26,7 +25,6 @@ import {
   isSelect,
   retrieveSchema,
   sanitizeDataForNewSchema,
-  toIdSchema,
   toPathSchema,
 } from './schema';
 import { makeAllReferencesAbsolute } from './findSchemaDefinition';
@@ -337,28 +335,6 @@ class SchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
     );
   }
 
-  /** 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 | null, formData?: T, idPrefix = 'root', idSeparator = '_'): IdSchema<T> {
-    return toIdSchema<T, S, F>(
-      this.validator,
-      schema,
-      id,
-      this.rootSchema,
-      formData,
-      idPrefix,
-      idSeparator,
-      this.experimental_customMergeAllOf,
-    );
-  }
-
   /** Generates an `PathSchema` object for the `schema`, recursively
    *
    * @param schema - The schema for which the display label flag is desired

package/src/enums.ts

@@ -63,7 +63,7 @@ export enum TranslatableString {
   InvalidObjectField = 'Invalid "%1" object field configuration: _%2_.',
   /** Unsupported field schema, used by UnsupportedField */
   UnsupportedField = 'Unsupported field schema.',
-  /** Unsupported field schema, where %1 will be replaced by the idSchema.$id as provided by UnsupportedField.
+  /** Unsupported field schema, where %1 will be replaced by the FieldPathId.$id as provided by UnsupportedField.
    * NOTE: Use markdown notation rather than html tags.
    */
   UnsupportedFieldWithId = 'Unsupported field schema for field `%1`.',
@@ -71,8 +71,8 @@ export enum TranslatableString {
    * NOTE: Use markdown notation rather than html tags.
    */
   UnsupportedFieldWithReason = 'Unsupported field schema: _%1_.',
-  /** Unsupported field schema, where %1 and %2 will be replaced by the idSchema.$id and reason strings, respectively,
-   * as provided by UnsupportedField.
+  /** Unsupported field schema, where %1 and %2 will be replaced by the FieldPathId.$id and reason strings,
+   * respectively, as provided by UnsupportedField.
    * NOTE: Use markdown notation rather than html tags.
    */
   UnsupportedFieldWithIdAndReason = 'Unsupported field schema for field `%1`: _%2_.',

package/src/idGenerators.ts

@@ -1,73 +1,73 @@
 import isString from 'lodash/isString';
 
-import { IdSchema } from './types';
+import { FieldPathId } from './types';
 import { ID_KEY } from './constants';
 
 /** Generates a consistent `id` pattern for a given `id` and a `suffix`
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @param suffix - The suffix to append to the id
  */
-function idGenerator<T = any>(id: IdSchema<T> | string, suffix: string) {
+function idGenerator(id: FieldPathId | string, suffix: string) {
   const theId = isString(id) ? id : id[ID_KEY];
   return `${theId}__${suffix}`;
 }
 /** Return a consistent `id` for the field description element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @returns - The consistent id for the field description element from the given `id`
  */
-export function descriptionId<T = any>(id: IdSchema<T> | string) {
-  return idGenerator<T>(id, 'description');
+export function descriptionId(id: FieldPathId | string) {
+  return idGenerator(id, 'description');
 }
 
 /** Return a consistent `id` for the field error element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @returns - The consistent id for the field error element from the given `id`
  */
-export function errorId<T = any>(id: IdSchema<T> | string) {
-  return idGenerator<T>(id, 'error');
+export function errorId(id: FieldPathId | string) {
+  return idGenerator(id, 'error');
 }
 
 /** Return a consistent `id` for the field examples element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @returns - The consistent id for the field examples element from the given `id`
  */
-export function examplesId<T = any>(id: IdSchema<T> | string) {
-  return idGenerator<T>(id, 'examples');
+export function examplesId(id: FieldPathId | string) {
+  return idGenerator(id, 'examples');
 }
 
 /** Return a consistent `id` for the field help element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @returns - The consistent id for the field help element from the given `id`
  */
-export function helpId<T = any>(id: IdSchema<T> | string) {
-  return idGenerator<T>(id, 'help');
+export function helpId(id: FieldPathId | string) {
+  return idGenerator(id, 'help');
 }
 
 /** Return a consistent `id` for the field title element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @returns - The consistent id for the field title element from the given `id`
  */
-export function titleId<T = any>(id: IdSchema<T> | string) {
-  return idGenerator<T>(id, 'title');
+export function titleId(id: FieldPathId | string) {
+  return idGenerator(id, 'title');
 }
 
 /** Return a list of element ids that contain additional information about the field that can be used to as the aria
  * description of the field. This is correctly omitting `titleId` which would be "labeling" rather than "describing" the
  * element.
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @param [includeExamples=false] - Optional flag, if true, will add the `examplesId` into the list
  * @returns - The string containing the list of ids for use in an `aria-describedBy` attribute
  */
-export function ariaDescribedByIds<T = any>(id: IdSchema<T> | string, includeExamples = false) {
-  const examples = includeExamples ? ` ${examplesId<T>(id)}` : '';
-  return `${errorId<T>(id)} ${descriptionId<T>(id)} ${helpId<T>(id)}${examples}`;
+export function ariaDescribedByIds(id: FieldPathId | string, includeExamples = false) {
+  const examples = includeExamples ? ` ${examplesId(id)}` : '';
+  return `${errorId(id)} ${descriptionId(id)} ${helpId(id)}${examples}`;
 }
 
 /** Return a consistent `id` for the `optionIndex`s of a `Radio` or `Checkboxes` widget
@@ -82,10 +82,10 @@ export function optionId(id: string, optionIndex: number) {
 
 /** Return a consistent `id` for the `btn` button element
  *
- * @param id - Either simple string id or an IdSchema from which to extract it
+ * @param id - Either simple string id or an FieldPathId from which to extract it
  * @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<T = any>(id: IdSchema<T> | string, btn: 'add' | 'copy' | 'moveDown' | 'moveUp' | 'remove') {
-  return idGenerator<T>(id, btn);
+export function buttonId(id: FieldPathId | string, btn: 'add' | 'copy' | 'moveDown' | 'moveUp' | 'remove') {
+  return idGenerator(id, btn);
 }

package/src/index.ts

@@ -59,6 +59,7 @@ 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 utcToLocal from './utcToLocal';
 import validationDataMerge from './validationDataMerge';
@@ -139,6 +140,7 @@ export {
   toDateString,
   toErrorList,
   toErrorSchema,
+  toFieldPathId,
   unwrapErrorHandler,
   utcToLocal,
   validationDataMerge,

package/src/schema/index.ts

@@ -10,7 +10,6 @@ import isMultiSelect from './isMultiSelect';
 import isSelect from './isSelect';
 import retrieveSchema from './retrieveSchema';
 import sanitizeDataForNewSchema from './sanitizeDataForNewSchema';
-import toIdSchema from './toIdSchema';
 import toPathSchema from './toPathSchema';
 
 export {
@@ -26,6 +25,5 @@ export {
   isSelect,
   retrieveSchema,
   sanitizeDataForNewSchema,
-  toIdSchema,
   toPathSchema,
 };

package/src/toFieldPathId.ts

@@ -0,0 +1,24 @@
+import { ID_KEY } from './constants';
+import { FieldPathId, FieldPathList, GlobalFormOptions } from './types';
+
+/** Constructs the `FieldPathId` for `fieldPath`. If `parentPathId` is provided, the `fieldPath` is appended to the end
+ * of the parent path. Then the `ID_KEY` of the resulting `FieldPathId` is constructed from the `idPrefix` and
+ * `idSeparator` contained within the `globalFormOptions`. If `fieldPath` is passed as an empty string, it will simply
+ * generate the path from the `parentPath` (if provided) and the `idPrefix` and `idSeparator`
+ *
+ * @param fieldPath - The property name or array index of the current field element
+ * @param globalFormOptions - The `GlobalFormOptions` used to get the `idPrefix` and `idSeparator`
+ * @param [parentPath] - The optional `FieldPathId` or `FieldPathList` of the parent element for this field element
+ * @returns - The `FieldPathId` for the given `fieldPath` and the optional `parentPathId`
+ */
+export default function toFieldPathId(
+  fieldPath: string | number,
+  globalFormOptions: GlobalFormOptions,
+  parentPath?: FieldPathId | FieldPathList,
+): FieldPathId {
+  const basePath = Array.isArray(parentPath) ? parentPath : parentPath?.path;
+  const childPath = fieldPath === '' ? [] : [fieldPath];
+  const path = basePath ? basePath.concat(...childPath) : childPath;
+  const id = [globalFormOptions.idPrefix, ...path].join(globalFormOptions.idSeparator);
+  return { path, [ID_KEY]: id };
+}

package/src/types.ts

@@ -158,20 +158,25 @@ export type InputPropsType = Omit<RangeSpecType, 'step'> & {
   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 & {
-      /** The set of ids for fields in the recursive object structure */
-      [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 */
@@ -275,8 +280,8 @@ export type FieldErrorProps<
   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 */
@@ -287,8 +292,8 @@ export type FieldHelpProps<
 > = 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;
 };
@@ -400,13 +405,13 @@ export type GlobalUISchemaOptions = GenericObjectType & {
  */
 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 `toIdSchema()` function within the RJSF field implementations.
+   * Default is `root`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
    */
-  readonly idPrefix?: string;
+  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 `toIdSchema()` function within the RJSF field implementations.
+   * ids; Default is `_`. This prop is passed to the `toFilePathId()` function within the RJSF field implementations.
    */
-  readonly idSeparator?: string;
+  readonly idSeparator: string;
   /** The component update strategy used by the Form and its fields for performance optimization */
   readonly experimental_componentUpdateStrategy?: 'customDeep' | 'shallow' | 'always';
 };
@@ -448,16 +453,16 @@ export interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
   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 field value, the optional change path for the value
+  /** 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?: (number | string)[], es?: ErrorSchema<T>, id?: string) => void;
+  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 */
@@ -548,8 +553,8 @@ export type UnsupportedFieldProps<
   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;
 };
@@ -588,8 +593,8 @@ export type ArrayFieldTitleProps<
 > = 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;
 };
 
 /** The properties that are passed to a `ArrayFieldDescriptionTemplate` implementation */
@@ -600,8 +605,8 @@ export type ArrayFieldDescriptionProps<
 > = 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 */
@@ -610,8 +615,8 @@ export type ArrayFieldItemButtonsTemplateType<
   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 */
@@ -691,8 +696,8 @@ export type ArrayFieldTemplateProps<
   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>;
+  /** 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 */
@@ -749,8 +754,8 @@ export type ObjectFieldTemplateProps<
   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 */
@@ -1025,7 +1030,10 @@ export type UiSchema<
      * 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
@@ -1282,16 +1290,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/schema/toIdSchema.d.ts

@@ -1,14 +0,0 @@
-import { Experimental_CustomMergeAllOf, FormContextType, IdSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types.js';
-/** Generates an `IdSchema` object for the `schema`, recursively
- *
- * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
- * @param schema - The schema for which the `IdSchema` is desired
- * @param [id] - The base id for the schema
- * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
- * @param [formData] - The current formData, if any, to assist retrieving a schema
- * @param [idPrefix='root'] - The prefix to use for the id
- * @param [idSeparator='_'] - The separator to use for the path segments in the id
- * @param [experimental_customMergeAllOf] - Optional function that allows for custom merging of `allOf` schemas
- * @returns - The `IdSchema` object for the `schema`
- */
-export default function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, id?: string | null, rootSchema?: S, formData?: T, idPrefix?: string, idSeparator?: string, experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>): IdSchema<T>;