@browserstack/mcp-server 1.2.3 → 1.2.4

package/dist/tools/sdk-utils/percy-automate/constants.js

@@ -0,0 +1,338 @@
+import { PERCY_SNAPSHOT_INSTRUCTION } from "../common/constants.js";
+export const percyAutomateReviewSnapshotsStep = `
+---STEP---
+Review the snapshots
+  - Go to your Percy project on https://percy.io to review snapshots and approve/reject any visual changes.
+`;
+export const pythonPytestSeleniumInstructions = `
+Install Percy Automate dependencies
+  - Install Percy CLI:
+    npm install --save-dev @percy/cli
+  - Install Percy Python SDK for Automate:
+    pip install percy-selenium
+
+---STEP---
+Update your Pytest test script  
+${PERCY_SNAPSHOT_INSTRUCTION}
+  - Import the Percy snapshot helper:
+    from percy import percy_screenshot
+  - In your test, take snapshots at key points:
+    percy_screenshot(driver, "Your snapshot name")
+
+Example:
+\`\`\`python
+import pytest
+from selenium import webdriver
+from percy import percy_screenshot
+
+@pytest.fixture
+def driver():
+    driver = webdriver.Chrome()
+    yield driver
+    driver.quit()
+
+def test_homepage(driver):
+    driver.get("http://localhost:8000")
+    percy_screenshot(driver, "Home page")
+    # ... more test steps ...
+    percy_screenshot(driver, "After login")
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- browserstack-sdk pytest').
+${percyAutomateReviewSnapshotsStep}
+`;
+export const pythonPytestPlaywrightInstructions = `
+Install Percy Automate dependencies
+  - Install Percy CLI:
+    npm install --save @percy/cli
+  - Install Percy Playwright SDK for Automate:
+    pip install percy-playwright
+
+---STEP---
+Update your Playwright test script
+${PERCY_SNAPSHOT_INSTRUCTION}
+  - Import the Percy screenshot helper:
+    from percy import percy_screenshot
+  - In your test, take snapshots at key points:
+    percy_screenshot(page, name="Your snapshot name")
+    # You can pass \`options\`:
+    percy_screenshot(page, name="Your snapshot name", options={ "full_page": True })
+
+Example:
+\`\`\`python
+from playwright.sync_api import sync_playwright
+from percy import percy_screenshot
+
+def test_visual_regression():
+    with sync_playwright() as p:
+        browser = p.chromium.launch()
+        page = browser.new_page()
+        page.goto("http://localhost:8000")
+        percy_screenshot(page, name="Home page")
+        # ... more test steps ...
+        percy_screenshot(page, name="After login", options={ "full_page": True })
+        browser.close()
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the script file>').
+${percyAutomateReviewSnapshotsStep}
+`;
+export const jsCypressPercyAutomateInstructions = `
+Install Percy Automate dependencies
+  - Install Percy CLI:
+    npm install --save-dev @percy/cli
+  - Install Percy Cypress SDK:
+    npm install --save-dev @percy/cypress
+
+---STEP---
+Update your Cypress test script
+${PERCY_SNAPSHOT_INSTRUCTION}
+  - Import and initialize Percy in your cypress/support/index.js:
+    import '@percy/cypress';
+  - In your test, take snapshots at key points:
+    cy.percySnapshot('Your snapshot name');
+
+Example:
+\`\`\`javascript
+describe('Percy Automate Cypress Example', () => {
+  it('should take Percy snapshots', () => {
+    cy.visit('http://localhost:8000');
+    cy.percySnapshot('Home page');
+    // ... more test steps ...
+    cy.percySnapshot('After login');
+  });
+});
+\`\`\`  
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- cypress run').
+${percyAutomateReviewSnapshotsStep}
+`;
+export const mochaPercyAutomateInstructions = `
+Install Percy Automate dependencies
+  - Install Percy CLI:
+    npm install --save @percy/cli
+  - Install Percy Selenium SDK:
+    npm install @percy/selenium-webdriver@2.0.1
+
+---STEP---
+Update your Mocha Automate test script
+  - Import the Percy screenshot helper:
+    const { percyScreenshot } = require('@percy/selenium-webdriver');
+  - Use the Percy screenshot command to take required screenshots in your Automate session:
+    await percyScreenshot(driver, 'Screenshot 1');
+    options = { percyCSS: 'h1{color:red;}' };
+    await percyScreenshot(driver, 'Screenshot 2', options);
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- mocha').
+${percyAutomateReviewSnapshotsStep}
+`;
+// Mocha Percy Playwright Instructions
+export const mochaPercyPlaywrightInstructions = `
+Install Percy Automate dependencies
+  - Install the latest Percy CLI:
+    npm install --save @percy/cli
+  - Install the Percy Playwright SDK:
+    npm install @percy/playwright
+
+---STEP---
+Update your Mocha Playwright test script
+  - Import the Percy screenshot helper:
+    const { percyScreenshot } = require("@percy/playwright");
+  - Use the Percy screenshot command to take required screenshots in your Automate session.
+
+Example:
+\`\`\`javascript
+const { percyScreenshot } = require("@percy/playwright");
+await percyScreenshot(page, "Screenshot 1");
+// With options
+await percyScreenshot(page, "Screenshot 2", { percyCSS: "h1{color:green;}" });
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- <command to run the tests>').
+${percyAutomateReviewSnapshotsStep}
+`;
+export const jestPercyAutomateInstructions = `
+Install or upgrade the BrowserStack SDK:
+  - Install the SDK:
+    npm i -D browserstack-node-sdk@latest
+  - Run the setup:
+    npx setup --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"
+
+---STEP---
+Manually capture screenshots:
+  1. Import the BrowserStack Percy SDK in your test script:
+     const { percy } = require('browserstack-node-sdk');
+  2. Use \`percy.screenshot(driver, name)\` at desired points in your test.
+
+Example:
+\`\`\`javascript
+const { percy } = require('browserstack-node-sdk');
+describe("JestJS test", () => {
+  let driver;
+  const caps = require("../" + conf_file).capabilities;
+
+  beforeAll(() => {
+    driver = new Builder()
+      .usingServer("http://example-servername/hub")
+      .withCapabilities(caps)
+      .build();
+  });
+
+  test("my test", async () => {
+    // ...
+    await percy.screenshot(driver, "My Screenshot");
+    // ...
+  });
+});
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npm run [your-test-script-name]-browserstack').
+${percyAutomateReviewSnapshotsStep}
+`;
+export const webdriverioPercyAutomateInstructions = `
+Install or upgrade BrowserStack SDK
+  - Install the BrowserStack SDK:
+    npm i -D @wdio/browserstack-service
+
+---STEP---
+Update your WebdriverIO config file
+  1. Set \`percy: true\`
+  2. Set a \`projectName\`
+  3. Set \`percyCaptureMode: auto\` (or another mode as needed)
+
+Example WebdriverIO config:
+\`\`\`js
+exports.config = {
+  user: process.env.BROWSERSTACK_USERNAME || 'YOUR_USERNAME',
+  key: process.env.BROWSERSTACK_ACCESS_KEY || 'YOUR_ACCESS_KEY',
+  hostname: 'hub.browserstack.com',
+  services: [
+    [
+      'browserstack',
+      { browserstackLocal: true, opts: { forcelocal: false }, percy: true, percyCaptureMode: 'auto' }
+    ],
+  ],
+  // add path to the test file
+}
+\`\`\`
+
+---STEP---
+(Optional) Manually capture screenshots
+  1. Import the BrowserStack Percy SDK in your test script:
+    const { percy } = require('browserstack-node-sdk');
+  2. Add the \`await percy.screenshot(driver, name)\` method at required points in your test script.
+
+Example:
+\`\`\`javascript
+    const { percy } = require('browserstack-node-sdk');
+  2. Add the \`await percy.screenshot(driver, name)\` method at required points in your test script.
+
+Example:
+\`\`\`javascript
+const { percy } = require('browserstack-node-sdk');
+describe("WebdriverIO Test", () => {
+  it("my test", async () => {
+    // ....
+    await percy.screenshot(driver, "My Screenshot")
+    // ....
+  });
+});
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command as defined in your package.json file.
+${percyAutomateReviewSnapshotsStep}
+`;
+export const testcafePercyAutomateInstructions = `
+Install Percy dependencies
+  - Install the required dependencies:
+    npm install --save-dev @percy/cli @percy/testcafe
+
+---STEP---
+Update your test script
+${PERCY_SNAPSHOT_INSTRUCTION}
+  - Import the Percy library and use the percySnapshot function to take screenshots.
+
+Example:
+\`\`\`javascript
+import percySnapshot from '@percy/testcafe';
+fixture('MyFixture')
+  .page('https://devexpress.github.io/testcafe/example/');
+test('Test1', async t => {
+  await t.typeText('#developer-name', 'John Doe');
+  await percySnapshot(t, 'TestCafe Example');
+});
+\`\`\`
+
+---STEP---
+To run the Percy build, call the tool runPercyScan with the appropriate test command (e.g., 'npx percy exec -- testcafe chrome:headless tests').
+${percyAutomateReviewSnapshotsStep}
+`;
+// Java Playwright Percy Automate Instructions
+export const javaPlaywrightJunitInstructions = `
+Install Percy Automate dependencies
+  - Install the latest Percy CLI:
+    npm install --save @percy/cli
+  - Add the Percy Playwright Java SDK to your pom.xml:
+\`\`\`xml
+<dependency>
+  <groupId>io.percy</groupId>
+  <artifactId>percy-playwright-java</artifactId>
+  <version>1.0.0</version>
+</dependency>
+\`\`\`
+
+---STEP---
+Update your Automate test script
+  - Import the Percy library:
+    import io.percy.playwright.Percy;
+  - Use the Percy screenshot command to take required screenshots in your Automate session.
+
+Example:
+\`\`\`java
+Percy percy = new Percy(page);
+percy.screenshot("screenshot_1");
+// With options
+percy.screenshot("screenshot_2", options);
+\`\`\`
+
+---STEP---
+To 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>').
+
+${percyAutomateReviewSnapshotsStep}
+`;
+// C# Playwright NUnit Percy Automate Instructions
+export const csharpPlaywrightNunitInstructions = `
+Install Percy Automate dependencies
+  - Install the latest Percy CLI:
+    npm install --save @percy/cli
+  - Add the Percy Playwright SDK to your .csproj file:
+\`\`\`xml
+<PackageReference Include="PercyIO.Playwright" Version="1.0.0" />
+\`\`\`
+
+---STEP---
+Update your NUnit Playwright test script
+  - Import the Percy library:
+    using PercyIO.Playwright;
+  - Use the Percy screenshot command to take required screenshots in your Automate session.
+
+Example:
+\`\`\`csharp
+using PercyIO.Playwright;
+Percy.Screenshot(page, "example_screenshot_1");
+// With options
+Percy.Screenshot(page, "example_screenshot_2", options);
+\`\`\`
+
+---STEP---
+To 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>').
+
+${percyAutomateReviewSnapshotsStep}
+`;

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

