import path from "node:path"; import { agent, compute, defineWorkflow, includeWorkflow, includedResult, } from "../workflows/definition.js"; import { digest } from "../workflows/human-decision.js"; import type { WorkflowNodeContext } from "../workflows/types.js"; import changeVerificationWorkflow, { type ChangeVerificationInput, type ChangeVerificationResult, type VerificationCheck, } from "./change-verification.workflow.js"; import workspacePreparationWorkflow, { parsePreparedWorkspace, type PreparedWorkspace, type WorkspaceMode, type WorkspacePreparationInput, } from "./workspace-preparation.workflow.js"; export type AutodocInput = { task: string; plan?: unknown; repository?: string; baseBranch?: string; scope?: string; workspaceMode?: WorkspaceMode; directDefaultBranchAuthorized?: boolean; preparedWorkspace?: PreparedWorkspace; verificationChecks?: VerificationCheck[]; documents?: string[]; evidence?: unknown; }; export type DocumentedPlan = { status: "ready"; task: string; plan: unknown; planDigest: string; documentation: { state: "current" | "updated"; files: string[]; digests: Record; evidence: unknown; }; verification: ChangeVerificationResult | { route: "ready"; reason: string }; workspace?: PreparedWorkspace; }; export type AutodocBlocked = { status: "blocked"; task: string; reason: string; evidence: unknown; sourceNode?: string; }; type LocatedPlan = { route: "found" | "blocked"; plan?: unknown; sources?: string[]; reason: string; evidence: unknown; }; type DocumentationAssessment = { route: "current" | "update" | "blocked"; files: string[]; digests: Record; reason: string; evidence: unknown; }; type WorkspaceGuard = | { route: "ready"; repository: string } | { route: "blocked"; reason: string; evidence: string[] }; function requireRecord(value: unknown, label: string): Record { if (value === null || typeof value !== "object" || Array.isArray(value)) { throw new Error(`${label} must be an object`); } return value as Record; } function requireString(value: unknown, label: string): string { if (typeof value !== "string" || value.trim().length === 0) { throw new Error(`${label} must be a non-empty string`); } return value.trim(); } function requireAbsolutePath(value: unknown, label: string): string { const result = requireString(value, label); if (!path.isAbsolute(result)) throw new Error(`${label} must be absolute`); return path.resolve(result); } function stringArray(value: unknown, label: string): string[] { if (!Array.isArray(value) || value.some((item) => typeof item !== "string")) { throw new Error(`${label} must be an array of strings`); } return [...value] as string[]; } function stringRecord(value: unknown, label: string): Record { if (value === undefined) return {}; const record = requireRecord(value, label); if (Object.values(record).some((item) => typeof item !== "string")) { throw new Error(`${label} values must be strings`); } return record as Record; } function parseWorkspaceMode(value: unknown): WorkspaceMode | undefined { if (value === undefined) return undefined; if (value !== "auto" && value !== "branch" && value !== "worktree" && value !== "defaultBranch") { throw new Error("autodoc workspaceMode must be auto, branch, worktree, or defaultBranch"); } return value; } function parseInput(value: unknown): AutodocInput { const input = requireRecord(value, "autodoc input"); const documents = input.documents; const workspaceMode = parseWorkspaceMode(input.workspaceMode); return { task: requireString(input.task, "autodoc task"), ...(input.plan !== undefined ? { plan: input.plan } : {}), ...(input.repository !== undefined ? { repository: requireAbsolutePath(input.repository, "autodoc repository") } : {}), ...(input.baseBranch !== undefined ? { baseBranch: requireString(input.baseBranch, "autodoc baseBranch") } : {}), ...(input.scope !== undefined ? { scope: requireString(input.scope, "autodoc scope") } : {}), ...(workspaceMode === undefined ? {} : { workspaceMode }), ...(input.directDefaultBranchAuthorized === undefined ? {} : { directDefaultBranchAuthorized: input.directDefaultBranchAuthorized === true }), ...(input.preparedWorkspace === undefined ? {} : { preparedWorkspace: parsePreparedWorkspace(input.preparedWorkspace) }), ...(input.verificationChecks === undefined ? {} : { verificationChecks: input.verificationChecks as VerificationCheck[] }), ...(documents !== undefined ? { documents: stringArray(documents, "autodoc documents") } : {}), ...(input.evidence !== undefined ? { evidence: input.evidence } : {}), }; } function parseLocatedPlan(value: unknown): LocatedPlan { const result = requireRecord(value, "located plan"); if (result.route !== "found" && result.route !== "blocked") { throw new Error("located plan route must be found or blocked"); } if (result.route === "found" && result.plan === undefined) { throw new Error("located plan must include the selected plan"); } return { route: result.route, ...(result.plan !== undefined ? { plan: result.plan } : {}), ...(result.sources !== undefined ? { sources: stringArray(result.sources, "located plan sources") } : {}), reason: requireString(result.reason, "located plan reason"), evidence: result.evidence ?? null, }; } function parseDocumentationAssessment(value: unknown): DocumentationAssessment { const result = requireRecord(value, "documentation assessment"); if (result.route !== "current" && result.route !== "update" && result.route !== "blocked") { throw new Error("documentation assessment route must be current, update, or blocked"); } return { route: result.route, files: stringArray(result.files, "documentation files"), digests: stringRecord(result.digests, "documentation digests"), reason: requireString(result.reason, "documentation reason"), evidence: result.evidence ?? null, }; } function currentPlan(context: WorkflowNodeContext): unknown { const explicit = (context.input as AutodocInput).plan; if (explicit !== undefined) return explicit; const located = context.outputs.locatePlan as LocatedPlan | undefined; if (located?.route === "found" && located.plan !== undefined) return located.plan; throw new Error("autodoc does not have a selected plan"); } function mutationRepository(request: AutodocInput): string { if (request.repository !== undefined) return request.repository; if (request.preparedWorkspace !== undefined) return request.preparedWorkspace.repository; throw new Error("autodoc mutation requires an explicit repository"); } function preparedWorkspace(context: WorkflowNodeContext): PreparedWorkspace { const request = context.input as AutodocInput; if (request.preparedWorkspace !== undefined) return request.preparedWorkspace; const result = includedResult(workspacePreparationWorkflow, context.outputs.workspace); if (result.exit !== "ready") throw new Error("autodoc workspace is not ready"); return result.output; } function verificationResult(context: WorkflowNodeContext): ChangeVerificationResult { const result = includedResult(changeVerificationWorkflow, context.outputs.verification); return result.output; } function blockedReason(context: WorkflowNodeContext): AutodocBlocked { const request = context.input as AutodocInput; const assessment = context.outputs.inspectDocumentation as DocumentationAssessment | undefined; const located = context.outputs.locatePlan as LocatedPlan | undefined; if (context.outputs.verification !== undefined) { const result = includedResult(changeVerificationWorkflow, context.outputs.verification); return { status: "blocked", task: request.task, reason: result.output.reason, evidence: result.output, sourceNode: result.output.qualifiedNode, }; } const guard = context.outputs.workspaceGuard as WorkspaceGuard | undefined; if (guard?.route === "blocked") { return { status: "blocked", task: request.task, reason: guard.reason, evidence: guard.evidence, sourceNode: "autodoc/workspaceGuard", }; } if (context.outputs.workspace !== undefined) { const result = includedResult(workspacePreparationWorkflow, context.outputs.workspace); if (result.exit === "blocked") { return { status: "blocked", task: request.task, reason: result.output.reason, evidence: result.output, sourceNode: "autodoc/workspace", }; } } return { status: "blocked", task: request.task, reason: assessment?.route === "blocked" ? assessment.reason : located?.route === "blocked" ? located.reason : "Autodoc could not identify a clear selected plan or canonical document target.", evidence: assessment?.evidence ?? located?.evidence ?? null, sourceNode: assessment?.route === "blocked" ? "autodoc/inspectDocumentation" : "autodoc/locatePlan", }; } export const autodocWorkflow = defineWorkflow({ source: import.meta.url, contractId: "pi-workflows.autodoc.v1", name: "autodoc", input: parseInput, title: ({ input }) => `autodoc: ${input.task.slice(0, 60)}`, startAt: "prepare", maxSteps: 80, includes: { workspace: includeWorkflow(workspacePreparationWorkflow, { input: (context): WorkspacePreparationInput => { const request = context.input as AutodocInput; return { repository: mutationRepository(request), ...(request.baseBranch === undefined ? {} : { baseBranch: request.baseBranch }), ...(request.scope === undefined ? {} : { scope: request.scope }), ...(request.workspaceMode === undefined ? {} : { workspaceMode: request.workspaceMode }), ...(request.directDefaultBranchAuthorized === undefined ? {} : { directDefaultBranchAuthorized: request.directDefaultBranchAuthorized }), ...(request.preparedWorkspace === undefined ? {} : { preparedWorkspace: request.preparedWorkspace }), }; }, }), verification: includeWorkflow(changeVerificationWorkflow, { input: (context): ChangeVerificationInput => { const request = context.input as AutodocInput; const update = requireRecord(context.outputs.updateDocumentation, "documentation update"); return { originatingWorkflow: "autodoc", qualifiedNode: "autodoc/verification", workspace: preparedWorkspace(context), ...(request.verificationChecks === undefined ? {} : { checks: request.verificationChecks }), changedFiles: stringArray(update.files, "updated documentation files"), plan: currentPlan(context), }; }, }), }, exits: { ready: { from: "finalize", validate: (value: unknown): DocumentedPlan => value as DocumentedPlan, }, blocked: { from: "blocked", validate: (value: unknown): AutodocBlocked => value as AutodocBlocked, }, }, nodes: { prepare: compute({ run: ({ input }) => ({ route: (input as AutodocInput).plan === undefined ? "locate" : "inspect", }), }), locatePlan: agent({ statusDetail: "locating selected plan", prompt: ({ input }) => { const request = input as AutodocInput; return [ "Find the clear plan that has already been selected for this task.", "Look in the current conversation context and in the referenced canonical documents.", "Do not devise, improve, replace, or implement the plan.", "Return blocked when no single clear selected plan exists.", `Task: ${request.task}`, `Repository: ${request.repository ?? "current repository"}`, `Preferred documents: ${JSON.stringify(request.documents ?? [])}`, ].join("\n"); }, expectedOutput: '{ "route": "found" | "blocked", "plan": {} (required when found), "sources": ["source"], "reason": "reason", "evidence": "evidence" }', validate: parseLocatedPlan, }), workspaceGuard: compute({ run: ({ input }): WorkspaceGuard => { const request = input as AutodocInput; if (request.repository !== undefined || request.preparedWorkspace !== undefined) { return { route: "ready", repository: mutationRepository(request) }; } return { route: "blocked", reason: "Updating canonical documentation requires an explicit repository path.", evidence: ["repository was not supplied", "preparedWorkspace was not supplied"], }; }, }), inspectDocumentation: agent({ statusDetail: "checking canonical documentation", prompt: (context) => { const request = context.input as AutodocInput; return [ "Check whether the selected plan is already recorded completely and accurately in the canonical specification and implementation plan.", "Use repository guidance to choose canonical files. Do not redesign or implement anything.", "Choose current only when the documents already preserve the whole selected plan and its boundaries.", "Choose update when documents are missing or stale and can be corrected in scope.", "Choose blocked only when no safe canonical target exists or repository rules prohibit the documentation change.", `Task: ${request.task}`, `Selected plan: ${JSON.stringify(currentPlan(context))}`, `Preferred documents: ${JSON.stringify(request.documents ?? [])}`, ].join("\n"); }, expectedOutput: '{ "route": "current" | "update" | "blocked", "files": ["canonical file"], "digests": { "file": "sha256:digest" }, "reason": "reason", "evidence": "evidence" }', validate: parseDocumentationAssessment, }), updateDocumentation: agent({ timeoutMs: 30 * 60_000, statusDetail: "updating canonical documentation", prompt: (context) => { const request = context.input as AutodocInput; const assessment = context.outputs.inspectDocumentation as DocumentationAssessment; return [ "Update the canonical specification and implementation plan to preserve the selected plan exactly.", "Use the repository documentation rules and keep the text plain and complete.", "Do not redesign the solution and do not implement code.", `Prepared workspace: ${JSON.stringify(preparedWorkspace(context))}`, `Task: ${request.task}`, `Selected plan: ${JSON.stringify(currentPlan(context))}`, `Canonical files: ${JSON.stringify(assessment.files)}`, `Assessment: ${JSON.stringify(assessment)}`, ].join("\n"); }, expectedOutput: '{ "updated": true, "files": ["changed file"], "digests": { "file": "sha256:digest" }, "summary": "what was recorded" }', validate: (value) => { const result = requireRecord(value, "documentation update"); if (result.updated !== true) throw new Error("documentation update must report updated: true"); stringArray(result.files, "updated documentation files"); stringRecord(result.digests, "updated documentation digests"); requireString(result.summary, "documentation update summary"); return result; }, }), finalize: compute({ run: (context) => { const request = context.input as AutodocInput; const assessment = context.outputs.inspectDocumentation as DocumentationAssessment; const plan = currentPlan(context); const updated = context.outputs.updateDocumentation; if (updated === undefined) { return { status: "ready", task: request.task, plan, planDigest: digest(plan), documentation: { state: "current", files: assessment.files, digests: assessment.digests, evidence: assessment.evidence, }, verification: { route: "ready", reason: "Canonical documentation was already current.", }, ...(request.preparedWorkspace === undefined ? {} : { workspace: request.preparedWorkspace }), } satisfies DocumentedPlan; } const updateRecord = requireRecord(updated, "documentation update"); return { status: "ready", task: request.task, plan, planDigest: digest(plan), documentation: { state: "updated", files: stringArray(updateRecord.files, "updated documentation files"), digests: stringRecord(updateRecord.digests, "updated documentation digests"), evidence: verificationResult(context), }, verification: verificationResult(context), workspace: preparedWorkspace(context), } satisfies DocumentedPlan; }, }), blocked: compute({ run: blockedReason }), }, edges: [ { from: "prepare", switch: { on: "$.route", cases: { locate: "locatePlan", inspect: "inspectDocumentation" } }, }, { from: "locatePlan", switch: { on: "$.route", cases: { found: "inspectDocumentation", blocked: "blocked" } }, }, { from: "inspectDocumentation", switch: { on: "$.route", cases: { current: "finalize", update: "workspaceGuard", blocked: "blocked" }, }, }, { from: "workspaceGuard", switch: { on: "$.route", cases: { ready: "workspace", blocked: "blocked" } }, }, { from: "workspace.ready", to: "updateDocumentation" }, { from: "workspace.blocked", to: "blocked" }, { from: "updateDocumentation", to: "verification" }, { from: "verification.ready", to: "finalize" }, { from: "verification.blocked", to: "blocked" }, ], }); export default autodocWorkflow;