vitest-plugin-vis 1.0.0

package/esm/client/ctx.d.ts

@@ -0,0 +1,6 @@
+import { getCurrentTest } from 'vitest/suite';
+export declare const ctx: {
+    getCurrentTest: typeof getCurrentTest;
+    __test__reset(): void;
+};
+//# sourceMappingURL=ctx.d.ts.map

package/esm/client/ctx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.d.ts","sourceRoot":"","sources":["../../src/client/ctx.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,eAAO,MAAM,GAAG;;;CAKf,CAAA"}

package/esm/client/ctx.js

@@ -0,0 +1,7 @@
+import { getCurrentTest } from 'vitest/suite';
+export const ctx = {
+    getCurrentTest,
+    __test__reset() {
+        ctx.getCurrentTest = getCurrentTest;
+    },
+};

package/esm/client/expect/expectation_result.d.ts

@@ -0,0 +1,3 @@
+import type { SyncExpectationResult } from '@vitest/expect';
+export declare const success: SyncExpectationResult;
+//# sourceMappingURL=expectation_result.d.ts.map

package/esm/client/expect/expectation_result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expectation_result.d.ts","sourceRoot":"","sources":["../../../src/client/expect/expectation_result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAE3D,eAAO,MAAM,OAAO,EAAE,qBAIrB,CAAA"}

package/esm/client/expect/expectation_result.js

@@ -0,0 +1,5 @@
+export const success = {
+    pass: true,
+    /* v8 ignore next */
+    message: () => '',
+};

package/esm/client/expect/extend.d.ts

@@ -0,0 +1,8 @@
+import type { ImageSnapshotMatcher } from './to_match_image_snapshot.types.ts';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> extends ImageSnapshotMatcher {
+        }
+    }
+}
+//# sourceMappingURL=extend.d.ts.map

package/esm/client/expect/extend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extend.d.ts","sourceRoot":"","sources":["../../../src/client/expect/extend.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AAE9E,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,IAAI,CAAC;QAEd,UAAU,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,oBAAoB;SAAG;KACxD;CACD"}

package/esm/client/expect/extend.js

@@ -0,0 +1,3 @@
+import { expect } from 'vitest';
+import { toMatchImageSnapshot } from "./to_match_image_snapshot.js";
+expect.extend({ toMatchImageSnapshot });

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

@@ -0,0 +1,9 @@
+import type { AsyncExpectationResult } from '@vitest/expect';
+import type { ToMatchImageSnapshotOptions } from './to_match_image_snapshot.types.ts';
+export declare function toMatchImageSnapshot(
+/**
+ * The element or locator to take the snapshot of,
+ * or the base64 value of the image to compare against.
+ */
+subject: any, options?: ToMatchImageSnapshotOptions | undefined): AsyncExpectationResult;
+//# sourceMappingURL=to_match_image_snapshot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"to_match_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAK5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAA;AAErF,wBAAgB,oBAAoB;AACnC;;;GAGG;AACH,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,GAC/C,sBAAsB,CAgBxB"}

package/esm/client/expect/to_match_image_snapshot.js

@@ -0,0 +1,32 @@
+import { commands } from '@vitest/browser/context';
+import { ctx } from "../ctx.js";
+import { toTaskId } from "../task_id.js";
+import { success } from "./expectation_result.js";
+import { parseImageSnapshotSubject } from "./to_match_image_snapshot.logic.js";
+export function toMatchImageSnapshot(
+/**
+ * The element or locator to take the snapshot of,
+ * or the base64 value of the image to compare against.
+ */
+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. ");
+    }
+    const s = parseImageSnapshotSubject(subject);
+    const taskId = toTaskId(test);
+    return toMatchImageSnapshotAsync(taskId, s, options).then(() => success);
+}
+async function toMatchImageSnapshotAsync(taskId, subject, options) {
+    if (options?.customizeSnapshotId) {
+        const index = await commands.imageSnapshotNextIndex(taskId);
+        const { customizeSnapshotId, ...rest } = options;
+        const snapshotFileId = customizeSnapshotId(taskId, index);
+        return commands.matchImageSnapshot(taskId, subject, { ...rest, snapshotFileId });
+    }
+    return commands.matchImageSnapshot(taskId, subject, options);
+}

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

