vitest-plugin-vis 3.5.1 → 4.1.0

package/esm/config/types.d.ts

@@ -1,60 +0,0 @@
-import type { ComparisonMethod, FailureThresholdOptions, ImageSnapshotKeyOptions, ImageSnapshotSubjectOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, PixelDiffOptions, SsimComparisonOptions, SsimDiffOptions } from '../shared/types.ts';
-export type { ComparisonMethod, PixelComparisonOptions, PixelDiffOptions, SsimComparisonOptions, SsimDiffOptions };
-export type VisOptions<M extends ComparisonMethod = 'pixel'> = (M extends 'ssim' ? {
-    comparisonMethod: M;
-    /**
-     * Custom options passed to 'ssim'
-     */
-    diffOptions?: Partial<SsimDiffOptions> | undefined;
-} : {
-    comparisonMethod?: M | undefined;
-    /**
-     * Custom options passed to 'pixelmatch'
-     */
-    diffOptions?: PixelDiffOptions | undefined;
-}) & FailureThresholdOptions & ImageSnapshotTimeoutOptions & ImageSnapshotKeyOptions & ImageSnapshotSubjectOptions & {
-    /**
-     * Loads the `test.setupFiles` of the specified preset.
-     *
-     * Note:
-     * - 'enable` is deprecated. Use `manual` for the same effect.
-     * - 'none` is deprecated. Use `custom` for the same effect.
-     *
-     * @default 'auto'
-     *
-     */
-    preset?: 'enable' | 'manual' | 'auto' | 'custom' | 'none' | undefined;
-    /**
-     * The snapshot folder relative to the root of the project.
-     *
-     * Default: `{projectRoot}/__vis__/{platform}`
-     */
-    snapshotRootDir?: string | ((context: {
-        ci: boolean;
-        browserName?: string | undefined;
-        providerName: string;
-        platform: string;
-        screenshotFailures?: boolean | undefined;
-        screenshotDirectory?: string | undefined;
-    }) => string) | undefined;
-    /**
-     * Customize the snapshot subpath.
-     *
-     * 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 options - Options for customizing the snapshot subpath.
-     * @property subPath - The path of the test file to be used as the snapshot subpath.
-     *                     To retain the full path, simply return it.
-     * @returns The customized snapshot subpath.
-     */
-    snapshotSubpath?: ((options: {
-        subpath: string;
-    }) => string) | undefined;
-};
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,MAAM,oBAAoB,CAAA;AAE3B,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,CAAA;AAElH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,MAAM,GAC7E;IACA,gBAAgB,EAAE,CAAC,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;CAClD,GACA;IACA,gBAAgB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC1C,CAAC,GACH,uBAAuB,GACvB,2BAA2B,GAC3B,uBAAuB,GACvB,2BAA2B,GAAG;IAC7B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;IACrE;;;;OAIG;IACH,eAAe,CAAC,EACb,MAAM,GACN,CAAC,CAAC,OAAO,EAAE;QACX,EAAE,EAAE,OAAO,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,YAAY,EAAE,MAAM,CAAA;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACxC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACvC,KAAK,MAAM,CAAC,GACb,SAAS,CAAA;IACZ;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;CACxE,CAAA"}

package/esm/config/types.js

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

package/esm/config/vis.d.ts

@@ -1,28 +0,0 @@
-import type { ComparisonMethod } from '../shared/types.ts';
-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<M extends ComparisonMethod = 'pixel'>(options?: VisOptions<M>): {
-    name: string;
-    config(this: unknown, userConfig: import("vite").UserConfig): {
-        test: {
-            browser: {
-                name: string;
-                commands: {
-                    setupVisSuite: import("vitest/node").BrowserCommand<[]>;
-                    imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
-                    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotKey: string | undefined]>;
-                    preparePageImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, options?: import("../server/commands/types.ts").MatchImageSnapshotOptions | undefined]>;
-                    prepareImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("../server/commands/types.ts").MatchImageSnapshotOptions | undefined]>;
-                    loadImageSnapshotResults: import("vitest/node").BrowserCommand<[taskId: string]>;
-                };
-            };
-            setupFiles: string[];
-        };
-    };
-};
-//# sourceMappingURL=vis.d.ts.map

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

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

package/esm/config/vis.js

