@rbaileysr/zephyr-managed-api 1.2.0 → 1.2.8

package/dist/groups/Private/PrivateCustomFields.js

@@ -0,0 +1,150 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError } from '../../utils';
+export class PrivateCustomFields extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * Create a custom field using private API
+     *
+     * Creates a custom field for the specified entity type (test case, test plan, test run, test step, or test execution).
+     *
+     * ⚠️ 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 category - Entity type for the custom field (TEST_CASE, TEST_PLAN, TEST_RUN, TEST_STEP, or TEST_EXECUTION)
+     * @param request - Custom field creation request
+     * @returns The created custom field response
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {ServerError} If the server returns an error
+     */
+    async createCustomField(credentials, category, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on category
+        const endpointMap = {
+            TEST_CASE: 'customfield/testcase',
+            TEST_PLAN: 'customfield/testplan',
+            TEST_RUN: 'customfield/testrun',
+            TEST_STEP: 'customfield/teststep',
+            TEST_EXECUTION: 'customfield/testexecution',
+        };
+        const url = `${this.privateApiBaseUrl}/${endpointMap[category]}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            'authorization': `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify(request),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to create custom field: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to create custom fields in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Project or resource not found.');
+                }
+                throw new ServerError(`Failed to create custom field. 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) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while creating custom field', error);
+        }
+    }
+    /**
+     * Get custom fields for a specific entity type using private API
+     *
+     * Retrieves all custom fields configured for the specified entity type (test case, test plan, test run, test step, or test execution) in a project.
+     *
+     * ⚠️ 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 category - Entity type for the custom fields (TEST_CASE, TEST_PLAN, TEST_RUN, TEST_STEP, or TEST_EXECUTION)
+     * @param request - Get custom fields request
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Array of custom field definitions
+     * @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 project is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async getCustomFields(credentials, category, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on category
+        // Note: API uses "testrun" in URL even though category is "TEST_RUN"
+        const endpointMap = {
+            TEST_CASE: 'testcase',
+            TEST_PLAN: 'testplan',
+            TEST_RUN: 'testrun', // API uses "testrun" in URL
+            TEST_STEP: 'teststep',
+            TEST_EXECUTION: 'testexecution',
+        };
+        const url = `${this.privateApiBaseUrl}/project/${request.projectId}/customfields/${endpointMap[category]}?projectId=${request.projectId}`;
+        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) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to get custom fields: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to view custom fields in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Project not found.');
+                }
+                throw new ServerError(`Failed to get custom fields. 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) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while getting custom fields', error);
+        }
+    }
+}

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

@@ -0,0 +1,38 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Versions sub-group
+ * Handles test case version creation
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, CreateTestCaseVersionRequest, CreateTestCaseVersionResponse } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateVersions extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Create a new test case version using private API
+     *
+     * Creates a new version of an existing test case. Note that when a new version
+     * is created, the testCaseId changes for that 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 - Test case version 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)
+     * @returns The created version response with id and key
+     * @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 (including 409 Conflict if version already exists)
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestCaseVersion(credentials: PrivateApiCredentials, request: CreateTestCaseVersionRequest): Promise<CreateTestCaseVersionResponse>;
+}
+//# sourceMappingURL=PrivateVersions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateVersions.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateVersions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,6BAA6B,EAC7B,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,6BAA6B,CAAC;CAqFzC"}

package/dist/groups/Private/PrivateVersions.js

@@ -0,0 +1,99 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError } from '../../utils';
+export class PrivateVersions extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * Create a new test case version using private API
+     *
+     * Creates a new version of an existing test case. Note that when a new version
+     * is created, the testCaseId changes for that 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 - Test case version 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)
+     * @returns The created version response with id and key
+     * @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 (including 409 Conflict if version already exists)
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    async createTestCaseVersion(credentials, request) {
+        // Get test case ID from key if we have API connection
+        let testCaseId;
+        if (this.testCaseGroup) {
+            try {
+                const testCase = await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}' not found.`);
+                }
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}' 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 url = `${this.privateApiBaseUrl}/testcase/${testCaseId}/newversion`;
+        const headers = {
+            'Content-Type': 'application/json',
+            'authorization': `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify({}), // Empty body as per documentation
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to create test case version: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to create test case versions in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Test case not found.');
+                }
+                if (response.status === 409) {
+                    throw new ServerError('Conflict: A new version already exists for this test case.', response.status, response.statusText);
+                }
+                throw new ServerError(`Failed to create test case version. 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 creating test case version', error);
+        }
+    }
+}