Feature - replaced IdSchema with FieldPathId #4787

heath-freenome · 2025-09-30T07:17:20Z

Reasons for making this change

In order to support an upcoming feature as well as eliminate a performance issue, IdSchema was replace with FieldPathId

In @rjsf/utils:
- Added new FieldPathList and FieldPathId types and DEFAULT_ID_PREFIX and DEFAULT_ID_SEPARATOR to constants.ts
- Added the new toFieldPathId() function to generate FieldPathIds, exporting it from the library
- BREAKING CHANGES
  - Removed the IdSchema type, replacing idSchema: IdSchema<T> in all types with fieldPathId: FieldPathId
  - Updated the idGenerators to replace id: IdSchema<T> | string with id: FieldPathId | string removing the need for the <T = any> generic on the functions
  - Removed the toIdSchema() function in the schema directory
  - Updated the SchemaUtilsType and createSchemaUtils() to remove the toIdSchema() function
  - Deleted the ui:rootFieldId from the UiSchema since idPrefix does the same exact thing
- Updated the tests accordingly
In @rjsf/antd, @rjsf/chakra-ui, @rjsf/fluent-ui, @rjsf/mantine, @rjsf/mui, @rjsf/primereact, @rjsf/react-bootstrap, @rjsf/semantic-ui and @rjsf/shadcn:
- BREAKING CHANGES - Updated all of the templates and widgets to change idSchema to fieldPathId or to remove the <T> off of the idGenerator functions
In @rjsf/core:
- BREAKING CHANGES
  - Updated all of the fields, templates and widgets to change idSchema to fieldPathId or to remove the <T> off of the idGenerator functions
  - ObjectField and ArrayField to use toFieldPathId instead of toIdSchema() to generate the fieldPathIds of all its children
  - Updated the onChange handling of fields to make path required and either pass it straight through, or use the fieldPathId.path instead of using an empty array or appending path information
  - Updated Form to use toFieldPathId() to generate fieldPathId instead of idSchema, always providing the idPrefix and idSeparator in the globalFormOptions and make the path: FieldPathList required
  - Updated LayoutGridField to remove the IdSchema related code in favor of FieldPathId code
- Also exported the getTestRegistry() function from the main index.ts to assist developers in creating registry object for tests
- Updated all of the test to deal with the idSchema -> fieldPathId changes
In @rjsf/daisyui:
- BREAKING CHANGES - Updated all of the templates and widgets to change idSchema to fieldPathId or to remove the <T> off of the idGenerator functions
- Also fixed the FieldTemplate to extract the description element so that it was not spread onto the div, fixing the snapshots
In @rjsf/validator-ajv8:
- Updated the test to no longer try to test the delete toIdSchema function
In docs:
- Updated custom-templates.md, custom-widgets-fields.md and layout-grid.md to change the idSchema documentation to fieldPathId
- Updated uiSchema.md to remove the ui:rootFieldId documentation
- Updated utility-functions.md delete toIdSchema(), add toFieldPathId() and to remove the <T> from the id generator functions
- Updated v6.x upgrade guide.md to document all the breaking changes made in this release
Updated the CHANGELOG.md accordingly

Checklist

I'm updating documentation
- I've checked the rendering of the Markdown text I've added
I'm adding or updating code
- I've added and/or updated tests. I've run npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:update to update snapshots, if needed.
- I've updated docs if needed
- I've updated the changelog with a description of the PR
I'm adding a new feature
- I've updated the playground with an example use of the feature

In order to support an upcoming feature as well as eliminate a performance issue, `IdSchema` was replace with `FieldPathId` - In @rjsf/utils: - Added new `FieldPathList` and `FieldPathId` types and `DEFAULT_ID_PREFIX` and `DEFAULT_ID_SEPARATOR` to `constants.ts` - Added the new `toFieldPathId()` function to generate `FieldPathId`s, exporting it from the library - BREAKING CHANGES - Removed the `IdSchema` type, replacing `idSchema: IdSchema<T>` in all types with `fieldPathId: FieldPathId` - Updated the `idGenerators` to replace `id: IdSchema<T> | string` with `id: FieldPathId | string` removing the need for the `<T = any>` generic on the functions - Removed the `toIdSchema()` function in the `schema` directory - Updated the `SchemaUtilsType` and `createSchemaUtils()` to remove the `toIdSchema()` function - Deleted the `ui:rootFieldId` from the `UiSchema` since `idPrefix` does the same exact thing - Updated the tests accordingly - In `@rjsf/antd`, `@rjsf/chakra-ui`, `@rjsf/fluent-ui`, `@rjsf/mantine`, `@rjsf/mui`, `@rjsf/primereact`, `@rjsf/react-bootstrap`, `@rjsf/semantic-ui` and `@rjsf/shadcn`: - BREAKING CHANGES - Updated all of the templates and widgets to change `idSchema` to `fieldPathId` or to remove the `<T>` off of the idGenerator functions - In @rjsf/core: - BREAKING CHANGES - Updated all of the fields, templates and widgets to change `idSchema` to `fieldPathId` or to remove the `<T>` off of the idGenerator functions - `ObjectField` and `ArrayField` to use `toFieldPathId` instead of `toIdSchema()` to generate the `fieldPathId`s of all its children - Updated the `onChange` handling of fields to make `path` required and either pass it straight through, or use the `fieldPathId.path` instead of using an empty array or appending path information - Updated `Form` to use `toFieldPathId()` to generate `fieldPathId` instead of `idSchema`, always providing the `idPrefix` and `idSeparator` in the `globalFormOptions` and make the `path: FieldPathList` required - Updated `LayoutGridField` to remove the `IdSchema` related code in favor of `FieldPathId` code - Also exported the `getTestRegistry()` function from the main `index.ts` to assist developers in creating `registry` object for tests - Updated all of the test to deal with the `idSchema` -> `fieldPathId` changes - In @rjsf/daisyui: - BREAKING CHANGES - Updated all of the templates and widgets to change `idSchema` to `fieldPathId` or to remove the `<T>` off of the idGenerator functions - Also fixed the `FieldTemplate` to extract the `description` element so that it was not spread onto the `div`, fixing the snapshots - In @rjsf/validator-ajv8: - Updated the test to no longer try to test the delete `toIdSchema` function - In docs: - Updated `custom-templates.md`, `custom-widgets-fields.md` and `layout-grid.md` to change the `idSchema` documentation to `fieldPathId` - Updated `uiSchema.md` to remove the `ui:rootFieldId` documentation - Updated `utility-functions.md` delete `toIdSchema()`, add `toFieldPathId()` and to remove the `<T>` from the id generator functions - Updated `v6.x upgrade guide.md` to document all the breaking changes made in this release - Updated the `CHANGELOG.md` accordingly

