vitest-plugin-vis 1.0.0

package/esm/presets/auto.js

@@ -0,0 +1,3 @@
+import 'vitest-browser-react';
+import { vis } from "../setup/vis.js";
+vis.presets.auto();

package/esm/presets/manual.d.ts

@@ -0,0 +1,2 @@
+import 'vitest-browser-react';
+//# sourceMappingURL=manual.d.ts.map

package/esm/presets/manual.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual.d.ts","sourceRoot":"","sources":["../../src/presets/manual.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAA"}

package/esm/presets/manual.js

@@ -0,0 +1,3 @@
+import 'vitest-browser-react';
+import { vis } from "../setup/vis.js";
+vis.presets.manual();

package/esm/server/browser_provider/browser_api.d.ts

@@ -0,0 +1,3 @@
+import type { BrowserCommandContext } from 'vitest/node';
+export declare function browserApi(context: BrowserCommandContext): import("./types.ts").BrowserApi;
+//# sourceMappingURL=browser_api.d.ts.map

package/esm/server/browser_provider/browser_api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser_api.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/browser_api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAIxD,wBAAgB,UAAU,CAAC,OAAO,EAAE,qBAAqB,mCAQxD"}

package/esm/server/browser_provider/browser_api.js

@@ -0,0 +1,11 @@
+import { playwright } from "./playwright.js";
+import { webdriverio } from "./webdriverio.js";
+export function browserApi(context) {
+    if (context.provider.name === 'playwright') {
+        return playwright(context);
+    }
+    if (context.provider.name === 'webdriverio') {
+        return webdriverio(context);
+    }
+    throw new Error(`Unsupported provider: ${context.provider.name}`);
+}

package/esm/server/browser_provider/playwright.d.ts

@@ -0,0 +1,4 @@
+import type { BrowserCommandContext } from 'vitest/node';
+import type { BrowserApi } from './types.ts';
+export declare function playwright(context: BrowserCommandContext): BrowserApi;
+//# sourceMappingURL=playwright.d.ts.map

package/esm/server/browser_provider/playwright.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/playwright.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,wBAAgB,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,CAYrE"}

package/esm/server/browser_provider/playwright.js

@@ -0,0 +1,13 @@
+export function playwright(context) {
+    return {
+        async takeScreenshot(filePath, selector, options) {
+            // The `Locator` type from `vitest` has less props than the `Locator` in `playwright`
+            const subject = context.iframe.locator(selector ?? 'body');
+            const buffer = await subject.screenshot({
+                timeout: options?.timeout,
+                path: filePath,
+            });
+            return buffer.toString('base64');
+        },
+    };
+}

package/esm/server/browser_provider/types.d.ts

@@ -0,0 +1,6 @@
+export interface BrowserApi {
+    takeScreenshot(filePath: string, selector: string, options: {
+        timeout?: number | undefined;
+    } | undefined): Promise<string>;
+}
+//# sourceMappingURL=types.d.ts.map

package/esm/server/browser_provider/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IAC1B,cAAc,CACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EACJ;QACA,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GACD,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;CAClB"}

package/esm/server/browser_provider/types.js

@@ -0,0 +1 @@
+export {};

package/esm/server/browser_provider/webdriverio.d.ts

@@ -0,0 +1,4 @@
+import type { BrowserCommandContext } from 'vitest/node';
+import type { BrowserApi } from './types.ts';
+export declare function webdriverio(context: BrowserCommandContext): BrowserApi;
+//# sourceMappingURL=webdriverio.d.ts.map

package/esm/server/browser_provider/webdriverio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webdriverio.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/webdriverio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,wBAAgB,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,CAStE"}

package/esm/server/browser_provider/webdriverio.js

@@ -0,0 +1,10 @@
+export function webdriverio(context) {
+    const page = context.provider.browser;
+    return {
+        async takeScreenshot(filePath, selector) {
+            const element = await page.$(`${selector ?? 'body'}`);
+            const buffer = await element.saveScreenshot(filePath);
+            return buffer.toString('base64');
+        },
+    };
+}

package/esm/server/commands/extend.d.ts

