@sienklogic/plan-build-run 2.1.0 → 2.1.1

package/dashboard/src/services/dashboard.service.js

@@ -1,286 +0,0 @@
-import { readFile } from 'node:fs/promises';
-import { join } from 'node:path';
-
-/**
- * Strip UTF-8 BOM from file content.
- * Duplicated from planning.repository.js intentionally --
- * this service reads raw text, not via the repository layer.
- *
- * @param {string} content - Raw file content
- * @returns {string} Content without BOM
- */
-function stripBOM(content) {
-  return content.replace(/^\uFEFF/, '');
-}
-
-/**
- * Parse STATE.md to extract project status information.
- * Uses regex on raw markdown body text (not YAML frontmatter).
- *
- * @param {string} projectDir - Absolute path to the project root
- * @returns {Promise<{projectName: string, currentPhase: object, lastActivity: object, progress: number}>}
- */
-export async function parseStateFile(projectDir) {
-  try {
-    const path = join(projectDir, '.planning', 'STATE.md');
-    const raw = await readFile(path, 'utf-8');
-    const content = stripBOM(raw).replace(/\r\n/g, '\n');
-
-    // Parse YAML frontmatter if present (STATE.md v2 format)
-    let frontmatter = {};
-    const fmMatch = content.match(/^---\n([\s\S]*?)\n---/);
-    if (fmMatch) {
-      for (const line of fmMatch[1].split('\n')) {
-        const kv = line.match(/^(\w+):\s*(.+)/);
-        if (kv) {
-          const val = kv[2].trim().replace(/^"(.*)"$/, '$1');
-          frontmatter[kv[1]] = val;
-        }
-      }
-    }
-
-    // Extract project name from **Current focus:** line
-    let projectName = 'Unknown Project';
-    const focusMatch = content.match(/\*\*Current focus:\*\*\s*(.+)/);
-    if (focusMatch) {
-      projectName = focusMatch[1].trim();
-    } else {
-      // Fallback: try H1 heading
-      const h1Match = content.match(/^# (.+)/m);
-      if (h1Match) {
-        projectName = h1Match[1].trim();
-      }
-    }
-
-    // Extract current phase: "Phase: 3 of 12 (UI Shell)"
-    let currentPhaseId = 0;
-    let totalPhases = 0;
-    let phaseName = 'Not Started';
-    const phaseMatch = content.match(/Phase:\s*(\d+)\s*of\s*(\d+)\s*\(([^)]+)\)/);
-    if (phaseMatch) {
-      currentPhaseId = parseInt(phaseMatch[1], 10);
-      totalPhases = parseInt(phaseMatch[2], 10);
-      phaseName = phaseMatch[3].trim();
-    }
-
-    // Extract plan status: "Plan: 2 of 2 complete"
-    let planStatus = 'N/A';
-    const planMatch = content.match(/Plan:\s*(.+)/);
-    if (planMatch) {
-      planStatus = planMatch[1].trim();
-    }
-
-    // Extract last activity: "Last activity: 2026-02-08 -- Phase 3 built (...)"
-    let activityDate = '';
-    let activityDescription = 'No activity recorded';
-    const activityMatch = content.match(/Last activity:\s*([\d-]+)\s*--\s*(.+)/);
-    if (activityMatch) {
-      activityDate = activityMatch[1].trim();
-      activityDescription = activityMatch[2].trim();
-    }
-
-    // Extract progress percentage: "Progress: [...] 25%"
-    let progress = 0;
-    const progressMatch = content.match(/Progress:.*?(\d+)%/);
-    if (progressMatch) {
-      progress = parseInt(progressMatch[1], 10);
-    } else if (totalPhases > 0) {
-      // Calculate from phase numbers if no explicit progress
-      progress = Math.ceil((currentPhaseId / totalPhases) * 100);
-    }
-
-    // Determine phase status from frontmatter or body text
-    // "built", "verified", "complete" all mean the current phase is done
-    const fmStatus = (frontmatter.status || '').toLowerCase();
-    const phaseStatus = ['built', 'verified', 'complete', 'reviewed'].includes(fmStatus)
-      ? 'complete'
-      : ['building', 'planning', 'planned', 'in-progress'].includes(fmStatus)
-        ? 'in-progress'
-        : fmStatus || 'unknown';
-
-    return {
-      projectName,
-      currentPhase: {
-        id: currentPhaseId,
-        total: totalPhases,
-        name: phaseName,
-        planStatus,
-        status: phaseStatus
-      },
-      lastActivity: {
-        date: activityDate,
-        description: activityDescription
-      },
-      progress
-    };
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      return {
-        projectName: 'Unknown Project',
-        currentPhase: { id: 0, total: 0, name: 'Not Started', planStatus: 'N/A', status: 'unknown' },
-        lastActivity: { date: '', description: 'No activity recorded' },
-        progress: 0
-      };
-    }
-    throw error;
-  }
-}
-
-/**
- * Parse ROADMAP.md to extract phase list from Progress table and checkbox list.
- * Uses the Progress table as primary source (contains ALL phases including those
- * added under milestone headings). Falls back to checkbox parsing for older
- * roadmaps that don't have a Progress table.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @returns {Promise<{phases: Array<{id: number, name: string, description: string, status: string}>, progress: number}>}
- */
-export async function parseRoadmapFile(projectDir) {
-  try {
-    const filePath = join(projectDir, '.planning', 'ROADMAP.md');
-    const raw = await readFile(filePath, 'utf-8');
-    const content = stripBOM(raw).replace(/\r\n/g, '\n');
-
-    // 1. Parse descriptions from checkbox list: "- [x] Phase 01: Name -- Description"
-    const checkboxMap = new Map();
-    const checkboxRegex = /^- \[([ xX])\] Phase (\d+):\s*([^-]+?)\s*--\s*(.+)$/gm;
-    for (const match of content.matchAll(checkboxRegex)) {
-      const id = parseInt(match[2], 10);
-      checkboxMap.set(id, {
-        name: match[3].trim(),
-        description: match[4].trim(),
-        status: (match[1] === 'x' || match[1] === 'X') ? 'complete' : 'not-started'
-      });
-    }
-
-    // 2. Parse descriptions from Phase Details: "### Phase NN: Name\n**Goal**: ..."
-    const goalMap = new Map();
-    const goalRegex = /### Phase (\d+):\s*(.+)\n\*\*Goal:?\*\*:?\s*(.+)/g;
-    for (const match of content.matchAll(goalRegex)) {
-      goalMap.set(parseInt(match[1], 10), match[3].trim());
-    }
-
-    // 3. Parse Progress table: "| 01. Name | 2/2 | Complete | 2026-02-08 |"
-    const progressRegex = /^\|\s*(\d+)\.\s+(.+?)\s*\|\s*(\d+)\/([\d?]+)\s*\|\s*(.+?)\s*\|\s*(.+?)\s*\|$/gm;
-    const progressPhases = [];
-    for (const match of content.matchAll(progressRegex)) {
-      const id = parseInt(match[1], 10);
-      const name = match[2].trim();
-      const statusText = match[5].trim().toLowerCase();
-
-      // Get description: prefer checkbox description, fall back to Phase Details Goal
-      const cbInfo = checkboxMap.get(id);
-      const goalDesc = goalMap.get(id);
-      const description = cbInfo?.description || goalDesc || '';
-
-      let status;
-      if (statusText === 'complete') status = 'complete';
-      else if (statusText === 'in progress') status = 'in-progress';
-      else status = 'not-started';
-
-      progressPhases.push({ id, name, description, status });
-    }
-
-    // 4. Parse H3 Phase Details: "### Phase N: Name\n**Goal:** ..."
-    const h3Phases = [];
-    const h3Regex = /### Phase (\d+):\s*(.+)\n\*\*Goal\*?\*?:?\*?\*?\s*(.+)/g;
-    for (const match of content.matchAll(h3Regex)) {
-      const id = parseInt(match[1], 10);
-      const name = match[2].trim();
-      const description = match[3].trim();
-      // Check checkbox map for status, default to not-started
-      const cbInfo = checkboxMap.get(id);
-      h3Phases.push({
-        id,
-        name,
-        description,
-        status: cbInfo?.status || 'not-started'
-      });
-    }
-
-    // Use Progress table if available, then checkbox list, then H3 headings
-    let phases;
-    if (progressPhases.length > 0) {
-      phases = progressPhases;
-    } else if (checkboxMap.size > 0) {
-      phases = [...checkboxMap.entries()]
-        .map(([id, info]) => ({
-          id,
-          name: info.name,
-          description: info.description,
-          status: info.status
-        }))
-        .sort((a, b) => a.id - b.id);
-    } else {
-      phases = h3Phases.sort((a, b) => a.id - b.id);
-    }
-
-    const completed = phases.filter(p => p.status === 'complete').length;
-    const total = phases.length;
-    const progress = total > 0 ? Math.ceil((completed / total) * 100) : 0;
-
-    return { phases, progress };
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      return { phases: [], progress: 0 };
-    }
-    throw error;
-  }
-}
-
-/**
- * Get combined dashboard data by parsing both STATE.md and ROADMAP.md.
- * Orchestrates both parsers in parallel and derives in-progress status.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @returns {Promise<{projectName: string, currentPhase: object, lastActivity: object, progress: number, phases: Array}>}
- */
-/**
- * Derive phase statuses by combining roadmap phases with STATE.md context.
- * Phases before the current phase are marked complete.
- * The current phase gets its status from STATE.md.
- * Phases after the current phase keep their roadmap status (typically not-started).
- *
- * @param {Array} phases - Raw phases from parseRoadmapFile
- * @param {{id: number, status: string}} currentPhase - Current phase from parseStateFile
- * @returns {Array} Phases with derived statuses
- */
-export function derivePhaseStatuses(phases, currentPhase) {
-  const currentId = currentPhase.id;
-  const currentStatus = currentPhase.status || 'unknown';
-  return phases.map(phase => {
-    // If the roadmap already has explicit status (from progress table/checkboxes), keep it
-    if (phase.status === 'complete') return phase;
-
-    if (phase.id < currentId) {
-      return { ...phase, status: 'complete' };
-    }
-    if (phase.id === currentId) {
-      return { ...phase, status: currentStatus === 'complete' ? 'complete' : 'in-progress' };
-    }
-    return phase;
-  });
-}
-
-export async function getDashboardData(projectDir) {
-  const [stateData, roadmapData] = await Promise.all([
-    parseStateFile(projectDir),
-    parseRoadmapFile(projectDir)
-  ]);
-
-  const phases = derivePhaseStatuses(roadmapData.phases, stateData.currentPhase);
-
-  // Recalculate progress from derived phase statuses
-  const completedPhases = phases.filter(p => p.status === 'complete').length;
-  const progress = phases.length > 0
-    ? Math.ceil((completedPhases / phases.length) * 100)
-    : stateData.progress;
-
-  return {
-    projectName: stateData.projectName,
-    currentPhase: stateData.currentPhase,
-    lastActivity: stateData.lastActivity,
-    progress,
-    phases
-  };
-}

