@dichovsky/testrail-api-client 1.0.0 → 2.1.0

package/dist/constants.d.ts

@@ -9,4 +9,5 @@ export declare const DEFAULT_CACHE_CLEANUP_INTERVAL_MS = 60000;
 export declare const DEFAULT_MAX_CACHE_SIZE = 1000;
 export declare const DEFAULT_RATE_LIMIT_MAX_REQUESTS = 100;
 export declare const DEFAULT_RATE_LIMIT_WINDOW_MS = 60000;
+export declare const DEFAULT_DNS_VALIDATION_MAX_WAIT_MS = 2000;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -11,4 +11,5 @@ export const DEFAULT_CACHE_CLEANUP_INTERVAL_MS = 60000; // 1 minute
 export const DEFAULT_MAX_CACHE_SIZE = 1000;
 export const DEFAULT_RATE_LIMIT_MAX_REQUESTS = 100;
 export const DEFAULT_RATE_LIMIT_WINDOW_MS = 60000; // 1 minute
+export const DEFAULT_DNS_VALIDATION_MAX_WAIT_MS = 2000;
 //# sourceMappingURL=constants.js.map

package/dist/errors.d.ts

@@ -1,20 +1,22 @@
+import { ZodError } from 'zod';
 /**
  * Thrown when the TestRail API returns a non-2xx response or a network error occurs.
- *
- * @property status - HTTP status code (if available)
- * @property statusText - HTTP status text (if available)
- * @property response - Raw response body (if available)
  */
 export declare class TestRailApiError extends Error {
-    readonly status?: number | undefined;
-    readonly statusText?: string | undefined;
-    readonly response?: string | undefined;
-    constructor(message: string, status?: number | undefined, statusText?: string | undefined, response?: string | undefined);
+    readonly status: number;
+    readonly statusText: string;
+    readonly response?: unknown | undefined;
+    constructor(status: number, statusText: string, response?: unknown | undefined);
 }
 /**
  * Thrown when client configuration or method parameters fail validation.
  */
 export declare class TestRailValidationError extends Error {
-    constructor(message: string);
+    readonly details?: unknown | undefined;
+    constructor(message: string, details?: unknown | undefined);
 }
+/**
+ * Utility to convert ZodError into TestRailValidationError.
+ */
+export declare function handleZodError(error: ZodError): TestRailValidationError;
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.js

