@vitest/browser 4.0.0-beta.13 → 4.0.0-beta.14

package/context.d.ts

@@ -1,4 +1,5 @@
 import { SerializedConfig } from 'vitest'
+import { StringifyOptions } from 'vitest/internal/browser'
 import { ARIARole } from './aria-role.js'
 import {} from './matchers.js'
 
@@ -186,7 +187,7 @@ export interface UserEvent {
    * state of keyboard to press and release buttons correctly.
    *
    * **Note:** Unlike `@testing-library/user-event`, the default `userEvent` instance
-   * from `@vitest/browser/context` is created once, not every time its methods are called!
+   * from `vitest/browser` is created once, not every time its methods are called!
    * @see {@link https://vitest.dev/guide/browser/interactivity-api.html#userevent-setup}
    */
   setup: () => UserEvent
@@ -361,6 +362,10 @@ export interface LocatorOptions {
    * regular expression. Note that exact match still trims whitespace.
    */
   exact?: boolean
+  hasText?: string | RegExp
+  hasNotText?: string | RegExp
+  has?: Locator
+  hasNot?: Locator
 }
 
 export interface LocatorByRoleOptions extends LocatorOptions {
@@ -660,13 +665,6 @@ export const server: {
   config: SerializedConfig
 }
 
-export interface LocatorOptions {
-  hasText?: string | RegExp
-  hasNotText?: string | RegExp
-  has?: Locator
-  hasNot?: Locator
-}
-
 /**
  * Handler for user interactions. The support is provided by the browser provider (`playwright` or `webdriverio`).
  * If used with `preview` provider, fallbacks to simulated events via `@testing-library/user-event`.
@@ -732,11 +730,54 @@ export interface BrowserPage extends LocatorSelectors {
 
 export interface BrowserLocators {
   createElementLocators(element: Element): LocatorSelectors
+  // TODO: enhance docs
+  /**
+   * Extends `page.*` and `locator.*` interfaces.
+   * @see {@link}
+   *
+   * @example
+   * ```ts
+   * import { locators } from 'vitest/browser'
+   *
+   * declare module 'vitest/browser' {
+   *   interface LocatorSelectors {
+   *     getByCSS(css: string): Locator
+   *   }
+   * }
+   *
+   * locators.extend({
+   *   getByCSS(css: string) {
+   *     return `css=${css}`
+   *   }
+   * })
+   * ```
+   */
   extend(methods: {
-    [K in keyof LocatorSelectors]?: (this: BrowserPage | Locator, ...args: Parameters<LocatorSelectors[K]>) => ReturnType<LocatorSelectors[K]> | string
+    [K in keyof LocatorSelectors]?: (
+      this: BrowserPage | Locator,
+      ...args: Parameters<LocatorSelectors[K]>
+    ) => ReturnType<LocatorSelectors[K]> | string
   }): void
 }
 
+
+export type PrettyDOMOptions = Omit<StringifyOptions, 'maxLength'>
+
+export const utils: {
+  getElementLocatorSelectors(element: Element): LocatorSelectors
+  debug(
+    el?: Element | Locator | null | (Element | Locator)[],
+    maxLength?: number,
+    options?: PrettyDOMOptions,
+  ): void
+  prettyDOM(
+    dom?: Element | Locator | undefined | null,
+    maxLength?: number,
+    prettyFormatOptions?: PrettyDOMOptions,
+  ): string
+  getElementError(selector: string, container?: Element): Error
+}
+
 export const locators: BrowserLocators
 
 export const page: BrowserPage

package/context.js

@@ -1,4 +1,4 @@
-// Vitest resolves "@vitest/browser/context" as a virtual module instead
+// Vitest resolves "vitest/browser" as a virtual module instead
 
 // fake exports for static analysis
 export const page = null
@@ -7,12 +7,13 @@ export const userEvent = null
 export const cdp = null
 export const commands = null
 export const locators = null
+export const utils = null
 
 const pool = globalThis.__vitest_worker__?.ctx?.pool
 
 throw new Error(
   // eslint-disable-next-line prefer-template
-  '@vitest/browser/context can be imported only inside the Browser Mode. '
+  'vitest/browser can be imported only inside the Browser Mode. '
   + (pool
     ? `Your test is running in ${pool} pool. Make sure your regular tests are excluded from the "test.include" glob pattern.`
     : 'Instead, it was imported outside of Vitest.'),

package/dist/client/.vite/manifest.json

@@ -4,7 +4,7 @@
     "name": "utils"
   },
   "orchestrator.html": {
-    "file": "__vitest_browser__/orchestrator-Pdu7HCGX.js",
+    "file": "__vitest_browser__/orchestrator-Ce7D5fGP.js",
     "name": "orchestrator",
     "src": "orchestrator.html",
     "isEntry": true,
@@ -13,7 +13,7 @@
     ]
   },
   "tester/tester.html": {
-    "file": "__vitest_browser__/tester-DYNLfPFH.js",
+    "file": "__vitest_browser__/tester-Vm4ppAv-.js",
     "name": "tester",
     "src": "tester/tester.html",
     "isEntry": true,