@@ -0,0 +1,2 @@
+export declare function parseImageSnapshotSubject(subject: any): any;
+//# sourceMappingURL=to_match_image_snapshot.logic.d.ts.map

package/esm/client/expect/to_match_image_snapshot.logic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to_match_image_snapshot.logic.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.logic.ts"],"names":[],"mappings":"AAGA,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,GAAG,OAOrD"}

package/esm/client/expect/to_match_image_snapshot.logic.js

@@ -0,0 +1,11 @@
+import { isBase64String } from "../../shared/base64.js";
+import { convertElementToCssSelector } from "../selector.js";
+export function parseImageSnapshotSubject(subject) {
+    if (subject instanceof Element)
+        return convertElementToCssSelector(subject);
+    if (subject?.['selector'])
+        return subject['selector'];
+    if (isBase64String(subject))
+        return subject;
+    throw new Error(`'toMatchImageSnapshot()' expects the subject to be an element, locator, or image encoded in base64 string, but got: ${subject}`);
+}

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

@@ -0,0 +1,7 @@
+import type { ImageSnapshotCompareOptions, ImageSnapshotIdOptions, ImageSnapshotTimeoutOptions } from '../../shared/types.ts';
+export interface ImageSnapshotMatcher {
+    toMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>;
+}
+export interface ToMatchImageSnapshotOptions extends ImageSnapshotTimeoutOptions, ImageSnapshotIdOptions, ImageSnapshotCompareOptions {
+}
+//# sourceMappingURL=to_match_image_snapshot.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"to_match_image_snapshot.types.d.ts","sourceRoot":"","sources":["../../../src/client/expect/to_match_image_snapshot.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,uBAAuB,CAAA;AAE9B,MAAM,WAAW,oBAAoB;IACpC,oBAAoB,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACtF;AAED,MAAM,WAAW,2BAChB,SAAQ,2BAA2B,EAClC,sBAAsB,EACtB,2BAA2B;CAAG"}

package/esm/client/expect/to_match_image_snapshot.types.js

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

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

@@ -0,0 +1,6 @@
+import { type HasImageSnapshotAction } from './has_image_snapshot.ts';
+declare module '@vitest/browser/context' {
+    interface BrowserPage extends HasImageSnapshotAction {
+    }
+}
+//# sourceMappingURL=extend.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"extend.d.ts","sourceRoot":"","sources":["../../../src/client/page/extend.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,sBAAsB,EAAoB,MAAM,yBAAyB,CAAA;AAEvF,OAAO,QAAQ,yBAAyB,CAAC;IACxC,UAAU,WAAY,SAAQ,sBAAsB;KAAG;CACvD"}

package/esm/client/page/extend.js

@@ -0,0 +1,3 @@
+import { page } from '@vitest/browser/context';
+import { hasImageSnapshot } from "./has_image_snapshot.js";
+page.extend({ hasImageSnapshot });

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

@@ -0,0 +1,10 @@
+import { type BrowserPage } from '@vitest/browser/context';
+import type { ImageSnapshotIdOptions } from '../../shared/types.ts';
+export interface HasImageSnapshotAction {
+    hasImageSnapshot(this: BrowserPage, options?: ImageSnapshotIdOptions | undefined): Promise<boolean>;
+}
+/**
+ * Check if the snapshot image exists.
+ */
+export declare function hasImageSnapshot(this: BrowserPage, options?: ImageSnapshotIdOptions | undefined): Promise<boolean>;
+//# sourceMappingURL=has_image_snapshot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"has_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/client/page/has_image_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAY,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAInE,MAAM,WAAW,sBAAsB;IACtC,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,SAAS,oBAoB/F"}

