browsertime 19.3.1 → 21.0.0

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

@@ -0,0 +1,33 @@
+/**
+ * Take a screenshot. The screenshot will be stored to disk,
+ * named by the name provided to the take function.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Screenshot {
+    constructor(screenshotManager: any, browser: any, index: any);
+    /**
+     * @private
+     */
+    private screenshotManager;
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private index;
+    /**
+     * Takes a screenshot and saves it using the screenshot manager.
+     *
+     * @async
+     * @example async commands.screenshot.take('my_startpage');
+     * @param {string} name The name to assign to the screenshot file.
+     * @throws {Error} Throws an error if the name parameter is not provided.
+     * @returns {Promise<Object>} A promise that resolves with the screenshot details.
+     */
+    take(name: string): Promise<any>;
+}
+//# sourceMappingURL=screenshot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/screenshot.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH;IACE,8DAaC;IAZC;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,cAAkB;IAGpB;;;;;;;;OAQG;IAEH,WALW,MAAM,GAEJ,YAAe,CAa3B;CACF"}

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

@@ -0,0 +1,52 @@
+/**
+ * Provides functionality to control page scrolling in the browser.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Scroll {
+    constructor(browser: any, options: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * Scrolls the page by the specified number of pixels.
+     *
+     * @async
+     * @param {number} Xpixels - The number of pixels to scroll horizontally.
+     * @param {number} Ypixels - The number of pixels to scroll vertically.
+     * @returns {Promise<void>} A promise that resolves when the scrolling action is completed.
+     */
+    byPixels(Xpixels: number, Ypixels: number): Promise<void>;
+    /**
+     * Scrolls the page by the specified number of lines. This method is only supported in Firefox.
+     *
+     * @async
+     * @param {number} lines - The number of lines to scroll.
+     * @returns {Promise<void>} A promise that resolves when the scrolling action is completed.
+     * @throws {Error} Throws an error if not used in Firefox.
+     */
+    byLines(lines: number): Promise<void>;
+    /**
+     * Scrolls the page by the specified number of pages.
+     *
+     * @async
+     * @param {number} pages - The number of pages to scroll.
+     * @returns {Promise<void>} A promise that resolves when the scrolling action is completed.
+     */
+    byPages(pages: number): Promise<void>;
+    /**
+     * Scrolls to the bottom of the page, scrolling page by page with a delay between each scroll.
+     *
+     * @async
+     * @param {number} [delayTime=250] - The delay time in milliseconds between each scroll.
+     * @returns {Promise<void>} A promise that resolves when the scrolling to the bottom is completed.
+     */
+    toBottom(delayTime?: number): Promise<void>;
+}
+//# sourceMappingURL=scroll.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scroll.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/scroll.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,wCASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;OAOG;IACH,kBAJW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAKzB;IAED;;;;;;;OAOG;IACH,eAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;OAMG;IACH,eAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;OAMG;IACH,qBAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;CACF"}

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

