imperial-mcp-qase 1.0.0

package/src/types/qase.ts

@@ -0,0 +1,343 @@
+// Qase API TypeScript Types
+
+// Common response wrapper
+export interface QaseResponse<T> {
+  status: boolean;
+  result: T;
+}
+
+export interface QaseListResponse<T> {
+  status: boolean;
+  result: {
+    total: number;
+    filtered: number;
+    count: number;
+    entities: T[];
+  };
+}
+
+export interface QaseErrorResponse {
+  status: boolean;
+  errorMessage?: string;
+  errorFields?: Record<string, string[]>;
+}
+
+// Project Types
+export interface Project {
+  title: string;
+  code: string;
+  counts: ProjectCounts;
+}
+
+export interface ProjectCounts {
+  cases: number;
+  suites: number;
+  milestones: number;
+  runs: {
+    total: number;
+    active: number;
+  };
+  defects: {
+    total: number;
+    open: number;
+  };
+}
+
+export interface ListProjectsFilters {
+  limit?: number;
+  offset?: number;
+}
+
+// Test Case Types
+export interface TestCase {
+  id: number;
+  position: number;
+  title: string;
+  description: string | null;
+  preconditions: string | null;
+  postconditions: string | null;
+  severity: number;
+  priority: number;
+  type: number;
+  layer: number;
+  is_flaky: number;
+  behavior: number;
+  automation: number;
+  status: number;
+  milestone_id: number | null;
+  suite_id: number | null;
+  links: TestCaseLink[];
+  custom_fields: CustomField[];
+  attachments: Attachment[];
+  steps_type: string | null;
+  steps: TestStep[];
+  params: Record<string, string[]>;
+  tags: Tag[];
+  member_id: number;
+  author_id: number;
+  created_at: string;
+  updated_at: string | null;
+}
+
+export interface TestCaseLink {
+  title: string | null;
+  url: string;
+}
+
+export interface CustomField {
+  id: number;
+  value: string | number | string[] | null;
+}
+
+export interface Attachment {
+  hash: string;
+  file: string;
+  mime: string;
+  size: number;
+  extension: string;
+  full_path: string;
+}
+
+export interface TestStep {
+  position: number;
+  action: string;
+  expected_result: string | null;
+  data: string | null;
+  attachments: Attachment[];
+}
+
+export interface Tag {
+  id: number;
+  title: string;
+}
+
+export interface CreateTestCaseInput {
+  title: string;
+  description?: string;
+  preconditions?: string;
+  postconditions?: string;
+  severity?: number;
+  priority?: number;
+  type?: number;
+  layer?: number;
+  is_flaky?: number;
+  behavior?: number;
+  automation?: number;
+  status?: number;
+  milestone_id?: number;
+  suite_id?: number;
+  steps?: CreateTestStepInput[];
+  tags?: string[];
+}
+
+export interface CreateTestStepInput {
+  action: string;
+  expected_result?: string;
+  data?: string;
+  position?: number;
+}
+
+export interface UpdateTestCaseInput extends Partial<CreateTestCaseInput> {}
+
+// Defect Types
+export interface Defect {
+  id: number;
+  title: string;
+  actual_result: string;
+  severity: number;
+  status: string;
+  milestone_id: number | null;
+  custom_fields: CustomField[];
+  attachments: Attachment[];
+  resolved_at: string | null;
+  member_id: number;
+  external_data: string | null;
+  tags: Tag[];
+  created_at: string;
+  updated_at: string | null;
+}
+
+export interface CreateDefectInput {
+  title: string;
+  actual_result: string;
+  severity?: number;
+  milestone_id?: number;
+  attachments?: string[];
+  tags?: string[];
+}
+
+export interface UpdateDefectInput extends Partial<CreateDefectInput> {
+  status?: string;
+}
+
+// Test Run Types
+export interface TestRun {
+  id: number;
+  title: string;
+  description: string | null;
+  status: number;
+  status_text: string;
+  start_time: string | null;
+  end_time: string | null;
+  public: boolean;
+  stats: TestRunStats;
+  time_spent: number;
+  environment_id: number | null;
+  milestone_id: number | null;
+  plan_id: number | null;
+  tags: Tag[];
+  cases: number[];
+  custom_fields: CustomField[];
+}
+
+export interface TestRunStats {
+  total: number;
+  untested: number;
+  passed: number;
+  failed: number;
+  blocked: number;
+  skipped: number;
+  retest: number;
+  in_progress: number;
+  invalid: number;
+}
+
+export interface CreateTestRunInput {
+  title: string;
+  description?: string;
+  environment_id?: number;
+  milestone_id?: number;
+  plan_id?: number;
+  cases?: number[];
+  is_autotest?: boolean;
+  tags?: string[];
+}
+
+// Test Result Types
+export interface TestResult {
+  hash: string;
+  comment: string | null;
+  stacktrace: string | null;
+  run_id: number;
+  case_id: number;
+  steps: TestResultStep[];
+  status: string;
+  is_api_result: boolean;
+  time_spent_ms: number;
+  end_time: string;
+  attachments: Attachment[];
+}
+
+export interface TestResultStep {
+  position: number;
+  status: string;
+  comment: string | null;
+  attachments: Attachment[];
+}
+
+export interface CreateTestResultInput {
+  case_id: number;
+  status: "passed" | "failed" | "blocked" | "skipped" | "invalid";
+  time_ms?: number;
+  member_id?: number;
+  comment?: string;
+  stacktrace?: string;
+  defect?: boolean;
+  steps?: CreateTestResultStepInput[];
+  attachments?: string[];
+}
+
+export interface CreateTestResultStepInput {
+  position: number;
+  status: "passed" | "failed" | "blocked" | "skipped";
+  comment?: string;
+  attachments?: string[];
+}
+
+// API Filter Types
+export interface ListCasesFilters {
+  limit?: number;
+  offset?: number;
+  search?: string;
+  milestone_id?: number;
+  suite_id?: number;
+  severity?: number[];
+  priority?: number[];
+  type?: number[];
+  behavior?: number[];
+  automation?: number[];
+  status?: number[];
+}
+
+export interface ListDefectsFilters {
+  limit?: number;
+  offset?: number;
+  status?: string;
+  severity?: number[];
+}
+
+export interface ListRunsFilters {
+  limit?: number;
+  offset?: number;
+  status?: string;
+  include?: string;
+}
+
+// Enums for reference
+export const CaseSeverity = {
+  NOT_SET: 0,
+  BLOCKER: 1,
+  CRITICAL: 2,
+  MAJOR: 3,
+  NORMAL: 4,
+  MINOR: 5,
+  TRIVIAL: 6,
+} as const;
+
+export const CasePriority = {
+  NOT_SET: 0,
+  HIGH: 1,
+  MEDIUM: 2,
+  LOW: 3,
+} as const;
+
+export const CaseType = {
+  OTHER: 0,
+  FUNCTIONAL: 1,
+  SMOKE: 2,
+  REGRESSION: 3,
+  SECURITY: 4,
+  USABILITY: 5,
+  PERFORMANCE: 6,
+  ACCEPTANCE: 7,
+  COMPATIBILITY: 8,
+  INTEGRATION: 9,
+  EXPLORATORY: 10,
+} as const;
+
+export const CaseAutomation = {
+  NOT_AUTOMATED: 0,
+  TO_BE_AUTOMATED: 1,
+  AUTOMATED: 2,
+} as const;
+
+export const DefectStatus = {
+  OPEN: "open",
+  RESOLVED: "resolved",
+  IN_PROGRESS: "in_progress",
+  INVALID: "invalid",
+} as const;
+
+export const RunStatus = {
+  ACTIVE: 0,
+  COMPLETE: 1,
+  ABORT: 2,
+} as const;
+
+export const ResultStatus = {
+  PASSED: "passed",
+  FAILED: "failed",
+  BLOCKED: "blocked",
+  SKIPPED: "skipped",
+  INVALID: "invalid",
+} as const;

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}