@@ -1,16 +1,12 @@
 /**
  * Thrown when the TestRail API returns a non-2xx response or a network error occurs.
- *
- * @property status - HTTP status code (if available)
- * @property statusText - HTTP status text (if available)
- * @property response - Raw response body (if available)
  */
 export class TestRailApiError extends Error {
     status;
     statusText;
     response;
-    constructor(message, status, statusText, response) {
-        super(message);
+    constructor(status, statusText, response) {
+        super(`TestRail API error: ${status} ${statusText}`);
         this.status = status;
         this.statusText = statusText;
         this.response = response;
@@ -21,9 +17,17 @@ export class TestRailApiError extends Error {
  * Thrown when client configuration or method parameters fail validation.
  */
 export class TestRailValidationError extends Error {
-    constructor(message) {
-        super(message);
+    details;
+    constructor(message, details) {
+        super(`TestRail Validation Error: ${message}`);
+        this.details = details;
         this.name = 'TestRailValidationError';
     }
 }
+/**
+ * Utility to convert ZodError into TestRailValidationError.
+ */
+export function handleZodError(error) {
+    return new TestRailValidationError('Schema validation failed', error.format());
+}
 //# sourceMappingURL=errors.js.map

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { TestRailClient } from './client.js';
-export { TestRailApiError, TestRailValidationError } from './errors.js';
-export type { TestRailConfig, RateLimiterConfig, Case, Suite, AddSuitePayload, UpdateSuitePayload, Section, Project, Plan, PlanEntry, Run, Test, Result, Milestone, User, Status, Priority, AddCasePayload, UpdateCasePayload, AddPlanPayload, UpdatePlanPayload, AddPlanEntryPayload, UpdatePlanEntryPayload, AddRunPayload, UpdateRunPayload, AddResultPayload, AddResultsForCasesPayload, AddResultForCasePayload, AddSectionPayload, UpdateSectionPayload, AddMilestonePayload, UpdateMilestonePayload, AddProjectPayload, UpdateProjectPayload, GetCasesOptions, GetPlansOptions, GetTestsOptions, GetResultsOptions, GetMilestonesOptions, GetRunsOptions, ResultField, ResultFieldConfig, CaseField, CaseFieldConfig, CaseType, Template, ConfigurationGroup, Configuration, AddConfigurationGroupPayload, UpdateConfigurationGroupPayload, AddConfigurationPayload, UpdateConfigurationPayload, AddUserPayload, UpdateUserPayload, Role, Group, AddGroupPayload, UpdateGroupPayload, Attachment, SharedStep, AddSharedStepPayload, UpdateSharedStepPayload, Variable, AddVariablePayload, UpdateVariablePayload, Dataset, AddDatasetPayload, UpdateDatasetPayload, Report, ReportResult, } from './types.js';
+export { TestRailApiError, TestRailValidationError, handleZodError } from './errors.js';
+export { TestRailConfigSchema, PaginationSchema, UserSchema, RoleSchema, GroupSchema, ProjectSchema, SuiteSchema, CaseSchema, SectionSchema, RunSchema, PlanEntrySchema, PlanSchema, TestSchema, ResultSchema, MilestoneSchema, StatusSchema, PrioritySchema, CaseFieldConfigSchema, CaseFieldSchema, ResultFieldConfigSchema, ResultFieldSchema, CaseTypeSchema, TemplateSchema, ConfigurationSchema, ConfigurationGroupSchema, AttachmentSchema, SharedStepSchema, VariableSchema, DatasetSchema, ReportSchema, ReportResultSchema, AddCasePayloadSchema, UpdateCasePayloadSchema, AddRunPayloadSchema, UpdateRunPayloadSchema, AddResultPayloadSchema, AddResultForCasePayloadSchema, AddResultsForCasesPayloadSchema, } from './schemas.js';
+export type { AddCasePayload, UpdateCasePayload, AddRunPayload, UpdateRunPayload, AddResultPayload, AddResultForCasePayload, AddResultsForCasesPayload, } from './schemas.js';
+export type { TestRailConfig, RateLimiterConfig, Case, Suite, AddSuitePayload, UpdateSuitePayload, Section, Project, Plan, PlanEntry, Run, Test, Result, Milestone, User, Status, Priority, AddPlanPayload, UpdatePlanPayload, AddPlanEntryPayload, UpdatePlanEntryPayload, AddSectionPayload, UpdateSectionPayload, AddMilestonePayload, UpdateMilestonePayload, AddProjectPayload, UpdateProjectPayload, GetCasesOptions, GetPlansOptions, GetTestsOptions, GetResultsOptions, GetMilestonesOptions, GetRunsOptions, ResultField, ResultFieldConfig, CaseField, CaseFieldConfig, CaseType, Template, ConfigurationGroup, Configuration, AddConfigurationGroupPayload, UpdateConfigurationGroupPayload, AddConfigurationPayload, UpdateConfigurationPayload, AddUserPayload, UpdateUserPayload, Role, Group, AddGroupPayload, UpdateGroupPayload, Attachment, SharedStep, AddSharedStepPayload, UpdateSharedStepPayload, Variable, AddVariablePayload, UpdateVariablePayload, Dataset, AddDatasetPayload, UpdateDatasetPayload, Report, ReportResult, } from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
 export { TestRailClient } from './client.js';
-export { TestRailApiError, TestRailValidationError } from './errors.js';
+export { TestRailApiError, TestRailValidationError, handleZodError } from './errors.js';
+export { TestRailConfigSchema, PaginationSchema, UserSchema, RoleSchema, GroupSchema, ProjectSchema, SuiteSchema, CaseSchema, SectionSchema, RunSchema, PlanEntrySchema, PlanSchema, TestSchema, ResultSchema, MilestoneSchema, StatusSchema, PrioritySchema, CaseFieldConfigSchema, CaseFieldSchema, ResultFieldConfigSchema, ResultFieldSchema, CaseTypeSchema, TemplateSchema, ConfigurationSchema, ConfigurationGroupSchema, AttachmentSchema, SharedStepSchema, VariableSchema, DatasetSchema, ReportSchema, ReportResultSchema, AddCasePayloadSchema, UpdateCasePayloadSchema, AddRunPayloadSchema, UpdateRunPayloadSchema, AddResultPayloadSchema, AddResultForCasePayloadSchema, AddResultsForCasesPayloadSchema, } from './schemas.js';
 //# sourceMappingURL=index.js.map

package/dist/modules/attachments.d.ts

@@ -0,0 +1,19 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Attachment } from '../types.js';
+export declare class AttachmentModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getAttachmentsForCase(caseId: number): Promise<Attachment[]>;
+    getAttachmentsForRun(runId: number): Promise<Attachment[]>;
+    getAttachmentsForTest(testId: number): Promise<Attachment[]>;
+    getAttachmentsForPlan(planId: number): Promise<Attachment[]>;
+    getAttachmentsForPlanEntry(planId: number, entryId: number): Promise<Attachment[]>;
+    getAttachment(attachmentId: number): Promise<ArrayBuffer>;
+    addAttachmentToCase(caseId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    addAttachmentToResult(resultId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    addAttachmentToRun(runId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    addAttachmentToPlan(planId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    addAttachmentToPlanEntry(planId: number, entryId: number, file: globalThis.Blob | Uint8Array | globalThis.File, filename: string): Promise<Attachment>;
+    deleteAttachment(attachmentId: number): Promise<void>;
+}
+//# sourceMappingURL=attachments.d.ts.map

package/dist/modules/attachments.js

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+import { AttachmentSchema } from '../schemas.js';
+export class AttachmentModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getAttachmentsForCase(caseId) {
+        this.client.validateId(caseId, 'caseId');
+        const raw = await this.client.request('GET', `get_attachments_for_case/${caseId}`);
+        return (this.client.parse(z.object({ attachments: z.array(AttachmentSchema).optional() }), raw).attachments ?? []);
+    }
+    async getAttachmentsForRun(runId) {
+        this.client.validateId(runId, 'runId');
+        const raw = await this.client.request('GET', `get_attachments_for_run/${runId}`);
+        return (this.client.parse(z.object({ attachments: z.array(AttachmentSchema).optional() }), raw).attachments ?? []);
+    }
+    async getAttachmentsForTest(testId) {
+        this.client.validateId(testId, 'testId');
+        const raw = await this.client.request('GET', `get_attachments_for_test/${testId}`);
+        return (this.client.parse(z.object({ attachments: z.array(AttachmentSchema).optional() }), raw).attachments ?? []);
+    }
+    async getAttachmentsForPlan(planId) {
+        this.client.validateId(planId, 'planId');
+        const raw = await this.client.request('GET', `get_attachments_for_plan/${planId}`);
+        return (this.client.parse(z.object({ attachments: z.array(AttachmentSchema).optional() }), raw).attachments ?? []);
+    }
+    async getAttachmentsForPlanEntry(planId, entryId) {
+        this.client.validateId(planId, 'planId');
+        this.client.validateId(entryId, 'entryId');
+        const raw = await this.client.request('GET', `get_attachments_for_plan_entry/${planId}/${entryId}`);
+        return (this.client.parse(z.object({ attachments: z.array(AttachmentSchema).optional() }), raw).attachments ?? []);
+    }
+    async getAttachment(attachmentId) {
+        this.client.validateId(attachmentId, 'attachmentId');
+        return this.client.requestBinary(`get_attachment/${attachmentId}`);
+    }
+    async addAttachmentToCase(caseId, file, filename) {
+        this.client.validateId(caseId, 'caseId');
+        return this.client.requestMultipart(`add_attachment_to_case/${caseId}`, file, filename);
+    }
+    async addAttachmentToResult(resultId, file, filename) {
+        this.client.validateId(resultId, 'resultId');
+        return this.client.requestMultipart(`add_attachment_to_result/${resultId}`, file, filename);
+    }
+    async addAttachmentToRun(runId, file, filename) {
+        this.client.validateId(runId, 'runId');
+        return this.client.requestMultipart(`add_attachment_to_run/${runId}`, file, filename);
+    }
+    async addAttachmentToPlan(planId, file, filename) {
+        this.client.validateId(planId, 'planId');
+        return this.client.requestMultipart(`add_attachment_to_plan/${planId}`, file, filename);
+    }
+    async addAttachmentToPlanEntry(planId, entryId, file, filename) {
+        this.client.validateId(planId, 'planId');
+        this.client.validateId(entryId, 'entryId');
+        return this.client.requestMultipart(`add_attachment_to_plan_entry/${planId}/${entryId}`, file, filename);
+    }
+    async deleteAttachment(attachmentId) {
+        this.client.validateId(attachmentId, 'attachmentId');
+        await this.client.request('POST', `delete_attachment/${attachmentId}`);
+    }
+}
+//# sourceMappingURL=attachments.js.map

package/dist/modules/cases.d.ts

@@ -0,0 +1,13 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Case, GetCasesOptions } from '../types.js';
+import type { AddCasePayload, UpdateCasePayload } from '../schemas.js';
+export declare class CaseModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getCase(caseId: number): Promise<Case>;
+    getCases(projectId: number, options?: GetCasesOptions): Promise<Case[]>;
+    addCase(sectionId: number, payload: AddCasePayload): Promise<Case>;
+    updateCase(caseId: number, payload: UpdateCasePayload): Promise<Case>;
+    deleteCase(caseId: number): Promise<void>;
+}
+//# sourceMappingURL=cases.d.ts.map

package/dist/modules/cases.js

@@ -0,0 +1,58 @@
+import { CaseSchema } from '../schemas.js';
+import { z } from 'zod';
+export class CaseModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getCase(caseId) {
+        this.client.validateId(caseId, 'caseId');
+        return this.client.parse(CaseSchema, await this.client.request('GET', `get_case/${caseId}`));
+    }
+    async getCases(projectId, options) {
+        this.client.validateId(projectId, 'projectId');
+        const { suiteId, sectionId, typeId, priorityId, templateId, milestoneId, createdAfter, createdBefore, updatedAfter, updatedBefore, limit, offset, } = options ?? {};
+        if (suiteId !== undefined)
+            this.client.validateId(suiteId, 'suiteId');
+        if (sectionId !== undefined)
+            this.client.validateId(sectionId, 'sectionId');
+        if (typeId !== undefined)
+            this.client.validateId(typeId, 'typeId');
+        if (priorityId !== undefined)
+            this.client.validateId(priorityId, 'priorityId');
+        if (templateId !== undefined)
+            this.client.validateId(templateId, 'templateId');
+        if (milestoneId !== undefined)
+            this.client.validateId(milestoneId, 'milestoneId');
+        this.client.validatePaginationParams(limit, offset);
+        const endpoint = this.client.buildEndpoint(`get_cases/${projectId}`, {
+            suite_id: suiteId,
+            section_id: sectionId,
+            type_id: typeId,
+            priority_id: priorityId,
+            template_id: templateId,
+            milestone_id: milestoneId,
+            created_after: createdAfter,
+            created_before: createdBefore,
+            updated_after: updatedAfter,
+            updated_before: updatedBefore,
+            limit,
+            offset,
+        });
+        const raw = await this.client.request('GET', endpoint);
+        return (this.client.parse(z.object({ cases: z.array(CaseSchema).optional() }), raw).cases ?? []);
+    }
+    async addCase(sectionId, payload) {
+        this.client.validateId(sectionId, 'sectionId');
+        return this.client.parse(CaseSchema, await this.client.request('POST', `add_case/${sectionId}`, payload));
+    }
+    async updateCase(caseId, payload) {
+        this.client.validateId(caseId, 'caseId');
+        return this.client.parse(CaseSchema, await this.client.request('POST', `update_case/${caseId}`, payload));
+    }
+    async deleteCase(caseId) {
+        this.client.validateId(caseId, 'caseId');
+        await this.client.request('POST', `delete_case/${caseId}`);
+    }
+}
+//# sourceMappingURL=cases.js.map

package/dist/modules/configurations.d.ts

@@ -0,0 +1,14 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { ConfigurationGroup, Configuration, AddConfigurationGroupPayload, UpdateConfigurationGroupPayload, AddConfigurationPayload, UpdateConfigurationPayload } from '../types.js';
+export declare class ConfigurationModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getConfigurations(projectId: number): Promise<ConfigurationGroup[]>;
+    addConfigurationGroup(projectId: number, payload: AddConfigurationGroupPayload): Promise<ConfigurationGroup>;
+    updateConfigurationGroup(configGroupId: number, payload: UpdateConfigurationGroupPayload): Promise<ConfigurationGroup>;
+    deleteConfigurationGroup(configGroupId: number): Promise<void>;
+    addConfiguration(configGroupId: number, payload: AddConfigurationPayload): Promise<Configuration>;
+    updateConfiguration(configId: number, payload: UpdateConfigurationPayload): Promise<Configuration>;
+    deleteConfiguration(configId: number): Promise<void>;
+}
+//# sourceMappingURL=configurations.d.ts.map

package/dist/modules/configurations.js

@@ -0,0 +1,37 @@
+import { ConfigurationGroupSchema, ConfigurationSchema } from '../schemas.js';
+import { z } from 'zod';
+export class ConfigurationModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getConfigurations(projectId) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(z.array(ConfigurationGroupSchema), await this.client.request('GET', `get_configs/${projectId}`));
+    }
+    async addConfigurationGroup(projectId, payload) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(ConfigurationGroupSchema, await this.client.request('POST', `add_config_group/${projectId}`, payload));
+    }
+    async updateConfigurationGroup(configGroupId, payload) {
+        this.client.validateId(configGroupId, 'configGroupId');
+        return this.client.parse(ConfigurationGroupSchema, await this.client.request('POST', `update_config_group/${configGroupId}`, payload));
+    }
+    async deleteConfigurationGroup(configGroupId) {
+        this.client.validateId(configGroupId, 'configGroupId');
+        await this.client.request('POST', `delete_config_group/${configGroupId}`);
+    }
+    async addConfiguration(configGroupId, payload) {
+        this.client.validateId(configGroupId, 'configGroupId');
+        return this.client.parse(ConfigurationSchema, await this.client.request('POST', `add_config/${configGroupId}`, payload));
+    }
+    async updateConfiguration(configId, payload) {
+        this.client.validateId(configId, 'configId');
+        return this.client.parse(ConfigurationSchema, await this.client.request('POST', `update_config/${configId}`, payload));
+    }
+    async deleteConfiguration(configId) {
+        this.client.validateId(configId, 'configId');
+        await this.client.request('POST', `delete_config/${configId}`);
+    }
+}
+//# sourceMappingURL=configurations.js.map

