qase-javascript-commons 2.0.0-beta.1 → 2.0.0-beta.10

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.envValidationSchema = void 0;
 const env_enum_1 = require("./env-enum");
 const options_1 = require("../options");
+const writer_1 = require("../writer");
 /**
  * @type {JSONSchemaType<EnvType>}
  */
@@ -14,6 +15,11 @@ exports.envValidationSchema = {
             enum: [options_1.ModeEnum.report, options_1.ModeEnum.testops, options_1.ModeEnum.off],
             nullable: true,
         },
+        [env_enum_1.EnvEnum.fallback]: {
+            type: 'string',
+            enum: [options_1.ModeEnum.report, options_1.ModeEnum.testops, options_1.ModeEnum.off],
+            nullable: true,
+        },
         [env_enum_1.EnvEnum.debug]: {
             type: 'boolean',
             nullable: true,
@@ -22,6 +28,10 @@ exports.envValidationSchema = {
             type: ['string', 'number'],
             nullable: true,
         },
+        [env_enum_1.EnvEnum.captureLogs]: {
+            type: 'boolean',
+            nullable: true,
+        },
         [env_enum_1.EnvTestOpsEnum.project]: {
             type: 'string',
             nullable: true,
@@ -30,8 +40,12 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
-        [env_enum_1.EnvTestOpsEnum.baseUrl]: {
-            type: 'string',
+        [env_enum_1.EnvTestOpsEnum.defect]: {
+            type: 'boolean',
+            nullable: true,
+        },
+        [env_enum_1.EnvTestOpsEnum.useV2]: {
+            type: 'boolean',
             nullable: true,
         },
         [env_enum_1.EnvApiEnum.token]: {
@@ -58,7 +72,11 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
-        [env_enum_1.EnvRunEnum.environment]: {
+        [env_enum_1.EnvPlanEnum.id]: {
+            type: 'number',
+            nullable: true,
+        },
+        [env_enum_1.EnvBatchEnum.size]: {
             type: 'number',
             nullable: true,
         },
@@ -66,8 +84,9 @@ exports.envValidationSchema = {
             type: 'string',
             nullable: true,
         },
-        [env_enum_1.EnvLocalEnum.ext]: {
+        [env_enum_1.EnvLocalEnum.format]: {
             type: 'string',
+            enum: [writer_1.FormatEnum.json, writer_1.FormatEnum.jsonp],
             nullable: true,
         },
     },

package/dist/formatter/index.d.ts

@@ -1,2 +1,3 @@
 export { type FormatterInterface } from './formatter-interface';
 export { JsonFormatter } from './json-formatter';
+export { JsonpFormatter } from './jsonp-formatter';

package/dist/formatter/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JsonFormatter = void 0;
+exports.JsonpFormatter = exports.JsonFormatter = void 0;
 var json_formatter_1 = require("./json-formatter");
 Object.defineProperty(exports, "JsonFormatter", { enumerable: true, get: function () { return json_formatter_1.JsonFormatter; } });
+var jsonp_formatter_1 = require("./jsonp-formatter");
+Object.defineProperty(exports, "JsonpFormatter", { enumerable: true, get: function () { return jsonp_formatter_1.JsonpFormatter; } });

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

@@ -0,0 +1,13 @@
+import { FormatterInterface } from './formatter-interface';
+export type JsonpFormatterOptionsType = {
+    space?: number | undefined;
+};
+/**
+ * @class JsonFormatter
+ * @implements FormatterInterface
+ */
+export declare class JsonpFormatter implements FormatterInterface {
+    private space;
+    constructor(options?: JsonpFormatterOptionsType);
+    format(object: unknown): Promise<string>;
+}

package/dist/formatter/jsonp-formatter.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonpFormatter = void 0;
+const strip_ansi_1 = __importDefault(require("strip-ansi"));
+/**
+ * @class JsonFormatter
+ * @implements FormatterInterface
+ */
+class JsonpFormatter {
+    constructor(options = {}) {
+        const { space = 4 } = options;
+        this.space = space;
+    }
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async format(object) {
+        const json = JSON.stringify(object, (key, value) => {
+            if (key === 'error' && value instanceof Error) {
+                return (0, strip_ansi_1.default)(String(value));
+            }
+            return value;
+        }, this.space);
+        return `qaseJsonp(${json});`;
+    }
+}
+exports.JsonpFormatter = JsonpFormatter;

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * from './options';
 export * from './reporters';
 export * from './writer';
 export * from './utils/get-package-version';
+export * from './utils/mimeTypes';

package/dist/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./options"), exports);
 __exportStar(require("./reporters"), exports);
 __exportStar(require("./writer"), exports);
 __exportStar(require("./utils/get-package-version"), exports);
+__exportStar(require("./utils/mimeTypes"), exports);

package/dist/models/attachment.d.ts

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

package/dist/models/attachment.js

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

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

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

package/dist/models/execution-sum.js

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

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

@@ -0,0 +1,11 @@
+export type HostData = {
+    system: string;
+    node: string;
+    release: string;
+    version: string;
+    machine: string;
+    python: string;
+    pip: string;
+    node_version: string;
+    npm: string;
+};

package/dist/models/host-data.js

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

package/dist/models/index.d.ts

@@ -1,2 +1,6 @@
-export { type TestResultType, TestStatusEnum as TestStatusEnum, } from './test-result';
-export { type TestStepType, StepStatusEnum } from './test-step';
+export { type TestResultType, Relation, Suite, SuiteData } from './test-result';
+export { TestExecution, TestStatusEnum } from './test-execution';
+export { type TestStepType, StepType } from './test-step';
+export { StepStatusEnum } from './step-execution';
+export { Attachment } from './attachment';
+export { Report } from './report';

package/dist/models/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StepStatusEnum = exports.TestStatusEnum = void 0;
-var test_result_1 = require("./test-result");
-Object.defineProperty(exports, "TestStatusEnum", { enumerable: true, get: function () { return test_result_1.TestStatusEnum; } });
+exports.StepStatusEnum = exports.StepType = exports.TestStatusEnum = void 0;
+var test_execution_1 = require("./test-execution");
+Object.defineProperty(exports, "TestStatusEnum", { enumerable: true, get: function () { return test_execution_1.TestStatusEnum; } });
 var test_step_1 = require("./test-step");
-Object.defineProperty(exports, "StepStatusEnum", { enumerable: true, get: function () { return test_step_1.StepStatusEnum; } });
+Object.defineProperty(exports, "StepType", { enumerable: true, get: function () { return test_step_1.StepType; } });
+var step_execution_1 = require("./step-execution");
+Object.defineProperty(exports, "StepStatusEnum", { enumerable: true, get: function () { return step_execution_1.StepStatusEnum; } });

package/dist/models/report.d.ts

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

package/dist/models/report.js

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

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

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

package/dist/models/short-result.js

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

package/dist/models/stats.d.ts

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

package/dist/models/stats.js

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

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

@@ -0,0 +1,9 @@
+export interface StepTextData {
+    action: string;
+    expected_result: string | null;
+}
+export interface StepGherkinData {
+    keyword: string;
+    name: string;
+    line: number;
+}

package/dist/models/step-data.js

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

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

@@ -0,0 +1,11 @@
+export declare enum StepStatusEnum {
+    passed = "passed",
+    failed = "failed",
+    blocked = "blocked"
+}
+export interface StepExecution {
+    start_time: number | null;
+    status: StepStatusEnum;
+    end_time: number | null;
+    duration: number | null;
+}

package/dist/models/step-execution.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepStatusEnum = void 0;
+var StepStatusEnum;
+(function (StepStatusEnum) {
+    StepStatusEnum["passed"] = "passed";
+    StepStatusEnum["failed"] = "failed";
+    StepStatusEnum["blocked"] = "blocked";
+})(StepStatusEnum || (exports.StepStatusEnum = StepStatusEnum = {}));

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

@@ -0,0 +1,19 @@
+/**
+ * @enum {string}
+ */
+export declare enum TestStatusEnum {
+    passed = "passed",
+    failed = "failed",
+    skipped = "skipped",
+    disabled = "disabled",
+    blocked = "blocked",
+    invalid = "invalid"
+}
+export interface TestExecution {
+    start_time: number | null;
+    status: TestStatusEnum;
+    end_time: number | null;
+    duration: number | null;
+    stacktrace: string | null;
+    thread: string | null;
+}

package/dist/models/test-execution.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestStatusEnum = void 0;
+/**
+ * @enum {string}
+ */
+var TestStatusEnum;
+(function (TestStatusEnum) {
+    TestStatusEnum["passed"] = "passed";
+    TestStatusEnum["failed"] = "failed";
+    TestStatusEnum["skipped"] = "skipped";
+    TestStatusEnum["disabled"] = "disabled";
+    TestStatusEnum["blocked"] = "blocked";
+    TestStatusEnum["invalid"] = "invalid";
+})(TestStatusEnum || (exports.TestStatusEnum = TestStatusEnum = {}));

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

@@ -1,25 +1,29 @@
 import { TestStepType } from './test-step';
-/**
- * @enum {string}
- */
-export declare enum TestStatusEnum {
-    passed = "passed",
-    failed = "failed",
-    skipped = "skipped",
-    disabled = "disabled",
-    blocked = "blocked",
-    invalid = "invalid"
-}
+import { Attachment } from './attachment';
+import { TestExecution } from './test-execution';
 export type TestResultType = {
     id: string;
-    testOpsId: number[];
     title: string;
-    status: `${TestStatusEnum}`;
-    suiteTitle?: string | string[] | undefined;
-    error?: Error | undefined;
-    startTime?: number | undefined;
-    duration?: number | undefined;
-    endTime?: number | undefined;
-    steps?: TestStepType[] | undefined;
-    attachments?: string[] | undefined;
+    signature: string;
+    run_id: number | null;
+    testops_id: number | number[] | null;
+    execution: TestExecution;
+    fields: Record<string, string>;
+    attachments: Attachment[];
+    steps: TestStepType[];
+    params: Record<string, string>;
+    author: string | null;
+    relations: Relation | null;
+    muted: boolean;
+    message: string | null;
+};
+export type Relation = {
+    suite?: Suite;
+};
+export type Suite = {
+    data: SuiteData[];
+};
+export type SuiteData = {
+    title: string;
+    public_id: number | null;
 };

package/dist/models/test-result.js

@@ -1,15 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStatusEnum = void 0;
-/**
- * @enum {string}
- */
-var TestStatusEnum;
-(function (TestStatusEnum) {
-    TestStatusEnum["passed"] = "passed";
-    TestStatusEnum["failed"] = "failed";
-    TestStatusEnum["skipped"] = "skipped";
-    TestStatusEnum["disabled"] = "disabled";
-    TestStatusEnum["blocked"] = "blocked";
-    TestStatusEnum["invalid"] = "invalid";
-})(TestStatusEnum || (exports.TestStatusEnum = TestStatusEnum = {}));

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

@@ -1,14 +1,16 @@
-export declare enum StepStatusEnum {
-    passed = "passed",
-    failed = "failed",
-    blocked = "blocked"
+import { StepGherkinData, StepTextData } from './step-data';
+import { StepExecution } from './step-execution';
+import { Attachment } from './attachment';
+export declare enum StepType {
+    TEXT = "text",
+    GHERKIN = "gherkin"
 }
 export type TestStepType = {
     id: string;
-    title: string;
-    status: `${StepStatusEnum}`;
-    duration?: number | undefined;
-    error?: Error | undefined;
-    steps?: TestStepType[] | undefined;
-    attachments?: string[] | undefined;
+    step_type: StepType;
+    data: StepTextData | StepGherkinData;
+    parent_id: string | null;
+    execution: StepExecution;
+    attachments: Attachment[];
+    steps: TestStepType[];
 };

package/dist/models/test-step.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StepStatusEnum = void 0;
-var StepStatusEnum;
-(function (StepStatusEnum) {
-    StepStatusEnum["passed"] = "passed";
-    StepStatusEnum["failed"] = "failed";
-    StepStatusEnum["blocked"] = "blocked";
-})(StepStatusEnum || (exports.StepStatusEnum = StepStatusEnum = {}));
+exports.StepType = void 0;
+var StepType;
+(function (StepType) {
+    StepType["TEXT"] = "text";
+    StepType["GHERKIN"] = "gherkin";
+})(StepType || (exports.StepType = StepType = {}));

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

@@ -20,6 +20,8 @@ export type OptionsType = {
     frameworkName: string;
     reporterName: string;
     mode?: `${ModeEnum}` | undefined;
+    fallback?: `${ModeEnum}` | undefined;
+    captureLogs?: boolean | undefined;
     debug?: boolean | undefined;
     environment?: string | number | undefined;
     testops?: (RecursivePartial<TestOpsOptionsType> & AdditionalTestOpsOptionsType) | undefined;

package/dist/qase.d.ts

@@ -1,11 +1,17 @@
-import { AbstractReporter, LoggerInterface } from './reporters';
 import { OptionsType } from './options';
 import { TestResultType } from './models';
+export interface ReporterInterface {
+    addTestResult(result: TestResultType): Promise<void>;
+    publish(): Promise<void>;
+    startTestRun(): void;
+    isCaptureLogs(): boolean;
+}
 /**
  * @class QaseReporter
  * @implements AbstractReporter
  */
-export declare class QaseReporter extends AbstractReporter {
+export declare class QaseReporter implements ReporterInterface {
+    private static instance;
     /**
      * @param {string} frameworkPackage
      * @param {string} frameworkName
@@ -15,36 +21,74 @@ export declare class QaseReporter extends AbstractReporter {
      */
     private static createHeaders;
     /**
-     * @type {ReporterInterface}
+     * @type {InternalReporterInterface}
      * @private
      */
-    private upstreamReporter?;
+    private readonly upstreamReporter?;
+    /**
+     * @type {InternalReporterInterface}
+     * @private
+     */
+    private readonly fallbackReporter?;
+    /**
+     * @type {boolean | undefined}
+     * @private
+     */
+    private readonly captureLogs;
     /**
      * @type {boolean}
      * @private
      */
     private disabled;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private useFallback;
+    private readonly logger;
+    private startTestRunOperation?;
+    /**
+     * @param {OptionsType} options
+     */
+    private constructor();
+    /**
+     * @returns {void}
+     */
+    startTestRun(): void;
     /**
      * @param {OptionsType} options
-     * @param {LoggerInterface} logger
+     * @returns {QaseReporter}
      */
-    constructor(options: OptionsType, logger?: LoggerInterface);
+    static getInstance(options: OptionsType): QaseReporter;
     /**
      * @param {TestResultType} result
      */
-    addTestResult(result: TestResultType): void;
+    addTestResult(result: TestResultType): Promise<void>;
+    /**
+     * @param {TestResultType} result
+     * @private
+     */
+    private addTestResultToFallback;
+    /**
+     * @returns {boolean}
+     */
+    isCaptureLogs(): boolean;
     /**
      * @returns {Promise<void>}
      */
     publish(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    private publishFallback;
     /**
      * @todo implement mode registry
+     * @param {ModeEnum} mode
      * @param {OptionsType} options
-     * @param {LoggerInterface} logger
-     * @returns {ReporterInterface}
+     * @returns {InternalReporterInterface}
      * @private
      */
-    private createUpstreamReporter;
+    private createReporter;
     /**
      * @param {TestResultType} test
      * @private