@@ -0,0 +1,15 @@
+import { type HasImageSnapshotCommand } from './has_image_snapshot.ts';
+import { type ImageSnapshotNextIndexCommand } from './image_snapshot_next_index.ts';
+import { type MatchImageSnapshotCommand } from './match_image_snapshot.ts';
+import { type SetupVisSuiteCommand } from './setup_vis_suite.ts';
+declare module '@vitest/browser/context' {
+    interface BrowserCommands extends SetupVisSuiteCommand, ImageSnapshotNextIndexCommand, HasImageSnapshotCommand, MatchImageSnapshotCommand {
+    }
+}
+export declare const commands: {
+    setupVisSuite: import("vitest/node").BrowserCommand<[]>;
+    imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
+    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotId?: string | undefined]>;
+    matchImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("./match_image_snapshot.ts").MatchImageSnapshotOptions | undefined]>;
+};
+//# sourceMappingURL=extend.d.ts.map

package/esm/server/commands/extend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extend.d.ts","sourceRoot":"","sources":["../../../src/server/commands/extend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,EAAoB,MAAM,yBAAyB,CAAA;AACxF,OAAO,EAAE,KAAK,6BAA6B,EAA0B,MAAM,gCAAgC,CAAA;AAC3G,OAAO,EAAE,KAAK,yBAAyB,EAAsB,MAAM,2BAA2B,CAAA;AAC9F,OAAO,EAAE,KAAK,oBAAoB,EAAiB,MAAM,sBAAsB,CAAA;AAE/E,OAAO,QAAQ,yBAAyB,CAAC;IACxC,UAAU,eACT,SAAQ,oBAAoB,EAC3B,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB;KAAG;CAC9B;AAED,eAAO,MAAM,QAAQ;;;;;CAKpB,CAAA"}

package/esm/server/commands/extend.js

@@ -0,0 +1,10 @@
+import { hasImageSnapshot } from "./has_image_snapshot.js";
+import { imageSnapshotNextIndex } from "./image_snapshot_next_index.js";
+import { matchImageSnapshot } from "./match_image_snapshot.js";
+import { setupVisSuite } from "./setup_vis_suite.js";
+export const commands = {
+    setupVisSuite,
+    imageSnapshotNextIndex,
+    hasImageSnapshot,
+    matchImageSnapshot,
+};

package/esm/server/commands/has_image_snapshot.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserCommand } from 'vitest/node';
+export interface HasImageSnapshotCommand {
+    hasImageSnapshot(taskId: string, snapshotId?: string | undefined): Promise<boolean>;
+}
+export declare const hasImageSnapshot: BrowserCommand<[taskId: string, snapshotId?: string | undefined]>;
+//# sourceMappingURL=has_image_snapshot.d.ts.map

package/esm/server/commands/has_image_snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/server/commands/has_image_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGjD,MAAM,WAAW,uBAAuB;IACvC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnF;AAED,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,CAU9F,CAAA"}

package/esm/server/commands/has_image_snapshot.js

@@ -0,0 +1,7 @@
+import { visContext } from "../vis_context.js";
+export const hasImageSnapshot = async (context, taskId, snapshotId) => {
+    if (!context.testPath) {
+        throw new Error('Cannot take snapshot without testPath');
+    }
+    return visContext.hasImageSnapshot(context.testPath, taskId, snapshotId);
+};

package/esm/server/commands/image_snapshot_next_index.d.ts

@@ -0,0 +1,9 @@
+import type { BrowserCommand } from 'vitest/node';
+export interface ImageSnapshotNextIndexCommand {
+    /**
+     * Get the index of the snapshot image to be created.
+     */
+    imageSnapshotNextIndex(taskId: string): Promise<number>;
+}
+export declare const imageSnapshotNextIndex: BrowserCommand<[taskId: string]>;
+//# sourceMappingURL=image_snapshot_next_index.d.ts.map

package/esm/server/commands/image_snapshot_next_index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image_snapshot_next_index.d.ts","sourceRoot":"","sources":["../../../src/server/commands/image_snapshot_next_index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGjD,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACvD;AAED,eAAO,MAAM,sBAAsB,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAMnE,CAAA"}

package/esm/server/commands/image_snapshot_next_index.js

@@ -0,0 +1,7 @@
+import { visContext } from "../vis_context.js";
+export const imageSnapshotNextIndex = async (context, taskId) => {
+    if (!context.testPath) {
+        throw new Error('Cannot take snapshot without testPath');
+    }
+    return visContext.getTaskCount(context.testPath, taskId);
+};

package/esm/server/commands/is_ci.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=is_ci.d.ts.map

package/esm/server/commands/is_ci.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is_ci.d.ts","sourceRoot":"","sources":["../../../src/server/commands/is_ci.ts"],"names":[],"mappings":""}

package/esm/server/commands/is_ci.js

@@ -0,0 +1,6 @@
+// import ci from 'is-ci'
+export {};
+// export interface IsCICommand {
+// 	isCI: () => Promise<boolean>
+// }
+// export const isCI = async () => ci

package/esm/server/commands/match_image_snapshot.d.ts

@@ -0,0 +1,17 @@
+import type { BrowserCommand } from 'vitest/node';
+import type { ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
+export interface MatchImageSnapshotCommand {
+    matchImageSnapshot: (taskId: string | undefined, subject: string, options?: MatchImageSnapshotOptions | undefined) => Promise<void>;
+}
+export interface MatchImageSnapshotOptions extends ImageSnapshotTimeoutOptions, ImageSnapshotIdOptions, ImageSnapshotCompareOptions {
+    /**
+     * The snapshot file id calculated on the client side.
+     */
+    snapshotFileId?: string | undefined;
+}
+export declare const matchImageSnapshot: BrowserCommand<[
+    taskId: string,
+    subject: string,
+    options?: MatchImageSnapshotOptions | undefined
+]>;
+//# sourceMappingURL=match_image_snapshot.d.ts.map

package/esm/server/commands/match_image_snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/server/commands/match_image_snapshot.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAyB,MAAM,aAAa,CAAA;AAIxE,OAAO,KAAK,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAM9B,MAAM,WAAW,yBAAyB;IACzC,kBAAkB,EAAE,CACnB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,IAAI,CAAC,CAAA;CAClB;AAED,MAAM,WAAW,yBAChB,SAAQ,2BAA2B,EAClC,sBAAsB,EACtB,2BAA2B;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC;AAED,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAC9C;IAAC,MAAM,EAAE,MAAM;IAAE,OAAO,EAAE,MAAM;IAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CA2DlF,CAAA"}

package/esm/server/commands/match_image_snapshot.js

@@ -0,0 +1,88 @@
+import dedent from 'dedent';
+import ci from 'is-ci';
+import { mkdirp } from 'mkdirp';
+import { dirname, resolve } from 'pathe';
+import { PNG } from 'pngjs';
+import { isBase64String } from "../../shared/base64.js";
+import { getMaxSize } from "../../shared/get_max_size.js";
+import { isSameSize } from "../../shared/is_same_size.js";
+import { browserApi } from "../browser_provider/browser_api.js";
+import { compareImage } from "../compare_image.js";
+import { file } from "../file.js";
+import { visContext } from "../vis_context.js";
+export const matchImageSnapshot = async (context, taskId, subject, options) => {
+    if (!context.testPath) {
+        throw new Error('Cannot match snapshot without testPath');
+    }
+    // vitest:browser passes in `null` when not defined
+    if (!options)
+        options = {};
+    options.timeout = options.timeout ?? (ci ? 30000 : 5000);
+    const info = visContext.getSnapshotInfo(context.testPath, taskId, options);
+    const baselineBase64 = await file.tryReadFileBase64(info.baselinePath);
+    if (!baselineBase64) {
+        await takeSnapshot(context, subject, info.baselinePath, options);
+        return;
+    }
+    const resultBase64 = await takeSnapshot(context, subject, info.resultPath, options);
+    const baselineImage = PNG.sync.read(Buffer.from(baselineBase64, 'base64'));
+    const resultImage = PNG.sync.read(Buffer.from(resultBase64, 'base64'));
+    const [baselineAlignedImage, resultAlignedImage] = isSameSize(baselineImage, resultImage)
+        ? [baselineImage, resultImage]
+        : alignImageSizes(baselineImage, resultImage);
+    const { pass, diffAmount, diffImage } = compareImage(baselineAlignedImage, resultAlignedImage, options);
+    if (pass) {
+        if (sizeNotChanged(baselineImage, baselineAlignedImage)) {
+            return;
+        }
+        throw new Error(dedent `Snapshot \`${taskId}\` mismatched
+
+				The image size changed form ${baselineImage.width}x${baselineImage.height} to ${resultImage.width}x${resultImage.height}
+
+				Expected:   ${resolve(context.project.runner.root, info.baselinePath)}
+				Actual:     ${resolve(context.project.runner.root, info.resultPath)}`);
+    }
+    const diffBase64 = PNG.sync.write(diffImage).toString('base64');
+    await writeSnapshot(diffBase64, info.diffPath);
+    throw new Error(dedent `Snapshot \`${taskId}\` mismatched
+
+			${options?.failureThreshold
+        ? options?.failureThresholdType === 'percent'
+            ? `Expected image to match within ${options.failureThreshold}% but was differ by ${diffAmount}%.`
+            : `Expected image to match within ${options.failureThreshold} pixels but was differ by ${diffAmount} pixels.`
+        : `Expected image to match but was differ by ${options?.failureThresholdType === 'percent' ? `${diffAmount}%` : `${diffAmount} pixels`}.`}
+
+			Options:    ${JSON.stringify(options)}
+
+			Expected:   ${resolve(context.project.runner.root, info.baselinePath)}
+			Actual:     ${resolve(context.project.runner.root, info.resultPath)}
+			Difference: ${resolve(context.project.runner.root, info.diffPath)}`);
+};
+async function takeSnapshot(context, subject, filePath, options) {
+    if (isBase64String(subject)) {
+        return writeSnapshot(subject, filePath);
+    }
+    await mkdirp(dirname(filePath));
+    const browser = browserApi(context);
+    return browser.takeScreenshot(filePath, subject, {
+        timeout: options?.timeout,
+    });
+}
+async function writeSnapshot(subject, filePath) {
+    await mkdirp(dirname(filePath));
+    await file.writeFileBase64(filePath, subject);
+    return subject;
+}
+function alignImageSizes(baseline, result) {
+    const size = getMaxSize(baseline, result);
+    const baselineAligned = new PNG(size);
+    const resultAligned = new PNG(size);
+    baselineAligned.data.fill(0);
+    resultAligned.data.fill(0);
+    PNG.bitblt(baseline, baselineAligned, 0, 0, baseline.width, baseline.height);
+    PNG.bitblt(result, resultAligned, 0, 0, result.width, result.height);
+    return [baselineAligned, resultAligned];
+}
+function sizeNotChanged(baselineImage, baselineAlignedImage) {
+    return baselineImage === baselineAlignedImage;
+}

package/esm/server/commands/setup_vis_suite.d.ts

@@ -0,0 +1,13 @@
+import type { BrowserCommand } from 'vitest/node';
+export interface SetupVisSuiteCommand {
+    /**
+     * Sets up the visual testing suite by cleaning up previous snapshot and diff output directories.
+     * When this command is run for the first time,
+     * it will remove the results and diffs directory of all suites.
+     *
+     * In subsequent runs, it will only remove the results and diffs directory of the current suite.
+     */
+    setupVisSuite: () => Promise<void>;
+}
+export declare const setupVisSuite: BrowserCommand<[]>;
+//# sourceMappingURL=setup_vis_suite.d.ts.map

package/esm/server/commands/setup_vis_suite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup_vis_suite.d.ts","sourceRoot":"","sources":["../../../src/server/commands/setup_vis_suite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGjD,MAAM,WAAW,oBAAoB;IACpC;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAClC;AAED,eAAO,MAAM,aAAa,EAAE,cAAc,CAAC,EAAE,CAE5C,CAAA"}

package/esm/server/commands/setup_vis_suite.js

@@ -0,0 +1,4 @@
+import { visContext } from "../vis_context.js";
+export const setupVisSuite = async (context) => {
+    await visContext.setupSuite(context);
+};

package/esm/server/compare_image.d.ts

@@ -0,0 +1,8 @@
+import { PNG } from 'pngjs';
+import type { ImageSnapshotCompareOptions } from '../shared/types.ts';
+export declare function compareImage(baselineImage: PNG, resultImage: PNG, { failureThreshold, failureThresholdType, diffOptions }?: ImageSnapshotCompareOptions): {
+    pass: boolean;
+    diffAmount: number;
+    diffImage: PNG;
+};
+//# sourceMappingURL=compare_image.d.ts.map

package/esm/server/compare_image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare_image.d.ts","sourceRoot":"","sources":["../../src/server/compare_image.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAE3B,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAErE,wBAAgB,YAAY,CAC3B,aAAa,EAAE,GAAG,EAClB,WAAW,EAAE,GAAG,EAChB,EAAE,gBAAoB,EAAE,oBAA8B,EAAE,WAAW,EAAE,GAAE,2BAAgC;;;;EAyBvG"}

package/esm/server/compare_image.js

@@ -0,0 +1,16 @@
+import pixelmatch from 'pixelmatch';
+import { PNG } from 'pngjs';
+import { convertThresholdUnit } from "../shared/convert_threshold_unit.js";
+export function compareImage(baselineImage, resultImage, { failureThreshold = 0, failureThresholdType = 'pixel', diffOptions } = {}) {
+    const diffImage = new PNG({
+        width: baselineImage.width,
+        height: baselineImage.height,
+    });
+    const pixelDiff = pixelmatch(resultImage.data, baselineImage.data, diffImage.data, baselineImage.width, baselineImage.height, diffOptions);
+    const diffAmount = convertThresholdUnit({ failureThresholdType, width: baselineImage.width, height: baselineImage.height }, pixelDiff);
+    return {
+        pass: diffAmount <= failureThreshold,
+        diffAmount,
+        diffImage,
+    };
+}

package/esm/server/file.d.ts

@@ -0,0 +1,6 @@
+export declare const file: {
+    tryReadFileBase64(filePath: string): Promise<string | undefined>;
+    writeFileBase64(filePath: string, data: string): Promise<void>;
+    existFile(filePath: string): Promise<boolean>;
+};
+//# sourceMappingURL=file.d.ts.map

package/esm/server/file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/server/file.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,IAAI;gCACkB,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;8BAG5C,MAAM,QAAQ,MAAM;wBAG1B,MAAM;CAK1B,CAAA"}

package/esm/server/file.js

@@ -0,0 +1,14 @@
+import { readFile, stat, writeFile } from 'node:fs/promises';
+export const file = {
+    async tryReadFileBase64(filePath) {
+        return readFile(filePath, { encoding: 'base64' }).catch(() => undefined);
+    },
+    writeFileBase64(filePath, data) {
+        return writeFile(filePath, data, { encoding: 'base64' });
+    },
+    existFile(filePath) {
+        return stat(filePath)
+            .then((s) => s.isFile())
+            .catch(() => false);
+    },
+};

package/esm/server/snapshot_path.d.ts

@@ -0,0 +1,4 @@
+import type { VisOptions } from '../config/types.ts';
+export declare function resolveSnapshotRootDir(options: VisOptions | undefined): string;
+export declare function getSnapshotSubpath(suiteName: string, options: VisOptions): string;
+//# sourceMappingURL=snapshot_path.d.ts.map

package/esm/server/snapshot_path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot_path.d.ts","sourceRoot":"","sources":["../../src/server/snapshot_path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAIpD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,UAErE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,UAGxE"}

package/esm/server/snapshot_path.js

@@ -0,0 +1,9 @@
+import { SNAPSHOT_ROOT_DIR } from "../shared/constants.js";
+import { trimCommonFolder } from "../shared/trim_common_folder.js";
+export function resolveSnapshotRootDir(options) {
+    return options?.snapshotRootDir ?? SNAPSHOT_ROOT_DIR;
+}
+export function getSnapshotSubpath(suiteName, options) {
+    const customizeSnapshotSubpath = options.customizeSnapshotSubpath ?? trimCommonFolder;
+    return customizeSnapshotSubpath(suiteName);
+}

package/esm/server/vis_context.ctx.d.ts

@@ -0,0 +1,29 @@
+export declare const ctx: {
+    rimraf: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+        rimraf: (path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>;
+        sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        rimrafSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        manual: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+            sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        };
+        manualSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        native: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+            sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        };
+        nativeSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        posix: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+            sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        };
+        posixSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        windows: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+            sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        };
+        windowsSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        moveRemove: ((path: string | string[], opt?: import("rimraf").RimrafAsyncOptions) => Promise<boolean>) & {
+            sync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+        };
+        moveRemoveSync: (path: string | string[], opt?: import("rimraf").RimrafSyncOptions) => boolean;
+    };
+    getSnapshotPlatform(): NodeJS.Platform | "local";
+};
+//# sourceMappingURL=vis_context.ctx.d.ts.map

