chore: [BREAKING] bump version to v4.0.0 (migration from Todoist REST API to Todoist API v1) (#280)

Author: pedroalves0

.eslintrc.json

@@ -4,7 +4,7 @@
         "sourceType": "module",
         "project": ["tsconfig.json", "tsconfig.test.json"]
     },
-    "extends": ["@doist/eslint-config/recommended-requiring-type-checking"],
+    "extends": ["@doist/eslint-config/recommended-type-checked"],
     "env": {
         "browser": true,
         "jest": true

.github/workflows/deploy-docusaurus.yml

@@ -3,7 +3,7 @@ name: Deploy Docs to Pages
 on:
     push:
         branches:
-            - v4
+            - main
     workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -34,7 +34,10 @@ jobs:
               with:
                   node-version-file: .nvmrc
 
-            - name: Install dependencies
+            - name: Install SDK dependencies
+              run: npm ci
+
+            - name: Install docusaurus dependencies
               working-directory: ./website
               run: npm ci
 

.gitignore

@@ -6,3 +6,4 @@ node_modules/
 scratch.ts
 
 .vscode/
+.DS_Store

.prettierignore

@@ -0,0 +1,2 @@
+# ignore auto-generated documentation website
+website

README.md

@@ -24,7 +24,19 @@ api.getTasks()
 
 ### Documentation
 
-For more detailed reference documentation, have a look at the [API documentation with TypeScript examples](https://developer.todoist.com/rest/v2/?javascript).
+For more detailed reference documentation, have a look at the [Todoist API v1 Documentation](https://todoist.com/api/v1).
+
+### Migration Guide
+
+If you're migrating from an older version of the Todoist API (v9), please refer to the [official migration guide](https://todoist.com/api/v1/docs#tag/Migrating-from-v9) for detailed information about the changes and breaking updates.
+
+Key changes in v1 include:
+
+-   Updated endpoint structure
+-   New pagination system
+-   Unified error response format
+-   Object renames (e.g., items → tasks, notes → comments)
+-   URL renames and endpoint signature changes
 
 ## Development and Testing
 

jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
-    preset: "ts-jest",
+    preset: 'ts-jest',
     transform: { '^.+\\.ts': 'ts-jest' },
     testMatch: ['**/*.test.ts'],
     clearMocks: true,
-    testEnvironment: 'node'
+    testEnvironment: 'node',
 }