screenci 0.0.69 → 0.0.70

package/dist/src/screenshot.d.ts

@@ -0,0 +1,105 @@
+import type { TestType, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestDetails, TestInfo } from '@playwright/test';
+import type { RecordOptions, RenderOptions, ScreenCIPage } from './types.js';
+import type { StudioRenderOptionsSentinel } from './studio.js';
+import type { CropTarget, CropOptions } from './crop.js';
+/**
+ * The `crop` fixture argument. Call it inside a `screenshot()` body to crop the
+ * implicit end-of-body capture to a locator or pixel region. Replaces the
+ * old module-level `crop()` function; the crop is recorded per test.
+ */
+export type CropFixture = (target: CropTarget, options?: CropOptions) => Promise<void>;
+type ScreenshotFixtureOptions = {
+    recordOptions: RecordOptions;
+    renderOptions: RenderOptions | StudioRenderOptionsSentinel | undefined;
+};
+type ScreenshotFixtures = {
+    crop: CropFixture;
+};
+type ScreenshotType = TestType<PlaywrightTestArgs & PlaywrightTestOptions & ScreenshotFixtureOptions & ScreenshotFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+type ScreenshotArgs = Omit<PlaywrightTestArgs, 'page'> & {
+    page: ScreenCIPage;
+} & PlaywrightTestOptions & ScreenshotFixtureOptions & ScreenshotFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions;
+type ScreenshotBody = (args: ScreenshotArgs, 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 ScreenshotCallSignatures {
+    /**
+     * Declares a ScreenCI screenshot test.
+     *
+     * Drives the page like a `video()` test, then captures the final state as a
+     * still image. The capture is framed on the configured background with the
+     * branded frame, cropped with the `crop` fixture argument, and decorated with
+     * overlays at render time. The viewport is derived from
+     * `recordOptions.aspectRatio` and `recordOptions.quality`;
+     * `recordOptions.deviceScaleFactor` raises the DPI.
+     *
+     * @example
+     * ```ts
+     * import { screenshot } from 'screenci'
+     *
+     * screenshot('Dashboard hero', async ({ page, crop }) => {
+     *   await page.goto('https://app.example.com/dashboard')
+     *   await crop(page.getByTestId('revenue-card'), { padding: 48 })
+     * })
+     * ```
+     */
+    (title: string, body: ScreenshotBody): void;
+    /**
+     * Declares a ScreenCI screenshot test with additional details (tags,
+     * annotations, etc.).
+     */
+    (title: string, details: TestDetails, body: ScreenshotBody): void;
+}
+/**
+ * Recursive interface so `.only`, `.skip`, `.fixme`, `.fail`, and `.slow`
+ * surface `page: ScreenCIPage` instead of the raw Playwright `page: Page`.
+ */
+interface Screenshot extends ScreenshotCallSignatures {
+    only: Screenshot;
+    skip: Screenshot & ConditionalOverloads;
+    fixme: Screenshot & ConditionalOverloads;
+    fail: Screenshot & ConditionalOverloads;
+    slow: Screenshot & ((condition?: boolean, description?: string) => void);
+    beforeEach(inner: (args: ScreenshotArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    beforeEach(title: string, inner: (args: ScreenshotArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    afterEach(inner: (args: ScreenshotArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    afterEach(title: string, inner: (args: ScreenshotArgs, testInfo: TestInfo) => Promise<void> | void): void;
+    describe: ScreenshotType['describe'];
+    beforeAll: ScreenshotType['beforeAll'];
+    afterAll: ScreenshotType['afterAll'];
+    use: ScreenshotType['use'];
+    extend: ScreenshotType['extend'];
+    step: ScreenshotType['step'];
+    info: ScreenshotType['info'];
+    expect: ScreenshotType['expect'];
+    setTimeout: ScreenshotType['setTimeout'];
+}
+/**
+ * ScreenCI screenshot test fixture.
+ *
+ * Extended Playwright test that captures a branded still image of the final page
+ * state. Configure capture options with `screenshot.use()` or in your config.
+ *
+ * @example
+ * ```ts
+ * import { screenshot, createOverlays } from 'screenci'
+ *
+ * const overlays = createOverlays({
+ *   badge: { path: '../assets/new-badge.png', x: 0.72, y: 0.06, width: 0.2 },
+ * })
+ *
+ * screenshot.use({
+ *   colorScheme: 'dark',
+ *   recordOptions: { quality: '1440p', deviceScaleFactor: 2 },
+ * })
+ *
+ * screenshot('Dashboard hero', async ({ page, crop }) => {
+ *   await page.goto('https://app.example.com/dashboard')
+ *   await overlays.badge()
+ *   await crop(page.getByTestId('revenue-card'), { padding: 0.06 })
+ * })
+ * ```
+ */
+export declare const screenshot: Screenshot;
+export {};
+//# sourceMappingURL=screenshot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../src/screenshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,EACX,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAGzB,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC5E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AAmB9D,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAKxD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,WAAW,KAClB,OAAO,CAAC,IAAI,CAAC,CAAA;AAKlB,KAAK,wBAAwB,GAAG;IAC9B,aAAa,EAAE,aAAa,CAAA;IAC5B,aAAa,EAAE,aAAa,GAAG,2BAA2B,GAAG,SAAS,CAAA;CACvE,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AAgND,KAAK,cAAc,GAAG,QAAQ,CAC5B,kBAAkB,GAChB,qBAAqB,GACrB,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,uBAAuB,EACzB,oBAAoB,GAAG,uBAAuB,CAC/C,CAAA;AAED,KAAK,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,qBAAqB,GACvB,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,uBAAuB,CAAA;AAEzB,KAAK,cAAc,GAAG,CACpB,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,QAAQ,KACf,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAEzB,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,wBAAwB;IAChC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;IAE3C;;;OAGG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;CAClE;AAED;;;GAGG;AACH,UAAU,UAAW,SAAQ,wBAAwB;IACnD,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,UAAU,GAAG,oBAAoB,CAAA;IACvC,KAAK,EAAE,UAAU,GAAG,oBAAoB,CAAA;IACxC,IAAI,EAAE,UAAU,GAAG,oBAAoB,CAAA;IACvC,IAAI,EAAE,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,CAAA;IAExE,UAAU,CACR,KAAK,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACxE,IAAI,CAAA;IACP,UAAU,CACR,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACxE,IAAI,CAAA;IACP,SAAS,CACP,KAAK,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACxE,IAAI,CAAA;IACP,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACxE,IAAI,CAAA;IAEP,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAA;IACpC,SAAS,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;IACtC,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAA;IACpC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAA;IAC1B,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;IAChC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAC5B,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAC5B,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;IAChC,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,UAAU,EAAiC,UAAU,CAAA"}

package/dist/src/screenshot.js

@@ -0,0 +1,188 @@
+import { test as base } from '@playwright/test';
+import { mkdir, rm } from 'fs/promises';
+import { join, relative } from 'path';
+import { getDimensions } from './dimensions.js';
+import { DEFAULT_VIDEO_OPTIONS, DEFAULT_ASPECT_RATIO, DEFAULT_QUALITY, DEFAULT_SCREENSHOT_DEVICE_SCALE_FACTOR, } from './defaults.js';
+import { EventRecorder } from './events.js';
+import { instrumentBrowser, instrumentContext } from './instrument.js';
+import { getChromiumLaunchOptions } from './browserLaunchOptions.js';
+import { createScreenCIRuntimeContext } from './runtimeContext.js';
+import { escapeFileSystemPathSegment } from './fileSystemName.js';
+import { buildScreenCIContextOptions, resolveDeviceScaleFactor, } from './contextOptions.js';
+import { resolveCrop } from './crop.js';
+import { getRuntimePage, setRuntimeCrop } from './runtimeContext.js';
+import { ScreenciError } from './errors.js';
+import { withActiveRecordingContext } from './video.js';
+/** File name of the raw page capture written beside `data.json`. */
+const SCREENSHOT_FILE_NAME = 'screenshot.png';
+const _screenshotBase = base.extend({
+    recordOptions: [DEFAULT_VIDEO_OPTIONS, { option: true }],
+    renderOptions: [undefined, { option: true }],
+    crop: async ({}, use) => {
+        await use(async (target, options) => {
+            const page = getRuntimePage();
+            if (page === null) {
+                throw new ScreenciError('crop() requires an active ScreenCI page. Call it inside a screenshot() body.');
+            }
+            setRuntimeCrop(await resolveCrop(target, page, options));
+        });
+    },
+    browser: async ({ playwright }, use) => {
+        const shouldRecord = process.env.SCREENCI_RECORDING === 'true';
+        const launchOptions = getChromiumLaunchOptions(shouldRecord);
+        const browser = await playwright.chromium.launch(launchOptions);
+        instrumentBrowser(browser);
+        await use(browser);
+        if (browser.isConnected()) {
+            await browser.close();
+        }
+    },
+    context: async ({ browser, recordOptions, colorScheme, locale, timezoneId, userAgent, geolocation, permissions, extraHTTPHeaders, httpCredentials, ignoreHTTPSErrors, offline, storageState, baseURL, bypassCSP, acceptDownloads, javaScriptEnabled, hasTouch, isMobile, deviceScaleFactor, }, use) => {
+        const aspectRatio = recordOptions.aspectRatio ?? DEFAULT_ASPECT_RATIO;
+        const quality = recordOptions.quality ?? DEFAULT_QUALITY;
+        const dimensions = getDimensions(aspectRatio, quality);
+        const shouldRecord = process.env.SCREENCI_RECORDING === 'true';
+        // Screenshots honor deviceScaleFactor for higher-DPI stills.
+        const context = await browser.newContext(buildScreenCIContextOptions({
+            dimensions,
+            applyLocaleDefault: shouldRecord,
+            deviceScaleFactor: resolveDeviceScaleFactor(recordOptions, deviceScaleFactor, DEFAULT_SCREENSHOT_DEVICE_SCALE_FACTOR),
+            forwarded: {
+                colorScheme,
+                locale,
+                timezoneId,
+                userAgent,
+                geolocation,
+                permissions,
+                extraHTTPHeaders,
+                httpCredentials,
+                ignoreHTTPSErrors,
+                offline,
+                storageState,
+                baseURL,
+                bypassCSP,
+                acceptDownloads,
+                javaScriptEnabled,
+                hasTouch,
+                isMobile,
+            },
+        }));
+        instrumentContext(context);
+        try {
+            await use(context);
+        }
+        finally {
+            await context.close();
+        }
+    },
+    page: async ({ context, recordOptions, renderOptions, deviceScaleFactor }, use, testInfo) => {
+        const shouldRecord = process.env.SCREENCI_RECORDING === 'true';
+        const recorder = new EventRecorder(renderOptions, recordOptions);
+        if (!shouldRecord) {
+            // Preview run (`screenci test`): exercise the body without capturing.
+            const page = await context.newPage();
+            const runtimeContext = createScreenCIRuntimeContext({
+                recorder,
+                page,
+                testFilePath: testInfo.file,
+            });
+            recorder.start();
+            await withActiveRecordingContext({
+                runtimeContext,
+                page,
+                recorder,
+                unendedOverlays: 'autoEnd',
+                fn: async () => {
+                    await use(page);
+                },
+            });
+            await page.close();
+            return;
+        }
+        const aspectRatio = recordOptions.aspectRatio ?? DEFAULT_ASPECT_RATIO;
+        const quality = recordOptions.quality ?? DEFAULT_QUALITY;
+        const dimensions = getDimensions(aspectRatio, quality);
+        const dsf = resolveDeviceScaleFactor(recordOptions, deviceScaleFactor, DEFAULT_SCREENSHOT_DEVICE_SCALE_FACTOR);
+        const directoryName = escapeFileSystemPathSegment(testInfo.title);
+        const screenshotDir = join(process.cwd(), '.screenci', directoryName);
+        // Start fresh.
+        try {
+            await rm(screenshotDir, { recursive: true, force: true });
+        }
+        catch {
+            // Ignore if it does not exist.
+        }
+        await mkdir(screenshotDir, { recursive: true });
+        const page = await context.newPage();
+        const runtimeContext = createScreenCIRuntimeContext({
+            recorder,
+            page,
+            testFilePath: testInfo.file,
+            recordingDir: screenshotDir,
+        });
+        recorder.start();
+        try {
+            await withActiveRecordingContext({
+                runtimeContext,
+                page,
+                recorder,
+                unendedOverlays: 'autoEnd',
+                fn: async () => {
+                    await use(page);
+                },
+            });
+            // The body completed successfully: capture the final page state. Capturing
+            // here (not in `finally`) mirrors the video fixture's passed-only upload:
+            // a thrown body skips capture and fails the test.
+            await page.screenshot({
+                path: join(screenshotDir, SCREENSHOT_FILE_NAME),
+            });
+            const crop = runtimeContext.crop ?? undefined;
+            const screenshot = {
+                path: SCREENSHOT_FILE_NAME,
+                width: Math.round(dimensions.width * dsf),
+                height: Math.round(dimensions.height * dsf),
+                deviceScaleFactor: dsf,
+            };
+            const configDir = process.env.SCREENCI_CONFIG_DIR ?? process.cwd();
+            // The crop (from the `crop` fixture) is a render option, so it goes into
+            // renderOptions.screenshot.crop (editable in Studio), not ScreenshotInfo.
+            await recorder.writeToFile(screenshotDir, testInfo.title, relative(configDir, testInfo.file), {
+                output: 'screenshot',
+                screenshot,
+                ...(crop !== undefined && { crop }),
+            });
+        }
+        finally {
+            await page.close();
+        }
+    },
+});
+/**
+ * ScreenCI screenshot test fixture.
+ *
+ * Extended Playwright test that captures a branded still image of the final page
+ * state. Configure capture options with `screenshot.use()` or in your config.
+ *
+ * @example
+ * ```ts
+ * import { screenshot, createOverlays } from 'screenci'
+ *
+ * const overlays = createOverlays({
+ *   badge: { path: '../assets/new-badge.png', x: 0.72, y: 0.06, width: 0.2 },
+ * })
+ *
+ * screenshot.use({
+ *   colorScheme: 'dark',
+ *   recordOptions: { quality: '1440p', deviceScaleFactor: 2 },
+ * })
+ *
+ * screenshot('Dashboard hero', async ({ page, crop }) => {
+ *   await page.goto('https://app.example.com/dashboard')
+ *   await overlays.badge()
+ *   await crop(page.getByTestId('revenue-card'), { padding: 0.06 })
+ * })
+ * ```
+ */
+export const screenshot = _screenshotBase;
+//# sourceMappingURL=screenshot.js.map

package/dist/src/screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../src/screenshot.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,QAAQ,EAAE,MAAM,MAAM,CAAA;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,sCAAsC,GACvC,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAA;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAYvD,oEAAoE;AACpE,MAAM,oBAAoB,GAAG,gBAAgB,CAAA;AAW7C,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAEjC;IACA,aAAa,EAAE,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACxD,aAAa,EAAE,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAE5C,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACtB,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAClC,MAAM,IAAI,GAAG,cAAc,EAAE,CAAA;YAC7B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,MAAM,IAAI,aAAa,CACrB,8EAA8E,CAC/E,CAAA;YACH,CAAC;YACD,cAAc,CAAC,MAAM,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QAC1D,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE;QACrC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,MAAM,CAAA;QAC9D,MAAM,aAAa,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAA;QAE5D,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,IAAI,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,KAAK,EACZ,EACE,OAAO,EACP,aAAa,EACb,WAAW,EACX,MAAM,EACN,UAAU,EACV,SAAS,EACT,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,OAAO,EACP,YAAY,EACZ,OAAO,EACP,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,iBAAiB,GAClB,EACD,GAAG,EACH,EAAE;QACF,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;QACtD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,MAAM,CAAA;QAE9D,6DAA6D;QAC7D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,2BAA2B,CAAC;YAC1B,UAAU;YACV,kBAAkB,EAAE,YAAY;YAChC,iBAAiB,EAAE,wBAAwB,CACzC,aAAa,EACb,iBAAiB,EACjB,sCAAsC,CACvC;YACD,SAAS,EAAE;gBACT,WAAW;gBACX,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,WAAW;gBACX,WAAW;gBACX,gBAAgB;gBAChB,eAAe;gBACf,iBAAiB;gBACjB,OAAO;gBACP,YAAY;gBACZ,OAAO;gBACP,SAAS;gBACT,eAAe;gBACf,iBAAiB;gBACjB,QAAQ;gBACR,QAAQ;aACT;SACF,CAAC,CACH,CAAA;QAED,iBAAiB,CAAC,OAAO,CAAC,CAAA;QAE1B,IAAI,CAAC;YACH,MAAM,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;IAED,IAAI,EAAE,KAAK,EACT,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,iBAAiB,EAAE,EAC5D,GAAG,EACH,QAAQ,EACR,EAAE;QACF,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,MAAM,CAAA;QAC9D,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;QAEhE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,sEAAsE;YACtE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;YACpC,MAAM,cAAc,GAAG,4BAA4B,CAAC;gBAClD,QAAQ;gBACR,IAAI;gBACJ,YAAY,EAAE,QAAQ,CAAC,IAAI;aAC5B,CAAC,CAAA;YACF,QAAQ,CAAC,KAAK,EAAE,CAAA;YAChB,MAAM,0BAA0B,CAAC;gBAC/B,cAAc;gBACd,IAAI;gBACJ,QAAQ;gBACR,eAAe,EAAE,SAAS;gBAC1B,EAAE,EAAE,KAAK,IAAI,EAAE;oBACb,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;aACF,CAAC,CAAA;YACF,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;YAClB,OAAM;QACR,CAAC;QAED,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;QACtD,MAAM,GAAG,GAAG,wBAAwB,CAClC,aAAa,EACb,iBAAiB,EACjB,sCAAsC,CACvC,CAAA;QAED,MAAM,aAAa,GAAG,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACjE,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,aAAa,CAAC,CAAA;QAErE,eAAe;QACf,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3D,CAAC;QAAC,MAAM,CAAC;YACP,+BAA+B;QACjC,CAAC;QACD,MAAM,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE/C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QACpC,MAAM,cAAc,GAAG,4BAA4B,CAAC;YAClD,QAAQ;YACR,IAAI;YACJ,YAAY,EAAE,QAAQ,CAAC,IAAI;YAC3B,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAA;QAEF,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,IAAI,CAAC;YACH,MAAM,0BAA0B,CAAC;gBAC/B,cAAc;gBACd,IAAI;gBACJ,QAAQ;gBACR,eAAe,EAAE,SAAS;gBAC1B,EAAE,EAAE,KAAK,IAAI,EAAE;oBACb,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;aACF,CAAC,CAAA;YAEF,2EAA2E;YAC3E,0EAA0E;YAC1E,kDAAkD;YAClD,MAAM,IAAI,CAAC,UAAU,CAAC;gBACpB,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC;aAChD,CAAC,CAAA;YAEF,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,IAAI,SAAS,CAAA;YAC7C,MAAM,UAAU,GAAmB;gBACjC,IAAI,EAAE,oBAAoB;gBAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC;gBAC3C,iBAAiB,EAAE,GAAG;aACvB,CAAA;YAED,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;YAClE,yEAAyE;YACzE,0EAA0E;YAC1E,MAAM,QAAQ,CAAC,WAAW,CACxB,aAAa,EACb,QAAQ,CAAC,KAAK,EACd,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,EAClC;gBACE,MAAM,EAAE,YAAY;gBACpB,UAAU;gBACV,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;aACpC,CACF,CAAA;QACH,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;QACpB,CAAC;IACH,CAAC;CACF,CAAC,CAAA;AAmGF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,eAAwC,CAAA"}

package/dist/src/stillCapture.d.ts

@@ -0,0 +1,68 @@
+import type { Page } from '@playwright/test';
+import type { IEventRecorder } from './events.js';
+import type { CropTarget, ScreenshotCropRecord } from './crop.js';
+import type { RecordOptions, RenderOptions } from './types.js';
+import type { StudioRenderOptionsSentinel } from './studio.js';
+/**
+ * The screenci-specific options added to `page.screenshot()` inside a `video()`.
+ * Everything else is forwarded to Playwright's native screenshot.
+ */
+export type StillScreenshotOptions = {
+    /**
+     * Names the still recording produced from this capture. The recording's title
+     * is `"<video title> - <name>"`. Defaults to the `path` basename, then an
+     * auto-indexed `screenshot`, `screenshot 2`, ...
+     */
+    name?: string;
+    /** Crop the still to a locator or pixel region (applied by the compositor). */
+    crop?: CropTarget;
+};
+/**
+ * Resolve the still's name: explicit `name`, else the `path` basename (without
+ * extension), else an auto-indexed fallback that stays unique within `used`.
+ * Pure and exported for testing.
+ */
+export declare function resolveStillName(name: string | undefined, path: string | undefined, used: Set<string>): string;
+/** Injectable side effects, so the writer can be unit tested without real I/O. */
+export type StillCaptureDeps = {
+    /** Captures the page to `pngPath` and returns the raw bytes. */
+    capture: (pngPath: string) => Promise<Buffer>;
+    fs?: {
+        rm: (path: string) => Promise<void>;
+        mkdir: (path: string) => Promise<void>;
+    };
+    makeRecorder?: (renderOptions: RenderOptions | StudioRenderOptionsSentinel | undefined, recordOptions: RecordOptions | undefined) => IEventRecorder;
+};
+/**
+ * Write a standalone screenshot recording (its own `.screenci/<title>/` dir with
+ * `output: 'screenshot'`). Discovered and uploaded by the CLI exactly like a
+ * `screenshot()` fixture capture, so no rendering/backend changes are needed.
+ * Returns the captured bytes so the wrapped `page.screenshot()` can return them.
+ */
+export declare function writeStillRecording(params: {
+    name: string;
+    screenciDir: string;
+    dimensions: {
+        width: number;
+        height: number;
+    };
+    deviceScaleFactor: number;
+    crop?: ScreenshotCropRecord;
+    testFilePath: string | null;
+    configDir: string;
+    recordOptions: RecordOptions | undefined;
+    renderOptions: RenderOptions | StudioRenderOptionsSentinel | undefined;
+    deps: StillCaptureDeps;
+}): Promise<Buffer>;
+/**
+ * Wrap `page.screenshot()` so that, while recording a `video()`, each call also
+ * writes a branded still as a separate screenshot recording, then returns the
+ * native Buffer. Outside recording it strips the screenci-specific keys and
+ * delegates straight to Playwright.
+ *
+ * Bound only to the `video()` fixture's page (never the `screenshot()` fixture's),
+ * so the screenshot fixture's own implicit capture and the overlay rasterizer
+ * keep the native behavior.
+ */
+export declare function bindStillCaptureToPage(page: Page): void;
+//# sourceMappingURL=stillCapture.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stillCapture.d.ts","sourceRoot":"","sources":["../../src/stillCapture.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAI5C,OAAO,KAAK,EAAE,cAAc,EAAkB,MAAM,aAAa,CAAA;AAEjE,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAOjE,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC9D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AAK9D;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+EAA+E;IAC/E,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB,CAAA;AAQD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,GAChB,MAAM,CAqBR;AAED,kFAAkF;AAClF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gEAAgE;IAChE,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7C,EAAE,CAAC,EAAE;QACH,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QACnC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KACvC,CAAA;IACD,YAAY,CAAC,EAAE,CACb,aAAa,EAAE,aAAa,GAAG,2BAA2B,GAAG,SAAS,EACtE,aAAa,EAAE,aAAa,GAAG,SAAS,KACrC,cAAc,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,iBAAiB,EAAE,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,oBAAoB,CAAA;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,aAAa,GAAG,SAAS,CAAA;IACxC,aAAa,EAAE,aAAa,GAAG,2BAA2B,GAAG,SAAS,CAAA;IACtE,IAAI,EAAE,gBAAgB,CAAA;CACvB,GAAG,OAAO,CAAC,MAAM,CAAC,CAmDlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAqDvD"}

package/dist/src/stillCapture.js

@@ -0,0 +1,119 @@
+import { mkdir as fsMkdir, rm as fsRm } from 'fs/promises';
+import { join, relative } from 'path';
+import { getDimensions } from './dimensions.js';
+import { escapeFileSystemPathSegment } from './fileSystemName.js';
+import { EventRecorder } from './events.js';
+import { resolveCrop } from './crop.js';
+import { getScreenCIRuntimeContext } from './runtimeContext.js';
+import { DEFAULT_VIDEO_OPTIONS, DEFAULT_ASPECT_RATIO, DEFAULT_QUALITY, } from './defaults.js';
+/** File name of the raw page capture written beside a still's `data.json`. */
+const SCREENSHOT_FILE_NAME = 'screenshot.png';
+/**
+ * Resolve the still's name: explicit `name`, else the `path` basename (without
+ * extension), else an auto-indexed fallback that stays unique within `used`.
+ * Pure and exported for testing.
+ */
+export function resolveStillName(name, path, used) {
+    let base = name?.trim() || undefined;
+    if (base === undefined && typeof path === 'string') {
+        base =
+            path
+                .split(/[\\/]/)
+                .pop()
+                ?.replace(/\.[^.]+$/, '') || undefined;
+    }
+    if (base === undefined) {
+        base = 'screenshot';
+    }
+    let candidate = base;
+    let n = 2;
+    while (used.has(candidate)) {
+        candidate = `${base} ${n}`;
+        n++;
+    }
+    used.add(candidate);
+    return candidate;
+}
+/**
+ * Write a standalone screenshot recording (its own `.screenci/<title>/` dir with
+ * `output: 'screenshot'`). Discovered and uploaded by the CLI exactly like a
+ * `screenshot()` fixture capture, so no rendering/backend changes are needed.
+ * Returns the captured bytes so the wrapped `page.screenshot()` can return them.
+ */
+export async function writeStillRecording(params) {
+    const { name, screenciDir, dimensions, deviceScaleFactor, crop, testFilePath, configDir, recordOptions, renderOptions, deps, } = params;
+    const rm = deps.fs?.rm ??
+        ((path) => fsRm(path, { recursive: true, force: true }));
+    const mkdir = deps.fs?.mkdir ??
+        ((path) => fsMkdir(path, { recursive: true }).then(() => undefined));
+    const makeRecorder = deps.makeRecorder ?? ((ro, rec) => new EventRecorder(ro, rec));
+    // The still is named exactly by `name`; its directory and recording title both
+    // use it directly (like a standalone screenshot() test's title).
+    const dir = join(screenciDir, escapeFileSystemPathSegment(name));
+    await rm(dir);
+    await mkdir(dir);
+    const buffer = await deps.capture(join(dir, SCREENSHOT_FILE_NAME));
+    const screenshot = {
+        path: SCREENSHOT_FILE_NAME,
+        width: Math.round(dimensions.width * deviceScaleFactor),
+        height: Math.round(dimensions.height * deviceScaleFactor),
+        deviceScaleFactor,
+    };
+    const recorder = makeRecorder(renderOptions, recordOptions);
+    recorder.start();
+    // The crop is a render option (renderOptions.screenshot.crop), passed through
+    // writeToFile rather than stored on ScreenshotInfo.
+    await recorder.writeToFile(dir, name, testFilePath !== null ? relative(configDir, testFilePath) : undefined, { output: 'screenshot', screenshot, ...(crop !== undefined && { crop }) });
+    return buffer;
+}
+/**
+ * Wrap `page.screenshot()` so that, while recording a `video()`, each call also
+ * writes a branded still as a separate screenshot recording, then returns the
+ * native Buffer. Outside recording it strips the screenci-specific keys and
+ * delegates straight to Playwright.
+ *
+ * Bound only to the `video()` fixture's page (never the `screenshot()` fixture's),
+ * so the screenshot fixture's own implicit capture and the overlay rasterizer
+ * keep the native behavior.
+ */
+export function bindStillCaptureToPage(page) {
+    const original = page.screenshot.bind(page);
+    const usedNames = new Set();
+    const wrapped = async (options) => {
+        const { name, crop: cropTarget, ...playwrightOptions } = options ?? {};
+        if (process.env.SCREENCI_RECORDING !== 'true') {
+            return original(playwrightOptions);
+        }
+        const ctx = getScreenCIRuntimeContext();
+        const recordOptions = ctx.recordOptions ?? DEFAULT_VIDEO_OPTIONS;
+        const aspectRatio = recordOptions.aspectRatio ?? DEFAULT_ASPECT_RATIO;
+        const quality = recordOptions.quality ?? DEFAULT_QUALITY;
+        const dimensions = getDimensions(aspectRatio, quality);
+        const resolvedName = resolveStillName(name, typeof playwrightOptions.path === 'string'
+            ? playwrightOptions.path
+            : undefined, usedNames);
+        let crop;
+        if (cropTarget !== undefined && ctx.page !== null) {
+            crop = await resolveCrop(cropTarget, ctx.page);
+        }
+        const configDir = process.env.SCREENCI_CONFIG_DIR ?? process.cwd();
+        return writeStillRecording({
+            name: resolvedName,
+            screenciDir: join(process.cwd(), '.screenci'),
+            dimensions,
+            // The video context never applies deviceScaleFactor (video.ts), so a still
+            // captured mid-recording is at the viewport resolution (DSF 1).
+            deviceScaleFactor: 1,
+            ...(crop !== undefined && { crop }),
+            testFilePath: ctx.testFilePath,
+            configDir,
+            recordOptions,
+            renderOptions: ctx.renderOptions,
+            deps: {
+                capture: (pngPath) => original({ ...playwrightOptions, path: pngPath }),
+            },
+        });
+    };
+    page.screenshot = wrapped;
+}
+//# sourceMappingURL=stillCapture.js.map

package/dist/src/stillCapture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stillCapture.js","sourceRoot":"","sources":["../../src/stillCapture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAC/D,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,GAChB,MAAM,eAAe,CAAA;AAItB,8EAA8E;AAC9E,MAAM,oBAAoB,GAAG,gBAAgB,CAAA;AAuB7C;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAwB,EACxB,IAAwB,EACxB,IAAiB;IAEjB,IAAI,IAAI,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,SAAS,CAAA;IACpC,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnD,IAAI;YACF,IAAI;iBACD,KAAK,CAAC,OAAO,CAAC;iBACd,GAAG,EAAE;gBACN,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,SAAS,CAAA;IAC5C,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,GAAG,YAAY,CAAA;IACrB,CAAC;IAED,IAAI,SAAS,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,GAAG,CAAC,CAAA;IACT,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,EAAE,CAAA;QAC1B,CAAC,EAAE,CAAA;IACL,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACnB,OAAO,SAAS,CAAA;AAClB,CAAC;AAgBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAWzC;IACC,MAAM,EACJ,IAAI,EACJ,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,IAAI,EACJ,YAAY,EACZ,SAAS,EACT,aAAa,EACb,aAAa,EACb,IAAI,GACL,GAAG,MAAM,CAAA;IAEV,MAAM,EAAE,GACN,IAAI,CAAC,EAAE,EAAE,EAAE;QACX,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAClE,MAAM,KAAK,GACT,IAAI,CAAC,EAAE,EAAE,KAAK;QACd,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAC9E,MAAM,YAAY,GAChB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,aAAa,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;IAEhE,+EAA+E;IAC/E,iEAAiE;IACjE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;IAEhE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAA;IACb,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IAEhB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAA;IAElE,MAAM,UAAU,GAAmB;QACjC,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,iBAAiB,CAAC;QACvD,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,iBAAiB,CAAC;QACzD,iBAAiB;KAClB,CAAA;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;IAC3D,QAAQ,CAAC,KAAK,EAAE,CAAA;IAChB,8EAA8E;IAC9E,oDAAoD;IACpD,MAAM,QAAQ,CAAC,WAAW,CACxB,GAAG,EACH,IAAI,EACJ,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EACrE,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAC1E,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAU;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAA;IAEnC,MAAM,OAAO,GAAG,KAAK,EACnB,OAAkC,EACjB,EAAE;QACnB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,iBAAiB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;QAEtE,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,MAAM,EAAE,CAAC;YAC9C,OAAO,QAAQ,CAAC,iBAAiB,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,GAAG,GAAG,yBAAyB,EAAE,CAAA;QACvC,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,IAAI,qBAAqB,CAAA;QAChE,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,YAAY,GAAG,gBAAgB,CACnC,IAAI,EACJ,OAAO,iBAAiB,CAAC,IAAI,KAAK,QAAQ;YACxC,CAAC,CAAC,iBAAiB,CAAC,IAAI;YACxB,CAAC,CAAC,SAAS,EACb,SAAS,CACV,CAAA;QAED,IAAI,IAAsC,CAAA;QAC1C,IAAI,UAAU,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAClD,IAAI,GAAG,MAAM,WAAW,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;QAChD,CAAC;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;QAElE,OAAO,mBAAmB,CAAC;YACzB,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC;YAC7C,UAAU;YACV,2EAA2E;YAC3E,gEAAgE;YAChE,iBAAiB,EAAE,CAAC;YACpB,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;YACnC,YAAY,EAAE,GAAG,CAAC,YAAY;YAC9B,SAAS;YACT,aAAa;YACb,aAAa,EAAE,GAAG,CAAC,aAAa;YAChC,IAAI,EAAE;gBACJ,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,GAAG,iBAAiB,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;aACxE;SACF,CAAC,CAAA;IACJ,CAAC,CAEA;IAAC,IAAkD,CAAC,UAAU,GAAG,OAAO,CAAA;AAC3E,CAAC"}

package/dist/src/studio.d.ts

@@ -5,7 +5,7 @@
  * Code opts in per concern:
  * - `createStudioNarration('intro', 'outro')` declares cue keys whose text and
  *   voice are filled in on the Studio page.
- * - `renderOptions: STUDIO_RENDER_OPTIONS` defers render options to Studio.
+ * - `renderOptions: 'studio'` defers render options to Studio.
  *
  * On the first upload of a studio-mode video, rendering is held until the
  * video is configured in Studio; later uploads reuse the saved configuration.
@@ -14,23 +14,20 @@
  * Sentinel value for the `renderOptions` fixture/config option meaning
  * "render options are configured in Studio".
  *
- * Implemented as a frozen, JSON-safe branded object (not a string or symbol)
- * so it survives Playwright's serialization of `use` options between the
- * config file and test workers, and cannot collide with a real
- * {@link import('./types.js').RenderOptions} value.
+ * A plain string literal (not an object or symbol) so it survives Playwright's
+ * serialization of `use` options between the config file and test workers, and
+ * cannot collide with a real {@link import('./types.js').RenderOptions} value,
+ * which is always an object.
  *
  * @example
  * ```ts
- * import { defineConfig, STUDIO_RENDER_OPTIONS } from 'screenci'
+ * import { defineConfig } from 'screenci'
  *
  * export default defineConfig({
- *   use: { renderOptions: STUDIO_RENDER_OPTIONS },
+ *   use: { renderOptions: 'studio' },
  * })
  * ```
  */
-export declare const STUDIO_RENDER_OPTIONS: Readonly<{
-    readonly __screenciStudioRenderOptions: true;
-}>;
-export type StudioRenderOptionsSentinel = typeof STUDIO_RENDER_OPTIONS;
+export type StudioRenderOptionsSentinel = 'studio';
 export declare function isStudioRenderOptions(value: unknown): value is StudioRenderOptionsSentinel;
 //# sourceMappingURL=studio.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"studio.d.ts","sourceRoot":"","sources":["../../src/studio.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,qBAAqB;;EAEvB,CAAA;AAEX,MAAM,MAAM,2BAA2B,GAAG,OAAO,qBAAqB,CAAA;AAEtE,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,2BAA2B,CAMtC"}
+{"version":3,"file":"studio.d.ts","sourceRoot":"","sources":["../../src/studio.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAAA;AAElD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,2BAA2B,CAEtC"}

package/dist/src/studio.js

@@ -5,35 +5,12 @@
  * Code opts in per concern:
  * - `createStudioNarration('intro', 'outro')` declares cue keys whose text and
  *   voice are filled in on the Studio page.
- * - `renderOptions: STUDIO_RENDER_OPTIONS` defers render options to Studio.
+ * - `renderOptions: 'studio'` defers render options to Studio.
  *
  * On the first upload of a studio-mode video, rendering is held until the
  * video is configured in Studio; later uploads reuse the saved configuration.
  */
-/**
- * Sentinel value for the `renderOptions` fixture/config option meaning
- * "render options are configured in Studio".
- *
- * Implemented as a frozen, JSON-safe branded object (not a string or symbol)
- * so it survives Playwright's serialization of `use` options between the
- * config file and test workers, and cannot collide with a real
- * {@link import('./types.js').RenderOptions} value.
- *
- * @example
- * ```ts
- * import { defineConfig, STUDIO_RENDER_OPTIONS } from 'screenci'
- *
- * export default defineConfig({
- *   use: { renderOptions: STUDIO_RENDER_OPTIONS },
- * })
- * ```
- */
-export const STUDIO_RENDER_OPTIONS = Object.freeze({
-    __screenciStudioRenderOptions: true,
-});
 export function isStudioRenderOptions(value) {
-    return (typeof value === 'object' &&
-        value !== null &&
-        value.__screenciStudioRenderOptions === true);
+    return value === 'studio';
 }
 //# sourceMappingURL=studio.js.map

package/dist/src/studio.js.map

@@ -1 +1 @@
-{"version":3,"file":"studio.js","sourceRoot":"","sources":["../../src/studio.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjD,6BAA6B,EAAE,IAAI;CAC3B,CAAC,CAAA;AAIX,MAAM,UAAU,qBAAqB,CACnC,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACb,KAAiC,CAAC,6BAA6B,KAAK,IAAI,CAC1E,CAAA;AACH,CAAC"}
+{"version":3,"file":"studio.js","sourceRoot":"","sources":["../../src/studio.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAsBH,MAAM,UAAU,qBAAqB,CACnC,KAAc;IAEd,OAAO,KAAK,KAAK,QAAQ,CAAA;AAC3B,CAAC"}