@rbaileysr/zephyr-managed-api 1.3.2 → 1.3.4

package/dist/groups/Private/PrivateConfig.js

@@ -6,6 +6,7 @@ import { PrivateCustomFields } from './PrivateCustomFields';
 import { PrivateLabels } from './PrivateLabels';
 import { PrivateIterations } from './PrivateIterations';
 import { PrivateDataSets } from './PrivateDataSets';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
 export class PrivateConfig extends PrivateBase {
     constructor(apiConnection) {
         super(apiConnection);
@@ -14,4 +15,103 @@ export class PrivateConfig extends PrivateBase {
         this.Iterations = new PrivateIterations(apiConnection);
         this.DataSets = new PrivateDataSets(apiConnection);
     }
+    /**
+     * Archive a config item (Environment or Iteration) using private API
+     *
+     * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
+     *
+     * ⚠️ 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 - Archive config request
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to archive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the archived item
+     * @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 environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async archiveConfig(credentials, request) {
+        return this.updateArchiveStatus(credentials, request, true);
+    }
+    /**
+     * Unarchive a config item (Environment or Iteration) using private API
+     *
+     * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
+     *
+     * ⚠️ 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 - Archive config request (same interface as archive, but sets isArchived to false)
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to unarchive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the unarchived item
+     * @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 environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async unarchiveConfig(credentials, request) {
+        return this.updateArchiveStatus(credentials, request, false);
+    }
+    /**
+     * Internal method to update archive status
+     */
+    async updateArchiveStatus(credentials, request, isArchived) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on type
+        const endpoint = request.type.toLowerCase(); // 'environment' or 'iteration'
+        const url = `${this.privateApiBaseUrl}/${endpoint}/${request.id}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = {
+            id: request.id,
+            isArchived,
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for ${isArchived ? 'archiving' : 'unarchiving'} ${request.type.toLowerCase()}.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError(`Insufficient permissions to ${isArchived ? 'archive' : 'unarchive'} ${request.type.toLowerCase()}.`);
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`${request.type} with ID '${request.id}' not found.`);
+                }
+                throw new ServerError(`Failed to ${isArchived ? 'archive' : 'unarchive'} ${request.type.toLowerCase()}. Status: ${response.status}`, response.status, response.statusText);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while ${isArchived ? 'archiving' : 'unarchiving'} ${request.type.toLowerCase()}`, error);
+        }
+    }
 }

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

@@ -0,0 +1,169 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Version Control sub-group
+ * Handles version-specific operations for test case links, test script, and test steps
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, GetTestCaseIssueLinksRequest, GetTestCaseWebLinksRequest, GetTestCaseTestScriptRequest, GetTestCaseTestStepsRequest, GetTestExecutionStepIssueLinksRequest, CreateTestExecutionStepIssueLinkRequest, CreateTestExecutionStepIssueLinkResponse, TestExecutionStepIssueLinkList, IssueLinkList, WebLinkList, TestScript, TestStepsList } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateVersionControl extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get issue links for a test case using private API (with version support)
+     *
+     * Retrieves all issue links associated with a test case, optionally for a specific version.
+     * The response format matches the public API `getTestCaseLinks().issues` format.
+     *
+     * ⚠️ 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 issue links 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.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
+     * @returns Array of issue links matching the public API format
+     * @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
+     */
+    getTestCaseIssueLinks(credentials: PrivateApiCredentials, request: GetTestCaseIssueLinksRequest): Promise<IssueLinkList>;
+    /**
+     * Get web links for a test case using private API (with version support)
+     *
+     * Retrieves all web links associated with a test case, optionally for a specific version.
+     * The response format matches the public API `getTestCaseLinks().webLinks` format.
+     *
+     * ⚠️ 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 web links 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.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
+     * @returns Array of web links matching the public API format
+     * @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
+     */
+    getTestCaseWebLinks(credentials: PrivateApiCredentials, request: GetTestCaseWebLinksRequest): Promise<WebLinkList>;
+    /**
+     * Get test script for a test case using private API (with version support)
+     *
+     * Retrieves the test script associated with a test case, optionally for a specific version.
+     * The response format matches the public API `getTestCaseTestScript()` format.
+     *
+     * ⚠️ 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 test script request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
+     * @returns Test script matching the public API format, or null if no test script exists
+     * @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 cannot be retrieved
+     */
+    getTestCaseTestScript(credentials: PrivateApiCredentials, request: GetTestCaseTestScriptRequest): Promise<TestScript | null>;
+    /**
+     * Get test steps for a test case using private API (with version support)
+     *
+     * Retrieves the test steps associated with a test case, optionally for a specific version.
+     * The response format matches the public API `getTestCaseTestSteps()` format.
+     *
+     * ⚠️ 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 test steps request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
+     * @returns Test steps list matching the public API format
+     * @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 cannot be retrieved
+     */
+    getTestCaseTestSteps(credentials: PrivateApiCredentials, request: GetTestCaseTestStepsRequest): Promise<TestStepsList>;
+    /**
+     * Map LinkType to numeric typeId for private API
+     */
+    private mapLinkTypeToTypeId;
+    /**
+     * Map numeric typeId to LinkType for private API
+     */
+    private mapTypeIdToLinkType;
+    /**
+     * Get issue links for a test execution step using private API
+     *
+     * Retrieves all issue links associated with a specific test execution step. This is useful for
+     * migration scenarios where you need to extract issue links from a source test execution and
+     * recreate them in a target instance.
+     *
+     * ⚠️ 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 issue links request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns List of issue links for the test execution step
+     * @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 execution or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If an unexpected error occurs
+     */
+    getTestExecutionStepIssueLinks(credentials: PrivateApiCredentials, request: GetTestExecutionStepIssueLinksRequest): Promise<TestExecutionStepIssueLinkList>;
+    /**
+     * Map system key to LinkType
+     */
+    private mapSystemKeyToLinkType;
+    /**
+     * Create an issue link for a test execution step using private API
+     *
+     * Creates a link between a test execution step and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     * This functionality is not available in the public API.
+     *
+     * ⚠️ 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 - Create issue link request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.issueId - Jira issue ID (numeric)
+     * @param request.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Created link response with ID
+     * @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 execution or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up
+     */
+    createTestExecutionStepIssueLink(credentials: PrivateApiCredentials, request: CreateTestExecutionStepIssueLinkRequest): Promise<CreateTestExecutionStepIssueLinkResponse>;
+}
+//# sourceMappingURL=PrivateVersionControl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateVersionControl.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateVersionControl.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,qCAAqC,EACrC,uCAAuC,EACvC,wCAAwC,EACxC,8BAA8B,EAC9B,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EAMb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAS5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAqEvD,qBAAa,qBAAsB,SAAQ,WAAW;gBACzC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,aAAa,CAAC;IA2GzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CACxB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,WAAW,CAAC;IA2GvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAgH7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,oBAAoB,CACzB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,aAAa,CAAC;IAiIzB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,8BAA8B,CACnC,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,qCAAqC,GAC5C,OAAO,CAAC,8BAA8B,CAAC;IAiF1C;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAa9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gCAAgC,CACrC,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,uCAAuC,GAC9C,OAAO,CAAC,wCAAwC,CAAC;CA+IpD"}