@browserstack/mcp-server 1.2.3 → 1.2.5

package/dist/tools/sdk-utils/common/types.d.ts

@@ -0,0 +1,66 @@
+export declare enum PercyIntegrationTypeEnum {
+    WEB = "web",
+    AUTOMATE = "automate"
+}
+export declare enum SDKSupportedLanguageEnum {
+    nodejs = "nodejs",
+    python = "python",
+    java = "java",
+    csharp = "csharp",
+    ruby = "ruby"
+}
+export type SDKSupportedLanguage = keyof typeof SDKSupportedLanguageEnum;
+export declare enum SDKSupportedBrowserAutomationFrameworkEnum {
+    playwright = "playwright",
+    selenium = "selenium",
+    cypress = "cypress"
+}
+export type SDKSupportedBrowserAutomationFramework = keyof typeof SDKSupportedBrowserAutomationFrameworkEnum;
+export declare enum SDKSupportedTestingFrameworkEnum {
+    jest = "jest",
+    codeceptjs = "codeceptjs",
+    playwright = "playwright",
+    pytest = "pytest",
+    robot = "robot",
+    behave = "behave",
+    cucumber = "cucumber",
+    nightwatch = "nightwatch",
+    webdriverio = "webdriverio",
+    mocha = "mocha",
+    junit4 = "junit4",
+    junit5 = "junit5",
+    testng = "testng",
+    cypress = "cypress",
+    nunit = "nunit",
+    mstest = "mstest",
+    xunit = "xunit",
+    specflow = "specflow",
+    reqnroll = "reqnroll",
+    rspec = "rspec",
+    serenity = "serenity"
+}
+export declare const SDKSupportedLanguages: SDKSupportedLanguageEnum[];
+export type SDKSupportedTestingFramework = keyof typeof SDKSupportedTestingFrameworkEnum;
+export declare const SDKSupportedTestingFrameworks: SDKSupportedTestingFrameworkEnum[];
+export type ConfigMapping = Partial<Record<SDKSupportedLanguageEnum, Partial<Record<SDKSupportedBrowserAutomationFrameworkEnum, Partial<Record<SDKSupportedTestingFrameworkEnum, {
+    instructions: (username: string, accessKey: string) => {
+        setup: string;
+        run: string;
+    };
+}>>>>>>;
+export interface RunTestsStep {
+    type: "instruction" | "error" | "warning";
+    title: string;
+    content: string;
+    isError?: boolean;
+}
+export interface RunTestsInstructionResult {
+    steps: RunTestsStep[];
+    requiresPercy: boolean;
+    missingDependencies: string[];
+    shouldSkipFormatting?: boolean;
+}
+export declare enum PercyAutomateNotImplementedType {
+    LANGUAGE = "language",
+    FRAMEWORK = "framework"
+}

package/dist/tools/sdk-utils/{types.js → common/types.js}

@@ -1,16 +1,21 @@
+export var PercyIntegrationTypeEnum;
+(function (PercyIntegrationTypeEnum) {
+    PercyIntegrationTypeEnum["WEB"] = "web";
+    PercyIntegrationTypeEnum["AUTOMATE"] = "automate";
+})(PercyIntegrationTypeEnum || (PercyIntegrationTypeEnum = {}));
 export var SDKSupportedLanguageEnum;
 (function (SDKSupportedLanguageEnum) {
     SDKSupportedLanguageEnum["nodejs"] = "nodejs";
     SDKSupportedLanguageEnum["python"] = "python";
     SDKSupportedLanguageEnum["java"] = "java";
     SDKSupportedLanguageEnum["csharp"] = "csharp";
+    SDKSupportedLanguageEnum["ruby"] = "ruby";
 })(SDKSupportedLanguageEnum || (SDKSupportedLanguageEnum = {}));
 export var SDKSupportedBrowserAutomationFrameworkEnum;
 (function (SDKSupportedBrowserAutomationFrameworkEnum) {
     SDKSupportedBrowserAutomationFrameworkEnum["playwright"] = "playwright";
     SDKSupportedBrowserAutomationFrameworkEnum["selenium"] = "selenium";
     SDKSupportedBrowserAutomationFrameworkEnum["cypress"] = "cypress";
-    SDKSupportedBrowserAutomationFrameworkEnum["webdriverio"] = "webdriverio";
 })(SDKSupportedBrowserAutomationFrameworkEnum || (SDKSupportedBrowserAutomationFrameworkEnum = {}));
 export var SDKSupportedTestingFrameworkEnum;
 (function (SDKSupportedTestingFrameworkEnum) {
@@ -27,11 +32,19 @@ export var SDKSupportedTestingFrameworkEnum;
     SDKSupportedTestingFrameworkEnum["junit4"] = "junit4";
     SDKSupportedTestingFrameworkEnum["junit5"] = "junit5";
     SDKSupportedTestingFrameworkEnum["testng"] = "testng";
-    SDKSupportedTestingFrameworkEnum["serenity"] = "serenity";
     SDKSupportedTestingFrameworkEnum["cypress"] = "cypress";
     SDKSupportedTestingFrameworkEnum["nunit"] = "nunit";
     SDKSupportedTestingFrameworkEnum["mstest"] = "mstest";
     SDKSupportedTestingFrameworkEnum["xunit"] = "xunit";
     SDKSupportedTestingFrameworkEnum["specflow"] = "specflow";
     SDKSupportedTestingFrameworkEnum["reqnroll"] = "reqnroll";
+    SDKSupportedTestingFrameworkEnum["rspec"] = "rspec";
+    SDKSupportedTestingFrameworkEnum["serenity"] = "serenity";
 })(SDKSupportedTestingFrameworkEnum || (SDKSupportedTestingFrameworkEnum = {}));
