@wdio/allure-reporter 8.4.0 → 8.5.0

package/README.md

@@ -58,7 +58,14 @@ export const config = {
 * `addFeature(featureName)` – assign features to test
 * `addStory(storyName)` – assign user story to test
 * `addSeverity(value)` – assign severity to test, accepts one of these values: blocker, critical, normal, minor, trivial
+* `addTag(value)` – assign a tag label to test
+* `addEpic(value)` – assign an epic label to test
+* `addOwner(value)` – assign an owner label to test
+* `addSuite(value)` – assign a suite label to test
+* `addSubSuite(value)` – assign a sub suite label to test
+* `addParentSuite(value)` – assign a parent suite label to test
 * `addIssue(value)` – assign issue id to test
+* `addAllureId(value)` – assign allure test ops id label to test
 * `addTestId(value)` – assign TMS test id to test
 * `addEnvironment(name, value)` – save environment value
 * `addAttachment(name, content, [type])` – save attachment to test.
@@ -78,6 +85,8 @@ export const config = {
     * `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
 
 ### Usage
 Allure Api can be accessed using:
@@ -115,6 +124,20 @@ Given('I include feature and story name', () => {
 })
 ```
 
+#### Custom steps
+
+`step` method simplifies dealing with steps because each step present as an async function with any content inside.
+The first argument of the function is the current step, that has most of the allure API methods (such as `label`, `epic`, `attach` etc):
+
+```js
+allureReporter.step('my step name', async (s1) => {
+    s1.label('foo', 'bar')
+    await s1.step('my child step name', async (s2) => {
+        // you can add any combination of steps in the body function
+    })
+})
+```
+
 ##### Cucumber Tags
 
 Cucumber tags with special names (`issue` and `testId`) are converted to the links (the corresponding link templates must be configured before):

package/build/common/api.d.ts

@@ -1,11 +1,6 @@
 /// <reference types="node" />
-import type { Status } from '../types.js';
-/**
- * Assign feature to test
- * @name addFeature
- * @param {(string)} featureName - feature name or an array of names
- */
-export declare function addFeature(featureName: string): void;
+import type { StepBodyFunction } from 'allure-js-commons';
+import { Status } from 'allure-js-commons';
 /**
  * Assign label to test
  * @name addLabel
@@ -13,6 +8,26 @@ export declare function addFeature(featureName: string): void;
  * @param {string} value - label value
  */
 export declare function addLabel(name: string, value: string): void;
+/**
+ * Assign link to test
+ * @name addLink
+ * @param {string} url - link name
+ * @param {string} [name] - link name
+ * @param {string} [type] - link type
+ */
+export declare function addLink(url: string, name?: string, type?: string): void;
+/**
+ * Assign allure id label to test to link test to existing entity inside the test ops
+ * @name addAllureId
+ * @param {string} id - inner allure test ops id
+ */
+export declare function addAllureId(id: string): void;
+/**
+ * Assign feature to test
+ * @name addFeature
+ * @param {(string)} featureName - feature name or an array of names
+ */
+export declare function addFeature(featureName: string): void;
 /**
  * Assign severity to test
  * @name addSeverity
@@ -32,11 +47,47 @@ export declare function addIssue(issue: string): void;
  */
 export declare function addTestId(testId: string): void;
 /**
- * Assign story to test
+ * Assign story label to test
  * @name addStory
  * @param {string} storyName - story name for test
  */
 export declare function addStory(storyName: string): void;
+/**
+ * Assign suite label to test
+ * @name addSuite
+ * @param {string} suiteName - story name for test
+ */
+export declare function addSuite(suiteName: string): void;
+/**
+ * Assign parent suite label to test
+ * @name addParentSuite
+ * @param {string} suiteName - suite name
+ */
+export declare function addParentSuite(suiteName: string): void;
+/**
+ * Assign sub-suite label to test
+ * @name addSubSuite
+ * @param {string} suiteName - sub-suite name
+ */
+export declare function addSubSuite(suiteName: string): void;
+/**
+ * Assign epic label to test
+ * @name addEpic
+ * @param {string} epicName - the epic name
+ */
+export declare function addEpic(epicName: string): void;
+/**
+ * Assign owner label to test
+ * @name addOwner
+ * @param {string} owner - the owner name
+ */
+export declare function addOwner(owner: string): void;
+/**
+ * Assign tag label to test
+ * @name addTag
+ * @param {string} tag - the tag name
+ */
+export declare function addTag(tag: string): void;
 /**
  * Add environment value
  * @name addEnvironment
@@ -89,8 +140,16 @@ export declare function addStep(title: string, { content, name, type }?: any, st
  * @param {string} value - argument value
  */
 export declare function addArgument(name: string, value: string): void;
+/**
+ * Starts allure step execution with any content
+ * Can be used to generate any hierarchy of steps
+ * @param {string} name - the step name
+ * @param {StepBodyFunction} body - the step content function
+ */
+export declare function step(name: string, body: StepBodyFunction): Promise<void>;
 declare const _default: {
     addFeature: typeof addFeature;
+    addAllureId: typeof addAllureId;
     addLabel: typeof addLabel;
     addSeverity: typeof addSeverity;
     addIssue: typeof addIssue;
@@ -103,6 +162,7 @@ declare const _default: {
     endStep: typeof endStep;
     addStep: typeof addStep;
     addArgument: typeof addArgument;
+    step: typeof step;
 };
 export default _default;
 //# sourceMappingURL=api.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAYzC;;;;GAIG;AACH,wBAAgB,UAAU,CAAE,WAAW,EAAE,MAAM,QAE9C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AACD;;;;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;;;;;GAKG;AACH,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,MAAiB,QAKjD;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACnB,KAAK,EAAE,MAAM,EACb,EACI,OAAO,EACP,IAAmB,EACnB,IAAmB,EACtB,GAAE,GAAQ,EACX,MAAM,GAAE,MAAiB,QAQ5B;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEvD;;;;;;;;;;;;;;;;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;;;;;GAKG;AACH,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"}

package/build/common/api.js

@@ -1,4 +1,5 @@
-import { events, stepStatuses } from '../constants.js';
+import { Status, AllureCommandStepExecutable } from 'allure-js-commons';
+import { events } from '../constants.js';
 /**
  * Call reporter
  * @param {string} event  - event name
@@ -8,14 +9,6 @@ import { events, stepStatuses } from '../constants.js';
 const tellReporter = (event, msg = {}) => {
     process.emit(event, msg);
 };
-/**
- * Assign feature to test
- * @name addFeature
- * @param {(string)} featureName - feature name or an array of names
- */
-export function addFeature(featureName) {
-    tellReporter(events.addFeature, { featureName });
-}
 /**
  * Assign label to test
  * @name addLabel
@@ -25,6 +18,32 @@ export function addFeature(featureName) {
 export function addLabel(name, value) {
     tellReporter(events.addLabel, { name, value });
 }
+/**
+ * Assign link to test
+ * @name addLink
+ * @param {string} url - link name
+ * @param {string} [name] - link name
+ * @param {string} [type] - link type
+ */
+export function addLink(url, name, type) {
+    tellReporter(events.addLink, { url, name, type });
+}
+/**
+ * Assign allure id label to test to link test to existing entity inside the test ops
+ * @name addAllureId
+ * @param {string} id - inner allure test ops id
+ */
+export function addAllureId(id) {
+    tellReporter(events.addAllureId, { id });
+}
+/**
+ * Assign feature to test
+ * @name addFeature
+ * @param {(string)} featureName - feature name or an array of names
+ */
+export function addFeature(featureName) {
+    tellReporter(events.addFeature, { featureName });
+}
 /**
  * Assign severity to test
  * @name addSeverity
@@ -50,13 +69,61 @@ export function addTestId(testId) {
     tellReporter(events.addTestId, { testId });
 }
 /**
- * Assign story to test
+ * Assign story label to test
  * @name addStory
  * @param {string} storyName - story name for test
  */
 export function addStory(storyName) {
     tellReporter(events.addStory, { storyName });
 }
+/**
+ * Assign suite label to test
+ * @name addSuite
+ * @param {string} suiteName - story name for test
+ */
+export function addSuite(suiteName) {
+    tellReporter(events.addSuite, { suiteName });
+}
+/**
+ * Assign parent suite label to test
+ * @name addParentSuite
+ * @param {string} suiteName - suite name
+ */
+export function addParentSuite(suiteName) {
+    tellReporter(events.addParentSuite, { suiteName });
+}
+/**
+ * Assign sub-suite label to test
+ * @name addSubSuite
+ * @param {string} suiteName - sub-suite name
+ */
+export function addSubSuite(suiteName) {
+    tellReporter(events.addSubSuite, { suiteName });
+}
+/**
+ * Assign epic label to test
+ * @name addEpic
+ * @param {string} epicName - the epic name
+ */
+export function addEpic(epicName) {
+    tellReporter(events.addEpic, { epicName });
+}
+/**
+ * Assign owner label to test
+ * @name addOwner
+ * @param {string} owner - the owner name
+ */
+export function addOwner(owner) {
+    tellReporter(events.addOwner, { owner });
+}
+/**
+ * Assign tag label to test
+ * @name addTag
+ * @param {string} tag - the tag name
+ */
+export function addTag(tag) {
+    tellReporter(events.addTag, { tag });
+}
 /**
  * Add environment value
  * @name addEnvironment
@@ -101,9 +168,9 @@ export function startStep(title) {
  * @name endStep
  * @param {StepStatus} [status='passed'] - step status
  */
-export function endStep(status = 'passed') {
-    if (!Object.values(stepStatuses).includes(status)) {
-        throw new Error(`Step status must be ${Object.values(stepStatuses).join(' or ')}. You tried to set "${status}"`);
+export function endStep(status = Status.PASSED) {
+    if (!Object.values(Status).includes(status)) {
+        throw new Error(`Step status must be ${Object.values(Status).join(' or ')}. You tried to set "${status}"`);
     }
     tellReporter(events.endStep, status);
 }
@@ -117,9 +184,9 @@ export function endStep(status = 'passed') {
  * @param {string} [attachmentObject.type='text/plain'] - attachment type
  * @param {string} [status='passed'] - step status
  */
-export function addStep(title, { content, name = 'attachment', type = 'text/plain' } = {}, status = 'passed') {
-    if (!Object.values(stepStatuses).includes(status)) {
-        throw new Error(`Step status must be ${Object.values(stepStatuses).join(' or ')}. You tried to set "${status}"`);
+export function addStep(title, { content, name = 'attachment', type = 'text/plain' } = {}, status = Status.PASSED) {
+    if (!Object.values(Status).includes(status)) {
+        throw new Error(`Step status must be ${Object.values(Status).join(' or ')}. You tried to set "${status}"`);
     }
     const step = content ? { title, attachment: { content, name, type }, status } : { title, status };
     tellReporter(events.addStep, { step });
@@ -133,7 +200,18 @@ export function addStep(title, { content, name = 'attachment', type = 'text/plai
 export function addArgument(name, value) {
     tellReporter(events.addArgument, { name, value });
 }
+/**
+ * Starts allure step execution with any content
+ * Can be used to generate any hierarchy of steps
+ * @param {string} name - the step name
+ * @param {StepBodyFunction} body - the step content function
+ */
+export async function step(name, body) {
+    const runningStep = new AllureCommandStepExecutable(name);
+    const result = await runningStep.start(body);
+    tellReporter(events.addAllureStep, result);
+}
 export default {
-    addFeature, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment,
-    addDescription, addAttachment, startStep, endStep, addStep, addArgument
+    addFeature, addAllureId, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment,
+    addDescription, addAttachment, startStep, endStep, addStep, addArgument, step,
 };

package/build/constants.d.ts

@@ -1,18 +1,17 @@
-import type { Status } from './types.js';
-export declare const PASSED = "passed";
-export declare const FAILED = "failed";
-export declare const BROKEN = "broken";
-export declare const PENDING = "pending";
-export declare const CANCELED = "canceled";
-export declare const SKIPPED = "skipped";
-export declare const testStatuses: Record<string, Status>;
-export declare const stepStatuses: Record<string, Status>;
 export declare const events: {
     readonly addLabel: "allure:addLabel";
+    readonly addLink: "allure:addLink";
     readonly addFeature: "allure:addFeature";
     readonly addStory: "allure:addStory";
+    readonly addEpic: "allure:addEpic";
+    readonly addSuite: "allure:addSuite";
+    readonly addSubSuite: "allure:addSubSuite";
+    readonly addParentSuite: "allure:addParentSuite";
+    readonly addOwner: "allure:addOwner";
     readonly addSeverity: "allure:addSeverity";
+    readonly addTag: "allure:addTag";
     readonly addIssue: "allure:addIssue";
+    readonly addAllureId: "allure:addAllureId";
     readonly addTestId: "allure:addTestId";
     readonly addEnvironment: "allure:addEnvironment";
     readonly addDescription: "allure:addDescription";
@@ -21,6 +20,7 @@ export declare const events: {
     readonly endStep: "allure:endStep";
     readonly addStep: "allure:addStep";
     readonly addArgument: "allure:addArgument";
+    readonly addAllureStep: "allure:addAllureStep";
 };
 export declare const mochaEachHooks: readonly ["\"before each\" hook", "\"after each\" hook"];
 export declare const mochaAllHooks: readonly ["\"before all\" hook", "\"after all\" hook"];

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExC,eAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,eAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,eAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,eAAO,MAAM,OAAO,YAAY,CAAA;AAChC,eAAO,MAAM,QAAQ,aAAa,CAAA;AAClC,eAAO,MAAM,OAAO,YAAY,CAAA;AAEhC,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAKtC,CAAA;AACV,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAMtC,CAAA;AAEV,eAAO,MAAM,MAAM;;;;;;;;;;;;;;CAcT,CAAA;AAEV,eAAO,MAAM,cAAc,0DAAuD,CAAA;AAClF,eAAO,MAAM,aAAa,wDAAqD,CAAA;AAC/E,eAAO,MAAM,eAAe,OAAO,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;CAuBT,CAAA;AAEV,eAAO,MAAM,cAAc,0DAAuD,CAAA;AAClF,eAAO,MAAM,aAAa,wDAAqD,CAAA;AAC/E,eAAO,MAAM,eAAe,OAAO,CAAA"}

package/build/constants.js

@@ -1,28 +1,17 @@
-export const PASSED = 'passed';
-export const FAILED = 'failed';
-export const BROKEN = 'broken';
-export const PENDING = 'pending';
-export const CANCELED = 'canceled';
-export const SKIPPED = 'skipped';
-export const testStatuses = {
-    PASSED,
-    FAILED,
-    BROKEN,
-    PENDING
-};
-export const stepStatuses = {
-    PASSED,
-    FAILED,
-    BROKEN,
-    CANCELED,
-    SKIPPED
-};
 export const events = {
     addLabel: 'allure:addLabel',
+    addLink: 'allure:addLink',
     addFeature: 'allure:addFeature',
     addStory: 'allure:addStory',
+    addEpic: 'allure:addEpic',
+    addSuite: 'allure:addSuite',
+    addSubSuite: 'allure:addSubSuite',
+    addParentSuite: 'allure:addParentSuite',
+    addOwner: 'allure:addOwner',
     addSeverity: 'allure:addSeverity',
+    addTag: 'allure:addTag',
     addIssue: 'allure:addIssue',
+    addAllureId: 'allure:addAllureId',
     addTestId: 'allure:addTestId',
     addEnvironment: 'allure:addEnvironment',
     addDescription: 'allure:addDescription',
@@ -30,7 +19,8 @@ export const events = {
     startStep: 'allure:startStep',
     endStep: 'allure:endStep',
     addStep: 'allure:addStep',
-    addArgument: 'allure:addArgument'
+    addArgument: 'allure:addArgument',
+    addAllureStep: 'allure:addAllureStep'
 };
 export const mochaEachHooks = ['"before each" hook', '"after each" hook'];
 export const mochaAllHooks = ['"before all" hook', '"after all" hook'];

package/build/reporter.d.ts

@@ -1,62 +1,82 @@
-import type { SuiteStats, HookStats, RunnerStats, TestStats, BeforeCommandArgs, AfterCommandArgs, CommandArgs } from '@wdio/reporter';
+/// <reference types="node" />
+import type { SuiteStats, HookStats, RunnerStats, TestStats, BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
 import WDIOReporter from '@wdio/reporter';
-import { addFeature, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment, addDescription, addAttachment, startStep, endStep, addStep, addArgument } from './common/api.js';
-import type { AddAttachmentEventArgs, AddDescriptionEventArgs, AddEnvironmentEventArgs, AddFeatureEventArgs, AddIssueEventArgs, AddLabelEventArgs, AddSeverityEventArgs, AddStoryEventArgs, AddTestIdEventArgs, Status, AllureReporterOptions } from './types.js';
+import type { MetadataMessage, AllureStep } from 'allure-js-commons';
+import { AllureGroup, AllureTest, Status as AllureStatus, ContentType } from 'allure-js-commons';
+import { addFeature, addLink, addOwner, addEpic, addSuite, addSubSuite, addParentSuite, addTag, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment, addAllureId, addDescription, addAttachment, startStep, endStep, addStep, addArgument, step } from './common/api.js';
+import { AllureReporterState } from './state.js';
+import type { AddAttachmentEventArgs, AddDescriptionEventArgs, AddEnvironmentEventArgs, AddFeatureEventArgs, AddIssueEventArgs, AddLabelEventArgs, AddSeverityEventArgs, AddEpicEventArgs, AddOwnerEventArgs, AddParentSuiteEventArgs, AddSubSuiteEventArgs, AddLinkEventArgs, AddAllureIdEventArgs, AddSuiteEventArgs, AddTagEventArgs, AddStoryEventArgs, AddTestIdEventArgs, AllureReporterOptions } from './types.js';
 export default class AllureReporter extends WDIOReporter {
     private _allure;
     private _capabilities;
     private _isMultiremote?;
     private _config?;
-    private _lastScreenshot?;
     private _options;
     private _consoleOutput;
     private _originalStdoutWrite;
-    private _addConsoleLogs;
-    private _startedFeatures;
+    _state: AllureReporterState;
+    _runningUnits: Array<AllureGroup | AllureTest | AllureStep>;
     constructor(options?: AllureReporterOptions);
+    attachLogs(): void;
+    attachFile(name: string, content: string | Buffer, contentType: ContentType): void;
+    attachJSON(name: string, json: any): void;
+    attachScreenshot(name: string, content: Buffer): void;
+    _startSuite(suiteTitle: string): void;
+    _endSuite(): void;
+    _startTest(testTitle: string, cid?: string): void;
+    _skipTest(): void;
+    _endTest(status: AllureStatus, error?: Error): void;
+    _startStep(testTitle: string): void;
+    setTestParameters(cid?: string): void;
     registerListeners(): void;
     onRunnerStart(runner: RunnerStats): void;
     onSuiteStart(suite: SuiteStats): void;
-    onSuiteEnd(suite: SuiteStats): any;
+    onSuiteEnd(suite: SuiteStats): void;
     onTestStart(test: TestStats | HookStats): void;
-    setCaseParameters(cid: string | undefined, parentUid: string | undefined, addFeatureLabel?: boolean): void;
-    getParentSuite(uid?: string): SuiteStats | undefined;
-    getLabels({ tags }: SuiteStats): {
-        name: string;
-        value: string;
-    }[];
-    onTestPass(): any;
+    onTestPass(): void;
     onTestFail(test: TestStats | HookStats): void;
     onTestSkip(test: TestStats): void;
     onBeforeCommand(command: BeforeCommandArgs): void;
     onAfterCommand(command: AfterCommandArgs): void;
-    onHookStart(hook: HookStats): false | undefined;
-    onHookEnd(hook: HookStats): false | undefined;
-    addLabel({ name, value }: AddLabelEventArgs): false | undefined;
-    addStory({ storyName }: AddStoryEventArgs): false | undefined;
-    addFeature({ featureName }: AddFeatureEventArgs): false | undefined;
-    addSeverity({ severity }: AddSeverityEventArgs): false | undefined;
-    addIssue({ issue }: AddIssueEventArgs): false | undefined;
-    addTestId({ testId }: AddTestIdEventArgs): false | undefined;
-    addEnvironment({ name, value }: AddEnvironmentEventArgs): false | undefined;
-    addDescription({ description, descriptionType }: AddDescriptionEventArgs): false | undefined;
-    addAttachment({ name, content, type }: AddAttachmentEventArgs): false | undefined;
-    startStep(title: string): false | undefined;
-    endStep(status: Status): false | undefined;
-    addStep({ step }: any): false | undefined;
-    addArgument({ name, value }: any): false | undefined;
-    isAnyTestRunning(): any;
-    isScreenshotCommand(command: CommandArgs): boolean;
-    dumpJSON(name: string, json: object): void;
-    attachScreenshot(): void;
+    onHookStart(hook: HookStats): void;
+    onHookEnd(hook: HookStats): void;
+    addLabel({ name, value }: AddLabelEventArgs): void;
+    addLink({ name, url, type, }: AddLinkEventArgs): void;
+    addAllureId({ id, }: AddAllureIdEventArgs): void;
+    addStory({ storyName }: AddStoryEventArgs): void;
+    addFeature({ featureName }: AddFeatureEventArgs): void;
+    addSeverity({ severity }: AddSeverityEventArgs): void;
+    addEpic({ epicName, }: AddEpicEventArgs): void;
+    addOwner({ owner, }: AddOwnerEventArgs): void;
+    addSuite({ suiteName, }: AddSuiteEventArgs): void;
+    addParentSuite({ suiteName, }: AddParentSuiteEventArgs): void;
+    addSubSuite({ suiteName, }: AddSubSuiteEventArgs): void;
+    addTag({ tag, }: AddTagEventArgs): void;
+    addTestId({ testId, linkName, }: AddTestIdEventArgs): void;
+    addIssue({ issue, linkName, }: AddIssueEventArgs): void;
+    addEnvironment({ name, value }: AddEnvironmentEventArgs): void;
+    addDescription({ description, descriptionType }: AddDescriptionEventArgs): void;
+    addAttachment({ name, content, type }: AddAttachmentEventArgs): void;
+    startStep(title: string): void;
+    endStep(status: AllureStatus): void;
+    addStep({ step }: any): void;
+    addArgument({ name, value }: any): void;
+    addAllureStep(metadata: MetadataMessage): void;
     /**
      * public API attached to the reporter
      * deprecated approach and only here for backwards compatibility
      */
     static addFeature: typeof addFeature;
+    static addLink: typeof addLink;
+    static addEpic: typeof addEpic;
+    static addOwner: typeof addOwner;
+    static addTag: typeof addTag;
     static addLabel: typeof addLabel;
     static addSeverity: typeof addSeverity;
     static addIssue: typeof addIssue;
+    static addSuite: typeof addSuite;
+    static addSubSuite: typeof addSubSuite;
+    static addParentSuite: typeof addParentSuite;
     static addTestId: typeof addTestId;
     static addStory: typeof addStory;
     static addEnvironment: typeof addEnvironment;
@@ -66,5 +86,7 @@ export default class AllureReporter extends WDIOReporter {
     static endStep: typeof endStep;
     static addStep: typeof addStep;
     static addArgument: typeof addArgument;
+    static addAllureId: typeof addAllureId;
+    static step: typeof step;
 }
 //# sourceMappingURL=reporter.d.ts.map

package/build/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,UAAU,EAAO,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,iBAAiB,EACrE,gBAAgB,EAAE,WAAW,EAChC,MAAM,gBAAgB,CAAA;AACvB,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAGzC,OAAO,EACH,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAChF,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAC1E,MAAM,iBAAiB,CAAA;AAMxB,OAAO,KAAK,EACR,sBAAsB,EAAE,uBAAuB,EAAE,uBAAuB,EACxE,mBAAmB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAC/E,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,EAAE,qBAAqB,EACvE,MAAM,YAAY,CAAA;AAWnB,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,YAAY;IACpD,OAAO,CAAC,OAAO,CAAK;IACpB,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,OAAO,CAAC,CAAoB;IACpC,OAAO,CAAC,eAAe,CAAC,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,cAAc,CAAQ;IAC9B,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,gBAAgB,CAAmB;gBAE/B,OAAO,GAAE,qBAA0B;IA6B/C,iBAAiB;IAgBjB,aAAa,CAAC,MAAM,EAAE,WAAW;IAMjC,YAAY,CAAC,KAAK,EAAE,UAAU;IA8C9B,UAAU,CAAC,KAAK,EAAE,UAAU;IAsC5B,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IA6BvC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,eAAe,GAAE,OAAc;IAkCzG,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAQpD,SAAS,CAAC,EACN,IAAI,EACP,EAAE,UAAU;cACa,MAAM;eAAS,MAAM;;IAY/C,UAAU;IAYV,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IA8BtC,UAAU,CAAC,IAAI,EAAE,SAAS;IAc1B,eAAe,CAAC,OAAO,EAAE,iBAAiB;IAsB1C,cAAc,CAAC,OAAO,EAAE,gBAAgB;IAgCxC,WAAW,CAAC,IAAI,EAAE,SAAS;IAuB3B,SAAS,CAAC,IAAI,EAAE,SAAS;IA8CzB,QAAQ,CAAC,EACL,IAAI,EACJ,KAAK,EACR,EAAE,iBAAiB;IASpB,QAAQ,CAAC,EACL,SAAS,EACZ,EAAE,iBAAiB;IASpB,UAAU,CAAC,EACP,WAAW,EACd,EAAE,mBAAmB;IAStB,WAAW,CAAC,EACR,QAAQ,EACX,EAAE,oBAAoB;IASvB,QAAQ,CAAC,EACL,KAAK,EACR,EAAE,iBAAiB;IAUpB,SAAS,CAAC,EACN,MAAM,EACT,EAAE,kBAAkB;IAUrB,cAAc,CAAC,EACX,IAAI,EACJ,KAAK,EACR,EAAE,uBAAuB;IAS1B,cAAc,CAAC,EACX,WAAW,EACX,eAAe,EAClB,EAAE,uBAAuB;IAS1B,aAAa,CAAC,EACV,IAAI,EACJ,OAAO,EACP,IAAmB,EACtB,EAAE,sBAAsB;IAYzB,SAAS,CAAC,KAAK,EAAE,MAAM;IAOvB,OAAO,CAAC,MAAM,EAAE,MAAM;IAOtB,OAAO,CAAC,EACJ,IAAI,EACP,EAAE,GAAG;IAWN,WAAW,CAAC,EACR,IAAI,EACJ,KAAK,EACR,EAAE,GAAG;IASN,gBAAgB;IAIhB,mBAAmB,CAAC,OAAO,EAAE,WAAW;IAUxC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMnC,gBAAgB;IAOhB;;;OAGG;IACH,MAAM,CAAC,UAAU,oBAAa;IAC9B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,aAAa,uBAAgB;IACpC,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,WAAW,qBAAc;CACnC"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EACR,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,iBAAiB,EAChE,gBAAgB,EACnB,MAAM,gBAAgB,CAAA;AACvB,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,EAAS,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAiB,WAAW,EAAE,UAAU,EAAE,MAAM,IAAI,YAAY,EAA8B,WAAW,EAA+B,MAAM,mBAAmB,CAAA;AACxK,OAAO,EACH,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EACxK,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAChF,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAMhD,OAAO,KAAK,EACR,sBAAsB,EAAE,uBAAuB,EAAE,uBAAuB,EACxE,mBAAmB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAC/E,gBAAgB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,oBAAoB,EAClF,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,eAAe,EAC1E,iBAAiB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAKpF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,YAAY;IACpD,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,OAAO,CAAC,CAAoB;IACpC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,cAAc,CAAQ;IAC9B,OAAO,CAAC,oBAAoB,CAAU;IAEtC,MAAM,EAAE,mBAAmB,CAAA;IAE3B,aAAa,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC,CAAK;gBAEpD,OAAO,GAAE,qBAA0B;IA+B/C,UAAU;IAiBV,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,WAAW;IAgB3E,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAOlC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAI9C,WAAW,CAAC,UAAU,EAAE,MAAM;IAQ9B,SAAS;IAoBT,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAS1C,SAAS;IAiBT,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,KAAK;IAsB5C,UAAU,CAAC,SAAS,EAAE,MAAM;IAU5B,iBAAiB,CAAC,GAAG,CAAC,EAAE,MAAM;IA0D9B,iBAAiB;IAyBjB,aAAa,CAAC,MAAM,EAAE,WAAW;IAMjC,YAAY,CAAC,KAAK,EAAE,UAAU;IAqC9B,UAAU,CAAC,KAAK,EAAE,UAAU;IA2D5B,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IA4BvC,UAAU;IAKV,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IAyBtC,UAAU,CAAC,IAAI,EAAE,SAAS;IAY1B,eAAe,CAAC,OAAO,EAAE,iBAAiB;IAqB1C,cAAc,CAAC,OAAO,EAAE,gBAAgB;IAoBxC,WAAW,CAAC,IAAI,EAAE,SAAS;IA+B3B,SAAS,CAAC,IAAI,EAAE,SAAS;IAkCzB,QAAQ,CAAC,EACL,IAAI,EACJ,KAAK,EACR,EAAE,iBAAiB;IAQpB,OAAO,CAAC,EACJ,IAAI,EACJ,GAAG,EACH,IAAI,GACP,EAAE,gBAAgB;IAQnB,WAAW,CAAC,EACR,EAAE,GACL,EAAE,oBAAoB;IAOvB,QAAQ,CAAC,EACL,SAAS,EACZ,EAAE,iBAAiB;IAOpB,UAAU,CAAC,EACP,WAAW,EACd,EAAE,mBAAmB;IAOtB,WAAW,CAAC,EACR,QAAQ,EACX,EAAE,oBAAoB;IAOvB,OAAO,CAAC,EACJ,QAAQ,GACX,EAAE,gBAAgB;IAOnB,QAAQ,CAAC,EACL,KAAK,GACR,EAAE,iBAAiB;IAOpB,QAAQ,CAAC,EACL,SAAS,GACZ,EAAE,iBAAiB;IAOpB,cAAc,CAAC,EACX,SAAS,GACZ,EAAE,uBAAuB;IAO1B,WAAW,CAAC,EACR,SAAS,GACZ,EAAE,oBAAoB;IAOvB,MAAM,CAAC,EACH,GAAG,GACN,EAAE,eAAe;IAOlB,SAAS,CAAC,EACN,MAAM,EACN,QAAQ,GACX,EAAE,kBAAkB;IAkBrB,QAAQ,CAAC,EACL,KAAK,EACL,QAAQ,GACX,EAAE,iBAAiB;IAkBpB,cAAc,CAAC,EACX,IAAI,EACJ,KAAK,EACR,EAAE,uBAAuB;IAM1B,cAAc,CAAC,EACX,WAAW,EACX,eAAe,EAClB,EAAE,uBAAuB;IAa1B,aAAa,CAAC,EACV,IAAI,EACJ,OAAO,EACP,IAAuB,EAC1B,EAAE,sBAAsB;IAazB,SAAS,CAAC,KAAK,EAAE,MAAM;IAQvB,OAAO,CAAC,MAAM,EAAE,YAAY;IAQ5B,OAAO,CAAC,EACJ,IAAI,EACP,EAAE,GAAG;IAcN,WAAW,CAAC,EACR,IAAI,EACJ,KAAK,EACR,EAAE,GAAG;IAQN,aAAa,CAAC,QAAQ,EAAE,eAAe;IAgDvC;;;OAGG;IACH,MAAM,CAAC,UAAU,oBAAa;IAC9B,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,MAAM,gBAAS;IACtB,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,aAAa,uBAAgB;IACpC,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,IAAI,cAAO;CACrB"}