@@ -0,0 +1,81 @@
+/**
+ * Provides functionality to interact with `<select>` elements on a web page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Select {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * Selects an option in a `<select>` element by its ID and the value of the option.
+     *
+     * @async
+     * @param {string} selectId - The ID of the `<select>` element.
+     * @param {string} value - The value of the option to select.
+     * @returns {Promise<void>} A promise that resolves when the option is selected.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    selectByIdAndValue(selectId: string, value: string): Promise<void>;
+    /**
+     * Selects an option in a `<select>` element by its name and the value of the option.
+     *
+     * @async
+     * @param {string} selectName - The name of the `<select>` element.
+     * @param {string} value - The value of the option to select.
+     * @returns {Promise<void>} A promise that resolves when the option is selected.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    selectByNameAndValue(selectName: string, value: string): Promise<void>;
+    /**
+     * Selects an option in a `<select>` element by its ID and the index of the option.
+     *
+     * @async
+     * @param {string} selectId - The ID of the `<select>` element.
+     * @param {number} index - The index of the option to select.
+     * @returns {Promise<void>} A promise that resolves when the option is selected.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    selectByIdAndIndex(selectId: string, index: number): Promise<void>;
+    /**
+     * Selects an option in a `<select>` element by its name and the index of the option.
+     *
+     * @async
+     * @param {string} selectName - The name of the `<select>` element.
+     * @param {number} index - The index of the option to select.
+     * @returns {Promise<void>} A promise that resolves when the option is selected.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    selectByNameAndIndex(selectName: string, index: number): Promise<void>;
+    /**
+     * Deselects all options in a `<select>` element by its ID.
+     *
+     * @async
+     * @param {string} selectId - The ID of the `<select>` element.
+     * @returns {Promise<void>} A promise that resolves when all options are deselected.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    deselectById(selectId: string): Promise<void>;
+    /**
+     * Retrieves all option values in a `<select>` element by its ID.
+     *
+     * @async
+     * @param {string} selectId - The ID of the `<select>` element.
+     * @returns {Promise<string[]>} A promise that resolves with an array of the values of the options.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    getValuesById(selectId: string): Promise<string[]>;
+    /**
+     * Retrieves the value of the selected option in a `<select>` element by its ID.
+     *
+     * @async
+     * @param {string} selectId - The ID of the `<select>` element.
+     * @returns {Promise<string>} A promise that resolves with the value of the selected option.
+     * @throws {Error} Throws an error if the `<select>` element is not found.
+     */
+    getSelectedValueById(selectId: string): Promise<string>;
+}
+//# sourceMappingURL=select.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"select.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/select.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IACE,0BAKC;IAJC;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;;OAQG;IACH,6BALW,MAAM,SACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,iCALW,MAAM,SACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IAED;;;;;;;;OAQG;IACH,6BALW,MAAM,SACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;OAQG;IACH,iCALW,MAAM,SACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;OAOG;IACH,uBAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAazB;IAED;;;;;;;OAOG;IACH,wBAJW,MAAM,GACJ,QAAQ,MAAM,EAAE,CAAC,CAoB7B;IAED;;;;;;;OAOG;IACH,+BAJW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAa3B;CACF"}

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

@@ -0,0 +1,74 @@
+/**
+ * Provides functionality to set properties like innerHTML, innerText, and value on elements in a web page.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Set {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * Sets the innerHTML of an element using a CSS selector.
+     *
+     * @async
+     * @param {string} html - The HTML string to set as innerHTML.
+     * @param {string} selector - The CSS selector of the element.
+     * @returns {Promise<void>} A promise that resolves when the innerHTML is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    innerHtml(html: string, selector: string): Promise<void>;
+    /**
+     * Sets the innerHTML of an element using its ID.
+     *
+     * @async
+     * @param {string} html - The HTML string to set as innerHTML.
+     * @param {string} id - The ID of the element.
+     * @returns {Promise<void>} A promise that resolves when the innerHTML is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    innerHtmlById(html: string, id: string): Promise<void>;
+    /**
+     * Sets the innerText of an element using a CSS selector.
+     *
+     * @async
+     * @param {string} text - The text to set as innerText.
+     * @param {string} selector - The CSS selector of the element.
+     * @returns {Promise<void>} A promise that resolves when the innerText is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    innerText(text: string, selector: string): Promise<void>;
+    /**
+     * Sets the innerText of an element using its ID.
+     *
+     * @async
+     * @param {string} text - The text to set as innerText.
+     * @param {string} id - The ID of the element.
+     * @returns {Promise<void>} A promise that resolves when the innerText is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    innerTextById(text: string, id: string): Promise<void>;
+    /**
+     * Sets the value of an element using a CSS selector.
+     *
+     * @async
+     * @param {string} value - The value to set on the element.
+     * @param {string} selector - The CSS selector of the element.
+     * @returns {Promise<void>} A promise that resolves when the value is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    value(value: string, selector: string): Promise<void>;
+    /**
+     * Sets the value of an element using its ID.
+     *
+     * @async
+     * @param {string} value - The value to set on the element.
+     * @param {string} id - The ID of the element.
+     * @returns {Promise<void>} A promise that resolves when the value is set.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    valueById(value: string, id: string): Promise<void>;
+}
+//# sourceMappingURL=set.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/set.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IACE,0BAKC;IAJC;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;;OAQG;IACH,gBALW,MAAM,YACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IAED;;;;;;;;OAQG;IACH,oBALW,MAAM,MACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,YACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAczB;IAED;;;;;;;;OAQG;IACH,oBALW,MAAM,MACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,aALW,MAAM,YACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,iBALW,MAAM,MACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;CACF"}

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

@@ -0,0 +1,49 @@
+/**
+ * A stopwatch utility for measuring time intervals.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class StopWatch {
+    constructor(name: any, measure: any);
+    /**
+     * @private
+     */
+    private name;
+    /**
+     * @private
+     */
+    private measure;
+    /**
+     * Starts the stopwatch.
+     */
+    start(): void;
+    /**
+     * Stops the stopwatch and automatically adds the measured time to the
+     * last measured page. Logs an error if no page has been measured.
+     * @returns {number} The measured time in milliseconds.
+     */
+    stopAndAdd(): number;
+    /**
+     * Stops the stopwatch.
+     * @returns {number} The measured time in milliseconds.
+     */
+    stop(): number;
+    /**
+     * Gets the name of the stopwatch.
+     * @returns {string} The name of the stopwatch.
+     */
+    getName(): string;
+}
+/**
+ * @private
+ */
+export class Watch {
+    constructor(measure: any);
+    measure: any;
+    /**
+     * @private
+     */
+    private get;
+}
+//# sourceMappingURL=stopWatch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stopWatch.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/stopWatch.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,qCAaC;IAZC;;OAEG;IACH,aAAgB;IAChB;;OAEG;IACH,gBAAsB;IAOxB;;OAEG;IACH,cAEC;IAED;;;;OAIG;IACH,cAFa,MAAM,CAOlB;IAED;;;OAGG;IACH,QAFa,MAAM,CAMlB;IAED;;;OAGG;IACH,WAFa,MAAM,CAIlB;CACF;AAED;;GAEG;AACH;IACE,0BAEC;IADC,aAAsB;IAGxB;;OAEG;IACH,YAEC;CACF"}

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

