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

package/dist/esm/utils/validators.js

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ActivityEventSchema } from '../types/activity/types.js';
 import { BackupSchema } from '../types/backups/types.js';
 import { AttachmentSchema, CommentSchema } from '../types/comments/types.js';
@@ -6,167 +7,74 @@ import { IdMappingSchema, MovedIdSchema } from '../types/id-mappings/types.js';
 import { ProjectActivityStatsSchema, ProjectHealthSchema, ProjectHealthContextSchema, ProjectProgressSchema, WorkspaceInsightsSchema, } from '../types/insights/types.js';
 import { LabelSchema } from '../types/labels/types.js';
 import { ProductivityStatsSchema } from '../types/productivity/types.js';
-import { PersonalProjectSchema, WorkspaceProjectSchema, } from '../types/projects/types.js';
+import { WorkspaceProjectSchema, ProjectSchema } from '../types/projects/types.js';
 import { SectionSchema } from '../types/sections/types.js';
+import { SyncResponseSchema } from '../types/sync/response.js';
 import { TaskSchema } from '../types/tasks/types.js';
 import { UserSchema, CurrentUserSchema } from '../types/users/types.js';
 import { WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, WorkspaceSchema, MemberActivityInfoSchema, WorkspaceUserTaskSchema, } from '../types/workspaces/types.js';
 import { FilterSchema, CollaboratorSchema, CollaboratorStateSchema, FolderSchema, NoteSchema, TooltipsSchema, WorkspaceFilterSchema, WorkspaceGoalSchema, CalendarSchema, CalendarAccountSchema, ReminderSchema, LocationReminderSchema, CompletedInfoSchema, ViewOptionsSchema, ProjectViewOptionsDefaultsSchema, UserPlanLimitsSchema, LiveNotificationSchema, SyncWorkspaceSchema, SyncUserSchema, UserSettingsSchema, SuggestionSchema, } from '../types/sync/resources/index.js';
 function createValidator(schema) {
-    return (input) => schema.parse(input);
-}
-function createArrayValidator(validateItem) {
-    return (input) => {
-        if (!Array.isArray(input)) {
-            throw new TypeError(`Expected array, got ${typeof input}`);
-        }
-        return input.map(validateItem);
+    return {
+        validate: (input) => schema.parse(input),
+        validateArray: (input) => z.array(schema).parse(input),
     };
 }
 // Entity validators
-export const validateTask = createValidator(TaskSchema);
-export const validateTaskArray = createArrayValidator(validateTask);
-/**
- * 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 function isWorkspaceProject(project) {
-    return 'workspaceId' in project;
-}
-/**
- * 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 function isPersonalProject(project) {
-    return !isWorkspaceProject(project);
-}
+export const { validate: validateTask, validateArray: validateTaskArray } = createValidator(TaskSchema);
 /**
  * Validates and parses a project input.
  * @param input The input to validate
  * @returns A validated project (either PersonalProject or WorkspaceProject)
  */
-export function validateProject(input) {
-    if ('workspaceId' in input) {
-        return WorkspaceProjectSchema.parse(input);
-    }
-    return PersonalProjectSchema.parse(input);
-}
-export function validateProjectArray(input) {
-    if (!Array.isArray(input)) {
-        throw new TypeError(`Expected array, got ${typeof input}`);
-    }
-    return input.map(validateProject);
-}
-export const validateWorkspaceProject = createValidator(WorkspaceProjectSchema);
-export const validateWorkspaceProjectArray = createArrayValidator(validateWorkspaceProject);
-export const validateSection = createValidator(SectionSchema);
-export const validateSectionArray = createArrayValidator(validateSection);
-export const validateLabel = createValidator(LabelSchema);
-export const validateLabelArray = createArrayValidator(validateLabel);
-export const validateComment = createValidator(CommentSchema);
-export const validateCommentArray = createArrayValidator(validateComment);
-export const validateUser = createValidator(UserSchema);
-export const validateUserArray = createArrayValidator(validateUser);
-export const validateProductivityStats = createValidator(ProductivityStatsSchema);
-export const validateCurrentUser = createValidator(CurrentUserSchema);
-export const validateActivityEvent = createValidator(ActivityEventSchema);
-export const validateActivityEventArray = createArrayValidator(validateActivityEvent);
-export const validateAttachment = createValidator(AttachmentSchema);
-export const validateWorkspaceUser = createValidator(WorkspaceUserSchema);
-export function validateWorkspaceUserArray(input) {
-    if (!Array.isArray(input)) {
-        throw new Error(`Expected array for workspace users, got ${typeof input}`);
-    }
-    return input.map(validateWorkspaceUser);
-}
-export const validateWorkspaceInvitation = createValidator(WorkspaceInvitationSchema);
-export const validateWorkspaceInvitationArray = createArrayValidator(validateWorkspaceInvitation);
-export const validateWorkspacePlanDetails = createValidator(WorkspacePlanDetailsSchema);
-export const validateJoinWorkspaceResult = createValidator(JoinWorkspaceResultSchema);
-export const validateWorkspace = createValidator(WorkspaceSchema);
-export const validateWorkspaceArray = createArrayValidator(validateWorkspace);
-export const validateMemberActivityInfo = createValidator(MemberActivityInfoSchema);
-export const validateMemberActivityInfoArray = createArrayValidator(validateMemberActivityInfo);
-export const validateWorkspaceUserTask = createValidator(WorkspaceUserTaskSchema);
-export const validateWorkspaceUserTaskArray = createArrayValidator(validateWorkspaceUserTask);
-export const validateProjectActivityStats = createValidator(ProjectActivityStatsSchema);
-export const validateProjectHealth = createValidator(ProjectHealthSchema);
-export const validateProjectHealthContext = createValidator(ProjectHealthContextSchema);
-export const validateProjectProgress = createValidator(ProjectProgressSchema);
-export const validateWorkspaceInsights = createValidator(WorkspaceInsightsSchema);
-export const validateBackup = createValidator(BackupSchema);
-export const validateBackupArray = createArrayValidator(validateBackup);
-export const validateIdMapping = createValidator(IdMappingSchema);
-export const validateIdMappingArray = createArrayValidator(validateIdMapping);
-export const validateMovedId = createValidator(MovedIdSchema);
-export const validateMovedIdArray = createArrayValidator(validateMovedId);
+export const { validate: validateProject, validateArray: validateProjectArray } = createValidator(ProjectSchema);
+export const { validate: validateWorkspaceProject, validateArray: validateWorkspaceProjectArray } = createValidator(WorkspaceProjectSchema);
+export const { validate: validateSection, validateArray: validateSectionArray } = createValidator(SectionSchema);
+export const { validate: validateLabel, validateArray: validateLabelArray } = createValidator(LabelSchema);
+export const { validate: validateComment, validateArray: validateCommentArray } = createValidator(CommentSchema);
+export const { validate: validateUser, validateArray: validateUserArray } = createValidator(UserSchema);
+export const { validate: validateProductivityStats } = createValidator(ProductivityStatsSchema);
+export const { validate: validateCurrentUser } = createValidator(CurrentUserSchema);
+export const { validate: validateActivityEvent, validateArray: validateActivityEventArray } = createValidator(ActivityEventSchema);
+export const { validate: validateAttachment } = createValidator(AttachmentSchema);
+export const { validate: validateWorkspaceUser, validateArray: validateWorkspaceUserArray } = createValidator(WorkspaceUserSchema);
+export const { validate: validateWorkspaceInvitation, validateArray: validateWorkspaceInvitationArray, } = createValidator(WorkspaceInvitationSchema);
+export const { validate: validateWorkspacePlanDetails } = createValidator(WorkspacePlanDetailsSchema);
+export const { validate: validateJoinWorkspaceResult } = createValidator(JoinWorkspaceResultSchema);
+export const { validate: validateWorkspace, validateArray: validateWorkspaceArray } = createValidator(WorkspaceSchema);
+export const { validate: validateMemberActivityInfo, validateArray: validateMemberActivityInfoArray, } = createValidator(MemberActivityInfoSchema);
+export const { validate: validateWorkspaceUserTask, validateArray: validateWorkspaceUserTaskArray, } = createValidator(WorkspaceUserTaskSchema);
+export const { validate: validateProjectActivityStats } = createValidator(ProjectActivityStatsSchema);
+export const { validate: validateProjectHealth } = createValidator(ProjectHealthSchema);
+export const { validate: validateProjectHealthContext } = createValidator(ProjectHealthContextSchema);
+export const { validate: validateProjectProgress } = createValidator(ProjectProgressSchema);
+export const { validate: validateWorkspaceInsights } = createValidator(WorkspaceInsightsSchema);
+export const { validate: validateBackup, validateArray: validateBackupArray } = createValidator(BackupSchema);
+export const { validate: validateIdMapping, validateArray: validateIdMappingArray } = createValidator(IdMappingSchema);
+export const { validate: validateMovedId, validateArray: validateMovedIdArray } = createValidator(MovedIdSchema);
 // Sync resource validators
-export const validateFilter = createValidator(FilterSchema);
-export const validateFilterArray = createArrayValidator(validateFilter);
-export const validateCollaborator = createValidator(CollaboratorSchema);
-export const validateCollaboratorArray = createArrayValidator(validateCollaborator);
-export const validateCollaboratorState = createValidator(CollaboratorStateSchema);
-export const validateCollaboratorStateArray = createArrayValidator(validateCollaboratorState);
-export const validateFolder = createValidator(FolderSchema);
-export const validateFolderArray = createArrayValidator(validateFolder);
-export const validateGoal = createValidator(GoalSchema);
-export const validateGoalArray = createArrayValidator(validateGoal);
-export const validateNote = createValidator(NoteSchema);
-export const validateNoteArray = createArrayValidator(validateNote);
-export const validateTooltips = createValidator(TooltipsSchema);
-export const validateWorkspaceFilter = createValidator(WorkspaceFilterSchema);
-export const validateWorkspaceFilterArray = createArrayValidator(validateWorkspaceFilter);
-export const validateWorkspaceGoal = createValidator(WorkspaceGoalSchema);
-export const validateWorkspaceGoalArray = createArrayValidator(validateWorkspaceGoal);
-export const validateCalendar = createValidator(CalendarSchema);
-export const validateCalendarArray = createArrayValidator(validateCalendar);
-export const validateCalendarAccount = createValidator(CalendarAccountSchema);
-export const validateCalendarAccountArray = createArrayValidator(validateCalendarAccount);
-export const validateReminder = createValidator(ReminderSchema);
-export const validateReminderArray = createArrayValidator(validateReminder);
-export const validateLocationReminder = createValidator(LocationReminderSchema);
-export const validateLocationReminderArray = createArrayValidator(validateLocationReminder);
-export const validateCompletedInfo = createValidator(CompletedInfoSchema);
-export const validateCompletedInfoArray = createArrayValidator(validateCompletedInfo);
-export const validateViewOptions = createValidator(ViewOptionsSchema);
-export const validateViewOptionsArray = createArrayValidator(validateViewOptions);
-export const validateProjectViewOptionsDefaults = createValidator(ProjectViewOptionsDefaultsSchema);
-export const validateProjectViewOptionsDefaultsArray = createArrayValidator(validateProjectViewOptionsDefaults);
-export const validateUserPlanLimits = createValidator(UserPlanLimitsSchema);
-export const validateLiveNotification = createValidator(LiveNotificationSchema);
-export const validateLiveNotificationArray = createArrayValidator(validateLiveNotification);
-export const validateSyncWorkspace = createValidator(SyncWorkspaceSchema);
-export const validateSyncWorkspaceArray = createArrayValidator(validateSyncWorkspace);
-export const validateSyncUser = createValidator(SyncUserSchema);
-export const validateUserSettings = createValidator(UserSettingsSchema);
-export const validateSuggestion = createValidator(SuggestionSchema);
-export const validateSuggestionArray = createArrayValidator(validateSuggestion);
+export const { validate: validateFilter, validateArray: validateFilterArray } = createValidator(FilterSchema);
+export const { validate: validateCollaborator, validateArray: validateCollaboratorArray } = createValidator(CollaboratorSchema);
+export const { validate: validateCollaboratorState, validateArray: validateCollaboratorStateArray, } = createValidator(CollaboratorStateSchema);
+export const { validate: validateFolder, validateArray: validateFolderArray } = createValidator(FolderSchema);
+export const { validate: validateGoal, validateArray: validateGoalArray } = createValidator(GoalSchema);
+export const { validate: validateNote, validateArray: validateNoteArray } = createValidator(NoteSchema);
+export const { validate: validateTooltips } = createValidator(TooltipsSchema);
+export const { validate: validateWorkspaceFilter, validateArray: validateWorkspaceFilterArray } = createValidator(WorkspaceFilterSchema);
+export const { validate: validateWorkspaceGoal, validateArray: validateWorkspaceGoalArray } = createValidator(WorkspaceGoalSchema);
+export const { validate: validateCalendar, validateArray: validateCalendarArray } = createValidator(CalendarSchema);
+export const { validate: validateCalendarAccount, validateArray: validateCalendarAccountArray } = createValidator(CalendarAccountSchema);
+export const { validate: validateReminder, validateArray: validateReminderArray } = createValidator(ReminderSchema);
+export const { validate: validateLocationReminder, validateArray: validateLocationReminderArray } = createValidator(LocationReminderSchema);
+export const { validate: validateCompletedInfo, validateArray: validateCompletedInfoArray } = createValidator(CompletedInfoSchema);
+export const { validate: validateViewOptions, validateArray: validateViewOptionsArray } = createValidator(ViewOptionsSchema);
+export const { validate: validateProjectViewOptionsDefaults, validateArray: validateProjectViewOptionsDefaultsArray, } = createValidator(ProjectViewOptionsDefaultsSchema);
+export const { validate: validateUserPlanLimits } = createValidator(UserPlanLimitsSchema);
+export const { validate: validateLiveNotification, validateArray: validateLiveNotificationArray } = createValidator(LiveNotificationSchema);
+export const { validate: validateSyncWorkspace, validateArray: validateSyncWorkspaceArray } = createValidator(SyncWorkspaceSchema);
+export const { validate: validateSyncUser } = createValidator(SyncUserSchema);
+export const { validate: validateUserSettings } = createValidator(UserSettingsSchema);
+export const { validate: validateSuggestion, validateArray: validateSuggestionArray } = createValidator(SuggestionSchema);
 export function parseSyncResponse(raw) {
-    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, raw), ('items' in raw ? { items: validateTaskArray(raw.items) } : {})), ('projects' in raw ? { projects: validateProjectArray(raw.projects) } : {})), ('sections' in raw ? { sections: validateSectionArray(raw.sections) } : {})), ('labels' in raw ? { labels: validateLabelArray(raw.labels) } : {})), ('notes' in raw ? { notes: validateNoteArray(raw.notes) } : {})), ('projectNotes' in raw ? { projectNotes: validateNoteArray(raw.projectNotes) } : {})), ('filters' in raw ? { filters: validateFilterArray(raw.filters) } : {})), ('reminders' in raw ? { reminders: validateReminderArray(raw.reminders) } : {})), ('remindersLocation' in raw
-        ? { remindersLocation: validateLocationReminderArray(raw.remindersLocation) }
-        : {})), ('user' in raw ? { user: validateSyncUser(raw.user) } : {})), ('liveNotifications' in raw
-        ? { liveNotifications: validateLiveNotificationArray(raw.liveNotifications) }
-        : {})), ('collaborators' in raw
-        ? { collaborators: validateCollaboratorArray(raw.collaborators) }
-        : {})), ('collaboratorStates' in raw
-        ? { collaboratorStates: validateCollaboratorStateArray(raw.collaboratorStates) }
-        : {})), ('userSettings' in raw ? { userSettings: validateUserSettings(raw.userSettings) } : {})), ('userPlanLimits' in raw
-        ? { userPlanLimits: validateUserPlanLimits(raw.userPlanLimits) }
-        : {})), ('completedInfo' in raw
-        ? { completedInfo: validateCompletedInfoArray(raw.completedInfo) }
-        : {})), ('workspaces' in raw ? { workspaces: validateSyncWorkspaceArray(raw.workspaces) } : {})), ('workspaceUsers' in raw
-        ? { workspaceUsers: validateWorkspaceUserArray(raw.workspaceUsers) }
-        : {})), ('workspaceFilters' in raw
-        ? { workspaceFilters: validateWorkspaceFilterArray(raw.workspaceFilters) }
-        : {})), ('viewOptions' in raw ? { viewOptions: validateViewOptionsArray(raw.viewOptions) } : {})), ('projectViewOptionsDefaults' in raw
-        ? {
-            projectViewOptionsDefaults: validateProjectViewOptionsDefaultsArray(raw.projectViewOptionsDefaults),
-        }
-        : {})), ('folders' in raw ? { folders: validateFolderArray(raw.folders) } : {})), ('goals' in raw ? { goals: validateGoalArray(raw.goals) } : {})), ('workspaceGoals' in raw
-        ? { workspaceGoals: validateWorkspaceGoalArray(raw.workspaceGoals) }
-        : {})), ('calendars' in raw ? { calendars: validateCalendarArray(raw.calendars) } : {})), ('calendarAccounts' in raw
-        ? { calendarAccounts: validateCalendarAccountArray(raw.calendarAccounts) }
-        : {})), ('suggestions' in raw ? { suggestions: validateSuggestionArray(raw.suggestions) } : {})), ('tooltips' in raw ? { tooltips: validateTooltips(raw.tooltips) } : {}));
+    return SyncResponseSchema.parse(raw);
 }

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

