@augment-vir/test 31.50.0 → 31.50.2

package/dist/augments/test-playwright.d.ts

@@ -1,21 +1,18 @@
 import { RuntimeEnvError } from '@augment-vir/core';
 export { type MenuOptionOptions } from '../test-playwright/get-option.js';
-export { playwrightTeatNameUrlParam, type NavPath } from '../test-playwright/nav.js';
-export { type LocatorScreenshotOptions } from '../test-playwright/screenshot.js';
+export { playwrightTeatNameUrlParam, type NavOptions } from '../test-playwright/nav.js';
+export { type LocatorScreenshotOptions, type SaveScreenshotOptions, type TakeScreenshotOptions, } from '../test-playwright/screenshot.js';
 declare function importPlaywrightTestApi(this: void): Promise<RuntimeEnvError | {
-    /** Navigate to a URL in Playwright via given paths. */
-    nav: typeof import("../test-playwright/nav.js").nav;
+    navigation: {
+        /** Navigate to a URL in Playwright via given paths. */
+        navigateTo: typeof import("../test-playwright/nav.js").navigateTo;
+        extractNavUrl: typeof import("../test-playwright/nav.js").extractNavUrl;
+    };
     /**
      * Expects that all matches for the given locator are either visible or hidden (controlled
      * by `isVisible`).
      */
     expectAllVisible: typeof import("../test-playwright/all-visible.js").expectAllVisible;
-    /**
-     * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have different
-     * sizes and has default comparison threshold options that are wide enough to allow testing
-     * between different operating systems without failure (usually).
-     */
-    expectScreenshot: typeof import("../test-playwright/screenshot.js").expectScreenshot;
     /** Clicks a label to select its input and then types the given text. */
     enterTextByLabel: typeof import("../test-playwright/enter-text").enterTextByLabel;
     /** Find the matching (or first) element with the "option" role. */
@@ -29,6 +26,23 @@ declare function importPlaywrightTestApi(this: void): Promise<RuntimeEnvError |
     handleNewPageOrDownload: typeof import("../test-playwright/new-page-or-download").handleNewPageOrDownload;
     /** Read from a page's local storage (using `page.evaluate`). */
     readLocalStorage: typeof import("../test-playwright/local-storage.js").readLocalStorage;
+    /** Screenshot methods. */
+    screenshot: {
+        /**
+         * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have
+         * different sizes and has default comparison threshold options that are wide enough to
+         * allow testing between different operating systems without failure (usually).
+         */
+        expectScreenshot: typeof import("../test-playwright/screenshot.js").expectScreenshot;
+        /** Get the path to save the given screenshot file name to. */
+        getScreenshotPath: typeof import("../test-playwright/screenshot.js").getScreenshotPath;
+        /**
+         * Take and immediately save a screenshot.
+         *
+         * @returns The path that the screenshot was saved to.
+         */
+        takeScreenshot: typeof import("../test-playwright/screenshot.js").takeScreenshot;
+    };
 }>;
 /**
  * A suite of Playwright test helpers. This is only accessible within a Playwright test runtime. If

package/dist/augments/test-playwright.js

@@ -7,25 +7,22 @@ async function importPlaywrightTestApi() {
     const { checkHasClass } = await import('../test-playwright/has-class');
     const { enterTextByLabel } = await import('../test-playwright/enter-text');
     const { expectAllVisible } = await import('../test-playwright/all-visible.js');
-    const { expectScreenshot } = await import('../test-playwright/screenshot.js');
     const { getMenuOption } = await import('../test-playwright/get-option');
+    const { getScreenshotPath, takeScreenshot, expectScreenshot } = await import('../test-playwright/screenshot.js');
     const { handleNewPageOrDownload } = await import('../test-playwright/new-page-or-download');
-    const { nav } = await import('../test-playwright/nav.js');
+    const { navigateTo, extractNavUrl } = await import('../test-playwright/nav.js');
     const { readLocalStorage } = await import('../test-playwright/local-storage.js');
     return {
-        /** Navigate to a URL in Playwright via given paths. */
-        nav,
+        navigation: {
+            /** Navigate to a URL in Playwright via given paths. */
+            navigateTo,
+            extractNavUrl,
+        },
         /**
          * Expects that all matches for the given locator are either visible or hidden (controlled
          * by `isVisible`).
          */
         expectAllVisible,
