@vitest/browser 4.0.0-beta.16 → 4.0.0-beta.18

package/context.d.ts

@@ -1,5 +1,5 @@
 import { SerializedConfig } from 'vitest'
-import { StringifyOptions } from 'vitest/internal/browser'
+import { StringifyOptions, BrowserCommands } from 'vitest/internal/browser'
 import { ARIARole } from './aria-role.js'
 import {} from './matchers.js'
 
@@ -17,11 +17,6 @@ export type BufferEncoding =
   | 'binary'
   | 'hex'
 
-export interface FsOptions {
-  encoding?: BufferEncoding
-  flag?: string | number
-}
-
 export interface CDPSession {
   // methods are defined by the provider type augmentation
 }
@@ -45,7 +40,7 @@ export interface ScreenshotOptions {
   save?: boolean
 }
 
-export interface ScreenshotComparatorRegistry {
+interface StandardScreenshotComparators {
   pixelmatch: {
     /**
      * The maximum number of pixels that are allowed to differ between the captured
@@ -141,6 +136,13 @@ export interface ScreenshotComparatorRegistry {
   }
 }
 
+export interface ScreenshotComparatorRegistry extends StandardScreenshotComparators {}
+
+export type NonStandardScreenshotComparators = Omit<
+  ScreenshotComparatorRegistry,
+  keyof StandardScreenshotComparators
+>
+
 export interface ScreenshotMatcherOptions<
   ComparatorName extends keyof ScreenshotComparatorRegistry = keyof ScreenshotComparatorRegistry
 > {
@@ -168,19 +170,6 @@ export interface ScreenshotMatcherOptions<
   timeout?: number
 }
 
-export interface BrowserCommands {
-  readFile: (
-    path: string,
-    options?: BufferEncoding | FsOptions
-  ) => Promise<string>
-  writeFile: (
-    path: string,
-    content: string,
-    options?: BufferEncoding | (FsOptions & { mode?: number | string })
-  ) => Promise<void>
-  removeFile: (path: string) => Promise<void>
-}
-
 export interface UserEvent {
   /**
    * Creates a new user event instance. This is useful if you need to keep the
@@ -421,7 +410,7 @@ export interface LocatorByRoleOptions extends LocatorOptions {
 
 interface LocatorScreenshotOptions extends Omit<ScreenshotOptions, 'element'> {}
 
-interface LocatorSelectors {
+export interface LocatorSelectors {
   /**
    * Creates a way to locate an element by its [ARIA role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles), [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and [accessible name](https://developer.mozilla.org/en-US/docs/Glossary/Accessible_name).
    * @see {@link https://vitest.dev/guide/browser/locators#getbyrole}

package/dist/index.d.ts

@@ -1,4 +1,40 @@
 import { ResolvedConfig, BrowserCommand, BrowserServerFactory, BrowserProviderOption } from 'vitest/node';
+import { ScreenshotMatcherOptions, NonStandardScreenshotComparators, ScreenshotComparatorRegistry } from '@vitest/browser/context';
+
+interface BaseMetadata {
+	height: number;
+	width: number;
+}
+type TypedArray = Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike>;
+type Promisable<T> = T | Promise<T>;
+type Comparator<Options extends Record<string, unknown>> = (reference: {
+	metadata: BaseMetadata;
+	data: TypedArray;
+}, actual: {
+	metadata: BaseMetadata;
+	data: TypedArray;
+}, options: {
+	/**
+	* Allows the comparator to create a diff image.
+	*
+	* Note that the comparator might choose to ignore the flag, so a diff image is not guaranteed.
+	*/
+	createDiff: boolean;
+} & Options) => Promisable<{
+	pass: boolean;
+	diff: TypedArray | null;
+	message: string | null;
+}>;
+type CustomComparatorsToRegister = { [Key in keyof NonStandardScreenshotComparators] : Comparator<NonStandardScreenshotComparators[Key]> };
+type CustomComparatorsRegistry = keyof CustomComparatorsToRegister extends never ? {
+	comparators?: Record<string, Comparator<Record<string, unknown>>>;
+} : {
+	comparators: CustomComparatorsToRegister;
+};
+declare module "vitest/node" {
+	interface ToMatchScreenshotOptions extends Omit<ScreenshotMatcherOptions, "comparatorName" | "comparatorOptions">, CustomComparatorsRegistry {}
+	interface ToMatchScreenshotComparators extends ScreenshotComparatorRegistry {}
+}
 
 declare enum DOM_KEY_LOCATION {
 	STANDARD = 0,
@@ -34,3 +70,4 @@ declare function defineBrowserProvider<T extends object = object>(options: Omit<
 }): BrowserProviderOption;
 
 export { createBrowserServer, defineBrowserCommand, defineBrowserProvider, parseKeyDef, resolveScreenshotPath };
+export type { CustomComparatorsRegistry };

package/dist/index.js

@@ -18,7 +18,7 @@ import { PNG } from 'pngjs';
 import pm from 'pixelmatch';
 import { WebSocketServer } from 'ws';
 
-var version = "4.0.0-beta.16";
+var version = "4.0.0-beta.18";
 
 const _DRIVE_LETTER_START_RE = /^[A-Za-z]:\//;
 function normalizeWindowsPath(input = "") {
@@ -2045,10 +2045,14 @@ const pixelmatch = (reference, actual, { createDiff,...options }) => {
 	};
 };
 
-const comparators = new Map(Object.entries({ pixelmatch }));
-function getComparator(comparator) {
-	if (comparators.has(comparator)) {
-		return comparators.get(comparator);
+const comparators = { pixelmatch };
+function getComparator(comparator, context) {
+	if (comparator in comparators) {
+		return comparators[comparator];
+	}
+	const customComparators = context.project.config.browser.expect?.toMatchScreenshot?.comparators;
+	if (customComparators && comparator in customComparators) {
+		return customComparators[comparator];
 	}
 	throw new Error(`Unrecognized comparator ${comparator}`);
 }
@@ -2103,7 +2107,7 @@ function resolveOptions({ context, name, options, testName }) {
 	};
 	return {
 		codec: getCodec(extension),
-		comparator: getComparator(resolvedOptions.comparatorName),
+		comparator: getComparator(resolvedOptions.comparatorName, context),
 		resolvedOptions,
 		paths: {
 			reference: resolvedOptions.resolveScreenshotPath(resolvePathData),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/browser",
   "type": "module",
-  "version": "4.0.0-beta.16",
+  "version": "4.0.0-beta.18",
   "description": "Browser running for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -36,8 +36,7 @@
       "default": "./dist/locators.js"
     },
     "./utils": {
-      "types": "./utils.d.ts",
-      "default": "./dist/utils.js"
+      "default": "./dummy.js"
     },
     "./package.json": "./package.json"
   },
@@ -52,7 +51,7 @@
     "providers"
   ],
   "peerDependencies": {
-    "vitest": "4.0.0-beta.16"
+    "vitest": "4.0.0-beta.18"
   },
   "dependencies": {
     "magic-string": "^0.30.19",
@@ -61,8 +60,8 @@
     "sirv": "^3.0.2",
     "tinyrainbow": "^3.0.3",
     "ws": "^8.18.3",
-    "@vitest/utils": "4.0.0-beta.16",
-    "@vitest/mocker": "4.0.0-beta.16"
+    "@vitest/mocker": "4.0.0-beta.18",
+    "@vitest/utils": "4.0.0-beta.18"
   },
   "devDependencies": {
     "@testing-library/user-event": "^14.6.1",
@@ -73,8 +72,8 @@
     "ivya": "^1.7.0",
     "mime": "^4.1.0",
     "pathe": "^2.0.3",
-    "vitest": "4.0.0-beta.16",
-    "@vitest/runner": "4.0.0-beta.16"
+    "@vitest/runner": "4.0.0-beta.18",
+    "vitest": "4.0.0-beta.18"
   },
   "scripts": {
     "typecheck": "tsc -p ./src/client/tsconfig.json --noEmit",