vitest-plugin-vis 1.4.0 → 1.5.0

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,mBA8D7G;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.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,UAUpF"}
+{"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/config/types.d.ts

@@ -1,11 +1,18 @@
-import type { ToMatchImageSnapshotOptions } from '../client/expect/to_match_image_snapshot.types.ts';
-import type { ComparisonMethod } from '../shared/types.ts';
+import type { ComparisonMethod, ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../shared/types.ts';
 export type { ComparisonMethod };
-export type VisOptions<M extends ComparisonMethod = 'pixel'> = ToMatchImageSnapshotOptions<M> & {
+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.
      *

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;AACpG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE1D,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAEhC,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,2BAA2B,CAAC,CAAC,CAAC,GAAG;IAC/F;;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,CAAA"}
+{"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/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,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"}
+{"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/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

@@ -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;;;;;;;sBAC0kD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CADtjD,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

@@ -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>;

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;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;;;;;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,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":"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/types.d.ts

@@ -4,7 +4,7 @@ export interface ImageSnapshotTimeoutOptions {
     /**
      * Timeout for taking the snapshot.
      *
-     * Default: 5000 ms locally, 30000 ms on CI.
+     * Default: 30000 ms (30 seconds)
      */
     timeout?: number | undefined;
 }
@@ -18,12 +18,7 @@ export interface ImageSnapshotIdOptions {
     customizeSnapshotId?: (id: string, index: number) => string;
 }
 export type ComparisonMethod = 'pixel' | 'ssim';
-export type ImageSnapshotCompareOptions<M extends ComparisonMethod = 'pixel'> = M extends 'ssim' ? {
-    comparisonMethod: M;
-    /**
-     * Custom options passed to 'ssim'
-     */
-    diffOptions?: Partial<SsimOptions> | undefined;
+export type FailureThresholdOptions = {
     /**
      * Failure threshold should measure in `pixel` or `percent`.
      *
@@ -36,23 +31,20 @@ export type ImageSnapshotCompareOptions<M extends ComparisonMethod = 'pixel'> =
      * 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;
-    /**
-     * Failure threshold should measure in `pixel` or `percent`.
-     *
-     * Default is `pixel`.
-     */
-    failureThresholdType?: 'pixel' | 'percent' | undefined;
-    /**
-     * Failure tolerance threshold.
-     *
-     * Default is `0`.
-     */
-    failureThreshold?: number | 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;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,2BAA2B,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,SAAS,MAAM,GAC7F;IACA,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;IAC9C;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,GACA;IACA,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;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,CAAA"}
+{"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.4.0",
+  "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",

package/readme.md

@@ -60,14 +60,16 @@ export default defineConfig({
 	plugins: [
 		vis({
 			preset: 'auto',
-			comparisonMethod: 'pixel',
 			snapshotRootDir: '__vis__',
+			platform: '...', // {process.platform} or `local`
 			customizeSnapshotSubpath: (subpath) => trimCommonFolder(subpath),
 			customizeSnapshotId: (id, index) => `${id}-${index}`,
-			diffOptions: undefined, // pixelmatch options
+			comparisonMethod: 'pixel',
+			// pixelmatch or ssim.js options, depending on `comparisonMethod`.
+			diffOptions: undefined,
 			failureThresholdType: 'pixel',
 			failureThreshold: 0,
-			timeout: 5000 // 30000 on CI
+			timeout: 30000
 		})
 	],
 	test:{
@@ -189,7 +191,7 @@ setAutoSnapshotOptions({
 	diffOptions: { threshold: 0.01 },
 	failureThreshold: 0.01,
 	failureThresholdType: 'percent',
-	timeout: 15000
+	timeout: 60000
 })
 ```
 
@@ -242,7 +244,7 @@ it('manual snapshot with options', async () => {
 		diffOptions: {
 			threshold: 0.1
 		},
-		timeout: 15000
+		timeout: 60000
 	})
 })
 ```
@@ -286,6 +288,7 @@ Please follow its guide to set up your environment.
 
 Bonus note, if you want to install [Firefox] on WSL,
 you can follow these steps: [Install Firefox on Ubuntu 22.04](https://askubuntu.com/a/1444967).
+Also, you may need to `sudo apt-get install xdg-utils` to fix [`xdg-settings: not found`](https://serverfault.com/questions/1091926/running-chrome-on-ubuntu-server-how-to-solve-xdg-settings-not-found-using).
 
 ## Running on CI
 

package/src/client/image_snapshot_matcher.logic.ts

@@ -5,9 +5,10 @@ export function prettifyOptions(options: ToMatchImageSnapshotOptions<any> | unde
 
 	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/src/client/image_snapshot_matcher.ts

@@ -6,6 +6,7 @@ import type { PrepareImageSnapshotComparisonCommand } from '../server/commands/p
 import type { WriteImageSnapshotCommand } from '../server/commands/write_image_snapshot.ts'
 import { isBase64String } from '../shared/base64.ts'
 import { compareImage } from '../shared/compare_image.ts'
+import type { ComparisonMethod } from '../shared/types.ts'
 import { alignImagesToSameSize } from './align_images.ts'
 import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts'
 import { toDataURL, toImageData } from './image_data.ts'
@@ -27,6 +28,8 @@ export function imageSnapshotMatcher(
 
 		if (!info) return
 
+		options = { ...info, ...options } as any
+
 		const baselineImage = await toImageData(info.baseline)
 		const resultImage = await toImageData(info.result)
 		const [baselineAlignedImage, resultAlignedImage] = alignImagesToSameSize(baselineImage, resultImage)

package/src/config/types.ts

@@ -1,38 +1,52 @@
-import type { ToMatchImageSnapshotOptions } from '../client/expect/to_match_image_snapshot.types.ts'
-import type { ComparisonMethod } from '../shared/types.ts'
+import type {
+	ComparisonMethod,
+	ImageSnapshotCompareOptions,
+	ImageSnapshotIdOptions,
+	ImageSnapshotTimeoutOptions,
+} from '../shared/types.ts'
 
 export type { ComparisonMethod }
 
-export type VisOptions<M extends ComparisonMethod = 'pixel'> = ToMatchImageSnapshotOptions<M> & {
-	/**
-	 * Loads the `test.setupFiles` of the specified preset.
-	 */
-	preset?: 'manual' | 'auto' | 'none' | undefined
-	/**
-	 * The snapshot folder relative to the root of the project.
-	 *
-	 * Default: `__vis__`
-	 */
-	snapshotRootDir?: string | undefined
-	/**
-	 * Customize the snapshot subpath.
-	 *
-	 * The snapshot subpath is used along with `snapshotRootDir` to determine the folder of the snapshots:
-	 *
-	 * - baseline: `<snapshotRootDir>/<platform>/<snapshotSubpath>/<snapshotId>.png`
-	 * - result: `<snapshotRootDir>/__results__/<snapshotSubpath>/<snapshotId>.png`
-	 * - diff: `<snapshotRootDir>/__diffs__/<snapshotSubpath>/<snapshotId>.png`
-	 *
-	 * Typically, you place your test files either in a dedicated `tests` folder or in the `src` folder along with your source code.
-	 * By default, the snapshot subpath is the test file path with that folder removed to reduces nesting of the snapshot folders.
-	 *
-	 * If you place your test files in multiple folders,
-	 * such as in both `tests` and `src` folders,
-	 * and they might have files with the same name and create conflicting snapshots,
-	 * you can set this to customize the snapshot subpath.
-	 *
-	 * @param subPath - The path of the test file to be used as the snapshot sub path.
-	 * If you want to keep the full path, you can simply return it.
-	 */
-	customizeSnapshotSubpath?: (subPath: string) => string
-}
+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.
+		 *
+		 * Default: `__vis__`
+		 */
+		snapshotRootDir?: string | undefined
+		/**
+		 * Customize the snapshot subpath.
+		 *
+		 * The snapshot subpath is used along with `snapshotRootDir` to determine the folder of the snapshots:
+		 *
+		 * - baseline: `<snapshotRootDir>/<platform>/<snapshotSubpath>/<snapshotId>.png`
+		 * - result: `<snapshotRootDir>/__results__/<snapshotSubpath>/<snapshotId>.png`
+		 * - diff: `<snapshotRootDir>/__diffs__/<snapshotSubpath>/<snapshotId>.png`
+		 *
+		 * Typically, you place your test files either in a dedicated `tests` folder or in the `src` folder along with your source code.
+		 * By default, the snapshot subpath is the test file path with that folder removed to reduces nesting of the snapshot folders.
+		 *
+		 * If you place your test files in multiple folders,
+		 * such as in both `tests` and `src` folders,
+		 * and they might have files with the same name and create conflicting snapshots,
+		 * you can set this to customize the snapshot subpath.
+		 *
+		 * @param subPath - The path of the test file to be used as the snapshot sub path.
+		 * If you want to keep the full path, you can simply return it.
+		 */
+		customizeSnapshotSubpath?: (subPath: string) => string
+	}

package/src/server/commands/match_image_snapshot.ts

@@ -1,5 +1,4 @@
 import dedent from 'dedent'
-import ci from 'is-ci'
 import { resolve } from 'pathe'
 import { PNG } from 'pngjs'
 import type { BrowserCommand } from 'vitest/node'
@@ -41,7 +40,7 @@ export const matchImageSnapshot: BrowserCommand<
 
 	// 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)

package/src/server/commands/prepare_image_snapshot_comparison.ts

@@ -1,6 +1,11 @@
-import ci from 'is-ci'
 import type { BrowserCommand } from 'vitest/node'
 import { isBase64String } from '../../shared/base64.ts'
+import type {
+	FailureThresholdOptions,
+	ImageSnapshotTimeoutOptions,
+	PixelComparisonOptions,
+	SsimComparisonOptions,
+} from '../../shared/types.ts'
 import { file } from '../file.ts'
 import { takeSnapshot, takeSnapshotByBrowser, writeSnapshot } from '../snapshot.ts'
 import { visContext } from '../vis_context.ts'
@@ -14,7 +19,9 @@ type ImageSnapshotComparisonInfo = {
 	diffPath: string
 	baseline: string
 	result: string
-}
+} & ImageSnapshotTimeoutOptions &
+	FailureThresholdOptions &
+	(SsimComparisonOptions | PixelComparisonOptions)
 
 export interface PrepareImageSnapshotComparisonCommand {
 	prepareImageSnapshotComparison: (
@@ -31,7 +38,7 @@ export const prepareImageSnapshotComparison: BrowserCommand<
 
 	// 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)

package/src/server/vis_context.ctx.ts

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

package/src/server/vis_context.logic.ts

@@ -1,4 +1,5 @@
 import { join, relative } from 'pathe'
+import { pick } from 'type-plus'
 import type { VisOptions } from '../config/types.ts'
 import { DIFF_DIR, RESULT_DIR } from '../shared/constants.ts'
 import { file } from './file.ts'
@@ -67,6 +68,7 @@ export function createVisContext() {
 			const diffPath = join(diffDir, snapshotFilename)
 
 			return {
+				...pick(visOptions, 'comparisonMethod', 'diffOptions', 'failureThreshold', 'failureThresholdType', 'timeout'),
 				baselinePath,
 				resultPath,
 				diffPath,
@@ -102,10 +104,13 @@ export function createVisContext() {
 	return context
 }
 
-async function setupState(suite: PartialBrowserCommandContext, visOptions: Pick<VisOptions, 'snapshotRootDir'>) {
+async function setupState(
+	suite: PartialBrowserCommandContext,
+	visOptions: Pick<VisOptions, 'snapshotRootDir' | 'platform'>,
+) {
 	const snapshotRootDir = resolveSnapshotRootDir(visOptions)
 	const projectPath = suite.project.config.root
-	const platform = ctx.getSnapshotPlatform()
+	const platform = visOptions.platform ?? ctx.getSnapshotPlatform()
 
 	const state = {
 		projectPath,

package/src/setup/create_vis.ts

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

package/src/shared/types.ts

@@ -5,7 +5,7 @@ export interface ImageSnapshotTimeoutOptions {
 	/**
 	 * Timeout for taking the snapshot.
 	 *
-	 * Default: 5000 ms locally, 30000 ms on CI.
+	 * Default: 30000 ms (30 seconds)
 	 */
 	timeout?: number | undefined
 }
@@ -22,42 +22,37 @@ export interface ImageSnapshotIdOptions {
 
 export type ComparisonMethod = 'pixel' | 'ssim'
 
-export type ImageSnapshotCompareOptions<M extends ComparisonMethod = 'pixel'> = M extends 'ssim'
-	? {
-			comparisonMethod: M
-			/**
-			 * Custom options passed to 'ssim'
-			 */
-			diffOptions?: Partial<SsimOptions> | undefined
-			/**
-			 * Failure threshold should measure in `pixel` or `percent`.
-			 *
-			 * Default is `pixel`.
-			 */
-			failureThresholdType?: 'pixel' | 'percent' | undefined
-			/**
-			 * Failure tolerance threshold.
-			 *
-			 * Default is `0`.
-			 */
-			failureThreshold?: number | undefined
-		}
-	: {
-			comparisonMethod?: M | undefined
-			/**
-			 * Custom options passed to 'pixelmatch'
-			 */
-			diffOptions?: PixelmatchOptions | undefined
-			/**
-			 * Failure threshold should measure in `pixel` or `percent`.
-			 *
-			 * Default is `pixel`.
-			 */
-			failureThresholdType?: 'pixel' | 'percent' | undefined
-			/**
-			 * Failure tolerance threshold.
-			 *
-			 * Default is `0`.
-			 */
-			failureThreshold?: number | undefined
-		}
+export type FailureThresholdOptions = {
+	/**
+	 * Failure threshold should measure in `pixel` or `percent`.
+	 *
+	 * Default is `pixel`.
+	 */
+	failureThresholdType?: 'pixel' | 'percent' | undefined
+	/**
+	 * Failure tolerance threshold.
+	 *
+	 * 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