@rbaileysr/zephyr-managed-api 1.0.0

package/dist/index.js

@@ -0,0 +1,124 @@
+/**
+ * Zephyr Managed API
+ *
+ * A comprehensive Managed API wrapper for Zephyr Cloud REST API v2
+ * Provides type-safe, hierarchical access to all Zephyr API endpoints
+ *
+ * Usage:
+ * ```typescript
+ * import { createZephyrApi } from './zephyr';
+ * import ZephyrApiConnection from '../api/zephyr';
+ *
+ * // Using API Connection (ScriptRunner Connect)
+ * const Zephyr = createZephyrApi(ZephyrApiConnection, 'us');
+ *
+ * // Using OAuth Token
+ * const Zephyr = createZephyrApi('oauth-token-string', 'us');
+ *
+ * // Use the API
+ * const testCase = await Zephyr.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
+ * ```
+ */
+import { TestCaseGroup } from './groups/TestCase';
+import { TestCycleGroup } from './groups/TestCycle';
+import { TestExecutionGroup } from './groups/TestExecution';
+import { TestPlanGroup } from './groups/TestPlan';
+import { FolderGroup } from './groups/Folder';
+import { ProjectGroup } from './groups/Project';
+import { StatusGroup } from './groups/Status';
+import { PriorityGroup } from './groups/Priority';
+import { EnvironmentGroup } from './groups/Environment';
+import { LinkGroup } from './groups/Link';
+import { IssueLinkGroup } from './groups/IssueLink';
+import { AutomationGroup } from './groups/Automation';
+import { AllGroup } from './groups/All';
+/**
+ * OAuth-based API connection implementation
+ * Retrieves OAuth token and adds it to requests
+ */
+class OAuthZephyrConnection {
+    constructor(oauthToken, baseUrl) {
+        this.oauthToken = oauthToken;
+        this.baseUrl = baseUrl;
+    }
+    async fetch(path, options) {
+        const headers = new Headers(options?.headers);
+        headers.set('Authorization', `Bearer ${this.oauthToken}`);
+        if (!headers.has('Content-Type') && options?.body && typeof options.body === 'string') {
+            headers.set('Content-Type', 'application/json');
+        }
+        const response = await fetch(`${this.baseUrl}${path}`, {
+            ...options,
+            headers,
+        });
+        // Return structural type compatible with ZephyrApiConnection
+        return {
+            ok: response.ok,
+            status: response.status,
+            statusText: response.statusText,
+            json: () => response.json(),
+            headers: {
+                get: (name) => response.headers.get(name),
+            },
+        };
+    }
+    get connectionId() {
+        return `oauth-zephyr-${this.baseUrl}`;
+    }
+}
+/**
+ * Get base URL for region
+ */
+function getBaseUrl(region) {
+    return region === 'us'
+        ? 'https://api.zephyrscale.smartbear.com/v2'
+        : 'https://eu.api.zephyrscale.smartbear.com/v2';
+}
+/**
+ * Main Zephyr API class
+ * Provides hierarchical access to all Zephyr API groups
+ */
+export class ZephyrApi {
+    constructor(apiConnection) {
+        this.fetch = apiConnection.fetch.bind(apiConnection);
+        this.connectionId = apiConnection.connectionId;
+        // Initialize all API groups
+        this.TestCase = new TestCaseGroup(apiConnection);
+        this.TestCycle = new TestCycleGroup(apiConnection);
+        this.TestExecution = new TestExecutionGroup(apiConnection);
+        this.TestPlan = new TestPlanGroup(apiConnection);
+        this.Folder = new FolderGroup(apiConnection);
+        this.Project = new ProjectGroup(apiConnection);
+        this.Status = new StatusGroup(apiConnection);
+        this.Priority = new PriorityGroup(apiConnection);
+        this.Environment = new EnvironmentGroup(apiConnection);
+        this.Link = new LinkGroup(apiConnection);
+        this.IssueLink = new IssueLinkGroup(apiConnection);
+        this.Automation = new AutomationGroup(apiConnection);
+        this.All = new AllGroup(apiConnection);
+    }
+}
+// Implementation
+export function createZephyrApi(apiConnectionOrOAuthToken, region, baseUrl) {
+    const finalRegion = region ?? 'us';
+    let apiConnection;
+    if (typeof apiConnectionOrOAuthToken === 'string') {
+        // OAuth mode - create OAuth connection
+        const finalBaseUrl = baseUrl ?? getBaseUrl(finalRegion);
+        apiConnection = new OAuthZephyrConnection(apiConnectionOrOAuthToken, finalBaseUrl);
+    }
+    else {
+        // Connector mode - use provided connection
+        // Note: Region is ignored when using API Connection as it's configured in the connection
+        apiConnection = apiConnectionOrOAuthToken;
+    }
+    return new ZephyrApi(apiConnection);
+}
+// Export all types for use in scripts
+export * from './types';
+// Export error strategy utilities
+export * from './error-strategy';
+// Export pagination utilities
+export { getAllPages, getAllPagesCursor } from './utils';
+// Export error types
+export { HttpError, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, TooManyRequestsError, ServerError, UnexpectedError, } from './utils';