@@ -0,0 +1,77 @@
+/**
+ * Provides functionality to switch between frames, windows, and tabs in the browser.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Switch {
+    constructor(browser: any, pageCompleteCheck: any, navigate: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * @private
+     */
+    private navigate;
+    /**
+     * Switches to a frame identified by its ID.
+     *
+     * @async
+     * @param {string|number} id - The ID of the frame.
+     * @throws {Error} Throws an error if switching to the frame fails.
+     */
+    toFrame(id: string | number): Promise<void>;
+    /**
+     * Switches to a frame identified by an XPath.
+     *
+     * @async
+     * @param {string} xpath - The XPath of the frame element.
+     * @throws {Error} Throws an error if the frame is not found or switching fails.
+     */
+    toFrameByXpath(xpath: string): Promise<void>;
+    /**
+     * Switches to a frame identified by a CSS selector.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the frame element.
+     * @throws {Error} Throws an error if the frame is not found or switching fails.
+     */
+    toFrameBySelector(selector: string): Promise<void>;
+    /**
+     * Switches to a window identified by its name.
+     *
+     * @async
+     * @param {string} name - The name of the window.
+     * @throws {Error} Throws an error if switching to the window fails.
+     */
+    toWindow(name: string): Promise<void>;
+    /**
+     * Switches to the parent frame of the current frame.
+     *
+     * @async
+     * @throws {Error} Throws an error if switching to the parent frame fails.
+     */
+    toParentFrame(): Promise<void>;
+    /**
+     * Opens a new tab and optionally navigates to a URL.
+     *
+     * @async
+     * @param {string} [url] - Optional URL to navigate to in the new tab.
+     * @throws {Error} Throws an error if opening a new tab fails.
+     */
+    toNewTab(url?: string): Promise<void>;
+    /**
+     * Opens a new window and optionally navigates to a URL.
+     *
+     * @async
+     * @param {string} [url] - Optional URL to navigate to in the new window.
+     * @throws {Error} Throws an error if opening a new window fails.
+     */
+    toNewWindow(url?: string): Promise<void>;
+}
+//# sourceMappingURL=switch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"switch.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/switch.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH;IACE,iEAaC;IAZC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,iBAAwB;IAG1B;;;;;;OAMG;IACH,YAHW,MAAM,GAAC,MAAM,iBAYvB;IAED;;;;;;OAMG;IACH,sBAHW,MAAM,iBAkBhB;IAED;;;;;;OAMG;IACH,4BAHW,MAAM,iBAkBhB;IAED;;;;;;OAMG;IACH,eAHW,MAAM,iBAYhB;IAED;;;;;OAKG;IACH,+BASC;IAED;;;;;;OAMG;IACH,eAHW,MAAM,iBAiBhB;IAED;;;;;;OAMG;IACH,kBAHW,MAAM,iBAiBhB;CACF"}

