vitest-plugin-vis 2.4.4 → 3.0.0

package/esm/server/vis_options.js

@@ -0,0 +1,14 @@
+import { assertSnapshotKeyWithoutDash } from "../shared/asserts.js";
+import { getProjectName } from "./project.js";
+const DEFAULT_PROJECT_NAME = '__default';
+const visOptions = {};
+export function setVisOption(userConfig, options) {
+    assertSnapshotKeyWithoutDash(options?.snapshotKey);
+    const name = userConfig.test?.name;
+    const id = name ?? DEFAULT_PROJECT_NAME;
+    visOptions[id] = options;
+}
+export function getVisOption(context) {
+    const id = getProjectName(context) ?? DEFAULT_PROJECT_NAME;
+    return visOptions[id] ?? {};
+}

package/esm/server/vis_server_context.d.ts

@@ -0,0 +1,50 @@
+export declare const visServerContext: {
+    getSnapshotResults(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, taskId: string): Promise<import("./commands/load_image_snapshot_results.ts").ImageSnapshotResult[]>;
+    getSnapshotInfo(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, taskId: string, options?: import("../client-api.ts").ImageSnapshotKeyOptions): Promise<{
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+        comparisonMethod: any;
+        diffOptions?: Partial<import("ssim.js").Options> | undefined;
+        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
+        failureThreshold?: number | undefined | undefined;
+        timeout?: number | undefined | undefined;
+    } | {
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+        comparisonMethod?: any;
+        diffOptions?: {
+            threshold?: number | undefined;
+            includeAA?: boolean | undefined;
+            alpha?: number | undefined;
+            aaColor?: [number, number, number] | undefined;
+            diffColor?: [number, number, number] | undefined;
+            diffColorAlt?: [number, number, number] | undefined;
+            diffMask?: boolean | undefined;
+        } | undefined;
+        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
+        failureThreshold?: number | undefined | undefined;
+        timeout?: number | undefined | undefined;
+    }>;
+    getTaskCount(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, taskId: string): Promise<number>;
+    hasImageSnapshot(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, taskId: string, snapshotKey: string | undefined): Promise<boolean>;
+    getSnapshotFilename(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, info: {
+        taskId: string;
+        task: {
+            count: number;
+        };
+    }, snapshotKey: string | undefined): string;
+    getSuiteInfo(browserContext: import("./vis_server_context.types.ts").PartialBrowserCommandContext, taskId: string): Promise<{
+        projectRoot: string;
+        suiteId: string;
+        taskId: string;
+        baselineDir: string;
+        resultDir: string;
+        diffDir: string;
+        task: {
+            count: number;
+        };
+    }>;
+};
+//# sourceMappingURL=vis_server_context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vis_server_context.d.ts","sourceRoot":"","sources":["../../src/server/vis_server_context.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA2B,CAAA"}

package/esm/server/{vis_context.ctx.d.ts → vis_server_context.deps.d.ts}

