quickpickle 1.10.0 → 1.11.0

package/dist/world.d.ts

@@ -2,9 +2,10 @@ import type { TestContext } from 'vitest';
 import type { QuickPickleConfig } from '.';
 import sanitize from './shims/path-sanitizer';
 import { type PixelmatchOptions } from 'pixelmatch';
-import type { AriaRole } from '@a11y-tools/aria-roles';
+import { type AriaRole } from '@a11y-tools/aria-roles';
 export type AriaRoleExtended = AriaRole | 'element' | 'input';
 import { Buffer } from 'buffer';
+export declare function isAriaRoleExtended(role: string): role is AriaRoleExtended;
 interface Common {
     info: {
         feature: string;
@@ -30,9 +31,7 @@ export interface QuickPickleWorldInterface {
     isComplete: boolean;
     config: QuickPickleConfig;
     worldConfig: QuickPickleConfig['worldConfig'];
-    data: {
-        [key: string]: any;
-    };
+    data: Record<string, any>;
     common: Common;
     init: () => Promise<void>;
     tagsMatch(tags: string[]): string[] | null;
@@ -48,7 +47,7 @@ export declare class QuickPickleWorld implements QuickPickleWorldInterface {
     info: QuickPickleWorldInterface['info'];
     common: QuickPickleWorldInterface['common'];
     context: TestContext;
-    data: {};
+    data: Record<string, any>;
     sanitizePath: typeof sanitize;
     constructor(context: TestContext, info: InfoConstructor);
     init(): Promise<void>;
@@ -101,8 +100,35 @@ export type VisualDiffResult = {
     pct: number;
 };
 export type ScreenshotComparisonOptions = any & Partial<PixelmatchOptions> & {
+    /**
+     * The maximum difference between the actual and expected images, as a percentage of the total number of pixels.
+     */
     maxDiffPercentage?: number;
+    /**
+     * The maximum difference between the actual and expected images, as the number of pixels.
+     */
     maxDiffPixels?: number;
+    /**
+     * Whether to compare the images even if they are of different sizes by resizing them as necessary.
+     * @default false
+     */
+    resizeEnabled?: boolean;
+    /**
+     * Whether to ignore the resized area when comparing images.
+     */
+    resizeIgnored?: boolean;
+    /**
+     * The color to use for resizing images, in [r,g,b] format, with values from 0 to 255.
+     * If this number is too similar to the color of the larger image, the resized area
+     * will be ignored by the pixelmatch algorithm.
+     * @default [255,0,128]
+     */
+    resizeColor?: [number, number, number];
+    /**
+     * The anchor point to use if the images are of different size.
+     * @default "top left"
+     */
+    resizeAnchor?: 'top left' | 'top right' | 'bottom left' | 'bottom right' | 'center' | 'top' | 'bottom' | 'left' | 'right';
 };
 export declare const defaultScreenshotComparisonOptions: ScreenshotComparisonOptions;
 export interface VisualConfigSetting {
@@ -163,7 +189,7 @@ export interface VisualWorldInterface extends StubVisualWorldInterface {
      * @param text string
      * A string that the element must contain.
      */
-    getLocator(locator: any, identifier: string, role: AriaRoleExtended, text?: string | null): any;
+    getLocator(locator: any, identifier: string, role: AriaRoleExtended | string, text?: string | null): any;
     /**
      * Sets a value on a form element based on its type (select, checkbox/radio, or other input).
      * The "Locator" interface used should be whatever is compatible with the testing library

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickpickle",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Plugin for Vitest to run tests written in Gherkin Syntax.",
   "keywords": [
     "BDD",
@@ -41,6 +41,8 @@
     "@cucumber/messages": "^27.2.0",
     "@cucumber/tag-expressions": "^6.1.2",
     "buffer": "^6.0.3",
+    "image-crop-or-pad": "^1.0.1",
+    "js-yaml": "^4.1.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
     "pngjs": "^7.0.0"
@@ -51,6 +53,7 @@
     "@rollup/plugin-replace": "^6.0.2",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.2",
+    "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.16",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.15.17",
@@ -65,7 +68,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dnotes/quickpickle.git"
+    "url": "https://github.com/dnotes/quickpickle"
   },
   "scripts": {
     "build": "rollup -c && FORMAT=cjs rollup -c",