package/types/core/engine/command/util/lcpHighlightScript.d.ts

@@ -0,0 +1,2 @@
+export const lcpHighlightScript: "\nreturn (function(color) {\n    const observer = new PerformanceObserver(list => {});\n    observer.observe({ type: 'largest-contentful-paint', buffered: true });\n    const entries = observer.takeRecords();\n    if (entries.length > 0) {\n        const largestEntry = entries[entries.length - 1];\n        // There could be cases where we do not get an element\n        if (largestEntry.element) {\n            const clientRect = largestEntry.element.getBoundingClientRect();\n\n            const canvas = document.createElement('canvas'); //Create a canvas element\n            canvas.style.width='100%';\n            canvas.style.height='100%';\n            canvas.width = window.innerWidth;\n            canvas.height = window.innerHeight;\n            canvas.style.position='absolute';\n            canvas.style.left=0;\n            canvas.style.top=0;\n            canvas.style.zIndex=2147483646;\n            canvas.id = \"browsertime-lcp\";\n            document.body.appendChild(canvas); \n            const context = canvas.getContext('2d');\n            context.rect(Math.max(0,clientRect.x), Math.max(0,clientRect.y), Math.min(clientRect.width, window.innerWidth - clientRect.x) , Math.min(clientRect.height, window.innerHeight-clientRect.y));\n            context.lineWidth = \"6\";\n            context.strokeStyle = color;\n            context.stroke();\n\n            context.fillStyle = color;\n            context.globalAlpha = 0.1;\n            context.rect(Math.max(0,clientRect.x), Math.max(0,clientRect.y), Math.min(clientRect.width, window.innerWidth - clientRect.x) , Math.min(clientRect.height, window.innerHeight-clientRect.y));\n            context.fill();\n            return '';\n        } else {\n            return 'No element attached to the entry in largest-contentful-paint';\n        }\n    } else {\n        return 'Chrome did not report any largest-contentful-paint';\n    }\n})(arguments[arguments.length - 1]);\n";
+//# sourceMappingURL=lcpHighlightScript.d.ts.map

package/types/core/engine/command/util/lcpHighlightScript.d.ts.map

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

package/types/core/engine/command/util/lsHighlightScript.d.ts

@@ -0,0 +1,2 @@
+export const clsHighlightScript: "\n(function(options) {\n    const rectColor = options.color;\n    const limit = options.limit;\n    const observer = new PerformanceObserver(list => {});\n    observer.observe({ type: 'layout-shift', buffered: true });\n    const entries = observer.takeRecords();\n    if (entries.length > 0) {\n        const canvas = document.createElement('canvas'); \n        canvas.style.width='100%';\n        canvas.style.height='100%';\n        canvas.width = window.innerWidth;\n        canvas.height = window.innerHeight;\n        canvas.style.position='absolute';\n        canvas.style.left=0;\n        canvas.style.top=0;\n        canvas.style.zIndex=2147483646;\n        canvas.id = \"browsertime-ls\";\n        document.body.appendChild(canvas);\n\n        function paintRectangle(context, clientRect, color) { \n            context.fillStyle = color;\n            context.globalAlpha = 0.03;\n            context.rect(Math.max(0,clientRect.x), Math.max(0,clientRect.y), Math.min(clientRect.width, window.innerWidth - clientRect.x) , Math.min(clientRect.height, window.innerHeight-clientRect.y));\n            context.fill();\n\n\n            context.strokeStyle = color;\n            context.globalAlpha = 1.0;\n            context.rect(Math.max(0,clientRect.x), Math.max(0,clientRect.y), Math.min(clientRect.width, window.innerWidth - clientRect.x) , Math.min(clientRect.height, window.innerHeight-clientRect.y));\n            context.stroke();\n        }\n\n        let maxSessionGap1sLimit5s = {}; \n        let max = 0; \n        let current = [];\n        let curr = 0; \n        let firstTs = Number.NEGATIVE_INFINITY;\n        let prevTs = Number.NEGATIVE_INFINITY;\n\n        for (let entry of entries) {\n            if (entry.hadRecentInput || entry.value <= limit) {\n                continue;\n            } \n        if (entry.startTime - firstTs > 5000 || entry.startTime - prevTs > 1000) {\n            firstTs = entry.startTime;\n            curr = 0;\n            maxSessionGap1sLimit5s[max] = [...current];\n            current = []; \n          }\n          prevTs = entry.startTime;\n          curr += entry.value;\n          max = Math.max(max, curr);\n          current.push(entry);\n        }\n\n          for (let entry of maxSessionGap1sLimit5s[max] || current) {\n            for (let source of entry.sources) {\n                if (source.previousRect && source.currentRect) {\n                    const context = canvas.getContext('2d');\n                    \n                    // paintRectangle(context, source.previousRect, \"yellow\", false);\n                    paintRectangle(context, source.currentRect, rectColor);\n                \n                    context.font = \"bolder 24px Arial\";\n                    context.fillStyle = \"black\";\n                    context.fillText(entry.value.toFixed(4), Math.max(0,source.currentRect.x) + 24,Math.max(0,source.currentRect.y) + 24);\n\n                }\n            }\n        }\n    }\n})(arguments[arguments.length - 1]);\n";
+//# sourceMappingURL=lsHighlightScript.d.ts.map