@@ -1,4 +1,4 @@
-export declare const ctx: {
+export declare const deps: {
     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;
@@ -26,4 +26,4 @@ export declare const ctx: {
     };
     getSnapshotPlatform(): NodeJS.Platform | "local";
 };
-//# sourceMappingURL=vis_context.ctx.d.ts.map
+//# sourceMappingURL=vis_server_context.deps.d.ts.map

package/esm/server/vis_server_context.deps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_server_context.deps.d.ts","sourceRoot":"","sources":["../../src/server/vis_server_context.deps.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,IAAI;;6CAOgsD,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;;;CAF5mG,CAAA"}

package/esm/server/{vis_context.ctx.js → vis_server_context.deps.js}

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

package/esm/server/vis_server_context.js

@@ -0,0 +1,2 @@
+import { createVisServerContext } from "./vis_server_context.logic.js";
+export const visServerContext = createVisServerContext();

package/esm/server/{vis_context.logic.d.ts → vis_server_context.logic.d.ts}

@@ -1,32 +1,21 @@
-import type { VisOptions } from '../config/types.ts';
-import type { PartialBrowserCommandContext, VisProjectState } from './vis_context.types.ts';
-export declare function createVisContext(): {
-    setOptions<M extends "pixel" | "ssim">(projectName: string | undefined, options?: VisOptions<M>): void;
-    __test__getOptions(projectName: string): VisOptions<any> | undefined;
-    __test__reset(): void;
-    __test__getState(context: PartialBrowserCommandContext): Promise<VisProjectState>;
-    /**
-     * 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(browserContext: PartialBrowserCommandContext): Promise<import("type-plus").Pick._<VisProjectState, "subjectDataTestId">>;
-    getSnapshotInfo(browserContext: PartialBrowserCommandContext, name: string, isAutoSnapshot: boolean, options?: {
-        snapshotFileId?: string | undefined;
-    }): Promise<{
+import type { ImageSnapshotKeyOptions } from '../client-api.ts';
+import type { ImageSnapshotResult } from './commands/load_image_snapshot_results.ts';
+import type { PartialBrowserCommandContext } from './vis_server_context.types.ts';
+export declare function createVisServerContext(): {
+    getSnapshotResults(browserContext: PartialBrowserCommandContext, taskId: string): Promise<ImageSnapshotResult[]>;
+    getSnapshotInfo(browserContext: PartialBrowserCommandContext, taskId: string, options?: ImageSnapshotKeyOptions): Promise<{
         baselinePath: string;
         resultPath: string;
         diffPath: string;
-        timeout?: number | undefined | undefined;
         comparisonMethod: any;
-        diffOptions?: Partial<import("ssim.js").Options> | undefined;
+        diffOptions?: Partial<import("ssim.js/dist/types.js").Options> | undefined;
         failureThresholdType?: "pixel" | "percent" | undefined | undefined;
         failureThreshold?: number | undefined | undefined;
+        timeout?: number | undefined | undefined;
     } | {
         baselinePath: string;
         resultPath: string;
         diffPath: string;
-        timeout?: number | undefined | undefined;
         comparisonMethod?: any;
         diffOptions?: {
             threshold?: number | undefined;
@@ -39,15 +28,16 @@ export declare function createVisContext(): {
         } | undefined;
         failureThresholdType?: "pixel" | "percent" | undefined | undefined;
         failureThreshold?: number | undefined | undefined;
+        timeout?: number | undefined | undefined;
     }>;
     getTaskCount(browserContext: PartialBrowserCommandContext, taskId: string): Promise<number>;
-    hasImageSnapshot(browserContext: PartialBrowserCommandContext, taskId: string, snapshotFileId: string | undefined, isAutoSnapshot: boolean): Promise<boolean>;
+    hasImageSnapshot(browserContext: PartialBrowserCommandContext, taskId: string, snapshotKey: string | undefined): Promise<boolean>;
     getSnapshotFilename(browserContext: PartialBrowserCommandContext, info: {
         taskId: string;
         task: {
             count: number;
         };
-    }, snapshotFileId: string | undefined, isAutoSnapshot: boolean): string;
+    }, snapshotKey: string | undefined): string;
     getSuiteInfo(browserContext: PartialBrowserCommandContext, taskId: string): Promise<{
         projectRoot: string;
         suiteId: string;
@@ -60,14 +50,4 @@ export declare function createVisContext(): {
         };
     }>;
 };
-export declare function createSuite(state: VisProjectState, testPath: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): {
-    suiteId: string;
-    suite: {
-        baselineDir: string;
-        resultDir: string;
-        diffDir: string;
-        tasks: {};
-    };
-};
-export declare function getSuiteId(state: VisProjectState, testPath: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): string;
-//# sourceMappingURL=vis_context.logic.d.ts.map
+//# sourceMappingURL=vis_server_context.logic.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vis_server_context.logic.d.ts","sourceRoot":"","sources":["../../src/server/vis_server_context.logic.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAA;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAA;AAIpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAEjF,wBAAgB,sBAAsB;uCAEK,4BAA4B,UAAU,MAAM;oCA2BpE,4BAA4B,UACpC,MAAM,YACJ,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;iCA2BC,4BAA4B,UAAU,MAAM;qCAI9D,4BAA4B,UACpC,MAAM,eACD,MAAM,GAAG,SAAS;wCASf,4BAA4B,QACtC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,eACpC,MAAM,GAAG,SAAS;iCASG,4BAA4B,UAAU,MAAM;;;;;;;;;;;EAkBhF"}

package/esm/server/vis_server_context.logic.js

@@ -0,0 +1,79 @@
+import { basename, join, resolve } from 'pathe';
+import { pick } from 'type-plus';
+import { file } from "./externals/file.js";
+import { getSuite, getTaskSubpath } from "./suite.js";
+import { getVisOption } from "./vis_options.js";
+export function createVisServerContext() {
+    const context = {
+        async getSnapshotResults(browserContext, taskId) {
+            const suiteInfo = await context.getSuiteInfo(browserContext, taskId);
+            const baselines = await file.glob(join(suiteInfo.projectRoot, suiteInfo.baselineDir, `${suiteInfo.taskId}-*.png`));
+            const results = await file.glob(join(suiteInfo.projectRoot, suiteInfo.resultDir, `${suiteInfo.taskId}-*.png`));
+            const diffs = await file.glob(join(suiteInfo.projectRoot, suiteInfo.diffDir, `${suiteInfo.taskId}-*.png`));
+            const r = [];
+            await Promise.all(baselines.map(async (baselinePath) => {
+                const filename = basename(baselinePath);
+                const resultPath = results.find((r) => r.endsWith(filename));
+                const diffPath = diffs.find((d) => d.endsWith(filename));
+                const baselineBuffer = await file.tryReadFile(baselinePath);
+                const resultBuffer = await file.tryReadFile(resultPath);
+                const diffBuffer = await file.tryReadFile(diffPath);
+                r.push({
+                    filename,
+                    baseline: baselineBuffer?.toString('base64'),
+                    result: resultBuffer?.toString('base64'),
+                    diff: diffBuffer?.toString('base64'),
+                });
+            }));
+            return r;
+        },
+        async getSnapshotInfo(browserContext, taskId, options) {
+            const suiteInfo = await context.getSuiteInfo(browserContext, taskId);
+            const snapshotFilename = context.getSnapshotFilename(browserContext, suiteInfo, options?.snapshotKey);
+            const { baselineDir, resultDir, diffDir, task } = suiteInfo;
+            task.count = task.count + 1;
+            const baselinePath = join(baselineDir, snapshotFilename);
+            const resultPath = join(resultDir, snapshotFilename);
+            const diffPath = join(diffDir, snapshotFilename);
+            return {
+                ...pick(getVisOption(browserContext), 'comparisonMethod', 'diffOptions', 'failureThreshold', 'failureThresholdType', 'timeout'),
+                baselinePath,
+                resultPath,
+                diffPath,
+            };
+        },
+        async getTaskCount(browserContext, taskId) {
+            return (await context.getSuiteInfo(browserContext, taskId)).task.count;
+        },
+        async hasImageSnapshot(browserContext, taskId, snapshotKey) {
+            const info = await context.getSuiteInfo(browserContext, taskId);
+            return file.existFile(resolve(info.projectRoot, info.baselineDir, context.getSnapshotFilename(browserContext, info, snapshotKey)));
+        },
+        getSnapshotFilename(browserContext, info, snapshotKey) {
+            if (snapshotKey)
+                return `${info.taskId}-${snapshotKey}.png`;
+            const visOptions = getVisOption(browserContext);
+            if (typeof visOptions.snapshotKey === 'string') {
+                return `${info.taskId}-${visOptions.snapshotKey}.png`;
+            }
+            return `${info.taskId}-${info.task.count}.png`;
+        },
+        async getSuiteInfo(browserContext, taskId) {
+            const projectState = await getSuite(browserContext);
+            const visOptions = getVisOption(browserContext);
+            const moduleId = getTaskSubpath(projectState, browserContext.testPath, visOptions);
+            const m = projectState.modules[moduleId];
+            const task = (m.tasks[taskId] = m.tasks[taskId] ?? { count: 1 });
+            return {
+                projectRoot: projectState.projectRoot,
+                suiteId: moduleId,
+                taskId,
+                baselineDir: m.baselineDir,
+                resultDir: m.resultDir,
+                diffDir: m.diffDir,
+                task,
+            };
+        },
+    };
+    return context;
+}

package/esm/server/{vis_context.types.d.ts → vis_server_context.types.d.ts}

@@ -1,7 +1,7 @@
-export type VisState = {
-    [projectPath: string]: Promise<VisProjectState>;
+export type VisSuites = {
+    [projectPath: string]: Promise<VisSuite>;
 };
-export type VisProjectState = {
+export type VisSuite = {
     projectRoot: string;
     testTimeout: number;
     hookTimeout: number;
@@ -10,8 +10,8 @@ export type VisProjectState = {
     snapshotResultDir: string;
     snapshotDiffDir: string;
     snapshotRootPath: string;
-    subjectDataTestId: string | undefined;
-    suites: Record<string, {
+    subject: string | undefined;
+    modules: Record<string, {
         baselineDir: string;
         resultDir: string;
         diffDir: string;
@@ -50,4 +50,4 @@ export type PartialBrowserCommandContext = {
     };
     testPath: string;
 };
-//# sourceMappingURL=vis_context.types.d.ts.map
+//# sourceMappingURL=vis_server_context.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vis_server_context.types.d.ts","sourceRoot":"","sources":["../../src/server/vis_server_context.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACvB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,iBAAiB,EAAE,MAAM,CAAA;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,OAAO,EAAE,MAAM,CACd,MAAM,EACN;QACC,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CACZ,MAAM,EACN;YACC,KAAK,EAAE,MAAM,CAAA;SACb,CACD,CAAA;KACD,CACD,CAAA;CACD,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,EAAE;QACR,MAAM,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,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;QACD,IAAI,EAAE;YACL,MAAM,EAAE;gBACP,IAAI,CAAC,EAAE;oBACN,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;iBACzB,CAAA;aACD,CAAA;SACD,CAAA;KACD,CAAA;IACD,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,OAAO,CAAC,EAAE;YACT,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;YAC9B,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;YACxC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;SACxC,CAAA;KACD,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CAChB,CAAA"}

package/esm/server/vis_server_context.types.js

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

package/esm/server-utils.d.ts

@@ -0,0 +1,3 @@
+export * from './shared/constants.ts';
+export * from './shared/trim_common_folder.ts';
+//# sourceMappingURL=server-utils.d.ts.map

package/esm/server-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-utils.d.ts","sourceRoot":"","sources":["../src/server-utils.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA"}

package/esm/server-utils.js

@@ -0,0 +1,2 @@
+export * from "./shared/constants.js";
+export * from "./shared/trim_common_folder.js";

package/esm/setup.d.ts

@@ -1,5 +1,5 @@
 import './client/expect/extend.ts';
 import './client/page/extend.ts';
-export * from './setup/vis.ts';
-export * from './setup/create_vis.ts';
+export * from './client/setup/vis.ts';
+export * from './client/setup/create_vis.ts';
 //# sourceMappingURL=setup.d.ts.map

package/esm/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AACA,OAAO,2BAA2B,CAAA;AAClC,OAAO,yBAAyB,CAAA;AAEhC,cAAc,gBAAgB,CAAA;AAI9B,cAAc,uBAAuB,CAAA"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AACA,OAAO,2BAA2B,CAAA;AAClC,OAAO,yBAAyB,CAAA;AAEhC,cAAc,uBAAuB,CAAA;AAIrC,cAAc,8BAA8B,CAAA"}

package/esm/setup.js

@@ -1,7 +1,7 @@
 // `vitest-plugin-vis/setup` provides code needed in `vitest.setup.ts`.
 import "./client/expect/extend.js";
 import "./client/page/extend.js";
-export * from "./setup/vis.js";
+export * from "./client/setup/vis.js";
 // This is exported for main/app boundary separation
 // They can co-exist in the same export file thanks to ESM.
-export * from "./setup/create_vis.js";
+export * from "./client/setup/create_vis.js";

package/esm/shared/asserts.d.ts

@@ -0,0 +1,2 @@
+export declare function assertSnapshotKeyWithoutDash(snapshotKey: string | undefined): void;
+//# sourceMappingURL=asserts.d.ts.map

package/esm/shared/asserts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asserts.d.ts","sourceRoot":"","sources":["../../src/shared/asserts.ts"],"names":[],"mappings":"AAAA,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,QAI3E"}

package/esm/shared/asserts.js

@@ -0,0 +1,5 @@
+export function assertSnapshotKeyWithoutDash(snapshotKey) {
+    if (snapshotKey?.includes('-')) {
+        throw new Error('Snapshot key cannot contain dash');
+    }
+}

package/esm/shared/types.d.ts

@@ -1,5 +1,7 @@
 import type pixelMatch from 'pixelmatch';
-import type { Options as SsimOptions } from 'ssim.js';
+import type { Options as SsimDiffOptions } from 'ssim.js';
+import type { SnapshotMeta } from '../client/snapshot_meta.ts';
+import type { NAME } from './constants.ts';
 export interface ImageSnapshotTimeoutOptions {
     /**
      * Timeout for taking the snapshot.
@@ -8,18 +10,11 @@ export interface ImageSnapshotTimeoutOptions {
      */
     timeout?: number | undefined;
 }
-export interface ImageSnapshotIdOptions {
+export interface ImageSnapshotKeyOptions {
     /**
-     * Customize the snapshot id. This is used as the filename of the snapshot: `${snapshotId}.png`
-     *
-     * @param id The id of the snapshot.
-     * @param index The index of the snapshot.
+     * Customize the `snapshotKey` of the snapshot.
      */
-    customizeSnapshotId?: (context: {
-        id: string;
-        index: number;
-        isAutoSnapshot: boolean;
-    }) => string;
+    snapshotKey?: string | undefined;
 }
 export type ComparisonMethod = 'pixel' | 'ssim';
 export type FailureThresholdOptions = {
@@ -41,34 +36,40 @@ export type SsimComparisonOptions<M = 'ssim'> = {
     /**
      * Custom options passed to 'ssim'
      */
-    diffOptions?: Partial<SsimOptions> | undefined;
+    diffOptions?: Partial<SsimDiffOptions> | undefined;
 };
+export type { SsimDiffOptions };
 export type PixelComparisonOptions<M = 'pixel'> = {
     comparisonMethod?: M | undefined;
     /**
      * Custom options passed to 'pixelmatch'
      */
-    diffOptions?: Parameters<typeof pixelMatch>[5] | undefined;
+    diffOptions?: PixelDiffOptions | undefined;
 };
+export type PixelDiffOptions = Parameters<typeof pixelMatch>[5];
 export type ImageSnapshotCompareOptions<M extends ComparisonMethod = 'pixel'> = (M extends 'ssim' ? SsimComparisonOptions<M> : PixelComparisonOptions<M>) & FailureThresholdOptions;
-export type AutoSnapshotOptions = {
+export type ImageSnapshotSubjectOptions = {
     /**
-     * Specify the data-testid of the subject element. Default is `subject`.
+     * Specify the query of the subject element.
      *
-     * If the test does not have an element with the specified data-testid,
+     * If the test does not have an element with the specified query,
      * the `body` element will be used.
      */
-    subjectDataTestId?: string | undefined;
+    subject?: string | undefined;
 };
-export type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & ImageSnapshotCompareOptions<M> & {
+export type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotKeyOptions & ImageSnapshotCompareOptions<M> & {
     /**
      * Expect the matcher to fail.
      * If it passes, it will throw an error with details.
      */
     expectToFail?: boolean | undefined;
 };
-export type SnapshotMeta<M extends ComparisonMethod> = ToMatchImageSnapshotOptions<M> & AutoSnapshotOptions & {
-    enable?: boolean | undefined;
-    [key: string]: unknown;
+export interface PageImageSnapshotOptions {
+    fullPage?: boolean | undefined;
+}
+export type SnapshotTestMeta = {
+    meta: {
+        [NAME]?: SnapshotMeta<ComparisonMethod>;
+    };
 };
 //# sourceMappingURL=types.d.ts.map

package/esm/shared/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,SAAS,CAAA;AAIrD,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACtC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE;QAC/B,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,cAAc,EAAE,OAAO,CAAA;KACvB,KAAK,MAAM,CAAA;CACZ;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAA;AAE/C,MAAM,MAAM,uBAAuB,GAAG;IACrC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,MAAM,IAAI;IAC/C,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;CAC9C,CAAA;AACD,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IACjD,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAA;CAC1D,CAAA;AAED,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,MAAM,GAC9F,qBAAqB,CAAC,CAAC,CAAC,GACxB,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC5B,uBAAuB,CAAA;AAExB,MAAM,MAAM,mBAAmB,GAAG;IACjC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC,CAAA;AACD,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,2BAA2B,GAC1G,sBAAsB,GACtB,2BAA2B,CAAC,CAAC,CAAC,GAAG;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAClC,CAAA;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,IAAI,2BAA2B,CAAC,CAAC,CAAC,GACpF,mBAAmB,GAAG;IACrB,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,SAAS,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAChC;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAA;AAE/C,MAAM,MAAM,uBAAuB,GAAG;IACrC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,MAAM,IAAI;IAC/C,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;CAClD,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,CAAA;AAE/B,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IACjD,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/D,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,MAAM,GAC9F,qBAAqB,CAAC,CAAC,CAAC,GACxB,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC5B,uBAAuB,CAAA;AAExB,MAAM,MAAM,2BAA2B,GAAG;IACzC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B,CAAA;AACD,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,2BAA2B,GAC1G,uBAAuB,GACvB,2BAA2B,CAAC,CAAC,CAAC,GAAG;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAClC,CAAA;AAEF,MAAM,WAAW,wBAAwB;IACxC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC9B;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE;QACL,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAA;KACvC,CAAA;CACD,CAAA"}

package/esm/testing/stubBrowserCommandContext.d.ts

@@ -1,5 +1,5 @@
 import type { BrowserCommandContext } from 'vitest/node';
-import type { PartialBrowserCommandContext } from '../server/vis_context.types.ts';
+import type { PartialBrowserCommandContext } from '../server/vis_server_context.types.ts';
 export declare const stubBrowserCommandContext: (stub?: import("type-plus").RecursivePartial<BrowserCommandContext> | undefined) => BrowserCommandContext;
 export declare function createStubPartialBrowserCommandContext({ root, testPath }: {
     root: string;

package/esm/testing/stubBrowserCommandContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stubBrowserCommandContext.d.ts","sourceRoot":"","sources":["../../src/testing/stubBrowserCommandContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAElF,eAAO,MAAM,yBAAyB,2GAAwC,CAAA;AAE9E,wBAAgB,sCAAsC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,2HAmB5G"}
+{"version":3,"file":"stubBrowserCommandContext.d.ts","sourceRoot":"","sources":["../../src/testing/stubBrowserCommandContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAA;AAEzF,eAAO,MAAM,yBAAyB,2GAAwC,CAAA;AAE9E,wBAAgB,sCAAsC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,2HAS5G"}

package/esm/testing/stubBrowserCommandContext.js

@@ -3,20 +3,10 @@ export const stubBrowserCommandContext = stub.build({});
 export function createStubPartialBrowserCommandContext({ root, testPath }) {
     return stub.build({
         project: {
-            config: {
-                root,
-            },
-            vite: {
-                config: {
-                    test: {
-                        name: 'subject',
-                    },
-                },
-            },
-        },
-        provider: {
-            options: {},
+            config: { root },
+            vite: { config: { test: { name: 'subject' } } },
         },
+        provider: { options: {} },
         testPath,
     });
 }

package/esm/testing/stubSuite.d.ts

@@ -0,0 +1,10 @@
+import { type RecursivePartial } from 'type-plus';
+import type { UserConfig } from 'vite';
+import type { BrowserCommandContext } from 'vitest/node';
+export declare function stubSuite(partialUserConfig?: RecursivePartial<UserConfig>, partialBrowserCommandContext?: RecursivePartial<BrowserCommandContext>): {
+    userConfig: UserConfig & {
+        configFile: string;
+    };
+    browserCommandContext: BrowserCommandContext;
+};
+//# sourceMappingURL=stubSuite.d.ts.map

package/esm/testing/stubSuite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubSuite.d.ts","sourceRoot":"","sources":["../../src/testing/stubSuite.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AACtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAIxD,wBAAgB,SAAS,CACxB,iBAAiB,GAAE,gBAAgB,CAAC,UAAU,CAAM,EACpD,4BAA4B,GAAE,gBAAgB,CAAC,qBAAqB,CAAM;;;;;EA4B1E"}

package/esm/testing/stubSuite.js

@@ -0,0 +1,27 @@
+import { resolve } from 'pathe';
+import { requiredDeep } from 'type-plus';
+import { stubBrowserCommandContext } from "./stubBrowserCommandContext.js";
+import { stubUserConfig } from "./stubUserConfig.js";
+export function stubSuite(partialUserConfig = {}, partialBrowserCommandContext = {}) {
+    const root = resolve(import.meta.dirname, '../..');
+    const userConfig = stubUserConfig({
+        root,
+        ...partialUserConfig,
+    });
+    const browserCommandContext = stubBrowserCommandContext(requiredDeep({
+        project: {
+            config: { root },
+            vite: {
+                config: {
+                    test: {
+                        name: partialUserConfig.test?.name,
+                    },
+                },
+            },
+        },
+    }, partialBrowserCommandContext));
+    return {
+        userConfig,
+        browserCommandContext,
+    };
+}

package/esm/testing/stubUserConfig.d.ts

@@ -0,0 +1,7 @@
+import type { UserConfig } from 'vite';
+export declare const stubUserConfig: (stub?: import("type-plus").RecursivePartial<UserConfig & {
+    configFile: string;
+}> | undefined) => UserConfig & {
+    configFile: string;
+};
+//# sourceMappingURL=stubUserConfig.d.ts.map

package/esm/testing/stubUserConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubUserConfig.d.ts","sourceRoot":"","sources":["../../src/testing/stubUserConfig.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEtC,eAAO,MAAM,cAAc;gBAAyC,MAAM;;gBAAN,MAAM;CAEvE,CAAA"}

package/esm/testing/stubUserConfig.js

@@ -0,0 +1,4 @@
+import { stub } from 'type-plus';
+export const stubUserConfig = stub.build((stub) => ({
+    ...stub,
+}));