@doist/todoist-api-typescript 5.9.0 → 6.0.0

package/dist/esm/utils/validators.js

@@ -0,0 +1,97 @@
+import { AttachmentSchema, SectionSchema, LabelSchema, CommentSchema, UserSchema, CurrentUserSchema, TaskSchema, PersonalProjectSchema, WorkspaceProjectSchema, ProductivityStatsSchema, ActivityEventSchema, WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, } from '../types/entities.js';
+export function validateTask(input) {
+    return TaskSchema.parse(input);
+}
+export function validateTaskArray(input) {
+    return input.map(validateTask);
+}
+/**
+ * Type guard to check if a project is a workspace project.
+ * @param project The project to check
+ * @returns True if the project is a workspace project
+ */
+export function isWorkspaceProject(project) {
+    return 'workspaceId' in project;
+}
+/**
+ * Type guard to check if a project is a personal project.
+ * @param project The project to check
+ * @returns True if the project is a personal project
+ */
+export function isPersonalProject(project) {
+    return !isWorkspaceProject(project);
+}
+/**
+ * Validates and parses a project input.
+ * @param input The input to validate
+ * @returns A validated project (either PersonalProject or WorkspaceProject)
+ */
+export function validateProject(input) {
+    if ('workspaceId' in input) {
+        return WorkspaceProjectSchema.parse(input);
+    }
+    return PersonalProjectSchema.parse(input);
+}
+export function validateProjectArray(input) {
+    return input.map(validateProject);
+}
+export function validateSection(input) {
+    return SectionSchema.parse(input);
+}
+export function validateSectionArray(input) {
+    return input.map(validateSection);
+}
+export function validateLabel(input) {
+    return LabelSchema.parse(input);
+}
+export function validateLabelArray(input) {
+    return input.map(validateLabel);
+}
+export function validateComment(input) {
+    return CommentSchema.parse(input);
+}
+export function validateCommentArray(input) {
+    return input.map(validateComment);
+}
+export function validateUser(input) {
+    return UserSchema.parse(input);
+}
+export function validateUserArray(input) {
+    return input.map(validateUser);
+}
+export function validateProductivityStats(input) {
+    return ProductivityStatsSchema.parse(input);
+}
+export function validateCurrentUser(input) {
+    return CurrentUserSchema.parse(input);
+}
+export function validateActivityEvent(input) {
+    return ActivityEventSchema.parse(input);
+}
+export function validateActivityEventArray(input) {
+    return input.map(validateActivityEvent);
+}
+export function validateAttachment(input) {
+    return AttachmentSchema.parse(input);
+}
+export function validateWorkspaceUser(input) {
+    return WorkspaceUserSchema.parse(input);
+}
+export function validateWorkspaceUserArray(input) {
+    if (!Array.isArray(input)) {
+        throw new Error(`Expected array for workspace users, got ${typeof input}`);
+    }
+    return input.map(validateWorkspaceUser);
+}
+export function validateWorkspaceInvitation(input) {
+    return WorkspaceInvitationSchema.parse(input);
+}
+export function validateWorkspaceInvitationArray(input) {
+    return input.map(validateWorkspaceInvitation);
+}
+export function validateWorkspacePlanDetails(input) {
+    return WorkspacePlanDetailsSchema.parse(input);
+}
+export function validateJoinWorkspaceResult(input) {
+    return JoinWorkspaceResultSchema.parse(input);
+}

package/dist/{authentication.d.ts → types/authentication.d.ts}

@@ -68,7 +68,12 @@ export declare function getAuthStateParameter(): string;
  * @returns The full authorization URL to redirect users to
  * @see https://todoist.com/api/v1/docs#tag/Authorization/OAuth
  */
