@juangadm/pre-post 1.3.0 → 1.5.0

package/dist/ffmpeg.js

@@ -0,0 +1,143 @@
+/**
+ * Encoding with the ffmpeg Playwright already knows how to install.
+ *
+ * Playwright ships a 2.5 MB ffmpeg for its own video recording, installed the
+ * same way as the headless browser, so nobody has to install anything. It is a
+ * minimal build (measured, revision 1011): libvpx VP8 encode and decode, mjpeg
+ * decode, image2pipe in, WebM out, pad/crop/scale — and no `hstack`, no
+ * drawtext, no `-` alias for stdin (it has to be `pipe:0`, as Playwright's own
+ * recorder writes it). That is why frames are composited in a canvas and piped
+ * in as JPEGs, and why the output is WebM.
+ */
+import fs from 'fs';
+import path from 'path';
+import { spawn, spawnSync } from 'child_process';
+import { installBrowser, playwrightCacheDir } from './browser.js';
+import { onPath } from './baseline.js';
+const BINARY = process.platform === 'darwin' ? 'ffmpeg-mac'
+    : process.platform === 'win32' ? 'ffmpeg-win64.exe'
+        : 'ffmpeg-linux';
+/**
+ * The largest clip that is sure to upload. GitHub takes 10 MB of video on a
+ * Free plan (100 MB on paid ones, but nothing here can tell which), so a clip
+ * over this is re-encoded smaller rather than refused at upload.
+ */
+export const MAX_CLIP_BYTES = 8 * 1024 * 1024;
+/** Playwright's ffmpeg, newest revision first, when one is installed. */
+function findCached() {
+    const dir = playwrightCacheDir();
+    let entries;
+    try {
+        entries = fs.readdirSync(dir).filter(e => /^ffmpeg-\d+$/.test(e));
+    }
+    catch {
+        return null;
+    }
+    entries.sort((a, b) => Number(b.slice(7)) - Number(a.slice(7)));
+    for (const entry of entries) {
+        const full = path.join(dir, entry, BINARY);
+        if (fs.existsSync(full))
+            return full;
+    }
+    return null;
+}
+/** An ffmpeg on PATH that can encode VP8, the last resort. */
+function findSystem() {
+    if (!onPath('ffmpeg'))
+        return null;
+    const probe = spawnSync('ffmpeg', ['-hide_banner', '-encoders'], { encoding: 'utf-8' });
+    return probe.status === 0 && /libvpx/.test(probe.stdout) ? 'ffmpeg' : null;
+}
+/** Where ffmpeg is, without installing anything. For `doctor`. */
+export function findFfmpeg() {
+    const override = process.env.PRE_POST_FFMPEG;
+    if (override)
+        return fs.existsSync(override) ? override : null;
+    return findCached() ?? findSystem();
+}
+let ready = null;
+/** ffmpeg, installing Playwright's (one time, ~2 MB) when there is none. */
+export function ensureFfmpeg() {
+    ready ??= (async () => {
+        const found = findFfmpeg();
+        if (found)
+            return found;
+        if (await installBrowser('ffmpeg')) {
+            const installed = findCached();
+            if (installed)
+                return installed;
+        }
+        throw new Error('Video needs ffmpeg and it could not be installed. Run: npx playwright-core install ffmpeg');
+    })().catch(err => { ready = null; throw err; });
+    return ready;
+}
+const VP8 = ['-c:v', 'libvpx', '-qmin', '0', '-qmax', '50', '-deadline', 'realtime', '-cpu-used', '8', '-auto-alt-ref', '0'];
+/**
+ * Stream JPEG frames at `fps` into a WebM at `out`.
+ *
+ * `-crf 10` is what sets the quality; the bitrate only caps it. Measured on a
+ * dropdown clip, 1M and 3M came out within 15% of each other and both kept
+ * 16px text readable in an 800px pane.
+ */
+/** Run ffmpeg; `closed` resolves when it exits cleanly, rejects with its last error line. */
+function run(ffmpeg, args, stdin) {
+    const child = spawn(ffmpeg, ['-loglevel', 'error', '-y', ...args], { stdio: [stdin, 'ignore', 'pipe'] });
+    let stderr = '';
+    child.stderr.on('data', d => { stderr += d; });
+    const closed = new Promise((resolve, reject) => {
+        child.on('error', reject);
+        child.on('close', code => code === 0 ? resolve() : reject(new Error(`ffmpeg failed (exit ${code}): ${stderr.trim().split('\n').pop() ?? ''}`)));
+    });
+    return { child, closed };
+}
+export function startEncoder(ffmpeg, out, fps) {
+    const { child, closed } = run(ffmpeg, [
+        '-f', 'image2pipe', '-avioflags', 'direct', '-fpsprobesize', '0', '-probesize', '32', '-analyzeduration', '0',
+        '-framerate', String(fps), '-c:v', 'mjpeg', '-i', 'pipe:0',
+        '-an', ...VP8, '-crf', '10', '-b:v', '2M', out,
+    ], 'pipe');
+    const stdin = child.stdin;
+    // stdin errors (EPIPE when ffmpeg dies early) surface through `closed`.
+    stdin.on('error', () => undefined);
+    let exited = false;
+    closed.catch(() => undefined).finally(() => { exited = true; });
+    return {
+        async write(jpeg) {
+            // A dead encoder never drains, so waiting on 'drain' alone would hang
+            // the run forever; the spike did exactly that.
+            if (exited)
+                return closed;
+            if (!stdin.write(jpeg)) {
+                await Promise.race([new Promise(r => stdin.once('drain', r)), closed]);
+            }
+        },
+        async finish() {
+            stdin.end();
+            await closed;
+        },
+    };
+}
+/**
+ * Bring a clip under `maxBytes` by re-encoding it smaller, once. Returns the
+ * final size. Re-encodes from the WebM itself, so nothing has to keep every
+ * frame in memory in case the clip turns out large.
+ */
+export async function fitSize(ffmpeg, file, durationMs, maxBytes = MAX_CLIP_BYTES) {
+    const size = fs.statSync(file).size;
+    if (size <= maxBytes)
+        return size;
+    const seconds = Math.max(1, durationMs / 1000);
+    // 90% of the budget, leaving room for the container.
+    const kbps = Math.max(200, Math.floor((maxBytes * 8 * 0.9) / seconds / 1000));
+    const tmp = file.replace(/\.webm$/, '.fit.webm');
+    // Asynchronous: the other Moments are still being drawn and encoded, and a
+    // re-encode takes seconds.
+    await run(ffmpeg, [
+        '-i', file,
+        '-vf', 'scale=trunc(iw*0.75/2)*2:trunc(ih*0.75/2)*2',
+        '-an', ...VP8, '-crf', '30', '-b:v', `${kbps}k`, '-maxrate', `${kbps}k`, '-bufsize', `${kbps * 2}k`, tmp,
+    ], 'ignore').closed.catch(err => { throw new Error(`Could not shrink the clip: ${err.message}`); });
+    fs.renameSync(tmp, file);
+    return fs.statSync(file).size;
+}
+//# sourceMappingURL=ffmpeg.js.map

package/dist/ffmpeg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ffmpeg.js","sourceRoot":"","sources":["../src/ffmpeg.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY;IACzD,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,kBAAkB;QACjD,CAAC,CAAC,cAAc,CAAC;AAErB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAE9C,yEAAyE;AACzE,SAAS,UAAU;IACjB,MAAM,GAAG,GAAG,kBAAkB,EAAE,CAAC;IACjC,IAAI,OAAiB,CAAC;IACtB,IAAI,CAAC;QACH,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;IACvC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,8DAA8D;AAC9D,SAAS,UAAU;IACjB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACxF,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,UAAU;IACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IAC7C,IAAI,QAAQ;QAAE,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,OAAO,UAAU,EAAE,IAAI,UAAU,EAAE,CAAC;AACtC,CAAC;AAED,IAAI,KAAK,GAA2B,IAAI,CAAC;AAEzC,4EAA4E;AAC5E,MAAM,UAAU,YAAY;IAC1B,KAAK,KAAK,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC;QAC3B,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;QACxB,IAAI,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC;YAC/B,IAAI,SAAS;gBAAE,OAAO,SAAS,CAAC;QAClC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;IAC/G,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,KAAK,CAAC;AACf,CAAC;AASD,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;AAE7H;;;;;;GAMG;AACH,6FAA6F;AAC7F,SAAS,GAAG,CAAC,MAAc,EAAE,IAAc,EAAE,KAAwB;IACnE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACzG,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,CAAC,MAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnD,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,uBAAuB,IAAI,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAClJ,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,GAAW,EAAE,GAAW;IACnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE;QACpC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG;QAC7G,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ;QAC1D,KAAK,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;KAC/C,EAAE,MAAM,CAAC,CAAC;IACX,MAAM,KAAK,GAAG,KAAK,CAAC,KAAM,CAAC;IAC3B,wEAAwE;IACxE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO;QACL,KAAK,CAAC,KAAK,CAAC,IAAI;YACd,sEAAsE;YACtE,+CAA+C;YAC/C,IAAI,MAAM;gBAAE,OAAO,MAAM,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QACD,KAAK,CAAC,MAAM;YACV,KAAK,CAAC,GAAG,EAAE,CAAC;YACZ,MAAM,MAAM,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,MAAc,EAAE,IAAY,EAAE,UAAkB,EAAE,QAAQ,GAAG,cAAc;IACvG,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IACpC,IAAI,IAAI,IAAI,QAAQ;QAAE,OAAO,IAAI,CAAC;IAClC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC,CAAC;IAC/C,qDAAqD;IACrD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC;IAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACjD,2EAA2E;IAC3E,2BAA2B;IAC3B,MAAM,GAAG,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,6CAA6C;QACpD,KAAK,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,EAAE,UAAU,EAAE,GAAG,IAAI,GAAG,EAAE,UAAU,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,GAAG;KACzG,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpG,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzB,OAAO,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;AAChC,CAAC"}

