askui 0.11.6 → 0.12.1

package/dist/esm/execution/dsl.js

@@ -351,11 +351,14 @@ export class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    withText(text) {
+    withText(text, similarityScore = 70) {
         this._textStr = '';
         this._textStr += 'with';
         this._textStr += ' text';
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
+        if (similarityScore !== undefined) {
+            this._textStr += ` that matches to ${similarityScore} %`;
+        }
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -1069,11 +1072,14 @@ export class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    withText(text) {
+    withText(text, similarityScore = 70) {
         this._textStr = '';
         this._textStr += 'with';
         this._textStr += ' text';
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
+        if (similarityScore !== undefined) {
+            this._textStr += ` that matches to ${similarityScore} %`;
+        }
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -2408,11 +2414,14 @@ export class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    withText(text) {
+    withText(text, similarityScore = 70) {
         this._textStr = '';
         this._textStr += 'with';
         this._textStr += ' text';
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
+        if (similarityScore !== undefined) {
+            this._textStr += ` that matches to ${similarityScore} %`;
+        }
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**

package/dist/esm/execution/ui-control-client-dependency-builder.d.ts

@@ -9,6 +9,5 @@ export declare class UiControlClientDependencyBuilder {
         executionRuntime: ExecutionRuntime;
         stepReporter: StepReporter;
     }>;
-    private static buildReporter;
     static getClientArgsWithDefaults(clientArgs: ClientArgs): Promise<ClientArgsWithDefaults>;
 }

package/dist/esm/execution/ui-control-client-dependency-builder.js

@@ -14,7 +14,7 @@ import { envCredentials } from './read-environment-credentials';
 import { Analytics } from '../utils/analytics';
 import { envProxyAgents } from '../utils/proxy/proxy-builder';
 import { ExecutionRuntime } from './execution-runtime';
-import { DEFAULT_REPORTER, StepReporter, } from '../core/reporting';
+import { StepReporter } from '../core/reporting';
 export class UiControlClientDependencyBuilder {
     static buildHttpClient(clientArgs) {
         var _a;
@@ -46,22 +46,10 @@ export class UiControlClientDependencyBuilder {
             };
         });
     }
-    static buildReporter(reporterArg) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-        return {
-            config: {
-                withScreenshots: (_b = (_a = reporterArg === null || reporterArg === void 0 ? void 0 : reporterArg.config) === null || _a === void 0 ? void 0 : _a.withScreenshots) !== null && _b !== void 0 ? _b : DEFAULT_REPORTER.config.withScreenshots,
-                withDetectedElements: (_d = (_c = reporterArg === null || reporterArg === void 0 ? void 0 : reporterArg.config) === null || _c === void 0 ? void 0 : _c.withDetectedElements) !== null && _d !== void 0 ? _d : DEFAULT_REPORTER.config.withDetectedElements,
-            },
-            onStepBegin: (_f = (_e = reporterArg === null || reporterArg === void 0 ? void 0 : reporterArg.onStepBegin) === null || _e === void 0 ? void 0 : _e.bind(reporterArg)) !== null && _f !== void 0 ? _f : DEFAULT_REPORTER.onStepBegin.bind(DEFAULT_REPORTER),
-            onStepRetry: (_h = (_g = reporterArg === null || reporterArg === void 0 ? void 0 : reporterArg.onStepRetry) === null || _g === void 0 ? void 0 : _g.bind(reporterArg)) !== null && _h !== void 0 ? _h : DEFAULT_REPORTER.onStepRetry.bind(DEFAULT_REPORTER),
-            onStepEnd: (_k = (_j = reporterArg === null || reporterArg === void 0 ? void 0 : reporterArg.onStepEnd) === null || _j === void 0 ? void 0 : _j.bind(reporterArg)) !== null && _k !== void 0 ? _k : DEFAULT_REPORTER.onStepEnd.bind(DEFAULT_REPORTER),
-        };
-    }
     static getClientArgsWithDefaults(clientArgs) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            return Object.assign(Object.assign({}, clientArgs), { uiControllerUrl: (_a = clientArgs.uiControllerUrl) !== null && _a !== void 0 ? _a : 'http://127.0.0.1:6769', inferenceServerUrl: (_b = clientArgs.inferenceServerUrl) !== null && _b !== void 0 ? _b : 'https://inference.askui.com', credentials: (_c = clientArgs.credentials) !== null && _c !== void 0 ? _c : envCredentials(), proxyAgents: (_d = clientArgs.proxyAgents) !== null && _d !== void 0 ? _d : yield envProxyAgents(), reporter: UiControlClientDependencyBuilder.buildReporter(clientArgs.reporter) });
+            return Object.assign(Object.assign({}, clientArgs), { uiControllerUrl: (_a = clientArgs.uiControllerUrl) !== null && _a !== void 0 ? _a : 'http://127.0.0.1:6769', inferenceServerUrl: (_b = clientArgs.inferenceServerUrl) !== null && _b !== void 0 ? _b : 'https://inference.askui.com', credentials: (_c = clientArgs.credentials) !== null && _c !== void 0 ? _c : envCredentials(), proxyAgents: (_d = clientArgs.proxyAgents) !== null && _d !== void 0 ? _d : yield envProxyAgents() });
         });
     }
 }

