@wdio/browserstack-service 8.16.6 → 8.16.7

package/build/accessibility-handler.d.ts

@@ -0,0 +1,38 @@
+import type { Capabilities, Frameworks } from '@wdio/types';
+import type { ITestCaseHookParameter } from './cucumber-types.js';
+declare class _AccessibilityHandler {
+    private _browser;
+    private _capabilities;
+    private _framework?;
+    private _accessibilityAutomation?;
+    private _accessibilityOpts?;
+    private _platformA11yMeta;
+    private _caps;
+    private _suiteFile?;
+    private _accessibility?;
+    private _accessibilityOptions?;
+    private _testMetadata;
+    constructor(_browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, _capabilities: Capabilities.RemoteCapability, isAppAutomate?: boolean, _framework?: string | undefined, _accessibilityAutomation?: string | boolean | undefined, _accessibilityOpts?: {
+        [key: string]: any;
+    } | undefined);
+    setSuiteFile(filename: string): void;
+    _getCapabilityValue(caps: Capabilities.RemoteCapability, capType: string, legacyCapType: string): WebdriverIO.SafaridriverOptions | undefined;
+    before(): Promise<void>;
+    beforeTest(suiteTitle: string | undefined, test: Frameworks.Test): Promise<void>;
+    afterTest(suiteTitle: string | undefined, test: Frameworks.Test): Promise<void>;
+    /**
+      * Cucumber Only
+    */
+    beforeScenario(world: ITestCaseHookParameter): Promise<void>;
+    afterScenario(world: ITestCaseHookParameter): Promise<void>;
+    private sendTestStartEvent;
+    private sendTestForceStopEvent;
+    private sendTestStopEvent;
+    private getIdentifier;
+    private shouldRunTestHooks;
+    private checkIfPageOpened;
+}
+declare const AccessibilityHandler: typeof _AccessibilityHandler;
+type AccessibilityHandler = _AccessibilityHandler;
+export default AccessibilityHandler;
+//# sourceMappingURL=accessibility-handler.d.ts.map

package/build/accessibility-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility-handler.d.ts","sourceRoot":"","sources":["../src/accessibility-handler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAkBjE,cAAM,qBAAqB;IASnB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IAErB,OAAO,CAAC,UAAU,CAAC;IACnB,OAAO,CAAC,wBAAwB,CAAC;IACjC,OAAO,CAAC,kBAAkB,CAAC;IAb/B,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,qBAAqB,CAAC,CAAyB;IACvD,OAAO,CAAC,aAAa,CAA8B;gBAGvC,QAAQ,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAC9D,aAAa,EAAE,YAAY,CAAC,gBAAgB,EACpD,aAAa,CAAC,EAAE,OAAO,EACf,UAAU,CAAC,oBAAQ,EACnB,wBAAwB,CAAC,8BAAkB,EAC3C,kBAAkB,CAAC;;iBAAyB;IAgBxD,YAAY,CAAC,QAAQ,EAAE,MAAM;IAI7B,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IA6BzF,MAAM;IAmBN,UAAU,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAiCjE,SAAS,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IA0CtE;;MAEE;IACI,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAiC7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IA8ClD,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,kBAAkB;YAOZ,iBAAiB;CAiBlC;AAGD,QAAA,MAAM,oBAAoB,EAAE,OAAO,qBAAoE,CAAA;AACvG,KAAK,oBAAoB,GAAG,qBAAqB,CAAA;AAEjD,eAAe,oBAAoB,CAAA"}

package/build/accessibility-handler.js