package/esm/client/page/has_image_snapshot.js

@@ -0,0 +1,23 @@
+import { commands } from '@vitest/browser/context';
+import { ctx } from "../ctx.js";
+import { toTaskId } from "../task_id.js";
+/**
+ * Check if the snapshot image exists.
+ */
+export 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. ");
+    }
+    const taskId = toTaskId(test);
+    if (options?.customizeSnapshotId) {
+        return commands
+            .imageSnapshotNextIndex(taskId)
+            .then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId(taskId, index)));
+    }
+    return commands.hasImageSnapshot(taskId);
+}

package/esm/client/selector.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Most of the code in this file is copied from Vitest.
+ *
+ * @see https://github.com/vitest-dev/vitest/blob/main/packages/browser/src/client/utils.ts
+ */
+import type { Locator } from '@vitest/browser/context';
+export declare function convertToSelector(elementOrLocator: Element | Locator): string;
+export declare function convertElementToCssSelector(element: Element): string;
+//# sourceMappingURL=selector.d.ts.map

package/esm/client/selector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selector.d.ts","sourceRoot":"","sources":["../../src/client/selector.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAEtD,wBAAgB,iBAAiB,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAW7E;AACD,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,OAAO,UAM3D"}

package/esm/client/selector.js

@@ -0,0 +1,104 @@
+export function convertToSelector(elementOrLocator) {
+    if (!elementOrLocator) {
+        throw new Error('Expected element or locator to be defined.');
+    }
+    if (elementOrLocator instanceof Element) {
+        return convertElementToCssSelector(elementOrLocator);
+    }
+    if ('selector' in elementOrLocator) {
+        return elementOrLocator.selector;
+    }
+    throw new Error('Expected element or locator to be an instance of Element or Locator.');
+}
+export function convertElementToCssSelector(element) {
+    if (!element || !(element instanceof Element)) {
+        throw new Error(`Expected DOM element to be an instance of Element, received ${typeof element}`);
+    }
+    return getUniqueCssSelector(element);
+}
+function escapeIdForCSSSelector(id) {
+    return id
+        .split('')
+        .map((char) => {
+        const code = char.charCodeAt(0);
+        if (char === ' ' ||
+            char === '#' ||
+            char === '.' ||
+            char === ':' ||
+            char === '[' ||
+            char === ']' ||
+            char === '>' ||
+            char === '+' ||
+            char === '~' ||
+            char === '\\') {
+            // Escape common special characters with backslashes
+            return `\\${char}`;
+        }
+        if (code >= 0x10000) {
+            // Unicode escape for characters outside the BMP
+            return `\\${code.toString(16).toUpperCase().padStart(6, '0')} `;
+        }
+        if (code < 0x20 || code === 0x7f) {
+            // Non-printable ASCII characters (0x00-0x1F and 0x7F) are escaped
+            return `\\${code.toString(16).toUpperCase().padStart(2, '0')} `;
+        }
+        if (code >= 0x80) {
+            // Non-ASCII characters (0x80 and above) are escaped
+            return `\\${code.toString(16).toUpperCase().padStart(2, '0')} `;
+        }
+        // Allowable characters are used directly
+        return char;
+    })
+        .join('');
+}
+function getUniqueCssSelector(el) {
+    const path = [];
+    let parent;
+    let hasShadowRoot = false;
+    // eslint-disable-next-line no-cond-assign
+    while ((parent = getParent(el))) {
+        if (parent.shadowRoot) {
+            hasShadowRoot = true;
+        }
+        const tag = el.tagName;
+        if (el.id) {
+            path.push(`#${escapeIdForCSSSelector(el.id)}`);
+        }
+        else if (!el.nextElementSibling && !el.previousElementSibling) {
+            path.push(tag.toLowerCase());
+        }
+        else {
+            let index = 0;
+            let sameTagSiblings = 0;
+            let elementIndex = 0;
+            for (const sibling of parent.children) {
+                index++;
+                if (sibling.tagName === tag) {
+                    sameTagSiblings++;
+                }
+                if (sibling === el) {
+                    elementIndex = index;
+                }
+            }
+            if (sameTagSiblings > 1) {
+                path.push(`${tag.toLowerCase()}:nth-child(${elementIndex})`);
+            }
+            else {
+                path.push(tag.toLowerCase());
+            }
+        }
+        el = parent;
+    }
+    return `${getBrowserState().provider === 'webdriverio' && hasShadowRoot ? '>>>' : ''}${path.reverse().join(' > ')}`;
+}
+function getParent(el) {
+    const parent = el.parentNode;
+    if (parent instanceof ShadowRoot) {
+        return parent.host;
+    }
+    return parent;
+}
+function getBrowserState() {
+    // @ts-expect-error not typed global
+    return window.__vitest_browser_runner__;
+}