package/dist/esm/execution/ui-controller-client-interface.d.ts

@@ -1,7 +1,7 @@
 import { CredentialArgs } from './credentials-args';
 import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 import { ModelCompositionBranch } from './model-composition-branch';
-import { Reporter, ReporterConfig } from '../core/reporting';
+import { Reporter } from '../core/reporting';
 /**
  * Configuration options for the askui UI Control Client
  *
@@ -21,7 +21,8 @@ import { Reporter, ReporterConfig } from '../core/reporting';
  * the authentication of the askui Inference Server.
  * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
  * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for http(s) requests.
- * @param {Reporter} reporter - To configure the reporter to report on step runs.
+ * @param {Reporter | Reporter[]} reporter - To configure the reporter(s)
+ *  to report on step runs/executions.
  */
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
@@ -30,12 +31,9 @@ export interface ClientArgs {
     readonly proxyAgents?: ProxyAgentArgs | undefined;
     readonly resize?: number;
     readonly modelComposition?: ModelCompositionBranch[];
-    readonly reporter?: Reporter | undefined;
+    readonly reporter?: Reporter | Reporter[] | undefined;
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;
     readonly inferenceServerUrl: string;
-    readonly reporter: Required<Reporter> & {
-        config: Required<ReporterConfig>;
-    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.11.6",
+    "version": "0.12.1",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",
@@ -54,6 +54,7 @@
         "fs-extra": "10.0.0",
         "got": "11.8.6",
         "jsdom": "20.0.0",
+        "lodash": "^4.17.21",
         "node-machine-id": "1.1.12",
         "pino": "7.8.1",
         "pino-pretty": "7.5.3",
@@ -75,6 +76,7 @@
         "@types/ws": "7.4.4",
         "hpagent": "^1.2.0",
         "jest": "28.1.1",
+        "jest-extended": "^4.0.1",
         "proxy": "^1.0.2",
         "proxy-agent": "^5.0.0",
         "sharp": "0.30.6",

package/dist/cjs/core/model/test-case-dto/custom-element-json.d.ts

@@ -1,75 +0,0 @@
-/**
- * Defines a 'custom element'. This is a UI element which is defined by
- * providing an image and other parameters such as degree of rotation.
- * It allows filtering for a UI element that is not recognized
- * by our machine learning models by default.
- * It can also be used for pixel assertions of elements using classical
- * [template matching](https://en.wikipedia.org/wiki/Template_matching).
- *
- * **Important:** The `CustomElementJson` needs to capture as accurately as possible
- * what the custom element looks like during test execution as otherwise
- * our machine learning models cannot find it, even with the additional data
- * provided. This is especially true for the resolution used while cropping
- * the `CustomElementJson.customImage` which should match the resolution during
- * test execution.
- *
- * Rotated custom elements can be filtered for using
- * `CustomElementJson.rotationDegreePerStep`.
- */
-export interface CustomElementJson {
-    /**
-     * An cropped image in form of a base64 string or file path,
-     * e.g., "./custom.png".
-     */
-    customImage: string;
-    /**
-     * A unique name which can be used for filtering for the custom element,
-     * e.g.,
-     * ```typescript
-     * ...customElement({
-     *   name: 'unique-name',
-     *   // ... (rest of the custom element)
-     * }).withText('unique-name')
-     * ```
-     *
-     * If not set, the text inside the custom element is
-     * detected via
-     * [OCR](https://en.wikipedia.org/wiki/Optical_character_recognition).
-     * It can also be used for filtering for the custom element.
-     */
-    name?: string | undefined;
-    /**
-     * A threshold for how similar UI elements shown during test execution
-     * need to be to the custom element as defined by the other fields in
-     * `CustomElementJson` to be recognized as such. Takes values between
-     * `0.0` (= all elements are recognized as the custom element which is
-     * probably not what you want) and `1.0` (= elements need to look exactly
-     * like defined by `CustomElementJson` which is unlikely to be achieved
-     * as even minor differences count). Defaults to `0.9`.
-     */
-    threshold?: number | undefined;
-    /**
-     * A step size in rotation degree. Rotates the custom image by
-     * `rotationDegreePerStep` until 360° is exceeded. Range is between
-     * 0° - 360°. Defaults to 0°.
-     *
-     * **Important**: This increases the prediction time quite a bit. So only use
-     * it when absolutely necessary.
-     */
-    rotationDegreePerStep?: number | undefined;
-    /**
-     * A color compare style. Allows matching a custom element by color, e.g.,
-     * instead of filtering for all icons (blue and green ones),
-     * only the green ones captured by `customImage` are filtered for using 'RGB'.
-     * Defaults to 'grayscale'.
-     *
-     * **Important**: This increases the prediction time quite a bit. So only use
-     * it when absolutely necessary.
-     */
-    imageCompareFormat?: 'RGB' | 'grayscale' | undefined;
-    /** A polygon to match only a certain area of the custom element. */
-    mask?: ({
-        x: number;
-        y: number;
-    })[] | undefined;
-}

package/dist/cjs/core/model/test-case-dto/custom-element-json.js

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

package/dist/cjs/core/model/test-case-dto/custom-element.d.ts

@@ -1,21 +0,0 @@
-import { CustomElementJson } from './custom-element-json';
-export declare class CustomElement implements CustomElementJson {
-    customImage: string;
-    name?: string | undefined;
-    threshold?: number | undefined;
-    rotationDegreePerStep?: number | undefined;
-    imageCompareFormat?: "RGB" | "grayscale" | undefined;
-    mask?: {
-        x: number;
-        y: number;
-    }[] | undefined;
-    private static schema;
-    constructor(customImage: string, name?: string | undefined, threshold?: number | undefined, rotationDegreePerStep?: number | undefined, imageCompareFormat?: "RGB" | "grayscale" | undefined, mask?: {
-        x: number;
-        y: number;
-    }[] | undefined);
-    static fromJsonListWithImagePathOrImage(ceJson?: CustomElementJson[]): Promise<CustomElement[]>;
-    static fromJsonWithImagePathOrImage(ceJson: CustomElementJson): Promise<CustomElement>;
-    static fromJson(ceJson: CustomElementJson): CustomElement;
-    validate(): void;
-}

package/dist/cjs/core/model/test-case-dto/custom-element.js

@@ -1,54 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomElement = void 0;
-const yup_1 = require("yup");
-const base_64_image_1 = require("../../../utils/base_64_image/base-64-image");
-class CustomElement {
-    constructor(customImage, name, threshold, rotationDegreePerStep, imageCompareFormat, mask) {
-        this.customImage = customImage;
-        this.name = name;
-        this.threshold = threshold;
-        this.rotationDegreePerStep = rotationDegreePerStep;
-        this.imageCompareFormat = imageCompareFormat;
-        this.mask = mask;
-    }
-    static fromJsonListWithImagePathOrImage(ceJson = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return Promise.all(ceJson.map((customElement) => CustomElement.fromJsonWithImagePathOrImage(customElement)));
-        });
-    }
-    static fromJsonWithImagePathOrImage(ceJson) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const customImage = (yield base_64_image_1.Base64Image.fromPathOrString(ceJson.customImage)).toString();
-            const customElement = CustomElement.fromJson(Object.assign(Object.assign({}, ceJson), { customImage }));
-            customElement.validate();
-            return customElement;
-        });
-    }
-    static fromJson(ceJson) {
-        return new CustomElement(ceJson.customImage, ceJson.name, ceJson.threshold, ceJson.rotationDegreePerStep, ceJson.imageCompareFormat, ceJson.mask);
-    }
-    validate() {
-        try {
-            CustomElement.schema.validateSync(this, { abortEarly: false, strict: true });
-        }
-        catch (e) { // ValidationError
-            throw new yup_1.ValidationError(e.errors.join(', '));
-        }
-    }
-}
-exports.CustomElement = CustomElement;
-CustomElement.schema = (0, yup_1.object)({
-    threshold: (0, yup_1.number)().optional().min(0).max(1),
-    rotationDegreePerStep: (0, yup_1.number)().optional().min(0).lessThan(360),
-    mask: (0, yup_1.array)().optional().min(3, 'mask must contain at least 3 points'),
-});

