vitest-plugin-vis 5.0.0 → 5.1.1

package/dist/server/testing/stubSuite.d.mts

@@ -0,0 +1,17 @@
+import { ExtendedBrowserCommandContext } from "../vis_server_context.types.mjs";
+import { RecursivePartial } from "type-plus";
+import * as vite0 from "vite";
+import { TestUserConfig } from "vitest/node";
+
+//#region src/server/testing/stubSuite.d.ts
+declare function stubSuite(partialUserConfig?: RecursivePartial<{
+  test?: {
+    name?: TestUserConfig['name'];
+  };
+}>, partialBrowserCommandContext?: RecursivePartial<ExtendedBrowserCommandContext>): {
+  userConfig: vite0.UserConfig;
+  browserCommandContext: ExtendedBrowserCommandContext;
+};
+//#endregion
+export { stubSuite };
+//# sourceMappingURL=stubSuite.d.mts.map

package/dist/server/testing/stubSuite.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubSuite.d.mts","names":[],"sources":["../../../src/server/testing/stubSuite.ts"],"sourcesContent":[],"mappings":";;;;;;iBAOgB,SAAA,kBACuC,GAAnC;;WAAmC;EADvC,CAAA;CACuC,CAAA,EAAA,4BAAA,CAAA,EACxB,gBADwB,CACP,6BADO,CAAA,CAAA,EAAA;EAAnC,UAAA,EAC2B,KAAA,CAAA,UAD3B;EAC4B,qBAAA,+BAAA;CAAjB"}

package/dist/server/testing/stubSuite.mjs

@@ -0,0 +1,23 @@
+import { stubBrowserCommandContext } from "./stubBrowserCommandContext.mjs";
+import { stubUserConfig } from "./stubUserConfig.mjs";
+import { resolve } from "pathe";
+import { requiredDeep } from "type-plus";
+
+//#region src/server/testing/stubSuite.ts
+function stubSuite(partialUserConfig = {}, partialBrowserCommandContext = {}) {
+	const root = resolve(import.meta.dirname, "../..");
+	return {
+		userConfig: stubUserConfig({
+			root,
+			...partialUserConfig
+		}),
+		browserCommandContext: stubBrowserCommandContext(requiredDeep({ project: {
+			config: { root },
+			runner: { config: { name: partialUserConfig.test?.name } }
+		} }, partialBrowserCommandContext))
+	};
+}
+
+//#endregion
+export { stubSuite };
+//# sourceMappingURL=stubSuite.mjs.map