@@ -0,0 +1,8 @@
+import { ConfigMapping } from "./types.js";
+export declare const SUPPORTED_CONFIGURATIONS: ConfigMapping;
+/**
+ * Utility function to check if a given language, driver, and testing framework
+ * are supported by Percy Automate.
+ * This now expects the structure: language -> driver -> framework
+ */
+export declare function isPercyAutomateFrameworkSupported(language: string, driver: string, framework: string): boolean;

package/dist/tools/sdk-utils/percy-automate/frameworks.js

@@ -0,0 +1,50 @@
+import * as instructions from "./constants.js";
+export const SUPPORTED_CONFIGURATIONS = {
+    python: {
+        selenium: {
+            pytest: {
+                instructions: instructions.pythonPytestSeleniumInstructions,
+            },
+        },
+        playwright: {
+            pytest: {
+                instructions: instructions.pythonPytestPlaywrightInstructions,
+            },
+        },
+    },
+    java: {
+        playwright: {
+            junit: { instructions: instructions.javaPlaywrightJunitInstructions },
+        },
+    },
+    nodejs: {
+        selenium: {
+            mocha: { instructions: instructions.mochaPercyAutomateInstructions },
+            jest: { instructions: instructions.jestPercyAutomateInstructions },
+            webdriverio: {
+                instructions: instructions.webdriverioPercyAutomateInstructions,
+            },
+            testcafe: {
+                instructions: instructions.testcafePercyAutomateInstructions,
+            },
+        },
+        playwright: {
+            mocha: { instructions: instructions.mochaPercyPlaywrightInstructions },
+            jest: { instructions: instructions.jestPercyAutomateInstructions },
+        },
+    },
+};
+/**
+ * Utility function to check if a given language, driver, and testing framework
+ * are supported by Percy Automate.
+ * This now expects the structure: language -> driver -> framework
+ */
+export function isPercyAutomateFrameworkSupported(language, driver, framework) {
+    const languageConfig = SUPPORTED_CONFIGURATIONS[language];
+    if (!languageConfig)
+        return false;
+    const driverConfig = languageConfig[driver];
+    if (!driverConfig)
+        return false;
+    return !!driverConfig[framework];
+}

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

