@rbaileysr/zephyr-managed-api 1.2.1 → 1.2.8

package/dist/groups/Private/PrivateAuthentication.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Authentication sub-group
+ * Handles Jira Context JWT token retrieval
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateAuthentication extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get Jira Context JWT token
+     *
+     * Retrieves a short-lived JWT token (15 minutes) from Jira that is required
+     * for private Zephyr API endpoints. This token may need to be refreshed
+     * during long operations.
+     *
+     * ⚠️ WARNING: This uses a private Jira endpoint and may change without notice.
+     *
+     * @param credentials - Private API credentials
+     * @returns The Context JWT token string
+     */
+    getContextJwt(credentials: PrivateApiCredentials): Promise<string>;
+}
+//# sourceMappingURL=PrivateAuthentication.d.ts.map

package/dist/groups/Private/PrivateAuthentication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateAuthentication.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateAuthentication.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD,qBAAa,qBAAsB,SAAQ,WAAW;gBACzC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,WAAW,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGxE"}

package/dist/groups/Private/PrivateAuthentication.js

@@ -0,0 +1,24 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+export class PrivateAuthentication extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * Get Jira Context JWT token
+     *
+     * Retrieves a short-lived JWT token (15 minutes) from Jira that is required
+     * for private Zephyr API endpoints. This token may need to be refreshed
+     * during long operations.
+     *
+     * ⚠️ WARNING: This uses a private Jira endpoint and may change without notice.
+     *
+     * @param credentials - Private API credentials
+     * @returns The Context JWT token string
+     */
+    async getContextJwt(credentials) {
+        return super.getContextJwt(credentials);
+    }
+}

package/dist/groups/Private/PrivateBase.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Base class for Private API sub-groups
+ * Provides shared resources and utilities
+ */
+import type { PrivateApiCredentials } from '../../types';
+import type { ZephyrApiConnection } from '../../index';
+import { TestCaseGroup } from '../TestCase';
+import { TestCycleGroup } from '../TestCycle';
+import { TestPlanGroup } from '../TestPlan';
+import { TestExecutionGroup } from '../TestExecution';
+export declare class PrivateBase {
+    protected readonly privateApiBaseUrl = "https://app.tm4j.smartbear.com/backend/rest/tests/2.0";
+    protected readonly testCaseGroup?: TestCaseGroup;
+    protected readonly testCycleGroup?: TestCycleGroup;
+    protected readonly testPlanGroup?: TestPlanGroup;
+    protected readonly testExecutionGroup?: TestExecutionGroup;
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get Jira Context JWT token
+     *
+     * Retrieves a short-lived JWT token (15 minutes) from Jira that is required
+     * for private Zephyr API endpoints. This token may need to be refreshed
+     * during long operations.
+     *
+     * ⚠️ WARNING: This uses a private Jira endpoint and may change without notice.
+     */
+    protected getContextJwt(credentials: PrivateApiCredentials): Promise<string>;
+}
+//# sourceMappingURL=PrivateBase.d.ts.map

package/dist/groups/Private/PrivateBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateBase.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateBase.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAGtD,qBAAa,WAAW;IACvB,SAAS,CAAC,QAAQ,CAAC,iBAAiB,2DAA2D;IAC/F,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IACnD,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;gBAE/C,aAAa,CAAC,EAAE,mBAAmB;IAS/C;;;;;;;;OAQG;cACa,aAAa,CAAC,WAAW,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;CAsElF"}

package/dist/groups/Private/PrivateBase.js

@@ -0,0 +1,77 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { TestCaseGroup } from '../TestCase';
+import { TestCycleGroup } from '../TestCycle';
+import { TestPlanGroup } from '../TestPlan';
+import { TestExecutionGroup } from '../TestExecution';
+import { UnauthorizedError, ServerError, UnexpectedError } from '../../utils';
+export class PrivateBase {
+    constructor(apiConnection) {
+        this.privateApiBaseUrl = 'https://app.tm4j.smartbear.com/backend/rest/tests/2.0';
+        if (apiConnection) {
+            this.testCaseGroup = new TestCaseGroup(apiConnection);
+            this.testCycleGroup = new TestCycleGroup(apiConnection);
+            this.testPlanGroup = new TestPlanGroup(apiConnection);
+            this.testExecutionGroup = new TestExecutionGroup(apiConnection);
+        }
+    }
+    /**
+     * Get Jira Context JWT token
+     *
+     * Retrieves a short-lived JWT token (15 minutes) from Jira that is required
+     * for private Zephyr API endpoints. This token may need to be refreshed
+     * during long operations.
+     *
+     * ⚠️ WARNING: This uses a private Jira endpoint and may change without notice.
+     */
+    async getContextJwt(credentials) {
+        const url = `${credentials.jiraInstanceUrl}/plugins/servlet/ac/com.kanoah.test-manager/main-project-page`;
+        // Create Basic Auth header
+        const authCredentials = btoa(`${credentials.userEmail}:${credentials.apiToken}`);
+        const headers = {
+            'Authorization': `Basic ${authCredentials}`,
+            'Content-Type': 'application/json',
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate with Jira. Please check your email and API token.');
+                }
+                throw new ServerError(`Failed to retrieve Context JWT. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const responseText = await response.text();
+            // Extract contextJwt using regex (as per documentation)
+            const match = responseText.match(/"contextJwt":"([^"]+)"/);
+            if (!match || !match[1]) {
+                // Retry once if JWT is missing (as per documentation)
+                const retryResponse = await fetch(url, {
+                    method: 'POST',
+                    headers,
+                });
+                if (!retryResponse.ok) {
+                    throw new ServerError(`Failed to retrieve Context JWT on retry. Status: ${retryResponse.status}`, retryResponse.status, retryResponse.statusText);
+                }
+                const retryText = await retryResponse.text();
+                const retryMatch = retryText.match(/"contextJwt":"([^"]+)"/);
+                if (!retryMatch || !retryMatch[1]) {
+                    throw new UnexpectedError('Context JWT not found in response after retry. This may be a Jira bug or API change.', { responseText: retryText });
+                }
+                return retryMatch[1];
+            }
+            return match[1];
+        }
+        catch (error) {
+            if (error instanceof UnauthorizedError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while retrieving Context JWT', error);
+        }
+    }
+}

package/dist/groups/Private/PrivateComments.d.ts

@@ -0,0 +1,149 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Comments sub-group
+ * Handles comment-related operations for test cases, test cycles, and test plans
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, PrivateComment, GetTestCaseCommentsRequest, GetTestCycleCommentsRequest, GetTestPlanCommentsRequest, CreateTestCaseCommentRequest, CreateTestCaseCommentResponse, CreateTestCycleCommentRequest, CreateTestPlanCommentRequest, CreateCommentResponse } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateComments extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get comments for a test case using private API
+     *
+     * Retrieves all comments associated with a test case.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get comments request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Array of comments
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test case is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    getTestCaseComments(credentials: PrivateApiCredentials, request: GetTestCaseCommentsRequest): Promise<PrivateComment[]>;
+    /**
+     * Get comments for a test cycle using private API
+     *
+     * Retrieves all comments associated with a test cycle (test run).
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get comments request
+     * @param request.testCycleId - Test cycle ID (numeric)
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Array of comments
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    getTestCycleComments(credentials: PrivateApiCredentials, request: GetTestCycleCommentsRequest): Promise<PrivateComment[]>;
+    /**
+     * Get comments for a test plan using private API
+     *
+     * Retrieves all comments associated with a test plan.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get comments request
+     * @param request.testPlanId - Test plan ID (numeric)
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Array of comments
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test plan is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    getTestPlanComments(credentials: PrivateApiCredentials, request: GetTestPlanCommentsRequest): Promise<PrivateComment[]>;
+    /**
+     * Create a comment on a test case using private API
+     *
+     * Adds a comment to an existing test case. The comment will be associated with
+     * the specified user account ID.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Comment creation request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.body - Comment text/body
+     * @param request.createdBy - Atlassian account ID of the user creating the comment (e.g., '5d6fdc98dc6e480dbc021aae')
+     * @returns Comment creation response
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test case is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestCaseComment(credentials: PrivateApiCredentials, request: CreateTestCaseCommentRequest): Promise<CreateTestCaseCommentResponse>;
+    /**
+     * Create a comment on a test cycle using private API
+     *
+     * Adds a comment to an existing test cycle (test run). The comment will be associated with
+     * the specified user account ID.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Comment creation request
+     * @param request.testCycleKey - Test cycle key (e.g., 'PROJ-R1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.body - Comment text/body
+     * @param request.createdBy - Atlassian account ID of the user creating the comment (e.g., '5d6fdc98dc6e480dbc021aae')
+     * @returns Comment creation response
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test cycle ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestCycleComment(credentials: PrivateApiCredentials, request: CreateTestCycleCommentRequest): Promise<CreateCommentResponse>;
+    /**
+     * Create a comment on a test plan using private API
+     *
+     * Adds a comment to an existing test plan. The comment will be associated with
+     * the specified user account ID.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Comment creation request
+     * @param request.testPlanKey - Test plan key (e.g., 'PROJ-P1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.body - Comment text/body
+     * @param request.createdBy - Atlassian account ID of the user creating the comment (e.g., '5d6fdc98dc6e480dbc021aae')
+     * @returns Comment creation response
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test plan is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test plan ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestPlanComment(credentials: PrivateApiCredentials, request: CreateTestPlanCommentRequest): Promise<CreateCommentResponse>;
+}
+//# sourceMappingURL=PrivateComments.d.ts.map

package/dist/groups/Private/PrivateComments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateComments.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateComments.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,cAAc,EACd,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,4BAA4B,EAC5B,qBAAqB,EACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD,qBAAa,eAAgB,SAAQ,WAAW;gBACnC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,mBAAmB,CACxB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,cAAc,EAAE,CAAC;IA6E5B;;;;;;;;;;;;;;;;;;OAkBG;IACG,oBAAoB,CACzB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,cAAc,EAAE,CAAC;IAqD5B;;;;;;;;;;;;;;;;;;OAkBG;IACG,mBAAmB,CACxB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,cAAc,EAAE,CAAC;IAqD5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAoFzC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sBAAsB,CAC3B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,6BAA6B,GACpC,OAAO,CAAC,qBAAqB,CAAC;IAoFjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,qBAAqB,CAAC;CAmFjC"}