browsertime 19.3.1 → 21.0.0

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

@@ -0,0 +1,194 @@
+/**
+ * A measurement tool for browser-based metrics, handling various aspects
+ * of metric collection including navigation, video recording, and data collection.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Measure {
+    constructor(browser: any, index: any, pageCompleteCheck: any, result: any, engineDelegate: any, extensionServer: any, storageManager: any, videos: any, scriptsByCategory: any, asyncScriptsByCategory: any, postURLScripts: any, context: any, screenshotManager: any, options: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * @private
+     */
+    private index;
+    /**
+     * @private
+     */
+    private result;
+    /**
+     * @private
+     */
+    private engineDelegate;
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * @private
+     */
+    private screenshotManager;
+    /**
+     * @private
+     */
+    private storageManager;
+    /**
+     * @private
+     */
+    private recordVideo;
+    /**
+     * @private
+     */
+    private extensionServer;
+    /**
+     * @private
+     */
+    private videos;
+    /**
+     * @private
+     */
+    private scriptsByCategory;
+    /**
+     * @private
+     */
+    private asyncScriptsByCategory;
+    /**
+     * @private
+     */
+    private postURLScripts;
+    /**
+     * @private
+     */
+    private context;
+    /**
+     * @private
+     */
+    private numberOfMeasuredPages;
+    /**
+     * @private
+     */
+    private numberOfVisitedPages;
+    /**
+     * @private
+     */
+    private areWeMeasuring;
+    /**
+     * @private
+     */
+    private testedURLs;
+    /**
+     * @private
+     */
+    private tcpDump;
+    /**
+     * @private
+     */
+    private ANDROID_DELAY_TIME;
+    /**
+     * @private
+     */
+    private IOS_DELAY_TIME;
+    /**
+     * @private
+     */
+    private DESKTOP_DELAY_TIME;
+    /**
+     * Have a consistent way of starting the video
+     * @private
+     */
+    private _startVideo;
+    video: Video;
+    /**
+     * Have a consistent way of starting stopping the video
+     * @private
+     */
+    private _stopVideo;
+    /**
+     * Have a consistent way of adding an error
+     * @private
+     */
+    private _error;
+    /**
+     * Have a consistent way of adding an failure
+     * @private
+     */
+    private _failure;
+    /**
+     * Navigates to a specified URL and handles additional setup for the first page visit.
+     *
+     * This function is responsible for setting up the browser with necessary configurations and
+     * navigating to the URL. It also waits for the page
+     * to load completely based on configured page completion check.
+     *
+     * @async
+     * @private
+     * @param {string} url - The URL to navigate to.
+     * @throws {Error} Throws an error if navigation or setup fails.
+     * @returns {Promise<void>} A promise that resolves when the navigation and setup are complete.
+     */
+    private _navigate;
+    /**
+     * Starts the measurement process for a given URL or an alias.
+     *
+     * It supports starting measurements by either directly providing a URL or using an alias.
+     * If a URL is provided, it navigates to that URL and performs the measurement.
+     * If an alias is provided, or no URL is available, it sets up the environment for a user-driven navigation.
+     *
+     * @async
+     * @example
+     * await commands.measure.start('https://www.example.org');
+     * // Or start the measurement and click on a link
+     * await commands.measure.start();
+     * await commands.click.byLinkTextAndWait('Documentation');
+     * // Remember to stop the measurements if you do not provide a URL
+     * await commands.measure.stop();
+     * @param {string} urlOrAlias - The URL to navigate to, or an alias representing the test.
+     * @param {string} [optionalAlias] - An optional alias that can be used if the first parameter is a URL.
+     * @throws {Error} Throws an error if navigation fails or if there are issues in the setup process.
+     * @returns {Promise<void>} A promise that resolves when the start process is complete, or rejects if there are errors.
+     */
+    start(urlOrAlias: string, optionalAlias?: string): Promise<void>;
+    /**
+     * 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,
+     * and initiates the data collection process.
+     *
+     * @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.
+     */
+    stop(testedStartUrl: string): Promise<any>;
+    /**
+     * Adds a custom metric to the current measurement result.
+     * This method should be called after a measurement has started and before it has stopped.
+     *
+     * @param {string} name - The name of the metric.
+     * @param {*} value - The value of the metric.
+     * @throws {Error} Throws an error if called before a measurement cycle has started.
+     */
+    add(name: string, value: any): void;
+    /**
+     * Adds multiple custom metrics to the current measurement result.
+     * This method accepts an object containing multiple key-value pairs representing different metrics.
+     * Similar to `add`, it should be used within an active measurement cycle.
+     *
+     * @param {Object} object - An object containing key-value pairs of metrics to add.
+     * @throws {Error} Throws an error if called before a measurement cycle has started.
+     */
+    addObject(object: any): void;
+    /**
+     *
+     * @private
+     */
+    private collect;
+}
+import { Video } from '../../../video/video.js';
+//# sourceMappingURL=measure.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"measure.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/measure.js"],"names":[],"mappings":"AA6BA;;;;;;GAMG;AACH;IACE,sRA4GC;IA5FC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,cAAkB;IAClB;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,oBAAyD;IACzD;;OAEG;IACH,wBAAsC;IACtC;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,+BAAoD;IACpD;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,8BAA8B;IAC9B;;OAEG;IACH,6BAA6B;IAC7B;;OAEG;IACH,uBAA2B;IAC3B;;OAEG;IACH,mBAAoB;IACpB;;OAEG;IACH,gBAA6D;IAC7D;;OAEG;IACH,2BAAsE;IACtE;;OAEG;IACH,uBAA8D;IAC9D;;OAEG;IACH,2BAAqE;IAGvE;;;OAGG;IACH,oBAsBC;IArBC,aAAuE;IAuBzE;;;OAGG;IACH,mBAKC;IAED;;;OAGG;IACH,eAsBC;IAED;;;OAGG;IACH,iBAQC;IAED;;;;;;;;;;;;OAYG;IACH,kBAuBC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBALW,MAAM,kBACN,MAAM,GAEJ,QAAQ,IAAI,CAAC,CAwFzB;IAED;;;;;;;;;OASG;IACH,qBAJW,MAAM,gBAkEhB;IAED;;;;;;;OAOG;IACH,UAJW,MAAM,oBAYhB;IAED;;;;;;;OAOG;IACH,6BAOC;IAED;;;OAGG;IACH,gBA+KC;CACF;sBAlpBqB,yBAAyB"}

