Make records paths inferred from type compatible with react-hook-form #10279
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fzaninotto
requested changes
Oct 16, 2024
packages/ra-core/src/types.ts
Outdated
| @@ -13,9 +14,11 @@ export interface RaRecord<IdentifierType extends Identifier = Identifier> | |||
| id: IdentifierType; | |||
| } | |||
|
|
|||
| export type SortOrder = 'ASC' | 'DESC'; | |||
There was a problem hiding this comment.
This type is already defined in ra-ui-materialui (packages/ra-ui-materialui/src/field/types.ts), I'm afraid of a conflic. As this change seems to be unrelated to the subject of the PR, could you revert it?
| // Useful for props such as "source" in react-admin components | ||
| export type ExtractRecordPaths<T extends RecordValues> = | ||
| // Trick that allows to check whether T was provided | ||
| [T] extends [never] ? string : RecordPath<T>; |
There was a problem hiding this comment.
we used AnyString as the default value, now it's string. Isn't it a BC?
There was a problem hiding this comment.
No, AnyString is no longer necessary
There was a problem hiding this comment.
More precisely, AnyString wasn't needed before. It was unnecessary already. It's only useful for HintedString
fzaninotto
approved these changes
Oct 16, 2024
|
typecheck fails |
fzaninotto
approved these changes
Oct 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Fixes #9849
Records paths inferred from type using
hotscriptaren't compatible with those inferred byreact-hook-formSolution
Declare our own types for path inference that currently just re-export those from
react-hook-form, making us more resilient to future changes.How To Test
InvoiceShowof the CRM demo and add a type parameter to theTextFieldof the Order reference. TheTextFieldsourceshould be valid and trying to replace it should trigger the IDE autocompletion, showing allOrderfieldsAdditional Checks
masterfor a bugfix, ornextfor a feature