package/dist/modules/datasets.d.ts

@@ -0,0 +1,12 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Dataset, AddDatasetPayload, UpdateDatasetPayload } from '../types.js';
+export declare class DatasetModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getDataset(datasetId: number): Promise<Dataset>;
+    getDatasets(projectId: number): Promise<Dataset[]>;
+    addDataset(projectId: number, payload: AddDatasetPayload): Promise<Dataset>;
+    updateDataset(datasetId: number, payload: UpdateDatasetPayload): Promise<Dataset>;
+    deleteDataset(datasetId: number): Promise<void>;
+}
+//# sourceMappingURL=datasets.d.ts.map

package/dist/modules/datasets.js

@@ -0,0 +1,28 @@
+import { DatasetSchema } from '../schemas.js';
+export class DatasetModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getDataset(datasetId) {
+        this.client.validateId(datasetId, 'datasetId');
+        return this.client.parse(DatasetSchema, await this.client.request('GET', `get_dataset/${datasetId}`));
+    }
+    async getDatasets(projectId) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(DatasetSchema.array(), await this.client.request('GET', `get_datasets/${projectId}`));
+    }
+    async addDataset(projectId, payload) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(DatasetSchema, await this.client.request('POST', `add_dataset/${projectId}`, payload));
+    }
+    async updateDataset(datasetId, payload) {
+        this.client.validateId(datasetId, 'datasetId');
+        return this.client.parse(DatasetSchema, await this.client.request('POST', `update_dataset/${datasetId}`, payload));
+    }
+    async deleteDataset(datasetId) {
+        this.client.validateId(datasetId, 'datasetId');
+        await this.client.request('POST', `delete_dataset/${datasetId}`);
+    }
+}
+//# sourceMappingURL=datasets.js.map

package/dist/modules/metadata.d.ts

@@ -0,0 +1,14 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Status, Priority, ResultField, CaseField, CaseType, Template, Role } from '../types.js';
+export declare class MetadataModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getStatuses(): Promise<Status[]>;
+    getPriorities(): Promise<Priority[]>;
+    getResultFields(): Promise<ResultField[]>;
+    getCaseFields(): Promise<CaseField[]>;
+    getCaseTypes(): Promise<CaseType[]>;
+    getTemplates(projectId: number): Promise<Template[]>;
+    getRoles(): Promise<Role[]>;
+}
+//# sourceMappingURL=metadata.d.ts.map

package/dist/modules/metadata.js

@@ -0,0 +1,31 @@
+import { StatusSchema, PrioritySchema, ResultFieldSchema, CaseFieldSchema, CaseTypeSchema, TemplateSchema, RoleSchema, } from '../schemas.js';
+import { z } from 'zod';
+export class MetadataModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getStatuses() {
+        return this.client.parse(z.array(StatusSchema), await this.client.request('GET', 'get_statuses'));
+    }
+    async getPriorities() {
+        return this.client.parse(z.array(PrioritySchema), await this.client.request('GET', 'get_priorities'));
+    }
+    async getResultFields() {
+        return this.client.parse(z.array(ResultFieldSchema), await this.client.request('GET', 'get_result_fields'));
+    }
+    async getCaseFields() {
+        return this.client.parse(z.array(CaseFieldSchema), await this.client.request('GET', 'get_case_fields'));
+    }
+    async getCaseTypes() {
+        return this.client.parse(z.array(CaseTypeSchema), await this.client.request('GET', 'get_case_types'));
+    }
+    async getTemplates(projectId) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(z.array(TemplateSchema), await this.client.request('GET', `get_templates/${projectId}`));
+    }
+    async getRoles() {
+        return this.client.parse(z.array(RoleSchema), await this.client.request('GET', 'get_roles'));
+    }
+}
+//# sourceMappingURL=metadata.js.map

