qase-javascript-commons 2.4.13 → 2.4.15

package/dist/client/clientV2.d.ts

@@ -3,13 +3,15 @@ import { StepStatusEnum, TestResultType, TestStatusEnum } from "../models";
 import { LoggerInterface } from "../utils/logger";
 import { ClientV1 } from "./clientV1";
 import { TestOpsOptionsType } from "../models/config/TestOpsOptionsType";
+import { HostData } from "../models/host-data";
 export declare class ClientV2 extends ClientV1 {
     private readonly rootSuite;
     static statusMap: Record<TestStatusEnum, string>;
     static stepStatusMap: Record<StepStatusEnum, ResultStepStatus>;
     private readonly resultsClient;
-    constructor(logger: LoggerInterface, config: TestOpsOptionsType, environment: string | undefined, rootSuite: string | undefined);
+    constructor(logger: LoggerInterface, config: TestOpsOptionsType, environment: string | undefined, rootSuite: string | undefined, hostData?: HostData, reporterName?: string, frameworkName?: string);
     private createApiConfigV2;
+    private buildHeaders;
     uploadResults(runId: number, results: TestResultType[]): Promise<void>;
     private transformTestResult;
     private transformParams;

package/dist/client/clientV2.js

@@ -31,19 +31,79 @@ class ClientV2 extends clientV1_1.ClientV1 {
         [models_1.StepStatusEnum.skipped]: qase_api_v2_client_1.ResultStepStatus.SKIPPED,
     };
     resultsClient;
-    constructor(logger, config, environment, rootSuite) {
+    constructor(logger, config, environment, rootSuite, hostData, reporterName, frameworkName) {
         super(logger, config, environment);
         this.rootSuite = rootSuite;
-        const apiConfig = this.createApiConfigV2();
+        const apiConfig = this.createApiConfigV2(hostData, reporterName, frameworkName);
         this.resultsClient = new qase_api_v2_client_1.ResultsApi(apiConfig);
     }
-    createApiConfigV2() {
+    createApiConfigV2(hostData, reporterName, frameworkName) {
         const apiConfig = new qase_api_v2_client_1.Configuration({ apiKey: this.config.api.token, formDataCtor: form_data_1.default });
         apiConfig.basePath = this.config.api.host && this.config.api.host != API_CONFIG.DEFAULT_HOST
             ? `${API_CONFIG.BASE_URL}${this.config.api.host}${API_CONFIG.VERSION}`
             : `https://api.${API_CONFIG.DEFAULT_HOST}${API_CONFIG.VERSION}`;
+        // Set default headers for all requests
+        if (hostData) {
+            const headers = this.buildHeaders(hostData, reporterName, frameworkName);
+            const existingHeaders = apiConfig.baseOptions?.headers || {};
+            const baseOptionsWithHeaders = {
+                ...(apiConfig.baseOptions || {}),
+                headers: {
+                    ...existingHeaders,
+                    ...headers,
+                },
+            };
+            apiConfig.baseOptions = baseOptionsWithHeaders;
+        }
         return apiConfig;
     }
+    buildHeaders(hostData, reporterName, frameworkName) {
+        const headers = {};
+        // Build X-Client header
+        const clientParts = [];
+        if (reporterName && reporterName.trim()) {
+            clientParts.push(`reporter=${reporterName}`);
+        }
+        if (hostData.reporter && hostData.reporter.trim()) {
+            clientParts.push(`reporter_version=${hostData.reporter}`);
+        }
+        if (frameworkName && frameworkName.trim()) {
+            clientParts.push(`framework=${frameworkName}`);
+        }
+        if (hostData.framework && hostData.framework.trim()) {
+            clientParts.push(`framework_version=${hostData.framework}`);
+        }
+        if (hostData.apiClientV1 && hostData.apiClientV1.trim()) {
+            clientParts.push(`client_version_v1=${hostData.apiClientV1}`);
+        }
+        if (hostData.apiClientV2 && hostData.apiClientV2.trim()) {
+            clientParts.push(`client_version_v2=${hostData.apiClientV2}`);
+        }
+        if (hostData.commons && hostData.commons.trim()) {
+            clientParts.push(`core_version=${hostData.commons}`);
+        }
+        if (clientParts.length > 0) {
+            headers['X-Client'] = clientParts.join(';');
+        }
+        // Build X-Platform header
+        const platformParts = [];
+        if (hostData.system && hostData.system.trim()) {
+            platformParts.push(`os=${hostData.system}`);
+        }
+        if (hostData.arch && hostData.arch.trim()) {
+            platformParts.push(`arch=${hostData.arch}`);
+        }
+        if (hostData.node && hostData.node.trim()) {
+            platformParts.push(`node=${hostData.node}`);
+        }
+        if (hostData.npm && hostData.npm.trim()) {
+            platformParts.push(`npm=${hostData.npm}`);
+        }
+        if (platformParts.length > 0) {
+            headers['X-Platform'] = platformParts.join(';');
+        }
+        return headers;
+    }
     async uploadResults(runId, results) {
         try {
             const models = await Promise.all(results.map(result => this.transformTestResult(result)));

package/dist/models/index.d.ts

@@ -1,9 +1,11 @@
-export { TestResultType, Relation, Suite, SuiteData } from './test-result';
+export { TestResultType } from './test-result';
+export type { Relation, Suite, SuiteData } from './test-result';
 export { TestExecution, TestStatusEnum } from './test-execution';
 export { TestStepType, StepType } from './test-step';
 export { StepStatusEnum } from './step-execution';
-export { Attachment } from './attachment';
-export { Report } from './report';
+export type { Attachment } from './attachment';
+export type { 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';
+export type { ConfigurationGroup, ConfigurationItem, ConfigurationGroupResponse } from './configuration';
+export { ExternalLinkType } from './config/TestOpsOptionsType';
+export type { TestOpsOptionsType, TestOpsApiType, TestOpsRunType, TestOpsPlanType, TestOpsBatchType, TestOpsConfigurationType, TestOpsConfigurationValueType, TestOpsExternalLinkType } from './config/TestOpsOptionsType';

package/dist/qase.d.ts

@@ -46,6 +46,7 @@ export declare class QaseReporter implements ReporterInterface {
     private startTestRunOperation?;
     private options;
     private withState;
+    private readonly hostData;
     /**
      * @param {OptionsType} options
      */

package/dist/qase.js

@@ -63,6 +63,7 @@ class QaseReporter {
     startTestRunOperation;
     options;
     withState;
+    hostData;
     /**
      * @param {OptionsType} options
      */
@@ -94,8 +95,8 @@ class QaseReporter {
         }
         this.logger = new logger_1.Logger(loggerOptions);
         this.logger.logDebug(`Config: ${JSON.stringify(this.sanitizeOptions(composedOptions))}`);
-        const hostData = (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName);
-        this.logger.logDebug(`Host data: ${JSON.stringify(hostData)}`);
+        this.hostData = (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName);
+        this.logger.logDebug(`Host data: ${JSON.stringify(this.hostData)}`);
         this.captureLogs = composedOptions.captureLogs;
         try {
             this.upstreamReporter = this.createReporter(
@@ -448,7 +449,7 @@ class QaseReporter {
                 if (!options.testops.project) {
                     throw new Error(`Either "testops.project" parameter or "${env_1.EnvTestOpsEnum.project}" environment variable is required in "testops" mode`);
                 }
-                const apiClient = new clientV2_1.ClientV2(this.logger, options.testops, options.environment, options.rootSuite);
+                const apiClient = new clientV2_1.ClientV2(this.logger, options.testops, options.environment, options.rootSuite, this.hostData, options.reporterName, options.frameworkPackage);
                 return new reporters_1.TestOpsReporter(this.logger, apiClient, this.withState, options.testops.project, options.testops.api.host, options.testops.batch?.size, options.testops.run?.id, options.testops.showPublicReportLink);
             }
             case options_1.ModeEnum.report: {

package/package.json

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