@@ -0,0 +1,3 @@
+import { RunTestsInstructionResult } from "../common/types.js";
+import { SetUpPercyInput } from "../common/schema.js";
+export declare function runPercyAutomateOnly(input: SetUpPercyInput, percyToken: string): RunTestsInstructionResult;

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

@@ -0,0 +1,30 @@
+import { SUPPORTED_CONFIGURATIONS } from "./frameworks.js";
+export function runPercyAutomateOnly(input, percyToken) {
+    const steps = [];
+    // Assume configuration is supported due to guardrails at orchestration layer
+    const languageConfig = SUPPORTED_CONFIGURATIONS[input.detectedLanguage];
+    const driverConfig = languageConfig[input.detectedBrowserAutomationFramework];
+    const testingFrameworkConfig = driverConfig
+        ? driverConfig[input.detectedTestingFramework]
+        : undefined;
+    // Generate instructions for the supported configuration with project name
+    const instructions = testingFrameworkConfig
+        ? testingFrameworkConfig.instructions
+        : "";
+    // Prepend a step to set the Percy token in the environment
+    steps.push({
+        type: "instruction",
+        title: "Set Percy Token in Environment",
+        content: `Here is percy token if required {${percyToken}}`,
+    });
+    steps.push({
+        type: "instruction",
+        title: `Percy Automate Setup for ${input.detectedLanguage} with ${input.detectedTestingFramework}`,
+        content: instructions,
+    });
+    return {
+        steps,
+        requiresPercy: true,
+        missingDependencies: [],
+    };
+}

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