package/dashboard/src/services/phase.service.js

@@ -1,226 +0,0 @@
-import { readdir } from 'node:fs/promises';
-import { join } from 'node:path';
-import { readMarkdownFile, validatePath } from '../repositories/planning.repository.js';
-
-/**
- * Format a phase directory name into a human-readable title.
- * Strips the numeric prefix and title-cases each word.
- *
- * @param {string} dirName - Directory name like "04-dashboard-landing-page"
- * @returns {string} Formatted name like "Dashboard Landing Page"
- */
-function formatPhaseName(dirName) {
-  const parts = dirName.split('-');
-  // Remove the numeric prefix (first element)
-  parts.shift();
-  return parts
-    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
-    .join(' ');
-}
-
-/**
- * Parse the "Task Results" markdown table from a SUMMARY.md body.
- * Returns an array of commit objects extracted from the table rows.
- *
- * Expected table format (produced by pbr executor):
- * | Task | Status | Commit | Files | Verify |
- * |------|--------|--------|-------|--------|
- * | 05-01-T1: Create phase.service.js | done | 2a52581 | 1 | passed |
- *
- * @param {string} rawContent - The markdown body content (after frontmatter)
- * @returns {Array<{task: string, status: string, hash: string, files: number, verify: string}>}
- */
-export function parseTaskResultsTable(rawContent) {
-  if (!rawContent) return [];
-
-  // Find the Task Results section. The table may be followed by another section,
-  // a blank line, or EOF. Use a non-greedy match to capture just the table block.
-  const sectionRegex = /## Task Results\s*\n([\s\S]*?)(?=\n##\s|\n\n\n|$)/;
-  const sectionMatch = rawContent.match(sectionRegex);
-  if (!sectionMatch) return [];
-
-  const tableBlock = sectionMatch[1].trim();
-  const lines = tableBlock.split('\n');
-
-  // Need at least header row + separator row + 1 data row = 3 lines
-  if (lines.length < 3) return [];
-
-  // Skip header row (index 0) and separator row (index 1)
-  const dataRows = lines.slice(2);
-  const commits = [];
-
-  for (const row of dataRows) {
-    // Split by pipe, trim, filter out empty strings from leading/trailing pipes
-    const cells = row.split('|').map(c => c.trim()).filter(c => c);
-    if (cells.length < 5) continue;
-
-    const hash = cells[2];
-    // Skip rows where commit is empty, a dash, or not a hex string
-    if (!hash || hash === '-' || hash === '' || !/^[0-9a-f]{5,40}$/i.test(hash)) continue;
-
-    commits.push({
-      task: cells[0],
-      status: cells[1],
-      hash: hash,
-      files: parseInt(cells[3], 10) || 0,
-      verify: cells[4]
-    });
-  }
-
-  return commits;
-}
-
-/**
- * Get detailed information about a specific phase, including all plans,
- * their summaries, and verification status.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @param {string} phaseId - Two-digit phase identifier (e.g., "04")
- * @returns {Promise<{phaseId: string, phaseName: string, phaseDir: string|null, plans: Array, verification: object|null}>}
- */
-export async function getPhaseDetail(projectDir, phaseId) {
-  const emptyState = { phaseId, phaseName: 'Unknown', phaseDir: null, plans: [], verification: null };
-  const phasesDir = join(projectDir, '.planning', 'phases');
-
-  let phaseDirEntries;
-  try {
-    phaseDirEntries = await readdir(phasesDir, { withFileTypes: true });
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      return emptyState;
-    }
-    throw error;
-  }
-
-  // Find the directory matching this phaseId (prefer longest name to handle stale renames)
-  const phaseDir = phaseDirEntries
-    .filter(entry => entry.isDirectory() && entry.name.startsWith(`${phaseId}-`))
-    .sort((a, b) => b.name.length - a.name.length)
-    [0];
-
-  if (!phaseDir) {
-    return emptyState;
-  }
-
-  const phaseName = formatPhaseName(phaseDir.name);
-  const phaseFullPath = join(phasesDir, phaseDir.name);
-
-  // Read files in the phase directory
-  const phaseFiles = await readdir(phaseFullPath);
-
-  // Filter and sort PLAN.md files
-  // Supports both naming conventions:
-  //   - NN-NN-PLAN.md (plan ID embedded in filename)
-  //   - PLAN.md (single plan per phase, ID derived from phase directory)
-  const planRegex = /^(?:\d{2}-\d{2}-)?PLAN\.md$/;
-  const planFiles = phaseFiles
-    .filter(f => planRegex.test(f))
-    .sort();
-
-  // Build summary paths and read them in parallel
-  // Derive planId from filename (NN-NN-PLAN.md) or phase directory (PLAN.md -> NN-01)
-  const summaryPaths = planFiles.map((planFile, index) => {
-    const idMatch = planFile.match(/^(\d{2}-\d{2})-PLAN\.md$/);
-    const planId = idMatch ? idMatch[1] : `${phaseId.padStart(2, '0')}-${String(index + 1).padStart(2, '0')}`;
-    return { planId, planFile, summaryPath: join(phaseFullPath, `SUMMARY-${planId}.md`) };
-  });
-
-  const summaryResults = await Promise.allSettled(
-    summaryPaths.map(({ summaryPath }) => readMarkdownFile(summaryPath))
-  );
-
-  // Map results to plan objects
-  const plans = summaryPaths.map(({ planId, planFile }, index) => {
-    const result = summaryResults[index];
-    if (result.status === 'fulfilled') {
-      return {
-        planId,
-        planFile,
-        summary: result.value.frontmatter,
-        content: result.value.html,
-        commits: parseTaskResultsTable(result.value.rawContent)
-      };
-    }
-    if (result.reason && result.reason.code === 'ENOENT') {
-      return { planId, planFile, summary: null, content: null, commits: [] };
-    }
-    // Unexpected error -- re-throw
-    throw result.reason;
-  });
-
-  // Read VERIFICATION.md
-  let verification = null;
-  try {
-    const verDoc = await readMarkdownFile(join(phaseFullPath, 'VERIFICATION.md'));
-    verification = verDoc.frontmatter;
-  } catch (error) {
-    if (error.code !== 'ENOENT') {
-      throw error;
-    }
-    // ENOENT -> verification stays null
-  }
-
-  return {
-    phaseId,
-    phaseName,
-    phaseDir: phaseDir.name,
-    plans,
-    verification
-  };
-}
-
-/**
- * Read and render a PLAN.md or SUMMARY.md file for a specific phase and plan.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @param {string} phaseId - Two-digit phase identifier (e.g., "04")
- * @param {string} planId - Plan identifier (e.g., "04-01")
- * @param {'plan'|'summary'} docType - Which document to read
- * @returns {Promise<{phaseId: string, planId: string, docType: string, phaseName: string, frontmatter: object, html: string}|null>}
- */
-export async function getPhaseDocument(projectDir, phaseId, planId, docType) {
-  const phasesDir = join(projectDir, '.planning', 'phases');
-
-  let phaseDirEntries;
-  try {
-    phaseDirEntries = await readdir(phasesDir, { withFileTypes: true });
-  } catch (error) {
-    if (error.code === 'ENOENT') return null;
-    throw error;
-  }
-
-  const phaseDir = phaseDirEntries
-    .filter(entry => entry.isDirectory() && entry.name.startsWith(`${phaseId}-`))
-    .sort((a, b) => b.name.length - a.name.length)
-    [0];
-
-  if (!phaseDir) return null;
-
-  const phaseName = formatPhaseName(phaseDir.name);
-  const phaseFullPath = join(phasesDir, phaseDir.name);
-
-  // Try plan ID-prefixed filename first, then fall back to plain PLAN.md
-  // Supports both "01-01-PLAN.md" and "PLAN.md" naming conventions
-  const fileNames = docType === 'plan'
-    ? [`${planId}-PLAN.md`, 'PLAN.md']
-    : [`SUMMARY-${planId}.md`];
-
-  for (const fileName of fileNames) {
-    const filePath = validatePath(phaseFullPath, fileName);
-    try {
-      const doc = await readMarkdownFile(filePath);
-      return {
-        phaseId,
-        planId,
-        docType,
-        phaseName,
-        frontmatter: doc.frontmatter,
-        html: doc.html
-      };
-    } catch (error) {
-      if (error.code === 'ENOENT') continue;
-      throw error;
-    }
-  }
-  return null;
-}