package/dist/index.d.ts

@@ -22,4 +22,8 @@ export { runLogin } from './commands/login.js';
 export { runPrune } from './commands/prune.js';
 export { runDoctor } from './commands/doctor.js';
 export { runDetect } from './commands/detect.js';
+export { recordMoments } from './video.js';
+export type { RecordMomentsOptions } from './video.js';
+export { parseMoments, loadMomentsFile, MomentError, MAX_MOMENTS } from './moments.js';
+export type { Moment, Step } from './moments.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,YAAY,CAAC;AAC3B,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAClG,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,YAAY,CAAC;AAC3B,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAClG,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACvF,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -17,4 +17,6 @@ export { runLogin } from './commands/login.js';
 export { runPrune } from './commands/prune.js';
 export { runDoctor } from './commands/doctor.js';
 export { runDetect } from './commands/detect.js';
+export { recordMoments } from './video.js';
+export { parseMoments, loadMomentsFile, MomentError, MAX_MOMENTS } from './moments.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAElG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAElG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}

package/dist/moments.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Moments: short, named interactions recorded on Pre and Post and played side
+ * by side in one clip.
+ *
+ * A screenshot cannot show a menu opening or a hover state; a recording of a
+ * page sitting still shows nothing either (that is why the first GIF attempt
+ * was parked). So the unit of video is an interaction a person would do —
+ * "Open the account menu" — written as a few plain steps that target what the
+ * person sees, not CSS.
+ *
+ * Everything here is pure: parsing, validation, choosing which Moments run,
+ * and the sentences a reviewer reads. The browser side is `record.ts`.
+ */
+declare const VERBS: readonly ["click", "hover", "type", "press", "scroll", "wait"];
+export type StepVerb = typeof VERBS[number];
+export type Step = {
+    verb: 'click' | 'hover';
+    target: string;
+} | {
+    verb: 'type';
+    target: string;
+    text: string;
+} | {
+    verb: 'press';
+    key: string;
+} | {
+    verb: 'scroll';
+    target?: string;
+    px?: number;
+} | {
+    verb: 'wait';
+    ms: number;
+};
+export interface Moment {
+    /** What a reviewer reads above the clip, e.g. "Open the account menu". */
+    name: string;
+    route: string;
+    /** Viewport preset or WxH. Default desktop. */
+    viewport: string;
+    steps: Step[];
+}
+/** As written in `.pre-post.json` or a `--moments` file. */
+export interface MomentInput {
+    name?: unknown;
+    route?: unknown;
+    viewport?: unknown;
+    steps?: unknown;
+}
+/**
+ * Moments per run. A big PR gets video for the few changes a reviewer most
+ * needs to see move; every changed page still gets screenshots. Order is
+ * priority: the first three run, the rest are named in one line.
+ */
+export declare const MAX_MOMENTS = 3;
+/**
+ * Past this a clip still ships, with a nudge to split it. Not a cap: length
+ * comes only from the steps someone wrote, so nothing records for minutes on
+ * its own, and a clip a reviewer can take in on one play is the goal.
+ */
+export declare const LONG_CLIP_MS = 30000;
+export declare class MomentError extends Error {
+}
+/** Validate one Moment. `where` names it in errors, e.g. "Moment 2". */
+export declare function parseMoment(raw: MomentInput, where: string): Moment;
+/** Validate a list of Moments, as found in config or a file. */
+export declare function parseMoments(raw: unknown, source: string): Moment[];
+/** Read a `--moments` file. */
+export declare function loadMomentsFile(file: string, cwd?: string): Moment[];
+/** The Moments that run, in priority order, and the names of the rest. */
+export declare function selectMoments(moments: Moment[]): {
+    run: Moment[];
+    skipped: string[];
+};
+/** A name as a reviewer reads it: “Open the account menu”. */
+export declare function quote(s: string): string;
+/** A step as a reviewer would say it: `Click “Save”`. Shown under the clip. */
+export declare function describeStep(step: Step): string;
+/** One line for a clip that ran long, or null. */
+export declare function longClipNote(name: string, durationMs: number): string | null;
+/** One line naming the Moments over the limit, or null. */
+export declare function skippedNote(skipped: string[]): string | null;
+export {};
+//# sourceMappingURL=moments.d.ts.map

package/dist/moments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moments.d.ts","sourceRoot":"","sources":["../src/moments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAMH,QAAA,MAAM,KAAK,gEAAiE,CAAC;AAC7E,MAAM,MAAM,QAAQ,GAAG,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC;AAE5C,MAAM,MAAM,IAAI,GACZ;IAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjC,MAAM,WAAW,MAAM;IACrB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,4DAA4D;AAC5D,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,IAAI,CAAC;AAE7B;;;;GAIG;AACH,eAAO,MAAM,YAAY,QAAS,CAAC;AAQnC,qBAAa,WAAY,SAAQ,KAAK;CAAG;AAmDzC,wEAAwE;AACxE,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAkBnE;AAED,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAKnE;AAED,+BAA+B;AAC/B,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,SAAgB,GAAG,MAAM,EAAE,CAe3E;AAED,0EAA0E;AAC1E,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAErF;AAED,8DAA8D;AAC9D,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEvC;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAS/C;AAED,kDAAkD;AAClD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG5E;AAED,2DAA2D;AAC3D,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAG5D"}

package/dist/moments.js

@@ -0,0 +1,170 @@
+/**
+ * Moments: short, named interactions recorded on Pre and Post and played side
+ * by side in one clip.
+ *
+ * A screenshot cannot show a menu opening or a hover state; a recording of a
+ * page sitting still shows nothing either (that is why the first GIF attempt
+ * was parked). So the unit of video is an interaction a person would do —
+ * "Open the account menu" — written as a few plain steps that target what the
+ * person sees, not CSS.
+ *
+ * Everything here is pure: parsing, validation, choosing which Moments run,
+ * and the sentences a reviewer reads. The browser side is `record.ts`.
+ */
+import fs from 'fs';
+import path from 'path';
+import { parseViewport } from './viewport.js';
+const VERBS = ['click', 'hover', 'type', 'press', 'scroll', 'wait'];
+/**
+ * Moments per run. A big PR gets video for the few changes a reviewer most
+ * needs to see move; every changed page still gets screenshots. Order is
+ * priority: the first three run, the rest are named in one line.
+ */
+export const MAX_MOMENTS = 3;
+/**
+ * Past this a clip still ships, with a nudge to split it. Not a cap: length
+ * comes only from the steps someone wrote, so nothing records for minutes on
+ * its own, and a clip a reviewer can take in on one play is the goal.
+ */
+export const LONG_CLIP_MS = 30_000;
+/** What a clip should aim for; used in the nudge. */
+const TARGET_CLIP_S = 15;
+/** A `wait` longer than this is almost certainly a mistake (ms, not s). */
+const MAX_WAIT_MS = 10_000;
+export class MomentError extends Error {
+}
+function fail(where, message) {
+    throw new MomentError(`${where}: ${message}`);
+}
+function parseStep(raw, where) {
+    if (!raw || typeof raw !== 'object' || Array.isArray(raw)) {
+        fail(where, `expected a step like { "click": "Save" }, got ${JSON.stringify(raw)}`);
+    }
+    const keys = Object.keys(raw);
+    if (keys.length !== 1 || !VERBS.includes(keys[0])) {
+        fail(where, `a step has exactly one of ${VERBS.join(', ')} (got ${keys.join(', ') || 'nothing'})`);
+    }
+    const verb = keys[0];
+    const value = raw[verb];
+    const text = (v) => typeof v === 'string' && v.trim() ? v : null;
+    switch (verb) {
+        case 'click':
+        case 'hover': {
+            const target = text(value);
+            if (!target)
+                fail(where, `"${verb}" needs the text of what to ${verb}, e.g. { "${verb}": "Save" }`);
+            return { verb, target };
+        }
+        case 'type': {
+            if (!Array.isArray(value) || value.length !== 2 || !text(value[0]) || typeof value[1] !== 'string') {
+                fail(where, '"type" needs [field, text], e.g. { "type": ["Email", "ada@example.com"] }');
+            }
+            return { verb, target: value[0], text: value[1] };
+        }
+        case 'press': {
+            const key = text(value);
+            if (!key)
+                fail(where, '"press" needs a key, e.g. { "press": "Escape" }');
+            return { verb, key };
+        }
+        case 'scroll': {
+            if (typeof value === 'number' && Number.isFinite(value))
+                return { verb, px: value };
+            const target = text(value);
+            if (!target)
+                fail(where, '"scroll" needs the text to scroll to, or a number of pixels');
+            return { verb, target };
+        }
+        case 'wait': {
+            if (typeof value !== 'number' || !Number.isFinite(value) || value < 0) {
+                fail(where, '"wait" needs milliseconds, e.g. { "wait": 600 }');
+            }
+            if (value > MAX_WAIT_MS)
+                fail(where, `"wait" is in milliseconds; ${value} is over ${MAX_WAIT_MS / 1000}s`);
+            return { verb, ms: value };
+        }
+    }
+}
+/** Validate one Moment. `where` names it in errors, e.g. "Moment 2". */
+export function parseMoment(raw, where) {
+    if (!raw || typeof raw !== 'object' || Array.isArray(raw))
+        fail(where, 'expected an object with name, route and steps');
+    const name = typeof raw.name === 'string' ? raw.name.trim() : '';
+    if (!name)
+        fail(where, 'needs a "name" — the caption a reviewer reads, e.g. "Open the account menu"');
+    const label = `${where} ("${name}")`;
+    const route = typeof raw.route === 'string' ? raw.route.trim() : '';
+    if (!route.startsWith('/'))
+        fail(label, 'needs a "route" starting with /, e.g. "/settings"');
+    const viewport = raw.viewport === undefined ? 'desktop' : typeof raw.viewport === 'string' ? raw.viewport.trim() : '';
+    // Checked here, with the rest of the file, so a typo stops the run before
+    // any capture instead of costing one Moment after all of them were recorded.
+    try {
+        parseViewport(viewport);
+    }
+    catch {
+        fail(label, `"viewport" is desktop, tablet, mobile or WxH (got ${JSON.stringify(raw.viewport)})`);
+    }
+    if (raw.steps !== undefined && !Array.isArray(raw.steps))
+        fail(label, '"steps" is a list');
+    const steps = (raw.steps ?? []).map((s, i) => parseStep(s, `${label} step ${i + 1}`));
+    return { name, route, viewport, steps };
+}
+/** Validate a list of Moments, as found in config or a file. */
+export function parseMoments(raw, source) {
+    const list = Array.isArray(raw) ? raw
+        : raw && typeof raw === 'object' && Array.isArray(raw.moments) ? raw.moments
+            : fail(source, 'expected a list of Moments, or { "moments": [...] }');
+    return list.map((m, i) => parseMoment(m, `${source}, Moment ${i + 1}`));
+}
+/** Read a `--moments` file. */
+export function loadMomentsFile(file, cwd = process.cwd()) {
+    const full = path.resolve(cwd, file);
+    let text;
+    try {
+        text = fs.readFileSync(full, 'utf-8');
+    }
+    catch {
+        throw new MomentError(`Cannot read the Moments file ${file}.`);
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch (err) {
+        throw new MomentError(`${file} is not valid JSON: ${err.message}`);
+    }
+    return parseMoments(parsed, path.basename(file));
+}
+/** The Moments that run, in priority order, and the names of the rest. */
+export function selectMoments(moments) {
+    return { run: moments.slice(0, MAX_MOMENTS), skipped: moments.slice(MAX_MOMENTS).map(m => m.name) };
+}
+/** A name as a reviewer reads it: “Open the account menu”. */
+export function quote(s) {
+    return `“${s}”`;
+}
+/** A step as a reviewer would say it: `Click “Save”`. Shown under the clip. */
+export function describeStep(step) {
+    switch (step.verb) {
+        case 'click': return `Click ${quote(step.target)}`;
+        case 'hover': return `Hover ${quote(step.target)}`;
+        case 'type': return `Type ${quote(step.text)} into ${quote(step.target)}`;
+        case 'press': return `Press ${step.key}`;
+        case 'scroll': return step.target ? `Scroll to ${quote(step.target)}` : `Scroll ${step.px >= 0 ? 'down' : 'up'} ${Math.abs(step.px)}px`;
+        case 'wait': return 'Wait';
+    }
+}
+/** One line for a clip that ran long, or null. */
+export function longClipNote(name, durationMs) {
+    if (durationMs <= LONG_CLIP_MS)
+        return null;
+    return `${quote(name)} is ${Math.round(durationMs / 1000)}s — clips under ${TARGET_CLIP_S}s get watched; consider splitting it into smaller Moments.`;
+}
+/** One line naming the Moments over the limit, or null. */
+export function skippedNote(skipped) {
+    if (!skipped.length)
+        return null;
+    return `Recorded the first ${MAX_MOMENTS} Moments; also listed, not recorded: ${skipped.map(quote).join(', ')}.`;
+}
+//# sourceMappingURL=moments.js.map

package/dist/moments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moments.js","sourceRoot":"","sources":["../src/moments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AA2B7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC;AAE7B;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAEnC,qDAAqD;AACrD,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB,2EAA2E;AAC3E,MAAM,WAAW,GAAG,MAAM,CAAC;AAE3B,MAAM,OAAO,WAAY,SAAQ,KAAK;CAAG;AAEzC,SAAS,IAAI,CAAC,KAAa,EAAE,OAAe;IAC1C,MAAM,IAAI,WAAW,CAAC,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,SAAS,CAAC,GAAY,EAAE,KAAa;IAC5C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC,KAAK,EAAE,iDAAiD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAE,KAA2B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,CAAC,KAAK,EAAE,6BAA6B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,GAAG,CAAC,CAAC;IACrG,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAa,CAAC;IACjC,MAAM,KAAK,GAAI,GAA+B,CAAC,IAAI,CAAC,CAAC;IACrD,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1E,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,+BAA+B,IAAI,aAAa,IAAI,aAAa,CAAC,CAAC;YACpG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC1B,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACnG,IAAI,CAAC,KAAK,EAAE,2EAA2E,CAAC,CAAC;YAC3F,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,CAAC,GAAG;gBAAE,IAAI,CAAC,KAAK,EAAE,iDAAiD,CAAC,CAAC;YACzE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QACvB,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;YACpF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,KAAK,EAAE,6DAA6D,CAAC,CAAC;YACxF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC1B,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACtE,IAAI,CAAC,KAAK,EAAE,iDAAiD,CAAC,CAAC;YACjE,CAAC;YACD,IAAI,KAAK,GAAG,WAAW;gBAAE,IAAI,CAAC,KAAK,EAAE,8BAA8B,KAAK,YAAY,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC;YAC3G,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,WAAW,CAAC,GAAgB,EAAE,KAAa;IACzD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,IAAI,CAAC,KAAK,EAAE,+CAA+C,CAAC,CAAC;IACxH,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,IAAI,CAAC,IAAI;QAAE,IAAI,CAAC,KAAK,EAAE,6EAA6E,CAAC,CAAC;IACtG,MAAM,KAAK,GAAG,GAAG,KAAK,MAAM,IAAI,IAAI,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,IAAI,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAC7F,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtH,0EAA0E;IAC1E,6EAA6E;IAC7E,IAAI,CAAC;QACH,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC,KAAK,EAAE,qDAAqD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACpG,CAAC;IACD,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;QAAE,IAAI,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;IAC3F,MAAM,KAAK,GAAG,CAAE,GAAG,CAAC,KAA+B,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACjH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC1C,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,YAAY,CAAC,GAAY,EAAE,MAAc;IACvD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG;QACnC,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAE,GAA6B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,GAA8B,CAAC,OAAO;YACjI,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,qDAAqD,CAAC,CAAC;IAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAgB,EAAE,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrC,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,WAAW,CAAC,gCAAgC,IAAI,GAAG,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,WAAW,CAAC,GAAG,IAAI,uBAAwB,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,aAAa,CAAC,OAAiB;IAC7C,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;AACtG,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,KAAK,CAAC,CAAS;IAC7B,OAAO,IAAI,CAAC,GAAG,CAAC;AAClB,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,YAAY,CAAC,IAAU;IACrC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,OAAO,CAAC,CAAC,OAAO,SAAS,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,KAAK,OAAO,CAAC,CAAC,OAAO,SAAS,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,KAAK,MAAM,CAAC,CAAC,OAAO,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1E,KAAK,OAAO,CAAC,CAAC,OAAO,SAAS,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAG,CAAC,IAAI,CAAC;QAC1I,KAAK,MAAM,CAAC,CAAC,OAAO,MAAM,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,UAAkB;IAC3D,IAAI,UAAU,IAAI,YAAY;QAAE,OAAO,IAAI,CAAC;IAC5C,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,mBAAmB,aAAa,4DAA4D,CAAC;AACxJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,WAAW,CAAC,OAAiB;IAC3C,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACjC,OAAO,sBAAsB,WAAW,wCAAwC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AACnH,CAAC"}

package/dist/record.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Record one side of a Moment: load the page, then play its steps while the
+ * browser streams frames.
+ *
+ * Frames come from CDP `Page.startScreencast`, which sends a frame only when
+ * pixels change — about every 17 ms during a transition, nothing while the
+ * page sits still (measured; docs/internal/video-spike.md). Playwright's own
+ * `recordVideo` was the alternative: fixed at 25 fps and recording from the
+ * moment the context opens, load and all.
+ *
+ * Every step's start time is marked, so `timeline.ts` can line the two sides
+ * up step by step. A step that fails ends the recording at the moment it
+ * began: the seconds spent looking for a button that is not there are not
+ * something a reviewer should watch.
+ */
+import { AuthOptions, ViewportSize } from './types.js';
+import { Moment } from './moments.js';
+import { SideTiming } from './timeline.js';
+/** Still frames before the first step, so the viewer sees the page first. */
+export declare const LEAD_IN_MS = 500;
+/** After each step, so its result is on screen before the next one starts. */
+export declare const BREATH_MS = 400;
+/** After the last step, so the clip ends on the result. */
+export declare const TAIL_MS = 1000;
+/** A Moment with no steps records this much of the page loading, for entrance animations. */
+export declare const LOAD_ONLY_MS = 3000;
+/**
+ * How long a step looks for its target. Short, because a missing target is
+ * the normal case on Pre for a new feature, and every second spent looking is
+ * a second the whole run waits.
+ */
+export declare const FIND_TIMEOUT_MS = 3000;
+/** How long a found target's action (click, hover, typing) may take. */
+export declare const STEP_TIMEOUT_MS = 5000;
+export interface Frame {
+    t: number;
+    data: Buffer;
+}
+/** Where a pointer step acted, in viewport CSS pixels, for the click marker. */
+export interface PointerMark {
+    step: number;
+    x: number;
+    y: number;
+}
+export interface SideRecording extends SideTiming {
+    viewport: ViewportSize;
+    frames: Frame[];
+    pointers: PointerMark[];
+    /** HTTP status of the page. */
+    status?: number;
+    /** The step that could not be done, and why, in plain words. */
+    failure?: {
+        step: number;
+        message: string;
+    };
+}
+export declare class StepError extends Error {
+}
+/**
+ * Record `moment` on `url`. Throws NavigationError / HttpStatusError when the
+ * page cannot be loaded; returns a recording with `failure` set when a step
+ * cannot be done. A page that answers 4xx/5xx comes back with its status and
+ * no frames, for the caller to phrase.
+ */
+export declare function recordSide(url: string, moment: Moment, viewport: ViewportSize, opts: {
+    auth?: AuthOptions;
+    maxWidth: number;
+}): Promise<SideRecording>;
+//# sourceMappingURL=record.d.ts.map

package/dist/record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAQ,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,6EAA6E;AAC7E,eAAO,MAAM,UAAU,MAAM,CAAC;AAC9B,8EAA8E;AAC9E,eAAO,MAAM,SAAS,MAAM,CAAC;AAC7B,2DAA2D;AAC3D,eAAO,MAAM,OAAO,OAAO,CAAC;AAC5B,6FAA6F;AAC7F,eAAO,MAAM,YAAY,OAAO,CAAC;AACjC;;;;GAIG;AACH,eAAO,MAAM,eAAe,OAAO,CAAC;AACpC,wEAAwE;AACxE,eAAO,MAAM,eAAe,OAAO,CAAC;AAOpC,MAAM,WAAW,KAAK;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,IAAI,EAAE,MAAM,CAAC;CACd;AAED,gFAAgF;AAChF,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,QAAQ,EAAE,YAAY,CAAC;IACvB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C;AAED,qBAAa,SAAU,SAAQ,KAAK;CAAG;AAwHvC;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE;IAAE,IAAI,CAAC,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAwD5J"}