package/esm/server/vis_context.ctx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_context.ctx.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.ctx.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,GAAG;;6CAQ2qD,CAAC;2CAAkF,CAAC;iDAA8E,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;6CAA0E,CAAC;+CAA0F,CAAC;;gDAAoF,CAAC;+CAA4E,CAAC;+CAA0F,CAAC;;kDAAsF,CAAC;kDAA+E,CAAC;+CAA0F,CAAC;;qDAAyF,CAAC;;;CAFtlG,CAAA"}

package/esm/server/vis_context.ctx.js

@@ -0,0 +1,11 @@
+/* v8 ignore start */
+import ci from 'is-ci';
+import { rimraf } from 'rimraf';
+export const ctx = {
+    rimraf,
+    getSnapshotPlatform() {
+        /* v8 ignore next */
+        return ci ? process.platform : 'local';
+    },
+};
+/* v8 ignore end */

package/esm/server/vis_context.d.ts

@@ -0,0 +1,33 @@
+export declare const visContext: {
+    setOptions(options?: import("../config.ts").VisOptions): void;
+    __test__getOptions(): import("../config.ts").VisOptions;
+    __test__reset(): void;
+    __test__getState(): import("./vis_context.types.ts").VisState;
+    setupSuite(context: import("./vis_context.logic.ts").PartialBrowserCommandContext): Promise<void>;
+    getSnapshotInfo(testPath: string, name: string, options?: {
+        snapshotFileId?: string | undefined;
+    }): {
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+    };
+    getTaskCount(testPath: string, taskId: string): number;
+    hasImageSnapshot(testPath: string, taskId: string, snapshotFileId: string | undefined): Promise<boolean>;
+    getSnapshotFilename(info: {
+        taskId: string;
+        task: {
+            count: number;
+        };
+    }, snapshotFileId: string | undefined): string;
+    getSuiteInfo(testPath: string, taskId: string): {
+        suiteId: string;
+        taskId: string;
+        baselineDir: string;
+        resultDir: string;
+        diffDir: string;
+        task: {
+            count: number;
+        };
+    };
+};
+//# sourceMappingURL=vis_context.d.ts.map

