/** * WorkGraph planning doc generator — produces markdown planning documents * from saga WorkGraph structures with agent and maintainer audience modes. * * @task T10634 * @saga T10538 * @epic T10547 */ /** Audience mode controlling output style and detail level. */ export type PlanningDocAudience = 'agent' | 'maintainer'; /** Parameters for generating a planning document from a saga WorkGraph. */ export interface PlanningDocParams { /** Saga task ID to generate the plan for. */ readonly sagaId: string; /** Output audience mode. Defaults to 'maintainer'. */ readonly audience?: PlanningDocAudience; /** Maximum estimated token budget for agent-mode output. */ readonly tokenBudget?: number; } /** A single epic entry in the planning document. */ export interface PlanningDocEpicEntry { epicId: string; title: string; status: string; completionPct: number; totalChildren: number; doneChildren: number; activeChildren: number; blockedChildren: number; pendingChildren: number; } /** A ready task entry in the planning document. */ export interface PlanningDocReadyTask { id: string; title: string; priority: string; epicId: string; depends: string[]; } /** A blocked task entry in the planning document. */ export interface PlanningDocBlockedTask { id: string; title: string; status: string; blockedBy: string[]; blocksCount: number; } /** Structured result of plan generation. */ export interface PlanningDocResult { /** The generated markdown document. */ readonly markdown: string; /** Estimated token count of the output. */ readonly estimatedTokens: number; /** Audience mode used for generation. */ readonly audience: PlanningDocAudience; /** ISO 8601 timestamp of generation. */ readonly generatedAt: string; /** Saga ID the plan was generated from. */ readonly sagaId: string; /** Saga title. */ readonly sagaTitle: string; /** Structured epic entries (for SSoT attachment). */ readonly epics: readonly PlanningDocEpicEntry[]; /** Ready task entries. */ readonly readyTasks: readonly PlanningDocReadyTask[]; /** Blocked task entries. */ readonly blockedTasks: readonly PlanningDocBlockedTask[]; } /** * Generate a planning document from a saga WorkGraph structure. * * Reads saga membership, epic statuses, and child task data to produce * a structured markdown planning document. Supports two audience modes: * * - `agent`: Compact, token-efficient output for LLM consumption. * Prioritizes structured lists over prose, uses icons/symbols, and * caps output at ~1500 tokens. * * - `maintainer` (default): Human-readable markdown with descriptive * prose, headers, status emojis, and actionable recommendations. * * The result includes structured entries suitable for attachment to the * docs SSoT via `cleo docs add`. * * @param projectRoot - Absolute path to the project root. * @param params - Saga ID and audience configuration. * @returns Structured planning document with markdown and metadata. */ export declare function generatePlanningDoc(projectRoot: string, params: PlanningDocParams): Promise; //# sourceMappingURL=scaffold-plan.d.ts.map