+export const SDKSupportedLanguages = Object.values(SDKSupportedLanguageEnum);
+export const SDKSupportedTestingFrameworks = Object.values(SDKSupportedTestingFrameworkEnum);
+export var PercyAutomateNotImplementedType;
+(function (PercyAutomateNotImplementedType) {
+    PercyAutomateNotImplementedType["LANGUAGE"] = "language";
+    PercyAutomateNotImplementedType["FRAMEWORK"] = "framework";
+})(PercyAutomateNotImplementedType || (PercyAutomateNotImplementedType = {}));

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

@@ -0,0 +1,25 @@
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { PercyIntegrationTypeEnum } from "../common/types.js";
+import { RunTestsInstructionResult, PercyAutomateNotImplementedType } from "./types.js";
+export declare function checkPercyIntegrationSupport(input: {
+    integrationType: string;
+    detectedLanguage: string;
+    detectedTestingFramework?: string;
+    detectedBrowserAutomationFramework?: string;
+}): {
+    supported: boolean;
+    errorMessage?: string;
+};
+export declare function formatToolResult(resultPromise: Promise<RunTestsInstructionResult> | RunTestsInstructionResult, runType?: "percy-web" | "bstack" | "percy-bstack" | "percy-automate"): Promise<CallToolResult>;
+export declare function getPercyAutomateNotImplementedMessage(type: PercyAutomateNotImplementedType, input: {
+    detectedLanguage: string;
+    detectedBrowserAutomationFramework: string;
+}, supported: string[]): string;
+export declare function getBootstrapFailedMessage(error: unknown, context: {
+    config: unknown;
+    percyMode?: string;
+    sdkVersion?: string;
+}): string;
+export declare function percyUnsupportedResult(integrationType: PercyIntegrationTypeEnum, supportCheck?: {
+    errorMessage?: string;
+}): CallToolResult;

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

