qase-javascript-commons 2.2.18 → 2.3.0

package/dist/formatter/jsonp-formatter.d.ts

@@ -1,7 +1,7 @@
 import { FormatterInterface } from './formatter-interface';
-export type JsonpFormatterOptionsType = {
+export interface JsonpFormatterOptionsType {
     space?: number | undefined;
-};
+}
 /**
  * @class JsonFormatter
  * @implements FormatterInterface

package/dist/models/attachment.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-export type Attachment = {
+export interface Attachment {
     file_name: string;
     mime_type: string;
     file_path: string | null;
     content: string | Buffer;
     size: number;
     id: string;
-};
+}

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

@@ -0,0 +1,25 @@
+export interface TestOpsOptionsType {
+    project: string;
+    uploadAttachments?: boolean | undefined;
+    api: TestOpsApiType;
+    run: TestOpsRunType;
+    plan: TestOpsPlanType;
+    batch?: TestOpsBatchType;
+    defect?: boolean | undefined;
+}
+export interface TestOpsRunType {
+    id?: number | undefined;
+    title?: string;
+    description?: string;
+    complete?: boolean | undefined;
+}
+export interface TestOpsPlanType {
+    id?: number | undefined;
+}
+export interface TestOpsBatchType {
+    size?: number | undefined;
+}
+export interface TestOpsApiType {
+    token: string;
+    host?: string | undefined;
+}

package/dist/models/config/TestOpsOptionsType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/execution-sum.d.ts

@@ -1,6 +1,6 @@
-export type ExecutionSum = {
+export interface ExecutionSum {
     start_time: number;
     end_time: number;
     duration: number;
     cumulative_duration: number;
-};
+}

package/dist/models/host-data.d.ts

@@ -9,5 +9,6 @@ export interface HostData {
     framework: string;
     reporter: string;
     commons: string;
-    apiClient: string;
+    apiClientV1: string;
+    apiClientV2: string;
 }

package/dist/models/report.d.ts

@@ -2,13 +2,13 @@ import { HostData } from './host-data';
 import { ShortResult } from './short-result';
 import { Stats } from './stats';
 import { ExecutionSum } from './execution-sum';
-export type Report = {
+export interface Report {
     environment: string;
     execution: ExecutionSum;
     host_data: HostData;
     results: ShortResult[];
     stats: Stats;
-    suites: any[];
+    suites: string[];
     threads: string[];
     title: string;
-};
+}

package/dist/models/short-result.d.ts

@@ -1,7 +1,7 @@
-export type ShortResult = {
+export interface ShortResult {
     id: string;
     title: string;
     status: string;
     duration: number;
     thread: string | null;
-};
+}

package/dist/models/stats.d.ts

@@ -1,8 +1,8 @@
-export type Stats = {
+export interface Stats {
     passed: number;
     failed: number;
     skipped: number;
     broken: number;
     muted: number;
     total: number;
-};
+}

package/dist/models/test-result.d.ts

@@ -19,13 +19,13 @@ export declare class TestResultType {
     message: string | null;
     constructor(title: string);
 }
-export type Relation = {
+export interface Relation {
     suite?: Suite;
-};
-export type Suite = {
+}
+export interface Suite {
     data: SuiteData[];
-};
-export type SuiteData = {
+}
+export interface SuiteData {
     title: string;
     public_id: number | null;
-};
+}

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

@@ -1,13 +1,9 @@
-import { QaseApiOptionsType } from 'qaseio/dist/qaseio';
 import { ModeEnum } from './mode-enum';
-import { TestOpsOptionsType } from '../reporters';
 import { DriverEnum, FsWriterOptionsType } from '../writer';
+import { TestOpsOptionsType } from '../models/config/TestOpsOptionsType';
 type RecursivePartial<T> = {
     [K in keyof T]?: RecursivePartial<T[K]> | undefined;
 };
-export type AdditionalTestOpsOptionsType = {
-    api?: RecursivePartial<QaseApiOptionsType>;
-};
 export type ConnectionsType = {
     [DriverEnum.local]?: FsWriterOptionsType;
 };
@@ -25,7 +21,7 @@ export type OptionsType = {
     debug?: boolean | undefined;
     environment?: string | undefined;
     rootSuite?: string | undefined;
-    testops?: (RecursivePartial<TestOpsOptionsType> & AdditionalTestOpsOptionsType) | undefined;
+    testops?: RecursivePartial<TestOpsOptionsType> | undefined;
     report?: RecursivePartial<AdditionalReportOptionsType> | undefined;
 };
 export type FrameworkOptionsType<F extends string, O> = {

package/dist/qase.d.ts

@@ -4,6 +4,7 @@ export interface ReporterInterface {
     addTestResult(result: TestResultType): Promise<void>;
     publish(): Promise<void>;
     startTestRun(): void;
+    startTestRunAsync(): Promise<void>;
     isCaptureLogs(): boolean;
     getResults(): TestResultType[];
     sendResults(): Promise<void>;

package/dist/qase.js

@@ -6,17 +6,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.QaseReporter = void 0;
 const env_schema_1 = __importDefault(require("env-schema"));
 const chalk_1 = __importDefault(require("chalk"));
-const qaseio_1 = require("qaseio");
 const reporters_1 = require("./reporters");
 const options_1 = require("./options");
 const env_1 = require("./env");
 const models_1 = require("./models");
 const writer_1 = require("./writer");
-const custom_boundary_1 = require("./utils/custom-boundary");
 const disabled_exception_1 = require("./utils/disabled-exception");
 const logger_1 = require("./utils/logger");
 const state_1 = require("./state/state");
 const hostData_1 = require("./utils/hostData");
+const clientV2_1 = require("./client/clientV2");
 /**
  * @type {Record<TestStatusEnum, (test: TestResultType) => string>}
  */
