@web/test-runner-commands 0.0.0-canary-20230403143511

package/README.md

@@ -0,0 +1,7 @@
+# Test Runner Commands
+
+Commands for executing code server-side during your tests in the browser. To control the browser page, access the file system, or execute NodeJS libraries.
+
+Built-in commands can change the viewport, emulate media queries or set the user agent. You can create custom commands to implement your own functionalities.
+
+See [our website](https://modern-web.dev/docs/test-runner/commands/) for full documentation.

package/browser/commands.d.ts

@@ -0,0 +1,297 @@
+import {
+  Media,
+  Viewport,
+  SendKeysPayload,
+  A11ySnapshotPayload,
+  WriteFilePayload,
+  ReadFilePayload,
+  RemoveFilePayload,
+  SnapshotPluginConfig,
+  SaveSnapshotPayload,
+  SendMousePayload,
+} from '../dist/index';
+
+/**
+ * Executes a command on the server. If this is a custom command, you need to implement a plugin
+ * to execute this command.
+ */
+export function executeServerCommand<R, P>(command: string, payload?: P): Promise<R>;
+
+/**
+ * Sets the viewport of the browser.
+ */
+export function setViewport(viewport: Viewport): Promise<void>;
+
+/**
+ * Emulates browser media, such as screen/print or color scheme, to be used in
+ * CSS media queries.
+ *
+ * The `forcedColors` property is Playwright-only API that does not work in WebKit.
+ *
+ * @example
+ * ```ts
+ *    await emulateMedia({
+ *        colorScheme: 'dark',
+ *        reducedMotion: 'reduce',
+ *    });
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await emulateMedia({
+ *        media: 'print',
+ *    });
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await emulateMedia({
+ *        forcedColors: 'active',
+ *    });
+ * ```
+ */
+export function emulateMedia(media: Media): Promise<void>;
+
+/**
+ * Sets the user agent of the browser. This is a puppeteer-only API.
+ */
+export function setUserAgent(userAgent: string): Promise<void>;
+
+/**
+ * Sends a string of keys for the browser to press (all at once, as with single keys
+ * or shortcuts; e.g. `{press: 'Tab'}` or `{press: 'Shift+a'}` or
+ * `{press: 'Option+ArrowUp}`) or type (in sequence, e.g. `{type: 'Your name'}`) natively.
+ *
+ * For specific documentation of the strings to leverage here, see the Playwright documentation,
+ * here:
+ *
+ * - `press`: https://playwright.dev/docs/api/class-keyboard#keyboardpresskey-options
+ * - `type`: https://playwright.dev/docs/api/class-keyboard#keyboardtypetext-options
+ *
+ * Or, the Puppeter documentation, here:
+ *
+ * - `press`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardpresskey-options
+ * - `type`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardtypetext-options
+ *
+ * Or, the Webdriver documentation, here:
+ *
+ * https://webdriver.io/docs/api/browser/keys/
+ *
+ * @param payload An object including a `press` or `type` property an the associated string
+ *     for the browser runner to apply via that input method.
+ *
+ * @example
+ * ```ts
+ *    await sendKeys({
+ *        press: 'Tab',
+ *    });
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await sendKeys({
+ *        type: 'Your address',
+ *    });
+ * ```
+ *
+ **/
+export function sendKeys(payload: SendKeysPayload): Promise<void>;
+
+/**
+ * Sends an action for the mouse to move it to a specific position or click a mouse button (left, middle, or right).
+ *
+ * WARNING: When moving the mouse or holding down a mouse button, the mouse stays in this state as long as
+ * you do not explicitly move it to another position or release the button. For this reason, it is recommended
+ * to reset the mouse state with the `resetMouse` command after each test case manipulating the mouse to avoid
+ * unexpected side effects.
+ *
+ * @param payload An object representing a mouse action specified by the `type` property (move, click, down, up)
+ *     and including some properties to configure this action.
+ *
+ * @example
+ * ```ts
+ *    await sendMouse({
+ *        type: 'move',
+ *        position: [100, 100]
+ *    });
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await sendMouse({
+ *        type: 'click',
+ *        position: [100, 100],
+ *        button: 'right'
+ *    });
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await sendMouse({
+ *        type: 'down'
+ *    });
+ * ```
+ *
+ **/
+export function sendMouse(payload: SendMousePayload): Promise<void>;
+
+/**
+ * Resets the mouse position to (0, 0) and releases mouse buttons.
+ *
+ * Use this command to reset the mouse state after mouse manipulations by the `sendMouse` command.
+ *
+ * @example
+ * ```
+ * it('does something with the mouse', () => {
+ *   await sendMouse({ type: 'move', position: [150, 150] });
+ *   await sendMouse({ type: 'down', button: 'middle' });
+ * });
+ *
+ * afterEach(() => {
+ *   await resetMouse();
+ * });
+ * ```
+ */
+export function resetMouse(): Promise<void>;
+
+/**
+ * Request a snapshot of the Accessibility Tree of the entire page or starting from
+ * the element that is obtained via the `selector` property of the `payload` argument.
+ *
+ * Learn more about the tree that is returned from Playwright here:
+ * - https://playwright.dev/docs/api/class-accessibility/
+ *
+ * Learn more about the tree that is returned from Puppeteer here:
+ * - https://pptr.dev/#?product=Puppeteer&show=api-class-accessibility
+ *
+ * @param payload An object including a `selector` property pointing to the root of the
+ *     a11y tree you'd like returned.
+ *
+ * @example
+ * ```ts
+ *    await a11ySnapshot();
+ * ```
+ *
+ * @example
+ * ```ts
+ *    await a11ySnapshot({
+ *        selector: 'main'
+ *    });
+ * ```
+ */
+export function a11ySnapshot(payload: A11ySnapshotPayload): Promise<void>;
+
+/**
+ * Walk the provided accessibility tree that starts on `node` and test each
+ * node in the tree until one is found that meast the `test` provided.
+ *
+ * Learn more about the tree that is returned from Playwright here:
+ * - https://playwright.dev/docs/api/class-accessibility/
+ *
+ * Learn more about the tree that is returned from Puppeteer here:
+ * - https://pptr.dev/#?product=Puppeteer&show=api-class-accessibility
+ *
+ * @param node
+ * @param test
+ *
+ * @example
+ * // return whether a node in the `snapshot` has `name: 'Label Text Value Text'`
+ * ```ts
+ *    findAccessibilityNode<{ name: string }>(
+ *        snapshot,
+ *        (node) => node.name === 'Label Text Value Text'
+ *    )
+ * ```
+ */
+export function findAccessibilityNode<TNode>(
+  node: TNode & { children: TNode[] },
+  test: (node: TNode) => boolean,
+): TNode | null;
+
+/**
+ * Writes a file to disk.
+ *
+ * @param payload.filePath the path of the file to save. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ * @param payload.content the file content to save as a string.
+ * @param payload.encoding optional encoding to use when saving the file.
+ *
+ * @example
+ * ```ts
+ *    await writeFile({ path: 'hello-world.txt', content: 'Hello world!' });
+ * ```
+ */
+export function writeFile(payload: WriteFilePayload): Promise<void>;
+
+/**
+ * Reads a file from disk.
+ *
+ * @param payload.filePath the path of the file to read. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ * @param payload.encoding optional encoding to use when reading the file.
+ *
+ * @example
+ * ```ts
+ *    const content = await readFile({ path: 'hello-world.txt' });
+ * ```
+ */
+export function readFile(payload: ReadFilePayload): Promise<string | undefined>;
+
+/**
+ * Removes a file from disk.
+ *
+ * @param payload.filePath the path of the file to remove. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ *
+ * @example
+ * ```ts
+ *    await removeFile({ path: 'hello-world.txt' });
+ * ```
+ */
+export function removeFile(payload: RemoveFilePayload): Promise<void>;
+
+/**
+ * Gets configuration for snapshot testing.
+ *
+ * @param payload.updateSnapshots whether to updated snapshots that are not the same
+ */
+export function getSnapshotConfig(): Promise<SnapshotPluginConfig>;
+
+/**
+ * Gets the snapshots stored for this test file.
+ */
+export function getSnapshots(): Promise<Record<string, string>>;
+
+/**
+ * Saves a snapshot for this test file.
+ *
+ * @param payload.name the name of the snapshot
+ */
+export function getSnapshot(options: { name: string }): Promise<string | undefined>;
+
+/**
+ * Saves a snapshot for this test file.
+ *
+ * @param payload.name the name of the snapshot
+ * @param payload.content the content of the snapshot as a string
+ */
+export function saveSnapshot(options: SaveSnapshotPayload): Promise<void>;
+
+/**
+ * Removes stored snapshots for this test file.
+ *
+ * @param payload.name the name of the snapshot
+ *
+ */
+export function removeSnapshot(options: { name: string }): Promise<void>;
+
+/**
+ * If no snapshot exists on disk or if update-snapshots is set to true server-side,
+ * the passed snapshot is saved. Otherwise the snapshot is compared with what's stored
+ * on disk. If the snapshots are not equal, an error is thrown.
+ *
+ * @param options
+ */
+export function compareSnapshot(options: { name: string; content: string }): Promise<void>;
+
+export { Media, Viewport, SendKeysPayload, WriteFilePayload, ReadFilePayload, RemoveFilePayload };

package/browser/commands.mjs

@@ -0,0 +1,223 @@
+/* eslint-env browser, es2020 */
+const PARAM_SESSION_ID = 'wtr-session-id';
+
+const sessionId = new URL(window.location.href).searchParams.get(PARAM_SESSION_ID);
+
+function isObject(payload) {
+  return payload != null && typeof payload === 'object';
+}
+
+export async function executeServerCommand(command, payload, pluginName) {
+  if (typeof sessionId !== 'string') {
+    throw new Error(
+      'Unable to execute server commands in a browser not controlled by the test runner. ' +
+        'Use the debug option from the watch menu to debug in a controlled browser.',
+    );
+  }
+
+  let sendMessageWaitForResponse;
+  try {
+    const webSocketModule = await import('/__web-dev-server__web-socket.js');
+    ({ sendMessageWaitForResponse } = webSocketModule);
+  } catch (error) {
+    throw new Error(
+      'Could not setup web socket connection. Are you executing this test through Web Test Runner?',
+    );
+  }
+
+  try {
+    const response = await sendMessageWaitForResponse({
+      type: 'wtr-command',
+      sessionId,
+      command,
+      payload,
+    });
+
+    if (!response.executed) {
+      let msg;
+      if (pluginName) {
+        msg = `Unknown command ${command}. Add the ${pluginName} to your config.`;
+      } else {
+        msg = `Unknown command ${command}. Did you install a plugin to handle this command?`;
+      }
+      throw new Error(msg);
+    }
+
+    return response.result;
+  } catch (error) {
+    throw new Error(
+      `Error while executing command ${command}${
+        payload ? ` with payload ${JSON.stringify(payload)}` : ''
+      }: ${error.message}`,
+    );
+  }
+}
+
+export function setViewport(viewport) {
+  return executeServerCommand('set-viewport', viewport);
+}
+
+export function emulateMedia(media) {
+  return executeServerCommand('emulate-media', media);
+}
+
+export function setUserAgent(options) {
+  return executeServerCommand('set-user-agent', options);
+}
+
+export function sendKeys(options) {
+  return executeServerCommand('send-keys', options);
+}
+
+export function selectOption(options) {
+  return executeServerCommand('select-option', options);
+}
+
+export function sendMouse(options) {
+  return executeServerCommand('send-mouse', options);
+}
+
+export function resetMouse(options) {
+  return executeServerCommand('reset-mouse', options);
+}
+
+export function a11ySnapshot(options) {
+  return executeServerCommand('a11y-snapshot', options);
+}
+
+export function writeFile(options) {
+  return executeServerCommand('write-file', options, 'filePlugin from @web/test-runner-commands');
+}
+
+export function readFile(options) {
+  return executeServerCommand('read-file', options, 'filePlugin from @web/test-runner-commands');
+}
+
+export function removeFile(options) {
+  return executeServerCommand('remove-file', options, 'filePlugin from @web/test-runner-commands');
+}
+
+export function findAccessibilityNode(node, test) {
+  if (test(node)) return node;
+  for (const child of node.children || []) {
+    const foundNode = findAccessibilityNode(child, test);
+    if (foundNode) {
+      return foundNode;
+    }
+  }
+  return null;
+}
+
+let snapshotConfig;
+let cachedSnapshots;
+
+export async function getSnapshotConfig() {
+  if (!snapshotConfig) {
+    snapshotConfig = await executeServerCommand(
+      'get-snapshot-config',
+      undefined,
+      'snapshotPlugin from @web/test-runner-commands',
+    );
+  }
+
+  return snapshotConfig;
+}
+
+/**
+ * This regexp is used to capture the snapshots contents.
+ *
+ * snapshots\[[^\]]+] = (\n)? - snapshot definition. Sometimes the initial content backtick is placed in the next line
+ * (?<content>`[^`]+`) - capture the snapshot content, which is included between backticks "`"
+ * /gm - global and multiline
+ * @type {RegExp}
+ */
+const ESCAPE_REGEX = /snapshots\[[^\]]+] = (\n)?(?<content>`[^`]*`)/gm;
+
+const escapeContent = content => {
+  [...content.matchAll(ESCAPE_REGEX)].forEach(({ groups: { content: itemContent } }) => {
+    content = content.replaceAll(itemContent, encodeURIComponent(itemContent));
+  });
+
+  return content;
+};
+
+export async function getSnapshots({ cache = true } = {}) {
+  if (cache && cachedSnapshots) {
+    return cachedSnapshots;
+  }
+
+  const result = await executeServerCommand(
+    'get-snapshots',
+    undefined,
+    'snapshotPlugin from @web/test-runner-commands',
+  );
+
+  if (typeof result?.content !== 'string') {
+    throw new Error('Expected a result as string');
+  }
+
+  const content = `${escapeContent(result.content)}/* ${Math.random()} */`;
+  const module = await import(`data:text/javascript;charset=utf-8,${content}`);
+
+  if (!module || !isObject(module.snapshots)) {
+    throw new Error('Expected snapshot result to be a module that exports an object.');
+  }
+
+  cachedSnapshots = module.snapshots;
+
+  return cachedSnapshots;
+}
+
+export async function getSnapshot(options) {
+  if (!isObject(options)) throw new Error('You must provide a payload object');
+  if (typeof options.name !== 'string') throw new Error('You must provide a snapshot name');
+
+  const snapshots = await getSnapshots(options);
+
+  return snapshots[options.name];
+}
+
+export async function saveSnapshot(options) {
+  if (!isObject(options)) throw new Error('You must provide a payload object');
+  if (typeof options.name !== 'string') throw new Error('You must provide a snapshot name');
+  if (options.content !== undefined && typeof options.content !== 'string')
+    throw new Error('You must provide a snapshot content');
+
+  // ensure snapshots for this file are loaded
+  const snapshots = await getSnapshots();
+
+  // store snapshot in-memory
+  snapshots[options.name] = options.content;
+
+  return executeServerCommand(
+    'save-snapshot',
+    options,
+    'snapshotPlugin from @web/test-runner-commands',
+  );
+}
+
+export function removeSnapshot(options) {
+  if (!isObject(options)) throw new Error('You must provide a payload object');
+  if (typeof options.name !== 'string') throw new Error('You must provide a snapshot name');
+
+  return saveSnapshot({ ...options, content: undefined });
+}
+
+export async function compareSnapshot({ name, content }) {
+  const currentSnapshot = await getSnapshot({ name });
+  if (currentSnapshot) {
+    const config = await getSnapshotConfig();
+    if (!config.updateSnapshots) {
+      if (currentSnapshot !== content) {
+        throw new Error(
+          `Snapshots for ${name} are not equal. \n\n` +
+            `Stored:\n${currentSnapshot}\n\n` +
+            `New:\n${content}`,
+        );
+      }
+    } else if (currentSnapshot === content) {
+      return;
+    }
+  }
+  await saveSnapshot({ name, content });
+}

package/dist/a11ySnapshotPlugin.d.ts

@@ -0,0 +1,6 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+export declare type A11ySnapshotPayload = {
+    selector?: string;
+};
+export declare function a11ySnapshotPlugin(): TestRunnerPlugin<A11ySnapshotPayload>;
+//# sourceMappingURL=a11ySnapshotPlugin.d.ts.map

package/dist/a11ySnapshotPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"a11ySnapshotPlugin.d.ts","sourceRoot":"","sources":["../src/a11ySnapshotPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAIzD,oBAAY,mBAAmB,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,wBAAgB,kBAAkB,IAAI,gBAAgB,CAAC,mBAAmB,CAAC,CA8C1E"}

package/dist/a11ySnapshotPlugin.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.a11ySnapshotPlugin = void 0;
+function a11ySnapshotPlugin() {
+    return {
+        name: 'a11y-snapshot-command',
+        async executeCommand({ command, payload, session }) {
+            if (command === 'a11y-snapshot') {
+                // handle specific behavior for playwright
+                if (session.browser.type === 'playwright') {
+                    const page = session.browser.getPage(session.id);
+                    const options = {};
+                    if (payload && payload.selector) {
+                        const root = await page.$(payload.selector);
+                        if (root) {
+                            options.root = root;
+                        }
+                    }
+                    const snapshot = await page.accessibility.snapshot(options);
+                    return snapshot;
+                }
+                // handle specific behavior for puppeteer
+                if (session.browser.type === 'puppeteer') {
+                    const page = session.browser.getPage(session.id);
+                    const options = {};
+                    if (payload && payload.selector) {
+                        // @ts-ignore
+                        const root = await page.$(payload.selector);
+                        if (root) {
+                            options.root = root;
+                        }
+                    }
+                    // @ts-ignore
+                    const snapshot = await page.accessibility.snapshot(options);
+                    return snapshot;
+                }
+                // you might not be able to support all browser launchers
+                throw new Error(`Acessibility snapshot is not supported for browser type ${session.browser.type}.`);
+            }
+        },
+    };
+}
+exports.a11ySnapshotPlugin = a11ySnapshotPlugin;
+//# sourceMappingURL=a11ySnapshotPlugin.js.map

package/dist/a11ySnapshotPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"a11ySnapshotPlugin.js","sourceRoot":"","sources":["../src/a11ySnapshotPlugin.ts"],"names":[],"mappings":";;;AAMA,SAAgB,kBAAkB;IAChC,OAAO;QACL,IAAI,EAAE,uBAAuB;QAC7B,KAAK,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;YAChD,IAAI,OAAO,KAAK,eAAe,EAAE;gBAC/B,0CAA0C;gBAC1C,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE;oBACzC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA8B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACzE,MAAM,OAAO,GAET,EAAE,CAAC;oBACP,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE;wBAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;wBAC5C,IAAI,IAAI,EAAE;4BACR,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;yBACrB;qBACF;oBACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC5D,OAAO,QAAQ,CAAC;iBACjB;gBAED,yCAAyC;gBACzC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;oBACxC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA0B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACrE,MAAM,OAAO,GAET,EAAE,CAAC;oBACP,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE;wBAC/B,aAAa;wBACb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;wBAC5C,IAAI,IAAI,EAAE;4BACR,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;yBACrB;qBACF;oBACD,aAAa;oBACb,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC5D,OAAO,QAAQ,CAAC;iBACjB;gBAED,yDAAyD;gBACzD,MAAM,IAAI,KAAK,CACb,2DAA2D,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CACnF,CAAC;aACH;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AA9CD,gDA8CC"}

package/dist/emulateMediaPlugin.d.ts

@@ -0,0 +1,9 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+export interface Media {
+    media?: 'screen' | 'print';
+    colorScheme?: 'dark' | 'light' | 'no-preference';
+    reducedMotion?: 'reduce' | 'no-preference';
+    forcedColors?: 'active' | 'none';
+}
+export declare function emulateMediaPlugin(): TestRunnerPlugin;
+//# sourceMappingURL=emulateMediaPlugin.d.ts.map

package/dist/emulateMediaPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulateMediaPlugin.d.ts","sourceRoot":"","sources":["../src/emulateMediaPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAIzD,MAAM,WAAW,KAAK;IACpB,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;IACjD,aAAa,CAAC,EAAE,QAAQ,GAAG,eAAe,CAAC;IAC3C,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAuBD,wBAAgB,kBAAkB,IAAI,gBAAgB,CA0CrD"}

package/dist/emulateMediaPlugin.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emulateMediaPlugin = void 0;
+function isObject(payload) {
+    return payload != null && typeof payload === 'object';
+}
+function isMediaObject(payload) {
+    if (!isObject(payload))
+        throw new Error('You must provide a viewport object');
+    if (payload.media != null && !(typeof payload.media === 'string')) {
+        throw new Error('media should be a string.');
+    }
+    if (payload.colorScheme != null && !(typeof payload.colorScheme === 'string')) {
+        throw new Error('colorScheme should be a string.');
+    }
+    if (payload.reducedMotion != null && !(typeof payload.reducedMotion === 'string')) {
+        throw new Error('reducedMotion should be a string.');
+    }
+    return true;
+}
+function emulateMediaPlugin() {
+    return {
+        name: 'emulate-media-command',
+        async executeCommand({ command, payload, session }) {
+            if (command === 'emulate-media') {
+                if (!isMediaObject(payload)) {
+                    throw new Error('You must provide a viewport object');
+                }
+                if (session.browser.type === 'puppeteer') {
+                    const page = session.browser.getPage(session.id);
+                    const features = [];
+                    if (payload.colorScheme != null) {
+                        features.push({ name: 'prefers-color-scheme', value: payload.colorScheme });
+                    }
+                    if (payload.reducedMotion != null) {
+                        features.push({ name: 'prefers-reduced-motion', value: payload.reducedMotion });
+                    }
+                    await page.emulateMediaFeatures(features);
+                    if (payload.media) {
+                        await page.emulateMediaType(payload.media);
+                    }
+                    return true;
+                }
+                if (session.browser.type === 'playwright') {
+                    const page = session.browser.getPage(session.id);
+                    await page.emulateMedia(payload);
+                    return true;
+                }
+                throw new Error(`Setting viewport is not supported for browser type ${session.browser.type}.`);
+            }
+        },
+    };
+}
+exports.emulateMediaPlugin = emulateMediaPlugin;
+//# sourceMappingURL=emulateMediaPlugin.js.map

package/dist/emulateMediaPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulateMediaPlugin.js","sourceRoot":"","sources":["../src/emulateMediaPlugin.ts"],"names":[],"mappings":";;;AAWA,SAAS,QAAQ,CAAC,OAAgB;IAChC,OAAO,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;AACxD,CAAC;AAED,SAAS,aAAa,CAAC,OAAgB;IACrC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAE9E,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,EAAE;QACjE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,IAAI,CAAC,CAAC,OAAO,OAAO,CAAC,WAAW,KAAK,QAAQ,CAAC,EAAE;QAC7E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;IAED,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,IAAI,CAAC,CAAC,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,CAAC,EAAE;QACjF,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,kBAAkB;IAChC,OAAO;QACL,IAAI,EAAE,uBAAuB;QAE7B,KAAK,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;YAChD,IAAI,OAAO,KAAK,eAAe,EAAE;gBAC/B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;oBAC3B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;iBACvD;gBAED,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;oBACxC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA0B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACrE,MAAM,QAAQ,GAAG,EAAE,CAAC;oBAEpB,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE;wBAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;qBAC7E;oBACD,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,EAAE;wBACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;qBACjF;oBAED,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBAE1C,IAAI,OAAO,CAAC,KAAK,EAAE;wBACjB,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBAED,OAAO,IAAI,CAAC;iBACb;gBAED,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE;oBACzC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA8B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACzE,MAAM,IAAI,CAAC,YAAY,CAAC,OAAc,CAAC,CAAC;oBACxC,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,IAAI,KAAK,CACb,sDAAsD,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAC9E,CAAC;aACH;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AA1CD,gDA0CC"}

package/dist/filePlugin.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { TestRunnerPlugin } from '@web/test-runner-core';
+export interface WriteFilePayload {
+    path: string;
+    content: string;
+    encoding?: BufferEncoding;
+}
+export interface ReadFilePayload {
+    path: string;
+    encoding?: BufferEncoding;
+}
+export interface RemoveFilePayload {
+    path: string;
+}
+export declare function filePlugin(): TestRunnerPlugin;
+//# sourceMappingURL=filePlugin.d.ts.map

package/dist/filePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filePlugin.d.ts","sourceRoot":"","sources":["../src/filePlugin.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAwBzD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;CACd;AA6BD,wBAAgB,UAAU,IAAI,gBAAgB,CAyC7C"}