screencraft 0.1.0

package/src/detectors/simulator.js

@@ -0,0 +1,317 @@
+/**
+ * src/detectors/simulator.js
+ * --------------------------
+ * Captures screenshots from the iOS or Android simulator.
+ *
+ * Three modes (checked in order):
+ *   1. Manual folder  — ./screenshots/ already has PNGs → use those
+ *   2. Interactive     — simulator is running, user navigates + presses Enter
+ *   3. Deep-link auto  — config defines routes, tool navigates automatically
+ *
+ * iOS:  uses xcrun simctl
+ * Android: uses adb
+ */
+
+const { execSync } = require('child_process');
+const path     = require('path');
+const fs       = require('fs');
+const readline = require('readline');
+
+const MAX_SCREENSHOTS = 6;
+
+// ─────────────────────────────────────────────────────────────────
+// MAIN EXPORT
+// ─────────────────────────────────────────────────────────────────
+
+/**
+ * captureScreenshots(root, framework, opts)
+ *
+ * opts.screenConfigs — array of { route, label, timeout } for auto-nav mode
+ * opts.outputDir     — where to save captured PNGs
+ * opts.log           — { info, success, warn } log helpers
+ *
+ * Returns array of { index, file, label }
+ */
+async function captureScreenshots(root, framework, opts = {}) {
+  const { screenConfigs, outputDir, log } = opts;
+
+  const screenshotDir = outputDir
+    ? path.join(outputDir, 'screenshots')
+    : path.join(root, 'launch-kit', 'screenshots');
+  fs.mkdirSync(screenshotDir, { recursive: true });
+
+  // Mode 1: manual screenshots folder
+  const manualDir = path.join(root, 'screenshots');
+  if (fs.existsSync(manualDir)) {
+    const files = fs.readdirSync(manualDir)
+      .filter(f => /\.(png|jpg|jpeg)$/i.test(f))
+      .sort()
+      .slice(0, MAX_SCREENSHOTS);
+
+    if (files.length > 0) {
+      if (log) log.success(`Found ${files.length} screenshots in ./screenshots/`);
+      return files.map((f, i) => ({
+        index: i + 1,
+        file:  path.join(manualDir, f),
+        label: null,
+      }));
+    }
+  }
+
+  // Mode 2 & 3: simulator capture
+  if (framework.platform.includes('ios')) {
+    return captureIOS(root, screenshotDir, screenConfigs, log);
+  } else if (framework.platform.includes('android')) {
+    return captureAndroid(root, screenshotDir, screenConfigs, log);
+  }
+
+  throw new Error(
+    'No screenshots found and no simulator available.\n' +
+    'Place PNGs in a ./screenshots/ folder, or run the iOS/Android simulator first.'
+  );
+}
+
+module.exports = { captureScreenshots };
+
+
+// ─────────────────────────────────────────────────────────────────
+// iOS CAPTURE
+// ─────────────────────────────────────────────────────────────────
+
+async function captureIOS(root, outputDir, screenConfigs, log) {
+  // Find a booted simulator, or boot one
+  const device = ensureIOSSimulator(log);
+
+  // If we have route configs, use auto-nav mode
+  if (screenConfigs?.length) {
+    return captureIOSAutoNav(device, outputDir, screenConfigs, log);
+  }
+
+  // Otherwise: interactive capture
+  return captureIOSInteractive(device, outputDir, log);
+}
+
+/**
+ * Ensure an iOS simulator is booted. Returns the device UDID.
+ */
+function ensureIOSSimulator(log) {
+  // Check if one is already booted
+  try {
+    const list = execSync('xcrun simctl list devices booted -j', { encoding: 'utf8' });
+    const json = JSON.parse(list);
+    for (const runtime of Object.values(json.devices)) {
+      for (const device of runtime) {
+        if (device.state === 'Booted') {
+          if (log) log.success(`Simulator running: ${device.name}`);
+          return device.udid;
+        }
+      }
+    }
+  } catch {}
+
+  // None booted — try to boot an iPhone
+  if (log) log.info('No simulator running. Booting one...');
+
+  const preferred = [
+    'iPhone 16 Pro', 'iPhone 16', 'iPhone 15 Pro', 'iPhone 15',
+    'iPhone 16 Pro Max', 'iPhone 15 Pro Max',
+  ];
+
+  for (const name of preferred) {
+    try {
+      execSync(`xcrun simctl boot "${name}" 2>/dev/null`);
+      execSync('open -a Simulator 2>/dev/null');
+      if (log) log.success(`Booted: ${name}`);
+      // Wait for it to finish booting
+      sleepSync(4000);
+      // Get the UDID
+      const list = execSync('xcrun simctl list devices booted -j', { encoding: 'utf8' });
+      const json = JSON.parse(list);
+      for (const runtime of Object.values(json.devices)) {
+        for (const device of runtime) {
+          if (device.state === 'Booted') return device.udid;
+        }
+      }
+    } catch {}
+  }
+
+  throw new Error(
+    'Could not boot a simulator. Open Xcode → run your app in the Simulator first,\n' +
+    'then re-run screencraft launch.'
+  );
+}
+
+/**
+ * Interactive capture: user navigates the app, presses Enter to capture each screen.
+ */
+async function captureIOSInteractive(device, outputDir, log) {
+  const results = [];
+
+  console.log('');
+  console.log('  ┌─────────────────────────────────────────────┐');
+  console.log('  │  Navigate your app in the Simulator.        │');
+  console.log('  │  Press Enter here to capture each screen.   │');
+  console.log('  │  Press D then Enter when done.              │');
+  console.log('  │  (Up to 6 screenshots)                     │');
+  console.log('  └─────────────────────────────────────────────┘');
+  console.log('');
+
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+
+  const ask = (prompt) => new Promise(resolve => rl.question(prompt, resolve));
+
+  // Capture first screen automatically (whatever's showing)
+  const firstFile = path.join(outputDir, 'screen_01_raw.png');
+  execSync(`xcrun simctl io "${device}" screenshot "${firstFile}"`);
+  results.push({ index: 1, file: firstFile, label: null });
+  if (log) log.success('Screen 1 captured (current view)');
+
+  // Interactive loop for remaining screens
+  for (let i = 2; i <= MAX_SCREENSHOTS; i++) {
+    const input = await ask(`  Navigate to screen ${i}, then press Enter (or D to finish): `);
+
+    if (input.trim().toLowerCase() === 'd') break;
+
+    // Small delay to let any animation finish
+    await sleep(300);
+
+    const outFile = path.join(outputDir, `screen_${String(i).padStart(2, '0')}_raw.png`);
+    execSync(`xcrun simctl io "${device}" screenshot "${outFile}"`);
+    results.push({ index: i, file: outFile, label: null });
+    if (log) log.success(`Screen ${i} captured`);
+  }
+
+  rl.close();
+  console.log('');
+  if (log) log.success(`${results.length} screenshot${results.length > 1 ? 's' : ''} captured`);
+
+  return results;
+}
+
+/**
+ * Auto-nav capture: config defines routes, tool deep-links to each one.
+ */
+async function captureIOSAutoNav(device, outputDir, screenConfigs, log) {
+  const results = [];
+
+  for (let i = 0; i < screenConfigs.length; i++) {
+    const cfg     = screenConfigs[i];
+    const outFile = path.join(outputDir, `screen_${String(i + 1).padStart(2, '0')}_raw.png`);
+
+    if (cfg.route) {
+      try {
+        execSync(`xcrun simctl openurl "${device}" "${cfg.route}" 2>/dev/null || true`);
+        await sleep(cfg.timeout || 2500);
+      } catch {}
+    }
+
+    execSync(`xcrun simctl io "${device}" screenshot "${outFile}"`);
+    results.push({ index: i + 1, file: outFile, label: cfg.label || null });
+
+    if (log) log.success(`Screen ${i + 1} captured${cfg.label ? ` (${cfg.label})` : ''}`);
+  }
+
+  return results;
+}
+
+
+// ─────────────────────────────────────────────────────────────────
+// ANDROID CAPTURE
+// ─────────────────────────────────────────────────────────────────
+
+async function captureAndroid(root, outputDir, screenConfigs, log) {
+  // Check ADB is available and a device is connected
+  try {
+    const devices = execSync('adb devices', { encoding: 'utf8' });
+    if (!devices.includes('\tdevice')) {
+      throw new Error('No Android device/emulator found. Run an emulator first.');
+    }
+  } catch (err) {
+    throw new Error('adb not found. Install Android SDK platform-tools.');
+  }
+
+  if (log) log.success('Android device connected');
+
+  // If we have route configs, use auto-nav
+  if (screenConfigs?.length) {
+    return captureAndroidAutoNav(outputDir, screenConfigs, log);
+  }
+
+  // Otherwise: interactive
+  return captureAndroidInteractive(outputDir, log);
+}
+
+async function captureAndroidInteractive(outputDir, log) {
+  const results = [];
+
+  console.log('');
+  console.log('  ┌─────────────────────────────────────────────┐');
+  console.log('  │  Navigate your app on the emulator.         │');
+  console.log('  │  Press Enter here to capture each screen.   │');
+  console.log('  │  Press D then Enter when done.              │');
+  console.log('  │  (Up to 6 screenshots)                     │');
+  console.log('  └─────────────────────────────────────────────┘');
+  console.log('');
+
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  const ask = (prompt) => new Promise(resolve => rl.question(prompt, resolve));
+
+  // Capture first screen
+  const firstFile = path.join(outputDir, 'screen_01_raw.png');
+  execSync(`adb exec-out screencap -p > "${firstFile}"`);
+  results.push({ index: 1, file: firstFile, label: null });
+  if (log) log.success('Screen 1 captured (current view)');
+
+  for (let i = 2; i <= MAX_SCREENSHOTS; i++) {
+    const input = await ask(`  Navigate to screen ${i}, then press Enter (or D to finish): `);
+    if (input.trim().toLowerCase() === 'd') break;
+
+    await sleep(300);
+
+    const outFile = path.join(outputDir, `screen_${String(i).padStart(2, '0')}_raw.png`);
+    execSync(`adb exec-out screencap -p > "${outFile}"`);
+    results.push({ index: i, file: outFile, label: null });
+    if (log) log.success(`Screen ${i} captured`);
+  }
+
+  rl.close();
+  console.log('');
+  if (log) log.success(`${results.length} screenshot${results.length > 1 ? 's' : ''} captured`);
+
+  return results;
+}
+
+async function captureAndroidAutoNav(outputDir, screenConfigs, log) {
+  const results = [];
+
+  for (let i = 0; i < screenConfigs.length; i++) {
+    const cfg     = screenConfigs[i];
+    const outFile = path.join(outputDir, `screen_${String(i + 1).padStart(2, '0')}_raw.png`);
+
+    if (cfg.route) {
+      try {
+        execSync(`adb shell am start -a android.intent.action.VIEW -d "${cfg.route}" 2>/dev/null`);
+        await sleep(cfg.timeout || 3000);
+      } catch {}
+    }
+
+    execSync(`adb exec-out screencap -p > "${outFile}"`);
+    results.push({ index: i + 1, file: outFile, label: cfg.label || null });
+    if (log) log.success(`Screen ${i + 1} captured${cfg.label ? ` (${cfg.label})` : ''}`);
+  }
+
+  return results;
+}
+
+
+// ─────────────────────────────────────────────────────────────────
+// HELPERS
+// ─────────────────────────────────────────────────────────────────
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+function sleepSync(ms) {
+  execSync(`sleep ${ms / 1000}`);
+}