browsertime 19.3.1 → 21.0.0

package/lib/firefox/webdriver/firefox.js

@@ -140,7 +140,7 @@ export class Firefox {
       this.firefoxConfig.geckoProfiler &&
       this.firefoxConfig.geckoProfilerRecordingType !== 'custom'
     ) {
-      await this.geckoProfiler.stop(index, url);
+      await this.geckoProfiler.stop(index, url, result);
     }
 
     if (this.firefoxConfig.perfStats) {

package/lib/support/cli.js

@@ -537,6 +537,13 @@ export function parseCommandLine() {
         'need to specify the logs you wish to gather.',
       group: 'firefox'
     })
+    .option('firefox.powerConsumption', {
+      type: 'boolean',
+      default: false,
+      describe:
+        'Enable power consumption collection (in Wh). To get the consumption you also need to set firefox.geckoProfilerParams.features to include power.',
+      group: 'firefox'
+    })
     .option('firefox.setMozLog', {
       describe:
         'Use in conjunction with firefox.collectMozLog to set MOZ_LOG to something ' +
@@ -905,43 +912,50 @@ export function parseCommandLine() {
     })
     .option('pageCompleteCheck', {
       describe:
-        'Supply a JavaScript (inline or JavaScript file) that decides when the browser is finished loading the page and can start to collect metrics. The JavaScript snippet is repeatedly queried to see if page has completed loading (indicated by the script returning true). Use it to fetch timings happening after the loadEventEnd. By default the tests ends 2 seconds after loadEventEnd. Also checkout --pageCompleteCheckInactivity and --pageCompleteCheckPollTimeout'
+        'Supply a JavaScript (inline or JavaScript file) that decides when the browser is finished loading the page and can start to collect metrics. The JavaScript snippet is repeatedly queried to see if page has completed loading (indicated by the script returning true). Use it to fetch timings happening after the loadEventEnd. By default the tests ends 2 seconds after loadEventEnd. Also checkout --pageCompleteCheckInactivity and --pageCompleteCheckPollTimeout',
+      group: 'PageLoad'
     })
     .option('pageCompleteWaitTime', {
       describe:
         'How long time you want to wait for your pageComplteteCheck to finish, after it is signaled to closed. Extra parameter passed on to your pageCompleteCheck.',
-      default: 8000
+      default: 8000,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckInactivity', {
       describe:
         'Alternative way to choose when to end your test. This will wait for 2 seconds of inactivity that happens after loadEventEnd.',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckNetworkIdle', {
       describe:
         'Alternative way to choose when to end your test that works in Chrome and Firefox. Uses CDP or WebDriver Bidi to look at network traffic instead of running JavaScript in the browser to know when to end the test. By default this will wait 5 seconds of inactivity in the network log (no requets/responses in 5 seconds). Use --timeouts.networkIdle to change the 5 seconds. The test will end after 2 minutes if there is still activity on the network. You can change that timout using --timeouts.pageCompleteCheck ',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckPollTimeout', {
       type: 'number',
       default: 1500,
       describe:
-        'The time in ms to wait for running the page complete check the next time.'
+        'The time in ms to wait for running the page complete check the next time.',
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckStartWait', {
       type: 'number',
       default: 5000,
       describe:
-        'The time in ms to wait for running the page complete check for the first time. Use this when you have a pageLoadStrategy set to none'
+        'The time in ms to wait for running the page complete check for the first time. Use this when you have a pageLoadStrategy set to none',
+      group: 'PageLoad'
     })
     .option('pageLoadStrategy', {
       type: 'string',
       default: 'none',
       choices: ['eager', 'none', 'normal'],
       describe:
-        'Set the strategy to waiting for document readiness after a navigation event. After the strategy is ready, your pageCompleteCheck will start runninhg.'
+        'Set the strategy to waiting for document readiness after a navigation event. After the strategy is ready, your pageCompleteCheck will start running.',
+      group: 'PageLoad'
     })
     .option('iterations', {
       alias: 'n',
@@ -965,13 +979,15 @@ export function parseCommandLine() {
       type: 'number',
       default: 0,
       describe:
-        'Extra time added for the browser to settle before starting to test a URL. This delay happens after the browser was opened and before the navigation to the URL'
+        'Extra time added for the browser to settle before starting to test a URL. This delay happens after the browser was opened and before the navigation to the URL',
+      group: 'PageLoad'
     })
     .option('webdriverPageload', {
       type: 'boolean',
       describe:
         'Use webdriver.get to initialize the page load instead of window.location.',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('proxy.pac', {
       type: 'string',
@@ -1106,7 +1122,8 @@ export function parseCommandLine() {
       describe:
         'Use internal browser functionality to clear browser cache between runs instead of only using Selenium.',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('basicAuth', {
       describe:
@@ -1211,9 +1228,9 @@ export function parseCommandLine() {
       type: 'integer',
       default: 1500
     })
-    .option('userTimingWhitelist', {
+    .option('userTimingAllowList', {
       describe:
-        'All userTimings are captured by default this option takes a regex that will whitelist which userTimings to capture in the results.'
+        'All userTimings are captured by default this option takes a regex that will allow which userTimings to capture in the results.'
     })
     .option('headless', {
       type: 'boolean',
@@ -1233,7 +1250,8 @@ export function parseCommandLine() {
       type: 'boolean',
       default: false,
       describe:
-        'Flush DNS between runs, works on Mac OS and Linux. Your user needs sudo rights to be able to flush the DNS.'
+        'Flush DNS between runs, works on Mac OS and Linux. Your user needs sudo rights to be able to flush the DNS.',
+      group: 'PageLoad'
     })
     .option('extension', {
       describe:
@@ -1243,7 +1261,8 @@ export function parseCommandLine() {
       describe:
         'Convenient parameter to use if you test a SPA application: will automatically wait for X seconds after last network activity and use hash in file names. Read more: https://www.sitespeed.io/documentation/sitespeed.io/spa/',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('cjs', {
       describe:
@@ -1255,7 +1274,8 @@ export function parseCommandLine() {
       type: 'number',
       default: 3,
       describe:
-        'If the browser fails to start, you can retry to start it this amount of times.'
+        'If the browser fails to start, you can retry to start it this amount of times.',
+      group: 'PageLoad'
     })
     .option('preWarmServer', {
       type: 'boolean',

package/lib/support/engineUtils.js

@@ -1,12 +1,17 @@
 import { resolve, dirname, join } from 'node:path';
 import { promisify } from 'node:util';
-import { writeFile as _writeFile, unlink as _unlink } from 'node:fs';
+import {
+  writeFile as _writeFile,
+  unlink as _unlink,
+  readFile as _readFile
+} from 'node:fs';
 import { pathToFileURL } from 'node:url';
 import dayjs from 'dayjs';
 import intel from 'intel';
 import { toArray } from '../support/util.js';
 const log = intel.getLogger('browsertime');
 const writeFile = promisify(_writeFile);
+const readFile = promisify(_readFile);
 const unlink = promisify(_unlink);
 
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
@@ -82,6 +87,13 @@ export async function loadPrePostScripts(scripts, options) {
   return readScripts;
 }
 
+export async function loadPageCompleteScript(script) {
+  if (script && script.endsWith('js')) {
+    return readFile(resolve(script), 'utf8');
+  }
+  return script;
+}
+
 export async function loadScript(script, options, throwError) {
   if (script) {
     return loadFile(script, options, throwError);

package/lib/support/statistics.js

@@ -10,6 +10,10 @@ function validateType(value, type, message) {
   }
 }
 
+function hasDecimals(num) {
+  return num !== Math.floor(num);
+}
+
 function percentileName(percentile) {
   if (percentile === 0) {
     return 'min';
@@ -129,7 +133,7 @@ export class Statistics {
         // https://en.wikipedia.org/wiki/Interquartile_range
         stats = stats.iqr();
       }
-      if (stats.median() < 1 && stats.median() > 0) {
+      if (stats.median() < 10 && stats.median() > 0) {
         decimals = 4;
       }
       const node = {
@@ -165,6 +169,12 @@ export class Statistics {
       }
       if (stats.median() < 1 && stats.median() > 0) {
         decimals = 4;
+      } else if (
+        hasDecimals(stats.median()) &&
+        stats.median() < 100 &&
+        stats.median() > 1
+      ) {
+        decimals = 2;
       }
       const results = {
         median: Number.parseFloat(stats.median().toFixed(decimals)),

package/lib/support/userTiming.js

@@ -1,5 +1,5 @@
-export function filterWhitelisted(userTimings, whitelistRegex) {
-  const allowed = new RegExp(whitelistRegex);
+export function filterAllowlisted(userTimings, allowlistRegex) {
+  const allowed = new RegExp(allowlistRegex);
   userTimings.marks = userTimings.marks.filter(mark => allowed.test(mark.name));
   userTimings.measures = userTimings.measures.filter(measure =>
     allowed.test(measure.name)

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "19.3.1",
+  "version": "21.0.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
+  "types": "./types/scripting.d.ts",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "3.2.5",
     "@sitespeed.io/chromedriver": "120.0.6099-71",
     "@sitespeed.io/edgedriver": "120.0.2210-77",
-    "@sitespeed.io/geckodriver": "0.33.0-c",
+    "@sitespeed.io/geckodriver": "0.34.0",
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
-    "ff-test-bidi-har-export": "0.0.12",
     "btoa": "1.2.1",
     "chrome-har": "0.13.2",
     "chrome-remote-interface": "0.33.0",
     "dayjs": "1.11.10",
     "execa": "8.0.1",
     "fast-stats": "0.0.6",
+    "ff-test-bidi-har-export": "0.0.12",
     "find-up": "7.0.0",
     "get-port": "7.0.0",
     "hasbin": "1.2.3",
@@ -36,14 +37,18 @@
     "jimp": "0.22.10"
   },
   "devDependencies": {
+    "@types/selenium-webdriver": "4.1.21",
     "ava": "6.0.1",
+    "clean-jsdoc-theme": "4.2.17",
     "eslint": "8.55.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-unicorn": "49.0.0",
+    "jsdoc": "4.0.2",
     "prettier": "3.1.1",
+    "serve": "14.2.1",
     "serve-handler": "6.1.5",
-    "serve": "14.2.1"
+    "typescript": "5.3.3"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -56,13 +61,14 @@
     "bin",
     "browserscripts",
     "browsersupport",
-    "visualmetrics",
+    "visualmetrics/visualmetrics-portable.py",
+    "visualmetrics/visualmetrics.py",
     "browsertime.png",
-    "docs",
     "index.js",
     "lib",
     "package.json",
-    "vendor"
+    "vendor",
+    "types"
   ],
   "exports": "./index.js",
   "scripts": {
@@ -70,7 +76,10 @@
     "start-server": "serve test/data/html/",
     "stop-server": "sudo pkill serve",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "tsc": "tsc",
+    "jsdoc": "jsdoc --configure jsdoc/jsdoc.json",
+    "prepublishOnly": "npm run lint && npm run tsc"
   },
   "author": "Peter Hedenskog",
   "contributors": [

package/types/android/index.d.ts

@@ -0,0 +1,70 @@
+export function isAndroidConfigured(options: any): boolean;
+export class Android {
+    constructor(options: any);
+    client: any;
+    id: any;
+    port: any;
+    screenBrightnessMode: number;
+    screenBrightness: number;
+    tmpDir: string;
+    _init(): Promise<void>;
+    device: any;
+    sdcard: any;
+    _runCommand(command: any): Promise<any>;
+    _runCommandAndGet(command: any): Promise<any>;
+    _runAsRootAndGet(command: any): Promise<any>;
+    _runAsRoot(command: any): Promise<boolean>;
+    _downloadFile(sourcePath: any, destinationPath: any): Promise<any>;
+    _downloadDir(sourcePath: any, destinationPath: any): Promise<void>;
+    getFullPathOnSdCard(path: any): string;
+    mkDirOnSdCard(dirName: any): Promise<any>;
+    removeFileOnSdCard(file: any): Promise<any>;
+    removePathOnSdCard(path: any): Promise<any>;
+    reboot(): Promise<any>;
+    getTemperature(): Promise<number>;
+    getMeta(): Promise<{
+        model: any;
+        name: any;
+        device: any;
+        androidVersion: any;
+        id: any;
+        wifi: any;
+    }>;
+    pullNetLog(destination: any): Promise<any>;
+    addDevtoolsFw(): Promise<any>;
+    removeDevtoolsFw(): Promise<({
+        all?: string;
+        isCanceled: boolean;
+    } & import("execa").ExecaReturnBase<string>)[]>;
+    startVideo(): Promise<any>;
+    ping(address: any): Promise<boolean>;
+    clickPowerButton(): Promise<any>;
+    getWifi(): Promise<any>;
+    closeAppNotRespondingPopup(): Promise<any>;
+    pressHomeButton(): Promise<any>;
+    stopVideo(): Promise<any>;
+    getPhoneState(): Promise<string>;
+    pullVideo(destinationPath: any): Promise<any>;
+    removeVideo(): Promise<any>;
+    pidof(packageName: any): Promise<any>;
+    _pidofWithPidof(packageName: any): Promise<number>;
+    _pidofWithPs(packageName: any): Promise<number>;
+    _processStartTime(pid: any): Promise<{
+        dateInMs: number;
+        systemUptimeInSeconds: any;
+        utilStartTimeAfterSystemStartTimeInJiffies: any;
+        processStartTimeAfterSystemStartTimeInJiffies: any;
+        jiffesPerSeconds: number;
+        processStartTimeInMs: number;
+    }>;
+    processStartTime(pid: any, count?: number): Promise<number>;
+    startPowerTesting(): Promise<void>;
+    stopPowerTesting(): Promise<void>;
+    resetPowerUsage(): Promise<void>;
+    measurePowerUsage(packageName: any): Promise<{
+        'full-screen': number;
+        'full-wifi': number;
+        total: number;
+    }>;
+}
+//# sourceMappingURL=index.d.ts.map

package/types/android/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/android/index.js"],"names":[],"mappings":"AAiiBA,2DAWC;AA/hBD;IACE,0BAwBC;IAfC,YAAgC;IAEhC,QAIC;IACD,UAAgC;IAGhC,6BAA6B;IAC7B,yBAA2B;IAC3B,eAAgC;IAKlC,uBAgBC;IALC,YAA4C;IAG1C,YAAoE;IAIxE,wCAEC;IAED,8CAIC;IAED,6CAIC;IAED,2CAUC;IAED,mEAYC;IAED,mEAcC;IAED,uCAEC;IAED,0CAGC;IAED,4CAMC;IAED,4CAMC;IAED,uBAGC;IAED,kCAOC;IAED;;;;;;;OAuBC;IAED,2CAKC;IAED,8BAKC;IAED;;;oDAuBC;IAED,2BAIC;IAED,qCAGC;IAED,iCAGC;IAED,wBASC;IAED,2CAOC;IAED,gCAEC;IAED,0BAIC;IAED,iCAGC;IAED,8CAIC;IAED,4BAEC;IAED,sCAYC;IAED,mDAsBC;IAED,gDA+CC;IAED;;;;;;;OAqDC;IAED,4DAQC;IAED,mCAcC;IAED,kCAQC;IAED,iCAIC;IAED;;;;OAGC;CACF"}

package/types/chrome/parseCpuTrace.d.ts

@@ -0,0 +1,21 @@
+export function parseCPUTrace(tracelog: any, url: any): Promise<{
+    categories: {
+        parseHTML: number;
+        styleLayout: number;
+        paintCompositeRender: number;
+        scriptParseCompile: number;
+        scriptEvaluation: number;
+        garbageCollection: number;
+        other: number;
+    };
+    events: {};
+    urls: {
+        url: string;
+        value: number;
+    }[];
+} | {
+    categories?: undefined;
+    events?: undefined;
+    urls?: undefined;
+}>;
+//# sourceMappingURL=parseCpuTrace.d.ts.map

package/types/chrome/parseCpuTrace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseCpuTrace.d.ts","sourceRoot":"","sources":["../../lib/chrome/parseCpuTrace.js"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;;GA4EC"}

package/types/chrome/traceCategoriesParser.d.ts

@@ -0,0 +1,2 @@
+export function parse(events: any, url: any): any;
+//# sourceMappingURL=traceCategoriesParser.d.ts.map

package/types/chrome/traceCategoriesParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traceCategoriesParser.d.ts","sourceRoot":"","sources":["../../lib/chrome/traceCategoriesParser.js"],"names":[],"mappings":"AA2JA,kDAQC"}

package/types/chrome/webdriver/traceUtilities.d.ts

@@ -0,0 +1,8 @@
+export function getRenderBlocking(trace: any): Promise<{
+    renderBlockingInfo: {};
+    renderBlocking: {
+        recalculateStyle: {};
+        requests: {};
+    };
+}>;
+//# sourceMappingURL=traceUtilities.d.ts.map

package/types/chrome/webdriver/traceUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traceUtilities.d.ts","sourceRoot":"","sources":["../../../lib/chrome/webdriver/traceUtilities.js"],"names":[],"mappings":"AA8DA;;;;;;GAoCC"}

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

@@ -0,0 +1,73 @@
+/**
+ * This class provides an abstraction layer for Selenium's action sequence functionality.
+ * It allows for easy interaction with web elements using different locating strategies
+ * and simulating complex user gestures like mouse movements, key presses, etc.
+ *
+ * @class
+ * @hideconstructor
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/
+ */
+export class Action {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * @private
+     */
+    private actions;
+    clear(): Promise<any>;
+    /**
+     * Retrieves the current action sequence builder.
+     * The actions builder can be used to chain multiple browser actions.
+     * @returns {SeleniumActions} The current Selenium Actions builder object for chaining browser actions.
+     *  @example
+     * // Example of using the actions builder to perform a drag-and-drop operation:
+     * const elementToDrag = await commands.action.getElementByCss('.draggable');
+     * const dropTarget = await commands.action.getElementByCss('.drop-target');
+     * await commands.action.getAction()
+     *   .dragAndDrop(elementToDrag, dropTarget)
+     *   .perform();
+     *
+     */
+    getAction(): SeleniumActions;
+    /**
+     * 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.
+     */
+    getElementByCss(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.
+     */
+    getElementById(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.
+     */
+    getElementByXpath(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.
+     */
+    getElementByClassName(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.
+     */
+    getElementByName(name: string): Promise<WebElement>;
+}
+import { Actions as SeleniumActions } from 'selenium-webdriver';
+import { WebElement } from 'selenium-webdriver';
+//# sourceMappingURL=action.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/action.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH;IACE,0BASC;IARC;;OAEG;IACH,eAAiC;IACjC;;OAEG;IACH,gBAAmD;IASrD,sBAEC;IAED;;;;;;;;;;;;OAYG;IACH,aAVa,eAAe,CAY3B;IAED;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,mBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,yBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,iCAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;IAED;;;;;OAKG;IACH,uBAHW,MAAM,GACJ,QAAQ,UAAU,CAAC,CAI/B;CACF;2CAnG0D,oBAAoB;2BAApB,oBAAoB"}

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

@@ -0,0 +1,38 @@
+/**
+ * This class provides an abstraction layer for Selenium's action sequence functionality.
+ * It allows for easy interaction with web elements using different locating strategies
+ * and simulating complex user gestures like mouse movements, key presses, etc.
+ *
+ * @class
+ * @hideconstructor
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/
+ * @see https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/lib/input_exports_Actions.html
+ */
+export class Actions {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private driver;
+    /**
+     * @private
+     */
+    private actions;
+    clear(): Promise<any>;
+    /**
+     * Retrieves the current action sequence builder.
+     * The actions builder can be used to chain multiple browser actions.
+     * @returns {SeleniumActions} The current Selenium Actions builder object for chaining browser actions.
+     *  @example
+     * // Example of using the actions builder to perform a drag-and-drop operation:
+     * const elementToDrag = await commands.action.getElementByCss('.draggable');
+     * const dropTarget = await commands.action.getElementByCss('.drop-target');
+     * await commands.action.getAction()
+     *   .dragAndDrop(elementToDrag, dropTarget)
+     *   .perform();
+     *
+     */
+    getActions(): SeleniumActions;
+}
+import { Actions as SeleniumActions } from 'selenium-webdriver/lib/input.js';
+//# sourceMappingURL=actions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/actions.js"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH;IACE,0BASC;IARC;;OAEG;IACH,eAAiC;IACjC;;OAEG;IACH,gBAAmD;IASrD,sBAEC;IAED;;;;;;;;;;;;OAYG;IACH,cAVa,eAAe,CAY3B;CACF;2CAjD0C,iCAAiC"}

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

@@ -0,0 +1,68 @@
+/**
+ * Provides functionality to add text to elements on a web page using various selectors.
+ * @class
+ * @hideconstructor
+ */
+export class AddText {
+    constructor(browser: any);
+    /**
+     * @private
+     */
+    private browser;
+    /**
+     * Adds text to an element identified by its ID.
+     *
+     * @async
+     * @example commands.addText.byId('mytext', 'id');
+     * @param {string} text - The text string to add.
+     * @param {string} id - The ID of the element.
+     * @returns {Promise<void>} A promise that resolves when the text has been added.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byId(text: string, id: string): Promise<void>;
+    /**
+     * Adds text to an element identified by its XPath.
+     *
+     * @async
+     * @example commands.addText.byXpath('mytext', 'xpath');
+     * @param {string} text - The text string to add.
+     * @param {string} xpath - The XPath of the element.
+     * @returns {Promise<void>} A promise that resolves when the text has been added.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byXpath(text: string, xpath: string): Promise<void>;
+    /**
+     * Adds text to an element identified by its CSS selector.
+     *
+     * @async
+     * @example commands.addText.bySelector('mytext', 'selector');
+     * @param {string} text - The text string to add.
+     * @param {string} selector - The CSS selector of the element.
+     * @returns {Promise<void>} A promise that resolves when the text has been added.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    bySelector(text: string, selector: string): Promise<void>;
+    /**
+     * Adds text to an element identified by its class name.
+     *
+     * @async
+     * @example commands.addText.byClassName('mytext', 'className');
+     * @param {string} text - The text string to add.
+     * @param {string} className - The class name of the element.
+     * @returns {Promise<void>} A promise that resolves when the text has been added.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byClassName(text: string, className: string): Promise<void>;
+    /**
+     * Adds text to an element identified by its name attribute.
+     *
+     * @async
+     * @example commands.addText.byName('mytext', 'name');
+     * @param {string} text - The text string to add.
+     * @param {string} name - The name attribute of the element.
+     * @returns {Promise<void>} A promise that resolves when the text has been added.
+     * @throws {Error} Throws an error if the element is not found.
+     */
+    byName(text: string, name: string): Promise<void>;
+}
+//# sourceMappingURL=addText.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addText.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/addText.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH;IACE,0BAKC;IAJC;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;;;OASG;IACH,WALW,MAAM,MACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;;OASG;IACH,cALW,MAAM,SACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;;OASG;IACH,iBALW,MAAM,YACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;;OASG;IACH,kBALW,MAAM,aACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;;OASG;IACH,aALW,MAAM,QACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;CACF"}

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

@@ -0,0 +1,39 @@
+/**
+ * Provides functionality to interact with an Android device through shell commands.
+ * @class
+ * @see https://www.sitespeed.io/documentation/sitespeed.io/mobile-phones/#test-on-android
+ * @hideconstructor
+ */
+export class AndroidCommand {
+    constructor(options: any);
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * Runs a shell command on the connected Android device.
+     * This method requires the Android device to be properly configured.
+     *
+     * @async
+     * @example await commands.android.shell('');
+     * @param {string} command - The shell command to run on the Android device.
+     * @returns {Promise<string>} A promise that resolves with the result of the command or rejects if there's an error.
+     * @throws {Error} Throws an error if Android is not configured or if the command fails.
+     */
+    shell(command: string): Promise<string>;
+    a: Android;
+    /**
+     * Runs a shell command on the connected Android device as the root user.
+     * This method requires the Android device to be properly configured and that you
+     * rooted the device.
+     *
+     * @async
+     * @example await commands.android.shellAsRoot('');
+     * @param {string} command - The shell command to run on the Android device as root.
+     * @returns {Promise<string>} A promise that resolves with the result of the command or rejects if there's an error.
+     * @throws {Error} Throws an error if Android is not configured or if the command fails.
+     */
+    shellAsRoot(command: string): Promise<string>;
+}
+import { Android } from '../../../android/index.js';
+//# sourceMappingURL=android.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"android.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/android.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IACE,0BAKC;IAJC;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;;;OASG;IACH,eAJW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAc3B;IAPK,WAAkC;IASxC;;;;;;;;;;OAUG;IACH,qBAJW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAgB3B;CACF;wBAhE4C,2BAA2B"}