packages/docs/docs/migration-guides/v6.x upgrade guide.md

nickgros · 2025-09-30T13:51:04Z

packages/daisyui/src/templates/FieldTemplate/FieldTemplate.tsx

    displayLabel,
    classNames,
    // Destructure props we don't want to pass to div
+    description,


nice subtle fix, the only snapshot changes are related to this (so the ID Schema replacement is clean! 🙌 )

packages/core/test/LayoutGridField.test.tsx

nickgros · 2025-09-30T13:56:15Z

packages/core/test/LayoutGridField.test.tsx

      uiSchema: { ...gridFormUISchema, [UI_GLOBAL_OPTIONS_KEY]: globalUiOptions },
      formData: {},
      errorSchema: { employment: {} },
-      // IdSchema is weirdly recursive and it's easier to just ignore the error


not anymore!

nickgros · 2025-09-30T13:59:36Z

packages/core/src/components/Form.tsx

+      idPrefix: props.idPrefix || DEFAULT_ID_PREFIX,
+      idSeparator: props.idSeparator || DEFAULT_ID_SEPARATOR,


Are we able to call this.getDefaultRegistry().globalFormOptions here to get the prefix/separator?

No, it blew things up because this is called in the constructor, before the this.props has been setup properly.

packages/core/src/components/fields/LayoutGridField.tsx

nickgros · 2025-09-30T14:05:12Z

packages/core/src/components/fields/ObjectField.tsx

      unset(copiedFormData, key);
      // drop property will pass the name in `path` array
-      onChange(copiedFormData, []);
+      onChange(copiedFormData, fieldPathId.path);


Need to ensure no regression in #4763 since we didn't add a test for that

I manually tested additional properties and arrays in my local playground. All works

packages/core/src/components/fields/LayoutGridField.tsx

packages/utils/src/toFieldPathId.ts

packages/docs/docs/api-reference/utility-functions.md

heath-freenome requested review from epicfaace and nickgros September 30, 2025 07:17

heath-freenome mentioned this pull request Sep 30, 2025

feat: Add support for user nameGenerator function #4773

Merged

8 tasks

heath-freenome force-pushed the idSchema-to-fieldPathId branch from e2c246a to cc5b4f9 Compare September 30, 2025 07:32

- Updated docs to mention getTestRegistry()

c05cb0a

nickgros reviewed Sep 30, 2025

View reviewed changes

packages/docs/docs/migration-guides/v6.x upgrade guide.md Outdated Show resolved Hide resolved

nickgros reviewed Sep 30, 2025

View reviewed changes

packages/core/test/LayoutGridField.test.tsx Outdated Show resolved Hide resolved

nickgros reviewed Sep 30, 2025

View reviewed changes

packages/core/src/components/fields/LayoutGridField.tsx Outdated Show resolved Hide resolved

nickgros reviewed Sep 30, 2025

View reviewed changes

packages/core/src/components/fields/LayoutGridField.tsx Outdated Show resolved Hide resolved

heath-freenome added 2 commits September 30, 2025 09:25

- Responded to most of the reviewer feedback

008c81d

- Fixed tests

ecfc209

heath-freenome commented Sep 30, 2025

View reviewed changes

packages/utils/src/toFieldPathId.ts Outdated Show resolved Hide resolved

packages/docs/docs/api-reference/utility-functions.md Outdated Show resolved Hide resolved

heath-freenome added 2 commits September 30, 2025 16:32

- Switched rootFieldId to be deprecated

92ee92d

- Fixed documentation

3dc291b

heath-freenome requested a review from nickgros September 30, 2025 23:38

- Moved semantic-ui deprecation warning into its own section

c374db7

nickgros approved these changes Oct 1, 2025

View reviewed changes

heath-freenome merged commit 90446a3 into main Oct 1, 2025
4 checks passed

heath-freenome deleted the idSchema-to-fieldPathId branch October 1, 2025 20:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature - replaced IdSchema with FieldPathId #4787

Feature - replaced IdSchema with FieldPathId #4787

Uh oh!

heath-freenome commented Sep 30, 2025

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Uh oh!

nickgros Sep 30, 2025

Uh oh!

heath-freenome Sep 30, 2025

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Uh oh!

heath-freenome Sep 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		idPrefix: props.idPrefix \|\| DEFAULT_ID_PREFIX,
		idSeparator: props.idSeparator \|\| DEFAULT_ID_SEPARATOR,

Feature - replaced IdSchema with FieldPathId #4787

Feature - replaced IdSchema with FieldPathId #4787

Uh oh!

Conversation

heath-freenome commented Sep 30, 2025

Reasons for making this change

Checklist

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

nickgros Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

heath-freenome Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nickgros Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

heath-freenome Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants