vitest-plugin-vis 2.4.3 → 3.0.0

package/esm/client/setup/vis.ctx.d.ts

@@ -0,0 +1,12 @@
+import { afterEach, beforeAll, beforeEach, type Awaitable, type Suite } from 'vitest';
+export declare const ctx: {
+    beforeAll: typeof beforeAll;
+    beforeEach: typeof beforeEach;
+    afterEach: typeof afterEach;
+    commands: import("@vitest/browser/context").BrowserCommands;
+    mock(): {
+        beforeAllListeners: ((suite: Readonly<Suite | File>) => Awaitable<unknown>)[];
+    };
+    reset(): void;
+};
+//# sourceMappingURL=vis.ctx.d.ts.map

package/esm/client/setup/vis.ctx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis.ctx.d.ts","sourceRoot":"","sources":["../../../src/client/setup/vis.ctx.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAM,KAAK,SAAS,EAAE,KAAK,KAAK,EAAE,MAAM,QAAQ,CAAA;AAEzF,eAAO,MAAM,GAAG;;;;;;qCAM0B,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC;;;CAuBtF,CAAA"}

package/esm/client/setup/vis.ctx.js

@@ -0,0 +1,32 @@
+import { commands } from '@vitest/browser/context';
+import { afterEach, beforeAll, beforeEach, vi } from 'vitest';
+export const ctx = {
+    beforeAll,
+    beforeEach,
+    afterEach,
+    commands,
+    mock() {
+        const beforeAllListeners = [];
+        beforeEach(() => {
+            ctx.beforeAll = vi.fn((fn) => {
+                beforeAllListeners.push(fn);
+            });
+            ctx.beforeEach = vi.fn();
+            ctx.afterEach = vi.fn();
+            ctx.commands = {
+                setupVisSuite: vi.fn(),
+            };
+        });
+        afterEach(() => {
+            ctx.reset();
+        });
+        return {
+            beforeAllListeners,
+        };
+    },
+    reset() {
+        ctx.beforeAll = beforeAll;
+        ctx.beforeEach = beforeEach;
+        ctx.afterEach = afterEach;
+    },
+};

package/esm/client/setup/vis.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Visual test configuration on the client side.
+ */
+export declare const vis: import("./create_vis.ts").VisClientConfigurator<unknown>;
+//# sourceMappingURL=vis.d.ts.map

package/esm/client/setup/vis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis.d.ts","sourceRoot":"","sources":["../../../src/client/setup/vis.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,GAAG,0DAAsB,CAAA"}

package/esm/client/should_take_snapshot.d.ts

@@ -1,10 +1,3 @@
-import type { SnapshotMeta } from '../shared/types.ts';
-/**
- * Determine should snapshot be taken.
- *
- * not story: false
- * no `snapshot` tag: false
- * disabled by `!snapshot` tag: false
- */
-export declare function shouldTakeSnapshot(meta?: SnapshotMeta<any> | undefined): boolean | undefined;
+import type { SnapshotMeta } from './snapshot_meta.ts';
+export declare function shouldTakeSnapshot(meta: SnapshotMeta<any> | undefined): boolean | undefined;
 //# sourceMappingURL=should_take_snapshot.d.ts.map

