chore: Corrects the quick add types and fixes the tests

Author: scottlovegrove

src/TodoistApi.comments.test.ts

@@ -16,7 +16,7 @@ function getTarget() {
 describe('TodoistApi comment endpoints', () => {
     describe('getComments', () => {
         test('calls get request with expected params', async () => {
-            const getCommentsArgs = { projectId: 12 }
+            const getCommentsArgs = { projectId: '12' }
             const requestMock = setupRestClientMock([DEFAULT_COMMENT])
             const api = getTarget()
 
@@ -37,7 +37,7 @@ describe('TodoistApi comment endpoints', () => {
             setupRestClientMock(expectedComments)
             const api = getTarget()
 
-            const comments = await api.getComments({ taskId: 12 })
+            const comments = await api.getComments({ taskId: '12' })
 
             expect(comments).toEqual(expectedComments)
         })
@@ -80,7 +80,7 @@ describe('TodoistApi comment endpoints', () => {
     describe('addComment', () => {
         const addCommentArgs = {
             content: 'A comment',
-            taskId: 123,
+            taskId: '123',
         }
 
         test('makes post request with expected params', async () => {

src/TodoistApi.sections.test.ts

@@ -79,7 +79,7 @@ describe('TodoistApi section endpoints', () => {
     describe('addSection', () => {
         const DEFAULT_ADD_SECTION_ARGS = {
             name: 'This is a section',
-            projectId: 123,
+            projectId: '123',
         }
 
         test('calls post on restClient with expected parameters', async () => {

src/TodoistApi.tasks.test.ts

@@ -265,7 +265,7 @@ describe('TodoistApi task endpoints', () => {
 
     describe('getTasks', () => {
         const DEFAULT_GET_TASKS_ARGS = {
-            projectId: 123,
+            projectId: '123',
         }
 
         test('calls get on expected endpoint with args', async () => {

src/testUtils/testDefaults.ts

@@ -23,6 +23,7 @@ const DEFAULT_SECTION_ID = '456'
 const DEFAULT_SECTION_NAME = 'This is a section'
 const DEFAULT_PARENT_ID = '5678'
 const DEFAULT_ASSIGNEE = '1234'
+const DEFAULT_CREATOR = '1234'
 const DEFAULT_DATE = '2020-09-08T12:00:00Z'
 const DEFAULT_ENTITY_COLOR = 'berry_red'
 const DEFAULT_LABELS = ['personal', 'work', 'hobby']
@@ -49,18 +50,19 @@ export const INVALID_DUE_DATE = {
 }
 
 export const DEFAULT_QUICK_ADD_RESPONSE: QuickAddTaskResponse = {
-    id: DEFAULT_TASK_ID,
-    projectId: DEFAULT_PROJECT_ID,
+    id: parseInt(DEFAULT_TASK_ID),
+    projectId: parseInt(DEFAULT_PROJECT_ID),
     content: DEFAULT_TASK_CONTENT,
     description: DEFAULT_TASK_DESCRIPTION,
     priority: DEFAULT_TASK_PRIORITY,
-    sectionId: DEFAULT_SECTION_ID,
-    parentId: DEFAULT_PARENT_ID,
+    sectionId: parseInt(DEFAULT_SECTION_ID),
+    parentId: parseInt(DEFAULT_PARENT_ID),
     childOrder: DEFAULT_ORDER,
-    labels: DEFAULT_LABELS,
-    responsibleUid: DEFAULT_ASSIGNEE,
+    labels: [1, 2, 3],
+    responsibleUid: parseInt(DEFAULT_ASSIGNEE),
     checked: 0,
     dateAdded: DEFAULT_DATE,
+    creatorId: parseInt(DEFAULT_CREATOR),
     due: {
         date: DEFAULT_DATE,
         timezone: null,
@@ -86,6 +88,7 @@ export const DEFAULT_TASK: Task = {
     url: 'https://todoist.com/showTask?id=1234',
     due: DEFAULT_DUE_DATE,
     assigneeId: DEFAULT_ASSIGNEE,
+    creatorId: DEFAULT_CREATOR,
 }
 
 export const INVALID_TASK = {

src/types/entities.ts

@@ -51,6 +51,7 @@ export const Task = Record({
     commentCount: Int,
     createdAt: String,
     url: String,
+    creatorId: String,
 }).And(
     Partial({
         due: DueDate,
@@ -150,18 +151,19 @@ export type Color = TodoistEntity & {
 }
 
 export type QuickAddTaskResponse = {
-    id: string
-    projectId: string
+    id: number
+    projectId: number
     content: string
     description: string
     priority: number
-    sectionId: string | null
-    parentId: string | null
+    sectionId: number | null
+    parentId: number | null
     childOrder: number // order
-    labels: string[] // labelIds
-    responsibleUid: string | null
+    labels: number[] // labelIds
+    responsibleUid: number | null
     checked: number // completed
     dateAdded: string // created
+    creatorId: number | null
     due: {
         date: string
         timezone: string | null

src/utils/colors.test.ts

@@ -1,4 +1,4 @@
-import { getColor, berryRed, charcoal, taupe } from './colors'
+import { berryRed, charcoal, taupe, getColorById } from './colors'
 
 describe('getColor', () => {
     const colorTheories = [
@@ -9,7 +9,7 @@ describe('getColor', () => {
     ] as const
 
     test.each(colorTheories)('id %p returns color %p', (id, expected) => {
-        const color = getColor(id)
+        const color = getColorById(id)
         expect(color).toEqual(expected)
     })
 })

src/utils/taskConverters.test.ts

@@ -4,7 +4,7 @@ import { DEFAULT_QUICK_ADD_RESPONSE, DEFAULT_TASK } from '../testUtils/testDefau
 describe('getTaskFromQuickAddResponse', () => {
     test('maps sync data to expected task properties', () => {
         const task = getTaskFromQuickAddResponse(DEFAULT_QUICK_ADD_RESPONSE)
-        expect(task).toEqual(DEFAULT_TASK)
+        expect(task).toEqual({ ...DEFAULT_TASK, labels: ['1', '2', '3'] })
     })
 
     test('converts null sectionId to null', () => {
@@ -62,8 +62,8 @@ describe('getTaskFromQuickAddResponse', () => {
     })
 
     const taskUrlTheories = [
-        ['1234', 'https://todoist.com/showTask?id=1234'],
-        ['1234', 'https://todoist.com/showTask?id=1234'],
+        [1234, 'https://todoist.com/showTask?id=1234'],
+        [1234, 'https://todoist.com/showTask?id=1234'],
     ] as const
 
     test.each(taskUrlTheories)('with id %p and syncId %p returns url %p', (id, url) => {

src/utils/taskConverters.ts

@@ -18,21 +18,24 @@ export function getTaskFromQuickAddResponse(responseData: QuickAddTaskResponse):
         : undefined
 
     const task = {
-        id: responseData.id,
+        id: String(responseData.id),
         order: responseData.childOrder,
         content: responseData.content,
         description: responseData.description,
-        projectId: responseData.projectId,
-        sectionId: responseData.sectionId ?? undefined,
+        projectId: String(responseData.projectId),
+        sectionId: responseData.sectionId ? String(responseData.sectionId) : undefined,
         isCompleted: responseData.checked === 1,
-        labels: responseData.labels,
+        labels: responseData.labels.map((x) => String(x)),
         priority: responseData.priority,
         commentCount: 0, // Will always be 0 for a quick add
         createdAt: responseData.dateAdded,
         url: getTaskUrlFromQuickAddResponse(responseData),
+        creatorId: responseData.creatorId ? String(responseData.creatorId) : '',
         ...(due !== undefined && { due }),
-        ...(responseData.parentId !== null && { parentId: responseData.parentId }),
-        ...(responseData.responsibleUid !== null && { assigneeId: responseData.responsibleUid }),
+        ...(responseData.parentId !== null && { parentId: String(responseData.parentId) }),
+        ...(responseData.responsibleUid !== null && {
+            assigneeId: String(responseData.responsibleUid),
+        }),
     }
 
     return task