@@ -0,0 +1,91 @@
+import { PercyIntegrationTypeEnum } from "../common/types.js";
+import { isPercyAutomateFrameworkSupported } from "../percy-automate/frameworks.js";
+import { isPercyWebFrameworkSupported } from "../percy-web/frameworks.js";
+import { formatInstructionsWithNumbers, generateVerificationMessage, } from "./formatUtils.js";
+import { PercyAutomateNotImplementedType, } from "./types.js";
+import { IMPORTANT_SETUP_WARNING } from "./index.js";
+export function checkPercyIntegrationSupport(input) {
+    if (input.integrationType === PercyIntegrationTypeEnum.AUTOMATE) {
+        const isSupported = isPercyAutomateFrameworkSupported(input.detectedLanguage, input.detectedBrowserAutomationFramework || "", input.detectedTestingFramework || "");
+        if (!isSupported) {
+            return {
+                supported: false,
+                errorMessage: `Percy Automate is not supported for this configuration. Language: ${input.detectedLanguage} Testing Framework: ${input.detectedTestingFramework}`,
+            };
+        }
+    }
+    else if (input.integrationType === PercyIntegrationTypeEnum.WEB) {
+        const isSupported = isPercyWebFrameworkSupported(input.detectedLanguage, input.detectedBrowserAutomationFramework || "");
+        if (!isSupported) {
+            return {
+                supported: false,
+                errorMessage: `Percy Web is not supported for this configuration. Language: ${input.detectedLanguage} Browser Automation Framework: ${input.detectedBrowserAutomationFramework}`,
+            };
+        }
+    }
+    return { supported: true };
+}
+export async function formatToolResult(resultPromise, runType) {
+    const { steps, requiresPercy, missingDependencies, shouldSkipFormatting } = await resultPromise;
+    if (shouldSkipFormatting) {
+        return {
+            content: steps.map((step) => ({
+                type: "text",
+                text: step.content,
+            })),
+            isError: steps.some((s) => s.isError),
+            steps,
+            requiresPercy,
+            missingDependencies,
+        };
+    }
+    const combinedInstructions = steps.map((step) => step.content).join("\n");
+    const { formattedSteps, stepCount } = formatInstructionsWithNumbers(combinedInstructions);
+    const verificationMessage = generateVerificationMessage(stepCount);
+    const finalContent = [
+        { type: "text", text: IMPORTANT_SETUP_WARNING },
+        { type: "text", text: formattedSteps },
+        { type: "text", text: verificationMessage },
+    ];
+    if (runType != "percy-web") {
+        finalContent.push({
+            type: "text",
+            text: "CRITICAL: After the build is run, you MUST explicitly ask the user if they want to perform RCA (Root Cause Analysis) for any failed tests. This step is mandatory and should not be skipped.",
+        });
+    }
+    return {
+        content: finalContent,
+        isError: steps.some((s) => s.isError),
+        requiresPercy,
+        missingDependencies,
+    };
+}
+export function getPercyAutomateNotImplementedMessage(type, input, supported) {
+    if (type === PercyAutomateNotImplementedType.LANGUAGE) {
+        return `Percy Automate does not support the language: ${input.detectedLanguage}. Supported languages are: ${supported.join(", ")}.`;
+    }
+    else {
+        return `Percy Automate does not support ${input.detectedBrowserAutomationFramework} for ${input.detectedLanguage}. Supported frameworks for ${input.detectedLanguage} are: ${supported.join(", ")}.`;
+    }
+}
+export function getBootstrapFailedMessage(error, context) {
+    const error_message = error instanceof Error ? error.message : "unknown error";
+    return `Failed to bootstrap project with BrowserStack SDK.
+Error: ${error_message}
+Percy Mode: ${context.percyMode ?? "automate"}
+SDK Version: ${context.sdkVersion ?? "N/A"}
+Please open an issue on GitHub if the problem persists.`;
+}
+export function percyUnsupportedResult(integrationType, supportCheck) {
+    const defaultMessage = `Percy ${integrationType} integration is not supported for this configuration.`;
+    return {
+        content: [
+            {
+                type: "text",
+                text: supportCheck?.errorMessage || defaultMessage,
+            },
+        ],
+        isError: true,
+        shouldSkipFormatting: true,
+    };
+}

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

@@ -0,0 +1,5 @@
+import { BrowserStackConfig } from "../../lib/types.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+export declare function runTestsOnBrowserStackHandler(rawInput: unknown, config: BrowserStackConfig): Promise<CallToolResult>;
+export declare function setUpPercyHandler(rawInput: unknown, config: BrowserStackConfig): Promise<CallToolResult>;
+export declare function simulatePercyChangeHandler(rawInput: unknown, config: BrowserStackConfig): Promise<CallToolResult>;

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

@@ -0,0 +1,147 @@
+import { formatToolResult } from "./common/utils.js";
+import { PercyIntegrationTypeEnum } from "./common/types.js";
+import { getBrowserStackAuth } from "../../lib/get-auth.js";
+import { fetchPercyToken } from "./percy-web/fetchPercyToken.js";
+import { runPercyWeb } from "./percy-web/handler.js";
+import { runPercyAutomateOnly } from "./percy-automate/handler.js";
+import { runBstackSDKOnly } from "./bstack/sdkHandler.js";
+import { runPercyWithBrowserstackSDK } from "./percy-bstack/handler.js";
+import { checkPercyIntegrationSupport } from "./common/utils.js";
+import { SetUpPercySchema, RunTestsOnBrowserStackSchema, } from "./common/schema.js";
+import { getBootstrapFailedMessage, percyUnsupportedResult, } from "./common/utils.js";
+import { PERCY_SIMULATE_INSTRUCTION, PERCY_REPLACE_REGEX, PERCY_SIMULATION_DRIVER_INSTRUCTION, PERCY_VERIFICATION_REGEX, } from "./common/constants.js";
+export async function runTestsOnBrowserStackHandler(rawInput, config) {
+    const input = RunTestsOnBrowserStackSchema.parse(rawInput);
+    const result = await runBstackSDKOnly(input, config);
+    return await formatToolResult(result);
+}
+export async function setUpPercyHandler(rawInput, config) {
+    try {
+        const input = SetUpPercySchema.parse(rawInput);
+        const authorization = getBrowserStackAuth(config);
+        const percyInput = {
+            projectName: input.projectName,
+            detectedLanguage: input.detectedLanguage,
+            detectedBrowserAutomationFramework: input.detectedBrowserAutomationFramework,
+            detectedTestingFramework: input.detectedTestingFramework,
+            integrationType: input.integrationType,
+            folderPaths: input.folderPaths || [],
+        };
+        // Check for Percy Web integration support
+        if (input.integrationType === PercyIntegrationTypeEnum.WEB) {
+            const supportCheck = checkPercyIntegrationSupport(percyInput);
+            if (!supportCheck.supported) {
+                return percyUnsupportedResult(PercyIntegrationTypeEnum.WEB, supportCheck);
+            }
+            // Fetch the Percy token
+            const percyToken = await fetchPercyToken(input.projectName, authorization, { type: PercyIntegrationTypeEnum.WEB });
+            const result = runPercyWeb(percyInput, percyToken);
+            return await formatToolResult(result, "percy-web");
+        }
+        else if (input.integrationType === PercyIntegrationTypeEnum.AUTOMATE) {
+            // First try Percy with BrowserStack SDK
+            const percyWithBrowserstackSDKResult = runPercyWithBrowserstackSDK({
+                ...percyInput,
+                devices: [],
+            }, config);
+            const hasPercySDKError = percyWithBrowserstackSDKResult.steps &&
+                percyWithBrowserstackSDKResult.steps.some((step) => step.isError);
+            if (!hasPercySDKError) {
+                // Percy with SDK is supported, prepend warning and return those steps
+                if (percyWithBrowserstackSDKResult.steps) {
+                    percyWithBrowserstackSDKResult.steps.unshift({
+                        type: "instruction",
+                        title: "Important: Existing SDK Setup",
+                        content: "If you have already set up the BrowserStack SDK, do not override it unless you have explicitly decided to do so.",
+                    });
+                }
+                return await formatToolResult(percyWithBrowserstackSDKResult);
+            }
+            else {
+                // Fallback to standalone Percy Automate if supported
+                const supportCheck = checkPercyIntegrationSupport({
+                    ...percyInput,
+                    integrationType: PercyIntegrationTypeEnum.AUTOMATE,
+                });
+                if (!supportCheck.supported) {
+                    return percyUnsupportedResult(PercyIntegrationTypeEnum.AUTOMATE, supportCheck);
+                }
+                // SDK setup instructions (for Automate, without Percy)
+                const sdkInput = {
+                    projectName: input.projectName,
+                    detectedLanguage: input.detectedLanguage,
+                    detectedBrowserAutomationFramework: input.detectedBrowserAutomationFramework,
+                    detectedTestingFramework: input.detectedTestingFramework,
+                    devices: [],
+                };
+                const sdkResult = await runBstackSDKOnly(sdkInput, config, true);
+                // Percy Automate instructions
+                const percyToken = await fetchPercyToken(input.projectName, authorization, { type: PercyIntegrationTypeEnum.AUTOMATE });
+                const percyAutomateResult = runPercyAutomateOnly(percyInput, percyToken);
+                // Combine steps: warning, SDK steps, Percy Automate steps
+                const steps = [
+                    {
+                        type: "instruction",
+                        title: "Important: Existing SDK Setup",
+                        content: "If you have already set up the BrowserStack SDK, do not override it unless you have explicitly decided to do so.",
+                    },
+                    ...(sdkResult.steps || []),
+                    ...(percyAutomateResult.steps || []),
+                ];
+                // Combine all steps into the final result
+                return await formatToolResult({
+                    ...percyAutomateResult,
+                    steps,
+                });
+            }
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "Unknown or unsupported Percy integration type requested.",
+                    },
+                ],
+                isError: true,
+                shouldSkipFormatting: true,
+            };
+        }
+    }
+    catch (error) {
+        throw new Error(getBootstrapFailedMessage(error, { config }));
+    }
+}
+export async function simulatePercyChangeHandler(rawInput, config) {
+    try {
+        let percyInstruction;
+        try {
+            percyInstruction = await setUpPercyHandler(rawInput, config);
+        }
+        catch {
+            throw new Error("Failed to set up Percy");
+        }
+        if (percyInstruction.isError) {
+            return percyInstruction;
+        }
+        if (Array.isArray(percyInstruction.content)) {
+            percyInstruction.content = percyInstruction.content.map((item) => {
+                if (typeof item.text === "string") {
+                    const updatedText = item.text
+                        .replace(PERCY_REPLACE_REGEX, PERCY_SIMULATE_INSTRUCTION)
+                        .replace(PERCY_VERIFICATION_REGEX, "");
+                    return { ...item, text: updatedText };
+                }
+                return item;
+            });
+        }
+        percyInstruction.content?.push({
+            type: "text",
+            text: PERCY_SIMULATION_DRIVER_INSTRUCTION,
+        });
+        return percyInstruction;
+    }
+    catch (error) {
+        throw new Error(getBootstrapFailedMessage(error, { config }));
+    }
+}