package/dist/cjs/core/model/test-case-dto/index.d.ts

@@ -1,3 +0,0 @@
-export { CustomElement } from './custom-element';
-export { CustomElementJson } from './custom-element-json';
-export { TestStep } from './test-step';

package/dist/cjs/core/model/test-case-dto/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomElement = void 0;
-var custom_element_1 = require("./custom-element");
-Object.defineProperty(exports, "CustomElement", { enumerable: true, get: function () { return custom_element_1.CustomElement; } });

package/dist/cjs/core/model/test-case-dto/test-step.d.ts

@@ -1,6 +0,0 @@
-import { CustomElement } from './custom-element';
-export interface TestStep {
-    instruction: string;
-    customElements?: CustomElement[];
-    secretText?: string | undefined;
-}

package/dist/cjs/core/model/test-case-dto/test-step.js

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

package/dist/cjs/core/model/test-case-result-dto/index.d.ts

@@ -1,2 +0,0 @@
-export { TestStepResultDto } from './test-step-result-dto';
-export { TestStepState } from './test-step-state';

package/dist/cjs/core/model/test-case-result-dto/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStepState = exports.TestStepResultDto = void 0;
-var test_step_result_dto_1 = require("./test-step-result-dto");
-Object.defineProperty(exports, "TestStepResultDto", { enumerable: true, get: function () { return test_step_result_dto_1.TestStepResultDto; } });
-var test_step_state_1 = require("./test-step-state");
-Object.defineProperty(exports, "TestStepState", { enumerable: true, get: function () { return test_step_state_1.TestStepState; } });

