@reshotdev/screenshot 0.0.1-beta.24 → 0.0.1-beta.25

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@reshotdev/screenshot",
-  "version": "0.0.1-beta.24",
+  "version": "0.0.1-beta.25",
   "description": "Screenshot and video capture CLI",
   "author": "Reshot <hello@reshot.dev>",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "homepage": "https://reshot.dev",
   "repository": {
     "type": "git",
@@ -22,11 +22,10 @@
     "playwright"
   ],
   "bin": {
-    "reshot": "src/index.js"
+    "reshot": "./src/index.js"
   },
   "files": [
     "src/",
-    "vendor/compose/dist/",
     "web/manager/dist/",
     "web/cropper/",
     "web/subtitle-editor/",
@@ -36,13 +35,26 @@
   "engines": {
     "node": ">=18.0.0"
   },
+  "scripts": {
+    "test": "node scripts/test.js",
+    "test:unit": "node --test tests/unit/*.test.js",
+    "test:integration": "node --test tests/integration/*.test.js",
+    "test:all": "node --test tests/unit/*.test.js tests/integration/*.test.js",
+    "test:dry-run": "node src/index.js --help && node src/index.js --version",
+    "test:source": "node src/index.js",
+    "prepublishOnly": "cd web/manager && npm install && npm run build",
+    "ui:build": "cd web/manager && npm install && npm run build",
+    "ui:dev": "cd web/manager && npm install && npm run dev",
+    "lint": "echo 'No linting configured yet'",
+    "pack:check": "npm pack --dry-run"
+  },
   "dependencies": {
+    "@reshot/compose": "workspace:*",
     "axios": "^1.6.2",
     "chalk": "^4.1.2",
     "commander": "^11.1.0",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
-    "esbuild": "^0.27.2",
     "express": "^4.18.2",
     "form-data": "^4.0.0",
     "fs-extra": "^11.2.0",
@@ -52,24 +64,10 @@
     "ora": "^7.0.1",
     "pixelmatch": "^5.3.0",
     "playwright": "^1.40.0",
-    "playwright-core": "^1.57.0",
     "pngjs": "^7.0.0",
     "sharp": "^0.33.2",
     "socket.io": "^4.7.2",
     "uuid": "^9.0.1",
     "@aws-sdk/client-s3": "^3.650.0"
-  },
-  "scripts": {
-    "test": "node scripts/test.js",
-    "test:unit": "node --test tests/unit/*.test.js",
-    "test:integration": "node --test tests/integration/*.test.js",
-    "test:all": "node --test tests/unit/*.test.js tests/integration/*.test.js",
-    "test:dry-run": "node src/index.js --help && node src/index.js --version",
-    "test:source": "node src/index.js",
-    "ui:build": "cd web/manager && npm install && npm run build",
-    "ui:dev": "cd web/manager && npm install && npm run dev",
-    "lint": "echo 'No linting configured yet'",
-    "build": "pnpm run ui:build",
-    "pack:check": "npm pack --dry-run"
   }
 }

package/src/commands/doctor-target.js

@@ -31,7 +31,7 @@ async function doctorTargetCommand(options = {}) {
         chalk.red("\n  ✖ Target doctor aborted: Config file not found."),
       );
       console.error(
-        chalk.gray("  Run `reshot init` (or `reshot setup`) to create one."),
+        chalk.gray("  Run `reshot setup` to create one."),
       );
     }
     process.exitCode = 1;
@@ -95,17 +95,21 @@ async function doctorTargetCommand(options = {}) {
         continue;
       }
       // Build an actionable reason from whatever failed, instead of a bare ✖
-      // with no explanation (audit run-16 F4).
+      // with no explanation (audit run-16 F4). The status / selector / ready
+      // fields live on the nested pageAudit, not the top-level audit object —
+      // reading them at the wrong level meant a server-down run printed only
+      // the generic "readiness check failed" with no cause (audit run-19 #2).
+      const pa = audit.pageAudit || {};
       const reasons = [];
       if (audit.contractFailure) reasons.push(audit.contractFailure);
