@smartbear/mcp 0.12.1 → 0.13.2

package/dist/qmetry/client/issues.js

@@ -1,123 +1,141 @@
 import { QMETRY_PATHS } from "../config/rest-endpoints.js";
-import { DEFAULT_CREATE_ISSUE_PAYLOAD, DEFAULT_FETCH_ISSUES_LINKED_TO_TESTCASE_PAYLOAD, DEFAULT_FETCH_ISSUES_PAYLOAD, DEFAULT_LINK_ISSUES_TO_TESTCASE_RUN_PAYLOAD, DEFAULT_UPDATE_ISSUE_PAYLOAD, } from "../types/issues.js";
+import { DEFAULT_LINK_ISSUES_TO_TESTCASE_RUN_PAYLOAD, DEFAULT_FETCH_ISSUES_PAYLOAD, DEFAULT_UPDATE_ISSUE_PAYLOAD, DEFAULT_CREATE_ISSUE_PAYLOAD, DEFAULT_FETCH_ISSUES_LINKED_TO_TESTCASE_PAYLOAD } from "../types/issues.js";
 import { qmetryRequest } from "./api/client-api.js";
 import { resolveDefaults } from "./utils.js";
-/**
- * Create Defect/Issue.
- * @throws If `issueType` or `issuePriority` or `summary` are missing/invalid.
- */
-export async function createIssue(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_CREATE_ISSUE_PAYLOAD,
-        ...payload,
-    };
-    if (typeof body.issueType !== "number") {
-        throw new Error("[createIssue] Missing or invalid required parameter: 'issueType'.");
-    }
-    if (typeof body.issuePriority !== "number") {
-        throw new Error("[createIssue] Missing or invalid required parameter: 'issuePriority'.");
-    }
-    if (typeof body.summary !== "string") {
-        throw new Error("[createIssue] Missing or invalid required parameter: 'summary'.");
-    }
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.ISSUES.CREATE_UPDATE_ISSUE,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function createIssue(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_CREATE_ISSUE_PAYLOAD,
+    ...payload
+  };
+  if (typeof body.issueType !== "number") {
+    throw new Error(
+      "[createIssue] Missing or invalid required parameter: 'issueType'."
+    );
+  }
+  if (typeof body.issuePriority !== "number") {
+    throw new Error(
+      "[createIssue] Missing or invalid required parameter: 'issuePriority'."
+    );
+  }
+  if (typeof body.summary !== "string") {
+    throw new Error(
+      "[createIssue] Missing or invalid required parameter: 'summary'."
+    );
+  }
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.ISSUES.CREATE_UPDATE_ISSUE,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Update Defect/Issue.
- * @throws If `DefectId` is missing/invalid.
- */
-export async function updateIssue(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_UPDATE_ISSUE_PAYLOAD,
-        ...payload,
-    };
-    if (typeof body.DefectId !== "number") {
-        throw new Error("[updateIssue] Missing or invalid required parameter: 'DefectId'.");
-    }
-    return qmetryRequest({
-        method: "PUT",
-        path: QMETRY_PATHS.ISSUES.CREATE_UPDATE_ISSUE,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function updateIssue(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_UPDATE_ISSUE_PAYLOAD,
+    ...payload
+  };
+  if (typeof body.DefectId !== "number") {
+    throw new Error(
+      "[updateIssue] Missing or invalid required parameter: 'DefectId'."
+    );
+  }
+  return qmetryRequest({
+    method: "PUT",
+    path: QMETRY_PATHS.ISSUES.CREATE_UPDATE_ISSUE,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Fetches a list of test suites.
- * @throws If `viewId` or `folderPath` are missing/invalid.
- */
-export async function fetchIssues(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_FETCH_ISSUES_PAYLOAD,
-        ...payload,
-    };
-    if (typeof body.viewId !== "number") {
-        throw new Error("[fetchIssues] Missing or invalid required parameter: 'viewId'.");
-    }
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.ISSUES.GET_ISSUES_LIST,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function fetchIssues(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_FETCH_ISSUES_PAYLOAD,
+    ...payload
+  };
+  if (typeof body.viewId !== "number") {
+    throw new Error(
+      "[fetchIssues] Missing or invalid required parameter: 'viewId'."
+    );
+  }
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.ISSUES.GET_ISSUES_LIST,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Fetches issues linked to a specific test case.
- * @throws If `tcID` is missing/invalid.
- */
-export async function fetchIssuesLinkedToTestCase(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_FETCH_ISSUES_LINKED_TO_TESTCASE_PAYLOAD,
-        ...payload,
-    };
-    if (typeof body.tcID !== "number") {
-        throw new Error("[fetchIssuesLinkedToTestCase] Missing or invalid required parameter: 'tcID'.");
-    }
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.ISSUES.GET_ISSUES_LINKED_TO_TC,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function fetchIssuesLinkedToTestCase(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_FETCH_ISSUES_LINKED_TO_TESTCASE_PAYLOAD,
+    ...payload
+  };
+  if (typeof body.tcID !== "number") {
+    throw new Error(
+      "[fetchIssuesLinkedToTestCase] Missing or invalid required parameter: 'tcID'."
+    );
+  }
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.ISSUES.GET_ISSUES_LINKED_TO_TC,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Link Issues to Testcase Run.
- * @throws If issueIds or tcrId are missing/invalid.
- */
-export async function linkIssuesToTestcaseRun(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_LINK_ISSUES_TO_TESTCASE_RUN_PAYLOAD,
-        ...payload,
-    };
-    if (!Array.isArray(body.issueIds) || body.issueIds.length === 0) {
-        throw new Error("[linkIssuesToTestcaseRun] Missing or invalid required parameter: 'issueIds'.");
-    }
-    if (typeof body.tcrId !== "number") {
-        throw new Error("[linkIssuesToTestcaseRun] Missing or invalid required parameter: 'tcrId'.");
-    }
-    return qmetryRequest({
-        method: "PUT",
-        path: QMETRY_PATHS.ISSUES.LINK_ISSUES_TO_TESTCASE_RUN,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function linkIssuesToTestcaseRun(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_LINK_ISSUES_TO_TESTCASE_RUN_PAYLOAD,
+    ...payload
+  };
+  if (!Array.isArray(body.issueIds) || body.issueIds.length === 0) {
+    throw new Error(
+      "[linkIssuesToTestcaseRun] Missing or invalid required parameter: 'issueIds'."
+    );
+  }
+  if (typeof body.tcrId !== "number") {
+    throw new Error(
+      "[linkIssuesToTestcaseRun] Missing or invalid required parameter: 'tcrId'."
+    );
+  }
+  return qmetryRequest({
+    method: "PUT",
+    path: QMETRY_PATHS.ISSUES.LINK_ISSUES_TO_TESTCASE_RUN,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
+export {
+  createIssue,
+  fetchIssues,
+  fetchIssuesLinkedToTestCase,
+  linkIssuesToTestcaseRun,
+  updateIssue
+};

package/dist/qmetry/client/project.js

@@ -1,186 +1,165 @@
 import { QMETRY_DEFAULTS } from "../config/constants.js";
 import { QMETRY_PATHS } from "../config/rest-endpoints.js";
-import { DEFAULT_CREATE_CYCLE_PAYLOAD, DEFAULT_CREATE_RELEASE_PAYLOAD, DEFAULT_FETCH_BUILD_PAYLOAD, DEFAULT_FETCH_PLATFORMS_PAYLOAD, DEFAULT_FETCH_PROJECTS_PAYLOAD, } from "../types/project.js";
+import { DEFAULT_CREATE_CYCLE_PAYLOAD, DEFAULT_CREATE_RELEASE_PAYLOAD, DEFAULT_FETCH_PROJECTS_PAYLOAD, DEFAULT_FETCH_BUILD_PAYLOAD, DEFAULT_FETCH_PLATFORMS_PAYLOAD } from "../types/project.js";
 import { qmetryRequest } from "./api/client-api.js";
 import { resolveDefaults } from "./utils.js";
-/**
- * Retrieves project information from QMetry
- *
- * This function serves dual purpose:
- * 1. SET_PROJECT_INFO - Sets/switches the current project context
- * 2. FETCH_PROJECT_INFO - Retrieves project details and configuration
- *
- * Both operations use the same API endpoint as QMetry handles project context
- * switching and information retrieval through the same GET request.
- *
- * @param token - QMetry API authentication token
- * @param baseUrl - QMetry instance base URL (defaults to configured URL)
- * @param project - Project key to retrieve info for (defaults to configured project)
- * @returns Promise resolving to project information including viewIds, folders, and configuration
- */
-export async function getProjectInfo(token, baseUrl, project) {
-    return qmetryRequest({
-        method: "GET",
-        path: QMETRY_PATHS.PROJECT.GET_INFO,
-        token,
-        baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
-        project: project || QMETRY_DEFAULTS.PROJECT_KEY,
-    });
+async function getProjectInfo(token, baseUrl, project) {
+  return qmetryRequest({
+    method: "GET",
+    path: QMETRY_PATHS.PROJECT.GET_INFO,
+    token,
+    baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
+    project: project || QMETRY_DEFAULTS.PROJECT_KEY
+  });
 }
-/**
- * Fetches a List of projects.
- */
-export async function getProjects(token, baseUrl, project, payload) {
-    const body = {
-        ...DEFAULT_FETCH_PROJECTS_PAYLOAD,
-        ...payload,
-    };
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.GET_PROJECTS,
-        token,
-        baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
-        project: project || QMETRY_DEFAULTS.PROJECT_KEY,
-        body,
-    });
+async function getProjects(token, baseUrl, project, payload) {
+  const body = {
+    ...DEFAULT_FETCH_PROJECTS_PAYLOAD,
+    ...payload
+  };
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.GET_PROJECTS,
+    token,
+    baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
+    project: project || QMETRY_DEFAULTS.PROJECT_KEY,
+    body
+  });
 }
-export async function getReleasesCycles(token, baseUrl, project, payload = {}) {
-    let showArchiveValue;
-    if (payload.showArchive !== undefined) {
-        showArchiveValue = payload.showArchive;
-    }
-    else {
-        showArchiveValue = false;
-    }
-    const body = {
-        showArchive: showArchiveValue,
-    };
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.GET_RELEASES_CYCLES,
-        token,
-        baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
-        project: project || QMETRY_DEFAULTS.PROJECT_KEY,
-        body,
-    });
+async function getReleasesCycles(token, baseUrl, project, payload = {}) {
+  let showArchiveValue;
+  if (payload.showArchive !== void 0) {
+    showArchiveValue = payload.showArchive;
+  } else {
+    showArchiveValue = false;
+  }
+  const body = {
+    showArchive: showArchiveValue
+  };
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.GET_RELEASES_CYCLES,
+    token,
+    baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
+    project: project || QMETRY_DEFAULTS.PROJECT_KEY,
+    body
+  });
 }
-/**
- * Fetches a List of Builds of the current project.
- */
-export async function getBuilds(token, baseUrl, project, payload) {
-    const body = {
-        ...DEFAULT_FETCH_BUILD_PAYLOAD,
-        ...payload,
-    };
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.GET_BUILD,
-        token,
-        baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
-        project: project || QMETRY_DEFAULTS.PROJECT_KEY,
-        body,
-    });
+async function getBuilds(token, baseUrl, project, payload) {
+  const body = {
+    ...DEFAULT_FETCH_BUILD_PAYLOAD,
+    ...payload
+  };
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.GET_BUILD,
+    token,
+    baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
+    project: project || QMETRY_DEFAULTS.PROJECT_KEY,
+    body
+  });
 }