@@ -0,0 +1 @@
+export { runPercyAutomateOnly } from "./handler.js";

package/dist/tools/sdk-utils/percy-automate/index.js

@@ -0,0 +1,2 @@
+// Percy Automate utilities
+export { runPercyAutomateOnly } from "./handler.js";

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

@@ -0,0 +1,13 @@
+/**
+ * Type for Percy Automate configuration mapping.
+ * Structure: language -> driver -> testingFramework -> { instructions: string }
+ */
+export type ConfigMapping = {
+    [language: string]: {
+        [driver: string]: {
+            [framework: string]: {
+                instructions: string;
+            };
+        };
+    };
+};

package/dist/tools/sdk-utils/percy-automate/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,4 @@
+export declare const javaSeleniumInstructions = "\nImport the BrowserStack Percy SDK in your test script:\nAdd the Percy import to your test file.\n\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\nAdd screenshot capture method at required points:\nUse the `PercySDK.screenshot(driver, name)` method at points in your test script where you want to capture screenshots.\n\nHere's an example:\n\n```java\n// ...imports\nimport com.browserstack.PercySDK;\n\npublic class YourTestClass extends YourBaseTest {\n    @Test\n    public void test() throws Exception {\n         // your test logic\n         // ...\n         \n         // Capture a Percy screenshot\n         PercySDK.screenshot(driver, \"My Screenshot Name\");\n         \n         // ...\n         // more test logic\n    }\n}\n```\n";
+export declare const nodejsSeleniumInstructions = "\nImport the BrowserStack Percy SDK in your test script:\nAdd the Percy import to your test file.\n\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\n---STEP---\n\nAdd screenshot capture method at required points:\nUse the `percy.snapshot(driver, name)` method at points in your test script where you want to capture screenshots.\n\n```javascript\nconst { percy } = require('browserstack-node-sdk');\ndescribe(\"sample Test\", () => {\n  // ... other imports and setup\n  \n  test(\"my test\", async () => {\n    // ....\n    await percy.screenshot(driver, \"My Snapshot\")\n    // ....\n  });\n})\n```\n";
+export declare const webdriverioPercyInstructions = "\nEnable Percy in `wdio.conf.js`:\nIn your WebdriverIO configuration file, modify the 'browserstack' service options to enable Percy.\n\n- Set `percy: true`.\n- Set a `projectName`. This is required and will be used for both your Automate and Percy projects.\n- Set `percyCaptureMode`. The default `manual` as we are adding screenshot commands manually.\n\nHere's how to modify the service configuration:\n```javascript\n// in wdio.conf.js\n\nexports.config = {\n  // ... other configs\n  services: [\n    [\n      'browserstack',\n      { \n        // ... other service options\n        percy: true,\n        percyCaptureMode: 'manual' // or 'auto', etc.\n      },\n    ],\n  ],\n\n  commonCapabilities: {\n    'bstack:options': {\n      projectName: \"My Percy Project\", // This is required for Percy\n      // ... other common capabilities\n    }\n  },\n  // ... rest of your config\n};\n```\n\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\n---STEP---\n\nManually Capturing Screenshots (Optional):\nIf you set `percyCaptureMode: 'manual'` or want to take extra screenshots in `auto` mode, you need to add screenshot commands to your tests.\n\nFirst, install `browserstack-node-sdk`:\n```bash\nnpm install browserstack-node-sdk\n```\n\nThen, in your test script, import `percy` and use it to take a snapshot:\n```javascript\n// your_test_file.js\nconst { percy } = require('browserstack-node-sdk');\n\ndescribe(\"My WebdriverIO Test\", () => {\n  it(\"should take a percy snapshot\", async () => {\n    // ... your test logic (e.g., browser.url('https://example.com'))\n    \n    // Capture a Percy screenshot\n    await percy.screenshot(driver, \"My Snapshot Name\");\n    \n    // ... more test logic\n  });\n});\n```\n";
+export declare const csharpSeleniumInstructions = "\nImport the BrowserStack Percy SDK in your test script:\nAdd the Percy import to your test file.\n\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\nAdd screenshot capture method at required points:\nUse the `PercySDK.Screenshot(driver, name)` method at points in your test script where you want to capture screenshots.\n\nHere's an example:\n\n```csharp\nusing BrowserStackSDK.Percy;\nnamespace Tests;\n\npublic class MyTest\n{\n    [Test]\n    public void SampleTest()\n    {\n        // your test logic\n        // ...\n        \n        // Capture a Percy screenshot\n        PercySDK.Screenshot(driver, \"Screenshot name\");\n        \n        // ...\n        // more test logic\n    }\n}\n```\n";

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

