@browserstack/mcp-server 1.2.2-beta.1 → 1.2.3-beta.1

package/dist/tools/appautomate.js

@@ -4,14 +4,13 @@ import { getBrowserStackAuth } from "../lib/get-auth.js";
 import { trackMCP } from "../lib/instrumentation.js";
 import { maybeCompressBase64 } from "../lib/utils.js";
 import { remote } from "webdriverio";
-import { AppTestPlatform } from "./appautomate-utils/types.js";
+import { AppTestPlatform } from "./appautomate-utils/native-execution/types.js";
+import { setupAppAutomateHandler } from "./appautomate-utils/appium-sdk/handler.js";
+import { SETUP_APP_AUTOMATE_DESCRIPTION, SETUP_APP_AUTOMATE_SCHEMA, } from "./appautomate-utils/appium-sdk/constants.js";
+import { Platform, } from "./appautomate-utils/native-execution/types.js";
 import { getDevicesAndBrowsers, BrowserStackProducts, } from "../lib/device-cache.js";
-import { findMatchingDevice, getDeviceVersions, resolveVersion, validateArgs, uploadApp, uploadEspressoApp, uploadEspressoTestSuite, triggerEspressoBuild, uploadXcuiApp, uploadXcuiTestSuite, triggerXcuiBuild, } from "./appautomate-utils/appautomate.js";
-var Platform;
-(function (Platform) {
-    Platform["ANDROID"] = "android";
-    Platform["IOS"] = "ios";
-})(Platform || (Platform = {}));
+import { findMatchingDevice, getDeviceVersions, resolveVersion, validateArgs, uploadApp, uploadEspressoApp, uploadEspressoTestSuite, triggerEspressoBuild, uploadXcuiApp, uploadXcuiTestSuite, triggerXcuiBuild, } from "./appautomate-utils/native-execution/appautomate.js";
+import { RUN_APP_AUTOMATE_DESCRIPTION, RUN_APP_AUTOMATE_SCHEMA, } from "./appautomate-utils/native-execution/constants.js";
 /**
  * Launches an app on a selected BrowserStack device and takes a screenshot.
  */
@@ -214,39 +213,7 @@ export default function addAppAutomationTools(server, config) {
             };
         }
     });
