@wdio/browserstack-service 0.0.0-canary-20260722132416

package/LICENSE-MIT

@@ -0,0 +1,20 @@
+Copyright (c) OpenJS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,392 @@
+WebdriverIO BrowserStack Service
+==========
+
+> A WebdriverIO service that manages local tunnel and job metadata for BrowserStack users.
+
+## Installation
+
+
+The easiest way is to keep `@wdio/browserstack-service` as a devDependency in your `package.json`, via:
+
+```sh
+npm install @wdio/browserstack-service --save-dev
+```
+
+Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted)
+
+
+## Configuration
+
+WebdriverIO has BrowserStack support out of the box. You should set `user` and `key` in your `wdio.conf.js` file. This service plugin provides support for [BrowserStack Tunnel](https://www.browserstack.com/docs/automate/selenium/getting-started/nodejs/local-testing). Set `browserstackLocal: true` also to activate this feature.
+Reporting of session status on BrowserStack will respect `strict` setting of Cucumber options.
+
+```js
+// wdio.conf.js
+export const config = {
+    // ...
+    user: process.env.BROWSERSTACK_USERNAME,
+    key: process.env.BROWSERSTACK_ACCESS_KEY,
+    services: [
+        ['browserstack', {
+            testReporting: true,
+            testReportingOptions: {
+                projectName: "Your project name goes here",
+                buildName: "The static build job name goes here e.g. Nightly regression"
+            },
+            browserstackLocal: true
+        }]
+    ],
+    // ...
+};
+```
+
+## Options
+
+In order to authorize to the BrowserStack service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
+
+### testReporting (formerly testObservability)
+
+Test Reporting and Analytics is an advanced test reporting tool that gives insights to improve your automation tests and helps you debug faster. It's enabled by default by setting the testReporting flag as true for all users of browserstack-service. You can disable this by setting the testReporting flag to false.
+
+Once your tests finish running, you can visit [Test Reporting and Analytics](https://automation.browserstack.com/?utm_source=webdriverio&utm_medium=partnered&utm_campaign=documentation) to debug your builds with additional insights like Unique Error Analysis, Automatic Flaky Test Detection, and more.
+
+You can use Test Reporting and Analytics even if you don't run your tests on the BrowserStack infrastructure. Even if you run your tests on a CI, a local machine, or even on other cloud service providers, Test Reporting and Analytics can still generate intelligent test reports and advanced analytics on your tests.
+
+If you want to use Test Reporting and Analytics without running your tests on BrowserStack infrastructure, you can set your config as follows:
+
+```js
+// wdio.conf.js
+export const config = {
+    // ...
+    services: [
+        ['browserstack', {
+            testReporting: true,
+            testReportingOptions: {
+                user: process.env.BROWSERSTACK_USERNAME,
+                key: process.env.BROWSERSTACK_ACCESS_KEY,
+                projectName: "Your project name goes here",
+                buildName: "The static build job name goes here e.g. Nightly regression"
+            }
+        }]
+    ],
+    // ...
+};
+```
+
+For backward compatibility, the legacy `testObservability` and `testObservabilityOptions` flags are still supported:
+
+```js
+// wdio.conf.js (legacy configuration)
+export const config = {
+    // ...
+    services: [
+        ['browserstack', {
+            testObservability: true, // deprecated, use testReporting instead
+            testObservabilityOptions: { // deprecated, use testReportingOptions instead
+                user: process.env.BROWSERSTACK_USERNAME,
+                key: process.env.BROWSERSTACK_ACCESS_KEY,
+                projectName: "Your project name goes here",
+                buildName: "The static build job name goes here e.g. Nightly regression"
+            }
+        }]
+    ],
+    // ...
+};
+```
+
+#### Environment Variables
+
+The following environment variables are supported:
+
+**New (recommended):**
+- `BROWSERSTACK_TEST_REPORTING` - Enable/disable test reporting
+- `BROWSERSTACK_TEST_REPORTING_DEBUG` - Enable debug mode for test reporting  
+- `TEST_REPORTING_BUILD_TAG` - Comma-separated build tags
+
+**Legacy (still supported):**
+- `BROWSERSTACK_OBSERVABILITY` - Enable/disable test observability (deprecated)
+- `TEST_OBSERVABILITY_BUILD_TAG` - Comma-separated build tags (deprecated)
+
+You can explore all the features of Test Reporting and Analytics in [this sandbox](https://automation-demo.browserstack.com/?utm_source=webdriverio&utm_medium=partnered&utm_campaign=documentation) or read more about it [here](https://www.browserstack.com/docs/test-reporting/overview/what-is-test-reporting?utm_source=webdriverio&utm_medium=partnered&utm_campaign=documentation).
+
+### browserstackLocal
+Set this to true to enable routing connections from BrowserStack cloud through your computer.
+
+Type: `Boolean`<br />
+Default: `false`
+
+### forcedStop
+Set this to true to kill the BrowserStack Local process on complete, without waiting for the BrowserStack Local stop callback to be called. This is experimental and should not be used by all. Mostly necessary as a workaround for [this issue](https://github.com/browserstack/browserstack-local-nodejs/issues/41).
+
+Type: `Boolean`<br />
+Default: `false`
+
+### app
+
+[Appium](https://appium.io/) set this with the app file path available locally on your machine to use the app as [application under test](https://www.browserstack.com/docs/app-automate/appium/set-up-tests/specify-app) for Appium sessions.
+
+Type: `String` or `JsonObject`<br />
+Default: `undefined`
+
+List of available app values:
+
+#### path
+Use locally available app file path as an application under test for Appium.
+
+```js
+services: [
+  ['browserstack', {
+    app: '/path/to/local/app.apk'
+    // OR
+    app: {
+      path: '/path/to/local/app.apk'
+    }
+  }]
+]
+```
+
+Pass custom_id while the app upload.
+
+```js
+services: [
+  ['browserstack', {
+    app: {
+      path: '/path/to/local/app.apk',
+      custom_id: 'custom_id'
+    }
+  }]
+]
+```
+
+#### id
+Use the app URL returned after uploading the app to BrowserStack.
+
+```js
+services: [
+  ['browserstack', {
+    app: 'bs://<app-id>'
+    // OR
+    app: {
+      id: 'bs://<app-id>'
+    }
+  }]
+]
+```
+
+#### custom_id
+
+use custom_id of already uploaded apps
+
+```js
+services: [
+  ['browserstack', {
+    app: 'custom_id'
+    // OR
+    app: {
+      custom_id: 'custom_id'
+    }
+  }]
+]
+```
+
+#### shareable_id
+
+use shareable_id of already uploaded apps
+
+```js
+services: [
+  ['browserstack', {
+    app: 'username/custom_id'
+    // OR
+    app: {
+      shareable_id: 'username/custom_id'
+    }
+  }]
+]
+```
+
+### preferScenarioName
+
+Cucumber only. Set the BrowserStack Automate session name to the Scenario name if only a single Scenario ran.
+Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+
+Type: `Boolean`<br />
+Default: `false`
+
+### sessionNameFormat
+
+Customize the BrowserStack Automate session name format.
+
+Type: `Function`<br />
+Default (Cucumber/Jasmine): `(config, capabilities, suiteTitle) => suiteTitle`<br />
+Default (Mocha): `(config, capabilities, suiteTitle, testTitle) => suiteTitle + ' - ' + testTitle`
+
+### sessionNameOmitTestTitle
+
+Mocha only. Do not append the test title to the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `false`
+
+### sessionNamePrependTopLevelSuiteTitle
+
+Mocha only. Prepend the top level suite title to the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `false`
+
+### setSessionName
+
+Automatically set the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `true`
+
+### setSessionStatus
+
+Automatically set the BrowserStack Automate session status (passed/failed).
+
+Type: `Boolean`<br />
+Default: `true`
+
+### buildIdentifier
+
+**buildIdentifier** is a unique id to differentiate every execution that gets appended to buildName. Choose your buildIdentifier format from the available expressions:
+* `BUILD_NUMBER`: Generates an incremental counter with every execution
+* `DATE_TIME`: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+
+```js
+services: [
+  ['browserstack', {
+    buildIdentifier: '#${BUILD_NUMBER}'
+  }]
+]
+```
+Build Identifier supports usage of either or both expressions along with any other characters enabling custom formatting options.
+
+### opts
+
+BrowserStack Local options.
+
+Type: `Object`<br />
+Default: `{}`
+
+List of available local testing modifiers to be passed as opts:
+
+#### Local Identifier
+
+If doing simultaneous multiple local testing connections, set this uniquely for different processes -
+
+```js
+opts = { localIdentifier: "randomstring" };
+```
+
+#### Verbose Logging
+
+To enable verbose logging -
+
+```js
+opts = { verbose: "true" };
+```
+
+Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
+
+#### Force Local
+
+To route all traffic via local(your) machine -
+
+```js
+opts = { forceLocal: "true" };
+```
+
+#### Folder Testing
+
+To test local folder rather internal server, provide path to folder as value of this option -
+
+```js
+opts = { f: "/my/awesome/folder" };
+```
+
+#### Force Start
+
+To kill other running BrowserStack Local instances -
+
+```js
+opts = { force: "true" };
+```
+
+#### Only Automate
+
+To disable local testing for Live and Screenshots, and enable only Automate -
+
+```js
+opts = { onlyAutomate: "true" };
+```
+
+#### Proxy
+
+To use a proxy for local testing -
+
+- proxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+- proxyPort: Port for the proxy, defaults to 3128 when -proxyHost is used
+- proxyUser: Username for connecting to proxy (Basic Auth Only)
+- proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+
+```js
+opts = {
+  proxyHost: "127.0.0.1",
+  proxyPort: "8000",
+  proxyUser: "user",
+  proxyPass: "password",
+};
+```
+
+#### Local Proxy
+
+To use local proxy in local testing -
+
+- localProxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+- localProxyPort: Port for the proxy, defaults to 8081 when -localProxyHost is used
+- localProxyUser: Username for connecting to proxy (Basic Auth Only)
+- localProxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+
+```js
+opts = {
+  localProxyHost: "127.0.0.1",
+  localProxyPort: "8000",
+  localProxyUser: "user",
+  localProxyPass: "password",
+};
+```
+
+#### PAC (Proxy Auto-Configuration)
+
+To use PAC (Proxy Auto-Configuration) in local testing -
+
+- pac-file: PAC (Proxy Auto-Configuration) file’s absolute path
+
+```js
+opts = { "pac-file": "<pac_file_abs_path>" };
+```
+
+#### Binary Path
+
+By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
+Path to specify local Binary path -
+
+```js
+opts = { binarypath: "/path/to/binary" };
+```
+
+#### Logfile
+
+To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
+To specify the path to file where the logs will be saved -
+
+```js
+opts = { verbose: "true", logFile: "./local.log" };
+```
+
+----
+
+For more information on WebdriverIO see the [homepage](https://webdriver.io).

package/browserstack-service.d.ts

@@ -0,0 +1,43 @@
+declare module WebdriverIO {
+    interface ServiceOption extends BrowserstackConfig {}
+
+    interface Suite {
+        title: string;
+        fullName: string;
+        file: string;
+    }
+
+    interface Test extends Suite {
+        parent: string;
+        passed: boolean;
+    }
+
+    interface TestResult {
+        exception: string;
+        status: string;
+    }
+}
+
+interface BrowserstackConfig {
+    /**
+     * Set this to true to enable routing connections from Browserstack cloud through your computer.
+     * You will also need to set `browserstack.local` to true in browser capabilities.
+     */
+    browserstackLocal?: boolean;
+    /**
+     * Cucumber only. Set this to true to enable updating the session name to the Scenario name if only
+     * a single Scenario was ran. Useful when running in parallel
+     * with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+     */
+    preferScenarioName?: boolean;
+    /**
+     * Set this to true to kill the browserstack process on complete, without waiting for the
+     * browserstack stop callback to be called. This is experimental and should not be used by all.
+     */
+    forcedStop?: boolean;
+    /**
+     * Specified optional will be passed down to BrowserstackLocal. See this list for details:
+     * https://stackoverflow.com/questions/39040108/import-class-in-definition-file-d-ts
+     */
+    opts?: Partial<import('browserstack-local').Options>
+}

package/build/Percy/Percy-Handler.d.ts

@@ -0,0 +1,32 @@
+import type { Capabilities } from '@wdio/types';
+import type { BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
+declare class _PercyHandler {
+    private _percyAutoCaptureMode;
+    private _browser;
+    private _capabilities;
+    private _isAppAutomate?;
+    private _framework?;
+    private _testMetadata;
+    private _sessionName?;
+    private _isPercyCleanupProcessingUnderway?;
+    private _percyScreenshotCounter;
+    private _percyDeferredScreenshots;
+    private _percyScreenshotInterval;
+    private _percyCaptureMap?;
+    constructor(_percyAutoCaptureMode: string | undefined, _browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, _capabilities: Capabilities.RemoteCapability, _isAppAutomate?: boolean | undefined, _framework?: string | undefined);
+    _setSessionName(name: string): void;
+    teardown(): Promise<void>;
+    percyAutoCapture(eventName: string | null, sessionName: string | null): Promise<void>;
+    before(): Promise<void>;
+    deferCapture(sessionName: string, eventName: string | null): void;
+    isDOMChangingCommand(args: BeforeCommandArgs): boolean;
+    cleanupDeferredScreenshots(): Promise<void>;
+    browserBeforeCommand(args: BeforeCommandArgs): Promise<void>;
+    browserAfterCommand(args: BeforeCommandArgs & AfterCommandArgs): Promise<void>;
+    afterTest(): Promise<void>;
+    afterScenario(): Promise<void>;
+}
+declare const PercyHandler: typeof _PercyHandler;
+type PercyHandler = _PercyHandler;
+export default PercyHandler;
+//# sourceMappingURL=Percy-Handler.d.ts.map

package/build/Percy/Percy-Handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Percy-Handler.d.ts","sourceRoot":"","sources":["../../src/Percy/Percy-Handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAezE,cAAM,aAAa;IAUX,OAAO,CAAC,qBAAqB;IAC7B,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,cAAc,CAAC;IACvB,OAAO,CAAC,UAAU,CAAC;IAbvB,OAAO,CAAC,aAAa,CAA6B;IAClD,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,iCAAiC,CAAC,CAAiB;IAC3D,OAAO,CAAC,uBAAuB,CAAS;IACxC,OAAO,CAAC,yBAAyB,CAAU;IAC3C,OAAO,CAAC,wBAAwB,CAAY;IAC5C,OAAO,CAAC,gBAAgB,CAAC,CAAiB;gBAG9B,qBAAqB,EAAE,MAAM,GAAG,SAAS,EACzC,QAAQ,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAC9D,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,cAAc,CAAC,EAAE,OAAO,YAAA,EACxB,UAAU,CAAC,EAAE,MAAM,YAAA;IAO/B,eAAe,CAAC,IAAI,EAAE,MAAM;IAItB,QAAQ;IAUR,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAyBrE,MAAM;IAIZ,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAM1D,oBAAoB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO;IA+BhD,0BAA0B;IAS1B,oBAAoB,CAAE,IAAI,EAAE,iBAAiB;IAoB7C,mBAAmB,CAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB;IA0B/D,SAAS;IAMT,aAAa;CAKtB;AAGD,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AAEjC,eAAe,YAAY,CAAA"}

package/build/Percy/Percy-Handler.js

@@ -0,0 +1,165 @@
+import { o11yClassErrorHandler, sleep } from '../util.js';
+import PercyCaptureMap from './PercyCaptureMap.js';
+import * as PercySDK from './PercySDK.js';
+import { PercyLogger } from './PercyLogger.js';
+import { PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS, CAPTURE_MODES } from '../constants.js';
+import PerformanceTester from '../instrumentation/performance/performance-tester.js';
+import * as PERFORMANCE_SDK_EVENTS from '../instrumentation/performance/constants.js';
+class _PercyHandler {
+    _percyAutoCaptureMode;
+    _browser;
+    _capabilities;
+    _isAppAutomate;
+    _framework;
+    _testMetadata = {};
+    _sessionName;
+    _isPercyCleanupProcessingUnderway = false;
+    _percyScreenshotCounter = 0;
+    _percyDeferredScreenshots = [];
+    _percyScreenshotInterval = null;
+    _percyCaptureMap;
+    constructor(_percyAutoCaptureMode, _browser, _capabilities, _isAppAutomate, _framework) {
+        this._percyAutoCaptureMode = _percyAutoCaptureMode;
+        this._browser = _browser;
+        this._capabilities = _capabilities;
+        this._isAppAutomate = _isAppAutomate;
+        this._framework = _framework;
+        if (!_percyAutoCaptureMode || !CAPTURE_MODES.includes(_percyAutoCaptureMode)) {
+            this._percyAutoCaptureMode = 'auto';
+        }
+    }
+    _setSessionName(name) {
+        this._sessionName = name;
+    }
+    async teardown() {
+        await new Promise((resolve) => {
+            setInterval(() => {
+                if (this._percyScreenshotCounter === 0) {
+                    resolve();
+                }
+            }, 1000);
+        });
+    }
+    async percyAutoCapture(eventName, sessionName) {
+        PerformanceTester.start(PERFORMANCE_SDK_EVENTS.PERCY_EVENTS.AUTO_CAPTURE);
+        try {
+            if (eventName) {
+                if (!sessionName) {
+                    /* Service doesn't wait for handling of browser commands so the below counter is used in teardown method to delay service exit */
+                    this._percyScreenshotCounter += 1;
+                }
+                this._percyCaptureMap?.increment(sessionName ? sessionName : this._sessionName, eventName);
+                const performanceEventName = this._isAppAutomate ? PERFORMANCE_SDK_EVENTS.PERCY_EVENTS.SCREENSHOT_APP : PERFORMANCE_SDK_EVENTS.PERCY_EVENTS.SCREENSHOT;
+                await PerformanceTester.measureWrapper(performanceEventName, async () => {
+                    await (this._isAppAutomate ? PercySDK.screenshotApp(this._percyCaptureMap?.getName(sessionName ? sessionName : this._sessionName, eventName)) : await PercySDK.screenshot(this._browser, this._percyCaptureMap?.getName(sessionName ? sessionName : this._sessionName, eventName)));
+                })();
+                this._percyScreenshotCounter -= 1;
+            }
+        }
+        catch (err) {
+            this._percyScreenshotCounter -= 1;
+            this._percyCaptureMap?.decrement(sessionName ? sessionName : this._sessionName, eventName);
+            PerformanceTester.end(PERFORMANCE_SDK_EVENTS.PERCY_EVENTS.AUTO_CAPTURE, false, err, { eventName, sessionName });
+            PercyLogger.error(`Error while trying to auto capture Percy screenshot ${err}`);
+        }
+        PerformanceTester.end(PERFORMANCE_SDK_EVENTS.PERCY_EVENTS.AUTO_CAPTURE, true, null, { eventName, sessionName });
+    }
+    async before() {
+        this._percyCaptureMap = new PercyCaptureMap();
+    }
+    deferCapture(sessionName, eventName) {
+        /* Service doesn't wait for handling of browser commands so the below counter is used in teardown method to delay service exit */
+        this._percyScreenshotCounter += 1;
+        this._percyDeferredScreenshots.push({ sessionName, eventName });
+    }
+    isDOMChangingCommand(args) {
+        /*
+          Percy screenshots which are to be taken on events such as send keys, element click & screenshot are deferred until
+          another DOM changing command is seen such that any DOM processing post the previous command is completed
+        */
+        return (typeof args.method === 'string' && typeof args.endpoint === 'string' &&
+            ((args.method === 'POST' &&
+                (PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS.includes(args.endpoint) ||
+                    (
+                    /* click / clear element */
+                    args.endpoint.includes('/session/:sessionId/element') &&
+                        (args.endpoint.includes('click') ||
+                            args.endpoint.includes('clear'))) ||
+                    /* execute script sync / async */
+                    (args.endpoint.includes('/session/:sessionId/execute') && args.body?.script) ||
+                    /* Touch action for Appium */
+                    (args.endpoint.includes('/session/:sessionId/touch')))) ||
+                (args.method === 'DELETE' && args.endpoint === '/session/:sessionId')));
+    }
+    async cleanupDeferredScreenshots() {
+        this._isPercyCleanupProcessingUnderway = true;
+        for (const entry of this._percyDeferredScreenshots) {
+            await this.percyAutoCapture(entry.eventName, entry.sessionName);
+        }
+        this._percyDeferredScreenshots = [];
+        this._isPercyCleanupProcessingUnderway = false;
+    }
+    async browserBeforeCommand(args) {
+        try {
+            if (!this.isDOMChangingCommand(args)) {
+                return;
+            }
+            do {
+                await sleep(1000);
+            } while (this._percyScreenshotInterval);
+            this._percyScreenshotInterval = setInterval(async () => {
+                if (!this._isPercyCleanupProcessingUnderway) {
+                    clearInterval(this._percyScreenshotInterval);
+                    await this.cleanupDeferredScreenshots();
+                    this._percyScreenshotInterval = null;
+                }
+            }, 1000);
+        }
+        catch (err) {
+            PercyLogger.error(`Error while trying to cleanup deferred screenshots ${err}`);
+        }
+    }
+    async browserAfterCommand(args) {
+        try {
+            if (!args.endpoint || !this._percyAutoCaptureMode) {
+                return;
+            }
+            let eventName = null;
+            const endpoint = args.endpoint;
+            if (endpoint.includes('click') && ['click', 'auto'].includes(this._percyAutoCaptureMode)) {
+                eventName = 'click';
+            }
+            else if (endpoint.includes('screenshot') && ['screenshot', 'auto'].includes(this._percyAutoCaptureMode)) {
+                eventName = 'screenshot';
+            }
+            else if (endpoint.includes('actions') && ['auto'].includes(this._percyAutoCaptureMode)) {
+                if (args.body && args.body.actions && Array.isArray(args.body.actions) && args.body.actions.length && args.body.actions[0].type === 'key') {
+                    eventName = 'keys';
+                }
+            }
+            else if (endpoint.includes('/session/:sessionId/element') && endpoint.includes('value') && ['auto'].includes(this._percyAutoCaptureMode)) {
+                eventName = 'keys';
+            }
+            if (eventName) {
+                this.deferCapture(this._sessionName, eventName);
+            }
+        }
+        catch (err) {
+            PercyLogger.error(`Error while trying to calculate auto capture parameters ${err}`);
+        }
+    }
+    async afterTest() {
+        if (this._percyAutoCaptureMode && this._percyAutoCaptureMode === 'testcase') {
+            await this.percyAutoCapture('testcase', null);
+        }
+    }
+    async afterScenario() {
+        if (this._percyAutoCaptureMode && this._percyAutoCaptureMode === 'testcase') {
+            await this.percyAutoCapture('testcase', null);
+        }
+    }
+}
+// https://github.com/microsoft/TypeScript/issues/6543
+const PercyHandler = o11yClassErrorHandler(_PercyHandler);
+export default PercyHandler;
+//# sourceMappingURL=Percy-Handler.js.map

package/build/Percy/Percy-Handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Percy-Handler.js","sourceRoot":"","sources":["../../src/Percy/Percy-Handler.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,qBAAqB,EACrB,KAAK,EACR,MAAM,YAAY,CAAA;AACnB,OAAO,eAAe,MAAM,sBAAsB,CAAA;AAElD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,OAAO,EAAE,qCAAqC,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACtF,OAAO,iBAAiB,MAAM,sDAAsD,CAAA;AACpF,OAAO,KAAK,sBAAsB,MAAM,6CAA6C,CAAA;AAErF,MAAM,aAAa;IAUH;IACA;IACA;IACA;IACA;IAbJ,aAAa,GAA2B,EAAE,CAAA;IAC1C,YAAY,CAAS;IACrB,iCAAiC,GAAa,KAAK,CAAA;IACnD,uBAAuB,GAAQ,CAAC,CAAA;IAChC,yBAAyB,GAAQ,EAAE,CAAA;IACnC,wBAAwB,GAAQ,IAAI,CAAA;IACpC,gBAAgB,CAAkB;IAE1C,YACY,qBAAyC,EACzC,QAA8D,EAC9D,aAA4C,EAC5C,cAAwB,EACxB,UAAmB;QAJnB,0BAAqB,GAArB,qBAAqB,CAAoB;QACzC,aAAQ,GAAR,QAAQ,CAAsD;QAC9D,kBAAa,GAAb,aAAa,CAA+B;QAC5C,mBAAc,GAAd,cAAc,CAAU;QACxB,eAAU,GAAV,UAAU,CAAS;QAE3B,IAAI,CAAC,qBAAqB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,qBAA+B,CAAC,EAAE,CAAC;YACrF,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAA;QACvC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,IAAY;QACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAChC,WAAW,CAAC,GAAG,EAAE;gBACb,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;oBACrC,OAAO,EAAE,CAAA;gBACb,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,CAAA;QACZ,CAAC,CAAC,CAAA;IACN,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,SAAwB,EAAE,WAA0B;QACvE,iBAAiB,CAAC,KAAK,CAAC,sBAAsB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,WAAW,EAAE,CAAC;oBACf,iIAAiI;oBACjI,IAAI,CAAC,uBAAuB,IAAI,CAAC,CAAA;gBACrC,CAAC;gBAED,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,YAAuB,EAAE,SAAS,CAAC,CAAA;gBACtG,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,UAAU,CAAA;gBACtJ,MAAM,iBAAiB,CAAC,cAAc,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;oBACpE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,YAAuB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,YAAuB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;gBACjT,CAAC,CAAC,EAAE,CAAA;gBACJ,IAAI,CAAC,uBAAuB,IAAI,CAAC,CAAA;YACrC,CAAC;QACL,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,uBAAuB,IAAI,CAAC,CAAA;YACjC,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,YAAuB,EAAE,SAAmB,CAAC,CAAA;YAChH,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CAAC,YAAY,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAA;YAC/G,WAAW,CAAC,KAAK,CAAC,uDAAuD,GAAG,EAAE,CAAC,CAAA;QACnF,CAAC;QACD,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAA;IACnH,CAAC;IAED,KAAK,CAAC,MAAM;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAA;IACjD,CAAC;IAED,YAAY,CAAC,WAAmB,EAAE,SAAwB;QACtD,iIAAiI;QACjI,IAAI,CAAC,uBAAuB,IAAI,CAAC,CAAA;QACjC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,oBAAoB,CAAC,IAAuB;QACxC;;;UAGE;QACF,OAAO,CACH,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;YACpE,CACI,CACI,IAAI,CAAC,MAAM,KAAK,MAAM;gBACtB,CACI,qCAAqC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAC7D;oBACI,2BAA2B;oBAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,6BAA6B,CAAC;wBACrD,CACI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;4BAC/B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAClC,CACJ;oBACD,iCAAiC;oBACjC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,6BAA6B,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;oBAC5E,6BAA6B;oBAC7B,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CACxD,CACJ;gBACD,CAAE,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,qBAAqB,CAAE,CAC1E,CACJ,CAAA;IACL,CAAC;IAED,KAAK,CAAC,0BAA0B;QAC5B,IAAI,CAAC,iCAAiC,GAAG,IAAI,CAAA;QAC7C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACjD,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;QACnE,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAA;QACnC,IAAI,CAAC,iCAAiC,GAAG,KAAK,CAAA;IAClD,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAE,IAAuB;QAC/C,IAAI,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,OAAM;YACV,CAAC;YACD,GAAG,CAAC;gBACA,MAAM,KAAK,CAAC,IAAI,CAAC,CAAA;YACrB,CAAC,QAAQ,IAAI,CAAC,wBAAwB,EAAC;YACvC,IAAI,CAAC,wBAAwB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;gBACnD,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE,CAAC;oBAC1C,aAAa,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAA;oBAC5C,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAA;oBACvC,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAA;gBACxC,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,CAAA;QACZ,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,WAAW,CAAC,KAAK,CAAC,sDAAsD,GAAG,EAAE,CAAC,CAAA;QAClF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAE,IAA0C;QACjE,IAAI,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAChD,OAAM;YACV,CAAC;YACD,IAAI,SAAS,GAAG,IAAI,CAAA;YACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAkB,CAAA;YACxC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAA+B,CAAC,EAAE,CAAC;gBACjG,SAAS,GAAG,OAAO,CAAA;YACvB,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAA+B,CAAC,EAAE,CAAC;gBAClH,SAAS,GAAG,YAAY,CAAA;YAC5B,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAA+B,CAAC,EAAE,CAAC;gBACjG,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;oBACxI,SAAS,GAAG,MAAM,CAAA;gBACtB,CAAC;YACL,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,6BAA6B,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAA+B,CAAC,EAAE,CAAC;gBACnJ,SAAS,GAAG,MAAM,CAAA;YACtB,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAsB,EAAE,SAAS,CAAC,CAAA;YAC7D,CAAC;QACL,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,WAAW,CAAC,KAAK,CAAC,2DAA2D,GAAG,EAAE,CAAC,CAAA;QACvF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,SAAS;QACX,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,qBAAqB,KAAK,UAAU,EAAE,CAAC;YAC1E,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACjD,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa;QACf,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,qBAAqB,KAAK,UAAU,EAAE,CAAC;YAC1E,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACjD,CAAC;IACL,CAAC;CACJ;AAED,sDAAsD;AACtD,MAAM,YAAY,GAAyB,qBAAqB,CAAC,aAAa,CAAC,CAAA;AAG/E,eAAe,YAAY,CAAA"}