@dichovsky/testrail-api-client 1.0.0

package/src/constants.ts

@@ -0,0 +1,15 @@
+// Retry backoff bounds
+export const BASE_RETRY_DELAY_MS = 1000;
+export const MAX_RETRY_DELAY_MS = 10000;
+
+/** Maximum allowed request timeout: 5 minutes */
+export const MAX_TIMEOUT_MS = 5 * 60 * 1000;
+
+// TestRailConfig defaults
+export const DEFAULT_TIMEOUT_MS = 30000;
+export const DEFAULT_MAX_RETRIES = 3;
+export const DEFAULT_CACHE_TTL_MS = 300000; // 5 minutes
+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

package/src/errors.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 {
+    constructor(
+        message: string,
+        public readonly status?: number,
+        public readonly statusText?: string,
+        public readonly response?: string,
+    ) {
+        super(message);
+        this.name = 'TestRailApiError';
+    }
+}
+
+/**
+ * Thrown when client configuration or method parameters fail validation.
+ */
+export class TestRailValidationError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'TestRailValidationError';
+    }
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+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';