@doist/todoist-sdk 0.0.1 → 8.0.0

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

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { AttachmentSchema } from '../../comments/types.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,47 @@
+import { z } from 'zod';
+import { DueDateSchema } from '../../tasks/types.js';
+export const ReminderBaseSchema = z.object({
+    id: z.string(),
+    notifyUid: z.string(),
+    itemId: z.string(),
+    projectId: z.string().optional(),
+    isDeleted: z.boolean(),
+});
+/** Enum-like object of reminder type values. */
+export const ReminderTypeEnum = {
+    Relative: 'relative',
+    Absolute: 'absolute',
+    Location: 'location',
+};
+/** Available reminder types. */
+export const REMINDER_TYPES = [
+    ReminderTypeEnum.Relative,
+    ReminderTypeEnum.Absolute,
+    ReminderTypeEnum.Location,
+];
+/** Available location reminder triggers. */
+export const LOCATION_TRIGGERS = ['on_enter', 'on_leave'];
+export const LocationReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal(ReminderTypeEnum.Location),
+    name: z.string(),
+    locLat: z.string(),
+    locLong: z.string(),
+    locTrigger: z.enum(LOCATION_TRIGGERS),
+    radius: z.number().int(),
+}).passthrough();
+export const AbsoluteReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal(ReminderTypeEnum.Absolute),
+    due: DueDateSchema,
+    isUrgent: z.boolean().optional(),
+}).passthrough();
+export const RelativeReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal(ReminderTypeEnum.Relative),
+    minuteOffset: z.number().int(),
+    due: DueDateSchema.optional(),
+    isUrgent: z.boolean().optional(),
+}).passthrough();
+export const ReminderSchema = z.discriminatedUnion('type', [
+    LocationReminderSchema,
+    AbsoluteReminderSchema,
+    RelativeReminderSchema,
+]);

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+/** Available template types. */
+export const TEMPLATE_TYPES = ['project', 'setup'];
+export const TemplateSuggestionSchema = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    templateType: z.enum(TEMPLATE_TYPES),
+})
+    .passthrough();
+export const WorkspaceTemplateSuggestionSchema = TemplateSuggestionSchema.extend({
+    workspaceId: z.string().nullable(),
+});
+/** Available suggestion section types. */
+export const SUGGESTION_SECTION_TYPES = ['templates', 'most_used_user_templates'];
+export const SyncTemplateSuggestionsSchema = z
+    .object({
+    type: z.enum(SUGGESTION_SECTION_TYPES),
+    content: z.object({
+        templates: z.array(TemplateSuggestionSchema),
+        locale: z.string(),
+    }),
+    isDeleted: z.boolean(),
+})
+    .passthrough();
+export 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';
+export const NavigationFeatureSchema = z.object({
+    name: z.string(),
+    shown: z.boolean(),
+});
+export 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,117 @@
+import { z } from 'zod';
+import { PREMIUM_STATUSES } from '../../users/types.js';
+import { BooleanFromZeroOneSchema, DateFormatSchema, DayOfWeekSchema, TimeFormatSchema, } from '../user-preferences.js';
+export const FeaturesSchema = z
+    .object({
+    karmaDisabled: z.boolean(),
+    restriction: z.number().int(),
+    karmaVacation: z.boolean(),
+    dateistLang: z.any(),
+    beta: BooleanFromZeroOneSchema,
+    hasPushReminders: z.boolean(),
+    dateistInlineDisabled: z.boolean(),
+    autoInviteDisabled: z.boolean().optional(),
+    goldTheme: z.boolean().optional(),
+    migratedFromTdb: z.boolean().optional(),
+})
+    .passthrough();
+export const TzInfoSchema = z
+    .object({
+    timezone: z.string(),
+    hours: z.number().int(),
+    minutes: z.number().int(),
+    isDst: BooleanFromZeroOneSchema,
+    gmtString: z.string(),
+})
+    .passthrough();
+export const JoinableWorkspaceSchema = z
+    .object({
+    workspaceId: z.string(),
+    workspaceName: z.string(),
+    memberCount: z.number().int(),
+})
+    .passthrough();
+export 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: DateFormatSchema,
+    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: DayOfWeekSchema,
+    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(PREMIUM_STATUSES),
+    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: DayOfWeekSchema,
+    startPage: z.string(),
+    themeId: z.string(),
+    timeFormat: TimeFormatSchema,
+    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,80 @@
+import { z } from 'zod';
+/** Available view types. */
+export const VIEW_TYPES = [
+    'TODAY',
+    'UPCOMING',
+    'PROJECT',
+    'LABEL',
+    'FILTER',
+    'WORKSPACE_FILTER',
+    'SEARCH',
+    'TEMPLATE_PREVIEW',
+    'TASK_DETAIL',
+    'AUTOMATION',
+    'ASSIGNED',
+    'OVERDUE',
+    'WORKSPACE_OVERVIEW',
+];
+export const ViewTypeSchema = z.enum(VIEW_TYPES);
+/** Available view modes. */
+export const VIEW_MODES = ['LIST', 'BOARD', 'CALENDAR'];
+export const ViewModeSchema = z.enum(VIEW_MODES);
+/** Available grouping options. */
+export const GROUPED_BY_OPTIONS = [
+    'ASSIGNEE',
+    'ADDED_DATE',
+    'DUE_DATE',
+    'DEADLINE',
+    'LABEL',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+];
+export const GroupedBySchema = z.enum(GROUPED_BY_OPTIONS).nullable();
+/** Available sorting options. */
+export const SORTED_BY_OPTIONS = [
+    'MANUAL',
+    'ALPHABETICALLY',
+    'ASSIGNEE',
+    'DUE_DATE',
+    'DEADLINE',
+    'ADDED_DATE',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+];
+export const SortedBySchema = z.enum(SORTED_BY_OPTIONS).nullable();
+/** Available sort directions. */
+export const SORT_ORDERS = ['ASC', 'DESC'];
+export const SortOrderSchema = z.enum(SORT_ORDERS).nullable();
+/** Available calendar layout modes. */
+export const CALENDAR_LAYOUTS = ['WEEK', 'MONTH'];
+export const CalendarSettingsSchema = z
+    .object({
+    layout: z.enum(CALENDAR_LAYOUTS).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,70 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { z } from 'zod';
+import { StringOrNumberSchema } from '../../common.js';
+import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, WorkspacePropertiesSchema, } from '../../workspaces/types.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: StringOrNumberSchema,
+    name: z.string(),
+    description: z.string(),
+    logoBig: z.string().optional(),
+    logoMedium: z.string().optional(),
+    logoSmall: z.string().optional(),
+    logoS640: z.string().optional(),
+    creatorId: StringOrNumberSchema,
+    createdAt: z.string().optional(),
+    dateCreated: z.string().optional(),
+    isDeleted: z.boolean(),
+    isCollapsed: z.boolean(),
+    role: WorkspaceRoleSchema.optional(),
+    plan: WorkspacePlanSchema,
+    limits: WorkspaceLimitsSchema.optional(),
+    inviteCode: z.string().nullable().optional(),
+    isLinkSharingEnabled: z.boolean().nullable().optional(),
+    isGuestAllowed: z.boolean().nullable().optional(),
+    currentActiveProjects: z.number().nullable(),
+    currentMemberCount: z.number().nullable(),
+    memberCountByType: z
+        .object({
+        adminCount: z.number().int(),
+        guestCount: z.number().int(),
+        memberCount: z.number().int(),
+    })
+        .optional(),
+    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()
+    .transform((_a) => {
+    var { dateCreated, createdAt } = _a, rest = __rest(_a, ["dateCreated", "createdAt"]);
+    return (Object.assign(Object.assign({}, rest), { createdAt: createdAt !== null && createdAt !== void 0 ? createdAt : dateCreated }));
+});

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

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

package/dist/esm/types/sync/user-preferences.js

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+/** Available date format options. */
+export const DATE_FORMATS = ['DD/MM/YYYY', 'MM/DD/YYYY'];
+/** Available time format options. */
+export const TIME_FORMATS = ['24h', '12h'];
+/** Available days of the week. */
+export const DAYS_OF_WEEK = [
+    'Monday',
+    'Tuesday',
+    'Wednesday',
+    'Thursday',
+    'Friday',
+    'Saturday',
+    'Sunday',
+];
+export const DATE_FORMAT_FROM_API = {
+    0: 'DD/MM/YYYY',
+    1: 'MM/DD/YYYY',
+};
+export const TIME_FORMAT_FROM_API = {
+    0: '24h',
+    1: '12h',
+};
+export const DAY_OF_WEEK_FROM_API = {
+    1: 'Monday',
+    2: 'Tuesday',
+    3: 'Wednesday',
+    4: 'Thursday',
+    5: 'Friday',
+    6: 'Saturday',
+    7: 'Sunday',
+};
+export const DATE_FORMAT_TO_API = {
+    'DD/MM/YYYY': 0,
+    'MM/DD/YYYY': 1,
+};
+export const TIME_FORMAT_TO_API = { '24h': 0, '12h': 1 };
+export const DAY_OF_WEEK_TO_API = {
+    Monday: 1,
+    Tuesday: 2,
+    Wednesday: 3,
+    Thursday: 4,
+    Friday: 5,
+    Saturday: 6,
+    Sunday: 7,
+};
+/** Zod read-schema: parse API 0/1 integer, emit boolean */
+export const BooleanFromZeroOneSchema = z
+    .union([z.literal(0), z.literal(1)])
+    .transform((v) => v === 1);
+/** Zod read-schemas: parse API numbers, emit descriptive strings */
+export const DateFormatSchema = z
+    .union([z.literal(0), z.literal(1)])
+    .transform((v) => DATE_FORMAT_FROM_API[v]);
+export const TimeFormatSchema = z
+    .union([z.literal(0), z.literal(1)])
+    .transform((v) => TIME_FORMAT_FROM_API[v]);
+export const DayOfWeekSchema = z
+    .union([
+    z.literal(1),
+    z.literal(2),
+    z.literal(3),
+    z.literal(4),
+    z.literal(5),
+    z.literal(6),
+    z.literal(7),
+])
+    .transform((v) => DAY_OF_WEEK_FROM_API[v]);

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

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/esm/types/tasks/requests.js

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

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

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+import { getTaskUrl } from '../../utils/url-helpers.js';
+import { hasUncompletablePrefix } from '../../utils/uncompletable-helpers.js';
+export const DueDateSchema = z
+    .object({
+    isRecurring: z.boolean(),
+    string: z.string(),
+    date: z.string(),
+})
+    .extend({
+    datetime: z.string().nullable().optional(),
+    timezone: z.string().nullable().optional(),
+    lang: z.string().nullable().optional(),
+});
+/** Available duration units for task deadlines. */
+export const DURATION_UNITS = ['minute', 'day'];
+export const DurationSchema = z.object({
+    amount: z.number().positive('Value should be greater than zero'),
+    unit: z.enum(DURATION_UNITS),
+});
+export const DeadlineSchema = z.object({
+    date: z.string(),
+    lang: z.string(),
+});
+export const TaskSchema = z
+    .object({
+    id: z.string(),
+    userId: z.string(),
+    projectId: z.string(),
+    sectionId: z.string().nullable(),
+    parentId: z.string().nullable(),
+    addedByUid: z.string().nullable(),
+    assignedByUid: z.string().nullable(),
+    responsibleUid: z.string().nullable(),
+    labels: z.array(z.string()),
+    deadline: DeadlineSchema.nullable(),
+    duration: DurationSchema.nullable(),
+    checked: z.boolean(),
+    isDeleted: z.boolean(),
+    addedAt: z.string().nullable(),
+    completedAt: z.string().nullable(),
+    updatedAt: z.string().nullable(),
+    due: DueDateSchema.nullable(),
+    priority: z.number().int(),
+    childOrder: z.number().int(),
+    content: z.string(),
+    description: z.string(),
+    dayOrder: z.number().int(),
+    isCollapsed: z.boolean(),
+    isUncompletable: z.boolean().default(false),
+})
+    .transform((data) => {
+    // Auto-detect uncompletable status from content prefix
+    const isUncompletable = hasUncompletablePrefix(data.content);
+    return Object.assign(Object.assign({}, data), { isUncompletable, url: getTaskUrl(data.id, data.content) });
+});

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

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/esm/types/templates/requests.js

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

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

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/esm/types/uploads/requests.js

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

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

@@ -0,0 +1 @@
+export * from './types.js';