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

package/src/index.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
 // index.js - Reshot CLI entry point
-// Consolidated command structure for ease of use while maintaining power features
 
 require("dotenv").config({
   path: require("path").join(__dirname, "..", ".env"),
@@ -15,7 +14,7 @@ const program = new Command();
 
 program
   .name("reshot")
-  .description("Visual documentation that stays in sync")
+  .description("Visual capture, publishing, and governance for your UI")
   .version(pkg.version);
 
 // ============================================================================
@@ -25,8 +24,9 @@ program
 // Setup: Interactive wizard for initial configuration
 program
   .command("setup")
-  .description("Interactive setup wizard (auth, config, features)")
-  .option("--offline", "Skip authentication (local-only mode)")
+  .description("Set up the local or hosted workflow from scratch")
+  .option("--offline", "Stay local-only and skip hosted authentication")
+  .option("--no-studio", "Skip offering to launch Studio after setup")
   .option("--force", "Force re-initialization even if already set up")
   .action(async (options) => {
     try {
@@ -38,13 +38,23 @@ program
     }
   });
 
-// Sync: Upload traces and documentation to platform
+program.addHelpText(
+  "after",
+  `
+Primary workflow:
+  reshot setup          Configure the project and choose local-only or hosted mode
+  reshot run            Run configured scenarios with fail-fast preflight checks
+  reshot publish        Upload captured assets to the Reshot platform
+  reshot pull           Pull approved CDN-backed asset references into your repo
+  reshot doctor target  Audit certified-target readiness before capture
+`,
+);
+
+// Sync: Upload Playwright traces to platform
 program
   .command("sync")
-  .description("Upload Playwright traces and documentation to Reshot")
+  .description("Upload Playwright traces to Reshot")
   .option("--trace-dir <path>", "Path to test-results directory")
-  .option("--traces", "Sync traces only")
-  .option("--docs", "Sync documentation only")
   .option("--dry-run", "Preview what would be synced")
   .option("-v, --verbose", "Show detailed output")
   .action(async (options) => {
@@ -52,8 +62,6 @@ program
       const syncCommand = require("./commands/sync");
       await syncCommand({
         traceDir: options.traceDir,
-        traces: options.traces,
-        docs: options.docs,
         dryRun: options.dryRun,
         verbose: options.verbose,
       });
@@ -63,7 +71,7 @@ program
     }
   });
 
-// Status: View project status, sync jobs, and drift summary
+// Status: View project status and drift summary
 program
   .command("status")
   .description("View project status, sync history, and drift summary")
@@ -99,27 +107,6 @@ program
     }
   });
 
-// Validate: Check configuration and documentation bindings
-program
-  .command("validate")
-  .description("Validate configuration and documentation bindings")
-  .option("--strict", "Fail on warnings (zombie links, unbound files)")
-  .option("--fix", "Attempt to auto-fix issues where possible")
-  .option("-v, --verbose", "Show detailed validation output")
-  .action(async (options) => {
-    try {
-      const validateCommand = require("./commands/validate-docs");
-      if (typeof validateCommand.validateDocSync === "function") {
-        await validateCommand.validateDocSync(options);
-      } else {
-        await validateCommand.validateDocs(options);
-      }
-    } catch (error) {
-      console.error(chalk.red("Error:"), error.message);
-      process.exit(1);
-    }
-  });
-
 // ============================================================================
 // VISUAL CAPTURE COMMANDS
 // ============================================================================
@@ -179,19 +166,96 @@ program
     }
   });
 
+// Capture: Compatibility alias for older docs and snippets
+program
+  .command("capture")
+  .description("Compatibility alias for `reshot run` (prefer `reshot run` and `reshot publish`)")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--mode <mode>", "Compatibility mode: preview | publish", "preview")
+  .option("--config <path>", "Compatibility config path (defaults to reshot.config.json)")
+  .option("--base-url <url>", "Temporary base URL override for compatibility flows")
+  .option("--tag <tag>", "Version tag when mode=publish")
+  .option("-m, --message <message>", "Publish message when mode=publish")
+  .option("--no-headless", "Run browser in visible mode")
+  .option("-c, --concurrency <n>", "Number of parallel browser workers", parseInt)
+  .option("--debug", "Enable verbose debug logging")
+  .action(async (options) => {
+    if (options.debug) {
+      process.env.RESHOT_DEBUG = "1";
+    }
+    if (options.config && options.config !== "reshot.config.json") {
+      console.log(
+        chalk.yellow(
+          "Compatibility mode currently uses reshot.config.json from the working directory.",
+        ),
+      );
+    }
+    if (options.baseUrl) {
+      process.env.RESHOT_BASE_URL = options.baseUrl;
+      console.log(
+        chalk.gray(
+          `Using temporary base URL override for this run: ${options.baseUrl}`,
+        ),
+      );
+    }
+    try {
+      const runCommand = require("./commands/run");
+      const scenarioKeys = options.scenarios
+        ? options.scenarios.split(",").map((s) => s.trim())
+        : null;
+      await runCommand({
+        scenarioKeys,
+        headless: options.headless,
+        concurrency: options.concurrency,
+      });
+
+      if (String(options.mode || "preview").toLowerCase() === "publish") {
+        const publishCommand = require("./commands/publish");
+        await publishCommand({
+          tag: options.tag,
+          message: options.message,
+        });
+      }
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      if (options.debug && error.stack) {
+        console.error(chalk.gray(error.stack));
+      }
+      process.exit(1);
+    }
+  });
+
 // Record: Interactive visual recording from live browser
 program
   .command("record [title]")
   .description("Interactively record visuals from a live browser session")
+  .option("--name <title>", "Compatibility alias for the scenario title")
   .option("--browser", "Launch Chrome with remote debugging before recording")
   .option("-p, --port <port>", "Chrome debugging port (default: 9222)")
   .option("--url <url>", "URL to open when launching browser")
+  .option("--refresh-session", "Only refresh the auth session (no recording prompts)")
   .option("--debug", "Enable verbose debug logging")
   .action(async (title, options) => {
     if (options.debug) {
       process.env.RESHOT_DEBUG = "1";
     }
+    const resolvedTitle = title || options.name;
     try {
+      // If --refresh-session, just sync the session and exit
+      if (options.refreshSession) {
+        const { autoSyncSessionFromCDP, getDefaultSessionPath } = require("./lib/record-cdp");
+        const sessionPath = getDefaultSessionPath();
+        console.log(chalk.gray("  Syncing session from active browser..."));
+        const result = await autoSyncSessionFromCDP(sessionPath);
+        if (result.synced) {
+          console.log(chalk.green("  ✔ Session refreshed at " + sessionPath));
+        } else {
+          console.log(chalk.yellow("  ⚠ No active CDP browser found. Launch Chrome with remote debugging first:"));
+          console.log(chalk.gray("    reshot record --browser --refresh-session"));
+        }
+        return;
+      }
+
       // If --browser flag, launch Chrome first
       if (options.browser) {
         const chromeCommand = require("./commands/chrome");
@@ -204,7 +268,7 @@ program
       }
 
       const recordCommand = require("./commands/record");
-      await recordCommand(title);
+      await recordCommand(resolvedTitle);
     } catch (error) {
       console.error(chalk.red("Error:"), error.message);
       if (options.debug && error.stack) {
@@ -246,13 +310,18 @@ program
   .option("--video <path>", "Explicit video file to upload with this publish")
   .option("--dry-run", "Preview without uploading")
   .option("-f, --force", "Skip confirmation prompts")
+  .option("--all-output", "Publish from the full .reshot/output tree instead of the latest successful run manifest")
   .option("--output-json", "Write structured result to .reshot/output/publish-result.json")
+  .option("--auto-approve", "Automatically approve published visuals (skip review queue)")
+  .option("--skip-release-doctor", "Skip the composed release gate precheck")
   .action(async (options) => {
     try {
       const publishCommand = require("./commands/publish");
       await publishCommand({
         ...options,
         outputJson: options.outputJson,
+        autoApprove: options.autoApprove,
+        skipReleaseDoctor: options.skipReleaseDoctor,
       });
     } catch (error) {
       console.error(chalk.red("Error:"), error.message);
@@ -283,6 +352,78 @@ program
     }
   });
 
+// Doctor: Validate target contract and readiness
+const doctor = program.command("doctor").description("Validate target configuration and readiness");
+
+doctor
+  .command("target")
+  .description("Audit the certified target contract before capture")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--json", "Output JSON report")
+  .action(async (options) => {
+    try {
+      const doctorTargetCommand = require("./commands/doctor-target");
+      await doctorTargetCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+doctor
+  .command("release")
+  .description("Run the combined release gate: preflight, target doctor, and docs assets")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--json", "Output JSON report")
+  .action(async (options) => {
+    try {
+      const doctorReleaseCommand = require("./commands/doctor-release");
+      await doctorReleaseCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Verify: Publish/pull/hosted delivery verification
+const verify = program.command("verify").description("Verify publish and delivery flows");
+
+verify
+  .command("publish")
+  .description("Verify publish, pull, and hosted asset delivery")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--tag <tag>", "Version tag for verification publish")
+  .option("-m, --message <message>", "Publish message override")
+  .option("--json", "Output JSON report")
+  .action(async (options) => {
+    try {
+      const verifyPublishCommand = require("./commands/verify-publish");
+      await verifyPublishCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Certify: full certified-target release gate
+program
+  .command("certify")
+  .description("Run the full certified target pipeline")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--tag <tag>", "Version tag for certification publish")
+  .option("-m, --message <message>", "Publish message override")
+  .option("--skip-release-doctor", "Skip the composed release gate precheck")
+  .option("--json", "Output JSON report")
+  .action(async (options) => {
+    try {
+      const certifyCommand = require("./commands/certify");
+      await certifyCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
 // CI: CI/CD integration commands
 const ciCommand = program
   .command("ci")
@@ -304,11 +445,12 @@ ciCommand
 ciCommand
   .command("run")
   .description("Run capture + publish in one step (CI-optimized)")
-  .option("-c, --config <path>", "Path to docsync.config.json")
+  .option("-c, --config <path>", "Path to reshot.config.json")
   .option("--tag <tag>", "Version tag for publish")
   .option("-m, --message <message>", "Commit message for publish")
   .option("--dry-run", "Preview without uploading")
   .option("--no-publish", "Run capture only, skip publish")
+  .option("--skip-release-doctor", "Skip the composed release gate precheck")
   .action(async (options) => {
     try {
       const ciRun = require("./commands/ci-run");
@@ -323,10 +465,10 @@ ciCommand
 // DRIFT MANAGEMENT COMMANDS
 // ============================================================================
 
-// Drifts: View and manage documentation drifts
+// Drifts: View and manage visual drifts
 program
   .command("drifts [action] [id]")
-  .description("View and manage documentation drifts")
+  .description("View and manage visual drifts")
   .addHelpText(
     "after",
     `
@@ -339,7 +481,6 @@ Actions:
   sync <id>         Mark as manually synced (external_host)
   approve-all       Approve all pending drifts
   reject-all        Reject all pending drifts
-  validate          Validate journey bindings
 `,
   )
   .option("--status <status>", "Filter: PENDING, APPROVED, REJECTED, IGNORED")
@@ -348,7 +489,6 @@ Actions:
   .action(async (action, id, options) => {
     try {
       const driftsCommand = require("./commands/drifts");
-      // Map action/id to the expected subcommand/args format
       const subcommand = action || "list";
       const args = id ? [id] : [];
       await driftsCommand(subcommand, args, options);
@@ -363,9 +503,22 @@ Actions:
 // ============================================================================
 
 // Auth: Standalone authentication (for re-auth scenarios)
-program
-  .command("auth", { hidden: true })
-  .description("Authenticate with Reshot Cloud")
+const auth = program
+  .command("auth")
+  .description("Authenticate with Reshot Cloud (or set RESHOT_API_KEY + RESHOT_PROJECT_ID env vars)")
+  .action(async () => {
+    try {
+      const authCommand = require("./commands/auth");
+      await authCommand();
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+auth
+  .command("login")
+  .description("Compatibility alias for `reshot auth`")
   .action(async () => {
     try {
       const authCommand = require("./commands/auth");
@@ -406,57 +559,4 @@ program
     }
   });
 
-// Ingest: Alias for sync (backward compatibility)
-program
-  .command("ingest", { hidden: true })
-  .description("Upload traces and docs (alias for sync)")
-  .option("--trace-dir <path>", "Path to test-results directory")
-  .option("--dry-run", "Preview what would be synced")
-  .action(async (options) => {
-    console.log(
-      chalk.yellow("Note: 'ingest' is now 'sync'. Running sync...\n"),
-    );
-    try {
-      const syncCommand = require("./commands/sync");
-      await syncCommand({
-        traceDir: options.traceDir,
-        dryRun: options.dryRun,
-      });
-    } catch (error) {
-      console.error(chalk.red("Error:"), error.message);
-      process.exit(1);
-    }
-  });
-
-// UI: Alias for studio (backward compatibility)
-program
-  .command("ui", { hidden: true })
-  .description("Launch Reshot Studio (alias for studio)")
-  .option("--port <port>", "Port for web UI", "4300")
-  .option("--host <host>", "Host for web UI", "127.0.0.1")
-  .option("--no-open", "Do not automatically open browser")
-  .action(async (options) => {
-    try {
-      const uiCommand = require("./commands/ui");
-      await uiCommand(options);
-    } catch (error) {
-      console.error(chalk.red("Error:"), error.message);
-      process.exit(1);
-    }
-  });
-
-// Init-docs: Alias hidden (merged into setup wizard)
-program
-  .command("init-docs", { hidden: true })
-  .description("Initialize documentation sync (use setup instead)")
-  .action(async () => {
-    try {
-      const initDocsCommand = require("./commands/init-docs");
-      await initDocsCommand();
-    } catch (error) {
-      console.error(chalk.red("Error:"), error.message);
-      process.exit(1);
-    }
-  });
-
 program.parse(process.argv);

package/src/lib/api-client.js

@@ -3,15 +3,80 @@ const axios = require("axios");
 const FormData = require("form-data");
 const fs = require("fs");
 
-const baseUrl =
-  process.env.RESHOT_API_BASE_URL ||
-  process.env.DOCSYNC_API_BASE_URL ||
-  "http://localhost:3000/api";
+const PRODUCTION_API_URL = "https://reshot.dev/api";
+
+function summarizeApiBody(body) {
+  if (body == null) return "";
+  if (typeof body === "string") return body.trim();
+  if (typeof body !== "object") return String(body);
+
+  const candidates = [
+    body.message,
+    body.error?.message,
+    body.error,
+    body.reason,
+    body.details,
+  ].filter(Boolean);
+
+  for (const candidate of candidates) {
+    if (typeof candidate === "string" && candidate.trim()) {
+      return candidate.trim();
+    }
+  }
+
+  try {
+    return JSON.stringify(body);
+  } catch {
+    return String(body);
+  }
+}
+
+function createApiError(kind, endpoint, error) {
+  const status = error.response?.status || null;
+  const statusText = error.response?.statusText || "";
+  const bodySummary = summarizeApiBody(error.response?.data);
+  const baseMessage = bodySummary || error.message || "Unknown API error";
+  const statusLabel = status ? `${status}${statusText ? ` ${statusText}` : ""}` : "request failed";
+  const wrapped = new Error(`${kind} (${statusLabel}) at ${endpoint}: ${baseMessage}`);
+  wrapped.response = error.response;
+  wrapped.code = error.code;
+  wrapped.reshot = {
+    kind,
+    endpoint,
+    status,
+    statusText,
+    bodySummary,
+  };
+  return wrapped;
+}
 
 function getApiBaseUrl() {
-  return baseUrl;
+  // 1. Explicit env var override (for CI or local dev)
+  if (process.env.RESHOT_API_BASE_URL) {
+    return process.env.RESHOT_API_BASE_URL;
+  }
+
+  // 2. Read from settings.json (set during auth/setup)
+  try {
+    const path = require("path");
+    const settingsPath = path.join(process.cwd(), ".reshot", "settings.json");
+    if (fs.existsSync(settingsPath)) {
+      const settings = JSON.parse(fs.readFileSync(settingsPath, "utf8"));
+      if (settings.platformUrl) {
+        return settings.platformUrl.replace(/\/+$/, "") + "/api";
+      }
+    }
+  } catch {
+    // Settings don't exist yet (first auth) — fall through to default
+  }
+
+  // 3. Default to production
+  return PRODUCTION_API_URL;
 }
 
+// Resolved once at module load — all API calls use this
+const baseUrl = getApiBaseUrl();
+
 /**
  * Sleep helper for retry delays
  */
@@ -190,20 +255,7 @@ async function publishAssetsV1(apiKey, metadata, assets) {
     });
     return response.data;
   } catch (error) {
-    if (error.response) {
-      const status = error.response.status;
-      const errorMsg = error.response.data?.error || error.message;
-
-      // Create an error that preserves the response for auth detection
-      const err = new Error(
-        status === 401 || status === 403
-          ? `Authentication failed: ${errorMsg}`
-          : `Failed to publish assets: ${errorMsg}`,
-      );
-      err.response = error.response;
-      throw err;
-    }
-    throw new Error(`Failed to publish assets: ${error.message}`);
+    throw createApiError("publish_ingest_failure", `${baseUrl}/v1/publish`, error);
   }
 }
 
@@ -586,6 +638,30 @@ async function publishTransactional(apiKey, payload) {
   return response.data;
 }
 
+/**
+ * Batch publish metadata for multiple scenarios in one request
+ * @param {string} apiKey - API key for authentication
+ * @param {Object} payload - { commits: Array<{ metadata, assets }> }
+ * @returns {Promise<Object>}
+ */
+async function publishBatch(apiKey, payload) {
+  if (!apiKey) {
+    throw new Error("API key is required to publish");
+  }
+
+  const response = await axios.post(`${baseUrl}/v1/publish/batch`, payload, {
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${apiKey}`,
+    },
+    timeout: 60000,
+    maxBodyLength: Infinity,
+    maxContentLength: Infinity,
+  });
+
+  return response.data;
+}
+
 /**
  * Check which hashes already exist in storage (for deduplication)
  * @param {string} apiKey - API key for authentication
@@ -648,7 +724,7 @@ async function getBaselines(projectId, apiKey) {
  */
 async function exportVisuals(projectId, options = {}) {
   const { format = "json", status = "approved" } = options;
-  const settings = require("./config").loadSettings();
+  const settings = require("./config").readSettings();
   const apiKey = settings?.apiKey;
 
   if (!apiKey) {
@@ -656,15 +732,23 @@ async function exportVisuals(projectId, options = {}) {
   }
 
   return withRetry(async () => {
-    const response = await axios.get(
-      `${baseUrl}/projects/${projectId}/visuals/export`,
-      {
-        params: { format, status },
-        headers: { Authorization: `Bearer ${apiKey}` },
-        timeout: 60000,
-      },
-    );
-    return response.data;
+    try {
+      const response = await axios.get(
+        `${baseUrl}/projects/${projectId}/visuals/export`,
+        {
+          params: { format, status },
+          headers: { Authorization: `Bearer ${apiKey}` },
+          timeout: 60000,
+        },
+      );
+      return response.data;
+    } catch (error) {
+      throw createApiError(
+        "export_visuals_failure",
+        `${baseUrl}/projects/${projectId}/visuals/export`,
+        error,
+      );
+    }
   });
 }
 
@@ -688,7 +772,7 @@ async function post(endpoint, data, options = {}) {
 }
 
 /**
- * DocSync: Initialize ingestion job with manifest
+ * Initialize ingestion job with manifest
  */
 async function initIngest(apiKey, projectId, manifest) {
   return withRetry(async () => {
@@ -705,7 +789,7 @@ async function initIngest(apiKey, projectId, manifest) {
 }
 
 /**
- * DocSync: Commit ingestion job after uploads complete
+ * Commit ingestion job after uploads complete
  */
 async function commitIngest(apiKey, projectId, uploadResults, git, cli) {
   return withRetry(async () => {
@@ -722,7 +806,7 @@ async function commitIngest(apiKey, projectId, uploadResults, git, cli) {
 }
 
 /**
- * DocSync: Get drift records for a project
+ * Get drift records for a project
  */
 async function getDrifts(apiKey, projectId, options = {}) {
   return withRetry(async () => {
@@ -742,7 +826,7 @@ async function getDrifts(apiKey, projectId, options = {}) {
 }
 
 /**
- * DocSync: Get sync jobs for a project
+ * Get sync jobs for a project
  */
 async function getSyncJobs(apiKey, projectId, options = {}) {
   return withRetry(async () => {
@@ -762,7 +846,7 @@ async function getSyncJobs(apiKey, projectId, options = {}) {
 }
 
 /**
- * DocSync: Perform action on a drift record
+ * Perform action on a drift record
  */
 async function driftAction(apiKey, projectId, driftId, action, options = {}) {
   return withRetry(async () => {
@@ -794,18 +878,20 @@ module.exports = {
   getProjectConfig,
   postChangelogDrafts,
   getApiBaseUrl,
+  createApiError,
   syncPushAssets,
   getSyncStatus,
   // New transactional flow
   signAssets,
   uploadToPresignedUrl,
   publishTransactional,
+  publishBatch,
   checkExistingHashes,
   // Diffing support
   getBaselines,
   // Export support
   exportVisuals,
-  // DocSync
+  // Reshot
   post,
   initIngest,
   commitIngest,