storybook-addon-vis-v9-fix-test/dist/index.d.ts

Storybook Vitest visual testing addon

import './matcher.js';
export * from 'vitest-plugin-vis';
import { ImageSnapshotKeyOptions, ComparisonMethod, ToMatchImageSnapshotOptions, ImageSnapshotSubjectOptions, ImageSnapshotTimeoutOptions, SsimComparisonOptions, PixelComparisonOptions, FailureThresholdOptions } from 'vitest-plugin-vis/client-api';
export { ComparisonMethod, FailureThresholdOptions, ImageSnapshotCompareOptions, ImageSnapshotKeyOptions, ImageSnapshotSubjectOptions, ImageSnapshotTimeoutOptions, PixelComparisonOptions, SsimComparisonOptions, ToMatchImageSnapshotOptions } from 'vitest-plugin-vis/client-api';

/**
 * Check if the snapshot image exists.
 */
declare function hasImageSnapshot(options?: ImageSnapshotKeyOptions | undefined): false | Promise<boolean>;

/**
 * Define snapshot parameter for auto snapshot.
 */
declare function defineAutoSnapshotParam<M extends ComparisonMethod>(snapshot: ToMatchImageSnapshotOptions<M> & ImageSnapshotSubjectOptions): {
    snapshot: ImageSnapshotTimeoutOptions & ImageSnapshotKeyOptions & (M extends "ssim" ? SsimComparisonOptions<M> : PixelComparisonOptions<M>) & FailureThresholdOptions & {
        expectToFail?: boolean | undefined;
    } & ImageSnapshotSubjectOptions;
};

declare function isSnapshotEnabled(tags: string[]): boolean;

/**
 * Configuration options for visual testing suites in Storybook.
 *
 * @param options.visProjects Array of visual testing project configurations
 * @param options.visProjects[].snapshotRootDir Root directory for storing snapshots. Can be a string path or a function that returns a path based on CI and platform context
 * @param options.visProjects[].snapshotSubpath Optional function to customize the snapshot subdirectory path
 */
type StorybookVisOptions = {
    visProjects: Array<{
        snapshotRootDir: string | ((context: {
            ci: boolean;
            platform: string;
        }) => string) | undefined;
        snapshotSubpath?: ((options: {
            subpath: string;
        }) => string) | undefined;
    }>;
};
/**
 * Define options for Storybook Visual Testing addon.
 */
declare function defineStorybookVisOptions(options: StorybookVisOptions): StorybookVisOptions;

export { type StorybookVisOptions, defineAutoSnapshotParam, defineStorybookVisOptions, hasImageSnapshot, isSnapshotEnabled };