@@ -1,27 +0,0 @@
-import { commands } from "../server/commands/commands.js";
-import { setVisOption } from "../server/vis_options.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' }) {
-    return {
-        name: NAME,
-        config(userConfig) {
-            setVisOption(userConfig, options);
-            const preset = options?.preset;
-            return {
-                test: {
-                    browser: {
-                        name: undefined,
-                        commands,
-                    },
-                    setupFiles: preset && preset !== 'none' && preset !== 'custom' ? [`vitest-plugin-vis/presets/${preset}`] : [],
-                },
-            };
-        },
-    };
-}

package/esm/config.d.ts

@@ -1,4 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

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

package/esm/index.d.ts

@@ -1,5 +0,0 @@
-import './client/expect/augment.ts';
-import './client/page/augment.ts';
-export { setAutoSnapshotOptions, type MetaTask } from './client/auto_snapshot_options.ts';
-export type * from './shared/types.ts';
-//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAA;AACnC,OAAO,0BAA0B,CAAA;AAEjC,OAAO,EAAE,sBAAsB,EAAE,KAAK,QAAQ,EAAE,MAAM,mCAAmC,CAAA;AACzF,mBAAmB,mBAAmB,CAAA"}

package/esm/index.js

@@ -1,4 +0,0 @@
-// `vitest-plugin-vis` provides code that can be used in test files.
-import "./client/expect/augment.js";
-import "./client/page/augment.js";
-export { setAutoSnapshotOptions } from "./client/auto_snapshot_options.js";

package/esm/presets/auto.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=auto.d.ts.map

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

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

package/esm/presets/auto.js

@@ -1,8 +0,0 @@
-import { afterEach, beforeAll } from 'vitest';
-import { setAutoSnapshotOptions } from "../index.js";
-import { vis } from "../setup.js";
-beforeAll(async () => {
-    await vis.beforeAll.setup();
-    setAutoSnapshotOptions(true);
-});
-afterEach(() => vis.afterEach.matchImageSnapshot());

package/esm/presets/enable.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=enable.d.ts.map

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

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

package/esm/presets/enable.js

@@ -1,4 +0,0 @@
-import { afterEach, beforeAll } from 'vitest';
-import { vis } from "../setup.js";
-beforeAll(() => vis.beforeAll.setup());
-afterEach(() => vis.afterEach.matchImageSnapshot());

package/esm/presets/manual.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=manual.d.ts.map

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

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

package/esm/presets/manual.js

@@ -1,4 +0,0 @@
-import { afterEach, beforeAll } from 'vitest';
-import { vis } from "../setup.js";
-beforeAll(() => vis.beforeAll.setup());
-afterEach(() => vis.afterEach.matchImageSnapshot());

package/esm/server/browser_provider/browser_api.d.ts

@@ -1,3 +0,0 @@
-import type { BrowserCommandContext } from 'vitest/node';
-export declare function browserApi(context: BrowserCommandContext): import("./types.ts").BrowserApi;
-//# sourceMappingURL=browser_api.d.ts.map

package/esm/server/browser_provider/browser_api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser_api.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/browser_api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAIxD,wBAAgB,UAAU,CAAC,OAAO,EAAE,qBAAqB,mCAQxD"}

package/esm/server/browser_provider/browser_api.js

@@ -1,11 +0,0 @@
-import { playwright } from "./playwright.js";
-import { webdriverio } from "./webdriverio.js";
-export function browserApi(context) {
-    if (context.provider.name === 'playwright') {
-        return playwright(context);
-    }
-    if (context.provider.name === 'webdriverio') {
-        return webdriverio(context);
-    }
-    throw new Error(`Unsupported provider: ${context.provider.name}`);
-}

package/esm/server/browser_provider/playwright.d.ts

@@ -1,4 +0,0 @@
-import type { BrowserCommandContext } from 'vitest/node';
-import type { BrowserApi } from './types.ts';
-export declare function playwright(context: BrowserCommandContext): BrowserApi;
-//# sourceMappingURL=playwright.d.ts.map

package/esm/server/browser_provider/playwright.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/playwright.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,wBAAgB,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,CAgBrE"}

package/esm/server/browser_provider/playwright.js

@@ -1,18 +0,0 @@
-import { resolve } from 'pathe';
-export function playwright(context) {
-    return {
-        async takeScreenshot(projectRoot, relativeFilePath, selector, options) {
-            const subject = context.iframe.locator(selector);
-            return subject.screenshot({
-                path: resolve(projectRoot, relativeFilePath),
-                ...options,
-            });
-        },
-        async takePageScreenshot(projectRoot, relativeFilePath, options) {
-            return context.page.screenshot({
-                path: resolve(projectRoot, relativeFilePath),
-                ...options,
-            });
-        },
-    };
-}