package/esm/server/vis_context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_context.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU;;;;;;;sBAC4iD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CADxhD,CAAA"}

package/esm/server/vis_context.js

@@ -0,0 +1,2 @@
+import { createVisContext } from "./vis_context.logic.js";
+export const visContext = createVisContext();

package/esm/server/vis_context.logic.d.ts

@@ -0,0 +1,63 @@
+import type { VisOptions } from '../config/types.ts';
+import type { VisState } from './vis_context.types.ts';
+export type PartialBrowserCommandContext = {
+    project: {
+        config: {
+            root: string;
+            snapshotOptions: {
+                updateSnapshot: 'all' | 'new' | 'none';
+            };
+            testTimeout: number;
+            hookTimeout: number;
+        };
+    };
+    testPath: string | undefined;
+};
+export declare function createVisContext(): {
+    setOptions(options?: VisOptions): void;
+    __test__getOptions(): VisOptions;
+    __test__reset(): void;
+    __test__getState(): VisState;
+    /**
+     * Setup suite is called on each test file's beforeAll hook.
+     * Test files include vitest test files and storybook story files.
+     * It needs to make sure there is no race condition between the test files.
+     */
+    setupSuite(context: PartialBrowserCommandContext): Promise<void>;
+    getSnapshotInfo(testPath: string, name: string, options?: {
+        snapshotFileId?: string | undefined;
+    }): {
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+    };
+    getTaskCount(testPath: string, taskId: string): number;
+    hasImageSnapshot(testPath: string, taskId: string, snapshotFileId: string | undefined): Promise<boolean>;
+    getSnapshotFilename(info: {
+        taskId: string;
+        task: {
+            count: number;
+        };
+    }, snapshotFileId: string | undefined): string;
+    getSuiteInfo(testPath: string, taskId: string): {
+        suiteId: string;
+        taskId: string;
+        baselineDir: string;
+        resultDir: string;
+        diffDir: string;
+        task: {
+            count: number;
+        };
+    };
+};
+export declare function getSuiteId(state: VisState, testPath: string, options: VisOptions): string;
+export declare function createSuite(state: VisState, testPath: string, options: VisOptions): {
+    suiteId: string;
+    suite: {
+        baselineDir: string;
+        resultDir: string;
+        diffDir: string;
+        tasks: {};
+    };
+};
+//# sourceMappingURL=vis_context.logic.d.ts.map

package/esm/server/vis_context.logic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_context.logic.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.logic.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAKpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAEtD,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,EAAE;QACR,MAAM,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,eAAe,EAAE;gBAChB,cAAc,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;aACtC,CAAA;YACD,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,MAAM,CAAA;SACnB,CAAA;KACD,CAAA;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B,CAAA;AAED,wBAAgB,gBAAgB;yBAMV,UAAU;;;;IAY9B;;;;OAIG;wBACuB,4BAA4B;8BAY5B,MAAM,QAAQ,MAAM,YAAY;QAAE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;;;;;2BAiB1E,MAAM,UAAU,MAAM;+BAGlB,MAAM,UAAU,MAAM,kBAAkB,MAAM,GAAG,SAAS;8BAI3D;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,kBAAkB,MAAM,GAAG,SAAS;2BAMlF,MAAM,UAAU,MAAM;;;;;;;;;;EAe9C;AAuBD,wBAAgB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,UAEhF;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;;;;;;;;EAWjF"}