@todoist/sdk 0.0.1 → 19.0.0

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

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

package/dist/esm/types/productivity/types.js

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+import { BooleanFromZeroOneSchema, DayOfWeekSchema } from '../sync/user-preferences.js';
+export const StreakSchema = z.object({
+    count: z.number(),
+    start: z.string(),
+    end: z.string(),
+});
+export const CompletedItemSchema = z.object({
+    id: z.string(),
+    completed: z.number(),
+});
+export const ItemsWithDateSchema = z.object({
+    items: z.array(CompletedItemSchema),
+    totalCompleted: z.number(),
+});
+export const KarmaUpdateSchema = z.object({
+    time: z.string(),
+    newKarma: z.number(),
+    positiveKarma: z.number(),
+    negativeKarma: z.number(),
+    positiveKarmaReasons: z.array(z.any()),
+    negativeKarmaReasons: z.array(z.any()),
+});
+export const ProductivityStatsSchema = z.object({
+    completedCount: z.number(),
+    daysItems: z.array(ItemsWithDateSchema.extend({
+        date: z.string(),
+    })),
+    goals: z.object({
+        currentDailyStreak: StreakSchema,
+        currentWeeklyStreak: StreakSchema,
+        dailyGoal: z.number(),
+        ignoreDays: z.array(DayOfWeekSchema),
+        karmaDisabled: BooleanFromZeroOneSchema,
+        lastDailyStreak: StreakSchema,
+        lastWeeklyStreak: StreakSchema,
+        maxDailyStreak: StreakSchema,
+        maxWeeklyStreak: StreakSchema,
+        user: z.string(),
+        userId: z.string(),
+        vacationMode: BooleanFromZeroOneSchema,
+        weeklyGoal: z.number(),
+    }),
+    karma: z.number(),
+    karmaGraphData: z.array(z.object({
+        date: z.string(),
+        karmaAvg: z.number(),
+    })),
+    karmaLastUpdate: z.number(),
+    karmaTrend: z.string(),
+    karmaUpdateReasons: z.array(KarmaUpdateSchema),
+    projectColors: z.record(z.string(), z.string()),
+    weekItems: z.array(ItemsWithDateSchema.extend({
+        from: z.string(),
+        to: z.string(),
+    })),
+});
+export const ColorSchema = z.object({
+    /** The key of the color (i.e. 'berry_red') */
+    key: z.string(),
+    /** The display name of the color (i.e. 'Berry Red') */
+    displayName: z.string(),
+    /** The hex value of the color (i.e. '#b8255f') */
+    hexValue: z.string(),
+});

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

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

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

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

package/dist/esm/types/projects/types.js

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+import { getProjectUrl } from '../../utils/url-helpers.js';
+/**
+ * Base schema for all project types in Todoist.
+ * Contains common fields shared between personal and workspace projects.
+ */
+export const BaseProjectSchema = z.object({
+    id: z.string(),
+    canAssignTasks: z.boolean(),
+    childOrder: z.number().int(),
+    orderKey: z.string().nullable().optional(),
+    color: z.string(),
+    createdAt: z.coerce.date().nullable(),
+    isArchived: z.boolean(),
+    isDeleted: z.boolean(),
+    isFavorite: z.boolean(),
+    isFrozen: z.boolean(),
+    name: z.string(),
+    updatedAt: z.coerce.date().nullable(),
+    viewStyle: z.string(),
+    defaultOrder: z.number().int(),
+    defaultOrderKey: z.string().nullable().optional(),
+    description: z.string(),
+    isCollapsed: z.boolean(),
+    isShared: z.boolean(),
+});
+/**
+ * Schema for personal projects in Todoist.
+ */
+export const PersonalProjectSchema = BaseProjectSchema.extend({
+    parentId: z.string().nullable(),
+    inboxProject: z.boolean().optional().default(false),
+}).transform((data) => {
+    return Object.assign(Object.assign({}, data), { url: getProjectUrl(data.id, data.name) });
+});
+/** Available project visibility levels. */
+export const PROJECT_VISIBILITIES = ['restricted', 'team', 'public'];
+export const ProjectVisibilitySchema = z.enum(PROJECT_VISIBILITIES);
+/**
+ * Schema for workspace projects in Todoist.
+ */
+export const WorkspaceProjectSchema = BaseProjectSchema.extend({
+    access: z.object({ visibility: ProjectVisibilitySchema }).optional(),
+    collaboratorRoleDefault: z.string(),
+    folderId: z.string().nullable(),
+    isInviteOnly: z.boolean().nullable(),
+    isLinkSharingEnabled: z.boolean(),
+    role: z.string().nullable(),
+    status: z.string(),
+    workspaceId: z.string(),
+}).transform((data) => {
+    return Object.assign(Object.assign({}, data), { url: getProjectUrl(data.id, data.name) });
+});
+/**
+ * Schema for any project type in Todoist (personal or workspace).
+ * Dispatches to WorkspaceProjectSchema when workspaceId is present, PersonalProjectSchema otherwise.
+ */
+export const ProjectSchema = z.unknown().transform((val) => {
+    if (typeof val === 'object' && val !== null && 'workspaceId' in val) {
+        return WorkspaceProjectSchema.parse(val);
+    }
+    return PersonalProjectSchema.parse(val);
+});
+/** Available project view styles. */
+export const PROJECT_VIEW_STYLES = ['list', 'board', 'calendar', 'table'];

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

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

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

