vitest-plugin-vis 1.3.2 → 1.5.0

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

@@ -1,12 +1,12 @@
-import type { ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
+import type { ComparisonMethod, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
 export interface ImageSnapshotMatcher {
-    toMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>;
+    toMatchImageSnapshot<M extends ComparisonMethod>(options?: ToMatchImageSnapshotOptions<M> | undefined): Promise<void>;
 }
-export interface ToMatchImageSnapshotOptions extends ImageSnapshotTimeoutOptions, ImageSnapshotIdOptions, ImageSnapshotCompareOptions {
+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,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAE9B,MAAM,WAAW,oBAAoB;IACpC,oBAAoB,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACtF;AAED,MAAM,WAAW,2BAChB,SAAQ,2BAA2B,EAClC,sBAAsB,EACtB,2BAA2B;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAClC"}
+{"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"}

package/esm/client/image_snapshot_matcher.d.ts

@@ -3,7 +3,7 @@ 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) => Promise<void>;
+export declare function imageSnapshotMatcher(commands: PrepareImageSnapshotComparisonCommand & WriteImageSnapshotCommand & ImageSnapshotNextIndexCommand): (test: Task, 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,mBA8DxG;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,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;AAK3F,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"}

package/esm/client/image_snapshot_matcher.js

@@ -14,6 +14,7 @@ export function imageSnapshotMatcher(commands) {
         const info = await commands.prepareImageSnapshotComparison(taskId, parseImageSnapshotSubject(subject), options?.customizeSnapshotId ? await parseImageSnapshotOptions(commands, taskId, options) : options);
         if (!info)
             return;
+        options = { ...info, ...options };
         const baselineImage = await toImageData(info.baseline);
         const resultImage = await toImageData(info.result);
         const [baselineAlignedImage, resultAlignedImage] = alignImagesToSameSize(baselineImage, resultImage);

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

@@ -1,3 +1,3 @@
 import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
-export declare function prettifyOptions(options: ToMatchImageSnapshotOptions | undefined): string;
+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,GAAG,SAAS,UAU/E"}
+{"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"}

package/esm/client/image_snapshot_matcher.logic.js

@@ -3,9 +3,10 @@ export function prettifyOptions(options) {
         return 'none';
     return [
         `failureThreshold: ${options.failureThreshold ?? 0} ${options.failureThresholdType ?? 'pixels'}`,
-        options.diffOptions ? `diffOptions: ${JSON.stringify(options.diffOptions)}` : '',
         options.timeout ? `timeout: ${options.timeout} ms` : '',
+        `comparisonMethod: ${options.comparisonMethod ?? 'pixel'}`,
+        options.diffOptions ? `diffOptions: ${JSON.stringify(options.diffOptions)}` : '',
     ]
         .filter(Boolean)
-        .join(', ');
+        .join('\n                 ');
 }

package/esm/client/should_take_snapshot.d.ts

@@ -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 | undefined): boolean;
+export declare function shouldTakeSnapshot(meta?: SnapshotMeta<any> | undefined): boolean;
 //# 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,GAAG,SAAS,WAGjE"}
+{"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"}

package/esm/client/snapshot_options.d.ts

@@ -1,5 +1,6 @@
+import type { ComparisonMethod } from '../shared/types.ts';
 import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
-export type SnapshotMeta = ToMatchImageSnapshotOptions & {
+export type SnapshotMeta<M extends ComparisonMethod> = ToMatchImageSnapshotOptions<M> & {
     enable?: boolean | undefined;
 };
 type Suite = {
@@ -28,7 +29,7 @@ export type MetaTask = {
  * @param task Optional. Suite or task to set the options.
  * If not provided, it will set the options for the current test.
  */
-export declare function setAutoSnapshotOptions(task: MetaTask, meta: SnapshotMeta | boolean): void;
-export declare function setAutoSnapshotOptions(meta: SnapshotMeta | boolean): void;
+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 {};
 //# 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,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAE5F,MAAM,MAAM,YAAY,GAAG,2BAA2B,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,CAAA;AAEzF,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,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,IAAI,CAAA;AAC1F,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,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,MAAM,oBAAoB,CAAA;AAE1D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAE5F,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,IAAI,2BAA2B,CAAC,CAAC,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,CAAA;AAExH,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"}

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

@@ -1,3 +1,3 @@
 import type { MetaTask, SnapshotMeta } from './snapshot_options.ts';
-export declare function getAutoSnapshotOptions(task: MetaTask): SnapshotMeta | undefined;
+export declare function getAutoSnapshotOptions(task: MetaTask): SnapshotMeta<any> | undefined;
 //# sourceMappingURL=snapshot_options.internal.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snapshot_options.internal.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_options.internal.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEnE,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY,GAAG,SAAS,CAkB/E"}
+{"version":3,"file":"snapshot_options.internal.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_options.internal.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEnE,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,SAAS,CAkBpF"}

package/esm/config/types.d.ts

@@ -1,9 +1,18 @@
-import type { ToMatchImageSnapshotOptions } from '../client/expect/to_match_image_snapshot.types.ts';
-export interface VisOptions extends ToMatchImageSnapshotOptions {
+import type { ComparisonMethod, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../shared/types.ts';
+export type { ComparisonMethod };
+export type VisOptions<M extends ComparisonMethod = 'pixel'> = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & ImageSnapshotCompareOptions<M> & {
     /**
      * Loads the `test.setupFiles` of the specified preset.
      */
     preset?: 'manual' | 'auto' | 'none' | undefined;
+    /**
+     * The name of the subdirectory that the baseline snapshots get saved in.
+     *
+     * <snapshotRootDir>/<platform>/<snapshotSubpath>/<snapshotId>.png
+     *
+     * Default: undefined
+     */
+    platform?: string | undefined;
     /**
      * The snapshot folder relative to the root of the project.
      *
@@ -31,5 +40,5 @@ export interface VisOptions extends ToMatchImageSnapshotOptions {
      * If you want to keep the full path, you can simply return it.
      */
     customizeSnapshotSubpath?: (subPath: string) => string;
-}
+};
 //# 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,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAA;AAEpG,MAAM,WAAW,UAAW,SAAQ,2BAA2B;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/C;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;CACtD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,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,GAAG;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;CACtD,CAAA"}

package/esm/config/vis.d.ts

@@ -1,3 +1,4 @@
+import type { ComparisonMethod } from '../shared/types.ts';
 import type { VisOptions } from './types.ts';
 /**
  * Create a Vite plugin for visual testing.
@@ -5,7 +6,7 @@ import type { VisOptions } from './types.ts';
  * If options are not provided, the plugin will use the default options,
  * which enables the `auto` preset.
  */
-export declare function vis(options?: VisOptions): {
+export declare function vis<M extends ComparisonMethod = 'pixel'>(options?: VisOptions<M>): {
     name: string;
     config(this: void): {
         test: {

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,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,OAAO,GAAE,UAA+B;;;;;sBASxB,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/server/commands/match_image_snapshot.d.ts

@@ -3,12 +3,12 @@ import type { ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshot
 export interface MatchImageSnapshotCommand {
     matchImageSnapshot: (taskId: string | undefined, subject: string, options?: MatchImageSnapshotOptions | undefined) => Promise<void>;
 }
-export interface MatchImageSnapshotOptions extends ImageSnapshotTimeoutOptions, ImageSnapshotIdOptions, ImageSnapshotCompareOptions {
+export type MatchImageSnapshotOptions = ImageSnapshotTimeoutOptions & ImageSnapshotIdOptions & ImageSnapshotCompareOptions<any> & {
     /**
      * The snapshot file id calculated on the client side.
      */
     snapshotFileId?: string | undefined;
-}
+};
 export declare const matchImageSnapshot: BrowserCommand<[
     taskId: string,
     subject: string,

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

@@ -1 +1 @@
-{"version":3,"file":"match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/server/commands/match_image_snapshot.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAKjD,OAAO,KAAK,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAM9B,MAAM,WAAW,yBAAyB;IACzC,kBAAkB,EAAE,CACnB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,IAAI,CAAC,CAAA;CAClB;AAED,MAAM,WAAW,yBAChB,SAAQ,2BAA2B,EAClC,sBAAsB,EACtB,2BAA2B;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC;AAED,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAC9C;IAAC,MAAM,EAAE,MAAM;IAAE,OAAO,EAAE,MAAM;IAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CAuElF,CAAA"}
+{"version":3,"file":"match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/server/commands/match_image_snapshot.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAKjD,OAAO,KAAK,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAM9B,MAAM,WAAW,yBAAyB;IACzC,kBAAkB,EAAE,CACnB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,IAAI,CAAC,CAAA;CAClB;AAED,MAAM,MAAM,yBAAyB,GAAG,2BAA2B,GAClE,sBAAsB,GACtB,2BAA2B,CAAC,GAAG,CAAC,GAAG;IAClC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC,CAAA;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAC9C;IAAC,MAAM,EAAE,MAAM;IAAE,OAAO,EAAE,MAAM;IAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CAuElF,CAAA"}

package/esm/server/commands/match_image_snapshot.js

@@ -1,5 +1,4 @@
 import dedent from 'dedent';
-import ci from 'is-ci';
 import { resolve } from 'pathe';
 import { PNG } from 'pngjs';
 import { isBase64String } from "../../shared/base64.js";
@@ -15,7 +14,7 @@ export const matchImageSnapshot = async (context, taskId, subject, options) => {
     // vitest:browser passes in `null` when not defined
     if (!options)
         options = {};
-    options.timeout = options.timeout ?? (ci ? 30000 : 5000);
+    options.timeout = options.timeout ?? 30000;
     const info = visContext.getSnapshotInfo(context.testPath, taskId, options);
     const baselineBuffer = await file.tryReadFile(info.baselinePath);
     if (!baselineBuffer) {

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

@@ -1,4 +1,5 @@
 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 = {
     projectRoot: string;
@@ -7,7 +8,7 @@ type ImageSnapshotComparisonInfo = {
     diffPath: string;
     baseline: string;
     result: string;
-};
+} & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
 export interface PrepareImageSnapshotComparisonCommand {
     prepareImageSnapshotComparison: (taskId: string | undefined, subject: string, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
 }

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;AAMjD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,KAAK,2BAA2B,GAAG;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,WAAW,qCAAqC;IACrD,8BAA8B,EAAE,CAC/B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,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;IAAC,MAAM,EAAE,MAAM;IAAE,UAAU,EAAE,MAAM;IAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CA0BrF,CAAA"}
+{"version":3,"file":"prepare_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_image_snapshot_comparison.ts"],"names":[],"mappings":"AAAA,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,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,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,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,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS;CAAC,CA0BrF,CAAA"}

package/esm/server/commands/prepare_image_snapshot_comparison.js

@@ -1,4 +1,3 @@
-import ci from 'is-ci';
 import { isBase64String } from "../../shared/base64.js";
 import { file } from "../file.js";
 import { takeSnapshot, takeSnapshotByBrowser, writeSnapshot } from "../snapshot.js";
@@ -9,7 +8,7 @@ export const prepareImageSnapshotComparison = async (context, taskId, subject, o
     // vitest:browser passes in `null` when not defined
     if (!options)
         options = {};
-    options.timeout = options.timeout ?? (ci ? 30000 : 5000);
+    options.timeout = options.timeout ?? 30000;
     const info = visContext.getSnapshotInfo(context.testPath, taskId, options);
     const baselineBuffer = await file.tryReadFile(info.baselinePath);
     if (!baselineBuffer) {

package/esm/server/snapshot_path.d.ts

@@ -1,4 +1,4 @@
 import type { VisOptions } from '../config/types.ts';
-export declare function resolveSnapshotRootDir(options: VisOptions | undefined): string;
-export declare function getSnapshotSubpath(suiteName: string, options: VisOptions): string;
+export declare function resolveSnapshotRootDir(options: Pick<VisOptions, 'snapshotRootDir'> | undefined): string;
+export declare function getSnapshotSubpath(suiteName: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): 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":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAIpD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,UAErE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,UAGxE"}
+{"version":3,"file":"snapshot_path.d.ts","sourceRoot":"","sources":["../../src/server/snapshot_path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAIpD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GAAG,SAAS,UAE9F;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,UAG1G"}

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

@@ -1 +1 @@
-{"version":3,"file":"vis_context.ctx.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.ctx.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,GAAG;;6CAQ2qD,CAAC;2CAAkF,CAAC;iDAA8E,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;6CAA0E,CAAC;+CAA0F,CAAC;;gDAAoF,CAAC;+CAA4E,CAAC;+CAA0F,CAAC;;kDAAsF,CAAC;kDAA+E,CAAC;+CAA0F,CAAC;;qDAAyF,CAAC;;;CAFtlG,CAAA"}
+{"version":3,"file":"vis_context.ctx.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.ctx.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,GAAG;;6CAOksD,CAAC;2CAAkF,CAAC;iDAA8E,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;8CAA2E,CAAC;+CAA0F,CAAC;;iDAAqF,CAAC;6CAA0E,CAAC;+CAA0F,CAAC;;gDAAoF,CAAC;+CAA4E,CAAC;+CAA0F,CAAC;;kDAAsF,CAAC;kDAA+E,CAAC;+CAA0F,CAAC;;qDAAyF,CAAC;;;CAF7mG,CAAA"}

package/esm/server/vis_context.ctx.js

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

package/esm/server/vis_context.d.ts

@@ -1,6 +1,6 @@
 export declare const visContext: {
-    setOptions(options?: import("../config.ts").VisOptions): void;
-    __test__getOptions(): import("../config.ts").VisOptions;
+    setOptions<M extends "pixel" | "ssim">(options?: import("../config.ts").VisOptions<M>): void;
+    __test__getOptions(): import("../config.ts").VisOptions<any>;
     __test__reset(): void;
     __test__getState(): import("./vis_context.types.ts").VisState;
     setupSuite(context: import("./vis_context.logic.ts").PartialBrowserCommandContext): Promise<void>;
@@ -10,6 +10,20 @@ export declare const visContext: {
         baselinePath: string;
         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;
+    } | {
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+        timeout?: number | undefined | undefined;
+        comparisonMethod?: any;
+        diffOptions?: import("pixelmatch").PixelmatchOptions | 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;;;;;;;sBAC+hD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CAD3gD,CAAA"}
+{"version":3,"file":"vis_context.d.ts","sourceRoot":"","sources":["../../src/server/vis_context.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU;;;;;;;sBAC2mD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADvlD,CAAA"}

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

@@ -14,8 +14,8 @@ export type PartialBrowserCommandContext = {
     testPath: string;
 };
 export declare function createVisContext(): {
-    setOptions(options?: VisOptions): void;
-    __test__getOptions(): VisOptions;
+    setOptions<M extends "pixel" | "ssim">(options?: VisOptions<M>): void;
+    __test__getOptions(): VisOptions<any>;
     __test__reset(): void;
     __test__getState(): VisState;
     /**
@@ -30,6 +30,20 @@ export declare function createVisContext(): {
         baselinePath: string;
         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;
+    } | {
+        baselinePath: string;
+        resultPath: string;
+        diffPath: string;
+        timeout?: number | undefined | undefined;
+        comparisonMethod?: any;
+        diffOptions?: import("pixelmatch").PixelmatchOptions | 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>;
@@ -50,7 +64,7 @@ export declare function createVisContext(): {
         };
     };
 };
-export declare function createSuite(state: VisState, testPath: string, options: VisOptions): {
+export declare function createSuite(state: VisState, testPath: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): {
     suiteId: string;
     suite: {
         baselineDir: string;
@@ -59,5 +73,5 @@ export declare function createSuite(state: VisState, testPath: string, options:
         tasks: {};
     };
 };
-export declare function getSuiteId(state: VisState, testPath: string, options: VisOptions): string;
+export declare function getSuiteId(state: VisState, testPath: string, options: Pick<VisOptions, 'customizeSnapshotSubpath'>): string;
 //# sourceMappingURL=vis_context.logic.d.ts.map

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":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAKpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAEtD,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,EAAE;QACR,MAAM,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,eAAe,EAAE;gBAChB,cAAc,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;aACtC,CAAA;YACD,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,MAAM,CAAA;SACnB,CAAA;KACD,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,wBAAgB,gBAAgB;yBAMV,UAAU;;;;IAY9B;;;;OAIG;wBACuB,4BAA4B;8BAY5B,MAAM,QAAQ,MAAM,YAAY;QAAE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;;;;;2BAiB1E,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;2BAMlF,MAAM,UAAU,MAAM;;;;;;;;;;EAe9C;AAuBD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;;;;;;;;EAWjF;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,UAEhF"}
+{"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,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAEtD,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,EAAE;QACR,MAAM,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,eAAe,EAAE;gBAChB,cAAc,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;aACtC,CAAA;YACD,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,MAAM,CAAA;SACnB,CAAA;KACD,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,wBAAgB,gBAAgB;eAMnB,CAAC,SAAS,OAAO,GAAG,MAAM,YAAW,UAAU,CAAC,CAAC,CAAC;;;;IAY7D;;;;OAIG;wBACuB,4BAA4B;8BAY5B,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;2BAMlF,MAAM,UAAU,MAAM;;;;;;;;;;EAe9C;AA0BD,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,4 +1,5 @@
 import { join, relative } from 'pathe';
+import { pick } from 'type-plus';
 import { DIFF_DIR, RESULT_DIR } from "../shared/constants.js";
 import { file } from "./file.js";
 import { getSnapshotSubpath, resolveSnapshotRootDir } from "./snapshot_path.js";
@@ -46,6 +47,7 @@ export function createVisContext() {
             const resultPath = join(resultDir, snapshotFilename);
             const diffPath = join(diffDir, snapshotFilename);
             return {
+                ...pick(visOptions, 'comparisonMethod', 'diffOptions', 'failureThreshold', 'failureThresholdType', 'timeout'),
                 baselinePath,
                 resultPath,
                 diffPath,
@@ -83,7 +85,7 @@ export function createVisContext() {
 async function setupState(suite, visOptions) {
     const snapshotRootDir = resolveSnapshotRootDir(visOptions);
     const projectPath = suite.project.config.root;
-    const platform = ctx.getSnapshotPlatform();
+    const platform = visOptions.platform ?? ctx.getSnapshotPlatform();
     const state = {
         projectPath,
         platform,

package/esm/setup/create_vis.js

@@ -86,7 +86,7 @@ export function createVis(commands) {
                             .map(([themeId, error]) => {
                             return `Theme \`${themeId}\` failed: ${error.message}`;
                         })
-                            .join('\n')}`);
+                            .join('\n\n')}`);
                     }
                 };
             },

package/esm/shared/compare_image.d.ts

@@ -1,5 +1,5 @@
-import type { ImageSnapshotCompareOptions } from './types.ts';
-export declare function compareImage(img1: Uint8ClampedArray | Buffer, img2: Uint8ClampedArray | Buffer, output: Uint8ClampedArray | Buffer, width: number, height: number, { failureThreshold, failureThresholdType, diffOptions }?: ImageSnapshotCompareOptions): {
+import type { ComparisonMethod, ImageSnapshotCompareOptions } from './types.ts';
+export declare function compareImage<M extends ComparisonMethod>(img1: Uint8ClampedArray | Buffer, img2: Uint8ClampedArray | Buffer, output: Uint8ClampedArray | Buffer, width: number, height: number, options?: ImageSnapshotCompareOptions<M>): {
     pass: boolean;
     diffAmount: number;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"compare_image.d.ts","sourceRoot":"","sources":["../../src/shared/compare_image.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAE7D,wBAAgB,YAAY,CAC3B,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAChC,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAChC,MAAM,EAAE,iBAAiB,GAAG,MAAM,EAClC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,EAAE,gBAAoB,EAAE,oBAA8B,EAAE,WAAW,EAAE,GAAE,2BAAgC;;;EASvG"}
+{"version":3,"file":"compare_image.d.ts","sourceRoot":"","sources":["../../src/shared/compare_image.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAE/E,wBAAgB,YAAY,CAAC,CAAC,SAAS,gBAAgB,EACtD,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAChC,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAChC,MAAM,EAAE,iBAAiB,GAAG,MAAM,EAClC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,2BAA2B,CAAC,CAAC,CAAa;;;EAenD"}

package/esm/shared/compare_image.js

@@ -1,10 +1,42 @@
 import pixelmatch from 'pixelmatch';
+import { ssim } from 'ssim.js';
 import { convertThresholdUnit } from "./convert_threshold_unit.js";
-export function compareImage(img1, img2, output, width, height, { failureThreshold = 0, failureThresholdType = 'pixel', diffOptions } = {}) {
-    const pixelDiff = pixelmatch(img1, img2, output, width, height, diffOptions);
-    const diffAmount = convertThresholdUnit({ failureThresholdType, width, height }, pixelDiff);
+export function compareImage(img1, img2, output, width, height, options = {}) {
+    const pixelDiff = options.comparisonMethod === 'ssim'
+        ? compareWithSsim(img1, img2, output, width, height, options.diffOptions)
+        : pixelmatch(img1, img2, output, width, height, options.diffOptions);
+    const diffAmount = convertThresholdUnit({ failureThresholdType: options.failureThresholdType ?? 'pixel', width, height }, pixelDiff);
     return {
-        pass: diffAmount <= failureThreshold,
+        pass: diffAmount <= (options.failureThreshold ?? 0),
         diffAmount,
     };
 }
+/**
+ * @author This code is based on `jest-image-snapshot` implementation.
+ */
+function compareWithSsim(img1, img2, output, width, height, diffOptions) {
+    const newImage = { data: img1, width: width, height: height };
+    const baselineImage = { data: img2, width: width, height: height };
+    const { ssim_map, mssim } = ssim(newImage, baselineImage, {
+        ssim: 'bezkrovny',
+        ...diffOptions,
+    });
+    // Converts the SSIM value to different pixels based on image width and height
+    // conforms to how pixelmatch works.
+    const diffPixels = Math.round((1 - mssim) * width * height);
+    const diffRgbaPixels = new DataView(output.buffer, output.byteOffset);
+    for (let ln = 0; ln !== height; ++ln) {
+        for (let pos = 0; pos !== width; ++pos) {
+            const rPos = ln * width + pos;
+            // initial value is transparent.  We'll add in the SSIM offset.
+            // red (ff) green (00) blue (00) alpha (00)
+            const diffValue = 0xff000000 +
+                Math.floor(0xff *
+                    (1 -
+                        ssim_map.data[ssim_map.width * Math.round((ssim_map.height * ln) / height) +
+                            Math.round((ssim_map.width * pos) / width)]));
+            diffRgbaPixels.setUint32(rPos * 4, diffValue);
+        }
+    }
+    return diffPixels;
+}

package/esm/shared/types.d.ts

@@ -1,9 +1,10 @@
 import type { PixelmatchOptions } from 'pixelmatch';
+import type { Options as SsimOptions } from 'ssim.js';
 export interface ImageSnapshotTimeoutOptions {
     /**
      * Timeout for taking the snapshot.
      *
-     * Default: 5000 ms locally, 30000 ms on CI.
+     * Default: 30000 ms (30 seconds)
      */
     timeout?: number | undefined;
 }
@@ -16,11 +17,8 @@ export interface ImageSnapshotIdOptions {
      */
     customizeSnapshotId?: (id: string, index: number) => string;
 }
-export interface ImageSnapshotCompareOptions {
-    /**
-     * Custom options passed to 'pixelmatch'
-     */
-    diffOptions?: PixelmatchOptions | undefined;
+export type ComparisonMethod = 'pixel' | 'ssim';
+export type FailureThresholdOptions = {
     /**
      * Failure threshold should measure in `pixel` or `percent`.
      *
@@ -33,5 +31,20 @@ export interface ImageSnapshotCompareOptions {
      * Default is `0`.
      */
     failureThreshold?: number | undefined;
-}
+};
+export type SsimComparisonOptions<M = 'ssim'> = {
+    comparisonMethod: M;
+    /**
+     * Custom options passed to 'ssim'
+     */
+    diffOptions?: Partial<SsimOptions> | undefined;
+};
+export type PixelComparisonOptions<M = 'pixel'> = {
+    comparisonMethod?: M | undefined;
+    /**
+     * Custom options passed to 'pixelmatch'
+     */
+    diffOptions?: PixelmatchOptions | undefined;
+};
+export type ImageSnapshotCompareOptions<M extends ComparisonMethod = 'pixel'> = (M extends 'ssim' ? SsimComparisonOptions<M> : PixelComparisonOptions<M>) & FailureThresholdOptions;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACtC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC3D;AAED,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;IAC3C;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,SAAS,CAAA;AAErD,MAAM,WAAW,2BAA2B;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACtC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC3D;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAA;AAE/C,MAAM,MAAM,uBAAuB,GAAG;IACrC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,MAAM,IAAI;IAC/C,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;CAC9C,CAAA;AACD,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IACjD,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,MAAM,GAC9F,qBAAqB,CAAC,CAAC,CAAC,GACxB,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC5B,uBAAuB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-plugin-vis",
-  "version": "1.3.2",
+  "version": "1.5.0",
   "description": "Vitest visual testing plugin",
   "keywords": [
     "image-snapshot",
@@ -54,6 +54,7 @@
     },
     "./package.json": "./package.json"
   },
+  "types": "./esm/index.d.ts",
   "files": [
     "esm",
     "src",
@@ -68,6 +69,7 @@
     "pixelmatch": "^6.0.0",
     "pngjs": "^7.0.0",
     "rimraf": "^6.0.1",
+    "ssim.js": "^3.5.0",
     "type-plus": "^8.0.0-beta.6"
   },
   "devDependencies": {