@web/test-runner-commands 0.5.11 → 0.6.1

package/browser/commands.d.ts

@@ -8,6 +8,7 @@ import {
   RemoveFilePayload,
   SnapshotPluginConfig,
   SaveSnapshotPayload,
+  SendMousePayload,
 } from '../dist/index';
 
 /**
@@ -74,6 +75,63 @@ export function setUserAgent(userAgent: string): Promise<void>;
  **/
 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.
@@ -155,7 +213,7 @@ export function writeFile(payload: WriteFilePayload): Promise<void>;
  *    const content = await readFile({ path: 'hello-world.txt' });
  * ```
  */
-export function readFile(payload: WriteFilePayload): Promise<string | undefined>;
+export function readFile(payload: ReadFilePayload): Promise<string | undefined>;
 
 /**
  * Removes a file from disk.

package/browser/commands.mjs

@@ -69,6 +69,14 @@ export function sendKeys(options) {
   return executeServerCommand('send-keys', 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);
 }
@@ -123,7 +131,7 @@ const ESCAPE_REGEX = /snapshots\[[^\]]+] = (\n)?(?<content>`[^`]*`)/gm;
 
 const escapeContent = content => {
   [...content.matchAll(ESCAPE_REGEX)].forEach(({ groups: { content: itemContent } }) => {
-    content = content.replaceAll(itemContent, itemContent.replaceAll(/\n/g, '\\n'));
+    content = content.replaceAll(itemContent, encodeURIComponent(itemContent));
   });
 
   return content;

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
 export { setUserAgentPlugin } from './setUserAgentPlugin';
 export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';
+export { sendMousePlugin, SendMousePayload } from './sendMousePlugin';
 export { a11ySnapshotPlugin, A11ySnapshotPayload } from './a11ySnapshotPlugin';
 export { WriteFilePayload, ReadFilePayload, RemoveFilePayload, filePlugin } from './filePlugin';
 export { SaveSnapshotPayload, SnapshotPluginConfig, snapshotPlugin } from './snapshotPlugin';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAChG,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAChG,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snapshotPlugin = exports.filePlugin = exports.a11ySnapshotPlugin = exports.sendKeysPlugin = exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
+exports.snapshotPlugin = exports.filePlugin = exports.a11ySnapshotPlugin = exports.sendMousePlugin = exports.sendKeysPlugin = exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
 var setViewportPlugin_1 = require("./setViewportPlugin");
 Object.defineProperty(exports, "setViewportPlugin", { enumerable: true, get: function () { return setViewportPlugin_1.setViewportPlugin; } });
 var emulateMediaPlugin_1 = require("./emulateMediaPlugin");
@@ -9,6 +9,8 @@ var setUserAgentPlugin_1 = require("./setUserAgentPlugin");
 Object.defineProperty(exports, "setUserAgentPlugin", { enumerable: true, get: function () { return setUserAgentPlugin_1.setUserAgentPlugin; } });
 var sendKeysPlugin_1 = require("./sendKeysPlugin");
 Object.defineProperty(exports, "sendKeysPlugin", { enumerable: true, get: function () { return sendKeysPlugin_1.sendKeysPlugin; } });
+var sendMousePlugin_1 = require("./sendMousePlugin");
+Object.defineProperty(exports, "sendMousePlugin", { enumerable: true, get: function () { return sendMousePlugin_1.sendMousePlugin; } });
 var a11ySnapshotPlugin_1 = require("./a11ySnapshotPlugin");
 Object.defineProperty(exports, "a11ySnapshotPlugin", { enumerable: true, get: function () { return a11ySnapshotPlugin_1.a11ySnapshotPlugin; } });
 var filePlugin_1 = require("./filePlugin");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAAkE;AAA/C,sHAAA,iBAAiB,OAAA;AACpC,2DAAiE;AAAjD,wHAAA,kBAAkB,OAAA;AAClC,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,mDAAmE;AAA1D,gHAAA,cAAc,OAAA;AACvB,2DAA+E;AAAtE,wHAAA,kBAAkB,OAAA;AAC3B,2CAAgG;AAAjC,wGAAA,UAAU,OAAA;AACzE,mDAA6F;AAAzC,gHAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAAkE;AAA/C,sHAAA,iBAAiB,OAAA;AACpC,2DAAiE;AAAjD,wHAAA,kBAAkB,OAAA;AAClC,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,mDAAmE;AAA1D,gHAAA,cAAc,OAAA;AACvB,qDAAsE;AAA7D,kHAAA,eAAe,OAAA;AACxB,2DAA+E;AAAtE,wHAAA,kBAAkB,OAAA;AAC3B,2CAAgG;AAAjC,wGAAA,UAAU,OAAA;AACzE,mDAA6F;AAAzC,gHAAA,cAAc,OAAA"}

package/dist/sendMousePlugin.d.ts

@@ -0,0 +1,24 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+declare type MousePosition = [number, number];
+declare type MouseButton = 'left' | 'middle' | 'right';
+export declare type SendMousePayload = MovePayload | ClickPayload | DownPayload | UpPayload;
+export declare type MovePayload = {
+    type: 'move';
+    position: MousePosition;
+};
+export declare type ClickPayload = {
+    type: 'click';
+    position: MousePosition;
+    button?: MouseButton;
+};
+export declare type DownPayload = {
+    type: 'down';
+    button?: MouseButton;
+};
+export declare type UpPayload = {
+    type: 'up';
+    button?: MouseButton;
+};
+export declare function sendMousePlugin(): TestRunnerPlugin<SendMousePayload>;
+export {};
+//# sourceMappingURL=sendMousePlugin.d.ts.map

package/dist/sendMousePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendMousePlugin.d.ts","sourceRoot":"","sources":["../src/sendMousePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAKzD,aAAK,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,aAAK,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE/C,oBAAY,gBAAgB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,CAAC;AAEpF,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,aAAa,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AA+CF,wBAAgB,eAAe,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,CAkHpE"}

package/dist/sendMousePlugin.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendMousePlugin = void 0;
+function isObject(payload) {
+    return payload != null && typeof payload === 'object';
+}
+function isSendMousePayload(payload) {
+    const validTypes = ['move', 'click', 'down', 'up'];
+    const validButtons = ['left', 'middle', 'right'];
+    if (!isObject(payload)) {
+        throw new Error('You must provide a `SendMousePayload` object');
+    }
+    if (typeof payload.type !== 'string' || !validTypes.includes(payload.type)) {
+        throw new Error(`You must provide a type option with one of the following values: ${validTypes.join(', ')}.`);
+    }
+    if (['click', 'move'].includes(payload.type)) {
+        if (!Array.isArray(payload.position) ||
+            typeof payload.position[0] !== 'number' ||
+            typeof payload.position[1] !== 'number' ||
+            !Number.isInteger(payload.position[0]) ||
+            !Number.isInteger(payload.position[1])) {
+            throw new Error('You must provide a position option as a [x, y] tuple where x and y are integers.');
+        }
+    }
+    if (['click', 'up', 'down'].includes(payload.type)) {
+        if (typeof payload.button === 'string' && !validButtons.includes(payload.button)) {
+            throw new Error(`The button option must be one of the following values when provided: ${validButtons.join(', ')}.`);
+        }
+    }
+    return true;
+}
+function sendMousePlugin() {
+    return {
+        name: 'send-mouse-command',
+        async executeCommand({ command, payload, session }) {
+            if (command === 'send-mouse') {
+                if (!payload || !isSendMousePayload(payload)) {
+                    throw new Error('You must provide a `SendMousePayload` object');
+                }
+                // handle specific behavior for playwright
+                if (session.browser.type === 'playwright') {
+                    const page = session.browser.getPage(session.id);
+                    switch (payload.type) {
+                        case 'move':
+                            await page.mouse.move(payload.position[0], payload.position[1]);
+                            return true;
+                        case 'click':
+                            await page.mouse.click(payload.position[0], payload.position[1], {
+                                button: payload.button,
+                            });
+                            return true;
+                        case 'down':
+                            await page.mouse.down({ button: payload.button });
+                            return true;
+                        case 'up':
+                            await page.mouse.up({ button: payload.button });
+                            return true;
+                    }
+                }
+                // handle specific behavior for puppeteer
+                if (session.browser.type === 'puppeteer') {
+                    const page = session.browser.getPage(session.id);
+                    switch (payload.type) {
+                        case 'move':
+                            await page.mouse.move(payload.position[0], payload.position[1]);
+                            return true;
+                        case 'click':
+                            await page.mouse.click(payload.position[0], payload.position[1], {
+                                button: payload.button,
+                            });
+                            return true;
+                        case 'down':
+                            await page.mouse.down({ button: payload.button });
+                            return true;
+                        case 'up':
+                            await page.mouse.up({ button: payload.button });
+                            return true;
+                    }
+                }
+                // handle specific behavior for webdriver
+                if (session.browser.type === 'webdriver') {
+                    const page = session.browser;
+                    switch (payload.type) {
+                        case 'move':
+                            await page.sendMouseMove(session.id, payload.position[0], payload.position[1]);
+                            return true;
+                        case 'click':
+                            await page.sendMouseClick(session.id, payload.position[0], payload.position[1], payload.button);
+                            return true;
+                        case 'down':
+                            await page.sendMouseDown(session.id, payload.button);
+                            return true;
+                        case 'up':
+                            await page.sendMouseUp(session.id, payload.button);
+                            return true;
+                    }
+                }
+                // you might not be able to support all browser launchers
+                throw new Error(`Sending mouse is not supported for browser type ${session.browser.type}.`);
+            }
+            if (command === 'reset-mouse') {
+                // handle specific behavior for playwright
+                if (session.browser.type === 'playwright') {
+                    const page = session.browser.getPage(session.id);
+                    await page.mouse.up({ button: 'left' });
+                    await page.mouse.up({ button: 'middle' });
+                    await page.mouse.up({ button: 'right' });
+                    await page.mouse.move(0, 0);
+                    return true;
+                }
+                // handle specific behavior for puppeteer
+                if (session.browser.type === 'puppeteer') {
+                    const page = session.browser.getPage(session.id);
+                    await page.mouse.up({ button: 'left' });
+                    await page.mouse.up({ button: 'middle' });
+                    await page.mouse.up({ button: 'right' });
+                    await page.mouse.move(0, 0);
+                    return true;
+                }
+                // handle specific behavior for webdriver
+                if (session.browser.type === 'webdriver') {
+                    const page = session.browser;
+                    await page.resetMouse(session.id);
+                    return true;
+                }
+                // you might not be able to support all browser launchers
+                throw new Error(`Resetting mouse is not supported for browser type ${session.browser.type}.`);
+            }
+        },
+    };
+}
+exports.sendMousePlugin = sendMousePlugin;
+//# sourceMappingURL=sendMousePlugin.js.map

package/dist/sendMousePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendMousePlugin.js","sourceRoot":"","sources":["../src/sendMousePlugin.ts"],"names":[],"mappings":";;;AA+BA,SAAS,QAAQ,CAAC,OAAgB;IAChC,OAAO,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;AACxD,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAgB;IAC1C,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEjD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACjE;IAED,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC1E,MAAM,IAAI,KAAK,CACb,oEAAoE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC7F,CAAC;KACH;IAED,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC5C,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAChC,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ;YACvC,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ;YACvC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EACtC;YACA,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;SACH;KACF;IAED,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAClD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAChF,MAAM,IAAI,KAAK,CACb,wEAAwE,YAAY,CAAC,IAAI,CACvF,IAAI,CACL,GAAG,CACL,CAAC;SACH;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,eAAe;IAC7B,OAAO;QACL,IAAI,EAAE,oBAAoB;QAC1B,KAAK,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;YAChD,IAAI,OAAO,KAAK,YAAY,EAAE;gBAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE;oBAC5C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;iBACjE;gBAED,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,QAAQ,OAAO,CAAC,IAAI,EAAE;wBACpB,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;4BAChE,OAAO,IAAI,CAAC;wBACd,KAAK,OAAO;4BACV,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gCAC/D,MAAM,EAAE,OAAO,CAAC,MAAM;6BACvB,CAAC,CAAC;4BACH,OAAO,IAAI,CAAC;wBACd,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;4BAClD,OAAO,IAAI,CAAC;wBACd,KAAK,IAAI;4BACP,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;4BAChD,OAAO,IAAI,CAAC;qBACf;iBACF;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,QAAQ,OAAO,CAAC,IAAI,EAAE;wBACpB,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;4BAChE,OAAO,IAAI,CAAC;wBACd,KAAK,OAAO;4BACV,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gCAC/D,MAAM,EAAE,OAAO,CAAC,MAAM;6BACvB,CAAC,CAAC;4BACH,OAAO,IAAI,CAAC;wBACd,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;4BAClD,OAAO,IAAI,CAAC;wBACd,KAAK,IAAI;4BACP,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;4BAChD,OAAO,IAAI,CAAC;qBACf;iBACF;gBAED,yCAAyC;gBACzC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;oBACxC,MAAM,IAAI,GAAG,OAAO,CAAC,OAA4B,CAAC;oBAClD,QAAQ,OAAO,CAAC,IAAI,EAAE;wBACpB,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC/E,OAAO,IAAI,CAAC;wBACd,KAAK,OAAO;4BACV,MAAM,IAAI,CAAC,cAAc,CACvB,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,MAAM,CACf,CAAC;4BACF,OAAO,IAAI,CAAC;wBACd,KAAK,MAAM;4BACT,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;4BACrD,OAAO,IAAI,CAAC;wBACd,KAAK,IAAI;4BACP,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;4BACnD,OAAO,IAAI,CAAC;qBACf;iBACF;gBAED,yDAAyD;gBACzD,MAAM,IAAI,KAAK,CAAC,mDAAmD,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;aAC7F;YAED,IAAI,OAAO,KAAK,aAAa,EAAE;gBAC7B,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,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;oBACxC,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;oBAC1C,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;oBACzC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC5B,OAAO,IAAI,CAAC;iBACb;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,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;oBACxC,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;oBAC1C,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;oBACzC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC5B,OAAO,IAAI,CAAC;iBACb;gBAED,yCAAyC;gBACzC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;oBACxC,MAAM,IAAI,GAAG,OAAO,CAAC,OAA4B,CAAC;oBAClD,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBAClC,OAAO,IAAI,CAAC;iBACb;gBAED,yDAAyD;gBACzD,MAAM,IAAI,KAAK,CACb,qDAAqD,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAC7E,CAAC;aACH;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAlHD,0CAkHC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web/test-runner-commands",
-  "version": "0.5.11",
+  "version": "0.6.1",
   "publishConfig": {
     "access": "public"
   },
@@ -51,7 +51,7 @@
   "devDependencies": {
     "@web/test-runner-chrome": "^0.10.2",
     "@web/test-runner-playwright": "^0.8.8",
-    "@web/test-runner-webdriver": "^0.4.2",
+    "@web/test-runner-webdriver": "^0.5.0",
     "mocha": "^8.2.1"
   }
 }

