@vitest/browser-playwright 4.0.0-beta.14

package/README.md

@@ -0,0 +1,48 @@
+# @vitest/browser-playwright
+
+[![NPM version](https://img.shields.io/npm/v/@vitest/browser-playwright?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/browser-playwright)
+
+Run your Vitest [browser tests](https://vitest.dev/guide/browser/) using [playwright](https://playwright.dev/docs/api/class-playwright) API. Note that Vitest does not use playwright as a test runner, but only as a browser provider.
+
+We recommend using this package if you are already using playwright in your project or if you do not have any E2E tests yet.
+
+## Installation
+
+Install the package with your favorite package manager:
+
+```sh
+npm install -D @vitest/browser-playwright
+# or
+yarn add -D @vitest/browser-playwright
+# or
+pnpm add -D @vitest/browser-playwright
+```
+
+Then specify it in the `browser.provider` field of your Vitest configuration:
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+import { playwright } from '@vitest/browser-playwright'
+
+export default defineConfig({
+  test: {
+    browser: {
+      provider: playwright({
+        // ...custom playwright options
+      }),
+      instances: [
+        { name: 'chromium' },
+      ],
+    },
+  },
+})
+```
+
+Then run Vitest in the browser mode:
+
+```sh
+npx vitest --browser
+```
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/browser-playwright) | [Documentation](https://vitest.dev/guide/browser/playwright)

package/context.d.ts

@@ -0,0 +1 @@
+export * from '@vitest/browser/context'

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import { Page, Frame, FrameLocator, BrowserContext, LaunchOptions, ConnectOptions, BrowserContextOptions, Browser } from 'playwright';
+import { Protocol } from 'playwright-core/types/protocol';
+import { ScreenshotMatcherOptions, ScreenshotComparatorRegistry, Locator } from 'vitest/browser';
+import { BrowserProviderOption, BrowserProvider, BrowserModuleMocker, TestProject, CDPSession } from 'vitest/node';
+export { defineBrowserCommand } from '@vitest/browser';
+
+declare const playwrightBrowsers: readonly ["firefox", "webkit", "chromium"];
+type PlaywrightBrowser = (typeof playwrightBrowsers)[number];
+interface PlaywrightProviderOptions {
+	/**
+	* The options passed down to [`playwright.connect`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch) method.
+	* @see {@link https://playwright.dev/docs/api/class-browsertype#browser-type-launch}
+	*/
+	launchOptions?: Omit<LaunchOptions, "tracesDir">;
+	/**
+	* The options passed down to [`playwright.connect`](https://playwright.dev/docs/api/class-browsertype#browser-type-connect) method.
+	*
+	* This is used only if you connect remotely to the playwright instance via a WebSocket connection.
+	* @see {@link https://playwright.dev/docs/api/class-browsertype#browser-type-connect}
+	*/
+	connectOptions?: ConnectOptions & {
+		wsEndpoint: string;
+	};
+	/**
+	* The options passed down to [`browser.newContext`](https://playwright.dev/docs/api/class-browser#browser-new-context) method.
+	* @see {@link https://playwright.dev/docs/api/class-browser#browser-new-context}
+	*/
+	contextOptions?: Omit<BrowserContextOptions, "ignoreHTTPSErrors" | "serviceWorkers">;
+	/**
+	* The maximum time in milliseconds to wait for `userEvent` action to complete.
+	* @default 0 (no timeout)
+	*/
+	actionTimeout?: number;
+}
+declare function playwright(options?: PlaywrightProviderOptions): BrowserProviderOption<PlaywrightProviderOptions>;
+declare class PlaywrightBrowserProvider implements BrowserProvider {
+	private project;
+	private options;
+	name: "playwright";
+	supportsParallelism: boolean;
+	browser: Browser | null;
+	contexts: Map<string, BrowserContext>;
+	pages: Map<string, Page>;
+	mocker: BrowserModuleMocker;
+	browserName: PlaywrightBrowser;
+	private browserPromise;
+	private closing;
+	tracingContexts: Set<string>;
+	pendingTraces: Map<string, string>;
+	initScripts: string[];
+	constructor(project: TestProject, options: PlaywrightProviderOptions);
+	private openBrowser;
+	private createMocker;
+	private createContext;
+	getPage(sessionId: string): Page;
+	getCommandsContext(sessionId: string): {
+		page: Page;
+		context: BrowserContext;
+		frame: () => Promise<Frame>;
+		readonly iframe: FrameLocator;
+	};
+	private openBrowserPage;
+	openPage(sessionId: string, url: string): Promise<void>;
+	private _throwIfClosing;
+	getCDPSession(sessionid: string): Promise<CDPSession>;
+	close(): Promise<void>;
+}
+declare module "vitest/node" {
+	interface BrowserCommandContext {
+		page: Page;
+		frame(): Promise<Frame>;
+		iframe: FrameLocator;
+		context: BrowserContext;
+	}
+	interface _BrowserNames {
+		playwright: PlaywrightBrowser;
+	}
+	interface ToMatchScreenshotOptions extends Omit<ScreenshotMatcherOptions, "comparatorName" | "comparatorOptions"> {}
+	interface ToMatchScreenshotComparators extends ScreenshotComparatorRegistry {}
+}
+type PWHoverOptions = NonNullable<Parameters<Page["hover"]>[1]>;
+type PWClickOptions = NonNullable<Parameters<Page["click"]>[1]>;
+type PWDoubleClickOptions = NonNullable<Parameters<Page["dblclick"]>[1]>;
+type PWFillOptions = NonNullable<Parameters<Page["fill"]>[2]>;
+type PWScreenshotOptions = NonNullable<Parameters<Page["screenshot"]>[0]>;
+type PWSelectOptions = NonNullable<Parameters<Page["selectOption"]>[2]>;
+type PWDragAndDropOptions = NonNullable<Parameters<Page["dragAndDrop"]>[2]>;
+type PWSetInputFiles = NonNullable<Parameters<Page["setInputFiles"]>[2]>;
+declare module "vitest/browser" {
+	interface UserEventHoverOptions extends PWHoverOptions {}
+	interface UserEventClickOptions extends PWClickOptions {}
+	interface UserEventDoubleClickOptions extends PWDoubleClickOptions {}
+	interface UserEventTripleClickOptions extends PWClickOptions {}
+	interface UserEventFillOptions extends PWFillOptions {}
+	interface UserEventSelectOptions extends PWSelectOptions {}
+	interface UserEventDragAndDropOptions extends PWDragAndDropOptions {}
+	interface UserEventUploadOptions extends PWSetInputFiles {}
+	interface ScreenshotOptions extends Omit<PWScreenshotOptions, "mask"> {
+		mask?: ReadonlyArray<Element | Locator> | undefined;
+	}
+	interface CDPSession {
+		send<T extends keyof Protocol.CommandParameters>(method: T, params?: Protocol.CommandParameters[T]): Promise<Protocol.CommandReturnValues[T]>;
+		on<T extends keyof Protocol.Events>(event: T, listener: (payload: Protocol.Events[T]) => void): this;
+		once<T extends keyof Protocol.Events>(event: T, listener: (payload: Protocol.Events[T]) => void): this;
+		off<T extends keyof Protocol.Events>(event: T, listener: (payload: Protocol.Events[T]) => void): this;
+	}
+}
+
+export { PlaywrightBrowserProvider, playwright };
+export type { PlaywrightProviderOptions };