@doist/todoist-api-typescript 7.9.1 → 7.10.0

package/README.md

@@ -1,210 +1,11 @@
-# Todoist API TypeScript Client
+# @doist/todoist-api-typescript
 
-This is the official TypeScript API client for the Todoist REST API.
+> **This package has been renamed to [`@doist/todoist-sdk`](https://npmjs.com/package/@doist/todoist-sdk).**
 
-## Installation
-
-Requires Node 20.18.1+.
-
-```
-npm install @doist/todoist-api-typescript
-```
-
-### Usage
-
-An example of initializing the API client and fetching a user's tasks:
-
-```typescript
-import { TodoistApi } from '@doist/todoist-api-typescript'
-
-const api = new TodoistApi('YOURTOKEN')
-
-api.getTasks()
-    .then((tasks) => console.log(tasks))
-    .catch((error) => console.log(error))
-```
-
-### Documentation
-
-For more detailed reference documentation, have a look at the [Todoist API v1 Documentation](https://todoist.com/api/v1/docs).
-
-### 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
-
-## Custom HTTP Clients
-
-The Todoist API client supports custom HTTP implementations to enable usage in environments with specific networking requirements, such as:
-
--   **Obsidian plugins** - Desktop app with strict CORS policies
--   **Browser extensions** - Custom HTTP APIs with different security models
--   **Electron apps** - Requests routed through IPC layer
--   **React Native** - Different networking stack
--   **Enterprise environments** - Proxy configuration, custom headers, or certificate handling
-
-### Basic Usage
-
-```typescript
-import { TodoistApi } from '@doist/todoist-api-typescript'
-
-// Using the new options-based constructor
-const api = new TodoistApi('YOURTOKEN', {
-    baseUrl: 'https://custom-api.example.com', // optional
-    customFetch: myCustomFetch, // your custom fetch implementation
-})
-
-// Legacy constructor (deprecated but supported)
-const apiLegacy = new TodoistApi('YOURTOKEN', 'https://custom-api.example.com')
-```
-
-### Custom Fetch Interface
-
-Your custom fetch function must implement this interface:
-
-```typescript
-type CustomFetch = (
-    url: string,
-    options?: RequestInit & { timeout?: number },
-) => Promise<CustomFetchResponse>
-
-type CustomFetchResponse = {
-    ok: boolean
-    status: number
-    statusText: string
-    headers: Record<string, string>
-    text(): Promise<string>
-    json(): Promise<unknown>
-}
-```
-
-### OAuth with Custom Fetch
-
-OAuth authentication functions (`getAuthToken`, `revokeAuthToken`, `revokeToken`) support custom fetch through an options object:
-
-```typescript
-// New options-based usage
-const { accessToken } = await getAuthToken(args, {
-    baseUrl: 'https://custom-auth.example.com',
-    customFetch: myCustomFetch,
-})
-
-await revokeToken(args, {
-    customFetch: myCustomFetch,
-})
-
-// Legacy usage (deprecated)
-const { accessToken } = await getAuthToken(args, baseUrl)
-```
-
-### Important Notes
-
--   All existing transforms (snake_case ↔ camelCase) work automatically with custom fetch
--   Retry logic and error handling are preserved
--   File uploads work with custom fetch implementations
--   The custom fetch function should handle FormData for multipart uploads
--   Timeout parameter is optional and up to your custom implementation
-
-## Development and Testing
-
-Instead of having an example app in the repository to assist development and testing, we have included [ts-node](https://github.com/TypeStrong/ts-node) as a dev dependency. This allows us to have a scratch file locally that can import and utilize the API while developing or reviewing pull requests without having to manage a separate app project.
-
--   `npm install`
--   Add a file named `scratch.ts` in the `src` folder.
--   Configure your IDE to run the scratch file with `ts-node` (instructions for [VSCode](https://medium.com/@dupski/debug-typescript-in-vs-code-without-compiling-using-ts-node-9d1f4f9a94a), [WebStorm](https://www.jetbrains.com/help/webstorm/running-and-debugging-typescript.html#ws_ts_run_debug_server_side_ts_node)), or you can optionally run ts-node in a terminal using instructions [here](https://github.com/TypeStrong/ts-node) (`npx ts-node ./src/scratch.ts` should be enough).
--   Import and call the relevant modules and run the scratch file.
-
-Example scratch.ts file:
-
-```
-/* eslint-disable no-console */
-import { TodoistApi } from './todoist-api'
-
-const token = 'YOURTOKEN'
-const api = new TodoistApi(token)
-
-api.getProjects()
-    .then((projects) => {
-        console.log(projects)
-    })
-    .catch((error) => console.error(error))
-```
-
-### Local API Requests With .env
-
-For live API verification, you can run raw requests with a local token:
-
-1. Copy `.env.example` to `.env`.
-2. Set `TODOIST_API_TOKEN` in `.env`.
-3. Run requests with `npm run api:request -- ...`.
-4. Optional: set `TODOIST_API_BASE_URL` in `.env` (defaults to `https://api.todoist.com`).
-
-Examples:
+Please update your dependency:
 
 ```bash
-npm run api:request -- --path /api/v1/tasks
-npm run api:request -- --method POST --path /api/v1/tasks --body '{"content":"API smoke test"}'
-npm run api:request -- --method POST --path /api/v1/tasks/123 --body '{"due_string":"no date"}'
-npm run api:request -- --path /api/v1/tasks --query '{"project_id":"123","limit":10}'
-```
-
-To see all options:
-
-```bash
-npm run api:request -- --help
-```
-
-## Releases
-
-This project uses [Release Please](https://github.com/googleapis/release-please) to automate releases. Releases are created automatically based on [Conventional Commits](https://www.conventionalcommits.org/).
-
-### For Contributors
-
-When making changes, use conventional commit messages:
-
--   `feat:` - New features (triggers a minor version bump)
--   `fix:` - Bug fixes (triggers a patch version bump)
--   `feat!:` or `BREAKING CHANGE:` - Breaking changes (triggers a major version bump)
--   `chore:`, `docs:`, `refactor:`, `perf:` - Other changes (included in changelog)
-
-Example:
-
+npm install @doist/todoist-sdk
 ```
-feat: add support for recurring tasks
-fix: resolve issue with date parsing
-feat!: remove deprecated getTask method
-```
-
-### For Maintainers
-
-The release process is fully automated:
-
-1. **Automatic PR Creation**: When commits are merged to `main`, Release Please automatically creates or updates a release PR with:
-
-    - Updated version in `package.json`
-    - Updated `CHANGELOG.md`
-    - Aggregated changes since the last release
-
-2. **Review and Merge**: Review the release PR to ensure the version bump and changelog are correct, then merge it.
-
-3. **Automatic Release**: Upon merging the release PR:
-    - A GitHub release is automatically created with the new version tag
-    - The `publish.yml` workflow is triggered by the tag
-    - The package is automatically published to NPM
-
-Users of the API client can then update to the new version in their `package.json`.
-
-### Feedback
-
-Any feedback, such as bugs, questions, comments, etc. can be reported as _Issues_ in this repository, and will be handled by us in Todoist.
-
-### Contributions
 
-We would also love contributions in the form of _Pull requests_ in this repository.
+This package will continue to work as a shim for the foreseeable future, but will not receive new features.

package/index.d.ts

@@ -0,0 +1 @@
+export * from '@doist/todoist-sdk'

package/index.js

@@ -0,0 +1 @@
+module.exports = require('@doist/todoist-sdk')

package/index.mjs

@@ -0,0 +1 @@
+export * from '@doist/todoist-sdk'

package/package.json

@@ -1,101 +1,21 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "7.9.1",
-    "description": "A typescript wrapper for the Todoist REST API.",
-    "author": "Doist developers",
-    "repository": "https://github.com/Doist/todoist-api-typescript",
-    "homepage": "https://doist.github.io/todoist-api-typescript/",
-    "license": "MIT",
-    "type": "module",
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
-    "types": "dist/types/index.d.ts",
+    "version": "7.10.0",
+    "description": "Deprecated: renamed to @doist/todoist-sdk",
+    "main": "index.js",
+    "module": "index.mjs",
+    "types": "index.d.ts",
     "exports": {
         ".": {
-            "types": "./dist/types/index.d.ts",
-            "import": "./dist/esm/index.js",
-            "require": "./dist/cjs/index.js"
+            "types": "./index.d.ts",
+            "import": "./index.mjs",
+            "require": "./index.js"
         }
     },
-    "publishConfig": {
-        "access": "public",
-        "provenance": true
-    },
-    "sideEffects": false,
-    "engines": {
-        "node": ">=20.18.1"
-    },
-    "scripts": {
-        "clean": "rimraf dist",
-        "format-check": "npx prettier --check \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\" --ignore-path .prettierignore",
-        "format-fix": "npx prettier --write \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\" --ignore-path .prettierignore",
-        "lint": "oxlint src --fix",
-        "lint-check": "oxlint src",
-        "ts-compile-check": "npx tsc -p tsconfig.typecheck.json",
-        "audit": "npm audit --audit-level=moderate",
-        "test": "vitest run",
-        "test:watch": "vitest",
-        "test:coverage": "vitest run --coverage",
-        "api:request": "node ./scripts/todoist-api-request.cjs",
-        "build:cjs": "npx tsc -p tsconfig.cjs.json",
-        "build:esm": "npx tsc -p tsconfig.esm.json",
-        "build:fix-esm": "node scripts/fix-esm-imports.cjs",
-        "build:fix-dts": "node scripts/fix-dts-imports.cjs",
-        "build:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-        "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:fix-dts build:post",
-        "attw": "npx @arethetypeswrong/cli --pack --ignore-rules fallback-condition false-esm",
-        "integrity-checks": "npm-run-all clean format-check lint-check test build attw",
-        "prepublishOnly": "npm run integrity-checks",
-        "prepare": "npm run build"
-    },
     "dependencies": {
-        "camelcase": "6.3.0",
-        "emoji-regex": "10.6.0",
-        "form-data": "4.0.5",
-        "ts-custom-error": "^3.2.0",
-        "undici": "^7.16.0",
-        "uuid": "11.1.0",
-        "zod": "4.3.6"
-    },
-    "devDependencies": {
-        "@doist/prettier-config": "4.0.0",
-        "@semantic-release/changelog": "6.0.3",
-        "@semantic-release/exec": "7.1.0",
-        "@semantic-release/git": "10.0.1",
-        "conventional-changelog-conventionalcommits": "9.3.0",
-        "dotenv": "17.3.1",
-        "husky": "9.1.7",
-        "lint-staged": "16.2.7",
-        "msw": "2.12.13",
-        "npm-run-all2": "8.0.4",
-        "obsidian": "^1.10.2-1",
-        "oxlint": "1.57.0",
-        "prettier": "3.3.2",
-        "rimraf": "6.1.3",
-        "semantic-release": "25.0.3",
-        "ts-node": "10.9.2",
-        "type-fest": "^5.0.0",
-        "typescript": "5.9.3",
-        "vitest": "4.0.14"
+        "@doist/todoist-sdk": ">=8.0.0"
     },
-    "peerDependencies": {
-        "type-fest": "^4.12.0"
-    },
-    "prettier": "@doist/prettier-config",
-    "husky": {
-        "hooks": {
-            "pre-commit": "npx lint-staged && npm run build"
-        }
-    },
-    "lint-staged": {
-        "*.{ts,tsx}": "oxlint --fix",
-        "*.{ts,tsx,json,html,yml,yaml,md}": "prettier --check"
-    },
-    "files": [
-        "dist/cjs/**/*",
-        "dist/esm/**/*",
-        "dist/types/**/*",
-        "!dist/**/*.test.js",
-        "!dist/**/*.test.d.ts"
-    ]
+    "publishConfig": {
+        "access": "public"
+    }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Doist
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/cjs/authentication.js

@@ -1,204 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERMISSIONS = void 0;
-exports.getAuthStateParameter = getAuthStateParameter;
-exports.getAuthorizationUrl = getAuthorizationUrl;
-exports.getAuthToken = getAuthToken;
-exports.revokeToken = revokeToken;
-exports.migratePersonalToken = migratePersonalToken;
-const http_client_1 = require("./transport/http-client");
-const uuid_1 = require("uuid");
-const types_1 = require("./types");
-const endpoints_1 = require("./consts/endpoints");
-/** Available OAuth2 permission scopes. */
-exports.PERMISSIONS = [
-    'task:add',
-    'data:read',
-    'data:read_write',
-    'data:delete',
-    'project:delete',
-    'backups:read',
-];
-/**
- * Creates a Basic Authentication header value from client credentials.
- * @param clientId - The OAuth client ID
- * @param clientSecret - The OAuth client secret
- * @returns The Basic Auth header value (without the 'Basic ' prefix)
- */
-function createBasicAuthHeader(clientId, clientSecret) {
-    const credentials = `${clientId}:${clientSecret}`;
-    return Buffer.from(credentials).toString('base64');
-}
-/**
- * Generates a random state parameter for OAuth2 authorization.
- * The state parameter helps prevent CSRF attacks.
- *
- * @example
- * ```typescript
- * const state = getAuthStateParameter()
- * // Store state in session
- * const authUrl = getAuthorizationUrl(clientId, ['data:read'], state)
- * ```
- *
- * @returns A random UUID v4 string
- */
-function getAuthStateParameter() {
-    return (0, uuid_1.v4)();
-}
-/**
- * Generates the authorization URL for the OAuth2 flow.
- *
- * @example
- * ```typescript
- * const url = getAuthorizationUrl(
- *   'your-client-id',
- *   ['data:read', 'task:add'],
- *   state
- * )
- * // Redirect user to url
- * ```
- *
- * @returns The full authorization URL to redirect users to
- * @see https://developer.todoist.com/api/v1/#tag/Authorization/OAuth
- */
-function getAuthorizationUrl({ clientId, permissions, state, baseUrl, }) {
-    if (!(permissions === null || permissions === void 0 ? void 0 : permissions.length)) {
-        throw new Error('At least one scope value should be passed for permissions.');
-    }
-    const scope = permissions.join(',');
-    return `${(0, endpoints_1.getAuthBaseUri)(baseUrl)}${endpoints_1.ENDPOINT_AUTHORIZATION}?client_id=${clientId}&scope=${scope}&state=${state}`;
-}
-/**
- * Exchanges an authorization code for an access token.
- *
- * @example
- * ```typescript
- * const { accessToken } = await getAuthToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   code: authCode
- * })
- * ```
- *
- * @returns The access token response
- * @throws {@link TodoistRequestError} If the token exchange fails
- */
-async function getAuthToken(args, options) {
-    var _a;
-    if (typeof options === 'string') {
-        throw new TypeError('Passing baseUrl as a string is no longer supported. Use an options object instead: getAuthToken(args, { baseUrl })');
-    }
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    try {
-        const response = await (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: (0, endpoints_1.getAuthBaseUri)(baseUrl),
-            relativePath: endpoints_1.ENDPOINT_GET_TOKEN,
-            apiToken: undefined,
-            payload: args,
-            customFetch,
-        });
-        if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
-            throw new types_1.TodoistRequestError('Authentication token exchange failed.', response.status, response.data);
-        }
-        return response.data;
-    }
-    catch (error) {
-        // Re-throw with custom message for authentication failures
-        const err = error;
-        throw new types_1.TodoistRequestError('Authentication token exchange failed.', err.httpStatusCode, err.responseData);
-    }
-}
-/**
- * Revokes a token using the RFC 7009 OAuth 2.0 Token Revocation standard.
- *
- * This function uses HTTP Basic Authentication with client credentials and follows
- * the RFC 7009 specification for token revocation.
- *
- * @example
- * ```typescript
- * await revokeToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   token: 'access-token-to-revoke'
- * })
- * ```
- *
- * @returns True if revocation was successful
- * @see https://datatracker.ietf.org/doc/html/rfc7009
- * @see https://developer.todoist.com/api/v1/#tag/Authorization
- */
-async function revokeToken(args, options) {
-    if (typeof options === 'string') {
-        throw new TypeError('Passing baseUrl as a string is no longer supported. Use an options object instead: revokeToken(args, { baseUrl })');
-    }
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    const { clientId, clientSecret, token } = args;
-    // Create Basic Auth header as per RFC 7009
-    const basicAuth = createBasicAuthHeader(clientId, clientSecret);
-    const customHeaders = {
-        Authorization: `Basic ${basicAuth}`,
-    };
-    // Request body only contains the token and optional token_type_hint
-    const requestBody = {
-        token,
-        token_type_hint: 'access_token',
-    };
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
-        relativePath: endpoints_1.ENDPOINT_REVOKE,
-        apiToken: undefined,
-        payload: requestBody,
-        requestId: undefined,
-        hasSyncCommands: false,
-        customHeaders: customHeaders,
-        customFetch,
-    });
-    return (0, http_client_1.isSuccess)(response);
-}
-/**
- * Migrates a personal API token to an OAuth access token.
- *
- * This allows applications to transition users from personal API tokens
- * to proper OAuth tokens without requiring the user to go through the
- * full OAuth authorization flow.
- *
- * @example
- * ```typescript
- * const { accessToken } = await migratePersonalToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   personalToken: 'user-personal-token',
- *   scope: 'data:read_write,data:delete'
- * })
- * ```
- *
- * @returns The new OAuth token response
- * @throws {@link TodoistRequestError} If the migration fails
- */
-async function migratePersonalToken(args, options) {
-    var _a;
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    try {
-        const response = await (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
-            relativePath: endpoints_1.ENDPOINT_REST_ACCESS_TOKENS_MIGRATE,
-            apiToken: undefined,
-            payload: Object.assign(Object.assign({}, args), { scope: args.scope.join(',') }),
-            customFetch,
-        });
-        if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
-            throw new types_1.TodoistRequestError('Personal token migration failed.', response.status, response.data);
-        }
-        return response.data;
-    }
-    catch (error) {
-        const err = error;
-        throw new types_1.TodoistRequestError('Personal token migration failed.', err.httpStatusCode, err.responseData);
-    }
-}