package/types/core/engine/command/meta.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Add meta data to your user journey.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Meta {
+    /**
+     * Sets the description for the user journey.
+     * @example commands.meta.setDescription('My test');
+     * @param {string} text - The text to set as the description.
+     */
+    setDescription(text: string): void;
+    description: string;
+    /**
+     * Sets the title for the user journey.
+     * @example commands.meta.setTitle('Test title');
+     * @param {string} text - The text to set as the title.
+     */
+    setTitle(text: string): void;
+    title: string;
+}
+//# sourceMappingURL=meta.d.ts.map

package/types/core/engine/command/meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/meta.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH;IAGE;;;;OAIG;IACH,qBAFW,MAAM,QAIhB;IADC,oBAAuB;IAGzB;;;;OAIG;IACH,eAFW,MAAM,QAIhB;IADC,cAAiB;CAEpB"}

package/types/core/engine/command/mouse/clickAndHold.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Provides functionality to click and hold elements on a web page using different strategies.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class ClickAndHold {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * @private
+     */
+    private actions;
+    /**
+     * Clicks and holds on an element that matches a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to interact with.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string): Promise<void>;
+    /**
+     * Clicks and holds on an element that matches a given CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to interact with.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string): Promise<void>;
+    /**
+     * Clicks and holds at the current cursor position.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    atCursor(): Promise<void>;
+    /**
+     * Clicks and holds at the specified screen coordinates.
+     *
+     * @async
+     * @param {number} xPos - The x-coordinate on the screen.
+     * @param {number} yPos - The y-coordinate on the screen.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    atPosition(xPos: number, yPos: number): Promise<void>;
+    /**
+     * Releases the mouse button on an element matching the specified XPath.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to release the mouse on.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    releaseAtXpath(xpath: string): Promise<void>;
+    /**
+     * Releases the mouse button on an element matching the specified CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to release the mouse on.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    releaseAtSelector(selector: string): Promise<void>;
+    /**
+     * Releases the mouse button at the specified screen coordinates.
+     *
+     * @async
+     * @param {number} xPos - The x-coordinate on the screen.
+     * @param {number} yPos - The y-coordinate on the screen.
+     * @returns {Promise<void>} A promise that resolves when the action is performed.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    releaseAtPosition(xPos: number, yPos: number): Promise<void>;
+}
+//# sourceMappingURL=clickAndHold.d.ts.map

package/types/core/engine/command/mouse/clickAndHold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clickAndHold.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/clickAndHold.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,0BASC;IARC;;OAEG;IACH,eAAiC;IACjC;;OAEG;IACH,gBAAmD;IAGrD;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IAED;;;;;;;OAOG;IACH,qBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;;;;OAMG;IACH,YAHa,QAAQ,IAAI,CAAC,CAWzB;IAED;;;;;;;;OAQG;IACH,iBALW,MAAM,QACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;OAOG;IACH,sBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,4BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,wBALW,MAAM,QACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;CACF"}

package/types/core/engine/command/mouse/contextClick.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Provides functionality to perform a context click (right-click) on elements in a web page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class ContextClick {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * @private
+     */
+    private actions;
+    /**
+     * Performs a context click (right-click) on an element that matches a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to context click.
+     * @returns {Promise<void>} A promise that resolves when the context click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string): Promise<void>;
+    /**
+     * Performs a context click (right-click) on an element that matches a given CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to context click.
+     * @returns {Promise<void>} A promise that resolves when the context click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string): Promise<void>;
+    /**
+     * Performs a context click (right-click) at the current cursor position.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when the context click action is performed.
+     * @throws {Error} Throws an error if the context click action cannot be performed.
+     */
+    atCursor(): Promise<void>;
+}
+//# sourceMappingURL=contextClick.d.ts.map