package/types/core/engine/command/util/lsHighlightScript.d.ts.map

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

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

@@ -0,0 +1,74 @@
+/**
+ * Provides functionality to wait for different conditions in the browser.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class Wait {
+    constructor(browser: any, pageCompleteCheck: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * @private
+     */
+    private pageCompleteCheck;
+    /**
+     * Waits for an element with a specific ID to appear within a maximum time.
+     *
+     * @async
+     * @param {string} id - The ID of the element to wait for.
+     * @param {number} maxTime - Maximum time to wait in milliseconds.
+     * @returns {Promise<void>} A promise that resolves when the element is found or the time times out.
+     * @throws {Error} Throws an error if the element is not found within the specified time.
+     */
+    byId(id: string, maxTime: number): Promise<void>;
+    /**
+     * Waits for an element located by XPath to appear within a maximum time.
+     *
+     * @async
+     * @param {string} xpath - The XPath of the element to wait for.
+     * @param {number} maxTime - Maximum time to wait in milliseconds.
+     * @returns {Promise<void>} A promise that resolves when the element is found or the time times out.
+     * @throws {Error} Throws an error if the element is not found within the specified time.
+     */
+    byXpath(xpath: string, maxTime: number): Promise<void>;
+    /**
+     * Waits for an element located by a CSS selector to appear within a maximum time.
+     *
+     * @async
+     * @param {string} selector - The CSS selector of the element to wait for.
+     * @param {number} maxTime - Maximum time to wait in milliseconds.
+     * @returns {Promise<void>} A promise that resolves when the element is found or the time times out.
+     * @throws {Error} Throws an error if the element is not found within the specified time.
+     */
+    bySelector(selector: string, maxTime: number): Promise<void>;
+    /**
+     * Waits for a specified amount of time.
+     *
+     * @async
+     * @example async commands.wait.byTime(1000);
+     * @param {number} ms - The time in milliseconds to wait.
+     * @returns {Promise<void>} A promise that resolves when the specified time has elapsed.
+     */
+    byTime(ms: number): Promise<void>;
+    /**
+     * Waits for the page to finish loading.
+     * @async
+     * @example async commands.wait.byPageToComplete();
+     * @returns {Promise<void>} A promise that resolves when the page complete check has finished.
+     */
+    byPageToComplete(): Promise<void>;
+    /**
+     * Waits for a JavaScript condition to return a truthy value within a maximum time.
+     *
+     * @async
+     * @param {string} jsExpression - The JavaScript expression to evaluate.
+     * @param {number} maxTime - Maximum time to wait in milliseconds.
+     * @returns {Promise<void>} A promise that resolves when the condition becomes truthy or the time times out.
+     * @throws {Error} Throws an error if the condition is not met within the specified time.
+     */
+    byCondition(jsExpression: string, maxTime: number): Promise<void>;
+}
+//# sourceMappingURL=wait.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wait.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/wait.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;;OAQG;IACH,SALW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;;;;;;OAQG;IACH,eALW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAmBzB;IAED;;;;;;;;OAQG;IACH,qBALW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAuBzB;IAED;;;;;;;OAOG;IACH,WAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAIzB;IAED;;;;;OAKG;IACH,oBAFa,QAAQ,IAAI,CAAC,CAIzB;IAED;;;;;;;;OAQG;IACH,0BALW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAiBzB;CACF"}

