@doist/todoist-api-typescript 6.0.0 → 6.1.4

package/dist/types/rest-client.d.ts

@@ -1,4 +1,4 @@
-import { HttpMethod, HttpResponse } from './types/http';
+import { HttpMethod, HttpResponse, CustomFetch } from './types/http';
 type RequestArgs = {
     httpMethod: HttpMethod;
     baseUri: string;
@@ -8,6 +8,7 @@ type RequestArgs = {
     requestId?: string;
     hasSyncCommands?: boolean;
     customHeaders?: Record<string, string>;
+    customFetch?: CustomFetch;
 };
 export declare function paramsSerializer(params: Record<string, unknown>): string;
 export declare function isSuccess(response: HttpResponse): boolean;

package/dist/types/test-utils/mocks.d.ts

@@ -1 +0,0 @@
-export declare function setupRestClientMock(responseData: unknown, status?: number): jest.SpyInstance;

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

@@ -1,3 +1,33 @@
+import { http, HttpResponse, type DefaultBodyType } from 'msw';
+export type MockApiOptions = {
+    status?: number;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: Record<string, string>;
+};
+export type CapturedRequest = {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body: unknown;
+};
+export declare function captureRequest({ request, body }: {
+    request: Request;
+    body: unknown;
+}): void;
+export declare function getLastRequest(): CapturedRequest | undefined;
+export declare function getAllRequests(): CapturedRequest[];
+export declare function clearCapturedRequests(): void;
 export declare const handlers: never[];
 export declare const server: import("msw/node").SetupServerApi;
-export { http, HttpResponse } from 'msw';
+export declare function mockApiResponse<T extends DefaultBodyType>({ endpoint, data, options, }: {
+    endpoint: string;
+    data: T;
+    options?: MockApiOptions;
+}): void;
+export declare function mockApiError<T extends DefaultBodyType>({ endpoint, data, status, options, }: {
+    endpoint: string;
+    data: T;
+    status: number;
+    options?: Omit<MockApiOptions, 'status'>;
+}): void;
+export { http, HttpResponse };

package/dist/types/test-utils/obsidian-fetch-adapter.d.ts

@@ -0,0 +1,29 @@
+import type { RequestUrlParam, RequestUrlResponse } from 'obsidian';
+import type { CustomFetch } from '../types/http';
+/**
+ * Creates a CustomFetch adapter for Obsidian's requestUrl API.
+ *
+ * This adapter bridges the gap between Obsidian's requestUrl interface and the
+ * standard fetch-like interface expected by the Todoist API SDK.
+ *
+ * Key differences handled by this adapter:
+ * - Obsidian returns response data as properties (response.json, response.text)
+ *   while the SDK expects methods (response.json(), response.text())
+ * - Obsidian's requestUrl bypasses CORS restrictions that would block standard fetch
+ * - Obsidian throws on HTTP errors by default; we set throw: false to handle manually
+ * - Obsidian doesn't provide statusText; we default to empty string
+ *
+ * @example
+ * ```typescript
+ * import { requestUrl } from 'obsidian';
+ * import { createObsidianFetchAdapter } from './obsidian-fetch-adapter';
+ *
+ * const api = new TodoistApi('your-token', {
+ *   customFetch: createObsidianFetchAdapter(requestUrl)
+ * });
+ * ```
+ *
+ * @param requestUrl - The Obsidian requestUrl function
+ * @returns A CustomFetch function compatible with the Todoist API SDK
+ */
+export declare function createObsidianFetchAdapter(requestUrl: (request: RequestUrlParam | string) => Promise<RequestUrlResponse>): CustomFetch;

package/dist/types/todoist-api.d.ts

@@ -1,5 +1,6 @@
 import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult } from './types/entities';
 import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/requests';
+import { CustomFetch } from './types/http';
 /**
  * A client for interacting with the Todoist API v1.
  * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
@@ -21,18 +22,28 @@ import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskAr
  * For more information about the Todoist API v1, see the [official documentation](https://todoist.com/api/v1).
  * If you're migrating from v9, please refer to the [migration guide](https://todoist.com/api/v1/docs#tag/Migrating-from-v9).
  */
