feat(graphql): add getData and getCount options #6357
Conversation
🦋 Changeset detectedLatest commit: 3cb0e82 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 |
| export type GraphQLDataProviderOptions = { | ||
| getData: GraphQLGetDataFunction; | ||
| getCount: GraphQLGetCountFunction; | ||
| }; |
There was a problem hiding this comment.
This type is also used in the dataProvider export and forces user to define both of the functions. It should allow partial assignments.
| import camelCase from "camelcase"; | ||
| import pluralize from "pluralize"; | ||
|
|
||
| "asd".toUpperCase; |
| | { method: "deleteOne"; params: DeleteOneParams } | ||
| ); | ||
|
|
||
| type GraphQLGetDataFunction = (params: GraphQLGetDataFunctionParams) => any; |
There was a problem hiding this comment.
Return type can be inferred from params.method by checking it like below:
type ResponseMap = {
getList: GetListResponse<any>;
getOne: GetOneResponse<any>;
/* ... */
};
type InferResponse<T extends GraphQLGetDataFunctionParams> = T extends { method: infer M }
? M extends keyof ResponseMap
? ResponseMap[M]
: never
: never;
type GraphQLGetDataFunction = (params: GraphQLGetDataFunctionParams) => InferResponse<typeof params>;| getCount: GraphQLGetCountFunction; | ||
| }; | ||
|
|
||
| export const defaultGetDataFunc: GraphQLGetDataFunction = ({ |
There was a problem hiding this comment.
I think Func suffix here doesn't add any context, let's remove the Func or don't try to cut 4 letters 🤣
| const camelCreateName = camelCase(`create-${singularResource}`); | ||
| const operation = params.meta?.operation ?? camelCreateName; | ||
|
|
||
| // console.log(response, operation, singularResource); |
| options: GraphQLDataProviderOptions = { | ||
| getCount: defaultGetCountFunc, | ||
| getData: defaultGetDataFunc, | ||
| }, |
There was a problem hiding this comment.
This marks the options as optional but requires both methods to be defined when passing it. getCount and getData should have default values individually.
| options: GraphQLDataProviderOptions = { | |
| getCount: defaultGetCountFunc, | |
| getData: defaultGetDataFunc, | |
| }, | |
| { | |
| getCount = defaultGetCountFunc, | |
| getData = defaultGetDataFunc, | |
| }, |
PR Checklist
Please check if your PR fulfills the following requirements:
Bugs / Features
What is the current behavior?
What is the new behavior?
fixes (issue)
Notes for reviewers