package/types/core/engine/commands.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Represents the set of commands available in a Browsertime script.
+ * @hideconstructor
+ */
+export class Commands {
+    constructor(browser: any, engineDelegate: any, index: any, result: any, storageManager: any, pageCompleteCheck: any, extensionServer: any, context: any, videos: any, screenshotManager: any, scriptsByCategory: any, asyncScriptsByCategory: any, postURLScripts: any, options: any);
+    profiler: GeckoProfilerCommand;
+    /**
+     * Manages Chrome trace functionality, enabling custom profiling and trace collection in Chrome.
+     * @type {ChromeTrace}
+     */
+    trace: ChromeTrace;
+    /**
+     * Provides functionality to perform click actions on elements in a web page using various selectors.
+     * @type {Click}
+     */
+    click: Click;
+    /**
+     * Provides functionality to control page scrolling in the browser.
+     * @type {Scroll}
+     */
+    scroll: Scroll;
+    /**
+     * Provides functionality to add text to elements on a web page using various selectors.
+     * @type {AddText}
+     */
+    addText: AddText;
+    /**
+     * Provides functionality to wait for different conditions in the browser.
+     * @type {Wait}
+     */
+    wait: Wait;
+    /**
+     * Provides functionality for measuring a navigation.
+     * @type {Measure}
+     */
+    measure: Measure;
+    /**
+     * Navigates to a specified URL and handles additional setup for a page visit.
+     * @async
+     * @example await commands.navigate('https://www.example.org');
+     * @type {Function}
+     * @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
+     */
+    navigate: Function;
+    /**
+     *  Provides functionality to control browser navigation such as back, forward, and refresh actions.
+     * @type {Navigation}
+     */
+    navigation: Navigation;
+    /**
+     * Add a text that will be an error attached to the current page.
+     * @example await commands.error('My error message');
+     * @param {string} message - The error message.
+     * @type {Function}
+     */
+    error: Function;
+    /**
+     * Mark this run as an failure. Add a message that explains the failure.
+     * @example await commands.markAsFailure('My failure message');
+     * @param {string} message - The message attached as a failure
+     * @type {Function}
+     */
+    markAsFailure: Function;
+    /**
+     * Executes JavaScript in the browser context.
+     * @type {JavaScript}
+     */
+    js: JavaScript;
+    /**
+     * Switches context to different frames, windows, or tabs in the browser.
+     * @type {Switch}
+     */
+    switch: Switch;
+    /**
+     * Sets values on HTML elements in the page.
+     * @type {Set}
+     */
+    set: Set;
+    /**
+     * Stopwatch utility for measuring time intervals.
+     * @type {StopWatch}
+     */
+    stopWatch: StopWatch;
+    /**
+     * Manages the browser's cache.
+     * @type {Cache}
+     */
+    cache: Cache;
+    /**
+     * Adds metadata to the user journey.
+     * @type {Meta}
+     */
+    meta: Meta;
+    /**
+     * Takes and manages screenshots.
+     * @type {Screenshot}
+     */
+    screenshot: Screenshot;
+    /**
+     * Use the Chrome DevTools Protocol, available in Chrome and Edge.
+     * @type {ChromeDevelopmentToolsProtocol}
+     */
+    cdp: ChromeDevelopmentToolsProtocol;
+    /**
+     * Provides commands for interacting with an Android device.
+     * @type {AndroidCommand}
+     */
+    android: AndroidCommand;
+    /**
+     * Provides debugging capabilities within a browser automation script.
+     * It allows setting breakpoints to pause script execution and inspect the current state.
+     *  @type {Debug}
+     */
+    debug: Debug;
+    /**
+     * Interact with the page using the mouse.
+     * @type {Object}
+     */
+    mouse: any;
+    /**
+     * Interact with a select element.
+     * @type {Select}
+     */
+    select: Select;
+    /**
+     * Selenium's action sequence functionality.
+     * @type {Actions}
+     * @see https://www.selenium.dev/documentation/webdriver/actions_api/
+     */
+    action: Actions;
+    /**
+     * Get Selenium's WebElements.
+     * @type {Element}
+     */
+    element: Element;
+}
+import { GeckoProfiler as GeckoProfilerCommand } from './command/geckoProfiler.js';
+import { ChromeTrace } from './command/chromeTrace.js';
+import { Click } from './command/click.js';
+import { Scroll } from './command/scroll.js';
+import { AddText } from './command/addText.js';
+import { Wait } from './command/wait.js';
+import { Measure } from './command/measure.js';
+import { Navigation } from './command/navigation.js';
+import { JavaScript } from './command/javaScript.js';
+import { Switch } from './command/switch.js';
+import { Set } from './command/set.js';
+import { Watch as StopWatch } from './command/stopWatch.js';
+import { Cache } from './command/cache.js';
+import { Meta } from './command/meta.js';
+import { Screenshot } from './command/screenshot.js';
+import { ChromeDevelopmentToolsProtocol } from './command/chromeDevToolsProtocol.js';
+import { AndroidCommand } from './command/android.js';
+import { Debug } from './command/debug.js';
+import { Select } from './command/select.js';
+import { Actions } from './command/actions.js';
+import { Element } from './command/element.js';
+//# sourceMappingURL=commands.d.ts.map