-export declare function getAuthorizationUrl(clientId: string, permissions: Permission[], state: string, baseUrl?: string): string;
+export declare function getAuthorizationUrl({ clientId, permissions, state, baseUrl, }: {
+    clientId: string;
+    permissions: Permission[];
+    state: string;
+    baseUrl?: string;
+}): string;
 /**
  * Exchanges an authorization code for an access token.
  *

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
-export * from './entities';
-export * from './errors';
-export * from './requests';
+export * from './todoist-api';
+export * from './authentication';
+export * from './types';
+export * from './utils';

package/dist/{rest-client.d.ts → types/rest-client.d.ts}

@@ -1,5 +1,4 @@
-import { AxiosResponse } from 'axios';
-import { HttpMethod } from './types/http';
+import { HttpMethod, HttpResponse } from './types/http';
 type RequestArgs = {
     httpMethod: HttpMethod;
     baseUri: string;
@@ -11,6 +10,6 @@ type RequestArgs = {
     customHeaders?: Record<string, string>;
 };
 export declare function paramsSerializer(params: Record<string, unknown>): string;
-export declare function isSuccess(response: AxiosResponse): boolean;
-export declare function request<T>(args: RequestArgs): Promise<AxiosResponse<T>>;
+export declare function isSuccess(response: HttpResponse): boolean;
+export declare function request<T>(args: RequestArgs): Promise<HttpResponse<T>>;
 export {};

package/dist/types/test-utils/msw-setup.d.ts

@@ -0,0 +1,3 @@
+export declare const handlers: never[];
+export declare const server: import("msw/node").SetupServerApi;
+export { http, HttpResponse } from 'msw';

package/dist/types/types/http.d.ts

@@ -0,0 +1,68 @@
+export type HttpMethod = 'POST' | 'GET' | 'DELETE' | 'PUT';
+/**
+ * HTTP response type that replaces AxiosResponse
+ */
+export type HttpResponse<T = unknown> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+};
+/**
+ * HTTP request configuration
+ */
+export type HttpRequestConfig = {
+    method?: HttpMethod;
+    headers?: Record<string, string>;
+    timeout?: number;
+    signal?: AbortSignal;
+};
+/**
+ * Internal HTTP request options
+ */
+export type HttpRequestOptions = HttpRequestConfig & {
+    url: string;
+    params?: Record<string, unknown>;
+    data?: unknown;
+};
+/**
+ * Configuration for retry behavior
+ */
+export type RetryConfig = {
+    retries: number;
+    retryCondition: (error: Error) => boolean;
+    retryDelay: (retryNumber: number) => number;
+};
+/**
+ * Configuration for the HTTP client
+ */
+export type HttpClientConfig = {
+    baseURL?: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+    retry?: RetryConfig;
+};
+/**
+ * Network error type for retry logic
+ */
+export type NetworkError = Error & {
+    code?: string;
+    isNetworkError: true;
+};
+/**
+ * HTTP error with status code and response data
+ */
+export type HttpError = Error & {
+    status?: number;
+    statusText?: string;
+    response?: HttpResponse<unknown>;
+    data?: unknown;
+};
+/**
+ * Type guard to check if an error is a network error
+ */
+export declare function isNetworkError(error: Error): error is NetworkError;
+/**
+ * Type guard to check if an error is an HTTP error
+ */
+export declare function isHttpError(error: Error): error is HttpError;

package/dist/types/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './errors';
+export * from './requests';

package/dist/types/utils/case-conversion.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Custom camelCase function that preserves emoji strings
+ */
+export declare function customCamelCase(input: string): string;
+/**
+ * Converts object keys from snake_case to camelCase recursively
+ */
+export declare function camelCaseKeys<T>(obj: T): T;
+/**
+ * Converts object keys from camelCase to snake_case recursively
+ */
+export declare function snakeCaseKeys<T>(obj: T): T;

package/dist/types/utils/fetch-with-retry.d.ts

@@ -0,0 +1,11 @@
+import type { HttpResponse, RetryConfig } from '../types/http';
+/**
+ * Performs a fetch request with retry logic and timeout support
+ */
+export declare function fetchWithRetry<T = unknown>(args: {
+    url: string;
+    options?: RequestInit & {
+        timeout?: number;
+    };
+    retryConfig?: Partial<RetryConfig>;
+}): Promise<HttpResponse<T>>;

package/package.json

@@ -1,14 +1,26 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "5.9.0",
+    "version": "6.0.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",
     "homepage": "https://doist.github.io/todoist-api-typescript/",
     "license": "MIT",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "type": "module",
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/esm/index.js",
+            "require": "./dist/cjs/index.js",
+            "types": "./dist/types/index.d.ts"
+        }
+    },
     "sideEffects": false,