-        /**
-         * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have different
-         * sizes and has default comparison threshold options that are wide enough to allow testing
-         * between different operating systems without failure (usually).
-         */
-        expectScreenshot,
         /** Clicks a label to select its input and then types the given text. */
         enterTextByLabel,
         /** Find the matching (or first) element with the "option" role. */
@@ -39,6 +36,23 @@ async function importPlaywrightTestApi() {
         handleNewPageOrDownload,
         /** Read from a page's local storage (using `page.evaluate`). */
         readLocalStorage,
+        /** Screenshot methods. */
+        screenshot: {
+            /**
+             * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have
+             * different sizes and has default comparison threshold options that are wide enough to
+             * allow testing between different operating systems without failure (usually).
+             */
+            expectScreenshot,
+            /** Get the path to save the given screenshot file name to. */
+            getScreenshotPath,
+            /**
+             * Take and immediately save a screenshot.
+             *
+             * @returns The path that the screenshot was saved to.
+             */
+            takeScreenshot,
+        },
     };
 }
 /**

package/dist/augments/universal-testing-suite/it-cases-with-context.d.ts

@@ -9,7 +9,7 @@ import { type UniversalTestContext } from './universal-test-context.js';
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export type BaseFunctionWithContext = (testContext: UniversalTestContext, ...args: any[]) => any;
+export type BaseFunctionWithContext = (testContext: Readonly<UniversalTestContext>, ...args: any[]) => any;
 /**
  * Input for a test function with context that only has a single input.
  *

package/dist/augments/universal-testing-suite/universal-it.d.ts

@@ -10,7 +10,7 @@ import { type UniversalTestContext } from './universal-test-context.js';
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export type UniversalItCallback = (this: void, context: UniversalTestContext) => Promise<void> | void;
+export type UniversalItCallback = (this: void, context: Readonly<UniversalTestContext>) => Promise<void> | void;
 /**
  * A minimal interface for {@link it}. This is used in {@link UniversalIt}.
  *

package/dist/augments/universal-testing-suite/universal-it.js

@@ -27,6 +27,11 @@ async function createPlaywrightIt() {
     const originalPlaywrightIt = 'default' in rawPlaywrightImport
         ? rawPlaywrightImport.default
         : rawPlaywrightImport;
+    /**
+     * Right now this wrapper nukes Playwright's file detection. See
+     * https://github.com/microsoft/playwright/issues/23157#issuecomment-1574955057 for possible
+     * help.
+     */
     const playwrightIt = Object.assign((doesThis, callback) => {
         return originalPlaywrightIt(doesThis, async ({ page, baseURL, browser, context, extraHTTPHeaders, viewport, video, userAgent, timezoneId, serviceWorkers, screenshot, isMobile, headless, hasTouch, }, testInfo) => {
             const playwrightTestContext = {

package/dist/augments/universal-testing-suite/universal-snapshot.d.ts

@@ -22,4 +22,4 @@ export declare class SnapshotFileMissingError extends Error {
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function assertSnapshot(this: void, testContext: UniversalTestContext, data: unknown): Promise<void>;
+export declare function assertSnapshot(this: void, testContext: Readonly<UniversalTestContext>, data: unknown): Promise<void>;

package/dist/augments/universal-testing-suite/universal-test-context.d.ts

@@ -58,6 +58,13 @@ export type PlaywrightTestContext = SelectFrom<PlaywrightTestArgs & PlaywrightTe
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
 export type UniversalTestContext = NodeTestContext | MochaTestContext | PlaywrightTestContext;
+/**
+ * Used to determine which test context is in use.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export declare enum TestEnv {
     Node = "node",
     Web = "web",
@@ -109,7 +116,7 @@ export declare function cleanTestNameAsDir(testName: string): string;
  * @throws `TypeError` if the context does not match the env.
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function assertWrapTestContext<const SpecificEnv extends TestEnv>(this: void, context: UniversalTestContext, env: SpecificEnv): TestContextByEnv[SpecificEnv];
+export declare function assertWrapTestContext<const SpecificEnv extends TestEnv>(this: void, context: Readonly<UniversalTestContext>, env: SpecificEnv): TestContextByEnv[SpecificEnv];
 /**
  * Asserts that the given context is for the given env, otherwise throws an Error.
  *
@@ -117,7 +124,7 @@ export declare function assertWrapTestContext<const SpecificEnv extends TestEnv>
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function assertTestContext<const SpecificEnv extends TestEnv>(this: void, context: UniversalTestContext, env: SpecificEnv): asserts context is TestContextByEnv[SpecificEnv];
+export declare function assertTestContext<const SpecificEnv extends TestEnv>(this: void, context: Readonly<UniversalTestContext>, env: SpecificEnv): asserts context is TestContextByEnv[SpecificEnv];
 /**
  * Checks that the given context is for the given env.
  *
@@ -125,7 +132,7 @@ export declare function assertTestContext<const SpecificEnv extends TestEnv>(thi
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function isTestContext<const SpecificEnv extends TestEnv>(this: void, context: UniversalTestContext, env: SpecificEnv): context is TestContextByEnv[SpecificEnv];
+export declare function isTestContext<const SpecificEnv extends TestEnv>(this: void, context: Readonly<UniversalTestContext>, env: SpecificEnv): context is TestContextByEnv[SpecificEnv];
 /**
  * Determine the env for the given test context.
  *

package/dist/augments/universal-testing-suite/universal-test-context.js

@@ -1,5 +1,12 @@
 import { assertWrap } from '@augment-vir/assert';
 import { camelCaseToKebabCase, sanitizeFilePath } from '@augment-vir/common';
+/**
+ * Used to determine which test context is in use.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export var TestEnv;
 (function (TestEnv) {
     TestEnv["Node"] = "node";

package/dist/test-playwright/enter-text.d.ts

@@ -1,10 +1,10 @@
-import { type Page } from '@playwright/test';
+import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Clicks a label to select its input and then types the given text.
  *
  * @category Internal
  */
-export declare function enterTextByLabel(page: Readonly<Page>, { label, text }: {
+export declare function enterTextByLabel(testContext: Readonly<UniversalTestContext>, { label, text }: {
     label: string;
     text: string;
 }): Promise<void>;

package/dist/test-playwright/enter-text.js

@@ -1,9 +1,11 @@
+import { assertTestContext, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Clicks a label to select its input and then types the given text.
  *
  * @category Internal
  */
-export async function enterTextByLabel(page, { label, text }) {
-    await page.getByLabel(label).first().click();
-    await page.keyboard.type(text);
+export async function enterTextByLabel(testContext, { label, text }) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    await testContext.page.getByLabel(label).first().click();
+    await testContext.page.keyboard.type(text);
 }

package/dist/test-playwright/get-option.d.ts

@@ -1,4 +1,5 @@
 import { type Page } from '@playwright/test';
+import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Options for `testPlaywright.getMenuOption`.
  *
@@ -12,4 +13,4 @@ export type MenuOptionOptions = Parameters<Page['getByRole']>[1] & Partial<{
  *
  * @category Internal
  */
-export declare function getMenuOption(page: Readonly<Page>, options?: MenuOptionOptions | undefined): import("playwright-core").Locator;
+export declare function getMenuOption(testContext: Readonly<UniversalTestContext>, options?: MenuOptionOptions | undefined): import("playwright-core").Locator;

package/dist/test-playwright/get-option.js

@@ -1,10 +1,12 @@
+import { assertTestContext, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Find the matching (or first) "option" element.
  *
  * @category Internal
  */
-export function getMenuOption(page, options) {
-    const baseLocator = page.getByRole('option', options);
+export function getMenuOption(testContext, options) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    const baseLocator = testContext.page.getByRole('option', options);
     if (options && 'nth' in options) {
         return baseLocator.nth(options.nth);
     }

package/dist/test-playwright/local-storage.d.ts

@@ -1,7 +1,7 @@
-import { type Page } from '@playwright/test';
+import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Read from a page's local storage.
  *
  * @category Internal
  */
-export declare function readLocalStorage(page: Readonly<Page>, storageKey: string): Promise<string | undefined>;
+export declare function readLocalStorage(testContext: Readonly<UniversalTestContext>, storageKey: string): Promise<string | undefined>;

package/dist/test-playwright/local-storage.js

@@ -1,10 +1,12 @@
+import { assertTestContext, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Read from a page's local storage.
  *
  * @category Internal
  */
-export async function readLocalStorage(page, storageKey) {
-    return ((await page.evaluate((keyToRead) => {
+export async function readLocalStorage(testContext, storageKey) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    return ((await testContext.page.evaluate((keyToRead) => {
         return localStorage.getItem(keyToRead);
     }, storageKey)) || undefined);
 }

package/dist/test-playwright/nav.d.ts

@@ -1,15 +1,24 @@
 import { type GenericTreePaths } from 'spa-router-vir';
+import { type UrlOverrides } from 'url-vir';
 import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
+/**
+ * Converts {@link NavOptions} into an actionable URL string.
+ *
+ * @category Internal
+ */
+export declare function extractNavUrl(testContext: Readonly<UniversalTestContext>, options: Readonly<NavOptions>): string;
 /**
  * Used for the `path` argument of `testPlaywright.nav`.
  *
  * @category Internal
  */
-export type NavPath = /** A full URL to load, will not be appended to the auto detected frontend url. */ string
-/** Path array to append to the auto detected frontend url. */
- | string[]
-/** Prefer using tree paths with `frontendPathTree` */
- | GenericTreePaths;
+export type NavOptions = Omit<UrlOverrides, 'paths'> & {
+    /** If not provided, the page's current URL will be used. */
+    baseFrontendUrl?: string | undefined;
+    paths?: string[]
+    /** Prefer using tree paths with `frontendPathTree` */
+     | GenericTreePaths;
+};
 /**
  * The test name appended to the frontend when `testPlaywright.nav` is used.
  *
@@ -21,8 +30,4 @@ export declare const playwrightTeatNameUrlParam = "test-name";
  *
  * @category Internal
  */
-export declare function nav(testContext: UniversalTestContext, { path, baseFrontendUrl, }: {
-    path: NavPath;
-    /** If not provided, the page's current URL will be used. */
-    baseFrontendUrl?: string | undefined;
-}): Promise<void>;
+export declare function navigateTo(testContext: Readonly<UniversalTestContext>, options: Readonly<NavOptions>): Promise<void>;

package/dist/test-playwright/nav.js

@@ -1,16 +1,26 @@
 import { check } from '@augment-vir/assert';
+import { omitObjectKeys } from '@augment-vir/common';
 import { buildUrl } from 'url-vir';
-import { assertTestContext, extractTestNameAsDir, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
-function extractNavUrl(frontendUrl, path) {
-    return check.isString(path)
-        ? path
-        : check.isArray(path)
-            ? buildUrl(frontendUrl, {
-                paths: path,
-            }).href
-            : buildUrl(frontendUrl, {
-                paths: path.fullPaths,
-            }).href;
+import { assertTestContext, assertWrapTestContext, extractTestNameAsDir, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
+/**
+ * Converts {@link NavOptions} into an actionable URL string.
+ *
+ * @category Internal
+ */
+export function extractNavUrl(testContext, options) {
+    return buildUrl(options.baseFrontendUrl ||
+        assertWrapTestContext(testContext, TestEnv.Playwright).page.url(), {
+        ...omitObjectKeys(options, ['paths']),
+        ...(options.paths
+            ? check.isArray(options.paths)
+                ? {
+                    paths: options.paths,
+                }
+                : {
+                    paths: options.paths.fullPaths,
+                }
+            : {}),
+    }).href;
 }
 /**
  * The test name appended to the frontend when `testPlaywright.nav` is used.
@@ -23,11 +33,11 @@ export const playwrightTeatNameUrlParam = 'test-name';
  *
  * @category Internal
  */
-export async function nav(testContext, { path, baseFrontendUrl, }) {
+export async function navigateTo(testContext, options) {
     assertTestContext(testContext, TestEnv.Playwright);
     const page = testContext.page;
     const testName = extractTestNameAsDir(testContext);
-    const finalPath = buildUrl(extractNavUrl(baseFrontendUrl || page.url(), path), {
+    const finalPath = buildUrl(extractNavUrl(testContext, options), {
         search: {
             [playwrightTeatNameUrlParam]: [testName],
         },

package/dist/test-playwright/new-page-or-download.d.ts

@@ -1,13 +1,14 @@
 import { type MaybePromise } from '@augment-vir/common';
 import { type Download, type Page } from '@playwright/test';
 import { type RequireExactlyOne } from 'type-fest';
+import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Run the trigger and catch a new page _or_ a new download (sometimes Playwright inconsistently
  * chooses on or the other).
  *
  * @category Internal
  */
-export declare function handleNewPageOrDownload(page: Readonly<Page>, trigger: () => MaybePromise<void>): Promise<RequireExactlyOne<{
+export declare function handleNewPageOrDownload(testContext: Readonly<UniversalTestContext>, trigger: () => MaybePromise<void>): Promise<RequireExactlyOne<{
     newPage: Page;
     download: Download;
 }>>;

package/dist/test-playwright/new-page-or-download.js

@@ -1,20 +1,22 @@
+import { assertTestContext, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /**
  * Run the trigger and catch a new page _or_ a new download (sometimes Playwright inconsistently
  * chooses on or the other).
  *
  * @category Internal
  */
-export async function handleNewPageOrDownload(page, trigger) {
+export async function handleNewPageOrDownload(testContext, trigger) {
+    assertTestContext(testContext, TestEnv.Playwright);
     const openOrDownload = Promise.race([
-        page
+        testContext.page
             .context()
             .waitForEvent('page', async (newPage) => {
-            return (await newPage.opener()) === page;
+            return (await newPage.opener()) === testContext.page;
         })
             .then((result) => {
             return { page: result };
         }),
-        page.waitForEvent('download').then((result) => {
+        testContext.page.waitForEvent('download').then((result) => {
             return { download: result };
         }),
     ]);

package/dist/test-playwright/screenshot.d.ts

@@ -1,4 +1,6 @@
-import { type Locator, type Page, type TestInfo } from '@playwright/test';
+import { type PartialWithUndefined } from '@augment-vir/common';
+import { type Locator } from '@playwright/test';
+import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
 /** This is used for type extraction because Playwright does not export the types we need. */
 declare function extractScreenshotMethod(): {
     (name: string | ReadonlyArray<string>, options?: {
@@ -49,6 +51,31 @@ export declare const defaultScreenshotOptions: {
     threshold: number;
     maxDiffPixelRatio: number;
 };
+export type TakeScreenshotOptions = PartialWithUndefined<{
+    /** If no locator is provided then the whole page is use. */
+    locator: Readonly<Locator>;
+}> & Partial<LocatorScreenshotOptions>;
+/**
+ * Get the path to save the given screenshot file name to.
+ *
+ * @category Internal
+ */
+export declare function getScreenshotPath(testContext: Readonly<UniversalTestContext>, screenshotBaseName: string): string;
+/**
+ * Options for taking _and_ saving a screenshot.
+ *
+ * @category Internal
+ */
+export type SaveScreenshotOptions = TakeScreenshotOptions & {
+    screenshotBaseName: string;
+};
+/**
+ * Take and immediately save a screenshot.
+ *
+ * @category Internal
+ * @returns The path that the screenshot was saved to.
+ */
+export declare function takeScreenshot(testContext: Readonly<UniversalTestContext>, options: Readonly<SaveScreenshotOptions>): Promise<string>;
 /**
  * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have different sizes and
  * has default comparison threshold options that are wide enough to allow testing between different
@@ -56,11 +83,5 @@ export declare const defaultScreenshotOptions: {
  *
  * @category Internal
  */
-export declare function expectScreenshot(page: Readonly<Page>, { locator, screenshotName, testInfo, options, }: {
-    testInfo: Readonly<TestInfo>;
-    /** If no locator is provided, a screenshot of the whole page will be taken. */
-    locator: Readonly<Locator> | undefined;
-    screenshotName: string;
-    options?: Partial<LocatorScreenshotOptions> | undefined;
-}): Promise<void>;
+export declare function expectScreenshot(testContext: Readonly<UniversalTestContext>, options: Readonly<SaveScreenshotOptions>): Promise<void>;
 export {};

package/dist/test-playwright/screenshot.js

@@ -8,6 +8,7 @@ import { relative } from 'node:path';
 import pixelmatch from 'pixelmatch';
 import { PNG } from 'pngjs';
 import sharp from 'sharp';
+import { assertTestContext, assertWrapTestContext, TestEnv, } from '../augments/universal-testing-suite/universal-test-context.js';
 /** This is used for type extraction because Playwright does not export the types we need. */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 function extractScreenshotMethod() {
@@ -62,18 +63,48 @@ async function padToSameCanvas(aBuf, bBuf) {
         dimensions,
     };
 }
-async function takeScreenshot({ locator, page, options, }) {
-    if (locator) {
+async function takeScreenshotBuffer(testContext, options = {}) {
+    if (options.locator) {
         /** The locator expectation has different options than the page expectation. */
-        return await locator.screenshot({ ...defaultScreenshotOptions, ...options });
+        return await options.locator.screenshot({
+            ...defaultScreenshotOptions,
+            ...options,
+        });
     }
     else {
-        return await page.screenshot({
+        assertTestContext(testContext, TestEnv.Playwright);
+        return await testContext.page.screenshot({
             ...defaultScreenshotOptions,
             ...options,
         });
     }
 }
+/** @returns The path that the screenshot was saved to. */
+async function saveScreenshotBuffer(testContext, screenshotBuffer, screenshotBaseName) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    const screenshotPath = getScreenshotPath(testContext, screenshotBaseName);
+    await writeFileAndDir(screenshotPath, screenshotBuffer);
+    return screenshotPath;
+}
+/**
+ * Get the path to save the given screenshot file name to.
+ *
+ * @category Internal
+ */
+export function getScreenshotPath(testContext, screenshotBaseName) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    const screenshotFileName = addSuffix({ value: screenshotBaseName, suffix: '.png' });
+    return testContext.testInfo.snapshotPath(screenshotFileName);
+}
+/**
+ * Take and immediately save a screenshot.
+ *
+ * @category Internal
+ * @returns The path that the screenshot was saved to.
+ */
+export async function takeScreenshot(testContext, options) {
+    return await saveScreenshotBuffer(testContext, await takeScreenshotBuffer(testContext, options), options.screenshotBaseName);
+}
 /**
  * Similar to Playwright's `expect().toHaveScreenshot` but allows images to have different sizes and
  * has default comparison threshold options that are wide enough to allow testing between different
@@ -81,25 +112,25 @@ async function takeScreenshot({ locator, page, options, }) {
  *
  * @category Internal
  */
-export async function expectScreenshot(page, { locator, screenshotName, testInfo, options = {}, }) {
-    const screenshotFileName = addSuffix({ value: screenshotName, suffix: '.png' });
-    const currentScreenshotBuffer = await takeScreenshot({ page, locator, options });
-    const screenshotFilePath = testInfo.snapshotPath(screenshotFileName);
+export async function expectScreenshot(testContext, options) {
+    assertTestContext(testContext, TestEnv.Playwright);
+    const currentScreenshotBuffer = await takeScreenshotBuffer(testContext, options);
+    const screenshotFilePath = getScreenshotPath(testContext, options.screenshotBaseName);
     async function writeNewScreenshot() {
         log.mutate(`Updated screenshot: ${relative(process.cwd(), screenshotFilePath)}`);
-        await writeFileAndDir(screenshotFilePath, currentScreenshotBuffer);
+        await saveScreenshotBuffer(testContext, currentScreenshotBuffer, screenshotFilePath);
     }
     async function writeExpectationScreenshot(contents, fileName) {
-        const filePath = testInfo.outputPath(addSuffix({ value: fileName, suffix: '.png' }));
+        const filePath = assertWrapTestContext(testContext, TestEnv.Playwright).testInfo.outputPath(addSuffix({ value: fileName, suffix: '.png' }));
         await writeFileAndDir(filePath, contents);
     }
     if (existsSync(screenshotFilePath)) {
-        if (testInfo.config.updateSnapshots === 'changed') {
+        if (testContext.testInfo.config.updateSnapshots === 'changed') {
             await writeNewScreenshot();
         }
     }
     else {
-        if (testInfo.config.updateSnapshots !== 'none') {
+        if (testContext.testInfo.config.updateSnapshots !== 'none') {
             await writeNewScreenshot();
         }
         await writeExpectationScreenshot(currentScreenshotBuffer, 'actual');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "31.50.0",
+    "version": "31.50.2",
     "description": "A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.",
     "keywords": [
         "test",
@@ -44,8 +44,8 @@
         "test:web": "virmator test --no-deps web 'src/test-web/**/*.test.ts' 'src/augments/universal-testing-suite/**/*.test.ts'"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.50.0",
-        "@augment-vir/common": "^31.50.0",
+        "@augment-vir/assert": "^31.50.2",
+        "@augment-vir/common": "^31.50.2",
         "@open-wc/testing-helpers": "^3.0.1",
         "@virmator/test": "^14.2.2",
         "type-fest": "^5.2.0"