package/esm/server/browser_provider/types.d.ts

@@ -1,10 +0,0 @@
-export interface BrowserApi {
-    takeScreenshot(projectRoot: string, relativeFilePath: string, selector: string, options: {
-        timeout?: number | undefined;
-    } | undefined): Promise<Buffer>;
-    takePageScreenshot(projectRoot: string, relativeFilePath: string, options: {
-        fullPage?: boolean | undefined;
-        timeout?: number | undefined;
-    } | undefined): Promise<Buffer>;
-}
-//# sourceMappingURL=types.d.ts.map

package/esm/server/browser_provider/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IAC1B,cAAc,CACb,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,EACJ;QACA,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GACD,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,kBAAkB,CACjB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EACJ;QACA,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GACD,SAAS,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;CAClB"}

package/esm/server/browser_provider/types.js

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

package/esm/server/browser_provider/webdriverio.d.ts

@@ -1,4 +0,0 @@
-import type { BrowserCommandContext } from 'vitest/node';
-import type { BrowserApi } from './types.ts';
-export declare function webdriverio(context: BrowserCommandContext): BrowserApi;
-//# sourceMappingURL=webdriverio.d.ts.map

package/esm/server/browser_provider/webdriverio.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"webdriverio.d.ts","sourceRoot":"","sources":["../../../src/server/browser_provider/webdriverio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,wBAAgB,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,CAWtE"}

package/esm/server/browser_provider/webdriverio.js

@@ -1,12 +0,0 @@
-export function webdriverio(context) {
-    const browser = context.browser;
-    return {
-        async takeScreenshot(_projectRoot, relativeFilePath, selector) {
-            const element = await browser.$(`${selector}`);
-            return element.saveScreenshot(relativeFilePath);
-        },
-        async takePageScreenshot(_projectRoot, relativeFilePath, options) {
-            return browser.saveScreenshot(relativeFilePath, options);
-        },
-    };
-}

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

@@ -1,5 +0,0 @@
-import type { RequiredPick } from 'type-plus';
-import type { BrowserCommandContext } from 'vitest/node';
-export declare function assertTestPathDefined(context: BrowserCommandContext, commandName: string): asserts context is RequiredPick<BrowserCommandContext, 'testPath'>;
-export declare function assertIsRelativePath(relativeFilePath: string, propName: string): void;
-//# sourceMappingURL=_assertions.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"_assertions.d.ts","sourceRoot":"","sources":["../../../src/server/commands/_assertions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,MAAM,GACjB,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAIpE;AAED,wBAAgB,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,QAI9E"}

package/esm/server/commands/_assertions.js

@@ -1,11 +0,0 @@
-import { isAbsolute } from 'pathe';
-export function assertTestPathDefined(context, commandName) {
-    if (!context.testPath) {
-        throw new Error(`'commands.${commandName}' requires testPath to be defined`);
-    }
-}
-export function assertIsRelativePath(relativeFilePath, propName) {
-    if (isAbsolute(relativeFilePath)) {
-        throw new Error(`'${propName}' must be a relative path`);
-    }
-}

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

@@ -1,11 +0,0 @@
-import type { HasImageSnapshotCommand } from './has_image_snapshot.ts';
-import type { ImageSnapshotNextIndexCommand } from './image_snapshot_next_index.ts';
-import type { LoadImageSnapshotResultsCommand } from './load_image_snapshot_results.ts';
-import type { PrepareImageSnapshotComparisonCommand } from './prepare_image_snapshot_comparison.ts';
-import type { PreparePageImageSnapshotComparisonCommand } from './prepare_page_image_snapshot_comparison.ts';
-import type { SetupVisSuiteCommand } from './setup_vis_suite.ts';
-declare module '@vitest/browser/context' {
-    interface BrowserCommands extends SetupVisSuiteCommand, ImageSnapshotNextIndexCommand, HasImageSnapshotCommand, PreparePageImageSnapshotComparisonCommand, PrepareImageSnapshotComparisonCommand, LoadImageSnapshotResultsCommand {
-    }
-}
-//# sourceMappingURL=augment.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"augment.d.ts","sourceRoot":"","sources":["../../../src/server/commands/augment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAA;AACnF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAA;AACvF,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,wCAAwC,CAAA;AACnG,OAAO,KAAK,EAAE,yCAAyC,EAAE,MAAM,6CAA6C,CAAA;AAC5G,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAEhE,OAAO,QAAQ,yBAAyB,CAAC;IACxC,UAAU,eACT,SAAQ,oBAAoB,EAC3B,6BAA6B,EAC7B,uBAAuB,EACvB,yCAAyC,EACzC,qCAAqC,EACrC,+BAA+B;KAAG;CACpC"}

