@vitest/browser 1.6.0 → 2.0.0-beta.10

package/context.d.ts

@@ -0,0 +1,127 @@
+import type { ResolvedConfig } from 'vitest'
+
+export type BufferEncoding =
+  | 'ascii'
+  | 'utf8'
+  | 'utf-8'
+  | 'utf16le'
+  | 'utf-16le'
+  | 'ucs2'
+  | 'ucs-2'
+  | 'base64'
+  | 'base64url'
+  | 'latin1'
+  | 'binary'
+  | 'hex'
+
+export interface FsOptions {
+  encoding?: BufferEncoding
+  flag?: string | number
+}
+
+export interface TypePayload { type: string }
+export interface PressPayload { press: string }
+export interface DownPayload { down: string }
+export interface UpPayload { up: string }
+
+export type SendKeysPayload = TypePayload | PressPayload | DownPayload | UpPayload
+
+export interface ScreenshotOptions {
+  element?: Element
+  /**
+   * Path relative to the `screenshotDirectory` in the test config.
+   */
+  path?: string
+}
+
+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>
+  sendKeys: (payload: SendKeysPayload) => Promise<void>
+}
+
+export interface UserEvent {
+  /**
+   * Click on an element. Uses provider's API under the hood and supports all its options.
+   * @see {@link https://playwright.dev/docs/api/class-locator#locator-click} Playwright API
+   * @see {@link https://webdriver.io/docs/api/element/click/} WebdriverIO API
+   * @see {@link https://testing-library.com/docs/user-event/convenience/#click} testing-library API
+   */
+  click: (element: Element, options?: UserEventClickOptions) => Promise<void>
+}
+
+export interface UserEventClickOptions {
+  [key: string]: any
+}
+
+type Platform =
+  | 'aix'
+  | 'android'
+  | 'darwin'
+  | 'freebsd'
+  | 'haiku'
+  | 'linux'
+  | 'openbsd'
+  | 'sunos'
+  | 'win32'
+  | 'cygwin'
+  | 'netbsd'
+
+export const server: {
+  /**
+   * Platform the Vitest server is running on.
+   * The same as calling `process.platform` on the server.
+   */
+  platform: Platform
+  /**
+   * Runtime version of the Vitest server.
+   * The same as calling `process.version` on the server.
+   */
+  version: string
+  /**
+   * Name of the browser provider.
+   */
+  provider: string
+  /**
+   * Name of the current browser.
+   */
+  browser: string
+  /**
+   * Available commands for the browser.
+   * @see {@link https://vitest.dev/guide/browser#commands}
+   */
+  commands: BrowserCommands
+}
+
+/**
+ * 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`.
+ * @experimental
+ */
+export const userEvent: UserEvent
+
+/**
+ * Available commands for the browser.
+ * A shortcut to `server.commands`.
+ * @see {@link https://vitest.dev/guide/browser#commands}
+ */
+export const commands: BrowserCommands
+
+export interface BrowserPage {
+  /**
+   * Serialized test config.
+   */
+  config: ResolvedConfig
+  /**
+   * Change the size of iframe's viewport.
+   */
+  viewport: (width: number, height: number) => Promise<void>
+  /**
+   * Make a screenshot of the test iframe or a specific element.
+   * @returns Path to the screenshot file.
+   */
+  screenshot: (options?: ScreenshotOptions) => Promise<string>
+}
+
+export const page: BrowserPage

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

@@ -0,0 +1,24 @@
+{
+  "_rpc-CImfI7bO.js": {
+    "file": "__vitest_browser__/rpc-CImfI7bO.js",
+    "name": "rpc"
+  },
+  "orchestrator.html": {
+    "file": "__vitest_browser__/orchestrator-BCpOi5ot.js",
+    "name": "orchestrator",
+    "src": "orchestrator.html",
+    "isEntry": true,
+    "imports": [
+      "_rpc-CImfI7bO.js"
+    ]
+  },
+  "tester.html": {
+    "file": "__vitest_browser__/tester-e70VCOgC.js",
+    "name": "tester",
+    "src": "tester.html",
+    "isEntry": true,
+    "imports": [
+      "_rpc-CImfI7bO.js"
+    ]
+  }
+}