@uarlouski/testrail-mcp-server 1.3.0 → 1.3.1

package/src/client/testrail.ts

@@ -1,227 +0,0 @@
-import { Case, Section, Priority, CaseType, CaseField, Template, Project, Run, Status, Test, Result, Attachment } from "../types/testrail.js";
-
-import * as fs from "fs";
-
-interface PaginatedCasesResponse {
-    cases: Case[];
-    _links: { next: string | null };
-}
-
-interface PaginatedTestsResponse {
-    tests: Test[];
-    _links: { next: string | null };
-}
-
-const API_INDEX = '/index.php?';
-const API_BASE_V2 = `${API_INDEX}/api/v2`;
-
-export class TestRailClient {
-    private baseUrl: string;
-    private headers: HeadersInit;
-    private auth: string;
-    private prioritiesPromise: Promise<Priority[]> | null = null;
-    private caseTypesPromise: Promise<CaseType[]> | null = null;
-    private caseFieldsPromise: Promise<CaseField[]> | null = null;
-    private statusesPromise: Promise<Status[]> | null = null;
-    private projectsPromise: Promise<Project[]> | null = null;
-    private templatesPromiseMap: Map<string, Promise<Template[]>> = new Map();
-
-    constructor(baseUrl: string, email: string, apiKey: string) {
-        this.baseUrl = baseUrl.replace(/\/$/, "");
-        const auth = Buffer.from(`${email}:${apiKey}`).toString('base64');
-        this.auth = `Basic ${auth}`;
-        this.headers = {
-            "Content-Type": "application/json",
-            "Authorization": this.auth,
-        };
-    }
-
-    async getCase(caseId: string): Promise<Case> {
-        return this.get<Case>(`${API_BASE_V2}/get_case/${caseId}`);
-    }
-
-    async getCases(projectId: string, sectionId?: string, filter?: Record<string, string>): Promise<Case[]> {
-        let url = `${API_BASE_V2}/get_cases/${projectId}`;
-
-        if (sectionId) {
-            url += `&section_id=${sectionId}`;
-        }
-
-        if (filter) {
-            for (const [key, value] of Object.entries(filter)) {
-                url += `&${key}=${encodeURIComponent(value)}`;
-            }
-        }
-
-        const allCases: Case[] = [];
-        let nextUrl: string | null = url;
-
-        while (nextUrl) {
-            const response: PaginatedCasesResponse = await this.get<PaginatedCasesResponse>(nextUrl);
-
-            allCases.push(...response.cases);
-
-            nextUrl = response._links?.next;
-            if (nextUrl) {
-                nextUrl = `${API_INDEX}${nextUrl}`;
-            }
-        }
-
-        return allCases;
-    }
-
-    async getSection(sectionId: string): Promise<Section> {
-        return this.get<Section>(`${API_BASE_V2}/get_section/${sectionId}`);
-    }
-
-    async getPriorities(): Promise<Priority[]> {
-        if (!this.prioritiesPromise) {
-            this.prioritiesPromise = this.get<Priority[]>(`${API_BASE_V2}/get_priorities`);
-        }
-        return this.prioritiesPromise;
-    }
-
-    async getCaseTypes(): Promise<CaseType[]> {
-        if (!this.caseTypesPromise) {
-            this.caseTypesPromise = this.get<CaseType[]>(`${API_BASE_V2}/get_case_types`);
-        }
-        return this.caseTypesPromise;
-    }
-
-    async getCaseFields(): Promise<CaseField[]> {
-        if (!this.caseFieldsPromise) {
-            this.caseFieldsPromise = this.get<CaseField[]>(`${API_BASE_V2}/get_case_fields`);
-        }
-        return this.caseFieldsPromise;
-    }
-
-    async getStatuses(): Promise<Status[]> {
-        if (!this.statusesPromise) {
-            this.statusesPromise = this.get<Status[]>(`${API_BASE_V2}/get_statuses`);
-        }
-        return this.statusesPromise;
-    }
-
-    async getTemplates(projectId: string): Promise<Template[]> {
-        if (!this.templatesPromiseMap.has(projectId)) {
-            this.templatesPromiseMap.set(
-                projectId,
-                this.get<Template[]>(`${API_BASE_V2}/get_templates/${projectId}`)
-            );
-        }
-        return this.templatesPromiseMap.get(projectId)!;
-    }
-
-    async updateCase(caseId: string, fields: Record<string, any>): Promise<Case> {
-        return this.post<Case>(`${API_BASE_V2}/update_case/${caseId}`, fields);
-    }
-
-    async updateCases(suiteId: number, caseIds: number[], fields: Record<string, any>): Promise<Case[]> {
-        const response = await this.post<{ updated_cases: Case[] }>(`${API_BASE_V2}/update_cases/${suiteId}`, {
-            case_ids: caseIds,
-            ...fields,
-        });
-
-        return response.updated_cases;
-    }
-
-    async createCase(sectionId: string, fields: Record<string, any>): Promise<Case> {
-        return this.post<Case>(`${API_BASE_V2}/add_case/${sectionId}`, fields);
-    }
-
-    async addRun(projectId: string, fields: Record<string, any>): Promise<Run> {
-        return this.post<Run>(`${API_BASE_V2}/add_run/${projectId}`, fields);
-    }
-
-    async getSections(projectId: string): Promise<Section[]> {
-        const response = await this.get<{ sections: Section[] }>(`${API_BASE_V2}/get_sections/${projectId}`);
-        return response.sections;
-    }
-
-    async getProjects(): Promise<Project[]> {
-        if (!this.projectsPromise) {
-            this.projectsPromise = this.get<{ projects: Project[] }>(`${API_BASE_V2}/get_projects`)
-                .then(response => response.projects);
-        }
-        return this.projectsPromise;
-    }
-
-
-    async getTests(runId: number, statusId?: number[]): Promise<Test[]> {
-        let url = `${API_BASE_V2}/get_tests/${runId}`;
-
-        if (statusId && statusId.length > 0) {
-            url += `&status_id=${statusId.join(',')}`;
-        }
-
-        const allTests: Test[] = [];
-        let nextUrl: string | null = url;
-
-        while (nextUrl) {
-            const response: PaginatedTestsResponse = await this.get<PaginatedTestsResponse>(nextUrl);
-            allTests.push(...response.tests);
-
-            nextUrl = response._links?.next;
-            if (nextUrl) {
-                nextUrl = `${API_INDEX}${nextUrl}`;
-            }
-        }
-
-        return allTests;
-    }
-
-
-    async addResults(runId: number, results: Array<Record<string, any>>): Promise<Result[]> {
-        return this.post<Result[]>(`${API_BASE_V2}/add_results/${runId}`, { results });
-    }
-
-    async addAttachmentToRun(runId: number, filePath: string, filename: string): Promise<Attachment> {
-        const fileBuffer = await fs.promises.readFile(filePath);
-        const blob = new Blob([fileBuffer]);
-        const formData = new FormData();
-        formData.append('attachment', blob, filename);
-
-        const headers: HeadersInit = {
-            'Authorization': this.auth,
-        };
-
-        return this._executeRequest<Attachment>('POST', `${API_BASE_V2}/add_attachment_to_run/${runId}`, headers, formData);
-    }
-
-    private async get<T>(endpoint: string): Promise<T> {
-        return this.executeRequest<T>('GET', endpoint);
-    }
-
-    private async post<T>(endpoint: string, data: Record<string, any>): Promise<T> {
-        return this.executeRequest<T>('POST', endpoint, data);
-    }
-
-    private async executeRequest<T>(method: 'GET' | 'POST', endpoint: string, data?: Record<string, any>): Promise<T> {
-        let jsonData = undefined;
-        if (data) {
-            jsonData = JSON.stringify(data);
-        }
-
-        return this._executeRequest<T>(method, endpoint, this.headers, jsonData);
-    }
-
-    private async _executeRequest<T>(method: 'GET' | 'POST', endpoint: string, headers: HeadersInit, body?: any): Promise<T> {
-        const url = `${this.baseUrl}${endpoint}`;
-        const params: RequestInit = {
-            method,
-            headers,
-            body,
-        };
-
-        const response = await fetch(url, params);
-
-        if (!response.ok) {
-            let errorMessage = `TestRail: ${response.status} ${response.statusText}`;
-            const errorText = await response.text();
-            errorMessage += ` - ${errorText}`;
-            throw new Error(errorMessage);
-        }
-
-        return await response.json() as T;
-    }
-}

package/src/types/custom.ts

@@ -1,19 +0,0 @@
-import { z } from "zod";
-
-export interface TestCaseResponse {
-    id: number;
-    title: string;
-    section: string;
-    type: string;
-    priority: string;
-    labels: string[];
-    references: string | null;
-    [key: string]: any;
-}
-
-export interface ToolDefinition<T extends z.ZodRawShape, Context = any> {
-    name: string;
-    description: string;
-    parameters: T;
-    handler: (args: z.infer<z.ZodObject<T>>, context: Context) => Promise<Record<string, any>>;
-}