package/esm/server/commands/augment.js

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

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

@@ -1,9 +0,0 @@
-export declare const commands: {
-    setupVisSuite: import("vitest/node").BrowserCommand<[]>;
-    imageSnapshotNextIndex: import("vitest/node").BrowserCommand<[taskId: string]>;
-    hasImageSnapshot: import("vitest/node").BrowserCommand<[taskId: string, snapshotKey: string | undefined]>;
-    preparePageImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, options?: import("./types.ts").MatchImageSnapshotOptions | undefined]>;
-    prepareImageSnapshotComparison: import("vitest/node").BrowserCommand<[taskId: string, subject: string, options?: import("./types.ts").MatchImageSnapshotOptions | undefined]>;
-    loadImageSnapshotResults: import("vitest/node").BrowserCommand<[taskId: string]>;
-};
-//# sourceMappingURL=commands.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../src/server/commands/commands.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ;;;;;;;CAOpB,CAAA"}

package/esm/server/commands/commands.js

@@ -1,14 +0,0 @@
-import { hasImageSnapshot } from "./has_image_snapshot.js";
-import { imageSnapshotNextIndex } from "./image_snapshot_next_index.js";
-import { loadImageSnapshotResults } from "./load_image_snapshot_results.js";
-import { prepareImageSnapshotComparison } from "./prepare_image_snapshot_comparison.js";
-import { preparePageImageSnapshotComparison } from "./prepare_page_image_snapshot_comparison.js";
-import { setupVisSuite } from "./setup_vis_suite.js";
-export const commands = {
-    setupVisSuite,
-    imageSnapshotNextIndex,
-    hasImageSnapshot,
-    preparePageImageSnapshotComparison,
-    prepareImageSnapshotComparison,
-    loadImageSnapshotResults,
-};

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

@@ -1,6 +0,0 @@
-import type { BrowserCommand } from 'vitest/node';
-export interface HasImageSnapshotCommand {
-    hasImageSnapshot(taskId: string, snapshotKey: string | undefined): Promise<boolean>;
-}
-export declare const hasImageSnapshot: BrowserCommand<Parameters<HasImageSnapshotCommand['hasImageSnapshot']>>;
-//# sourceMappingURL=has_image_snapshot.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"has_image_snapshot.d.ts","sourceRoot":"","sources":["../../../src/server/commands/has_image_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD,MAAM,WAAW,uBAAuB;IACvC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnF;AAED,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAQpG,CAAA"}

package/esm/server/commands/has_image_snapshot.js

@@ -1,6 +0,0 @@
-import { visServerContext } from "../vis_server_context.js";
-import { assertTestPathDefined } from "./_assertions.js";
-export const hasImageSnapshot = async (context, taskId, snapshotKey) => {
-    assertTestPathDefined(context, 'hasImageSnapshot');
-    return visServerContext.hasImageSnapshot(context, taskId, snapshotKey);
-};

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

@@ -1,9 +0,0 @@
-import type { BrowserCommand } from 'vitest/node';
-export interface ImageSnapshotNextIndexCommand {
-    /**
-     * Get the index of the snapshot image to be created.
-     */
-    imageSnapshotNextIndex(taskId: string): Promise<number>;
-}
-export declare const imageSnapshotNextIndex: BrowserCommand<Parameters<ImageSnapshotNextIndexCommand['imageSnapshotNextIndex']>>;
-//# sourceMappingURL=image_snapshot_next_index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"image_snapshot_next_index.d.ts","sourceRoot":"","sources":["../../../src/server/commands/image_snapshot_next_index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACvD;AAED,eAAO,MAAM,sBAAsB,EAAE,cAAc,CAClD,UAAU,CAAC,6BAA6B,CAAC,wBAAwB,CAAC,CAAC,CAKnE,CAAA"}

package/esm/server/commands/image_snapshot_next_index.js

@@ -1,6 +0,0 @@
-import { visServerContext } from "../vis_server_context.js";
-import { assertTestPathDefined } from "./_assertions.js";
-export const imageSnapshotNextIndex = async (context, taskId) => {
-    assertTestPathDefined(context, 'imageSnapshotNextIndex');
-    return visServerContext.getTaskCount(context, taskId);
-};

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

