@doist/todoist-sdk 8.3.0-next.1 → 8.4.0-next.1

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

@@ -1,4 +1,5 @@
 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';
 export declare const validateTask: (input: unknown) => {
     isUncompletable: boolean;
@@ -40,7 +41,7 @@ export declare const validateTask: (input: unknown) => {
     dayOrder: number;
     isCollapsed: boolean;
 };
-export declare const validateTaskArray: (input: unknown[]) => {
+export declare const validateTaskArray: (input: unknown) => {
     isUncompletable: boolean;
     url: string;
     id: string;
@@ -98,7 +99,7 @@ export declare function isPersonalProject(project: PersonalProject | WorkspacePr
  * @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 validateProjectArray(input: unknown): (PersonalProject | WorkspaceProject)[];
 export declare const validateWorkspaceProject: (input: unknown) => {
     url: string;
     id: string;
@@ -128,7 +129,7 @@ export declare const validateWorkspaceProject: (input: unknown) => {
         visibility: "restricted" | "team" | "public";
     } | undefined;
 };
-export declare const validateWorkspaceProjectArray: (input: unknown[]) => {
+export declare const validateWorkspaceProjectArray: (input: unknown) => {
     url: string;
     id: string;
     canAssignTasks: boolean;
@@ -171,7 +172,7 @@ export declare const validateSection: (input: unknown) => {
     isDeleted: boolean;
     isCollapsed: boolean;
 };
-export declare const validateSectionArray: (input: unknown[]) => {
+export declare const validateSectionArray: (input: unknown) => {
     url: string;
     id: string;
     userId: string;
@@ -192,7 +193,7 @@ export declare const validateLabel: (input: unknown) => {
     color: string;
     isFavorite: boolean;
 };
-export declare const validateLabelArray: (input: unknown[]) => {
+export declare const validateLabelArray: (input: unknown) => {
     id: string;
     order: number | null;
     name: string;
@@ -224,7 +225,7 @@ export declare const validateComment: (input: unknown) => {
     isDeleted: boolean;
     projectId?: string | undefined;
 };
-export declare const validateCommentArray: (input: unknown[]) => {
+export declare const validateCommentArray: (input: unknown) => {
     taskId: string | undefined;
     id: string;
     content: string;
@@ -254,7 +255,7 @@ export declare const validateUser: (input: unknown) => {
     name: string;
     email: string;
 };
-export declare const validateUserArray: (input: unknown[]) => {
+export declare const validateUserArray: (input: unknown) => {
     id: string;
     name: string;
     email: string;
@@ -380,7 +381,7 @@ export declare const validateActivityEvent: (input: unknown) => {
     initiatorId: string | null;
     extraData: Record<string, any> | null;
 };
-export declare const validateActivityEventArray: (input: unknown[]) => {
+export declare const validateActivityEventArray: (input: unknown) => {
     [x: string]: any;
     objectType: string;
     objectId: string;
@@ -425,7 +426,7 @@ export declare const validateWorkspaceInvitation: (input: unknown) => {
     role: "ADMIN" | "MEMBER" | "GUEST";
     isExistingUser: boolean;
 };
-export declare const validateWorkspaceInvitationArray: (input: unknown[]) => {
+export declare const validateWorkspaceInvitationArray: (input: unknown) => {
     id: string;
     inviterId: string;
     userEmail: string;
@@ -487,7 +488,7 @@ export declare const validateWorkspace: (input: unknown) => {
     logoSmall?: string | null | undefined;
     logoS640?: string | null | undefined;
 };
-export declare const validateWorkspaceArray: (input: unknown[]) => {
+export declare const validateWorkspaceArray: (input: unknown) => {
     createdAt: string | undefined;
     id: string;
     name: string;
@@ -513,7 +514,7 @@ export declare const validateMemberActivityInfo: (input: unknown) => {
     tasksAssigned: number;
     tasksOverdue: number;
 };
-export declare const validateMemberActivityInfoArray: (input: unknown[]) => {
+export declare const validateMemberActivityInfoArray: (input: unknown) => {
     userId: string;
     tasksAssigned: number;
     tasksOverdue: number;
@@ -542,7 +543,7 @@ export declare const validateWorkspaceUserTask: (input: unknown) => {
     description: string;
     isOverdue: boolean;
 };
-export declare const validateWorkspaceUserTaskArray: (input: unknown[]) => {
+export declare const validateWorkspaceUserTaskArray: (input: unknown) => {
     id: string;
     content: string;
     responsibleUid: string | null;
@@ -652,7 +653,7 @@ export declare const validateBackup: (input: unknown) => {
     version: string;
     url: string;
 };
-export declare const validateBackupArray: (input: unknown[]) => {
+export declare const validateBackupArray: (input: unknown) => {
     version: string;
     url: string;
 }[];
@@ -660,7 +661,7 @@ export declare const validateIdMapping: (input: unknown) => {
     oldId: string | null;
     newId: string | null;
 };
-export declare const validateIdMappingArray: (input: unknown[]) => {
+export declare const validateIdMappingArray: (input: unknown) => {
     oldId: string | null;
     newId: string | null;
 }[];
@@ -668,7 +669,7 @@ export declare const validateMovedId: (input: unknown) => {
     oldId: string;
     newId: string;
 };
-export declare const validateMovedIdArray: (input: unknown[]) => {
+export declare const validateMovedIdArray: (input: unknown) => {
     oldId: string;
     newId: string;
 }[];
@@ -683,7 +684,7 @@ export declare const validateFilter: (input: unknown) => {
     isFrozen: boolean;
     itemOrder: number;
 };
-export declare const validateFilterArray: (input: unknown[]) => {
+export declare const validateFilterArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -702,7 +703,7 @@ export declare const validateCollaborator: (input: unknown) => {
     timezone: string;
     imageId: string | null;
 };
-export declare const validateCollaboratorArray: (input: unknown[]) => {
+export declare const validateCollaboratorArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     email: string;
@@ -718,7 +719,7 @@ export declare const validateCollaboratorState: (input: unknown) => {
     isDeleted: boolean;
     workspaceRole?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
 };
-export declare const validateCollaboratorStateArray: (input: unknown[]) => {
+export declare const validateCollaboratorStateArray: (input: unknown) => {
     [x: string]: unknown;
     userId: string;
     projectId: string;
@@ -735,7 +736,7 @@ export declare const validateFolder: (input: unknown) => {
     defaultOrder: number;
     childOrder: number;
 };
-export declare const validateFolderArray: (input: unknown[]) => {
+export declare const validateFolderArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -770,7 +771,7 @@ export declare const validateNote: (input: unknown) => {
     itemId?: string | undefined;
     projectId?: string | undefined;
 };
-export declare const validateNoteArray: (input: unknown[]) => {
+export declare const validateNoteArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     content: string;
@@ -817,7 +818,7 @@ export declare const validateWorkspaceFilter: (input: unknown) => {
     createdAt: string;
     updatedAt: string;
 };
-export declare const validateWorkspaceFilterArray: (input: unknown[]) => {
+export declare const validateWorkspaceFilterArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     workspaceId: string;
@@ -833,6 +834,54 @@ export declare const validateWorkspaceFilterArray: (input: unknown[]) => {
     createdAt: string;
     updatedAt: string;
 }[];
+export declare const validateGoal: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalItemCount: number;
+        completedItemCount: number;
+        percentage: number;
+    } | undefined;
+};
+export declare const validateGoalArray: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalItemCount: number;
+        completedItemCount: number;
+        percentage: number;
+    } | undefined;
+}[];
 export declare const validateWorkspaceGoal: (input: unknown) => {
     [x: string]: unknown;
     id: string;
@@ -851,7 +900,7 @@ export declare const validateWorkspaceGoal: (input: unknown) => {
     createdAt: string;
     updatedAt: string;
 };
-export declare const validateWorkspaceGoalArray: (input: unknown[]) => {
+export declare const validateWorkspaceGoalArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     workspaceId: string;
@@ -878,7 +927,7 @@ export declare const validateCalendar: (input: unknown) => {
     isVisible: boolean;
     isTaskCalendar?: boolean | undefined;
 };
-export declare const validateCalendarArray: (input: unknown[]) => {
+export declare const validateCalendarArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     summary: string;
@@ -899,7 +948,7 @@ export declare const validateCalendarAccount: (input: unknown) => {
     pendingOperationUntil?: string | null | undefined;
     calendarsSyncState?: "error" | "synced" | "syncing" | undefined;
 };
-export declare const validateCalendarAccountArray: (input: unknown[]) => {
+export declare const validateCalendarAccountArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     name: string;
@@ -960,7 +1009,7 @@ export declare const validateReminder: (input: unknown) => {
     } | undefined;
     isUrgent?: boolean | undefined;
 };
-export declare const validateReminderArray: (input: unknown[]) => ({
+export declare const validateReminderArray: (input: unknown) => ({
     [x: string]: unknown;
     id: string;
     notifyUid: string;
@@ -1023,7 +1072,7 @@ export declare const validateLocationReminder: (input: unknown) => {
     radius: number;
     projectId?: string | undefined;
 };
-export declare const validateLocationReminderArray: (input: unknown[]) => {
+export declare const validateLocationReminderArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     notifyUid: string;
@@ -1053,7 +1102,7 @@ export declare const validateCompletedInfo: (input: unknown) => {
     completedItems: number;
     id?: string | undefined;
 };
-export declare const validateCompletedInfoArray: (input: unknown[]) => ({
+export declare const validateCompletedInfoArray: (input: unknown) => ({
     [x: string]: unknown;
     projectId: string;
     archivedSections: number;
@@ -1080,7 +1129,7 @@ export declare const validateViewOptions: (input: unknown) => {
     sortedBy?: "PROJECT" | "WORKSPACE" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
 };
-export declare const validateViewOptionsArray: (input: unknown[]) => {
+export declare const 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;
@@ -1105,7 +1154,7 @@ export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
         layout?: "WEEK" | "MONTH" | undefined;
     } | null | undefined;
 };
-export declare const validateProjectViewOptionsDefaultsArray: (input: unknown[]) => {
+export declare const validateProjectViewOptionsDefaultsArray: (input: unknown) => {
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
@@ -1171,7 +1220,7 @@ export declare const validateLiveNotification: (input: unknown) => {
     isDeleted?: boolean | undefined;
     invitationSecret?: string | undefined;
 };
-export declare const validateLiveNotificationArray: (input: unknown[]) => {
+export declare const validateLiveNotificationArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
     createdAt: string;
@@ -1236,7 +1285,7 @@ export declare const validateSyncWorkspace: (input: unknown) => {
     } | undefined;
     properties?: Record<string, unknown> | undefined;
 };
-export declare const validateSyncWorkspaceArray: (input: unknown[]) => {
+export declare const validateSyncWorkspaceArray: (input: unknown) => {
     createdAt: string | undefined;
     id: string;
     name: string;
@@ -1432,7 +1481,7 @@ export declare const validateSuggestion: (input: unknown) => {
     };
     isDeleted: boolean;
 };
-export declare const validateSuggestionArray: (input: unknown[]) => ({
+export declare const validateSuggestionArray: (input: unknown) => ({
     [x: string]: unknown;
     type: "templates" | "most_used_user_templates";
     content: {
@@ -1460,3 +1509,4 @@ export declare const validateSuggestionArray: (input: unknown[]) => ({
     };
     isDeleted: boolean;
 })[];
+export declare function parseSyncResponse(raw: Record<string, unknown>): SyncResponse;

package/package.json

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