-
Notifications
You must be signed in to change notification settings - Fork 81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(useStrapi): improve types for v5
and v4
#445
Merged
Merged
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
✅ Deploy Preview for nuxt-strapi-module canceled.
|
ChristopheCVB
changed the title
Added types for
Improve v5 types for Nov 23, 2024
fields
, sort
and populate
in Strapi5RequestParams
RequestParams
benjamincanac
changed the title
Improve v5 types for
feat(useStrapi): improve typess for Nov 28, 2024
RequestParams
v5
and v4
@XanderD99 Could I ask you to review this? |
benjamincanac
changed the title
feat(useStrapi): improve typess for
feat(useStrapi): improve types for Nov 28, 2024
v5
and v4
v5
and v4
Implementation looks good to me. I would suggest tho to add something like this to it. Since the populate can be an object as well: https://docs.strapi.io/dev-docs/api/rest/populate-select type StrapiRequestParamPopulate<T> = {
[K in keyof T]: T[K] extends object
? T[K] extends Array<infer I>
? `${Exclude<K, symbol>}` | `${Exclude<K, symbol>}.${StrapiRequestParamPopulate<I>}`
: `${Exclude<K, symbol>}` | `${Exclude<K, symbol>}.${StrapiRequestParamPopulate<T[K]>}`
: never;
}[keyof T]
interface Strapi5RequestParams<T> {
populate?: ValidPopulateKeys<T> extends never
? never // Exclude `populate` if no sub-objects exist.
: '*' // Populate all relations.
| StrapiRequestParamPopulate<T> // String paths like "field.subfield".
| Array<StrapiRequestParamPopulate<T>> // Array of string paths.
| { // Nested object for advanced populates.
[K in keyof T]?: T[K] extends object
? T[K] extends Array<infer I>
? Strapi5RequestParams<I> | '*' // Nested array population or wildcard.
: Strapi5RequestParams<T[K]> | '*' // Nested object population or wildcard.
: never; // Non-object keys cannot have nested populate.
}
}
type ValidPopulateKeys<T> = keyof {
[K in keyof T as T[K] extends object ? K : never]: T[K];
}; |
Merging this, @XanderD99 your suggestion can be done in another PR I guess. |
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.
Types of changes
Description
Added types for
fields
,sort
andpopulate
inStrapi5RequestParams
Checklist: