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

package/src/commands/ingest.js

@@ -1,458 +0,0 @@
-// ingest.js - Upload traces and documentation for Reshot processing
-// Implements the "Smart Handoff" protocol from the Reshot specification
-
-const chalk = require("chalk");
-const crypto = require("crypto");
-const fs = require("fs-extra");
-const path = require("path");
-const { execSync } = require("child_process");
-const config = require("../lib/config");
-const apiClient = require("../lib/api-client");
-const { hashFile } = require("../lib/hash");
-const pkg = require("../../package.json");
-
-// File extension allowlists
-const TRACE_EXTENSIONS = [".zip"];
-const DOC_EXTENSIONS = [".md", ".mdx"];
-const MAX_DOC_SIZE = 5 * 1024 * 1024; // 5MB per doc file
-const MAX_TRACE_SIZE = 100 * 1024 * 1024; // 100MB per trace
-
-/**
- * Parse frontmatter from a markdown file
- * Extracts YAML frontmatter between --- delimiters
- */
-function parseFrontmatter(content) {
-  const frontmatterRegex = /^---\n([\s\S]*?)\n---/;
-  const match = content.match(frontmatterRegex);
-  
-  if (!match) return { frontmatter: {}, content };
-  
-  const frontmatter = {};
-  const lines = match[1].split('\n');
-  
-  for (const line of lines) {
-    const colonIndex = line.indexOf(':');
-    if (colonIndex > 0) {
-      const key = line.slice(0, colonIndex).trim();
-      let value = line.slice(colonIndex + 1).trim();
-      // Remove quotes if present
-      if ((value.startsWith('"') && value.endsWith('"')) ||
-          (value.startsWith("'") && value.endsWith("'"))) {
-        value = value.slice(1, -1);
-      }
-      frontmatter[key] = value;
-    }
-  }
-  
-  return {
-    frontmatter,
-    content: content.slice(match[0].length).trim()
-  };
-}
-
-/**
- * Discover documentation files based on reshot.config.json
- */
-async function discoverDocumentation(docConfig, projectRoot) {
-  const files = [];
-  const root = path.resolve(projectRoot, docConfig.root || './docs');
-  
-  if (!fs.existsSync(root)) {
-    console.log(chalk.yellow(`  ⚠ Documentation root not found: ${root}`));
-    return files;
-  }
-  
-  const include = docConfig.include || ['**/*.md', '**/*.mdx'];
-  const exclude = docConfig.exclude || ['**/_*.mdx', 'node_modules'];
-  const mappings = docConfig.mappings || {};
-  
-  // Simple glob-like recursive file discovery
-  function walkDir(dir, relativePath = '') {
-    const items = fs.readdirSync(dir);
-    
-    for (const item of items) {
-      const fullPath = path.join(dir, item);
-      const relPath = path.join(relativePath, item);
-      const stat = fs.statSync(fullPath);
-      
-      // Check exclusions
-      const shouldExclude = exclude.some(pattern => {
-        if (pattern.includes('*')) {
-          // Simple glob matching
-          const regex = new RegExp(pattern.replace(/\*\*/g, '.*').replace(/\*/g, '[^/]*'));
-          return regex.test(relPath);
-        }
-        return relPath.includes(pattern) || item === pattern;
-      });
-      
-      if (shouldExclude) continue;
-      
-      if (stat.isDirectory()) {
-        walkDir(fullPath, relPath);
-      } else {
-        const ext = path.extname(item).toLowerCase();
-        if (DOC_EXTENSIONS.includes(ext)) {
-          // Read file and check for reshot_journey frontmatter
-          const content = fs.readFileSync(fullPath, 'utf-8');
-          const { frontmatter } = parseFrontmatter(content);
-          
-          // Get journey key from frontmatter or explicit mappings
-          const journeyKey = frontmatter.reshot_journey || 
-                            mappings[relPath] || 
-                            mappings[fullPath];
-          
-          // Only include files that have a binding
-          if (journeyKey) {
-            const fileSize = stat.size;
-            
-            if (fileSize > MAX_DOC_SIZE) {
-              console.log(chalk.yellow(`  ⚠ Skipping ${relPath}: exceeds ${MAX_DOC_SIZE / 1024 / 1024}MB limit`));
-              continue;
-            }
-            
-            files.push({
-              path: fullPath,
-              relativePath: relPath,
-              journeyKey,
-              contentHash: crypto.createHash('sha256').update(content).digest('hex'),
-              size: fileSize,
-              frontmatter
-            });
-          }
-        }
-      }
-    }
-  }
-  
-  walkDir(root);
-  return files;
-}
-
-/**
- * Discover Playwright trace files
- */
-async function discoverTraces(traceDir) {
-  const traces = [];
-  
-  if (!fs.existsSync(traceDir)) {
-    console.log(chalk.yellow(`  ⚠ Trace directory not found: ${traceDir}`));
-    return traces;
-  }
-  
-  function walkDir(dir) {
-    const items = fs.readdirSync(dir);
-    
-    for (const item of items) {
-      const fullPath = path.join(dir, item);
-      const stat = fs.statSync(fullPath);
-      
-      if (stat.isDirectory()) {
-        walkDir(fullPath);
-      } else if (path.extname(item).toLowerCase() === '.zip') {
-        const fileSize = stat.size;
-        
-        if (fileSize > MAX_TRACE_SIZE) {
-          console.log(chalk.yellow(`  ⚠ Skipping trace ${item}: exceeds ${MAX_TRACE_SIZE / 1024 / 1024}MB limit`));
-          continue;
-        }
-        
-        // Extract journey key from directory structure or filename
-        // Convention: test-results/<test-name>/trace.zip
-        const parentDir = path.basename(path.dirname(fullPath));
-        const journeyKey = parentDir !== 'test-results' ? parentDir : path.basename(item, '.zip');
-        
-        traces.push({
-          path: fullPath,
-          filename: item,
-          journeyKey,
-          contentHash: hashFile(fullPath),
-          size: fileSize
-        });
-      }
-    }
-  }
-  
-  walkDir(traceDir);
-  return traces;
-}
-
-/**
- * Get git metadata for the current commit
- */
-function getGitMetadata() {
-  try {
-    const commitHash = execSync('git rev-parse HEAD', { encoding: 'utf-8' }).trim();
-    const branch = execSync('git rev-parse --abbrev-ref HEAD', { encoding: 'utf-8' }).trim();
-    const commitMessage = execSync('git log -1 --pretty=%B', { encoding: 'utf-8' }).trim();
-    
-    return { commitHash, branch, commitMessage };
-  } catch {
-    console.log(chalk.yellow('  ⚠ Not a git repository or git not available'));
-    return { commitHash: 'unknown', branch: 'unknown', commitMessage: '' };
-  }
-}
-
-/**
- * Phase 1: Initialize ingestion with manifest handshake
- */
-async function initializeIngestion(apiKey, projectId, manifest) {
-  const response = await apiClient.post('/v1/ingest/init', {
-    projectId,
-    manifest
-  }, {
-    headers: { Authorization: `Bearer ${apiKey}` }
-  });
-  
-  return response;
-}
-
-/**
- * Phase 2: Upload files to presigned URLs
- */
-async function uploadFiles(files, presignedUrls, onProgress) {
-  const results = [];
-  let uploaded = 0;
-  
-  for (const file of files) {
-    const presigned = presignedUrls[file.contentHash];
-    
-    if (!presigned) {
-      // File already exists (deduplication)
-      results.push({ ...file, skipped: true });
-      uploaded++;
-      onProgress?.(uploaded, files.length);
-      continue;
-    }
-    
-    try {
-      const fileBuffer = fs.readFileSync(file.path);
-      
-      // Upload to presigned URL
-      await apiClient.uploadToPresignedUrl(presigned.url, fileBuffer, {
-        contentType: presigned.contentType || 'application/octet-stream'
-      });
-      
-      results.push({ ...file, uploaded: true, storageKey: presigned.storageKey });
-    } catch (error) {
-      results.push({ ...file, error: error.message });
-    }
-    
-    uploaded++;
-    onProgress?.(uploaded, files.length);
-  }
-  
-  return results;
-}
-
-/**
- * Phase 3: Commit the ingestion job
- */
-async function commitIngestion(apiKey, projectId, uploadResults, git, cliVersion) {
-  const response = await apiClient.post('/v1/ingest/commit', {
-    projectId,
-    uploadResults,
-    git,
-    cli: {
-      version: cliVersion,
-      timestamp: new Date().toISOString()
-    }
-  }, {
-    headers: { Authorization: `Bearer ${apiKey}` }
-  });
-  
-  return response;
-}
-
-/**
- * Main ingest command
- */
-async function ingestCommand(options = {}) {
-  console.log(chalk.blue('\n📥 Reshot Reshot Ingest\n'));
-  
-  // Read configuration
-  let reshotConfig;
-  try {
-    reshotConfig = config.readConfigLenient();
-  } catch (error) {
-    console.error(chalk.red('Error:'), 'reshot.config.json not found. Run `reshot init` first.');
-    process.exit(1);
-  }
-  
-  // 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 || 
-                    reshotConfig._metadata?.projectId;
-  
-  if (!apiKey) {
-    console.error(chalk.red('Error:'), 'API key not found. Set RESHOT_API_KEY or run `reshot auth`.');
-    process.exit(1);
-  }
-  
-  if (!projectId) {
-    console.error(chalk.red('Error:'), 'Project ID not found. Set RESHOT_PROJECT_ID or run `reshot init`.');
-    process.exit(1);
-  }
-  
-  // Validate documentation configuration
-  const docConfig = reshotConfig.documentation;
-  if (!docConfig) {
-    console.error(chalk.red('Error:'), 'No "documentation" block found in reshot.config.json');
-    process.exit(1);
-  }
-  
-  if (!docConfig.strategy) {
-    console.error(chalk.red('Error:'), 'documentation.strategy is required (git_pr or external_host)');
-    process.exit(1);
-  }
-  
-  const projectRoot = process.cwd();
-  const traceDir = options.traceDir || path.join(projectRoot, 'test-results');
-  
-  // Phase 1: Discovery
-  console.log(chalk.gray('📁 Discovering files...'));
-  
-  const [docs, traces] = await Promise.all([
-    discoverDocumentation(docConfig, projectRoot),
-    discoverTraces(traceDir)
-  ]);
-  
-  console.log(chalk.green(`  ✓ Found ${docs.length} documentation file(s) with journey bindings`));
-  console.log(chalk.green(`  ✓ Found ${traces.length} trace file(s)`));
-  
-  if (docs.length === 0 && traces.length === 0) {
-    console.log(chalk.yellow('\n⚠ No files to ingest. Make sure:'));
-    console.log(chalk.yellow('  - Documentation files have reshot_journey frontmatter'));
-    console.log(chalk.yellow('  - Playwright traces are in test-results/'));
-    return;
-  }
-  
-  // Validate unique bindings (1:1 relationship)
-  const journeyKeys = new Set();
-  const duplicates = [];
-  for (const doc of docs) {
-    if (journeyKeys.has(doc.journeyKey)) {
-      duplicates.push(doc.journeyKey);
-    }
-    journeyKeys.add(doc.journeyKey);
-  }
-  
-  if (duplicates.length > 0) {
-    console.error(chalk.red('\nError: Duplicate journey bindings found:'));
-    duplicates.forEach(key => console.error(chalk.red(`  - ${key}`)));
-    console.error(chalk.yellow('Each document must have a unique reshot_journey key.'));
-    process.exit(1);
-  }
-  
-  // Get git metadata
-  const git = getGitMetadata();
-  console.log(chalk.gray(`\n📍 Git: ${git.branch} @ ${git.commitHash.slice(0, 7)}`));
-  
-  // Dry run mode
-  if (options.dryRun) {
-    console.log(chalk.blue('\n🔍 Dry run - would upload:'));
-    console.log(chalk.gray('\nDocumentation:'));
-    docs.forEach(doc => {
-      console.log(chalk.white(`  ${doc.relativePath} → ${doc.journeyKey}`));
-    });
-    console.log(chalk.gray('\nTraces:'));
-    traces.forEach(trace => {
-      console.log(chalk.white(`  ${trace.filename} → ${trace.journeyKey}`));
-    });
-    return;
-  }
-  
-  // Phase 2: Manifest Handshake
-  console.log(chalk.gray('\n🤝 Initializing ingestion...'));
-  
-  const manifest = {
-    docs: docs.map(d => ({
-      relativePath: d.relativePath,
-      journeyKey: d.journeyKey,
-      contentHash: d.contentHash,
-      size: d.size
-    })),
-    traces: traces.map(t => ({
-      filename: t.filename,
-      journeyKey: t.journeyKey,
-      contentHash: t.contentHash,
-      size: t.size
-    }))
-  };
-  
-  let initResult;
-  try {
-    initResult = await initializeIngestion(apiKey, projectId, manifest);
-    console.log(chalk.green('  ✓ Server acknowledged manifest'));
-    
-    if (initResult.skippedFiles?.length > 0) {
-      console.log(chalk.gray(`  ℹ ${initResult.skippedFiles.length} file(s) unchanged (cached)`));
-    }
-  } catch (error) {
-    console.error(chalk.red('\nError during init:'), error.message);
-    process.exit(1);
-  }
-  
-  // Phase 3: Upload files to presigned URLs
-  const filesToUpload = [...docs, ...traces].filter(
-    f => !initResult.skippedFiles?.includes(f.contentHash)
-  );
-  
-  if (filesToUpload.length > 0) {
-    console.log(chalk.gray(`\n📤 Uploading ${filesToUpload.length} file(s)...`));
-    
-    const uploadResults = await uploadFiles(
-      filesToUpload,
-      initResult.presignedUrls || {},
-      (current, total) => {
-        process.stdout.write(`\r  Progress: ${current}/${total}`);
-      }
-    );
-    
-    const failed = uploadResults.filter(r => r.error);
-    if (failed.length > 0) {
-      console.log(chalk.red(`\n  ✗ ${failed.length} upload(s) failed`));
-      failed.forEach(f => console.log(chalk.red(`    - ${f.relativePath || f.filename}: ${f.error}`)));
-    }
-    
-    console.log(chalk.green(`\n  ✓ Uploaded ${filesToUpload.length - failed.length} file(s)`));
-  }
-  
-  // Phase 4: Commit and trigger processing
-  console.log(chalk.gray('\n🔒 Committing ingestion job...'));
-  
-  try {
-    const commitResult = await commitIngestion(apiKey, projectId, {
-      docs: docs.map(d => ({
-        relativePath: d.relativePath,
-        journeyKey: d.journeyKey,
-        storageKey: initResult.presignedUrls?.[d.contentHash]?.storageKey || d.contentHash
-      })),
-      traces: traces.map(t => ({
-        filename: t.filename,
-        journeyKey: t.journeyKey,
-        storageKey: initResult.presignedUrls?.[t.contentHash]?.storageKey || t.contentHash
-      }))
-    }, git, pkg.version);
-    
-    console.log(chalk.green('  ✓ Ingestion job created'));
-    console.log(chalk.blue(`\n📊 Job ID: ${commitResult.jobId}`));
-    console.log(chalk.gray('  The background worker will process traces and detect drift.'));
-    
-    if (docConfig.strategy === 'git_pr') {
-      console.log(chalk.gray('  A Pull Request will be created if drift is detected.'));
-    } else {
-      console.log(chalk.gray('  Check the Sync Kit in the dashboard for update proposals.'));
-    }
-    
-    console.log(chalk.blue('\n✨ Ingestion complete!\n'));
-    
-    return commitResult;
-  } catch (error) {
-    console.error(chalk.red('\nError during commit:'), error.message);
-    process.exit(1);
-  }
-}
-
-module.exports = ingestCommand;

package/src/commands/setup.js

@@ -1,165 +0,0 @@
-// setup.js - Consolidated command: auth + init + studio launch
-const chalk = require("chalk");
-const oraModule = require("ora");
-const ora = oraModule.default || oraModule;
-const { execSync } = require("child_process");
-
-const {
-  writeSettings,
-  readSettings,
-  configExists,
-  writeConfig,
-  SETTINGS_DIR,
-} = require("../lib/config");
-
-/**
- * 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/reshot-config.json",
-    version: "2.0",
-    projectId: settings.projectId,
-    baseUrl: "http://localhost:3000",
-    assetDir: ".reshot/output",
-    viewport: { width: 1280, height: 720 },
-    timeout: 30000,
-    headless: true,
-    scenarios: [],
-  };
-
-  return defaultConfig;
-}
-
-/**
- * Main setup command - consolidates auth, init, and launches studio
- * One command to rule them all!
- * 
- * @param {Object} options - Command options
- * @param {boolean} options.noStudio - Skip launching studio after setup
- * @param {boolean} options.force - Force re-initialization even if already set up
- */
-async function setupCommand(options = {}) {
-  const { noStudio = false, force = false } = options;
-
-  console.log(chalk.cyan("\n🚀 Reshot Setup\n"));
-  console.log(chalk.gray("Setting up your project in one step...\n"));
-
-  // Step 1: Check current authentication state
-  let existingSettings = null;
-  let isAlreadyAuthed = false;
-
-  try {
-    existingSettings = readSettings();
-    isAlreadyAuthed = !!(
-      existingSettings?.apiKey && existingSettings?.projectId
-    );
-  } catch (e) {
-    // No existing settings - that's fine
-  }
-
-  // Step 2: Handle authentication
-  if (isAlreadyAuthed && !force) {
-    console.log(
-      chalk.green("✔ Already authenticated as:"),
-      chalk.cyan(existingSettings.projectName || existingSettings.projectId)
-    );
-    console.log(
-      chalk.gray(
-        "  Use --force to re-authenticate with a different project.\n"
-      )
-    );
-  } else {
-    // Run browser-based authentication
-    console.log(chalk.gray("Opening browser for authentication...\n"));
-    
-    const authCommand = require("./auth");
-    await authCommand();
-
-    // Re-read settings after auth
-    try {
-      existingSettings = readSettings();
-      isAlreadyAuthed = !!(
-        existingSettings?.apiKey && existingSettings?.projectId
-      );
-    } catch (e) {
-      throw new Error("Authentication failed. Please try again.");
-    }
-
-    if (!isAlreadyAuthed) {
-      throw new Error("Authentication was not completed.");
-    }
-
-    console.log(); // Add spacing after auth
-  }
-
-  // Step 3: Handle initialization (create reshot.config.json if missing)
-  const hasConfig = configExists();
-
-  if (hasConfig && !force) {
-    console.log(chalk.green("✔ Configuration found:"), chalk.cyan("reshot.config.json"));
-  } else if (hasConfig && force) {
-    // 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 reshot.config.json..."));
-    const newConfig = createDefaultConfig(existingSettings);
-    writeConfig(newConfig);
-    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
-  console.log(chalk.green("\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"));
-  console.log(chalk.green.bold("✔ Project initialized successfully!"));
-  console.log(chalk.green("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"));
-
-  // Step 5: Launch Studio (unless --no-studio)
-  if (!noStudio) {
-    console.log(chalk.cyan("🎬 Launching Reshot Studio...\n"));
-    
-    // Small delay to let the user read the success message
-    await new Promise((resolve) => setTimeout(resolve, 500));
-    
-    const uiCommand = require("./ui");
-    await uiCommand({ open: true });
-  } else {
-    console.log(chalk.gray("Next steps:"));
-    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"));
-  }
-}
-
-module.exports = setupCommand;