package/dist/cjs/core/model/test-case-result-dto/test-step-result-dto.d.ts

@@ -1,9 +0,0 @@
-import { TestStepState } from './test-step-state';
-export declare class TestStepResultDto {
-    state: TestStepState;
-    comment: string;
-    createDate: Date;
-    updateDate: Date;
-    constructor(state: TestStepState, comment?: string, createDate?: Date, updateDate?: Date);
-    static fromJson(testStepResult: TestStepResultDto): TestStepResultDto;
-}

package/dist/cjs/core/model/test-case-result-dto/test-step-result-dto.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStepResultDto = void 0;
-const test_step_state_1 = require("./test-step-state");
-class TestStepResultDto {
-    constructor(state, comment = '', createDate = new Date(), updateDate = new Date()) {
-        this.state = state;
-        this.comment = comment;
-        this.createDate = createDate;
-        this.updateDate = updateDate;
-    }
-    static fromJson(testStepResult) {
-        return new TestStepResultDto(test_step_state_1.TestStepState[testStepResult.state], testStepResult.comment, new Date(testStepResult.createDate), new Date(testStepResult.updateDate));
-    }
-}
-exports.TestStepResultDto = TestStepResultDto;

package/dist/cjs/core/model/test-case-result-dto/test-step-state.d.ts

