export interface CreateTaskArgs {
content: string;
description?: string;
due_string?: string;
priority?: number;
labels?: string[];
deadline_date?: string;
project_id?: string;
section_id?: string;
parent_id?: string;
}
export interface GetTasksArgs {
task_id?: string;
project_id?: string;
filter?: string;
label_id?: string;
priority?: number;
limit?: number;
due_before?: string;
due_after?: string;
lang?: string;
task_name?: string;
}
export interface UpdateTaskArgs {
task_name?: string;
task_id?: string;
content?: string;
description?: string;
due_string?: string;
priority?: number;
project_id?: string;
section_id?: string;
labels?: string[];
}
export interface TaskNameArgs {
task_name?: string;
task_id?: string;
}
export interface GetSectionsArgs {
project_id?: string;
}
export interface CreateProjectArgs {
name: string;
color?: string;
is_favorite?: boolean;
}
export interface CreateSectionArgs {
name: string;
project_id: string;
order?: number;
}
export interface UpdateSectionArgs {
section_id?: string;
section_name?: string;
project_id?: string;
name?: string;
}
export interface SectionIdentifierArgs {
section_id?: string;
section_name?: string;
project_id?: string;
}
export interface TodoistTaskData {
content: string;
description?: string;
dueString?: string;
priority?: number;
labels?: string[];
deadlineDate?: string;
projectId?: string;
sectionId?: string;
}
export interface TodoistProjectData {
name: string;
color?: string;
isFavorite?: boolean;
}
export interface TodoistSectionData {
name: string;
projectId: string;
}
// API response interfaces for backward compatibility
export interface TodoistTaskDueData {
string: string;
date?: string | null;
datetime?: string | null;
timezone?: string | null;
lang?: string | null;
isRecurring?: boolean;
}
export interface TodoistTask {
id: string;
content: string;
description?: string;
due?: TodoistTaskDueData | null;
deadline?: { date: string } | null;
priority?: number;
labels?: string[];
projectId?: string;
sectionId?: string | null;
parentId?: string | null;
isCompleted?: boolean;
}
export interface TodoistProject {
id: string;
name: string;
color?: string;
isFavorite?: boolean;
}
export interface TodoistSection {
id: string;
name: string;
projectId: string;
}
// Bulk operation interfaces
export interface BulkCreateTasksArgs {
tasks: CreateTaskArgs[];
}
export interface BulkUpdateTasksArgs {
search_criteria: {
project_id?: string;
priority?: number;
due_before?: string;
due_after?: string;
content_contains?: string;
};
updates: {
content?: string;
description?: string;
due_string?: string;
priority?: number;
project_id?: string;
section_id?: string;
labels?: string[];
};
}
export interface BulkTaskFilterArgs {
search_criteria: {
project_id?: string;
priority?: number;
due_before?: string;
due_after?: string;
content_contains?: string;
};
}
// Comment operation interfaces
export interface CreateCommentArgs {
task_id?: string;
task_name?: string;
project_id?: string;
content: string;
attachment?: {
file_name: string;
file_url: string;
file_type: string;
};
}
export interface GetCommentsArgs {
task_id?: string;
task_name?: string;
project_id?: string;
}
export interface UpdateCommentArgs {
comment_id: string;
content: string;
}
export interface DeleteCommentArgs {
comment_id: string;
}
export interface TodoistCommentData {
content: string;
taskId?: string;
projectId?: string;
attachment?: {
fileName: string;
fileUrl: string;
fileType: string;
};
}
// API response interfaces for comments (using flexible typing for API compatibility)
export interface TodoistComment {
id?: string;
content?: string;
taskId?: string;
projectId?: string;
postedAt?: string;
attachment?: {
fileName?: string;
fileUrl?: string;
fileType?: string;
};
}
// Label operation interfaces
export interface TodoistLabel {
id: string;
name: string;
color?: string;
order?: number;
is_favorite?: boolean;
}
export interface CreateLabelArgs {
name: string;
color?: string;
is_favorite?: boolean;
order?: number;
}
export interface UpdateLabelArgs {
label_id?: string;
label_name?: string;
name?: string;
color?: string;
order?: number;
is_favorite?: boolean;
}
export interface LabelNameArgs {
label_id?: string;
label_name?: string;
}
export interface LabelStatistics {
label: string;
totalTasks: number;
completedTasks: number;
completionRate: number;
color?: string;
mostRecentUse: string | null;
}
// Proper API response interfaces to replace unknown types
/**
* Generic interface for Todoist API responses that may return data in different formats
*/
export interface TodoistAPIResponse<T> {
results?: T[];
data?: T[];
}
/**
* Specific API response types for each entity
*/
export type TasksResponse = TodoistTask[] | TodoistAPIResponse<TodoistTask>;
export type ProjectsResponse =
| TodoistProject[]
| TodoistAPIResponse<TodoistProject>;
export type SectionsResponse =
| TodoistSection[]
| TodoistAPIResponse<TodoistSection>;
export type CommentsResponse =
| TodoistComment[]
| TodoistAPIResponse<TodoistComment>;
export type LabelsResponse = TodoistLabel[] | TodoistAPIResponse<TodoistLabel>;
/**
* Enhanced comment response interface for API compatibility
*/
export interface CommentResponse {
content: string;
attachment?: {
fileName: string;
fileType: string;
};
postedAt?: string;
taskId?: string;
projectId?: string;
}
/**
* Enhanced comment creation data interface
*/
export interface CommentCreationData {
content: string;
taskId: string;
attachment?: {
fileName: string;
fileUrl: string;
fileType: string;
};
}
/**
* API error response interface for structured error handling
*/
export interface TodoistAPIErrorResponse {
error?: string;
error_description?: string;
error_code?: number;
message?: string;
}
/**
* Cache entry interface for typed cache storage
*/
export interface CacheEntry<T> {
data: T;
timestamp: number;
ttl: number;
}
/**
* Cache statistics interface for monitoring
*/
export interface CacheStats {
totalKeys: number;
hitCount: number;
missCount: number;
hitRate: number;
totalMemoryUsage: number;
}
// Subtask operation interfaces
export interface CreateSubtaskArgs {
parent_task_id?: string;
parent_task_name?: string;
content: string;
description?: string;
due_string?: string;
priority?: number;
labels?: string[];
deadline_date?: string;
}
export interface BulkCreateSubtasksArgs {
parent_task_id?: string;
parent_task_name?: string;
subtasks: {
content: string;
description?: string;
due_string?: string;
priority?: number;
labels?: string[];
deadline_date?: string;
}[];
}
export interface ConvertToSubtaskArgs {
task_id?: string;
task_name?: string;
parent_task_id?: string;
parent_task_name?: string;
}
export interface PromoteSubtaskArgs {
subtask_id?: string;
subtask_name?: string;
project_id?: string;
section_id?: string;
}
export interface GetTaskHierarchyArgs {
task_id?: string;
task_name?: string;
include_completed?: boolean;
}
export interface TaskNode {
task: TodoistTask;
children: TaskNode[];
depth: number;
completionPercentage: number;
isOriginalTask?: boolean;
}
export interface TaskHierarchy {
root: TaskNode;
totalTasks: number;
completedTasks: number;
overallCompletion: number;
originalTaskId?: string;
}
// Reminder operation interfaces (Phase 10: Reminder Management)
// Based on Todoist Sync API v1
/**
* Reminder types supported by Todoist
* - relative: Time-based reminder relative to task due date (uses minute_offset)
* - absolute: Time-based reminder at a specific date/time (uses due object)
* - location: Location-based reminder (uses location fields)
*/
export type ReminderType = "relative" | "absolute" | "location";
/**
* Location trigger types for location-based reminders
*/
export type LocationTrigger = "on_enter" | "on_leave";
/**
* Due date object for absolute reminders
*/
export interface ReminderDue {
date: string; // ISO 8601 format (e.g., "2024-10-15T11:00:00.000000Z")
timezone?: string;
}
/**
* Todoist Reminder object from the Sync API
*/
export interface TodoistReminder {
id: string;
notify_uid?: string;
item_id: string;
type: ReminderType;
due?: ReminderDue;
minute_offset?: number;
name?: string; // Location alias name
loc_lat?: string;
loc_long?: string;
loc_trigger?: LocationTrigger;
radius?: number;
is_deleted?: boolean;
}
/**
* Arguments for getting reminders
*/
export interface GetRemindersArgs {
task_id?: string;
task_name?: string;
}
/**
* Arguments for creating a reminder
*/
export interface CreateReminderArgs {
task_id?: string;
task_name?: string;
type: ReminderType;
// For relative reminders
minute_offset?: number;
// For absolute reminders
due_date?: string; // ISO 8601 format or natural language
timezone?: string;
// For location reminders
location_name?: string;
latitude?: string;
longitude?: string;
location_trigger?: LocationTrigger;
radius?: number;
}
/**
* Arguments for updating a reminder
*/
export interface UpdateReminderArgs {
reminder_id: string;
type?: ReminderType;
// For relative reminders
minute_offset?: number;
// For absolute reminders
due_date?: string;
timezone?: string;
// For location reminders
location_name?: string;
latitude?: string;
longitude?: string;
location_trigger?: LocationTrigger;
radius?: number;
}
/**
* Arguments for deleting a reminder
*/
export interface DeleteReminderArgs {
reminder_id: string;
}
/**
* Sync API command structure
*/
export interface SyncCommand {
type: string;
uuid: string;
temp_id?: string;
args: Record<string, unknown>;
}
/**
* Sync API response structure
*/
export interface SyncResponse {
sync_status: Record<string, string>;
temp_id_mapping?: Record<string, string>;
reminders?: TodoistReminder[];
full_sync?: boolean;
sync_token?: string;
}
/**
* Response type for reminder operations
*/
export type RemindersResponse =
| TodoistReminder[]
| { reminders?: TodoistReminder[] };
