screencast-axi 0.1.0

package/dist/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,MAAM,IAAI,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAkB,MAAM,YAAY,CAAC;AAE5D,MAAM,CAAC,MAAM,WAAW,GACtB,yEAAyE,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,cAAc,GAAG,GAAG;IACxB,gDAAgD;IAChD,EAAE;IACF,WAAW;IACX,iEAAiE;IACjE,kDAAkD;IAClD,2EAA2E;IAC3E,4DAA4D;IAC5D,yEAAyE;IACzE,mEAAmE;IACnE,yCAAyC;IACzC,wEAAwE;IACxE,sEAAsE;IACtE,wEAAwE;IACxE,sEAAsE;IACtE,EAAE;IACF,wEAAwE;CACzE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAEjB,SAAS,WAAW,CAAC,IAAY,EAAE,WAAmB,EAAE,KAAe,EAAE,KAAgB;IACvF,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,GAAG;QACR,YAAY,IAAI,EAAE;QAClB,gBAAgB,WAAW,EAAE;QAC7B,EAAE;QACF,QAAQ;QACR,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC;AAED,MAAM,YAAY,GAA2B;IAC3C,KAAK,EAAE,SAAS,EAAE;IAClB,MAAM,EAAE,WAAW,CACjB,QAAQ,EACR,oCAAoC,EACpC;QACE,mEAAmE;QACnE,gEAAgE;QAChE,iEAAiE;KAClE,EACD,YAAY,CACb;IACD,QAAQ,EAAE,WAAW,CACnB,UAAU,EACV,sEAAsE,EACtE,CAAC,8BAA8B,EAAE,4CAA4C,CAAC,EAC9E,cAAc,CACf;IACD,IAAI,EAAE,WAAW,CACf,MAAM,EACN,gEAAgE,EAChE;QACE,mFAAmF;QACnF,mFAAmF;QACnF,4EAA4E;KAC7E,EACD,UAAU,CACX;IACD,IAAI,EAAE,WAAW,CACf,MAAM,EACN,6CAA6C,EAC7C,CAAC,qBAAqB,EAAE,6BAA6B,EAAE,4BAA4B,CAAC,EACpF,UAAU,CACX;IACD,IAAI,EAAE,WAAW,CACf,MAAM,EACN,oEAAoE,EACpE,CAAC,kCAAkC,CAAC,EACpC,UAAU,CACX;IACD,KAAK,EAAE,WAAW,CAChB,OAAO,EACP,oEAAoE,EACpE,CAAC,sBAAsB,EAAE,oCAAoC,CAAC,EAC9D,WAAW,CACZ;IACD,MAAM,EAAE,WAAW,CACjB,QAAQ,EACR,kDAAkD,EAClD,CAAC,uBAAuB,CAAC,EACzB,YAAY,CACb;IACD,KAAK,EAAE,WAAW,CAChB,OAAO,EACP,sEAAsE,EACtE,CAAC,sBAAsB,EAAE,sCAAsC,CAAC,EAChE,WAAW,CACZ;IACD,IAAI,EAAE,WAAW,CACf,MAAM,EACN,+DAA+D,EAC/D,CAAC,qBAAqB,EAAE,+CAA+C,CAAC,EACxE,UAAU,CACX;IACD,QAAQ,EAAE,WAAW,CACnB,UAAU,EACV,uEAAuE,EACvE;QACE,gEAAgE;QAChE,yEAAyE;KAC1E,EACD,cAAc,CACf;CACF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;QAC1B,OAAO;YACL,MAAM,EAAE,GAAG,IAAI,CAAC;gBACd,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,QAAQ,EAAE,KAAK,CAAC,UAAU;gBAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrD,GAAG,CAAC,CAAC,CAAC,WAAW;oBACf,CAAC,CAAC;wBACE,YAAY,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;4BACtC,QAAQ,EAAE,CAAC,CAAC,QAAQ;4BACpB,KAAK,EAAE,CAAC,CAAC,KAAK;4BACd,OAAO,EAAE,CAAC,CAAC,OAAO;yBACnB,CAAC,CAAC;qBACJ;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrE,CAAC,IAAI;YACN,QAAQ,EAAE,CAAC;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO;YACL,MAAM,EAAE,GAAG,IAAI,CAAC;gBACd,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrE,CAAC,IAAI;YACN,yEAAyE;YACzE,0CAA0C;YAC1C,QAAQ,EAAE,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,GAAG,IAAI,CAAC;YACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;YAC7D,IAAI,EAAE,SAAS;SAChB,CAAC,IAAI;QACN,QAAQ,EAAE,CAAC;KACZ,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAe;IACxC,MAAM,SAAS,CAAC;QACd,WAAW;QACX,WAAW,EAAE,WAAW;QACxB,OAAO,EAAE,OAAO;QAChB,YAAY,EAAE,cAAc;QAC5B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzB,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;QACtB,QAAQ,EAAE;YACR,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YACnC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC;YACzC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;YACjC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YACnC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC;YACrC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YACnC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;YACjC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC;YAC/C,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC;SACpD;QACD,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC;KACnD,CAAC,CAAC;AACL,CAAC"}

package/dist/src/commands/auth.d.ts

@@ -0,0 +1,4 @@
+import { type FlagSpecs } from "../flags.js";
+import type { AxiStructuredOutput } from "../output.js";
+export declare const AUTH_FLAGS: FlagSpecs;
+export declare function authCommand(args: string[]): Promise<AxiStructuredOutput>;

package/dist/src/commands/auth.js

@@ -0,0 +1,207 @@
+import { mkdir } from "node:fs/promises";
+import { dirname, isAbsolute, resolve } from "node:path";
+import { openContext, resolveViewport } from "../browser.js";
+import { loadConfig, selectStrategy } from "../config.js";
+import { ScreencastError } from "../errors.js";
+import { parseFlags } from "../flags.js";
+import { parseDuration } from "../duration.js";
+export const AUTH_FLAGS = {
+    config: { kind: "string", description: "Path to a config file", placeholder: "path" },
+    "base-url": { kind: "string", description: "Site to sign in to", placeholder: "url" },
+    interactive: { kind: "boolean", description: "Required for `login`: opens a real browser" },
+    "save-state": {
+        kind: "string",
+        description: "Write a Playwright storage state here as well",
+        placeholder: "path",
+    },
+    headed: { kind: "boolean", description: "Show the browser for `check`" },
+    wait: {
+        kind: "string",
+        description: "How long `login` waits for the window to close (default 5m)",
+        placeholder: "5m",
+    },
+};
+function contextFor(baseUrl, rootDir) {
+    return {
+        baseUrl,
+        rootDir,
+        scenario: { id: "auth", title: "Sign-in check" },
+        log: (message) => void process.stderr.write(`  ${message}\n`),
+    };
+}
+/**
+ * Whether a browser window could actually be seen by someone.
+ *
+ * On Linux a missing DISPLAY means no window can appear at all, so waiting for
+ * one to close is dead time. macOS and Windows always have a desktop for a
+ * logged-in session.
+ */
+function hasDisplay() {
+    if (process.platform !== "linux")
+        return true;
+    return Boolean(process.env["DISPLAY"] ?? process.env["WAYLAND_DISPLAY"]);
+}
+async function withTimeout(work, ms, baseUrl) {
+    let timer;
+    try {
+        return await Promise.race([
+            work,
+            new Promise((_, reject) => {
+                timer = setTimeout(() => reject(new ScreencastError("Timed out waiting for the sign-in window", "LOGIN_TIMEOUT", [
+                    "Nothing was saved. Run it again when there is time to finish signing in",
+                    `Give it longer with \`--wait 15m\`, or sign in at ${baseUrl} first`,
+                ])), ms);
+            }),
+        ]);
+    }
+    finally {
+        if (timer)
+            clearTimeout(timer);
+    }
+}
+export async function authCommand(args) {
+    const { positionals, flags } = parseFlags(args, AUTH_FLAGS);
+    const [action, name] = positionals;
+    if (action !== "login" && action !== "check") {
+        throw new ScreencastError(action ? `Unknown auth action: ${action}` : "Say what to do", "VALIDATION_ERROR", [
+            "`screencast-axi auth login --interactive` opens a browser to sign in by hand",
+            "`screencast-axi auth check` reports whether the saved session still works",
+        ]);
+    }
+    const config = await loadConfig(flags["config"]);
+    const baseUrl = flags["base-url"] ?? config.baseUrl;
+    const strategy = selectStrategy(config, undefined, name);
+    if (!strategy) {
+        throw new ScreencastError("No auth strategy is configured", "NO_AUTH_STRATEGY", [
+            "Add one under `auth` in screencast.config.ts",
+            "`profileAuth()` is the one that needs no code for the site you are recording",
+            "Import it from `screencast-axi`",
+        ]);
+    }
+    const viewport = await resolveViewport({ ...(config.device ? { device: config.device } : {}) }, config.viewport);
+    const authCtx = contextFor(baseUrl, config.rootDir);
+    if (action === "login") {
+        return login(config, strategy, viewport, authCtx, flags);
+    }
+    return check(config, strategy, viewport, authCtx, flags);
+}
+/**
+ * Opens a browser so a person can sign in by hand.
+ *
+ * The one command here that needs a human, and the reason the whole tool works
+ * on a site nobody wrote a strategy for: OAuth, SSO, a magic link and
+ * two-factor are all just "the person does the thing", and the session lands
+ * in the profile.
+ *
+ * It never reads stdin, so an agent can open the window on the user's screen
+ * rather than making them retype a command. What it must never do is hang: the
+ * wait is bounded, it says on stderr what it is waiting for, and it refuses up
+ * front where no window could appear (a headless Linux box has no display, so
+ * nobody would ever see it and the wait would be pure dead time).
+ *
+ * `--interactive` stays required. An agent reaching for `auth login` without
+ * meaning to involve a person should be told to, not quietly open a window.
+ */
+async function login(config, strategy, viewport, authCtx, flags) {
+    if (!strategy.interactiveLogin) {
+        throw new ScreencastError(`The \`${strategy.name}\` strategy has no interactive sign-in`, "NOT_SUPPORTED", [
+            "`profileAuth()` is the strategy that signs in through a real browser",
+            `\`${strategy.name}\` gets its session another way - check its own configuration`,
+        ]);
+    }
+    if (flags["interactive"] !== true) {
+        throw new ScreencastError("Signing in needs a person at the keyboard", "NEEDS_HUMAN", [
+            "Pass `--interactive` to open a browser window for them to sign in",
+            "The window has to appear on a screen someone is actually looking at",
+        ]);
+    }
+    if (!hasDisplay()) {
+        throw new ScreencastError("No display to open a browser window on", "NO_DISPLAY", [
+            "Ask the user to run this on their own machine:",
+            `  npx -y screencast-axi auth login --interactive --base-url ${authCtx.baseUrl}`,
+            "Or produce a session file there and point `storageStateAuth` at it",
+        ]);
+    }
+    if (!config.browser.profileDir) {
+        throw new ScreencastError("No profile directory to save the session in", "CONFIG_MISSING", [
+            "Set `browser.profileDir` in screencast.config.ts, e.g. `.screencast/profile`",
+            "The profile is what remembers the session between takes - add it to .gitignore",
+        ]);
+    }
+    await mkdir(config.browser.profileDir, { recursive: true });
+    const opened = await openContext({
+        resolved: viewport,
+        headless: false,
+        args: config.browser.args,
+        profileDir: config.browser.profileDir,
+    });
+    try {
+        const waitMs = flags["wait"] ? parseDuration(flags["wait"]) : 5 * 60_000;
+        // Immediately, and to stderr: a window has appeared somewhere and the
+        // process is now waiting on a human. Silence here reads as a hang.
+        process.stderr.write(`A browser window is open at ${authCtx.baseUrl}.\n` +
+            `Sign in, then close the window. Waiting up to ${Math.round(waitMs / 60_000)} minutes.\n`);
+        await withTimeout(strategy.interactiveLogin(opened.context, opened.page, authCtx), waitMs, authCtx.baseUrl);
+        const savePath = flags["save-state"];
+        let saved;
+        if (savePath) {
+            saved = isAbsolute(savePath) ? savePath : resolve(config.rootDir, savePath);
+            await mkdir(dirname(saved), { recursive: true });
+            await opened.context.storageState({ path: saved });
+        }
+        return {
+            "signed in": strategy.name,
+            profile: config.browser.profileDir,
+            ...(saved ? { storage_state: saved } : {}),
+            help: [
+                "Check it took: `screencast-axi auth check`",
+                "The session lives in the profile, so every take reuses it until it expires",
+                ...(saved ? [] : ["Add `--save-state <path>` to also write a portable session file"]),
+            ],
+        };
+    }
+    finally {
+        await opened.close().catch(() => undefined);
+    }
+}
+/** Reports whether the saved session still gets past the login. */
+async function check(config, strategy, viewport, authCtx, flags) {
+    await strategy.preflight?.(authCtx);
+    const patch = strategy.prepareContext?.(authCtx) ?? {};
+    const opened = await openContext({
+        resolved: viewport,
+        headless: flags["headed"] !== true,
+        args: config.browser.args,
+        ...(config.browser.profileDir ? { profileDir: config.browser.profileDir } : {}),
+        ...(patch.storageState ? { storageState: patch.storageState } : {}),
+        ...(patch.httpCredentials ? { httpCredentials: patch.httpCredentials } : {}),
+    });
+    try {
+        // Open the site first. A strategy that only patches the context - basic
+        // auth, a storage state - never navigates on its own, and reporting
+        // `landed: about:blank` next to "signed in: true" tells nobody anything.
+        // A strategy that does navigate (to verify) simply moves on from here.
+        await opened.page.goto(authCtx.baseUrl, { waitUntil: "domcontentloaded" });
+        const identity = await strategy.signIn?.(opened.page, authCtx);
+        await strategy.assertSignedIn?.(opened.page, authCtx);
+        const shot = resolve(config.rawDir, "auth-check.png");
+        await mkdir(config.rawDir, { recursive: true });
+        await opened.page.screenshot({ path: shot }).catch(() => undefined);
+        return {
+            "signed in": true,
+            strategy: strategy.name,
+            ...(identity ? { as: identity.label } : {}),
+            landed: opened.page.url(),
+            screenshot: shot,
+            ...(strategy.describe ? { config: strategy.describe() } : {}),
+            help: [
+                "Looks good. Record with `screencast-axi record <id>`",
+                "Open the screenshot if the landed URL is not what you expected",
+            ],
+        };
+    }
+    finally {
+        await opened.close().catch(() => undefined);
+    }
+}
+//# sourceMappingURL=auth.js.map

package/dist/src/commands/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/commands/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAkB,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAI/C,MAAM,CAAC,MAAM,UAAU,GAAc;IACnC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,EAAE;IACrF,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,WAAW,EAAE,KAAK,EAAE;IACrF,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,4CAA4C,EAAE;IAC3F,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,+CAA+C;QAC5D,WAAW,EAAE,MAAM;KACpB;IACD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,8BAA8B,EAAE;IACxE,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6DAA6D;QAC1E,WAAW,EAAE,IAAI;KAClB;CACF,CAAC;AAEF,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe;IAClD,OAAO;QACL,OAAO;QACP,OAAO;QACP,QAAQ,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE;QAChD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,OAAO,IAAI,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU;IACjB,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IAC9C,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,KAAK,UAAU,WAAW,CAAI,IAAgB,EAAE,EAAU,EAAE,OAAe;IACzE,IAAI,KAAiC,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;YACxB,IAAI;YACJ,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;gBAC/B,KAAK,GAAG,UAAU,CAChB,GAAG,EAAE,CACH,MAAM,CACJ,IAAI,eAAe,CAAC,0CAA0C,EAAE,eAAe,EAAE;oBAC/E,yEAAyE;oBACzE,qDAAqD,OAAO,QAAQ;iBACrE,CAAC,CACH,EACH,EAAE,CACH,CAAC;YACJ,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,IAAI,KAAK;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAc;IAC9C,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC;IAEnC,IAAI,MAAM,KAAK,OAAO,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QAC7C,MAAM,IAAI,eAAe,CACvB,MAAM,CAAC,CAAC,CAAC,wBAAwB,MAAM,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAC5D,kBAAkB,EAClB;YACE,8EAA8E;YAC9E,2EAA2E;SAC5E,CACF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAuB,CAAC,CAAC;IACvE,MAAM,OAAO,GAAI,KAAK,CAAC,UAAU,CAAwB,IAAI,MAAM,CAAC,OAAO,CAAC;IAC5E,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,EAAE;YAC9E,8CAA8C;YAC9C,8EAA8E;YAC9E,iCAAiC;SAClC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,eAAe,CACpC,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EACvD,MAAM,CAAC,QAAQ,CAChB,CAAC;IACF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAEpD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAOD;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,KAAK,CAClB,MAAc,EACd,QAAkB,EAClB,QAAkB,EAClB,OAAoB,EACpB,KAAY;IAEZ,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CACvB,SAAS,QAAQ,CAAC,IAAI,wCAAwC,EAC9D,eAAe,EACf;YACE,sEAAsE;YACtE,KAAK,QAAQ,CAAC,IAAI,+DAA+D;SAClF,CACF,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CAAC,2CAA2C,EAAE,aAAa,EAAE;YACpF,mEAAmE;YACnE,qEAAqE;SACtE,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QAClB,MAAM,IAAI,eAAe,CAAC,wCAAwC,EAAE,YAAY,EAAE;YAChF,gDAAgD;YAChD,+DAA+D,OAAO,CAAC,OAAO,EAAE;YAChF,oEAAoE;SACrE,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,6CAA6C,EAAE,gBAAgB,EAAE;YACzF,8EAA8E;YAC9E,gFAAgF;SACjF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC;QAC/B,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI;QACzB,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU;KACtC,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;QAEnF,sEAAsE;QACtE,mEAAmE;QACnE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,+BAA+B,OAAO,CAAC,OAAO,KAAK;YACjD,iDAAiD,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,aAAa,CAC5F,CAAC;QAEF,MAAM,WAAW,CACf,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/D,MAAM,EACN,OAAO,CAAC,OAAO,CAChB,CAAC;QAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAuB,CAAC;QAC3D,IAAI,KAAyB,CAAC;QAC9B,IAAI,QAAQ,EAAE,CAAC;YACb,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC5E,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACjD,MAAM,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,OAAO;YACL,WAAW,EAAE,QAAQ,CAAC,IAAI;YAC1B,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU;YAClC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1C,IAAI,EAAE;gBACJ,4CAA4C;gBAC5C,4EAA4E;gBAC5E,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iEAAiE,CAAC,CAAC;aACtF;SACF,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,mEAAmE;AACnE,KAAK,UAAU,KAAK,CAClB,MAAc,EACd,QAAkB,EAClB,QAAkB,EAClB,OAAoB,EACpB,KAAY;IAEZ,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAEvD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC;QAC/B,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI;QAClC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI;QACzB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/E,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7E,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,wEAAwE;QACxE,oEAAoE;QACpE,yEAAyE;QACzE,uEAAuE;QACvE,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEtD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACtD,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAEpE,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;YACzB,UAAU,EAAE,IAAI;YAChB,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,IAAI,EAAE;gBACJ,sDAAsD;gBACtD,gEAAgE;aACjE;SACF,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC"}

package/dist/src/commands/check.d.ts

@@ -0,0 +1,12 @@
+import { type FlagSpecs } from "../flags.js";
+import type { AxiStructuredOutput } from "../output.js";
+export declare const CHECK_FLAGS: FlagSpecs;
+/**
+ * Does the clip library hang together?
+ *
+ * The browser-free half of verifying a set of screencasts: manifest against
+ * scenarios against the files on disk. Everything a page-level audit would
+ * also check needs a browser and a built site, and belongs in whatever builds
+ * that site - this part does not, and runs in milliseconds.
+ */
+export declare function checkCommand(args: string[]): Promise<AxiStructuredOutput>;

package/dist/src/commands/check.js

@@ -0,0 +1,103 @@
+import { rm } from "node:fs/promises";
+import { join } from "node:path";
+import { loadConfig } from "../config.js";
+import { buildInventory } from "../inventory.js";
+import { parseFlags } from "../flags.js";
+import { readManifest, writeManifest } from "../manifest.js";
+export const CHECK_FLAGS = {
+    config: { kind: "string", description: "Path to a config file", placeholder: "path" },
+    "fix-orphans": {
+        kind: "boolean",
+        description: "Delete manifest entries and media with no scenario behind them",
+    },
+};
+/**
+ * Does the clip library hang together?
+ *
+ * The browser-free half of verifying a set of screencasts: manifest against
+ * scenarios against the files on disk. Everything a page-level audit would
+ * also check needs a browser and a built site, and belongs in whatever builds
+ * that site - this part does not, and runs in milliseconds.
+ */
+export async function checkCommand(args) {
+    const { flags } = parseFlags(args, CHECK_FLAGS);
+    const config = await loadConfig(flags["config"]);
+    const inventory = await buildInventory(config);
+    const failures = [];
+    for (const p of inventory.problems) {
+        failures.push({
+            problem: "manifest entry is invalid",
+            detail: p.index >= 0 ? `entry ${p.index}: ${p.reason}` : p.reason,
+        });
+    }
+    for (const row of inventory.rows) {
+        if (row.status === "incomplete") {
+            failures.push({ problem: `${row.id} is missing files`, detail: row.missing.join(", ") });
+        }
+        if (row.status === "stale") {
+            failures.push({ problem: `${row.id} is stale`, detail: row.staleReason ?? "changed" });
+        }
+        if (row.status === "never-recorded") {
+            failures.push({ problem: `${row.id} has never been recorded`, detail: row.file });
+        }
+    }
+    for (const orphan of inventory.orphans) {
+        failures.push({
+            problem: `${orphan.id} has no scenario`,
+            detail: "in the manifest, but nothing in the config produces it any more",
+        });
+    }
+    for (const stray of inventory.strays) {
+        failures.push({
+            problem: `${stray} is not in the manifest`,
+            detail: "left over from a rename or a deleted scenario",
+        });
+    }
+    if (flags["fix-orphans"] === true &&
+        (inventory.orphans.length > 0 || inventory.strays.length > 0)) {
+        const removed = [];
+        const { entries } = readManifest(config.outDir);
+        const keep = entries.filter((e) => !inventory.orphans.some((o) => o.id === e.id));
+        if (keep.length !== entries.length) {
+            writeManifest(config.outDir, keep);
+            removed.push(...inventory.orphans.map((o) => `${o.id} (manifest entry)`));
+        }
+        for (const orphan of inventory.orphans) {
+            for (const ext of orphan.formats ?? ["mp4", "webm", "webp"]) {
+                const file = join(config.outDir, `${orphan.id}.${ext}`);
+                await rm(file, { force: true });
+                removed.push(`${orphan.id}.${ext}`);
+            }
+        }
+        for (const stray of inventory.strays) {
+            await rm(join(config.outDir, stray), { force: true });
+            removed.push(stray);
+        }
+        return {
+            removed,
+            totals: `${removed.length} removed`,
+            help: ["Run `screencast-axi check` again to confirm the library is clean"],
+        };
+    }
+    if (failures.length === 0) {
+        return {
+            checked: inventory.rows.length,
+            result: "consistent",
+            totals: `${inventory.rows.length} scenarios, manifest and files all agree`,
+            help: ["Nothing to do"],
+        };
+    }
+    return {
+        failures,
+        totals: `${failures.length} problem(s) across ${inventory.rows.length} scenarios`,
+        help: [
+            ...(inventory.rows.some((r) => r.status !== "recorded")
+                ? ["`screencast-axi record --all --if-changed` re-shoots what has drifted"]
+                : []),
+            ...(inventory.orphans.length + inventory.strays.length > 0
+                ? ["`screencast-axi check --fix-orphans` deletes what no scenario claims"]
+                : []),
+        ],
+    };
+}
+//# sourceMappingURL=check.js.map

package/dist/src/commands/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../../src/commands/check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAkB,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG7D,MAAM,CAAC,MAAM,WAAW,GAAc;IACpC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,EAAE;IACrF,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,gEAAgE;KAC9E;CACF,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAc;IAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAuB,CAAC,CAAC;IACvE,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAA0C,EAAE,CAAC;IAE3D,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;QACnC,QAAQ,CAAC,IAAI,CAAC;YACZ,OAAO,EAAE,2BAA2B;YACpC,MAAM,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM;SAClE,CAAC,CAAC;IACL,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,GAAG,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,WAAW,IAAI,SAAS,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,gBAAgB,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,0BAA0B,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,CAAC;YACZ,OAAO,EAAE,GAAG,MAAM,CAAC,EAAE,kBAAkB;YACvC,MAAM,EAAE,iEAAiE;SAC1E,CAAC,CAAC;IACL,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC;YACZ,OAAO,EAAE,GAAG,KAAK,yBAAyB;YAC1C,MAAM,EAAE,+CAA+C;SACxD,CAAC,CAAC;IACL,CAAC;IAED,IACE,KAAK,CAAC,aAAa,CAAC,KAAK,IAAI;QAC7B,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAC7D,CAAC;QACD,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClF,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;YACnC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC5E,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACxD,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,OAAO;YACL,OAAO;YACP,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,UAAU;YACnC,IAAI,EAAE,CAAC,kEAAkE,CAAC;SAC3E,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;YACL,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;YAC9B,MAAM,EAAE,YAAY;YACpB,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,0CAA0C;YAC1E,IAAI,EAAE,CAAC,eAAe,CAAC;SACxB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,QAAQ;QACR,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,SAAS,CAAC,IAAI,CAAC,MAAM,YAAY;QACjF,IAAI,EAAE;YACJ,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC;gBACrD,CAAC,CAAC,CAAC,uEAAuE,CAAC;gBAC3E,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBACxD,CAAC,CAAC,CAAC,sEAAsE,CAAC;gBAC1E,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;AACJ,CAAC"}

package/dist/src/commands/doctor.d.ts

@@ -0,0 +1,15 @@
+import { type FlagSpecs } from "../flags.js";
+import type { AxiStructuredOutput } from "../output.js";
+import { run } from "../toolchain.js";
+export declare const DOCTOR_FLAGS: FlagSpecs;
+/**
+ * Everything that has to be true before a take can run.
+ *
+ * The point is to answer all of it at once. A missing ffmpeg discovered
+ * partway through a forty-second recording is the same information delivered
+ * at the worst possible moment, and each prerequisite found one at a time is a
+ * separate round trip.
+ */
+export declare function doctorCommand(args: string[]): Promise<AxiStructuredOutput>;
+/** Exposed for `setup`, which needs the same probe. */
+export { run };

package/dist/src/commands/doctor.js

@@ -0,0 +1,131 @@
+import { access, constants, mkdir } from "node:fs/promises";
+import { loadConfig, resolveConfigPath } from "../config.js";
+import { parseFlags } from "../flags.js";
+import { detectToolchain, installHint, run } from "../toolchain.js";
+import { resolvePlaywright } from "../browser.js";
+export const DOCTOR_FLAGS = {
+    config: { kind: "string", description: "Path to a config file", placeholder: "path" },
+};
+/**
+ * Everything that has to be true before a take can run.
+ *
+ * The point is to answer all of it at once. A missing ffmpeg discovered
+ * partway through a forty-second recording is the same information delivered
+ * at the worst possible moment, and each prerequisite found one at a time is a
+ * separate round trip.
+ */
+export async function doctorCommand(args) {
+    const { flags } = parseFlags(args, DOCTOR_FLAGS);
+    const findings = [];
+    findings.push({
+        what: "node",
+        ok: Number(process.versions.node.split(".")[0]) >= 20,
+        detail: process.versions.node,
+        ...(Number(process.versions.node.split(".")[0]) >= 20
+            ? {}
+            : { fix: "Upgrade to Node 20 or newer" }),
+    });
+    let playwright = null;
+    try {
+        const { specifier } = await resolvePlaywright();
+        playwright = specifier;
+        findings.push({ what: "playwright", ok: true, detail: `resolved from \`${specifier}\`` });
+    }
+    catch {
+        findings.push({
+            what: "playwright",
+            ok: false,
+            detail: "not installed",
+            fix: "pnpm add -D playwright",
+        });
+    }
+    if (playwright) {
+        // Launching is the only honest check: the package can be installed while
+        // the browser binary it needs has never been downloaded.
+        try {
+            const { module } = await resolvePlaywright();
+            const browser = await module.chromium.launch();
+            const version = browser.version?.() ?? "ok";
+            await browser.close();
+            findings.push({ what: "chromium", ok: true, detail: String(version) });
+        }
+        catch (error) {
+            findings.push({
+                what: "chromium",
+                ok: false,
+                detail: error.message.split("\n")[0] ?? "will not launch",
+                fix: "screencast-axi setup",
+            });
+        }
+    }
+    const toolchain = await detectToolchain();
+    findings.push({
+        what: "ffmpeg",
+        ok: toolchain.ffmpeg !== null,
+        detail: toolchain.ffmpeg
+            ? `${toolchain.ffmpeg.version.replace(/^ffmpeg version /, "").split(" ")[0]} (${toolchain.ffmpeg.source})`
+            : "not found",
+        ...(toolchain.ffmpeg ? {} : { fix: installHint("ffmpeg") }),
+    });
+    findings.push({
+        what: "poster encoder",
+        ok: true,
+        detail: toolchain.posterEncoder === "png"
+            ? "PNG fallback - neither ffmpeg's libwebp nor cwebp is available"
+            : `WebP via ${toolchain.posterEncoder}`,
+        ...(toolchain.posterEncoder === "png" ? { fix: installHint("cwebp") } : {}),
+    });
+    findings.push({
+        what: "animated webp",
+        ok: true,
+        detail: toolchain.gif2webp ? "available via gif2webp" : "unavailable - `--webp` will fail",
+        ...(toolchain.gif2webp ? {} : { fix: installHint("cwebp") }),
+    });
+    const configPath = resolveConfigPath(flags["config"]);
+    findings.push({
+        what: "config",
+        ok: true,
+        detail: configPath ?? "none - defaults apply, which is fine for a one-off",
+    });
+    if (configPath) {
+        const config = await loadConfig(flags["config"]);
+        let writable = true;
+        try {
+            await mkdir(config.outDir, { recursive: true });
+            await access(config.outDir, constants.W_OK);
+        }
+        catch {
+            writable = false;
+        }
+        findings.push({
+            what: "output directory",
+            ok: writable,
+            detail: writable ? config.outDir : `${config.outDir} is not writable`,
+            ...(writable ? {} : { fix: `Check permissions on ${config.outDir}` }),
+        });
+        findings.push({
+            what: "scenarios",
+            ok: true,
+            detail: config.scenarios.length > 0 ? config.scenarios.join(", ") : "none configured",
+        });
+    }
+    const broken = findings.filter((f) => !f.ok);
+    const fixes = findings.filter((f) => f.fix).map((f) => `${f.what}: ${f.fix}`);
+    return {
+        ready: broken.length === 0,
+        checks: findings.map((f) => ({
+            what: f.what,
+            ok: f.ok,
+            detail: f.detail,
+        })),
+        totals: broken.length === 0
+            ? `${findings.length} checks, all clear`
+            : `${broken.length} of ${findings.length} checks need attention`,
+        help: fixes.length > 0
+            ? fixes
+            : ["Everything a recording needs is in place. `screencast-axi record <id>`"],
+    };
+}
+/** Exposed for `setup`, which needs the same probe. */
+export { run };
+//# sourceMappingURL=doctor.js.map

package/dist/src/commands/doctor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../../../src/commands/doctor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAkB,MAAM,aAAa,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElD,MAAM,CAAC,MAAM,YAAY,GAAc;IACrC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,EAAE;CACtF,CAAC;AAUF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAc;IAChD,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,QAAQ,CAAC,IAAI,CAAC;QACZ,IAAI,EAAE,MAAM;QACZ,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;QACrD,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;QAC7B,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACnD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,GAAG,EAAE,6BAA6B,EAAE,CAAC;KAC5C,CAAC,CAAC;IAEH,IAAI,UAAU,GAAkB,IAAI,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,iBAAiB,EAAE,CAAC;QAChD,UAAU,GAAG,SAAS,CAAC;QACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,SAAS,IAAI,EAAE,CAAC,CAAC;IAC5F,CAAC;IAAC,MAAM,CAAC;QACP,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,EAAE,EAAE,KAAK;YACT,MAAM,EAAE,eAAe;YACvB,GAAG,EAAE,wBAAwB;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,yEAAyE;QACzE,yDAAyD;QACzD,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,iBAAiB,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,IAAI,CAAC;YAC5C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,UAAU;gBAChB,EAAE,EAAE,KAAK;gBACT,MAAM,EAAG,KAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,iBAAiB;gBACpE,GAAG,EAAE,sBAAsB;aAC5B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,eAAe,EAAE,CAAC;IAC1C,QAAQ,CAAC,IAAI,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,SAAS,CAAC,MAAM,KAAK,IAAI;QAC7B,MAAM,EAAE,SAAS,CAAC,MAAM;YACtB,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG;YAC1G,CAAC,CAAC,WAAW;QACf,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;KAC5D,CAAC,CAAC;IACH,QAAQ,CAAC,IAAI,CAAC;QACZ,IAAI,EAAE,gBAAgB;QACtB,EAAE,EAAE,IAAI;QACR,MAAM,EACJ,SAAS,CAAC,aAAa,KAAK,KAAK;YAC/B,CAAC,CAAC,gEAAgE;YAClE,CAAC,CAAC,YAAY,SAAS,CAAC,aAAa,EAAE;QAC3C,GAAG,CAAC,SAAS,CAAC,aAAa,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5E,CAAC,CAAC;IACH,QAAQ,CAAC,IAAI,CAAC;QACZ,IAAI,EAAE,eAAe;QACrB,EAAE,EAAE,IAAI;QACR,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,kCAAkC;QAC1F,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;KAC7D,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAuB,CAAC,CAAC;IAC5E,QAAQ,CAAC,IAAI,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,IAAI;QACR,MAAM,EAAE,UAAU,IAAI,oDAAoD;KAC3E,CAAC,CAAC;IAEH,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAuB,CAAC,CAAC;QACvE,IAAI,QAAQ,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,kBAAkB;YACxB,EAAE,EAAE,QAAQ;YACZ,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,kBAAkB;YACrE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,wBAAwB,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;SACtE,CAAC,CAAC;QACH,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,WAAW;YACjB,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAiB;SACtF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAE9E,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3B,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,MAAM,EAAE,CAAC,CAAC,MAAM;SACjB,CAAC,CAAC;QACH,MAAM,EACJ,MAAM,CAAC,MAAM,KAAK,CAAC;YACjB,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,oBAAoB;YACxC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,OAAO,QAAQ,CAAC,MAAM,wBAAwB;QACpE,IAAI,EACF,KAAK,CAAC,MAAM,GAAG,CAAC;YACd,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,CAAC,wEAAwE,CAAC;KACjF,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/src/commands/guide.d.ts

@@ -0,0 +1,6 @@
+import { type FlagSpecs } from "../flags.js";
+import type { AxiStructuredOutput } from "../output.js";
+/** No flags: it takes a topic and nothing else. */
+export declare const GUIDE_FLAGS: FlagSpecs;
+export declare function guideCommand(args: string[]): AxiStructuredOutput;
+export declare function guideHelp(): string;