package/dist/server/testing/stubSuite.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubSuite.mjs","names":[],"sources":["../../../src/server/testing/stubSuite.ts"],"sourcesContent":["import { resolve } from 'pathe'\nimport { requiredDeep, type RecursivePartial } from 'type-plus'\nimport type { TestUserConfig } from 'vitest/node'\nimport type { ExtendedBrowserCommandContext } from '../vis_server_context.types.ts'\nimport { stubBrowserCommandContext } from './stubBrowserCommandContext.ts'\nimport { stubUserConfig } from './stubUserConfig.ts'\n\nexport function stubSuite(\n\tpartialUserConfig: RecursivePartial<{ test?: { name?: TestUserConfig['name'] } }> = {},\n\tpartialBrowserCommandContext: RecursivePartial<ExtendedBrowserCommandContext> = {},\n) {\n\tconst root = resolve(import.meta.dirname, '../..')\n\tconst userConfig = stubUserConfig({\n\t\troot,\n\t\t...partialUserConfig,\n\t})\n\tconst browserCommandContext = stubBrowserCommandContext(\n\t\trequiredDeep<RecursivePartial<ExtendedBrowserCommandContext>>(\n\t\t\t{\n\t\t\t\tproject: {\n\t\t\t\t\tconfig: { root },\n\t\t\t\t\trunner: {\n\t\t\t\t\t\tconfig: {\n\t\t\t\t\t\t\tname: partialUserConfig.test?.name as string | undefined,\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tpartialBrowserCommandContext,\n\t\t),\n\t)\n\treturn {\n\t\tuserConfig,\n\t\tbrowserCommandContext,\n\t}\n}\n"],"mappings":";;;;;;AAOA,SAAgB,UACf,oBAAoF,EAAE,EACtF,+BAAgF,EAAE,EACjF;CACD,MAAM,OAAO,QAAQ,OAAO,KAAK,SAAS,QAAQ;AAoBlD,QAAO;EACN,YApBkB,eAAe;GACjC;GACA,GAAG;GACH,CAAC;EAkBD,uBAjB6B,0BAC7B,aACC,EACC,SAAS;GACR,QAAQ,EAAE,MAAM;GAChB,QAAQ,EACP,QAAQ,EACP,MAAM,kBAAkB,MAAM,MAC9B,EACD;GACD,EACD,EACD,6BACA,CACD;EAIA"}

package/dist/server/testing/stubUserConfig.mjs

@@ -0,0 +1,8 @@
+import { stub } from "type-plus";
+
+//#region src/server/testing/stubUserConfig.ts
+const stubUserConfig = stub.build((stub$1) => ({ ...stub$1 }));
+
+//#endregion
+export { stubUserConfig };
+//# sourceMappingURL=stubUserConfig.mjs.map

package/dist/server/testing/stubUserConfig.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubUserConfig.mjs","names":["stub"],"sources":["../../../src/server/testing/stubUserConfig.ts"],"sourcesContent":["import { stub } from 'type-plus'\nimport type { ViteUserConfig } from 'vitest/config'\n\nexport const stubUserConfig = stub.build<ViteUserConfig>((stub) => ({\n\t...stub,\n}))\n"],"mappings":";;;AAGA,MAAa,iBAAiB,KAAK,OAAuB,YAAU,EACnE,GAAGA,QACH,EAAE"}

package/dist/server/vis_options.d.mts

@@ -0,0 +1,120 @@
+import { PixelDiffOptions } from "../shared/types.mjs";
+import { ExtendedBrowserCommandContext } from "./vis_server_context.types.mjs";
+import "../index.mjs";
+import * as ssim_js0 from "ssim.js";
+import { TestUserConfig } from "vitest/node";
+
+//#region src/server/vis_options.d.ts
+
+declare function getVisOption(context: ExtendedBrowserCommandContext): {
+  comparisonMethod: any;
+  diffOptions?: Partial<ssim_js0.Options> | undefined;
+  failureThresholdType?: "pixel" | "percent" | undefined;
+  failureThreshold?: number | undefined;
+  timeout?: number | undefined;
+  snapshotKey?: string | undefined;
+  subject?: string | undefined;
+  preset?: "manual" | "auto" | "custom" | undefined;
+  snapshotRootDir?: string | ((context: {
+    ci: boolean;
+    rootDir: string;
+    projectName?: string | undefined;
+    browserName?: string | undefined;
+    providerName: string;
+    platform: string;
+    screenshotFailures?: boolean | undefined;
+    screenshotDirectory?: string | undefined;
+  }) => string) | undefined;
+  snapshotSubpath?: ((options: {
+    subpath: string;
+  }) => string) | undefined;
+  shortenLongSnapshotPaths?: boolean | undefined;
+} | {
+  comparisonMethod: any;
+  diffOptions?: {
+    threshold?: number | undefined;
+    includeAA?: boolean | undefined;
+    alpha?: number | undefined;
+    aaColor?: [number, number, number] | undefined;
+    diffColor?: [number, number, number] | undefined;
+    diffColorAlt?: [number, number, number] | undefined;
+    diffMask?: boolean | undefined;
+  } | Partial<ssim_js0.Options> | undefined;
+  failureThresholdType?: "pixel" | "percent" | undefined;
+  failureThreshold?: number | undefined;
+  timeout?: number | undefined;
+  snapshotKey?: string | undefined;
+  subject?: string | undefined;
+  preset?: "manual" | "auto" | "custom" | undefined;
+  snapshotRootDir?: string | ((context: {
+    ci: boolean;
+    rootDir: string;
+    projectName?: string | undefined;
+    browserName?: string | undefined;
+    providerName: string;
+    platform: string;
+    screenshotFailures?: boolean | undefined;
+    screenshotDirectory?: string | undefined;
+  }) => string) | undefined;
+  snapshotSubpath?: ((options: {
+    subpath: string;
+  }) => string) | undefined;
+  shortenLongSnapshotPaths?: boolean | undefined;
+} | {
+  comparisonMethod: any;
+  diffOptions?: {
+    threshold?: number | undefined;
+    includeAA?: boolean | undefined;
+    alpha?: number | undefined;
+    aaColor?: [number, number, number] | undefined;
+    diffColor?: [number, number, number] | undefined;
+    diffColorAlt?: [number, number, number] | undefined;
+    diffMask?: boolean | undefined;
+  } | Partial<ssim_js0.Options> | undefined;
+  failureThresholdType?: "pixel" | "percent" | undefined;
+  failureThreshold?: number | undefined;
+  timeout?: number | undefined;
+  snapshotKey?: string | undefined;
+  subject?: string | undefined;
+  preset?: "manual" | "auto" | "custom" | undefined;
+  snapshotRootDir?: string | ((context: {
+    ci: boolean;
+    rootDir: string;
+    projectName?: string | undefined;
+    browserName?: string | undefined;
+    providerName: string;
+    platform: string;
+    screenshotFailures?: boolean | undefined;
+    screenshotDirectory?: string | undefined;
+  }) => string) | undefined;
+  snapshotSubpath?: ((options: {
+    subpath: string;
+  }) => string) | undefined;
+  shortenLongSnapshotPaths?: boolean | undefined;
+} | {
+  comparisonMethod?: any;
+  diffOptions?: PixelDiffOptions | undefined;
+  failureThresholdType?: "pixel" | "percent" | undefined;
+  failureThreshold?: number | undefined;
+  timeout?: number | undefined;
+  snapshotKey?: string | undefined;
+  subject?: string | undefined;
+  preset?: "manual" | "auto" | "custom" | undefined;
+  snapshotRootDir?: string | ((context: {
+    ci: boolean;
+    rootDir: string;
+    projectName?: string | undefined;
+    browserName?: string | undefined;
+    providerName: string;
+    platform: string;
+    screenshotFailures?: boolean | undefined;
+    screenshotDirectory?: string | undefined;
+  }) => string) | undefined;
+  snapshotSubpath?: ((options: {
+    subpath: string;
+  }) => string) | undefined;
+  shortenLongSnapshotPaths?: boolean | undefined;
+};
+//#endregion
+export { getVisOption };
+//# sourceMappingURL=vis_options.d.mts.map

package/dist/server/vis_options.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_options.d.mts","names":[],"sources":["../../src/server/vis_options.ts"],"sourcesContent":[],"mappings":";;;;;;;;iBA6BgB,YAAA,UAAsB;;wBAA6B,QAAA,CAAA,OAAA"}

package/dist/server/vis_options.mjs

@@ -11,7 +11,13 @@ function setVisOption(userConfig, options) {
 	visOptions[id] = options;
 }
 function getVisOption(context) {
-	return visOptions[getProjectName(context) || DEFAULT_PROJECT_NAME] ?? {};
+	const id = getProjectName(context) || DEFAULT_PROJECT_NAME;
+	const base = visOptions[DEFAULT_PROJECT_NAME] ?? {};
+	const override = visOptions[id] ?? {};
+	return {
+		...base,
+		...override
+	};
 }
 
 //#endregion

package/dist/server/vis_options.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vis_options.mjs","names":[],"sources":["../../src/server/vis_options.ts"],"sourcesContent":["import type { TestUserConfig } from 'vitest/node'\nimport type { VisOptions } from '../config/types.ts'\nimport { assertSnapshotKeyWithoutDash } from '../shared/asserts.ts'\nimport { getProjectName } from './project.ts'\nimport type { ExtendedBrowserCommandContext } from './vis_server_context.types.ts'\n\nconst DEFAULT_PROJECT_NAME = '__default'\n\nconst visOptions: Record<string, VisOptions<any> | undefined> = {}\n\nexport function setVisOption(\n\tuserConfig: { test?: { name?: TestUserConfig['name'] | undefined } },\n\toptions: VisOptions<any> | undefined,\n) {\n\tassertSnapshotKeyWithoutDash(options?.snapshotKey)\n\n\tconst name = userConfig.test?.name\n\tconst id = typeof name === 'string' ? name : typeof name === 'object' ? name?.label : DEFAULT_PROJECT_NAME\n\n\tvisOptions[id] = options\n}\n\nexport function getVisOption(context: ExtendedBrowserCommandContext) {\n\tconst id = getProjectName(context) || DEFAULT_PROJECT_NAME\n\treturn visOptions[id] ?? {}\n}\n"],"mappings":";;;;AAMA,MAAM,uBAAuB;AAE7B,MAAM,aAA0D,EAAE;AAElE,SAAgB,aACf,YACA,SACC;AACD,8BAA6B,SAAS,YAAY;CAElD,MAAM,OAAO,WAAW,MAAM;CAC9B,MAAM,KAAK,OAAO,SAAS,WAAW,OAAO,OAAO,SAAS,WAAW,MAAM,QAAQ;AAEtF,YAAW,MAAM;;AAGlB,SAAgB,aAAa,SAAwC;AAEpE,QAAO,WADI,eAAe,QAAQ,IAAI,yBACb,EAAE"}
+{"version":3,"file":"vis_options.mjs","names":[],"sources":["../../src/server/vis_options.ts"],"sourcesContent":["import type { TestUserConfig } from 'vitest/node'\nimport type { VisOptions } from '../config/types.ts'\nimport { assertSnapshotKeyWithoutDash } from '../shared/asserts.ts'\nimport { getProjectName } from './project.ts'\nimport type { ExtendedBrowserCommandContext } from './vis_server_context.types.ts'\n\nconst DEFAULT_PROJECT_NAME = '__default'\n\nconst visOptions: Record<string, VisOptions<any> | undefined> = {}\n\n/** Clears stored options (for tests that share this module). */\nexport function clearVisOptionsRegistryForTesting() {\n\tfor (const key of Object.keys(visOptions)) {\n\t\tdelete visOptions[key]\n\t}\n}\n\nexport function setVisOption(\n\tuserConfig: { test?: { name?: TestUserConfig['name'] | undefined } },\n\toptions: VisOptions<any> | undefined,\n) {\n\tassertSnapshotKeyWithoutDash(options?.snapshotKey)\n\n\tconst name = userConfig.test?.name\n\tconst id = typeof name === 'string' ? name : typeof name === 'object' ? name?.label : DEFAULT_PROJECT_NAME\n\n\tvisOptions[id] = options\n}\n\nexport function getVisOption(context: ExtendedBrowserCommandContext) {\n\tconst id = getProjectName(context) || DEFAULT_PROJECT_NAME\n\tconst base = visOptions[DEFAULT_PROJECT_NAME] ?? {}\n\tconst override = visOptions[id] ?? {}\n\treturn { ...base, ...override }\n}\n"],"mappings":";;;;AAMA,MAAM,uBAAuB;AAE7B,MAAM,aAA0D,EAAE;AASlE,SAAgB,aACf,YACA,SACC;AACD,8BAA6B,SAAS,YAAY;CAElD,MAAM,OAAO,WAAW,MAAM;CAC9B,MAAM,KAAK,OAAO,SAAS,WAAW,OAAO,OAAO,SAAS,WAAW,MAAM,QAAQ;AAEtF,YAAW,MAAM;;AAGlB,SAAgB,aAAa,SAAwC;CACpE,MAAM,KAAK,eAAe,QAAQ,IAAI;CACtC,MAAM,OAAO,WAAW,yBAAyB,EAAE;CACnD,MAAM,WAAW,WAAW,OAAO,EAAE;AACrC,QAAO;EAAE,GAAG;EAAM,GAAG;EAAU"}

package/dist/server/vis_server_context.logic.mjs

@@ -1,4 +1,5 @@
 import { file } from "./externals/file.mjs";
+import { absoluteSnapshotFilePath, getLegacySnapshotFilename, resolveLegacySnapshotFileRelativePath } from "./snapshot_path_limits.mjs";
 import { getVisOption } from "./vis_options.mjs";
 import { getSuite, getTaskSubpath } from "./suite.mjs";
 import { basename, join, resolve } from "pathe";
@@ -9,14 +10,17 @@ function createVisServerContext() {
 	const context = {
 		async getSnapshotResults(browserContext, taskId) {
 			const suiteInfo = await context.getSuiteInfo(browserContext, taskId);
-			const baselines = await file.glob(join(suiteInfo.projectRoot, suiteInfo.baselineDir, `${suiteInfo.taskId}-*.png`));
-			const results = await file.glob(join(suiteInfo.projectRoot, suiteInfo.resultDir, `${suiteInfo.taskId}-*.png`));
-			const diffs = await file.glob(join(suiteInfo.projectRoot, suiteInfo.diffDir, `${suiteInfo.taskId}-*.png`));
+			const legacyPattern = join(resolve(suiteInfo.projectRoot, suiteInfo.baselineDir), `${suiteInfo.taskId}-*.png`);
+			const baselines = await file.glob(legacyPattern);
+			const resultPattern = join(resolve(suiteInfo.projectRoot, suiteInfo.resultDir), `${suiteInfo.taskId}-*.png`);
+			const results = await file.glob(resultPattern);
+			const diffPattern = join(resolve(suiteInfo.projectRoot, suiteInfo.diffDir), `${suiteInfo.taskId}-*.png`);
+			const diffs = await file.glob(diffPattern);
 			const r = [];
 			await Promise.all(baselines.map(async (baselinePath) => {
 				const filename = basename(baselinePath);
-				const resultPath = results.find((r$1) => r$1.endsWith(filename));
-				const diffPath = diffs.find((d) => d.endsWith(filename));
+				const resultPath = results.find((p) => p.endsWith(filename));
+				const diffPath = diffs.find((p) => p.endsWith(filename));
 				const baselineBuffer = await file.tryReadFile(baselinePath);
 				const resultBuffer = await file.tryReadFile(resultPath);
 				const diffBuffer = await file.tryReadFile(diffPath);
@@ -33,7 +37,7 @@ function createVisServerContext() {
 			const suiteInfo = await context.getSuiteInfo(browserContext, taskId);
 			const snapshotFilename = context.getSnapshotFilename(browserContext, suiteInfo, options?.snapshotKey);
 			const { baselineDir, resultDir, diffDir, task } = suiteInfo;
-			task.count = task.count + 1;
+			task.count += 1;
 			const baselinePath = join(baselineDir, snapshotFilename);
 			const resultPath = join(resultDir, snapshotFilename);
 			const diffPath = join(diffDir, snapshotFilename);
@@ -49,13 +53,36 @@ function createVisServerContext() {
 		},
 		async hasImageSnapshot(browserContext, taskId, snapshotKey) {
 			const info = await context.getSuiteInfo(browserContext, taskId);
-			return file.existFile(resolve(info.projectRoot, info.baselineDir, context.getSnapshotFilename(browserContext, info, snapshotKey)));
+			const visOptions = getVisOption(browserContext);
+			const legacyFilename = getLegacySnapshotFilename({
+				taskId: info.taskId,
+				explicitSnapshotKey: snapshotKey,
+				defaultSnapshotKey: typeof visOptions.snapshotKey === "string" ? visOptions.snapshotKey : void 0,
+				taskCount: info.task.count
+			});
+			const filename = resolveLegacySnapshotFileRelativePath({
+				projectRoot: info.projectRoot,
+				baselineDir: info.baselineDir,
+				legacySnapshotFilename: legacyFilename,
+				shortenLongSnapshotPaths: visOptions.shortenLongSnapshotPaths === true
+			});
+			const legacyAbs = absoluteSnapshotFilePath(info.projectRoot, info.baselineDir, filename);
+			return file.existFile(legacyAbs);
 		},
 		getSnapshotFilename(browserContext, info, snapshotKey) {
-			if (snapshotKey) return `${info.taskId}-${snapshotKey}.png`;
 			const visOptions = getVisOption(browserContext);
-			if (typeof visOptions.snapshotKey === "string") return `${info.taskId}-${visOptions.snapshotKey}.png`;
-			return `${info.taskId}-${info.task.count}.png`;
+			const legacyFilename = getLegacySnapshotFilename({
+				taskId: info.taskId,
+				explicitSnapshotKey: snapshotKey,
+				defaultSnapshotKey: typeof visOptions.snapshotKey === "string" ? visOptions.snapshotKey : void 0,
+				taskCount: info.task.count
+			});
+			return resolveLegacySnapshotFileRelativePath({
+				projectRoot: info.projectRoot,
+				baselineDir: info.baselineDir,
+				legacySnapshotFilename: legacyFilename,
+				shortenLongSnapshotPaths: visOptions.shortenLongSnapshotPaths === true
+			});
 		},
 		async getSuiteInfo(browserContext, taskId) {
 			const projectState = await getSuite(browserContext);

package/dist/server/vis_server_context.logic.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vis_server_context.logic.mjs","names":["r"],"sources":["../../src/server/vis_server_context.logic.ts"],"sourcesContent":["import { basename, join, resolve } from 'pathe'\nimport { pick } from 'type-plus'\nimport type { ImageSnapshotKeyOptions } from '../client-api.ts'\nimport type { ImageSnapshotResult } from '../shared/commands.types.ts'\nimport { file } from './externals/file.ts'\nimport { getSuite, getTaskSubpath } from './suite.ts'\nimport { getVisOption } from './vis_options.ts'\nimport type { ExtendedBrowserCommandContext } from './vis_server_context.types.ts'\n\nexport function createVisServerContext() {\n\tconst context = {\n\t\tasync getSnapshotResults(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\tconst suiteInfo = await context.getSuiteInfo(browserContext, taskId)\n\t\t\tconst baselines = await file.glob(join(suiteInfo.projectRoot, suiteInfo.baselineDir, `${suiteInfo.taskId}-*.png`))\n\t\t\tconst results = await file.glob(join(suiteInfo.projectRoot, suiteInfo.resultDir, `${suiteInfo.taskId}-*.png`))\n\t\t\tconst diffs = await file.glob(join(suiteInfo.projectRoot, suiteInfo.diffDir, `${suiteInfo.taskId}-*.png`))\n\n\t\t\tconst r: ImageSnapshotResult[] = []\n\t\t\tawait Promise.all(\n\t\t\t\tbaselines.map(async (baselinePath) => {\n\t\t\t\t\tconst filename = basename(baselinePath)\n\t\t\t\t\tconst resultPath = results.find((r) => r.endsWith(filename))\n\t\t\t\t\tconst diffPath = diffs.find((d) => d.endsWith(filename))\n\n\t\t\t\t\tconst baselineBuffer = await file.tryReadFile(baselinePath)\n\t\t\t\t\tconst resultBuffer = await file.tryReadFile(resultPath)\n\t\t\t\t\tconst diffBuffer = await file.tryReadFile(diffPath)\n\t\t\t\t\tr.push({\n\t\t\t\t\t\tfilename,\n\t\t\t\t\t\tbaseline: baselineBuffer?.toString('base64'),\n\t\t\t\t\t\tresult: resultBuffer?.toString('base64'),\n\t\t\t\t\t\tdiff: diffBuffer?.toString('base64'),\n\t\t\t\t\t})\n\t\t\t\t}),\n\t\t\t)\n\t\t\treturn r\n\t\t},\n\t\tasync getSnapshotInfo(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\ttaskId: string,\n\t\t\toptions?: ImageSnapshotKeyOptions,\n\t\t) {\n\t\t\tconst suiteInfo = await context.getSuiteInfo(browserContext, taskId)\n\t\t\tconst snapshotFilename = context.getSnapshotFilename(browserContext, suiteInfo, options?.snapshotKey)\n\n\t\t\tconst { baselineDir, resultDir, diffDir, task } = suiteInfo\n\n\t\t\ttask.count = task.count + 1\n\t\t\tconst baselinePath = join(baselineDir, snapshotFilename)\n\t\t\tconst resultPath = join(resultDir, snapshotFilename)\n\t\t\tconst diffPath = join(diffDir, snapshotFilename)\n\n\t\t\treturn {\n\t\t\t\t...pick(\n\t\t\t\t\tgetVisOption(browserContext),\n\t\t\t\t\t'comparisonMethod',\n\t\t\t\t\t'diffOptions',\n\t\t\t\t\t'failureThreshold',\n\t\t\t\t\t'failureThresholdType',\n\t\t\t\t\t'timeout',\n\t\t\t\t),\n\t\t\t\tbaselinePath,\n\t\t\t\tresultPath,\n\t\t\t\tdiffPath,\n\t\t\t}\n\t\t},\n\n\t\tasync getTaskCount(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\treturn (await context.getSuiteInfo(browserContext, taskId)).task.count\n\t\t},\n\t\tasync hasImageSnapshot(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\ttaskId: string,\n\t\t\tsnapshotKey: string | undefined,\n\t\t) {\n\t\t\tconst info = await context.getSuiteInfo(browserContext, taskId)\n\n\t\t\treturn file.existFile(\n\t\t\t\tresolve(info.projectRoot, info.baselineDir, context.getSnapshotFilename(browserContext, info, snapshotKey)),\n\t\t\t)\n\t\t},\n\t\tgetSnapshotFilename(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\tinfo: { taskId: string; task: { count: number } },\n\t\t\tsnapshotKey: string | undefined,\n\t\t) {\n\t\t\tif (snapshotKey) return `${info.taskId}-${snapshotKey}.png`\n\t\t\tconst visOptions = getVisOption(browserContext)\n\t\t\tif (typeof visOptions.snapshotKey === 'string') {\n\t\t\t\treturn `${info.taskId}-${visOptions.snapshotKey}.png`\n\t\t\t}\n\t\t\treturn `${info.taskId}-${info.task.count}.png`\n\t\t},\n\t\tasync getSuiteInfo(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\tconst projectState = await getSuite(browserContext)\n\t\t\tconst visOptions = getVisOption(browserContext)\n\t\t\tconst moduleId = getTaskSubpath(projectState, browserContext.testPath, visOptions)\n\t\t\tconst m = projectState.modules[moduleId]!\n\t\t\tconst task = (m.tasks[taskId] = m.tasks[taskId] ?? { count: 1 })\n\t\t\treturn {\n\t\t\t\tprojectRoot: projectState.projectRoot,\n\t\t\t\tsuiteId: moduleId,\n\t\t\t\ttaskId,\n\t\t\t\tbaselineDir: m.baselineDir,\n\t\t\t\tresultDir: m.resultDir,\n\t\t\t\tdiffDir: m.diffDir,\n\t\t\t\ttask,\n\t\t\t}\n\t\t},\n\t}\n\treturn context\n}\n"],"mappings":";;;;;;;AASA,SAAgB,yBAAyB;CACxC,MAAM,UAAU;EACf,MAAM,mBAAmB,gBAA+C,QAAgB;GACvF,MAAM,YAAY,MAAM,QAAQ,aAAa,gBAAgB,OAAO;GACpE,MAAM,YAAY,MAAM,KAAK,KAAK,KAAK,UAAU,aAAa,UAAU,aAAa,GAAG,UAAU,OAAO,QAAQ,CAAC;GAClH,MAAM,UAAU,MAAM,KAAK,KAAK,KAAK,UAAU,aAAa,UAAU,WAAW,GAAG,UAAU,OAAO,QAAQ,CAAC;GAC9G,MAAM,QAAQ,MAAM,KAAK,KAAK,KAAK,UAAU,aAAa,UAAU,SAAS,GAAG,UAAU,OAAO,QAAQ,CAAC;GAE1G,MAAM,IAA2B,EAAE;AACnC,SAAM,QAAQ,IACb,UAAU,IAAI,OAAO,iBAAiB;IACrC,MAAM,WAAW,SAAS,aAAa;IACvC,MAAM,aAAa,QAAQ,MAAM,QAAMA,IAAE,SAAS,SAAS,CAAC;IAC5D,MAAM,WAAW,MAAM,MAAM,MAAM,EAAE,SAAS,SAAS,CAAC;IAExD,MAAM,iBAAiB,MAAM,KAAK,YAAY,aAAa;IAC3D,MAAM,eAAe,MAAM,KAAK,YAAY,WAAW;IACvD,MAAM,aAAa,MAAM,KAAK,YAAY,SAAS;AACnD,MAAE,KAAK;KACN;KACA,UAAU,gBAAgB,SAAS,SAAS;KAC5C,QAAQ,cAAc,SAAS,SAAS;KACxC,MAAM,YAAY,SAAS,SAAS;KACpC,CAAC;KACD,CACF;AACD,UAAO;;EAER,MAAM,gBACL,gBACA,QACA,SACC;GACD,MAAM,YAAY,MAAM,QAAQ,aAAa,gBAAgB,OAAO;GACpE,MAAM,mBAAmB,QAAQ,oBAAoB,gBAAgB,WAAW,SAAS,YAAY;GAErG,MAAM,EAAE,aAAa,WAAW,SAAS,SAAS;AAElD,QAAK,QAAQ,KAAK,QAAQ;GAC1B,MAAM,eAAe,KAAK,aAAa,iBAAiB;GACxD,MAAM,aAAa,KAAK,WAAW,iBAAiB;GACpD,MAAM,WAAW,KAAK,SAAS,iBAAiB;AAEhD,UAAO;IACN,GAAG,KACF,aAAa,eAAe,EAC5B,oBACA,eACA,oBACA,wBACA,UACA;IACD;IACA;IACA;IACA;;EAGF,MAAM,aAAa,gBAA+C,QAAgB;AACjF,WAAQ,MAAM,QAAQ,aAAa,gBAAgB,OAAO,EAAE,KAAK;;EAElE,MAAM,iBACL,gBACA,QACA,aACC;GACD,MAAM,OAAO,MAAM,QAAQ,aAAa,gBAAgB,OAAO;AAE/D,UAAO,KAAK,UACX,QAAQ,KAAK,aAAa,KAAK,aAAa,QAAQ,oBAAoB,gBAAgB,MAAM,YAAY,CAAC,CAC3G;;EAEF,oBACC,gBACA,MACA,aACC;AACD,OAAI,YAAa,QAAO,GAAG,KAAK,OAAO,GAAG,YAAY;GACtD,MAAM,aAAa,aAAa,eAAe;AAC/C,OAAI,OAAO,WAAW,gBAAgB,SACrC,QAAO,GAAG,KAAK,OAAO,GAAG,WAAW,YAAY;AAEjD,UAAO,GAAG,KAAK,OAAO,GAAG,KAAK,KAAK,MAAM;;EAE1C,MAAM,aAAa,gBAA+C,QAAgB;GACjF,MAAM,eAAe,MAAM,SAAS,eAAe;GACnD,MAAM,aAAa,aAAa,eAAe;GAC/C,MAAM,WAAW,eAAe,cAAc,eAAe,UAAU,WAAW;GAClF,MAAM,IAAI,aAAa,QAAQ;GAC/B,MAAM,OAAQ,EAAE,MAAM,UAAU,EAAE,MAAM,WAAW,EAAE,OAAO,GAAG;AAC/D,UAAO;IACN,aAAa,aAAa;IAC1B,SAAS;IACT;IACA,aAAa,EAAE;IACf,WAAW,EAAE;IACb,SAAS,EAAE;IACX;IACA;;EAEF;AACD,QAAO"}
+{"version":3,"file":"vis_server_context.logic.mjs","names":[],"sources":["../../src/server/vis_server_context.logic.ts"],"sourcesContent":["import { basename, join, resolve } from 'pathe'\nimport { pick } from 'type-plus'\nimport type { ImageSnapshotKeyOptions } from '../exports/client-api.ts'\nimport type { ImageSnapshotResult } from '../shared/commands.types.ts'\nimport { file } from './externals/file.ts'\nimport {\n\tabsoluteSnapshotFilePath,\n\tgetLegacySnapshotFilename,\n\tresolveLegacySnapshotFileRelativePath,\n} from './snapshot_path_limits.ts'\nimport { getSuite, getTaskSubpath } from './suite.ts'\nimport { getVisOption } from './vis_options.ts'\nimport type { ExtendedBrowserCommandContext } from './vis_server_context.types.ts'\n\nexport function createVisServerContext() {\n\tconst context = {\n\t\tasync getSnapshotResults(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\tconst suiteInfo = await context.getSuiteInfo(browserContext, taskId)\n\t\t\tconst base = resolve(suiteInfo.projectRoot, suiteInfo.baselineDir)\n\n\t\t\tconst legacyPattern = join(base, `${suiteInfo.taskId}-*.png`)\n\t\t\tconst baselines = await file.glob(legacyPattern)\n\n\t\t\tconst resultPattern = join(resolve(suiteInfo.projectRoot, suiteInfo.resultDir), `${suiteInfo.taskId}-*.png`)\n\t\t\tconst results = await file.glob(resultPattern)\n\n\t\t\tconst diffPattern = join(resolve(suiteInfo.projectRoot, suiteInfo.diffDir), `${suiteInfo.taskId}-*.png`)\n\t\t\tconst diffs = await file.glob(diffPattern)\n\n\t\t\tconst r: ImageSnapshotResult[] = []\n\t\t\tawait Promise.all(\n\t\t\t\tbaselines.map(async (baselinePath) => {\n\t\t\t\t\tconst filename = basename(baselinePath)\n\t\t\t\t\tconst resultPath = results.find((p) => p.endsWith(filename))\n\t\t\t\t\tconst diffPath = diffs.find((p) => p.endsWith(filename))\n\n\t\t\t\t\tconst baselineBuffer = await file.tryReadFile(baselinePath)\n\t\t\t\t\tconst resultBuffer = await file.tryReadFile(resultPath)\n\t\t\t\t\tconst diffBuffer = await file.tryReadFile(diffPath)\n\t\t\t\t\tr.push({\n\t\t\t\t\t\tfilename,\n\t\t\t\t\t\tbaseline: baselineBuffer?.toString('base64'),\n\t\t\t\t\t\tresult: resultBuffer?.toString('base64'),\n\t\t\t\t\t\tdiff: diffBuffer?.toString('base64'),\n\t\t\t\t\t})\n\t\t\t\t}),\n\t\t\t)\n\t\t\treturn r\n\t\t},\n\t\tasync getSnapshotInfo(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\ttaskId: string,\n\t\t\toptions?: ImageSnapshotKeyOptions,\n\t\t) {\n\t\t\tconst suiteInfo = await context.getSuiteInfo(browserContext, taskId)\n\t\t\tconst snapshotFilename = context.getSnapshotFilename(browserContext, suiteInfo, options?.snapshotKey)\n\n\t\t\tconst { baselineDir, resultDir, diffDir, task } = suiteInfo\n\n\t\t\ttask.count += 1\n\t\t\tconst baselinePath = join(baselineDir, snapshotFilename)\n\t\t\tconst resultPath = join(resultDir, snapshotFilename)\n\t\t\tconst diffPath = join(diffDir, snapshotFilename)\n\n\t\t\treturn {\n\t\t\t\t...pick(\n\t\t\t\t\tgetVisOption(browserContext),\n\t\t\t\t\t'comparisonMethod',\n\t\t\t\t\t'diffOptions',\n\t\t\t\t\t'failureThreshold',\n\t\t\t\t\t'failureThresholdType',\n\t\t\t\t\t'timeout',\n\t\t\t\t),\n\t\t\t\tbaselinePath,\n\t\t\t\tresultPath,\n\t\t\t\tdiffPath,\n\t\t\t}\n\t\t},\n\n\t\tasync getTaskCount(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\treturn (await context.getSuiteInfo(browserContext, taskId)).task.count\n\t\t},\n\t\tasync hasImageSnapshot(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\ttaskId: string,\n\t\t\tsnapshotKey: string | undefined,\n\t\t) {\n\t\t\tconst info = await context.getSuiteInfo(browserContext, taskId)\n\t\t\tconst visOptions = getVisOption(browserContext)\n\t\t\tconst legacyFilename = getLegacySnapshotFilename({\n\t\t\t\ttaskId: info.taskId,\n\t\t\t\texplicitSnapshotKey: snapshotKey,\n\t\t\t\tdefaultSnapshotKey: typeof visOptions.snapshotKey === 'string' ? visOptions.snapshotKey : undefined,\n\t\t\t\ttaskCount: info.task.count,\n\t\t\t})\n\t\t\tconst filename = resolveLegacySnapshotFileRelativePath({\n\t\t\t\tprojectRoot: info.projectRoot,\n\t\t\t\tbaselineDir: info.baselineDir,\n\t\t\t\tlegacySnapshotFilename: legacyFilename,\n\t\t\t\tshortenLongSnapshotPaths: visOptions.shortenLongSnapshotPaths === true,\n\t\t\t})\n\t\t\tconst legacyAbs = absoluteSnapshotFilePath(info.projectRoot, info.baselineDir, filename)\n\t\t\treturn file.existFile(legacyAbs)\n\t\t},\n\t\tgetSnapshotFilename(\n\t\t\tbrowserContext: ExtendedBrowserCommandContext,\n\t\t\tinfo: { taskId: string; task: { count: number }; suiteId: string; baselineDir: string; projectRoot: string },\n\t\t\tsnapshotKey: string | undefined,\n\t\t) {\n\t\t\tconst visOptions = getVisOption(browserContext)\n\t\t\tconst legacyFilename = getLegacySnapshotFilename({\n\t\t\t\ttaskId: info.taskId,\n\t\t\t\texplicitSnapshotKey: snapshotKey,\n\t\t\t\tdefaultSnapshotKey: typeof visOptions.snapshotKey === 'string' ? visOptions.snapshotKey : undefined,\n\t\t\t\ttaskCount: info.task.count,\n\t\t\t})\n\t\t\treturn resolveLegacySnapshotFileRelativePath({\n\t\t\t\tprojectRoot: info.projectRoot,\n\t\t\t\tbaselineDir: info.baselineDir,\n\t\t\t\tlegacySnapshotFilename: legacyFilename,\n\t\t\t\tshortenLongSnapshotPaths: visOptions.shortenLongSnapshotPaths === true,\n\t\t\t})\n\t\t},\n\t\tasync getSuiteInfo(browserContext: ExtendedBrowserCommandContext, taskId: string) {\n\t\t\tconst projectState = await getSuite(browserContext)\n\t\t\tconst visOptions = getVisOption(browserContext)\n\t\t\tconst moduleId = getTaskSubpath(projectState, browserContext.testPath, visOptions)\n\t\t\tconst m = projectState.modules[moduleId]!\n\t\t\tconst task = (m.tasks[taskId] = m.tasks[taskId] ?? { count: 1 })\n\t\t\treturn {\n\t\t\t\tprojectRoot: projectState.projectRoot,\n\t\t\t\tsuiteId: moduleId,\n\t\t\t\ttaskId,\n\t\t\t\tbaselineDir: m.baselineDir,\n\t\t\t\tresultDir: m.resultDir,\n\t\t\t\tdiffDir: m.diffDir,\n\t\t\t\ttask,\n\t\t\t}\n\t\t},\n\t}\n\treturn context\n}\n"],"mappings":";;;;;;;;AAcA,SAAgB,yBAAyB;CACxC,MAAM,UAAU;EACf,MAAM,mBAAmB,gBAA+C,QAAgB;GACvF,MAAM,YAAY,MAAM,QAAQ,aAAa,gBAAgB,OAAO;GAGpE,MAAM,gBAAgB,KAFT,QAAQ,UAAU,aAAa,UAAU,YAAY,EAEjC,GAAG,UAAU,OAAO,QAAQ;GAC7D,MAAM,YAAY,MAAM,KAAK,KAAK,cAAc;GAEhD,MAAM,gBAAgB,KAAK,QAAQ,UAAU,aAAa,UAAU,UAAU,EAAE,GAAG,UAAU,OAAO,QAAQ;GAC5G,MAAM,UAAU,MAAM,KAAK,KAAK,cAAc;GAE9C,MAAM,cAAc,KAAK,QAAQ,UAAU,aAAa,UAAU,QAAQ,EAAE,GAAG,UAAU,OAAO,QAAQ;GACxG,MAAM,QAAQ,MAAM,KAAK,KAAK,YAAY;GAE1C,MAAM,IAA2B,EAAE;AACnC,SAAM,QAAQ,IACb,UAAU,IAAI,OAAO,iBAAiB;IACrC,MAAM,WAAW,SAAS,aAAa;IACvC,MAAM,aAAa,QAAQ,MAAM,MAAM,EAAE,SAAS,SAAS,CAAC;IAC5D,MAAM,WAAW,MAAM,MAAM,MAAM,EAAE,SAAS,SAAS,CAAC;IAExD,MAAM,iBAAiB,MAAM,KAAK,YAAY,aAAa;IAC3D,MAAM,eAAe,MAAM,KAAK,YAAY,WAAW;IACvD,MAAM,aAAa,MAAM,KAAK,YAAY,SAAS;AACnD,MAAE,KAAK;KACN;KACA,UAAU,gBAAgB,SAAS,SAAS;KAC5C,QAAQ,cAAc,SAAS,SAAS;KACxC,MAAM,YAAY,SAAS,SAAS;KACpC,CAAC;KACD,CACF;AACD,UAAO;;EAER,MAAM,gBACL,gBACA,QACA,SACC;GACD,MAAM,YAAY,MAAM,QAAQ,aAAa,gBAAgB,OAAO;GACpE,MAAM,mBAAmB,QAAQ,oBAAoB,gBAAgB,WAAW,SAAS,YAAY;GAErG,MAAM,EAAE,aAAa,WAAW,SAAS,SAAS;AAElD,QAAK,SAAS;GACd,MAAM,eAAe,KAAK,aAAa,iBAAiB;GACxD,MAAM,aAAa,KAAK,WAAW,iBAAiB;GACpD,MAAM,WAAW,KAAK,SAAS,iBAAiB;AAEhD,UAAO;IACN,GAAG,KACF,aAAa,eAAe,EAC5B,oBACA,eACA,oBACA,wBACA,UACA;IACD;IACA;IACA;IACA;;EAGF,MAAM,aAAa,gBAA+C,QAAgB;AACjF,WAAQ,MAAM,QAAQ,aAAa,gBAAgB,OAAO,EAAE,KAAK;;EAElE,MAAM,iBACL,gBACA,QACA,aACC;GACD,MAAM,OAAO,MAAM,QAAQ,aAAa,gBAAgB,OAAO;GAC/D,MAAM,aAAa,aAAa,eAAe;GAC/C,MAAM,iBAAiB,0BAA0B;IAChD,QAAQ,KAAK;IACb,qBAAqB;IACrB,oBAAoB,OAAO,WAAW,gBAAgB,WAAW,WAAW,cAAc;IAC1F,WAAW,KAAK,KAAK;IACrB,CAAC;GACF,MAAM,WAAW,sCAAsC;IACtD,aAAa,KAAK;IAClB,aAAa,KAAK;IAClB,wBAAwB;IACxB,0BAA0B,WAAW,6BAA6B;IAClE,CAAC;GACF,MAAM,YAAY,yBAAyB,KAAK,aAAa,KAAK,aAAa,SAAS;AACxF,UAAO,KAAK,UAAU,UAAU;;EAEjC,oBACC,gBACA,MACA,aACC;GACD,MAAM,aAAa,aAAa,eAAe;GAC/C,MAAM,iBAAiB,0BAA0B;IAChD,QAAQ,KAAK;IACb,qBAAqB;IACrB,oBAAoB,OAAO,WAAW,gBAAgB,WAAW,WAAW,cAAc;IAC1F,WAAW,KAAK,KAAK;IACrB,CAAC;AACF,UAAO,sCAAsC;IAC5C,aAAa,KAAK;IAClB,aAAa,KAAK;IAClB,wBAAwB;IACxB,0BAA0B,WAAW,6BAA6B;IAClE,CAAC;;EAEH,MAAM,aAAa,gBAA+C,QAAgB;GACjF,MAAM,eAAe,MAAM,SAAS,eAAe;GACnD,MAAM,aAAa,aAAa,eAAe;GAC/C,MAAM,WAAW,eAAe,cAAc,eAAe,UAAU,WAAW;GAClF,MAAM,IAAI,aAAa,QAAQ;GAC/B,MAAM,OAAQ,EAAE,MAAM,UAAU,EAAE,MAAM,WAAW,EAAE,OAAO,GAAG;AAC/D,UAAO;IACN,aAAa,aAAa;IAC1B,SAAS;IACT;IACA,aAAa,EAAE;IACf,WAAW,EAAE;IACb,SAAS,EAAE;IACX;IACA;;EAEF;AACD,QAAO"}

package/dist/server/vis_server_context.types.d.mts

@@ -1 +1,32 @@
-import "../shared/types.mjs";
+import { Merge } from "type-plus";
+import { BrowserCommandContext } from "vitest/node";
+
+//#region src/server/vis_server_context.types.d.ts
+
+type ExtendedBrowserCommandContext = {
+  page: BrowserCommandContext['page'];
+  browser: BrowserCommandContext['browser'];
+  iframe: BrowserCommandContext['iframe'];
+  testPath: NonNullable<BrowserCommandContext['testPath']>;
+  provider: BrowserCommandContext['provider'];
+  project: Merge<BrowserCommandContext['project'], {
+    browser: {
+      config: {
+        browser: {
+          name: string;
+          screenshotFailures: boolean;
+          screenshotDirectory: string;
+        };
+      };
+    };
+    config: BrowserCommandContext['project']['config'];
+    runner: {
+      config: {
+        name: string;
+      };
+    };
+  }>;
+};
+//#endregion
+export { ExtendedBrowserCommandContext };
+//# sourceMappingURL=vis_server_context.types.d.mts.map

package/dist/server/vis_server_context.types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis_server_context.types.d.mts","names":[],"sources":["../../src/server/vis_server_context.types.ts"],"sourcesContent":[],"mappings":";;;;;KAuCY,6BAAA;QACL;WACG;UACD;YACE,YAAY;YACZ;WAED,MACR;;;;;;;;;;YAWS"}

package/dist/setup/create_vis.mjs

@@ -6,14 +6,14 @@ import { afterEach, beforeAll, expect } from "vitest";
 function createVis(commands) {
 	const matcher = autoSnapshotMatcher(commands, expect);
 	return { setup(options) {
-		if (!options || options.auto === false) beforeAll(matcher.setup);
-		else beforeAll(async () => {
+		const suiteDefaults = options?.createMissingBaseline !== void 0 ? { createMissingBaseline: options.createMissingBaseline } : void 0;
+		beforeAll(async () => {
 			await matcher.setup();
-			setAutoSnapshotOptions(true);
+			setAutoSnapshotOptions(!!options?.auto);
 		});
-		if (typeof options?.auto === "function") afterEach(matcher.createMatcher({ auto: options.auto }));
-		else if (typeof options?.auto === "object") afterEach(matcher.createMatcher(options.auto));
-		else afterEach(matcher.createMatcher({ async auto() {} }));
+		if (typeof options?.auto === "function") afterEach(matcher.createMatcher({ auto: options.auto }, suiteDefaults));
+		else if (typeof options?.auto === "object") afterEach(matcher.createMatcher(options.auto, suiteDefaults));
+		else afterEach(matcher.createMatcher({ async auto() {} }, suiteDefaults));
 	} };
 }
 

package/dist/setup/create_vis.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"create_vis.mjs","names":[],"sources":["../../src/setup/create_vis.ts"],"sourcesContent":["import { afterEach, beforeAll, expect } from 'vitest'\nimport { setAutoSnapshotOptions } from '../auto_snapshots/auto_snapshot_options.ts'\nimport { autoSnapshotMatcher } from '../client/suite/auto_snapshot_matcher.ts'\nimport type { SetupVisSuiteCommand } from '../shared/commands.types.ts'\nimport type { SetupVisOptions } from '../shared/types.ts'\n\n/**\n * Visual test configuration on the client side.\n */\nexport type VisClientConfigurator<GM extends Record<string, any> | unknown = unknown> = {\n\t/**\n\t * Setup the visual test configuration.\n\t *\n\t * @example\n\t * ```ts\n\t * // Setup with auto snapshot enabled\n\t * vis().setup({ auto: true })\n\t *\n\t * // Setup with auto snapshot disabled\n\t * vis().setup({ auto: false })\n\t *\n\t * // Same as `vis.setup({ auto: false })`\n\t * vis.setup()\n\t *\n\t * // Setup with auto snapshot determined by the test meta\n\t * vis.setup({\n\t * \tauto: async ({ meta }) => meta['darkOnly'],\n\t * })\n\t *\n\t * // Setup with multiple auto snapshots\n\t * vis.setup({\n\t *   auto: {\n\t *     async light() { document.body.classList.remove('dark') },\n\t *     async dark() { document.body.classList.add('dark') },\n\t *   }\n\t * })\n\t * ```\n\t */\n\tsetup(options?: SetupVisOptions<GM>): void\n}\n\nexport function createVis<GM extends Record<string, any> | unknown = unknown>(commands: SetupVisSuiteCommand) {\n\tconst matcher = autoSnapshotMatcher(commands, expect)\n\n\tconst vis: VisClientConfigurator<GM> = {\n\t\tsetup(options) {\n\t\t\tif (!options || options.auto === false) {\n\t\t\t\tbeforeAll(matcher.setup)\n\t\t\t} else {\n\t\t\t\tbeforeAll(async () => {\n\t\t\t\t\tawait matcher.setup()\n\t\t\t\t\tsetAutoSnapshotOptions(true)\n\t\t\t\t})\n\t\t\t}\n\n\t\t\tif (typeof options?.auto === 'function') {\n\t\t\t\tafterEach(matcher.createMatcher({ auto: options.auto }))\n\t\t\t} else if (typeof options?.auto === 'object') {\n\t\t\t\tafterEach(matcher.createMatcher(options.auto))\n\t\t\t} else {\n\t\t\t\tafterEach(matcher.createMatcher({ async auto() {} }))\n\t\t\t}\n\t\t},\n\t}\n\treturn vis\n}\n"],"mappings":";;;;;AAyCA,SAAgB,UAA8D,UAAgC;CAC7G,MAAM,UAAU,oBAAoB,UAAU,OAAO;AAsBrD,QApBuC,EACtC,MAAM,SAAS;AACd,MAAI,CAAC,WAAW,QAAQ,SAAS,MAChC,WAAU,QAAQ,MAAM;MAExB,WAAU,YAAY;AACrB,SAAM,QAAQ,OAAO;AACrB,0BAAuB,KAAK;IAC3B;AAGH,MAAI,OAAO,SAAS,SAAS,WAC5B,WAAU,QAAQ,cAAc,EAAE,MAAM,QAAQ,MAAM,CAAC,CAAC;WAC9C,OAAO,SAAS,SAAS,SACnC,WAAU,QAAQ,cAAc,QAAQ,KAAK,CAAC;MAE9C,WAAU,QAAQ,cAAc,EAAE,MAAM,OAAO,IAAI,CAAC,CAAC;IAGvD"}
+{"version":3,"file":"create_vis.mjs","names":[],"sources":["../../src/setup/create_vis.ts"],"sourcesContent":["import { afterEach, beforeAll, expect } from 'vitest'\nimport { setAutoSnapshotOptions } from '../auto_snapshots/auto_snapshot_options.ts'\nimport { autoSnapshotMatcher } from '../client/suite/auto_snapshot_matcher.ts'\nimport type { SetupVisSuiteCommand } from '../shared/commands.types.ts'\nimport type { SetupVisOptions } from '../shared/types.ts'\n\n/**\n * Visual test configuration on the client side.\n */\nexport type VisClientConfigurator<GM extends Record<string, any> | unknown = unknown> = {\n\t/**\n\t * Setup the visual test configuration.\n\t *\n\t * @example\n\t * ```ts\n\t * // Setup with auto snapshot enabled\n\t * vis().setup({ auto: true })\n\t *\n\t * // Setup with auto snapshot disabled\n\t * vis().setup({ auto: false })\n\t *\n\t * // Same as `vis.setup({ auto: false })`\n\t * vis.setup()\n\t *\n\t * // Setup with auto snapshot determined by the test meta\n\t * vis.setup({\n\t * \tauto: async ({ meta }) => meta['darkOnly'],\n\t * })\n\t *\n\t * // Setup with multiple auto snapshots\n\t * vis.setup({\n\t *   auto: {\n\t *     async light() { document.body.classList.remove('dark') },\n\t *     async dark() { document.body.classList.add('dark') },\n\t *   }\n\t * })\n\t * ```\n\t */\n\tsetup(options?: SetupVisOptions<GM>): void\n}\n\nexport function createVis<GM extends Record<string, any> | unknown = unknown>(commands: SetupVisSuiteCommand) {\n\tconst matcher = autoSnapshotMatcher(commands, expect)\n\n\tconst vis: VisClientConfigurator<GM> = {\n\t\tsetup(options) {\n\t\t\tconst suiteDefaults =\n\t\t\t\toptions?.createMissingBaseline !== undefined\n\t\t\t\t\t? { createMissingBaseline: options.createMissingBaseline }\n\t\t\t\t\t: undefined\n\n\t\t\tbeforeAll(async () => {\n\t\t\t\tawait matcher.setup()\n\t\t\t\tsetAutoSnapshotOptions(!!options?.auto)\n\t\t\t})\n\n\t\t\tif (typeof options?.auto === 'function') {\n\t\t\t\tafterEach(matcher.createMatcher({ auto: options.auto }, suiteDefaults))\n\t\t\t} else if (typeof options?.auto === 'object') {\n\t\t\t\tafterEach(matcher.createMatcher(options.auto, suiteDefaults))\n\t\t\t} else {\n\t\t\t\tafterEach(matcher.createMatcher({ async auto() {} }, suiteDefaults))\n\t\t\t}\n\t\t},\n\t}\n\treturn vis\n}\n"],"mappings":";;;;;AAyCA,SAAgB,UAA8D,UAAgC;CAC7G,MAAM,UAAU,oBAAoB,UAAU,OAAO;AAuBrD,QArBuC,EACtC,MAAM,SAAS;EACd,MAAM,gBACL,SAAS,0BAA0B,SAChC,EAAE,uBAAuB,QAAQ,uBAAuB,GACxD;AAEJ,YAAU,YAAY;AACrB,SAAM,QAAQ,OAAO;AACrB,0BAAuB,CAAC,CAAC,SAAS,KAAK;IACtC;AAEF,MAAI,OAAO,SAAS,SAAS,WAC5B,WAAU,QAAQ,cAAc,EAAE,MAAM,QAAQ,MAAM,EAAE,cAAc,CAAC;WAC7D,OAAO,SAAS,SAAS,SACnC,WAAU,QAAQ,cAAc,QAAQ,MAAM,cAAc,CAAC;MAE7D,WAAU,QAAQ,cAAc,EAAE,MAAM,OAAO,IAAI,EAAE,cAAc,CAAC;IAGtE"}

package/dist/shared/types.d.mts

@@ -79,6 +79,15 @@ type ToMatchImageSnapshotOptions<M extends ComparisonMethod = 'pixel'> = ImageSn
    * If it passes, it will throw an error with details.
    */
   expectToFail?: boolean | undefined;
+  /**
+   * Create a baseline image when none exists on disk.
+   *
+   * If `true`, the captured image is written to the baseline path and the assertion succeeds,
+   * without Vitest `-u` / `updateSnapshot: 'all'`.
+   *
+   * @default false
+   */
+  createMissingBaseline?: boolean | undefined;
 };
 interface PageImageSnapshotOptions {
   fullPage?: boolean | undefined;
@@ -120,9 +129,20 @@ type ImageSnapshotComparisonInfo = {
    */
   diff?: string | undefined;
 } & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
-type MatchImageSnapshotOptions = ImageSnapshotTimeoutOptions & ImageSnapshotCompareOptions<any> & ImageSnapshotKeyOptions;
+type MatchImageSnapshotOptions = ImageSnapshotTimeoutOptions & ImageSnapshotCompareOptions<any> & ImageSnapshotKeyOptions & {
+  /**
+   * When `true`, write a missing baseline on first run (see {@link ToMatchImageSnapshotOptions} `createMissingBaseline`).
+   */
+  createMissingBaseline?: boolean | undefined;
+};
 type SetupVisOptions<GM extends Record<string, any> | unknown = unknown> = {
   auto?: boolean | (<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void) | Record<string, boolean | (<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void)>;
+  /**
+   * Default {@link ToMatchImageSnapshotOptions#createMissingBaseline} for auto snapshots.
+   *
+   * @default false
+   */
+  createMissingBaseline?: boolean | undefined;
 };
 //#endregion
 export { Awaitable, ComparisonMethod, FailureThresholdOptions, ImageSnapshotCompareOptions, ImageSnapshotComparisonInfo, ImageSnapshotKeyOptions, ImageSnapshotSubjectOptions, ImageSnapshotTimeoutOptions, MatchImageSnapshotOptions, PageImageSnapshotOptions, PixelComparisonOptions, PixelDiffOptions, SetupVisOptions, SnapshotTestMeta, SsimComparisonOptions, type SsimDiffOptions, ToMatchImageSnapshotOptions, ToMatchPageImageSnapshotOptions };

package/dist/shared/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/shared/types.ts"],"sourcesContent":[],"mappings":";;;;;;KAKY,eAAe,IAAI,YAAY;UAE1B,2BAAA;EAFL;;;;;EAEK,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;AASjB;AAOY,UAPK,uBAAA,CAOW;EAEhB;AA6BZ;;EAKuB,WAAA,CAAA,EAAA,MAAA,GAAA,SAAA;;AAAD,KApCV,gBAAA,GAoCU,OAAA,GAAA,MAAA;AAKV,KAvCA,uBAAA,GAuCsB;EAQtB;AAEZ;;;;EACG,oBAAA,CAAA,EAAA,OAAA,GAAA,SAAA,GAAA,SAAA;EACuB;;;;AAG1B;AASA;;;;;;;AAUA;AAIA;;;;;;EAGY,gBAAA,CAAA,EAAgB,MAAA,GAAA,SAAA;CAEJ;AAAb,KArDC,qBAqDD,CAAA,IAAA,MAAA,CAAA,GAAA;EAAR,gBAAA,EApDgB,CAoDhB;EAAI;AAIP;;EA+BC,WAAA,CAAA,EAnFc,OAmFd,CAnFsB,eAmFtB,CAAA,GAAA,SAAA;CACC;AAA8C,KA/EpC,sBA+EoC,CAAA,IAAA,OAAA,CAAA,GAAA;EAEpC,gBAAA,CAAA,EAhFQ,CAgFR,GAAA,SAAyB;EAAG;;;EAEhB,WAAA,CAAA,EA9ET,gBA8ES,GAAA,SAAA;AAExB,CAAA;AAAuC,KA7E3B,gBAAA,GAAmB,UA6EQ,CAAA,OA7EU,UA6EV,CAAA,CAAA,CAAA,CAAA;AAGvB,KA9EJ,2BA8EI,CAAA,UA9EkC,gBA8ElC,GAAA,OAAA,CAAA,GAAA,CA9EiE,CA8EjE,SAAA,MAAA,GA7Eb,qBA6Ea,CA7ES,CA6ET,CAAA,GA5Eb,sBA4Ea,CA5EU,CA4EV,CAAA,CAAA,GA3Ef,uBA2Ee;AAA4B,KAzEhC,2BAAA,GAyEgC;EAClB;;;;;;EAKR,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;CAA4B;AAClB,KAvEhB,2BAuEgB,CAAA,UAvEsB,gBAuEtB,GAAA,OAAA,CAAA,GAvEoD,2BAuEpD,GAtE3B,uBAsE2B,GArE3B,2BAqE2B,CArEC,CAqED,CAAA,GAAA;EAAb;;;;EACe,YAAA,CAAA,EAAA,OAAA,GAAA,SAAA;CAL1B;AAAM,UAzDO,wBAAA,CAyDP;;;KArDE,0CAA0C,8BAA8B,4BAA4B,KAC/G;KAEW,gBAAA;;KAET,IAAA,IAAQ,aAAa;;;KAIZ,2BAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8BR,8BACH,2BACC,wBAAwB;KAEd,yBAAA,GAA4B,8BACvC,mCACA;KAEW,2BAA2B;+BAGvB,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB,kCACxB,qCAGc,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB"}
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/shared/types.ts"],"sourcesContent":[],"mappings":";;;;;;KAKY,eAAe,IAAI,YAAY;UAE1B,2BAAA;EAFL;;;;;EAEK,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;AASjB;AAOY,UAPK,uBAAA,CAOW;EAEhB;AA6BZ;;EAKuB,WAAA,CAAA,EAAA,MAAA,GAAA,SAAA;;AAAD,KApCV,gBAAA,GAoCU,OAAA,GAAA,MAAA;AAKV,KAvCA,uBAAA,GAuCsB;EAQtB;AAEZ;;;;EACG,oBAAA,CAAA,EAAA,OAAA,GAAA,SAAA,GAAA,SAAA;EACuB;;;;AAG1B;AASA;;;;;;;AAmBA;AAIA;;;;;;EAGY,gBAAA,CAAA,EAAgB,MAAA,GAAA,SAAA;CAEJ;AAAb,KA9DC,qBA8DD,CAAA,IAAA,MAAA,CAAA,GAAA;EAAR,gBAAA,EA7DgB,CA6DhB;EAAI;AAIP;;EA+BC,WAAA,CAAA,EA5Fc,OA4Fd,CA5FsB,eA4FtB,CAAA,GAAA,SAAA;CACC;AAA8C,KAxFpC,sBAwFoC,CAAA,IAAA,OAAA,CAAA,GAAA;EAEpC,gBAAA,CAAA,EAzFQ,CAyFR,GAAA,SAAyB;EAAG;;;EAEhB,WAAA,CAAA,EAvFT,gBAuFS,GAAA,SAAA;AAOxB,CAAA;AAAuC,KA3F3B,gBAAA,GAAmB,UA2FQ,CAAA,OA3FU,UA2FV,CAAA,CAAA,CAAA,CAAA;AAGvB,KA5FJ,2BA4FI,CAAA,UA5FkC,gBA4FlC,GAAA,OAAA,CAAA,GAAA,CA5FiE,CA4FjE,SAAA,MAAA,GA3Fb,qBA2Fa,CA3FS,CA2FT,CAAA,GA1Fb,sBA0Fa,CA1FU,CA0FV,CAAA,CAAA,GAzFf,uBAyFe;AAA4B,KAvFhC,2BAAA,GAuFgC;EAClB;;;;;;EAKR,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;CAA4B;AAClB,KArFhB,2BAqFgB,CAAA,UArFsB,gBAqFtB,GAAA,OAAA,CAAA,GArFoD,2BAqFpD,GApF3B,uBAoF2B,GAnF3B,2BAmF2B,CAnFC,CAmFD,CAAA,GAAA;EAAb;;;;EACe,YAAA,CAAA,EAAA,OAAA,GAAA,SAAA;EAL1B;;;;;;;;;;UA9Da,wBAAA;;;KAIL,0CAA0C,8BAA8B,4BAA4B,KAC/G;KAEW,gBAAA;;KAET,IAAA,IAAQ,aAAa;;;KAIZ,2BAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8BR,8BACH,2BACC,wBAAwB;KAEd,yBAAA,GAA4B,8BACvC,mCACA;;;;;;KAOW,2BAA2B;+BAGvB,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB,kCACxB,qCAGc,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-plugin-vis",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "description": "Vitest visual testing plugin",
   "keywords": [
     "image-snapshot",
@@ -21,46 +21,23 @@
   "type": "module",
   "imports": {
     "#vitest-plugin-vis": "./src/index.ts",
-    "#vitest-plugin-vis/client-api": "./src/client-api.ts",
-    "#vitest-plugin-vis/config": "./src/config.ts",
-    "#vitest-plugin-vis/setup": "./src/setup.ts"
+    "#vitest-plugin-vis/client-api": "./src/exports/client-api.ts",
+    "#vitest-plugin-vis/config": "./src/exports/config.ts",
+    "#vitest-plugin-vis/setup": "./src/exports/setup.ts",
+    "#vitest-plugin-vis/setup-api": "./src/exports/setup-api.ts",
+    "#vitest-plugin-vis/testing": "./src/exports/testing.ts",
+    "#vitest-plugin-vis/testing/node": "./src/exports/testing/node.ts"
   },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/index.d.mts",
       "default": "./dist/index.mjs"
     },
-    "./config": {
-      "types": "./dist/config.d.mts",
-      "default": "./dist/config.mjs"
-    },
-    "./client-api": {
-      "types": "./dist/client-api.d.mts",
-      "default": "./dist/client-api.mjs"
-    },
-    "./presets/auto": {
-      "types": "./dist/presets/auto.d.mts",
-      "default": "./dist/presets/auto.mjs"
-    },
-    "./presets/manual": {
-      "types": "./dist/presets/manual.d.mts",
-      "default": "./dist/presets/manual.mjs"
-    },
-    "./server-utils": {
-      "types": "./dist/server-utils.d.mts",
-      "default": "./dist/server-utils.mjs"
-    },
-    "./setup": {
-      "types": "./dist/setup.d.mts",
-      "default": "./dist/setup.mjs"
-    },
-    "./setup-api": {
-      "types": "./dist/setup-api.d.mts",
-      "default": "./dist/setup-api.mjs"
-    },
-    "./testing": {
-      "types": "./dist/testing.d.mts",
-      "default": "./dist/testing.mjs"
+    "./*": {
+      "source": "./src/exports/*.ts",
+      "types": "./dist/exports/*.d.mts",
+      "default": "./dist/exports/*.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -109,7 +86,7 @@
     "storybook-addon-tag-badges": "^3.1.0",
     "tailwindcss": "^4.1.14",
     "tsdown": "^0.19.0",
-    "typescript": "^5.9.3",
+    "typescript": "^6.0.0",
     "vite": "^8.0.0",
     "vitest": "^4.1.4",
     "vitest-browser-react": "^2.0.2"

package/readme.md

@@ -261,6 +261,10 @@ export default defineConfig({
 })
 ```
 
+#### `shortenLongSnapshotPaths` (long absolute paths)
+
+Defaults to `false`. When `true`, the plugin keeps legacy snapshot files as `taskId-key.png` and only adjusts the **`snapshotSubpath` segment** when needed: it builds **absolute** paths under `__baselines__` (after `snapshotRootDir` and your `snapshotSubpath`) plus representative snapshot filenames; if those would exceed typical Windows limits (length at least **250**, below classic `MAX_PATH` **260** with margin, or a path component longer than **255**), **directory segments stay as-is** and only the **final path component** (the file name derived from your test/story path) is shortened to `{firstToken}-{hash12}{ext}` — the first token is the substring before the first `.` in the basename (similar in spirit to [tersify](https://github.com/unional/tersify) terse labels). The same resolved subpath is used for **baselines**, **results**, and **diffs**. Your `snapshotRootDir` is not rewritten.
+
 #### Multiple browser instances
 
 When using multiple browser instances (e.g., different viewports or browsers),
@@ -451,6 +455,8 @@ setAutoSnapshotOptions({
 })
 ```
 
+`createMissingBaseline` (on the matcher or on `vis.setup`) writes a missing baseline on the first run without `-u`. For auto snapshots, `vis.setup({ createMissingBaseline: true, auto: true })` applies a default; a test can override with `setAutoSnapshotOptions({ createMissingBaseline: false })` or equivalent meta.
+
 You can also enable/disable auto snapshot by passing boolean:
 
 ```ts

package/src/auto_snapshots/_extract_auto_snapshot_options.ts

@@ -1,4 +1,4 @@
-import { NAME } from '../client-api.ts'
+import { NAME } from '../exports/client-api.ts'
 import type { MetaTask } from './auto_snapshot_options.ts'
 import type { SnapshotMeta } from './snapshot_meta.ts'
 

package/src/client/expect/to_match_image_snapshot.mdx

@@ -72,6 +72,26 @@ it('should use custom snapshot key', async ({ expect }) => {
 })
 ```
 
+#### `createMissingBaseline`
+
+When `true`, if there is **no baseline image yet**,
+the matcher writes the captured image to the baseline path and the assertion succeeds—without using Vitest's `-u` / `updateSnapshot` mode.
+If a baseline already exists, `createMissingBaseline` does not change comparison behavior.
+
+You can also set a default for **auto** snapshots with `vis.setup({ createMissingBaseline: true, auto: ... })`.
+Per-test options from `setAutoSnapshotOptions` / test meta override that default when they set `createMissingBaseline` explicitly.
+
+```ts
+it('creates baseline on first run with createMissingBaseline', async ({ expect }) => {
+	render(<MyComponent />)
+
+	await expect(document.body).toMatchImageSnapshot({
+		snapshotKey: 'first_run',
+		createMissingBaseline: true
+	})
+})
+```
+
 ### Failure Threshold
 
 #### `failureThreshold` and `failureThresholdType`
@@ -258,7 +278,10 @@ it('should demonstrate all options', async ({ expect }) => {
 		timeout: 45000,
 
 		// Testing utility
-		expectToFail: false
+		expectToFail: false,
+
+		// First-run baseline (optional)
+		createMissingBaseline: false
 	})
 })
 ```