vitest-plugin-vis 3.0.1 → 3.2.0

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

@@ -1,8 +1,6 @@
-import type { PageImageSnapshotOptions, ToMatchImageSnapshotOptions } from '../../shared/types.ts';
-export interface ToMatchPageImageSnapshotOptions extends ToMatchImageSnapshotOptions, PageImageSnapshotOptions {
-}
+import type { ComparisonMethod, ToMatchPageImageSnapshotOptions } from '../../shared/types.ts';
 export interface ToMatchImageSnapshotAction {
-    toMatchImageSnapshot(options?: ToMatchPageImageSnapshotOptions | undefined): Promise<void>;
+    toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(options?: ToMatchPageImageSnapshotOptions<M> | undefined): Promise<void>;
 }
-export declare function toMatchImageSnapshot(options?: ToMatchPageImageSnapshotOptions | undefined): Promise<void>;
+export declare function toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(options?: ToMatchPageImageSnapshotOptions<M> | undefined): Promise<void>;
 //# sourceMappingURL=to_match_image_snapshot.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"to_match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/page/to_match_image_snapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,wBAAwB,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AAKlG,MAAM,WAAW,+BAAgC,SAAQ,2BAA2B,EAAE,wBAAwB;CAAG;AAEjH,MAAM,WAAW,0BAA0B;IAC1C,oBAAoB,CAAC,OAAO,CAAC,EAAE,+BAA+B,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,CAAC,EAAE,+BAA+B,GAAG,SAAS,iBAczF"}
+{"version":3,"file":"to_match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/page/to_match_image_snapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAA;AAK9F,MAAM,WAAW,0BAA0B;IAC1C,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EACxD,OAAO,CAAC,EAAE,+BAA+B,CAAC,CAAC,CAAC,GAAG,SAAS,GACtD,OAAO,CAAC,IAAI,CAAC,CAAA;CAChB;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EACxE,OAAO,CAAC,EAAE,+BAA+B,CAAC,CAAC,CAAC,GAAG,SAAS,iBAexD"}

package/esm/client-api.d.ts

@@ -2,6 +2,7 @@ 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 * from './client/actions/match_page_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';

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

@@ -1 +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"}
+{"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,cAAc,sDAAsD,CAAA;AACpE,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

@@ -2,6 +2,7 @@ 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 * from "./client/actions/match_page_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";

package/esm/server/snapshot_path.d.ts

@@ -1,5 +1,6 @@
 import type { VisOptions } from '../config/types.ts';
 import type { PartialBrowserCommandContext } from './vis_server_context.types.ts';
 export declare function resolveSnapshotRootDir(browserCommandContext: PartialBrowserCommandContext, options: VisOptions): string;
+export declare function getSnapshotRootDir(snapshotRootDir: string): 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":"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"}
+{"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;AAED,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,UAEzD;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAGjG"}

package/esm/server/snapshot_path.js

@@ -17,10 +17,10 @@ export function resolveSnapshotRootDir(browserCommandContext, options) {
         screenshotDirectory: browserCommandContext.provider.options?.screenshotDirectory,
     });
 }
-function getSnapshotRootDir(snapshotRootDir) {
+export function getSnapshotRootDir(snapshotRootDir) {
     return `${snapshotRootDir}/${ci ? platform : 'local'}`;
 }
 export function getSnapshotSubpath(suiteName, options) {
-    const customizeSnapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath));
-    return customizeSnapshotSubpath({ subpath: suiteName });
+    const snapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath));
+    return snapshotSubpath({ subpath: suiteName });
 }

package/esm/server-utils.d.ts

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

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

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

package/esm/server-utils.js

@@ -1,2 +1,3 @@
+export { getSnapshotRootDir } from "./server/snapshot_path.js";
 export * from "./shared/constants.js";
 export * from "./shared/trim_common_folder.js";

package/esm/shared/types.d.ts

@@ -67,6 +67,7 @@ export type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> =
 export interface PageImageSnapshotOptions {
     fullPage?: boolean | undefined;
 }
+export type ToMatchPageImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ToMatchImageSnapshotOptions<M> & PageImageSnapshotOptions;
 export type SnapshotTestMeta = {
     meta: {
         [NAME]?: SnapshotMeta<ComparisonMethod>;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-plugin-vis",
-  "version": "3.0.1",
+  "version": "3.2.0",
   "description": "Vitest visual testing plugin",
   "keywords": [
     "image-snapshot",
@@ -96,7 +96,7 @@
     "typescript": "^5.7.2",
     "vite": "^6.2.3",
     "vitest": "^3.0.9",
-    "vitest-browser-react": "^0.1.1"
+    "vitest-browser-react": "^0.2.0"
   },
   "peerDependencies": {
     "@vitest/browser": "^2 || ^3",

package/src/client/page/to_match_image_snapshot.ts

@@ -1,16 +1,18 @@
 import { commands } from '@vitest/browser/context'
-import type { PageImageSnapshotOptions, ToMatchImageSnapshotOptions } from '../../shared/types.ts'
+import type { ComparisonMethod, ToMatchPageImageSnapshotOptions } from '../../shared/types.ts'
 import { matchPageImageSnapshotAction } from '../actions/match_page_image_snapshot_action.ts'
 import { ctx } from '../ctx.ts'
 import { toTaskId } from '../task_id.ts'
 
-export interface ToMatchPageImageSnapshotOptions extends ToMatchImageSnapshotOptions, PageImageSnapshotOptions {}
-
 export interface ToMatchImageSnapshotAction {
-	toMatchImageSnapshot(options?: ToMatchPageImageSnapshotOptions | undefined): Promise<void>
+	toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(
+		options?: ToMatchPageImageSnapshotOptions<M> | undefined,
+	): Promise<void>
 }
 
-export function toMatchImageSnapshot(options?: ToMatchPageImageSnapshotOptions | undefined) {
+export function toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(
+	options?: ToMatchPageImageSnapshotOptions<M> | undefined,
+) {
 	const test = ctx.getCurrentTest()
 	if (!test) {
 		throw new Error('`toMatchImageSnapshot()` must be called in a test.')

package/src/client-api.ts

@@ -3,6 +3,7 @@ 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 * from './client/actions/match_page_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'

package/src/server/snapshot_path.ts

@@ -19,11 +19,11 @@ export function resolveSnapshotRootDir(browserCommandContext: PartialBrowserComm
 	})
 }
 
-function getSnapshotRootDir(snapshotRootDir: string) {
+export function getSnapshotRootDir(snapshotRootDir: string) {
 	return `${snapshotRootDir}/${ci ? platform : 'local'}`
 }
 
 export function getSnapshotSubpath(suiteName: string, options: Pick<VisOptions, 'snapshotSubpath'>) {
-	const customizeSnapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath))
-	return customizeSnapshotSubpath({ subpath: suiteName })
+	const snapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath))
+	return snapshotSubpath({ subpath: suiteName })
 }

package/src/server-utils.ts

@@ -1,2 +1,3 @@
+export { getSnapshotRootDir } from './server/snapshot_path.ts'
 export * from './shared/constants.ts'
 export * from './shared/trim_common_folder.ts'

package/src/shared/types.ts

@@ -84,6 +84,9 @@ export interface PageImageSnapshotOptions {
 	fullPage?: boolean | undefined
 }
 
+export type ToMatchPageImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ToMatchImageSnapshotOptions<M> &
+	PageImageSnapshotOptions
+
 export type SnapshotTestMeta = {
 	meta: {
 		[NAME]?: SnapshotMeta<ComparisonMethod>