qase-javascript-commons 2.4.0 → 2.4.1

package/README.md

@@ -54,6 +54,7 @@ All configuration options are listed in the table below:
 | Qase test run description                                                                                             | `testops.run.description`  | `QASE_TESTOPS_RUN_DESCRIPTION`  | `<Framework name> automated run`        | No       | Any string                 |
 | Qase test run complete                                                                                                | `testops.run.complete`     | `QASE_TESTOPS_RUN_COMPLETE`     | `True`                                  |          | `True`, `False`            |
 | Array of tags to be added to the test run                                                                             | `testops.run.tags`         | `QASE_TESTOPS_RUN_TAGS`         | `[]`                                    | No       | Array of strings           |
+| External link to associate with test run (e.g., Jira ticket)                                                          | `testops.run.externalLink` | `QASE_TESTOPS_RUN_EXTERNAL_LINK` | undefined                              | No       | JSON object with `type` (`jiraCloud` or `jiraServer`) and `link` (e.g., `PROJ-123`) |
 | Qase test plan ID                                                                                                     | `testops.plan.id`          | `QASE_TESTOPS_PLAN_ID`          |  undefined                              | No       | Any integer                |
 | Size of batch for sending test results                                                                                | `testops.batch.size`       | `QASE_TESTOPS_BATCH_SIZE`       | `200`                                   | No       | Any integer                |
 | Enable defects for failed test cases                                                                                  | `testops.defect`           | `QASE_TESTOPS_DEFECT`           | `False`                                 | No       | `True`, `False`            |
@@ -88,7 +89,11 @@ All configuration options are listed in the table below:
       "title": "Regress run",
       "description": "Regress run description",
       "complete": true,
-      "tags": ["tag1", "tag2"]
+      "tags": ["tag1", "tag2"],
+      "externalLink": {
+        "type": "jiraCloud",
+        "link": "PROJ-123"
+      }
     },
     "defect": false,
     "project": "<project_code>",
