@codebolt/codeboltjs 2.2.1 → 2.2.3

package/dist/modules/task.d.ts

@@ -1,138 +1,182 @@
-import type { Task, SubTask, TaskResponse, TaskCreateOptions, TaskUpdateOptions, AddSubTaskOptions, UpdateSubTaskOptions, TaskFilterOptions, TaskMarkdownImportOptions, TaskMarkdownExportOptions } from '../types';
+import type { CreateTaskOptions, UpdateTaskOptions, GetTaskListOptions, AddStepToTaskOptions, GetTaskDetailOptions, GetTaskMessagesOptions, SendSteeringMessageOptions, GetAllStepsOptions, GetActiveStepOptions, UpdateStepStatusOptions, CompleteStepOptions, DeleteTaskOptions, CompleteTaskOptions, StartTaskOptions, CanTaskStartOptions, GetTasksDependentOnOptions, GetTasksReadyToStartOptions, GetTaskDependencyChainOptions, GetTaskStatsOptions, MessageData, Position, FlowData, Step } from '@codebolt/types/agent-to-app-ws-schema';
+import type { TaskResponse, TaskListResponse, StepResponse, StepListResponse, TaskMessagesResponse, ActiveStepResponse, SendSteeringMessageResponse, DeleteTaskResponse, CanTaskStartResponse, TaskStatsResponse, CreateTaskResponse, GetTaskListResponse, AddStepToTaskResponse, GetTaskDetailResponse, GetTaskMessagesResponse, GetAllStepsResponse, GetCurrentRunningStepResponse, UpdateStepStatusResponse, CompleteStepResponse, UpdateTaskResponse, CompleteTaskResponse, StartTaskResponse, GetTasksDependentOnResponse, GetTasksReadyToStartResponse, GetTaskDependencyChainResponse, GetTaskStatsResponse, Task, ExtendedTask, ExtendedStep, TaskMessage, TaskStats, TaskResponseMessageData as ResponseMessageData } from '@codebolt/types/app-to-agent-ws-schema';
+import type { Task as LegacyTask, SubTask as LegacySubTask, TaskResponse as LegacyTaskResponse, TaskCreateOptions as LegacyTaskCreateOptions, TaskUpdateOptions as LegacyTaskUpdateOptions, AddSubTaskOptions, UpdateSubTaskOptions, TaskFilterOptions, TaskMarkdownImportOptions, TaskMarkdownExportOptions } from '../types';
 /**
- * Enhanced task planner with agent-based organization and comprehensive task management.
+ * Enhanced task service with comprehensive task and step management.
+ * This module provides a modern API for task management based on the new task service schemas.
  */