@@ -0,0 +1,260 @@
+import logger from '@wdio/logger';
+import { getA11yResultsSummary, getA11yResults, getUniqueIdentifier, getUniqueIdentifierForCucumber, isAccessibilityAutomationSession, isBrowserstackSession, o11yClassErrorHandler, shouldScanTestForAccessibility, validateCapsWithA11y, isTrue, } from './util.js';
+import { testForceStop, testStartEvent, testStop } from './scripts/test-event-scripts.js';
+const log = logger('@wdio/browserstack-service');
+class _AccessibilityHandler {
+    _browser;
+    _capabilities;
+    _framework;
+    _accessibilityAutomation;
+    _accessibilityOpts;
+    _platformA11yMeta;
+    _caps;
+    _suiteFile;
+    _accessibility;
+    _accessibilityOptions;
+    _testMetadata = {};
+    constructor(_browser, _capabilities, isAppAutomate, _framework, _accessibilityAutomation, _accessibilityOpts) {
+        this._browser = _browser;
+        this._capabilities = _capabilities;
+        this._framework = _framework;
+        this._accessibilityAutomation = _accessibilityAutomation;
+        this._accessibilityOpts = _accessibilityOpts;
+        const caps = this._browser.capabilities;
+        this._platformA11yMeta = {
+            browser_name: caps.browserName,
+            browser_version: caps?.browserVersion || caps?.version || 'latest',
+            os_name: this._getCapabilityValue(_capabilities, 'os', 'os'),
+            os_version: this._getCapabilityValue(_capabilities, 'osVersion', 'os_version')
+        };
+        this._caps = _capabilities;
+        this._accessibility = isTrue(_accessibilityAutomation);
+        this._accessibilityOptions = _accessibilityOpts;
+    }
+    setSuiteFile(filename) {
+        this._suiteFile = filename;
+    }
+    _getCapabilityValue(caps, capType, legacyCapType) {
+        if (caps) {
+            if (capType === 'accessibility') {
+                if (caps['bstack:options'] && (isTrue(caps['bstack:options']?.accessibility))) {
+                    return caps['bstack:options']?.accessibility;
+                }
+                else if (isTrue(caps['browserstack.accessibility'])) {
+                    return caps['browserstack.accessibility'];
+                }
+            }
+            else if (capType === 'deviceName') {
+                if (caps['bstack:options'] && caps['bstack:options']?.deviceName) {
+                    return caps['bstack:options']?.deviceName;
+                }
+                else if (caps['bstack:options'] && caps['bstack:options']?.device) {
+                    return caps['bstack:options']?.device;
+                }
+                else if (caps['appium:deviceName']) {
+                    return caps['appium:deviceName'];
+                }
+            }
+            else if (capType === 'goog:chromeOptions' && caps['goog:chromeOptions']) {
+                return caps['goog:chromeOptions'];
+            }
+            else {
+                const bstackOptions = caps['bstack:options'];
+                if (bstackOptions && bstackOptions?.[capType]) {
+                    return bstackOptions?.[capType];
+                }
+                else if (caps[legacyCapType]) {
+                    return caps[legacyCapType];
+                }
+            }
+        }
+    }
+    async before() {
+        this._accessibility = isTrue(this._getCapabilityValue(this._caps, 'accessibility', 'browserstack.accessibility'));
+        if (isBrowserstackSession(this._browser) && isAccessibilityAutomationSession(this._accessibility)) {
+            const deviceName = this._getCapabilityValue(this._caps, 'deviceName', 'device');
+            const chromeOptions = this._getCapabilityValue(this._caps, 'goog:chromeOptions', '');
+            this._accessibility = validateCapsWithA11y(deviceName, this._platformA11yMeta, chromeOptions);
+        }
+        this._browser.getAccessibilityResultsSummary = async () => {
+            return await getA11yResultsSummary(this._browser, isBrowserstackSession(this._browser), this._accessibility);
+        };
+        this._browser.getAccessibilityResults = async () => {
+            return await getA11yResults(this._browser, isBrowserstackSession(this._browser), this._accessibility);
+        };
+    }
+    async beforeTest(suiteTitle, test) {
+        if (this._framework !== 'mocha' ||
+            !this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return;
+        }
+        const shouldScanTest = shouldScanTestForAccessibility(suiteTitle, test.title, this._accessibilityOptions);
+        const testIdentifier = this.getIdentifier(test);
+        const isPageOpened = await this.checkIfPageOpened(this._browser, testIdentifier, shouldScanTest);
+        if (!isPageOpened) {
+            return;
+        }
+        try {
+            if (shouldScanTest) {
+                log.info('Setup for Accessibility testing has started. Automate test case execution will begin momentarily.');
+                await this.sendTestStartEvent(this._browser);
+            }
+            else {
+                await this.sendTestForceStopEvent(this._browser);
+            }
+            this._testMetadata[testIdentifier].accessibilityScanStarted = shouldScanTest;
+            if (shouldScanTest) {
+                log.info('Automate test case execution has started.');
+            }
+        }
+        catch (error) {
+            log.error(`Exception in starting accessibility automation scan for this test case ${error}`);
+        }
+    }
+    async afterTest(suiteTitle, test) {
+        if (this._framework !== 'mocha' ||
+            !this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return;
+        }
+        try {
+            const testIdentifier = this.getIdentifier(test);
+            const accessibilityScanStarted = this._testMetadata[testIdentifier]?.accessibilityScanStarted;
+            const shouldScanTestForAccessibility = this._testMetadata[testIdentifier]?.scanTestForAccessibility;
+            if (!accessibilityScanStarted) {
+                return;
+            }
+            if (shouldScanTestForAccessibility) {
+                log.info('Automate test case execution has ended. Processing for accessibility testing is underway. ');
+            }
+            const dataForExtension = {
+                saveResults: shouldScanTestForAccessibility,
+                testDetails: {
+                    'name': test.title,
+                    'testRunId': process.env.BS_A11Y_TEST_RUN_ID,
+                    'filePath': this._suiteFile,
+                    'scopeList': [suiteTitle, test.title]
+                },
+                platform: this._platformA11yMeta
+            };
+            await this.sendTestStopEvent(this._browser, dataForExtension);
+            if (shouldScanTestForAccessibility) {
+                log.info('Accessibility testing for this test case has ended.');
+            }
+        }
+        catch (error) {
+            log.error(`Accessibility results could not be processed for the test case ${test.title}. Error :`, error);
+        }
+    }
+    /**
+      * Cucumber Only
+    */
+    async beforeScenario(world) {
+        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return;
+        }
+        const pickleData = world.pickle;
+        const gherkinDocument = world.gherkinDocument;
+        const featureData = gherkinDocument.feature;
+        const uniqueId = getUniqueIdentifierForCucumber(world);
+        const shouldScanScenario = shouldScanTestForAccessibility(featureData?.name, pickleData.name, this._accessibilityOptions);
+        const isPageOpened = await this.checkIfPageOpened(this._browser, uniqueId, shouldScanScenario);
+        if (!isPageOpened) {
+            return;
+        }
+        try {
+            if (shouldScanScenario) {
+                log.info('Setup for Accessibility testing has started. Automate test case execution will begin momentarily.');
+                await this.sendTestStartEvent(this._browser);
+            }
+            else {
+                await this.sendTestForceStopEvent(this._browser);
+            }
+            this._testMetadata[uniqueId].accessibilityScanStarted = shouldScanScenario;
+            if (shouldScanScenario) {
+                log.info('Automate test case execution has started.');
+            }
+        }
+        catch (error) {
+            log.error(`Exception in starting accessibility automation scan for this test case ${error}`);
+        }
+    }
+    async afterScenario(world) {
+        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return;
+        }
+        const pickleData = world.pickle;
+        try {
+            const gherkinDocument = world.gherkinDocument;
+            const featureData = gherkinDocument.feature;
+            const uniqueId = getUniqueIdentifierForCucumber(world);
+            const accessibilityScanStarted = this._testMetadata[uniqueId]?.accessibilityScanStarted;
+            const shouldScanTestForAccessibility = this._testMetadata[uniqueId]?.scanTestForAccessibility;
+            if (!accessibilityScanStarted) {
+                return;
+            }
+            if (shouldScanTestForAccessibility) {
+                log.info('Automate test case execution has ended. Processing for accessibility testing is underway. ');
+            }
+            const dataForExtension = {
+                saveResults: shouldScanTestForAccessibility,
+                testDetails: {
+                    'name': pickleData.name,
+                    'testRunId': process.env.BS_A11Y_TEST_RUN_ID,
+                    'filePath': gherkinDocument.uri,
+                    'scopeList': [featureData?.name, pickleData.name]
+                },
+                platform: this._platformA11yMeta
+            };
+            await this.sendTestStopEvent(this._browser, dataForExtension);
+            if (shouldScanTestForAccessibility) {
+                log.info('Accessibility testing for this test case has ended.');
+            }
+        }
+        catch (error) {
+            log.error(`Accessibility results could not be processed for the test case ${pickleData.name}. Error :`, error);
+        }
+    }
+    /*
+     * private methods
+     */
+    sendTestStartEvent(browser) {
+        return browser.executeAsync(testStartEvent);
+    }
+    sendTestForceStopEvent(browser) {
+        return browser.execute(testForceStop);
+    }
+    sendTestStopEvent(browser, dataForExtension) {
+        return browser.executeAsync(testStop, dataForExtension);
+    }
+    getIdentifier(test) {
+        if ('pickle' in test) {
+            return getUniqueIdentifierForCucumber(test);
+        }
+        return getUniqueIdentifier(test, this._framework);
+    }
+    shouldRunTestHooks(browser, isAccessibility) {
+        if (!browser) {
+            return false;
+        }
+        return isBrowserstackSession(browser) && isAccessibilityAutomationSession(isAccessibility);
+    }
+    async checkIfPageOpened(browser, testIdentifier, shouldScanTest) {
+        let pageOpen = false;
+        this._testMetadata[testIdentifier] = {
+            scanTestForAccessibility: shouldScanTest,
+            accessibilityScanStarted: true
+        };
+        try {
+            const currentURL = await browser.getUrl();
+            const url = new URL(currentURL);
+            pageOpen = url?.protocol === 'http:' || url?.protocol === 'https:';
+        }
+        catch (e) {
+            pageOpen = false;
+        }
+        return pageOpen;
+    }
+}
+// https://github.com/microsoft/TypeScript/issues/6543
+const AccessibilityHandler = o11yClassErrorHandler(_AccessibilityHandler);
+export default AccessibilityHandler;

package/build/constants.d.ts

@@ -13,4 +13,6 @@ export declare const BATCH_EVENT_TYPES: string[];
 export declare const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000;
 export declare const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100;
 export declare const BSTACK_SERVICE_VERSION: any;
+export declare const ACCESSIBILITY_API_URL = "https://accessibility.browserstack.com/api";
+export declare const NOT_ALLOWED_KEYS_IN_CAPS: string[];
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAKpD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAIvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AAEvE,eAAO,MAAM,aAAa,qDAAqD,CAAA;AAC/E,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,eAAe,OAAO,CAAA;AACnC,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,iBAAiB,UAAgH,CAAA;AAC9I,eAAO,MAAM,wCAAwC,OAAO,CAAA;AAC5D,eAAO,MAAM,yCAAyC,MAAM,CAAA;AAC5D,eAAO,MAAM,sBAAsB,KAAuB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAKpD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AAEvE,eAAO,MAAM,aAAa,qDAAqD,CAAA;AAC/E,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,eAAe,OAAO,CAAA;AACnC,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,iBAAiB,UAAgH,CAAA;AAC9I,eAAO,MAAM,wCAAwC,OAAO,CAAA;AAC5D,eAAO,MAAM,yCAAyC,MAAM,CAAA;AAC5D,eAAO,MAAM,sBAAsB,KAAuB,CAAA;AAE1D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA"}

