@testomatio/reporter 2.1.0-beta.3-filter-plan → 2.1.0-beta.5-codeceptjs

package/lib/adapter/codecept.js

@@ -50,17 +50,18 @@ function CodeceptReporter(config) {
     };
     output.debug = function (msg) {
         originalOutput.debug(msg);
-        data_storage_js_1.dataStorage.putData('log', repeat(this.stepShift) + picocolors_1.default.cyan(msg.toString()));
+        data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.cyan(msg.toString()));
     };
     output.say = function (message, color = 'cyan') {
         originalOutput.say(message, color);
-        const sayMsg = repeat(this.stepShift) + `  ${picocolors_1.default.bold(picocolors_1.default[color](message))}`;
+        const sayMsg = repeat(this?.stepShift || 0) + `  ${picocolors_1.default.bold(picocolors_1.default[color](message))}`;
         data_storage_js_1.dataStorage.putData('log', sayMsg);
     };
     output.log = function (msg) {
         originalOutput.log(msg);
-        data_storage_js_1.dataStorage.putData('log', repeat(this.stepShift) + picocolors_1.default.gray(msg));
+        data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.gray(msg));
     };
+    output.stepShift = 0;
     recorder.startUnlessRunning();
     const hookSteps = new Map();
     let currentHook = null;

package/lib/pipe/testomatio.js