package/dist/modules/milestones.d.ts

@@ -0,0 +1,12 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Milestone, GetMilestonesOptions, AddMilestonePayload, UpdateMilestonePayload } from '../types.js';
+export declare class MilestoneModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getMilestone(milestoneId: number): Promise<Milestone>;
+    getMilestones(projectId: number, options?: GetMilestonesOptions): Promise<Milestone[]>;
+    addMilestone(projectId: number, payload: AddMilestonePayload): Promise<Milestone>;
+    updateMilestone(milestoneId: number, payload: UpdateMilestonePayload): Promise<Milestone>;
+    deleteMilestone(milestoneId: number): Promise<void>;
+}
+//# sourceMappingURL=milestones.d.ts.map

package/dist/modules/milestones.js

@@ -0,0 +1,36 @@
+import { MilestoneSchema } from '../schemas.js';
+import { z } from 'zod';
+export class MilestoneModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getMilestone(milestoneId) {
+        this.client.validateId(milestoneId, 'milestoneId');
+        return this.client.parse(MilestoneSchema, await this.client.request('GET', `get_milestone/${milestoneId}`));
+    }
+    async getMilestones(projectId, options) {
+        this.client.validateId(projectId, 'projectId');
+        this.client.validatePaginationParams(options?.limit, options?.offset);
+        const endpoint = this.client.buildEndpoint(`get_milestones/${projectId}`, {
+            is_completed: options?.is_completed,
+            limit: options?.limit,
+            offset: options?.offset,
+        });
+        const raw = await this.client.request('GET', endpoint);
+        return (this.client.parse(z.object({ milestones: z.array(MilestoneSchema).optional() }), raw).milestones ?? []);
+    }
+    async addMilestone(projectId, payload) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(MilestoneSchema, await this.client.request('POST', `add_milestone/${projectId}`, payload));
+    }
+    async updateMilestone(milestoneId, payload) {
+        this.client.validateId(milestoneId, 'milestoneId');
+        return this.client.parse(MilestoneSchema, await this.client.request('POST', `update_milestone/${milestoneId}`, payload));
+    }
+    async deleteMilestone(milestoneId) {
+        this.client.validateId(milestoneId, 'milestoneId');
+        await this.client.request('POST', `delete_milestone/${milestoneId}`);
+    }
+}
+//# sourceMappingURL=milestones.js.map

