pi-workflow-engine 0.2.0 → 0.4.0

package/src/index.ts

@@ -1,141 +0,0 @@
-import { fileURLToPath } from "node:url";
-import { Type } from "typebox";
-import type { ExtensionAPI, ExtensionCommandContext } from "@earendil-works/pi-coding-agent";
-import { Text } from "@earendil-works/pi-tui";
-import { discoverWorkflows } from "./discovery.ts";
-import { runWorkflow } from "./engine.ts";
-import type { WorkflowModule, WorkflowRunOptions } from "./types.ts";
-import { isWorkflowResult, renderWorkflowResult, type WorkflowResultEnvelope } from "./ui/workflow-result-renderer.ts";
-
-/** Repo root (this file lives in <repo>/src/index.ts). */
-const REPO_DIR = fileURLToPath(new URL("..", import.meta.url));
-
-function summarize(result: unknown): string {
-  if (result && typeof result === "object" && typeof (result as { summary?: unknown }).summary === "string") {
-    return (result as { summary: string }).summary;
-  }
-  return typeof result === "string" ? result : "Workflow finished.";
-}
-
-function formatReport(name: string, result: unknown): string {
-  return [`## Workflow: ${name}`, "", "```json", JSON.stringify(result, null, 2), "```"].join("\n");
-}
-
-function workflowEnvelope(name: string, result: unknown): WorkflowResultEnvelope {
-  return { name, result, completedAt: Date.now() };
-}
-
-interface WorkflowInvocation {
-  name: string;
-  args: string;
-  options: WorkflowRunOptions;
-}
-
-function parseWorkflowInvocation(input: string): WorkflowInvocation {
-  const trimmed = input.trim();
-  const space = trimmed.indexOf(" ");
-  const name = space === -1 ? trimmed : trimmed.slice(0, space);
-  const rest = space === -1 ? "" : trimmed.slice(space + 1).trim();
-  const inspect = /(?:^|\s)--inspect(?:\s|$)/.test(rest);
-  const cleanedArgs = rest.replace(/(?:^|\s)--inspect(?=\s|$)/g, " ").trim();
-  return { name, args: cleanedArgs, options: inspect ? { inspect: true } : {} };
-}
-
-async function pickWorkflow(
-  workflows: ReadonlyMap<string, WorkflowModule>,
-  ctx: ExtensionCommandContext,
-): Promise<WorkflowInvocation | undefined> {
-  const choices = [...workflows.values()].map((mod) => `${mod.meta.name} — ${mod.meta.description}`);
-  const choice = await ctx.ui.select("Run workflow", choices);
-  if (!choice) return undefined;
-
-  const separator = choice.indexOf(" — ");
-  const name = separator === -1 ? choice : choice.slice(0, separator);
-  const args = name === "code-review" ? (await ctx.ui.input("Code-review target/instructions", "Blank = auto-detect diff"))?.trim() ?? "" : "";
-  const inspect = await ctx.ui.confirm("Open inspector?", "Open a live workflow inspector while this workflow runs?");
-  return { name, args, options: { inspect } };
-}
-
-async function sendWorkflowResult(
-  pi: ExtensionAPI,
-  ctx: ExtensionCommandContext,
-  name: string,
-  mod: WorkflowModule,
-  args: string,
-  options: WorkflowRunOptions,
-): Promise<void> {
-  const result = await runWorkflow(ctx, mod, args, options);
-  pi.sendMessage(
-    { customType: "workflow-result", content: formatReport(name, result), display: true, details: workflowEnvelope(name, result) },
-    { triggerTurn: false },
-  );
-}
-
-export default function workflowEngine(pi: ExtensionAPI): void {
-  pi.registerMessageRenderer("workflow-result", (message, { expanded }, theme) => {
-    const details = message.details;
-    if (isWorkflowResult(details)) return renderWorkflowResult(details.name, details.result, expanded, theme);
-    return renderWorkflowResult("workflow", details ?? message.content, expanded, theme);
-  });
-
-  // /workflow <name> [args] — user-invoked.
-  pi.registerCommand("workflow", {
-    description: "Run a multi-agent workflow: /workflow <name> [args]",
-    handler: async (args: string, ctx: ExtensionCommandContext) => {
-      const workflows = await discoverWorkflows(REPO_DIR);
-      const available = [...workflows.keys()].join(", ") || "(none)";
-      const direct = parseWorkflowInvocation(args);
-      const invocation = direct.name ? direct : ctx.hasUI ? await pickWorkflow(workflows, ctx) : undefined;
-
-      if (!invocation) {
-        ctx.ui.notify(`Usage: /workflow <name> [args]. Available: ${available}`, "warning");
-        return;
-      }
-
-      const mod = workflows.get(invocation.name);
-      if (!mod) {
-        ctx.ui.notify(`Unknown workflow "${invocation.name}". Available: ${available}`, "error");
-        return;
-      }
-
-      await sendWorkflowResult(pi, ctx, invocation.name, mod, invocation.args, invocation.options);
-    },
-  });
-
-  // workflow tool — lets the host agent fan out mid-conversation.
-  pi.registerTool({
-    name: "workflow",
-    label: "Workflow",
-    description:
-      "Run a named multi-agent workflow (fan-out → verify → synthesize) and return its structured result. Use for thorough reviews or audits.",
-    parameters: Type.Object({
-      name: Type.String({ description: "Workflow name, e.g. code-review" }),
-      args: Type.Optional(Type.String({ description: "Arguments for the workflow (e.g. target or focus)" })),
-    }),
-    renderCall(args, theme) {
-      const suffix = args.args ? ` ${theme.fg("dim", args.args)}` : "";
-      return new Text(`▸ ${theme.fg("toolTitle", theme.bold("workflow"))} ${theme.fg("accent", args.name)}${suffix}`, 0, 0);
-    },
-    renderResult(result, { expanded, isPartial }, theme) {
-      if (isPartial) return new Text(theme.fg("accent", "Running workflow…"), 0, 0);
-      const details = result.details;
-      if (isWorkflowResult(details)) return renderWorkflowResult(details.name, details.result, expanded, theme);
-      const first = result.content[0];
-      const text = first?.type === "text" ? first.text : "Workflow finished.";
-      return new Text(theme.fg("muted", text), 0, 0);
-    },
-    async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
-      const workflows = await discoverWorkflows(REPO_DIR);
-      const mod = workflows.get(params.name);
-      if (!mod) {
-        const available = [...workflows.keys()].join(", ") || "(none)";
-        return {
-          content: [{ type: "text", text: `Unknown workflow "${params.name}". Available: ${available}` }],
-          details: { error: "unknown_workflow", available },
-        };
-      }
-      const result = await runWorkflow(ctx, mod, params.args ?? "");
-      return { content: [{ type: "text", text: summarize(result) }], details: workflowEnvelope(params.name, result) };
-    },
-  });
-}