package/esm/client/should_take_snapshot.d.ts

@@ -0,0 +1,10 @@
+import type { SnapshotMeta } from './snapshot_options.ts';
+/**
+ * Determine should snapshot be taken.
+ *
+ * not story: false
+ * no `snapshot` tag: false
+ * disabled by `!snapshot` tag: false
+ */
+export declare function shouldTakeSnapshot(meta?: SnapshotMeta | undefined): boolean;
+//# sourceMappingURL=should_take_snapshot.d.ts.map

package/esm/client/should_take_snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"should_take_snapshot.d.ts","sourceRoot":"","sources":["../../src/client/should_take_snapshot.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,WAGjE"}

package/esm/client/should_take_snapshot.js

@@ -0,0 +1,13 @@
+import { ctx } from "./ctx.js";
+import { getAutoSnapshotOptions } from "./snapshot_options.internal.js";
+/**
+ * Determine should snapshot be taken.
+ *
+ * not story: false
+ * no `snapshot` tag: false
+ * disabled by `!snapshot` tag: false
+ */
+export function shouldTakeSnapshot(meta) {
+    const m = meta ?? getAutoSnapshotOptions(ctx.getCurrentTest());
+    return document.body.childElementCount > 0 && m?.enable !== false;
+}

package/esm/client/snapshot_options.d.ts

@@ -0,0 +1,34 @@
+import type { ToMatchImageSnapshotOptions } from './expect/to_match_image_snapshot.types.ts';
+export type SnapshotMeta = ToMatchImageSnapshotOptions & {
+    enable?: boolean | undefined;
+};
+type Suite = {
+    meta: Record<string, any>;
+    suite?: Suite | undefined;
+};
+export type MetaTask = {
+    file?: {
+        meta: Record<string, any>;
+    } | undefined;
+    suite?: Suite | undefined;
+    meta: Record<string, any>;
+} | undefined;
+/**
+ * Set the snapshot options for auto snapshot.
+ *
+ * ```ts
+ * beforeAll((suite) => setAutoSnapshotOptions(suite, ...))
+ * beforeEach(({ task }) => setAutoSnapshotOptions(task, ...))
+ *
+ * it('...', ({ task }) => {
+ *   setAutoSnapshotOptions(task, ...)
+ * })
+ * ```
+ *
+ * @param task Optional. Suite or task to set the options.
+ * If not provided, it will set the options for the current test.
+ */
+export declare function setAutoSnapshotOptions(task: MetaTask, meta: SnapshotMeta | boolean): void;
+export declare function setAutoSnapshotOptions(meta: SnapshotMeta | boolean): void;
+export {};
+//# sourceMappingURL=snapshot_options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot_options.d.ts","sourceRoot":"","sources":["../../src/client/snapshot_options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAA;AAE5F,MAAM,MAAM,YAAY,GAAG,2BAA2B,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,CAAA;AAEzF,KAAK,KAAK,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CAAE,CAAA;AAErE,MAAM,MAAM,QAAQ,GACjB;IACA,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,SAAS,CAAA;IAChD,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxB,GACD,SAAS,CAAA;AAEZ;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,IAAI,CAAA;AAC1F,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,IAAI,CAAA"}

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

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

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

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