@@ -1,21 +0,0 @@
-import type { BrowserCommand } from 'vitest/node';
-export interface ImageSnapshotResult {
-    filename: string;
-    /**
-     * The base64 encoded image of the baseline snapshot.
-     */
-    baseline?: string | undefined;
-    /**
-     * The base64 encoded image of the result snapshot.
-     */
-    result?: string | undefined;
-    /**
-     * The base64 encoded image of the diff snapshot.
-     */
-    diff?: string | undefined;
-}
-export interface LoadImageSnapshotResultsCommand {
-    loadImageSnapshotResults(taskId: string): Promise<ImageSnapshotResult[]>;
-}
-export declare const loadImageSnapshotResults: BrowserCommand<[taskId: string]>;
-//# sourceMappingURL=load_image_snapshot_results.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"load_image_snapshot_results.d.ts","sourceRoot":"","sources":["../../../src/server/commands/load_image_snapshot_results.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD,MAAM,WAAW,mBAAmB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB;AAED,MAAM,WAAW,+BAA+B;IAC/C,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;CACxE;AAED,eAAO,MAAM,wBAAwB,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAOrE,CAAA"}

package/esm/server/commands/load_image_snapshot_results.js

@@ -1,6 +0,0 @@
-import { visServerContext } from "../vis_server_context.js";
-import { assertTestPathDefined } from "./_assertions.js";
-export const loadImageSnapshotResults = async (context, taskId) => {
-    assertTestPathDefined(context, 'loadImageSnapshotResults');
-    return visServerContext.getSnapshotResults(context, taskId);
-};

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