@@ -1,8 +1,9 @@
-const javaSeleniumInstructions = `
+import { PERCY_SNAPSHOT_INSTRUCTION } from "../common/constants.js";
+export const javaSeleniumInstructions = `
 Import the BrowserStack Percy SDK in your test script:
 Add the Percy import to your test file.
 
----STEP---
+${PERCY_SNAPSHOT_INSTRUCTION}
 
 Add screenshot capture method at required points:
 Use the \`PercySDK.screenshot(driver, name)\` method at points in your test script where you want to capture screenshots.
@@ -32,6 +33,8 @@ export const nodejsSeleniumInstructions = `
 Import the BrowserStack Percy SDK in your test script:
 Add the Percy import to your test file.
 
+${PERCY_SNAPSHOT_INSTRUCTION}
+
 ---STEP---
 
 Add screenshot capture method at required points:
@@ -44,19 +47,19 @@ describe("sample Test", () => {
   
   test("my test", async () => {
     // ....
-    await percy.snapshot(driver, "My Snapshot")
+    await percy.screenshot(driver, "My Snapshot")
     // ....
   });
 })
 \`\`\`
 `;
-const webdriverioPercyInstructions = `
+export const webdriverioPercyInstructions = `
 Enable Percy in \`wdio.conf.js\`:
 In your WebdriverIO configuration file, modify the 'browserstack' service options to enable Percy.
 
 - Set \`percy: true\`.
 - Set a \`projectName\`. This is required and will be used for both your Automate and Percy projects.
-- Set \`percyCaptureMode\`. The default \`auto\` mode is recommended, which captures screenshots on events like clicks. Other modes are \`testcase\`, \`click\`, \`screenshot\`, and \`manual\`.
+- Set \`percyCaptureMode\`. The default \`manual\` as we are adding screenshot commands manually.
 
 Here's how to modify the service configuration:
 \`\`\`javascript
@@ -70,7 +73,7 @@ exports.config = {
       { 
         // ... other service options
         percy: true,
-        percyCaptureMode: 'auto' // or 'manual', 'testcase', etc.
+        percyCaptureMode: 'manual' // or 'auto', etc.
       },
     ],
   ],
@@ -85,6 +88,8 @@ exports.config = {
 };
 \`\`\`
 
+${PERCY_SNAPSHOT_INSTRUCTION}
+
 ---STEP---
 
 Manually Capturing Screenshots (Optional):
@@ -112,11 +117,11 @@ describe("My WebdriverIO Test", () => {
 });
 \`\`\`
 `;
