@wdio/image-comparison-core 1.0.0

package/dist/helpers/options.interfaces.d.ts

@@ -0,0 +1,363 @@
+import type { TabbableOptions } from '../commands/tabbable.interfaces.js';
+export interface ClassOptions {
+    /**
+     * The padding added to the address bar on iOS and Android
+     * to properly cut out the viewport.
+     */
+    addressBarShadowPadding?: number;
+    /**
+     * Automatically scroll to an element before taking a screenshot.
+     */
+    autoElementScroll?: boolean;
+    /**
+     * Add iOS bezel corners and notch/dynamic island to the screenshot.
+     */
+    addIOSBezelCorners?: boolean;
+    /**
+     * Delete runtime folder (actual & diff) on initialization.
+     */
+    clearRuntimeFolder?: boolean;
+    /**
+     * Use user based fullpage screenshots, by default the desktop screenshots are taken with the BiDi protocol.
+     */
+    userBasedFullPageScreenshot?: boolean;
+    /**
+     * By default the screenshots are taken with the BiDi protocol if Bidi is available.
+     * If you want to use the legacy method, set this to true.
+     */
+    enableLegacyScreenshotMethod?: boolean;
+    /**
+     * Customize the naming of saved images using a format string.
+     */
+    formatImageName?: string;
+    /**
+     * Indicates if this is a hybrid app.
+     */
+    isHybridApp?: boolean;
+    /**
+     * Save the images per instance in a separate folder.
+     */
+    savePerInstance?: boolean;
+    /**
+     * The padding added to the toolbar on iOS and Android
+     * to properly cut out the viewport.
+     */
+    toolBarShadowPadding?: number;
+    /**
+     * Wait for fonts to be fully loaded before taking a screenshot.
+     */
+    waitForFontsLoaded?: boolean;
+    /**
+     * If no baseline image is found during comparison, automatically save the image to the baseline folder.
+     */
+    autoSaveBaseline?: boolean;
+    /**
+     * Directory where all actual and diff screenshots will be stored.
+     */
+    screenshotPath?: string | ((options: ClassOptions) => string);
+    /**
+     * Directory for storing baseline images used during comparison.
+     */
+    baselineFolder?: string | ((options: ClassOptions) => string);
+    /**
+     * Disable the blinking cursor in screenshots.
+     */
+    disableBlinkingCursor?: boolean;
+    /**
+     * Enable or disable all CSS animations and input carets.
+     */
+    disableCSSAnimation?: boolean;
+    /**
+     * Make all text transparent to focus only on layout.
+     */
+    enableLayoutTesting?: boolean;
+    /**
+     * Time (ms) to wait after a scroll; useful for lazy loading content.
+     */
+    fullPageScrollTimeout?: number;
+    /**
+     * Hide scrollbars in the screenshots.
+     */
+    hideScrollBars?: boolean;
+    /**
+     * @deprecated Use `compareOptions` instead.
+     * Automatically block out the side bar for iPads in landscape mode during comparisons.
+     * Prevents failures on the tab/private/bookmark native component.
+     */
+    blockOutSideBar?: boolean;
+    /**
+     * Automatically block out the status and address bar during comparisons (mobile only).
+     * Prevents failures due to dynamic UI elements like time, Wi-Fi, battery, etc.
+     */
+    blockOutStatusBar?: boolean;
+    /**
+     * Automatically block out the tool bar during comparisons (mobile only).
+     */
+    blockOutToolBar?: boolean;
+    /**
+     * Generate JSON report files with comparison data (useful for custom HTML reports).
+     */
+    createJsonReportFiles?: boolean;
+    /**
+     * Pixel proximity used to group diff pixels in JSON reports.
+     *
+     * @default 5
+     */
+    diffPixelBoundingBoxProximity?: number;
+    /**
+     * Ignore alpha channel when comparing images.
+     */
+    ignoreAlpha?: boolean;
+    /**
+     * Ignore anti-aliasing when comparing images.
+     */
+    ignoreAntialiasing?: boolean;
+    /**
+     * Compare two images in black and white only.
+     */
+    ignoreColors?: boolean;
+    /**
+     * Compare images with reduced sensitivity.
+     * red = 16, green = 16, blue = 16, alpha = 16, minBrightness = 16, maxBrightness = 240
+     */
+    ignoreLess?: boolean;
+    /**
+     * Compare images with full sensitivity.
+     * red = 0, green = 0, blue = 0, alpha = 0, minBrightness = 0, maxBrightness = 255
+     */
+    ignoreNothing?: boolean;
+    /**
+     * Return raw mismatch percentage (e.g., `0.12345678`) instead of rounded (e.g., `0.12`).
+     */
+    rawMisMatchPercentage?: boolean;
+    /**
+     * Return all compare data, not just mismatch percentage.
+     */
+    returnAllCompareData?: boolean;
+    /**
+     * Threshold mismatch percentage above which diff image will be saved.
+     */
+    saveAboveTolerance?: number;
+    /**
+     * Scale images to same dimensions before comparison.
+     */
+    scaleImagesToSameSize?: boolean;
+    /**
+     * Options object passed to the underlying image comparison engine.
+     */
+    compareOptions?: Partial<CompareOptions>;
+    /**
+     * Configuration for tabbable elements highlighting.
+     */
+    tabbableOptions?: TabbableOptions;
+    /**
+     * Storybook-specific visual testing options.
+     */
+    storybook?: {
+        /**
+         * If true, clips the story component to remove extra whitespace.
+         *
+         * @default true
+         */
+        clip?: boolean;
+        /**
+         * Selector to use when `clip = true`. Defaults to Storybook's root element.
+         */
+        clipSelector?: string;
+        /**
+         * Number of shards to divide tests across.
+         *
+         * @default 1
+         */
+        numShards?: number;
+        /**
+         * Stories to skip, by string or RegExp.
+         */
+        skipStories?: string | string[];
+        /**
+         * Storybook server URL.
+         *
+         * @default 'http://127.0.0.1:6006'
+         */
+        url?: string;
+        /**
+         * Version of Storybook in use.
+         *
+         * @default 7
+         */
+        version?: number;
+        /**
+         * Additional search parameters for the Storybook URL.
+         *
+         * @example new URLSearchParams({ 'foo': 'bar' })
+         * Results in URL like: `http://storybook.url/iframe.html?id=story-id&foo=bar`
+         */
+        additionalSearchParams?: URLSearchParams;
+        /**
+         * Path builder for saving story baselines.
+         *
+         * @param category The component category (e.g. "forms").
+         * @param component The component name (e.g. "input").
+         * @returns Path to store baselines under the `baselineFolder`.
+         *
+         * @example
+         * ```ts
+         * (category, component) => `${category}__${component}`
+         * ```
+         *
+         * @default
+         * ```ts
+         * (category, component) => `./${category}/${component}/`
+         * ```
+         */
+        getStoriesBaselinePath?: (category: string, component: string) => string;
+    };
+}
+export interface DefaultOptions {
+    /**
+     * Padding added to the address bar (iOS/Android) to properly cut out the viewport.
+     */
+    addressBarShadowPadding: number;
+    /**
+     * Automatically scroll to an element before capturing a screenshot.
+     */
+    autoElementScroll: boolean;
+    /**
+     * Adds iOS bezel corners and notch/dynamic island to the screenshot.
+     */
+    addIOSBezelCorners: boolean;
+    /**
+     * Automatically saves the image as a baseline if none is found during comparison.
+     */
+    autoSaveBaseline: boolean;
+    /**
+     * Delete the runtime folder (`actual` and `diff`) on initialization.
+     */
+    clearFolder: boolean;
+    /**
+     * Options used for image comparison.
+     */
+    compareOptions: CompareOptions;
+    /**
+     * Use user based fullpage screenshots, by default the desktop screenshots are taken with the BiDi protocol.
+     */
+    userBasedFullPageScreenshot: boolean;
+    /**
+     * By default the screenshots are taken with the BiDi protocol if Bidi is available.
+     * If you want to use the legacy method, set this to true.
+     */
+    enableLegacyScreenshotMethod: boolean;
+    /**
+     * Disable the blinking cursor in the screenshot.
+     */
+    disableBlinkingCursor: boolean;
+    /**
+     * Disable all CSS animations and input caret.
+     */
+    disableCSSAnimation: boolean;
+    /**
+     * Make all text transparent to focus only on layout during comparison.
+     */
+    enableLayoutTesting: boolean;
+    /**
+     * A format string for customizing image file names.
+     */
+    formatImageName: string;
+    /**
+     * Timeout in milliseconds to wait after scrolling, useful for lazy-loaded pages.
+     */
+    fullPageScrollTimeout: number;
+    /**
+     * Hide scrollbars in the screenshot.
+     */
+    hideScrollBars: boolean;
+    /**
+     * Indicates whether the app is a hybrid (native + webview).
+     */
+    isHybridApp: boolean;
+    /**
+     * Save screenshots per instance in separate folders.
+     */
+    savePerInstance: boolean;
+    /**
+     * Options for visualizing tabbable elements.
+     */
+    tabbableOptions: TabbableOptions;
+    /**
+     * Padding added to the toolbar (iOS/Android) to properly cut out the viewport.
+     */
+    toolBarShadowPadding: number;
+    /**
+     * Wait for fonts to be fully loaded before taking a screenshot.
+     */
+    waitForFontsLoaded: boolean;
+}
+export interface CompareOptions {
+    /**
+     * Automatically block out the side bar for iPads in landscape mode during comparisons.
+     * Prevents failures caused by the tab/private/bookmark native component.
+     */
+    blockOutSideBar: boolean;
+    /**
+     * Automatically block out the status and address bar during comparisons.
+     * This is mobile only and helps avoid failures caused by dynamic content like time, Wi-Fi, or battery status.
+     */
+    blockOutStatusBar: boolean;
+    /**
+     * Automatically block out the tool bar during comparisons.
+     * This is mobile only.
+     */
+    blockOutToolBar: boolean;
+    /**
+     * Create JSON report files with all comparison data.
+     * This can be used to generate custom (HTML) reports.
+     */
+    createJsonReportFiles: boolean;
+    /**
+     * Proximity of diff pixels used to group them in the JSON report.
+     *
+     * The higher the value, the more pixels will be grouped together. Lower values improve accuracy.
+     *
+     * @default 5
+     */
+    diffPixelBoundingBoxProximity: number;
+    /**
+     * Compare images and discard the alpha channel.
+     */
+    ignoreAlpha: boolean;
+    /**
+     * Compare images and ignore anti-aliasing effects.
+     */
+    ignoreAntialiasing: boolean;
+    /**
+     * Compare two black-and-white versions of the images, ignoring colors.
+     */
+    ignoreColors: boolean;
+    /**
+     * Use a less sensitive comparison setting:
+     * red = 16, green = 16, blue = 16, alpha = 16, minBrightness = 16, maxBrightness = 240
+     */
+    ignoreLess: boolean;
+    /**
+     * Use the most sensitive comparison setting:
+     * red = 0, green = 0, blue = 0, alpha = 0, minBrightness = 0, maxBrightness = 255
+     */
+    ignoreNothing: boolean;
+    /**
+     * Return the raw mismatch percentage as a decimal (e.g., `0.12345678`), instead of a rounded value (e.g., `0.12`).
+     */
+    rawMisMatchPercentage: boolean;
+    /**
+     * Return all comparison data, not just the mismatch percentage.
+     */
+    returnAllCompareData: boolean;
+    /**
+     * Mismatch percentage threshold above which the image with differences will be saved.
+     */
+    saveAboveTolerance: number;
+    /**
+     * Scale images to the same size before comparing them.
+     */
+    scaleImagesToSameSize: boolean;
+}
+//# sourceMappingURL=options.interfaces.d.ts.map