package/src/ui/workflow-result-renderer.ts

@@ -1,149 +0,0 @@
-import type { Theme } from "@earendil-works/pi-coding-agent";
-import { Box, type Component, Text } from "@earendil-works/pi-tui";
-import { badge, formatCount } from "./workflow-format.ts";
-
-export interface WorkflowResultEnvelope {
-  name: string;
-  result: unknown;
-  completedAt: number;
-}
-
-export interface CodeReviewFinding {
-  file: string;
-  line?: number;
-  severity?: string;
-  verdict?: string;
-  summary: string;
-  evidence?: string;
-  failure_scenario?: string;
-}
-
-export interface CodeReviewResult {
-  summary: string;
-  findings: CodeReviewFinding[];
-  stats?: Record<string, string | number>;
-}
-
-export function isWorkflowResult(value: unknown): value is WorkflowResultEnvelope {
-  if (!isRecord(value)) return false;
-  return typeof value.name === "string" && "result" in value && typeof value.completedAt === "number";
-}
-
-export function isFinding(value: unknown): value is CodeReviewFinding {
-  if (!isRecord(value)) return false;
-  if (typeof value.file !== "string" || typeof value.summary !== "string") return false;
-  if (value.line !== undefined && typeof value.line !== "number") return false;
-  if (value.severity !== undefined && typeof value.severity !== "string") return false;
-  if (value.verdict !== undefined && typeof value.verdict !== "string") return false;
-  if (value.evidence !== undefined && typeof value.evidence !== "string") return false;
-  if (value.failure_scenario !== undefined && typeof value.failure_scenario !== "string") return false;
-  return true;
-}
-
-export function isCodeReviewResult(value: unknown): value is CodeReviewResult {
-  if (!isRecord(value)) return false;
-  if (typeof value.summary !== "string" || !Array.isArray(value.findings)) return false;
-  if (!value.findings.every(isFinding)) return false;
-  if (value.stats !== undefined && !isStats(value.stats)) return false;
-  return true;
-}
-
-export function renderWorkflowResult(name: string, result: unknown, expanded: boolean, theme: Theme): Component {
-  const box = new Box(1, 1, (text) => theme.bg("customMessageBg", text));
-  box.addChild(new Text(renderWorkflowResultText(name, result, expanded, theme), 0, 0));
-  return box;
-}
-
-export function renderWorkflowResultText(name: string, result: unknown, expanded: boolean, theme: Theme): string {
-  if (name === "code-review" && isCodeReviewResult(result)) {
-    return renderCodeReviewResult(name, result, expanded, theme);
-  }
-  return renderGenericWorkflowResult(name, result, expanded, theme);
-}
-
-function renderCodeReviewResult(name: string, result: CodeReviewResult, expanded: boolean, theme: Theme): string {
-  const icon = theme.fg("success", "✓");
-  const title = theme.fg("accent", theme.bold(`Workflow: ${name}`));
-  const lines = [`${icon} ${title}`, theme.fg("muted", result.summary)];
-  const stats = statsLine(result.stats, theme);
-  if (stats) lines.push(stats);
-
-  if (result.findings.length === 0) {
-    lines.push(theme.fg("success", "No findings."));
-    return lines.join("\n");
-  }
-
-  const findings = expanded ? result.findings : result.findings.slice(0, 3);
-  lines.push(theme.fg("dim", expanded ? "Findings:" : "Top findings:"));
-  for (const finding of findings) {
-    lines.push(renderFinding(finding, expanded, theme));
-  }
-  if (!expanded && result.findings.length > findings.length) {
-    lines.push(theme.fg("dim", `… ${result.findings.length - findings.length} more finding(s)`));
-  }
-  return lines.join("\n");
-}
-
-function renderFinding(finding: CodeReviewFinding, expanded: boolean, theme: Theme): string {
-  const location = `${finding.file}${finding.line != null ? `:${finding.line}` : ""}`;
-  const severityColor = finding.severity === "bug" ? "error" : "warning";
-  const verdictColor = finding.verdict === "CONFIRMED" ? "success" : finding.verdict === "PLAUSIBLE" ? "warning" : "muted";
-  let text =
-    `  ${badge(finding.severity ?? "finding", severityColor, theme)} ` +
-    `${badge(finding.verdict ?? "", verdictColor, theme)} ` +
-    `${theme.fg("accent", location)} ${theme.fg("muted", finding.summary)}`;
-  if (expanded) {
-    if (finding.failure_scenario) text += `\n    ${theme.fg("dim", `Failure: ${finding.failure_scenario}`)}`;
-    if (finding.evidence) text += `\n    ${theme.fg("dim", `Evidence: ${finding.evidence}`)}`;
-  }
-  return text;
-}
-
-function renderGenericWorkflowResult(name: string, result: unknown, expanded: boolean, theme: Theme): string {
-  const lines = [`${theme.fg("success", "✓")} ${theme.fg("accent", theme.bold(`Workflow: ${name}`))}`];
-  const summary = extractSummary(result);
-  if (summary) lines.push(theme.fg("muted", summary));
-  if (expanded) lines.push(theme.fg("dim", safeJson(result)));
-  else if (!summary) lines.push(theme.fg("dim", compactJson(result)));
-  return lines.join("\n");
-}
-
-function statsLine(stats: Record<string, string | number> | undefined, theme: Theme): string | undefined {
-  if (!stats) return undefined;
-  const ordered = ["files", "candidates", "dropped", "verified", "kept"];
-  const parts = ordered.flatMap((key) => {
-    const value = stats[key];
-    if (value === undefined) return [];
-    return [`${key} ${typeof value === "number" ? formatCount(value) : value}`];
-  });
-  if (parts.length === 0) return undefined;
-  return theme.fg("dim", parts.join(" · "));
-}
-
-function extractSummary(value: unknown): string | undefined {
-  if (typeof value === "string") return value;
-  if (isRecord(value) && typeof value.summary === "string") return value.summary;
-  return undefined;
-}
-
-function compactJson(value: unknown): string {
-  const json = safeJson(value).replace(/\s+/g, " ").trim();
-  return json.length > 240 ? `${json.slice(0, 237)}...` : json;
-}
-
-function safeJson(value: unknown): string {
-  try {
-    return JSON.stringify(value, null, 2) ?? String(value);
-  } catch (error) {
-    return error instanceof Error ? error.message : String(error);
-  }
-}
-
-function isStats(value: unknown): value is Record<string, string | number> {
-  if (!isRecord(value)) return false;
-  return Object.values(value).every((entry) => typeof entry === "string" || typeof entry === "number");
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null;
-}