@@ -260,6 +260,11 @@ export declare class TodoistApi {
     /**
      * Deletes a project by its ID.
      *
+     * If the project is a workspace project, it must have been
+     * archived first before it can be deleted, otherwise calling
+     * this function will result in an error. Personal projects can
+     * be deleted regardless of their archived status.
+     *
      * @param id - The unique identifier of the project to delete.
      * @param requestId - Optional custom identifier for the request.
      * @returns A promise that resolves to `true` if successful.

package/dist/types/types/projects/types.d.ts

@@ -192,6 +192,61 @@ export type PersonalProject = z.infer<typeof PersonalProjectSchema>;
  * @see https://developer.todoist.com/api/v1/#tag/Projects
  */
 export type WorkspaceProject = z.infer<typeof WorkspaceProjectSchema>;
+/**
+ * Schema for any project type in Todoist (personal or workspace).
+ * Dispatches to WorkspaceProjectSchema when workspaceId is present, PersonalProjectSchema otherwise.
+ */
+export declare const ProjectSchema: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+    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;
+}, unknown>>;
+/** A project in Todoist — either a {@link PersonalProject} or a {@link WorkspaceProject}. */
+export type Project = z.infer<typeof ProjectSchema>;
 /** Available project view styles. */
 export declare const PROJECT_VIEW_STYLES: readonly ["list", "board", "calendar"];
 /**