wdio-qase-reporter 1.0.2 → 1.1.0

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-wdio@1.1.0
+
+## What's new
+
+- Updated to the latest minor version of the common package for improved compatibility and features.
+- Fixed all ESLint warnings across the project to ensure code quality and maintainability.
+
 # qase-wdio@1.0.2
 
 ## What's new

package/dist/hooks.js

@@ -8,7 +8,7 @@ async function beforeRunHook() {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
         ...config,
-        frameworkPackage: 'wdio',
+        frameworkPackage: '@wdio/cli',
         frameworkName: 'wdio',
         reporterName: 'wdio-qase-reporter',
     });

package/dist/reporter.d.ts

@@ -25,7 +25,7 @@ export default class WDIOQaseReporter extends WDIOReporter {
     onRunnerStart(runner: RunnerStats): void;
     onSuiteStart(suite: SuiteStats): void;
     onSuiteEnd(suite: SuiteStats): Promise<void>;
-    onRunnerEnd(_: RunnerStats): Promise<void>;
+    onRunnerEnd(): Promise<void>;
     onTestStart(test: TestStats): void;
     /**
      * @param {Error[]} testErrors

package/dist/reporter.js

@@ -34,6 +34,7 @@ class WDIOQaseReporter extends reporter_1.default {
     isSync;
     _options;
     _isMultiremote;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(options) {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         super(options);
@@ -42,7 +43,7 @@ class WDIOQaseReporter extends reporter_1.default {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...(0, qase_javascript_commons_1.composeOptions)(options, config),
-            frameworkPackage: 'wdio',
+            frameworkPackage: '@wdio/cli',
             frameworkName: 'wdio',
             reporterName: 'wdio-qase-reporter',
         });
@@ -127,7 +128,7 @@ class WDIOQaseReporter extends reporter_1.default {
         }
         this.storage.clear();
     }
-    async onRunnerEnd(_) {
+    async onRunnerEnd() {
         await this.reporter.sendResults();
         this.isSync = true;
     }
@@ -146,6 +147,7 @@ class WDIOQaseReporter extends reporter_1.default {
     static transformError(testErrors) {
         const err = new qase_javascript_commons_1.CompoundError();
         for (const error of testErrors) {
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
             if (error.message == undefined) {
                 continue;
             }
@@ -325,8 +327,6 @@ class WDIOQaseReporter extends reporter_1.default {
         curTest.fields = records;
     }
     addAttachment({ name, type, content, paths }) {
-        console.log('addAttachment');
-        console.log(name, type, content, paths);
         const curTest = this.storage.getCurrentTest();
         if (!curTest) {
             return;

package/dist/storage.js

@@ -39,7 +39,7 @@ const findLast = (arr, predicate) => {
     let result;
     for (let i = arr.length - 1; i >= 0; i--) {
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
+        // @ts-expect-error
         if (predicate(arr[i])) {
             result = arr[i];
             break;

package/dist/utils.js

@@ -6,6 +6,7 @@ exports.isScreenshotCommand = exports.isEmpty = void 0;
  * @param object {Object}
  * @private
  */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const isEmpty = (object) => 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 !object || Object.keys(object).length === 0;

package/dist/wdio.d.ts

@@ -1,4 +1,4 @@
-import { StepFunction } from './step';
+import { StepFunction } from 'qase-javascript-commons';
 export declare class qase {
     /**
      * Assign QaseID to test

package/dist/wdio.js

@@ -2,17 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.qase = void 0;
 const events_1 = require("./events");
-const step_1 = require("./step");
+const qase_javascript_commons_1 = require("qase-javascript-commons");
 /**
  * Send event to reporter
  * @param {string} event  - event name
  * @param {object} msg - event payload
  * @private
  */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const sendEvent = (event, msg = {}) => {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
     process.emit(event, msg);
 };
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
 class qase {
     /**
      * Assign QaseID to test
@@ -91,7 +93,7 @@ class qase {
      * @param {StepFunction} body - the step content function
      */
     static async step(name, body) {
-        const runningStep = new step_1.QaseStep(name);
+        const runningStep = new qase_javascript_commons_1.QaseStep(name);
         // eslint-disable-next-line @typescript-eslint/require-await
         await runningStep.run(body, async (message) => sendEvent(events_1.events.addStep, message));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-qase-reporter",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Qase WebDriverIO Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -32,7 +32,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.2.14",
+    "qase-javascript-commons": "~2.3.0",
     "uuid": "^9.0.1",
     "@types/node": "^20.1.0",
     "@wdio/reporter": "^8.39.0",

package/dist/step.d.ts

@@ -1,16 +0,0 @@
-import { Attachment, TestStepType } from 'qase-javascript-commons';
-export type StepFunction<T = any> = (this: QaseStep, step: QaseStep) => T | Promise<T>;
-export declare class QaseStep {
-    name: string;
-    attachments: Attachment[];
-    steps: TestStepType[];
-    constructor(name: string);
-    attach(attach: {
-        name?: string;
-        type?: string;
-        content?: string;
-        paths?: string[] | string;
-    }): void;
-    step(name: string, body: StepFunction): Promise<void>;
-    run(body: StepFunction, messageEmitter: (step: TestStepType) => Promise<void>): Promise<void>;
-}

package/dist/step.js

@@ -1,88 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QaseStep = void 0;
-const qase_javascript_commons_1 = require("qase-javascript-commons");
-const uuid_1 = require("uuid");
-const path_1 = __importDefault(require("path"));
-class QaseStep {
-    name = '';
-    attachments = [];
-    steps = [];
-    constructor(name) {
-        this.name = name;
-    }
-    attach(attach) {
-        if (attach.paths) {
-            const files = Array.isArray(attach.paths) ? attach.paths : [attach.paths];
-            for (const file of files) {
-                const attachmentName = path_1.default.basename(file);
-                const contentType = 'application/octet-stream';
-                this.attachments.push({
-                    id: (0, uuid_1.v4)(),
-                    file_name: attachmentName,
-                    mime_type: contentType,
-                    content: '',
-                    file_path: file,
-                    size: 0,
-                });
-            }
-            return;
-        }
-        if (attach.content) {
-            const attachmentName = attach.name ?? 'attachment';
-            const contentType = attach.type ?? 'application/octet-stream';
-            this.attachments.push({
-                id: (0, uuid_1.v4)(),
-                file_name: attachmentName,
-                mime_type: contentType,
-                content: attach.content,
-                file_path: null,
-                size: attach.content.length,
-            });
-        }
-    }
-    async step(name, body) {
-        const childStep = new QaseStep(name);
-        // eslint-disable-next-line @typescript-eslint/require-await
-        await childStep.run(body, async (step) => {
-            this.steps.push(step);
-        });
-    }
-    async run(body, messageEmitter) {
-        const startDate = new Date().getTime();
-        const step = new qase_javascript_commons_1.TestStepType();
-        step.data = {
-            action: this.name,
-            expected_result: null,
-            data: null,
-        };
-        try {
-            await body.call(this, this);
-            step.execution = {
-                start_time: startDate,
-                end_time: new Date().getTime(),
-                status: qase_javascript_commons_1.StepStatusEnum.passed,
-                duration: null,
-            };
-            step.attachments = this.attachments;
-            step.steps = this.steps;
-            await messageEmitter(step);
-        }
-        catch (e) {
-            step.execution = {
-                start_time: startDate,
-                end_time: new Date().getTime(),
-                status: qase_javascript_commons_1.StepStatusEnum.failed,
-                duration: null,
-            };
-            step.attachments = this.attachments;
-            step.steps = this.steps;
-            await messageEmitter(step);
-            throw e;
-        }
-    }
-}
-exports.QaseStep = QaseStep;