chore: Update types to be consistent with documentation #244
Conversation
|
@pawelgrimm, I don't think I have permission to assign you as a reviewer. I hope you don't mind the direct tag, thank you! |
|
Thanks, @thales-fukuda! I'll try to take a look at this tomorrow or on Thursday. |
src/types/entities.ts
Outdated
| @@ -84,7 +85,7 @@ export const Project = Record({ | |||
| isInboxProject: Boolean, | |||
| isTeamInbox: Boolean, | |||
| order: Int, | |||
| viewStyle: String, | |||
| viewStyle: Union(Literal('list'), Literal('board')), | |||
There was a problem hiding this comment.
Technically the API could return something other than "list" or "board" here.
Let's keep this as String, but export a new type here for ProjectViewStyle to get intellisense for requests, like adding or updating projects.
| viewStyle: Union(Literal('list'), Literal('board')), | |
| viewStyle: String, |
export type ProjectViewStyle = 'list' | 'board'
src/types/requests.ts
Outdated
|
|
||
| export type ProjectViewStyle = 'list' | 'board' | ||
| export type ProjectViewStyle = Project['viewStyle'] |
There was a problem hiding this comment.
Let's just reference Project['viewStyle'] instead of creating another type for it here.
| export type ProjectViewStyle = Project['viewStyle'] |
There was a problem hiding this comment.
Ope, I guess we can't do that because it breaks validators.validateProject. Let's reference the ProjectViewStyle type here.
src/types/requests.ts
Outdated
| } & RequireOneOrNone<{ | ||
| dueString?: string | ||
| dueDate?: string | ||
| dueDatetime?: string |
There was a problem hiding this comment.
You can specify a dueString and a dueDate/dueDatetime. This is because the dueString could indicate the recurrence (e.g. "every day at 9am"), whereas the dueDatetime could indicate the due time of the current instance of the task (e.g. "2023-10-26T12:00:00").
| } & RequireOneOrNone<{ | |
| dueString?: string | |
| dueDate?: string | |
| dueDatetime?: string | |
| dueString?: string | |
| } & RequireOneOrNone<{ | |
| dueDate?: string | |
| dueDatetime?: string |
src/types/requests.ts
Outdated
| } & RequireOneOrNone<{ | ||
| dueString?: string |
There was a problem hiding this comment.
♻️ Same situation as my previous comment
| } & RequireOneOrNone<{ | |
| dueString?: string | |
| dueString?: string | |
| } & RequireOneOrNone<{ |
src/types/requests.ts
Outdated
| } & RequireExactlyOne<{ | ||
| taskId?: string | ||
| projectId?: string | ||
| }> | ||
|
|
||
| export type AddTaskCommentArgs = AddCommentArgs & { |
There was a problem hiding this comment.
We can get rid of AddTaskCommentArgs and Add ProjectCommentArgs now 🙌
Closes #243
Documentation reference: