screenci 0.0.4 → 0.0.5

package/dist/src/video.d.ts

@@ -0,0 +1,138 @@
+import type { TestType, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestDetails, TestInfo } from '@playwright/test';
+import type { RecordOptions, RenderOptions, ScreenCIPage } from './types.js';
+export { getDimensions } from './dimensions.js';
+type VideoFixtureOptions = {
+    recordOptions: RecordOptions;
+    renderOptions: RenderOptions | undefined;
+    _xvfbSetup: void;
+};
+type VideoType = TestType<PlaywrightTestArgs & PlaywrightTestOptions & VideoFixtureOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+type VideoArgs = Omit<PlaywrightTestArgs, 'page'> & {
+    page: ScreenCIPage;
+} & PlaywrightTestOptions & VideoFixtureOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions;
+type VideoBody = (args: VideoArgs, testInfo: TestInfo) => void | Promise<void>;
+/** Conditional overloads shared by skip / fixme / fail */
+type ConditionalOverloads = ((condition?: boolean, description?: string) => void) & ((condition?: boolean, callback?: () => string) => void);
+interface VideoCallSignatures {
+    /**
+     * Declares a ScreenCI video recording test.
+     *
+     * Tests automatically record browser interactions as video. The viewport is
+     * configured based on `recordOptions.aspectRatio` and `recordOptions.quality`.
+     *
+     * @param title - Test title (used as the video filename)
+     * @param body - Test body containing page interactions to record
+     *
+     * @example
+     * ```ts
+     * import { video } from 'screenci'
+     *
+     * video('Product demo', async ({ page }) => {
+     *   await page.goto('https://example.com')
+     *   await page.click('text=Get Started')
+     *   // Video recorded at 16:9 1080p, 30fps (defaults)
+     * })
+     * ```
+     *
+     * @example
+     * Configure video options:
+     * ```ts
+     * video.use({ recordOptions: { aspectRatio: '16:9', quality: '2160p', fps: 60 } })
+     *
+     * video('4K demo', async ({ page }) => {
+     *   await page.goto('https://example.com')
+     * })
+     * ```
+     */
+    (title: string, body: VideoBody): void;
+    /**
+     * Declares a ScreenCI video recording test with additional details.
+     *
+     * Tests automatically record browser interactions as video. The viewport is
+     * configured based on `recordOptions.aspectRatio` and `recordOptions.quality`.
+     *
+     * @param title - Test title (used as the video filename)
+     * @param details - Additional test configuration (tags, annotations, etc.)
+     * @param body - Test body containing page interactions to record
+     *
+     * @example
+     * Using tags:
+     * ```ts
+     * import { video } from 'screenci'
+     *
+     * video('Checkout flow', {
+     *   tag: '@critical',
+     * }, async ({ page }) => {
+     *   await page.goto('https://example.com/checkout')
+     * })
+     * ```
+     *
+     * @example
+     * Using annotations:
+     * ```ts
+     * video('Sign up', {
+     *   annotation: { type: 'issue', description: 'https://github.com/...' },
+     * }, async ({ page }) => {
+     *   await page.goto('https://example.com/signup')
+     * })
+     * ```
+     */
+    (title: string, details: TestDetails, body: VideoBody): void;
+}
+/**
+ * Recursive interface so `.only`, `.skip`, `.fixme`, `.fail`, and `.slow`
+ * all surface `page: ScreenCIPage` instead of the raw Playwright `page: Page`.
+ *
+ * Properties that don't receive per-test fixture args (`describe`, `beforeAll`,
+ * `afterAll`, `use`, `extend`, `step`, `info`, `expect`, `setTimeout`) are
+ * forwarded from `VideoType` unchanged.
+ */
+interface Video extends VideoCallSignatures {
+    /** Run only this test. */
+    only: Video;
+    /** Skip this test, with optional conditional overloads. */
+    skip: Video & ConditionalOverloads;
+    /** Mark this test as fixme, with optional conditional overloads. */
+    fixme: Video & ConditionalOverloads;
+    /** Mark this test as expected to fail, with optional conditional overloads. */
+    fail: Video & ConditionalOverloads;
+    /** Mark this test as slow, with optional conditional overload. */
+    slow: Video & ((condition?: boolean, description?: string) => void);
+    /** Run a hook before each test in the current suite. */
+    beforeEach(inner: (args: VideoArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    beforeEach(title: string, inner: (args: VideoArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    /** Run a hook after each test in the current suite. */
+    afterEach(inner: (args: VideoArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    afterEach(title: string, inner: (args: VideoArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    describe: VideoType['describe'];
+    beforeAll: VideoType['beforeAll'];
+    afterAll: VideoType['afterAll'];
+    use: VideoType['use'];
+    extend: VideoType['extend'];
+    step: VideoType['step'];
+    info: VideoType['info'];
+    expect: VideoType['expect'];
+    setTimeout: VideoType['setTimeout'];
+}
+/**
+ * ScreenCI video recording test fixture.
+ *
+ * Extended Playwright test that automatically records browser interactions as video.
+ * Configure recording options globally with `video.use()` or in your config file.
+ *
+ * @example
+ * Basic usage:
+ * ```ts
+ * import { video, caption } from 'screenci'
+ *
+ * video('Tutorial', async ({ page }) => {
+ *   await page.goto('https://example.com')
+ *   caption('User navigates to homepage')
+ *
+ *   await page.click('text=Sign up')
+ *   caption('Clicks sign up button')
+ * })
+ * ```
+ */
+export declare const video: Video;
+//# sourceMappingURL=video.d.ts.map

package/dist/src/video.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"video.d.ts","sourceRoot":"","sources":["../../src/video.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,EACX,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAKzB,OAAO,KAAK,EAIV,aAAa,EACb,aAAa,EACb,YAAY,EACb,MAAM,YAAY,CAAA;AAEnB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AA8N/C,KAAK,mBAAmB,GAAG;IACzB,aAAa,EAAE,aAAa,CAAA;IAC5B,aAAa,EAAE,aAAa,GAAG,SAAS,CAAA;IACxC,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAgQD,KAAK,SAAS,GAAG,QAAQ,CACvB,kBAAkB,GAChB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,GACpB,uBAAuB,EACzB,oBAAoB,GAAG,uBAAuB,CAC/C,CAAA;AAED,KAAK,SAAS,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG;IAClD,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,qBAAqB,GACvB,mBAAmB,GACnB,oBAAoB,GACpB,uBAAuB,CAAA;AAEzB,KAAK,SAAS,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAE9E,0DAA0D;AAC1D,KAAK,oBAAoB,GAAG,CAAC,CAC3B,SAAS,CAAC,EAAE,OAAO,EACnB,WAAW,CAAC,EAAE,MAAM,KACjB,IAAI,CAAC,GACR,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,MAAM,KAAK,IAAI,CAAC,CAAA;AAE1D,UAAU,mBAAmB;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;CAC7D;AAED;;;;;;;GAOG;AACH,UAAU,KAAM,SAAQ,mBAAmB;IACzC,0BAA0B;IAC1B,IAAI,EAAE,KAAK,CAAA;IACX,2DAA2D;IAC3D,IAAI,EAAE,KAAK,GAAG,oBAAoB,CAAA;IAClC,oEAAoE;IACpE,KAAK,EAAE,KAAK,GAAG,oBAAoB,CAAA;IACnC,+EAA+E;IAC/E,IAAI,EAAE,KAAK,GAAG,oBAAoB,CAAA;IAClC,kEAAkE;IAClE,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,CAAA;IAEnE,wDAAwD;IACxD,UAAU,CACR,KAAK,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACnE,IAAI,CAAA;IACP,UAAU,CACR,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACnE,IAAI,CAAA;IACP,uDAAuD;IACvD,SAAS,CACP,KAAK,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACnE,IAAI,CAAA;IACP,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACnE,IAAI,CAAA;IAGP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;IAC/B,SAAS,EAAE,SAAS,CAAC,WAAW,CAAC,CAAA;IACjC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;IAC/B,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAA;IACrB,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;IAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;IACvB,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;IAC3B,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,CAAA;CACpC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,EAA4B,KAAK,CAAA"}

package/dist/src/video.js

@@ -0,0 +1,415 @@
+import { test as base } from '@playwright/test';
+import { mkdir, rm } from 'fs/promises';
+import { join } from 'path';
+import { spawn } from 'child_process';
+import { sanitizeVideoName } from './sanitize.js';
+export { getDimensions } from './dimensions.js';
+import { getDimensions } from './dimensions.js';
+import { isHeadless, startXvfb } from './xvfb.js';
+import { setActiveCaptionRecorder, resetCaptionChain } from './caption.js';
+import { setActiveHideRecorder } from './hide.js';
+import { setActiveAutoZoomRecorder } from './autoZoom.js';
+import { setActiveAssetRecorder } from './asset.js';
+import { DEFAULT_VIDEO_OPTIONS, DEFAULT_ASPECT_RATIO, DEFAULT_QUALITY, DEFAULT_FPS, } from './defaults.js';
+import { EventRecorder } from './events.js';
+import { setActiveClickRecorder, instrumentBrowser, instrumentContext, } from './instrument.js';
+import { logger } from './logger.js';
+async function setupMouseTracking(page, recorder) {
+    /*
+    await page.exposeFunction(
+      '__screenci_recordMouseMove',
+      (x: number, y: number) => {
+        recorder.addMouseMove(x, y)
+      }
+    )
+  
+    await page.addInitScript(() => {
+      // Throttle mouse moves to ~60fps (16ms) to keep data.json size manageable
+      let lastMouseMove = 0
+      document.addEventListener(
+        'mousemove',
+        (e) => {
+          const now = Date.now()
+          if (now - lastMouseMove >= 16) {
+            lastMouseMove = now
+            ;(
+              window as Window & {
+                __screenci_recordMouseMove?: (x: number, y: number) => void
+              }
+            ).__screenci_recordMouseMove?.(e.clientX, e.clientY)
+          }
+        },
+        { capture: true }
+      )
+    })
+    */
+}
+/**
+ * Get the path to the system ffmpeg binary
+ */
+function getSystemFfmpegPath() {
+    // Use system ffmpeg from standard locations
+    return '/usr/bin/ffmpeg';
+}
+/**
+ * Get CRF value (encoding quality) for a given quality preset.
+ *
+ * Higher resolution presets use a lower CRF (better quality) because the
+ * larger file size budget is expected at those resolutions.
+ * - `'720p'`   → CRF 21 (medium – balanced size/quality for HD)
+ * - `'1080p'`  → CRF 16 (high   – best quality for Full HD)
+ * - `'1440p'`  → CRF 16 (high   – best quality for Quad HD)
+ * - `'2160p'`  → CRF 16 (high   – best quality for UHD)
+ */
+function getCrfForQuality(quality) {
+    switch (quality) {
+        case '720p':
+            return 21;
+        case '1080p':
+            return 16;
+        case '1440p':
+            return 16;
+        case '2160p':
+            return 16;
+    }
+}
+/**
+ * Start ffmpeg screen recording
+ */
+function startScreenRecording(outputPath, fps, quality, aspectRatio) {
+    const { width, height } = getDimensions(aspectRatio, quality);
+    const crf = getCrfForQuality(quality);
+    const display = process.env.DISPLAY || ':0';
+    const ffmpegArgs = [
+        '-f',
+        'x11grab',
+        '-draw_mouse',
+        '0',
+        '-video_size',
+        `${width}x${height}`,
+        '-framerate',
+        `${fps}`,
+        '-i',
+        `${display}+0,0`,
+        '-c:v',
+        'libx264',
+        '-tune',
+        'zerolatency',
+        '-preset',
+        'fast',
+        '-crf',
+        `${crf}`,
+        '-pix_fmt',
+        'yuv444p',
+        '-movflags',
+        'frag_keyframe+empty_moov',
+        '-y',
+        outputPath,
+    ];
+    const ffmpegPath = getSystemFfmpegPath();
+    const ffmpeg = spawn(ffmpegPath, ffmpegArgs);
+    activeFFmpegProcesses.add(ffmpeg);
+    ffmpeg.on('close', () => activeFFmpegProcesses.delete(ffmpeg));
+    let hasStarted = false;
+    let hasErrored = false;
+    const startedPromise = new Promise((resolve) => {
+        const timeout = setTimeout(() => {
+            if (!hasStarted && !hasErrored) {
+                hasStarted = true;
+                resolve(true);
+            }
+        }, 1000);
+        ffmpeg.stderr.on('data', (data) => {
+            const output = data.toString();
+            // ffmpeg outputs info to stderr, check for actual errors
+            if (output.includes('frame=') || output.includes('fps=')) {
+                if (!hasStarted) {
+                    hasStarted = true;
+                    clearTimeout(timeout);
+                    resolve(true);
+                }
+            }
+            else if (output.includes('error') ||
+                output.includes('Error') ||
+                output.includes('Invalid')) {
+                if (!hasErrored) {
+                    hasErrored = true;
+                    clearTimeout(timeout);
+                    logger.error('FFmpeg error:', output);
+                    resolve(false);
+                }
+            }
+        });
+        ffmpeg.on('error', (err) => {
+            if (!hasErrored) {
+                hasErrored = true;
+                clearTimeout(timeout);
+                logger.error('Failed to start FFmpeg:', err);
+                resolve(false);
+            }
+        });
+        ffmpeg.on('close', (code) => {
+            clearTimeout(timeout);
+            if (code === 0) {
+                logger.info('Screen recording completed successfully');
+            }
+            else if (code !== null && !hasErrored) {
+                logger.error(`FFmpeg exited with code ${code}`);
+            }
+        });
+    });
+    return { process: ffmpeg, started: startedPromise };
+}
+/**
+ * Stop ffmpeg recording gracefully.
+ *
+ * SIGTERM tells ffmpeg to flush buffers and write the moov atom before exiting.
+ * SIGKILL is a last resort after timeoutMs and will leave the file corrupt.
+ */
+async function stopScreenRecording(ffmpegProcess, timeoutMs = 10000) {
+    // Already exited (e.g. display closed under it) — nothing to signal
+    if (ffmpegProcess.exitCode !== null || ffmpegProcess.killed) {
+        return;
+    }
+    return new Promise((resolve) => {
+        const sigkillTimer = setTimeout(() => {
+            logger.warn('FFmpeg did not stop gracefully, forcing SIGKILL (file may be corrupt)');
+            ffmpegProcess.kill('SIGKILL');
+            resolve();
+        }, timeoutMs);
+        ffmpegProcess.on('close', () => {
+            clearTimeout(sigkillTimer);
+            resolve();
+        });
+        ffmpegProcess.kill('SIGTERM');
+    });
+}
+// Internal state for xvfb management (not exposed to users)
+let currentXvfb = null;
+let originalDisplay;
+// Track active ffmpeg processes so they can be killed if the process is
+// interrupted before the fixture teardown has a chance to stop them.
+const activeFFmpegProcesses = new Set();
+function killActiveFFmpegProcesses() {
+    for (const proc of activeFFmpegProcesses) {
+        try {
+            proc.kill('SIGTERM');
+        }
+        catch { }
+    }
+    activeFFmpegProcesses.clear();
+}
+// Clean up Xvfb and any active ffmpeg processes when the worker process exits
+// so lock/socket files don't persist and block the next run.
+process.on('exit', () => {
+    killActiveFFmpegProcesses();
+    if (currentXvfb) {
+        try {
+            currentXvfb.process.kill('SIGTERM');
+        }
+        catch { }
+    }
+});
+// Forward SIGTERM/SIGINT: kill ffmpeg and Xvfb, then let the process exit.
+const handleTermSignal = (signal) => {
+    logger.info(`Worker received ${signal}, killing ffmpeg and Xvfb...`);
+    killActiveFFmpegProcesses();
+    if (currentXvfb) {
+        try {
+            currentXvfb.process.kill('SIGTERM');
+        }
+        catch { }
+    }
+    process.exit(0);
+};
+process.on('SIGTERM', handleTermSignal);
+process.on('SIGINT', handleTermSignal);
+const _videoBase = base.extend({
+    recordOptions: [DEFAULT_VIDEO_OPTIONS, { option: true }],
+    renderOptions: [undefined, { option: true }],
+    // Internal worker fixture to manage xvfb per test
+    _xvfbSetup: [
+        async ({ recordOptions }, use) => {
+            const shouldRecord = process.env.SCREENCI_RECORD === 'true';
+            if (shouldRecord && !currentXvfb && isHeadless()) {
+                // Start Xvfb once per worker at 3840×3840 — a square large enough to
+                // contain any quality/aspect-ratio combination. Per-test sizing is
+                // handled by the Playwright viewport override and the FFmpeg capture
+                // region. The framebuffer costs ~56 MB of RAM, negligible on any runner.
+                logger.info('Starting Xvfb at 3840×3840');
+                currentXvfb = await startXvfb(3840, 3840);
+                logger.info(`Xvfb started on ${currentXvfb.display}`);
+                if (originalDisplay === undefined) {
+                    originalDisplay = process.env.DISPLAY;
+                }
+                process.env.DISPLAY = currentXvfb.display;
+            }
+            await use();
+            // Xvfb stays alive between tests — cleanup happens on process exit.
+        },
+        { scope: 'test', auto: true },
+    ],
+    browser: async ({ playwright }, use) => {
+        // Launch browser with kiosk mode when recording for fullscreen capture
+        // Note: _xvfbSetup runs automatically before this due to auto: true
+        const shouldRecord = process.env.SCREENCI_RECORD === 'true';
+        const launchOptions = shouldRecord
+            ? {
+                headless: false,
+                args: [
+                    '--window-position=0,0',
+                    '--kiosk',
+                    '--disable-translate',
+                    '--disable-spell-checking',
+                    '--disable-notifications', // no permission popups
+                    '--disable-save-password-bubble', // no "save password?" dialog
+                    '--disable-infobars', // no "Chrome is being controlled by..." bar
+                    '--no-first-run', // skip first-run UI
+                    '--hide-scrollbars', // scrollbars invisible in recordings
+                ],
+            }
+            : undefined;
+        const browser = await playwright.chromium.launch(launchOptions);
+        instrumentBrowser(browser);
+        await use(browser);
+        await browser.close();
+    },
+    context: async ({ browser, recordOptions }, use) => {
+        // Configure browser context
+        const aspectRatio = recordOptions.aspectRatio ?? DEFAULT_ASPECT_RATIO;
+        const quality = recordOptions.quality ?? DEFAULT_QUALITY;
+        const dimensions = getDimensions(aspectRatio, quality);
+        const context = await browser.newContext({
+            viewport: dimensions,
+        });
+        instrumentContext(context);
+        await use(context);
+        await context.close();
+    },
+    page: async ({ context, recordOptions, renderOptions }, use, testInfo) => {
+        // Only record when explicitly enabled (record command)
+        const shouldRecord = process.env.SCREENCI_RECORD === 'true';
+        if (!shouldRecord) {
+            // Skip recording, just create page
+            resetCaptionChain();
+            setActiveCaptionRecorder(null);
+            setActiveClickRecorder(null);
+            setActiveHideRecorder(null);
+            setActiveAutoZoomRecorder(null);
+            setActiveAssetRecorder(null);
+            const page = await context.newPage();
+            await use(page);
+            await page.close();
+            return;
+        }
+        // Get video options
+        const aspectRatio = recordOptions.aspectRatio ?? DEFAULT_ASPECT_RATIO;
+        const quality = recordOptions.quality ?? DEFAULT_QUALITY;
+        const fps = recordOptions.fps ?? DEFAULT_FPS;
+        const dimensions = getDimensions(aspectRatio, quality);
+        // Sanitize video title to create a valid directory name
+        const sanitizedVideoName = sanitizeVideoName(testInfo.title);
+        // Create directory path: .screenci/[video-name]/
+        const videoDir = join(process.cwd(), '.screenci', sanitizedVideoName);
+        // Delete old directory if it exists (start fresh)
+        try {
+            await rm(videoDir, { recursive: true, force: true });
+        }
+        catch {
+            // Ignore errors if directory doesn't exist
+        }
+        // Create the directory
+        await mkdir(videoDir, { recursive: true });
+        // Video output path - always use recording.mp4
+        const videoPath = join(videoDir, 'recording.mp4');
+        logger.info(`Recording video to: ${videoPath}`);
+        logger.info(`Recording with ${aspectRatio} ${quality} (${dimensions.width}x${dimensions.height}), ${fps}fps`);
+        const recorder = new EventRecorder(renderOptions, recordOptions);
+        resetCaptionChain();
+        setActiveCaptionRecorder(recorder);
+        setActiveClickRecorder(recorder);
+        setActiveHideRecorder(recorder);
+        setActiveAutoZoomRecorder(recorder);
+        setActiveAssetRecorder(recorder);
+        // Create page FIRST to ensure browser window is rendered
+        const page = await context.newPage();
+        await setupMouseTracking(page, recorder);
+        // Navigate to blank page to ensure window is ready and rendered
+        await page.goto('about:blank');
+        // Wait for browser window to be fully rendered before starting recording
+        // This prevents black screen captures
+        await page.waitForTimeout(1500);
+        // Hide browser toolbar via CDP fullscreen. --kiosk alone is not reliable on
+        // Xvfb; the CDP call triggers Chromium's internal fullscreen mode which
+        // removes all browser UI chrome. No explicit dims here — those conflict with
+        // windowState and are not needed (FFmpeg captures from +0,0 at test dims).
+        try {
+            const cdpSession = await context.newCDPSession(page);
+            const { windowId } = await cdpSession.send('Browser.getWindowForTarget', {});
+            await cdpSession.send('Browser.setWindowBounds', {
+                windowId,
+                bounds: { windowState: 'fullscreen' },
+            });
+            await cdpSession.detach();
+        }
+        catch (cdpError) {
+            logger.warn('CDP fullscreen failed, toolbar may be visible:', cdpError);
+        }
+        // Start ffmpeg recording after browser window is ready
+        const { process: ffmpegProcess, started } = startScreenRecording(videoPath, fps, quality, aspectRatio);
+        // Wait for ffmpeg to start or fail
+        const didStart = await started;
+        if (didStart) {
+            // Mark the moment the video recording actually begins
+            recorder.start();
+        }
+        else {
+            logger.warn('Warning: Screen recording failed to start. Test will continue without recording.');
+            logger.warn(`Note: Recording at ${dimensions.width}x${dimensions.height} requires a display of at least that size.`);
+        }
+        await use(page);
+        await page.close();
+        setActiveCaptionRecorder(null);
+        setActiveClickRecorder(null);
+        setActiveHideRecorder(null);
+        setActiveAutoZoomRecorder(null);
+        setActiveAssetRecorder(null);
+        // Stop ffmpeg recording after test (only if it started)
+        if (didStart) {
+            logger.info('Stopping recording...');
+            await stopScreenRecording(ffmpegProcess);
+            logger.info(`Video saved to: ${videoPath}`);
+            // Write recorded events next to the video
+            await recorder.writeToFile(videoDir, testInfo.title);
+            logger.info(`Events saved to: ${join(videoDir, 'data.json')}`);
+        }
+        else {
+            // Kill the process if it's still running
+            if (!ffmpegProcess.killed) {
+                ffmpegProcess.kill('SIGKILL');
+            }
+        }
+    },
+});
+/**
+ * ScreenCI video recording test fixture.
+ *
+ * Extended Playwright test that automatically records browser interactions as video.
+ * Configure recording options globally with `video.use()` or in your config file.
+ *
+ * @example
+ * Basic usage:
+ * ```ts
+ * import { video, caption } from 'screenci'
+ *
+ * video('Tutorial', async ({ page }) => {
+ *   await page.goto('https://example.com')
+ *   caption('User navigates to homepage')
+ *
+ *   await page.click('text=Sign up')
+ *   caption('Clicks sign up button')
+ * })
+ * ```
+ */
+export const video = _videoBase;
+//# sourceMappingURL=video.js.map

package/dist/src/video.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"video.js","sourceRoot":"","sources":["../../src/video.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAU/C,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,KAAK,EAAqB,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAUjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAqB,MAAM,WAAW,CAAA;AACpE,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,WAAW,GACZ,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,KAAK,UAAU,kBAAkB,CAC/B,IAAU,EACV,QAAuB;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;MA2BE;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB;IAC1B,4CAA4C;IAC5C,OAAO,iBAAiB,CAAA;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,gBAAgB,CAAC,OAAgB;IACxC,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,MAAM;YACT,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;IACb,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAC3B,UAAkB,EAClB,GAAQ,EACR,OAAgB,EAChB,WAAwB;IAExB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACrC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,IAAI,CAAA;IAE3C,MAAM,UAAU,GAAG;QACjB,IAAI;QACJ,SAAS;QACT,aAAa;QACb,GAAG;QACH,aAAa;QACb,GAAG,KAAK,IAAI,MAAM,EAAE;QACpB,YAAY;QACZ,GAAG,GAAG,EAAE;QACR,IAAI;QACJ,GAAG,OAAO,MAAM;QAChB,MAAM;QACN,SAAS;QACT,OAAO;QACP,aAAa;QACb,SAAS;QACT,MAAM;QACN,MAAM;QACN,GAAG,GAAG,EAAE;QACR,UAAU;QACV,SAAS;QACT,WAAW;QACX,0BAA0B;QAC1B,IAAI;QACJ,UAAU;KACX,CAAA;IAED,MAAM,UAAU,GAAG,mBAAmB,EAAE,CAAA;IACxC,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IAE5C,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;IAE9D,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,IAAI,UAAU,GAAG,KAAK,CAAA;IAEtB,MAAM,cAAc,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;QACtD,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC/B,UAAU,GAAG,IAAI,CAAA;gBACjB,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC;QACH,CAAC,EAAE,IAAI,CAAC,CAAA;QAER,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAA;YAE9B,yDAAyD;YACzD,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,UAAU,GAAG,IAAI,CAAA;oBACjB,YAAY,CAAC,OAAO,CAAC,CAAA;oBACrB,OAAO,CAAC,IAAI,CAAC,CAAA;gBACf,CAAC;YACH,CAAC;iBAAM,IACL,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACxB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACxB,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAC1B,CAAC;gBACD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,UAAU,GAAG,IAAI,CAAA;oBACjB,YAAY,CAAC,OAAO,CAAC,CAAA;oBACrB,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;oBACrC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAChB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,UAAU,GAAG,IAAI,CAAA;gBACjB,YAAY,CAAC,OAAO,CAAC,CAAA;gBACrB,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAA;gBAC5C,OAAO,CAAC,KAAK,CAAC,CAAA;YAChB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1B,YAAY,CAAC,OAAO,CAAC,CAAA;YACrB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAA;YACxD,CAAC;iBAAM,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxC,MAAM,CAAC,KAAK,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAA;YACjD,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,CAAA;AACrD,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,mBAAmB,CAChC,aAA2B,EAC3B,SAAS,GAAG,KAAK;IAEjB,oEAAoE;IACpE,IAAI,aAAa,CAAC,QAAQ,KAAK,IAAI,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QAC5D,OAAM;IACR,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,EAAE;YACnC,MAAM,CAAC,IAAI,CACT,uEAAuE,CACxE,CAAA;YACD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC7B,OAAO,EAAE,CAAA;QACX,CAAC,EAAE,SAAS,CAAC,CAAA;QAEb,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC7B,YAAY,CAAC,YAAY,CAAC,CAAA;YAC1B,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;QAEF,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/B,CAAC,CAAC,CAAA;AACJ,CAAC;AAQD,4DAA4D;AAC5D,IAAI,WAAW,GAAwB,IAAI,CAAA;AAC3C,IAAI,eAAmC,CAAA;AAEvC,wEAAwE;AACxE,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAgB,CAAA;AAErD,SAAS,yBAAyB;IAChC,KAAK,MAAM,IAAI,IAAI,qBAAqB,EAAE,CAAC;QACzC,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IACD,qBAAqB,CAAC,KAAK,EAAE,CAAA;AAC/B,CAAC;AAED,8EAA8E;AAC9E,6DAA6D;AAC7D,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;IACtB,yBAAyB,EAAE,CAAA;IAC3B,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;AACH,CAAC,CAAC,CAAA;AAEF,2EAA2E;AAC3E,MAAM,gBAAgB,GAAG,CAAC,MAAsB,EAAE,EAAE;IAClD,MAAM,CAAC,IAAI,CAAC,mBAAmB,MAAM,8BAA8B,CAAC,CAAA;IACpE,yBAAyB,EAAE,CAAA;IAC3B,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;AACvC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;AAEtC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAsB;IAClD,aAAa,EAAE,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACxD,aAAa,EAAE,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAE5C,kDAAkD;IAClD,UAAU,EAAE;QACV,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,GAAiC,EAAE,EAAE;YAC7D,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,MAAM,CAAA;YAE3D,IAAI,YAAY,IAAI,CAAC,WAAW,IAAI,UAAU,EAAE,EAAE,CAAC;gBACjD,qEAAqE;gBACrE,mEAAmE;gBACnE,qEAAqE;gBACrE,yEAAyE;gBACzE,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;gBACzC,WAAW,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBACzC,MAAM,CAAC,IAAI,CAAC,mBAAmB,WAAW,CAAC,OAAO,EAAE,CAAC,CAAA;gBAErD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAClC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAA;gBACvC,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;YAC3C,CAAC;YAED,MAAM,GAAG,EAAE,CAAA;YAEX,oEAAoE;QACtE,CAAC;QACD,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;KAC9B;IAED,OAAO,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE;QACrC,uEAAuE;QACvE,oEAAoE;QACpE,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,MAAM,CAAA;QAC3D,MAAM,aAAa,GAAG,YAAY;YAChC,CAAC,CAAC;gBACE,QAAQ,EAAE,KAAK;gBACf,IAAI,EAAE;oBACJ,uBAAuB;oBACvB,SAAS;oBACT,qBAAqB;oBACrB,0BAA0B;oBAC1B,yBAAyB,EAAE,uBAAuB;oBAClD,gCAAgC,EAAE,6BAA6B;oBAC/D,oBAAoB,EAAE,4CAA4C;oBAClE,gBAAgB,EAAE,oBAAoB;oBACtC,mBAAmB,EAAE,qCAAqC;iBAC3D;aACF;YACH,CAAC,CAAC,SAAS,CAAA;QAEb,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;QAC/D,iBAAiB,CAAC,OAAO,CAAC,CAAA;QAC1B,MAAM,GAAG,CAAC,OAAO,CAAC,CAAA;QAClB,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IACvB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,EAAE;QACjD,4BAA4B;QAC5B,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,IAAI,oBAAoB,CAAA;QACrE,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,eAAe,CAAA;QACxD,MAAM,UAAU,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;QAEtD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC;YACvC,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAA;QAEF,iBAAiB,CAAC,OAAO,CAAC,CAAA;QAE1B,MAAM,GAAG,CAAC,OAAO,CAAC,CAAA;QAElB,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IACvB,CAAC;IAED,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE;QACvE,uDAAuD;QACvD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,MAAM,CAAA;QAE3D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,mCAAmC;YACnC,iBAAiB,EAAE,CAAA;YACnB,wBAAwB,CAAC,IAAI,CAAC,CAAA;YAC9B,sBAAsB,CAAC,IAAI,CAAC,CAAA;YAC5B,qBAAqB,CAAC,IAAI,CAAC,CAAA;YAC3B,yBAAyB,CAAC,IAAI,CAAC,CAAA;YAC/B,sBAAsB,CAAC,IAAI,CAAC,CAAA;YAC5B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;YACpC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA;YACf,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;YAClB,OAAM;QACR,CAAC;QAED,oBAAoB;QACpB,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,IAAI,oBAAoB,CAAA;QACrE,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,eAAe,CAAA;QACxD,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,WAAW,CAAA;QAC5C,MAAM,UAAU,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;QAEtD,wDAAwD;QACxD,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAE5D,iDAAiD;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAA;QAErE,kDAAkD;QAClD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACtD,CAAC;QAAC,MAAM,CAAC;YACP,2CAA2C;QAC7C,CAAC;QAED,uBAAuB;QACvB,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE1C,+CAA+C;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAEjD,MAAM,CAAC,IAAI,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAA;QAC/C,MAAM,CAAC,IAAI,CACT,kBAAkB,WAAW,IAAI,OAAO,KAAK,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,MAAM,MAAM,GAAG,KAAK,CACjG,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;QAChE,iBAAiB,EAAE,CAAA;QACnB,wBAAwB,CAAC,QAAQ,CAAC,CAAA;QAClC,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QAChC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QAC/B,yBAAyB,CAAC,QAAQ,CAAC,CAAA;QACnC,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QAEhC,yDAAyD;QACzD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QAEpC,MAAM,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAExC,gEAAgE;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAE9B,yEAAyE;QACzE,sCAAsC;QACtC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAE/B,4EAA4E;QAC5E,wEAAwE;QACxE,6EAA6E;QAC7E,2EAA2E;QAC3E,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;YACpD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,UAAU,CAAC,IAAI,CACxC,4BAA4B,EAC5B,EAAE,CACH,CAAA;YACD,MAAM,UAAU,CAAC,IAAI,CAAC,yBAAyB,EAAE;gBAC/C,QAAQ;gBACR,MAAM,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE;aACtC,CAAC,CAAA;YACF,MAAM,UAAU,CAAC,MAAM,EAAE,CAAA;QAC3B,CAAC;QAAC,OAAO,QAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,IAAI,CAAC,gDAAgD,EAAE,QAAQ,CAAC,CAAA;QACzE,CAAC;QAED,uDAAuD;QACvD,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAC9D,SAAS,EACT,GAAG,EACH,OAAO,EACP,WAAW,CACZ,CAAA;QAED,mCAAmC;QACnC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAA;QAE9B,IAAI,QAAQ,EAAE,CAAC;YACb,sDAAsD;YACtD,QAAQ,CAAC,KAAK,EAAE,CAAA;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CACT,kFAAkF,CACnF,CAAA;YACD,MAAM,CAAC,IAAI,CACT,sBAAsB,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,MAAM,4CAA4C,CACxG,CAAA;QACH,CAAC;QAED,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA;QACf,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;QAClB,wBAAwB,CAAC,IAAI,CAAC,CAAA;QAC9B,sBAAsB,CAAC,IAAI,CAAC,CAAA;QAC5B,qBAAqB,CAAC,IAAI,CAAC,CAAA;QAC3B,yBAAyB,CAAC,IAAI,CAAC,CAAA;QAC/B,sBAAsB,CAAC,IAAI,CAAC,CAAA;QAE5B,wDAAwD;QACxD,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;YACpC,MAAM,mBAAmB,CAAC,aAAa,CAAC,CAAA;YACxC,MAAM,CAAC,IAAI,CAAC,mBAAmB,SAAS,EAAE,CAAC,CAAA;YAE3C,0CAA0C;YAC1C,MAAM,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;YACpD,MAAM,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,CAAC,CAAA;QAChE,CAAC;aAAM,CAAC;YACN,yCAAyC;YACzC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;gBAC1B,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAC,CAAA;AAgJF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,UAA8B,CAAA"}

package/dist/src/voices.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Named voices available for use with `createCaptions`.
+ *
+ * Voices are grouped by language. Only voices belonging to a language may be
+ * used with captions written in that language — the TypeScript types enforce
+ * this when using the multi-language overload of `createCaptions`.
+ *
+ * The actual provider voice IDs are intentionally kept out of this package
+ * and are only known to the rendering infrastructure.
+ *
+ * Example:
+ * ```ts
+ * import { voices } from 'screenci'
+ *
+ * createCaptions({
+ *   en: { voice: voices.en.Ava, captions: { intro: 'Hello' } },
+ *   fi: { voice: voices.fi.Selma, captions: { intro: 'Hei' } },
+ * })
+ * ```
+ */
+export declare const voices: {
+    readonly fi: {
+        readonly Martti: "fi.Martti";
+        readonly Selma: "fi.Selma";
+        readonly Noora: "fi.Noora";
+    };
+    readonly en: {
+        readonly Jude: "en.Jude";
+        readonly Ava: "en.Ava";
+        readonly Andrew: "en.Andrew";
+        readonly Adam: "en.Adam";
+        readonly Alloy: "en.Alloy";
+        readonly Aria: "en.Aria";
+        readonly Bree: "en.Bree";
+        readonly Brian: "en.Brian";
+        readonly Davis: "en.Davis";
+        readonly Emma: "en.Emma";
+        readonly Emma2: "en.Emma2";
+        readonly Jane: "en.Jane";
+    };
+};
+type Voices = typeof voices;
+/**
+ * Union of all valid voice keys, e.g. `'fi.Martti' | 'en.Ava'`.
+ */
+export type VoiceKey = {
+    [L in keyof Voices]: Voices[L][keyof Voices[L]];
+}[keyof Voices];
+/**
+ * Narrows the set of valid voice keys to those belonging to language `L`.
+ *
+ * - `VoiceForLang<'fi'>` → `'fi.Martti' | 'fi.Selma' | 'fi.Noora'`
+ * - `VoiceForLang<'en'>` → `'en.Jude' | 'en.Ava' | ...`
+ * - `VoiceForLang<'de'>` → `never` (no German voices defined)
+ */
+export type VoiceForLang<L extends string> = L extends keyof Voices ? Voices[L][keyof Voices[L]] : never;
+/** Union of supported language codes, e.g. `'en' | 'fi'`. */
+export type Lang = keyof Voices;
+export {};
+//# sourceMappingURL=voices.d.ts.map

package/dist/src/voices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"voices.d.ts","sourceRoot":"","sources":["../../src/voices.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;CAoBT,CAAA;AAEV,KAAK,MAAM,GAAG,OAAO,MAAM,CAAA;AAE3B;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;KACpB,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC;CAChD,CAAC,MAAM,MAAM,CAAC,CAAA;AAEf;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,MAAM,GAC/D,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,GAC1B,KAAK,CAAA;AAET,6DAA6D;AAC7D,MAAM,MAAM,IAAI,GAAG,MAAM,MAAM,CAAA"}