@doist/todoist-api-typescript 7.1.1 → 7.2.0

package/dist/cjs/todoist-api.js

@@ -55,6 +55,34 @@ function preprocessSyncCommands(commands) {
         return cmd;
     });
 }
+/**
+ * A client for interacting with the Todoist API v1.
+ * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
+ *
+ * @example
+ * ```typescript
+ * const api = new TodoistApi('your-api-token');
+ *
+ * // Get all tasks
+ * const tasks = await api.getTasks();
+ *
+ * // Create a new task
+ * const newTask = await api.addTask({
+ *   content: 'My new task',
+ *   projectId: '12345'
+ * });
+ * ```
+ *
+ * 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).
+ */
+function headersToRecord(headers) {
+    const result = {};
+    headers.forEach((value, key) => {
+        result[key] = value;
+    });
+    return result;
+}
 class TodoistApi {
     constructor(
     /**
@@ -1194,6 +1222,83 @@ class TodoistApi {
         });
         return (0, rest_client_1.isSuccess)(response);
     }
+    /**
+     * Fetches the content of a file attachment from a Todoist comment.
+     *
+     * Accepts either a Comment object (extracts the file URL from its attachment)
+     * or a direct file URL string. Returns the raw Response object so the caller
+     * can read the body in the appropriate format (.arrayBuffer(), .text(), etc.).
+     *
+     * @param commentOrUrl - A Comment object with a file attachment, or a file URL string.
+     * @returns The raw fetch Response for the file content.
+     * @throws Error if a Comment is provided without a file attachment or file URL.
+     *
+     * @example
+     * ```typescript
+     * // From a comment object
+     * const comments = await api.getComments({ taskId: '12345' })
+     * const comment = comments.results[0]
+     * const response = await api.viewAttachment(comment)
+     * const imageData = await response.arrayBuffer()
+     *
+     * // From a URL string
+     * const response = await api.viewAttachment('https://files.todoist.com/...')
+     * const text = await response.text()
+     * ```
+     */
+    async viewAttachment(commentOrUrl) {
+        var _a;
+        let fileUrl;
+        if (typeof commentOrUrl === 'string') {
+            fileUrl = commentOrUrl;
+        }
+        else {
+            if (!((_a = commentOrUrl.fileAttachment) === null || _a === void 0 ? void 0 : _a.fileUrl)) {
+                throw new Error('Comment does not have a file attachment');
+            }
+            fileUrl = commentOrUrl.fileAttachment.fileUrl;
+        }
+        // Validate the URL belongs to Todoist to prevent leaking the auth token
+        const urlHostname = new URL(fileUrl).hostname;
+        if (!urlHostname.endsWith('.todoist.com')) {
+            throw new Error('Attachment URLs must be on a todoist.com domain');
+        }
+        const fetchOptions = {
+            method: 'GET',
+            headers: { Authorization: `Bearer ${this.authToken}` },
+        };
+        if (this.customFetch) {
+            const response = await this.customFetch(fileUrl, fetchOptions);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
+            }
+            // Convert text to ArrayBuffer for custom fetch implementations that lack arrayBuffer()
+            const text = await response.text();
+            const buffer = new TextEncoder().encode(text).buffer;
+            return {
+                ok: response.ok,
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+                text: () => Promise.resolve(text),
+                json: () => response.json(),
+                arrayBuffer: () => Promise.resolve(buffer),
+            };
+        }
+        const response = await fetch(fileUrl, fetchOptions);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
+        }
+        return {
+            ok: response.ok,
+            status: response.status,
+            statusText: response.statusText,
+            headers: headersToRecord(response.headers),
+            text: () => response.text(),
+            json: () => response.json(),
+            arrayBuffer: () => response.arrayBuffer(),
+        };
+    }
     /* Workspace methods */
     /**
      * Gets pending invitations for a workspace.

package/dist/esm/todoist-api.js

@@ -52,6 +52,34 @@ function preprocessSyncCommands(commands) {
         return cmd;
     });
 }
+/**
+ * A client for interacting with the Todoist API v1.
+ * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
+ *
+ * @example
+ * ```typescript
+ * const api = new TodoistApi('your-api-token');
+ *
+ * // Get all tasks
+ * const tasks = await api.getTasks();
+ *
+ * // Create a new task
+ * const newTask = await api.addTask({
+ *   content: 'My new task',
+ *   projectId: '12345'
+ * });
+ * ```
+ *
+ * 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).
+ */
+function headersToRecord(headers) {
+    const result = {};
+    headers.forEach((value, key) => {
+        result[key] = value;
+    });
+    return result;
+}
 export class TodoistApi {
     constructor(
     /**
@@ -1191,6 +1219,83 @@ export class TodoistApi {
         });
         return isSuccess(response);
     }
+    /**
+     * Fetches the content of a file attachment from a Todoist comment.
+     *
+     * Accepts either a Comment object (extracts the file URL from its attachment)
+     * or a direct file URL string. Returns the raw Response object so the caller
+     * can read the body in the appropriate format (.arrayBuffer(), .text(), etc.).
+     *
+     * @param commentOrUrl - A Comment object with a file attachment, or a file URL string.
+     * @returns The raw fetch Response for the file content.
+     * @throws Error if a Comment is provided without a file attachment or file URL.
+     *
+     * @example
+     * ```typescript
+     * // From a comment object
+     * const comments = await api.getComments({ taskId: '12345' })
+     * const comment = comments.results[0]
+     * const response = await api.viewAttachment(comment)
+     * const imageData = await response.arrayBuffer()
+     *
+     * // From a URL string
+     * const response = await api.viewAttachment('https://files.todoist.com/...')
+     * const text = await response.text()
+     * ```
+     */
+    async viewAttachment(commentOrUrl) {
+        var _a;
+        let fileUrl;
+        if (typeof commentOrUrl === 'string') {
+            fileUrl = commentOrUrl;
+        }
+        else {
+            if (!((_a = commentOrUrl.fileAttachment) === null || _a === void 0 ? void 0 : _a.fileUrl)) {
+                throw new Error('Comment does not have a file attachment');
+            }
+            fileUrl = commentOrUrl.fileAttachment.fileUrl;
+        }
+        // Validate the URL belongs to Todoist to prevent leaking the auth token
+        const urlHostname = new URL(fileUrl).hostname;
+        if (!urlHostname.endsWith('.todoist.com')) {
+            throw new Error('Attachment URLs must be on a todoist.com domain');
+        }
+        const fetchOptions = {
+            method: 'GET',
+            headers: { Authorization: `Bearer ${this.authToken}` },
+        };
+        if (this.customFetch) {
+            const response = await this.customFetch(fileUrl, fetchOptions);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
+            }
+            // Convert text to ArrayBuffer for custom fetch implementations that lack arrayBuffer()
+            const text = await response.text();
+            const buffer = new TextEncoder().encode(text).buffer;
+            return {
+                ok: response.ok,
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+                text: () => Promise.resolve(text),
+                json: () => response.json(),
+                arrayBuffer: () => Promise.resolve(buffer),
+            };
+        }
+        const response = await fetch(fileUrl, fetchOptions);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
+        }
+        return {
+            ok: response.ok,
+            status: response.status,
+            statusText: response.statusText,
+            headers: headersToRecord(response.headers),
+            text: () => response.text(),
+            json: () => response.json(),
+            arrayBuffer: () => response.arrayBuffer(),
+        };
+    }
     /* Workspace methods */
     /**
      * Gets pending invitations for a workspace.

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

@@ -1,28 +1,14 @@
 import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace } from './types/entities.js';
 import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, SearchSectionsArgs, 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, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs } from './types/requests.js';
-import { CustomFetch } from './types/http.js';
+import { CustomFetch, CustomFetchResponse } from './types/http.js';
 import { type SyncResponse, type SyncRequest } from './types/sync/index.js';
 /**
- * A client for interacting with the Todoist API v1.
- * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
- *
- * @example
- * ```typescript
- * const api = new TodoistApi('your-api-token');
- *
- * // Get all tasks
- * const tasks = await api.getTasks();
- *
- * // Create a new task
- * const newTask = await api.addTask({
- *   content: 'My new task',
- *   projectId: '12345'
- * });
- * ```
- *
- * 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).
+ * Response from viewAttachment, extending CustomFetchResponse with
+ * arrayBuffer() support for binary file content.
  */