@@ -111,3 +116,13 @@ All configuration options are listed in the table below:
   }
 }
 ```
+
+### Environment Variables Example:
+
+```bash
+# Set external link for Jira Cloud
+export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraCloud","link":"PROJ-123"}'
+
+# Set external link for Jira Server
+export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraServer","link":"PROJ-456"}'
+```

package/changelog.md

@@ -1,3 +1,9 @@
+# qase-javascript-commons@2.4.1
+
+## What's new
+
+Added support for external links in the test run.
+
 # qase-javascript-commons@2.3.6
 
 ## What's new

package/dist/client/clientV1.js

@@ -74,6 +74,22 @@ class ClientV1 {
                 throw new qase_error_1.QaseError('Failed to create test run');
             }
             this.logger.logDebug(`Test run created: ${JSON.stringify(data)}`);
+            if (this.config.run.externalLink && data.result.id) {
+                // Map our enum values to API enum values
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+                const apiType = this.config.run.externalLink.type === 'jiraCloud'
+                    ? qase_api_client_1.RunexternalIssuesTypeEnum.CLOUD
+                    : qase_api_client_1.RunexternalIssuesTypeEnum.SERVER;
+                await this.runClient.runUpdateExternalIssue(this.config.project, {
+                    type: apiType,
+                    links: [
+                        {
+                            run_id: data.result.id,
+                            external_issue: this.config.run.externalLink.link,
+                        },
+                    ],
+                });
+            }
             return data.result.id;
         }
         catch (error) {

package/dist/config/config-validation-schema.d.ts

@@ -1,5 +1,6 @@
 import { ModeEnum } from '../options';
 import { DriverEnum, FormatEnum } from '../writer';
+import { ExternalLinkType } from '../models/config/TestOpsOptionsType';
 /**
  * @type {JSONSchemaType<ConfigType>}
  */
@@ -85,6 +86,20 @@ export declare const configValidationSchema: {
                             };
                             nullable: boolean;
                         };
+                        externalLink: {
+                            type: string;
+                            nullable: boolean;
+                            properties: {
+                                type: {
+                                    type: string;
+                                    enum: ExternalLinkType[];
+                                };
+                                link: {
+                                    type: string;
+                                };
+                            };
+                            required: string[];
+                        };
                     };
                 };
                 plan: {

package/dist/config/config-validation-schema.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.configValidationSchema = void 0;
 const options_1 = require("../options");
 const writer_1 = require("../writer");
+const TestOpsOptionsType_1 = require("../models/config/TestOpsOptionsType");
 /**
  * @type {JSONSchemaType<ConfigType>}
  */
@@ -88,6 +89,20 @@ exports.configValidationSchema = {
                             },
                             nullable: true,
                         },
+                        externalLink: {
+                            type: 'object',
+                            nullable: true,
+                            properties: {
+                                type: {
+                                    type: 'string',
+                                    enum: [TestOpsOptionsType_1.ExternalLinkType.JIRA_CLOUD, TestOpsOptionsType_1.ExternalLinkType.JIRA_SERVER],
+                                },
+                                link: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['type', 'link'],
+                        },
                     },
                 },
                 plan: {

package/dist/env/env-enum.d.ts

@@ -32,7 +32,8 @@ export declare enum EnvRunEnum {
     title = "QASE_TESTOPS_RUN_TITLE",
     description = "QASE_TESTOPS_RUN_DESCRIPTION",
     complete = "QASE_TESTOPS_RUN_COMPLETE",
-    tags = "QASE_TESTOPS_RUN_TAGS"
+    tags = "QASE_TESTOPS_RUN_TAGS",
+    externalLink = "QASE_TESTOPS_RUN_EXTERNAL_LINK"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -40,6 +40,7 @@ var EnvRunEnum;
     EnvRunEnum["description"] = "QASE_TESTOPS_RUN_DESCRIPTION";
     EnvRunEnum["complete"] = "QASE_TESTOPS_RUN_COMPLETE";
     EnvRunEnum["tags"] = "QASE_TESTOPS_RUN_TAGS";
+    EnvRunEnum["externalLink"] = "QASE_TESTOPS_RUN_EXTERNAL_LINK";
 })(EnvRunEnum || (exports.EnvRunEnum = EnvRunEnum = {}));
 /**
  * @enum {string}

package/dist/env/env-to-config.js

@@ -26,6 +26,25 @@ const envToConfig = (env) => ({
             description: env[env_enum_1.EnvRunEnum.description],
             complete: env[env_enum_1.EnvRunEnum.complete],
             tags: env[env_enum_1.EnvRunEnum.tags]?.split(',').map(tag => tag.trim()) ?? [],
+            externalLink: env[env_enum_1.EnvRunEnum.externalLink] ? (() => {
+                try {
+                    const externalLinkValue = env[env_enum_1.EnvRunEnum.externalLink];
+                    if (!externalLinkValue)
+                        return undefined;
+                    const parsed = JSON.parse(externalLinkValue);
+                    // Validate that type is a valid ExternalLinkType value
+                    if (parsed.type !== 'jiraCloud' && parsed.type !== 'jiraServer') {
+                        return undefined;
+                    }
+                    return {
+                        type: parsed.type,
+                        link: parsed.link,
+                    };
+                }
+                catch {
+                    return undefined;
+                }
+            })() : undefined,
         },
         plan: {
             id: env[env_enum_1.EnvPlanEnum.id],

package/dist/env/env-type.d.ts

@@ -18,6 +18,7 @@ export interface EnvType {
     [EnvRunEnum.description]?: string;
     [EnvRunEnum.complete]?: boolean;
     [EnvRunEnum.tags]?: string;
+    [EnvRunEnum.externalLink]?: string;
     [EnvPlanEnum.id]?: number;
     [EnvBatchEnum.size]?: number;
     [EnvConfigurationsEnum.values]?: string;

package/dist/env/env-validation-schema.js

@@ -76,6 +76,10 @@ exports.envValidationSchema = {
             type: 'string',
             nullable: true,
         },
+        [env_enum_1.EnvRunEnum.externalLink]: {
+            type: 'string',
+            nullable: true,
+        },
         [env_enum_1.EnvPlanEnum.id]: {
             type: 'number',
             nullable: true,

package/dist/models/config/TestOpsOptionsType.d.ts

@@ -16,12 +16,21 @@ export interface TestOpsConfigurationValueType {
     name: string;
     value: string;
 }
+export declare enum ExternalLinkType {
+    JIRA_CLOUD = "jiraCloud",
+    JIRA_SERVER = "jiraServer"
+}
+export interface TestOpsExternalLinkType {
+    type: ExternalLinkType;
+    link: string;
+}
 export interface TestOpsRunType {
     id?: number | undefined;
     title?: string;
     description?: string;
     complete?: boolean | undefined;
     tags?: string[] | undefined;
+    externalLink?: TestOpsExternalLinkType | undefined;
 }
 export interface TestOpsPlanType {
     id?: number | undefined;

package/dist/models/config/TestOpsOptionsType.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExternalLinkType = void 0;
+var ExternalLinkType;
+(function (ExternalLinkType) {
+    ExternalLinkType["JIRA_CLOUD"] = "jiraCloud";
+    ExternalLinkType["JIRA_SERVER"] = "jiraServer";
+})(ExternalLinkType || (exports.ExternalLinkType = ExternalLinkType = {}));

package/dist/models/index.d.ts

@@ -6,3 +6,4 @@ export { Attachment } from './attachment';
 export { Report } from './report';
 export { CompoundError } from './error';
 export { ConfigurationGroup, ConfigurationItem, ConfigurationGroupResponse } from './configuration';
+export { ExternalLinkType, TestOpsOptionsType, TestOpsApiType, TestOpsRunType, TestOpsPlanType, TestOpsBatchType, TestOpsConfigurationType, TestOpsConfigurationValueType, TestOpsExternalLinkType } from './config/TestOpsOptionsType';

package/dist/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompoundError = exports.StepStatusEnum = exports.StepType = exports.TestStepType = exports.TestStatusEnum = exports.TestExecution = exports.TestResultType = void 0;
+exports.ExternalLinkType = exports.CompoundError = exports.StepStatusEnum = exports.StepType = exports.TestStepType = exports.TestStatusEnum = exports.TestExecution = exports.TestResultType = void 0;
 var test_result_1 = require("./test-result");
 Object.defineProperty(exports, "TestResultType", { enumerable: true, get: function () { return test_result_1.TestResultType; } });
 var test_execution_1 = require("./test-execution");
@@ -13,3 +13,5 @@ var step_execution_1 = require("./step-execution");
 Object.defineProperty(exports, "StepStatusEnum", { enumerable: true, get: function () { return step_execution_1.StepStatusEnum; } });
 var error_1 = require("./error");
 Object.defineProperty(exports, "CompoundError", { enumerable: true, get: function () { return error_1.CompoundError; } });
+var TestOpsOptionsType_1 = require("./config/TestOpsOptionsType");
+Object.defineProperty(exports, "ExternalLinkType", { enumerable: true, get: function () { return TestOpsOptionsType_1.ExternalLinkType; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",