feat: support null alias for task due clearing (#478)

Author: gnapse

src/todoist-api.tasks.test.ts

@@ -205,6 +205,50 @@ describe('TodoistApi task endpoints', () => {
 
             expect(response.isUncompletable).toBe(false)
         })
+
+        test('translates dueString null to "no date"', async () => {
+            const returnedTask = {
+                ...DEFAULT_TASK,
+                due: null,
+            }
+
+            server.use(
+                http.post(`${getSyncBaseUri()}${ENDPOINT_REST_TASKS}/123`, async ({ request }) => {
+                    const body = (await request.json()) as Record<string, unknown>
+                    expect(body.due_string).toBe('no date')
+                    return HttpResponse.json(returnedTask, { status: 200 })
+                }),
+            )
+            const api = getTarget()
+
+            const response = await api.updateTask('123', {
+                dueString: null,
+            })
+
+            expect(response.due).toBeNull()
+        })
+
+        test('keeps deadlineDate null in payload', async () => {
+            const returnedTask = {
+                ...DEFAULT_TASK,
+                deadline: null,
+            }
+
+            server.use(
+                http.post(`${getSyncBaseUri()}${ENDPOINT_REST_TASKS}/123`, async ({ request }) => {
+                    const body = (await request.json()) as Record<string, unknown>
+                    expect(body.deadline_date).toBeNull()
+                    return HttpResponse.json(returnedTask, { status: 200 })
+                }),
+            )
+            const api = getTarget()
+
+            const response = await api.updateTask('123', {
+                deadlineDate: null,
+            })
+
+            expect(response.deadline).toBeNull()
+        })
     })
 
     describe('closeTask', () => {

src/todoist-api.ts

@@ -588,18 +588,28 @@ export class TodoistApi {
      * Updates an existing task by its ID with the provided parameters.
      *
      * @param id - The unique identifier of the task to update.
-     * @param args - Update parameters such as content, priority, or due date.
+     * @param args - Update parameters such as content, priority, or due date. Pass
+     * `dueString: null` (or `"no date"`) to clear the due date.
      * @param requestId - Optional custom identifier for the request.
      * @returns A promise that resolves to the updated task.
      */
     async updateTask(id: string, args: UpdateTaskArgs, requestId?: string): Promise<Task> {
         z.string().parse(id)
 
+        // Translate SDK alias for due-date clearing to Todoist's accepted payload value.
+        const normalizedArgs = args.dueString === null ? { ...args, dueString: 'no date' } : args
+
         // Process content if both content and isUncompletable are provided
         const processedArgs =
-            args.content && args.isUncompletable !== undefined
-                ? { ...args, content: processTaskContent(args.content, args.isUncompletable) }
-                : args
+            normalizedArgs.content && normalizedArgs.isUncompletable !== undefined
+                ? {
+                      ...normalizedArgs,
+                      content: processTaskContent(
+                          normalizedArgs.content,
+                          normalizedArgs.isUncompletable,
+                      ),
+                  }
+                : normalizedArgs
 
         const response = await request<Task>({
             httpMethod: 'POST',

src/types/requests.ts

@@ -140,9 +140,17 @@ export type UpdateTaskArgs = {
     description?: string
     labels?: string[]
     priority?: number
-    dueString?: string
+    /**
+     * Natural language due date.
+     * Use `"no date"` to clear a due date, or `null` as an SDK alias for the same behavior.
+     */
+    dueString?: (string & {}) | 'no date' | null
     dueLang?: string | null
     assigneeId?: string | null
+    /**
+     * Deadline date in `YYYY-MM-DD` format.
+     * Use `null` to clear a task deadline.
+     */
     deadlineDate?: string | null
     deadlineLang?: string | null
     isUncompletable?: boolean