@@ -113,8 +113,7 @@ class TestomatioPipe {
             const resp = await this.client.request({
                 method: 'GET',
                 url: '/api/test_grep',
-                params: q.params,
-                responseType: q.responseType
+                ...q,
             });
             if (Array.isArray(resp.data?.tests) && resp.data?.tests?.length > 0) {
                 (0, utils_js_1.foundedTestLog)(constants_js_1.APP_PREFIX, resp.data.tests);

package/lib/reporter-functions.d.ts

@@ -9,6 +9,8 @@ export default _default;
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+ * @param {any} [context=null] - optional context parameter
+ * @returns {void}
  */
 declare function saveArtifact(data: string | {
     path: string;
@@ -17,18 +19,21 @@ declare function saveArtifact(data: string | {
 }, context?: any): void;
 /**
  * Attach log message(s) to the test report
- * @param  string
+ * @param {...any} args - log messages to attach
+ * @returns {void}
  */
 declare function logMessage(...args: any[]): void;
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message
+ * @param {string} message - step message
+ * @returns {void}
  */
 declare function addStep(message: string): void;
 /**
  * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
- * @param {string?} value
+ * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)
+ * @param {string|null} [value=null] - optional value when keyValue is a string
+ * @returns {void}
  */
 declare function setKeyValue(keyValue: {
     [key: string]: string;
@@ -36,6 +41,7 @@ declare function setKeyValue(keyValue: {
 /**
  * Add a single label to the test report
  * @param {string} key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
- * @param {string} [value] - optional label value (e.g. 'high', 'login')
+ * @param {string|null} [value=null] - optional label value (e.g. 'high', 'login')
+ * @returns {void}
  */
-declare function setLabel(key: string, value?: string): void;
+declare function setLabel(key: string, value?: string | null): void;

package/lib/reporter-functions.js

@@ -4,6 +4,8 @@ const index_js_1 = require("./services/index.js");
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+ * @param {any} [context=null] - optional context parameter
+ * @returns {void}
  */
 function saveArtifact(data, context = null) {
     if (process.env.IS_PLAYWRIGHT)
@@ -15,7 +17,8 @@ function saveArtifact(data, context = null) {
 }
 /**
  * Attach log message(s) to the test report
- * @param  string
+ * @param {...any} args - log messages to attach
+ * @returns {void}
  */
 function logMessage(...args) {
     if (process.env.IS_PLAYWRIGHT)
@@ -24,7 +27,8 @@ function logMessage(...args) {
 }
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message
+ * @param {string} message - step message
+ * @returns {void}
  */
 function addStep(message) {
     if (process.env.IS_PLAYWRIGHT)
@@ -33,8 +37,9 @@ function addStep(message) {
 }
 /**
  * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
- * @param {string?} value
+ * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)
+ * @param {string|null} [value=null] - optional value when keyValue is a string
+ * @returns {void}
  */
 function setKeyValue(keyValue, value = null) {
     if (process.env.IS_PLAYWRIGHT)
@@ -47,7 +52,8 @@ function setKeyValue(keyValue, value = null) {
 /**
  * Add a single label to the test report
  * @param {string} key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
- * @param {string} [value] - optional label value (e.g. 'high', 'login')
+ * @param {string|null} [value=null] - optional label value (e.g. 'high', 'login')
+ * @returns {void}
  */
 function setLabel(key, value = null) {
     if (!key || typeof key !== 'string') {

package/lib/reporter.d.ts

@@ -1,12 +1,9 @@
-export type artifact = typeof import("./reporter-functions.js");
 export const artifact: (data: string | {
     path: string;
     type: string;
     name: string;
 }, context?: any) => void;
-export type log = typeof import("./reporter-functions.js");
 export const log: (...args: any[]) => void;
-export type logger = typeof import("./services/index.js");
 export const logger: {
     "__#13@#originalUserLogger": {
         assert(condition?: boolean, ...data: any[]): void;
@@ -75,14 +72,11 @@ export const logger: {
     }): void;
     prettyObjects: boolean;
 };
-export type meta = typeof import("./reporter-functions.js");
 export const meta: (keyValue: {
     [key: string]: string;
 } | string, value?: string | null) => void;
-export type step = typeof import("./reporter-functions.js");
 export const step: (message: string) => void;
-export type label = typeof import("./reporter-functions.js");
-export const label: (key: string, value?: string) => void;
+export const label: (key: string, value?: string | null) => void;
 declare namespace _default {
     let testomatioLogger: {
         "__#13@#originalUserLogger": {
@@ -230,6 +224,12 @@ declare namespace _default {
         [key: string]: string;
     } | string, value?: string | null) => void;
     let step: (message: string) => void;
-    let label: (key: string, value?: string) => void;
+    let label: (key: string, value?: string | null) => void;
 }
 export default _default;
+export type ArtifactFunction = typeof import("./reporter-functions.js").default.artifact;
+export type LogFunction = typeof import("./reporter-functions.js").default.log;
+export type LoggerService = typeof import("./services/index.js").services.logger;
+export type MetaFunction = typeof import("./reporter-functions.js").default.keyValue;
+export type StepFunction = typeof import("./reporter-functions.js").default.step;
+export type LabelFunction = typeof import("./reporter-functions.js").default.label;

package/lib/reporter.js

@@ -15,12 +15,12 @@ exports.meta = reporter_functions_js_1.default.keyValue;
 exports.step = reporter_functions_js_1.default.step;
 exports.label = reporter_functions_js_1.default.label;
 /**
- * @typedef {import('./reporter-functions.js')} artifact
- * @typedef {import('./reporter-functions.js')} log
- * @typedef {import('./services/index.js')} logger
- * @typedef {import('./reporter-functions.js')} meta
- * @typedef {import('./reporter-functions.js')} step
- * @typedef {import('./reporter-functions.js')} label
+ * @typedef {typeof import('./reporter-functions.js').default.artifact} ArtifactFunction
+ * @typedef {typeof import('./reporter-functions.js').default.log} LogFunction
+ * @typedef {typeof import('./services/index.js').services.logger} LoggerService
+ * @typedef {typeof import('./reporter-functions.js').default.keyValue} MetaFunction
+ * @typedef {typeof import('./reporter-functions.js').default.step} StepFunction
+ * @typedef {typeof import('./reporter-functions.js').default.label} LabelFunction
  */
 module.exports = {
     /**

package/lib/utils/pipe_utils.js

@@ -74,8 +74,11 @@ function parseFilterParams(opts) {
  *                            Returns undefined if the type is not valid.
  */
 function updateFilterType(type) {
-    const typeLowerCase = type.toLowerCase();
-    const filterTypes = ['tag-name', 'plan-id', 'label', 'jira-ticket'];
+    let typeLowerCase = type.toLowerCase();
+    const filterTypes = ['tag-name', 'plan', 'label', 'jira-ticket'];
+    if (typeLowerCase === 'plan-id') {
+        typeLowerCase = 'plan';
+    }
     const filterApi = [
         'tag',
         'plan',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.1.0-beta.3-filter-plan",
+  "version": "2.1.0-beta.5-codeceptjs",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/adapter/codecept.js

@@ -56,19 +56,20 @@ function CodeceptReporter(config) {
 
   output.debug = function(msg) {
     originalOutput.debug(msg);
-    dataStorage.putData('log', repeat(this.stepShift) + pc.cyan(msg.toString()));
+    dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.cyan(msg.toString()));
   };
 
   output.say = function(message, color = 'cyan') {
     originalOutput.say(message, color);
-    const sayMsg = repeat(this.stepShift) + `  ${pc.bold(pc[color](message))}`;
+    const sayMsg = repeat(this?.stepShift || 0) + `  ${pc.bold(pc[color](message))}`;
     dataStorage.putData('log', sayMsg);
   };
 
   output.log = function(msg) {
     originalOutput.log(msg);
-    dataStorage.putData('log', repeat(this.stepShift) + pc.gray(msg));
+    dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.gray(msg));
   };
+  output.stepShift = 0;
 
   recorder.startUnlessRunning();
 

package/src/pipe/testomatio.js

@@ -119,7 +119,7 @@ class TestomatioPipe {
       const resp = await this.client.request({
         method: 'GET',
         url: '/api/test_grep',
-        params: q
+        ...q,
       });
 
       if (Array.isArray(resp.data?.tests) && resp.data?.tests?.length > 0) {

package/src/reporter-functions.js

@@ -3,6 +3,8 @@ import { services } from './services/index.js';
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+ * @param {any} [context=null] - optional context parameter
+ * @returns {void}
  */
 function saveArtifact(data, context = null) {
   if (process.env.IS_PLAYWRIGHT)
@@ -14,7 +16,8 @@ function saveArtifact(data, context = null) {
 
 /**
  * Attach log message(s) to the test report
- * @param  string
+ * @param {...any} args - log messages to attach
+ * @returns {void}
  */
 function logMessage(...args) {
   if (process.env.IS_PLAYWRIGHT) throw new Error('This function is not available in Playwright framework');
@@ -23,7 +26,8 @@ function logMessage(...args) {
 
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message
+ * @param {string} message - step message
+ * @returns {void}
  */
 function addStep(message) {
   if (process.env.IS_PLAYWRIGHT)
@@ -34,8 +38,9 @@ function addStep(message) {
 
 /**
  * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
- * @param {string?} value
+ * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)
+ * @param {string|null} [value=null] - optional value when keyValue is a string
+ * @returns {void}
  */
 function setKeyValue(keyValue, value = null) {
   if (process.env.IS_PLAYWRIGHT)
@@ -50,7 +55,8 @@ function setKeyValue(keyValue, value = null) {
 /**
  * Add a single label to the test report
  * @param {string} key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
- * @param {string} [value] - optional label value (e.g. 'high', 'login')
+ * @param {string|null} [value=null] - optional label value (e.g. 'high', 'login')
+ * @returns {void}
  */
 function setLabel(key, value = null) {
   if (!key || typeof key !== 'string') {

package/src/reporter.js

@@ -11,12 +11,12 @@ export const step = reporterFunctions.step;
 export const label = reporterFunctions.label;
 
 /**
- * @typedef {import('./reporter-functions.js')} artifact
- * @typedef {import('./reporter-functions.js')} log
- * @typedef {import('./services/index.js')} logger
- * @typedef {import('./reporter-functions.js')} meta
- * @typedef {import('./reporter-functions.js')} step
- * @typedef {import('./reporter-functions.js')} label
+ * @typedef {typeof import('./reporter-functions.js').default.artifact} ArtifactFunction
+ * @typedef {typeof import('./reporter-functions.js').default.log} LogFunction
+ * @typedef {typeof import('./services/index.js').services.logger} LoggerService
+ * @typedef {typeof import('./reporter-functions.js').default.keyValue} MetaFunction
+ * @typedef {typeof import('./reporter-functions.js').default.step} StepFunction
+ * @typedef {typeof import('./reporter-functions.js').default.label} LabelFunction
  */
 export default {
   /**

package/src/utils/pipe_utils.js

@@ -69,9 +69,13 @@ function parseFilterParams(opts) {
  *                            Returns undefined if the type is not valid.
  */
 function updateFilterType(type) {
-  const typeLowerCase = type.toLowerCase();
+  let typeLowerCase = type.toLowerCase();
 
-  const filterTypes = ['tag-name', 'plan-id', 'label', 'jira-ticket'];
+  const filterTypes = ['tag-name', 'plan', 'label', 'jira-ticket'];
+
+  if (typeLowerCase === 'plan-id') {
+    typeLowerCase = 'plan';
+  }
 
   const filterApi = [
     'tag',

package/src/reporter.cjs_decprecated

@@ -1,21 +0,0 @@
-// const _reporter = require('../lib/reporter.js');
-
-
-// /**
-//  * @typedef {import('../lib/reporter-functions.js').saveArtifact} artifact
-//  * @typedef {import('../lib/reporter-functions.js').log} log
-//  * @typedef {import('../lib/reporter-functions.js').logger} logger
-//  * @typedef {import('../lib/reporter-functions.js')} meta
-//  * @typedef {import('../lib/reporter-functions.js')} step
-//  * 
-//  * "Reporter" type which is object containing all types from the above
-//  * @typedef {{artifact: artifact, log: log, logger: logger, meta: meta, step: step, }} Reporter
-//  */
-
-// // const reporter = _reporter;
-
-// /**
-//  * @type {Reporter}
-//  */
-// const reporter = _reporter;
-// module.exports = reporter;