@doist/todoist-api-typescript 7.9.1 → 7.10.0

package/dist/esm/types/insights/types.js

@@ -1,81 +0,0 @@
-import { z } from 'zod';
-export const DayActivitySchema = z.object({
-    date: z.string(),
-    totalCount: z.number().int(),
-});
-export const WeekRollupSchema = z.object({
-    fromDate: z.string(),
-    toDate: z.string(),
-    totalCount: z.number().int(),
-});
-export const ProjectActivityStatsSchema = z.object({
-    dayItems: z.array(DayActivitySchema),
-    weekItems: z.array(WeekRollupSchema).nullable(),
-});
-/** Available project health statuses. */
-export const HEALTH_STATUSES = [
-    'UNKNOWN',
-    'ON_TRACK',
-    'AT_RISK',
-    'CRITICAL',
-    'EXCELLENT',
-    'ERROR',
-];
-export const TaskRecommendationSchema = z.object({
-    taskId: z.string(),
-    recommendation: z.string(),
-});
-export const ProjectHealthSchema = z.object({
-    status: z.enum(HEALTH_STATUSES),
-    description: z.string().nullable().optional(),
-    descriptionSummary: z.string().nullable().optional(),
-    taskRecommendations: z.array(TaskRecommendationSchema).nullable().optional(),
-    projectId: z.string().nullable().optional(),
-    updatedAt: z.string().nullable().optional(),
-    isStale: z.boolean().default(false),
-    updateInProgress: z.boolean().default(false),
-});
-export const ProjectMetricsSchema = z.object({
-    totalTasks: z.number().int(),
-    completedTasks: z.number().int(),
-    overdueTasks: z.number().int(),
-    tasksCreatedThisWeek: z.number().int(),
-    tasksCompletedThisWeek: z.number().int(),
-    averageCompletionTime: z.number().nullable(),
-});
-export const TaskContextSchema = z.object({
-    id: z.string(),
-    content: z.string(),
-    due: z.string().nullable().optional(),
-    deadline: z.string().nullable().optional(),
-    priority: z.string(),
-    isCompleted: z.boolean(),
-    createdAt: z.string(),
-    updatedAt: z.string(),
-    completedAt: z.string().nullable(),
-    completedByUid: z.string().nullable(),
-    labels: z.array(z.string()),
-});
-export const ProjectHealthContextSchema = z.object({
-    projectId: z.string(),
-    projectName: z.string(),
-    projectDescription: z.string().nullable(),
-    projectMetrics: ProjectMetricsSchema,
-    tasks: z.array(TaskContextSchema),
-    language: z.string().nullable().optional(),
-});
-export const ProjectProgressSchema = z.object({
-    projectId: z.string(),
-    completedCount: z.number().int(),
-    activeCount: z.number().int(),
-    progressPercent: z.number().int(),
-});
-export const ProjectInsightSchema = z.object({
-    projectId: z.string(),
-    health: ProjectHealthSchema.nullable(),
-    progress: ProjectProgressSchema.nullable(),
-});
-export const WorkspaceInsightsSchema = z.object({
-    folderId: z.string().nullable(),
-    projectInsights: z.array(ProjectInsightSchema),
-});

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

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

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

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

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

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-export const LabelSchema = z.object({
-    id: z.string(),
-    order: z.number().int().nullable(),
-    name: z.string(),
-    color: z.string(),
-    isFavorite: z.boolean(),
-});

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

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

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

@@ -1,64 +0,0 @@
-import { z } from 'zod';
-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(z.number()),
-        karmaDisabled: z.number(),
-        lastDailyStreak: StreakSchema,
-        lastWeeklyStreak: StreakSchema,
-        maxDailyStreak: StreakSchema,
-        maxWeeklyStreak: StreakSchema,
-        user: z.string(),
-        userId: z.string(),
-        vacationMode: z.number(),
-        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

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

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

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

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

@@ -1,53 +0,0 @@
-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(),
-    color: z.string(),
-    createdAt: z.string().nullable(),
-    isArchived: z.boolean(),
-    isDeleted: z.boolean(),
-    isFavorite: z.boolean(),
-    isFrozen: z.boolean(),
-    name: z.string(),
-    updatedAt: z.string().nullable(),
-    viewStyle: z.string(),
-    defaultOrder: z.number().int(),
-    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) });
-});
-/** Available project view styles. */
-export const PROJECT_VIEW_STYLES = ['list', 'board', 'calendar'];

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

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

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

@@ -1,92 +0,0 @@
-import { z } from 'zod';
-import { DueDateSchema } from '../tasks/types.js';
-import { LOCATION_TRIGGERS, ReminderTypeEnum } from '../sync/resources/reminders.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

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

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

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

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

@@ -1,19 +0,0 @@
-import { z } from 'zod';
-import { getSectionUrl } from '../../utils/url-helpers.js';
-export const SectionSchema = z
-    .object({
-    id: z.string(),
-    userId: z.string(),
-    projectId: z.string(),
-    addedAt: z.string(),
-    updatedAt: z.string(),
-    archivedAt: z.string().nullable(),
-    name: z.string(),
-    sectionOrder: z.number().int(),
-    isArchived: z.boolean(),
-    isDeleted: z.boolean(),
-    isCollapsed: z.boolean(),
-})
-    .transform((data) => {
-    return Object.assign(Object.assign({}, data), { url: getSectionUrl(data.id, data.name) });
-});

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

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

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

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

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

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

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

@@ -1,19 +0,0 @@
-// 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 './workspace-goals.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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,16 +0,0 @@
-/**
- * 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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,6 +0,0 @@
-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

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

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

@@ -1,37 +0,0 @@
-/**
- * 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',
-    'workspace_goals',
-    'day_orders',
-    'calendars',
-    'calendar_accounts',
-    'suggestions',
-    'tooltips',
-];

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

@@ -1,28 +0,0 @@
-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();
-/** 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
-    .object({
-    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(),
-})
-    .passthrough();

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

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

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

@@ -1,27 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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(),
-    fromUser: z
-        .object({
-        email: z.string(),
-        fullName: z.string(),
-        id: z.string(),
-        imageId: z.string().nullable(),
-    })
-        .optional(),
-    projectName: z.string().optional(),
-    isDeleted: z.boolean().optional(),
-    invitationSecret: z.string().optional(),
-})
-    .passthrough();