+export type ViewAttachmentResponse = CustomFetchResponse & {
+    arrayBuffer(): Promise<ArrayBuffer>;
+};
 /**
  * Configuration options for the TodoistApi constructor
  */
@@ -511,6 +497,31 @@ export declare class TodoistApi {
      * ```
      */
     deleteUpload(args: DeleteUploadArgs, requestId?: string): Promise<boolean>;
+    /**
+     * Fetches the content of a file attachment from a Todoist comment.
+     *
+     * Accepts either a Comment object (extracts the file URL from its attachment)
+     * or a direct file URL string. Returns the raw Response object so the caller
+     * can read the body in the appropriate format (.arrayBuffer(), .text(), etc.).
+     *
+     * @param commentOrUrl - A Comment object with a file attachment, or a file URL string.
+     * @returns The raw fetch Response for the file content.
+     * @throws Error if a Comment is provided without a file attachment or file URL.
+     *
+     * @example
+     * ```typescript
+     * // From a comment object
+     * const comments = await api.getComments({ taskId: '12345' })
+     * const comment = comments.results[0]
+     * const response = await api.viewAttachment(comment)
+     * const imageData = await response.arrayBuffer()
+     *
+     * // From a URL string
+     * const response = await api.viewAttachment('https://files.todoist.com/...')
+     * const text = await response.text()
+     * ```
+     */
+    viewAttachment(commentOrUrl: Comment | string): Promise<ViewAttachmentResponse>;
     /**
      * Gets pending invitations for a workspace.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "7.1.1",
+    "version": "7.2.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-api-typescript",