-declare const taskplaner: {
+declare const taskService: {
     /**
-     * Adds a new task with enhanced parameters.
-     * @param {TaskCreateOptions} params - The task parameters including title, agentId, description, etc.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the add task event.
+     * Creates a new task with comprehensive options.
+     * @param {CreateTaskOptions} options - The task creation parameters
+     * @returns {Promise<CreateTaskResponse>} A promise that resolves with the task creation response
      */
-    addTask: (params: TaskCreateOptions) => Promise<TaskResponse>;
+    createTask: (options: CreateTaskOptions) => Promise<CreateTaskResponse>;
     /**
-     * Adds a task using simple string parameter (legacy support).
-     * @param {string} task - The task title.
-     * @param {string} agentId - The agent ID (optional, defaults to 'default-agent').
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the add task event.
+     * Creates a simple task with minimal parameters (legacy compatibility).
+     * @param {string} taskName - The task name
+     * @param {string} threadId - The thread ID (defaults to 'default-thread')
+     * @returns {Promise<CreateTaskResponse>} A promise that resolves with the task creation response
      */
-    addSimpleTask: (task: string, agentId?: string) => Promise<TaskResponse>;
+    createSimpleTask: (taskName: string, threadId?: string) => Promise<CreateTaskResponse>;
     /**
-     * Retrieves all tasks with optional filtering.
-     * @param {TaskFilterOptions} filters - Optional filters for agentId, category, phase, etc.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the get tasks event.
+     * Retrieves a list of tasks with optional filtering.
+     * @param {GetTaskListOptions} options - Optional filters for tasks
+     * @returns {Promise<GetTaskListResponse>} A promise that resolves with the task list response
      */
-    getTasks: (filters?: TaskFilterOptions) => Promise<TaskResponse>;
+    getTaskList: (options?: GetTaskListOptions) => Promise<GetTaskListResponse>;
     /**
-     * Retrieves tasks for a specific agent.
-     * @param {string} agentId - The agent ID.
-     * @returns {Promise<TaskResponse>} A promise that resolves with tasks for the specified agent.
+     * Retrieves detailed information about a specific task.
+     * @param {GetTaskDetailOptions} options - The task detail options
+     * @returns {Promise<GetTaskDetailResponse>} A promise that resolves with the task detail response
      */
-    getTasksByAgent: (agentId: string) => Promise<TaskResponse>;
+    getTaskDetail: (options: GetTaskDetailOptions) => Promise<GetTaskDetailResponse>;
     /**
-     * Retrieves tasks by category.
-     * @param {string} category - The category name.
-     * @returns {Promise<TaskResponse>} A promise that resolves with tasks in the specified category.
+     * Adds a step to an existing task.
+     * @param {AddStepToTaskOptions} options - The step addition options
+     * @returns {Promise<AddStepToTaskResponse>} A promise that resolves with the step addition response
      */
-    getTasksByCategory: (category: string) => Promise<TaskResponse>;
+    addStepToTask: (options: AddStepToTaskOptions) => Promise<AddStepToTaskResponse>;
     /**
-     * Retrieves all available agents.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the list of all agents.
+     * Retrieves messages for a specific task.
+     * @param {GetTaskMessagesOptions} options - The task messages options
+     * @returns {Promise<GetTaskMessagesResponse>} A promise that resolves with the task messages response
      */
-    getAllAgents: () => Promise<TaskResponse>;
+    getTaskMessages: (options: GetTaskMessagesOptions) => Promise<GetTaskMessagesResponse>;
     /**
      * Updates an existing task.
-     * @param {TaskUpdateOptions} params - The task update parameters.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * @param {string} taskId - The task ID to update
+     * @param {UpdateTaskOptions} updates - The task update parameters
+     * @returns {Promise<UpdateTaskResponse>} A promise that resolves with the task update response
      */
-    updateTask: (params: TaskUpdateOptions) => Promise<TaskResponse>;
+    updateTask: (taskId: string, updates: UpdateTaskOptions) => Promise<UpdateTaskResponse>;
     /**
-     * Updates an existing task using legacy string parameter.
-     * @param {string} taskId - The task ID.
-     * @param {string} task - The updated task information.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * Updates a task with simple name change (legacy compatibility).
+     * @param {string} taskId - The task ID
+     * @param {string} taskName - The new task name
+     * @returns {Promise<UpdateTaskResponse>} A promise that resolves with the task update response
      */
-    updateSimpleTask: (taskId: string, task: string) => Promise<TaskResponse>;
+    updateSimpleTask: (taskId: string, taskName: string) => Promise<UpdateTaskResponse>;
     /**
      * Deletes a task.
-     * @param {string} taskId - The task ID to delete.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the delete task event.
+     * @param {string} taskId - The task ID to delete
+     * @returns {Promise<DeleteTaskResponse>} A promise that resolves with the task deletion response
      */
-    deleteTask: (taskId: string) => Promise<TaskResponse>;
+    deleteTask: (taskId: string) => Promise<DeleteTaskResponse>;
     /**
-     * Adds a subtask to an existing task.
-     * @param {AddSubTaskOptions} params - The subtask parameters.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the add subtask event.
+     * Completes a task.
+     * @param {string} taskId - The task ID to complete
+     * @returns {Promise<CompleteTaskResponse>} A promise that resolves with the task completion response
      */
-    addSubTask: (params: AddSubTaskOptions) => Promise<TaskResponse>;
+    completeTask: (taskId: string) => Promise<CompleteTaskResponse>;
     /**
-     * Updates an existing subtask.
-     * @param {UpdateSubTaskOptions} params - The subtask update parameters.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update subtask event.
+     * Starts a task.
+     * @param {string} taskId - The task ID to start
+     * @returns {Promise<StartTaskResponse>} A promise that resolves with the task start response
      */
-    updateSubTask: (params: UpdateSubTaskOptions) => Promise<TaskResponse>;
+    startTask: (taskId: string) => Promise<StartTaskResponse>;
     /**
-     * Deletes a subtask.
-     * @param {string} taskId - The parent task ID.
-     * @param {string} subtaskId - The subtask ID to delete.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the delete subtask event.
+     * Retrieves all steps with optional filtering.
+     * @param {GetAllStepsOptions} options - Optional filters for steps
+     * @returns {Promise<GetAllStepsResponse>} A promise that resolves with the steps response
      */
-    deleteSubTask: (taskId: string, subtaskId: string) => Promise<TaskResponse>;
+    getAllSteps: (options?: GetAllStepsOptions) => Promise<GetAllStepsResponse>;
     /**
-     * Creates tasks from markdown content.
-     * @param {TaskMarkdownImportOptions} params - The markdown parameters including content, agentId, phase, and category.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the create tasks from markdown event.
+     * Gets the currently running step for a task or agent.
+     * @param {GetActiveStepOptions} options - Options for getting active step
+     * @returns {Promise<GetCurrentRunningStepResponse>} A promise that resolves with the active step response
      */
-    createTasksFromMarkdown: (params: TaskMarkdownImportOptions) => Promise<TaskResponse>;
+    getCurrentRunningStep: (options?: GetActiveStepOptions) => Promise<GetCurrentRunningStepResponse>;
     /**
-     * Exports tasks to markdown format.
-     * @param {TaskMarkdownExportOptions} params - The export parameters including optional phase, agentId, and category filters.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the markdown content.
+     * Updates the status of a specific step.
+     * @param {UpdateStepStatusOptions} options - The step status update options
+     * @returns {Promise<UpdateStepStatusResponse>} A promise that resolves with the step update response
      */
-    exportTasksToMarkdown: (params?: TaskMarkdownExportOptions) => Promise<TaskResponse>;
+    updateStepStatus: (options: UpdateStepStatusOptions) => Promise<UpdateStepStatusResponse>;
     /**
-     * Utility function to toggle task completion status.
-     * @param {string} taskId - The task ID.
-     * @param {boolean} completed - The new completion status.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * Completes a specific step.
+     * @param {CompleteStepOptions} options - The step completion options
+     * @returns {Promise<CompleteStepResponse>} A promise that resolves with the step completion response
+     */
+    completeStep: (options: CompleteStepOptions) => Promise<CompleteStepResponse>;
+    /**
+     * Sends a steering message to a running step.
+     * @param {SendSteeringMessageOptions} options - The steering message options
+     * @returns {Promise<SendSteeringMessageResponse>} A promise that resolves with the steering message response
+     */
+    sendSteeringMessage: (options: SendSteeringMessageOptions) => Promise<SendSteeringMessageResponse>;
+    /**
+     * Checks if a task can start based on its dependencies.
+     * @param {string} taskId - The task ID to check
+     * @returns {Promise<CanTaskStartResponse>} A promise that resolves with the task start capability response
      */
-    toggleTaskCompletion: (taskId: string, completed: boolean) => Promise<TaskResponse>;
+    canTaskStart: (taskId: string) => Promise<CanTaskStartResponse>;
     /**
-     * Utility function to toggle subtask completion status.
-     * @param {string} taskId - The parent task ID.
-     * @param {string} subtaskId - The subtask ID.
-     * @param {boolean} completed - The new completion status.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update subtask event.
+     * Gets tasks that depend on a specific task.
+     * @param {string} taskId - The task ID to check dependencies for
+     * @returns {Promise<GetTasksDependentOnResponse>} A promise that resolves with the dependent tasks response
      */
-    toggleSubTaskCompletion: (taskId: string, subtaskId: string, completed: boolean) => Promise<TaskResponse>;
+    getTasksDependentOn: (taskId: string) => Promise<GetTasksDependentOnResponse>;
     /**
-     * Utility function to move a task to a different agent.
-     * @param {string} taskId - The task ID.
-     * @param {string} newAgentId - The new agent ID.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * Gets tasks that are ready to start.
+     * @param {GetTasksReadyToStartOptions} options - Optional filters for ready tasks
+     * @returns {Promise<GetTasksReadyToStartResponse>} A promise that resolves with the ready tasks response
      */
-    moveTaskToAgent: (taskId: string, newAgentId: string) => Promise<TaskResponse>;
+    getTasksReadyToStart: (options?: GetTasksReadyToStartOptions) => Promise<GetTasksReadyToStartResponse>;
     /**
-     * Utility function to set task priority.
-     * @param {string} taskId - The task ID.
-     * @param {'low' | 'medium' | 'high'} priority - The priority level.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * Gets the dependency chain for a specific task.
+     * @param {string} taskId - The task ID to get dependency chain for
+     * @returns {Promise<GetTaskDependencyChainResponse>} A promise that resolves with the dependency chain response
      */
-    setTaskPriority: (taskId: string, priority: "low" | "medium" | "high") => Promise<TaskResponse>;
+    getTaskDependencyChain: (taskId: string) => Promise<GetTaskDependencyChainResponse>;
     /**
-     * Utility function to add tags to a task.
-     * @param {string} taskId - The task ID.
-     * @param {string[]} tags - The tags to add.
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the update task event.
+     * Gets task statistics.
+     * @param {GetTaskStatsOptions} options - Optional filters for task stats
+     * @returns {Promise<GetTaskStatsResponse>} A promise that resolves with the task stats response
      */
-    addTaskTags: (taskId: string, tags: string[]) => Promise<TaskResponse>;
+    getTaskStats: (options?: GetTaskStatsOptions) => Promise<GetTaskStatsResponse>;
+    /**
+     * Utility function to toggle task completion status.
+     * @param {string} taskId - The task ID
+     * @param {boolean} completed - The new completion status
+     * @returns {Promise<UpdateTaskResponse>} A promise that resolves with the task update response
+     */
+    toggleTaskCompletion: (taskId: string, completed: boolean) => Promise<UpdateTaskResponse>;
     /**
      * Utility function to create a quick task with minimal parameters.
-     * @param {string} title - The task title.
-     * @param {string} agentId - The agent ID (optional, defaults to 'default-agent').
-     * @param {string} category - The category (optional).
-     * @returns {Promise<TaskResponse>} A promise that resolves with the response from the add task event.
+     * @param {string} name - The task name
+     * @param {string} threadId - The thread ID (defaults to 'default-thread')
+     * @returns {Promise<CreateTaskResponse>} A promise that resolves with the task creation response
+     */
+    createQuickTask: (name: string, threadId?: string) => Promise<CreateTaskResponse>;
+    /**
+     * Gets tasks started by a specific user
+     * @param {string} userId - The user ID
+     * @param {GetTaskListOptions} options - Optional filters for tasks
+     * @returns {Promise<GetTaskListResponse>} A promise that resolves with the task list response
+     */
+    getTasksStartedByMe: (userId: string, options?: GetTaskListOptions) => Promise<GetTaskListResponse>;
+    /**
+     * Legacy function: Adds a task (mapped to createTask)
+     * @deprecated Use createTask instead
+     */
+    addTask: (params: LegacyTaskCreateOptions) => Promise<CreateTaskResponse>;
+    /**
+     * Legacy function: Gets tasks (mapped to getTaskList)
+     * @deprecated Use getTaskList instead
+     */
+    getTasks: (filters?: TaskFilterOptions) => Promise<GetTaskListResponse>;
+    /**
+     * Legacy function: Gets tasks by agent (mapped to getTaskList with threadId filter)
+     * @deprecated Use getTaskList with threadId filter instead
+     */
+    getTasksByAgent: (agentId: string) => Promise<GetTaskListResponse>;
+    /**
+     * Legacy function: Gets tasks by category (use getTaskList with custom filtering)
+     * @deprecated Use getTaskList instead
      */
-    createQuickTask: (title: string, agentId?: string, category?: string) => Promise<TaskResponse>;
+    getTasksByCategory: (category: string) => Promise<GetTaskListResponse>;
 };
-export type { Task, SubTask, TaskResponse, TaskCreateOptions, TaskUpdateOptions, AddSubTaskOptions, UpdateSubTaskOptions, TaskFilterOptions, TaskMarkdownImportOptions, TaskMarkdownExportOptions };
-export default taskplaner;
+export type { Task, ExtendedTask, Step, ExtendedStep, TaskMessage, MessageData, ResponseMessageData, TaskStats, CreateTaskOptions, UpdateTaskOptions, GetTaskListOptions, AddStepToTaskOptions, GetTaskDetailOptions, GetTaskMessagesOptions, UpdateStepStatusOptions, CompleteStepOptions, SendSteeringMessageOptions, GetAllStepsOptions, GetActiveStepOptions, DeleteTaskOptions, CompleteTaskOptions, StartTaskOptions, CanTaskStartOptions, GetTasksDependentOnOptions, GetTasksReadyToStartOptions, GetTaskDependencyChainOptions, GetTaskStatsOptions, TaskResponse, TaskListResponse, StepResponse, StepListResponse, TaskMessagesResponse, ActiveStepResponse, SendSteeringMessageResponse, DeleteTaskResponse, CanTaskStartResponse, TaskStatsResponse, CreateTaskResponse, GetTaskListResponse, AddStepToTaskResponse, GetTaskDetailResponse, GetTaskMessagesResponse, GetAllStepsResponse, GetCurrentRunningStepResponse, UpdateStepStatusResponse, CompleteStepResponse, UpdateTaskResponse, CompleteTaskResponse, StartTaskResponse, GetTasksDependentOnResponse, GetTasksReadyToStartResponse, GetTaskDependencyChainResponse, GetTaskStatsResponse, Position, FlowData };
+export type { LegacyTask as Task_Legacy, LegacySubTask as SubTask, LegacyTaskResponse as TaskResponse_Legacy, LegacyTaskCreateOptions as TaskCreateOptions_Legacy, LegacyTaskUpdateOptions as TaskUpdateOptions_Legacy, AddSubTaskOptions, UpdateSubTaskOptions, TaskFilterOptions, TaskMarkdownImportOptions, TaskMarkdownExportOptions };
+export default taskService;