browsertime 20.0.0 → 21.0.0

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

@@ -0,0 +1,151 @@
+/**
+ * Provides functionality to perform click actions on elements in a web page using various selectors.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Click {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Clicks on an element identified by its class name.
+     *
+     * @async
+     * @param {string} className - The class name of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byClassName(className: string): Promise<void>;
+    /**
+     * Clicks on an element identified by its class name and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} className - The class name of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action and page complete check are finished.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byClassNameAndWait(className: string): 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 for the page complete check to finish.
+     *
+     * @async
+     * @param {string} text - The visible text of the link to click.
+     * @returns {Promise<void>} A promise that resolves when the click action and page complete check are finished.
+     * @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 for the page complete check to finish.
+     *
+     * @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 and page complete check are finished.
+     * @throws {Error} Throws an error if the link is not found.
+     */
+    byPartialLinkTextAndWait(text: string): Promise<void>;
+    /**
+     * Clicks on an element that matches a given XPath selector.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(xpath: string): Promise<void>;
+    /**
+     * Clicks on an element that matches a given XPath selector and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} xpath - The XPath selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action and page complete check are finished.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpathAndWait(xpath: string): Promise<void>;
+    /**
+     * Clicks on an element located by evaluating a JavaScript expression.
+     *
+     * @async
+     * @param {string} js - The JavaScript expression that evaluates to an element or list of elements.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byJs(js: string): Promise<void>;
+    /**
+     * Clicks on an element located by evaluating a JavaScript expression and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} js - The JavaScript expression that evaluates to an element or list of elements.
+     * @returns {Promise<void>} A promise that resolves when the click action and page complete check are finished.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byJsAndWait(js: string): Promise<void>;
+    /**
+     * Clicks on an element located by its ID.
+     *
+     * @async
+     * @param {string} id - The ID of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byId(id: string): Promise<void>;
+    /**
+     * Clicks on an element located by its name attribute.
+     *
+     * @async
+     * @param {string} name - The name attribute of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byName(name: string): Promise<void>;
+    /**
+     * Click on link located by the ID attribute. Uses document.getElementById() to find the element. And wait for page complete check to finish.
+     * @param {string} id
+     * @returns {Promise<void>} Promise object represents when the element has been clicked and the pageCompleteCheck has finished.
+     * @throws Will throw an error if the element is not found
+     */
+    byIdAndWait(id: string): Promise<void>;
+    /**
+     * Clicks on an element located by its CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action is performed.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(selector: string): Promise<void>;
+    /**
+     * Clicks on an element located by its CSS selector and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to click.
+     * @returns {Promise<void>} A promise that resolves when the click action and page complete check are finished.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelectorAndWait(selector: string): Promise<void>;
+}
+//# sourceMappingURL=click.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/click.js"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;OAOG;IACH,uBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,8BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;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;;;;;;;OAOG;IACH,+BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IACD;;;;;;;OAOG;IACH,sBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,SAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,gBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;IAED;;;;;;;OAOG;IACH,SAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,aAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;OAKG;IACH,gBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;IAED;;;;;;;OAOG;IACH,qBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;OAOG;IACH,4BAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;CACF"}

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

@@ -0,0 +1,28 @@
+/**
+ * Provides debugging capabilities within a browser automation script.
+ * It allows setting breakpoints to pause script execution and inspect the current state.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Debug {
+    constructor(browser: any, options: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * Adds a breakpoint to the script. The browser will pause at the breakpoint, waiting for user input to continue.
+     * This is useful for debugging and inspecting the browser state at a specific point in the script.
+     *
+     * @async
+     * @param {string} [name] - An optional name for the breakpoint for logging purposes.
+     * @returns {Promise<void>} A promise that resolves when the user chooses to continue from the breakpoint.
+     */
+    breakpoint(name?: string): Promise<void>;
+}
+//# sourceMappingURL=debug.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/debug.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH;IACE,wCASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;OAOG;IACH,kBAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CA+BzB;CACF"}

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