@@ -177,7 +176,7 @@ class QaseReporter {
                 this.useFallback = true;
             }
             try {
-                await this.fallbackReporter?.sendResults();
+                await this.fallbackReporter.sendResults();
                 if (this.withState) {
                     state_1.StateManager.setMode(this.options.fallback);
                 }
@@ -210,7 +209,7 @@ class QaseReporter {
                 this.useFallback = true;
             }
             try {
-                await this.fallbackReporter?.complete();
+                await this.fallbackReporter.complete();
             }
             catch (error) {
                 this.logger.logError('Unable to complete the run in the fallback reporter:', error);
@@ -239,7 +238,7 @@ class QaseReporter {
                     return;
                 }
                 try {
-                    this.startTestRunOperation = this.fallbackReporter?.startTestRun();
+                    this.startTestRunOperation = this.fallbackReporter.startTestRun();
                     if (this.withState) {
                         state_1.StateManager.setMode(this.options.fallback);
                     }
@@ -291,6 +290,7 @@ class QaseReporter {
                     }
                     return;
                 }
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
                 if (!this.useFallback) {
                     this.fallbackReporter.setTestResults(this.upstreamReporter?.getTestResults() ?? []);
                     this.useFallback = true;
@@ -381,41 +381,21 @@ class QaseReporter {
      * @private
      */
     createReporter(mode, options) {
-        const { frameworkPackage, reporterName, environment, rootSuite, report = {}, testops = {}, } = options;
         switch (mode) {
             case options_1.ModeEnum.testops: {
-                const { api: { token, headers, ...api } = {}, project, run: { title, description, ...run } = {}, plan = {}, batch = {}, useV2, defect, uploadAttachments, } = testops;
-                if (!token) {
+                if (!options.testops?.api?.token) {
                     throw new Error(`Either "testops.api.token" parameter or "${env_1.EnvApiEnum.token}" environment variable is required in "testops" mode`);
                 }
-                if (!project) {
+                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 qaseio_1.QaseApi({
-                    token,
-                    headers: {
-                        ...headers,
-                    },
-                    ...api,
-                }, custom_boundary_1.CustomBoundaryFormData);
-                return new reporters_1.TestOpsReporter(this.logger, {
-                    project,
-                    uploadAttachments,
-                    run: {
-                        title: title ?? `Automated run ${new Date().toISOString()}`,
-                        description: description ?? `${reporterName} automated run`,
-                        ...run,
-                    },
-                    plan,
-                    batch,
-                    useV2,
-                    defect,
-                }, apiClient, this.withState, environment, rootSuite, api.host);
+                const apiClient = new clientV2_1.ClientV2(this.logger, options.testops, options.environment, options.rootSuite);
+                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);
             }
             case options_1.ModeEnum.report: {
-                const localOptions = report.connections?.[writer_1.DriverEnum.local];
+                const localOptions = options.report?.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(this.logger, writer, frameworkPackage, reporterName, environment, rootSuite, testops.run?.id);
+                return new reporters_1.ReportReporter(this.logger, writer, options.frameworkPackage, options.reporterName, options.environment, options.rootSuite, options.testops?.run?.id);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();
@@ -431,10 +411,7 @@ class QaseReporter {
         this.logger.log(resultLogMap[test.execution.status](test));
     }
     setWithState(options) {
-        return options.frameworkName == 'cypress'
-            || options.frameworkName == ''
-            || options.frameworkName == null
-            || options.frameworkName == undefined;
+        return options.frameworkName === 'cypress' || !options.frameworkName;
     }
     maskToken(token) {
         if (token.length <= 7) {
@@ -443,25 +420,11 @@ class QaseReporter {
         return `${token.slice(0, 3)}****${token.slice(-4)}`;
     }
     sanitizeOptions(options) {
-        if (typeof options !== 'object' || options === null) {
-            return options;
+        const sanitized = JSON.parse(JSON.stringify(options));
+        if (sanitized.testops?.api?.token) {
+            sanitized.testops.api.token = this.maskToken(sanitized.testops.api.token);
         }
-        const sanitizedObject = {};
-        for (const key in options) {
-            if (Object.prototype.hasOwnProperty.call(options, key)) {
-                const value = options[key];
-                if (key === 'token' && typeof value === 'string') {
-                    sanitizedObject[key] = this.maskToken(value);
-                }
-                else if (typeof value === 'object' && value !== null) {
-                    sanitizedObject[key] = this.sanitizeOptions(value);
-                }
-                else {
-                    sanitizedObject[key] = value;
-                }
-            }
-        }
-        return sanitizedObject;
+        return sanitized;
     }
 }
 exports.QaseReporter = QaseReporter;

package/dist/reporters/index.d.ts

@@ -1,3 +1,3 @@
 export { AbstractReporter, type InternalReporterInterface, } from './abstract-reporter';
 export { ReportReporter } from './report-reporter';
-export { TestOpsReporter, type TestOpsOptionsType } from './testops-reporter';
+export { TestOpsReporter } from './testops-reporter';

package/dist/reporters/testops-reporter.d.ts

@@ -1,28 +1,7 @@
-import { QaseApiInterface, ResultStepStatus, TestStepResultCreateStatusEnum } from 'qaseio';
 import { AbstractReporter } from './abstract-reporter';
-import { StepStatusEnum, TestResultType, TestStatusEnum } from '../models';
+import { TestResultType } from '../models';
 import { LoggerInterface } from '../utils/logger';
-export interface TestOpsRunType {
-    id?: number | undefined;
-    title: string;
-    description: string;
-    complete?: boolean | undefined;
-}
-export interface TestOpsPlanType {
-    id?: number | undefined;
-}
-export interface TestOpsBatchType {
-    size?: number | undefined;
-}
-export interface TestOpsOptionsType {
-    project: string;
-    uploadAttachments?: boolean | undefined;
-    run: TestOpsRunType;
-    plan: TestOpsPlanType;
-    batch?: TestOpsBatchType;
-    defect?: boolean | undefined;
-    useV2?: boolean | undefined;
-}
+import { IClient } from '../client/interface';
 /**
  * @class TestOpsReporter
  * @extends AbstractReporter
@@ -30,89 +9,22 @@ export interface TestOpsOptionsType {
 export declare class TestOpsReporter extends AbstractReporter {
     private api;
     private withState;
-    /**
-     * @type {Record<TestStatusEnum, string>}
-     */
-    static statusMap: Record<TestStatusEnum, string>;
-    /**
-     * @type {Record<StepStatusEnum, ResultStepStatus>}
-     */
-    static stepStatusMap: Record<StepStatusEnum, ResultStepStatus>;
-    /**
-     * @type {Record<StepStatusEnum, ResultStepStatus>}
-     */
-    static stepStatusMapV1: Record<StepStatusEnum, TestStepResultCreateStatusEnum>;
-    /**
-     * @type {string}
-     * @private
-     */
+    private projectCode;
     private readonly baseUrl;
-    /**
-     * @type {string}
-     * @private
-     */
-    private readonly projectCode;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    private readonly isUploadAttachments;
-    /**
-     * @type {TestOpsRunType}
-     * @private
-     */
-    private run;
-    /**
-     * @type { string | undefined}
-     * @private
-     */
-    private readonly environment;
-    /**
-     * @type { number | undefined}
-     * @private
-     */
-    private readonly planId;
-    /**
-     * @type {TestResultType[]}
-     * @private
-     */
     private readonly batchSize;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    private readonly useV2;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    private readonly defect;
-    /**
-     * @type {string | undefined}
-     * @private
-     */
-    private readonly rootSuite;
-    /**
-     * @type {number}
-     * @private
-     */
+    private runId;
     private firstIndex;
-    /**
-     * @type {boolean}
-     * @private
-     */
     private isTestRunReady;
     private mutex;
     /**
      * @param {LoggerInterface} logger
-     * @param {ReporterOptionsType & TestOpsOptionsType} options
-     * @param {QaseApiInterface} api
+     * @param {IClient} api
      * @param {boolean} withState
-     * @param {string | undefined} environment
-     * @param {string | undefined} rootSuite
+     * @param {string} projectCode
      * @param {string | undefined} baseUrl
+     * @param {number | undefined} batchSize
      */
-    constructor(logger: LoggerInterface, options: TestOpsOptionsType, api: QaseApiInterface, withState: boolean, environment?: string, rootSuite?: string, baseUrl?: string);
+    constructor(logger: LoggerInterface, api: IClient, withState: boolean, projectCode: string, baseUrl?: string, batchSize?: number, runId?: number);
     /**
      * @returns {Promise<void>}
      */
@@ -144,71 +56,6 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @returns {Promise<void>}
      */
     complete(): Promise<void>;
-    /**
-     * @param {TestResultType} result
-     * @returns Promise<ResultCreateV2>
-     * @private
-     */
-    private transformTestResult;
-    /**
-     * @param {TestResultType} result
-     * @returns Promise<ResultCreate>
-     * @private
-     */
-    private transformTestResultV1;
-    /**
-     * @returns {ResultExecution}
-     * @private
-     * @param {TestExecution} exec
-     */
-    private getExecution;
-    /**
-     * @param {Relation | null} relation
-     * @returns {ResultRelations}
-     * @private
-     */
-    private getRelation;
-    /**
-     * @param {TestStepType[]} steps
-     * @param testTitle
-     * @returns Promise<ResultStep[]>
-     * @private
-     */
-    private transformSteps;
-    /**
-     * @param {TestStepType[]} steps
-     * @param testTitle
-     * @returns Promise<TestStepResultCreate[]>
-     * @private
-     */
-    private transformStepsV1;
-    private logEmptyStep;
-    /**
-     * @param {string} title
-     * @param {string} description
-     * @param {number | undefined} environment
-     * @returns {Promise<IdResponse>}
-     * @private
-     */
-    private createRun;
-    /**
-     * @returns {string}
-     * @private
-     */
-    private getDate;
-    /**
-     * @returns {Promise<void>}
-     * @private
-     */
-    private uploadAttachments;
-    /**
-     * Process error and throw QaseError
-     * @param {Error | AxiosError} error
-     * @param {string} message
-     * @param {object} model
-     * @private
-     */
-    private processError;
     /**
      * @param {string | undefined} url
      * @return string