@wdio/browserstack-service 9.30.2 → 9.32.0

package/build/insights-handler.d.ts

@@ -33,6 +33,7 @@ declare class _InsightsHandler {
     getCucumberHookUniqueId(hookType: string, hook: CucumberHook | undefined): string | null;
     getCucumberFeatureUniqueId(): string;
     setCurrentHook(hookDetails: CurrentRunInfo): void;
+    getCurrentHook(): CurrentRunInfo;
     sendScenarioObjectSkipped(scenario: Scenario, feature: Feature, uri: string): Promise<void>;
     processCucumberHook(test: CucumberHook | undefined, params: CucumberHookParams, result?: Frameworks.TestResult): Promise<void>;
     beforeHook(test: Frameworks.Test | CucumberHook | undefined, context: unknown): Promise<void>;

package/build/types.d.ts

@@ -129,6 +129,17 @@ export interface BrowserstackConfig {
      * @default undefined
      */
     app?: string | AppConfig;
+    /**
+     * Treat this session as App Automate without the SDK managing the app.
+     * When `true`, the SDK classifies the run as App Automate, does NOT upload
+     * an app, and does NOT inject an `appium:app` capability — you supply the
+     * app reference yourself via the `appium:app` driver capability.
+     * When explicitly `false` and no `app` is provided, the SDK throws a
+     * config error before the run starts. Leaving it unset preserves existing
+     * behaviour.
+     * @default undefined
+     */
+    skipAppOverride?: boolean;
     /**
      * Enable routing connections from BrowserStack cloud through your computer.
      * You will also need to set `browserstack.local` to true in browser capabilities.

package/build/util.d.ts

@@ -80,8 +80,9 @@ export declare const shouldScanTestForAccessibility: (suiteTitle: string | undef
 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, testName?: string) => {
+export declare const _getParamsForAppAccessibility: (commandName?: string, testName?: string, hookRunUuid?: string | null) => {
     thTestRunUuid: any;
+    thHookRunUuid: any;
     thBuildUuid: any;
     thJwtToken: any;
     authHeader: any;
@@ -89,7 +90,7 @@ export declare const _getParamsForAppAccessibility: (commandName?: string, testN
     method: string | undefined;
     testName: string | undefined;
 };
-export declare const performA11yScan: (isAppAutomate: boolean, browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, isBrowserStackSession?: boolean, isAccessibility?: boolean | string, commandName?: string, testName?: string) => Promise<{
+export declare const performA11yScan: (isAppAutomate: boolean, browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, isBrowserStackSession?: boolean, isAccessibility?: boolean | string, commandName?: string, testName?: string, hookRunUuid?: string | null) => Promise<{
     [key: string]: any;
 } | undefined>;
 export declare const getA11yResults: (...args: (object | boolean | undefined | null | string)[]) => any;
@@ -160,6 +161,24 @@ export declare function getBrowserStackKey(config: Options.Testrunner): string |
 export declare function isUndefined(value: unknown): boolean;
 export declare function isTrue(value?: unknown): boolean;
 export declare function isFalse(value?: unknown): boolean;
+/**
+ * skipAppOverride validation chokepoint — ported from the Node SDK's
+ * validateSkipAppOverride (helper.js) / Java BrowserStackJavaAgent.processAppOptions.
+ * Called ONCE from the launcher (main process, pre-session). Emits the fixed warning,
+ * handles the three edge cases, and clears the app on conflict so it is neither uploaded
+ * nor injected. There is NO Tier-2 branch: every WebdriverIO test framework
+ * (mocha/jasmine/cucumber) supports App Automate.
+ *
+ * The standard warning and the edge-2 error are verbatim with the other BrowserStack SDKs
+ * (BrowserStackJavaAgent#processAppOptions). The edge-1 conflict warning is INTENTIONALLY adapted for
+ * WebdriverIO — it says "browserstack service options" (where WDIO reads `app`), not "browserstack.yml" —
+ * so please do NOT "fix" it back to the yml wording to match the other SDKs.
+ * Graceful: never throws except the deliberate edge-2 config error (explicit false + no app),
+ * which fires pre-session so the run aborts cleanly.
+ *
+ * Mutates `options.app` (edge-1). 3-state via isTrue/isFalse — never `!options.skipAppOverride`.
+ */
+export declare function validateSkipAppOverride(options?: BrowserstackConfig & BrowserstackOptions): void;
 export declare function frameworkSupportsHook(hook: string, framework?: string): boolean;
 export declare const patchConsoleLogs: (...args: unknown[]) => any;
 export declare function getFailureObject(error: string | Error): {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "9.30.2",
+  "version": "9.32.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "BrowserStack <support@browserstack.com>",
   "homepage": "https://github.com/browserstack/wdio-browserstack-service",