@doist/todoist-api-typescript 6.5.0 → 6.6.0

package/dist/types/types/sync/resources/user-settings.d.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+/**
+ * Sync API user settings resource.
+ */
+export declare const UserSettingsSchema: z.ZodObject<{
+    completedSoundDesktop: z.ZodBoolean;
+    completedSoundMobile: z.ZodBoolean;
+    debugLogSendingEnabledUntil: z.ZodNullable<z.ZodString>;
+    legacyPricing: z.ZodBoolean;
+    navigation: z.ZodObject<{
+        countsShown: z.ZodBoolean;
+        features: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            shown: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$loose>;
+    reminderDesktop: z.ZodBoolean;
+    reminderEmail: z.ZodBoolean;
+    reminderPush: z.ZodBoolean;
+    resetRecurringSubtasks: z.ZodBoolean;
+    aiEmailAssist: z.ZodBoolean;
+    theme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    syncTheme: z.ZodOptional<z.ZodBoolean>;
+    quickAdd: z.ZodObject<{
+        labelsShown: z.ZodBoolean;
+        features: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            shown: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export type UserSettings = z.infer<typeof UserSettingsSchema>;

package/dist/types/types/sync/resources/user.d.ts

@@ -0,0 +1,104 @@
+import { z } from 'zod';
+/**
+ * Sync API user resource.
+ *
+ * This is a superset of the REST `CurrentUserSchema` — the Sync API returns
+ * many additional fields for features, onboarding state, and account details.
+ */
+export declare const SyncUserSchema: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    fullName: z.ZodString;
+    activatedUser: z.ZodBoolean;
+    autoReminder: z.ZodNumber;
+    avatarBig: z.ZodOptional<z.ZodString>;
+    avatarMedium: z.ZodOptional<z.ZodString>;
+    avatarS640: z.ZodOptional<z.ZodString>;
+    avatarSmall: z.ZodOptional<z.ZodString>;
+    businessAccountId: z.ZodNullable<z.ZodString>;
+    dailyGoal: z.ZodNumber;
+    dateFormat: z.ZodNumber;
+    dateistLang: z.ZodNullable<z.ZodString>;
+    daysOff: z.ZodArray<z.ZodNumber>;
+    featureIdentifier: z.ZodString;
+    features: z.ZodObject<{
+        karmaDisabled: z.ZodBoolean;
+        restriction: z.ZodNumber;
+        karmaVacation: z.ZodBoolean;
+        dateistLang: z.ZodAny;
+        beta: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+        hasPushReminders: z.ZodBoolean;
+        dateistInlineDisabled: z.ZodBoolean;
+        autoInviteDisabled: z.ZodOptional<z.ZodBoolean>;
+        goldTheme: z.ZodOptional<z.ZodBoolean>;
+        migratedFromTdb: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>;
+    freeTrailExpires: z.ZodOptional<z.ZodString>;
+    hasMagicNumber: z.ZodBoolean;
+    hasPassword: z.ZodBoolean;
+    hasStartedATrial: z.ZodOptional<z.ZodBoolean>;
+    imageId: z.ZodNullable<z.ZodString>;
+    inboxProjectId: z.ZodString;
+    isCelebrationsEnabled: z.ZodBoolean;
+    isPremium: z.ZodBoolean;
+    joinableWorkspace: z.ZodNullable<z.ZodObject<{
+        workspaceId: z.ZodString;
+        workspaceName: z.ZodString;
+        memberCount: z.ZodNumber;
+    }, z.core.$loose>>;
+    joinedAt: z.ZodString;
+    gettingStartedGuideProjects: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        onboardingUseCase: z.ZodString;
+        projectId: z.ZodString;
+        completed: z.ZodBoolean;
+        closed: z.ZodBoolean;
+    }, z.core.$loose>>>;
+    karma: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    lang: z.ZodString;
+    mfaEnabled: z.ZodOptional<z.ZodBoolean>;
+    mobileHost: z.ZodNullable<z.ZodString>;
+    mobileNumber: z.ZodNullable<z.ZodString>;
+    nextWeek: z.ZodNumber;
+    onboardingLevel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    onboardingRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    onboardingPersona: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    onboardingInitiated: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    onboardingCompleted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    onboardingSkipped: z.ZodOptional<z.ZodBoolean>;
+    onboardingTeamMode: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    onboardingUseCases: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    premiumStatus: z.ZodEnum<{
+        not_premium: "not_premium";
+        current_personal_plan: "current_personal_plan";
+        legacy_personal_plan: "legacy_personal_plan";
+        teams_business_member: "teams_business_member";
+    }>;
+    premiumUntil: z.ZodNullable<z.ZodString>;
+    rambleSessionsUsage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        currentCount: z.ZodNumber;
+        limit: z.ZodNumber;
+        remaining: z.ZodNumber;
+        resetDate: z.ZodString;
+    }, z.core.$strip>>>;
+    shareLimit: z.ZodNumber;
+    sortOrder: z.ZodNumber;
+    startDay: z.ZodNumber;
+    startPage: z.ZodString;
+    themeId: z.ZodString;
+    timeFormat: z.ZodNumber;
+    token: z.ZodString;
+    tzInfo: z.ZodObject<{
+        timezone: z.ZodString;
+        hours: z.ZodNumber;
+        minutes: z.ZodNumber;
+        isDst: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+        gmtString: z.ZodString;
+    }, z.core.$loose>;
+    uniquePrefix: z.ZodNumber;
+    verificationStatus: z.ZodString;
+    websocketUrl: z.ZodString;
+    weekendStartDay: z.ZodNumber;
+    weeklyGoal: z.ZodNumber;
+}, z.core.$loose>;
+export type SyncUser = z.infer<typeof SyncUserSchema>;

package/dist/types/types/sync/resources/view-options.d.ts

@@ -0,0 +1,94 @@
+import { z } from 'zod';
+export declare const ViewOptionsSchema: z.ZodObject<{
+    viewType: z.ZodEnum<{
+        TODAY: "TODAY";
+        UPCOMING: "UPCOMING";
+        PROJECT: "PROJECT";
+        LABEL: "LABEL";
+        FILTER: "FILTER";
+        WORKSPACE_FILTER: "WORKSPACE_FILTER";
+        SEARCH: "SEARCH";
+        TEMPLATE_PREVIEW: "TEMPLATE_PREVIEW";
+        TASK_DETAIL: "TASK_DETAIL";
+        AUTOMATION: "AUTOMATION";
+        ASSIGNED: "ASSIGNED";
+        OVERDUE: "OVERDUE";
+        WORKSPACE_OVERVIEW: "WORKSPACE_OVERVIEW";
+    }>;
+    objectId: z.ZodOptional<z.ZodString>;
+    groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        PROJECT: "PROJECT";
+        LABEL: "LABEL";
+        ASSIGNEE: "ASSIGNEE";
+        ADDED_DATE: "ADDED_DATE";
+        DUE_DATE: "DUE_DATE";
+        DEADLINE: "DEADLINE";
+        PRIORITY: "PRIORITY";
+        WORKSPACE: "WORKSPACE";
+    }>>>;
+    filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    viewMode: z.ZodOptional<z.ZodEnum<{
+        LIST: "LIST";
+        BOARD: "BOARD";
+        CALENDAR: "CALENDAR";
+    }>>;
+    showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
+    sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        MANUAL: "MANUAL";
+        PROJECT: "PROJECT";
+        ASSIGNEE: "ASSIGNEE";
+        ADDED_DATE: "ADDED_DATE";
+        DUE_DATE: "DUE_DATE";
+        DEADLINE: "DEADLINE";
+        PRIORITY: "PRIORITY";
+        WORKSPACE: "WORKSPACE";
+        ALPHABETICALLY: "ALPHABETICALLY";
+    }>>>;
+    sortOrder: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        ASC: "ASC";
+        DESC: "DESC";
+    }>>>;
+}, z.core.$loose>;
+export type ViewOptions = z.infer<typeof ViewOptionsSchema>;
+export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    viewMode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        LIST: "LIST";
+        BOARD: "BOARD";
+        CALENDAR: "CALENDAR";
+    }>>>;
+    groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        PROJECT: "PROJECT";
+        LABEL: "LABEL";
+        ASSIGNEE: "ASSIGNEE";
+        ADDED_DATE: "ADDED_DATE";
+        DUE_DATE: "DUE_DATE";
+        DEADLINE: "DEADLINE";
+        PRIORITY: "PRIORITY";
+        WORKSPACE: "WORKSPACE";
+    }>>>;
+    sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        MANUAL: "MANUAL";
+        PROJECT: "PROJECT";
+        ASSIGNEE: "ASSIGNEE";
+        ADDED_DATE: "ADDED_DATE";
+        DUE_DATE: "DUE_DATE";
+        DEADLINE: "DEADLINE";
+        PRIORITY: "PRIORITY";
+        WORKSPACE: "WORKSPACE";
+        ALPHABETICALLY: "ALPHABETICALLY";
+    }>>>;
+    sortOrder: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        ASC: "ASC";
+        DESC: "DESC";
+    }>>>;
+    showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
+    filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    calendarSettings: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        layout: z.ZodOptional<z.ZodEnum<{
+            WEEK: "WEEK";
+            MONTH: "MONTH";
+        }>>;
+    }, z.core.$loose>>>;
+}, z.core.$loose>;
+export type ProjectViewOptionsDefaults = z.infer<typeof ProjectViewOptionsDefaultsSchema>;