-    tools.runAppTestsOnBrowserStack = server.tool("runAppTestsOnBrowserStack", "Run AppAutomate tests on BrowserStack by uploading app and test suite. If running from Android Studio or Xcode, the tool will help export app and test files automatically. For other environments, you'll need to provide the paths to your pre-built app and test files.", {
-        appPath: z
-            .string()
-            .describe("Path to your application file:\n" +
-            "If in development IDE directory:\n" +
-            "• For Android: 'gradle assembleDebug'\n" +
-            "• For iOS:\n" +
-            "  xcodebuild clean -scheme YOUR_SCHEME && \\\n" +
-            "  xcodebuild archive -scheme YOUR_SCHEME -configuration Release -archivePath build/app.xcarchive && \\\n" +
-            "  xcodebuild -exportArchive -archivePath build/app.xcarchive -exportPath build/ipa -exportOptionsPlist exportOptions.plist\n\n" +
-            "If in other directory, provide existing app path"),
-        testSuitePath: z
-            .string()
-            .describe("Path to your test suite file:\n" +
-            "If in development IDE directory:\n" +
-            "• For Android: 'gradle assembleAndroidTest'\n" +
-            "• For iOS:\n" +
-            "  xcodebuild test-without-building -scheme YOUR_SCHEME -destination 'generic/platform=iOS' && \\\n" +
-            "  cd ~/Library/Developer/Xcode/DerivedData/*/Build/Products/Debug-iphonesimulator/ && \\\n" +
-            "  zip -r Tests.zip *.xctestrun *-Runner.app\n\n" +
-            "If in other directory, provide existing test file path"),
-        devices: z
-            .array(z.string())
-            .describe("List of devices to run the test on, e.g., ['Samsung Galaxy S20-10.0', 'iPhone 12 Pro-16.0']."),
-        project: z
-            .string()
-            .optional()
-            .default("BStack-AppAutomate-Suite")
-            .describe("Project name for organizing test runs on BrowserStack."),
-        detectedAutomationFramework: z
-            .string()
-            .describe("The automation framework used in the project, such as 'espresso' (Android) or 'xcuitest' (iOS)."),
-    }, async (args) => {
+    tools.runAppTestsOnBrowserStack = server.tool("runAppTestsOnBrowserStack", RUN_APP_AUTOMATE_DESCRIPTION, RUN_APP_AUTOMATE_SCHEMA, async (args) => {
         try {
             trackMCP("runAppTestsOnBrowserStack", server.server.getClientVersion(), undefined, config);
             return await runAppTestsOnBrowserStack(args, config);
@@ -265,5 +232,23 @@ export default function addAppAutomationTools(server, config) {
             };
         }
     });
+    tools.setupBrowserStackAppAutomateTests = server.tool("setupBrowserStackAppAutomateTests", SETUP_APP_AUTOMATE_DESCRIPTION, SETUP_APP_AUTOMATE_SCHEMA, async (args) => {
+        try {
+            return await setupAppAutomateHandler(args, config);
+        }
+        catch (error) {
+            const error_message = error instanceof Error ? error.message : "Unknown error";
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to bootstrap project with BrowserStack App Automate SDK. Error: ${error_message}. Please open an issue on GitHub if the problem persists`,
+                        isError: true,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    });
     return tools;
 }

package/dist/tools/bstack-sdk.d.ts

@@ -1,4 +1,17 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { SDKSupportedBrowserAutomationFramework, SDKSupportedLanguage, SDKSupportedTestingFramework } from "./sdk-utils/types.js";
 import { BrowserStackConfig } from "../lib/types.js";
-export declare function registerRunBrowserStackTestsTool(server: McpServer, config: BrowserStackConfig): Record<string, any>;
-export default registerRunBrowserStackTestsTool;
+/**
+ * BrowserStack SDK hooks into your test framework to seamlessly run tests on BrowserStack.
+ * This tool gives instructions to setup a browserstack.yml file in the project root and installs the necessary dependencies.
+ */
+export declare function bootstrapProjectWithSDK({ detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, desiredPlatforms, enablePercy, config, }: {
+    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework;
+    detectedTestingFramework: SDKSupportedTestingFramework;
+    detectedLanguage: SDKSupportedLanguage;
+    desiredPlatforms: string[];
+    enablePercy: boolean;
+    config: BrowserStackConfig;
+}): Promise<CallToolResult>;
+export default function addSDKTools(server: McpServer, config: BrowserStackConfig): Record<string, any>;

package/dist/tools/bstack-sdk.js

@@ -1,11 +1,128 @@
-import { RunTestsOnBrowserStackParamsShape } from "./sdk-utils/common/schema.js";
-import { runTestsOnBrowserStackHandler } from "./sdk-utils/handler.js";
-import { RUN_ON_BROWSERSTACK_DESCRIPTION } from "./sdk-utils/common/constants.js";
-export function registerRunBrowserStackTestsTool(server, config) {
+import { z } from "zod";
+import { trackMCP } from "../lib/instrumentation.js";
+import { getSDKPrefixCommand } from "./sdk-utils/commands.js";
+import { SDKSupportedLanguageEnum, SDKSupportedBrowserAutomationFrameworkEnum, SDKSupportedTestingFrameworkEnum, } from "./sdk-utils/types.js";
+import { generateBrowserStackYMLInstructions, getInstructionsForProjectConfiguration, formatInstructionsWithNumbers, } from "./sdk-utils/instructions.js";
+import { formatPercyInstructions, getPercyInstructions, } from "./sdk-utils/percy/instructions.js";
+import { getBrowserStackAuth } from "../lib/get-auth.js";
+/**
+ * BrowserStack SDK hooks into your test framework to seamlessly run tests on BrowserStack.
+ * This tool gives instructions to setup a browserstack.yml file in the project root and installs the necessary dependencies.
+ */
+export async function bootstrapProjectWithSDK({ detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, desiredPlatforms, enablePercy, config, }) {
+    // Get credentials from config
+    const authString = getBrowserStackAuth(config);
+    const [username, accessKey] = authString.split(":");
+    // Handle frameworks with unique setup instructions that don't use browserstack.yml
+    if (detectedBrowserAutomationFramework === "cypress" ||
+        detectedTestingFramework === "webdriverio") {
+        let combinedInstructions = getInstructionsForProjectConfiguration(detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey);
+        if (enablePercy) {
+            const percyInstructions = getPercyInstructions(detectedLanguage, detectedBrowserAutomationFramework, detectedTestingFramework);
+            if (percyInstructions) {
+                combinedInstructions +=
+                    "\n\n" + formatPercyInstructions(percyInstructions);
+            }
+            else {
+                throw new Error(`Percy is currently not supported through MCP for ${detectedLanguage} with ${detectedTestingFramework}. If you want to run the test cases without Percy, disable Percy and run it again.`);
+            }
+        }
+        // Apply consistent formatting for all configurations
+        return formatFinalInstructions(combinedInstructions);
+    }
+    // Handle default flow using browserstack.yml
+    const sdkSetupCommand = getSDKPrefixCommand(detectedLanguage, detectedTestingFramework, username, accessKey);
+    const ymlInstructions = generateBrowserStackYMLInstructions(desiredPlatforms, enablePercy);
+    const instructionsForProjectConfiguration = getInstructionsForProjectConfiguration(detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey);
+    let combinedInstructions = "";
+    // Step 1: Add SDK setup command
+    if (sdkSetupCommand) {
+        combinedInstructions += sdkSetupCommand;
+    }
+    // Step 2: Add browserstack.yml setup
+    if (ymlInstructions) {
+        combinedInstructions += "\n\n---STEP---\n" + ymlInstructions;
+    }
+    // Step 3: Add language/framework-specific setup
+    if (instructionsForProjectConfiguration) {
+        combinedInstructions += "\n\n" + instructionsForProjectConfiguration;
+    }
+    // Step 4: Add Percy setup if applicable
+    if (enablePercy) {
+        const percyInstructions = getPercyInstructions(detectedLanguage, detectedBrowserAutomationFramework, detectedTestingFramework);
+        if (percyInstructions) {
+            combinedInstructions +=
+                "\n\n" + formatPercyInstructions(percyInstructions);
+        }
+        else {
+            throw new Error(`Percy is currently not supported through MCP for ${detectedLanguage} with ${detectedTestingFramework}. If you want to run the test cases without Percy, disable Percy and run it again.`);
+        }
+    }
+    // Apply consistent formatting for all configurations
+    return formatFinalInstructions(combinedInstructions);
+}
+// Helper function to apply consistent formatting to all instruction types
+function formatFinalInstructions(combinedInstructions) {
+    const fullInstructions = `⚠️ IMPORTANT: DO NOT SKIP ANY STEP
+  All the setup steps described in this file MUST be executed regardless of any existing configuration or setup.
+  This ensures proper BrowserStack SDK setup.
+
+  ${formatInstructionsWithNumbers(combinedInstructions)}`;
+    return {
+        content: [
+            {
+                type: "text",
+                text: fullInstructions,
+                isError: false,
+            },
+        ],
+    };
+}
+export default function addSDKTools(server, config) {
     const tools = {};
-    tools.setupBrowserStackAutomateTests = server.tool("setupBrowserStackAutomateTests", RUN_ON_BROWSERSTACK_DESCRIPTION, RunTestsOnBrowserStackParamsShape, async (args) => {
-        return runTestsOnBrowserStackHandler(args, config);
+    tools.setupBrowserStackAutomateTests = server.tool("setupBrowserStackAutomateTests", "Set up and run automated web-based tests on BrowserStack using the BrowserStack SDK. Use for functional or integration tests on BrowserStack, with optional Percy visual testing for supported frameworks. Example prompts: run this test on browserstack; run this test on browserstack with Percy; set up this project for browserstack with Percy. Integrate BrowserStack SDK into your project", {
+        detectedBrowserAutomationFramework: z
+            .nativeEnum(SDKSupportedBrowserAutomationFrameworkEnum)
+            .describe("The automation framework configured in the project. Example: 'playwright', 'selenium'"),
+        detectedTestingFramework: z
+            .nativeEnum(SDKSupportedTestingFrameworkEnum)
+            .describe("The testing framework used in the project. Be precise with framework selection Example: 'webdriverio', 'jest', 'pytest', 'junit4', 'junit5', 'mocha'"),
+        detectedLanguage: z
+            .nativeEnum(SDKSupportedLanguageEnum)
+            .describe("The programming language used in the project. Example: 'nodejs', 'python', 'java', 'csharp'"),
+        desiredPlatforms: z
+            .array(z.enum(["windows", "macos", "android", "ios"]))
+            .describe("The platforms the user wants to test on. Always ask this to the user, do not try to infer this."),
+        enablePercy: z
+            .boolean()
+            .optional()
+            .default(false)
+            .describe("Set to true if the user wants to enable Percy for visual testing. Defaults to false."),
+    }, async (args) => {
+        try {
+            trackMCP("runTestsOnBrowserStack", server.server.getClientVersion(), undefined, config);
+            return await bootstrapProjectWithSDK({
+                detectedBrowserAutomationFramework: args.detectedBrowserAutomationFramework,
+                detectedTestingFramework: args.detectedTestingFramework,
+                detectedLanguage: args.detectedLanguage,
+                desiredPlatforms: args.desiredPlatforms,
+                enablePercy: args.enablePercy,
+                config,
+            });
+        }
+        catch (error) {
+            trackMCP("runTestsOnBrowserStack", server.server.getClientVersion(), error, config);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to bootstrap project with BrowserStack SDK. Error: ${error}. Please open an issue on GitHub if the problem persists`,
+                        isError: true,
+                    },
+                ],
+                isError: true,
+            };
+        }
     });
     return tools;
 }