-const csharpSeleniumInstructions = `
+export const csharpSeleniumInstructions = `
 Import the BrowserStack Percy SDK in your test script:
 Add the Percy import to your test file.
 
----STEP---
+${PERCY_SNAPSHOT_INSTRUCTION}
 
 Add screenshot capture method at required points:
 Use the \`PercySDK.Screenshot(driver, name)\` method at points in your test script where you want to capture screenshots.
@@ -125,8 +130,6 @@ Here's an example:
 
 \`\`\`csharp
 using BrowserStackSDK.Percy;
-using NUnit.Framework;
-
 namespace Tests;
 
 public class MyTest
@@ -146,32 +149,3 @@ public class MyTest
 }
 \`\`\`
 `;
-export const PERCY_INSTRUCTIONS = {
-    java: {
-        selenium: {
-            testng: { script_updates: javaSeleniumInstructions },
-            cucumber: { script_updates: javaSeleniumInstructions },
-            junit4: { script_updates: javaSeleniumInstructions },
-            junit5: { script_updates: javaSeleniumInstructions },
-            serenity: { script_updates: javaSeleniumInstructions },
-        },
-    },
-    csharp: {
-        selenium: {
-            nunit: { script_updates: csharpSeleniumInstructions },
-        },
-    },
-    nodejs: {
-        selenium: {
-            mocha: {
-                script_updates: nodejsSeleniumInstructions,
-            },
-            jest: {
-                script_updates: nodejsSeleniumInstructions,
-            },
-            webdriverio: {
-                script_updates: webdriverioPercyInstructions,
-            },
-        },
-    },
-};

package/dist/tools/sdk-utils/percy-bstack/frameworks.d.ts

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

package/dist/tools/sdk-utils/percy-bstack/frameworks.js

@@ -0,0 +1,27 @@
+import * as constants from "./constants.js";
+export const PERCY_INSTRUCTIONS = {
+    java: {
+        selenium: {
+            testng: { instructions: constants.javaSeleniumInstructions },
+            cucumber: { instructions: constants.javaSeleniumInstructions },
+            junit4: { instructions: constants.javaSeleniumInstructions },
+            junit5: { instructions: constants.javaSeleniumInstructions },
+            selenide: { instructions: constants.javaSeleniumInstructions },
+            jbehave: { instructions: constants.javaSeleniumInstructions },
+        },
+    },
+    csharp: {
+        selenium: {
+            nunit: { instructions: constants.csharpSeleniumInstructions },
+            xunit: { instructions: constants.csharpSeleniumInstructions },
+            specflow: { instructions: constants.csharpSeleniumInstructions },
+        },
+    },
+    nodejs: {
+        selenium: {
+            mocha: { instructions: constants.nodejsSeleniumInstructions },
+            jest: { instructions: constants.nodejsSeleniumInstructions },
+            webdriverio: { instructions: constants.webdriverioPercyInstructions },
+        },
+    },
+};

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

@@ -0,0 +1,4 @@
+import { RunTestsInstructionResult } from "../common/types.js";
+import { RunTestsOnBrowserStackInput } from "../common/schema.js";
+import { BrowserStackConfig } from "../../../lib/types.js";
+export declare function runPercyWithBrowserstackSDK(input: RunTestsOnBrowserStackInput, config: BrowserStackConfig): RunTestsInstructionResult;