@@ -1,38 +0,0 @@
-import type { BrowserCommand } from 'vitest/node';
-import type { FailureThresholdOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions } from '../../shared/types.ts';
-import type { MatchImageSnapshotOptions } from './types.ts';
-export type ImageSnapshotComparisonInfo = {
-    /**
-     * Path to the project root.
-     */
-    projectRoot: string;
-    /**
-     * Path to the baseline image relative to the project root.
-     */
-    baselinePath: string;
-    /**
-     * Path to the result image relative to the project root.
-     */
-    resultPath: string;
-    /**
-     * Path to the diff image relative to the project root.
-     */
-    diffPath: string;
-    /**
-     * Base64 encoded baseline image.
-     */
-    baseline: string;
-    /**
-     * Base64 encoded result image.
-     */
-    result: string;
-    /**
-     * Base64 encoded diff image.
-     */
-    diff?: string | undefined;
-} & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
-export interface PrepareImageSnapshotComparisonCommand {
-    prepareImageSnapshotComparison: (taskId: string, subject: string, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
-}
-export declare const prepareImageSnapshotComparison: BrowserCommand<Parameters<PrepareImageSnapshotComparisonCommand['prepareImageSnapshotComparison']>>;
-//# sourceMappingURL=prepare_image_snapshot_comparison.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"prepare_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_image_snapshot_comparison.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,KAAK,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,uBAAuB,CAAA;AAO9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAE3D,MAAM,MAAM,2BAA2B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB,GAAG,2BAA2B,GAC9B,uBAAuB,GACvB,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAA;AAEjD,MAAM,WAAW,qCAAqC;IACrD,8BAA8B,EAAE,CAC/B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,8BAA8B,EAAE,cAAc,CAC1D,UAAU,CAAC,qCAAqC,CAAC,gCAAgC,CAAC,CAAC,CA2BnF,CAAA"}

package/esm/server/commands/prepare_image_snapshot_comparison.js

@@ -1,34 +0,0 @@
-import { resolve } from 'pathe';
-import { isBase64String } from "../../shared/base64.js";
-import { file } from "../externals/file.js";
-import { getProjectRoot } from "../project.js";
-import { takeSnapshot, takeSnapshotByBrowser } from "../snapshot.js";
-import { snapshotWriter } from "../snapshot_writer.js";
-import { visServerContext } from "../vis_server_context.js";
-import { assertTestPathDefined } from "./_assertions.js";
-export const prepareImageSnapshotComparison = async (context, taskId, subject, options) => {
-    assertTestPathDefined(context, 'prepareImageSnapshotComparison');
-    // vitest:browser passes in `null` when not defined
-    if (!options)
-        options = {};
-    options.timeout = options.timeout ?? 30000;
-    const projectRoot = getProjectRoot(context);
-    const info = await visServerContext.getSnapshotInfo(context, taskId, options);
-    const baselineBuffer = await file.tryReadFile(resolve(projectRoot, info.baselinePath));
-    if (!baselineBuffer) {
-        if (isBase64String(subject)) {
-            await snapshotWriter.writeBase64(resolve(projectRoot, info.baselinePath), subject);
-        }
-        else {
-            await takeSnapshotByBrowser(context, projectRoot, info.baselinePath, subject, options);
-        }
-        return;
-    }
-    const resultBuffer = await takeSnapshot(context, projectRoot, info.resultPath, subject, options);
-    return {
-        ...info,
-        projectRoot,
-        baseline: baselineBuffer.toString('base64'),
-        result: resultBuffer.toString('base64'),
-    };
-};

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

@@ -1,35 +0,0 @@
-import type { BrowserCommand } from 'vitest/node';
-import type { FailureThresholdOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions } from '../../shared/types.ts';
-import type { MatchImageSnapshotOptions } from './types.ts';
-type ImageSnapshotComparisonInfo = {
-    /**
-     * Path to the project root.
-     */
-    projectRoot: string;
-    /**
-     * Path to the baseline image relative to the project root.
-     */
-    baselinePath: string;
-    /**
-     * Path to the result image relative to the project root.
-     */
-    resultPath: string;
-    /**
-     * Path to the diff image relative to the project root.
-     */
-    diffPath: string;
-    /**
-     * Base64 encoded baseline image.
-     */
-    baseline: string;
-    /**
-     * Base64 encoded result image.
-     */
-    result: string;
-} & ImageSnapshotTimeoutOptions & FailureThresholdOptions & (SsimComparisonOptions | PixelComparisonOptions);
-export interface PreparePageImageSnapshotComparisonCommand {
-    preparePageImageSnapshotComparison: (taskId: string, options?: MatchImageSnapshotOptions | undefined) => Promise<ImageSnapshotComparisonInfo | undefined>;
-}
-export declare const preparePageImageSnapshotComparison: BrowserCommand<Parameters<PreparePageImageSnapshotComparisonCommand['preparePageImageSnapshotComparison']>>;
-export {};
-//# sourceMappingURL=prepare_page_image_snapshot_comparison.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"prepare_page_image_snapshot_comparison.d.ts","sourceRoot":"","sources":["../../../src/server/commands/prepare_page_image_snapshot_comparison.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EACX,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,uBAAuB,CAAA;AAM9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAE3D,KAAK,2BAA2B,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACd,GAAG,2BAA2B,GAC9B,uBAAuB,GACvB,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAA;AAEjD,MAAM,WAAW,yCAAyC;IACzD,kCAAkC,EAAE,CACnC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,yBAAyB,GAAG,SAAS,KAC3C,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,kCAAkC,EAAE,cAAc,CAC9D,UAAU,CAAC,yCAAyC,CAAC,oCAAoC,CAAC,CAAC,CAsB3F,CAAA"}

package/esm/server/commands/prepare_page_image_snapshot_comparison.js

@@ -1,27 +0,0 @@
-import { resolve } from 'pathe';
-import { file } from "../externals/file.js";
-import { getProjectRoot } from "../project.js";
-import { takePageSnapshot } from "../snapshot.js";
-import { visServerContext } from "../vis_server_context.js";
-import { assertTestPathDefined } from "./_assertions.js";
-export const preparePageImageSnapshotComparison = async (context, taskId, options) => {
-    assertTestPathDefined(context, 'preparePageImageSnapshotComparison');
-    // vitest:browser passes in `null` when not defined
-    if (!options)
-        options = {};
-    options.timeout = options.timeout ?? 30000;
-    const projectRoot = getProjectRoot(context);
-    const info = await visServerContext.getSnapshotInfo(context, taskId, options);
-    const baselineBuffer = await file.tryReadFile(resolve(projectRoot, info.baselinePath));
-    if (!baselineBuffer) {
-        await takePageSnapshot(context, projectRoot, info.baselinePath, options);
-        return;
-    }
-    const resultBuffer = await takePageSnapshot(context, projectRoot, info.resultPath, options);
-    return {
-        ...info,
-        projectRoot,
-        baseline: baselineBuffer.toString('base64'),
-        result: resultBuffer.toString('base64'),
-    };
-};

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

@@ -1,15 +0,0 @@
-import type { Pick } from 'type-plus';
-import type { BrowserCommand } from 'vitest/node';
-import type { VisOptions } from '../../config/types.ts';
-export 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'>>;
-}
-export declare const setupVisSuite: BrowserCommand<[]>;
-//# sourceMappingURL=setup_vis_suite.d.ts.map