-      if (typeof audit.status === "number" && audit.status >= 400) {
-        reasons.push(`HTTP ${audit.status}`);
+      if (typeof pa.status === "number" && pa.status >= 400) {
+        reasons.push(`HTTP ${pa.status}`);
       }
-      if (audit.missingSelectors && audit.missingSelectors.length > 0) {
-        reasons.push(`missing selector(s): ${audit.missingSelectors.join(", ")}`);
+      if (pa.missingSelectors && pa.missingSelectors.length > 0) {
+        reasons.push(`missing selector(s): ${pa.missingSelectors.join(", ")}`);
       }
-      if (audit.readyFailure) reasons.push(audit.readyFailure);
-      if (audit.ready === false && !audit.readyFailure) {
+      if (pa.readyFailure) reasons.push(pa.readyFailure);
+      if (pa.ready === false && !pa.readyFailure) {
         reasons.push("readiness signal not satisfied");
       }
       const reason = reasons.length > 0 ? reasons.join("; ") : "readiness check failed";

package/src/commands/drifts.js

@@ -294,7 +294,7 @@ async function driftsCommand(subcommand, args = [], options = {}) {
   try {
     reshotConfig = config.readConfigLenient();
   } catch (error) {
-    console.error(chalk.red("Error:"), "reshot.config.json not found. Run `reshot init` first.");
+    console.error(chalk.red("Error:"), "reshot.config.json not found. Run `reshot setup` first.");
     process.exit(1);
   }
 
@@ -312,7 +312,7 @@ async function driftsCommand(subcommand, args = [], options = {}) {
   }
 
   if (!projectId) {
-    console.error(chalk.red("Error:"), "Project ID not found. Set RESHOT_PROJECT_ID or run `reshot init`.");
+    console.error(chalk.red("Error:"), "Project ID not found. Set RESHOT_PROJECT_ID or run `reshot setup`.");
     process.exit(1);
   }
 

package/src/commands/pull.js

@@ -114,7 +114,17 @@ function normalizeAssetMap(assets) {
  * printed usage example is copy-pasteable for THIS project (prefers the
  * "default" context). Returns null if the map is empty.
  */
+// A `step-N`/`step0Initial` key is an intermediate capture from a multi-step
+// scenario, not something a user wants to embed in their docs. Prefer a
+// meaningful named capture so the printed `<img>` example doesn't point at the
+// wrong/duplicate intermediate asset (audit run-19 #1).
+function isStepIntermediateKey(key) {
+  return /^step[-_]?\d/i.test(key) || /step[-_]?0/i.test(key);
+}
+
 function deriveUsageSample(assets) {
+  let firstAny = null;
+  let firstNonStep = null;
   for (const group of Object.keys(assets || {})) {
     for (const visualKey of Object.keys(assets[group] || {})) {
       const contexts = Object.keys(assets[group][visualKey] || {});
@@ -126,10 +136,16 @@ function deriveUsageSample(assets) {
       // produce an undefined src (audit run-12 MED-1).
       const entry = assets[group][visualKey][context];
       const stepped = !!(entry && Array.isArray(entry.steps));
-      return { group, visualKey, context, stepped };
+      const candidate = { group, visualKey, context, stepped };
+      if (!firstAny) firstAny = candidate;
+      if (isStepIntermediateKey(visualKey)) continue;
+      // The canonical scenario capture is keyed the same as its group; prefer it
+      // outright, otherwise fall back to the first non-intermediate capture.
+      if (visualKey === group) return candidate;
+      if (!firstNonStep) firstNonStep = candidate;
     }
   }
-  return null;
+  return firstNonStep || firstAny;
 }
 
 function validateHostedAssetUrl(urlString) {
@@ -290,7 +306,7 @@ async function pullCommand(options = {}) {
     projectConfig = config.readConfig();
   } catch (e) {
     console.error(
-      chalk.red("Error: No reshot.config.json found. Run 'reshot init' first.")
+      chalk.red("Error: No reshot.config.json found. Run 'reshot setup' first.")
     );
     if (!noExit) process.exit(1);
     return { success: false, error: "No reshot.config.json found" };

package/src/commands/setup-wizard.js

@@ -517,7 +517,7 @@ async function setupWizard(options = {}) {
     `     ${chalk.cyan(finalSupportedLocalCommand || "npm run build && npm run start")}`,
   );
   console.log(
-    `  ${chalk.gray("Unsupported for launch reliability:")} ${chalk.yellow("next dev")}\n`,
+    `  ${chalk.gray("Less reliable for capture (works, but prefer the above):")} ${chalk.yellow("next dev")}\n`,
   );
 
   console.log(chalk.cyan("Setup mode:\n"));

package/src/commands/status.js

@@ -280,7 +280,7 @@ async function buildStatusReport(options = {}) {
       createIssue(
         "config",
         "error",
-        "reshot.config.json not found. Run `reshot init` or `reshot setup` first.",
+        "reshot.config.json not found. Run `reshot setup` first.",
         { detail: error.message },
       ),
     );

package/src/lib/certification.js

@@ -488,14 +488,23 @@ async function runDoctorTarget(options = {}) {
         `Page readiness audit for ${scenario.key}`,
       );
     } catch (error) {
+      const auditUrl = resolveContractUrl(target.baseUrl, scenario.url);
+      // Surface "could not reach <url>" for connection failures instead of the
+      // raw Playwright net:: jargon, so `reshot doctor target` names an
+      // actionable cause when the dev server is down (audit run-19 #2).
+      const isUnreachable = /ERR_CONNECTION|ECONNREFUSED|ENOTFOUND|net::/i.test(
+        error.message || "",
+      );
       pageAudit = {
         ok: false,
         scenario: scenario.key,
-        url: resolveContractUrl(target.baseUrl, scenario.url),
+        url: auditUrl,
         status: 0,
         missingSelectors: [],
         ready: false,
-        readyFailure: error.message,
+        readyFailure: isUnreachable
+          ? `could not reach ${auditUrl} (is the dev server running?)`
+          : error.message,
         diagnostics: [
           {
             kind: "timeout",

package/src/lib/config.js

@@ -79,7 +79,7 @@ const WORKSPACE_PATH = path.join(process.cwd(), SETTINGS_DIR, "workspace.json");
 function readSettings() {
   if (!fs.existsSync(SETTINGS_PATH)) {
     throw new Error(
-      "Reshot is not initialized in this directory. Run `reshot init` after authenticating."
+      "Reshot is not initialized in this directory. Run `reshot setup` after authenticating."
     );
   }
   return fs.readJSONSync(SETTINGS_PATH);
@@ -280,7 +280,7 @@ function getWorkspaceWithScenarios() {
 function readConfig() {
   if (!fs.existsSync(CONFIG_PATH)) {
     throw new Error(
-      `Config file not found at ${CONFIG_PATH}. Run \`reshot init\` to create one.`
+      `Config file not found at ${CONFIG_PATH}. Run \`reshot setup\` to create one.`
     );
   }
 
@@ -492,7 +492,7 @@ function readConfig() {
 function readConfigLenient() {
   if (!fs.existsSync(CONFIG_PATH)) {
     throw new Error(
-      `Config file not found at ${CONFIG_PATH}. Run \`reshot init\` to create one.`
+      `Config file not found at ${CONFIG_PATH}. Run \`reshot setup\` to create one.`
     );
   }
 

package/src/lib/standalone-mode.js

@@ -329,7 +329,7 @@ function validateCaptureRequirements(config) {
   const warnings = [];
   
   if (!config) {
-    errors.push("No configuration found. Run `reshot init` first.");
+    errors.push("No configuration found. Run `reshot setup` first.");
     return { valid: false, errors, warnings };
   }