package/build/constants.js

@@ -19,7 +19,8 @@ export const VALID_APP_EXTENSION = [
 export const DEFAULT_OPTIONS = {
     setSessionName: true,
     setSessionStatus: true,
-    testObservability: true
+    testObservability: true,
+    accessibility: false
 };
 export const consoleHolder = Object.assign({}, console);
 export const DATA_ENDPOINT = 'https://collector-observability.browserstack.com';
@@ -32,3 +33,5 @@ export const BATCH_EVENT_TYPES = ['LogCreated', 'TestRunStarted', 'TestRunFinish
 export const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000; // 5s
 export const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100; // 100ms
 export const BSTACK_SERVICE_VERSION = bstackServiceVersion;
+export const ACCESSIBILITY_API_URL = 'https://accessibility.browserstack.com/api';
+export const NOT_ALLOWED_KEYS_IN_CAPS = ['includeTagsInTestingScope', 'excludeTagsInTestingScope'];

package/build/launcher.d.ts

@@ -13,6 +13,7 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _projectName?;
     private _buildTag?;
     private _buildIdentifier?;
+    private _accessibilityAutomation?;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
     onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): Promise<unknown>;
     onComplete(): Promise<unknown>;
@@ -22,6 +23,9 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
      *                                            <object>: only "path" and "custom_id" should coexist as multiple properties.
      */
     _validateApp(appConfig: AppConfig | string): Promise<App>;
+    _updateObjectTypeCaps(capabilities?: Capabilities.RemoteCapabilities, capType?: string, value?: {
+        [key: string]: any;
+    }): void;
     _updateCaps(capabilities?: Capabilities.RemoteCapabilities, capType?: string, value?: string): void;
     _handleBuildIdentifier(capabilities?: Capabilities.RemoteCapabilities): void;
     /**

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAG/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAavF,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAQ5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IATnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;gBAGrB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAgFjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA0GtF,UAAU;IAsDV,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAC,MAAM;IA4F3F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;CAQtF"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAG/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAkBvF,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAS5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IAVnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAS;gBAG9B,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAwGjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA8ItF,UAAU;IA4DV,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,qBAAqB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE;IAiFvH,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IA4F5F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;CAQtF"}

package/build/launcher.js

@@ -9,8 +9,8 @@ import os from 'node:os';
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import logger from '@wdio/logger';
 import PerformanceTester from './performance-tester.js';
-import { BSTACK_SERVICE_VERSION, VALID_APP_EXTENSION } from './constants.js';
-import { launchTestSession, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, } from './util.js';
+import { BSTACK_SERVICE_VERSION, NOT_ALLOWED_KEYS_IN_CAPS, VALID_APP_EXTENSION } from './constants.js';
+import { launchTestSession, createAccessibilityTestRun, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, isUndefined, isAccessibilityAutomationSession, stopAccessibilityTestRun, isTrue } from './util.js';
 import CrashReporter from './crash-reporter.js';
 const log = logger('@wdio/browserstack-service');
 export default class BrowserstackLauncherService {
@@ -21,6 +21,7 @@ export default class BrowserstackLauncherService {
     _projectName;
     _buildTag;
     _buildIdentifier;
+    _accessibilityAutomation;
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
@@ -41,6 +42,12 @@ export default class BrowserstackLauncherService {
                         const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
                         if (extensionCaps.length) {
                             capability['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION };
+                            if (!isUndefined(capability['browserstack.accessibility'])) {
+                                this._accessibilityAutomation ||= isTrue(capability['browserstack.accessibility']);
+                            }
+                            else if (isTrue(this._options.accessibility)) {
+                                capability['bstack:options'].accessibility = true;
+                            }
                         }
                         else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
                             capability['browserstack.wdioService'] = BSTACK_SERVICE_VERSION;
@@ -56,6 +63,12 @@ export default class BrowserstackLauncherService {
                     this._projectName = capability['bstack:options'].projectName;
                     this._buildTag = capability['bstack:options'].buildTag;
                     this._buildIdentifier = capability['bstack:options'].buildIdentifier;
+                    if (!isUndefined(capability['bstack:options'].accessibility)) {
+                        this._accessibilityAutomation ||= isTrue(capability['bstack:options'].accessibility);
+                    }
+                    else if (isTrue(this._options.accessibility)) {
+                        capability['bstack:options'].accessibility = (isTrue(this._options.accessibility));
+                    }
                 }
             });
         }
@@ -66,6 +79,12 @@ export default class BrowserstackLauncherService {
                         const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
                         if (extensionCaps.length) {
                             caps.capabilities['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION };
+                            if (!isUndefined(caps.capabilities['browserstack.accessibility'])) {
+                                this._accessibilityAutomation ||= isTrue(caps.capabilities['browserstack.accessibility']);
+                            }
+                            else if (isTrue(this._options.accessibility)) {
+                                caps.capabilities['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION, accessibility: (isTrue(this._options.accessibility)) };
+                            }
                         }
                         else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
                             caps.capabilities['browserstack.wdioService'] = BSTACK_SERVICE_VERSION;
@@ -80,12 +99,20 @@ export default class BrowserstackLauncherService {
                     this._projectName = bstackOptions.projectName;
                     this._buildTag = bstackOptions.buildTag;
                     this._buildIdentifier = bstackOptions.buildIdentifier;
+                    if (!isUndefined(bstackOptions.accessibility)) {
+                        this._accessibilityAutomation ||= isTrue(bstackOptions.accessibility);
+                    }
+                    else if (isTrue(this._options.accessibility)) {
+                        bstackOptions.accessibility = isTrue(this._options.accessibility);
+                    }
                 }
             });
         }
         if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
             PerformanceTester.startMonitoring('performance-report-launcher.csv');
         }
+        this._accessibilityAutomation ||= isTrue(this._options.accessibility);
+        this._options.accessibility = this._accessibilityAutomation;
         // by default observability will be true unless specified as false
         this._options.testObservability = this._options.testObservability === false ? false : true;
         if (this._options.testObservability
@@ -146,6 +173,38 @@ export default class BrowserstackLauncherService {
          * e.g., ${BUILD_NUMBER} and ${DATE_TIME}
         */
         this._handleBuildIdentifier(capabilities);
+        // remove accessibilityOptions from the capabilities if present
+        this._updateObjectTypeCaps(capabilities, 'accessibilityOptions');
+        if (this._accessibilityAutomation) {
+            const scannerVersion = await createAccessibilityTestRun(this._options, this._config, {
+                projectName: this._projectName,
+                buildName: this._buildName,
+                buildTag: this._buildTag,
+                bstackServiceVersion: BSTACK_SERVICE_VERSION,
+                buildIdentifier: this._buildIdentifier,
+                accessibilityOptions: this._options.accessibilityOptions
+            });
+            if (scannerVersion) {
+                process.env.BSTACK_A11Y_SCANNER_VERSION = scannerVersion;
+            }
+            log.debug(`Accessibility scannerVersion ${scannerVersion}`);
+        }
+        if (this._options.accessibilityOptions) {
+            const filteredOpts = Object.keys(this._options.accessibilityOptions)
+                .filter(key => !NOT_ALLOWED_KEYS_IN_CAPS.includes(key))
+                .reduce((opts, key) => {
+                return {
+                    ...opts,
+                    [key]: this._options.accessibilityOptions?.[key]
+                };
+            }, {});
+            if (Object.keys(filteredOpts).length > 0) {
+                this._updateObjectTypeCaps(capabilities, 'accessibilityOptions', filteredOpts);
+            }
+        }
+        else if (isAccessibilityAutomationSession(this._accessibilityAutomation)) {
+            this._updateObjectTypeCaps(capabilities, 'accessibilityOptions', {});
+        }
         if (this._options.testObservability) {
             log.debug('Sending launch start event');
             await launchTestSession(this._options, this._config, {
@@ -197,6 +256,11 @@ export default class BrowserstackLauncherService {
         });
     }
     async onComplete() {
+        if (isAccessibilityAutomationSession(this._accessibilityAutomation)) {
+            await stopAccessibilityTestRun().catch((error) => {
+                log.error(`Exception in stop accessibility test run: ${error}`);
+            });
+        }
         if (this._options.testObservability) {
             log.debug('Sending stop launch event');
             await stopBuildUpstream();
@@ -285,6 +349,96 @@ export default class BrowserstackLauncherService {
         }
         return app;
     }
+    _updateObjectTypeCaps(capabilities, capType, value) {
+        try {
+            if (Array.isArray(capabilities)) {
+                capabilities
+                    .flatMap((c) => {
+                    if (Object.values(c).length > 0 && Object.values(c).every(c => typeof c === 'object' && c.capabilities)) {
+                        return Object.values(c).map((o) => o.capabilities);
+                    }
+                    return c;
+                })
+                    .forEach((capability) => {
+                    if (!capability['bstack:options']) {
+                        const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
+                        if (extensionCaps.length) {
+                            if (capType === 'accessibilityOptions' && value) {
+                                capability['bstack:options'] = { accessibilityOptions: value };
+                            }
+                        }
+                        else if (capType === 'accessibilityOptions') {
+                            if (value) {
+                                const accessibilityOpts = { ...value };
+                                if (capability?.accessibility) {
+                                    accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
+                                    accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
+                                }
+                                capability['browserstack.accessibilityOptions'] = accessibilityOpts;
+                            }
+                            else {
+                                delete capability['browserstack.accessibilityOptions'];
+                            }
+                        }
+                    }
+                    else if (capType === 'accessibilityOptions') {
+                        if (value) {
+                            const accessibilityOpts = { ...value };
+                            if (capability['bstack:options'].accessibility) {
+                                accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
+                                accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
+                            }
+                            capability['bstack:options'].accessibilityOptions = accessibilityOpts;
+                        }
+                        else {
+                            delete capability['bstack:options'].accessibilityOptions;
+                        }
+                    }
+                });
+            }
+            else if (typeof capabilities === 'object') {
+                Object.entries(capabilities).forEach(([, caps]) => {
+                    if (!caps.capabilities['bstack:options']) {
+                        const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
+                        if (extensionCaps.length) {
+                            if (capType === 'accessibilityOptions' && value) {
+                                caps.capabilities['bstack:options'] = { accessibilityOptions: value };
+                            }
+                        }
+                        else if (capType === 'accessibilityOptions') {
+                            if (value) {
+                                const accessibilityOpts = { ...value };
+                                if (caps.capabilities['browserstack.accessibility']) {
+                                    accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
+                                    accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
+                                }
+                                caps.capabilities['browserstack.accessibilityOptions'] = accessibilityOpts;
+                            }
+                            else {
+                                delete caps.capabilities['browserstack.accessibilityOptions'];
+                            }
+                        }
+                    }
+                    else if (capType === 'accessibilityOptions') {
+                        if (value) {
+                            const accessibilityOpts = { ...value };
+                            if (caps.capabilities['bstack:options'].accessibility) {
+                                accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
+                                accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
+                            }
+                            caps.capabilities['bstack:options'].accessibilityOptions = accessibilityOpts;
+                        }
+                        else {
+                            delete caps.capabilities['bstack:options'].accessibilityOptions;
+                        }
+                    }
+                });
+            }
+        }
+        catch (error) {
+            log.debug(`Exception while retrieving capability value. Error - ${error}`);
+        }
+    }
     _updateCaps(capabilities, capType, value) {
         if (Array.isArray(capabilities)) {
             capabilities

package/build/scripts/test-event-scripts.d.ts

@@ -0,0 +1,10 @@
+export declare function testStartEvent(): void;
+export declare function testForceStop(): void;
+export declare function testStop(this: any): void;
+export declare function accessibilityResults(): Promise<Array<{
+    [key: string]: any;
+}>>;
+export declare function accessibilityResultsSummary(): Promise<{
+    [key: string]: any;
+}>;
+//# sourceMappingURL=test-event-scripts.d.ts.map

package/build/scripts/test-event-scripts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-event-scripts.d.ts","sourceRoot":"","sources":["../../src/scripts/test-event-scripts.ts"],"names":[],"mappings":"AAAA,wBAAgB,cAAc,SAY7B;AAED,wBAAgB,aAAa,SAG5B;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,QAgBjC;AAED,wBAAgB,oBAAoB,IAAK,OAAO,CAAC,KAAK,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAAE,CAAC,CAAC,CAc/E;AAED,wBAAgB,2BAA2B,IAAK,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAAE,CAAC,CAc/E"}

package/build/scripts/test-event-scripts.js

@@ -0,0 +1,65 @@
+export function testStartEvent() {
+    const callback = arguments[arguments.length - 1];
+    const fn = () => {
+        window.addEventListener('A11Y_TAP_STARTED', fn2);
+        const e = new CustomEvent('A11Y_FORCE_START');
+        window.dispatchEvent(e);
+    };
+    const fn2 = () => {
+        window.removeEventListener('A11Y_TAP_STARTED', fn);
+        callback();
+    };
+    fn();
+}
+export function testForceStop() {
+    const e = new CustomEvent('A11Y_FORCE_STOP');
+    window.dispatchEvent(e);
+}
+export function testStop() {
+    const callback = arguments[arguments.length - 1];
+    this.res = null;
+    if (arguments[0].saveResults) {
+        window.addEventListener('A11Y_TAP_TRANSPORTER', (event) => {
+            window.tapTransporterData = event.detail;
+            this.res = window.tapTransporterData;
+            callback(this.res);
+        });
+    }
+    const e = new CustomEvent('A11Y_TEST_END', { detail: arguments[0] });
+    window.dispatchEvent(e);
+    if (arguments[0].saveResults !== true) {
+        callback();
+    }
+}
+export function accessibilityResults() {
+    return new Promise(function (resolve, reject) {
+        try {
+            const event = new CustomEvent('A11Y_TAP_GET_RESULTS');
+            const fn = function (event) {
+                window.removeEventListener('A11Y_RESULTS_RESPONSE', fn);
+                resolve(event.detail.data);
+            };
+            window.addEventListener('A11Y_RESULTS_RESPONSE', fn);
+            window.dispatchEvent(event);
+        }
+        catch {
+            reject();
+        }
+    });
+}
+export function accessibilityResultsSummary() {
+    return new Promise(function (resolve, reject) {
+        try {
+            const event = new CustomEvent('A11Y_TAP_GET_RESULTS_SUMMARY');
+            const fn = function (event) {
+                window.removeEventListener('A11Y_RESULTS_SUMMARY_RESPONSE', fn);
+                resolve(event.detail.summary);
+            };
+            window.addEventListener('A11Y_RESULTS_SUMMARY_RESPONSE', fn);
+            window.dispatchEvent(event);
+        }
+        catch {
+            reject();
+        }
+    });
+}

package/build/service.d.ts

@@ -17,6 +17,8 @@ export default class BrowserstackService implements Services.ServiceInstance {
     private _observability;
     private _currentTest?;
     private _insightsHandler?;
+    private _accessibility;
+    private _accessibilityHandler?;
     constructor(options: BrowserstackConfig & Options.Testrunner, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
     _updateCaps(fn: (caps: Capabilities.Capabilities | Capabilities.DesiredCapabilities) => void): void;
     beforeSession(config: Omit<Options.Testrunner, 'capabilities'>): void;

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAW9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,YAAY,CAAA;AACxF,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAQhG,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAiBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAjBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAiB;gBAGtC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAqBvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAgBzD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO;IA+C/F;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IASpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAO5D,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI9F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAoBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAS/E,KAAK,CAAE,MAAM,EAAE,MAAM;IA+B3B;;OAEG;IAEG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAOjD;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAO7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAsB5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAKzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAIzF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAMzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAarC,gBAAgB;YAuBR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAW9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,YAAY,CAAA;AACxF,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAShG,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAmBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAnBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAC1C,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,qBAAqB,CAAC,CAAsB;gBAGhD,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAsBvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAgBzD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO;IA+D/F;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAUpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAO5D,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI9F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAqBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAU/E,KAAK,CAAE,MAAM,EAAE,MAAM;IA+B3B;;OAEG;IAEG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAOjD;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAQ7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAuB5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAKzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAIzF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAMzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAarC,gBAAgB;YAuBR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}

package/build/service.js

@@ -6,6 +6,7 @@ import InsightsHandler from './insights-handler.js';
 import TestReporter from './reporter.js';
 import { DEFAULT_OPTIONS } from './constants.js';
 import CrashReporter from './crash-reporter.js';
+import AccessibilityHandler from './accessibility-handler.js';
 const log = logger('@wdio/browserstack-service');
 export default class BrowserstackService {
     _caps;
@@ -23,6 +24,8 @@ export default class BrowserstackService {
     _observability;
     _currentTest;
     _insightsHandler;
+    _accessibility;
+    _accessibilityHandler;
     constructor(options, _caps, _config) {
         this._caps = _caps;
         this._config = _config;
@@ -30,6 +33,7 @@ export default class BrowserstackService {
         // added to maintain backward compatibility with webdriverIO v5
         this._config || (this._config = this._options);
         this._observability = this._options.testObservability;
+        this._accessibility = this._options.accessibility;
         if (this._observability) {
             this._config.reporters?.push(TestReporter);
             if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
@@ -91,6 +95,15 @@ export default class BrowserstackService {
                 CrashReporter.uploadCrashReport(`Error in service class before function: ${err}`, err && err.stack);
             }
         }
+        if (this._browser && isBrowserstackSession(this._browser)) {
+            try {
+                this._accessibilityHandler = new AccessibilityHandler(this._browser, this._caps, this._isAppAutomate(), this._config.framework, this._accessibility, this._options.accessibilityOptions);
+                await this._accessibilityHandler.before();
+            }
+            catch (err) {
+                log.error(`[Accessibility Test Run] Error in service class before function: ${err}`);
+            }
+        }
         return await this._printSessionURL();
     }
     /**
@@ -103,6 +116,7 @@ export default class BrowserstackService {
     async beforeSuite(suite) {
         this._suiteTitle = suite.title;
         this._insightsHandler?.setSuiteFile(suite.file);
+        this._accessibilityHandler?.setSuiteFile(suite.file);
         if (suite.title && suite.title !== 'Jasmine__TopLevel__Suite') {
             await this._setSessionName(suite.title);
         }
@@ -133,6 +147,7 @@ export default class BrowserstackService {
         await this._setSessionName(suiteTitle, test);
         await this._setAnnotation(`Test: ${test.fullName ?? test.title}`);
         await this._insightsHandler?.beforeTest(test);
+        await this._accessibilityHandler?.beforeTest(suiteTitle, test);
     }
     async afterTest(test, context, results) {
         this._specsRan = true;
@@ -141,6 +156,7 @@ export default class BrowserstackService {
             this._failReasons.push((error && error.message) || 'Unknown Error');
         }
         await this._insightsHandler?.afterTest(test, results);
+        await this._accessibilityHandler?.afterTest(this._suiteTitle, test);
     }
     async after(result) {
         const { preferScenarioName, setSessionName, setSessionStatus } = this._options;
@@ -185,6 +201,7 @@ export default class BrowserstackService {
     async beforeScenario(world) {
         this._currentTest = world;
         await this._insightsHandler?.beforeScenario(world);
+        await this._accessibilityHandler?.beforeScenario(world);
         const scenarioName = world.pickle.name || 'unknown scenario';
         await this._setAnnotation(`Scenario: ${scenarioName}`);
     }
@@ -202,6 +219,7 @@ export default class BrowserstackService {
             this._failReasons.push(exception);
         }
         await this._insightsHandler?.afterScenario(world);
+        await this._accessibilityHandler?.afterScenario(world);
     }
     async beforeStep(step, scenario) {
         await this._insightsHandler?.beforeStep(step, scenario);

package/build/types.d.ts

@@ -48,6 +48,20 @@ export interface BrowserstackConfig {
      * For e.g. buildName, projectName, BrowserStack access credentials, etc.
      */
     testObservabilityOptions?: TestObservabilityOptions;
+    /**
+    * Set this to true to enable BrowserStack Accessibility Automation which will
+    * automically conduct accessibility testing on your pre-existing test builds
+    * and generate health reports which can be viewed in the Accessibility dashboard.
+    * @default false
+    */
+    accessibility?: boolean;
+    /**
+    * Customise the Accessibility-related config options under this key.
+    * For e.g. wcagVersion, bestPractice issues, needsReview issues etc.
+    */
+    accessibilityOptions?: {
+        [key: string]: any;
+    };
     /**
      * Set this with app file path present locally on your device or
      * app hashed id returned after uploading app to BrowserStack or
@@ -185,6 +199,9 @@ export interface UserConfig {
     buildTag?: string;
     bstackServiceVersion?: string;
     buildIdentifier?: string;
+    accessibilityOptions?: {
+        [key: string]: any;
+    };
 }
 export interface UploadType {
     event_type: string;

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9D,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,wBAAwB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAChB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,KACjB,MAAM,CAAA;IACX;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACtE,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAA;KAAE,CAAC;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,UAAU;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,UAAU;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAC7C,GAAG,CAAC,EAAE;QACJ,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;QACzC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC;QAC9C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;KACjC,CAAA;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,iBAAiB;IACvB,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,YAAY;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,UAAU,QAAQ;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,OAAO;IACb,SAAS,EAAE,MAAM,EAAE,CAAA;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9D,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,wBAAwB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD;;;;;MAKE;IACF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;MAGE;IACF,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC/C;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAChB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,KACjB,MAAM,CAAA;IACX;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACtE,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAA;KAAE,CAAC;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,UAAU;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAA;CACjD;AAED,MAAM,WAAW,UAAU;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC;IAC7C,GAAG,CAAC,EAAE;QACJ,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;QACzC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC;QAC9C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;KACjC,CAAA;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,iBAAiB;IACvB,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,YAAY;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,UAAU,QAAQ;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,OAAO;IACb,SAAS,EAAE,MAAM,EAAE,CAAA;CACtB"}

package/build/util.d.ts

@@ -4,6 +4,7 @@ import http from 'node:http';
 import https from 'node:https';
 import type { Capabilities, Frameworks, Options } from '@wdio/types';
 import type { BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
+import type { Method } from 'got';
 import type { UploadType, BrowserstackConfig } from './types.js';
 import type { ITestCaseHookParameter } from './cucumber-types.js';
 import RequestQueueHandler from './request-handler.js';
@@ -36,11 +37,28 @@ export declare function getBrowserCapabilities(browser: WebdriverIO.Browser | We
 export declare function isBrowserstackCapability(cap?: Capabilities.Capabilities): boolean;
 export declare function getParentSuiteName(fullTitle: string, testSuiteTitle: string): string;
 export declare function o11yErrorHandler(fn: Function): (...args: any) => any;
+export declare function errorHandler(fn: Function): (...args: any) => any;
+export declare function nodeRequest(requestType: Method, apiEndpoint: string, options: any, apiUrl: string, timeout?: number): Promise<Object>;
 type ClassType = {
     new (...args: any[]): any;
 };
 export declare function o11yClassErrorHandler<T extends ClassType>(errorClass: T): T;
 export declare const launchTestSession: (...args: any) => any;
+export declare const validateCapsWithA11y: (deviceName?: any, platformMeta?: {
+    [key: string]: any;
+} | undefined, chromeOptions?: any) => boolean;
+export declare const shouldScanTestForAccessibility: (suiteTitle: string | undefined, testTitle: string, accessibilityOptions?: {
+    [key: string]: any;
+} | undefined) => boolean | undefined;
+export declare const isAccessibilityAutomationSession: (accessibilityFlag?: boolean | string) => boolean | "" | undefined;
+export declare const createAccessibilityTestRun: (...args: any) => any;
+export declare const getA11yResults: (browser: WebdriverIO.Browser, isBrowserStackSession?: boolean, isAccessibility?: boolean | string) => Promise<{
+    [key: string]: any;
+}[]>;
+export declare const getA11yResultsSummary: (browser: WebdriverIO.Browser, isBrowserStackSession?: boolean, isAccessibility?: boolean | string) => Promise<{
+    [key: string]: any;
+}>;
+export declare const stopAccessibilityTestRun: (...args: any) => any;
 export declare const stopBuildUpstream: (...args: any) => any;
 export declare function getCiInfo(): {
     name: string;
@@ -101,6 +119,10 @@ export declare function getObservabilityKey(options: BrowserstackConfig & Option
 export declare function getObservabilityProject(options: BrowserstackConfig & Options.Testrunner, bstackProjectName?: string): string | undefined;
 export declare function getObservabilityBuild(options: BrowserstackConfig & Options.Testrunner, bstackBuildName?: string): string;
 export declare function getObservabilityBuildTags(options: BrowserstackConfig & Options.Testrunner, bstackBuildTag?: string): string[];
+export declare function getBrowserStackUser(config: Options.Testrunner): string | undefined;
+export declare function getBrowserStackKey(config: Options.Testrunner): string | undefined;
+export declare function isUndefined(value: any): boolean;
+export declare function isTrue(value?: any): boolean;
 export declare function frameworkSupportsHook(hook: string, framework?: string): boolean;
 export declare function patchConsoleLogs(): void;
 export declare function getFailureObject(error: string | Error): {

package/build/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;AAEA,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,KAAK,MAAM,YAAY,CAAA;AAI9B,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAUzE,OAAO,KAAK,EAAc,UAAU,EAAkB,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC5F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAEjE,OAAO,mBAAmB,MAAM,sBAAsB,CAAA;AAMtD,eAAO,MAAM,sBAAsB;;;;;;;;;CASlC,CAAA;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,YAAY,CAAC,mBAAmB,UAa1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,MAAM,6BAS/J;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,YAAY,WAWvE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAUpF;AAaD,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,QAAQ,aACf,GAAG,SAehC;AAOD,KAAK,SAAS,GAAG;IAAE,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;CAAE,CAAC;AAC/C,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CA8B3E;AAED,eAAO,MAAM,iBAAiB,YAvDA,GAAG,QAkI/B,CAAA;AAEF,eAAO,MAAM,iBAAiB,YApIA,GAAG,QAyK/B,CAAA;AAEF,wBAAgB,SAAS;;;;;;;;;;;;;;;SA8FxB;AAED,wBAAsB,cAAc;;;;;;;;;;;;;;;;;;;;eAyBnC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAWrF;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,sBAAsB,GAAG,MAAM,CAEpF;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,GAAG,MAAM,CAKtG;AAED,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,uBAEnG;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,sBAAsB,wBAsChE;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAWnD;AAED,wBAAsB,eAAe,CAAE,SAAS,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAE,MAA4B;;;eAuCvH;AAGD,wBAAgB,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,YAK9C;AAED,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWrD;AAED,wBAAgB,mBAAmB,CAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,4BAE9E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,WAKzD;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAKxG;AAED,wBAAsB,kBAAkB,CAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,iBAmB3F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQhH;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQ/G;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,MAAM,sBAQnH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,EAAE,MAAM,UAQ/G;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAW7H;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,WAUrE;AAED,wBAAgB,gBAAgB,SAU/B;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAC,KAAK;;;;;;EAUnD;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,mBAAmB,GAAE,mBAAmB,GAAC,SAAqB,iBAQrH;AAED,eAAO,MAAM,KAAK,mCAAkE,CAAA"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;AAEA,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,KAAK,MAAM,YAAY,CAAA;AAI9B,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAIzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAOjC,OAAO,KAAK,EAAc,UAAU,EAAkB,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC5F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAEjE,OAAO,mBAAmB,MAAM,sBAAsB,CAAA;AAOtD,eAAO,MAAM,sBAAsB;;;;;;;;;CASlC,CAAA;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,YAAY,CAAC,mBAAmB,UAa1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,MAAM,6BAS/J;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,YAAY,WAWvE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAUpF;AAaD,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,QAAQ,aACf,GAAG,SAehC;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,QAAQ,aACX,GAAG,SAYhC;AAED,wBAAsB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,MAAe,mBAyBjI;AAOD,KAAK,SAAS,GAAG;IAAE,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;CAAE,CAAC;AAC/C,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CA8B3E;AAED,eAAO,MAAM,iBAAiB,YAjGA,GAAG,QA4K/B,CAAA;AAEF,eAAO,MAAM,oBAAoB,gBAAiB,GAAG;;+BAA0D,GAAG,YA0BjH,CAAA;AAED,eAAO,MAAM,8BAA8B,eAAgB,MAAM,GAAG,SAAS,aAAa,MAAM;;qCAc/F,CAAA;AAED,eAAO,MAAM,gCAAgC,uBAAwB,OAAO,GAAG,MAAM,6BAQpF,CAAA;AAED,eAAO,MAAM,0BAA0B,YAlNT,GAAG,QAsS/B,CAAA;AAEF,eAAO,MAAM,cAAc,YAAmB,YAAY,OAAO,0BAA0B,OAAO,oBAAoB,OAAO,GAAG,MAAM;;IAkBrI,CAAA;AAED,eAAO,MAAM,qBAAqB,YAAmB,YAAY,OAAO,0BAA0B,OAAO,oBAAoB,OAAO,GAAG,MAAM;;EAiB5I,CAAA;AAED,eAAO,MAAM,wBAAwB,YA/UP,GAAG,QA4X/B,CAAA;AAEF,eAAO,MAAM,iBAAiB,YAhZA,GAAG,QAqb/B,CAAA;AAEF,wBAAgB,SAAS;;;;;;;;;;;;;;;SA8FxB;AAED,wBAAsB,cAAc;;;;;;;;;;;;;;;;;;;;eAyBnC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAWrF;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,sBAAsB,GAAG,MAAM,CAEpF;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,GAAG,MAAM,CAKtG;AAED,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,uBAEnG;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,sBAAsB,wBAsChE;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAWnD;AAED,wBAAsB,eAAe,CAAE,SAAS,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAE,MAA4B;;;eAuCvH;AAGD,wBAAgB,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,YAK9C;AAED,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWrD;AAED,wBAAgB,mBAAmB,CAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,4BAE9E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,WAKzD;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAKxG;AAED,wBAAsB,kBAAkB,CAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,iBAmB3F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQhH;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQ/G;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,MAAM,sBAQnH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,EAAE,MAAM,UAQ/G;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAW7H;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,sBAK7D;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,sBAK5D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,WAErC;AAED,wBAAgB,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,WAEjC;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,WAUrE;AAED,wBAAgB,gBAAgB,SAU/B;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAC,KAAK;;;;;;EAUnD;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,mBAAmB,GAAE,mBAAmB,GAAC,SAAqB,iBAQrH;AAED,eAAO,MAAM,KAAK,mCAAkE,CAAA"}

package/build/util.js

@@ -10,9 +10,10 @@ import gitRepoInfo from 'git-repo-info';
 import gitconfig from 'gitconfiglocal';
 import logPatcher from './logPatcher.js';
 import PerformanceTester from './performance-tester.js';
-import { BROWSER_DESCRIPTION, DATA_ENDPOINT, DATA_EVENT_ENDPOINT, DATA_SCREENSHOT_ENDPOINT, consoleHolder } from './constants.js';
+import { ACCESSIBILITY_API_URL, BROWSER_DESCRIPTION, DATA_ENDPOINT, DATA_EVENT_ENDPOINT, DATA_SCREENSHOT_ENDPOINT, consoleHolder } from './constants.js';
 import RequestQueueHandler from './request-handler.js';
 import CrashReporter from './crash-reporter.js';
+import { accessibilityResults, accessibilityResultsSummary } from './scripts/test-event-scripts.js';
 const pGitconfig = promisify(gitconfig);
 const log = logger('@wdio/browserstack-service');
 export const DEFAULT_REQUEST_CONFIG = {
@@ -109,6 +110,50 @@ export function o11yErrorHandler(fn) {
         }
     };
 }
+export function errorHandler(fn) {
+    return function (...args) {
+        try {
+            const functionToHandle = fn;
+            const result = functionToHandle(...args);
+            if (result instanceof Promise) {
+                return result.catch(error => log.error(`Error in executing ${fn.name} with args ${args}: ${error}`));
+            }
+            return result;
+        }
+        catch (error) {
+            log.error(`Error in executing ${fn.name} with args ${args}: ${error}`);
+        }
+    };
+}
+export async function nodeRequest(requestType, apiEndpoint, options, apiUrl, timeout = 120000) {
+    try {
+        const response = await got(`${apiUrl}/${apiEndpoint}`, {
+            method: requestType,
+            timeout: {
+                request: timeout
+            },
+            ...options
+        }).json();
+        return response;
+    }
+    catch (error) {
+        if (error instanceof HTTPError && error.response) {
+            const errorMessageJson = error.response.body ? JSON.parse(error.response.body.toString()) : null;
+            const errorMessage = errorMessageJson ? errorMessageJson.message : null;
+            if (errorMessage) {
+                log.error(`${errorMessage} - ${error.stack}`);
+            }
+            else {
+                log.error(`${error.stack}`);
+            }
+            throw error;
+        }
+        else {
+            log.error(`Failed to fire api request due to ${error} - ${error.stack}`);
+            throw error;
+        }
+    }
+}
 export function o11yClassErrorHandler(errorClass) {
     const prototype = errorClass.prototype;
     if (Object.getOwnPropertyNames(prototype).length < 2) {
@@ -214,6 +259,201 @@ export const launchTestSession = o11yErrorHandler(async function launchTestSessi
         }
     }
 });
+export const validateCapsWithA11y = (deviceName, platformMeta, chromeOptions) => {
+    try {
+        if (deviceName) {
+            log.warn('Accessibility Automation will run only on Desktop browsers.');
+            return false;
+        }
+        if (platformMeta?.browser_name?.toLowerCase() !== 'chrome') {
+            log.warn('Accessibility Automation will run only on Chrome browsers.');
+            return false;
+        }
+        const browserVersion = platformMeta?.browser_version;
+        if (!isUndefined(browserVersion) && !(browserVersion === 'latest' || parseFloat(browserVersion + '') > 94)) {
+            log.warn('Accessibility Automation will run only on Chrome browser version greater than 94.');
+            return false;
+        }
+        if (chromeOptions?.args?.includes('--headless')) {
+            log.warn('Accessibility Automation will not run on legacy headless mode. Switch to new headless mode or avoid using headless mode.');
+            return false;
+        }
+        return true;
+    }
+    catch (error) {
+        log.debug(`Exception in checking capabilities compatibility with Accessibility. Error: ${error}`);
+    }
+    return false;
+};
+export const shouldScanTestForAccessibility = (suiteTitle, testTitle, accessibilityOptions) => {
+    try {
+        const includeTags = Array.isArray(accessibilityOptions?.includeTagsInTestingScope) ? accessibilityOptions?.includeTagsInTestingScope : [];
+        const excludeTags = Array.isArray(accessibilityOptions?.excludeTagsInTestingScope) ? accessibilityOptions?.excludeTagsInTestingScope : [];
+        const fullTestName = suiteTitle + ' ' + testTitle;
+        const excluded = excludeTags?.some((exclude) => fullTestName.includes(exclude));
+        const included = includeTags?.length === 0 || includeTags?.some((include) => fullTestName.includes(include));
+        return !excluded && included;
+    }
+    catch (error) {
+        log.debug('Error while validating test case for accessibility before scanning. Error : ', error);
+    }
+    return false;
+};
+export const isAccessibilityAutomationSession = (accessibilityFlag) => {
+    try {
+        const hasA11yJwtToken = typeof process.env.BSTACK_A11Y_JWT === 'string' && process.env.BSTACK_A11Y_JWT.length > 0 && process.env.BSTACK_A11Y_JWT !== 'null' && process.env.BSTACK_A11Y_JWT !== 'undefined';
+        return accessibilityFlag && hasA11yJwtToken;
+    }
+    catch (error) {
+        log.debug(`Exception in verifying the Accessibility session with error : ${error}`);
+    }
+    return false;
+};
+export const createAccessibilityTestRun = errorHandler(async function createAccessibilityTestRun(options, config, bsConfig) {
+    const userName = getBrowserStackUser(config);
+    const accessKey = getBrowserStackKey(config);
+    if (isUndefined(userName) || isUndefined(accessKey)) {
+        log.error('Exception while creating test run for BrowserStack Accessibility Automation: Missing BrowserStack credentials');
+        return null;
+    }
+    const data = {
+        'projectName': bsConfig.projectName,
+        'buildName': bsConfig.buildName ||
+            path.basename(path.resolve(process.cwd())),
+        'startTime': (new Date()).toISOString(),
+        'description': '',
+        'source': {
+            frameworkName: 'WebdriverIO-' + config.framework,
+            frameworkVersion: bsConfig.bstackServiceVersion,
+            sdkVersion: bsConfig.bstackServiceVersion
+        },
+        'settings': bsConfig.accessibilityOptions || {},
+        'versionControl': await getGitMetaData(),
+        'ciInfo': getCiInfo(),
+        'hostInfo': {
+            hostname: hostname(),
+            platform: platform(),
+            type: type(),
+            version: version(),
+            arch: arch()
+        },
+        'browserstackAutomation': true,
+    };
+    const requestOptions = {
+        json: data,
+        username: getBrowserStackUser(config),
+        password: getBrowserStackKey(config),
+    };
+    try {
+        const response = await nodeRequest('POST', 'test_runs', requestOptions, ACCESSIBILITY_API_URL);
+        log.debug(`[Create Accessibility Test Run] Success response: ${JSON.stringify(response)}`);
+        if (response.data.accessibilityToken) {
+            process.env.BSTACK_A11Y_JWT = response.data.accessibilityToken;
+        }
+        if (response.data.id) {
+            process.env.BS_A11Y_TEST_RUN_ID = response.data.id;
+        }
+        log.debug(`BrowserStack Accessibility Automation Test Run ID: ${response.data.id}`);
+        return response.data.scannerVersion;
+    }
+    catch (error) {
+        if (error.response) {
+            log.error(`Exception while creating test run for BrowserStack Accessibility Automation: ${error.response.status} ${error.response.statusText} ${JSON.stringify(error.response.data)}`);
+        }
+        else {
+            const errorMessage = error.message;
+            if (errorMessage === 'Invalid configuration passed.') {
+                log.error(`Exception while creating test run for BrowserStack Accessibility Automation: ${errorMessage || error.stack}`);
+                for (const errorkey of error.errors) {
+                    log.error(errorkey.message);
+                }
+            }
+            else {
+                log.error(`Exception while creating test run for BrowserStack Accessibility Automation: ${errorMessage || error.stack}`);
+            }
+        }
+        return null;
+    }
+});
+export const getA11yResults = async (browser, isBrowserStackSession, isAccessibility) => {
+    if (!isBrowserStackSession) {
+        log.warn('Not a BrowserStack Automate session, cannot retrieve Accessibility results.');
+        return []; // since we are running only on Automate as of now
+    }
+    if (!isAccessibilityAutomationSession(isAccessibility)) {
+        log.warn('Not an Accessibility Automation session, cannot retrieve Accessibility results.');
+        return [];
+    }
+    try {
+        const results = await browser.execute(accessibilityResults);
+        return results;
+    }
+    catch {
+        log.error('No accessibility results were found.');
+        return [];
+    }
+};
+export const getA11yResultsSummary = async (browser, isBrowserStackSession, isAccessibility) => {
+    if (!isBrowserStackSession) {
+        return {}; // since we are running only on Automate as of now
+    }
+    if (!isAccessibilityAutomationSession(isAccessibility)) {
+        log.warn('Not an Accessibility Automation session, cannot retrieve Accessibility results summary.');
+        return {};
+    }
+    try {
+        const summaryResults = await browser.execute(accessibilityResultsSummary);
+        return summaryResults;
+    }
+    catch {
+        log.error('No accessibility summary was found.');
+        return {};
+    }
+};
+export const stopAccessibilityTestRun = errorHandler(async function stopAccessibilityTestRun() {
+    const hasA11yJwtToken = typeof process.env.BSTACK_A11Y_JWT === 'string' && process.env.BSTACK_A11Y_JWT.length > 0 && process.env.BSTACK_A11Y_JWT !== 'null' && process.env.BSTACK_A11Y_JWT !== 'undefined';
+    if (!hasA11yJwtToken) {
+        return {
+            status: 'error',
+            message: 'Build creation had failed.'
+        };
+    }
+    const data = {
+        'endTime': (new Date()).toISOString(),
+    };
+    const requestOptions = { ...{
+            json: data,
+            headers: {
+                'Authorization': `Bearer ${process.env.BSTACK_A11Y_JWT}`,
+            }
+        } };
+    try {
+        const response = await nodeRequest('PUT', 'test_runs/stop', requestOptions, ACCESSIBILITY_API_URL);
+        if (response.data && response.data.error) {
+            throw new Error('Invalid request: ' + response.data.error);
+        }
+        else if (response.error) {
+            throw new Error('Invalid request: ' + response.error);
+        }
+        else {
+            log.info(`BrowserStack Accessibility Automation Test Run marked as completed at ${new Date().toISOString()}`);
+            return { status: 'success', message: '' };
+        }
+    }
+    catch (error) {
+        if (error.response && error.response.status && error.response.statusText && error.response.data) {
+            log.error(`Exception while marking completion of BrowserStack Accessibility Automation Test Run: ${error.response.status} ${error.response.statusText} ${JSON.stringify(error.response.data)}`);
+        }
+        else {
+            log.error(`Exception while marking completion of BrowserStack Accessibility Automation Test Run: ${error.message || util.format(error)}`);
+        }
+        return {
+            status: 'error',
+            message: error.message ||
+                (error.response ? `${error.response.status}:${error.response.statusText}` : error)
+        };
+    }
+});
 export const stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstream() {
     if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
         return;
@@ -593,6 +833,24 @@ export function getObservabilityBuildTags(options, bstackBuildTag) {
     }
     return [];
 }
+export function getBrowserStackUser(config) {
+    if (process.env.BROWSERSTACK_USERNAME) {
+        return process.env.BROWSERSTACK_USERNAME;
+    }
+    return config.user;
+}
+export function getBrowserStackKey(config) {
+    if (process.env.BROWSERSTACK_ACCESS_KEY) {
+        return process.env.BROWSERSTACK_ACCESS_KEY;
+    }
+    return config.key;
+}
+export function isUndefined(value) {
+    return value === undefined || value === null;
+}
+export function isTrue(value) {
+    return (value + '') === 'true';
+}
 export function frameworkSupportsHook(hook, framework) {
     if (framework === 'mocha' && (hook === 'before' || hook === 'after' || hook === 'beforeEach' || hook === 'afterEach')) {
         return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "8.16.6",
+  "version": "8.16.7",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "Adam Bjerstedt <abjerstedt@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
@@ -32,8 +32,8 @@
   "dependencies": {
     "@types/gitconfiglocal": "^2.0.1",
     "@wdio/logger": "8.11.0",
-    "@wdio/reporter": "8.16.3",
-    "@wdio/types": "8.16.3",
+    "@wdio/reporter": "8.16.7",
+    "@wdio/types": "8.16.7",
     "browserstack-local": "^1.5.1",
     "csv-writer": "^1.6.0",
     "form-data": "^4.0.0",
@@ -41,17 +41,18 @@
     "gitconfiglocal": "^2.1.0",
     "got": "^ 12.6.1",
     "uuid": "^9.0.0",
-    "webdriverio": "8.16.6",
+    "webdriverio": "8.16.7",
     "winston-transport": "^4.5.0"
   },
   "peerDependencies": {
     "@wdio/cli": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
   },
   "devDependencies": {
-    "@types/node": "^20.1.0"
+    "@types/node": "^20.1.0",
+    "@wdio/globals": "8.16.7"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "aa35c291fb496b80350766d674385ea7b4d1516a"
+  "gitHead": "15f7f225e6a81ea0e5e7a9ba8067ca59007f09c2"
 }