@rbaileysr/zephyr-managed-api 1.3.1 → 1.3.3

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

@@ -0,0 +1,108 @@
+/*!
+ * 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, 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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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>;
+}
+//# 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,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EAKb,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;CAgIzB"}

package/dist/groups/Private/PrivateVersionControl.js

@@ -0,0 +1,454 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
+export class PrivateVersionControl extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * 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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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
+     */
+    async getTestCaseIssueLinks(credentials, request) {
+        // Get test case ID from key if we have API connection
+        let testCaseId;
+        if (this.testCaseGroup) {
+            try {
+                // If version is specified, get the versioned test case; otherwise get the current version
+                const testCase = request.version !== undefined && request.version > 0
+                    ? await this.testCaseGroup.getTestCaseVersion({
+                        testCaseKey: request.testCaseKey,
+                        version: request.version,
+                    })
+                    : await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test case ID from key '${request.testCaseKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        else {
+            throw new UnexpectedError('Cannot look up test case ID from key. This method requires Zephyr Connector to be configured. Use createZephyrApi() with an API Connection.');
+        }
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        const fields = 'id,issueId,url,urlDescription,type(id,index,name,i18nKey,systemKey),testCaseId,testRunId,testPlanId';
+        const url = `${this.privateApiBaseUrl}/testcase/${testCaseId}/tracelinks/issue?fields=${encodeURIComponent(fields)}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError('Invalid request parameters for getting issue links.');
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get issue links.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new ServerError(`Failed to get test case issue links. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const privateLinks = (await response.json());
+            // Transform to public API format
+            const issueLinks = privateLinks.map((link) => {
+                // Build self URL (approximate format based on public API pattern)
+                const self = `/testcases/${request.testCaseKey}/links/issues/${link.id}`;
+                return {
+                    id: link.id,
+                    self,
+                    issueId: Number(link.issueId),
+                    target: `/issues/${link.issueId}`,
+                    type: link.type.systemKey,
+                };
+            });
+            return issueLinks;
+        }
+        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 getting test case issue links', error);
+        }
+    }
+    /**
+     * 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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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
+     */
+    async getTestCaseWebLinks(credentials, request) {
+        // Get test case ID from key if we have API connection
+        let testCaseId;
+        if (this.testCaseGroup) {
+            try {
+                // If version is specified, get the versioned test case; otherwise get the current version
+                const testCase = request.version !== undefined && request.version > 0
+                    ? await this.testCaseGroup.getTestCaseVersion({
+                        testCaseKey: request.testCaseKey,
+                        version: request.version,
+                    })
+                    : await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test case ID from key '${request.testCaseKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        else {
+            throw new UnexpectedError('Cannot look up test case ID from key. This method requires Zephyr Connector to be configured. Use createZephyrApi() with an API Connection.');
+        }
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        const fields = 'id,url,urlDescription,type(id,index,name,i18nKey,systemKey),testCaseId,testRunId,testPlanId';
+        const url = `${this.privateApiBaseUrl}/testcase/${testCaseId}/tracelinks/weblink?fields=${encodeURIComponent(fields)}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError('Invalid request parameters for getting web links.');
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get web links.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new ServerError(`Failed to get test case web links. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const privateLinks = (await response.json());
+            // Transform to public API format
+            const webLinks = privateLinks.map((link) => {
+                // Build self URL (approximate format based on public API pattern)
+                const self = `/testcases/${request.testCaseKey}/links/weblinks/${link.id}`;
+                return {
+                    id: link.id,
+                    self,
+                    url: link.url,
+                    description: link.urlDescription || undefined,
+                    type: link.type.systemKey,
+                };
+            });
+            return webLinks;
+        }
+        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 getting test case web links', error);
+        }
+    }
+    /**
+     * 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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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
+     */
+    async getTestCaseTestScript(credentials, request) {
+        // Get test case ID from key if we have API connection (for version support)
+        let testCaseId = request.testCaseKey;
+        if (this.testCaseGroup) {
+            try {
+                // If version is specified, get the versioned test case; otherwise get the current version
+                const testCase = request.version !== undefined && request.version > 0
+                    ? await this.testCaseGroup.getTestCaseVersion({
+                        testCaseKey: request.testCaseKey,
+                        version: request.version,
+                    })
+                    : await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                // Use the ID for the private API call (works with both key and ID)
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test case ID from key '${request.testCaseKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Build fields query to get test script
+        const fields = 'testScript(id,text,steps(index,reflectRef,description,text,expectedResult,testData,customFieldValues,attachments,id,stepParameters(id,testCaseParameterId,value),testCase(id,key,name,archived,majorVersion,latestVersion,projectKey,parameters(id,name,defaultValue,index))))';
+        const url = `${this.privateApiBaseUrl}/testcase/${testCaseId}?fields=${encodeURIComponent(fields)}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError('Invalid request parameters for getting test script.');
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get test script.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new ServerError(`Failed to get test case test script. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const testCase = (await response.json());
+            // If no test script exists, return null
+            if (!testCase.testScript) {
+                return null;
+            }
+            // If it's a step-by-step script (has steps), it's not a plain/BDD script, return null
+            if (testCase.testScript.stepByStepScript) {
+                return null;
+            }
+            // If it has text, it's a plain text script
+            if (testCase.testScript.text) {
+                return {
+                    id: testCase.testScript.id,
+                    type: 'plain',
+                    text: testCase.testScript.text,
+                };
+            }
+            // No script found
+            return null;
+        }
+        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 getting test case test script', error);
+        }
+    }
+    /**
+     * 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 (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @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
+     */
+    async getTestCaseTestSteps(credentials, request) {
+        // Get test case ID from key if we have API connection (for version support)
+        let testCaseId = request.testCaseKey;
+        if (this.testCaseGroup) {
+            try {
+                // If version is specified, get the versioned test case; otherwise get the current version
+                const testCase = request.version !== undefined && request.version > 0
+                    ? await this.testCaseGroup.getTestCaseVersion({
+                        testCaseKey: request.testCaseKey,
+                        version: request.version,
+                    })
+                    : await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                // Use the ID for the private API call (works with both key and ID)
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test case ID from key '${request.testCaseKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Build fields query to get test steps
+        const fields = 'testScript(id,text,steps(index,reflectRef,description,text,expectedResult,testData,customFieldValues,attachments,id,stepParameters(id,testCaseParameterId,value),testCase(id,key,name,archived,majorVersion,latestVersion,projectKey,parameters(id,name,defaultValue,index))))';
+        const url = `${this.privateApiBaseUrl}/testcase/${testCaseId}?fields=${encodeURIComponent(fields)}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError('Invalid request parameters for getting test steps.');
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get test steps.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}'${request.version !== undefined && request.version > 0 ? ` version ${request.version}` : ''} not found.`);
+                }
+                throw new ServerError(`Failed to get test case test steps. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const testCase = (await response.json());
+            // If no test script or no step-by-step script exists, return empty list
+            if (!testCase.testScript || !testCase.testScript.stepByStepScript || !testCase.testScript.stepByStepScript.steps) {
+                return {
+                    values: [],
+                    total: 0,
+                    maxResults: 0,
+                    startAt: 0,
+                    isLast: true,
+                    next: null,
+                };
+            }
+            const privateSteps = testCase.testScript.stepByStepScript.steps;
+            // Transform to public API format
+            const testSteps = privateSteps.map((step) => {
+                const inline = {
+                    description: step.description || '',
+                    testData: step.testData || undefined,
+                    expectedResult: step.expectedResult || '',
+                    reflectRef: step.reflectRef || undefined,
+                    // Note: customFieldValues transformation would require more complex logic
+                    // For now, we'll skip it as it's not in the public API TestStepInline type
+                };
+                return {
+                    inline,
+                };
+            });
+            return {
+                values: testSteps,
+                total: testSteps.length,
+                maxResults: testSteps.length,
+                startAt: 0,
+                isLast: true,
+                next: null,
+            };
+        }
+        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 getting test case test steps', error);
+        }
+    }
+}

package/dist/groups/Private.d.ts

@@ -8,6 +8,7 @@ import { PrivateConfig } from './Private/PrivateConfig';
 import { PrivateVersions } from './Private/PrivateVersions';
 import { PrivateAttachments } from './Private/PrivateAttachments';
 import { PrivateAuthentication } from './Private/PrivateAuthentication';
+import { PrivateVersionControl } from './Private/PrivateVersionControl';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
@@ -35,6 +36,10 @@ export declare class PrivateGroup extends PrivateBase {
      * Attachments sub-group - Get, download, and create attachments
      */
     readonly Attachments: PrivateAttachments;
+    /**
+     * Version Control sub-group - Get version-specific data (links, test script, test steps)
+     */
+    readonly VersionControl: PrivateVersionControl;
     constructor(apiConnection?: ZephyrApiConnection);
 }
 //# sourceMappingURL=Private.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AAyDH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AASxE;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,WAAW,EAAE,kBAAkB,CAAC;gBAEpC,aAAa,CAAC,EAAE,mBAAmB;CAS/C"}
+{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AAyDH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AASxE;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,WAAW,EAAE,kBAAkB,CAAC;IAEhD;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;gBAE1C,aAAa,CAAC,EAAE,mBAAmB;CAU/C"}

package/dist/groups/Private.js

@@ -7,6 +7,7 @@ import { PrivateConfig } from './Private/PrivateConfig';
 import { PrivateVersions } from './Private/PrivateVersions';
 import { PrivateAttachments } from './Private/PrivateAttachments';
 import { PrivateAuthentication } from './Private/PrivateAuthentication';
+import { PrivateVersionControl } from './Private/PrivateVersionControl';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
@@ -21,5 +22,6 @@ export class PrivateGroup extends PrivateBase {
         this.Config = new PrivateConfig(apiConnection);
         this.Versions = new PrivateVersions(apiConnection);
         this.Attachments = new PrivateAttachments(apiConnection);
+        this.VersionControl = new PrivateVersionControl(apiConnection);
     }
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbaileysr/zephyr-managed-api",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "Managed API wrapper for Zephyr Cloud REST API v2 - Comprehensive type-safe access to all Zephyr API endpoints for ScriptRunner Connect",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",