package/types/core/engine/command/mouse/contextClick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextClick.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/contextClick.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,0BASC;IARC;;OAEG;IACH,eAAiC;IACjC;;OAEG;IACH,gBAAmD;IAGrD;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,qBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IAED;;;;;;OAMG;IACH,YAHa,QAAQ,IAAI,CAAC,CAWzB;CACF"}

package/types/core/engine/command/mouse/doubleClick.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Provides functionality to perform a double-click action on elements in a web page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class DoubleClick {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private actions;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Performs a mouse double-click on an element matching a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to double-click.
+     * @param {Object} [options] - Additional options for the double-click action.
+     * @returns {Promise<void>} A promise that resolves when the double-click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string, options?: any): Promise<void>;
+    /**
+     * Performs a mouse double-click on an element matching a given CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to double-click.
+     * @param {Object} [options] - Additional options for the double-click action.
+     * @returns {Promise<void>} A promise that resolves when the double-click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string, options?: any): Promise<void>;
+    /**
+     * Performs a mouse double-click at the current cursor position.
+     *
+     * @async
+     * @param {Object} [options] - Additional options for the double-click action.
+     * @returns {Promise<void>} A promise that resolves when the double-click occurs.
+     * @throws {Error} Throws an error if the double-click action cannot be performed.
+     */
+    atCursor(options?: any): Promise<void>;
+}
+//# sourceMappingURL=doubleClick.d.ts.map

package/types/core/engine/command/mouse/doubleClick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doubleClick.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/doubleClick.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IACE,kDAaC;IAZC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAgE;IAChE;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;;OAQG;IACH,eALW,MAAM,kBAEJ,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;;;;;;OAQG;IACH,qBALW,MAAM,kBAEJ,QAAQ,IAAI,CAAC,CAmBzB;IAED;;;;;;;OAOG;IACH,yBAHa,QAAQ,IAAI,CAAC,CAczB;CACF"}

package/types/core/engine/command/mouse/index.d.ts

@@ -0,0 +1,6 @@
+export { ClickAndHold } from "./clickAndHold.js";
+export { DoubleClick } from "./doubleClick.js";
+export { ContextClick } from "./contextClick.js";
+export { SingleClick } from "./singleClick.js";
+export { MouseMove } from "./mouseMove.js";
+//# sourceMappingURL=index.d.ts.map

package/types/core/engine/command/mouse/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/index.js"],"names":[],"mappings":""}

package/types/core/engine/command/mouse/mouseMove.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Provides functionality to move the mouse cursor to elements or specific positions on a web page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class MouseMove {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * @private
+     */
+    private actions;
+    /**
+     * Moves the mouse cursor to an element that matches a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to move to.
+     * @returns {Promise<void>} A promise that resolves when the mouse has moved to the element.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string): Promise<void>;
+    /**
+     * Moves the mouse cursor to an element that matches a given CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to move to.
+     * @returns {Promise<void>} A promise that resolves when the mouse has moved to the element.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string): Promise<void>;
+    /**
+     * Moves the mouse cursor to a specific position on the screen.
+     *
+     * @async
+     * @param {number} xPos - The x-coordinate on the screen to move to.
+     * @param {number} yPos - The y-coordinate on the screen to move to.
+     * @returns {Promise<void>} A promise that resolves when the mouse has moved to the specified position.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    toPosition(xPos: number, yPos: number): Promise<void>;
+    /**
+     * Moves the mouse cursor by an offset from its current position.
+     *
+     * @async
+     * @param {number} xOffset - The x offset to move by.
+     * @param {number} yOffset - The y offset to move by.
+     * @returns {Promise<void>} A promise that resolves when the mouse has moved by the specified offset.
+     * @throws {Error} Throws an error if the action cannot be performed.
+     */
+    byOffset(xOffset: number, yOffset: number): Promise<void>;
+}
+//# sourceMappingURL=mouseMove.d.ts.map

