Tighten types on the mouse and measure surfaces

lib/core/engine/command/measure.js

@@ -328,7 +328,7 @@ export class Measure {
    *
    * @async
    * @param {string} errorMessage - The message about the error. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
-   * @returns {Promise} A promise that resolves when the stop process has completed.
+   * @returns {Promise<void>} A promise that resolves when the stop process has completed.
    * @since 21.2.0
    */
   async stopAsError(errorMessage) {
@@ -361,7 +361,7 @@ export class Measure {
    * @async
    * @param {string} alias - The friendly name for this measurement.
    * @param {string} selector - The CSS selector of the element to click.
-   * @returns {Promise} A promise that resolves with the collected metrics data.
+   * @returns {Promise<unknown>} A promise that resolves with the collected metrics data.
    * @throws {Error} Throws an error if the element is not found or the measurement fails.
    */
   async clickAndMeasure(alias, selector) {
@@ -378,7 +378,7 @@ export class Measure {
    * @async
    * @param {string} testedStartUrl - The URL that was initially tested. If not provided, it will be obtained from the browser.
    * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
-   * @returns {Promise} A promise that resolves with the collected metrics data.
+   * @returns {Promise<unknown>} A promise that resolves with the collected metrics data.
    */
   async stop(testedStartUrl) {
     log.debug('Stop measuring');

lib/core/engine/commands.js

@@ -357,10 +357,6 @@ export class Commands {
      */
     this.debug = new Debug(browser, options);
 
-    /**
-     * Interact with the page using the mouse.
-     * @type {Object}
-     */
     const singleClickInstance = new SingleClick(
       browser,
       pageCompleteCheck,
@@ -375,6 +371,16 @@ export class Commands {
     const mouseMoveInstance = new MouseMove(browser, options);
     const clickAndHoldInstance = new ClickAndHold(browser);
 
+    /**
+     * Interact with the page using the mouse.
+     * @type {{
+     *   moveTo: (selector: string) => Promise<void>,
+     *   singleClick: (selector: string, mouseOptions?: { waitForNavigation?: boolean }) => Promise<void>,
+     *   doubleClick: (selector: string) => Promise<void>,
+     *   contextClick: (selector: string) => Promise<void>,
+     *   clickAndHold: ClickAndHold
+     * }}
+     */
     this.mouse = {
       moveTo: async selector => mouseMoveInstance.run(selector),
       singleClick: async (selector, mouseOptions) =>

types/core/engine/command/measure.d.ts

@@ -144,10 +144,10 @@ export class Measure {
      *
      * @async
      * @param {string} errorMessage - The message about the error. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
-     * @returns {Promise} A promise that resolves when the stop process has completed.
+     * @returns {Promise<void>} A promise that resolves when the stop process has completed.
      * @since 21.2.0
      */
-    stopAsError(errorMessage: string): Promise<any>;
+    stopAsError(errorMessage: string): Promise<void>;
     /**
      * @private
      */
@@ -161,10 +161,10 @@ export class Measure {
      * @async
      * @param {string} alias - The friendly name for this measurement.
      * @param {string} selector - The CSS selector of the element to click.
-     * @returns {Promise} A promise that resolves with the collected metrics data.
+     * @returns {Promise<unknown>} A promise that resolves with the collected metrics data.
      * @throws {Error} Throws an error if the element is not found or the measurement fails.
      */
-    clickAndMeasure(alias: string, selector: string): Promise<any>;
+    clickAndMeasure(alias: string, selector: string): Promise<unknown>;
     /**
      * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
      * It finalizes the URL being tested, manages any URL-specific metadata, stops any ongoing video recordings,
@@ -173,9 +173,9 @@ export class Measure {
      * @async
      * @param {string} testedStartUrl - The URL that was initially tested. If not provided, it will be obtained from the browser.
      * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
-     * @returns {Promise} A promise that resolves with the collected metrics data.
+     * @returns {Promise<unknown>} A promise that resolves with the collected metrics data.
      */
-    stop(testedStartUrl: string): Promise<any>;
+    stop(testedStartUrl: string): Promise<unknown>;
     /**
      * Adds a custom metric to the current measurement result.
      * The metric will be attached to the latest tested page, meaming

types/core/engine/commands.d.ts

@@ -182,11 +182,23 @@ export class Commands {
      *  @type {Debug}
      */
     debug: Debug;
+    /**
+     * Interact with the page using the mouse.
+     * @type {{
+     *   moveTo: (selector: string) => Promise<void>,
+     *   singleClick: (selector: string, mouseOptions?: { waitForNavigation?: boolean }) => Promise<void>,
+     *   doubleClick: (selector: string) => Promise<void>,
+     *   contextClick: (selector: string) => Promise<void>,
+     *   clickAndHold: ClickAndHold
+     * }}
+     */
     mouse: {
-        moveTo: (selector: any) => Promise<void>;
-        singleClick: (selector: any, mouseOptions: any) => Promise<any>;
-        doubleClick: (selector: any) => Promise<void>;
-        contextClick: (selector: any) => Promise<void>;
+        moveTo: (selector: string) => Promise<void>;
+        singleClick: (selector: string, mouseOptions?: {
+            waitForNavigation?: boolean;
+        }) => Promise<void>;
+        doubleClick: (selector: string) => Promise<void>;
+        contextClick: (selector: string) => Promise<void>;
         clickAndHold: ClickAndHold;
     };
     /**