vitest-plugin-vis 2.1.1 → 2.3.0

package/esm/client/ctx.d.ts

@@ -1,5 +1,6 @@
 export declare const ctx: {
-    getCurrentTest: () => import("vitest").RunnerTestCase<object> | undefined;
+    autoEnabled: boolean | undefined;
+    getCurrentTest: () => import("../index.ts").CurrentTest;
     getCurrentSuite: () => import("vitest").SuiteCollector<object>;
     __test__reset(): void;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"ctx.d.ts","sourceRoot":"","sources":["../../src/client/ctx.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,GAAG;;;;CAOf,CAAA"}
+{"version":3,"file":"ctx.d.ts","sourceRoot":"","sources":["../../src/client/ctx.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,GAAG;iBACW,OAAO,GAAG,SAAS;;;;CAQ7C,CAAA"}

package/esm/client/ctx.js

@@ -1,9 +1,11 @@
 import { getCurrentSuite, getCurrentTest } from "./vitest_suite_proxy.js";
 export const ctx = {
+    autoEnabled: undefined,
     getCurrentTest,
     getCurrentSuite,
     __test__reset() {
         ctx.getCurrentTest = getCurrentTest;
         ctx.getCurrentSuite = getCurrentSuite;
+        ctx.autoEnabled = undefined;
     },
 };

package/esm/client/expect/to_match_image_snapshot.d.ts

@@ -1,5 +1,5 @@
 import type { AsyncExpectationResult } from '@vitest/expect';
-import type { ToMatchImageSnapshotOptions } from './to_match_image_snapshot.types.ts';
+import type { ToMatchImageSnapshotOptions } from '../../shared/types.ts';
 export declare function toMatchImageSnapshot(
 /**
  * The element or locator to take the snapshot of,

package/esm/client/expect/to_match_image_snapshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"to_match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAI5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAA;AAErF,wBAAgB,oBAAoB;AACnC;;;GAGG;AACH,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,GAC/C,sBAAsB,CAcxB"}
+{"version":3,"file":"to_match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AAKxE,wBAAgB,oBAAoB;AACnC;;;GAGG;AACH,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,GAC/C,sBAAsB,CAcxB"}

package/esm/client/expect/to_match_image_snapshot.types.d.ts

@@ -1,12 +1,5 @@
-import type { ComparisonMethod, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
+import type { ComparisonMethod, ToMatchImageSnapshotOptions } from '../../shared/types.ts';
 export interface ImageSnapshotMatcher {
     toMatchImageSnapshot<M extends ComparisonMethod>(options?: ToMatchImageSnapshotOptions<M> | undefined): Promise<void>;
 }
-export type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & ImageSnapshotCompareOptions<M> & {
-    /**
-     * Expect the matcher to fail.
-     * If it passes, it will throw an error with details.
-     */
-    expectToFail?: boolean | undefined;
-};
 //# sourceMappingURL=to_match_image_snapshot.types.d.ts.map

package/esm/client/expect/to_match_image_snapshot.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"to_match_image_snapshot.types.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAE9B,MAAM,WAAW,oBAAoB;IACpC,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACrH;AAED,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"}
+{"version":3,"file":"to_match_image_snapshot.types.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AAE1F,MAAM,WAAW,oBAAoB;IACpC,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACrH"}

package/esm/client/image_snapshot_matcher.d.ts

@@ -1,9 +1,8 @@
-import type { Task } from 'vitest';
 import type { ImageSnapshotNextIndexCommand } from '../commands.ts';
 import type { PrepareImageSnapshotComparisonCommand } from '../server/commands/prepare_image_snapshot_comparison.ts';
 import type { WriteImageSnapshotCommand } from '../server/commands/write_image_snapshot.ts';
-import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
-export declare function imageSnapshotMatcher(commands: PrepareImageSnapshotComparisonCommand & WriteImageSnapshotCommand & ImageSnapshotNextIndexCommand): (test: Task, subject: any, options?: ToMatchImageSnapshotOptions<any>) => Promise<void>;
+import type { CurrentTest, ToMatchImageSnapshotOptions } from '../shared/types.ts';
+export declare function imageSnapshotMatcher(commands: PrepareImageSnapshotComparisonCommand & WriteImageSnapshotCommand & ImageSnapshotNextIndexCommand): (test: CurrentTest & {}, subject: any, options?: ToMatchImageSnapshotOptions<any>) => Promise<void>;
 /**
  * @deprecated internalized. Use `matchImageSnapshot` directly instead.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"image_snapshot_matcher.d.ts","sourceRoot":"","sources":["../../src/client/image_snapshot_matcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAA;AACnE,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,yDAAyD,CAAA;AACpH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAI3F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAO5F,wBAAgB,oBAAoB,CACnC,QAAQ,EAAE,qCAAqC,GAAG,yBAAyB,GAAG,6BAA6B,UAE5D,IAAI,WAAW,GAAG,YAAY,2BAA2B,CAAC,GAAG,CAAC,mBAgE7G;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,GAAG,OAOrD"}
+{"version":3,"file":"image_snapshot_matcher.d.ts","sourceRoot":"","sources":["../../src/client/image_snapshot_matcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAA;AACnE,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,yDAAyD,CAAA;AACpH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAG3F,OAAO,KAAK,EAAE,WAAW,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAQlF,wBAAgB,oBAAoB,CACnC,QAAQ,EAAE,qCAAqC,GAAG,yBAAyB,GAAG,6BAA6B,UAGpG,WAAW,GAAG,EAAE,WACb,GAAG,YACF,2BAA2B,CAAC,GAAG,CAAC,mBAoE3C;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,GAAG,OAOrD"}

package/esm/client/image_snapshot_matcher.js

@@ -10,8 +10,11 @@ import { toTaskId } from "./task_id.js";
 import { server } from "./vitest_browser_context_proxy.js";
 export function imageSnapshotMatcher(commands) {
     return async function matchImageSnapshot(test, subject, options) {
+        const isAutoSnapshot = !!test.meta.vis?.isAutoSnapshot;
         const taskId = toTaskId(test);
-        const info = await commands.prepareImageSnapshotComparison(taskId, parseImageSnapshotSubject(subject), options?.customizeSnapshotId ? await parseImageSnapshotOptions(commands, taskId, options) : options);
+        const info = await commands.prepareImageSnapshotComparison(taskId, parseImageSnapshotSubject(subject), options?.customizeSnapshotId
+            ? await parseImageSnapshotOptions(commands, taskId, isAutoSnapshot, options)
+            : options);
         if (!info)
             return;
         options = { ...info, ...options };
@@ -69,9 +72,9 @@ async function writeSnapshot(commands, path, image) {
     const content = (await toDataURL(image)).split(',')[1];
     return commands.writeImageSnapshot(path, content);
 }
-async function parseImageSnapshotOptions(commands, taskId, options) {
+async function parseImageSnapshotOptions(commands, taskId, isAutoSnapshot, options) {
     const index = await commands.imageSnapshotNextIndex(taskId);
     const { customizeSnapshotId, ...rest } = options;
-    const snapshotFileId = customizeSnapshotId({ id: taskId, index });
+    const snapshotFileId = customizeSnapshotId({ id: taskId, index, isAutoSnapshot });
     return { ...rest, snapshotFileId };
 }

package/esm/client/image_snapshot_matcher.logic.d.ts

@@ -1,3 +1,3 @@
-import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
+import type { ToMatchImageSnapshotOptions } from '../shared/types.ts';
 export declare function prettifyOptions(options: ToMatchImageSnapshotOptions<any> | undefined): string;
 //# sourceMappingURL=image_snapshot_matcher.logic.d.ts.map

package/esm/client/image_snapshot_matcher.logic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image_snapshot_matcher.logic.d.ts","sourceRoot":"","sources":["../../src/client/image_snapshot_matcher.logic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAE5F,wBAAgB,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,GAAG,CAAC,GAAG,SAAS,UAWpF"}
+{"version":3,"file":"image_snapshot_matcher.logic.d.ts","sourceRoot":"","sources":["../../src/client/image_snapshot_matcher.logic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAErE,wBAAgB,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,GAAG,CAAC,GAAG,SAAS,UAWpF"}

package/esm/client/page/has_image_snapshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"has_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/page/has_image_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAY,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAInE,MAAM,WAAW,sBAAsB;IACtC,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,oBAoB/F"}
+{"version":3,"file":"has_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/page/has_image_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAY,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAInE,MAAM,WAAW,sBAAsB;IACtC,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,oBAyB/F"}

package/esm/client/page/has_image_snapshot.js

@@ -17,7 +17,7 @@ export function hasImageSnapshot(options) {
     if (options?.customizeSnapshotId) {
         return commands
             .imageSnapshotNextIndex(taskId)
-            .then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId({ id: taskId, index })));
+            .then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId({ id: taskId, index, isAutoSnapshot: !!test.meta.vis?.isAutoSnapshot })));
     }
     return commands.hasImageSnapshot(taskId);
 }

package/esm/client/should_take_snapshot.d.ts

@@ -1,4 +1,4 @@
-import type { SnapshotMeta } from './snapshot_options.ts';
+import type { SnapshotMeta } from '../shared/types.ts';
 /**
  * Determine should snapshot be taken.
  *
@@ -6,5 +6,5 @@ import type { SnapshotMeta } from './snapshot_options.ts';
  * no `snapshot` tag: false
  * disabled by `!snapshot` tag: false
  */
-export declare function shouldTakeSnapshot(meta?: SnapshotMeta<any> | undefined): boolean;
+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":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,SAAS,WAGtE"}
+{"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"}