+    "engines": {
+        "node": ">=20.0.0"
+    },
     "scripts": {
         "clean": "rimraf dist",
         "format-check": "npx prettier --check \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\"",
@@ -18,15 +30,16 @@
         "ts-compile-check": "npx tsc -p tsconfig.typecheck.json",
         "audit": "npm audit --audit-level=moderate",
         "test": "jest",
-        "build": "npx tsc -p tsconfig.json",
+        "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:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+        "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:post",
         "integrity-checks": "npm-run-all clean format-check lint-check test build",
         "prepublishOnly": "npm run integrity-checks",
         "prepare": "npm run build"
     },
     "dependencies": {
-        "axios": "^1.0.0",
-        "axios-case-converter": "^1.0.0",
-        "axios-retry": "^4.0.0",
         "camelcase": "6.3.0",
         "emoji-regex": "10.6.0",
         "form-data": "4.0.4",
@@ -48,6 +61,7 @@
         "husky": "9.1.7",
         "jest": "30.1.3",
         "lint-staged": "16.1.6",
+        "msw": "2.11.6",
         "npm-run-all2": "8.0.4",
         "prettier": "3.3.2",
         "rimraf": "6.0.1",
@@ -70,7 +84,9 @@
         "*.{ts,tsx,json,html,yml,yaml,md}": "prettier --check"
     },
     "files": [
-        "dist/**/*",
+        "dist/cjs/**/*",
+        "dist/esm/**/*",
+        "dist/types/**/*",
         "!dist/**/*.test.js",
         "!dist/**/*.test.d.ts"
     ]

package/dist/authentication.js

@@ -1,220 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuthStateParameter = getAuthStateParameter;
-exports.getAuthorizationUrl = getAuthorizationUrl;
-exports.getAuthToken = getAuthToken;
-exports.revokeAuthToken = revokeAuthToken;
-exports.revokeToken = revokeToken;
-var rest_client_1 = require("./rest-client");
-var uuid_1 = require("uuid");
-var types_1 = require("./types");
-var endpoints_1 = require("./consts/endpoints");
-/**
- * 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) {
-    var credentials = "".concat(clientId, ":").concat(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://todoist.com/api/v1/docs#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.');
-    }
-    var scope = permissions.join(',');
-    return "".concat((0, endpoints_1.getAuthBaseUri)(baseUrl)).concat(endpoints_1.ENDPOINT_AUTHORIZATION, "?client_id=").concat(clientId, "&scope=").concat(scope, "&state=").concat(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
- */
-function getAuthToken(args, baseUrl) {
-    return __awaiter(this, void 0, void 0, function () {
-        var response;
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, (0, rest_client_1.request)({
-                        httpMethod: 'POST',
-                        baseUri: (0, endpoints_1.getAuthBaseUri)(baseUrl),
-                        relativePath: endpoints_1.ENDPOINT_GET_TOKEN,
-                        apiToken: undefined,
-                        payload: args,
-                    })];
-                case 1:
-                    response = _b.sent();
-                    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 [2 /*return*/, response.data];
-            }
-        });
-    });
-}
-/**
- * Revokes an access token, making it invalid for future use.
- *
- * @example
- * ```typescript
- * await revokeAuthToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   accessToken: token
- * })
- * ```
- *
- * @deprecated Use {@link revokeToken} instead. This function uses a legacy endpoint that will be removed in a future version. The new function uses the RFC 7009 compliant endpoint.
- * @returns True if revocation was successful
- * @see https://todoist.com/api/v1/docs#tag/Authorization/operation/revoke_access_token_api_api_v1_access_tokens_delete
- */
-function revokeAuthToken(args, baseUrl) {
-    return __awaiter(this, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, (0, rest_client_1.request)({
-                        httpMethod: 'POST',
-                        baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
-                        relativePath: endpoints_1.ENDPOINT_REVOKE_TOKEN,
-                        apiToken: undefined,
-                        payload: args,
-                    })];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, (0, rest_client_1.isSuccess)(response)];
-            }
-        });
-    });
-}
-/**
- * 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://todoist.com/api/v1/docs#tag/Authorization
- */
-function revokeToken(args, baseUrl) {
-    return __awaiter(this, void 0, void 0, function () {
-        var clientId, clientSecret, token, basicAuth, customHeaders, requestBody, response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    clientId = args.clientId, clientSecret = args.clientSecret, token = args.token;
-                    basicAuth = createBasicAuthHeader(clientId, clientSecret);
-                    customHeaders = {
-                        Authorization: "Basic ".concat(basicAuth),
-                    };
-                    requestBody = {
-                        token: token,
-                        token_type_hint: 'access_token',
-                    };
-                    return [4 /*yield*/, (0, rest_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,
-                        })];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, (0, rest_client_1.isSuccess)(response)];
-            }
-        });
-    });
-}

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './todoist-api';
-export * from './authentication';
-export * from './types';
-export * from './utils';