@@ -0,0 +1,92 @@
+import { z } from 'zod';
+import { LOCATION_TRIGGERS, ReminderTypeEnum } from '../sync/resources/reminders.js';
+import { DueDateSchema } from '../tasks/types.js';
+/** Available reminder delivery services. */
+export const REMINDER_DELIVERY_SERVICES = ['email', 'push'];
+export const ReminderDeliveryServiceSchema = z.enum(REMINDER_DELIVERY_SERVICES);
+export const ReminderIdSchema = z.string();
+export const ReminderDueDateSchema = DueDateSchema.pick({
+    date: true,
+    string: true,
+    timezone: true,
+    lang: true,
+    isRecurring: true,
+})
+    .partial()
+    .strict();
+// ── Add schemas ──────────────────────────────────────────────────────
+export const AddRelativeReminderArgsSchema = z
+    .object({
+    taskId: z.string(),
+    reminderType: z.literal(ReminderTypeEnum.Relative).optional(),
+    minuteOffset: z.number().int(),
+    service: ReminderDeliveryServiceSchema.optional(),
+    notifyUid: z.string().optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+export const AddAbsoluteReminderArgsSchema = z
+    .object({
+    taskId: z.string(),
+    reminderType: z.literal(ReminderTypeEnum.Absolute),
+    due: ReminderDueDateSchema,
+    service: ReminderDeliveryServiceSchema.optional(),
+    notifyUid: z.string().optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+export const AddReminderArgsSchema = z.union([
+    AddRelativeReminderArgsSchema,
+    AddAbsoluteReminderArgsSchema,
+]);
+export const AddLocationReminderArgsSchema = z
+    .object({
+    taskId: z.string(),
+    notifyUid: z.string().optional(),
+    name: z.string(),
+    locLat: z.string(),
+    locLong: z.string(),
+    locTrigger: z.enum(LOCATION_TRIGGERS),
+    radius: z.number().int().optional(),
+})
+    .strict();
+// ── Update schemas ───────────────────────────────────────────────────
+export const UpdateRelativeReminderArgsSchema = z
+    .object({
+    reminderType: z.literal(ReminderTypeEnum.Relative),
+    minuteOffset: z.number().int().optional(),
+    notifyUid: z.string().optional(),
+    service: ReminderDeliveryServiceSchema.optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+export const UpdateAbsoluteReminderArgsSchema = z
+    .object({
+    reminderType: z.literal(ReminderTypeEnum.Absolute),
+    due: ReminderDueDateSchema.optional(),
+    notifyUid: z.string().optional(),
+    service: ReminderDeliveryServiceSchema.optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+export const UpdateReminderArgsSchema = z
+    .discriminatedUnion('reminderType', [
+    UpdateRelativeReminderArgsSchema,
+    UpdateAbsoluteReminderArgsSchema,
+])
+    .refine((args) => Object.entries(args).some(([key, value]) => key !== 'reminderType' && value !== undefined), {
+    message: 'At least one reminder field must be provided to updateReminder',
+});
+export const UpdateLocationReminderArgsSchema = z
+    .object({
+    notifyUid: z.string().optional(),
+    name: z.string().optional(),
+    locLat: z.string().optional(),
+    locLong: z.string().optional(),
+    locTrigger: z.enum(LOCATION_TRIGGERS).optional(),
+    radius: z.number().int().optional(),
+})
+    .strict()
+    .refine((args) => Object.values(args).some((value) => value !== undefined), {
+    message: 'At least one reminder field must be provided to updateLocationReminder',
+});

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

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

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

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

package/dist/esm/types/sections/types.js

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+import { getSectionUrl } from '../../utils/url-helpers.js';
+/**
+ * Raw section fields (the persisted shape). Exposed so schemas that extend
+ * or override a field — notably the webhook variant — can reuse the base
+ * without duplicating every field.
+ */
+export const SectionBaseSchema = z.object({
+    id: z.string(),
+    userId: z.string(),
+    projectId: z.string(),
+    addedAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+    archivedAt: z.coerce.date().nullable(),
+    name: z.string(),
+    description: z.string().nullable(),
+    sectionOrder: z.number().int(),
+    orderKey: z.string().nullable().optional(),
+    isArchived: z.boolean(),
+    isDeleted: z.boolean(),
+    isCollapsed: z.boolean(),
+});
+export const SectionSchema = SectionBaseSchema.transform((data) => (Object.assign(Object.assign({}, data), { url: getSectionUrl(data.id, data.name) })));

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

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

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

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

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

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

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

@@ -0,0 +1,18 @@
+// Re-export all domain types
+export * from './shared.js';
+export * from './tasks.js';
+export * from './projects.js';
+export * from './sections.js';
+export * from './labels.js';
+export * from './filters.js';
+export * from './notes.js';
+export * from './reminders.js';
+export * from './workspaces.js';
+export * from './folders.js';
+export * from './workspace-filters.js';
+export * from './notifications.js';
+export * from './sharing.js';
+export * from './view-options.js';
+export * from './project-view-options.js';
+export * from './calendars.js';
+export * from './others.js';

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

@@ -0,0 +1,2 @@
+/** Available label delete cascade modes. */
+export const LABEL_DELETE_CASCADE_MODES = ['none', 'all'];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Shared types used across multiple Sync API command argument types.
+ */
+/** Available project workflow statuses. */
+export const PROJECT_STATUSES = [
+    'PLANNED',
+    'IN_PROGRESS',
+    'PAUSED',
+    'COMPLETED',
+    'CANCELED',
+];
+export { COLLABORATOR_ROLES } from '../../workspaces/types.js';
+/** Available reminder notification services. */
+export const REMINDER_SERVICES = ['default', 'email', 'mobile', 'push', 'no_default'];
+/** Available workspace project sort orders. */
+export const WORKSPACE_PROJECT_SORT_ORDERS = ['MANUAL', 'A_TO_Z', 'Z_TO_A'];

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

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

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/workspaces.js

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

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

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

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

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

package/dist/esm/types/sync/resource-types.js

@@ -0,0 +1,36 @@
+/**
+ * All available Sync API resource types.
+ */
+export const SYNC_RESOURCE_TYPES = [
+    'labels',
+    'projects',
+    'items',
+    'notes',
+    'project_notes',
+    'sections',
+    'filters',
+    'reminders',
+    'reminders_location',
+    'locations',
+    'user',
+    'live_notifications',
+    'collaborators',
+    'collaborator_states',
+    'user_settings',
+    'notification_settings',
+    'user_plan_limits',
+    'completed_info',
+    'stats',
+    'workspaces',
+    'workspace_users',
+    'workspace_filters',
+    'view_options',
+    'project_view_options_defaults',
+    'role_actions',
+    'folders',
+    '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.looseObject({
+    id: z.string(),
+    summary: z.string(),
+    color: z.string().nullable(),
+    accountId: z.string(),
+    isVisible: z.boolean(),
+    isTaskCalendar: z.boolean().optional(),
+});
+/** Available calendar account provider types. */
+export const CALENDAR_ACCOUNT_TYPES = ['google', 'microsoft', 'apple'];
+/** Available calendar sync states. */
+export const CALENDAR_SYNC_STATES = ['synced', 'syncing', 'error'];
+export const CalendarAccountSchema = z.looseObject({
+    id: z.string(),
+    name: z.string(),
+    type: z.enum(CALENDAR_ACCOUNT_TYPES),
+    isDeleted: z.boolean().optional(),
+    isEventsEnabled: z.boolean().optional(),
+    isTasksEnabled: z.boolean().optional(),
+    isAllDayTasksEnabled: z.boolean().optional(),
+    pendingOperationUntil: z.string().nullable().optional(),
+    calendarsSyncState: z.enum(CALENDAR_SYNC_STATES).optional(),
+});

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

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { WorkspaceRoleSchema } from '../../workspaces/types.js';
+import { UserStatusSchema } from './user-status.js';
+export const CollaboratorSchema = z.looseObject({
+    id: z.string(),
+    email: z.string(),
+    fullName: z.string(),
+    timezone: z.string(),
+    imageId: z.string().nullable(),
+    /** The collaborator's shared status. Not related to {@link CollaboratorStatus}. */
+    status: UserStatusSchema.nullish(),
+});
+/** Available collaborator statuses. */
+export const COLLABORATOR_STATUSES = ['active', 'invited'];
+export const CollaboratorStateSchema = z.looseObject({
+    userId: z.string(),
+    projectId: z.string(),
+    state: z.enum(COLLABORATOR_STATUSES),
+    isDeleted: z.boolean(),
+    workspaceRole: WorkspaceRoleSchema.optional(),
+});

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

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

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

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

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

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

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

@@ -0,0 +1,18 @@
+export * from './filters.js';
+export * from './labels.js';
+export * from './collaborators.js';
+export * from './folders.js';
+export * from './tooltips.js';
+export * from './notes.js';
+export * from './workspace-filters.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 './user-status.js';
+export * from './suggestions.js';

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

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { LabelSchema } from '../../labels/types.js';
+/** A label returned by the Sync API. */
+export const SyncLabelSchema = LabelSchema.extend({
+    order: z.number().int().nullable().optional(),
+    isDeleted: z.boolean().optional(),
+});

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

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+import { StringOrNumberSchema } from '../../common.js';
+/**
+ * Live notification resource from the Sync API.
+ *
+ * Uses a loose object schema with commonly-present fields 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.looseObject({
+    id: z.string(),
+    createdAt: z.coerce.date(),
+    fromUid: z.string().optional(),
+    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().nullable().optional(),
+    assignedByUid: z.string().nullable().optional(),
+    fromUser: z
+        .object({
+        email: z.string(),
+        fullName: z.string(),
+        id: StringOrNumberSchema,
+        imageId: z.string().nullable(),
+    })
+        .optional(),
+    projectName: z.string().optional(),
+    isDeleted: z.boolean().optional(),
+    invitationSecret: z.string().optional(),
+});

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

@@ -0,0 +1,18 @@
+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.looseObject({
+    id: z.string(),
+    itemId: z.string().optional(),
+    projectId: z.string().optional(),
+    content: z.string(),
+    postedAt: z.coerce.date(),
+    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(),
+});

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

@@ -0,0 +1,58 @@
+import { z } from 'zod';
+import { DueDateSchema } from '../../tasks/types.js';
+export const ReminderBaseSchema = z.looseObject({
+    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(),
+});
+export const AbsoluteReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal(ReminderTypeEnum.Absolute),
+    due: DueDateSchema,
+    isUrgent: z.boolean().optional(),
+});
+export const RelativeReminderSchema = ReminderBaseSchema.extend({
+    type: z.literal(ReminderTypeEnum.Relative),
+    minuteOffset: z.number().int(),
+    due: DueDateSchema.optional(),
+    isUrgent: z.boolean().optional(),
+});
+export const ReminderSchema = z.discriminatedUnion('type', [
+    LocationReminderSchema,
+    AbsoluteReminderSchema,
+    RelativeReminderSchema,
+]);
+export const SyncAbsoluteReminderSchema = AbsoluteReminderSchema.extend({
+    due: DueDateSchema.nullable(),
+});
+export const SyncRelativeReminderSchema = RelativeReminderSchema.extend({
+    due: DueDateSchema.nullable().optional(),
+});
+export const SyncReminderSchema = z.discriminatedUnion('type', [
+    LocationReminderSchema,
+    SyncAbsoluteReminderSchema,
+    SyncRelativeReminderSchema,
+]);