package/esm/client/snapshot_options.internal.js

@@ -0,0 +1,20 @@
+import { NAME } from "../shared/constants.js";
+export function getAutoSnapshotOptions(task) {
+    if (!task)
+        return;
+    const list = [];
+    let current = task;
+    while (current?.suite) {
+        list.unshift(current.suite.meta);
+        current = current.suite;
+    }
+    list.unshift(task.file?.meta);
+    list.push(task.meta);
+    return list.reduce((acc, cur) => {
+        if (cur?.[NAME]) {
+            const { [NAME]: meta } = cur;
+            return Object.assign({}, acc, meta);
+        }
+        return acc;
+    }, {});
+}

package/esm/client/snapshot_options.js

@@ -0,0 +1,16 @@
+import { NAME } from "../shared/constants.js";
+import { ctx } from "./ctx.js";
+export function setAutoSnapshotOptions(...args) {
+    const [task, meta] = parseArgs(args);
+    if (task)
+        task.meta[NAME] = {
+            ...task.meta[NAME],
+            ...meta,
+        };
+}
+function parseArgs(args) {
+    return args.length === 1 ? [ctx.getCurrentTest(), parseMeta(args[0])] : [args[0], parseMeta(args[1])];
+}
+function parseMeta(meta) {
+    return typeof meta === 'boolean' ? { enable: meta } : { enable: true, ...meta };
+}

package/esm/client/task_id.d.ts

@@ -0,0 +1,7 @@
+type Task = {
+    name: string;
+    suite?: Task | undefined;
+};
+export declare function toTaskId(task: Task): string;
+export {};
+//# sourceMappingURL=task_id.d.ts.map

package/esm/client/task_id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"task_id.d.ts","sourceRoot":"","sources":["../../src/client/task_id.ts"],"names":[],"mappings":"AAAA,KAAK,IAAI,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CACxB,CAAA;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,UAUlC"}

package/esm/client/task_id.js

@@ -0,0 +1,10 @@
+export function toTaskId(task) {
+    const l = [];
+    let t = task;
+    while (t?.suite) {
+        l.unshift(t.suite.name.replace(/[^a-z0-9]/gi, '-').toLowerCase());
+        t = t.suite;
+    }
+    l.push(task.name.replace(/[^a-z0-9]/gi, '-').toLowerCase());
+    return l.join('/');
+}

package/esm/client.d.ts

@@ -0,0 +1,8 @@
+export * from './client/expect/expectation_result.ts';
+export * from './client/expect/to_match_image_snapshot.logic.ts';
+export type * from './client/expect/to_match_image_snapshot.types.ts';
+export * from './client/should_take_snapshot.ts';
+export * from './client/snapshot_options.ts';
+export * from './client/task_id.ts';
+export type * from './shared/types.ts';
+//# sourceMappingURL=client.d.ts.map

package/esm/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAA;AACrD,cAAc,kDAAkD,CAAA;AAChE,mBAAmB,kDAAkD,CAAA;AACrE,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,qBAAqB,CAAA;AACnC,mBAAmB,mBAAmB,CAAA"}

package/esm/client.js

@@ -0,0 +1,5 @@
+export * from "./client/expect/expectation_result.js";
+export * from "./client/expect/to_match_image_snapshot.logic.js";
+export * from "./client/should_take_snapshot.js";
+export * from "./client/snapshot_options.js";
+export * from "./client/task_id.js";

package/esm/commands.d.ts

@@ -0,0 +1,5 @@
+export * from './server/commands/has_image_snapshot.ts';
+export * from './server/commands/image_snapshot_next_index.ts';
+export * from './server/commands/match_image_snapshot.ts';
+export * from './server/commands/setup_vis_suite.ts';
+//# sourceMappingURL=commands.d.ts.map

