fix(core): extend BaseKey to include number[] for UUID support#7453
Open
devavijha wants to merge 1 commit into
Open
fix(core): extend BaseKey to include number[] for UUID support#7453devavijha wants to merge 1 commit into
devavijha wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: f58324a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Some OpenAPI generators produce TypeScript types where UUID fields are represented as number[] (byte arrays). The current BaseKey union of string | number did not cover this case, forcing users to cast their ID values when passing them to refine hooks. Extend BaseKey to string | number | number[]. The change is additive; all existing usage of string and number IDs is unaffected. Fixes refinedev#7403
d11814b to
f58324a
Compare
This file contains hidden or 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
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
BaseKeyis currently typed asstring | number. Some OpenAPI code generators represent UUID fields asnumber[](byte arrays) in TypeScript. Users working with such types must cast their ID values to satisfy theBaseKeyconstraint:This defeats TypeScript safety and produces confusing code.
See: #7403
Fix
Extend
BaseKeyfromstring | numbertostring | number | number[].The change is additive. All existing usage of
stringandnumberIDs is unaffected.Files changed
packages/core/src/contexts/data/types.ts— extendsBaseKeyunion typepackages/core/src/hooks/navigation/index.ts— fixes threeencodeURIComponent(id)call sites that TypeScript correctly flags after the type extension;number[]is converted to a comma-separated string before encodingTypeScript verification
Ran
tsc --noEmitonpackages/corebefore and after the change. The only remaining error is a pre-existing test file path issue present onmainas well.Closes #7403