@reshotdev/screenshot 0.0.1-beta.1 → 0.0.1-beta.10

package/src/commands/setup.js

@@ -2,6 +2,7 @@
 const chalk = require("chalk");
 const oraModule = require("ora");
 const ora = oraModule.default || oraModule;
+const { execSync } = require("child_process");
 
 const {
   writeSettings,
@@ -12,13 +13,13 @@ const {
 } = require("../lib/config");
 
 /**
- * Create a default docsync.config.json for platform mode
+ * Create a default reshot.config.json for platform mode
  * @param {Object} settings - Project settings from auth
  * @returns {Object} The created config
  */
 function createDefaultConfig(settings) {
   const defaultConfig = {
-    $schema: "https://reshot.dev/schemas/docsync-config.json",
+    $schema: "https://reshot.dev/schemas/reshot-config.json",
     version: "2.0",
     projectId: settings.projectId,
     baseUrl: "http://localhost:3000",
@@ -94,22 +95,49 @@ async function setupCommand(options = {}) {
     console.log(); // Add spacing after auth
   }
 
-  // Step 3: Handle initialization (create docsync.config.json if missing)
+  // Step 3: Handle initialization (create reshot.config.json if missing)
   const hasConfig = configExists();
 
   if (hasConfig && !force) {
-    console.log(chalk.green("✔ Configuration found:"), chalk.cyan("docsync.config.json"));
+    console.log(chalk.green("✔ Configuration found:"), chalk.cyan("reshot.config.json"));
   } else if (hasConfig && force) {
-    console.log(chalk.yellow("⚠ Overwriting existing docsync.config.json..."));
-    const newConfig = createDefaultConfig(existingSettings);
-    writeConfig(newConfig);
-    console.log(chalk.green("✔ Configuration updated"));
+    // Patch projectId in existing config instead of wiping scenarios
+    const fs = require("fs");
+    const path = require("path");
+    const configPath = path.join(process.cwd(), "reshot.config.json");
+    const existingConfig = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+    existingConfig.projectId = existingSettings.projectId;
+    fs.writeFileSync(configPath, JSON.stringify(existingConfig, null, 2) + "\n");
+    console.log(chalk.green("✔ Configuration updated (projectId synced)"));
   } else {
     // No config - create it
-    console.log(chalk.gray("Creating docsync.config.json..."));
+    console.log(chalk.gray("Creating reshot.config.json..."));
     const newConfig = createDefaultConfig(existingSettings);
     writeConfig(newConfig);
-    console.log(chalk.green("✔ Configuration created:"), chalk.cyan("docsync.config.json"));
+    console.log(chalk.green("✔ Configuration created:"), chalk.cyan("reshot.config.json"));
+  }
+
+  // Step 3.5: Ensure @reshotdev/screenshot is in devDependencies
+  const fs = require("fs");
+  const path = require("path");
+  const pkgJsonPath = path.join(process.cwd(), "package.json");
+  if (fs.existsSync(pkgJsonPath)) {
+    const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
+    const hasDep =
+      pkgJson.devDependencies?.["@reshotdev/screenshot"] ||
+      pkgJson.dependencies?.["@reshotdev/screenshot"];
+    if (!hasDep) {
+      console.log(chalk.gray("  Adding @reshotdev/screenshot to devDependencies..."));
+      const usePnpm = fs.existsSync(path.join(process.cwd(), "pnpm-lock.yaml"));
+      const useYarn = fs.existsSync(path.join(process.cwd(), "yarn.lock"));
+      const cmd = usePnpm ? "pnpm add -D" : useYarn ? "yarn add -D" : "npm install -D";
+      try {
+        execSync(`${cmd} @reshotdev/screenshot`, { stdio: "inherit" });
+        console.log(chalk.green("  ✔ Added @reshotdev/screenshot to devDependencies"));
+      } catch {
+        console.log(chalk.yellow("  ⚠ Could not auto-install. Run manually: " + cmd + " @reshotdev/screenshot"));
+      }
+    }
   }
 
   // Step 4: Success summary
@@ -128,9 +156,9 @@ async function setupCommand(options = {}) {
     await uiCommand({ open: true });
   } else {
     console.log(chalk.gray("Next steps:"));
-    console.log(chalk.gray("  • Run"), chalk.cyan("reshot studio"), chalk.gray("to open the management UI"));
-    console.log(chalk.gray("  • Run"), chalk.cyan("reshot record"), chalk.gray("to capture your first visual"));
-    console.log(chalk.gray("  • Run"), chalk.cyan("reshot run"), chalk.gray("to execute scenarios\n"));
+    console.log(chalk.gray("  • Run"), chalk.cyan("reshot run"), chalk.gray("to generate your first local capture"));
+    console.log(chalk.gray("  • Run"), chalk.cyan("reshot publish"), chalk.gray("when you are ready for hosted assets and review workflows"));
+    console.log(chalk.gray("  • Run"), chalk.cyan("reshot studio"), chalk.gray("to inspect output locally\n"));
   }
 }
 

package/src/commands/status.js

@@ -1,20 +1,46 @@
 #!/usr/bin/env node
 /**
- * status - Check DocSync status, sync jobs, and drift queue
+ * status - Check project status, sync jobs, and drift queue
  *
  * Displays:
  * - Current project configuration
  * - Recent sync jobs with status
  * - Drift queue summary
- * - Pending actions
  *
- * Usage: reshot status [--jobs] [--drifts] [--json]
+ * Usage: reshot status [--jobs] [--drifts] [--config] [--json]
  */
 
 const chalk = require("chalk");
 const config = require("../lib/config");
 const apiClient = require("../lib/api-client");
 
+function createIssue(scope, level, message, details = {}) {
+  return {
+    scope,
+    level,
+    message,
+    ...details,
+  };
+}
+
+function summarizeConfig(reshotConfig) {
+  return {
+    baseUrl: reshotConfig.baseUrl || null,
+    viewport: reshotConfig.viewport || null,
+    assetDir: reshotConfig.assetDir || ".reshot/output",
+    scenarioCount: reshotConfig.scenarios?.length || 0,
+    traceDir: reshotConfig.visuals?.traceDir || null,
+  };
+}
+
+function readSettingsSafe() {
+  try {
+    return config.readSettings();
+  } catch (error) {
+    return null;
+  }
+}
+
 /**
  * Format timestamp for display
  */
@@ -86,33 +112,255 @@ function formatDriftType(type) {
 }
 
 /**
- * Get and display project configuration
+ * Display project configuration summary
  */
-async function displayConfig(docSyncConfig) {
+async function displayConfig(configSummary) {
   console.log(chalk.bold("\n📋 Project Configuration\n"));
 
-  const docConfig = docSyncConfig.documentation;
-  if (!docConfig) {
-    console.log(chalk.yellow("  No documentation block configured."));
-    console.log(chalk.gray("  Add a 'documentation' block to docsync.config.json"));
+  console.log(chalk.gray("  Base URL:  ") + chalk.white(configSummary.baseUrl || "(not set)"));
+  console.log(chalk.gray("  Viewport:  ") + chalk.white(
+    configSummary.viewport
+      ? `${configSummary.viewport.width}×${configSummary.viewport.height}`
+      : "(default)"
+  ));
+  console.log(chalk.gray("  Asset Dir: ") + chalk.white(configSummary.assetDir || ".reshot/output"));
+
+  console.log(chalk.gray("  Scenarios: ") + chalk.white(`${configSummary.scenarioCount || 0} defined`));
+
+  if (configSummary.traceDir) {
+    console.log(chalk.gray("  Trace Dir: ") + chalk.white(configSummary.traceDir));
+  }
+}
+
+function renderJobs(jobs) {
+  if (jobs.length === 0) {
+    console.log(chalk.gray("  No sync jobs found."));
+    console.log(chalk.gray("  Run `reshot sync` to upload traces."));
     return;
   }
 
-  console.log(chalk.gray("  Root:      ") + chalk.white(docConfig.root || "./docs"));
-  console.log(chalk.gray("  Strategy:  ") + chalk.white(docConfig.strategy));
-  console.log(chalk.gray("  Format:    ") + chalk.white(docConfig.assetFormat || "markdown"));
-  
-  if (docConfig.include?.length) {
-    console.log(chalk.gray("  Include:   ") + chalk.white(docConfig.include.join(", ")));
+  for (const job of jobs) {
+    console.log(
+      `  ${formatJobStatus(job.status)} ` +
+        chalk.gray(`${job.id.slice(0, 8)} `) +
+        chalk.white(`${job.branch || "unknown"}@${(job.commitHash || "").slice(0, 7)} `) +
+        chalk.gray(formatTime(job.createdAt)),
+    );
+
+    if (job.driftCount > 0) {
+      console.log(chalk.gray(`      └─ ${job.driftCount} drift(s) detected`));
+    }
+    if (job.errorMessage) {
+      console.log(chalk.red(`      └─ Error: ${job.errorMessage}`));
+    }
+  }
+}
+
+function renderDrifts(drifts, stats, projectId, limit = 10) {
+  if (stats.total > 0) {
+    console.log(
+      chalk.gray("  Summary: ") +
+        chalk.yellow(`${stats.pending || 0} pending`) + ", " +
+        chalk.green(`${stats.approved || 0} approved`) + ", " +
+        chalk.red(`${stats.rejected || 0} rejected`) + ", " +
+        chalk.gray(`${stats.ignored || 0} ignored`),
+    );
+    console.log();
+  }
+
+  if (drifts.length === 0) {
+    console.log(chalk.green("  ✓ No pending drifts!"));
+    return;
+  }
+
+  const displayed = drifts.slice(0, limit);
+  for (const drift of displayed) {
+    console.log(
+      `  ${formatDriftType(drift.driftType)} ` +
+        chalk.white(drift.journeyKey) + " " +
+        chalk.gray(`(${Math.round(drift.confidenceScore * 100)}% confidence)`),
+    );
+  }
+
+  if (drifts.length > limit) {
+    console.log(chalk.gray(`\n  ... and ${drifts.length - limit} more.`));
+  }
+
+  console.log();
+  console.log(
+    chalk.gray("  View in dashboard: ") +
+      chalk.blue(`https://reshot.dev/app/projects/${projectId}/visuals`),
+  );
+}
+
+async function fetchJobsData(apiKey, projectId, limit = 5) {
+  try {
+    const response = await apiClient.getSyncJobs(apiKey, projectId, { limit });
+    return {
+      jobs: response.jobs || response.data?.jobs || [],
+      error: null,
+    };
+  } catch (error) {
+    return {
+      jobs: [],
+      error: {
+        message: error.message,
+        kind: error.reshot?.kind || null,
+        status: error.reshot?.status || error.response?.status || null,
+      },
+    };
+  }
+}
+
+async function fetchDriftsData(apiKey, projectId) {
+  try {
+    const response = await apiClient.getDrifts(apiKey, projectId, {
+      status: "PENDING",
+    });
+    return {
+      drifts: response.drifts || [],
+      stats: response.stats || {},
+      error: null,
+    };
+  } catch (error) {
+    return {
+      drifts: [],
+      stats: {},
+      error: {
+        message: error.message,
+        kind: error.reshot?.kind || null,
+        status: error.reshot?.status || error.response?.status || null,
+      },
+    };
+  }
+}
+
+async function buildStatusReport(options = {}) {
+  const report = {
+    generatedAt: new Date().toISOString(),
+    ok: true,
+    projectId: null,
+    mode: config.getModeInfo(),
+    config: {
+      exists: false,
+      summary: null,
+      validation: {
+        valid: false,
+        errors: [],
+        warnings: [],
+      },
+    },
+    auth: {
+      hasApiKey: false,
+      hasProjectId: false,
+    },
+    jobs: {
+      items: [],
+      error: null,
+    },
+    drifts: {
+      items: [],
+      stats: {},
+      error: null,
+    },
+    issues: [],
+  };
+
+  let reshotConfig = null;
+  try {
+    reshotConfig = config.readConfigLenient();
+    report.config.exists = true;
+    report.config.summary = summarizeConfig(reshotConfig);
+  } catch (error) {
+    report.issues.push(
+      createIssue(
+        "config",
+        "error",
+        "reshot.config.json not found. Run `reshot init` or `reshot setup` first.",
+        { detail: error.message },
+      ),
+    );
+  }
+
+  if (report.config.exists) {
+    report.config.validation = config.validateConfig();
+    for (const errorMessage of report.config.validation.errors) {
+      report.issues.push(createIssue("config", "error", errorMessage));
+    }
+    for (const warningMessage of report.config.validation.warnings) {
+      report.issues.push(createIssue("config", "warning", warningMessage));
+    }
+  }
+
+  const settings = readSettingsSafe();
+  const apiKey = process.env.RESHOT_API_KEY || settings?.apiKey || null;
+  const projectId =
+    process.env.RESHOT_PROJECT_ID ||
+    settings?.projectId ||
+    reshotConfig?._metadata?.projectId ||
+    null;
+
+  report.projectId = projectId;
+  report.auth.hasApiKey = Boolean(apiKey);
+  report.auth.hasProjectId = Boolean(projectId);
+
+  if (!apiKey) {
+    report.issues.push(
+      createIssue(
+        "auth",
+        "error",
+        "API key not found. Set RESHOT_API_KEY or run `reshot auth`.",
+      ),
+    );
   }
-  if (docConfig.exclude?.length) {
-    console.log(chalk.gray("  Exclude:   ") + chalk.white(docConfig.exclude.join(", ")));
+
+  if (!projectId) {
+    report.issues.push(
+      createIssue(
+        "auth",
+        "error",
+        "Project ID not found. Set RESHOT_PROJECT_ID or run `reshot setup`.",
+      ),
+    );
   }
-  
-  const mappingCount = Object.keys(docConfig.mappings || {}).length;
-  if (mappingCount > 0) {
-    console.log(chalk.gray("  Mappings:  ") + chalk.white(`${mappingCount} explicit binding(s)`));
+
+  if (apiKey && projectId) {
+    const [jobsResult, driftsResult] = await Promise.all([
+      fetchJobsData(apiKey, projectId, options.limit || 5),
+      fetchDriftsData(apiKey, projectId),
+    ]);
+
+    report.jobs.items = jobsResult.jobs;
+    report.jobs.error = jobsResult.error;
+    report.drifts.items = driftsResult.drifts;
+    report.drifts.stats = driftsResult.stats;
+    report.drifts.error = driftsResult.error;
+
+    if (jobsResult.error) {
+      report.issues.push(
+        createIssue(
+          "jobs",
+          "warning",
+          `Could not fetch sync jobs: ${jobsResult.error.message}`,
+          jobsResult.error,
+        ),
+      );
+    }
+
+    if (driftsResult.error) {
+      report.issues.push(
+        createIssue(
+          "drifts",
+          "warning",
+          `Could not fetch drifts: ${driftsResult.error.message}`,
+          driftsResult.error,
+        ),
+      );
+    }
   }
+
+  report.ok = !report.issues.some((issue) => issue.level === "error");
+  return report;
 }
 
 /**
@@ -122,32 +370,9 @@ async function displayJobs(apiKey, projectId, limit = 5) {
   console.log(chalk.bold("\n📦 Recent Sync Jobs\n"));
 
   try {
-    // Fetch jobs via API
     const response = await apiClient.getSyncJobs(apiKey, projectId, { limit });
-
     const jobs = response.jobs || response.data?.jobs || [];
-
-    if (jobs.length === 0) {
-      console.log(chalk.gray("  No sync jobs found."));
-      console.log(chalk.gray("  Run `reshot ingest` to upload traces and docs."));
-      return;
-    }
-
-    for (const job of jobs) {
-      console.log(
-        `  ${formatJobStatus(job.status)} ` +
-        chalk.gray(`${job.id.slice(0, 8)} `) +
-        chalk.white(`${job.branch || "unknown"}@${(job.commitHash || "").slice(0, 7)} `) +
-        chalk.gray(formatTime(job.createdAt))
-      );
-      
-      if (job.driftCount > 0) {
-        console.log(chalk.gray(`      └─ ${job.driftCount} drift(s) detected`));
-      }
-      if (job.errorMessage) {
-        console.log(chalk.red(`      └─ Error: ${job.errorMessage}`));
-      }
-    }
+    renderJobs(jobs);
   } catch (error) {
     console.log(chalk.yellow("  Could not fetch sync jobs: " + error.message));
     console.log(chalk.gray("  This endpoint may not be available yet."));
@@ -164,45 +389,7 @@ async function displayDrifts(apiKey, projectId, limit = 10) {
     const response = await apiClient.getDrifts(apiKey, projectId, { status: "PENDING" });
     const drifts = response.drifts || [];
     const stats = response.stats || {};
-
-    // Show stats summary
-    if (stats.total > 0) {
-      console.log(
-        chalk.gray("  Summary: ") +
-        chalk.yellow(`${stats.pending || 0} pending`) + ", " +
-        chalk.green(`${stats.approved || 0} approved`) + ", " +
-        chalk.red(`${stats.rejected || 0} rejected`) + ", " +
-        chalk.gray(`${stats.ignored || 0} ignored`)
-      );
-      console.log();
-    }
-
-    if (drifts.length === 0) {
-      console.log(chalk.green("  ✓ No pending drifts!"));
-      console.log(chalk.gray("  Your documentation is in sync with the application."));
-      return;
-    }
-
-    // Show pending drifts
-    const displayed = drifts.slice(0, limit);
-    for (const drift of displayed) {
-      console.log(
-        `  ${formatDriftType(drift.driftType)} ` +
-        chalk.white(drift.journeyKey || drift.docPath) + " " +
-        chalk.gray(`(${Math.round(drift.confidenceScore * 100)}% confidence)`)
-      );
-      
-      if (drift.docPath) {
-        console.log(chalk.gray(`      └─ ${drift.docPath}`));
-      }
-    }
-
-    if (drifts.length > limit) {
-      console.log(chalk.gray(`\n  ... and ${drifts.length - limit} more.`));
-    }
-
-    console.log();
-    console.log(chalk.gray("  View in dashboard: ") + chalk.blue(`https://reshot.dev/app/projects/${projectId}/docsync`));
+    renderDrifts(drifts, stats, projectId, limit);
   } catch (error) {
     console.log(chalk.yellow("  Could not fetch drifts: " + error.message));
   }
@@ -212,64 +399,65 @@ async function displayDrifts(apiKey, projectId, limit = 10) {
  * Main status command
  */
 async function statusCommand(options = {}) {
-  console.log(chalk.blue("\n📊 Reshot DocSync Status\n"));
+  const report = await buildStatusReport(options);
 
-  // Read configuration
-  let docSyncConfig;
-  try {
-    docSyncConfig = config.readDocSyncConfig();
-  } catch (error) {
-    console.error(chalk.red("Error:"), "docsync.config.json not found. Run `reshot init` first.");
-    process.exit(1);
+  if (options.json) {
+    console.log(JSON.stringify(report, null, 2));
+    if (!report.ok) {
+      process.exitCode = 1;
+    }
+    return report;
   }
 
-  // Get API key and project ID
-  const settings = config.readSettings();
-  const apiKey = process.env.RESHOT_API_KEY || settings?.apiKey;
-  const projectId =
-    process.env.RESHOT_PROJECT_ID ||
-    settings?.projectId ||
-    docSyncConfig._metadata?.projectId;
+  console.log(chalk.blue("\n📊 Reshot Status\n"));
 
-  if (!apiKey) {
-    console.error(chalk.red("Error:"), "API key not found. Set RESHOT_API_KEY or run `reshot auth`.");
-    process.exit(1);
+  if (report.projectId) {
+    console.log(chalk.gray(`  Project: ${report.projectId}`));
   }
 
-  if (!projectId) {
-    console.error(chalk.red("Error:"), "Project ID not found. Set RESHOT_PROJECT_ID or run `reshot init`.");
-    process.exit(1);
+  if (report.config.summary && (options.config || (!options.jobs && !options.drifts))) {
+    await displayConfig(report.config.summary);
   }
 
-  console.log(chalk.gray(`  Project: ${projectId}`));
-
-  // Display configuration
-  if (options.config || (!options.jobs && !options.drifts)) {
-    await displayConfig(docSyncConfig);
+  if (!options.config && (options.jobs || (!options.config && !options.drifts))) {
+    console.log(chalk.bold("\n📦 Recent Sync Jobs\n"));
+    if (report.jobs.error) {
+      console.log(chalk.yellow("  Could not fetch sync jobs: " + report.jobs.error.message));
+      console.log(chalk.gray("  This endpoint may not be available yet."));
+    } else {
+      renderJobs(report.jobs.items);
+    }
   }
 
-  // Display jobs
-  if (options.jobs || (!options.config && !options.drifts)) {
-    await displayJobs(apiKey, projectId, options.limit || 5);
+  if (!options.jobs && (options.drifts || (!options.config && !options.jobs))) {
+    console.log(chalk.bold("\n🔄 Drift Queue\n"));
+    if (report.drifts.error) {
+      console.log(chalk.yellow("  Could not fetch drifts: " + report.drifts.error.message));
+    } else {
+      renderDrifts(
+        report.drifts.items,
+        report.drifts.stats,
+        report.projectId,
+        options.limit || 10,
+      );
+    }
   }
 
-  // Display drifts
-  if (options.drifts || (!options.config && !options.jobs)) {
-    await displayDrifts(apiKey, projectId, options.limit || 10);
+  if (report.issues.length > 0) {
+    console.log(chalk.bold("\n⚠ Issues\n"));
+    for (const issue of report.issues) {
+      const prefix = issue.level === "error" ? chalk.red("  ✖") : chalk.yellow("  ⚠");
+      console.log(`${prefix} [${issue.scope}] ${issue.message}`);
+    }
   }
 
-  // JSON output mode
-  if (options.json) {
-    const response = await apiClient.getDrifts(apiKey, projectId).catch(() => ({}));
-    console.log(JSON.stringify({
-      projectId,
-      config: docSyncConfig.documentation,
-      drifts: response.drifts || [],
-      stats: response.stats || {},
-    }, null, 2));
+  if (!report.ok) {
+    process.exitCode = 1;
   }
 
   console.log();
+  return report;
 }
 
 module.exports = statusCommand;
+module.exports.buildStatusReport = buildStatusReport;