@navipartner/demo-video 0.4.0 → 0.5.1

package/bin/encode.mjs

@@ -1,187 +1,187 @@
-// Turns the webm Playwright recorded into an MP4, then extracts review stills.
-// Used by bin/demo-video.mjs (encode, stills, render). Reads <out>/manifest.json
-// written by the runner for the webm path and the start/end offsets that trim
-// the load-in and the tail. Plain JS on purpose: no TS loader is needed.
-
-import { spawnSync } from "node:child_process";
-import fs from "node:fs";
-import path from "node:path";
-
-import ffmpegPath from "ffmpeg-static";
-
-const STILLS = 10;
-// One frame a second, six to a row: the whole video's pacing at a glance.
-const SHEET_COLUMNS = 6;
-
-const run = (args) => {
-  const result = spawnSync(
-    ffmpegPath,
-    ["-hide_banner", "-loglevel", "error", "-y", ...args],
-    { stdio: "inherit" },
-  );
-  if (result.status !== 0) {
-    throw new Error(
-      `ffmpeg failed (${result.status}): ffmpeg ${args.join(" ")}`,
-    );
-  }
-};
-
-// ffmpeg-static ships no ffprobe; decode to null and read the final timestamp
-// from ffmpeg's own progress output instead.
-const probeDuration = (file) => {
-  const result = spawnSync(
-    ffmpegPath,
-    ["-hide_banner", "-i", file, "-f", "null", "-"],
-    { encoding: "utf8" },
-  );
-  const matches = [...result.stderr.matchAll(/time=(\d+):(\d+):(\d+\.\d+)/g)];
-  if (matches.length === 0) {
-    throw new Error(`Could not read the duration of ${file}`);
-  }
-  const [, h, m, s] = matches[matches.length - 1];
-  return Number(h) * 3600 + Number(m) * 60 + Number(s);
-};
-
-const encode = (manifest, output) => {
-  const cut = [];
-  if (manifest.startAt != null) {
-    cut.push("-ss", manifest.startAt.toFixed(3));
-  }
-  if (manifest.endAt != null) {
-    cut.push("-to", manifest.endAt.toFixed(3));
-  }
-  run([
-    ...cut,
-    "-i",
-    manifest.source,
-    "-c:v",
-    "libx264",
-    "-preset",
-    "slow",
-    "-crf",
-    "16",
-    // Spends bits on flat, soft areas too, so gradients don't block.
-    "-aq-mode",
-    "3",
-    "-pix_fmt",
-    "yuv420p",
-    "-colorspace",
-    "bt709",
-    "-color_primaries",
-    "bt709",
-    "-color_trc",
-    "bt709",
-    "-color_range",
-    "tv",
-    "-r",
-    String(manifest.fps),
-    "-movflags",
-    "+faststart",
-    output,
-  ]);
-  return probeDuration(output);
-};
-
-const extractStills = (video, duration, reviewDir) => {
-  fs.rmSync(reviewDir, { recursive: true, force: true });
-  fs.mkdirSync(reviewDir, { recursive: true });
-  const stills = [];
-  for (let i = 0; i < STILLS; i++) {
-    const at = ((i + 0.5) / STILLS) * duration;
-    const still = path.join(
-      reviewDir,
-      `still-${String(i + 1).padStart(2, "0")}-${at.toFixed(1)}s.jpg`,
-    );
-    stills.push(still);
-    run([
-      "-ss",
-      at.toFixed(2),
-      "-i",
-      video,
-      "-frames:v",
-      "1",
-      "-q:v",
-      "3",
-      still,
-    ]);
-  }
-  return stills;
-};
-
-const contactSheet = (video, duration, reviewDir) => {
-  const sheet = path.join(reviewDir, "sheet.jpg");
-  const rows = Math.max(1, Math.ceil(duration / SHEET_COLUMNS));
-  run([
-    "-i",
-    video,
-    "-vf",
-    `fps=1,scale=320:-1,tile=${SHEET_COLUMNS}x${rows}:padding=4:color=white`,
-    "-frames:v",
-    "1",
-    "-q:v",
-    "3",
-    sheet,
-  ]);
-  return sheet;
-};
-
-const readManifest = (workDir) => {
-  const manifestPath = path.join(workDir, "manifest.json");
-  if (!fs.existsSync(manifestPath)) {
-    throw new Error(`No recording in ${workDir}; record first`);
-  }
-  return JSON.parse(fs.readFileSync(manifestPath, "utf8"));
-};
-
-const outputPath = (outDir, manifest) =>
-  path.join(outDir, `${manifest.storyboard}-demo.mp4`);
-
-// ffmpeg-static downloads its binary in an install script. pnpm >= 10 skips
-// dependency install scripts unless they are allowed, which leaves the path
-// set but the file missing.
-const assertFfmpeg = () => {
-  if (!ffmpegPath || !fs.existsSync(ffmpegPath)) {
-    throw new Error(
-      `ffmpeg-static has no binary${ffmpegPath ? ` at ${ffmpegPath}` : " for this platform"}. ` +
-        'With pnpm >= 10, allow its install script ("pnpm": { "onlyBuiltDependencies": ["ffmpeg-static"] } in the root package.json) and reinstall.',
-    );
-  }
-};
-
-/**
- * Encodes the recording in workDir to an MP4 in outDir, then writes review
- * stills and a contact sheet. Returns { output, duration, stills, sheet }.
- */
-export const encodeRecording = (workDir, outDir) => {
-  assertFfmpeg();
-  const manifest = readManifest(workDir);
-  if (!fs.existsSync(manifest.source)) {
-    throw new Error(`Recording ${manifest.source} is missing`);
-  }
-  const output = outputPath(outDir, manifest);
-  const duration = encode(manifest, output);
-  const reviewDir = path.join(outDir, "review");
-  const stills = extractStills(output, duration, reviewDir);
-  const sheet = contactSheet(output, duration, reviewDir);
-  return { output, duration, stills, sheet };
-};
-
-/** Re-extracts review stills from the newest MP4 in outDir. */
-export const extractStillsFrom = (outDir) => {
-  assertFfmpeg();
-  const videos = fs.existsSync(outDir)
-    ? fs
-        .readdirSync(outDir)
-        .filter((f) => f.endsWith("-demo.mp4"))
-        .map((f) => path.join(outDir, f))
-        .sort((a, b) => fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs)
-    : [];
-  if (videos.length === 0) {
-    throw new Error(`No video in ${outDir}; render first`);
-  }
-  const output = videos[0];
-  const duration = probeDuration(output);
-  extractStills(output, duration, path.join(outDir, "review"));
-  contactSheet(output, duration, path.join(outDir, "review"));
-  return output;
-};
+// Turns the webm Playwright recorded into an MP4, then extracts review stills.
+// Used by bin/demo-video.mjs (encode, stills, render). Reads <out>/manifest.json
+// written by the runner for the webm path and the start/end offsets that trim
+// the load-in and the tail. Plain JS on purpose: no TS loader is needed.
+
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+
+import ffmpegPath from "ffmpeg-static";
+
+const STILLS = 10;
+// One frame a second, six to a row: the whole video's pacing at a glance.
+const SHEET_COLUMNS = 6;
+
+const run = (args) => {
+  const result = spawnSync(
+    ffmpegPath,
+    ["-hide_banner", "-loglevel", "error", "-y", ...args],
+    { stdio: "inherit" },
+  );
+  if (result.status !== 0) {
+    throw new Error(
+      `ffmpeg failed (${result.status}): ffmpeg ${args.join(" ")}`,
+    );
+  }
+};
+
+// ffmpeg-static ships no ffprobe; decode to null and read the final timestamp
+// from ffmpeg's own progress output instead.
+const probeDuration = (file) => {
+  const result = spawnSync(
+    ffmpegPath,
+    ["-hide_banner", "-i", file, "-f", "null", "-"],
+    { encoding: "utf8" },
+  );
+  const matches = [...result.stderr.matchAll(/time=(\d+):(\d+):(\d+\.\d+)/g)];
+  if (matches.length === 0) {
+    throw new Error(`Could not read the duration of ${file}`);
+  }
+  const [, h, m, s] = matches[matches.length - 1];
+  return Number(h) * 3600 + Number(m) * 60 + Number(s);
+};
+
+const encode = (manifest, output) => {
+  const cut = [];
+  if (manifest.startAt != null) {
+    cut.push("-ss", manifest.startAt.toFixed(3));
+  }
+  if (manifest.endAt != null) {
+    cut.push("-to", manifest.endAt.toFixed(3));
+  }
+  run([
+    ...cut,
+    "-i",
+    manifest.source,
+    "-c:v",
+    "libx264",
+    "-preset",
+    "slow",
+    "-crf",
+    "16",
+    // Spends bits on flat, soft areas too, so gradients don't block.
+    "-aq-mode",
+    "3",
+    "-pix_fmt",
+    "yuv420p",
+    "-colorspace",
+    "bt709",
+    "-color_primaries",
+    "bt709",
+    "-color_trc",
+    "bt709",
+    "-color_range",
+    "tv",
+    "-r",
+    String(manifest.fps),
+    "-movflags",
+    "+faststart",
+    output,
+  ]);
+  return probeDuration(output);
+};
+
+const extractStills = (video, duration, reviewDir) => {
+  fs.rmSync(reviewDir, { recursive: true, force: true });
+  fs.mkdirSync(reviewDir, { recursive: true });
+  const stills = [];
+  for (let i = 0; i < STILLS; i++) {
+    const at = ((i + 0.5) / STILLS) * duration;
+    const still = path.join(
+      reviewDir,
+      `still-${String(i + 1).padStart(2, "0")}-${at.toFixed(1)}s.jpg`,
+    );
+    stills.push(still);
+    run([
+      "-ss",
+      at.toFixed(2),
+      "-i",
+      video,
+      "-frames:v",
+      "1",
+      "-q:v",
+      "3",
+      still,
+    ]);
+  }
+  return stills;
+};
+
+const contactSheet = (video, duration, reviewDir) => {
+  const sheet = path.join(reviewDir, "sheet.jpg");
+  const rows = Math.max(1, Math.ceil(duration / SHEET_COLUMNS));
+  run([
+    "-i",
+    video,
+    "-vf",
+    `fps=1,scale=320:-1,tile=${SHEET_COLUMNS}x${rows}:padding=4:color=white`,
+    "-frames:v",
+    "1",
+    "-q:v",
+    "3",
+    sheet,
+  ]);
+  return sheet;
+};
+
+const readManifest = (workDir) => {
+  const manifestPath = path.join(workDir, "manifest.json");
+  if (!fs.existsSync(manifestPath)) {
+    throw new Error(`No recording in ${workDir}; record first`);
+  }
+  return JSON.parse(fs.readFileSync(manifestPath, "utf8"));
+};
+
+const outputPath = (outDir, manifest) =>
+  path.join(outDir, `${manifest.storyboard}-demo.mp4`);
+
+// ffmpeg-static downloads its binary in an install script. pnpm >= 10 skips
+// dependency install scripts unless they are allowed, which leaves the path
+// set but the file missing.
+const assertFfmpeg = () => {
+  if (!ffmpegPath || !fs.existsSync(ffmpegPath)) {
+    throw new Error(
+      `ffmpeg-static has no binary${ffmpegPath ? ` at ${ffmpegPath}` : " for this platform"}. ` +
+        'With pnpm >= 10, allow its install script ("pnpm": { "onlyBuiltDependencies": ["ffmpeg-static"] } in the root package.json) and reinstall.',
+    );
+  }
+};
+
+/**
+ * Encodes the recording in workDir to an MP4 in outDir, then writes review
+ * stills and a contact sheet. Returns { output, duration, stills, sheet }.
+ */
+export const encodeRecording = (workDir, outDir) => {
+  assertFfmpeg();
+  const manifest = readManifest(workDir);
+  if (!fs.existsSync(manifest.source)) {
+    throw new Error(`Recording ${manifest.source} is missing`);
+  }
+  const output = outputPath(outDir, manifest);
+  const duration = encode(manifest, output);
+  const reviewDir = path.join(outDir, "review");
+  const stills = extractStills(output, duration, reviewDir);
+  const sheet = contactSheet(output, duration, reviewDir);
+  return { output, duration, stills, sheet };
+};
+
+/** Re-extracts review stills from the newest MP4 in outDir. */
+export const extractStillsFrom = (outDir) => {
+  assertFfmpeg();
+  const videos = fs.existsSync(outDir)
+    ? fs
+        .readdirSync(outDir)
+        .filter((f) => f.endsWith("-demo.mp4"))
+        .map((f) => path.join(outDir, f))
+        .sort((a, b) => fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs)
+    : [];
+  if (videos.length === 0) {
+    throw new Error(`No video in ${outDir}; render first`);
+  }
+  const output = videos[0];
+  const duration = probeDuration(output);
+  extractStills(output, duration, path.join(outDir, "review"));
+  contactSheet(output, duration, path.join(outDir, "review"));
+  return output;
+};

package/bin/init.d.mts

@@ -1,24 +1,30 @@
-export type Change = [status: string, what: string, detail: string];
-export interface InitResult {
-  changes: Change[];
-  todo: string[];
-}
-export const IGNORE_LINE: string;
-export const LABEL: string;
-export const CALLER_WORKFLOW: string;
-export function initRepo(
-  root: string,
-  options?: { dryRun?: boolean; label?: boolean },
-): InitResult;
-export function initApp(
-  appDir: string,
-  options?: { dryRun?: boolean },
-): InitResult;
-export function adapterSkeleton(options: {
-  app: string;
-  command?: string;
-  url?: string;
-  env: Record<string, string>;
-  mocks: { name: string; file: string }[];
-  demoDir: string;
-}): string;
+export type Change = [status: string, what: string, detail: string];
+export interface InitResult {
+  changes: Change[];
+  todo: string[];
+}
+export const IGNORE_LINE: string;
+export const LABEL: string;
+export const CALLER_WORKFLOW: string;
+export function initRepo(
+  root: string,
+  options?: { dryRun?: boolean; label?: boolean },
+): InitResult;
+/** The repo's apps (folders with a playwright.config), "." for the root. */
+export function findApps(root: string): string[];
+export function initProject(
+  root: string,
+  options?: { dryRun?: boolean; label?: boolean },
+): InitResult & { apps: string[] };
+export function initApp(
+  appDir: string,
+  options?: { dryRun?: boolean },
+): InitResult;
+export function adapterSkeleton(options: {
+  app: string;
+  command?: string;
+  url?: string;
+  env: Record<string, string>;
+  mocks: { name: string; file: string }[];
+  demoDir: string;
+}): string;