@doccov/api 0.5.0 → 0.6.0

package/src/routes/demo.ts

@@ -3,6 +3,7 @@
  * Uses the /plan and /execute-stream endpoints from the Vercel API
  */
 
+import { fetchGitHubContext, parseScanGitHubUrl } from '@doccov/sdk';
 import { Hono } from 'hono';
 import { streamSSE } from 'hono/streaming';
 import { anonymousRateLimit } from '../middleware/anonymous-rate-limit';
@@ -86,20 +87,85 @@ async function fetchNpmPackage(packageName: string): Promise<NpmPackageInfo> {
 }
 
 /**
- * Analysis result summary (matches SpecSummary from Vercel API)
+ * Analysis result summary (matches SDK CoverageSnapshot naming)
  */
 interface AnalysisSummary {
   packageName: string;
   version: string;
-  coverage: number;
-  exportCount: number;
-  documentedCount: number;
-  undocumentedCount: number;
+  coverageScore: number;
+  totalExports: number;
+  documentedExports: number;
   driftCount: number;
   topUndocumented: string[];
   topDrift: Array<{ name: string; issue: string }>;
 }
 
+/**
+ * Workspace package info for monorepo detection
+ */
+interface WorkspacePackageInfo {
+  name: string;
+  path: string;
+  private: boolean;
+}
+
+/**
+ * Resolve workspace patterns to actual package names via GitHub API.
+ * Fetches package.json from each directory to get real package names.
+ */
+async function resolveGitHubPackages(
+  owner: string,
+  repo: string,
+  ref: string,
+  patterns: string[],
+): Promise<WorkspacePackageInfo[]> {
+  const packages: WorkspacePackageInfo[] = [];
+  const seen = new Set<string>();
+
+  for (const pattern of patterns) {
+    // Extract base directory from pattern: "packages/*" -> "packages"
+    const baseDir = pattern.replace(/\/?\*\*?$/, '');
+    if (!baseDir || baseDir.includes('*')) continue;
+
+    // List directories via GitHub API
+    const contentsUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${baseDir}?ref=${ref}`;
+    const contentsRes = await fetch(contentsUrl, {
+      headers: { 'User-Agent': 'DocCov', Accept: 'application/vnd.github.v3+json' },
+    });
+
+    if (!contentsRes.ok) continue;
+
+    const contents = (await contentsRes.json()) as Array<{ name: string; type: string }>;
+
+    // Fetch package.json from each subdirectory
+    for (const item of contents) {
+      if (item.type !== 'dir') continue;
+
+      const pkgPath = `${baseDir}/${item.name}`;
+      const pkgJsonUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${ref}/${pkgPath}/package.json`;
+
+      try {
+        const pkgRes = await fetch(pkgJsonUrl);
+        if (!pkgRes.ok) continue;
+
+        const pkg = (await pkgRes.json()) as { name?: string; private?: boolean };
+        if (pkg.name && !seen.has(pkg.name)) {
+          seen.add(pkg.name);
+          packages.push({
+            name: pkg.name,
+            path: pkgPath,
+            private: pkg.private ?? false,
+          });
+        }
+      } catch {
+        // Skip invalid package.json
+      }
+    }
+  }
+
+  return packages.sort((a, b) => a.name.localeCompare(b.name));
+}
+
 // GET /demo/analyze?package=lodash
 demoRoute.get('/analyze', async (c) => {
   const packageName = c.req.query('package');
@@ -228,6 +294,250 @@ demoRoute.get('/analyze', async (c) => {
                     exports: number;
                     documented: number;
                     undocumented: number;
+                    driftCount: number;
+                    topUndocumented: string[];
+                    topDrift: Array<{ name: string; issue: string }>;
+                  };
+                  error?: string;
+                };
+
+                // Forward progress events
+                if (eventType === 'progress') {
+                  await sendEvent('log', { message: eventData.message || eventData.stage });
+                } else if (eventType === 'step:start') {
+                  await sendEvent('status', {
+                    step: eventData.stepId === 'analyze' ? 'analyze' : 'build',
+                    message: eventData.name || `Running ${eventData.stepId}...`,
+                  });
+                } else if (eventType === 'step:complete' && eventData.stepId) {
+                  await sendEvent('log', {
+                    message: `${eventData.stepId} completed`,
+                  });
+                } else if (eventType === 'complete' && eventData.summary) {
+                  // Transform summary to our format (SDK-aligned field names)
+                  const summary: AnalysisSummary = {
+                    packageName: eventData.summary.name,
+                    version: eventData.summary.version,
+                    coverageScore: eventData.summary.coverage,
+                    totalExports: eventData.summary.exports,
+                    documentedExports: eventData.summary.documented,
+                    driftCount: eventData.summary.driftCount ?? 0,
+                    topUndocumented: eventData.summary.topUndocumented ?? [],
+                    topDrift: eventData.summary.topDrift ?? [],
+                  };
+
+                  await sendEvent('log', {
+                    message: `Found ${summary.totalExports} exports, ${summary.documentedExports} documented`,
+                  });
+
+                  await sendEvent('status', {
+                    step: 'complete',
+                    message: 'Analysis complete!',
+                  });
+
+                  await sendEvent('result', { data: summary });
+                  return;
+                } else if (eventType === 'error') {
+                  throw new Error(eventData.error || 'Execution failed');
+                }
+              } catch (parseError) {
+                // Ignore JSON parse errors for incomplete data
+                if (parseError instanceof SyntaxError) continue;
+                throw parseError;
+              }
+            }
+          }
+        }
+      }
+
+      // If we get here without a complete event, something went wrong
+      throw new Error('Execution completed without results');
+    } catch (err) {
+      const message = err instanceof Error ? err.message : 'Analysis failed';
+      await sendEvent('error', { message });
+    }
+  });
+});
+
+// POST /demo/detect - detect monorepo packages from GitHub URL
+demoRoute.post('/detect', async (c) => {
+  const body = (await c.req.json()) as { url?: string };
+
+  if (!body.url) {
+    return c.json({ error: 'GitHub URL required' }, 400);
+  }
+
+  // Validate and parse GitHub URL
+  const parsed = parseScanGitHubUrl(body.url);
+  if (!parsed) {
+    return c.json({ error: 'Invalid GitHub URL' }, 400);
+  }
+
+  try {
+    // Fetch context from GitHub
+    const context = await fetchGitHubContext(body.url);
+
+    // If not a monorepo, return simple response
+    if (!context.workspace.isMonorepo) {
+      return c.json({
+        isMonorepo: false,
+        packageManager: context.packageManager,
+        owner: context.metadata.owner,
+        repo: context.metadata.repo,
+        ref: context.ref,
+        packages: [],
+      });
+    }
+
+    // Resolve actual package names from workspace patterns
+    const patterns = context.workspace.packages || ['packages/*'];
+    const packages = await resolveGitHubPackages(
+      context.metadata.owner,
+      context.metadata.repo,
+      context.ref,
+      patterns,
+    );
+
+    return c.json({
+      isMonorepo: true,
+      packageManager: context.packageManager,
+      owner: context.metadata.owner,
+      repo: context.metadata.repo,
+      ref: context.ref,
+      packages,
+    });
+  } catch (err) {
+    const message = err instanceof Error ? err.message : 'Detection failed';
+    return c.json({ error: message }, 500);
+  }
+});
+
+// GET /demo/analyze-repo?url=...&package=... - analyze GitHub repo directly
+demoRoute.get('/analyze-repo', async (c) => {
+  const repoUrl = c.req.query('url');
+  const packageName = c.req.query('package');
+
+  if (!repoUrl) {
+    return c.json({ error: 'GitHub URL required' }, 400);
+  }
+
+  // Validate GitHub URL
+  const parsed = parseScanGitHubUrl(repoUrl);
+  if (!parsed) {
+    return c.json({ error: 'Invalid GitHub URL' }, 400);
+  }
+
+  return streamSSE(c, async (stream) => {
+    const sendEvent = async (
+      type: 'status' | 'log' | 'result' | 'error',
+      data: { step?: string; message?: string; data?: unknown },
+    ) => {
+      await stream.writeSSE({
+        data: JSON.stringify({ type, ...data }),
+        event: type === 'error' ? 'error' : type === 'result' ? 'complete' : 'progress',
+      });
+    };
+
+    try {
+      // Step 1: Log repo info
+      await sendEvent('status', {
+        step: 'repo',
+        message: `Analyzing ${parsed.owner}/${parsed.repo}...`,
+      });
+
+      await sendEvent('log', {
+        message: `Repository: ${repoUrl}`,
+      });
+
+      if (packageName) {
+        await sendEvent('log', {
+          message: `Package: ${packageName}`,
+        });
+      }
+
+      // Step 2: Generate build plan via /plan endpoint
+      await sendEvent('status', {
+        step: 'plan',
+        message: 'Generating build plan...',
+      });
+
+      const planResponse = await fetch(`${VERCEL_API_URL}/plan`, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({
+          url: repoUrl,
+          package: packageName,
+        }),
+      });
+
+      if (!planResponse.ok) {
+        const errorData = (await planResponse.json()) as { error?: string };
+        throw new Error(errorData.error || `Plan generation failed: ${planResponse.status}`);
+      }
+
+      const planData = (await planResponse.json()) as {
+        plan: unknown;
+        context: { isMonorepo: boolean; packageManager: string };
+      };
+
+      await sendEvent('log', {
+        message: `Build plan ready (${planData.context.packageManager}${planData.context.isMonorepo ? ', monorepo' : ''})`,
+      });
+
+      // Step 3: Execute build plan via /execute-stream endpoint
+      await sendEvent('status', {
+        step: 'build',
+        message: 'Building and analyzing...',
+      });
+
+      const executeResponse = await fetch(`${VERCEL_API_URL}/execute-stream`, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ plan: planData.plan }),
+      });
+
+      if (!executeResponse.ok || !executeResponse.body) {
+        throw new Error(`Execution failed: ${executeResponse.status}`);
+      }
+
+      // Stream the execute-stream SSE events and forward relevant ones
+      const reader = executeResponse.body.getReader();
+      const decoder = new TextDecoder();
+      let buffer = '';
+
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) break;
+
+        buffer += decoder.decode(value, { stream: true });
+        const lines = buffer.split('\n');
+        buffer = lines.pop() || '';
+
+        for (const line of lines) {
+          if (line.startsWith('event:')) {
+            const eventType = line.slice(7).trim();
+
+            // Get the next data line
+            const dataLineIndex = lines.indexOf(line) + 1;
+            if (dataLineIndex < lines.length && lines[dataLineIndex].startsWith('data:')) {
+              const dataStr = lines[dataLineIndex].slice(5).trim();
+              try {
+                const eventData = JSON.parse(dataStr) as {
+                  stage?: string;
+                  message?: string;
+                  stepId?: string;
+                  name?: string;
+                  success?: boolean;
+                  summary?: {
+                    name: string;
+                    version: string;
+                    coverage: number;
+                    exports: number;
+                    documented: number;
+                    undocumented: number;
+                    driftCount: number;
+                    topUndocumented: string[];
+                    topDrift: Array<{ name: string; issue: string }>;
                   };
                   error?: string;
                 };
@@ -245,21 +555,20 @@ demoRoute.get('/analyze', async (c) => {
                     message: `${eventData.stepId} completed`,
                   });
                 } else if (eventType === 'complete' && eventData.summary) {
-                  // Transform summary to our format
+                  // Transform summary to our format (SDK-aligned field names)
                   const summary: AnalysisSummary = {
                     packageName: eventData.summary.name,
                     version: eventData.summary.version,
-                    coverage: eventData.summary.coverage,
-                    exportCount: eventData.summary.exports,
-                    documentedCount: eventData.summary.documented,
-                    undocumentedCount: eventData.summary.undocumented,
-                    driftCount: 0,
-                    topUndocumented: [],
-                    topDrift: [],
+                    coverageScore: eventData.summary.coverage,
+                    totalExports: eventData.summary.exports,
+                    documentedExports: eventData.summary.documented,
+                    driftCount: eventData.summary.driftCount ?? 0,
+                    topUndocumented: eventData.summary.topUndocumented ?? [],
+                    topDrift: eventData.summary.topDrift ?? [],
                   };
 
                   await sendEvent('log', {
-                    message: `Found ${summary.exportCount} exports, ${summary.documentedCount} documented`,
+                    message: `Found ${summary.totalExports} exports, ${summary.documentedExports} documented`,
                   });
 
                   await sendEvent('status', {

package/src/routes/github-app.ts

@@ -280,7 +280,7 @@ async function handlePushEvent(payload: {
   const result = await analyzeRemoteRepo(installationId, owner.login, repo, sha);
 
   if (result) {
-    console.log(`[webhook] Analysis complete: ${result.coveragePercent}% coverage`);
+    console.log(`[webhook] Analysis complete: ${result.coverageScore}% coverage`);
 
     // Create check run with analysis results
     await createCheckRun(installationId, owner.login, repo, sha, result);
@@ -289,7 +289,7 @@ async function handlePushEvent(payload: {
     await db
       .updateTable('projects')
       .set({
-        coverageScore: result.coveragePercent,
+        coverageScore: result.coverageScore,
         driftCount: result.driftCount,
         updatedAt: new Date(),
       })
@@ -333,7 +333,7 @@ async function handlePullRequestEvent(payload: {
     return;
   }
 
-  console.log(`[webhook] PR analysis complete: ${headResult.coveragePercent}% coverage`);
+  console.log(`[webhook] PR analysis complete: ${headResult.coverageScore}% coverage`);
 
   // Try to get baseline from database or analyze base
   let diff: ReturnType<typeof computeAnalysisDiff> | null = null;
@@ -349,9 +349,9 @@ async function handlePullRequestEvent(payload: {
     // Use cached baseline for speed
     diff = computeAnalysisDiff(
       {
-        coveragePercent: project.coverageScore,
-        documentedCount: 0,
-        totalCount: 0,
+        coverageScore: project.coverageScore,
+        documentedExports: 0,
+        totalExports: 0,
         driftCount: project.driftCount ?? 0,
         qualityErrors: 0,
         qualityWarnings: 0,

package/src/routes/spec-v1.ts

@@ -0,0 +1,165 @@
+/**
+ * Spec routes (v1) - API key authenticated endpoints for programmatic access
+ *
+ * POST /v1/spec/diff - Compare two specs
+ */
+
+import { Hono } from 'hono';
+import { z } from 'zod';
+import { db } from '../db/client';
+import type { ApiKeyContext } from '../middleware/api-key-auth';
+import {
+  computeFullDiff,
+  type DiffOptions,
+  diffSpecs,
+  formatDiffResponse,
+} from '../utils/spec-diff-core';
+
+type Env = {
+  Variables: ApiKeyContext;
+};
+
+export const specV1Route = new Hono<Env>();
+
+// Request schemas
+const GitHubDiffSchema = z.object({
+  mode: z.literal('github'),
+  owner: z.string().min(1),
+  repo: z.string().min(1),
+  base: z.string().min(1),
+  head: z.string().min(1),
+  includeDocsImpact: z.boolean().optional(),
+});
+
+const SpecsDiffSchema = z.object({
+  mode: z.literal('specs'),
+  baseSpec: z.object({}).passthrough(),
+  headSpec: z.object({}).passthrough(),
+  markdownFiles: z
+    .array(
+      z.object({
+        path: z.string(),
+        content: z.string(),
+      }),
+    )
+    .optional(),
+});
+
+const DiffRequestSchema = z.discriminatedUnion('mode', [GitHubDiffSchema, SpecsDiffSchema]);
+
+/**
+ * POST /v1/spec/diff - Compare two specs
+ *
+ * Supports two modes:
+ * 1. GitHub refs: Clone and compare specs from GitHub refs
+ * 2. Direct specs: Compare uploaded spec objects
+ */
+specV1Route.post('/diff', async (c) => {
+  const org = c.get('org');
+
+  // Parse and validate request body
+  let body: z.infer<typeof DiffRequestSchema>;
+  try {
+    const rawBody = await c.req.json();
+    body = DiffRequestSchema.parse(rawBody);
+  } catch (err) {
+    if (err instanceof z.ZodError) {
+      return c.json(
+        {
+          error: 'Invalid request',
+          details: err.errors,
+        },
+        400,
+      );
+    }
+    return c.json({ error: 'Invalid JSON body' }, 400);
+  }
+
+  try {
+    if (body.mode === 'github') {
+      // GitHub mode: need to find installation for this org
+      const { owner, repo, base, head, includeDocsImpact } = body;
+
+      // Look up installation from org
+      const installation = await db
+        .selectFrom('github_installations')
+        .where('orgId', '=', org.id)
+        .select(['installationId'])
+        .executeTakeFirst();
+
+      if (!installation) {
+        return c.json(
+          {
+            error: 'No GitHub App installation found for this repository',
+            hint: 'Install the DocCov GitHub App to compare repos',
+          },
+          403,
+        );
+      }
+
+      // Compute diff with timeout
+      const diffOptions: DiffOptions = {
+        includeDocsImpact,
+      };
+
+      const result = await Promise.race([
+        computeFullDiff(
+          { owner, repo, ref: base, installationId: installation.installationId },
+          { owner, repo, ref: head, installationId: installation.installationId },
+          diffOptions,
+        ),
+        new Promise<never>((_, reject) => setTimeout(() => reject(new Error('TIMEOUT')), 60_000)),
+      ]);
+
+      return c.json(formatDiffResponse(result));
+    }
+
+    // Specs mode: direct comparison
+    const { baseSpec, headSpec, markdownFiles } = body;
+
+    const diff = diffSpecs(
+      baseSpec as Parameters<typeof diffSpecs>[0],
+      headSpec as Parameters<typeof diffSpecs>[1],
+      markdownFiles,
+    );
+
+    return c.json({
+      // Core diff fields
+      breaking: diff.breaking,
+      nonBreaking: diff.nonBreaking,
+      docsOnly: diff.docsOnly,
+      coverageDelta: diff.coverageDelta,
+      oldCoverage: diff.oldCoverage,
+      newCoverage: diff.newCoverage,
+      driftIntroduced: diff.driftIntroduced,
+      driftResolved: diff.driftResolved,
+      newUndocumented: diff.newUndocumented,
+      improvedExports: diff.improvedExports,
+      regressedExports: diff.regressedExports,
+
+      // Extended fields
+      memberChanges: diff.memberChanges,
+      categorizedBreaking: diff.categorizedBreaking,
+      docsImpact: diff.docsImpact,
+
+      // Metadata
+      generatedAt: new Date().toISOString(),
+      cached: false,
+    });
+  } catch (err) {
+    if (err instanceof Error) {
+      if (err.message === 'TIMEOUT') {
+        return c.json({ error: 'Spec generation timed out' }, 408);
+      }
+      if (err.message.includes('not found') || err.message.includes('404')) {
+        return c.json({ error: 'Repository or ref not found' }, 404);
+      }
+      if (err.message.includes('No token')) {
+        return c.json({ error: 'GitHub App access required' }, 403);
+      }
+    }
+
+    console.error('Spec diff error:', err);
+    return c.json({ error: 'Failed to compute diff' }, 500);
+  }
+});