@doist/todoist-api-typescript 4.0.4 → 5.0.0

package/dist/types/entities.js

@@ -22,8 +22,9 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColorSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.ProjectSchema = exports.RawProjectSchema = exports.TaskSchema = exports.RawTaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
+exports.ColorSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
 var zod_1 = require("zod");
+var urlHelpers_1 = require("../utils/urlHelpers");
 exports.DueDateSchema = zod_1.z
     .object({
     isRecurring: zod_1.z.boolean(),
@@ -43,13 +44,14 @@ exports.DeadlineSchema = zod_1.z.object({
     date: zod_1.z.string(),
     lang: zod_1.z.string(),
 });
-exports.RawTaskSchema = zod_1.z.object({
-    userId: zod_1.z.string(),
+exports.TaskSchema = zod_1.z
+    .object({
     id: zod_1.z.string(),
+    userId: zod_1.z.string(),
     projectId: zod_1.z.string(),
     sectionId: zod_1.z.string().nullable(),
     parentId: zod_1.z.string().nullable(),
-    addedByUid: zod_1.z.string(),
+    addedByUid: zod_1.z.string().nullable(),
     assignedByUid: zod_1.z.string().nullable(),
     responsibleUid: zod_1.z.string().nullable(),
     labels: zod_1.z.array(zod_1.z.string()),
@@ -57,70 +59,65 @@ exports.RawTaskSchema = zod_1.z.object({
     duration: exports.DurationSchema.nullable(),
     checked: zod_1.z.boolean(),
     isDeleted: zod_1.z.boolean(),
-    addedAt: zod_1.z.string(),
+    addedAt: zod_1.z.string().nullable(),
     completedAt: zod_1.z.string().nullable(),
-    updatedAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string().nullable(),
     due: exports.DueDateSchema.nullable(),
     priority: zod_1.z.number().int(),
     childOrder: zod_1.z.number().int(),
     content: zod_1.z.string(),
     description: zod_1.z.string(),
+    noteCount: zod_1.z.number().int(),
     dayOrder: zod_1.z.number().int(),
     isCollapsed: zod_1.z.boolean(),
+})
+    .transform(function (data) {
+    return __assign(__assign({}, data), { url: (0, urlHelpers_1.getTaskUrl)(data.id, data.content) });
 });
-exports.TaskSchema = zod_1.z.object({
-    id: zod_1.z.string(),
-    assignerId: zod_1.z.string().nullable(),
-    assigneeId: zod_1.z.string().nullable(),
-    projectId: zod_1.z.string(),
-    sectionId: zod_1.z.string().nullable(),
-    parentId: zod_1.z.string().nullable(),
-    order: zod_1.z.number().int(),
-    content: zod_1.z.string(),
-    description: zod_1.z.string(),
-    isCompleted: zod_1.z.boolean(),
-    labels: zod_1.z.array(zod_1.z.string()),
-    priority: zod_1.z.number().int(),
-    creatorId: zod_1.z.string(),
-    createdAt: zod_1.z.string(),
-    due: exports.DueDateSchema.nullable(),
-    url: zod_1.z.string(),
-    duration: exports.DurationSchema.nullable(),
-    deadline: exports.DeadlineSchema.nullable(),
-});
-exports.RawProjectSchema = zod_1.z.object({
+/**
+ * Base schema for all project types in Todoist.
+ * Contains common fields shared between personal and workspace projects.
+ */
+exports.BaseProjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     canAssignTasks: zod_1.z.boolean(),
-    childOrder: zod_1.z.number().int().nullable(),
+    childOrder: zod_1.z.number().int(),
     color: zod_1.z.string(),
-    createdAt: zod_1.z.string(),
+    createdAt: zod_1.z.string().nullable(),
     isArchived: zod_1.z.boolean(),
     isDeleted: zod_1.z.boolean(),
     isFavorite: zod_1.z.boolean(),
     isFrozen: zod_1.z.boolean(),
     name: zod_1.z.string(),
-    updatedAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string().nullable(),
     viewStyle: zod_1.z.string(),
-    defaultOrder: zod_1.z.number().int().nullable(),
+    defaultOrder: zod_1.z.number().int(),
     description: zod_1.z.string(),
-    publicAccess: zod_1.z.boolean(),
-    parentId: zod_1.z.string().nullable().optional(),
-    inboxProject: zod_1.z.boolean().optional(),
     isCollapsed: zod_1.z.boolean(),
     isShared: zod_1.z.boolean(),
 });
-exports.ProjectSchema = zod_1.z.object({
-    id: zod_1.z.string(),
+/**
+ * Schema for personal projects in Todoist.
+ */
+exports.PersonalProjectSchema = exports.BaseProjectSchema.extend({
     parentId: zod_1.z.string().nullable(),
-    order: zod_1.z.number().int().nullable(),
-    color: zod_1.z.string(),
-    name: zod_1.z.string(),
-    isShared: zod_1.z.boolean(),
-    isFavorite: zod_1.z.boolean(),
-    isInboxProject: zod_1.z.boolean(),
-    isTeamInbox: zod_1.z.boolean(),
-    url: zod_1.z.string(),
-    viewStyle: zod_1.z.string(),
+    inboxProject: zod_1.z.boolean(),
+}).transform(function (data) {
+    return __assign(__assign({}, data), { url: (0, urlHelpers_1.getProjectUrl)(data.id, data.name) });
+});
+/**
+ * Schema for workspace projects in Todoist.
+ */
+exports.WorkspaceProjectSchema = exports.BaseProjectSchema.extend({
+    collaboratorRoleDefault: zod_1.z.string(),
+    folderId: zod_1.z.boolean().nullable(),
+    isInviteOnly: zod_1.z.boolean().nullable(),
+    isLinkSharingEnabled: zod_1.z.boolean(),
+    role: zod_1.z.string().nullable(),
+    status: zod_1.z.string(),
+    workspaceId: zod_1.z.string(),
+}).transform(function (data) {
+    return __assign(__assign({}, data), { url: (0, urlHelpers_1.getProjectUrl)(data.id, data.name) });
 });
 exports.SectionSchema = zod_1.z.object({
     id: zod_1.z.string(),

package/dist/types/requests.d.ts

@@ -1,5 +1,5 @@
 import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
-import type { Comment, Deadline, DueDate, Duration, Label, Project, ProjectViewStyle, Section, Task, User } from './entities';
+import type { Comment, Duration, Label, PersonalProject, ProjectViewStyle, Section, Task, User, WorkspaceProject } from './entities';
 /**
  * Arguments for creating a new task.
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/create_task_api_v1_tasks_post
@@ -91,30 +91,6 @@ export type QuickAddTaskArgs = {
  * 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;
-    projectId: string;
-    content: string;
-    description: string;
-    priority: number;
-    sectionId: string | null;
-    parentId: string | null;
-    childOrder: number;
-    labels: string[];
-    assignedByUid: string | null;
-    responsibleUid: string | null;
-    checked: boolean;
-    addedAt: string;
-    addedByUid: string | null;
-    duration: Duration | null;
-    due: DueDate | null;
-    deadline: Deadline | null;
-};
-/**
- * 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;
 /**
  * Arguments for moving a task.
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/move_task_api_v1_tasks__task_id__move_post
@@ -137,7 +113,7 @@ export type GetProjectsArgs = {
  * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_projects_api_v1_projects_get
  */
 export type GetProjectsResponse = {
-    results: Project[];
+    results: (PersonalProject | WorkspaceProject)[];
     nextCursor: string | null;
 };
 /**

package/dist/types/sync.d.ts

@@ -1,4 +1,4 @@
-import type { SyncTask } from './requests';
+import { Task } from './entities';
 export type Command = {
     type: string;
     uuid: string;
@@ -16,6 +16,6 @@ export type SyncRequest = {
     resource_types?: string[];
 };
 export type SyncResponse = {
-    items?: SyncTask[];
+    items?: Task[];
     sync_status?: Record<string, 'ok' | SyncError>;
 };

package/dist/utils/urlHelpers.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generate the URL for a given task.
+ *
+ * @param taskId The ID of the task.
+ * @param content The content of the task.
+ * @returns The URL string for the task view.
+ */
+export declare function getTaskUrl(taskId: string, content?: string): string;
+/**
+ * Generate the URL for a given project.
+ *
+ * @param projectId The ID of the project.
+ * @param name The name of the project.
+ * @returns The URL string for the project view.
+ */
+export declare function getProjectUrl(projectId: string, name?: string): string;

package/dist/utils/urlHelpers.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectUrl = exports.getTaskUrl = void 0;
+var endpoints_1 = require("../consts/endpoints");
+/**
+ * Generate the URL for a given task.
+ *
+ * @param taskId The ID of the task.
+ * @param content The content of the task.
+ * @returns The URL string for the task view.
+ */
+function getTaskUrl(taskId, content) {
+    var slug = content ? slugify(content) : undefined;
+    var path = slug ? "".concat(slug, "-").concat(taskId) : taskId;
+    return "".concat(endpoints_1.TODOIST_WEB_URI, "/task/").concat(path);
+}
+exports.getTaskUrl = getTaskUrl;
+/**
+ * Generate the URL for a given project.
+ *
+ * @param projectId The ID of the project.
+ * @param name The name of the project.
+ * @returns The URL string for the project view.
+ */
+function getProjectUrl(projectId, name) {
+    var slug = name ? slugify(name) : undefined;
+    var path = slug ? "".concat(slug, "-").concat(projectId) : projectId;
+    return "".concat(endpoints_1.TODOIST_WEB_URI, "/project/").concat(path);
+}
+exports.getProjectUrl = getProjectUrl;
+/**
+ * Slugify function borrowed from Django.
+ *
+ * @param value The string to slugify.
+ * @returns The slugified string.
+ */
+function slugify(value) {
+    // Convert to ASCII
+    var result = value.normalize('NFKD').replace(/[\u0300-\u036f]/g, '');
+    // Remove non-ASCII characters
+    result = result.replace(/[^\x20-\x7E]/g, '');
+    // Convert to lowercase and replace non-alphanumeric characters with dashes
+    result = result.toLowerCase().replace(/[^\w\s-]/g, '');
+    // Replace spaces and repeated dashes with single dashes
+    result = result.replace(/[-\s]+/g, '-');
+    // Strip dashes from the beginning and end
+    return result.replace(/^-+|-+$/g, '');
+}

package/dist/utils/validators.d.ts

@@ -1,8 +1,25 @@
-import { type Task, type Project, type Section, type Label, type Comment, type User } from '../types/entities';
+import { type Task, type Section, type Label, type Comment, type User, type WorkspaceProject, type PersonalProject } from '../types/entities';
 export declare function validateTask(input: unknown): Task;
 export declare function validateTaskArray(input: unknown[]): Task[];
-export declare function validateProject(input: unknown): Project;
-export declare function validateProjectArray(input: unknown[]): Project[];
+/**
+ * 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 declare function isWorkspaceProject(project: PersonalProject | WorkspaceProject): project is WorkspaceProject;
+/**
+ * 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 declare function isPersonalProject(project: PersonalProject | WorkspaceProject): project is PersonalProject;
+/**
+ * Validates and parses a project input.
+ * @param input The input to validate
+ * @returns A validated project (either PersonalProject or WorkspaceProject)
+ */
+export declare function validateProject(input: unknown): PersonalProject | WorkspaceProject;
+export declare function validateProjectArray(input: unknown[]): (PersonalProject | WorkspaceProject)[];
 export declare function validateSection(input: unknown): Section;
 export declare function validateSectionArray(input: unknown[]): Section[];
 export declare function validateLabel(input: unknown): Label;

package/dist/utils/validators.js

@@ -1,15 +1,8 @@
 "use strict";
 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;
+exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateProjectArray = exports.validateProject = exports.isPersonalProject = exports.isWorkspaceProject = 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;
@@ -17,13 +10,34 @@ function validateTaskArray(input) {
     return input.map(validateTask);
 }
 exports.validateTaskArray = validateTaskArray;
+/**
+ * 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
+ */
+function isWorkspaceProject(project) {
+    return 'workspaceId' in project;
+}
+exports.isWorkspaceProject = isWorkspaceProject;
+/**
+ * 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
+ */
+function isPersonalProject(project) {
+    return !isWorkspaceProject(project);
+}
+exports.isPersonalProject = isPersonalProject;
+/**
+ * Validates and parses a project input.
+ * @param input The input to validate
+ * @returns A validated project (either PersonalProject or WorkspaceProject)
+ */
 function validateProject(input) {
-    var rawProjectParse = entities_1.RawProjectSchema.safeParse(input);
-    if (rawProjectParse.success) {
-        var project = (0, projectConverter_1.getProjectFromRawProjectResponse)(rawProjectParse.data);
-        return project;
+    if ('workspaceId' in input) {
+        return entities_1.WorkspaceProjectSchema.parse(input);
     }
-    return entities_1.ProjectSchema.parse(input);
+    return entities_1.PersonalProjectSchema.parse(input);
 }
 exports.validateProject = validateProject;
 function validateProjectArray(input) {

package/package.json

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

package/dist/utils/projectConverter.d.ts

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

package/dist/utils/projectConverter.js

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