import { executeOmniFocusScript } from '../../utils/scriptExecution.js';
import { RepetitionRule } from './addOmniFocusTask.js';
import { queryCache } from '../../utils/cache.js';
import { logger } from '../../utils/logger.js';
const log = logger.child('editItem');
// Status options for tasks and projects
type TaskStatus = 'incomplete' | 'completed' | 'dropped';
type ProjectStatus = 'active' | 'completed' | 'dropped' | 'onHold';
// Interface for item edit parameters
export interface EditItemParams {
id?: string; // ID of the task or project to edit
name?: string; // Name of the task or project to edit (as fallback if ID not provided)
itemType: 'task' | 'project'; // Type of item to edit
// Common editable fields
newName?: string; // New name for the item
newNote?: string; // New note for the item
newDueDate?: string; // New due date in ISO format (empty string to clear)
newDeferDate?: string; // New defer date in ISO format (empty string to clear)
newPlannedDate?: string; // New planned date in ISO format (empty string to clear)
newFlagged?: boolean; // New flagged status (false to remove flag, true to add flag)
newEstimatedMinutes?: number; // New estimated minutes
// Tag operations (work on both tasks and projects)
addTags?: string[]; // Tags to add (works on both tasks and projects)
removeTags?: string[]; // Tags to remove (works on both tasks and projects)
replaceTags?: string[]; // Replace all existing tags (works on both tasks and projects)
// Task-specific fields
newStatus?: TaskStatus; // New status for tasks (incomplete, completed, dropped)
dropCompletely?: boolean; // When dropping repeating task, true = drop completely (no future occurrences)
newRepetitionRule?: RepetitionRule | null; // New repetition rule (null to remove, object to set)
// Task movement fields
newProjectName?: string; // Move task to a different project (by name)
newProjectId?: string; // Move task to a different project (by ID)
newParentTaskId?: string; // Move task to be a subtask of another task (by ID)
newParentTaskName?: string; // Move task to be a subtask of another task (by name)
moveToInbox?: boolean; // Move task to inbox
// Project-specific fields
newSequential?: boolean; // Whether the project should be sequential
newFolderName?: string; // New folder to move the project to (by name)
newFolderId?: string; // New folder to move the project to (by ID)
newProjectStatus?: ProjectStatus; // New status for projects
// Project review fields
markReviewed?: boolean; // Mark project as reviewed (advances next review date)
newReviewInterval?: number; // Set new review interval in days
newNextReviewDate?: string; // Set next review date directly (ISO format)
}
/**
* Edit a task or project in OmniFocus
* Uses OmniJS to avoid AppleScript escaping issues with special characters like $
*/
export async function editItem(params: EditItemParams): Promise<{
success: boolean,
id?: string,
name?: string,
changedProperties?: string,
error?: string
}> {
try {
// Validate parameters
if (!params.id && !params.name) {
return {
success: false,
error: "Either id or name must be provided"
};
}
log.debug('Executing editItem', { itemType: params.itemType, id: params.id, name: params.name });
// Execute the OmniJS script with all parameters
const result = await executeOmniFocusScript('@editItem.js', {
id: params.id || null,
name: params.name || null,
itemType: params.itemType,
newName: params.newName,
newNote: params.newNote,
newDueDate: params.newDueDate,
newDeferDate: params.newDeferDate,
newPlannedDate: params.newPlannedDate,
newFlagged: params.newFlagged,
newEstimatedMinutes: params.newEstimatedMinutes,
newStatus: params.newStatus,
dropCompletely: params.dropCompletely || false,
addTags: params.addTags,
removeTags: params.removeTags,
replaceTags: params.replaceTags,
newRepetitionRule: params.newRepetitionRule,
newProjectName: params.newProjectName,
newProjectId: params.newProjectId,
newParentTaskId: params.newParentTaskId,
newParentTaskName: params.newParentTaskName,
moveToInbox: params.moveToInbox,
newSequential: params.newSequential,
newFolderName: params.newFolderName,
newFolderId: params.newFolderId,
newProjectStatus: params.newProjectStatus,
markReviewed: params.markReviewed,
newReviewInterval: params.newReviewInterval,
newNextReviewDate: params.newNextReviewDate
});
// Parse result
let parsed;
if (typeof result === 'string') {
try {
parsed = JSON.parse(result);
} catch (e) {
log.error('Failed to parse result as JSON', { error: (e as Error).message });
return {
success: false,
error: `Failed to parse result: ${result}`
};
}
} else {
parsed = result;
}
if (parsed.success) {
// Invalidate cache after successful write
queryCache.invalidateOnWrite();
return {
success: true,
id: parsed.id,
name: parsed.name,
changedProperties: parsed.changedProperties
};
} else {
return {
success: false,
error: parsed.error || "Unknown error"
};
}
} catch (error: any) {
log.error('Error in editItem', { error: error?.message });
return {
success: false,
error: error?.message || "Unknown error in editItem"
};
}
}