package/dist/types/types/sync/resources/workspace-filters.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+export declare const WorkspaceFilterSchema: z.ZodObject<{
+    id: z.ZodString;
+    workspaceId: z.ZodString;
+    name: z.ZodString;
+    query: z.ZodString;
+    color: z.ZodString;
+    itemOrder: z.ZodNumber;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    creatorUid: z.ZodString;
+    updaterUid: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$loose>;
+export type WorkspaceFilter = z.infer<typeof WorkspaceFilterSchema>;

package/dist/types/types/sync/resources/workspace-goals.d.ts

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export declare const WorkspaceGoalMilestoneSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    isCompleted: z.ZodBoolean;
+}, z.core.$loose>;
+export type WorkspaceGoalMilestone = z.infer<typeof WorkspaceGoalMilestoneSchema>;
+export declare const WorkspaceGoalProgressSchema: z.ZodObject<{
+    completedItems: z.ZodNumber;
+    totalItems: z.ZodNumber;
+}, z.core.$loose>;
+export type WorkspaceGoalProgress = z.infer<typeof WorkspaceGoalProgressSchema>;
+export declare const WorkspaceGoalSchema: z.ZodObject<{
+    id: z.ZodString;
+    workspaceId: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodString>;
+    isDeleted: z.ZodBoolean;
+    projectIds: z.ZodArray<z.ZodString>;
+    progress: z.ZodNullable<z.ZodObject<{
+        completedItems: z.ZodNumber;
+        totalItems: z.ZodNumber;
+    }, z.core.$loose>>;
+    creatorUid: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$loose>;
+export type WorkspaceGoal = z.infer<typeof WorkspaceGoalSchema>;

package/dist/types/types/sync/resources/workspaces.d.ts

@@ -0,0 +1,52 @@
+import { z } from 'zod';
+/**
+ * Sync API workspace resource.
+ *
+ * This is a superset of the REST `WorkspaceSchema` — the Sync API returns
+ * additional fields like description, isDeleted, isCollapsed, member counts,
+ * domain settings, and sorting preferences.
+ */
+export declare const SyncWorkspaceSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    logoBig: z.ZodOptional<z.ZodString>;
+    logoMedium: z.ZodOptional<z.ZodString>;
+    logoSmall: z.ZodOptional<z.ZodString>;
+    logoS640: z.ZodOptional<z.ZodString>;
+    creatorId: z.ZodString;
+    createdAt: z.ZodString;
+    isDeleted: z.ZodBoolean;
+    isCollapsed: z.ZodBoolean;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    plan: z.ZodEnum<{
+        STARTER: "STARTER";
+        BUSINESS: "BUSINESS";
+    }>;
+    limits: z.ZodObject<{
+        current: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        next: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$catchall<z.ZodAny>>;
+    inviteCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isLinkSharingEnabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    isGuestAllowed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    currentActiveProjects: z.ZodNullable<z.ZodNumber>;
+    currentMemberCount: z.ZodNullable<z.ZodNumber>;
+    currentTemplateCount: z.ZodNullable<z.ZodNumber>;
+    pendingInvitations: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    domainName: z.ZodOptional<z.ZodString>;
+    domainDiscovery: z.ZodOptional<z.ZodBoolean>;
+    restrictEmailDomains: z.ZodOptional<z.ZodBoolean>;
+    adminSortingApplied: z.ZodBoolean;
+    projectSortPreference: z.ZodOptional<z.ZodString>;
+    defaultCollaborators: z.ZodOptional<z.ZodObject<{
+        predefinedGroupIds: z.ZodArray<z.ZodString>;
+        userIds: z.ZodArray<z.ZodNumber>;
+    }, z.core.$strip>>;
+    properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+export type SyncWorkspace = z.infer<typeof SyncWorkspaceSchema>;

package/dist/types/types/sync/response.d.ts

@@ -0,0 +1,47 @@
+import type { Task, Label, Section, PersonalProject, WorkspaceProject, WorkspaceUser } from '../entities.js';
+import type { Filter, Collaborator, CollaboratorState, Folder, Note, Tooltips, WorkspaceFilter, WorkspaceGoal, Calendar, CalendarAccount, Reminder, CompletedInfo, ViewOptions, ProjectViewOptionsDefaults, UserPlanLimits, LiveNotification, SyncWorkspace, SyncUser, UserSettings, LocationReminder, Suggestion } from './resources/index.js';
+export type SyncError = {
+    error: string;
+    errorCode: number;
+    errorExtra: Record<string, unknown>;
+    errorTag: string;
+    httpCode: number;
+};
+export type SyncResponse = {
+    syncToken?: string;
+    fullSync?: boolean;
+    syncStatus?: Record<string, 'ok' | SyncError>;
+    tempIdMapping?: Record<string, string>;
+    items?: Task[];
+    projects?: (PersonalProject | WorkspaceProject)[];
+    sections?: Section[];
+    labels?: Label[];
+    notes?: Note[];
+    projectNotes?: Note[];
+    filters?: Filter[];
+    reminders?: Reminder[];
+    remindersLocation?: LocationReminder[];
+    locations?: Record<string, unknown>[];
+    user?: SyncUser;
+    liveNotifications?: LiveNotification[];
+    collaborators?: Collaborator[];
+    collaboratorStates?: CollaboratorState[];
+    userSettings?: UserSettings;
+    notificationSettings?: Record<string, boolean>;
+    userPlanLimits?: UserPlanLimits;
+    completedInfo?: CompletedInfo[];
+    stats?: Record<string, unknown>;
+    workspaces?: SyncWorkspace[];
+    workspaceUsers?: WorkspaceUser[];
+    workspaceFilters?: WorkspaceFilter[];
+    viewOptions?: ViewOptions[];
+    projectViewOptionsDefaults?: ProjectViewOptionsDefaults[];
+    roleActions?: Record<string, unknown>[];
+    folders?: Folder[];
+    workspaceGoals?: WorkspaceGoal[];
+    dayOrders?: Record<string, number>;
+    calendars?: Calendar[];
+    calendarAccounts?: CalendarAccount[];
+    suggestions?: Suggestion[];
+    tooltips?: Tooltips;
+};

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

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

package/dist/types/utils/multipart-upload.d.ts

@@ -3,7 +3,7 @@ type UploadMultipartFileArgs = {
     baseUrl: string;
     authToken: string;
     endpoint: string;
-    file: Buffer | NodeJS.ReadableStream | string;
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
     fileName?: string;
     additionalFields: Record<string, string | number | boolean>;
     requestId?: string;
@@ -15,11 +15,13 @@ type UploadMultipartFileArgs = {
  * This is a shared utility for uploading files to Todoist endpoints that require
  * multipart/form-data content type (e.g., file uploads, workspace logo uploads).
  *
+ * Supports both browser (Blob/File) and Node.js (Buffer/ReadableStream/path) environments.
+ *
  * @param baseUrl - The base API URL (e.g., https://api.todoist.com/api/v1/)
  * @param authToken - The authentication token
  * @param endpoint - The relative endpoint path (e.g., 'uploads', 'workspaces/logo')
- * @param file - The file content (Buffer, ReadableStream, or file system path)
- * @param fileName - Optional file name (required for Buffer/Stream, optional for paths)
+ * @param file - The file content (Blob/File for browser, or Buffer/ReadableStream/path for Node)
+ * @param fileName - Optional file name (required for Buffer/Stream, optional for paths and File objects)
  * @param additionalFields - Additional form fields to include (e.g., project_id, workspace_id)
  * @param requestId - Optional request ID for idempotency
  * @returns The response data from the server

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

@@ -0,0 +1,17 @@
+import type { SyncCommandType, SyncCommandsMap, SyncCommand } from '../types/sync/commands/index.js';
+/**
+ * Creates a strongly-typed Sync API command with an auto-generated UUID.
+ *
+ * @param type - The command type (e.g. `'item_add'`, `'project_update'`).
+ * @param args - The command arguments, constrained by the command type.
+ * @param tempId - Optional temporary ID for referencing the created resource in subsequent commands.
+ * @returns A fully formed `SyncCommand` ready to include in a sync request.
+ *
+ * @example
+ * ```typescript
+ * const cmd = createCommand('item_add', { content: 'Buy milk', priority: 2 })
+ * // cmd.type === 'item_add'
+ * // cmd.args is typed as TaskAddArgs
+ * ```
+ */
+export declare function createCommand<T extends SyncCommandType>(type: T, args: SyncCommandsMap[T], tempId?: string): SyncCommand<T>;