package/dashboard/src/services/project.service.js

@@ -1,57 +0,0 @@
-import { join, resolve, relative } from 'node:path';
-import { readMarkdownFile, listPlanningFiles } from '../repositories/planning.repository.js';
-
-/**
- * Get homepage data for the dashboard.
- * Reads .planning/README.md if it exists, returns fallback data if not.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @returns {Promise<{title: string, projectDir: string, content: string}>}
- */
-export async function getHomepage(projectDir) {
-  try {
-    const readmePath = join(projectDir, '.planning', 'README.md');
-    const { frontmatter, html } = await readMarkdownFile(readmePath);
-
-    return {
-      title: frontmatter.title || 'PBR Dashboard',
-      projectDir,
-      content: html
-    };
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      return {
-        title: 'Welcome',
-        projectDir,
-        content: '<p>No project README found.</p>'
-      };
-    }
-    throw error;
-  }
-}
-
-/**
- * Read a specific markdown file from within the .planning/ directory.
- * Validates that the resolved path stays within .planning/ to prevent
- * path traversal attacks.
- *
- * @param {string} projectDir - Absolute path to the project root
- * @param {string} relativePath - Path relative to .planning/ (e.g., 'phases/01/PLAN.md')
- * @returns {Promise<{frontmatter: object, html: string, rawContent: string}>}
- * @throws {Error} If path escapes .planning/ or file not found
- */
-export async function getMarkdownFile(projectDir, relativePath) {
-  const planningDir = resolve(projectDir, '.planning');
-  const filePath = resolve(planningDir, relativePath);
-
-  // Path traversal protection: ensure resolved path is under .planning/
-  const rel = relative(planningDir, filePath);
-  if (rel.startsWith('..') || resolve(filePath) !== filePath && rel.startsWith('..')) {
-    const err = new Error('Path traversal not allowed: path escapes .planning/ directory');
-    err.code = 'PATH_TRAVERSAL';
-    err.status = 403;
-    throw err;
-  }
-
-  return readMarkdownFile(filePath);
-}