package/types/core/engine/command/mouse/mouseMove.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mouseMove.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/mouseMove.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IACE,0BASC;IARC;;OAEG;IACH,eAAiC;IACjC;;OAEG;IACH,gBAAmD;IAGrD;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,qBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,iBALW,MAAM,QACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAWzB;IAED;;;;;;;;OAQG;IACH,kBALW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;CACF"}

package/types/core/engine/command/mouse/singleClick.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Provides functionality to perform a single click action on elements or at specific positions in a web page. Uses Seleniums Action API.
+ *
+ * @hideconstructor
+ * @class
+ */
+export class SingleClick {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private actions;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Performs a single mouse click on an element matching a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to click.
+     * @param {Object} [options] - Additional options for the click action.
+     * @returns {Promise<void>} A promise that resolves when the single click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string, options?: any): Promise<void>;
+    /**
+     * Performs a single mouse click on an element matching a given XPath selector and wait for page complete check.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the single click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpathAndWait(xpath: string): Promise<void>;
+    /**
+     * Performs a single mouse click on an element matching a given CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to click.
+     * @param {Object} [options] - Additional options for the click action.
+     * @returns {Promise<void>} A promise that resolves when the single click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string, options?: any): Promise<void>;
+    /**
+     * Performs a single mouse click on an element matching a given CSS selector and waits on the page complete check.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the single click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelectorAndWait(selector: string): Promise<void>;
+    /**
+     * Performs a single mouse click at the current cursor position.
+     *
+     * @async
+     * @param {Object} [options] - Additional options for the click action.
+     * @returns {Promise<void>} A promise that resolves when the single click occurs.
+     * @throws {Error} Throws an error if the single click action cannot be performed.
+     */
+    atCursor(options?: any): Promise<void>;
+    /**
+     * Performs a single mouse click at the current cursor position and waits on the
+     * page complete check.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when the single click occurs.
+     * @throws {Error} Throws an error if the single click action cannot be performed.
+     */
+    atCursorAndWait(): Promise<void>;
+    /**
+     * Clicks on a link whose visible text matches the given string.
+     *
+     * @async
+     * @param {string} text - The visible text of the link to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the link is not found.
+     */
+    byLinkText(text: string): Promise<void>;
+    /**
+     * Clicks on a link whose visible text matches the given string and waits on the opage complete check.
+     *
+     * @async
+     * @param {string} text - The visible text of the link to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the link is not found.
+     */
+    byLinkTextAndWait(text: string): Promise<void>;
+    /**
+     * Clicks on a link whose visible text contains the given substring.
+     *
+     * @async
+     * @param {string} text - The substring of the visible text of the link to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the link is not found.
+     */
+    byPartialLinkText(text: string): Promise<void>;
+    /**
+     * Clicks on a link whose visible text contains the given substring and waits on the
+     * page complete checl.
+     *
+     * @async
+     * @param {string} text - The substring of the visible text of the link to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the link is not found.
+     */
+    byPartialLinkTextAndWait(text: string): Promise<void>;
+}
+//# sourceMappingURL=singleClick.d.ts.map

package/types/core/engine/command/mouse/singleClick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleClick.d.ts","sourceRoot":"","sources":["../../../../../lib/core/engine/command/mouse/singleClick.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,kDAaC;IAZC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAgE;IAChE;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;;OAQG;IACH,eALW,MAAM,kBAEJ,QAAQ,IAAI,CAAC,CAoBzB;IAED;;;;;;;OAOG;IACH,sBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;OAQG;IACH,qBALW,MAAM,kBAEJ,QAAQ,IAAI,CAAC,CAsBzB;IAED;;;;;;;OAOG;IACH,4BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;;;;;OAOG;IACH,yBAHa,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;;;;;OAOG;IACH,mBAHa,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,iBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,wBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,wBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,+BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;CACF"}

package/types/core/engine/command/navigation.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Provides functionality to control browser navigation such as back, forward, and refresh actions.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Navigation {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Navigates backward in the browser's history.
+     *
+     * @async
+     * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
+     * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
+     * @throws {Error} Throws an error if navigation fails.
+     */
+    back(options?: any): Promise<void>;
+    /**
+     * Navigates forward in the browser's history.
+     *
+     * @async
+     * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
+     * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
+     * @throws {Error} Throws an error if navigation fails.
+     */
+    forward(options?: any): Promise<void>;
+    /**
+     * Refreshes the current page.
+     *
+     * @async
+     * @param {Object} [options] - Additional options for refresh action. Set {wait:true} to wait for the page complete check to run.
+     * @returns {Promise<void>} A promise that resolves when the page has been refreshed.
+     * @throws {Error} Throws an error if refreshing the page fails.
+     */
+    refresh(options?: any): Promise<void>;
+}
+//# sourceMappingURL=navigation.d.ts.map

package/types/core/engine/command/navigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/navigation.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;OAOG;IACH,qBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;CACF"}