@doist/todoist-sdk 8.4.0-next.2 → 8.5.0-next.1

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

@@ -2,3 +2,4 @@ export * from './colors.js';
 export * from './sanitization.js';
 export { getTaskUrl, getProjectUrl, getSectionUrl } from './url-helpers.js';
 export { createCommand } from './sync-helpers.js';
+export * from './project-helpers.js';

package/dist/types/utils/project-helpers.d.ts

@@ -0,0 +1,13 @@
+import type { PersonalProject, WorkspaceProject } from '../types/projects/types.js';
+/**
+ * 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;

package/dist/types/utils/validators.d.ts

@@ -1,6 +1,4 @@
-import { type WorkspaceProject, type PersonalProject } from '../types/projects/types.js';
-import type { SyncResponse } from '../types/sync/response.js';
-import { type WorkspaceUser } from '../types/workspaces/types.js';
+import { type SyncResponse } from '../types/sync/response.js';
 export declare const validateTask: (input: unknown) => {
     isUncompletable: boolean;
     url: string;
@@ -40,8 +38,7 @@ export declare const validateTask: (input: unknown) => {
     description: string;
     dayOrder: number;
     isCollapsed: boolean;
-};
-export declare const validateTaskArray: (input: unknown) => {
+}, validateTaskArray: (input: unknown) => {
     isUncompletable: boolean;
     url: string;
     id: string;
@@ -81,25 +78,108 @@ export declare const validateTaskArray: (input: unknown) => {
     dayOrder: number;
     isCollapsed: boolean;
 }[];
-/**
- * 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 const validateProject: (input: unknown) => {
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    parentId: string | null;
+    inboxProject: boolean;
+} | {
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: string | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    status: string;
+    workspaceId: string;
+    access?: {
+        visibility: "restricted" | "team" | "public";
+    } | undefined;
+}, validateProjectArray: (input: unknown) => ({
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    parentId: string | null;
+    inboxProject: boolean;
+} | {
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: string | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    status: string;
+    workspaceId: string;
+    access?: {
+        visibility: "restricted" | "team" | "public";
+    } | undefined;
+})[];
 export declare const validateWorkspaceProject: (input: unknown) => {
     url: string;
     id: string;
@@ -128,8 +208,7 @@ export declare const validateWorkspaceProject: (input: unknown) => {
     access?: {
         visibility: "restricted" | "team" | "public";
     } | undefined;
-};
-export declare const validateWorkspaceProjectArray: (input: unknown) => {
+}, validateWorkspaceProjectArray: (input: unknown) => {
     url: string;
     id: string;
     canAssignTasks: boolean;
@@ -171,8 +250,7 @@ export declare const validateSection: (input: unknown) => {
     isArchived: boolean;
     isDeleted: boolean;
     isCollapsed: boolean;
-};
-export declare const validateSectionArray: (input: unknown) => {
+}, validateSectionArray: (input: unknown) => {
     url: string;
     id: string;
     userId: string;
@@ -192,8 +270,7 @@ export declare const validateLabel: (input: unknown) => {
     name: string;
     color: string;
     isFavorite: boolean;
-};
-export declare const validateLabelArray: (input: unknown) => {
+}, validateLabelArray: (input: unknown) => {
     id: string;
     order: number | null;
     name: string;
@@ -224,8 +301,7 @@ export declare const validateComment: (input: unknown) => {
     reactions: Record<string, string[]> | null;
     isDeleted: boolean;
     projectId?: string | undefined;
-};
-export declare const validateCommentArray: (input: unknown) => {
+}, validateCommentArray: (input: unknown) => {
     taskId: string | undefined;
     id: string;
     content: string;
@@ -254,8 +330,7 @@ export declare const validateUser: (input: unknown) => {
     id: string;
     name: string;
     email: string;
-};
-export declare const validateUserArray: (input: unknown) => {
+}, validateUserArray: (input: unknown) => {
     id: string;
     name: string;
     email: string;
@@ -380,8 +455,7 @@ export declare const validateActivityEvent: (input: unknown) => {
     parentItemId: string | null;
     initiatorId: string | null;
     extraData: Record<string, any> | null;
-};
-export declare const validateActivityEventArray: (input: unknown) => {
+}, validateActivityEventArray: (input: unknown) => {
     [x: string]: any;
     objectType: string;
     objectId: string;
@@ -416,8 +490,16 @@ export declare const validateWorkspaceUser: (input: unknown) => {
     role: "ADMIN" | "MEMBER" | "GUEST";
     imageId: string | null;
     isDeleted: boolean;
-};
-export declare function validateWorkspaceUserArray(input: unknown): WorkspaceUser[];
+}, validateWorkspaceUserArray: (input: unknown) => {
+    userId: string;
+    workspaceId: string;
+    userEmail: string;
+    fullName: string;
+    timezone: string;
+    role: "ADMIN" | "MEMBER" | "GUEST";
+    imageId: string | null;
+    isDeleted: boolean;
+}[];
 export declare const validateWorkspaceInvitation: (input: unknown) => {
     id: string;
     inviterId: string;
@@ -425,8 +507,7 @@ export declare const validateWorkspaceInvitation: (input: unknown) => {
     workspaceId: string;
     role: "ADMIN" | "MEMBER" | "GUEST";
     isExistingUser: boolean;
-};
-export declare const validateWorkspaceInvitationArray: (input: unknown) => {
+}, validateWorkspaceInvitationArray: (input: unknown) => {
     id: string;
     inviterId: string;
     userEmail: string;
@@ -487,8 +568,7 @@ export declare const validateWorkspace: (input: unknown) => {
     logoMedium?: string | null | undefined;
     logoSmall?: string | null | undefined;
     logoS640?: string | null | undefined;
-};
-export declare const validateWorkspaceArray: (input: unknown) => {
+}, validateWorkspaceArray: (input: unknown) => {
     createdAt: string | undefined;
     id: string;
     name: string;
@@ -513,8 +593,7 @@ export declare const validateMemberActivityInfo: (input: unknown) => {
     userId: string;
     tasksAssigned: number;
     tasksOverdue: number;
-};
-export declare const validateMemberActivityInfoArray: (input: unknown) => {
+}, validateMemberActivityInfoArray: (input: unknown) => {
     userId: string;
     tasksAssigned: number;
     tasksOverdue: number;
@@ -542,8 +621,7 @@ export declare const validateWorkspaceUserTask: (input: unknown) => {
     priority: number;
     description: string;
     isOverdue: boolean;
-};
-export declare const validateWorkspaceUserTaskArray: (input: unknown) => {
+}, validateWorkspaceUserTaskArray: (input: unknown) => {
     id: string;
     content: string;
     responsibleUid: string | null;
@@ -652,24 +730,21 @@ export declare const validateWorkspaceInsights: (input: unknown) => {
 export declare const validateBackup: (input: unknown) => {
     version: string;
     url: string;
-};
-export declare const validateBackupArray: (input: unknown) => {
+}, validateBackupArray: (input: unknown) => {
     version: string;
     url: string;
 }[];
 export declare const validateIdMapping: (input: unknown) => {
     oldId: string | null;
     newId: string | null;
-};
-export declare const validateIdMappingArray: (input: unknown) => {
+}, validateIdMappingArray: (input: unknown) => {
     oldId: string | null;
     newId: string | null;
 }[];
 export declare const validateMovedId: (input: unknown) => {
     oldId: string;
     newId: string;
-};
-export declare const validateMovedIdArray: (input: unknown) => {
+}, validateMovedIdArray: (input: unknown) => {
     oldId: string;
     newId: string;
 }[];
@@ -683,8 +758,7 @@ export declare const validateFilter: (input: unknown) => {
     isFavorite: boolean;
     isFrozen: boolean;
     itemOrder: number;
-};
-export declare const validateFilterArray: (input: unknown) => {
+}, validateFilterArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -702,8 +776,7 @@ export declare const validateCollaborator: (input: unknown) => {
     fullName: string;
     timezone: string;
     imageId: string | null;
-};
-export declare const validateCollaboratorArray: (input: unknown) => {
+}, validateCollaboratorArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     email: string;
@@ -718,8 +791,7 @@ export declare const validateCollaboratorState: (input: unknown) => {
     state: "active" | "invited";
     isDeleted: boolean;
     workspaceRole?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
-};
-export declare const validateCollaboratorStateArray: (input: unknown) => {
+}, validateCollaboratorStateArray: (input: unknown) => {
     [x: string]: unknown;
     userId: string;
     projectId: string;
@@ -735,8 +807,7 @@ export declare const validateFolder: (input: unknown) => {
     isDeleted: boolean;
     defaultOrder: number;
     childOrder: number;
-};
-export declare const validateFolderArray: (input: unknown) => {
+}, validateFolderArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -768,8 +839,7 @@ export declare const validateGoal: (input: unknown) => {
         completedTaskCount: number;
         percentage: number;
     } | undefined;
-};
-export declare const validateGoalArray: (input: unknown) => {
+}, validateGoalArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     ownerType: "USER" | "WORKSPACE";
@@ -818,8 +888,7 @@ export declare const validateNote: (input: unknown) => {
     isDeleted: boolean;
     itemId?: string | undefined;
     projectId?: string | undefined;
-};
-export declare const validateNoteArray: (input: unknown) => {
+}, validateNoteArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     content: string;
@@ -865,8 +934,7 @@ export declare const validateWorkspaceFilter: (input: unknown) => {
     updaterUid: string;
     createdAt: string;
     updatedAt: string;
-};
-export declare const validateWorkspaceFilterArray: (input: unknown) => {
+}, validateWorkspaceFilterArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     workspaceId: string;
@@ -899,8 +967,7 @@ export declare const validateWorkspaceGoal: (input: unknown) => {
     creatorUid: string;
     createdAt: string;
     updatedAt: string;
-};
-export declare const validateWorkspaceGoalArray: (input: unknown) => {
+}, validateWorkspaceGoalArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     workspaceId: string;
@@ -926,8 +993,7 @@ export declare const validateCalendar: (input: unknown) => {
     accountId: string;
     isVisible: boolean;
     isTaskCalendar?: boolean | undefined;
-};
-export declare const validateCalendarArray: (input: unknown) => {
+}, validateCalendarArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     summary: string;
@@ -947,8 +1013,7 @@ export declare const validateCalendarAccount: (input: unknown) => {
     isAllDayTasksEnabled?: boolean | undefined;
     pendingOperationUntil?: string | null | undefined;
     calendarsSyncState?: "error" | "synced" | "syncing" | undefined;
-};
-export declare const validateCalendarAccountArray: (input: unknown) => {
+}, validateCalendarAccountArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -1008,8 +1073,7 @@ export declare const validateReminder: (input: unknown) => {
         lang?: string | null | undefined;
     } | undefined;
     isUrgent?: boolean | undefined;
-};
-export declare const validateReminderArray: (input: unknown) => ({
+}, validateReminderArray: (input: unknown) => ({
     [x: string]: unknown;
     id: string;
     notifyUid: string;
@@ -1071,8 +1135,7 @@ export declare const validateLocationReminder: (input: unknown) => {
     locTrigger: "on_enter" | "on_leave";
     radius: number;
     projectId?: string | undefined;
-};
-export declare const validateLocationReminderArray: (input: unknown) => {
+}, validateLocationReminderArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     notifyUid: string;
@@ -1101,8 +1164,7 @@ export declare const validateCompletedInfo: (input: unknown) => {
     itemId: string;
     completedItems: number;
     id?: string | undefined;
-};
-export declare const validateCompletedInfoArray: (input: unknown) => ({
+}, validateCompletedInfoArray: (input: unknown) => ({
     [x: string]: unknown;
     projectId: string;
     archivedSections: number;
@@ -1128,8 +1190,7 @@ export declare const validateViewOptions: (input: unknown) => {
     showCompletedTasks?: boolean | undefined;
     sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
-};
-export declare const validateViewOptionsArray: (input: unknown) => {
+}, validateViewOptionsArray: (input: unknown) => {
     [x: string]: unknown;
     viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
     objectId?: string | undefined;
@@ -1153,8 +1214,7 @@ export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
         [x: string]: unknown;
         layout?: "WEEK" | "MONTH" | undefined;
     } | null | undefined;
-};
-export declare const validateProjectViewOptionsDefaultsArray: (input: unknown) => {
+}, validateProjectViewOptionsDefaultsArray: (input: unknown) => {
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
@@ -1219,8 +1279,7 @@ export declare const validateLiveNotification: (input: unknown) => {
     projectName?: string | undefined;
     isDeleted?: boolean | undefined;
     invitationSecret?: string | undefined;
-};
-export declare const validateLiveNotificationArray: (input: unknown) => {
+}, validateLiveNotificationArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     createdAt: string;
@@ -1284,8 +1343,7 @@ export declare const validateSyncWorkspace: (input: unknown) => {
         userIds: number[];
     } | undefined;
     properties?: Record<string, unknown> | undefined;
-};
-export declare const validateSyncWorkspaceArray: (input: unknown) => {
+}, validateSyncWorkspaceArray: (input: unknown) => {
     createdAt: string | undefined;
     id: string;
     name: string;
@@ -1480,8 +1538,7 @@ export declare const validateSuggestion: (input: unknown) => {
         locale: string;
     };
     isDeleted: boolean;
-};
-export declare const validateSuggestionArray: (input: unknown) => ({
+}, validateSuggestionArray: (input: unknown) => ({
     [x: string]: unknown;
     type: "templates" | "most_used_user_templates";
     content: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "8.4.0-next.2",
+    "version": "8.5.0-next.1",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",