package/types/core/engine/commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../lib/core/engine/commands.js"],"names":[],"mappings":"AA6BA;;;GAGG;AACH;IACE,sRAuOC;IApMC,+BAMC;IAMD;;;OAGG;IACH,OAFU,WAAW,CAE+C;IAEpE;;;OAGG;IACH,OAFU,KAAK,CAEmC;IAElD;;;OAGG;IACH,QAFU,MAAM,CAE0B;IAE1C;;;OAGG;IACH,SAFU,OAAO,CAEkB;IAEnC;;;OAGG;IACH,MAFU,IAAI,CAEkC;IAEhD;;;OAGG;IACH,SAFU,OAAO,CAEK;IAEtB;;;;;;;;OAQG;IACH,mBAA+C;IAE/C;;;OAGG;IACH,YAFU,UAAU,CAEwC;IAE5D;;;;;OAKG;IACH,gBAAyC;IAEzC;;;;;OAKG;IACH,wBAAmD;IAEnD;;;OAGG;IACH,IAFU,UAAU,CAEgC;IAEpD;;;OAGG;IACH,QAFU,MAAM,CAMf;IAED;;;OAGG;IACH,KAFU,GAAG,CAEc;IAE3B;;;OAGG;IACH,WAFU,SAAS,CAEoB;IAEvC;;;OAGG;IACH,OAFU,KAAK,CAEuD;IAEtE;;;OAGG;IACH,MAFU,IAAI,CAEQ;IAEtB;;;OAGG;IACH,YAFU,UAAU,CAE+C;IAEnE;;;OAGG;IACH,KAFU,8BAA8B,CAE1B;IAEd;;;OAGG;IACH,SAFU,cAAc,CAEkB;IAE1C;;;;OAIG;IACH,OAFW,KAAK,CAEwB;IAExC;;;OAGG;IACH,WA0BC;IAED;;;OAGG;IACH,QAFU,MAAM,CAEiB;IAEjC;;;;OAIG;IACH,QAHU,OAAO,CAGiB;IAElC;;;OAGG;IACH,SAFU,OAAO,CAEkB;CAEtC;sDA9OqD,4BAA4B;4BAXtD,0BAA0B;sBAfhC,oBAAoB;uBAuBnB,qBAAqB;wBAxBpB,sBAAsB;qBAGzB,mBAAmB;wBAChB,sBAAsB;2BAqBnB,yBAAyB;2BApBzB,yBAAyB;uBAC7B,qBAAqB;oBAExB,kBAAkB;mCAGH,wBAAwB;sBAFrC,oBAAoB;qBACrB,mBAAmB;2BAHb,yBAAyB;+CAQL,qCAAqC;+BADrD,sBAAsB;sBAD/B,oBAAoB;uBADnB,qBAAqB;wBAbpB,sBAAsB;wBAGtB,sBAAsB"}