@@ -1,4 +0,0 @@
-export declare enum TestStepState {
-    PASSED = "PASSED",
-    FAILED = "FAILED"
-}

package/dist/cjs/core/model/test-case-result-dto/test-step-state.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStepState = void 0;
-var TestStepState;
-(function (TestStepState) {
-    TestStepState["PASSED"] = "PASSED";
-    TestStepState["FAILED"] = "FAILED";
-})(TestStepState = exports.TestStepState || (exports.TestStepState = {}));

package/dist/cjs/core/reporting/default-reporter.d.ts

@@ -1,10 +0,0 @@
-import { Step } from './step';
-export declare const DEFAULT_REPORTER: {
-    config: {
-        readonly withScreenshots: "onFailure";
-        readonly withDetectedElements: "onFailure";
-    };
-    onStepBegin: (_step: Step) => Promise<void>;
-    onStepRetry: (_step: Step) => Promise<void>;
-    onStepEnd: (_step: Step) => Promise<void>;
-};

package/dist/cjs/core/reporting/default-reporter.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_REPORTER = void 0;
-exports.DEFAULT_REPORTER = {
-    config: {
-        withScreenshots: 'onFailure',
-        withDetectedElements: 'onFailure',
-    },
-    onStepBegin: (_step) => Promise.resolve(),
-    onStepRetry: (_step) => Promise.resolve(),
-    onStepEnd: (_step) => Promise.resolve(),
-};

package/dist/cjs/execution/annotation-level.d.ts

@@ -1,5 +0,0 @@
-export declare enum AnnotationLevel {
-    DISABLED = "disabled",
-    ON_FAILURE = "onFailure",
-    ALL = "all"
-}

package/dist/cjs/execution/annotation-level.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnnotationLevel = void 0;
-var AnnotationLevel;
-(function (AnnotationLevel) {
-    AnnotationLevel["DISABLED"] = "disabled";
-    AnnotationLevel["ON_FAILURE"] = "onFailure";
-    AnnotationLevel["ALL"] = "all";
-})(AnnotationLevel = exports.AnnotationLevel || (exports.AnnotationLevel = {}));

package/dist/cjs/execution/reporter.d.ts

