@wdio/allure-reporter 8.15.0 → 8.15.7

package/README.md

@@ -52,7 +52,7 @@ export const config = {
 - `useCucumberStepReporter` - optional parameter (`false` by default), set it to true in order to change the report hierarchy when using cucumber. Try it for yourself and see how it looks.
 - `disableMochaHooks` - optional parameter (`false` by default), set it to true in order to not fetch the `before/after` stacktrace/screenshot/result hooks into the Allure Reporter.
 - `addConsoleLogs` - optional parameter(`false` by default), set to true in order to attach console logs from step to the reporter.
-- `reportedEnvironmentVars` - Set this option to display the environment variables in the report. Note that setting this, does not modify the actual environment variables.
+- `reportedEnvironmentVars` (**type:** `Record<string, string>`) - Set this option to display the environment variables in the report. Note that setting this, does not modify the actual environment variables.
 
 ## Supported Allure API
 * `addLabel(name, value)` - assign a custom label to test
@@ -77,15 +77,6 @@ export const config = {
 * `addDescription(description, [type])` – add description to test.
     * `description` (*String*) - description of the test.
     * `type` (*String*, optional) – description type, `text` by default. Values ['text', 'html','markdown']
-* `addStep(title, [{content, name = 'attachment'}], [status])` - add step to test.
-    * `title` (*String*) - name of the step.
-    * `content` (*String*, optional) - step attachment
-    * `name` (*String*, optional) - step attachment name, `attachment` by default.
-    * `status` (*String*, optional) - step status, `passed` by default. Must be "failed", "passed" or "broken"
-* `startStep(title)` - start with a step
-    * `title` (*String*) - name of the step.
-* `endStep(status)` - end with a step
-    * `status` (*String*, optional) - step status, `passed` by default. Must be "failed", "passed" or "broken"
 * `step(name, body)` - starts step with content function inside. Allows to create steps with infinite hierarchy
     * `body` (*Function*) - the step body async function
 

package/build/common/api.d.ts

@@ -111,18 +111,21 @@ export declare function addDescription(description: string, descriptionType: str
 export declare function addAttachment(name: string, content: string | Buffer | object, type: string): void;
 /**
  * Start allure step
+ * @deprecated use `step` method instead
  * @name startStep
  * @param {string} title - step name in report
  */
 export declare function startStep(title: string): void;
 /**
  * End current allure step
+ * @deprecated use `step` method instead
  * @name endStep
  * @param {StepStatus} [status='passed'] - step status
  */
 export declare function endStep(status?: Status): void;
 /**
  * Create allure step
+ * @deprecated use `step` method instead
  * @name addStep
  * @param {string} title - step name in report
  * @param {object} [attachmentObject={}] - attachment for step

package/build/common/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,MAAM,EAA+B,MAAM,mBAAmB,CAAA;AAavE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,QAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAE,WAAW,EAAE,MAAM,QAE9C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,KAAK,EAAE,MAAM,QAEtC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,MAAM,EAAE,MAAM,QAExC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,SAAS,EAAE,MAAM,QAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,QAEzC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,QAE/C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,QAEjC;AAED;;;;GAIG;AAEH,wBAAgB,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAE1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,QAE3E;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,QAK3F;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,KAAK,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAE,MAAM,GAAE,MAAsB,QAKtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACnB,KAAK,EAAE,MAAM,EACb,EACI,OAAO,EACP,IAAmB,EACnB,IAAmB,EACtB,GAAE,GAAQ,EACX,MAAM,GAAE,MAAsB,QAQjC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEvD;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,iBAK9D;;;;;;;;;;;;;;;;;;;AAED,wBAGC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,MAAM,EAA+B,MAAM,mBAAmB,CAAA;AAavE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,QAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAE,WAAW,EAAE,MAAM,QAE9C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,KAAK,EAAE,MAAM,QAEtC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,MAAM,EAAE,MAAM,QAExC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,SAAS,EAAE,MAAM,QAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,QAEzC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,QAE/C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,QAEjC;AAED;;;;GAIG;AAEH,wBAAgB,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAE1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,QAE3E;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,QAK3F;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAE,KAAK,EAAE,MAAM,QAEvC;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAE,MAAM,GAAE,MAAsB,QAKtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACnB,KAAK,EAAE,MAAM,EACb,EACI,OAAO,EACP,IAAmB,EACnB,IAAmB,EACtB,GAAE,GAAQ,EACX,MAAM,GAAE,MAAsB,QAQjC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEvD;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,iBAK9D;;;;;;;;;;;;;;;;;;;AAED,wBAGC"}

package/build/common/api.js

@@ -157,6 +157,7 @@ export function addAttachment(name, content, type) {
 }
 /**
  * Start allure step
+ * @deprecated use `step` method instead
  * @name startStep
  * @param {string} title - step name in report
  */
@@ -165,6 +166,7 @@ export function startStep(title) {
 }
 /**
  * End current allure step
+ * @deprecated use `step` method instead
  * @name endStep
  * @param {StepStatus} [status='passed'] - step status
  */
@@ -176,6 +178,7 @@ export function endStep(status = Status.PASSED) {
 }
 /**
  * Create allure step
+ * @deprecated use `step` method instead
  * @name addStep
  * @param {string} title - step name in report
  * @param {object} [attachmentObject={}] - attachment for step

package/cjs/common/api.js

@@ -177,6 +177,7 @@ function addAttachment(name, content, type) {
 exports.addAttachment = addAttachment;
 /**
  * Start allure step
+ * @deprecated use `step` method instead
  * @name startStep
  * @param {string} title - step name in report
  */
@@ -186,6 +187,7 @@ function startStep(title) {
 exports.startStep = startStep;
 /**
  * End current allure step
+ * @deprecated use `step` method instead
  * @name endStep
  * @param {StepStatus} [status='passed'] - step status
  */
@@ -198,6 +200,7 @@ function endStep(status = allure_js_commons_1.Status.PASSED) {
 exports.endStep = endStep;
 /**
  * Create allure step
+ * @deprecated use `step` method instead
  * @name addStep
  * @param {string} title - step name in report
  * @param {object} [attachmentObject={}] - attachment for step

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/allure-reporter",
-  "version": "8.15.0",
+  "version": "8.15.7",
   "description": "A WebdriverIO reporter plugin to create Allure Test Reports",
   "author": "Boris Osipov <osipov.boris@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-allure-reporter",
@@ -40,14 +40,14 @@
   },
   "dependencies": {
     "@types/node": "^20.1.0",
-    "@wdio/reporter": "8.15.0",
-    "@wdio/types": "8.15.0",
-    "allure-js-commons": "^2.0.0",
+    "@wdio/reporter": "8.15.7",
+    "@wdio/types": "8.15.7",
+    "allure-js-commons": "^2.5.0",
     "csv-stringify": "^6.0.4",
     "strip-ansi": "^7.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "78e199c5ffd74bdf3a5576952c3834c29afa989f"
+  "gitHead": "24d8f0dccf54e6e19779094d73eb90ae9086ee86"
 }