@@ -0,0 +1,49 @@
+/**
+ * This class provides a way to get hokld of Seleniums WebElements.
+ * @class
+ * @hideconstructor
+ */
+export class Element {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * Finds an element by its CSS selector.
+     *
+     * @param {string} name - The CSS selector of the element.
+     * @returns {Promise<WebElement>} A promise that resolves to the WebElement found.
+     */
+    getByCss(name: string): Promise<WebElement>;
+    /**
+     * Finds an element by its ID.
+     *
+     * @param {string} id - The ID of the element.
+     * @returns {Promise<WebElement>} A promise that resolves to the WebElement found.
+     */
+    getById(id: string): Promise<WebElement>;
+    /**
+     * Finds an element by its XPath.
+     *
+     * @param {string} xpath - The XPath query of the element.
+     * @returns {Promise<WebElement>} A promise that resolves to the WebElement found.
+     */
+    getByXpath(xpath: string): Promise<WebElement>;
+    /**
+     * Finds an element by its class name.
+     *
+     * @param {string} className - The class name of the element.
+     * @returns {Promise<WebElement>} A promise that resolves to the WebElement found.
+     */
+    getByClassName(className: string): Promise<WebElement>;
+    /**
+     * Finds an element by its name attribute.
+     *
+     * @param {string} name - The name attribute of the element.
+     * @returns {Promise<WebElement>} A promise that resolves to the WebElement found.
+     */
+    getByName(name: string): Promise<WebElement>;
+}
+import { WebElement } from 'selenium-webdriver';
+//# sourceMappingURL=element.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/element.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH;IACE,0BAKC;IAJC;;OAEG;IACH,eAAiC;IAGnC;;;;;OAKG;IACH,eAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,YAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,kBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,0BAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,gBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;CACF;2BA/D8B,oBAAoB"}

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

@@ -0,0 +1,46 @@
+/**
+ * Manages the Gecko Profiler for profiling Firefox performance.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class GeckoProfiler {
+    constructor(GeckoProfiler: any, browser: any, index: any, options: any, result: any);
+    /**
+     * @private
+     */
+    private GeckoProfiler;
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private index;
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * @private
+     */
+    private result;
+    /**
+     * Starts the Gecko Profiler.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when the profiler is started.
+     * @throws {Error} Throws an error if not running Firefox or if the configuration is not set for custom profiling.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the Gecko Profiler and processes the collected data.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when the profiler is stopped and the data is processed.
+     * @throws {Error} Throws an error if not running Firefox or if custom profiling was not started.
+     */
+    stop(): Promise<void>;
+}
+//# sourceMappingURL=geckoProfiler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"geckoProfiler.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/geckoProfiler.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;IACE,qFAqBC;IApBC;;OAEG;IACH,sBAAkC;IAClC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,cAAkB;IAClB;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,eAAoB;IAGtB;;;;;;OAMG;IACH,SAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;OAMG;IACH,QAHa,QAAQ,IAAI,CAAC,CAezB;CACF"}

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

@@ -0,0 +1,63 @@
+/**
+ * Provides functionality to execute JavaScript code in the context of the current page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class JavaScript {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Executes a JavaScript script.
+     *
+     * @async
+     * @param {string} js - The JavaScript code to execute.
+     * @returns {Promise<*>} A promise that resolves with the result of the executed script.
+     * @throws {Error} Throws an error if the JavaScript cannot be executed.
+     */
+    run(js: string): Promise<any>;
+    /**
+     * Executes a JavaScript script and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} js - The JavaScript code to execute.
+     * @returns {Promise<*>} A promise that resolves with the result of the executed script and the completion of the page load.
+     * @throws {Error} Throws an error if the JavaScript cannot be executed.
+     */
+    runAndWait(js: string): Promise<any>;
+    /**
+     * Executes synchronous privileged JavaScript.
+     *
+     * @async
+     * @param {string} js - The privileged JavaScript code to execute.
+     * @returns {Promise<*>} A promise that resolves with the result of the executed privileged script.
+     * @throws {Error} Throws an error if the privileged JavaScript cannot be executed.
+     */
+    runPrivileged(js: string): Promise<any>;
+    /**
+     * Executes synchronous privileged JavaScript and waits for the page complete check to finish.
+     *
+     * @async
+     * @param {string} js - The privileged JavaScript code to execute.
+     * @returns {Promise<*>} A promise that resolves with the result of the executed privileged script and the completion of the page load.
+     * @throws {Error} Throws an error if the privileged JavaScript cannot be executed.
+     */
+    runPrivilegedAndWait(js: string): Promise<any>;
+    /**
+     * Executes asynchronous privileged JavaScript.
+     *
+     * @async
+     * @param {string} js - The asynchronous privileged JavaScript code to execute.
+     * @returns {Promise<*>} A promise that resolves with the result of the executed asynchronous privileged script.
+     * @throws {Error} Throws an error if the asynchronous privileged JavaScript cannot be executed.
+     */
+    runPrivilegedAsync(js: string): Promise<any>;
+}
+//# sourceMappingURL=javaScript.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"javaScript.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/javaScript.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;OAOG;IACH,QAJW,MAAM,GACJ,YAAU,CAYtB;IAED;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,YAAU,CAYtB;IAED;;;;;;;OAOG;IACH,kBAJW,MAAM,GACJ,YAAU,CAetB;IAED;;;;;;;OAOG;IACH,yBAJW,MAAM,GACJ,YAAU,CAYtB;IAED;;;;;;;OAOG;IACH,uBAJW,MAAM,GACJ,YAAU,CAetB;CACF"}

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"}