package/esm/client/should_take_snapshot.js

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

package/esm/client/snapshot_options.d.ts

@@ -1,9 +1,4 @@
-import type { AutoSnapshotOptions, ComparisonMethod } from '../shared/types.ts';
-import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
-export type SnapshotMeta<M extends ComparisonMethod> = ToMatchImageSnapshotOptions<M> & AutoSnapshotOptions & {
-    enable?: boolean | undefined;
-    [key: string]: unknown;
-};
+import type { ComparisonMethod, SnapshotMeta } from '../shared/types.ts';
 type Suite = {
     meta: Record<string, any>;
     suite?: Suite | undefined;
@@ -15,6 +10,7 @@ export type MetaTask = {
     suite?: Suite | undefined;
     meta: Record<string, any>;
 } | undefined;
+export declare function enableAuto(): void;
 /**
  * Set the snapshot options for auto snapshot.
  *
@@ -32,5 +28,6 @@ export type MetaTask = {
  */
 export declare function setAutoSnapshotOptions<M extends ComparisonMethod>(task: MetaTask, meta: SnapshotMeta<M> | boolean): void;
 export declare function setAutoSnapshotOptions<M extends ComparisonMethod>(meta: SnapshotMeta<M> | boolean): void;
+export declare function extractAutoSnapshotOptions<M extends SnapshotMeta<any> = SnapshotMeta<any>>(task: MetaTask): M | undefined;
 export {};
 //# sourceMappingURL=snapshot_options.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snapshot_options.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE/E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAE5F,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;AAEF,KAAK,KAAK,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CAAE,CAAA;AAErE,MAAM,MAAM,QAAQ,GACjB;IACA,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,SAAS,CAAA;IAChD,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxB,GACD,SAAS,CAAA;AAEZ;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gBAAgB,EAChE,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,GAC7B,IAAI,CAAA;AACP,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gBAAgB,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA"}
+{"version":3,"file":"snapshot_options.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGxE,KAAK,KAAK,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CAAE,CAAA;AAErE,MAAM,MAAM,QAAQ,GACjB;IACA,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,SAAS,CAAA;IAChD,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxB,GACD,SAAS,CAAA;AAEZ,wBAAgB,UAAU,SAEzB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gBAAgB,EAChE,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,GAC7B,IAAI,CAAA;AACP,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gBAAgB,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;AAwBzG,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,EACzF,IAAI,EAAE,QAAQ,GACZ,CAAC,GAAG,SAAS,CAkBf"}

package/esm/client/snapshot_options.js

@@ -1,6 +1,8 @@
-import { getCurrentTest } from 'vitest/suite';
 import { NAME } from "../shared/constants.js";
 import { ctx } from "./ctx.js";
+export function enableAuto() {
+    ctx.autoEnabled = true;
+}
 export function setAutoSnapshotOptions(...args) {
     const [task, meta] = parseArgs(args);
     if (task)
@@ -17,3 +19,19 @@ function parseArgs(args) {
 function parseMeta(meta) {
     return typeof meta === 'boolean' ? { enable: meta } : { enable: true, ...meta };
 }
+export function extractAutoSnapshotOptions(task) {
+    if (!task)
+        return;
+    const list = [];
+    let current = task;
+    while (current?.suite) {
+        list.unshift(current.suite.meta);
+        current = current.suite;
+    }
+    list.unshift(task.file?.meta);
+    list.push(task.meta);
+    return list.reduce((acc, cur) => {
+        const meta = cur?.[NAME];
+        return meta ? Object.assign({}, acc, meta) : acc;
+    }, { enable: ctx.autoEnabled });
+}

package/esm/client/vitest_suite_proxy.d.ts

@@ -1,3 +1,4 @@
-export declare const getCurrentTest: () => import("vitest").RunnerTestCase<object> | undefined;
+import type { CurrentTest } from '../shared/types.ts';
+export declare const getCurrentTest: () => CurrentTest;
 export declare const getCurrentSuite: () => import("vitest").SuiteCollector<object>;
 //# sourceMappingURL=vitest_suite_proxy.d.ts.map

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":"AAQA,eAAO,MAAM,cAAc,2DAAsC,CAAA;AACjE,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,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAUrD,eAAO,MAAM,cAAc,QAA0C,WAAW,CAAA;AAChF,eAAO,MAAM,eAAe,+CAAuC,CAAA"}

package/esm/client.d.ts

@@ -2,7 +2,7 @@ export * from './client/expect/expectation_result.ts';
 export type * from './client/expect/to_match_image_snapshot.types.ts';
 export * from './client/image_snapshot_matcher.ts';
 export * from './client/should_take_snapshot.ts';
-export * from './client/snapshot_options.ts';
+export { setAutoSnapshotOptions, type MetaTask } from './client/snapshot_options.ts';
 export * from './client/task_id.ts';
 export type * from './shared/types.ts';
 //# sourceMappingURL=client.d.ts.map

package/esm/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAA;AACrD,mBAAmB,kDAAkD,CAAA;AACrE,cAAc,oCAAoC,CAAA;AAClD,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,qBAAqB,CAAA;AACnC,mBAAmB,mBAAmB,CAAA"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAA;AACrD,mBAAmB,kDAAkD,CAAA;AACrE,cAAc,oCAAoC,CAAA;AAClD,cAAc,kCAAkC,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,KAAK,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACpF,cAAc,qBAAqB,CAAA;AACnC,mBAAmB,mBAAmB,CAAA"}

package/esm/client.js

@@ -1,5 +1,5 @@
 export * from "./client/expect/expectation_result.js";
 export * from "./client/image_snapshot_matcher.js";
 export * from "./client/should_take_snapshot.js";
-export * from "./client/snapshot_options.js";
+export { setAutoSnapshotOptions } from "./client/snapshot_options.js";
 export * from "./client/task_id.js";

package/esm/config/types.d.ts

@@ -4,7 +4,7 @@ export type VisOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTime
     /**
      * Loads the `test.setupFiles` of the specified preset.
      */
-    preset?: 'manual' | 'auto' | 'none' | undefined;
+    preset?: 'enable' | 'manual' | 'auto' | 'none' | undefined;
     /**
      * The name of the subdirectory that the baseline snapshots get saved in.
      *

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,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/C;;;;;;;;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,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAA;QACvC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;KACtC,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,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,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAA;QACvC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;KACtC,KAAK,MAAM,CAAC,GACb,SAAS,CAAA;IACZ;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;CACtD,CAAA"}

package/esm/index.d.ts

@@ -1,4 +1,5 @@
 import './client/expect/augment.ts';
 import './client/page/augment.ts';
-export * from './client/snapshot_options.ts';
+export { setAutoSnapshotOptions, type MetaTask } from './client/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,cAAc,8BAA8B,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,8BAA8B,CAAA;AACpF,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 * from "./client/snapshot_options.js";
+export { setAutoSnapshotOptions } from "./client/snapshot_options.js";

package/esm/presets/enable.d.ts

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

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

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

package/esm/presets/enable.js

@@ -0,0 +1,4 @@
+import { vis } from "../setup/vis.js";
+import "../client/expect/extend.js";
+import "../client/page/extend.js";
+vis.presets.enable();

package/esm/server/vis_context.d.ts

@@ -11,15 +11,17 @@ export declare const visContext: {
         resultPath: string;
         diffPath: string;
         timeout?: number | undefined | undefined;
-        comparisonMethod: any;
-        diffOptions?: Partial<import("ssim.js").Options> | undefined;
         failureThresholdType?: "pixel" | "percent" | undefined | undefined;
         failureThreshold?: number | undefined | undefined;
+        comparisonMethod: any;
+        diffOptions?: Partial<import("ssim.js").Options> | undefined;
     } | {
         baselinePath: string;
         resultPath: string;
         diffPath: string;
         timeout?: number | undefined | undefined;
+        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
+        failureThreshold?: number | undefined | undefined;
         comparisonMethod?: any;
         diffOptions?: {
             threshold?: number | undefined;
@@ -30,8 +32,6 @@ export declare const visContext: {
             diffColorAlt?: [number, number, number] | undefined;
             diffMask?: boolean | undefined;
         } | undefined;
-        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
-        failureThreshold?: number | undefined | undefined;
     };
     getTaskCount(testPath: string, taskId: string): number;
     hasImageSnapshot(testPath: string, taskId: string, snapshotFileId: string | undefined): Promise<boolean>;

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

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

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

@@ -18,15 +18,17 @@ export declare function createVisContext(): {
         resultPath: string;
         diffPath: string;
         timeout?: number | undefined | undefined;
-        comparisonMethod: any;
-        diffOptions?: Partial<import("ssim.js").Options> | undefined;
         failureThresholdType?: "pixel" | "percent" | undefined | undefined;
         failureThreshold?: number | undefined | undefined;
+        comparisonMethod: any;
+        diffOptions?: Partial<import("ssim.js").Options> | undefined;
     } | {
         baselinePath: string;
         resultPath: string;
         diffPath: string;
         timeout?: number | undefined | undefined;
+        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
+        failureThreshold?: number | undefined | undefined;
         comparisonMethod?: any;
         diffOptions?: {
             threshold?: number | undefined;
@@ -37,8 +39,6 @@ export declare function createVisContext(): {
             diffColorAlt?: [number, number, number] | undefined;
             diffMask?: boolean | undefined;
         } | undefined;
-        failureThresholdType?: "pixel" | "percent" | undefined | undefined;
-        failureThreshold?: number | undefined | undefined;
     };
     getTaskCount(testPath: string, taskId: string): number;
     hasImageSnapshot(testPath: string, taskId: string, snapshotFileId: string | undefined): Promise<boolean>;

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

@@ -1 +1 @@
-{"version":3,"file":"vis_context.logic.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.logic.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAKpD,OAAO,KAAK,EAAE,4BAA4B,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAEpF,wBAAgB,gBAAgB;eAMnB,CAAC,SAAS,OAAO,GAAG,MAAM,YAAW,UAAU,CAAC,CAAC,CAAC;;;;IAY7D;;;;OAIG;wBACuB,4BAA4B;8BAa5B,MAAM,QAAQ,MAAM,YAAY;QAAE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkB1E,MAAM,UAAU,MAAM;+BAGlB,MAAM,UAAU,MAAM,kBAAkB,MAAM,GAAG,SAAS;8BAI3D;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,kBAAkB,MAAM,GAAG,SAAS;2BASlF,MAAM,UAAU,MAAM;;;;;;;;;;EAe9C;AAyBD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC;;;;;;;;EAWnH;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,UAElH"}
+{"version":3,"file":"vis_context.logic.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.logic.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAMpD,OAAO,KAAK,EAAE,4BAA4B,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAEpF,wBAAgB,gBAAgB;eAMnB,CAAC,SAAS,OAAO,GAAG,MAAM,YAAW,UAAU,CAAC,CAAC,CAAC;;;;IAY7D;;;;OAIG;wBACuB,4BAA4B;8BAa5B,MAAM,QAAQ,MAAM,YAAY;QAAE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkB1E,MAAM,UAAU,MAAM;+BAGlB,MAAM,UAAU,MAAM,kBAAkB,MAAM,GAAG,SAAS;8BAI3D;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,kBAAkB,MAAM,GAAG,SAAS;2BAWlF,MAAM,UAAU,MAAM;;;;;;;;;;EAe9C;AAyBD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC;;;;;;;;EAWnH;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,UAElH"}

package/esm/server/vis_context.logic.js

@@ -1,5 +1,6 @@
 import { join, relative } from 'pathe';
 import { pick } from 'type-plus';
+import { getCurrentTest } from 'vitest/suite';
 import { BASELINE_DIR, DIFF_DIR, RESULT_DIR } from "../shared/constants.js";
 import { file } from "./file.js";
 import { getSnapshotSubpath, resolveSnapshotRootDir } from "./snapshot_path.js";
@@ -64,10 +65,13 @@ export function createVisContext() {
         getSnapshotFilename(info, snapshotFileId) {
             if (snapshotFileId)
                 return `${snapshotFileId}.png`;
+            const test = getCurrentTest();
+            const isAutoSnapshot = !!test?.meta.vis?.isAutoSnapshot;
             const customizeSnapshotId = visOptions.customizeSnapshotId ?? (({ id, index }) => `${id}-${index}`);
             return `${customizeSnapshotId({
                 id: info.taskId,
                 index: info.task.count,
+                isAutoSnapshot,
             })}.png`;
         },
         getSuiteInfo(testPath, taskId) {

package/esm/setup/create_vis.d.ts

@@ -1,9 +1,21 @@
-import { type SnapshotMeta } from '../client.ts';
+import { type ComparisonMethod, type SnapshotMeta } from '../client.ts';
 import type { SetupVisSuiteCommand } from '../server/commands/setup_vis_suite.ts';
-export declare function createVis<M extends SnapshotMeta<any>>(commands: SetupVisSuiteCommand): {
+/**
+ * Visual test configuration on the client side.
+ */
+export type VisClientConfigurator<SM extends SnapshotMeta<ComparisonMethod>> = {
     presets: {
         /**
-         * Enable manual visual testing.
+         * Enable visual testing.
+         *
+         * auto snapshot is turned off by default.
+         * You can specify the test to take a snapshot during `afterEach()` hook with `setAutoSnapshotOptions()`.
+         */
+        enable(): void;
+        /**
+         * Enable visual testing.
+         *
+         * `setAutoSnapshotOptions` will have no effect in this preset.
          */
         manual(): void;
         /**
@@ -27,14 +39,15 @@ export declare function createVis<M extends SnapshotMeta<any>>(commands: SetupVi
          * })
          * ```
          */
-        theme(themes: Record<string, (options: M) => Promise<boolean> | Promise<void> | boolean | void>): void;
+        theme<M>(themes: Record<string, (options: M & SM) => Promise<boolean> | Promise<void> | boolean | void>): void;
     };
     beforeAll: {
         setup(): Promise<void>;
     };
     afterEach: {
         matchImageSnapshot(): Promise<void>;
-        matchPerTheme(themes: Record<string, (options: M) => Promise<boolean> | Promise<void> | boolean | void>): () => Promise<void>;
+        matchPerTheme<M>(themes: Record<string, (options: M & SM) => Promise<boolean> | Promise<void> | boolean | void>): () => Promise<void>;
     };
 };
+export declare function createVis<SM extends SnapshotMeta<ComparisonMethod>>(commands: SetupVisSuiteCommand): VisClientConfigurator<SM>;
 //# sourceMappingURL=create_vis.d.ts.map

package/esm/setup/create_vis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create_vis.d.ts","sourceRoot":"","sources":["../../src/setup/create_vis.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,YAAY,EAAY,MAAM,cAAc,CAAA;AAI1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAEjF,wBAAgB,SAAS,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,oBAAoB;;QAOlF;;WAEG;;QAIH;;;;WAIG;;QAKH;;;;;;;;;;;;;;WAcG;sBACW,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;;;;;;;8BAqBzE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;;EA4CzG"}
+{"version":3,"file":"create_vis.d.ts","sourceRoot":"","sources":["../../src/setup/create_vis.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,YAAY,EAAY,MAAM,cAAc,CAAA;AAIjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAEjF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,YAAY,CAAC,gBAAgB,CAAC,IAAI;IAC9E,OAAO,EAAE;QACR;;;;;WAKG;QACH,MAAM,IAAI,IAAI,CAAA;QACd;;;;WAIG;QACH,MAAM,IAAI,IAAI,CAAA;QACd;;;;WAIG;QACH,IAAI,IAAI,IAAI,CAAA;QACZ;;;;;;;;;;;;;;WAcG;QACH,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAA;KAC9G,CAAA;IACD,SAAS,EAAE;QACV,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KACtB,CAAA;IACD,SAAS,EAAE;QACV,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;QACnC,aAAa,CAAC,CAAC,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,GAC5F,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACtB,CAAA;CACD,CAAA;AAED,wBAAgB,SAAS,CAAC,EAAE,SAAS,YAAY,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,oBAAoB,6BAoFlG"}

package/esm/setup/create_vis.js

@@ -3,44 +3,23 @@ import { afterEach, beforeAll } from 'vitest';
 import { toTaskId } from "../client.js";
 import { ctx } from "../client/ctx.js";
 import { shouldTakeSnapshot } from "../client/should_take_snapshot.js";
-import { getAutoSnapshotOptions } from '../client/snapshot_options.internal.js';
+import { enableAuto, extractAutoSnapshotOptions } from "../client/snapshot_options.js";
 export function createVis(commands) {
     let subjectDataTestId;
-    /**
-     * Visual test configuration on the client side.
-     */
     const vis = {
         presets: {
-            /**
-             * Enable manual visual testing.
-             */
+            enable() {
+                beforeAll(vis.beforeAll.setup);
+                afterEach(vis.afterEach.matchImageSnapshot);
+            },
             manual() {
                 beforeAll(vis.beforeAll.setup);
             },
-            /**
-             * Enable automatic visual testing.
-             *
-             * This will take a snapshot after each test.
-             */
             auto() {
                 beforeAll(vis.beforeAll.setup);
                 afterEach(vis.afterEach.matchImageSnapshot);
+                enableAuto();
             },
-            /**
-             * Enable automatic visual testing with multiple themes.
-             *
-             * This will take a snapshot after each test for each theme.
-             *
-             * @param themes A record of theme names and their setup functions.
-             *
-             * @example
-             * ```ts
-             * vis().presets.theme({
-             *  light() { document.body.classList.add('light') },
-             *  dark() { document.body.classList.add('dark') },
-             * })
-             * ```
-             */
             theme(themes) {
                 beforeAll(vis.beforeAll.setup);
                 afterEach(vis.afterEach.matchPerTheme(themes));
@@ -56,9 +35,10 @@ export function createVis(commands) {
                 const test = ctx.getCurrentTest();
                 if ((test?.result?.errors?.length ?? 0) > 0)
                     return;
-                const meta = getAutoSnapshotOptions(test);
+                const meta = extractAutoSnapshotOptions(test);
                 if (!shouldTakeSnapshot(meta))
                     return;
+                test.meta.vis = { ...test.meta.vis, isAutoSnapshot: true };
                 await test.context.expect(getSubject(meta?.subjectDataTestId ?? subjectDataTestId)).toMatchImageSnapshot(meta);
             },
             matchPerTheme(themes) {
@@ -66,7 +46,7 @@ export function createVis(commands) {
                     const test = ctx.getCurrentTest();
                     if ((test?.result?.errors?.length ?? 0) > 0)
                         return;
-                    const meta = getAutoSnapshotOptions(test);
+                    const meta = extractAutoSnapshotOptions(test);
                     if (!shouldTakeSnapshot(meta))
                         return;
                     const errors = [];
@@ -81,7 +61,7 @@ export function createVis(commands) {
                                 .toMatchImageSnapshot({
                                 ...meta,
                                 customizeSnapshotId: meta?.customizeSnapshotId
-                                    ? ({ id, index }) => `${meta.customizeSnapshotId({ id, index })}-${themeId}`
+                                    ? ({ id, index }) => `${meta.customizeSnapshotId({ id, index, isAutoSnapshot: true })}-${themeId}`
                                     : ({ id }) => `${id}-${themeId}`,
                             });
                         }

package/esm/setup/vis.d.ts

@@ -1,18 +1,5 @@
 /**
  * Visual test configuration on the client side.
  */
-export declare const vis: {
-    presets: {
-        manual(): void;
-        auto(): void;
-        theme(themes: Record<string, (options: import("../client.ts").SnapshotMeta<any>) => Promise<boolean> | Promise<void> | boolean | void>): void;
-    };
-    beforeAll: {
-        setup(): Promise<void>;
-    };
-    afterEach: {
-        matchImageSnapshot(): Promise<void>;
-        matchPerTheme(themes: Record<string, (options: import("../client.ts").SnapshotMeta<any>) => Promise<boolean> | Promise<void> | boolean | void>): () => Promise<void>;
-    };
-};
+export declare const vis: import("./create_vis.ts").VisClientConfigurator<import("../index.ts").SnapshotMeta<import("../index.ts").ComparisonMethod>>;
 //# sourceMappingURL=vis.d.ts.map

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

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

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 { getCurrentTest } from 'vitest/suite';
+import type { NAME } from './constants.ts';
 export interface ImageSnapshotTimeoutOptions {
     /**
      * Timeout for taking the snapshot.
@@ -18,6 +20,7 @@ export interface ImageSnapshotIdOptions {
     customizeSnapshotId?: (context: {
         id: string;
         index: number;
+        isAutoSnapshot: boolean;
     }) => string;
 }
 export type ComparisonMethod = 'pixel' | 'ssim';
@@ -59,4 +62,22 @@ export type AutoSnapshotOptions = {
      */
     subjectDataTestId?: string | undefined;
 };
+export type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & 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 type CurrentTest = ReturnType<typeof getCurrentTest> & {
+    meta: {
+        [NAME]?: SnapshotMeta<'pixel' | 'ssim'> & {
+            isAutoSnapshot?: boolean | undefined;
+        };
+    };
+};
 //# sourceMappingURL=types.d.ts.map