@@ -1,132 +0,0 @@
-import { DetectedElement } from "@/core/model/annotation-result/detected-element";
-import { CustomElement } from "@/core/model/custom-element";
-export interface Snapshot {
-    readonly createdAt: Date;
-    readonly screenshot?: string | undefined;
-    readonly detectedElements?: Readonly<Readonly<DetectedElement>>[] | undefined;
-}
-export interface Instruction {
-    readonly value: string;
-    readonly valueHumanReadable: string;
-    readonly customElements?: Readonly<Readonly<CustomElement>>[];
-    readonly secretText?: string | undefined;
-}
-export interface Step {
-    readonly instruction: Readonly<Instruction>;
-    readonly status: StepStatus;
-    /**
-     * A snapshot of the state of the screen before the step is ran which is nearly immediately after the call to `.exec()`
-     */
-    readonly begin?: Snapshot | undefined;
-    /**
-     * The duration of the step in milliseconds based on the start and end time. If the step is still running, this property is undefined.
-     */
-    readonly duration?: number | undefined;
-    /**
-     * A snapshot of the state of the screen after the step has been run. If the step is still running or still pending, this property is undefined.
-     */
-    readonly end?: Snapshot | undefined;
-    /**
-     * When a step failed or is erroneous, this property contains the error.
-     */
-    readonly error?: Error | undefined;
-    readonly runs: Readonly<StepRun[]>;
-    readonly retries: Readonly<StepRun[]>;
-    readonly retryCount: number;
-    readonly firstRun?: StepRun | undefined;
-    readonly lastRun?: StepRun | undefined;
-    /**
-     * retryCount > 0.
-     */
-    readonly flaky: boolean;
-}
-export interface StepRun {
-    readonly status: StepStatus;
-    readonly begin?: Snapshot | undefined;
-    readonly end?: Snapshot | undefined;
-    readonly duration?: number | undefined;
-    readonly error?: Error | undefined;
-}
-declare class askuiStep implements Step {
-    instruction: Instruction;
-    runs: Readonly<StepRun[]>;
-    constructor(instruction: Instruction);
-    get status(): StepStatus;
-    get begin(): Snapshot | undefined;
-    get end(): Snapshot | undefined;
-    get error(): Error | undefined;
-    get retries(): StepRun[];
-    get retryCount(): number;
-    get firstRun(): StepRun | undefined;
-    get lastRun(): StepRun | undefined;
-    get flaky(): boolean;
-    get duration(): number | undefined;
-    onBegin(snapshot: Snapshot): askuiStep;
-    onRetry(snapshot: Snapshot, error: Error): askuiStep;
-    onEnd(snapshot: Snapshot, error?: Error): askuiStep;
-    private determineLastRunStatus;
-}
-/**
- * - `passed`: the step passed
- * - `failed`: the step failed because of a failed (implicit/explicit) assertion, e.g., an element could not be found
- * - `pending`: the step is waiting for a previous step to pass
- * - `running`: the step is currently running (including retries)
- * - `skipped`: the step was skipped, e.g., because a previous step failed or because workflow was skipped
- * - `erroneous`: the step could not be run because of a runtime error, e.g., the user has no usage left, response of inference backend cannot be processed, e.g., because lib version is outdated, etc. (currently not supported, everything "failed")
- */
-export declare type StepStatus = 'passed' | 'failed' | 'pending' | 'running' | 'erroneous';
-export declare type StepStatusEnd = 'passed' | 'failed' | 'erroneous';
-/**
- * Can be used to report on a step run.
- *
- * The reporter is an interface (instead of a class) so that the it may be implemented by a class that already extends another class, e.g., the reporter of a test framework.
- */
-export interface Reporter {
-    config?: ReporterConfig;
-    onStepBegin?(step: Step): Promise<void>;
-    onStepRetry?(step: Step): Promise<void>;
-    onStepEnd?(step: Step): Promise<void>;
-}
-export declare type SnapshotDetailLevel = 
-/**
- * Details of snapshot, e.g., screenshot or detected elements, may or may not be available depending on if they are required by the step. There are not guarantees made.
- */
-'required' | 
-/**
- * Details are available when the step fails, e.g., for debugging. Includes everything of required.
- */
-'onFailure' | 
-/**
- * Details are available also when the command is started, e.g., for detecting why a certain element was interacted with. Includes everything of onFailure.
- */
-'begin' | 
-/**
- * Details are available always, e.g., before and after a step has been run no matter if it failed or not for debugging.
- */
-'always';
-export interface ReporterConfig {
-    withScreenshots?: SnapshotDetailLevel;
-    withDetectedElements?: SnapshotDetailLevel;
-}
-export declare const DEFAULT_REPORTER: {
-    config: {
-        readonly withScreenshots: "onFailure";
-        readonly withDetectedElements: "onFailure";
-    };
-    onStepBegin: (_step: Step) => Promise<void>;
-    onStepRetry: (_step: Step) => Promise<void>;
-    onStepEnd: (_step: Step) => Promise<void>;
-};
-export declare class StepReporter {
-    private reporter;
-    currentStep?: askuiStep | undefined;
-    constructor(reporter: Required<Reporter> & {
-        config: Required<ReporterConfig>;
-    });
-    get config(): Required<ReporterConfig>;
-    resetStep(instruction: Instruction): void;
-    onStepBegin(snapshot: Snapshot): Promise<void>;
-    onStepRetry(snapshot: Snapshot, error: Error): Promise<void>;
-    onStepEnd(snapshot: Snapshot, error?: Error): Promise<void>;
-}
-export {};