package/dist/modules/plans.d.ts

@@ -0,0 +1,16 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Plan, PlanEntry, GetPlansOptions, AddPlanPayload, UpdatePlanPayload, AddPlanEntryPayload, UpdatePlanEntryPayload } from '../types.js';
+export declare class PlanModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getPlan(planId: number): Promise<Plan>;
+    getPlans(projectId: number, options?: GetPlansOptions): Promise<Plan[]>;
+    addPlan(projectId: number, payload: AddPlanPayload): Promise<Plan>;
+    updatePlan(planId: number, payload: UpdatePlanPayload): Promise<Plan>;
+    closePlan(planId: number): Promise<Plan>;
+    deletePlan(planId: number): Promise<void>;
+    addPlanEntry(planId: number, payload: AddPlanEntryPayload): Promise<PlanEntry>;
+    updatePlanEntry(planId: number, entryId: string, payload: UpdatePlanEntryPayload): Promise<PlanEntry>;
+    deletePlanEntry(planId: number, entryId: string): Promise<void>;
+}
+//# sourceMappingURL=plans.d.ts.map

package/dist/modules/plans.js

@@ -0,0 +1,59 @@
+import { PlanSchema, PlanEntrySchema } from '../schemas.js';
+import { serializeIdList } from '../utils.js';
+import { z } from 'zod';
+export class PlanModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async getPlan(planId) {
+        this.client.validateId(planId, 'planId');
+        return this.client.parse(PlanSchema, await this.client.request('GET', `get_plan/${planId}`));
+    }
+    async getPlans(projectId, options) {
+        this.client.validateId(projectId, 'projectId');
+        this.client.validatePaginationParams(options?.limit, options?.offset);
+        const endpoint = this.client.buildEndpoint(`get_plans/${projectId}`, {
+            created_after: options?.created_after,
+            created_before: options?.created_before,
+            created_by: serializeIdList(options?.created_by),
+            is_completed: options?.is_completed,
+            milestone_id: serializeIdList(options?.milestone_id),
+            limit: options?.limit,
+            offset: options?.offset,
+        });
+        const raw = await this.client.request('GET', endpoint);
+        return (this.client.parse(z.object({ plans: z.array(PlanSchema).optional() }), raw).plans ?? []);
+    }
+    async addPlan(projectId, payload) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(PlanSchema, await this.client.request('POST', `add_plan/${projectId}`, payload));
+    }
+    async updatePlan(planId, payload) {
+        this.client.validateId(planId, 'planId');
+        return this.client.parse(PlanSchema, await this.client.request('POST', `update_plan/${planId}`, payload));
+    }
+    async closePlan(planId) {
+        this.client.validateId(planId, 'planId');
+        return this.client.parse(PlanSchema, await this.client.request('POST', `close_plan/${planId}`));
+    }
+    async deletePlan(planId) {
+        this.client.validateId(planId, 'planId');
+        await this.client.request('POST', `delete_plan/${planId}`);
+    }
+    async addPlanEntry(planId, payload) {
+        this.client.validateId(planId, 'planId');
+        return this.client.parse(PlanEntrySchema, await this.client.request('POST', `add_plan_entry/${planId}`, payload));
+    }
+    async updatePlanEntry(planId, entryId, payload) {
+        this.client.validateId(planId, 'planId');
+        this.client.validateEntryId(entryId);
+        return this.client.parse(PlanEntrySchema, await this.client.request('POST', `update_plan_entry/${planId}/${entryId}`, payload));
+    }
+    async deletePlanEntry(planId, entryId) {
+        this.client.validateId(planId, 'planId');
+        this.client.validateEntryId(entryId);
+        await this.client.request('POST', `delete_plan_entry/${planId}/${entryId}`);
+    }
+}
+//# sourceMappingURL=plans.js.map