package/esm/commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAA;AACvD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,2CAA2C,CAAA;AACzD,cAAc,sCAAsC,CAAA"}

package/esm/commands.js

@@ -0,0 +1,4 @@
+export * from "./server/commands/has_image_snapshot.js";
+export * from "./server/commands/image_snapshot_next_index.js";
+export * from "./server/commands/match_image_snapshot.js";
+export * from "./server/commands/setup_vis_suite.js";

package/esm/config/types.d.ts

@@ -0,0 +1,35 @@
+import type { ToMatchImageSnapshotOptions } from '../client/expect/to_match_image_snapshot.types.ts';
+export interface VisOptions extends ToMatchImageSnapshotOptions {
+    /**
+     * 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;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAA;AAEpG,MAAM,WAAW,UAAW,SAAQ,2BAA2B;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/C;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;CACtD"}

package/esm/config/types.js

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

package/esm/config/vis.d.ts

@@ -0,0 +1,25 @@
+import type { VisOptions } from './types.ts';
+/**
+ * Create a Vite plugin for visual testing.
+ *
+ * If options are not provided, the plugin will use the default options,
+ * which enables the `auto` preset.
+ */
+export declare function vis(options?: VisOptions): {
+    name: string;
+    config(this: void): {
+        test: {
+            browser: {
+                name: string;
+                commands: {
+                    setupVisSuite: import("vitest/node").BrowserCommand<[]>;
+                    imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
+                    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotId?: string | undefined]>;
+                    matchImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("../commands.ts").MatchImageSnapshotOptions | undefined]>;
+                };
+            };
+            setupFiles: string[] | undefined;
+        };
+    };
+};
+//# sourceMappingURL=vis.d.ts.map

package/esm/config/vis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vis.d.ts","sourceRoot":"","sources":["../../src/config/vis.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,OAAO,GAAE,UAA+B;;;;;sBASxB,MAAM;;;;;;;;;;;EAQzC"}

package/esm/config/vis.js

@@ -0,0 +1,27 @@
+import { commands } from "../server/commands/extend.js";
+import { visContext } from "../server/vis_context.js";
+import { NAME } from "../shared/constants.js";
+/**
+ * Create a Vite plugin for visual testing.
+ *
+ * If options are not provided, the plugin will use the default options,
+ * which enables the `auto` preset.
+ */
+export function vis(options = { preset: 'auto' }) {
+    visContext.setOptions(options);
+    const preset = options?.preset;
+    return {
+        name: NAME,
+        config() {
+            return {
+                test: {
+                    browser: {
+                        name: undefined,
+                        commands,
+                    },
+                    setupFiles: preset && preset !== 'none' ? [`vitest-plugin-vis/presets/${preset}`] : undefined,
+                },
+            };
+        },
+    };
+}

package/esm/config.d.ts

@@ -0,0 +1,4 @@
+export type * from './config/types.ts';
+export * from './config/vis.ts';
+export * from './shared/trim_common_folder.ts';
+//# sourceMappingURL=config.d.ts.map

package/esm/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,mBAAmB,mBAAmB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gCAAgC,CAAA"}

package/esm/config.js

@@ -0,0 +1,2 @@
+export * from "./config/vis.js";
+export * from "./shared/trim_common_folder.js";

package/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client/snapshot_options.ts';
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,8BAA8B,CAAA"}

package/esm/index.js

@@ -0,0 +1,2 @@
+// `vitest-plugin-vis` provides code that can be used in test files.
+export * from "./client/snapshot_options.js";

package/esm/presets/auto.d.ts

@@ -0,0 +1,2 @@
+import 'vitest-browser-react';
+//# sourceMappingURL=auto.d.ts.map

package/esm/presets/auto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto.d.ts","sourceRoot":"","sources":["../../src/presets/auto.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAA"}