vitest-plugin-vis 2.4.3 → 3.0.0

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

@@ -0,0 +1,21 @@
+import type { BrowserCommand } from 'vitest/node';
+export interface ImageSnapshotResult {
+    filename: string;
+    /**
+     * The base64 encoded image of the baseline snapshot.
+     */
+    baseline?: string | undefined;
+    /**
+     * The base64 encoded image of the result snapshot.
+     */
+    result?: string | undefined;
+    /**
+     * The base64 encoded image of the diff snapshot.
+     */
+    diff?: string | undefined;
+}
+export interface LoadImageSnapshotResultsCommand {
+    loadImageSnapshotResults(taskId: string): Promise<ImageSnapshotResult[]>;
+}
+export declare const loadImageSnapshotResults: BrowserCommand<[taskId: string]>;
+//# sourceMappingURL=load_image_snapshot_results.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"load_image_snapshot_results.d.ts","sourceRoot":"","sources":["../../../src/server/commands/load_image_snapshot_results.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD,MAAM,WAAW,mBAAmB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB;AAED,MAAM,WAAW,+BAA+B;IAC/C,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;CACxE;AAED,eAAO,MAAM,wBAAwB,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAOrE,CAAA"}

package/esm/server/commands/load_image_snapshot_results.js

@@ -0,0 +1,6 @@
+import { visServerContext } from "../vis_server_context.js";
+import { assertTestPathDefined } from "./_assertions.js";
+export const loadImageSnapshotResults = async (context, taskId) => {
+    assertTestPathDefined(context, 'loadImageSnapshotResults');
+    return visServerContext.getSnapshotResults(context, taskId);
+};

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

@@ -1,7 +1,7 @@
 import type { BrowserCommand } from 'vitest/node';
 import type { FailureThresholdOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions } from '../../shared/types.ts';