-/**
- * Fetches platforms from the current QMetry project
- *
- */
-export async function getPlatforms(token, baseUrl, project, payload) {
-    const body = {
-        ...DEFAULT_FETCH_PLATFORMS_PAYLOAD,
-        ...payload,
-    };
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.GET_PLATFORMS,
-        token,
-        baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
-        project: project || QMETRY_DEFAULTS.PROJECT_KEY,
-        body,
-    });
+async function getPlatforms(token, baseUrl, project, payload) {
+  const body = {
+    ...DEFAULT_FETCH_PLATFORMS_PAYLOAD,
+    ...payload
+  };
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.GET_PLATFORMS,
+    token,
+    baseUrl: baseUrl || QMETRY_DEFAULTS.BASE_URL,
+    project: project || QMETRY_DEFAULTS.PROJECT_KEY,
+    body
+  });
 }
-/**
- * Creates a new release in QMetry with optional cycle
- *
- * @param token - QMetry API authentication token
- * @param baseUrl - QMetry instance base URL
- * @param project - Project key
- * @param payload - Release and cycle data
- * @returns Promise resolving to the created release information
- */
-export async function createRelease(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_CREATE_RELEASE_PAYLOAD,
-        ...payload,
-    };
-    if (typeof body.release.name !== "string") {
-        throw new Error("[createRelease] Missing or invalid required parameter: 'release.name'.");
-    }
-    if (body.cycle && typeof body.cycle.name !== "string") {
-        throw new Error("[createRelease] Missing or invalid required parameter: 'cycle.name'.");
-    }
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.CREATE_RELEASE,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function createRelease(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_CREATE_RELEASE_PAYLOAD,
+    ...payload
+  };
+  if (typeof body.release.name !== "string") {
+    throw new Error(
+      "[createRelease] Missing or invalid required parameter: 'release.name'."
+    );
+  }
+  if (body.cycle && typeof body.cycle.name !== "string") {
+    throw new Error(
+      "[createRelease] Missing or invalid required parameter: 'cycle.name'."
+    );
+  }
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.CREATE_RELEASE,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Creates a new cycle within an existing release in QMetry
- *
- * @param token - QMetry API authentication token
- * @param baseUrl - QMetry instance base URL
- * @param project - Project key
- * @param payload - Cycle data including releaseID
- * @returns Promise resolving to the created cycle information
- */
-export async function createCycle(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    const body = {
-        ...DEFAULT_CREATE_CYCLE_PAYLOAD.cycle,
-        ...payload,
-    };
-    if (typeof body.cycle.name !== "string") {
-        throw new Error("[createCycle] Missing or invalid required parameter: 'cycle.name'.");
-    }
-    if (typeof body.cycle.releaseID !== "number") {
-        throw new Error("[createCycle] Missing or invalid required parameter: 'cycle.releaseID'.");
-    }
-    return qmetryRequest({
-        method: "POST",
-        path: QMETRY_PATHS.PROJECT.CREATE_CYCLE,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body,
-    });
+async function createCycle(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  const body = {
+    ...DEFAULT_CREATE_CYCLE_PAYLOAD.cycle,
+    ...payload
+  };
+  if (typeof body.cycle.name !== "string") {
+    throw new Error(
+      "[createCycle] Missing or invalid required parameter: 'cycle.name'."
+    );
+  }
+  if (typeof body.cycle.releaseID !== "number") {
+    throw new Error(
+      "[createCycle] Missing or invalid required parameter: 'cycle.releaseID'."
+    );
+  }
+  return qmetryRequest({
+    method: "POST",
+    path: QMETRY_PATHS.PROJECT.CREATE_CYCLE,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body
+  });
 }
-/**
- * Updates an existing cycle in QMetry
- * @param token - QMetry API token
- * @param baseUrl - QMetry base URL
- * @param project - Project key
- * @param payload - Cycle data including buildID and releaseID for identification
- * @returns Promise resolving to the updated cycle information
- */
-export async function updateCycle(token, baseUrl, project, payload) {
-    const { resolvedBaseUrl, resolvedProject } = resolveDefaults(baseUrl, project);
-    if (typeof payload.cycle.buildID !== "number") {
-        throw new Error("[updateCycle] Missing or invalid required parameter: 'cycle.buildID'.");
-    }
-    if (typeof payload.cycle.releaseID !== "number") {
-        throw new Error("[updateCycle] Missing or invalid required parameter: 'cycle.releaseID'.");
-    }
-    return qmetryRequest({
-        method: "PUT",
-        path: QMETRY_PATHS.PROJECT.UPDATE_CYCLE,
-        token,
-        project: resolvedProject,
-        baseUrl: resolvedBaseUrl,
-        body: payload,
-    });
+async function updateCycle(token, baseUrl, project, payload) {
+  const { resolvedBaseUrl, resolvedProject } = resolveDefaults(
+    baseUrl,
+    project
+  );
+  if (typeof payload.cycle.buildID !== "number") {
+    throw new Error(
+      "[updateCycle] Missing or invalid required parameter: 'cycle.buildID'."
+    );
+  }
+  if (typeof payload.cycle.releaseID !== "number") {
+    throw new Error(
+      "[updateCycle] Missing or invalid required parameter: 'cycle.releaseID'."
+    );
+  }
+  return qmetryRequest({
+    method: "PUT",
+    path: QMETRY_PATHS.PROJECT.UPDATE_CYCLE,
+    token,
+    project: resolvedProject,
+    baseUrl: resolvedBaseUrl,
+    body: payload
+  });
 }
+export {
+  createCycle,
+  createRelease,
+  getBuilds,
+  getPlatforms,
+  getProjectInfo,
+  getProjects,
+  getReleasesCycles,
+  updateCycle
+};