package/dist/tools/sdk-utils/percy-automate/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const percyAutomateReviewSnapshotsStep = "\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n";
+export declare const pythonPytestSeleniumInstructions = "\nInstall Percy Automate dependencies\n  - Install Percy CLI:\n    npm install --save-dev @percy/cli\n  - Install Percy Python SDK for Automate:\n    pip install percy-selenium\n\n---STEP---\nUpdate your Pytest test script  \n\nInvoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---\nProcess files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:\n- Start with index 0\n- Then index 1  \n- Then index 2\n- Continue sequentially until the last index\n- DO NOT skip any index numbers\n- DO NOT jump to random indices like 10, 20, 30\n- DO NOT worry about time consuming and any constraints.\n- DO NOT STOP until you add commands in all the files or you reach end of the files.\n\n  - Import the Percy snapshot helper:\n    from percy import percy_screenshot\n  - In your test, take snapshots at key points:\n    percy_screenshot(driver, \"Your snapshot name\")\n\nExample:\n```python\nimport pytest\nfrom selenium import webdriver\nfrom percy import percy_screenshot\n\n@pytest.fixture\ndef driver():\n    driver = webdriver.Chrome()\n    yield driver\n    driver.quit()\n\ndef test_homepage(driver):\n    driver.get(\"http://localhost:8000\")\n    percy_screenshot(driver, \"Home page\")\n    # ... more test steps ...\n    percy_screenshot(driver, \"After login\")\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- browserstack-sdk pytest').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const pythonPytestPlaywrightInstructions = "\nInstall Percy Automate dependencies\n  - Install Percy CLI:\n    npm install --save @percy/cli\n  - Install Percy Playwright SDK for Automate:\n    pip install percy-playwright\n\n---STEP---\nUpdate your Playwright test script\n\nInvoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---\nProcess files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:\n- Start with index 0\n- Then index 1  \n- Then index 2\n- Continue sequentially until the last index\n- DO NOT skip any index numbers\n- DO NOT jump to random indices like 10, 20, 30\n- DO NOT worry about time consuming and any constraints.\n- DO NOT STOP until you add commands in all the files or you reach end of the files.\n\n  - Import the Percy screenshot helper:\n    from percy import percy_screenshot\n  - In your test, take snapshots at key points:\n    percy_screenshot(page, name=\"Your snapshot name\")\n    # You can pass `options`:\n    percy_screenshot(page, name=\"Your snapshot name\", options={ \"full_page\": True })\n\nExample:\n```python\nfrom playwright.sync_api import sync_playwright\nfrom percy import percy_screenshot\n\ndef test_visual_regression():\n    with sync_playwright() as p:\n        browser = p.chromium.launch()\n        page = browser.new_page()\n        page.goto(\"http://localhost:8000\")\n        percy_screenshot(page, name=\"Home page\")\n        # ... more test steps ...\n        percy_screenshot(page, name=\"After login\", options={ \"full_page\": True })\n        browser.close()\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the script file>').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const jsCypressPercyAutomateInstructions = "\nInstall Percy Automate dependencies\n  - Install Percy CLI:\n    npm install --save-dev @percy/cli\n  - Install Percy Cypress SDK:\n    npm install --save-dev @percy/cypress\n\n---STEP---\nUpdate your Cypress test script\n\nInvoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---\nProcess files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:\n- Start with index 0\n- Then index 1  \n- Then index 2\n- Continue sequentially until the last index\n- DO NOT skip any index numbers\n- DO NOT jump to random indices like 10, 20, 30\n- DO NOT worry about time consuming and any constraints.\n- DO NOT STOP until you add commands in all the files or you reach end of the files.\n\n  - Import and initialize Percy in your cypress/support/index.js:\n    import '@percy/cypress';\n  - In your test, take snapshots at key points:\n    cy.percySnapshot('Your snapshot name');\n\nExample:\n```javascript\ndescribe('Percy Automate Cypress Example', () => {\n  it('should take Percy snapshots', () => {\n    cy.visit('http://localhost:8000');\n    cy.percySnapshot('Home page');\n    // ... more test steps ...\n    cy.percySnapshot('After login');\n  });\n});\n```  \n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- cypress run').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const mochaPercyAutomateInstructions = "\nInstall Percy Automate dependencies\n  - Install Percy CLI:\n    npm install --save @percy/cli\n  - Install Percy Selenium SDK:\n    npm install @percy/selenium-webdriver@2.0.1\n\n---STEP---\nUpdate your Mocha Automate test script\n  - Import the Percy screenshot helper:\n    const { percyScreenshot } = require('@percy/selenium-webdriver');\n  - Use the Percy screenshot command to take required screenshots in your Automate session:\n    await percyScreenshot(driver, 'Screenshot 1');\n    options = { percyCSS: 'h1{color:red;}' };\n    await percyScreenshot(driver, 'Screenshot 2', options);\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- mocha').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const mochaPercyPlaywrightInstructions = "\nInstall Percy Automate dependencies\n  - Install the latest Percy CLI:\n    npm install --save @percy/cli\n  - Install the Percy Playwright SDK:\n    npm install @percy/playwright\n\n---STEP---\nUpdate your Mocha Playwright test script\n  - Import the Percy screenshot helper:\n    const { percyScreenshot } = require(\"@percy/playwright\");\n  - Use the Percy screenshot command to take required screenshots in your Automate session.\n\nExample:\n```javascript\nconst { percyScreenshot } = require(\"@percy/playwright\");\nawait percyScreenshot(page, \"Screenshot 1\");\n// With options\nawait percyScreenshot(page, \"Screenshot 2\", { percyCSS: \"h1{color:green;}\" });\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the tests>').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const jestPercyAutomateInstructions = "\nInstall or upgrade the BrowserStack SDK:\n  - Install the SDK:\n    npm i -D browserstack-node-sdk@latest\n  - Run the setup:\n    npx setup --username \"YOUR_USERNAME\" --key \"YOUR_ACCESS_KEY\"\n\n---STEP---\nManually capture screenshots:\n  1. Import the BrowserStack Percy SDK in your test script:\n     const { percy } = require('browserstack-node-sdk');\n  2. Use `percy.screenshot(driver, name)` at desired points in your test.\n\nExample:\n```javascript\nconst { percy } = require('browserstack-node-sdk');\ndescribe(\"JestJS test\", () => {\n  let driver;\n  const caps = require(\"../\" + conf_file).capabilities;\n\n  beforeAll(() => {\n    driver = new Builder()\n      .usingServer(\"http://example-servername/hub\")\n      .withCapabilities(caps)\n      .build();\n  });\n\n  test(\"my test\", async () => {\n    // ...\n    await percy.screenshot(driver, \"My Screenshot\");\n    // ...\n  });\n});\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npm run [your-test-script-name]-browserstack').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const webdriverioPercyAutomateInstructions = "\nInstall or upgrade BrowserStack SDK\n  - Install the BrowserStack SDK:\n    npm i -D @wdio/browserstack-service\n\n---STEP---\nUpdate your WebdriverIO config file\n  1. Set `percy: true`\n  2. Set a `projectName`\n  3. Set `percyCaptureMode: auto` (or another mode as needed)\n\nExample WebdriverIO config:\n```js\nexports.config = {\n  user: process.env.BROWSERSTACK_USERNAME || 'YOUR_USERNAME',\n  key: process.env.BROWSERSTACK_ACCESS_KEY || 'YOUR_ACCESS_KEY',\n  hostname: 'hub.browserstack.com',\n  services: [\n    [\n      'browserstack',\n      { browserstackLocal: true, opts: { forcelocal: false }, percy: true, percyCaptureMode: 'auto' }\n    ],\n  ],\n  // add path to the test file\n}\n```\n\n---STEP---\n(Optional) Manually capture screenshots\n  1. Import the BrowserStack Percy SDK in your test script:\n    const { percy } = require('browserstack-node-sdk');\n  2. Add the `await percy.screenshot(driver, name)` method at required points in your test script.\n\nExample:\n```javascript\n    const { percy } = require('browserstack-node-sdk');\n  2. Add the `await percy.screenshot(driver, name)` method at required points in your test script.\n\nExample:\n```javascript\nconst { percy } = require('browserstack-node-sdk');\ndescribe(\"WebdriverIO Test\", () => {\n  it(\"my test\", async () => {\n    // ....\n    await percy.screenshot(driver, \"My Screenshot\")\n    // ....\n  });\n});\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command as defined in your package.json file.\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const testcafePercyAutomateInstructions = "\nInstall Percy dependencies\n  - Install the required dependencies:\n    npm install --save-dev @percy/cli @percy/testcafe\n\n---STEP---\nUpdate your test script\n\nInvoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---\nProcess files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:\n- Start with index 0\n- Then index 1  \n- Then index 2\n- Continue sequentially until the last index\n- DO NOT skip any index numbers\n- DO NOT jump to random indices like 10, 20, 30\n- DO NOT worry about time consuming and any constraints.\n- DO NOT STOP until you add commands in all the files or you reach end of the files.\n\n  - Import the Percy library and use the percySnapshot function to take screenshots.\n\nExample:\n```javascript\nimport percySnapshot from '@percy/testcafe';\nfixture('MyFixture')\n  .page('https://devexpress.github.io/testcafe/example/');\ntest('Test1', async t => {\n  await t.typeText('#developer-name', 'John Doe');\n  await percySnapshot(t, 'TestCafe Example');\n});\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- testcafe chrome:headless tests').\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const javaPlaywrightJunitInstructions = "\nInstall Percy Automate dependencies\n  - Install the latest Percy CLI:\n    npm install --save @percy/cli\n  - Add the Percy Playwright Java SDK to your pom.xml:\n```xml\n<dependency>\n  <groupId>io.percy</groupId>\n  <artifactId>percy-playwright-java</artifactId>\n  <version>1.0.0</version>\n</dependency>\n```\n\n---STEP---\nUpdate your Automate test script\n  - Import the Percy library:\n    import io.percy.playwright.Percy;\n  - Use the Percy screenshot command to take required screenshots in your Automate session.\n\nExample:\n```java\nPercy percy = new Percy(page);\npercy.screenshot(\"screenshot_1\");\n// With options\npercy.screenshot(\"screenshot_2\", options);\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the automate script file>').\n\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";
+export declare const csharpPlaywrightNunitInstructions = "\nInstall Percy Automate dependencies\n  - Install the latest Percy CLI:\n    npm install --save @percy/cli\n  - Add the Percy Playwright SDK to your .csproj file:\n```xml\n<PackageReference Include=\"PercyIO.Playwright\" Version=\"1.0.0\" />\n```\n\n---STEP---\nUpdate your NUnit Playwright test script\n  - Import the Percy library:\n    using PercyIO.Playwright;\n  - Use the Percy screenshot command to take required screenshots in your Automate session.\n\nExample:\n```csharp\nusing PercyIO.Playwright;\nPercy.Screenshot(page, \"example_screenshot_1\");\n// With options\nPercy.Screenshot(page, \"example_screenshot_2\", options);\n```\n\n---STEP---\nTo run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the automate script file>').\n\n\n---STEP---\nReview the snapshots\n  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.\n\n";