xray-mcp 1.0.0

package/dist/xray-client.d.ts

@@ -0,0 +1,191 @@
+export interface XrayConfig {
+    clientId: string;
+    clientSecret: string;
+    baseUrl?: string;
+}
+export interface XrayAuthResponse {
+    access_token: string;
+    expires_in: number;
+}
+export interface TestCase {
+    id?: string;
+    key?: string;
+    summary: string;
+    description?: string;
+    testType?: 'Manual' | 'Cucumber' | 'Generic';
+    projectKey: string;
+    labels?: string[];
+    components?: string[];
+    priority?: string;
+    status?: string;
+}
+export interface TestCaseResponse {
+    id: string;
+    key: string;
+    self: string;
+}
+export interface TestExecution {
+    summary: string;
+    projectKey: string;
+    testIssueIds?: string[];
+    testEnvironments?: string[];
+    description?: string;
+}
+export interface TestExecutionResponse {
+    issueId: string;
+    key: string;
+    testRuns?: TestRun[];
+}
+export interface TestRun {
+    id: string;
+    status: {
+        name: string;
+        description?: string;
+    };
+    test: {
+        issueId: string;
+        jira: any;
+    };
+    startedOn?: string;
+    finishedOn?: string;
+    executedBy?: string;
+}
+export type TestRunStatus = 'TODO' | 'EXECUTING' | 'PASS' | 'FAIL' | 'ABORTED' | 'PASSED' | 'FAILED';
+export interface TestPlan {
+    summary: string;
+    projectKey: string;
+    testIssueIds?: string[];
+    description?: string;
+}
+export interface TestPlanResponse {
+    issueId: string;
+    key: string;
+    tests?: any[];
+}
+export interface TestSet {
+    summary: string;
+    projectKey: string;
+    testIssueIds?: string[];
+    description?: string;
+}
+export interface TestSetResponse {
+    issueId: string;
+    key: string;
+    tests?: any[];
+}
+export declare class XrayClient {
+    private config;
+    private client;
+    private graphqlClient;
+    private accessToken;
+    private tokenExpiry;
+    constructor(config: XrayConfig);
+    /**
+     * Authenticate with Xray Cloud API and get access token
+     */
+    private authenticate;
+    /**
+     * Make an authenticated request to the Xray API
+     */
+    private request;
+    /**
+     * Make a GraphQL query to Xray API
+     */
+    private graphqlRequest;
+    /**
+     * Create a new test case using GraphQL mutation
+     */
+    createTestCase(testCase: TestCase): Promise<TestCaseResponse>;
+    /**
+     * Get a test case by key using GraphQL
+     */
+    getTestCase(testKey: string): Promise<any>;
+    /**
+     * Update a test case
+     * Note: Xray GraphQL API has specific mutations for test definition updates
+     * (updateUnstructuredTestDefinition, updateGherkinTestDefinition, etc.)
+     * For general Jira field updates (summary, description, labels), use Jira REST API directly
+     */
+    updateTestCase(testKey: string, updates: Partial<TestCase>): Promise<void>;
+    /**
+     * Delete a test case using GraphQL mutation
+     * First retrieves the issueId from the test key, then deletes it
+     */
+    deleteTestCase(testKey: string): Promise<void>;
+    /**
+     * Get test cases for a project using GraphQL
+     */
+    getTestCasesByProject(projectKey: string, maxResults?: number): Promise<any>;
+    /**
+     * Search test cases using JQL and GraphQL
+     */
+    searchTestCases(jql: string, maxResults?: number): Promise<any>;
+    /**
+     * Create a new test execution using GraphQL mutation
+     */
+    createTestExecution(testExecution: TestExecution): Promise<TestExecutionResponse>;
+    /**
+     * Get a test execution by key using GraphQL
+     */
+    getTestExecution(testExecutionKey: string): Promise<any>;
+    /**
+     * Get test executions for a project using GraphQL
+     */
+    getTestExecutionsByProject(projectKey: string, maxResults?: number): Promise<any>;
+    /**
+     * Search test executions using JQL and GraphQL
+     */
+    searchTestExecutions(jql: string, maxResults?: number): Promise<any>;
+    /**
+     * Update the status of a test run using GraphQL mutation
+     */
+    updateTestRunStatus(testRunId: string, status: TestRunStatus): Promise<string>;
+    /**
+     * Create a new test plan using GraphQL mutation
+     */
+    createTestPlan(testPlan: TestPlan): Promise<TestPlanResponse>;
+    /**
+     * Get a test plan by key using GraphQL
+     */
+    getTestPlan(testPlanKey: string): Promise<any>;
+    /**
+     * Search test plans using JQL and GraphQL
+     */
+    searchTestPlans(jql: string, maxResults?: number): Promise<any>;
+    /**
+     * Get test plans for a project using GraphQL
+     */
+    getTestPlansByProject(projectKey: string, maxResults?: number): Promise<any>;
+    /**
+     * Add tests to a test plan using GraphQL mutation
+     */
+    addTestsToTestPlan(testPlanIssueId: string, testIssueIds: string[]): Promise<any>;
+    /**
+     * Remove tests from a test plan using GraphQL mutation
+     */
+    removeTestsFromTestPlan(testPlanIssueId: string, testIssueIds: string[]): Promise<any>;
+    /**
+     * Create a new test set using GraphQL mutation
+     */
+    createTestSet(testSet: TestSet): Promise<TestSetResponse>;
+    /**
+     * Get a test set by key using GraphQL
+     */
+    getTestSet(testSetKey: string): Promise<any>;
+    /**
+     * Search test sets using JQL and GraphQL
+     */
+    searchTestSets(jql: string, maxResults?: number): Promise<any>;
+    /**
+     * Get test sets for a project using GraphQL
+     */
+    getTestSetsByProject(projectKey: string, maxResults?: number): Promise<any>;
+    /**
+     * Add tests to a test set using GraphQL mutation
+     */
+    addTestsToTestSet(testSetIssueId: string, testIssueIds: string[]): Promise<any>;
+    /**
+     * Remove tests from a test set using GraphQL mutation
+     */
+    removeTestsFromTestSet(testSetIssueId: string, testIssueIds: string[]): Promise<any>;
+}