vitest-plugin-vis 3.5.1 → 4.0.0

package/dist/setup-BWgIDtv-.mjs

@@ -0,0 +1,141 @@
+import { n as setAutoSnapshotOptions, r as ctx, t as extractAutoSnapshotOptions } from "./auto_snapshot_options-CAD43Zkp.mjs";
+import { a as hasImageSnapshotAction, i as matchImageSnapshotAction, n as success, r as matchPageImageSnapshotAction, t as toTaskId } from "./task_id-DnS9_4Ub.mjs";
+import dedent from "dedent";
+import { afterEach, beforeAll, expect } from "vitest";
+import { commands, page } from "vitest/browser";
+
+//#region src/client/expect/to_match_image_snapshot.ts
+function toMatchImageSnapshot$1(subject, options) {
+	const test = ctx.getCurrentTest();
+	if (!test) throw new Error("`toMatchImageSnapshot()` must be called in a test.");
+	if (test.concurrent) throw new Error("`toMatchImageSnapshot()` cannot be called in a concurrent test because concurrent tests run at the same time in the same iframe and affect each other's environment.");
+	return matchImageSnapshotAction(commands, toTaskId(test), subject, options).then(() => success);
+}
+
+//#endregion
+//#region src/client/expect/extend.ts
+expect.extend({ toMatchImageSnapshot: toMatchImageSnapshot$1 });
+
+//#endregion
+//#region src/client/page/has_image_snapshot.ts
+function hasImageSnapshot(options) {
+	const test = ctx.getCurrentTest();
+	if (!test) throw new Error("`hasImageSnapshot()` must be called in a test.");
+	if (test.concurrent) throw new Error("`hasImageSnapshot()` cannot be called in a concurrent test because concurrent tests run at the same time in the same iframe and affect each other's environment. ");
+	return hasImageSnapshotAction(commands, toTaskId(test), options);
+}
+
+//#endregion
+//#region src/client/page/to_match_image_snapshot.ts
+function toMatchImageSnapshot(options) {
+	const test = ctx.getCurrentTest();
+	if (!test) throw new Error("`toMatchImageSnapshot()` must be called in a test.");
+	if (test.concurrent) throw new Error("`toMatchImageSnapshot()` cannot be called in a concurrent test because concurrent tests run at the same time in the same iframe and affect each other's environment.");
+	return matchPageImageSnapshotAction(commands, toTaskId(test), options);
+}
+
+//#endregion
+//#region src/client/page/extend.ts
+page.extend({
+	hasImageSnapshot,
+	toMatchImageSnapshot
+});
+
+//#endregion
+//#region src/client/should_take_snapshot.ts
+function shouldTakeSnapshot(meta) {
+	return document.body.childElementCount > 0 && meta?.enable;
+}
+
+//#endregion
+//#region src/client/setup/create_vis.ts
+function createVis(commands$1) {
+	let subject;
+	const vis$1 = {
+		setup(options) {
+			if (!options || options.auto === false) beforeAll(vis$1.beforeAll.setup);
+			else beforeAll(async () => {
+				await vis$1.beforeAll.setup();
+				setAutoSnapshotOptions(true);
+			});
+			if (typeof options?.auto === "function") afterEach(vis$1.afterEach.matchPerTheme({ auto: options.auto }));
+			else if (typeof options?.auto === "object") afterEach(vis$1.afterEach.matchPerTheme(options.auto));
+			else afterEach(vis$1.afterEach.matchImageSnapshot);
+		},
+		presets: {
+			enable() {
+				beforeAll(vis$1.beforeAll.setup);
+				afterEach(vis$1.afterEach.matchImageSnapshot);
+			},
+			manual() {
+				beforeAll(vis$1.beforeAll.setup);
+			},
+			auto() {
+				beforeAll(async () => {
+					await vis$1.beforeAll.setup();
+					setAutoSnapshotOptions(true);
+				});
+				afterEach(vis$1.afterEach.matchImageSnapshot);
+			},
+			theme(themes) {
+				beforeAll(async () => {
+					await vis$1.beforeAll.setup();
+					setAutoSnapshotOptions(true);
+				});
+				afterEach(vis$1.afterEach.matchPerTheme(themes));
+			}
+		},
+		beforeAll: { async setup() {
+			subject = (await commands$1.setupVisSuite()).subject;
+		} },
+		afterEach: {
+			async matchImageSnapshot() {
+				return vis$1.afterEach.matchPerTheme({ async auto() {} })();
+			},
+			matchPerTheme(themes) {
+				return async function matchImageSnapshot() {
+					const test = ctx.getCurrentTest();
+					if ((test?.result?.errors?.length ?? 0) > 0) return;
+					const meta = extractAutoSnapshotOptions(test);
+					if (!shouldTakeSnapshot(meta)) return;
+					const errors = [];
+					for (const themeId in themes) try {
+						await new Promise((a) => setTimeout(a, 10));
+						const theme = themes[themeId];
+						if ((typeof theme === "function" ? await theme(meta) : theme) === false) continue;
+						await test.context.expect(getSubject(meta?.subject ?? subject)).toMatchImageSnapshot({
+							...meta,
+							snapshotKey: meta?.snapshotKey ?? themeId
+						});
+					} catch (error) {
+						errors.push([themeId, error]);
+					}
+					if (errors.length > 0) {
+						if (errors.length === 1) throw errors[0][1];
+						const taskId = toTaskId(test);
+						throw new AggregateError(errors, dedent`Snapshot \`${taskId}\` mismatched
+
+						${errors.map(([themeId, error]) => {
+							return `Theme \`${themeId}\` failed: ${error.message}`;
+						}).join("\n\n")}`);
+					}
+				};
+			}
+		}
+	};
+	return vis$1;
+}
+function getSubject(selectors) {
+	return selectors ? document.querySelector(selectors) ?? document.body : document.body;
+}
+
+//#endregion
+//#region src/client/setup/vis.ts
+/**
+* Visual test configuration on the client side.
+*/
+const vis = createVis(commands);
+
+//#endregion
+export { createVis as n, vis as t };
+//# sourceMappingURL=setup-BWgIDtv-.mjs.map

package/dist/setup-BWgIDtv-.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-BWgIDtv-.mjs","names":["toMatchImageSnapshot","subject: string | undefined","vis: VisClientConfigurator<GM>","vis","commands","errors: Array<[string, Error]>"],"sources":["../src/client/expect/to_match_image_snapshot.ts","../src/client/expect/extend.ts","../src/client/page/has_image_snapshot.ts","../src/client/page/to_match_image_snapshot.ts","../src/client/page/extend.ts","../src/client/should_take_snapshot.ts","../src/client/setup/create_vis.ts","../src/client/setup/vis.ts"],"sourcesContent":["import { commands } from 'vitest/browser'\nimport type { AsyncExpectationResult } from '@vitest/expect'\nimport type { ToMatchImageSnapshotOptions } from '../../shared/types.ts'\nimport { matchImageSnapshotAction } from '../actions/match_image_snapshot_action.ts'\nimport { ctx } from '../ctx.ts'\nimport { toTaskId } from '../task_id.ts'\nimport { success } from './expectation_result.ts'\n\nexport function toMatchImageSnapshot(\n\t/**\n\t * The element or locator to take the snapshot of,\n\t * or the base64 value of the image to compare against.\n\t */\n\tsubject: any,\n\toptions?: ToMatchImageSnapshotOptions | undefined,\n): AsyncExpectationResult {\n\tconst test = ctx.getCurrentTest()\n\tif (!test) {\n\t\tthrow new Error('`toMatchImageSnapshot()` must be called in a test.')\n\t}\n\n\tif (test.concurrent) {\n\t\tthrow new Error(\n\t\t\t'`toMatchImageSnapshot()` cannot be called in a concurrent test because ' +\n\t\t\t\t\"concurrent tests run at the same time in the same iframe and affect each other's environment.\",\n\t\t)\n\t}\n\n\treturn matchImageSnapshotAction(commands, toTaskId(test), subject, options).then(() => success)\n}\n","import { expect } from 'vitest'\nimport { toMatchImageSnapshot } from './to_match_image_snapshot.ts'\nimport './augment.ts'\n\nexpect.extend({ toMatchImageSnapshot })\n","import { type BrowserPage, commands } from 'vitest/browser'\nimport type { ImageSnapshotKeyOptions } from '../../shared/types.ts'\nimport { hasImageSnapshotAction } from '../actions/has_image_snapshot_action.ts'\nimport { ctx } from '../ctx.ts'\nimport { toTaskId } from '../task_id.ts'\n\nexport interface HasImageSnapshotAction {\n\t/**\n\t * Check if the snapshot image exists.\n\t */\n\thasImageSnapshot(this: BrowserPage, options?: ImageSnapshotKeyOptions | undefined): Promise<boolean>\n}\n\nexport function hasImageSnapshot(this: BrowserPage, options?: ImageSnapshotKeyOptions | undefined) {\n\tconst test = ctx.getCurrentTest()\n\tif (!test) {\n\t\tthrow new Error('`hasImageSnapshot()` must be called in a test.')\n\t}\n\n\tif (test.concurrent) {\n\t\tthrow new Error(\n\t\t\t'`hasImageSnapshot()` cannot be called in a concurrent test because ' +\n\t\t\t\t\"concurrent tests run at the same time in the same iframe and affect each other's environment. \",\n\t\t)\n\t}\n\treturn hasImageSnapshotAction(commands, toTaskId(test), options)\n}\n","import { commands } from 'vitest/browser'\nimport type { ComparisonMethod, ToMatchPageImageSnapshotOptions } from '../../shared/types.ts'\nimport { matchPageImageSnapshotAction } from '../actions/match_page_image_snapshot_action.ts'\nimport { ctx } from '../ctx.ts'\nimport { toTaskId } from '../task_id.ts'\n\nexport interface ToMatchImageSnapshotAction {\n\ttoMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(\n\t\toptions?: ToMatchPageImageSnapshotOptions<M> | undefined,\n\t): Promise<void>\n}\n\nexport function toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(\n\toptions?: ToMatchPageImageSnapshotOptions<M> | undefined,\n) {\n\tconst test = ctx.getCurrentTest()\n\tif (!test) {\n\t\tthrow new Error('`toMatchImageSnapshot()` must be called in a test.')\n\t}\n\n\tif (test.concurrent) {\n\t\tthrow new Error(\n\t\t\t'`toMatchImageSnapshot()` cannot be called in a concurrent test because ' +\n\t\t\t\t\"concurrent tests run at the same time in the same iframe and affect each other's environment.\",\n\t\t)\n\t}\n\n\treturn matchPageImageSnapshotAction(commands, toTaskId(test), options)\n}\n","import { page } from 'vitest/browser'\nimport './augment.ts'\nimport { hasImageSnapshot } from './has_image_snapshot.ts'\nimport { toMatchImageSnapshot } from './to_match_image_snapshot.ts'\n\npage.extend({ hasImageSnapshot, toMatchImageSnapshot })\n","import type { SnapshotMeta } from './snapshot_meta.ts'\n\nexport function shouldTakeSnapshot(meta: SnapshotMeta<any> | undefined) {\n\treturn document.body.childElementCount > 0 && meta?.enable\n}\n","import dedent from 'dedent'\nimport { afterEach, beforeAll } from 'vitest'\nimport type { SetupVisSuiteCommand } from '../../server/commands/setup_vis_suite.ts'\nimport type { ComparisonMethod } from '../../shared/types.ts'\nimport { extractAutoSnapshotOptions, setAutoSnapshotOptions } from '../auto_snapshot_options.ts'\nimport { ctx } from '../ctx.ts'\nimport { shouldTakeSnapshot } from '../should_take_snapshot.ts'\nimport type { SnapshotMeta } from '../snapshot_meta.ts'\nimport { toTaskId } from '../task_id.ts'\n\nexport type SetupVisOptions<GM extends Record<string, any> | unknown = unknown> = {\n\tauto?:\n\t\t| boolean\n\t\t| (<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(\n\t\t\t\toptions: SnapshotMeta<C> & M & GM,\n\t\t  ) => Promise<boolean> | Promise<void> | boolean | void)\n\t\t| Record<\n\t\t\t\tstring,\n\t\t\t\t| boolean\n\t\t\t\t| (<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(\n\t\t\t\t\t\toptions: SnapshotMeta<C> & M & GM,\n\t\t\t\t  ) => Promise<boolean> | Promise<void> | boolean | void)\n\t\t  >\n}\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\t/**\n\t * @deprecated Use `vis.setup()` instead.\n\t */\n\tpresets: {\n\t\t/**\n\t\t * @deprecated Use `vis.setup()` instead.\n\t\t *\n\t\t * Enable visual testing.\n\t\t *\n\t\t * auto snapshot is turned off by default.\n\t\t * You can specify the test to take a snapshot during `afterEach()` hook with `setAutoSnapshotOptions()`.\n\t\t */\n\t\tenable(): void\n\t\t/**\n\t\t * @deprecated Use `vis.setup()` instead.\n\t\t *\n\t\t * Enable visual testing.\n\t\t *\n\t\t * `setAutoSnapshotOptions` will have no effect in this preset.\n\t\t */\n\t\tmanual(): void\n\t\t/**\n\t\t * @deprecated Use `vis.setup()` instead.\n\t\t *\n\t\t * Enable automatic visual testing.\n\t\t *\n\t\t * This will take a snapshot after each test.\n\t\t */\n\t\tauto(): void\n\t\t/**\n\t\t * @deprecated Use `vis.setup()` instead.\n\t\t *\n\t\t * Enable automatic visual testing with multiple themes.\n\t\t *\n\t\t * This will take a snapshot after each test for each theme.\n\t\t *\n\t\t * @param themes A record of theme names and their setup functions.\n\t\t *\n\t\t * @example\n\t\t * ```ts\n\t\t * vis().presets.theme({\n\t\t *  light() { document.body.classList.add('light') },\n\t\t *  dark() { document.body.classList.add('dark') },\n\t\t * })\n\t\t * ```\n\t\t */\n\t\ttheme<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(\n\t\t\tthemes: Record<\n\t\t\t\tstring,\n\t\t\t\tboolean | ((options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void)\n\t\t\t>,\n\t\t): void\n\t}\n\tbeforeAll: {\n\t\tsetup(): Promise<void>\n\t}\n\tafterEach: {\n\t\tmatchImageSnapshot(): Promise<void>\n\t\tmatchPerTheme<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(\n\t\t\tthemes: Record<\n\t\t\t\tstring,\n\t\t\t\tboolean | ((options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void)\n\t\t\t>,\n\t\t): () => Promise<void>\n\t}\n}\n\nexport function createVis<GM extends Record<string, any> | unknown = unknown>(commands: SetupVisSuiteCommand) {\n\tlet subject: string | undefined\n\n\tconst vis: VisClientConfigurator<GM> = {\n\t\tsetup(options) {\n\t\t\tif (!options || options.auto === false) {\n\t\t\t\tbeforeAll(vis.beforeAll.setup)\n\t\t\t} else {\n\t\t\t\tbeforeAll(async () => {\n\t\t\t\t\tawait vis.beforeAll.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(\n\t\t\t\t\tvis.afterEach.matchPerTheme({\n\t\t\t\t\t\tauto: options.auto,\n\t\t\t\t\t}),\n\t\t\t\t)\n\t\t\t} else if (typeof options?.auto === 'object') {\n\t\t\t\tafterEach(vis.afterEach.matchPerTheme(options.auto))\n\t\t\t} else {\n\t\t\t\tafterEach(vis.afterEach.matchImageSnapshot)\n\t\t\t}\n\t\t},\n\t\tpresets: {\n\t\t\tenable() {\n\t\t\t\tbeforeAll(vis.beforeAll.setup)\n\t\t\t\tafterEach(vis.afterEach.matchImageSnapshot)\n\t\t\t},\n\t\t\tmanual() {\n\t\t\t\tbeforeAll(vis.beforeAll.setup)\n\t\t\t},\n\t\t\tauto() {\n\t\t\t\tbeforeAll(async () => {\n\t\t\t\t\tawait vis.beforeAll.setup()\n\t\t\t\t\tsetAutoSnapshotOptions(true)\n\t\t\t\t})\n\t\t\t\tafterEach(vis.afterEach.matchImageSnapshot)\n\t\t\t},\n\t\t\ttheme(themes) {\n\t\t\t\tbeforeAll(async () => {\n\t\t\t\t\tawait vis.beforeAll.setup()\n\t\t\t\t\tsetAutoSnapshotOptions(true)\n\t\t\t\t})\n\t\t\t\tafterEach(vis.afterEach.matchPerTheme(themes))\n\t\t\t},\n\t\t},\n\t\tbeforeAll: {\n\t\t\tasync setup() {\n\t\t\t\tsubject = (await commands.setupVisSuite()).subject\n\t\t\t},\n\t\t},\n\t\tafterEach: {\n\t\t\tasync matchImageSnapshot() {\n\t\t\t\treturn vis.afterEach.matchPerTheme({ async auto() {} })()\n\t\t\t},\n\t\t\tmatchPerTheme(themes) {\n\t\t\t\treturn async function matchImageSnapshot() {\n\t\t\t\t\tconst test = ctx.getCurrentTest()\n\t\t\t\t\tif ((test?.result?.errors?.length ?? 0) > 0) return\n\n\t\t\t\t\tconst meta = extractAutoSnapshotOptions(test)\n\t\t\t\t\tif (!shouldTakeSnapshot(meta)) return\n\t\t\t\t\tconst errors: Array<[string, Error]> = []\n\t\t\t\t\tfor (const themeId in themes) {\n\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\tawait new Promise((a) => setTimeout(a, 10))\n\t\t\t\t\t\t\tconst theme = themes[themeId]\n\t\t\t\t\t\t\tconst r = typeof theme === 'function' ? await theme(meta! as any) : theme\n\t\t\t\t\t\t\tif (r === false) continue\n\t\t\t\t\t\t\tawait test!.context.expect(getSubject(meta?.subject ?? subject)).toMatchImageSnapshot({\n\t\t\t\t\t\t\t\t...meta,\n\t\t\t\t\t\t\t\tsnapshotKey: meta?.snapshotKey ?? themeId,\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t} catch (error) {\n\t\t\t\t\t\t\terrors.push([themeId, error as Error])\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif (errors.length > 0) {\n\t\t\t\t\t\tif (errors.length === 1) throw errors[0]![1]\n\t\t\t\t\t\tconst taskId = toTaskId(test!)\n\t\t\t\t\t\tthrow new AggregateError(\n\t\t\t\t\t\t\terrors,\n\t\t\t\t\t\t\tdedent`Snapshot \\`${taskId}\\` mismatched\n\n\t\t\t\t\t\t${errors\n\t\t\t\t\t\t\t.map(([themeId, error]) => {\n\t\t\t\t\t\t\t\treturn `Theme \\`${themeId}\\` failed: ${error.message}`\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t\t.join('\\n\\n')}`,\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},\n\t}\n\treturn vis\n}\n\nfunction getSubject(selectors: string | undefined) {\n\treturn selectors ? (document.querySelector(selectors) ?? document.body) : document.body\n}\n","import { commands } from 'vitest/browser'\nimport { createVis } from './create_vis.ts'\n\n/**\n * Visual test configuration on the client side.\n */\nexport const vis = createVis(commands)\n"],"mappings":";;;;;;;AAQA,SAAgBA,uBAKf,SACA,SACyB;CACzB,MAAM,OAAO,IAAI,gBAAgB;AACjC,KAAI,CAAC,KACJ,OAAM,IAAI,MAAM,qDAAqD;AAGtE,KAAI,KAAK,WACR,OAAM,IAAI,MACT,uKAEA;AAGF,QAAO,yBAAyB,UAAU,SAAS,KAAK,EAAE,SAAS,QAAQ,CAAC,WAAW,QAAQ;;;;;ACxBhG,OAAO,OAAO,EAAE,8CAAsB,CAAC;;;;ACSvC,SAAgB,iBAAoC,SAA+C;CAClG,MAAM,OAAO,IAAI,gBAAgB;AACjC,KAAI,CAAC,KACJ,OAAM,IAAI,MAAM,iDAAiD;AAGlE,KAAI,KAAK,WACR,OAAM,IAAI,MACT,oKAEA;AAEF,QAAO,uBAAuB,UAAU,SAAS,KAAK,EAAE,QAAQ;;;;;ACbjE,SAAgB,qBACf,SACC;CACD,MAAM,OAAO,IAAI,gBAAgB;AACjC,KAAI,CAAC,KACJ,OAAM,IAAI,MAAM,qDAAqD;AAGtE,KAAI,KAAK,WACR,OAAM,IAAI,MACT,uKAEA;AAGF,QAAO,6BAA6B,UAAU,SAAS,KAAK,EAAE,QAAQ;;;;;ACtBvE,KAAK,OAAO;CAAE;CAAkB;CAAsB,CAAC;;;;ACHvD,SAAgB,mBAAmB,MAAqC;AACvE,QAAO,SAAS,KAAK,oBAAoB,KAAK,MAAM;;;;;AC0HrD,SAAgB,UAA8D,YAAgC;CAC7G,IAAIC;CAEJ,MAAMC,QAAiC;EACtC,MAAM,SAAS;AACd,OAAI,CAAC,WAAW,QAAQ,SAAS,MAChC,WAAUC,MAAI,UAAU,MAAM;OAE9B,WAAU,YAAY;AACrB,UAAMA,MAAI,UAAU,OAAO;AAC3B,2BAAuB,KAAK;KAC3B;AAGH,OAAI,OAAO,SAAS,SAAS,WAC5B,WACCA,MAAI,UAAU,cAAc,EAC3B,MAAM,QAAQ,MACd,CAAC,CACF;YACS,OAAO,SAAS,SAAS,SACnC,WAAUA,MAAI,UAAU,cAAc,QAAQ,KAAK,CAAC;OAEpD,WAAUA,MAAI,UAAU,mBAAmB;;EAG7C,SAAS;GACR,SAAS;AACR,cAAUA,MAAI,UAAU,MAAM;AAC9B,cAAUA,MAAI,UAAU,mBAAmB;;GAE5C,SAAS;AACR,cAAUA,MAAI,UAAU,MAAM;;GAE/B,OAAO;AACN,cAAU,YAAY;AACrB,WAAMA,MAAI,UAAU,OAAO;AAC3B,4BAAuB,KAAK;MAC3B;AACF,cAAUA,MAAI,UAAU,mBAAmB;;GAE5C,MAAM,QAAQ;AACb,cAAU,YAAY;AACrB,WAAMA,MAAI,UAAU,OAAO;AAC3B,4BAAuB,KAAK;MAC3B;AACF,cAAUA,MAAI,UAAU,cAAc,OAAO,CAAC;;GAE/C;EACD,WAAW,EACV,MAAM,QAAQ;AACb,cAAW,MAAMC,WAAS,eAAe,EAAE;KAE5C;EACD,WAAW;GACV,MAAM,qBAAqB;AAC1B,WAAOD,MAAI,UAAU,cAAc,EAAE,MAAM,OAAO,IAAI,CAAC,EAAE;;GAE1D,cAAc,QAAQ;AACrB,WAAO,eAAe,qBAAqB;KAC1C,MAAM,OAAO,IAAI,gBAAgB;AACjC,UAAK,MAAM,QAAQ,QAAQ,UAAU,KAAK,EAAG;KAE7C,MAAM,OAAO,2BAA2B,KAAK;AAC7C,SAAI,CAAC,mBAAmB,KAAK,CAAE;KAC/B,MAAME,SAAiC,EAAE;AACzC,UAAK,MAAM,WAAW,OACrB,KAAI;AACH,YAAM,IAAI,SAAS,MAAM,WAAW,GAAG,GAAG,CAAC;MAC3C,MAAM,QAAQ,OAAO;AAErB,WADU,OAAO,UAAU,aAAa,MAAM,MAAM,KAAa,GAAG,WAC1D,MAAO;AACjB,YAAM,KAAM,QAAQ,OAAO,WAAW,MAAM,WAAW,QAAQ,CAAC,CAAC,qBAAqB;OACrF,GAAG;OACH,aAAa,MAAM,eAAe;OAClC,CAAC;cACM,OAAO;AACf,aAAO,KAAK,CAAC,SAAS,MAAe,CAAC;;AAGxC,SAAI,OAAO,SAAS,GAAG;AACtB,UAAI,OAAO,WAAW,EAAG,OAAM,OAAO,GAAI;MAC1C,MAAM,SAAS,SAAS,KAAM;AAC9B,YAAM,IAAI,eACT,QACA,MAAM,cAAc,OAAO;;QAE1B,OACA,KAAK,CAAC,SAAS,WAAW;AAC1B,cAAO,WAAW,QAAQ,aAAa,MAAM;QAC5C,CACD,KAAK,OAAO,GACb;;;;GAIJ;EACD;AACD,QAAOF;;AAGR,SAAS,WAAW,WAA+B;AAClD,QAAO,YAAa,SAAS,cAAc,UAAU,IAAI,SAAS,OAAQ,SAAS;;;;;;;;AC7NpF,MAAa,MAAM,UAAU,SAAS"}

package/dist/setup.d.mts

@@ -0,0 +1,110 @@
+import { n as ComparisonMethod, x as SnapshotMeta } from "./types-DFb23VE1.mjs";
+import "./vis_server_context.types-Ce1f9vOO.mjs";
+import "./types-Do1N7g4c.mjs";
+import { t as SetupVisSuiteCommand } from "./setup_vis_suite-C6JGGT7B.mjs";
+import "./to_match_image_snapshot.types-p-zilA_M.mjs";
+import "./augment-BJmy1S7i.mjs";
+
+//#region src/client/setup/create_vis.d.ts
+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)>;
+};
+/**
+ * Visual test configuration on the client side.
+ */
+type VisClientConfigurator<GM extends Record<string, any> | unknown = unknown> = {
+  /**
+   * Setup the visual test configuration.
+   *
+   * @example
+   * ```ts
+   * // Setup with auto snapshot enabled
+   * vis().setup({ auto: true })
+   *
+   * // Setup with auto snapshot disabled
+   * vis().setup({ auto: false })
+   *
+   * // Same as `vis.setup({ auto: false })`
+   * vis.setup()
+   *
+   * // Setup with auto snapshot determined by the test meta
+   * vis.setup({
+   * 	auto: async ({ meta }) => meta['darkOnly'],
+   * })
+   *
+   * // Setup with multiple auto snapshots
+   * vis.setup({
+   *   auto: {
+   *     async light() { document.body.classList.remove('dark') },
+   *     async dark() { document.body.classList.add('dark') },
+   *   }
+   * })
+   * ```
+   */
+  setup(options?: SetupVisOptions<GM>): void;
+  /**
+   * @deprecated Use `vis.setup()` instead.
+   */
+  presets: {
+    /**
+     * @deprecated Use `vis.setup()` instead.
+     *
+     * Enable visual testing.
+     *
+     * auto snapshot is turned off by default.
+     * You can specify the test to take a snapshot during `afterEach()` hook with `setAutoSnapshotOptions()`.
+     */
+    enable(): void;
+    /**
+     * @deprecated Use `vis.setup()` instead.
+     *
+     * Enable visual testing.
+     *
+     * `setAutoSnapshotOptions` will have no effect in this preset.
+     */
+    manual(): void;
+    /**
+     * @deprecated Use `vis.setup()` instead.
+     *
+     * Enable automatic visual testing.
+     *
+     * This will take a snapshot after each test.
+     */
+    auto(): void;
+    /**
+     * @deprecated Use `vis.setup()` instead.
+     *
+     * Enable automatic visual testing with multiple themes.
+     *
+     * This will take a snapshot after each test for each theme.
+     *
+     * @param themes A record of theme names and their setup functions.
+     *
+     * @example
+     * ```ts
+     * vis().presets.theme({
+     *  light() { document.body.classList.add('light') },
+     *  dark() { document.body.classList.add('dark') },
+     * })
+     * ```
+     */
+    theme<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(themes: Record<string, boolean | ((options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void)>): void;
+  };
+  beforeAll: {
+    setup(): Promise<void>;
+  };
+  afterEach: {
+    matchImageSnapshot(): Promise<void>;
+    matchPerTheme<C extends ComparisonMethod, M extends Record<string, any> | unknown = unknown>(themes: Record<string, boolean | ((options: SnapshotMeta<C> & M & GM) => Promise<boolean> | Promise<void> | boolean | void)>): () => Promise<void>;
+  };
+};
+declare function createVis<GM extends Record<string, any> | unknown = unknown>(commands: SetupVisSuiteCommand): VisClientConfigurator<GM>;
+//#endregion
+//#region src/client/setup/vis.d.ts
+/**
+ * Visual test configuration on the client side.
+ */
+declare const vis: VisClientConfigurator<unknown>;
+//#endregion
+export { SetupVisOptions, VisClientConfigurator, createVis, vis };
+//# sourceMappingURL=setup.d.mts.map

package/dist/setup.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.mts","names":[],"sources":["../src/client/setup/create_vis.ts","../src/client/setup/vis.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAUY,2BAA2B;+BAGvB,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB,kCACxB,qCAGc,4BAA4B,kDAC/B,aAAa,KAAK,IAAI,OAC1B,mBAAmB;;;;AAX9B;AAAuC,KAkB3B,qBAlB2B,CAAA,WAkBM,MAlBN,CAAA,MAAA,EAAA,GAAA,CAAA,GAAA,OAAA,GAAA,OAAA,CAAA,GAAA;EAGvB;;;;;;;;;;;;;;;;;;AAehB;;;;;;;;;;EA+EsD,KAAA,CAAA,OAAA,CAAA,EAlDrC,eAkDqC,CAlDrB,EAkDqB,CAAA,CAAA,EAAA,IAAA;EAAmB;;;EAQjD,OAAA,EAAA;IACE;;;;;;;;IACf,MAAA,EAAA,EAAA,IAAA;IAIA;;AAIX;;;;;IAA4G,MAAA,EAAA,EAAA,IAAA;;;;ACvH5G;;;;;;;;;;;;;;;;;;;;;;oBDkGkB,4BAA4B,iDACnC,oCAEc,aAAa,KAAK,IAAI,OAAO,mBAAmB;;;aAK9D;;;0BAGa;4BACE,4BAA4B,iDAC3C,oCAEc,aAAa,KAAK,IAAI,OAAO,mBAAmB,yCAE9D;;;iBAIK,qBAAqB,mDAAmD,uBAAoB,sBAAA;;;;;;cCvH/F,KAAyB"}

package/dist/setup.mjs

@@ -0,0 +1,8 @@
+import "./asserts--HSSlgPD.mjs";
+import "./constants-CTBaz8Ml.mjs";
+import "./auto_snapshot_options-CAD43Zkp.mjs";
+import "./base64-CHSENEAO.mjs";
+import "./task_id-DnS9_4Ub.mjs";
+import { n as createVis, t as vis } from "./setup-BWgIDtv-.mjs";
+
+export { createVis, vis };

package/dist/setup_vis_suite-C6JGGT7B.d.mts

@@ -0,0 +1,17 @@
+import { t as VisOptions } from "./types-Do1N7g4c.mjs";
+import { Pick } from "type-plus";
+
+//#region src/server/commands/setup_vis_suite.d.ts
+interface SetupVisSuiteCommand {
+  /**
+   * Sets up the visual testing suite by cleaning up previous snapshot and diff output directories.
+   * When this command is run for the first time,
+   * it will remove the results and diffs directory of all suites.
+   *
+   * In subsequent runs, it will only remove the results and diffs directory of the current suite.
+   */
+  setupVisSuite: () => Promise<Pick<VisOptions, 'comparisonMethod' | 'diffOptions' | 'failureThreshold' | 'failureThresholdType' | 'snapshotKey' | 'subject' | 'timeout'>>;
+}
+//#endregion
+export { SetupVisSuiteCommand as t };
+//# sourceMappingURL=setup_vis_suite-C6JGGT7B.d.mts.map

package/dist/setup_vis_suite-C6JGGT7B.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup_vis_suite-C6JGGT7B.d.mts","names":[],"sources":["../src/server/commands/setup_vis_suite.ts"],"sourcesContent":[],"mappings":";;;;UAMiB,oBAAA;EAAA;;;;;;;uBAQK,QACpB,KACC"}

package/dist/snapshot_path-7GliOSH_.mjs

@@ -0,0 +1,58 @@
+import { a as SNAPSHOT_ROOT_DIR } from "./constants-CTBaz8Ml.mjs";
+import ci from "is-ci";
+import { platform } from "node:process";
+
+//#region src/shared/trim_common_folder.ts
+/**
+* Trim off common folder such as `src` or `tests` from the test file path.
+* This is used to generate the default snapshot sub-path.
+*/
+function trimCommonFolder(suiteName) {
+	suiteName = suiteName.replaceAll("..", "__");
+	const suiteDir = suiteName.split("/", 1)[0];
+	if ([
+		"tests",
+		"test",
+		"src",
+		"source",
+		"js",
+		"ts",
+		"lib"
+	].includes(suiteDir)) return suiteName.slice(suiteDir.length + 1);
+	return suiteName;
+}
+
+//#endregion
+//#region src/server/snapshot_path.ts
+function resolveSnapshotRootDir(browserCommandContext, options) {
+	if (!options.snapshotRootDir) return getSnapshotRootDir(SNAPSHOT_ROOT_DIR);
+	const snapshotRootDir = options.snapshotRootDir;
+	if (typeof snapshotRootDir === "string") return getSnapshotRootDir(snapshotRootDir);
+	const { config } = browserCommandContext.project.browser;
+	return snapshotRootDir({
+		ci,
+		browserName: config.browser.name,
+		providerName: browserCommandContext.provider.name,
+		platform,
+		screenshotFailures: config.browser.screenshotFailures,
+		screenshotDirectory: config.browser.screenshotDirectory
+	});
+}
+/**
+* Gets the root directory for storing snapshots.
+*
+* @param snapshotRootDir - Base directory for snapshots. Defaults to `__vis__`.
+* @returns The full snapshot root directory path, which includes a platform-specific subdirectory:
+* - When running in CI: `<snapshotRootDir>/<platform>` (e.g. `__vis__/linux`)
+* - When running locally: `<snapshotRootDir>/local`
+*/
+function getSnapshotRootDir(snapshotRootDir = SNAPSHOT_ROOT_DIR) {
+	return `${snapshotRootDir}/${ci ? platform : "local"}`;
+}
+function getSnapshotSubpath(suiteName, options) {
+	return (options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath)))({ subpath: suiteName });
+}
+
+//#endregion
+export { trimCommonFolder as i, getSnapshotSubpath as n, resolveSnapshotRootDir as r, getSnapshotRootDir as t };
+//# sourceMappingURL=snapshot_path-7GliOSH_.mjs.map

package/dist/snapshot_path-7GliOSH_.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot_path-7GliOSH_.mjs","names":[],"sources":["../src/shared/trim_common_folder.ts","../src/server/snapshot_path.ts"],"sourcesContent":["/**\n * Trim off common folder such as `src` or `tests` from the test file path.\n * This is used to generate the default snapshot sub-path.\n */\nexport function trimCommonFolder(suiteName: string) {\n\tsuiteName = suiteName.replaceAll('..', '__')\n\tconst suiteDir = suiteName.split('/', 1)[0]!\n\tif (['tests', 'test', 'src', 'source', 'js', 'ts', 'lib'].includes(suiteDir))\n\t\treturn suiteName.slice(suiteDir.length + 1)\n\treturn suiteName\n}\n","import ci from 'is-ci'\nimport { platform } from 'node:process'\nimport type { VisOptions } from '../config/types.ts'\nimport { SNAPSHOT_ROOT_DIR } from '../shared/constants.ts'\nimport { trimCommonFolder } from '../shared/trim_common_folder.ts'\nimport type { ExtendedBrowserCommandContext } from './vis_server_context.types.ts'\n\nexport function resolveSnapshotRootDir(browserCommandContext: ExtendedBrowserCommandContext, options: VisOptions) {\n\tif (!options.snapshotRootDir) return getSnapshotRootDir(SNAPSHOT_ROOT_DIR)\n\tconst snapshotRootDir = options.snapshotRootDir\n\tif (typeof snapshotRootDir === 'string') return getSnapshotRootDir(snapshotRootDir)\n\tconst { config } = browserCommandContext.project.browser\n\treturn snapshotRootDir({\n\t\tci,\n\t\tbrowserName: config.browser.name,\n\t\tproviderName: browserCommandContext.provider.name,\n\t\tplatform,\n\t\tscreenshotFailures: config.browser.screenshotFailures,\n\t\tscreenshotDirectory: config.browser.screenshotDirectory,\n\t})\n}\n\n/**\n * Gets the root directory for storing snapshots.\n *\n * @param snapshotRootDir - Base directory for snapshots. Defaults to `__vis__`.\n * @returns The full snapshot root directory path, which includes a platform-specific subdirectory:\n * - When running in CI: `<snapshotRootDir>/<platform>` (e.g. `__vis__/linux`)\n * - When running locally: `<snapshotRootDir>/local`\n */\nexport function getSnapshotRootDir(snapshotRootDir = SNAPSHOT_ROOT_DIR) {\n\treturn `${snapshotRootDir}/${ci ? platform : 'local'}`\n}\n\nexport function getSnapshotSubpath(suiteName: string, options: Pick<VisOptions, 'snapshotSubpath'>) {\n\tconst snapshotSubpath = options.snapshotSubpath ?? (({ subpath }) => trimCommonFolder(subpath))\n\treturn snapshotSubpath({ subpath: suiteName })\n}\n"],"mappings":";;;;;;;;;AAIA,SAAgB,iBAAiB,WAAmB;AACnD,aAAY,UAAU,WAAW,MAAM,KAAK;CAC5C,MAAM,WAAW,UAAU,MAAM,KAAK,EAAE,CAAC;AACzC,KAAI;EAAC;EAAS;EAAQ;EAAO;EAAU;EAAM;EAAM;EAAM,CAAC,SAAS,SAAS,CAC3E,QAAO,UAAU,MAAM,SAAS,SAAS,EAAE;AAC5C,QAAO;;;;;ACFR,SAAgB,uBAAuB,uBAAsD,SAAqB;AACjH,KAAI,CAAC,QAAQ,gBAAiB,QAAO,mBAAmB,kBAAkB;CAC1E,MAAM,kBAAkB,QAAQ;AAChC,KAAI,OAAO,oBAAoB,SAAU,QAAO,mBAAmB,gBAAgB;CACnF,MAAM,EAAE,WAAW,sBAAsB,QAAQ;AACjD,QAAO,gBAAgB;EACtB;EACA,aAAa,OAAO,QAAQ;EAC5B,cAAc,sBAAsB,SAAS;EAC7C;EACA,oBAAoB,OAAO,QAAQ;EACnC,qBAAqB,OAAO,QAAQ;EACpC,CAAC;;;;;;;;;;AAWH,SAAgB,mBAAmB,kBAAkB,mBAAmB;AACvE,QAAO,GAAG,gBAAgB,GAAG,KAAK,WAAW;;AAG9C,SAAgB,mBAAmB,WAAmB,SAA8C;AAEnG,SADwB,QAAQ,qBAAqB,EAAE,cAAc,iBAAiB,QAAQ,GACvE,EAAE,SAAS,WAAW,CAAC"}

package/dist/src-CSQnlFa9.mjs

@@ -0,0 +1 @@
+export {  };