Merge pull request #22 from riexn/duedate-fix

Fix due date type when creating a new item

Author: romgrk

.gitignore

@@ -1,2 +1,3 @@
 dist
 node_modules
+.env

package-lock.json

@@ -50,6 +50,8 @@
     "@types/jest": "^25.1.4",
     "@types/node": "^13.9.8",
     "@types/uuid": "^8.0.0",
+    "cross-env": "^7.0.3",
+    "dotenv": "^10.0.0",
     "faker": "^4.1.0",
     "jest": "^25.2.4",
     "nodemon": "^2.0.4",

package.json

@@ -20,6 +20,17 @@ export interface DueDate {
   is_recurring: boolean
 }
 
+export interface DueDateInputString {
+  string: string
+  timezone?: string
+}
+
+export interface DueDateInputDate {
+  date: string
+}
+
+export type DueDateInput = DueDateInputString | DueDateInputDate
+
 export type Boolean = 0 | 1
 
 export type Priority = 1 | 2 | 3 | 4
@@ -110,7 +121,7 @@ export interface ItemAdd {
   /** The id of the project to add the task to (a number or a temp id). By default the task is added to the user’s Inbox project. */
   project_id?: Id
   /** The due date of the task. See the Due dates section for more details. */
-  due?: DueDate
+  due?: DueDateInput
   /** The priority of the task (a number between 1 and 4, 4 for very urgent and 1 for natural). */
   /** Note: Keep in mind that very urgent is the priority 1 on clients. So, p1 will return 4 in the API. */
   priority?: Priority

src/v8-types.ts

@@ -0,0 +1,87 @@
+import { v8 as Todoist } from './index'
+import { config } from 'dotenv'
+import { NodeType } from './v8-types'
+import path from 'path'
+config({ path: path.basename(__dirname + '/.env') })
+
+type ApiType = ReturnType<typeof Todoist>
+let api: ApiType
+
+describe('initialization', () => {
+  it('fails with invalid api key', () => {
+    expect(() => {
+      api = Todoist('invalid')
+    }).toThrow()
+  })
+
+  it('works', () => {
+    api = Todoist(process.env.TODOIST_API_KEY as string)
+  })
+
+  test('.sync() properly', async () => {
+    await api.sync()
+  })
+})
+
+describe('.items CRUD', () => {
+  let newItem: NodeType | undefined
+
+  test('.get() returns data', () => {
+    const items = api.items.get()
+    expect(items).toBeInstanceOf(Array)
+  })
+
+  test('.add() works', async () => {
+    newItem = await api.items.add({ content: 'testing-task' })
+    expect(newItem).toMatchObject({ content: 'testing-task' })
+  })
+
+  test('.delete() works', async () => {
+    if (!newItem) return
+    await api.items.delete({ id: newItem.id })
+    const deletedItem = api.items.get().find((item) => item.id === newItem?.id)
+    expect(deletedItem).toBeUndefined()
+  })
+})
+
+describe('.items due dates', () => {
+  let item: NodeType | undefined
+
+  afterEach(async () => {
+    if (item) {
+      await api.items.delete({ id: item.id })
+    }
+  })
+
+  test('.add() with string due date', async () => {
+    item = await api.items.add({ content: 'testing-task', due: { string: '17th of july 2021' } })
+    expect(item).toMatchObject({
+      content: 'testing-task',
+      due: {
+        date: '2021-07-17',
+        is_recurring: false,
+        lang: 'en',
+        string: '17th of july 2021',
+        timezone: null,
+      },
+    })
+  })
+
+  test('.add() with due date', async () => {
+    item = await api.items.add({
+      content: 'testing-task',
+      due: { date: '2018-10-14' },
+    })
+    console.log(item)
+    expect(item).toMatchObject({
+      content: 'testing-task',
+      due: {
+        date: '2018-10-14',
+        is_recurring: false,
+        lang: 'en',
+        string: '2018-10-14',
+        timezone: null,
+      },
+    })
+  })
+})

src/v8.test.js

@@ -232,8 +232,10 @@ export const Todoist = (token: string, userOptions = defaultOptions) => {
     >
     return state[stateKey].find((item) => item.id === newId)
   }
-  const createCommand = <Args>(type: keyof TodoistResources, action: string) => async (args: Args) =>
-    executeCommand(type, action, args)
+  const createCommand =
+    <Args>(type: keyof TodoistResources, action: string) =>
+    async (args: Args) =>
+      executeCommand(type, action, args)
 
   const sync = async (resourceTypes = options.resourceTypes) => {
     const res = await request(
@@ -373,7 +375,9 @@ export const Todoist = (token: string, userOptions = defaultOptions) => {
 
   const syncToken_ = {
     get: () => syncToken,
-    set: (newToken: string) => { syncToken = newToken },
+    set: (newToken: string) => {
+      syncToken = newToken
+    },
   }
 
   const api = {