+/**
+ * Configuration options for the TodoistApi constructor
+ */
+export type TodoistApiOptions = {
+    /**
+     * Optional custom API base URL. If not provided, defaults to Todoist's standard API endpoint
+     */
+    baseUrl?: string;
+    /**
+     * Optional custom fetch function for alternative HTTP clients (e.g., Obsidian's requestUrl, React Native fetch)
+     */
+    customFetch?: CustomFetch;
+};
 export declare class TodoistApi {
     private authToken;
     private syncApiBase;
-    constructor(
+    private customFetch?;
     /**
-     * Your Todoist API token.
-     */
-    authToken: string, 
-    /**
-     * Optional custom API base URL. If not provided, defaults to Todoist's standard API endpoint
+     * @deprecated Use options object instead: new TodoistApi(token, { baseUrl, customFetch })
      */
-    baseUrl?: string);
+    constructor(authToken: string, baseUrl?: string);
+    constructor(authToken: string, options?: TodoistApiOptions);
     /**
      * Retrieves information about the authenticated user.
      *

package/dist/types/types/entities.d.ts

@@ -818,15 +818,15 @@ export declare const WorkspacePlanDetailsSchema: z.ZodObject<{
  */
 export type WorkspacePlanDetails = z.infer<typeof WorkspacePlanDetailsSchema>;
 export declare const JoinWorkspaceResultSchema: z.ZodObject<{
-    custom_sorting_applied: z.ZodBoolean;
-    project_sort_preference: z.ZodString;
+    customSortingApplied: z.ZodBoolean;
+    projectSortPreference: z.ZodString;
     role: z.ZodEnum<{
         ADMIN: "ADMIN";
         MEMBER: "MEMBER";
         GUEST: "GUEST";
     }>;
-    user_id: z.ZodString;
-    workspace_id: z.ZodString;
+    userId: z.ZodString;
+    workspaceId: z.ZodString;
 }, z.core.$strip>;
 /**
  * Result returned when successfully joining a workspace.

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

@@ -66,3 +66,20 @@ 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;
+/**
+ * Custom fetch response interface that custom HTTP clients must implement
+ */
+export type CustomFetchResponse = {
+    ok: boolean;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    text(): Promise<string>;
+    json(): Promise<unknown>;
+};
+/**
+ * Custom fetch function type for alternative HTTP clients
+ */
+export type CustomFetch = (url: string, options?: RequestInit & {
+    timeout?: number;
+}) => Promise<CustomFetchResponse>;

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

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

package/dist/types/types/sync.d.ts

@@ -6,10 +6,10 @@ export type Command = {
 };
 export type SyncError = {
     error: string;
-    error_code: number;
-    error_extra: Record<string, unknown>;
-    error_tag: string;
-    http_code: number;
+    errorCode: number;
+    errorExtra: Record<string, unknown>;
+    errorTag: string;
+    httpCode: number;
 };
 export type SyncRequest = {
     commands: Command[];
@@ -17,5 +17,5 @@ export type SyncRequest = {
 };
 export type SyncResponse = {
     items?: Task[];
-    sync_status?: Record<string, 'ok' | SyncError>;
+    syncStatus?: Record<string, 'ok' | SyncError>;
 };

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

@@ -1,4 +1,4 @@
-import type { HttpResponse, RetryConfig } from '../types/http';
+import type { HttpResponse, RetryConfig, CustomFetch } from '../types/http';
 /**
  * Performs a fetch request with retry logic and timeout support
  */
@@ -8,4 +8,5 @@ export declare function fetchWithRetry<T = unknown>(args: {
         timeout?: number;
     };
     retryConfig?: Partial<RetryConfig>;
+    customFetch?: CustomFetch;
 }): Promise<HttpResponse<T>>;

package/dist/types/utils/multipart-upload.d.ts

@@ -1,3 +1,4 @@
+import type { CustomFetch } from '../types/http';
 type UploadMultipartFileArgs = {
     baseUrl: string;
     authToken: string;
@@ -6,6 +7,7 @@ type UploadMultipartFileArgs = {
     fileName?: string;
     additionalFields: Record<string, string | number | boolean>;
     requestId?: string;
+    customFetch?: CustomFetch;
 };
 /**
  * Uploads a file using multipart/form-data.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "6.0.0",
+    "version": "6.1.4",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",
@@ -23,8 +23,8 @@
     },
     "scripts": {
         "clean": "rimraf dist",
-        "format-check": "npx prettier --check \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\"",
-        "format-fix": "npx prettier --write \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\"",
+        "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": "eslint ./src --ext ts,tsx --fix",
         "lint-check": "eslint ./src --ext ts,tsx",
         "ts-compile-check": "npx tsc -p tsconfig.typecheck.json",
@@ -63,6 +63,7 @@
         "lint-staged": "16.1.6",
         "msw": "2.11.6",
         "npm-run-all2": "8.0.4",
+        "obsidian": "^1.10.2-1",
         "prettier": "3.3.2",
         "rimraf": "6.0.1",
         "ts-jest": "29.4.5",