pro-visu 0.3.1 → 0.4.0

package/dist/cli/index.js

@@ -4,7 +4,7 @@
 import { cac } from "cac";
 
 // src/version.ts
-var TOOL_VERSION = true ? "0.3.1" : "0.0.0-dev";
+var TOOL_VERSION = true ? "0.4.0" : "0.0.0-dev";
 
 // src/cli/update-check.ts
 import updateNotifier from "update-notifier";
@@ -163,17 +163,88 @@ async function ensureChromium(opts) {
 }
 
 // src/media/ensure-ffmpeg.ts
-import path5 from "path";
 import { existsSync as existsSync2 } from "fs";
-import { rm as rm3 } from "fs/promises";
 import { spawn as spawn3 } from "child_process";
-import { createRequire as createRequire2 } from "module";
 
 // src/media/ffmpeg.ts
-import path4 from "path";
+import path5 from "path";
 import { spawn as spawn2 } from "child_process";
-import { rm as rm2, writeFile as writeFile2 } from "fs/promises";
-import ffmpegStatic from "ffmpeg-static";
+import { rm as rm3, writeFile as writeFile2 } from "fs/promises";
+
+// src/media/ffmpeg-binary.ts
+import os from "os";
+import path4 from "path";
+import https from "https";
+import { createWriteStream } from "fs";
+import { mkdir as mkdir2, rename, rm as rm2, chmod } from "fs/promises";
+import { createGunzip } from "zlib";
+import { pipeline } from "stream/promises";
+var FFMPEG_RELEASE = process.env.FFMPEG_BINARY_RELEASE || "b6.1.1";
+var BINARIES_URL = process.env.FFMPEG_BINARIES_URL || "https://github.com/eugeneware/ffmpeg-static/releases/download";
+var SUPPORTED = {
+  darwin: ["x64", "arm64"],
+  linux: ["x64", "ia32", "arm64", "arm"],
+  win32: ["x64", "ia32"],
+  freebsd: ["x64"]
+};
+function ffmpegIsSupported() {
+  return (SUPPORTED[process.platform] ?? []).includes(process.arch);
+}
+function ffmpegCacheDir() {
+  const base = process.env.PROVISU_FFMPEG_DIR || path4.join(os.homedir(), ".cache", "pro-visu", "ffmpeg");
+  return path4.join(base, FFMPEG_RELEASE);
+}
+function ffmpegCachedBinary() {
+  return path4.join(ffmpegCacheDir(), process.platform === "win32" ? "ffmpeg.exe" : "ffmpeg");
+}
+function ffmpegBinaryPath() {
+  return process.env.FFMPEG_BIN || ffmpegCachedBinary();
+}
+function ffmpegDownloadUrl() {
+  if (!ffmpegIsSupported()) return null;
+  return `${BINARIES_URL}/${FFMPEG_RELEASE}/ffmpeg-${process.platform}-${process.arch}.gz`;
+}
+function getFollowing(url, redirects = 5) {
+  return new Promise((resolve, reject) => {
+    const req = https.get(url, { headers: { "User-Agent": "pro-visu" } }, (res) => {
+      const status = res.statusCode ?? 0;
+      if (status >= 300 && status < 400 && res.headers.location) {
+        res.resume();
+        if (redirects <= 0) return reject(new Error("Too many redirects fetching ffmpeg."));
+        resolve(getFollowing(new URL(res.headers.location, url).toString(), redirects - 1));
+        return;
+      }
+      if (status !== 200) {
+        res.resume();
+        reject(new Error(`ffmpeg download failed: HTTP ${status} for ${url}`));
+        return;
+      }
+      resolve(res);
+    });
+    req.on("error", reject);
+  });
+}
+async function downloadFfmpeg() {
+  const url = ffmpegDownloadUrl();
+  if (!url) {
+    throw new Error(
+      `No prebuilt ffmpeg for ${process.platform}/${process.arch}. Set FFMPEG_BIN to a local ffmpeg binary.`
+    );
+  }
+  const dest = ffmpegCachedBinary();
+  const tmp = `${dest}.download`;
+  await mkdir2(path4.dirname(dest), { recursive: true });
+  await rm2(tmp, { force: true });
+  const res = await getFollowing(url);
+  await pipeline(res, createGunzip(), createWriteStream(tmp));
+  await chmod(tmp, 493).catch(() => {
+  });
+  await rm2(dest, { force: true });
+  await rename(tmp, dest);
+  return dest;
+}
+
+// src/media/ffmpeg.ts
 var SCALE_COLOR = "out_color_matrix=bt709:out_range=tv";
 var COLOR_TAGS = [
   "-colorspace",
@@ -186,11 +257,7 @@ var COLOR_TAGS = [
   "tv"
 ];
 function ffmpegPath() {
-  const p = ffmpegStatic;
-  if (!p) {
-    throw new Error("ffmpeg-static did not provide a binary for this platform.");
-  }
-  return p;
+  return ffmpegBinaryPath();
 }
 function buildTranscodeArgs(args) {
   const seek = args.startOffsetSeconds && args.startOffsetSeconds > 0 ? ["-ss", args.startOffsetSeconds.toFixed(3)] : [];
@@ -332,7 +399,7 @@ function buildConcatArgs(listFile, outPath) {
   ];
 }
 async function concatMp4(segments, outPath, logger, signal) {
-  await ensureDir(path4.dirname(outPath));
+  await ensureDir(path5.dirname(outPath));
   const listFile = `${outPath}.concat.txt`;
   const list = segments.map((s) => `file '${s.replace(/\\/g, "/")}'`).join("\n");
   await writeFile2(listFile, `${list}
@@ -340,7 +407,7 @@ async function concatMp4(segments, outPath, logger, signal) {
   try {
     await runFfmpeg(buildConcatArgs(listFile, outPath), logger, signal);
   } finally {
-    await rm2(listFile, { force: true });
+    await rm3(listFile, { force: true });
   }
 }
 async function runFfmpeg(argv, logger, signal) {
@@ -362,7 +429,7 @@ ${stderr.slice(-2e3)}`));
   });
 }
 async function transcodeToMp4(args) {
-  await ensureDir(path4.dirname(args.outputPath));
+  await ensureDir(path5.dirname(args.outputPath));
   await runFfmpeg(buildTranscodeArgs(args), args.logger, args.signal);
 }
 function aspectTarget(aspect) {
@@ -467,7 +534,6 @@ function buildStillSegmentArgs(a) {
 }
 
 // src/media/ensure-ffmpeg.ts
-var require3 = createRequire2(import.meta.url);
 async function ffmpegWorks() {
   let bin;
   try {
@@ -488,42 +554,26 @@ async function ffmpegWorks() {
     child.on("close", (code) => resolve(code === 0));
   });
 }
-function resolveInstallScript() {
-  try {
-    return require3.resolve("ffmpeg-static/install.js");
-  } catch {
-    try {
-      const pkg = require3.resolve("ffmpeg-static/package.json");
-      return path5.join(path5.dirname(pkg), "install.js");
-    } catch {
-      return null;
-    }
-  }
-}
 async function ensureFfmpeg(opts) {
   if (await ffmpegWorks()) return true;
   if (opts.checkOnly) return false;
-  const installScript = resolveInstallScript();
-  if (!installScript) {
-    opts.logger.error("ffmpeg-static is not installed; cannot fetch an ffmpeg binary.");
+  if (process.env.FFMPEG_BIN) {
+    opts.logger.error(`FFMPEG_BIN is set to "${process.env.FFMPEG_BIN}" but that binary won't run.`);
+    return false;
+  }
+  if (!ffmpegIsSupported()) {
+    opts.logger.error(
+      `No prebuilt ffmpeg for ${process.platform}/${process.arch}. Set FFMPEG_BIN to a local ffmpeg binary.`
+    );
     return false;
   }
   opts.logger.info("Fetching ffmpeg (one-time, ~80 MB)\u2026");
   try {
-    await rm3(ffmpegPath(), { force: true });
-  } catch {
+    await downloadFfmpeg();
+  } catch (err) {
+    opts.logger.error(`ffmpeg download failed: ${err.message}`);
+    return false;
   }
-  await new Promise((resolve, reject) => {
-    const child = spawn3(process.execPath, [installScript], {
-      cwd: path5.dirname(installScript),
-      stdio: "inherit"
-    });
-    child.on("error", reject);
-    child.on(
-      "close",
-      (code) => code === 0 ? resolve() : reject(new Error(`ffmpeg download failed (exit code ${code}).`))
-    );
-  });
   if (!await ffmpegWorks()) {
     opts.logger.error("ffmpeg was downloaded but still won't run on this platform.");
     return false;
@@ -578,6 +628,16 @@ var serverSettingsSchema = z.object({
   /** If a server is already reachable at the URL, use it as-is (don't start or stop one). */
   reuseExisting: z.boolean().default(true).describe("If a server is already reachable at the URL, use it as-is (don't start or stop one). Default true.")
 }).strict();
+var captureSettingsSchema = z.object({
+  /** Query params appended to every URL-based asset (e.g. `{ capture: "1" }` → `?capture=1`). */
+  query: z.record(z.string(), z.string()).optional().describe('Query params appended to every URL-based asset, e.g. { capture: "1" }.'),
+  /** Cookies set on every capture context before navigation, scoped to the asset's origin. */
+  cookies: z.array(z.object({ name: z.string().min(1), value: z.string() }).strict()).optional().describe("Cookies set on every capture context before navigation (scoped to the asset's origin)."),
+  /** localStorage entries seeded before the page's own scripts run. */
+  localStorage: z.record(z.string(), z.string()).optional().describe("localStorage entries seeded (per origin) before the page's own scripts run."),
+  /** JS source run in every page before its own scripts — e.g. set a global capture flag. */
+  initScript: z.string().optional().describe("JS run in every page before its own scripts (e.g. `window.__PV_CAPTURE__ = true`).")
+}).strict();
 var settingsSchema = z.object({
   /** Output directory, relative to the repo root. */
   outDir: z.string().min(1).default("pro-visu").describe('Output directory for generated assets, relative to the repo root (default "pro-visu").'),
@@ -599,6 +659,8 @@ var settingsSchema = z.object({
   defaults: z.record(z.string(), z.record(z.string(), z.unknown())).default({}).describe("Per-generator option defaults, keyed by generator id, merged underneath each asset's own options."),
   /** Optional managed dev/prod server lifecycle (build → start → wait → … → stop). */
   server: serverSettingsSchema.optional().describe("Build \u2192 start \u2192 wait \u2192 capture \u2192 stop a server automatically."),
+  /** "Capture mode" toggles (query/cookies/localStorage/init script) applied to every URL capture. */
+  capture: captureSettingsSchema.optional().describe("Capture-mode toggles applied to every URL-based asset (e.g. disable animations / hide the cookie banner)."),
   /** Render quality. "draft" lowers fps/scale and speeds the encoder for fast iteration. */
   quality: z.enum(["draft", "final"]).default("final").describe('Render quality; "draft" lowers fps/scale and speeds the encoder for fast iteration (default "final").'),
   /** Skip assets whose inputs+options+tool fingerprint is unchanged (opt-in; can be stale). */
@@ -943,6 +1005,38 @@ var scrollReelOptionsSchema = z2.object({
 import path6 from "path";
 import { mkdtemp } from "fs/promises";
 
+// src/pipeline/capture.ts
+function withCaptureQuery(url, capture) {
+  if (!url || !capture?.query) return url;
+  try {
+    const u = new URL(url);
+    for (const [k, v] of Object.entries(capture.query)) u.searchParams.set(k, v);
+    return u.toString();
+  } catch {
+    return url;
+  }
+}
+async function applyCapture(context, capture, url) {
+  if (!capture) return;
+  if (capture.cookies?.length && url) {
+    try {
+      const origin = new URL(url).origin;
+      await context.addCookies(
+        capture.cookies.map((c) => ({ name: c.name, value: c.value, url: origin }))
+      );
+    } catch {
+    }
+  }
+  const scripts = [];
+  if (capture.localStorage) {
+    scripts.push(
+      `try{var e=${JSON.stringify(capture.localStorage)};for(var k in e)localStorage.setItem(k,e[k]);}catch(_){}`
+    );
+  }
+  if (capture.initScript) scripts.push(capture.initScript);
+  if (scripts.length) await context.addInitScript(scripts.join("\n"));
+}
+
 // src/generators/scroll-reel/scroll.ts
 var EASINGS = {
   linear: (t) => t,
@@ -957,16 +1051,21 @@ async function prepareScroll(args) {
   const target = findScrollTarget(document, getComputedStyle);
   forceInstant(target);
   const sleep2 = (ms) => new Promise((resolve) => setTimeout(() => resolve(), ms));
+  const withCap = (p, ms) => Promise.race([p ?? Promise.resolve(), sleep2(ms)]);
   scrollTargetTo(target, maxScrollOf(target));
   await sleep2(Math.max(0, args.settleMs));
   try {
-    await (document.fonts?.ready ?? Promise.resolve());
+    await withCap(document.fonts?.ready ?? null, 5e3);
   } catch {
   }
   try {
     const imgs = Array.from(document.images ?? []);
-    await Promise.all(imgs.map((im) => im.decode ? im.decode().catch(() => {
-    }) : null));
+    await withCap(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      Promise.all(imgs.map((im) => im.decode ? im.decode().catch(() => {
+      }) : null)),
+      4e3
+    );
   } catch {
   }
   scrollTargetTo(target, 0);
@@ -1410,6 +1509,7 @@ async function captureScrollWebm(args) {
       size: { width: options.width, height: options.height }
     }
   });
+  await applyCapture(context, args.capture, url);
   const page = await context.newPage();
   const video = page.video();
   const recStart = Date.now();
@@ -1444,10 +1544,10 @@ async function captureScrollWebm(args) {
 }
 
 // src/media/frame-capture.ts
-import os from "os";
+import os2 from "os";
 import path7 from "path";
 function autoWorkers() {
-  const cores = os.cpus()?.length ?? 2;
+  const cores = os2.cpus()?.length ?? 2;
   return Math.max(1, Math.min(6, Math.floor(cores / 2)));
 }
 function planFrames(totalFrames, workers) {
@@ -2019,6 +2119,7 @@ async function captureScrollFrames(a) {
     signal: a.signal,
     prepare: async (page, { logger }) => {
       if (a.colorScheme) await page.emulateMedia({ colorScheme: a.colorScheme });
+      await applyCapture(page.context(), a.capture, a.url);
       await installNetworkHygiene(page, options);
       await installPreNav(page, options);
       logger.debug(`navigating to ${a.url} (waitUntil=${options.waitUntil})`);
@@ -2483,6 +2584,7 @@ async function captureInteractionWebm(args) {
     deviceScaleFactor: options.deviceScaleFactor,
     recordVideo: { dir: recordDir, size: { width: options.width, height: options.height } }
   });
+  await applyCapture(context, args.capture, url);
   const page = await context.newPage();
   const video = page.video();
   const actions = options.actions ?? [];
@@ -2545,6 +2647,7 @@ async function captureFocusWebm(args) {
     deviceScaleFactor: options.deviceScaleFactor,
     recordVideo: { dir: recordDir, size: { width: options.width, height: options.height } }
   });
+  await applyCapture(context, args.capture, url);
   const page = await context.newPage();
   const video = page.video();
   const actions = focus.actions ?? [];
@@ -2639,6 +2742,7 @@ async function run(ctx, options) {
     ctx.logger.info(`recording ${url} (focus: ${options.focus.selector})`);
     const { webmPath, leadSeconds, durationSeconds, cropBox } = await captureFocusWebm({
       browser: ctx.browser,
+      capture: ctx.capture,
       url,
       options,
       colorScheme: scheme,
@@ -2692,6 +2796,7 @@ async function run(ctx, options) {
     ctx.logger.info(`recording ${url} (interaction, ${options.actions.length} action(s))`);
     const { webmPath, leadSeconds, durationSeconds } = await captureInteractionWebm({
       browser: ctx.browser,
+      capture: ctx.capture,
       url,
       options,
       colorScheme: scheme,
@@ -2755,6 +2860,7 @@ async function run(ctx, options) {
       );
       await captureScrollFrames({
         browser: ctx.browser,
+        capture: ctx.capture,
         url: routeUrl,
         options: routeOpts,
         outPath: segPath,
@@ -2810,6 +2916,7 @@ async function run(ctx, options) {
     ctx.logger.info(`recording ${url} (realtime)`);
     const { webmPath, leadSeconds } = await captureScrollWebm({
       browser: ctx.browser,
+      capture: ctx.capture,
       url,
       options,
       tmpDir: ctx.tmpDir,
@@ -2873,6 +2980,7 @@ async function run(ctx, options) {
     ctx.logger.info(`recording ${url}${label} (frame-stepped, ${workers} worker(s))`);
     await captureScrollFrames({
       browser: ctx.browser,
+      capture: ctx.capture,
       url,
       options: vopts,
       outPath: captureMp4,
@@ -2999,6 +3107,7 @@ async function captureBreakpoint(args, bp) {
       viewport: { width: bp.width, height: bp.height },
       deviceScaleFactor: bp.deviceScaleFactor ?? options.deviceScaleFactor
     });
+    await applyCapture(context, args.capture, url);
     const page = await context.newPage();
     try {
       logger.debug(`[${bp.name}] navigating to ${url}`);
@@ -3069,7 +3178,8 @@ async function run2(ctx, options) {
     browser: ctx.browser,
     url,
     options,
-    logger: ctx.logger
+    logger: ctx.logger,
+    capture: ctx.capture
   });
   const records = [];
   for (const shot of shots) {
@@ -3449,7 +3559,7 @@ var wallOptionsSchema = z6.object({
 // src/generators/scene/index.ts
 import path13 from "path";
 import { fileURLToPath } from "url";
-import { copyFile as copyFile2, rename, stat as stat4 } from "fs/promises";
+import { copyFile as copyFile2, rename as rename2, stat as stat4 } from "fs/promises";
 
 // src/scene/serve.ts
 import http from "http";
@@ -3774,7 +3884,7 @@ async function renderScene(ctx, options, generatorId = SCENE_ID) {
       });
     }
     try {
-      await rename(composedTmp, outPath);
+      await rename2(composedTmp, outPath);
     } catch {
       await copyFile2(composedTmp, outPath);
     }
@@ -4916,7 +5026,7 @@ function killTreeByPid(pid) {
 // src/server/manage-server.ts
 import path20 from "path";
 import http2 from "http";
-import https from "https";
+import https2 from "https";
 import { spawn as spawn6 } from "child_process";
 var delay = (ms) => new Promise((r) => setTimeout(r, ms));
 function resolveServerUrl(server) {
@@ -4924,7 +5034,7 @@ function resolveServerUrl(server) {
 }
 function probe(url) {
   return new Promise((resolve) => {
-    const lib = url.startsWith("https:") ? https : http2;
+    const lib = url.startsWith("https:") ? https2 : http2;
     const req = lib.get(url, (res) => {
       res.resume();
       resolve((res.statusCode ?? 0) > 0);
@@ -5085,7 +5195,7 @@ async function startManagedServer(server, baseCwd, logger, tasks = {}, signal) {
 }
 
 // src/pipeline/runner.ts
-import os2 from "os";
+import os3 from "os";
 import path23 from "path";
 import { existsSync as existsSync7 } from "fs";
 import { mkdtemp as mkdtemp4 } from "fs/promises";
@@ -5109,7 +5219,10 @@ async function createContext(args) {
   await ensureDir(genDir);
   return {
     browser: args.browser,
-    target: args.target,
+    // Fold the capture query params into the target URL so every generator's `requireUrl(ctx)`
+    // captures in capture mode without each one re-applying it.
+    target: { ...args.target, url: withCaptureQuery(args.target.url, args.capture) },
+    capture: args.capture,
     resolvedInputs: args.resolvedInputs,
     outDir: args.outDir,
     resolveOutPath: (filename) => path21.join(genDir, filename),
@@ -5196,7 +5309,7 @@ function computeCacheKey(parts) {
 // src/manifest/manifest.ts
 import path22 from "path";
 import { existsSync as existsSync6 } from "fs";
-import { readFile as readFile7, rename as rename2, rm as rm5, writeFile as writeFile8 } from "fs/promises";
+import { readFile as readFile7, rename as rename3, rm as rm5, writeFile as writeFile8 } from "fs/promises";
 
 // src/manifest/schema.ts
 import { z as z10 } from "zod";
@@ -5263,7 +5376,7 @@ async function writeManifest(outDir, manifest) {
   const maxAttempts = 5;
   for (let attempt = 1; ; attempt++) {
     try {
-      await rename2(tmp, file);
+      await rename3(tmp, file);
       return;
     } catch (err) {
       const code = err.code;
@@ -5324,7 +5437,7 @@ async function runPipeline(opts) {
   if (specs.length === 0) return [];
   await ensureDir(opts.outDir);
   const manifest = await ManifestStore.load(opts.outDir);
-  const tmpRoot = await mkdtemp4(path23.join(os2.tmpdir(), "pro-visu-"));
+  const tmpRoot = await mkdtemp4(path23.join(os3.tmpdir(), "pro-visu-"));
   const browser = await launchBrowser(opts.config.settings.browser);
   opts.onResources?.({ tmpDir: tmpRoot });
   const concurrency = Math.max(1, opts.concurrency ?? opts.config.settings.concurrency);
@@ -5376,7 +5489,9 @@ async function runPipeline(opts) {
         inputs: inputHashes,
         files: fileHashes,
         quality,
-        toolVersion: opts.toolVersion
+        toolVersion: opts.toolVersion,
+        // Capture-mode toggles change the rendered output, so a change must bust the cache.
+        capture: opts.config.settings.capture
       });
       if (cacheEnabled) {
         const existing = manifest.find(spec.name);
@@ -5405,6 +5520,7 @@ async function runPipeline(opts) {
         toolVersion: opts.toolVersion,
         quality,
         manifest,
+        capture: opts.config.settings.capture,
         onProgress: reporter ? (v) => reporter.progress(spec.name, v) : void 0,
         signal: opts.signal
       });