plan

Module: vibex/plan

Plan - Strategy for achieving a Mission

A Plan contains the breakdown of Tasks needed to complete a Mission. Plans can evolve as the Mission progresses - tasks can be added, removed, or reordered based on user feedback and agent discoveries.

Hierarchy: Space (persistent container) └── Mission (user’s intent) └── Plan (strategy) ‹— This file └── Task[] (individual work items)

Classes

Plan

Properties:

Name	Type	Description
`goal`	`string`
`tasks`	`Task[]`
`metadata`	`Record<string, unknown>`
`createdAt`	`Date`
`updatedAt`	`Date`

Methods:

addTask

Add a task to the plan


function addTask(task: Task): void

Parameters:

Name	Type	Description
`task`	`Task`

createTask

Create and add a new task


function createTask(config: TaskConfig): Task

Parameters:

Name	Type	Description
`config`	`TaskConfig`

removeTask

Remove a task from the plan


function removeTask(taskId: string): boolean

Parameters:

Name	Type	Description
`taskId`	`string`

getTaskById

Get task by ID


function getTaskById(taskId: string): Task | undefined

Parameters:

Name	Type	Description
`taskId`	`string`

updateTaskStatus

Update a task’s status


function updateTaskStatus(taskId: string, status: TaskStatus): boolean

Parameters:

Name	Type	Description
`taskId`	`string`
`status`	`TaskStatus`

getNextActionableTask

Get the next task that can be started


function getNextActionableTask(): Task | undefined

getAllActionableTasks

Get all tasks that can be started (for parallel execution)


function getAllActionableTasks(maxTasks?: number): Task[]

Parameters:

Name	Type	Description
`maxTasks`	`number` (optional)

getTasksByStatus

Get tasks by status


function getTasksByStatus(status: TaskStatus): Task[]

Parameters:

Name	Type	Description
`status`	`TaskStatus`

getTasksByAssignee

Get tasks assigned to a specific agent


function getTasksByAssignee(assignee: string): Task[]

Parameters:

Name	Type	Description
`assignee`	`string`

isComplete

Check if all tasks are complete


function isComplete(): boolean

hasFailedTasks

Check if any tasks have failed


function hasFailedTasks(): boolean

hasBlockedTasks

Check if any tasks are blocked


function hasBlockedTasks(): boolean

getProgressSummary

Get a summary of plan progress


function getProgressSummary(): PlanSummary

reorderTasks

Reorder tasks in the plan


function reorderTasks(fromIndex: number, toIndex: number): void

Parameters:

Name	Type	Description
`fromIndex`	`number`
`toIndex`	`number`

toJSON

Serialize to JSON


function toJSON(): Record<string, unknown>

fromJSON

Deserialize from JSON


function fromJSON(data: Record<string, unknown>): Plan

Parameters:

Name	Type	Description
`data`	`Record<string, unknown>`

Interfaces

PlanSummary

Properties:

Name	Type	Description
`totalTasks`	`number`
`completedTasks`	`number`
`runningTasks`	`number`
`pendingTasks`	`number`
`failedTasks`	`number`
`blockedTasks`	`number`
`progressPercentage`	`number`

PlanConfig

Properties:

Name	Type	Description
`goal`	`string`
`tasks`	`Task[]`	(optional)
`metadata`	`Record<string, unknown>`	(optional)

Paths Processor