package/src/ui/workflow-widget.ts

@@ -1,143 +0,0 @@
-import type { Theme } from "@earendil-works/pi-coding-agent";
-import type { AgentRowSnapshot, PhaseSnapshot, WorkflowProgressSnapshot } from "../progress.ts";
-import { formatCount, formatDuration, statusIcon, truncateDisplay } from "./workflow-format.ts";
-
-const MAX_WIDGET_LINES = 12;
-const SPINNER = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
-
-export interface WorkflowWidget {
-  nextFrame(): void;
-  render(width: number, theme: Theme): string[];
-  invalidate(): void;
-}
-
-export function createWorkflowWidget(snapshotProvider: () => WorkflowProgressSnapshot): WorkflowWidget {
-  return new LiveWorkflowWidget(snapshotProvider);
-}
-
-export function renderWorkflowWidgetLines(
-  snapshot: WorkflowProgressSnapshot,
-  frame: number,
-  width: number,
-  theme: Theme,
-): string[] {
-  const safeWidth = Math.max(1, width);
-  const agents = snapshot.phases.flatMap((phase) => phase.agents);
-  const running = agents.filter((agent) => agent.status === "running").length;
-  const queued = agents.filter((agent) => agent.status === "queued").length;
-  const done = agents.filter((agent) => agent.status === "done").length;
-  const failed = agents.filter((agent) => agent.status === "failed").length;
-  const active = running + queued;
-  const elapsed = formatDuration((snapshot.doneAt ?? Date.now()) - snapshot.startedAt);
-  const spinner = active > 0 ? theme.fg("accent", SPINNER[frame % SPINNER.length]) : theme.fg("success", "✓");
-
-  const headingParts = [`${done}/${agents.length} done`, elapsed];
-  if (running > 0) headingParts.unshift(`${running} running`);
-  if (queued > 0) headingParts.unshift(`${queued} queued`);
-  if (failed > 0) headingParts.unshift(theme.fg("error", `${failed} failed`));
-
-  const lines: string[] = [
-    truncateDisplay(
-      `${spinner} ${theme.bold(snapshot.title)} ${theme.fg("dim", "·")} ${theme.fg("muted", snapshot.currentPhase)} ${theme.fg("dim", "·")} ${headingParts.join(` ${theme.fg("dim", "·")} `)}`,
-      safeWidth,
-    ),
-  ];
-
-  const footer = footerLine(snapshot, theme);
-  const bodyBudget = Math.max(0, MAX_WIDGET_LINES - lines.length - (footer ? 1 : 0));
-  const bodyLines = prioritizedBodyLines(snapshot.phases, theme);
-  const visibleBody = bodyLines.slice(0, bodyBudget);
-  const hidden = bodyLines.length - visibleBody.length;
-
-  for (const line of visibleBody) lines.push(truncateDisplay(line, safeWidth));
-  if (hidden > 0 && lines.length < MAX_WIDGET_LINES) {
-    lines.push(truncateDisplay(`${theme.fg("dim", "└─")} ${theme.fg("dim", `+${hidden} more`)}`, safeWidth));
-  }
-  if (footer && lines.length < MAX_WIDGET_LINES) lines.push(truncateDisplay(footer, safeWidth));
-
-  return lines.slice(0, MAX_WIDGET_LINES).map((line) => truncateDisplay(line, safeWidth));
-}
-
-class LiveWorkflowWidget implements WorkflowWidget {
-  private frame = 0;
-  private cachedWidth: number | undefined;
-  private cachedFrame: number | undefined;
-  private cachedDoneAt: number | undefined;
-  private cachedLines: string[] | undefined;
-
-  constructor(private readonly snapshotProvider: () => WorkflowProgressSnapshot) {}
-
-  nextFrame(): void {
-    this.frame = (this.frame + 1) % SPINNER.length;
-    this.invalidate();
-  }
-
-  render(width: number, theme: Theme): string[] {
-    const snapshot = this.snapshotProvider();
-    if (
-      this.cachedLines &&
-      this.cachedWidth === width &&
-      this.cachedFrame === this.frame &&
-      this.cachedDoneAt === snapshot.doneAt
-    ) {
-      return this.cachedLines;
-    }
-
-    this.cachedLines = renderWorkflowWidgetLines(snapshot, this.frame, width, theme);
-    this.cachedWidth = width;
-    this.cachedFrame = this.frame;
-    this.cachedDoneAt = snapshot.doneAt;
-    return this.cachedLines;
-  }
-
-  invalidate(): void {
-    this.cachedWidth = undefined;
-    this.cachedFrame = undefined;
-    this.cachedDoneAt = undefined;
-    this.cachedLines = undefined;
-  }
-}
-
-function prioritizedBodyLines(phases: readonly PhaseSnapshot[], theme: Theme): string[] {
-  const activePhases = phases.filter((phase) => phase.agents.some((agent) => agent.status === "running" || agent.status === "queued"));
-  const inactivePhases = phases.filter((phase) => !activePhases.includes(phase));
-  return [...activePhases, ...inactivePhases].flatMap((phase) => phaseLines(phase, theme));
-}
-
-function phaseLines(phase: PhaseSnapshot, theme: Theme): string[] {
-  if (phase.agents.length === 0 && phase.title === "Workflow") return [];
-  const running = phase.agents.filter((agent) => agent.status === "running").length;
-  const done = phase.agents.filter((agent) => agent.status === "done").length;
-  const failed = phase.agents.filter((agent) => agent.status === "failed").length;
-  const parts: string[] = [];
-  if (running > 0) parts.push(`${running} running`);
-  if (done > 0) parts.push(`${done} done`);
-  if (failed > 0) parts.push(`${failed} failed`);
-
-  const lines = [`${theme.fg("dim", "├─")} ${theme.fg(running > 0 ? "accent" : "muted", phase.title)}${parts.length ? ` ${theme.fg("dim", `(${parts.join(" · ")})`)}` : ""}`];
-  const active = phase.agents.filter((agent) => agent.status === "running" || agent.status === "queued");
-  const failedAgents = phase.agents.filter((agent) => agent.status === "failed");
-  const completed = phase.agents.filter((agent) => agent.status === "done");
-  for (const agent of [...active, ...failedAgents, ...completed]) lines.push(agentLine(agent, theme));
-  return lines;
-}
-
-function agentLine(agent: AgentRowSnapshot, theme: Theme): string {
-  const detailParts: string[] = [];
-  if (agent.toolUses > 0) detailParts.push(`${agent.toolUses} tool${agent.toolUses === 1 ? "" : "s"}`);
-  if (agent.status === "running" && agent.lastTool) detailParts.push(agent.lastTool);
-  if (agent.startedAt !== undefined) detailParts.push(formatDuration((agent.doneAt ?? Date.now()) - agent.startedAt));
-  if (agent.status === "failed" && agent.error) detailParts.push(agent.error);
-
-  const activity = detailParts.length > 0 ? ` ${theme.fg("dim", `· ${detailParts.join(" · ")}`)}` : "";
-  return `${theme.fg("dim", "│  ")} ${statusIcon(agent.status, theme)} ${theme.fg(agent.status === "running" ? "text" : "muted", agent.label)}${activity}`;
-}
-
-function footerLine(snapshot: WorkflowProgressSnapshot, theme: Theme): string | undefined {
-  const counters = snapshot.counters.slice(0, 4).map((counter) => `${counter.label} ${formatCount(counter.value)}`);
-  const latestLog = snapshot.logs[snapshot.logs.length - 1];
-  const parts = counters.length > 0 ? counters : [];
-  if (latestLog) parts.push(latestLog);
-  if (parts.length === 0) return undefined;
-  return `${theme.fg("dim", "└─")} ${theme.fg("dim", parts.join(" · "))}`;
-}

package/src/workflows.ts

@@ -1,14 +0,0 @@
-import type { WorkflowModule } from "./types.ts";
-import * as codeReview from "../workflows/code-review.ts";
-import * as ping from "../workflows/ping.ts";
-
-/**
- * Workflows statically imported by the extension. These are loaded through pi's own
- * jiti instance (because they're part of the extension's module graph), so they share
- * pi's bundled `typebox` / SDK — guaranteeing schema validation works.
- *
- * To add a guaranteed workflow: drop a `.ts` in `workflows/`, import it here, and add
- * it to this array. (Drop-in workflows discovered at runtime are also supported — see
- * discovery.ts — but the static registry is the always-correct path.)
- */
-export const BUILTIN_WORKFLOWS: WorkflowModule[] = [codeReview, ping];