@doist/todoist-api-typescript 4.0.0-alpha.7 → 4.0.1

package/dist/types/requests.d.ts

@@ -1,7 +1,8 @@
 import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
 import type { Comment, Deadline, DueDate, Duration, Label, Project, ProjectViewStyle, Section, Task, User } from './entities';
 /**
- * @see https://developer.todoist.com/rest/v2/#create-a-new-task
+ * Arguments for creating a new task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/create_task_api_v1_tasks_post
  */
 export type AddTaskArgs = {
     content: string;
@@ -25,27 +26,38 @@ export type AddTaskArgs = {
     durationUnit?: Duration['unit'];
 }>;
 /**
- * @see https://developer.todoist.com/rest/v2/#tasks
+ * Arguments for retrieving tasks.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/get_tasks_api_v1_tasks_get
  */
 export type GetTasksArgs = {
     projectId?: string;
     sectionId?: string;
+    parentId?: string;
     label?: string;
-    filter?: string;
-    lang?: string;
     ids?: string[];
     cursor?: string | null;
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#tasks
+ * Arguments for retrieving tasks by filter.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/get_tasks_by_filter_api_v1_tasks_filter_get
+ */
+export type GetTasksByFilterArgs = {
+    query: string;
+    lang?: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/get_tasks_api_v1_tasks_get
  */
 export type GetTasksResponse = {
     results: Task[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#update-a-task
+ * Arguments for updating a task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/update_task_api_v1_tasks__task_id__post
  */
 export type UpdateTaskArgs = {
     content?: string;
@@ -65,7 +77,8 @@ export type UpdateTaskArgs = {
     durationUnit?: Duration['unit'];
 }>;
 /**
- * @see https://developer.todoist.com/rest/v2/#quick-add-task
+ * Arguments for quick adding a task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
  */
 export type QuickAddTaskArgs = {
     text: string;
@@ -75,7 +88,8 @@ export type QuickAddTaskArgs = {
     meta?: boolean;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#quick-add-task
+ * Response from quick adding a task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
  */
 export type SyncTask = {
     id: string;
@@ -97,11 +111,13 @@ export type SyncTask = {
     deadline: Deadline | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#quick-add-task
+ * Response from quick adding a task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
  */
 export type QuickAddTaskResponse = SyncTask;
 /**
- * @see https://developer.todoist.com/sync/v9/#move-an-item
+ * Arguments for moving a task.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/move_task_api_v1_tasks__task_id__move_post
  */
 export type MoveTaskArgs = RequireExactlyOne<{
     projectId?: string;
@@ -109,21 +125,24 @@ export type MoveTaskArgs = RequireExactlyOne<{
     parentId?: string;
 }>;
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-projects
+ * Arguments for retrieving projects.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_projects_api_v1_projects_get
  */
 export type GetProjectsArgs = {
     cursor?: string | null;
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-projects
+ * Response from retrieving projects.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_projects_api_v1_projects_get
  */
 export type GetProjectsResponse = {
     results: Project[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#create-a-new-project
+ * Arguments for creating a new project.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/create_project_api_v1_projects_post
  */
 export type AddProjectArgs = {
     name: string;
@@ -133,7 +152,8 @@ export type AddProjectArgs = {
     viewStyle?: ProjectViewStyle;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#update-a-project
+ * Arguments for updating a project.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/update_project_api_v1_projects__project_id__post
  */
 export type UpdateProjectArgs = {
     name?: string;
@@ -142,21 +162,24 @@ export type UpdateProjectArgs = {
     viewStyle?: ProjectViewStyle;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-collaborators
+ * Arguments for retrieving project collaborators.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_project_collaborators_api_v1_projects__project_id__collaborators_get
  */
 export type GetProjectCollaboratorsArgs = {
     cursor?: string | null;
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-collaborators
+ * Response from retrieving project collaborators.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_project_collaborators_api_v1_projects__project_id__collaborators_get
  */
 export type GetProjectCollaboratorsResponse = {
     results: User[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#sections
+ * Arguments for retrieving sections.
+ * @see https://todoist.com/api/v1/docs#tag/Sections/operation/get_sections_api_v1_sections_get
  */
 export type GetSectionsArgs = {
     projectId: string | null;
@@ -164,14 +187,16 @@ export type GetSectionsArgs = {
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#sections
+ * Response from retrieving sections.
+ * @see https://todoist.com/api/v1/docs#tag/Sections/operation/get_sections_api_v1_sections_get
  */
 export type GetSectionsResponse = {
     results: Section[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#create-a-new-section
+ * Arguments for creating a new section.
+ * @see https://todoist.com/api/v1/docs#tag/Sections/operation/create_section_api_v1_sections_post
  */
 export type AddSectionArgs = {
     name: string;
@@ -179,27 +204,31 @@ export type AddSectionArgs = {
     order?: number | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#update-a-section
+ * Arguments for updating a section.
+ * @see https://todoist.com/api/v1/docs#tag/Sections/operation/update_section_api_v1_sections__section_id__post
  */
 export type UpdateSectionArgs = {
     name: string;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-personal-labels
+ * Arguments for retrieving labels.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/get_labels_api_v1_labels_get
  */
 export type GetLabelsArgs = {
     cursor?: string | null;
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-personal-labels
+ * Response from retrieving labels.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/get_labels_api_v1_labels_get
  */
 export type GetLabelsResponse = {
     results: Label[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#create-a-new-personal-label
+ * Arguments for creating a new label.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/create_label_api_v1_labels_post
  */
 export type AddLabelArgs = {
     name: string;
@@ -208,7 +237,8 @@ export type AddLabelArgs = {
     isFavorite?: boolean;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#update-a-personal-label
+ * Arguments for updating a label.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/update_label_api_v1_labels__label_id__post
  */
 export type UpdateLabelArgs = {
     name?: string;
@@ -217,7 +247,8 @@ export type UpdateLabelArgs = {
     isFavorite?: boolean;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-shared-labels
+ * Arguments for retrieving shared labels.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/shared_labels_api_v1_labels_shared_get
  */
 export type GetSharedLabelsArgs = {
     omitPersonal?: boolean;
@@ -225,27 +256,41 @@ export type GetSharedLabelsArgs = {
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-shared-labels
+ * Response from retrieving shared labels.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/shared_labels_api_v1_labels_shared_get
  */
 export type GetSharedLabelsResponse = {
     results: string[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#rename-shared-labels
+ * Arguments for renaming a shared label.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/shared_labels_rename_api_v1_labels_shared_rename_post
  */
 export type RenameSharedLabelArgs = {
     name: string;
     newName: string;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#remove-shared-labels
+ * Arguments for removing a shared label.
+ * @see https://todoist.com/api/v1/docs#tag/Labels/operation/shared_labels_remove_api_v1_labels_shared_remove_post
  */
 export type RemoveSharedLabelArgs = {
     name: string;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-comments
+ * Arguments for retrieving comments.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetCommentsArgs = {
+    taskId: string;
+    projectId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving task comments.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/get_comments_api_v1_comments_get
  */
 export type GetTaskCommentsArgs = {
     taskId: string;
@@ -254,7 +299,8 @@ export type GetTaskCommentsArgs = {
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-comments
+ * Arguments for retrieving project comments.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/get_comments_api_v1_comments_get
  */
 export type GetProjectCommentsArgs = {
     projectId: string;
@@ -263,14 +309,16 @@ export type GetProjectCommentsArgs = {
     limit?: number;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#get-all-comments
+ * Response from retrieving comments.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/get_comments_api_v1_comments_get
  */
 export type GetCommentsResponse = {
     results: Comment[];
     nextCursor: string | null;
 };
 /**
- * @see https://developer.todoist.com/rest/v2/#create-a-new-comment
+ * Arguments for creating a new comment.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/create_comment_api_v1_comments_post
  */
 export type AddCommentArgs = {
     content: string;
@@ -285,7 +333,8 @@ export type AddCommentArgs = {
     projectId?: string;
 }>;
 /**
- * @see https://developer.todoist.com/rest/v2/#update-a-comment
+ * Arguments for updating a comment.
+ * @see https://todoist.com/api/v1/docs#tag/Comments/operation/update_comment_api_v1_comments__comment_id__post
  */
 export type UpdateCommentArgs = {
     content: string;

package/dist/utils/projectConverter.d.ts

@@ -0,0 +1,2 @@
+import { Project, RawProject } from '../types';
+export declare function getProjectFromRawProjectResponse(responseData: RawProject): Project;

package/dist/utils/projectConverter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectFromRawProjectResponse = void 0;
+var showProjectEndpoint = 'https://todoist.com/showProject';
+function getProjectUrlFromProjectId(projectId) {
+    return "".concat(showProjectEndpoint, "?id=").concat(projectId);
+}
+function getProjectFromRawProjectResponse(responseData) {
+    var _a, _b;
+    var project = {
+        id: responseData.id,
+        parentId: (_a = responseData.parentId) !== null && _a !== void 0 ? _a : null, // workspace projects do not have a parent
+        order: responseData.childOrder,
+        color: responseData.color,
+        name: responseData.name,
+        isShared: responseData.isShared,
+        isFavorite: responseData.isFavorite,
+        isInboxProject: (_b = responseData.inboxProject) !== null && _b !== void 0 ? _b : false, // workspace projects do not set this flag
+        isTeamInbox: false, // this flag is no longer used
+        url: getProjectUrlFromProjectId(responseData.id),
+        viewStyle: responseData.viewStyle,
+    };
+    return project;
+}
+exports.getProjectFromRawProjectResponse = getProjectFromRawProjectResponse;

package/dist/utils/taskConverters.d.ts

@@ -1,2 +1,3 @@
-import { QuickAddTaskResponse, Task } from '../types';
+import { QuickAddTaskResponse, RawTask, Task } from '../types';
 export declare function getTaskFromQuickAddResponse(responseData: QuickAddTaskResponse): Task;
+export declare function getTaskFromRawTaskResponse(responseData: RawTask): Task;

package/dist/utils/taskConverters.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTaskFromQuickAddResponse = void 0;
+exports.getTaskFromRawTaskResponse = exports.getTaskFromQuickAddResponse = void 0;
 var showTaskEndpoint = 'https://todoist.com/showTask';
-function getTaskUrlFromQuickAddResponse(responseData) {
-    return "".concat(showTaskEndpoint, "?id=").concat(responseData.id);
+function getTaskUrlFromTaskId(taskId) {
+    return "".concat(showTaskEndpoint, "?id=").concat(taskId);
 }
 function getTaskFromQuickAddResponse(responseData) {
     var _a;
@@ -18,7 +18,7 @@ function getTaskFromQuickAddResponse(responseData) {
         labels: responseData.labels,
         priority: responseData.priority,
         createdAt: responseData.addedAt,
-        url: getTaskUrlFromQuickAddResponse(responseData),
+        url: getTaskUrlFromTaskId(responseData.id),
         creatorId: (_a = responseData.addedByUid) !== null && _a !== void 0 ? _a : '',
         parentId: responseData.parentId,
         duration: responseData.duration,
@@ -30,3 +30,27 @@ function getTaskFromQuickAddResponse(responseData) {
     return task;
 }
 exports.getTaskFromQuickAddResponse = getTaskFromQuickAddResponse;
+function getTaskFromRawTaskResponse(responseData) {
+    var task = {
+        id: responseData.id,
+        assignerId: responseData.assignedByUid,
+        assigneeId: responseData.responsibleUid,
+        projectId: responseData.projectId,
+        sectionId: responseData.sectionId,
+        parentId: responseData.parentId,
+        order: responseData.childOrder,
+        content: responseData.content,
+        description: responseData.description,
+        isCompleted: responseData.checked,
+        labels: responseData.labels,
+        priority: responseData.priority,
+        creatorId: responseData.addedByUid,
+        createdAt: responseData.addedAt,
+        due: responseData.due,
+        url: getTaskUrlFromTaskId(responseData.id),
+        duration: responseData.duration,
+        deadline: responseData.deadline,
+    };
+    return task;
+}
+exports.getTaskFromRawTaskResponse = getTaskFromRawTaskResponse;

package/dist/utils/validators.js

@@ -2,7 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateProjectArray = exports.validateProject = exports.validateTaskArray = exports.validateTask = void 0;
 var entities_1 = require("../types/entities");
+var projectConverter_1 = require("./projectConverter");
+var taskConverters_1 = require("./taskConverters");
 function validateTask(input) {
+    var rawTaskParse = entities_1.RawTaskSchema.safeParse(input);
+    if (rawTaskParse.success) {
+        var task = (0, taskConverters_1.getTaskFromRawTaskResponse)(rawTaskParse.data);
+        return task;
+    }
     return entities_1.TaskSchema.parse(input);
 }
 exports.validateTask = validateTask;
@@ -11,6 +18,11 @@ function validateTaskArray(input) {
 }
 exports.validateTaskArray = validateTaskArray;
 function validateProject(input) {
+    var rawProjectParse = entities_1.RawProjectSchema.safeParse(input);
+    if (rawProjectParse.success) {
+        var project = (0, projectConverter_1.getProjectFromRawProjectResponse)(rawProjectParse.data);
+        return project;
+    }
     return entities_1.ProjectSchema.parse(input);
 }
 exports.validateProject = validateProject;

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "4.0.0-alpha.7",
+    "version": "4.0.1",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",
-    "homepage": "https://developer.todoist.com/rest/v1/?javascript",
+    "homepage": "https://doist.github.io/todoist-api-typescript/",
     "license": "MIT",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",