package/dist/helpers/options.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.interfaces.d.ts","sourceRoot":"","sources":["../../src/helpers/options.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAEzE,MAAM,WAAW,YAAY;IAKzB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAM7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,MAAM,CAAC,CAAC;IAE9D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,MAAM,CAAC,CAAC;IAM9D;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAMzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAMzC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE;QACR;;;;WAIG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAEhC;;;;WAIG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;;;WAKG;QACH,sBAAsB,CAAC,EAAE,eAAe,CAAC;QAEzC;;;;;;;;;;;;;;;;WAgBG;QACH,sBAAsB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;KAC5E,CAAA;CACJ;AAED,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,2BAA2B,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,4BAA4B,EAAE,OAAO,CAAC;IAEtC;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;;;;;OAMG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAClC"}

package/dist/helpers/options.interfaces.js

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

package/dist/helpers/options.js

@@ -0,0 +1,184 @@
+import { DEFAULT_COMPARE_OPTIONS, DEFAULT_FORMAT_STRING, DEFAULT_SHADOW, DEFAULT_TABBABLE_OPTIONS, FULL_PAGE_SCROLL_TIMEOUT, STORYBOOK_FORMAT_STRING, } from './constants.js';
+import { logAllDeprecatedCompareOptions, isStorybook, getBooleanOption, createConditionalProperty, getMethodOrWicOption, } from './utils.js';
+/**
+ * Determine the default options by merging user options with sensible defaults
+ */
+export function defaultOptions(options) {
+    const isStorybookMode = isStorybook();
+    return {
+        /**
+         * Module-specific options
+         */
+        addressBarShadowPadding: options.addressBarShadowPadding ?? DEFAULT_SHADOW.ADDRESS_BAR,
+        autoElementScroll: getBooleanOption(options, 'autoElementScroll', true),
+        addIOSBezelCorners: options.addIOSBezelCorners ?? false,
+        autoSaveBaseline: options.autoSaveBaseline ?? true,
+        clearFolder: options.clearRuntimeFolder ?? false,
+        userBasedFullPageScreenshot: options.userBasedFullPageScreenshot ?? false,
+        enableLegacyScreenshotMethod: options.enableLegacyScreenshotMethod ?? false,
+        formatImageName: options.formatImageName ?? (isStorybookMode ? STORYBOOK_FORMAT_STRING : DEFAULT_FORMAT_STRING),
+        isHybridApp: options.isHybridApp ?? false,
+        // Running in storybook mode with multiple browsers can generate many images
+        // Defaulting this to true provides better overview for users
+        savePerInstance: options.savePerInstance ?? isStorybookMode,
+        toolBarShadowPadding: options.toolBarShadowPadding ?? DEFAULT_SHADOW.TOOL_BAR,
+        /**
+         * Module and method options
+         */
+        disableBlinkingCursor: options.disableBlinkingCursor ?? false,
+        disableCSSAnimation: options.disableCSSAnimation ?? false,
+        enableLayoutTesting: options.enableLayoutTesting ?? false,
+        fullPageScrollTimeout: options.fullPageScrollTimeout ?? FULL_PAGE_SCROLL_TIMEOUT,
+        // Default to false for storybook mode as element screenshots use W3C protocol without scrollbars
+        // This also saves an extra webdriver call
+        hideScrollBars: getBooleanOption(options, 'hideScrollBars', !isStorybookMode),
+        waitForFontsLoaded: options.waitForFontsLoaded ?? true,
+        /**
+         * Compare options (merged sequentially):
+         * 1. Default options (fallback)
+         * 2. Root compareOptions (deprecated but supported)
+         * 3. User-provided compareOptions
+         */
+        compareOptions: {
+            ...DEFAULT_COMPARE_OPTIONS,
+            ...logAllDeprecatedCompareOptions(options),
+            ...options.compareOptions,
+        },
+        /**
+         * Tabbable options with deep merging
+         */
+        tabbableOptions: {
+            circle: {
+                ...DEFAULT_TABBABLE_OPTIONS.circle,
+                ...options.tabbableOptions?.circle,
+            },
+            line: {
+                ...DEFAULT_TABBABLE_OPTIONS.line,
+                ...options.tabbableOptions?.line,
+            },
+        },
+    };
+}
+/**
+ * Determine the screen method compare options with proper type safety
+ */
+export function screenMethodCompareOptions(options) {
+    return {
+        ...createConditionalProperty('blockOutSideBar' in options, 'blockOutSideBar', options.blockOutSideBar),
+        ...createConditionalProperty('blockOutStatusBar' in options, 'blockOutStatusBar', options.blockOutStatusBar),
+        ...createConditionalProperty('blockOutToolBar' in options, 'blockOutToolBar', options.blockOutToolBar),
+        ...methodCompareOptions(options),
+    };
+}
+/**
+ * Determine the method compare options with improved type safety
+ */
+export function methodCompareOptions(options) {
+    const compareOptionKeys = [
+        'blockOut',
+        'ignoreAlpha',
+        'ignoreAntialiasing',
+        'ignoreColors',
+        'ignoreLess',
+        'ignoreNothing',
+        'rawMisMatchPercentage',
+        'returnAllCompareData',
+        'saveAboveTolerance',
+        'scaleImagesToSameSize',
+    ];
+    return compareOptionKeys.reduce((result, key) => {
+        if (key in options && options[key] !== undefined) {
+            result[key] = options[key]; // Type assertion needed due to union types
+        }
+        return result;
+    }, {});
+}
+/**
+ * Creates BeforeScreenshotOptions by extracting common options from method and wic configurations
+ */
+export function createBeforeScreenshotOptions(instanceData, methodOptions, wicOptions) {
+    return {
+        instanceData,
+        addressBarShadowPadding: wicOptions.addressBarShadowPadding,
+        disableBlinkingCursor: getMethodOrWicOption(methodOptions, wicOptions, 'disableBlinkingCursor') || false,
+        disableCSSAnimation: getMethodOrWicOption(methodOptions, wicOptions, 'disableCSSAnimation') || false,
+        enableLayoutTesting: getMethodOrWicOption(methodOptions, wicOptions, 'enableLayoutTesting') || false,
+        hideElements: methodOptions.hideElements || [],
+        noScrollBars: getMethodOrWicOption(methodOptions, wicOptions, 'hideScrollBars') || false,
+        removeElements: methodOptions.removeElements || [],
+        toolBarShadowPadding: wicOptions.toolBarShadowPadding,
+        waitForFontsLoaded: getMethodOrWicOption(methodOptions, wicOptions, 'waitForFontsLoaded') || false,
+    };
+}
+/**
+ * Builds AfterScreenshotOptions consistently across all commands
+ * Handles differences between native and web commands automatically
+ */
+export function buildAfterScreenshotOptions({ base64Image, folders, tag, isNativeContext, instanceData, enrichedInstanceData, beforeOptions, wicOptions }) {
+    // Use enriched data when available (web commands), fallback to instance data (native commands)
+    const dataSource = enrichedInstanceData || instanceData;
+    // Extract common properties with smart fallbacks
+    const { browserName, browserVersion, deviceName, platformName, platformVersion, } = dataSource;
+    // Handle dimension data - enriched data has nested structure, instance data is flat
+    const dimensions = enrichedInstanceData?.dimensions?.window;
+    const devicePixelRatio = dimensions?.devicePixelRatio ?? instanceData.devicePixelRatio;
+    const isLandscape = dimensions?.isLandscape ?? false;
+    const outerHeight = dimensions?.outerHeight;
+    const outerWidth = dimensions?.outerWidth;
+    const screenHeight = dimensions?.screenHeight ?? instanceData.deviceRectangles?.screenSize?.height;
+    const screenWidth = dimensions?.screenWidth ?? instanceData.deviceRectangles?.screenSize?.width;
+    // Handle metadata with smart defaults
+    const isMobile = enrichedInstanceData?.isMobile ?? instanceData.isMobile;
+    const isTestInBrowser = enrichedInstanceData?.isTestInBrowser ?? !isNativeContext;
+    const logName = enrichedInstanceData?.logName ?? instanceData.logName;
+    const name = enrichedInstanceData?.name ?? instanceData.name;
+    const { formatImageName, savePerInstance } = wicOptions;
+    const afterOptions = {
+        actualFolder: folders.actualFolder,
+        base64Image,
+        filePath: {
+            browserName,
+            deviceName,
+            isMobile,
+            savePerInstance,
+        },
+        fileName: {
+            browserName,
+            browserVersion,
+            deviceName,
+            devicePixelRatio: devicePixelRatio || NaN,
+            formatImageName,
+            isMobile,
+            isTestInBrowser,
+            logName,
+            name,
+            outerHeight: outerHeight || NaN,
+            outerWidth: outerWidth || NaN,
+            platformName,
+            platformVersion,
+            screenHeight: screenHeight || NaN,
+            screenWidth: screenWidth || NaN,
+            tag,
+        },
+        isLandscape,
+        isNativeContext,
+        platformName: instanceData.platformName,
+    };
+    // Add browser state options only for web commands (when beforeOptions is provided)
+    if (beforeOptions) {
+        afterOptions.disableBlinkingCursor = beforeOptions.disableBlinkingCursor;
+        afterOptions.disableCSSAnimation = beforeOptions.disableCSSAnimation;
+        afterOptions.enableLayoutTesting = beforeOptions.enableLayoutTesting;
+        afterOptions.hideElements = beforeOptions.hideElements;
+        afterOptions.hideScrollBars = beforeOptions.noScrollBars;
+        afterOptions.removeElements = beforeOptions.removeElements;
+    }
+    return afterOptions;
+}
+/**
+ * Prepare ignore options for resemble.js comparison
+ */
+export function prepareIgnoreOptions(imageCompareOptions) {
+    const resembleIgnoreDefaults = ['alpha', 'antialiasing', 'colors', 'less', 'nothing'];
+    return resembleIgnoreDefaults.filter((option) => Object.keys(imageCompareOptions).find((key) => key.toLowerCase().includes(option) && imageCompareOptions[key]));
+}

package/dist/helpers/options.test.d.ts

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

package/dist/helpers/options.test.d.ts.map

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