package/dist/modules/projects.d.ts

@@ -0,0 +1,36 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Project, AddProjectPayload, UpdateProjectPayload } from '../types.js';
+export declare class ProjectModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    /**
+     * Get a project by ID.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getProject(projectId: number): Promise<Project>;
+    /**
+     * Get all projects.
+     * @throws {TestRailValidationError} When limit or offset is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    getProjects(limit?: number, offset?: number): Promise<Project[]>;
+    /**
+     * Add a new project.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    addProject(payload: AddProjectPayload): Promise<Project>;
+    /**
+     * Update an existing project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    updateProject(projectId: number, payload: UpdateProjectPayload): Promise<Project>;
+    /**
+     * Delete a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    deleteProject(projectId: number): Promise<void>;
+}
+//# sourceMappingURL=projects.d.ts.map

package/dist/modules/projects.js

@@ -0,0 +1,55 @@
+import { ProjectSchema } from '../schemas.js';
+import { z } from 'zod';
+export class ProjectModule {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get a project by ID.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    async getProject(projectId) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(ProjectSchema, await this.client.request('GET', `get_project/${projectId}`));
+    }
+    /**
+     * Get all projects.
+     * @throws {TestRailValidationError} When limit or offset is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    async getProjects(limit, offset) {
+        this.client.validatePaginationParams(limit, offset);
+        const endpoint = this.client.buildEndpoint('get_projects', { limit, offset });
+        const raw = await this.client.request('GET', endpoint);
+        return (this.client.parse(z.object({ projects: z.array(ProjectSchema).optional() }), raw)
+            .projects ?? []);
+    }
+    /**
+     * Add a new project.
+     * @throws {TestRailApiError} When the API request fails
+     */
+    async addProject(payload) {
+        return this.client.parse(ProjectSchema, await this.client.request('POST', 'add_project', payload));
+    }
+    /**
+     * Update an existing project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    async updateProject(projectId, payload) {
+        this.client.validateId(projectId, 'projectId');
+        return this.client.parse(ProjectSchema, await this.client.request('POST', `update_project/${projectId}`, payload));
+    }
+    /**
+     * Delete a project.
+     * @throws {TestRailValidationError} When projectId is invalid
+     * @throws {TestRailApiError} When the API request fails
+     */
+    async deleteProject(projectId) {
+        this.client.validateId(projectId, 'projectId');
+        await this.client.request('POST', `delete_project/${projectId}`);
+    }
+}
+//# sourceMappingURL=projects.js.map

package/dist/modules/reports.d.ts

@@ -0,0 +1,9 @@
+import { TestRailClientCore } from '../client-core.js';
+import type { Report, ReportResult } from '../types.js';
+export declare class ReportModule {
+    private readonly client;
+    constructor(client: TestRailClientCore);
+    getReports(projectId: number): Promise<Report[]>;
+    runReport(reportTemplateId: number): Promise<ReportResult>;
+}
+//# sourceMappingURL=reports.d.ts.map