@doist/todoist-api-typescript 7.5.0 → 7.6.1

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

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

package/dist/esm/types/comments/types.js

@@ -0,0 +1,57 @@
+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';
+/** Available file attachment upload states. */
+export const UPLOAD_STATES = ['pending', 'completed'];
+export const AttachmentSchema = z
+    .object({
+    resourceType: z.string(),
+})
+    .extend({
+    fileName: z.string().nullable().optional(),
+    fileSize: z.number().int().nullable().optional(),
+    fileType: z.string().nullable().optional(),
+    fileUrl: z.string().nullable().optional(),
+    fileDuration: z.number().int().nullable().optional(),
+    uploadState: z.enum(UPLOAD_STATES).nullable().optional(),
+    image: z.string().nullable().optional(),
+    imageWidth: z.number().int().nullable().optional(),
+    imageHeight: z.number().int().nullable().optional(),
+    url: z.string().nullable().optional(),
+    title: z.string().nullable().optional(),
+});
+export const RawCommentSchema = 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(),
+})
+    .refine((data) => {
+    // At least one of itemId or projectId must be present
+    return ((data.itemId !== undefined && data.projectId === undefined) ||
+        (data.itemId === undefined && data.projectId !== undefined));
+}, {
+    message: 'Exactly one of itemId or projectId must be provided',
+});
+export const CommentSchema = RawCommentSchema.transform((data) => {
+    const { itemId } = data, rest = __rest(data, ["itemId"]);
+    return Object.assign(Object.assign({}, rest), { 
+        // Map itemId to taskId for backwards compatibility
+        taskId: itemId });
+});

package/dist/esm/types/common.js

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

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

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

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

@@ -0,0 +1,2 @@
+/** Object types that support email forwarding. */
+export const EMAIL_OBJECT_TYPES = ['project', 'project_comments', 'task'];

package/dist/esm/types/id-mappings/index.js

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

package/dist/esm/types/id-mappings/requests.js

@@ -0,0 +1,17 @@
+/** Object types that support ID mappings. */
+export const ID_MAPPING_OBJECT_TYPES = [
+    'sections',
+    'tasks',
+    'comments',
+    'reminders',
+    'location_reminders',
+    'projects',
+];
+/** Object types that support moved ID lookups. */
+export const MOVED_ID_OBJECT_TYPES = [
+    'sections',
+    'tasks',
+    'comments',
+    'reminders',
+    'location_reminders',
+];

package/dist/esm/types/id-mappings/types.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export const IdMappingSchema = z.object({
+    oldId: z.string().nullable(),
+    newId: z.string().nullable(),
+});
+export const MovedIdSchema = z.object({
+    oldId: z.string(),
+    newId: z.string(),
+});

package/dist/esm/types/index.js

@@ -1,5 +1,19 @@
-export * from './entities.js';
+export * from './tasks/index.js';
+export * from './projects/index.js';
+export * from './sections/index.js';
+export * from './labels/index.js';
+export * from './comments/index.js';
+export * from './reminders/index.js';
+export * from './users/index.js';
+export * from './productivity/index.js';
+export * from './activity/index.js';
+export * from './workspaces/index.js';
+export * from './insights/index.js';
+export * from './backups/index.js';
+export * from './id-mappings/index.js';
+export * from './emails/index.js';
+export * from './uploads/index.js';
+export * from './templates/index.js';
 export * from './errors.js';
-export * from './requests.js';
 export * from './http.js';
 export * from './sync/index.js';

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -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,53 @@
+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

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

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,19 @@
+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/shared.js

@@ -9,7 +9,7 @@ export const PROJECT_STATUSES = [
     'COMPLETED',
     'CANCELED',
 ];
-export { COLLABORATOR_ROLES } from '../../entities.js';
+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. */

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { WorkspaceRoleSchema } from '../../entities.js';
+import { WorkspaceRoleSchema } from '../../workspaces/types.js';
 export const CollaboratorSchema = z
     .object({
     id: z.string(),

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AttachmentSchema } from '../../entities.js';
+import { AttachmentSchema } from '../../comments/types.js';
 /**
  * Sync API note (comment) resource.
  * Separate from the REST `CommentSchema` which transforms `itemId` to `taskId`.

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { DueDateSchema } from '../../entities.js';
+import { DueDateSchema } from '../../tasks/types.js';
 export const ReminderBaseSchema = z.object({
     id: z.string(),
     notifyUid: z.string(),

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { PREMIUM_STATUSES } from '../../entities.js';
+import { PREMIUM_STATUSES } from '../../users/types.js';
 import { BooleanFromZeroOneSchema, DateFormatSchema, DayOfWeekSchema, TimeFormatSchema, } from '../user-preferences.js';
 export const FeaturesSchema = z
     .object({

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, WorkspacePropertiesSchema, } from '../../entities.js';
+import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, WorkspacePropertiesSchema, } from '../../workspaces/types.js';
 /**
  * Sync API workspace resource.
  *

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';

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

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+export const UserSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.string(),
+});
+export const TimezoneInfoSchema = z.object({
+    gmtString: z.string(),
+    hours: z.number().int(),
+    isDst: z.number().int(),
+    minutes: z.number().int(),
+    timezone: z.string(),
+});
+/** Available user premium statuses. */
+export const PREMIUM_STATUSES = [
+    'not_premium',
+    'current_personal_plan',
+    'legacy_personal_plan',
+    'teams_business_member',
+];
+export const CurrentUserSchema = z.object({
+    id: z.string(),
+    email: z.string(),
+    fullName: z.string(),
+    avatarBig: z.string().nullish(),
+    avatarMedium: z.string().nullish(),
+    avatarS640: z.string().nullish(),
+    avatarSmall: z.string().nullish(),
+    businessAccountId: z.string().nullable(),
+    isPremium: z.boolean(),
+    premiumStatus: z.enum(PREMIUM_STATUSES),
+    dateFormat: z.number().int(),
+    timeFormat: z.number().int(),
+    weeklyGoal: z.number().int(),
+    dailyGoal: z.number().int(),
+    completedCount: z.number().int(),
+    completedToday: z.number().int(),
+    karma: z.number(),
+    karmaTrend: z.string(),
+    lang: z.string(),
+    nextWeek: z.number().int(),
+    startDay: z.number().int(),
+    startPage: z.string(),
+    tzInfo: TimezoneInfoSchema,
+    inboxProjectId: z.string(),
+    daysOff: z.array(z.number().int()),
+    weekendStartDay: z.number().int(),
+});

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

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

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

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