package/esm/client/should_take_snapshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"should_take_snapshot.d.ts","sourceRoot":"","sources":["../../src/client/should_take_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAItD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,SAAS,uBAGtE"}
+{"version":3,"file":"should_take_snapshot.d.ts","sourceRoot":"","sources":["../../src/client/should_take_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,SAAS,uBAErE"}

package/esm/client/should_take_snapshot.js

@@ -1,13 +1,3 @@
-import { ctx } from "./ctx.js";
-import { extractAutoSnapshotOptions } from "./snapshot_options.js";
-/**
- * Determine should snapshot be taken.
- *
- * not story: false
- * no `snapshot` tag: false
- * disabled by `!snapshot` tag: false
- */
 export function shouldTakeSnapshot(meta) {
-    const m = meta ?? extractAutoSnapshotOptions(ctx.getCurrentTest());
-    return document.body.childElementCount > 0 && m?.enable;
+    return document.body.childElementCount > 0 && meta?.enable;
 }

package/esm/client/snapshot_meta.d.ts

@@ -0,0 +1,6 @@
+import type { ComparisonMethod, ImageSnapshotSubjectOptions, ToMatchImageSnapshotOptions } from '../shared/types.ts';
+export type SnapshotMeta<M extends ComparisonMethod> = ToMatchImageSnapshotOptions<M> & ImageSnapshotSubjectOptions & {
+    enable?: boolean | undefined;
+    [key: string]: unknown;
+};
+//# sourceMappingURL=snapshot_meta.d.ts.map

package/esm/client/snapshot_meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot_meta.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAEpH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,IAAI,2BAA2B,CAAC,CAAC,CAAC,GACpF,2BAA2B,GAAG;IAC7B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB,CAAA"}

package/esm/client/task_id.d.ts

@@ -2,9 +2,6 @@ type Task = {
     name: string;
     suite?: Task | undefined;
 };
-/**
- * @deprecated not needed anymore. Use `matchImageSnapshot` directly instead.
- */
 export declare function toTaskId(task: Task): string;
 export {};
 //# sourceMappingURL=task_id.d.ts.map

package/esm/client/task_id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task_id.d.ts","sourceRoot":"","sources":["../../src/client/task_id.ts"],"names":[],"mappings":"AAAA,KAAK,IAAI,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,UAUlC"}
+{"version":3,"file":"task_id.d.ts","sourceRoot":"","sources":["../../src/client/task_id.ts"],"names":[],"mappings":"AAAA,KAAK,IAAI,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CACxB,CAAA;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,UAUlC"}

package/esm/client/task_id.js

@@ -1,6 +1,3 @@
-/**
- * @deprecated not needed anymore. Use `matchImageSnapshot` directly instead.
- */
 export function toTaskId(task) {
     const l = [];
     let t = task;

package/esm/client/vitest_suite_proxy.d.ts

@@ -1,13 +1,6 @@
-import type { NAME } from '../shared/constants.ts';
-import type { SnapshotMeta } from '../shared/types.ts';
+import type { SnapshotTestMeta } from '../shared/types.ts';
 declare let vitestSuite: Awaited<typeof import('vitest/suite')>;
-export type CurrentTest = ReturnType<typeof vitestSuite.getCurrentTest> & {
-    meta: {
-        [NAME]?: SnapshotMeta<'pixel' | 'ssim'> & {
-            isAutoSnapshot?: boolean | undefined;
-        };
-    };
-};
+export type CurrentTest = ReturnType<typeof vitestSuite.getCurrentTest> & SnapshotTestMeta;
 export declare const getCurrentTest: () => CurrentTest;
 export declare const getCurrentSuite: () => import("vitest").SuiteCollector<object>;
 export {};

package/esm/client/vitest_suite_proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vitest_suite_proxy.d.ts","sourceRoot":"","sources":["../../src/client/vitest_suite_proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,QAAA,IAAI,WAAW,EAAE,OAAO,CAAC,cAAc,cAAc,CAAC,CAAC,CAAA;AAQvD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,cAAc,CAAC,GAAG;IACzE,IAAI,EAAE;QAAE,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG;YAAE,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;SAAE,CAAA;KAAE,CAAA;CAC5F,CAAA;AAED,eAAO,MAAM,cAAc,QAA0C,WAAW,CAAA;AAChF,eAAO,MAAM,eAAe,+CAAuC,CAAA"}
+{"version":3,"file":"vitest_suite_proxy.d.ts","sourceRoot":"","sources":["../../src/client/vitest_suite_proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE1D,QAAA,IAAI,WAAW,EAAE,OAAO,CAAC,cAAc,cAAc,CAAC,CAAC,CAAA;AAQvD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,cAAc,CAAC,GAAG,gBAAgB,CAAA;AAE1F,eAAO,MAAM,cAAc,QAA0C,WAAW,CAAA;AAChF,eAAO,MAAM,eAAe,+CAAuC,CAAA"}

package/esm/client-api.d.ts

@@ -0,0 +1,11 @@
+import './server/commands/augment.ts';
+export * from './client/actions/has_image_snapshot_action.ts';
+export * from './client/actions/load_image_snapshot_results_action.ts';
+export * from './client/actions/match_image_snapshot_action.ts';
+export { setAutoSnapshotOptions, type MetaTask } from './client/auto_snapshot_options.ts';
+export * from './client/expect/expectation_result.ts';
+export type * from './client/expect/to_match_image_snapshot.types.ts';
+export * from './client/task_id.ts';
+export * from './shared/constants.ts';
+export type * from './shared/types.ts';
+//# sourceMappingURL=client-api.d.ts.map

package/esm/client-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-api.d.ts","sourceRoot":"","sources":["../src/client-api.ts"],"names":[],"mappings":"AAAA,OAAO,8BAA8B,CAAA;AAErC,cAAc,+CAA+C,CAAA;AAC7D,cAAc,wDAAwD,CAAA;AACtE,cAAc,iDAAiD,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,KAAK,QAAQ,EAAE,MAAM,mCAAmC,CAAA;AACzF,cAAc,uCAAuC,CAAA;AACrD,mBAAmB,kDAAkD,CAAA;AACrE,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,mBAAmB,mBAAmB,CAAA"}

package/esm/client-api.js

@@ -0,0 +1,8 @@
+import "./server/commands/augment.js";
+export * from "./client/actions/has_image_snapshot_action.js";
+export * from "./client/actions/load_image_snapshot_results_action.js";
+export * from "./client/actions/match_image_snapshot_action.js";
+export { setAutoSnapshotOptions } from "./client/auto_snapshot_options.js";
+export * from "./client/expect/expectation_result.js";
+export * from "./client/task_id.js";
+export * from "./shared/constants.js";

package/esm/commands.d.ts

@@ -1,6 +1,5 @@
 export * from './server/commands/has_image_snapshot.ts';
 export * from './server/commands/image_snapshot_next_index.ts';
-export * from './server/commands/match_image_snapshot.ts';
 export * from './server/commands/prepare_image_snapshot_comparison.ts';
 export * from './server/commands/setup_vis_suite.ts';
 //# sourceMappingURL=commands.d.ts.map

package/esm/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAA;AACvD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wDAAwD,CAAA;AACtE,cAAc,sCAAsC,CAAA"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAA;AACvD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,wDAAwD,CAAA;AACtE,cAAc,sCAAsC,CAAA"}

package/esm/commands.js

@@ -1,5 +1,4 @@
 export * from "./server/commands/has_image_snapshot.js";
 export * from "./server/commands/image_snapshot_next_index.js";
-export * from "./server/commands/match_image_snapshot.js";
 export * from "./server/commands/prepare_image_snapshot_comparison.js";
 export * from "./server/commands/setup_vis_suite.js";

package/esm/config/types.d.ts

@@ -1,20 +1,22 @@
-import type { AutoSnapshotOptions, ComparisonMethod, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../shared/types.ts';
-export type { ComparisonMethod };
-export type VisOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & ImageSnapshotCompareOptions<M> & AutoSnapshotOptions & {
+import type { ComparisonMethod, FailureThresholdOptions, ImageSnapshotKeyOptions, ImageSnapshotSubjectOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, PixelDiffOptions, SsimComparisonOptions, SsimDiffOptions } from '../shared/types.ts';
+export type { ComparisonMethod, PixelComparisonOptions, PixelDiffOptions, SsimComparisonOptions, SsimDiffOptions };
+export type VisOptions<M extends ComparisonMethod = 'pixel'> = (M extends 'ssim' ? {
+    comparisonMethod: M;
     /**
-     * Loads the `test.setupFiles` of the specified preset.
+     * Custom options passed to 'ssim'
      */
-    preset?: 'enable' | 'manual' | 'auto' | 'none' | undefined;
+    diffOptions?: Partial<SsimDiffOptions> | undefined;
+} : {
+    comparisonMethod?: M | undefined;
     /**
-     * The name of the subdirectory that the baseline snapshots get saved in.
-     *
-     * <snapshotRootDir>/<platform>/<snapshotSubpath>/<snapshotId>.png
-     *
-     * Default: undefined
-     *
-     * @deprecated Use `snapshotRootDir` instead.
+     * Custom options passed to 'pixelmatch'
+     */
+    diffOptions?: PixelDiffOptions | undefined;
+}) & FailureThresholdOptions & ImageSnapshotTimeoutOptions & ImageSnapshotKeyOptions & ImageSnapshotSubjectOptions & {
+    /**
+     * Loads the `test.setupFiles` of the specified preset.
      */
-    platform?: string | undefined;
+    preset?: 'enable' | 'manual' | 'auto' | 'none' | undefined;
     /**
      * The snapshot folder relative to the root of the project.
      *
@@ -31,12 +33,6 @@ export type VisOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTime
     /**
      * Customize the snapshot subpath.
      *
-     * The snapshot subpath is used along with `snapshotRootDir` to determine the folder of the snapshots:
-     *
-     * - baseline: `<snapshotRootDir>/baselines/<snapshotSubpath>/<snapshotId>.png`
-     * - result: `<snapshotRootDir>/results/<snapshotSubpath>/<snapshotId>.png`
-     * - diff: `<snapshotRootDir>/diffs/<snapshotSubpath>/<snapshotId>.png`
-     *
      * Typically, you place your test files either in a dedicated `tests` folder or in the `src` folder along with your source code.
      * By default, the snapshot subpath is the test file path with that folder removed to reduces nesting of the snapshot folders.
      *
@@ -45,9 +41,13 @@ export type VisOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTime
      * and they might have files with the same name and create conflicting snapshots,
      * you can set this to customize the snapshot subpath.
      *
-     * @param subPath - The path of the test file to be used as the snapshot sub path.
-     * If you want to keep the full path, you can simply return it.
+     * @param options - Options for customizing the snapshot subpath.
+     * @property subPath - The path of the test file to be used as the snapshot subpath.
+     *                     To retain the full path, simply return it.
+     * @returns The customized snapshot subpath.
      */
-    customizeSnapshotSubpath?: (subPath: string) => string;
+    snapshotSubpath?: ((options: {
+        subpath: string;
+    }) => string) | undefined;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,mBAAmB,EACnB,gBAAgB,EAChB,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,oBAAoB,CAAA;AAE3B,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAEhC,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,2BAA2B,GACzF,sBAAsB,GACtB,2BAA2B,CAAC,CAAC,CAAC,GAC9B,mBAAmB,GAAG;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC1D;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B;;;;OAIG;IACH,eAAe,CAAC,EACb,MAAM,GACN,CAAC,CAAC,OAAO,EAAE;QACX,EAAE,EAAE,OAAO,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACxC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACvC,KAAK,MAAM,CAAC,GACb,SAAS,CAAA;IACZ;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;CACtD,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,MAAM,oBAAoB,CAAA;AAE3B,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,CAAA;AAElH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,MAAM,GAC7E;IACA,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;CAClD,GACA;IACA,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC1C,CAAC,GACH,uBAAuB,GACvB,2BAA2B,GAC3B,uBAAuB,GACvB,2BAA2B,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC1D;;;;OAIG;IACH,eAAe,CAAC,EACb,MAAM,GACN,CAAC,CAAC,OAAO,EAAE;QACX,EAAE,EAAE,OAAO,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACxC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACvC,KAAK,MAAM,CAAC,GACb,SAAS,CAAA;IACZ;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;CACxE,CAAA"}

package/esm/config/vis.d.ts

@@ -15,9 +15,10 @@ export declare function vis<M extends ComparisonMethod = 'pixel'>(options?: VisO
                 commands: {
                     setupVisSuite: import("vitest/node").BrowserCommand<[]>;
                     imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
-                    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotId: string | undefined, isAutoSnapshot: boolean]>;
-                    matchImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, subject: string, isAutoSnapshot: boolean, options?: import("../commands.ts").MatchImageSnapshotOptions | undefined]>;
-                    prepareImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, snapshotId: string, isAutoSnapshot: boolean, options?: import("../commands.ts").MatchImageSnapshotOptions | undefined]>;
+                    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotKey: string | undefined]>;
+                    preparePageImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, options?: import("../server/commands/types.ts").MatchImageSnapshotOptions | undefined]>;
+                    prepareImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("../server/commands/types.ts").MatchImageSnapshotOptions | undefined]>;
+                    loadImageSnapshotResults: import("vitest/node").BrowserCommand<[taskId: string]>;
                 };
             };
             setupFiles: string[];

