@doist/todoist-api-typescript 6.5.1 → 6.7.0

package/dist/esm/types/sync/commands/tasks.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/commands/view-options.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/commands/workspace-filters.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/commands/workspace-goals.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/commands/workspaces.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/index.js

@@ -0,0 +1,5 @@
+export * from './commands/index.js';
+export * from './resources/index.js';
+export * from './resource-types.js';
+export * from './request.js';
+export * from './response.js';

package/dist/esm/types/sync/request.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/{sync.js → sync/resource-types.js}

@@ -6,6 +6,7 @@ export const SYNC_RESOURCE_TYPES = [
     'projects',
     'items',
     'notes',
+    'project_notes',
     'sections',
     'filters',
     'reminders',
@@ -14,6 +15,7 @@ export const SYNC_RESOURCE_TYPES = [
     'user',
     'live_notifications',
     'collaborators',
+    'collaborator_states',
     'user_settings',
     'notification_settings',
     'user_plan_limits',
@@ -25,4 +27,11 @@ export const SYNC_RESOURCE_TYPES = [
     'view_options',
     'project_view_options_defaults',
     'role_actions',
+    'folders',
+    'workspace_goals',
+    'day_orders',
+    'calendars',
+    'calendar_accounts',
+    'suggestions',
+    'tooltips',
 ];

package/dist/esm/types/sync/resources/calendars.js

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+export const CalendarSchema = z
+    .object({
+    id: z.string(),
+    summary: z.string(),
+    color: z.string().nullable(),
+    accountId: z.string(),
+    isVisible: z.boolean(),
+    isTaskCalendar: z.boolean().optional(),
+})
+    .passthrough();
+export const CalendarAccountSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    type: z.enum(['google', 'microsoft', 'apple']),
+    isDeleted: z.boolean().optional(),
+    isEventsEnabled: z.boolean().optional(),
+    isTasksEnabled: z.boolean().optional(),
+    isAllDayTasksEnabled: z.boolean().optional(),
+    pendingOperationUntil: z.string().nullable().optional(),
+    calendarsSyncState: z.enum(['synced', 'syncing', 'error']).optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/collaborators.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { WorkspaceRoleSchema } from '../../entities.js';
+export const CollaboratorSchema = z
+    .object({
+    id: z.string(),
+    email: z.string(),
+    fullName: z.string(),
+    timezone: z.string(),
+    imageId: z.string().nullable(),
+})
+    .passthrough();
+export const CollaboratorStateSchema = z
+    .object({
+    userId: z.string(),
+    projectId: z.string(),
+    state: z.enum(['active', 'invited']),
+    isDeleted: z.boolean(),
+    workspaceRole: WorkspaceRoleSchema.optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/completed-info.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+export const CompletedProjectMetadataSchema = z
+    .object({
+    projectId: z.string(),
+    archivedSections: z.number().int(),
+    completedItems: z.number().int(),
+})
+    .passthrough();
+export const CompletedSectionMetadataSchema = z
+    .object({
+    sectionId: z.string(),
+    id: z.string(),
+    completedItems: z.number().int(),
+})
+    .passthrough();
+export const CompletedTaskMetadataSchema = z
+    .object({
+    itemId: z.string(),
+    id: z.string().optional(),
+    completedItems: z.number().int(),
+})
+    .passthrough();
+export const CompletedInfoSchema = z.union([
+    CompletedProjectMetadataSchema,
+    CompletedSectionMetadataSchema,
+    CompletedTaskMetadataSchema,
+]);

package/dist/esm/types/sync/resources/filters.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export const FilterSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    query: z.string(),
+    color: z.string(),
+    isDeleted: z.boolean(),
+    isFavorite: z.boolean(),
+    isFrozen: z.boolean(),
+    itemOrder: z.number().int(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/folders.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export const FolderSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    workspaceId: z.string(),
+    isDeleted: z.boolean(),
+    defaultOrder: z.number().int(),
+    childOrder: z.number().int(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/index.js

@@ -0,0 +1,17 @@
+export * from './filters.js';
+export * from './collaborators.js';
+export * from './folders.js';
+export * from './tooltips.js';
+export * from './notes.js';
+export * from './workspace-filters.js';
+export * from './workspace-goals.js';
+export * from './calendars.js';
+export * from './reminders.js';
+export * from './completed-info.js';
+export * from './view-options.js';
+export * from './user-plan-limits.js';
+export * from './live-notifications.js';
+export * from './workspaces.js';
+export * from './user.js';
+export * from './user-settings.js';
+export * from './suggestions.js';

package/dist/esm/types/sync/resources/live-notifications.js

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+/**
+ * Live notification resource from the Sync API.
+ *
+ * Uses a base schema with commonly-present fields plus `.passthrough()` for
+ * forward compatibility. The Sync API returns 20+ notification variants;
+ * fully typing each is too fragile for a library, so we validate the common
+ * shape and preserve all extra fields.
+ */
+export const LiveNotificationSchema = z
+    .object({
+    id: z.string(),
+    createdAt: z.string(),
+    fromUid: z.string(),
+    notificationType: z.string(),
+    isUnread: z.boolean(),
+    // Commonly present optional fields
+    projectId: z.string().optional(),
+    invitationId: z.string().optional(),
+    itemId: z.string().optional(),
+    itemContent: z.string().optional(),
+    responsibleUid: z.string().optional(),
+    assignedByUid: z.string().optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/notes.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { AttachmentSchema } from '../../entities.js';
+/**
+ * Sync API note (comment) resource.
+ * Separate from the REST `CommentSchema` which transforms `itemId` to `taskId`.
+ */
+export const NoteSchema = z
+    .object({
+    id: z.string(),
+    itemId: z.string().optional(),
+    projectId: z.string().optional(),
+    content: z.string(),
+    postedAt: z.string(),
+    fileAttachment: AttachmentSchema.nullable(),
+    postedUid: z.string(),
+    uidsToNotify: z.array(z.string()).nullable(),
+    reactions: z.record(z.string(), z.array(z.string())).nullable(),
+    isDeleted: z.boolean(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/reminders.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { DueDateSchema } from '../../entities.js';
+const ReminderBaseSchema = z.object({
+    id: z.string(),
+    notifyUid: z.string(),
+    itemId: z.string(),
+    projectId: z.string().optional(),
+    isDeleted: z.boolean(),
+});
+export const LocationReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal('location'),
+    name: z.string(),
+    locLat: z.string(),
+    locLong: z.string(),
+    locTrigger: z.enum(['on_enter', 'on_leave']),
+    radius: z.number().int(),
+}).passthrough();
+export const AbsoluteReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal('absolute'),
+    due: DueDateSchema,
+}).passthrough();
+export const RelativeReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal('relative'),
+    minuteOffset: z.number().int(),
+    due: DueDateSchema.optional(),
+}).passthrough();
+export const ReminderSchema = z.discriminatedUnion('type', [
+    LocationReminderSchema,
+    AbsoluteReminderSchema,
+    RelativeReminderSchema,
+]);

package/dist/esm/types/sync/resources/suggestions.js

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+export const TemplateSuggestionSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    templateType: z.enum(['project', 'setup']),
+})
+    .passthrough();
+export const WorkspaceTemplateSuggestionSchema = TemplateSuggestionSchema.extend({
+    workspaceId: z.string().nullable(),
+});
+const SyncTemplateSuggestionsSchema = z
+    .object({
+    type: z.enum(['templates', 'most_used_user_templates']),
+    content: z.object({
+        templates: z.array(TemplateSuggestionSchema),
+        locale: z.string(),
+    }),
+    isDeleted: z.boolean(),
+})
+    .passthrough();
+const SyncWorkspaceTemplateSuggestionsSchema = z
+    .object({
+    type: z.literal('most_used_workspace_templates'),
+    content: z.object({
+        templates: z.array(WorkspaceTemplateSuggestionSchema),
+        locale: z.string(),
+    }),
+    isDeleted: z.boolean(),
+})
+    .passthrough();
+export const SuggestionSchema = z.union([
+    SyncWorkspaceTemplateSuggestionsSchema,
+    SyncTemplateSuggestionsSchema,
+]);

package/dist/esm/types/sync/resources/tooltips.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export const TooltipsSchema = z
+    .object({
+    seen: z.array(z.string()).optional(),
+    scheduled: z.array(z.string()).optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/user-plan-limits.js

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+export const PlanLimitsSchema = z
+    .object({
+    activeProjects: z.number().int().optional(),
+    activityLog: z.number().int().optional(),
+    collaboratorsPerProject: z.number().int().optional(),
+    commentsPerTask: z.number().int().optional(),
+    fileUploadsPerComment: z.number().int().optional(),
+    filtersPerUser: z.number().int().optional(),
+    labelsPerTask: z.number().int().optional(),
+    remindersPerUser: z.number().int().optional(),
+    sectionsPerProject: z.number().int().optional(),
+    tasksPerProject: z.number().int().optional(),
+})
+    .passthrough();
+export const UserPlanLimitsSchema = z
+    .object({
+    current: PlanLimitsSchema,
+    next: PlanLimitsSchema.nullable(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/user-settings.js

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+const NavigationFeatureSchema = z.object({
+    name: z.string(),
+    shown: z.boolean(),
+});
+const QuickAddFeatureSchema = z.object({
+    name: z.string(),
+    shown: z.boolean(),
+});
+/**
+ * Sync API user settings resource.
+ */
+export const UserSettingsSchema = z
+    .object({
+    completedSoundDesktop: z.boolean(),
+    completedSoundMobile: z.boolean(),
+    debugLogSendingEnabledUntil: z.string().nullable(),
+    legacyPricing: z.boolean(),
+    navigation: z
+        .object({
+        countsShown: z.boolean(),
+        features: z.array(NavigationFeatureSchema),
+    })
+        .passthrough(),
+    reminderDesktop: z.boolean(),
+    reminderEmail: z.boolean(),
+    reminderPush: z.boolean(),
+    resetRecurringSubtasks: z.boolean(),
+    aiEmailAssist: z.boolean(),
+    theme: z.string().nullable().optional(),
+    syncTheme: z.boolean().optional(),
+    quickAdd: z
+        .object({
+        labelsShown: z.boolean(),
+        features: z.array(QuickAddFeatureSchema),
+    })
+        .passthrough(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/user.js

@@ -0,0 +1,120 @@
+import { z } from 'zod';
+const FeaturesSchema = z
+    .object({
+    karmaDisabled: z.boolean(),
+    restriction: z.number().int(),
+    karmaVacation: z.boolean(),
+    dateistLang: z.any(),
+    beta: z.union([z.literal(0), z.literal(1)]),
+    hasPushReminders: z.boolean(),
+    dateistInlineDisabled: z.boolean(),
+    autoInviteDisabled: z.boolean().optional(),
+    goldTheme: z.boolean().optional(),
+    migratedFromTdb: z.boolean().optional(),
+})
+    .passthrough();
+const TzInfoSchema = z
+    .object({
+    timezone: z.string(),
+    hours: z.number().int(),
+    minutes: z.number().int(),
+    isDst: z.union([z.literal(0), z.literal(1)]),
+    gmtString: z.string(),
+})
+    .passthrough();
+const JoinableWorkspaceSchema = z
+    .object({
+    workspaceId: z.string(),
+    workspaceName: z.string(),
+    memberCount: z.number().int(),
+})
+    .passthrough();
+const GettingStartedGuideProjectSchema = z
+    .object({
+    onboardingUseCase: z.string(),
+    projectId: z.string(),
+    completed: z.boolean(),
+    closed: z.boolean(),
+})
+    .passthrough();
+/**
+ * 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 const SyncUserSchema = z
+    .object({
+    id: z.string(),
+    email: z.string(),
+    fullName: z.string(),
+    activatedUser: z.boolean(),
+    autoReminder: z.number().int(),
+    avatarBig: z.string().optional(),
+    avatarMedium: z.string().optional(),
+    avatarS640: z.string().optional(),
+    avatarSmall: z.string().optional(),
+    businessAccountId: z.string().nullable(),
+    dailyGoal: z.number().int(),
+    dateFormat: z.number().int(),
+    dateistLang: z.string().nullable(),
+    daysOff: z.array(z.number().int()),
+    featureIdentifier: z.string(),
+    features: FeaturesSchema,
+    freeTrailExpires: z.string().optional(),
+    hasMagicNumber: z.boolean(),
+    hasPassword: z.boolean(),
+    hasStartedATrial: z.boolean().optional(),
+    imageId: z.string().nullable(),
+    inboxProjectId: z.string(),
+    isCelebrationsEnabled: z.boolean(),
+    isPremium: z.boolean(),
+    joinableWorkspace: JoinableWorkspaceSchema.nullable(),
+    joinedAt: z.string(),
+    gettingStartedGuideProjects: z.array(GettingStartedGuideProjectSchema).nullable(),
+    karma: z.number(),
+    karmaTrend: z.string(),
+    lang: z.string(),
+    mfaEnabled: z.boolean().optional(),
+    mobileHost: z.string().nullable(),
+    mobileNumber: z.string().nullable(),
+    nextWeek: z.number().int(),
+    onboardingLevel: z.string().nullable().optional(),
+    onboardingRole: z.string().nullable().optional(),
+    onboardingPersona: z.string().nullable().optional(),
+    onboardingInitiated: z.boolean().nullable().optional(),
+    onboardingCompleted: z.boolean().nullable().optional(),
+    onboardingSkipped: z.boolean().optional(),
+    onboardingTeamMode: z.boolean().nullable().optional(),
+    onboardingUseCases: z.array(z.string()).nullable().optional(),
+    premiumStatus: z.enum([
+        'not_premium',
+        'current_personal_plan',
+        'legacy_personal_plan',
+        'teams_business_member',
+    ]),
+    premiumUntil: z.string().nullable(),
+    rambleSessionsUsage: z
+        .object({
+        currentCount: z.number().int(),
+        limit: z.number().int(),
+        remaining: z.number().int(),
+        resetDate: z.string(),
+    })
+        .nullable()
+        .optional(),
+    shareLimit: z.number().int(),
+    sortOrder: z.number().int(),
+    startDay: z.number().int(),
+    startPage: z.string(),
+    themeId: z.string(),
+    timeFormat: z.number().int(),
+    token: z.string(),
+    tzInfo: TzInfoSchema,
+    uniquePrefix: z.number().int(),
+    verificationStatus: z.string(),
+    websocketUrl: z.string(),
+    weekendStartDay: z.number().int(),
+    weeklyGoal: z.number().int(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/view-options.js

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+const ViewTypeSchema = z.enum([
+    'TODAY',
+    'UPCOMING',
+    'PROJECT',
+    'LABEL',
+    'FILTER',
+    'WORKSPACE_FILTER',
+    'SEARCH',
+    'TEMPLATE_PREVIEW',
+    'TASK_DETAIL',
+    'AUTOMATION',
+    'ASSIGNED',
+    'OVERDUE',
+    'WORKSPACE_OVERVIEW',
+]);
+const ViewModeSchema = z.enum(['LIST', 'BOARD', 'CALENDAR']);
+const GroupedBySchema = z
+    .enum([
+    'ASSIGNEE',
+    'ADDED_DATE',
+    'DUE_DATE',
+    'DEADLINE',
+    'LABEL',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+])
+    .nullable();
+const SortedBySchema = z
+    .enum([
+    'MANUAL',
+    'ALPHABETICALLY',
+    'ASSIGNEE',
+    'DUE_DATE',
+    'DEADLINE',
+    'ADDED_DATE',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+])
+    .nullable();
+const SortOrderSchema = z.enum(['ASC', 'DESC']).nullable();
+const CalendarSettingsSchema = z
+    .object({
+    layout: z.enum(['WEEK', 'MONTH']).optional(),
+})
+    .passthrough();
+export const ViewOptionsSchema = z
+    .object({
+    viewType: ViewTypeSchema,
+    objectId: z.string().optional(),
+    groupedBy: GroupedBySchema.optional(),
+    filteredBy: z.string().nullable().optional(),
+    viewMode: ViewModeSchema.optional(),
+    showCompletedTasks: z.boolean().optional(),
+    sortedBy: SortedBySchema.optional(),
+    sortOrder: SortOrderSchema.optional(),
+})
+    .passthrough();
+export const ProjectViewOptionsDefaultsSchema = z
+    .object({
+    projectId: z.string(),
+    viewMode: ViewModeSchema.nullable().optional(),
+    groupedBy: GroupedBySchema.optional(),
+    sortedBy: SortedBySchema.optional(),
+    sortOrder: SortOrderSchema.optional(),
+    showCompletedTasks: z.boolean().optional(),
+    filteredBy: z.string().nullable().optional(),
+    calendarSettings: CalendarSettingsSchema.nullable().optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/workspace-filters.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export const WorkspaceFilterSchema = z
+    .object({
+    id: z.string(),
+    workspaceId: z.string(),
+    name: z.string(),
+    query: z.string(),
+    color: z.string(),
+    itemOrder: z.number().int(),
+    isDeleted: z.boolean(),
+    isFavorite: z.boolean(),
+    isFrozen: z.boolean(),
+    creatorUid: z.string(),
+    updaterUid: z.string(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/workspace-goals.js

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export const WorkspaceGoalMilestoneSchema = z
+    .object({
+    id: z.string(),
+    title: z.string(),
+    isCompleted: z.boolean(),
+})
+    .passthrough();
+export const WorkspaceGoalProgressSchema = z
+    .object({
+    completedItems: z.number().int(),
+    totalItems: z.number().int(),
+})
+    .passthrough();
+export const WorkspaceGoalSchema = z
+    .object({
+    id: z.string(),
+    workspaceId: z.string(),
+    title: z.string(),
+    description: z.string().nullable(),
+    deadline: z.string().nullable(),
+    isDeleted: z.boolean(),
+    projectIds: z.array(z.string()),
+    progress: WorkspaceGoalProgressSchema.nullable(),
+    creatorUid: z.string(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+})
+    .passthrough();

package/dist/esm/types/sync/resources/workspaces.js

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, WorkspacePropertiesSchema, } from '../../entities.js';
+/**
+ * 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 const SyncWorkspaceSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    description: z.string(),
+    logoBig: z.string().optional(),
+    logoMedium: z.string().optional(),
+    logoSmall: z.string().optional(),
+    logoS640: z.string().optional(),
+    creatorId: z.string(),
+    createdAt: z.string(),
+    isDeleted: z.boolean(),
+    isCollapsed: z.boolean(),
+    role: WorkspaceRoleSchema,
+    plan: WorkspacePlanSchema,
+    limits: WorkspaceLimitsSchema,
+    inviteCode: z.string().nullable().optional(),
+    isLinkSharingEnabled: z.boolean().nullable().optional(),
+    isGuestAllowed: z.boolean().nullable().optional(),
+    currentActiveProjects: z.number().nullable(),
+    currentMemberCount: z.number().nullable(),
+    currentTemplateCount: z.number().nullable(),
+    pendingInvitations: z.array(z.string()).nullable().optional(),
+    domainName: z.string().optional(),
+    domainDiscovery: z.boolean().optional(),
+    restrictEmailDomains: z.boolean().optional(),
+    adminSortingApplied: z.boolean(),
+    projectSortPreference: z.string().optional(),
+    defaultCollaborators: z
+        .object({
+        predefinedGroupIds: z.array(z.string()),
+        userIds: z.array(z.number()),
+    })
+        .optional(),
+    properties: WorkspacePropertiesSchema.optional(),
+})
+    .passthrough();

package/dist/esm/types/sync/response.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/utils/index.js

@@ -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/esm/utils/sync-helpers.js

@@ -0,0 +1,19 @@
+import { v4 as uuidv4 } from 'uuid';
+/**
+ * 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 function createCommand(type, args, tempId) {
+    return Object.assign({ type, uuid: uuidv4(), args: args }, (tempId !== undefined ? { tempId } : {}));
+}