@browserstack/mcp-server 1.0.13 → 1.0.15

package/dist/tools/testmanagement-utils/create-testrun.js

@@ -1,28 +1,21 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTestRunSchema = void 0;
-exports.createTestRun = createTestRun;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for creating a test run.
  */
-exports.CreateTestRunSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const CreateTestRunSchema = z.object({
+    project_identifier: z
         .string()
         .describe("Identifier of the project in which to create the test run."),
-    test_run: zod_1.z.object({
-        name: zod_1.z.string().describe("Name of the test run"),
-        description: zod_1.z
+    test_run: z.object({
+        name: z.string().describe("Name of the test run"),
+        description: z
             .string()
             .optional()
             .describe("Brief information about the test run"),
-        run_state: zod_1.z
+        run_state: z
             .enum([
             "new_run",
             "in_progress",
@@ -33,17 +26,17 @@ exports.CreateTestRunSchema = zod_1.z.object({
         ])
             .optional()
             .describe("State of the test run. One of new_run, in_progress, under_review, rejected, done, closed"),
-        issues: zod_1.z.array(zod_1.z.string()).optional().describe("Linked issue IDs"),
-        issue_tracker: zod_1.z
-            .object({ name: zod_1.z.string(), host: zod_1.z.string().url() })
+        issues: z.array(z.string()).optional().describe("Linked issue IDs"),
+        issue_tracker: z
+            .object({ name: z.string(), host: z.string().url() })
             .optional()
             .describe("Issue tracker configuration"),
-        test_cases: zod_1.z
-            .array(zod_1.z.string())
+        test_cases: z
+            .array(z.string())
             .optional()
             .describe("List of test case IDs"),
-        folder_ids: zod_1.z
-            .array(zod_1.z.number())
+        folder_ids: z
+            .array(z.number())
             .optional()
             .describe("Folder IDs to include"),
     }),
@@ -51,7 +44,7 @@ exports.CreateTestRunSchema = zod_1.z.object({
 /**
  * Creates a test run via BrowserStack Test Management API.
  */
-async function createTestRun(rawArgs) {
+export async function createTestRun(rawArgs) {
     try {
         const inputArgs = {
             ...rawArgs,
@@ -60,12 +53,12 @@ async function createTestRun(rawArgs) {
                 include_all: false,
             },
         };
-        const args = exports.CreateTestRunSchema.parse(inputArgs);
+        const args = CreateTestRunSchema.parse(inputArgs);
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs`;
-        const response = await axios_1.default.post(url, { test_run: args.test_run }, {
+        const response = await axios.post(url, { test_run: args.test_run }, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
             headers: { "Content-Type": "application/json" },
         });
@@ -85,6 +78,6 @@ async function createTestRun(rawArgs) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to create test run");
+        return formatAxiosError(err, "Failed to create test run");
     }
 }

package/dist/tools/testmanagement-utils/list-testcases.js

@@ -1,39 +1,32 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListTestCasesSchema = void 0;
-exports.listTestCases = listTestCases;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for listing test cases with optional filters.
  */
-exports.ListTestCasesSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const ListTestCasesSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Identifier of the project to fetch test cases from.  Example: PR-12345"),
-    folder_id: zod_1.z
+        .describe("Identifier of the project to fetch test cases from. This id starts with a PR- and is followed by a number."),
+    folder_id: z
         .string()
         .optional()
         .describe("If provided, only return cases in this folder."),
-    case_type: zod_1.z
+    case_type: z
         .string()
         .optional()
         .describe("Comma-separated list of case types (e.g. functional,regression)."),
-    priority: zod_1.z
+    priority: z
         .string()
         .optional()
         .describe("Comma-separated list of priorities (e.g. critical,medium,low)."),
-    p: zod_1.z.number().optional().describe("Page number."),
+    p: z.number().optional().describe("Page number."),
 });
 /**
  * Calls BrowserStack Test Management to list test cases with filters.
  */
-async function listTestCases(args) {
+export async function listTestCases(args) {
     try {
         // Build query string
         const params = new URLSearchParams();
@@ -46,10 +39,10 @@ async function listTestCases(args) {
         if (args.p !== undefined)
             params.append("p", args.p.toString());
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-cases?${params.toString()}`;
-        const resp = await axios_1.default.get(url, {
+        const resp = await axios.get(url, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const resp_data = resp.data;
@@ -85,6 +78,6 @@ async function listTestCases(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to list test cases");
+        return formatAxiosError(err, "Failed to list test cases");
     }
 }

package/dist/tools/testmanagement-utils/list-testruns.js

@@ -1,22 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListTestRunsSchema = void 0;
-exports.listTestRuns = listTestRuns;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for listing test runs with optional filters.
  */
-exports.ListTestRunsSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const ListTestRunsSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Identifier of the project to fetch test runs from (e.g., PR-12345)"),
-    run_state: zod_1.z
+        .describe("Identifier of the project to fetch test runs from (usually starts with PR-)."),
+    run_state: z
         .string()
         .optional()
         .describe("Return all test runs with this state (comma-separated)"),
@@ -24,17 +17,17 @@ exports.ListTestRunsSchema = zod_1.z.object({
 /**
  * Fetches and formats the list of test runs for a project.
  */
-async function listTestRuns(args) {
+export async function listTestRuns(args) {
     try {
         const params = new URLSearchParams();
         if (args.run_state) {
             params.set("run_state", args.run_state);
         }
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs?` + params.toString();
-        const resp = await axios_1.default.get(url, {
+        const resp = await axios.get(url, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const data = resp.data;
@@ -63,6 +56,6 @@ async function listTestRuns(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to list test runs");
+        return formatAxiosError(err, "Failed to list test runs");
     }
 }

package/dist/tools/testmanagement-utils/testcase-from-file.js

@@ -0,0 +1,42 @@
+import { fetchFormFields, triggerTestCaseGeneration, pollScenariosTestDetails, bulkCreateTestCases, } from "./TCG-utils/api.js";
+import { buildDefaultFieldMaps, findBooleanFieldId, } from "./TCG-utils/helpers.js";
+import { signedUrlMap } from "../../lib/inmemory-store.js";
+import logger from "../../logger.js";
+import { projectIdentifierToId } from "./TCG-utils/api.js";
+export async function createTestCasesFromFile(args, context) {
+    logger.info(`createTestCasesFromFile called with projectId: ${args.projectReferenceId}, folderId: ${args.folderId}`);
+    if (args.projectReferenceId.startsWith("PR-")) {
+        args.projectReferenceId = await projectIdentifierToId(args.projectReferenceId);
+    }
+    const { default_fields, custom_fields } = await fetchFormFields(args.projectReferenceId);
+    const fieldMaps = buildDefaultFieldMaps(default_fields);
+    const booleanFieldId = findBooleanFieldId(custom_fields);
+    const documentObj = signedUrlMap.get(args.documentId);
+    if (!documentObj) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Document with ID ${args.documentId} not found.`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
+    }
+    const documentId = documentObj.fileId;
+    const document = documentObj.downloadUrl;
+    const source = "jira-on-prem";
+    const traceId = await triggerTestCaseGeneration(document, documentId, args.folderId, args.projectReferenceId, source);
+    const scenariosMap = await pollScenariosTestDetails(args, traceId, context, documentId, source);
+    const resultString = await bulkCreateTestCases(scenariosMap, args.projectReferenceId, args.folderId, fieldMaps, booleanFieldId, traceId, context, documentId);
+    signedUrlMap.delete(args.documentId);
+    return {
+        content: [
+            {
+                type: "text",
+                text: resultString,
+            },
+        ],
+    };
+}

package/dist/tools/testmanagement-utils/update-testrun.js

@@ -1,25 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateTestRunSchema = void 0;
-exports.updateTestRun = updateTestRun;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for updating a test run with partial fields.
  */
-exports.UpdateTestRunSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const UpdateTestRunSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Project identifier (e.g., PR-12345)"),
-    test_run_id: zod_1.z.string().describe("Test run identifier (e.g., TR-678)"),
-    test_run: zod_1.z.object({
-        name: zod_1.z.string().optional().describe("New name of the test run"),
-        run_state: zod_1.z
+        .describe("Identifier of the project (Starts with 'PR-')"),
+    test_run_id: z.string().describe("Test run identifier (e.g., TR-678)"),
+    test_run: z.object({
+        name: z.string().optional().describe("New name of the test run"),
+        run_state: z
             .enum([
             "new_run",
             "in_progress",
@@ -35,14 +28,14 @@ exports.UpdateTestRunSchema = zod_1.z.object({
 /**
  * Partially updates an existing test run.
  */
-async function updateTestRun(args) {
+export async function updateTestRun(args) {
     try {
         const body = { test_run: args.test_run };
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs/${encodeURIComponent(args.test_run_id)}/update`;
-        const resp = await axios_1.default.patch(url, body, {
+        const resp = await axios.patch(url, body, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const data = resp.data;
@@ -69,6 +62,6 @@ async function updateTestRun(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to update test run");
+        return formatAxiosError(err, "Failed to update test run");
     }
 }

package/dist/tools/testmanagement-utils/upload-file.js

@@ -0,0 +1,101 @@
+import { z } from "zod";
+import axios from "axios";
+import FormData from "form-data";
+import fs from "fs";
+import path from "path";
+import { v4 as uuidv4 } from "uuid";
+import config from "../../config.js";
+import { signedUrlMap } from "../../lib/inmemory-store.js";
+import { projectIdentifierToId } from "./TCG-utils/api.js";
+/**
+ * Schema for the upload file tool
+ */
+export const UploadFileSchema = z.object({
+    project_identifier: z
+        .string()
+        .describe("ID of the project where the file should be uploaded. Do not assume it, always ask user for it."),
+    file_path: z
+        .string()
+        .describe("Full path to the file that should be uploaded"),
+});
+/**
+ * Uploads a file to BrowserStack Test Management and returns the signed URL.
+ */
+export async function uploadFile(args) {
+    const { project_identifier, file_path } = args;
+    try {
+        // Validate file exists
+        if (!fs.existsSync(file_path)) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `File ${file_path} does not exist.`,
+                        isError: true,
+                    },
+                ],
+                isError: true,
+            };
+        }
+        // Get the project ID
+        const projectIdResponse = await projectIdentifierToId(project_identifier);
+        const formData = new FormData();
+        formData.append("attachments[]", fs.createReadStream(file_path));
+        const uploadUrl = `https://test-management.browserstack.com/api/v1/projects/${projectIdResponse}/generic/attachments/ai_uploads`;
+        const response = await axios.post(uploadUrl, formData, {
+            headers: {
+                ...formData.getHeaders(),
+                "API-TOKEN": `${config.browserstackUsername}:${config.browserstackAccessKey}`,
+                accept: "application/json, text/plain, */*",
+            },
+        });
+        if (response.status >= 200 &&
+            response.status < 300 &&
+            response.data.generic_attachment) {
+            const attachments = response.data.generic_attachment.map((attachment) => {
+                // Generate a unique ID for each attachment
+                const fileId = uuidv4();
+                // Store the download URL in the signedUrlMap
+                const data = {
+                    fileId: attachment.id,
+                    downloadUrl: attachment.download_url,
+                };
+                signedUrlMap.set(fileId, data);
+                return {
+                    name: attachment.name,
+                    documentID: fileId,
+                    contentType: attachment.content_type,
+                    size: attachment.size,
+                    projectReferenceId: projectIdResponse,
+                };
+            });
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully uploaded ${path.basename(file_path)} to BrowserStack Test Management.`,
+                    },
+                    {
+                        type: "text",
+                        text: JSON.stringify(attachments, null, 2),
+                    },
+                ],
+            };
+        }
+        else {
+            throw new Error(`Unexpected response: ${JSON.stringify(response.data)}`);
+        }
+    }
+    catch (error) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Failed to upload file: ${error instanceof Error ? error.message : "Unknown error"}. Please check your credentials and try again.`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
+    }
+}