-export default registerRunBrowserStackTestsTool;

package/dist/tools/sdk-utils/{bstack/commands.d.ts → commands.d.ts}

@@ -1,3 +1,3 @@
-import { SDKSupportedLanguage } from "../common/types.js";
+import { SDKSupportedLanguage } from "./types.js";
 export declare function getSDKPrefixCommand(language: SDKSupportedLanguage, framework: string, username: string, accessKey: string): string;
 export declare function getJavaFrameworkForMaven(framework: string): string;

package/dist/tools/sdk-utils/commands.js

@@ -0,0 +1,65 @@
+// Framework mapping for Java Maven archetype generation
+const JAVA_FRAMEWORK_MAP = {
+    testng: "testng",
+    junit5: "junit5",
+    junit4: "junit4",
+    cucumber: "cucumber-testng",
+    serenity: "serenity",
+};
+// Common Gradle setup instructions (platform-independent)
+const GRADLE_SETUP_INSTRUCTIONS = `
+**For Gradle setup:**
+1. Add browserstack-java-sdk to dependencies:
+   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
+
+2. Add browserstackSDK path variable:
+   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
+3. Add javaagent to gradle tasks:
+   jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
+`;
+export function getSDKPrefixCommand(language, framework, username, accessKey) {
+    switch (language) {
+        case "nodejs":
+            return `---STEP---
+Install BrowserStack Node SDK using command:
+\`\`\`bash
+npm i -D browserstack-node-sdk@latest
+\`\`\`
+---STEP---
+Run the following command to setup browserstack sdk:
+\`\`\`bash
+npx setup --username ${username} --key ${accessKey}
+\`\`\`
+---STEP---
+Edit the browserstack.yml file that was created in the project root to add your desired platforms and browsers.`;
+        case "java": {
+            const mavenFramework = getJavaFrameworkForMaven(framework);
+            const isWindows = process.platform === "win32";
+            const mavenCommand = isWindows
+                ? `mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.0" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.0" -DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" -DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`
+                : `mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \\
+-DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.0 \\
+-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \\
+-DBROWSERSTACK_USERNAME="${username}" \\
+-DBROWSERSTACK_ACCESS_KEY="${accessKey}" \\
+-DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
+            const platformLabel = isWindows ? "Windows" : "macOS/Linux";
+            return `---STEP---
+Install BrowserStack Java SDK
+
+**Maven command for ${framework} (${platformLabel}):**
+Run the command, it is required to generate the browserstack-sdk-archetype-integrate project:
+${mavenCommand}
+
+Alternative setup for Gradle users:
+${GRADLE_SETUP_INSTRUCTIONS}`;
+        }
+        // Add more languages as needed
+        default:
+            return "";
+    }
+}
+export function getJavaFrameworkForMaven(framework) {
+    return JAVA_FRAMEWORK_MAP[framework] || framework;
+}

package/dist/tools/sdk-utils/{bstack/frameworks.d.ts → constants.d.ts}

@@ -1,2 +1,2 @@
-import { ConfigMapping } from "../common/types.js";
+import { ConfigMapping } from "./types.js";
 export declare const SUPPORTED_CONFIGURATIONS: ConfigMapping;

package/dist/tools/sdk-utils/{bstack/constants.js → constants.js}

@@ -1,8 +1,7 @@
 /**
  * ---------- PYTHON INSTRUCTIONS ----------
  */
-export const pythonInstructions = (username, accessKey) => {
-    const setup = `
+const pythonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack SDK:
@@ -16,8 +15,7 @@ Setup the BrowserStack SDK with your credentials:
 \`\`\`bash
 browserstack-sdk setup --username "${username}" --key "${accessKey}"
 \`\`\`
-`;
-    const run = `
+
 ---STEP---
 
 Run your tests on BrowserStack:
@@ -25,10 +23,7 @@ Run your tests on BrowserStack:
 browserstack-sdk python <path-to-test-file>
 \`\`\`
 `;
-    return { setup, run };
-};
-export const generatePythonFrameworkInstructions = (framework) => (username, accessKey) => {
-    const setup = `
+const generatePythonFrameworkInstructions = (framework) => (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack SDK:
@@ -43,8 +38,7 @@ Setup the BrowserStack SDK with framework-specific configuration:
 \`\`\`bash
 browserstack-sdk setup --framework "${framework}" --username "${username}" --key "${accessKey}"
 \`\`\`
-`;
-    const run = `
+
 ---STEP---
 
 Run your ${framework} tests on BrowserStack:
@@ -52,17 +46,14 @@ Run your ${framework} tests on BrowserStack:
 browserstack-sdk ${framework} <path-to-test-files>
 \`\`\`
 `;
-    return { setup, run };
-};
-export const robotInstructions = generatePythonFrameworkInstructions("robot");
-export const behaveInstructions = generatePythonFrameworkInstructions("behave");
-export const pytestInstructions = generatePythonFrameworkInstructions("pytest");
+const robotInstructions = generatePythonFrameworkInstructions("robot");
+const behaveInstructions = generatePythonFrameworkInstructions("behave");
+const pytestInstructions = generatePythonFrameworkInstructions("pytest");
 /**
  * ---------- JAVA INSTRUCTIONS ----------
  */
 const argsInstruction = '<argLine>-javaagent:"${com.browserstack:browserstack-java-sdk:jar}"</argLine>';
-export const javaInstructions = (username, accessKey) => {
-    const setup = `
+const javaInstructions = (username, accessKey) => `
 ---STEP---
 
 Add the BrowserStack Java SDK dependency to your \`pom.xml\`:
@@ -91,8 +82,7 @@ Export your BrowserStack credentials as environment variables:
 export BROWSERSTACK_USERNAME=${username}
 export BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\`
-`;
-    const run = `
+
 ---STEP---
 
 Run your tests using Maven:
@@ -105,13 +95,66 @@ Or for Gradle:
 gradle clean test
 \`\`\`
 `;
-    return { setup, run };
-};
+const serenityInstructions = (username, accessKey) => `
+---STEP---
+
+Set BrowserStack credentials as environment variables:
+For macOS/Linux:
+\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\`
+
+For Windows Command Prompt:
+\`\`\`cmd
+set BROWSERSTACK_USERNAME=${username}
+set BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\`
+
+---STEP---
+
+Add serenity-browserstack dependency in pom.xml:
+Add the following dependency to your pom.xml file and save it:
+\`\`\`xml
+<dependency>
+  <groupId>net.serenity-bdd</groupId>
+  <artifactId>serenity-browserstack</artifactId>
+  <version>3.3.4</version>
+</dependency>
+\`\`\`
+
+---STEP---
+
+Set up serenity.conf file:
+Create or update your serenity.conf file in the project root with the following configuration:
+\`\`\`
+webdriver {
+  driver = remote
+  remote.url = "https://hub.browserstack.com/wd/hub"
+}
+browserstack.user="${username}"
+browserstack.key="${accessKey}"
+\`\`\`
+
+---STEP---
+
+Run your Serenity tests:
+You can continue running your tests as you normally would. For example:
+
+Using Maven:
+\`\`\`bash
+mvn clean verify
+\`\`\`
+
+Using Gradle:
+\`\`\`bash
+gradle clean test
+\`\`\`
+`;
 /**
  * ---------- CSharp INSTRUCTIONS ----------
  */
-export const csharpCommonInstructions = (username, accessKey) => {
-    const setup = `
+const csharpCommonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install BrowserStack TestAdapter NuGet package:
@@ -160,8 +203,7 @@ Install the x64 version of .NET for BrowserStack compatibility.
   sudo dotnet browserstack-sdk setup-dotnet --dotnet-path "<your-chosen-path>" --dotnet-version "<your-dotnet-version>"
   \`\`\`
   Common paths: /usr/local/share/dotnet, ~/dotnet-x64, or /opt/dotnet-x64
-`;
-    const run = `
+
 ---STEP---
 
 Run the tests:
@@ -174,10 +216,7 @@ Run the tests:
   dotnet test
   \`\`\`
 `;
-    return { setup, run };
-};
-export const csharpPlaywrightCommonInstructions = (username, accessKey) => {
-    const setup = `
+const csharpPlaywrightCommonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install BrowserStack TestAdapter NuGet package:
@@ -239,8 +278,7 @@ Fix for Playwright architecture (macOS only):
 If the folder exists:  
 \`<project-folder>/bin/Debug/net8.0/.playwright/node/darwin-arm64\`  
 Rename \`darwin-arm64\` to \`darwin-x64\`
-`;
-    const run = `
+
 ---STEP---
 
 Run the tests:
@@ -253,13 +291,10 @@ Run the tests:
   dotnet test
   \`\`\`
 `;
-    return { setup, run };
-};
 /**
  * ---------- NODEJS INSTRUCTIONS ----------
  */
-export const nodejsInstructions = (username, accessKey) => {
-    const setup = `
+const nodejsInstructions = (username, accessKey) => `
 ---STEP---
 
 Ensure \`browserstack-node-sdk\` is present in package.json with the latest version:
@@ -295,21 +330,10 @@ export BROWSERSTACK_ACCESS_KEY=${accessKey}
 Run your tests:
 You can now run your tests on BrowserStack using your standard command or Use the commands defined in your package.json file to run the tests.
 `;
-    const run = `
----STEP---
-
-Run your tests on BrowserStack:
-\`\`\`bash
-npm run test:browserstack
-\`\`\`
-`;
-    return { setup, run };
-};
 /**
  * ---------- EXPORT CONFIG ----------
  */
-export const webdriverioInstructions = (username, accessKey) => {
-    const setup = `
+const webdriverioInstructions = (username, accessKey) => `
 ---STEP---
 
 Set BrowserStack Credentials:
@@ -408,17 +432,13 @@ exports.config.capabilities.forEach(function (caps) {
     caps[i] = { ...caps[i], ...exports.config.commonCapabilities[i]};
 });
 \`\`\`
-`;
-    const run = `
+
 ---STEP---
 
 Run your tests:
 You can now run your tests on BrowserStack using your standard WebdriverIO command or Use the commands defined in your package.json file to run the tests.
 `;
-    return { setup, run };
-};
-export const cypressInstructions = (username, accessKey) => {
-    const setup = `
+const cypressInstructions = (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack Cypress CLI:
@@ -479,8 +499,7 @@ Open the generated \`browserstack.json\` file and update it with your BrowserSta
 \`\`\`
 
 **Note:** For Cypress v9 or lower, use \`"cypress_config_file": "./cypress.json"\`. The \`testObservability: true\` flag enables the [Test Reporting & Analytics dashboard](https://www.browserstack.com/docs/test-management/test-reporting-and-analytics) for deeper insights into your test runs.
-`;
-    const run = `
+
 ---STEP---
 
 Run Your Tests on BrowserStack:
@@ -489,69 +508,8 @@ Execute your tests on BrowserStack using the following command:
 npx browserstack-cypress run --sync
 \`\`\`
 
-After the tests complete, you can view the results on your [BrowserStack Automate Dashboard](https://automate.browserstack.com/dashboard/).`;
-    return { setup, run };
-};
-const serenityInstructions = (username, accessKey) => {
-    const setup = `
----STEP---
-
-Set BrowserStack credentials as environment variables:
-For macOS/Linux:
-\`\`\`bash
-export BROWSERSTACK_USERNAME=${username}
-export BROWSERSTACK_ACCESS_KEY=${accessKey}
-\`\`\`
-
-For Windows Command Prompt:
-\`\`\`cmd
-set BROWSERSTACK_USERNAME=${username}
-set BROWSERSTACK_ACCESS_KEY=${accessKey}
-\`\`\`
-
----STEP---
-
-Add serenity-browserstack dependency in pom.xml:
-Add the following dependency to your pom.xml file and save it:
-\`\`\`xml
-<dependency>
-  <groupId>net.serenity-bdd</groupId>
-  <artifactId>serenity-browserstack</artifactId>
-  <version>3.3.4</version>
-</dependency>
-\`\`\`
-
----STEP---
-
-Set up serenity.conf file:
-Create or update your serenity.conf file in the project root with the following configuration:
-\`\`\`
-webdriver {
-  driver = remote
-  remote.url = "https://hub.browserstack.com/wd/hub"
-}
-browserstack.user="${username}"
-browserstack.key="${accessKey}"
-\`\`\`
+After the tests complete, you can view the results on your [BrowserStack Automate Dashboard](https://automate.browserstack.com/dashboard/).
 `;
-    const run = `
----STEP---
-
-Run your Serenity tests:
-You can continue running your tests as you normally would. For example:
-
-Using Maven:
-\`\`\`bash
-mvn clean verify
-\`\`\`
-
-Using Gradle:
-\`\`\`bash
-gradle clean test
-\`\`\`
-`;
-    return { setup, run };
-};
 export const SUPPORTED_CONFIGURATIONS = {
     python: {
         playwright: {
@@ -607,5 +565,8 @@ export const SUPPORTED_CONFIGURATIONS = {
         cypress: {
             cypress: { instructions: cypressInstructions },
         },
+        webdriverio: {
+            mocha: { instructions: webdriverioInstructions },
+        },
     },
 };

package/dist/tools/sdk-utils/instructions.d.ts

@@ -0,0 +1,6 @@
+import { SDKSupportedLanguage } from "./types.js";
+import { SDKSupportedBrowserAutomationFramework } from "./types.js";
+import { SDKSupportedTestingFramework } from "./types.js";
+export declare const getInstructionsForProjectConfiguration: (detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework, detectedTestingFramework: SDKSupportedTestingFramework, detectedLanguage: SDKSupportedLanguage, username: string, accessKey: string) => string;
+export declare function generateBrowserStackYMLInstructions(desiredPlatforms: string[], enablePercy?: boolean): string;
+export declare function formatInstructionsWithNumbers(instructionText: string, separator?: string): string;