-import type { MatchImageSnapshotOptions } from './match_image_snapshot.ts';
-type ImageSnapshotComparisonInfo = {
+import type { MatchImageSnapshotOptions } from './types.ts';
+export type ImageSnapshotComparisonInfo = {
     /**
      * Path to the project root.
      */
@@ -26,15 +26,13 @@ type ImageSnapshotComparisonInfo = {
      * Base64 encoded result image.
      */
     result: string;
+    /**
+     * Base64 encoded diff image.
+     */
+    diff?: string | undefined;
 } & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
 export interface PrepareImageSnapshotComparisonCommand {
-    prepareImageSnapshotComparison: (taskId: string | undefined, subject: string, isAutoSnapshot: boolean, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
+    prepareImageSnapshotComparison: (taskId: string, subject: string, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
 }
-export declare const prepareImageSnapshotComparison: BrowserCommand<[
-    taskId: string,
-    snapshotId: string,
-    isAutoSnapshot: boolean,
-    options?: MatchImageSnapshotOptions | undefined
-]>;
-export {};
+export declare const prepareImageSnapshotComparison: BrowserCommand<Parameters<PrepareImageSnapshotComparisonCommand['prepareImageSnapshotComparison']>>;
 //# sourceMappingURL=prepare_image_snapshot_comparison.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"prepare_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_image_snapshot_comparison.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,KAAK,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,uBAAuB,CAAA;AAK9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,KAAK,2BAA2B,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACd,GAAG,2BAA2B,GAC9B,uBAAuB,GACvB,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAA;AAEjD,MAAM,WAAW,qCAAqC;IACrD,8BAA8B,EAAE,CAC/B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,OAAO,EACvB,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,8BAA8B,EAAE,cAAc,CAC1D;IAAC,MAAM,EAAE,MAAM;IAAE,UAAU,EAAE,MAAM;IAAE,cAAc,EAAE,OAAO;IAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CA0B9G,CAAA"}
+{"version":3,"file":"prepare_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_image_snapshot_comparison.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,KAAK,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,uBAAuB,CAAA;AAO9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAE3D,MAAM,MAAM,2BAA2B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB,GAAG,2BAA2B,GAC9B,uBAAuB,GACvB,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAA;AAEjD,MAAM,WAAW,qCAAqC;IACrD,8BAA8B,EAAE,CAC/B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,8BAA8B,EAAE,cAAc,CAC1D,UAAU,CAAC,qCAAqC,CAAC,gCAAgC,CAAC,CAAC,CA2BnF,CAAA"}

package/esm/server/commands/prepare_image_snapshot_comparison.js

@@ -1,28 +1,30 @@
 import { resolve } from 'pathe';
 import { isBase64String } from "../../shared/base64.js";
-import { file } from "../file.js";
-import { takeSnapshot, takeSnapshotByBrowser, writeSnapshot } from "../snapshot.js";
-import { visContext } from "../vis_context.js";
+import { file } from "../externals/file.js";
+import { getProjectRoot } from "../project.js";
+import { takeSnapshot, takeSnapshotByBrowser } from "../snapshot.js";
+import { snapshotWriter } from "../snapshot_writer.js";
+import { visServerContext } from "../vis_server_context.js";
 import { assertTestPathDefined } from "./_assertions.js";
-export const prepareImageSnapshotComparison = async (context, taskId, subject, isAutoSnapshot, options) => {
+export const prepareImageSnapshotComparison = async (context, taskId, subject, options) => {
     assertTestPathDefined(context, 'prepareImageSnapshotComparison');
     // vitest:browser passes in `null` when not defined
     if (!options)
         options = {};
     options.timeout = options.timeout ?? 30000;
-    const projectRoot = context.project.config.root;
-    const info = await visContext.getSnapshotInfo(context, taskId, isAutoSnapshot, options);
+    const projectRoot = getProjectRoot(context);
+    const info = await visServerContext.getSnapshotInfo(context, taskId, options);
     const baselineBuffer = await file.tryReadFile(resolve(projectRoot, info.baselinePath));
     if (!baselineBuffer) {
         if (isBase64String(subject)) {
-            await writeSnapshot(resolve(projectRoot, info.baselinePath), subject);
+            await snapshotWriter.writeBase64(resolve(projectRoot, info.baselinePath), subject);
         }
         else {
-            await takeSnapshotByBrowser(context, resolve(projectRoot, info.baselinePath), subject, options);
+            await takeSnapshotByBrowser(context, projectRoot, info.baselinePath, subject, options);
         }
         return;
     }
-    const resultBuffer = await takeSnapshot(context, resolve(projectRoot, info.resultPath), subject, options);
+    const resultBuffer = await takeSnapshot(context, projectRoot, info.resultPath, subject, options);
     return {
         ...info,
         projectRoot,

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

@@ -0,0 +1,35 @@
+import type { BrowserCommand } from 'vitest/node';
+import type { FailureThresholdOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions } from '../../shared/types.ts';
+import type { MatchImageSnapshotOptions } from './types.ts';
+type ImageSnapshotComparisonInfo = {
+    /**
+     * Path to the project root.
+     */
+    projectRoot: string;
+    /**
+     * Path to the baseline image relative to the project root.
+     */
+    baselinePath: string;
+    /**
+     * Path to the result image relative to the project root.
+     */
+    resultPath: string;
+    /**
+     * Path to the diff image relative to the project root.
+     */
+    diffPath: string;
+    /**
+     * Base64 encoded baseline image.
+     */
+    baseline: string;
+    /**
+     * Base64 encoded result image.
+     */
+    result: string;
+} & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
+export interface PreparePageImageSnapshotComparisonCommand {
+    preparePageImageSnapshotComparison: (taskId: string, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
+}
+export declare const preparePageImageSnapshotComparison: BrowserCommand<Parameters<PreparePageImageSnapshotComparisonCommand['preparePageImageSnapshotComparison']>>;
+export {};
+//# sourceMappingURL=prepare_page_image_snapshot_comparison.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prepare_page_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_page_image_snapshot_comparison.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,uBAAuB,CAAA;AAM9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAE3D,KAAK,2BAA2B,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACd,GAAG,2BAA2B,GAC9B,uBAAuB,GACvB,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAA;AAEjD,MAAM,WAAW,yCAAyC;IACzD,kCAAkC,EAAE,CACnC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,kCAAkC,EAAE,cAAc,CAC9D,UAAU,CAAC,yCAAyC,CAAC,oCAAoC,CAAC,CAAC,CAsB3F,CAAA"}

package/esm/server/commands/prepare_page_image_snapshot_comparison.js

@@ -0,0 +1,27 @@
+import { resolve } from 'pathe';
+import { file } from "../externals/file.js";
+import { getProjectRoot } from "../project.js";
+import { takePageSnapshot } from "../snapshot.js";
+import { visServerContext } from "../vis_server_context.js";
+import { assertTestPathDefined } from "./_assertions.js";
+export const preparePageImageSnapshotComparison = async (context, taskId, options) => {
+    assertTestPathDefined(context, 'preparePageImageSnapshotComparison');
+    // vitest:browser passes in `null` when not defined
+    if (!options)
+        options = {};
+    options.timeout = options.timeout ?? 30000;
+    const projectRoot = getProjectRoot(context);
+    const info = await visServerContext.getSnapshotInfo(context, taskId, options);
+    const baselineBuffer = await file.tryReadFile(resolve(projectRoot, info.baselinePath));
+    if (!baselineBuffer) {
+        await takePageSnapshot(context, projectRoot, info.baselinePath, options);
+        return;
+    }
+    const resultBuffer = await takePageSnapshot(context, projectRoot, info.resultPath, options);
+    return {
+        ...info,
+        projectRoot,
+        baseline: baselineBuffer.toString('base64'),
+        result: resultBuffer.toString('base64'),
+    };
+};

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

@@ -1,4 +1,6 @@
+import type { Pick } from 'type-plus';
 import type { BrowserCommand } from 'vitest/node';
+import type { VisOptions } from '../../config/types.ts';
 export interface SetupVisSuiteCommand {
     /**
      * Sets up the visual testing suite by cleaning up previous snapshot and diff output directories.
@@ -7,9 +9,7 @@ export interface SetupVisSuiteCommand {
      *
      * In subsequent runs, it will only remove the results and diffs directory of the current suite.
      */
-    setupVisSuite: () => Promise<{
-        subjectDataTestId: string | undefined;
-    }>;
+    setupVisSuite: () => Promise<Pick<VisOptions, 'comparisonMethod' | 'diffOptions' | 'failureThreshold' | 'failureThresholdType' | 'snapshotKey' | 'subject' | 'timeout'>>;
 }
 export declare const setupVisSuite: BrowserCommand<[]>;
 //# sourceMappingURL=setup_vis_suite.d.ts.map

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

@@ -1 +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;AAIjD,MAAM,WAAW,oBAAoB;IACpC;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC;QAAE,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC,CAAA;CACvE;AAED,eAAO,MAAM,aAAa,EAAE,cAAc,CAAC,EAAE,CAM5C,CAAA"}
+{"version":3,"file":"setup_vis_suite.d.ts","sourceRoot":"","sources":["../../../src/server/commands/setup_vis_suite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAIvD,MAAM,WAAW,oBAAoB;IACpC;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,OAAO,CAC3B,IAAI,CACH,UAAU,EACR,kBAAkB,GAClB,aAAa,GACb,kBAAkB,GAClB,sBAAsB,GACtB,aAAa,GACb,SAAS,GACT,SAAS,CACX,CACD,CAAA;CACD;AAED,eAAO,MAAM,aAAa,EAAE,cAAc,CAAC,EAAE,CAG5C,CAAA"}

package/esm/server/commands/setup_vis_suite.js

@@ -1,7 +1,6 @@
-import { visContext } from "../vis_context.js";
+import { setupSuite } from "../suite.js";
 import { assertTestPathDefined } from "./_assertions.js";
 export const setupVisSuite = async (context) => {
     assertTestPathDefined(context, 'setupVisSuite');
-    // using props not currently listed in the types
-    return visContext.setupSuite(context);
+    return setupSuite(context);
 };

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

@@ -0,0 +1,3 @@
+import type { ImageSnapshotCompareOptions, ImageSnapshotKeyOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
+export type MatchImageSnapshotOptions = ImageSnapshotTimeoutOptions & ImageSnapshotCompareOptions<any> & ImageSnapshotKeyOptions;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/commands/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,2BAA2B,EAC3B,uBAAuB,EACvB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAE9B,MAAM,MAAM,yBAAyB,GAAG,2BAA2B,GAClE,2BAA2B,CAAC,GAAG,CAAC,GAChC,uBAAuB,CAAA"}

package/esm/server/commands/types.js

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

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

@@ -0,0 +1,10 @@
+import { type GlobOptionsWithFileTypesUnset } from 'glob';
+import { writeFile } from 'node:fs/promises';
+export declare const file: {
+    existFile(filePath: string): Promise<boolean>;
+    glob(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Promise<string[]>;
+    mkdirp: (path: string) => Promise<string | undefined>;
+    tryReadFile(filePath: string | undefined): Promise<Buffer | undefined>;
+    writeFile: typeof writeFile;
+};
+//# sourceMappingURL=file.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/server/externals/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,6BAA6B,EAAE,MAAM,MAAM,CAAA;AAE/D,OAAO,EAAkB,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAE5D,eAAO,MAAM,IAAI;wBACI,MAAM;kBAKZ,MAAM,GAAG,MAAM,EAAE,YAAY,6BAA6B,GAAG,SAAS;YAGlE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;0BACnC,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;;CAM5E,CAAA"}

package/esm/server/{file.js → externals/file.js}

@@ -1,12 +1,20 @@
+import { glob } from 'glob';
+import { mkdirp } from 'mkdirp';
 import { readFile, stat, writeFile } from 'node:fs/promises';
 export const file = {
-    async tryReadFile(filePath) {
-        return readFile(filePath).catch(() => undefined);
-    },
-    writeFile,
     existFile(filePath) {
         return stat(filePath)
             .then((s) => s.isFile())
             .catch(() => false);
     },
+    glob(pattern, options) {
+        return glob(pattern, options);
+    },
+    mkdirp: mkdirp,
+    async tryReadFile(filePath) {
+        if (!filePath)
+            return undefined;
+        return readFile(filePath).catch(() => undefined);
+    },
+    writeFile,
 };

package/esm/server/{commands/browser_command_context.d.ts → project.d.ts}

@@ -1,4 +1,3 @@
-import type { BrowserCommandContext } from 'vitest/node';
 export declare function getProjectName(context: {
     project: {
         vite: {
@@ -10,5 +9,11 @@ export declare function getProjectName(context: {
         };
     };
 }): string | undefined;
-export declare function getBrowserInstanceProjectName(context: BrowserCommandContext): import("vitest/node").ResolvedConfig;
-//# sourceMappingURL=browser_command_context.d.ts.map
+export declare function getProjectRoot(context: {
+    project: {
+        config: {
+            root: string;
+        };
+    };
+}): string;
+//# sourceMappingURL=project.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../src/server/project.ts"],"names":[],"mappings":"AAAA,wBAAgB,cAAc,CAAC,OAAO,EAAE;IAAE,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,MAAM,EAAE;gBAAE,IAAI,CAAC,EAAE;oBAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;iBAAE,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,sBAElH;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE;IAAE,OAAO,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,UAEhF"}

package/esm/server/{commands/browser_command_context.js → project.js}

@@ -1,6 +1,6 @@
 export function getProjectName(context) {
     return context.project.vite.config.test?.name;
 }
-export function getBrowserInstanceProjectName(context) {
-    return context.project.config;
+export function getProjectRoot(context) {
+    return context.project.config.root;
 }

package/esm/server/snapshot.d.ts

@@ -1,7 +1,6 @@
 import type { BrowserCommandContext } from 'vitest/node';
-import type { ImageSnapshotTimeoutOptions } from '../client.ts';
-export declare function takeSnapshot(context: BrowserCommandContext, filePath: string, subject: string, options: ImageSnapshotTimeoutOptions | undefined): Promise<Buffer<ArrayBufferLike>>;
-export declare function takeSnapshotByBrowser(context: BrowserCommandContext, filePath: string, subject: string, options: ImageSnapshotTimeoutOptions | undefined): Promise<Buffer<ArrayBufferLike>>;
-export declare function writeSnapshot(filePath: string, subject: string): Promise<void>;
-export declare function writeSnapshotBuffer(filePath: string, subject: Buffer): Promise<void>;
+import type { ImageSnapshotTimeoutOptions, PageImageSnapshotOptions } from '../shared/types.ts';
+export declare function takeSnapshot(context: BrowserCommandContext, projectRoot: string, relativeFilePath: string, subject: string, options: ImageSnapshotTimeoutOptions | undefined): Promise<Buffer<ArrayBufferLike>>;
+export declare function takeSnapshotByBrowser(context: BrowserCommandContext, projectRoot: string, relativeFilePath: string, subject: string, options: ImageSnapshotTimeoutOptions | undefined): Promise<Buffer<ArrayBufferLike>>;
+export declare function takePageSnapshot(context: BrowserCommandContext, projectRoot: string, relativeFilePath: string, options: (PageImageSnapshotOptions & ImageSnapshotTimeoutOptions) | undefined): Promise<Buffer<ArrayBufferLike>>;
 //# sourceMappingURL=snapshot.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/server/snapshot.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAA;AAK/D,wBAAsB,YAAY,CACjC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,GAAG,SAAS,oCAOhD;AAED,wBAAsB,qBAAqB,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,GAAG,SAAS,oCAOhD;AAED,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,iBAGpE;AACD,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,iBAG1E"}
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/server/snapshot.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,OAAO,KAAK,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAI/F,wBAAsB,YAAY,CACjC,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,GAAG,SAAS,oCAOhD;AAED,wBAAsB,qBAAqB,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,GAAG,SAAS,oCAQhD;AAED,wBAAsB,gBAAgB,CACrC,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,CAAC,wBAAwB,GAAG,2BAA2B,CAAC,GAAG,SAAS,oCAS7E"}

package/esm/server/snapshot.js

@@ -1,27 +1,29 @@
 import { mkdirp } from 'mkdirp';
-import { dirname } from 'pathe';
+import { dirname, resolve } from 'pathe';
 import { isBase64String } from "../shared/base64.js";
 import { browserApi } from "./browser_provider/browser_api.js";
-import { file } from './file.js';
-export async function takeSnapshot(context, filePath, subject, options) {
+import { snapshotWriter } from "./snapshot_writer.js";
+export async function takeSnapshot(context, projectRoot, relativeFilePath, subject, options) {
     if (isBase64String(subject)) {
-        await writeSnapshot(filePath, subject);
+        await snapshotWriter.writeBase64(resolve(projectRoot, relativeFilePath), subject);
         return Buffer.from(subject, 'base64');
     }
-    return takeSnapshotByBrowser(context, filePath, subject, options);
+    return takeSnapshotByBrowser(context, projectRoot, relativeFilePath, subject, options);
 }
-export async function takeSnapshotByBrowser(context, filePath, subject, options) {
+export async function takeSnapshotByBrowser(context, projectRoot, relativeFilePath, subject, options) {
+    const filePath = resolve(projectRoot, relativeFilePath);
     await mkdirp(dirname(filePath));
     const browser = browserApi(context);
-    return browser.takeScreenshot(filePath, subject ?? 'body', {
+    return browser.takeScreenshot(projectRoot, relativeFilePath, subject ?? 'body', {
         timeout: options?.timeout,
     });
 }
-export async function writeSnapshot(filePath, subject) {
+export async function takePageSnapshot(context, projectRoot, relativeFilePath, options) {
+    const filePath = resolve(projectRoot, relativeFilePath);
     await mkdirp(dirname(filePath));
-    await file.writeFile(filePath, subject, { encoding: 'base64' });
-}
-export async function writeSnapshotBuffer(filePath, subject) {
-    await mkdirp(dirname(filePath));
-    await file.writeFile(filePath, subject);
+    const browser = browserApi(context);
+    return browser.takePageScreenshot(projectRoot, relativeFilePath, {
+        timeout: options?.timeout,
+        fullPage: options?.fullPage,
+    });
 }

package/esm/server/snapshot_path.d.ts

@@ -1,5 +1,5 @@
 import type { VisOptions } from '../config/types.ts';
-import type { PartialBrowserCommandContext } from './vis_context.types.ts';
-export declare function resolveSnapshotRootDir(suite: PartialBrowserCommandContext, options: VisOptions): string;
-export declare function getSnapshotSubpath(suiteName: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): string;
+import type { PartialBrowserCommandContext } from './vis_server_context.types.ts';
+export declare function resolveSnapshotRootDir(browserCommandContext: PartialBrowserCommandContext, options: VisOptions): string;
+export declare function getSnapshotSubpath(suiteName: string, options: Pick<VisOptions, 'snapshotSubpath'>): string;
 //# sourceMappingURL=snapshot_path.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snapshot_path.d.ts","sourceRoot":"","sources":["../../src/server/snapshot_path.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAGpD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAA;AAE1E,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,EAAE,OAAO,EAAE,UAAU,UAY9F;AAKD,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,UAG1G"}
+{"version":3,"file":"snapshot_path.d.ts","sourceRoot":"","sources":["../../src/server/snapshot_path.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAGpD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAEjF,wBAAgB,sBAAsB,CAAC,qBAAqB,EAAE,4BAA4B,EAAE,OAAO,EAAE,UAAU,UAY9G;AAMD,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAGjG"}

package/esm/server/snapshot_path.js

@@ -1,25 +1,26 @@
 import ci from 'is-ci';
+import { platform } from 'node:process';
 import { SNAPSHOT_ROOT_DIR } from "../shared/constants.js";
 import { trimCommonFolder } from "../shared/trim_common_folder.js";
-export function resolveSnapshotRootDir(suite, options) {
+export function resolveSnapshotRootDir(browserCommandContext, options) {
     if (!options.snapshotRootDir)
-        return getSnapshotRootDir(SNAPSHOT_ROOT_DIR, options.platform);
+        return getSnapshotRootDir(SNAPSHOT_ROOT_DIR);
     const snapshotRootDir = options.snapshotRootDir;
     if (typeof snapshotRootDir === 'string')
-        return getSnapshotRootDir(snapshotRootDir, options.platform);
+        return getSnapshotRootDir(snapshotRootDir);
     return snapshotRootDir({
         ci,
-        browserName: suite.provider.browserName,
-        providerName: suite.provider.name,
-        platform: process.platform,
-        screenshotFailures: suite.provider.options?.screenshotFailures,
-        screenshotDirectory: suite.provider.options?.screenshotDirectory,
+        browserName: browserCommandContext.provider.browserName,
+        providerName: browserCommandContext.provider.name,
+        platform,
+        screenshotFailures: browserCommandContext.provider.options?.screenshotFailures,
+        screenshotDirectory: browserCommandContext.provider.options?.screenshotDirectory,
     });
 }
-function getSnapshotRootDir(snapshotRootDir, platform = process.platform) {
+function getSnapshotRootDir(snapshotRootDir) {
     return `${snapshotRootDir}/${ci ? platform : 'local'}`;
 }
 export function getSnapshotSubpath(suiteName, options) {
-    const customizeSnapshotSubpath = options.customizeSnapshotSubpath ?? trimCommonFolder;
-    return customizeSnapshotSubpath(suiteName);
+    const customizeSnapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath));
+    return customizeSnapshotSubpath({ subpath: suiteName });
 }

package/esm/server/snapshot_writer.d.ts

@@ -0,0 +1,13 @@
+export interface SnapshotWriter {
+    writeBase64(filePath: string, data: string): Promise<void>;
+    writeBuffer(filePath: string, data: Buffer): Promise<void>;
+}
+export declare function createSnapshotWriter({ mkdirp, writeFile }?: {
+    existFile(filePath: string): Promise<boolean>;
+    glob(pattern: string | string[], options?: import("glob").GlobOptionsWithFileTypesUnset | undefined): Promise<string[]>;
+    mkdirp: (path: string) => Promise<string | undefined>;
+    tryReadFile(filePath: string | undefined): Promise<Buffer | undefined>;
+    writeFile: typeof import("fs/promises").writeFile;
+}): SnapshotWriter;
+export declare const snapshotWriter: SnapshotWriter;
+//# sourceMappingURL=snapshot_writer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot_writer.d.ts","sourceRoot":"","sources":["../../src/server/snapshot_writer.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc;IAC9B,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1D;AAED,wBAAgB,oBAAoB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE;;;;;;CAAO,GAAG,cAAc,CAWjF;AAED,eAAO,MAAM,cAAc,gBAAyB,CAAA"}

package/esm/server/snapshot_writer.js

@@ -0,0 +1,15 @@
+import { dirname } from 'pathe';
+import { file } from "./externals/file.js";
+export function createSnapshotWriter({ mkdirp, writeFile } = file) {
+    return {
+        async writeBase64(filePath, data) {
+            await mkdirp(dirname(filePath));
+            await writeFile(filePath, data, { encoding: 'base64' });
+        },
+        async writeBuffer(filePath, data) {
+            await mkdirp(dirname(filePath));
+            await writeFile(filePath, data);
+        },
+    };
+}
+export const snapshotWriter = createSnapshotWriter();

package/esm/server/suite.d.ts

@@ -0,0 +1,53 @@
+import type { VisOptions } from '../config/types.ts';
+import type { PartialBrowserCommandContext, VisSuite } from './vis_server_context.types.ts';
+/**
+ * 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.
+ */
+export declare function setupSuite(browserContext: PartialBrowserCommandContext): Promise<{
+    comparisonMethod: any;
+    diffOptions: Partial<import("ssim.js/dist/types.js").Options> | {
+        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;
+    failureThreshold: number | undefined;
+    failureThresholdType: "pixel" | "percent" | undefined;
+    snapshotKey: string | undefined;
+    subject: string | undefined;
+    timeout: number | undefined;
+}>;
+/**
+ * Suite ID also contains the project name to make it unique
+ * across different projects.
+ */
+export declare function getSuiteId(context: {
+    project: {
+        config: {
+            root: string;
+            name: string;
+        };
+        vite: {
+            config: {
+                test?: {
+                    name?: string | undefined;
+                };
+            };
+        };
+    };
+}): string;
+export declare function createModule(state: VisSuite, testPath: string, options: Pick<VisOptions, 'snapshotSubpath'>): {
+    taskSubpath: string;
+    baselineDir: string;
+    resultDir: string;
+    diffDir: string;
+    tasks: {};
+};
+export declare function getTaskSubpath(state: VisSuite, testPath: string, options: Pick<VisOptions, 'snapshotSubpath'>): string;
+export declare function getSuite(context: PartialBrowserCommandContext): Promise<VisSuite>;
+//# sourceMappingURL=suite.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"suite.d.ts","sourceRoot":"","sources":["../../src/server/suite.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAMpD,OAAO,KAAK,EAAE,4BAA4B,EAAE,QAAQ,EAAa,MAAM,+BAA+B,CAAA;AAItG;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,cAAc,EAAE,4BAA4B;;;;;;;;;;;;;;;;GA2B5E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE;IACnC,OAAO,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,IAAI,EAAE;YAAE,MAAM,EAAE;gBAAE,IAAI,CAAC,EAAE;oBAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;iBAAE,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAC/G,UAEA;AAyBD,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC;;;;;;EAS3G;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAE7G;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,4BAA4B,qBAE7D"}

package/esm/server/suite.js

@@ -0,0 +1,73 @@
+import { join, relative } from 'pathe';
+import { BASELINE_DIR, DIFF_DIR, RESULT_DIR } from "../shared/constants.js";
+import { getProjectName, getProjectRoot } from "./project.js";
+import { getSnapshotSubpath, resolveSnapshotRootDir } from "./snapshot_path.js";
+import { getVisOption } from "./vis_options.js";
+import { deps } from "./vis_server_context.deps.js";
+const suites = {};
+/**
+ * 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.
+ */
+export async function setupSuite(browserContext) {
+    const suiteId = getSuiteId(browserContext);
+    const visOptions = getVisOption(browserContext);
+    if (!suites[suiteId]) {
+        suites[suiteId] = createSuite(browserContext, visOptions);
+    }
+    const suite = await suites[suiteId];
+    const { taskSubpath, baselineDir, diffDir, resultDir, tasks } = createModule(suite, browserContext.testPath, visOptions);
+    suite.modules[taskSubpath] = { baselineDir, diffDir, resultDir, tasks };
+    await Promise.allSettled([deps.rimraf(diffDir), deps.rimraf(resultDir)]);
+    return {
+        comparisonMethod: visOptions.comparisonMethod,
+        diffOptions: visOptions.diffOptions,
+        failureThreshold: visOptions.failureThreshold,
+        failureThresholdType: visOptions.failureThresholdType,
+        snapshotKey: visOptions.snapshotKey,
+        subject: visOptions.subject,
+        timeout: visOptions.timeout,
+    };
+}
+/**
+ * Suite ID also contains the project name to make it unique
+ * across different projects.
+ */
+export function getSuiteId(context) {
+    return `${getProjectName(context)}/${context.project.config.name}`;
+}
+async function createSuite(browserContext, visOptions) {
+    const snapshotRootDir = resolveSnapshotRootDir(browserContext, visOptions);
+    const projectRoot = getProjectRoot(browserContext);
+    const state = {
+        projectRoot,
+        testTimeout: browserContext.project.config.testTimeout,
+        hookTimeout: browserContext.project.config.hookTimeout,
+        snapshotRootDir,
+        snapshotBaselineDir: join(snapshotRootDir, BASELINE_DIR),
+        snapshotResultDir: join(snapshotRootDir, RESULT_DIR),
+        snapshotDiffDir: join(snapshotRootDir, DIFF_DIR),
+        snapshotRootPath: join(projectRoot, snapshotRootDir),
+        subject: visOptions.subject,
+        modules: {},
+    };
+    await Promise.allSettled([deps.rimraf(join(state.snapshotDiffDir)), deps.rimraf(join(state.snapshotResultDir))]);
+    return state;
+}
+export function createModule(state, testPath, options) {
+    const taskSubpath = getTaskSubpath(state, testPath, options);
+    return {
+        taskSubpath,
+        baselineDir: join(state.snapshotBaselineDir, taskSubpath),
+        resultDir: join(state.snapshotResultDir, taskSubpath),
+        diffDir: join(state.snapshotDiffDir, taskSubpath),
+        tasks: {},
+    };
+}
+export function getTaskSubpath(state, testPath, options) {
+    return getSnapshotSubpath(relative(state.projectRoot, testPath), options);
+}
+export function getSuite(context) {
+    return suites[getSuiteId(context)];
+}

package/esm/server/vis_options.d.ts

@@ -0,0 +1,18 @@
+import type { VisOptions } from '../config/types.ts';
+export declare function setVisOption(userConfig: {
+    test?: {
+        name?: string | undefined;
+    } | undefined;
+}, options: VisOptions<any> | undefined): void;
+export declare function getVisOption(context: {
+    project: {
+        vite: {
+            config: {
+                test?: {
+                    name?: string | undefined;
+                };
+            };
+        };
+    };
+}): VisOptions<any>;
+//# sourceMappingURL=vis_options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vis_options.d.ts","sourceRoot":"","sources":["../../src/server/vis_options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAQpD,wBAAgB,YAAY,CAC3B,UAAU,EAAE;IAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAA;CAAE,EAChE,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,SAAS,QAQpC;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE;IACrC,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,MAAM,EAAE;gBAAE,IAAI,CAAC,EAAE;oBAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;iBAAE,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CACvE,mBAIA"}