package/esm/config/vis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vis.d.ts","sourceRoot":"","sources":["../../src/config/vis.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EAAE,OAAO,GAAE,UAAU,CAAC,CAAC,CAA6B;;;;;sBAWxE,MAAM;;;;;;;;;;;;EAQzC"}
+{"version":3,"file":"vis.d.ts","sourceRoot":"","sources":["../../src/config/vis.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EAAE,OAAO,GAAE,UAAU,CAAC,CAAC,CAA6B;;;;;sBASxE,MAAM;;;;;;;;;;;;;EAQzC"}

package/esm/config/vis.js

@@ -1,5 +1,5 @@
-import { commands } from "../server/commands/extend.js";
-import { visContext } from "../server/vis_context.js";
+import { commands } from "../server/commands/commands.js";
+import { setVisOption } from "../server/vis_options.js";
 import { NAME } from "../shared/constants.js";
 /**
  * Create a Vite plugin for visual testing.
@@ -11,8 +11,7 @@ export function vis(options = { preset: 'auto' }) {
     return {
         name: NAME,
         config(userConfig) {
-            const projectName = userConfig?.test?.name;
-            visContext.setOptions(projectName, options);
+            setVisOption(userConfig, options);
             const preset = options?.preset;
             return {
                 test: {

package/esm/index.d.ts

@@ -1,5 +1,5 @@
 import './client/expect/augment.ts';
 import './client/page/augment.ts';
-export { setAutoSnapshotOptions, type MetaTask } from './client/snapshot_options.ts';
+export { setAutoSnapshotOptions, type MetaTask } from './client/auto_snapshot_options.ts';
 export type * from './shared/types.ts';
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA;AAEjC,OAAO,EAAE,sBAAsB,EAAE,KAAK,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACpF,mBAAmB,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA;AAEjC,OAAO,EAAE,sBAAsB,EAAE,KAAK,QAAQ,EAAE,MAAM,mCAAmC,CAAA;AACzF,mBAAmB,mBAAmB,CAAA"}

package/esm/index.js

@@ -1,4 +1,4 @@
 // `vitest-plugin-vis` provides code that can be used in test files.
 import "./client/expect/augment.js";
 import "./client/page/augment.js";
-export { setAutoSnapshotOptions } from "./client/snapshot_options.js";
+export { setAutoSnapshotOptions } from "./client/auto_snapshot_options.js";

package/esm/presets/auto.d.ts

@@ -1,3 +1,2 @@
-import '../client/expect/extend.ts';
-import '../client/page/extend.ts';
+export {};
 //# sourceMappingURL=auto.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"auto.d.ts","sourceRoot":"","sources":["../../src/presets/auto.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA"}
+{"version":3,"file":"auto.d.ts","sourceRoot":"","sources":["../../src/presets/auto.ts"],"names":[],"mappings":""}

package/esm/presets/auto.js

@@ -1,4 +1,8 @@
-import { vis } from "../setup/vis.js";
-import "../client/expect/extend.js";
-import "../client/page/extend.js";
-vis.presets.auto();
+import { afterEach, beforeAll } from 'vitest';
+import { setAutoSnapshotOptions } from "../index.js";
+import { vis } from "../setup.js";
+beforeAll(async () => {
+    await vis.beforeAll.setup();
+    setAutoSnapshotOptions(true);
+});
+afterEach(() => vis.afterEach.matchImageSnapshot());

package/esm/presets/enable.d.ts

@@ -1,3 +1,2 @@
-import '../client/expect/extend.ts';
-import '../client/page/extend.ts';
+export {};
 //# sourceMappingURL=enable.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"enable.d.ts","sourceRoot":"","sources":["../../src/presets/enable.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA"}
+{"version":3,"file":"enable.d.ts","sourceRoot":"","sources":["../../src/presets/enable.ts"],"names":[],"mappings":""}

package/esm/presets/enable.js

@@ -1,4 +1,4 @@
-import { vis } from "../setup/vis.js";
-import "../client/expect/extend.js";
-import "../client/page/extend.js";
-vis.presets.enable();
+import { afterEach, beforeAll } from 'vitest';
+import { vis } from "../setup.js";
+beforeAll(() => vis.beforeAll.setup());
+afterEach(() => vis.afterEach.matchImageSnapshot());

package/esm/presets/manual.d.ts

@@ -1,3 +1,2 @@
-import '../client/expect/extend.ts';
-import '../client/page/extend.ts';
+export {};
 //# sourceMappingURL=manual.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"manual.d.ts","sourceRoot":"","sources":["../../src/presets/manual.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA"}
+{"version":3,"file":"manual.d.ts","sourceRoot":"","sources":["../../src/presets/manual.ts"],"names":[],"mappings":""}

package/esm/presets/manual.js

@@ -1,4 +1,3 @@
-import { vis } from "../setup/vis.js";
-import "../client/expect/extend.js";
-import "../client/page/extend.js";
-vis.presets.manual();
+import { beforeAll } from 'vitest';
+import { vis } from "../setup.js";
+beforeAll(() => vis.beforeAll.setup());

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

@@ -1 +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,CAWrE"}
+{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/playwright.ts"],"names":[],"mappings":"AACA,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,CAgBrE"}

package/esm/server/browser_provider/playwright.js

@@ -1,10 +1,16 @@
+import { resolve } from 'pathe';
 export function playwright(context) {
     return {
-        async takeScreenshot(filePath, selector, options) {
-            // The `Locator` type from `vitest` has less props than the `Locator` in `playwright`
+        async takeScreenshot(projectRoot, relativeFilePath, selector, options) {
             const subject = context.iframe.locator(selector);
             return subject.screenshot({
-                path: filePath,
+                path: resolve(projectRoot, relativeFilePath),
+                ...options,
+            });
+        },
+        async takePageScreenshot(projectRoot, relativeFilePath, options) {
+            return context.page.screenshot({
+                path: resolve(projectRoot, relativeFilePath),
                 ...options,
             });
         },

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

@@ -1,5 +1,9 @@
 export interface BrowserApi {
-    takeScreenshot(filePath: string, selector: string, options: {
+    takeScreenshot(projectRoot: string, relativeFilePath: string, selector: string, options: {
+        timeout?: number | undefined;
+    } | undefined): Promise<Buffer>;
+    takePageScreenshot(projectRoot: string, relativeFilePath: string, options: {
+        fullPage?: boolean | undefined;
         timeout?: number | undefined;
     } | undefined): Promise<Buffer>;
 }

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

@@ -1 +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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IAC1B,cAAc,CACb,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,EACJ;QACA,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GACD,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,kBAAkB,CACjB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EACJ;QACA,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GACD,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;CAClB"}

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

@@ -1 +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,CAQtE"}
+{"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,CAWtE"}

package/esm/server/browser_provider/webdriverio.js

@@ -1,9 +1,12 @@
 export function webdriverio(context) {
-    const page = context.provider.browser;
+    const browser = context.browser;
     return {
-        async takeScreenshot(filePath, selector) {
-            const element = await page.$(`${selector}`);
-            return element.saveScreenshot(filePath);
+        async takeScreenshot(_projectRoot, relativeFilePath, selector) {
+            const element = await browser.$(`${selector}`);
+            return element.saveScreenshot(relativeFilePath);
+        },
+        async takePageScreenshot(_projectRoot, relativeFilePath, options) {
+            return browser.saveScreenshot(relativeFilePath, options);
         },
     };
 }

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

@@ -0,0 +1,11 @@
+import type { HasImageSnapshotCommand } from './has_image_snapshot.ts';
+import type { ImageSnapshotNextIndexCommand } from './image_snapshot_next_index.ts';
+import type { LoadImageSnapshotResultsCommand } from './load_image_snapshot_results.ts';
+import type { PrepareImageSnapshotComparisonCommand } from './prepare_image_snapshot_comparison.ts';
+import type { PreparePageImageSnapshotComparisonCommand } from './prepare_page_image_snapshot_comparison.ts';
+import type { SetupVisSuiteCommand } from './setup_vis_suite.ts';
+declare module '@vitest/browser/context' {
+    interface BrowserCommands extends SetupVisSuiteCommand, ImageSnapshotNextIndexCommand, HasImageSnapshotCommand, PreparePageImageSnapshotComparisonCommand, PrepareImageSnapshotComparisonCommand, LoadImageSnapshotResultsCommand {
+    }
+}
+//# sourceMappingURL=augment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"augment.d.ts","sourceRoot":"","sources":["../../../src/server/commands/augment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAA;AACnF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAA;AACvF,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,wCAAwC,CAAA;AACnG,OAAO,KAAK,EAAE,yCAAyC,EAAE,MAAM,6CAA6C,CAAA;AAC5G,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAEhE,OAAO,QAAQ,yBAAyB,CAAC;IACxC,UAAU,eACT,SAAQ,oBAAoB,EAC3B,6BAA6B,EAC7B,uBAAuB,EACvB,yCAAyC,EACzC,qCAAqC,EACrC,+BAA+B;KAAG;CACpC"}

package/esm/server/commands/augment.js

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

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

@@ -0,0 +1,9 @@
+export declare const commands: {
+    setupVisSuite: import("vitest/node").BrowserCommand<[]>;
+    imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
+    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotKey: string | undefined]>;
+    preparePageImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, options?: import("./types.ts").MatchImageSnapshotOptions | undefined]>;
+    prepareImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("./types.ts").MatchImageSnapshotOptions | undefined]>;
+    loadImageSnapshotResults: import("vitest/node").BrowserCommand<[taskId: string]>;
+};
+//# sourceMappingURL=commands.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../src/server/commands/commands.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ;;;;;;;CAOpB,CAAA"}

package/esm/server/commands/commands.js

@@ -0,0 +1,14 @@
+import { hasImageSnapshot } from "./has_image_snapshot.js";
+import { imageSnapshotNextIndex } from "./image_snapshot_next_index.js";
+import { loadImageSnapshotResults } from "./load_image_snapshot_results.js";
+import { prepareImageSnapshotComparison } from "./prepare_image_snapshot_comparison.js";
+import { preparePageImageSnapshotComparison } from "./prepare_page_image_snapshot_comparison.js";
+import { setupVisSuite } from "./setup_vis_suite.js";
+export const commands = {
+    setupVisSuite,
+    imageSnapshotNextIndex,
+    hasImageSnapshot,
+    preparePageImageSnapshotComparison,
+    prepareImageSnapshotComparison,
+    loadImageSnapshotResults,
+};

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

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

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

@@ -1 +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;AAIjD,MAAM,WAAW,uBAAuB;IACvC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC3G;AAED,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAC5C;IAAC,MAAM,EAAE,MAAM;IAAE,UAAU,EAAE,MAAM,GAAG,SAAS;IAAE,cAAc,EAAE,OAAO;CAAC,CAKzE,CAAA"}
+{"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;AAIjD,MAAM,WAAW,uBAAuB;IACvC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnF;AAED,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAQpG,CAAA"}

package/esm/server/commands/has_image_snapshot.js

@@ -1,6 +1,6 @@
-import { visContext } from "../vis_context.js";
+import { visServerContext } from "../vis_server_context.js";
 import { assertTestPathDefined } from "./_assertions.js";
-export const hasImageSnapshot = async (context, taskId, snapshotId, isAutoSnapshot) => {
+export const hasImageSnapshot = async (context, taskId, snapshotKey) => {
     assertTestPathDefined(context, 'hasImageSnapshot');
-    return visContext.hasImageSnapshot(context, taskId, snapshotId, isAutoSnapshot);
+    return visServerContext.hasImageSnapshot(context, taskId, snapshotKey);
 };

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

@@ -5,5 +5,5 @@ export interface ImageSnapshotNextIndexCommand {
      */
     imageSnapshotNextIndex(taskId: string): Promise<number>;
 }
-export declare const imageSnapshotNextIndex: BrowserCommand<[taskId: string]>;
+export declare const imageSnapshotNextIndex: BrowserCommand<Parameters<ImageSnapshotNextIndexCommand['imageSnapshotNextIndex']>>;
 //# sourceMappingURL=image_snapshot_next_index.d.ts.map

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

@@ -1 +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;AAIjD,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,CAInE,CAAA"}
+{"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;AAIjD,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACvD;AAED,eAAO,MAAM,sBAAsB,EAAE,cAAc,CAClD,UAAU,CAAC,6BAA6B,CAAC,wBAAwB,CAAC,CAAC,CAKnE,CAAA"}

package/esm/server/commands/image_snapshot_next_index.js

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