@wdio/browserstack-service 0.0.0-canary-20260722132416

package/build/types.d.ts

@@ -0,0 +1,413 @@
+import type { Capabilities, Options, Frameworks } from '@wdio/types';
+import type { Options as BSOptions } from 'browserstack-local';
+export interface SessionResponse {
+    automation_session: {
+        browser_url: string;
+    };
+}
+export interface TurboScaleSessionResponse {
+    url: string;
+}
+export type MultiRemoteAction = (sessionId: string, browserName?: string) => Promise<any>;
+export type AppConfig = {
+    id?: string;
+    path?: string;
+    custom_id?: string;
+    shareable_id?: string;
+};
+export interface AppUploadResponse {
+    app_url?: string;
+    custom_id?: string;
+    shareable_id?: string;
+}
+export interface App {
+    app?: string;
+    customId?: string;
+}
+export interface TestObservabilityOptions {
+    buildName?: string;
+    projectName?: string;
+    buildTag?: string[];
+    user?: string;
+    key?: string;
+    /**
+     * When set to true, hook failures will not influence the test status.
+     * Tests will be marked as "passed" if all test steps pass, even if hooks fail.
+     * When set to false or not set (default), hook failures will mark tests as "failed".
+     * @default false
+     */
+    ignoreHooksStatus?: boolean;
+}
+export interface TestReportingOptions {
+    buildName?: string;
+    projectName?: string;
+    buildTag?: string[];
+    user?: string;
+    key?: string;
+}
+export interface TestManagementOptions {
+    testPlanId?: string;
+}
+export interface RunSmartSelectionOptions {
+    enabled?: boolean;
+    mode?: string;
+    source?: string | string[];
+}
+export interface TestOrchestrationOptions {
+    runSmartSelection?: RunSmartSelectionOptions;
+}
+export interface BrowserstackOptions extends Options.Testrunner {
+    selfHeal?: boolean;
+}
+export interface BrowserstackConfig {
+    /**
+     *`buildIdentifier` is a unique id to differentiate every execution that gets appended to
+     * buildName. Choose your buildIdentifier format from the available expressions:
+     * ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+     * ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+     */
+    buildIdentifier?: string;
+    /**
+     * Set this to true to enable BrowserStack Test Reporting and Analytics which will collect test related data
+     * (name, hierarchy, status, error stack trace, file name and hierarchy), test commands, etc.
+     * and show all the data in a meaningful manner in BrowserStack Test Reporting and Analytics dashboards for faster test debugging and better insights.
+     * @default true
+     * @deprecated Use testReporting instead
+     */
+    testObservability?: boolean;
+    /**
+     * Set this to true to enable BrowserStack Test Reporting and Analytics which will collect test related data
+     * (name, hierarchy, status, error stack trace, file name and hierarchy), test commands, etc.
+     * and show all the data in a meaningful manner in BrowserStack Test Reporting and Analytics dashboards for faster test debugging and better insights.
+     * @default true
+     */
+    testReporting?: boolean;
+    /**
+     * Set the Test Reporting and Analytics related config options under this key.
+     * For e.g. buildName, projectName, BrowserStack access credentials, etc.
+     * @deprecated Use testReportingOptions instead
+     */
+    testObservabilityOptions?: TestObservabilityOptions;
+    /**
+     * Set the Test Reporting and Analytics related config options under this key.
+     * For e.g. buildName, projectName, BrowserStack access credentials, etc.
+     */
+    testReportingOptions?: TestReportingOptions;
+    /**
+     * Set the Test Management related config options under this key.
+     * Currently supports testPlanId.
+     */
+    testManagementOptions?: TestManagementOptions;
+    /**
+     * Set this to true to enable BrowserStack Percy which will take screenshots
+     * and snapshots for your tests run on Browserstack
+     * @default false
+     */
+    percy?: boolean;
+    /**
+     * Accepts mode as a string to auto capture screenshots at different execution points
+     * Accepted values are auto, click, testcase, screenshot & manual
+     */
+    percyCaptureMode?: string;
+    /**
+     * Set the Percy related config options under this key.
+    */
+    percyOptions?: any;
+    /**
+    * 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
+     * custom_id, sharable_id of the uploaded app
+     * @default undefined
+     */
+    app?: string | AppConfig;
+    /**
+     * Enable routing connections from BrowserStack cloud through your computer.
+     * You will also need to set `browserstack.local` to true in browser capabilities.
+     * @default false
+     */
+    browserstackLocal?: boolean;
+    /**
+     * 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.__
+     * @default false
+     */
+    forcedStop?: boolean;
+    /**
+     * BrowserStack Local options. For more details check out the
+     * [`browserstack-local`](https://www.npmjs.com/package/browserstack-local#arguments) docs.
+     *
+     * @example
+     * ```js
+     * {
+     *   localIdentifier: 'some-identifier'
+     * }
+     * ```
+     * @default {}
+     */
+    opts?: Partial<BSOptions>;
+    /**
+     * 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).
+     * @default false
+     */
+    preferScenarioName?: boolean;
+    /**
+     * Customize the BrowserStack Automate session name format.
+     * @default undefined
+     */
+    sessionNameFormat?: (config: Options.Testrunner, capabilities: Capabilities.RemoteCapability, suiteTitle: string, testTitle?: string) => string;
+    /**
+     * Mocha only. Do not append the test title to the BrowserStack Automate session name.
+     * @default false
+     */
+    sessionNameOmitTestTitle?: boolean;
+    /**
+     * Mocha only. Prepend the top level suite title to the BrowserStack Automate session name.
+     * @default false
+     */
+    sessionNamePrependTopLevelSuiteTitle?: boolean;
+    /**
+     * Automatically set the BrowserStack Automate session name.
+     * @default true
+     */
+    setSessionName?: boolean;
+    /**
+     * Automatically set the BrowserStack Automate session status (passed/failed).
+     * @default true
+     */
+    setSessionStatus?: boolean;
+    /**
+     * Set this to true while running tests on the automation grid created using BrowserStack Automate TurboScale
+     * to automatically set the session name and status for quick debugging.
+     * @default false
+    */
+    turboScale?: boolean;
+    /**
+     * Set this to true to enable enterprise whitelisting
+     * @default false
+    */
+    ipWhiteListing?: boolean;
+    /**
+     * Set the Test Orchestration related config options under this key.
+     * For e.g. runSmartSelection configurations, etc.
+     */
+    testOrchestrationOptions?: TestOrchestrationOptions;
+}
+/**
+ * Observability types
+ */
+export interface PlatformMeta {
+    sessionId?: string;
+    browserName?: string;
+    browserVersion?: string;
+    platformName?: string;
+    caps?: WebdriverIO.Capabilities;
+    product?: string;
+}
+export interface TestMeta {
+    uuid?: string;
+    startedAt?: string;
+    finishedAt?: string;
+    steps?: StepData[];
+    feature?: {
+        name: string;
+        path?: string;
+        description: string | null;
+    };
+    scenario?: {
+        name: string;
+    };
+    examples?: string[];
+    hookType?: string;
+    testRunId?: string;
+}
+export interface CurrentRunInfo {
+    uuid?: string;
+    name?: string;
+    test?: Frameworks.Test;
+    finished?: boolean;
+}
+export interface TestData {
+    uuid?: string;
+    type?: string;
+    name?: string;
+    scope?: string;
+    scopes?: string[];
+    identifier?: string;
+    file_name?: string;
+    vc_filepath?: string;
+    location?: string;
+    started_at?: string;
+    finished_at?: string;
+    framework?: string;
+    body?: TestCodeBody;
+    result?: string;
+    failure?: Failure[];
+    failure_reason?: string;
+    failure_type?: string | null;
+    retries?: {
+        limit: number;
+        attempts: number;
+    };
+    duration_in_ms?: number;
+    integrations?: {
+        [index: string]: IntegrationObject;
+    };
+    hook_type?: string;
+    hooks?: string[];
+    meta?: TestMeta;
+    tags?: string[];
+    test_run_id?: string;
+    product_map?: {};
+}
+export interface UserConfig {
+    buildName?: string;
+    projectName?: string;
+    buildTag?: string;
+    bstackServiceVersion?: string;
+    buildIdentifier?: string;
+    accessibilityOptions?: {
+        [key: string]: any;
+    };
+}
+export interface UploadType {
+    event_type: string;
+    hook_run?: TestData;
+    test_run?: TestData | CBTData;
+    logs?: LogData[];
+}
+export interface LogData {
+    timestamp: string;
+    kind: 'TEST_LOG' | 'TEST_STEP' | 'HTTP' | 'TEST_SCREENSHOT';
+    test_run_uuid?: string;
+    hook_run_uuid?: string;
+    message?: string;
+    level?: string;
+    http_response?: any;
+}
+export interface StdLog extends LogData {
+    kind: 'TEST_LOG';
+}
+export interface ScreenshotLog extends LogData {
+    kind: 'TEST_SCREENSHOT';
+}
+export interface LaunchResponse {
+    jwt: string;
+    build_hashed_id: string;
+    observability?: {
+        success: boolean;
+        options: {
+            allow_screenshots?: boolean;
+        };
+        errors?: {
+            key: string;
+            message: string;
+        }[];
+    };
+    accessibility?: {
+        success: boolean;
+        errors?: {
+            key: string;
+            message: string;
+        }[];
+        options: {
+            status: string;
+            commandsToWrap: {
+                scriptsToRun: string[];
+                commands: any[];
+            };
+            scripts: {
+                name: string;
+                command: string;
+            }[];
+            capabilities: {
+                name: string;
+                value: any;
+            }[];
+        };
+    };
+}
+export interface UserConfigforReporting {
+    framework?: string;
+    services?: any[];
+    capabilities?: Capabilities.RemoteCapability;
+    env?: {
+        'BROWSERSTACK_BUILD': string | undefined;
+        'BROWSERSTACK_BUILD_NAME': string | undefined;
+        'BUILD_TAG': string | undefined;
+    };
+}
+export interface CredentialsForCrashReportUpload {
+    username?: string;
+    password?: string;
+}
+interface IntegrationObject {
+    capabilities?: WebdriverIO.Capabilities;
+    session_id?: string;
+    browser?: string;
+    browser_version?: string;
+    platform?: string;
+    product?: string;
+    platform_version?: string;
+}
+interface TestCodeBody {
+    lang: string;
+    code?: string | null;
+}
+interface StepData {
+    id?: string;
+    text?: string;
+    keyword?: string;
+    started_at?: string;
+    finished_at?: string;
+    result?: string;
+    duration?: number;
+    failure?: string;
+}
+interface Failure {
+    backtrace: string[];
+}
+export interface FeatureStatsOverview {
+    triggeredCount: number;
+    sentCount: number;
+    failedCount: number;
+}
+export interface FeaturesUsageData {
+    isTriggered?: boolean;
+    status?: string;
+    error?: string;
+}
+export interface CBTData {
+    uuid: string;
+    integrations: {
+        [index: string]: IntegrationObject;
+    };
+}
+export interface TOUsageStats {
+    enabled: boolean;
+    manuallySet: boolean;
+    buildHashedId?: string;
+    events?: any;
+}
+export interface TOStopData {
+    finished_at: string;
+    finished_metadata: Array<any>;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +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,WAAW,yBAAyB;IACtC,GAAG,EAAE,MAAM,CAAA;CACd;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,CAAC;IACb;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAGD,MAAM,WAAW,oBAAoB;IACjC,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,qBAAqB;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACrC,iBAAiB,CAAC,EAAE,wBAAwB,CAAA;CAC/C;AAED,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,UAAU;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;MAEE;IACF,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;;;;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;IAC1B;;;;MAIE;IACF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;MAGE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACvD;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,WAAW,CAAC,YAAY,CAAC;IAChC,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,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,CAAC;IACrB,WAAW,CAAC,EAAE,EAAE,CAAA;CACnB;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,GAAC,OAAO,CAAC;IAC5B,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,OAAO;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,UAAU,GAAC,WAAW,GAAC,MAAM,GAAC,iBAAiB,CAAA;IACrD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,GAAG,CAAA;CACtB;AAED,MAAM,WAAW,MAAO,SAAQ,OAAO;IACnC,IAAI,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC1C,IAAI,EAAE,iBAAiB,CAAA;CAC1B;AAED,MAAM,WAAW,cAAc;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE;YACL,iBAAiB,CAAC,EAAE,OAAO,CAAC;SAC/B,CAAC;QACF,MAAM,CAAC,EAAE;YACL,GAAG,EAAE,MAAM,CAAC;YACZ,OAAO,EAAE,MAAM,CAAC;SACnB,EAAE,CAAC;KACP,CAAC;IACF,aAAa,CAAC,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE;YACL,GAAG,EAAE,MAAM,CAAC;YACZ,OAAO,EAAE,MAAM,CAAC;SACnB,EAAE,CAAC;QACJ,OAAO,EAAE;YACL,MAAM,EAAE,MAAM,CAAC;YACf,cAAc,EAAE;gBACZ,YAAY,EAAE,MAAM,EAAE,CAAC;gBACvB,QAAQ,EAAE,GAAG,EAAE,CAAC;aACnB,CAAC;YACF,OAAO,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC;gBACb,OAAO,EAAE,MAAM,CAAC;aACnB,EAAE,CAAC;YACJ,YAAY,EAAE;gBACV,IAAI,EAAE,MAAM,CAAC;gBACb,KAAK,EAAE,GAAG,CAAA;aACb,EAAE,CAAC;SACP,CAAA;KACJ,CAAC;CACL;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,WAAW,CAAC,YAAY,CAAC;IACxC,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;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC5B;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;AAED,MAAM,WAAW,oBAAoB;IACjC,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,OAAO;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAA;KAAE,CAAA;CACvD;AAED,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,GAAG,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;CACjC"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/build/util.d.ts

@@ -0,0 +1,241 @@
+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 { ColorName } from 'chalk';
+import type { UploadType, LaunchResponse, BrowserstackConfig } from './types.js';
+import type { ITestCaseHookParameter } from './cucumber-types.js';
+import type { StartBinSessionResponse } from './grpc/index.js';
+export type GitMetaData = {
+    name: string;
+    sha: string;
+    short_sha: string;
+    branch: string;
+    tag: string | null;
+    committer: string;
+    committer_date: string;
+    author: string;
+    author_date: string;
+    commit_message: string;
+    root: string;
+    common_git_dir: string;
+    worktree_git_dir: string;
+    last_tag: string | null;
+    commits_since_last_tag: number;
+    remotes: Array<{
+        name: string;
+        url: string;
+    }>;
+};
+export declare const DEFAULT_REQUEST_CONFIG: {
+    agent: {
+        http: http.Agent;
+        https: https.Agent;
+    };
+    headers: {
+        'Content-Type': string;
+        'X-BSTACK-OBS': string;
+    };
+};
+export declare const COLORS: Record<string, ColorName>;
+/**
+ * get browser description for Browserstack service
+ * @param cap browser capablities
+ */
+export declare function getBrowserDescription(cap: Capabilities.DesiredCapabilities): string;
+/**
+ * get correct browser capabilities object in both multiremote and normal setups
+ * @param browser browser object
+ * @param caps browser capbilities object. In case of multiremote, the object itself should have a property named 'capabilities'
+ * @param browserName browser name in case of multiremote
+ */
+export declare function getBrowserCapabilities(browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, caps?: Capabilities.RemoteCapability, browserName?: string): WebdriverIO.Capabilities;
+/**
+ * check for browserstack W3C capabilities. Does not support legacy capabilities
+ * @param cap browser capabilities
+ */
+export declare function isBrowserstackCapability(cap?: WebdriverIO.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<any>;
+type ClassType = {
+    new (...args: any[]): any;
+};
+export declare function o11yClassErrorHandler<T extends ClassType>(errorClass: T): T;
+export declare const processTestObservabilityResponse: (response: LaunchResponse) => void;
+export declare const performO11ySync: (browser: WebdriverIO.Browser) => Promise<void>;
+interface DataElement {
+    [key: string]: any;
+}
+export declare const jsonifyAccessibilityArray: (dataArray: DataElement[], keyName: keyof DataElement, valueName: keyof DataElement) => Record<string, any>;
+export declare const processAccessibilityResponse: (response: LaunchResponse | StartBinSessionResponse, options: BrowserstackConfig & Options.Testrunner) => void;
+export declare const processLaunchBuildResponse: (response: LaunchResponse, options: BrowserstackConfig & Options.Testrunner) => void;
+export declare const launchTestSession: (...args: any[]) => any;
+export declare const validateCapsWithAppA11y: (platformMeta?: {
+    [key: string]: any;
+}) => boolean;
+export declare const validateCapsWithA11y: (deviceName?: any, platformMeta?: {
+    [key: string]: any;
+}, chromeOptions?: any) => boolean;
+export declare const validateCapsWithNonBstackA11y: (browserName?: string | undefined, browserVersion?: string | undefined) => boolean;
+export declare const shouldScanTestForAccessibility: (suiteTitle: string | undefined, testTitle: string, accessibilityOptions?: {
+    [key: string]: any;
+}, world?: {
+    [key: string]: any;
+}, isCucumber?: boolean) => boolean;
+export declare const isAccessibilityAutomationSession: (accessibilityFlag?: boolean | string | null) => boolean | "" | null | undefined;
+export declare const isAppAccessibilityAutomationSession: (accessibilityFlag?: boolean | string, isAppAutomate?: boolean) => boolean | "" | null | undefined;
+export declare const formatString: (template: (string | null), ...values: (string | null)[]) => string;
+export declare const _getParamsForAppAccessibility: (commandName?: string) => {
+    thTestRunUuid: any;
+    thBuildUuid: any;
+    thJwtToken: any;
+    authHeader: any;
+    scanTimestamp: Number;
+    method: string | undefined;
+};
+export declare const performA11yScan: (isAppAutomate: boolean, browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, isBrowserStackSession?: boolean, isAccessibility?: boolean | string, commandName?: string) => Promise<{
+    [key: string]: any;
+} | undefined>;
+export declare const getA11yResults: (...args: any[]) => any;
+export declare const getAppA11yResults: (...args: any[]) => any;
+export declare const getAppA11yResultsSummary: (...args: any[]) => any;
+export declare const getA11yResultsSummary: (...args: any[]) => any;
+export declare const stopBuildUpstream: (...args: any[]) => any;
+export declare function getCiInfo(): {
+    name: string;
+    build_url: string | undefined;
+    job_name: string | undefined;
+    build_number: string | undefined;
+} | {
+    name: string;
+    build_url: string | undefined;
+    job_name: string | null;
+    build_number: string | undefined;
+} | {
+    name: string;
+    build_url: null;
+    job_name: string | undefined;
+    build_number: string | undefined;
+} | {
+    name: string;
+    build_url: string;
+    job_name: null;
+    build_number: null;
+} | {
+    name: string;
+    build_url: null;
+    job_name: null;
+    build_number: string | undefined;
+} | {
+    name: string;
+    build_url: null;
+    job_name: string | null;
+    build_number: string | null;
+} | null;
+export declare function getGitMetaData(): Promise<GitMetaData | undefined>;
+export declare function getUniqueIdentifier(test: Frameworks.Test, framework?: string): string;
+export declare function getUniqueIdentifierForCucumber(world: ITestCaseHookParameter): string;
+export declare function getCloudProvider(browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser): string;
+export declare function isBrowserstackSession(browser?: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser): boolean | undefined;
+/**
+ * Sets a BrowserStack annotation with the provided message
+ * @param browser - The WebDriver browser instance
+ * @param message - The annotation message to set
+ * @param isAccessibilityEnabled - Whether accessibility is enabled for the session
+ */
+export declare function setBrowserstackAnnotation(browser: WebdriverIO.Browser, message: string, isAccessibilityEnabled: boolean): Promise<void>;
+export declare function getScenarioExamples(world: ITestCaseHookParameter): string[] | undefined;
+export declare function removeAnsiColors(message: string): string;
+export declare function getLogTag(eventType: string): string;
+export declare function getHierarchy(fullTitle?: string): string[];
+export declare function getHookType(hookName: string): string;
+export declare function isScreenshotCommand(args: BeforeCommandArgs | AfterCommandArgs): boolean | "" | undefined;
+export declare function isBStackSession(config: Options.Testrunner): boolean;
+export declare function isBrowserstackInfra(config: BrowserstackConfig & Options.Testrunner, caps?: Capabilities.BrowserStackCapabilities): boolean;
+export declare function getBrowserStackUserAndKey(config: Options.Testrunner, options: Options.Testrunner): {
+    user: string | undefined;
+    key: string | undefined;
+} | undefined;
+export declare function shouldAddServiceVersion(config: Options.Testrunner, testObservability?: boolean, caps?: Capabilities.BrowserStackCapabilities): boolean;
+export declare function batchAndPostEvents(eventUrl: string, kind: string, data: UploadType[]): Promise<void>;
+export declare function normalizeTestReportingConfig(_options: BrowserstackConfig & Options.Testrunner): void;
+export declare function normalizeTestReportingEnvVariables(): void;
+export declare function getObservabilityUser(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner): string | undefined;
+export declare function getObservabilityKey(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner): string | undefined;
+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 getTestPlanId(options: BrowserstackConfig & Options.Testrunner): string | undefined;
+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 isFalse(value?: any): boolean;
+export declare function frameworkSupportsHook(hook: string, framework?: string): boolean;
+export declare const patchConsoleLogs: (...args: any) => any;
+export declare function getFailureObject(error: string | Error): {
+    failure: {
+        backtrace: string[];
+    }[];
+    failure_reason: string;
+    failure_type: string | null;
+};
+export declare function truncateString(field: string, truncateSizeInBytes: number): string;
+export declare function getSizeOfJsonObjectInBytes(jsonData: GitMetaData): number;
+export declare function checkAndTruncateVCSInfo(gitMetaData: GitMetaData): GitMetaData;
+export declare const sleep: (ms?: number) => Promise<unknown>;
+export declare function uploadLogs(user: string | undefined, key: string | undefined, clientBuildUuid: string): Promise<any>;
+export declare const isObject: (object: any) => boolean;
+export declare const ObjectsAreEqual: (object1: any, object2: any) => boolean;
+export declare const getPlatformVersion: (...args: any) => any;
+export declare const isObjectEmpty: (objectName: unknown) => unknown;
+export declare const getErrorString: (err: unknown) => string | undefined;
+export declare function isTurboScale(options: (BrowserstackConfig & Options.Testrunner) | undefined): boolean;
+export declare function getObservabilityProduct(options: (BrowserstackConfig & Options.Testrunner) | undefined, isAppAutomate: boolean | undefined): string;
+export declare const hasBrowserName: (cap: Options.Testrunner) => boolean;
+export declare const isValidCapsForHealing: (caps: {
+    [key: string]: Options.Testrunner;
+}) => boolean;
+type PollingResult = {
+    data: any;
+    headers: Record<string, any>;
+    message?: string;
+};
+export declare function pollApi(url: string, params: Record<string, any>, headers: Record<string, string>, upperLimit: number, startTime?: number): Promise<PollingResult>;
+export declare function getBooleanValueFromString(value: string | undefined): boolean;
+/**
+ * Validate boolean value from mixed types (boolean or string)
+ * Only accepts true boolean or string "true" (case insensitive)
+ */
+export declare function isValidEnabledValue(value: boolean | string | undefined): boolean;
+export declare function mergeDeep(target: Record<string, any>, ...sources: any[]): Record<string, any>;
+export declare function mergeChromeOptions(base: Capabilities.ChromeOptions, override: Partial<Capabilities.ChromeOptions>): Capabilities.ChromeOptions;
+export declare function isNullOrEmpty(string: any): boolean;
+export declare function isHash(entity: any): boolean;
+export declare function nestedKeyValue(hash: any, keys: Array<string>): any;
+export declare function removeDir(dir: string): void;
+export declare function createDir(dir: string): void;
+export declare function isWritable(dirPath: string): boolean;
+export declare function setReadWriteAccess(dirPath: string): void;
+export declare function getMochaTestHierarchy(test: Frameworks.Test): string[];
+/**
+ * Checks if the capabilities represent a multiremote configuration
+ * @param capabilities - The capabilities to check
+ * @returns true if capabilities represent any multiremote configuration (regular or parallel)
+ *
+ * @example
+ * Regular multiremote (object):
+ * { browserA: { capabilities: {...} }, browserB: { capabilities: {...} } }
+ *
+ * Parallel multiremote (array with nested structure):
+ * [{ browserA: { capabilities: {...} }, browserB: { capabilities: {...} } }]
+ *
+ * Regular capabilities (array):
+ * [{ browserName: 'chrome', ... }]
+ */
+export declare function isMultiRemoteCaps(capabilities: Capabilities.RemoteCapabilities): boolean;
+export {};
+//# sourceMappingURL=util.d.ts.map