package/plugins.mjs

@@ -6,6 +6,7 @@ const {
   emulateMediaPlugin,
   setUserAgentPlugin,
   sendKeysPlugin,
+  sendMousePlugin,
   a11ySnapshotPlugin,
   filePlugin,
   snapshotPlugin,
@@ -16,6 +17,7 @@ export {
   emulateMediaPlugin,
   setUserAgentPlugin,
   sendKeysPlugin,
+  sendMousePlugin,
   a11ySnapshotPlugin,
   filePlugin,
   snapshotPlugin,

package/src/index.ts

@@ -2,6 +2,7 @@ export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
 export { setUserAgentPlugin } from './setUserAgentPlugin';
 export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';
+export { sendMousePlugin, SendMousePayload } from './sendMousePlugin';
 export { a11ySnapshotPlugin, A11ySnapshotPayload } from './a11ySnapshotPlugin';
 export { WriteFilePayload, ReadFilePayload, RemoveFilePayload, filePlugin } from './filePlugin';
 export { SaveSnapshotPayload, SnapshotPluginConfig, snapshotPlugin } from './snapshotPlugin';

package/src/sendMousePlugin.ts

@@ -0,0 +1,191 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+import type { ChromeLauncher } from '@web/test-runner-chrome';
+import type { PlaywrightLauncher } from '@web/test-runner-playwright';
+import type { WebdriverLauncher } from '@web/test-runner-webdriver';
+
+type MousePosition = [number, number];
+type MouseButton = 'left' | 'middle' | 'right';
+
+export type SendMousePayload = MovePayload | ClickPayload | DownPayload | UpPayload;
+
+export type MovePayload = {
+  type: 'move';
+  position: MousePosition;
+};
+
+export type ClickPayload = {
+  type: 'click';
+  position: MousePosition;
+  button?: MouseButton;
+};
+
+export type DownPayload = {
+  type: 'down';
+  button?: MouseButton;
+};
+
+export type UpPayload = {
+  type: 'up';
+  button?: MouseButton;
+};
+
+function isObject(payload: unknown): payload is Record<string, unknown> {
+  return payload != null && typeof payload === 'object';
+}
+
+function isSendMousePayload(payload: unknown): payload is SendMousePayload {
+  const validTypes = ['move', 'click', 'down', 'up'];
+  const validButtons = ['left', 'middle', 'right'];
+
+  if (!isObject(payload)) {
+    throw new Error('You must provide a `SendMousePayload` object');
+  }
+
+  if (typeof payload.type !== 'string' || !validTypes.includes(payload.type)) {
+    throw new Error(
+      `You must provide a type option with one of the following values: ${validTypes.join(', ')}.`,
+    );
+  }
+
+  if (['click', 'move'].includes(payload.type)) {
+    if (
+      !Array.isArray(payload.position) ||
+      typeof payload.position[0] !== 'number' ||
+      typeof payload.position[1] !== 'number' ||
+      !Number.isInteger(payload.position[0]) ||
+      !Number.isInteger(payload.position[1])
+    ) {
+      throw new Error(
+        'You must provide a position option as a [x, y] tuple where x and y are integers.',
+      );
+    }
+  }
+
+  if (['click', 'up', 'down'].includes(payload.type)) {
+    if (typeof payload.button === 'string' && !validButtons.includes(payload.button)) {
+      throw new Error(
+        `The button option must be one of the following values when provided: ${validButtons.join(
+          ', ',
+        )}.`,
+      );
+    }
+  }
+
+  return true;
+}
+
+export function sendMousePlugin(): TestRunnerPlugin<SendMousePayload> {
+  return {
+    name: 'send-mouse-command',
+    async executeCommand({ command, payload, session }): Promise<any> {
+      if (command === 'send-mouse') {
+        if (!payload || !isSendMousePayload(payload)) {
+          throw new Error('You must provide a `SendMousePayload` object');
+        }
+
+        // handle specific behavior for playwright
+        if (session.browser.type === 'playwright') {
+          const page = (session.browser as PlaywrightLauncher).getPage(session.id);
+          switch (payload.type) {
+            case 'move':
+              await page.mouse.move(payload.position[0], payload.position[1]);
+              return true;
+            case 'click':
+              await page.mouse.click(payload.position[0], payload.position[1], {
+                button: payload.button,
+              });
+              return true;
+            case 'down':
+              await page.mouse.down({ button: payload.button });
+              return true;
+            case 'up':
+              await page.mouse.up({ button: payload.button });
+              return true;
+          }
+        }
+
+        // handle specific behavior for puppeteer
+        if (session.browser.type === 'puppeteer') {
+          const page = (session.browser as ChromeLauncher).getPage(session.id);
+          switch (payload.type) {
+            case 'move':
+              await page.mouse.move(payload.position[0], payload.position[1]);
+              return true;
+            case 'click':
+              await page.mouse.click(payload.position[0], payload.position[1], {
+                button: payload.button,
+              });
+              return true;
+            case 'down':
+              await page.mouse.down({ button: payload.button });
+              return true;
+            case 'up':
+              await page.mouse.up({ button: payload.button });
+              return true;
+          }
+        }
+
+        // handle specific behavior for webdriver
+        if (session.browser.type === 'webdriver') {
+          const page = session.browser as WebdriverLauncher;
+          switch (payload.type) {
+            case 'move':
+              await page.sendMouseMove(session.id, payload.position[0], payload.position[1]);
+              return true;
+            case 'click':
+              await page.sendMouseClick(
+                session.id,
+                payload.position[0],
+                payload.position[1],
+                payload.button,
+              );
+              return true;
+            case 'down':
+              await page.sendMouseDown(session.id, payload.button);
+              return true;
+            case 'up':
+              await page.sendMouseUp(session.id, payload.button);
+              return true;
+          }
+        }
+
+        // you might not be able to support all browser launchers
+        throw new Error(`Sending mouse is not supported for browser type ${session.browser.type}.`);
+      }
+
+      if (command === 'reset-mouse') {
+        // handle specific behavior for playwright
+        if (session.browser.type === 'playwright') {
+          const page = (session.browser as PlaywrightLauncher).getPage(session.id);
+          await page.mouse.up({ button: 'left' });
+          await page.mouse.up({ button: 'middle' });
+          await page.mouse.up({ button: 'right' });
+          await page.mouse.move(0, 0);
+          return true;
+        }
+
+        // handle specific behavior for puppeteer
+        if (session.browser.type === 'puppeteer') {
+          const page = (session.browser as ChromeLauncher).getPage(session.id);
+          await page.mouse.up({ button: 'left' });
+          await page.mouse.up({ button: 'middle' });
+          await page.mouse.up({ button: 'right' });
+          await page.mouse.move(0, 0);
+          return true;
+        }
+
+        // handle specific behavior for webdriver
+        if (session.browser.type === 'webdriver') {
+          const page = session.browser as WebdriverLauncher;
+          await page.resetMouse(session.id);
+          return true;
+        }
+
+        // you might not be able to support all browser launchers
+        throw new Error(
+          `Resetting mouse is not supported for browser type ${session.browser.type}.`,
+        );
+      }
+    },
+  };
+}

package/CHANGELOG.md

@@ -1,296 +0,0 @@
-# @web/test-runner-commands
-
-## 0.5.11
-
-### Patch Changes
-
-- 62369e4d: Upgrade playwright to 1.14.0 which enables prefers-reduced-motion
-
-## 0.5.10
-
-### Patch Changes
-
-- 33ada3d8: Align @web/test-runner-core version
-
-## 0.5.9
-
-### Patch Changes
-
-- 056ba8c8: Add sendKeys support for webdriver
-
-## 0.5.8
-
-### Patch Changes
-
-- 687d4750: Downgrade @rollup/plugin-node-resolve to v11
-
-## 0.5.7
-
-### Patch Changes
-
-- 09af51ac: Escape the snapshot contents to avoid problems in Firrefox and Webkit
-
-## 0.5.6
-
-### Patch Changes
-
-- cb693c71: Use block comments in snapshots to make them work in all browsers
-
-## 0.5.5
-
-### Patch Changes
-
-- b362288a: make snapshots work on all browsers
-
-## 0.5.4
-
-### Patch Changes
-
-- 270a633a: dynamic import web socket module
-
-## 0.5.3
-
-### Patch Changes
-
-- 3af6ff86: improve snapshot formatting
-
-## 0.5.2
-
-### Patch Changes
-
-- 91e0e617: add compareSnapshot function
-
-## 0.5.1
-
-### Patch Changes
-
-- 339d05f7: add snapshots plugin
-
-## 0.5.0
-
-### Minor Changes
-
-- c3ead4fa: Added support for holding and releasing keys to the sendKeys command. The command now supports two additional actions `down` and `up` which hold down, or release a key. This effectively allows to hold down modifier keys while pressing other keys, which allows key combinations such as `Shift+Tab`.
-
-  @example
-
-  ```ts
-  await sendKeys({
-    down: 'Shift',
-  });
-  await sendKeys({
-    press: 'Tab',
-  });
-  await sendKeys({
-    up: 'Shift',
-  });
-  ```
-
-## 0.4.5
-
-### Patch Changes
-
-- 21f53211: add commands for reading/writing files
-
-## 0.4.4
-
-### Patch Changes
-
-- a6a018da: fix type references
-
-## 0.4.3
-
-### Patch Changes
-
-- 1d9411a3: Export `sendKeysPlugin` from `@web/test-runner-commands/plugins`.
-  Loosen the typing of the command payload.
-- d2389bac: Add a11ySnapshotPlugin to acquire the current accessibility tree from the browser:
-
-  ```js
-  import { a11ySnapshot, findAccessibilityNode } from '@web/test-runner-commands';
-
-  // ...
-
-  const nodeName = 'Label Text';
-  const snapshot = await a11ySnapshot();
-  const foundNode = findAccessibilityNode(snapshot, node => node.name === nodeName);
-  expect(foundNode).to.not.be.null;
-  ```
-
-## 0.4.2
-
-### Patch Changes
-
-- ce90c7c3: Add the `sendKeys` command
-
-  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
-
-  @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',
-  });
-  ```
-
-- Updated dependencies [ce90c7c3]
-  - @web/test-runner-core@0.10.14
-
-## 0.4.1
-
-### Patch Changes
-
-- e3314b02: update dependency on core
-
-## 0.4.0
-
-### Minor Changes
-
-- a7d74fdc: drop support for node v10 and v11
-- 1dd7cd0e: version bump after breaking change in @web/test-runner-core
-
-### Patch Changes
-
-- Updated dependencies [1dd7cd0e]
-- Updated dependencies [a7d74fdc]
-  - @web/test-runner-core@0.10.0
-
-## 0.3.0
-
-### Minor Changes
-
-- 6e313c18: merged @web/test-runner-cli package into @web/test-runner
-
-### Patch Changes
-
-- Updated dependencies [6e313c18]
-- Updated dependencies [0f613e0e]
-  - @web/test-runner-core@0.9.0
-
-## 0.2.1
-
-### Patch Changes
-
-- 416c0d2: Update dependencies
-- Updated dependencies [aadf0fe]
-  - @web/test-runner-core@0.8.4
-
-## 0.2.0
-
-### Minor Changes
-
-- 2291ca1: replaced HTTP with websocket for server-browser communication
-
-  this improves test speed, especially when a test file makes a lot of concurrent requests
-  it lets us us catch more errors during test execution, and makes us catch them faster
-
-### Patch Changes
-
-- Updated dependencies [2291ca1]
-  - @web/test-runner-core@0.8.0
-
-## 0.1.6
-
-### Patch Changes
-
-- ab97aa8: publish browser folder
-- Updated dependencies [ab97aa8]
-  - @web/test-runner-core@0.7.13
-
-## 0.1.5
-
-### Patch Changes
-
-- abf811f: improved error message when session id is missing
-- Updated dependencies [431ec8f]
-  - @web/test-runner-core@0.7.9
-
-## 0.1.4
-
-### Patch Changes
-
-- 632eb67: export browser and node types
-
-## 0.1.3
-
-### Patch Changes
-
-- ce2a2e6: align dependencies
-
-## 0.1.2
-
-### Patch Changes
-
-- 519e6e2: made the plugins import work on node v10
-
-## 0.1.1
-
-### Patch Changes
-
-- aa65fd1: run build before publishing
-- Updated dependencies [aa65fd1]
-  - @web/test-runner-core@0.7.1
-
-## 0.1.0
-
-### Minor Changes
-
-- fdcf2e5: Merged test runner server into core, and made it no longer possible configure a different server.
-
-  The test runner relies on the server for many things, merging it into core makes the code more maintainable. The server is composable, you can proxy requests to other servers and we can look into adding more composition APIs later.
-
-- 9be1f95: Added native node es module entrypoints. This is a breaking change. Before, native node es module imports would import a CJS module as a default import and require destructuring afterwards:
-
-  ```js
-  import playwrightModule from '@web/test-runner-playwright';
-
-  const { playwrightLauncher } = playwrightModule;
-  ```
-
-  Now, the exports are only available directly as a named export:
-
-  ```js
-  import { playwrightLauncher } from '@web/test-runner-playwright';
-  ```
-
-### Patch Changes
-
-- 62ff8b2: make tests work on windows
-- Updated dependencies [cdddf68]
-- Updated dependencies [fdcf2e5]
-- Updated dependencies [62ff8b2]
-- Updated dependencies [9be1f95]
-  - @web/test-runner-core@0.7.0
-
-## 0.0.1
-
-### Patch Changes
-
-- 74cc129: implement commands API
-- Updated dependencies [02a3926]
-- Updated dependencies [74cc129]
-  - @web/test-runner-core@0.6.22