askui 0.10.5 → 0.11.1

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultStep = void 0;
+const control_command_error_1 = require("../../execution/control-command-error");
 class DefaultStep {
     constructor(instruction) {
         this.instruction = instruction;
@@ -66,9 +67,12 @@ class DefaultStep {
         return this;
     }
     static determineLastRunStatus(error) {
-        if (error !== undefined) {
+        if (error instanceof control_command_error_1.ControlCommandError) {
             return 'failed';
         }
+        if (error !== undefined) {
+            return 'erroneous';
+        }
         return 'passed';
     }
 }

package/dist/cjs/core/reporting/instruction.d.ts

@@ -1,4 +1,4 @@
-import { CustomElement } from '@/core/model/custom-element';
+import { CustomElement } from '../model/custom-element';
 export interface Instruction {
     readonly value: string;
     readonly valueHumanReadable: string;

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

@@ -104,7 +104,15 @@ export declare class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    col(index: number): FluentFiltersOrRelations;
+    column(index: number): FluentFiltersOrRelations;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelations;
     /**
      *
      * @return {FluentFiltersOrRelations}
@@ -652,7 +660,15 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    col(index: number): FluentFiltersOrRelationsCondition;
+    column(index: number): FluentFiltersOrRelationsCondition;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelationsCondition;
     /**
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -1645,7 +1661,15 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    col(index: number): FluentFiltersOrRelationsGetter;
+    column(index: number): FluentFiltersOrRelationsGetter;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelationsGetter;
     /**
      *
      * @return {FluentFiltersOrRelationsGetter}

package/dist/cjs/execution/dsl.js

@@ -175,12 +175,28 @@ class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelations(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelations(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelations}
@@ -879,12 +895,28 @@ class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelationsCondition(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelationsCondition(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -2206,12 +2238,28 @@ class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelationsGetter(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelationsGetter}

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

@@ -1,2 +1 @@
-export { AnnotationLevel } from './annotation-level';
 export { UiControlClient } from './ui-control-client';

package/dist/cjs/execution/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UiControlClient = exports.AnnotationLevel = void 0;
-var annotation_level_1 = require("./annotation-level");
-Object.defineProperty(exports, "AnnotationLevel", { enumerable: true, get: function () { return annotation_level_1.AnnotationLevel; } });
+exports.UiControlClient = void 0;
 var ui_control_client_1 = require("./ui-control-client");
 Object.defineProperty(exports, "UiControlClient", { enumerable: true, get: function () { return ui_control_client_1.UiControlClient; } });

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

@@ -16,7 +16,6 @@ const inference_client_1 = require("./inference-client");
 const read_environment_credentials_1 = require("./read-environment-credentials");
 const analytics_1 = require("../utils/analytics");
 const proxy_builder_1 = require("../utils/proxy/proxy-builder");
-const annotation_level_1 = require("./annotation-level");
 const execution_runtime_1 = require("./execution-runtime");
 const reporting_1 = require("../core/reporting");
 class UiControlClientDependencyBuilder {
@@ -63,9 +62,9 @@ class UiControlClientDependencyBuilder {
         };
     }
     static getClientArgsWithDefaults(clientArgs) {
-        var _a, _b, _c, _d, _e;
+        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', annotationLevel: (_c = clientArgs.annotationLevel) !== null && _c !== void 0 ? _c : annotation_level_1.AnnotationLevel.DISABLED, credentials: (_d = clientArgs.credentials) !== null && _d !== void 0 ? _d : (0, read_environment_credentials_1.envCredentials)(), proxyAgents: (_e = clientArgs.proxyAgents) !== null && _e !== void 0 ? _e : yield (0, proxy_builder_1.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 : (0, read_environment_credentials_1.envCredentials)(), proxyAgents: (_d = clientArgs.proxyAgents) !== null && _d !== void 0 ? _d : yield (0, proxy_builder_1.envProxyAgents)(), reporter: UiControlClientDependencyBuilder.buildReporter(clientArgs.reporter) });
         });
     }
 }

package/dist/cjs/execution/ui-control-client.d.ts

@@ -6,7 +6,6 @@ import { AnnotationRequest } from '../core/model/annotation-result/annotation-in
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ClientArgs } from './ui-controller-client-interface';
 export declare class UiControlClient extends ApiCommands {
-    private config;
     private executionRuntime;
     private stepReporter;
     private constructor();
@@ -28,7 +27,6 @@ export declare class UiControlClient extends ApiCommands {
     startVideoRecording(): Promise<void>;
     stopVideoRecording(): Promise<void>;
     readVideoRecording(): Promise<string>;
-    private shouldWriteAnntotationAfterCommandExecution;
     private shouldAnnotateAfterCommandExecution;
     private afterCommandExecution;
     annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;

package/dist/cjs/execution/ui-control-client.js

@@ -14,13 +14,10 @@ const custom_element_1 = require("../core/model/custom-element");
 const dsl_1 = require("./dsl");
 const annotation_writer_1 = require("../core/annotation/annotation-writer");
 const logger_1 = require("../lib/logger");
-const annotation_level_1 = require("./annotation-level");
-const ui_control_client_error_1 = require("./ui-control-client-error");
 const ui_control_client_dependency_builder_1 = require("./ui-control-client-dependency-builder");
 class UiControlClient extends dsl_1.ApiCommands {
-    constructor(config, executionRuntime, stepReporter) {
+    constructor(executionRuntime, stepReporter) {
         super();
-        this.config = config;
         this.executionRuntime = executionRuntime;
         this.stepReporter = stepReporter;
         this.secretText = undefined;
@@ -30,9 +27,7 @@ class UiControlClient extends dsl_1.ApiCommands {
             const builder = ui_control_client_dependency_builder_1.UiControlClientDependencyBuilder;
             const clientArgsWithDefaults = yield builder.getClientArgsWithDefaults(clientArgs);
             const { executionRuntime, stepReporter } = yield builder.build(clientArgsWithDefaults);
-            return new UiControlClient({
-                annotationLevel: clientArgsWithDefaults.annotationLevel,
-            }, executionRuntime, stepReporter);
+            return new UiControlClient(executionRuntime, stepReporter);
         });
     }
     /**
@@ -72,14 +67,8 @@ class UiControlClient extends dsl_1.ApiCommands {
             return this.executionRuntime.readVideoRecording();
         });
     }
-    shouldWriteAnntotationAfterCommandExecution(error) {
-        const { annotationLevel } = this.config;
-        return annotationLevel === annotation_level_1.AnnotationLevel.ALL
-            || (annotationLevel === annotation_level_1.AnnotationLevel.ON_FAILURE && error !== undefined);
-    }
     shouldAnnotateAfterCommandExecution(error) {
-        return this.shouldWriteAnntotationAfterCommandExecution(error)
-            || (this.stepReporter.config.withDetectedElements === 'onFailure' && error !== undefined)
+        return (this.stepReporter.config.withDetectedElements === 'onFailure' && error !== undefined)
             || (this.stepReporter.config.withDetectedElements === 'always');
     }
     afterCommandExecution(instruction, error) {
@@ -91,9 +80,6 @@ class UiControlClient extends dsl_1.ApiCommands {
             if (this.shouldAnnotateAfterCommandExecution(error)) {
                 annotation = yield this.executionRuntime.annotateImage(undefined, instruction.customElements);
             }
-            if (annotation !== undefined && this.shouldWriteAnntotationAfterCommandExecution(error)) {
-                annotation_writer_1.AnnotationWriter.write(annotation.toHtml(), undefined, `${error !== undefined ? 'failed' : 'passed'}_testStep_annotation`);
-            }
             if (annotation !== undefined || this.stepReporter.config.withScreenshots === 'always') {
                 screenshot = (_a = annotation === null || annotation === void 0 ? void 0 : annotation.image) !== null && _a !== void 0 ? _a : yield this.executionRuntime.getScreenshot();
             }
@@ -147,7 +133,7 @@ class UiControlClient extends dsl_1.ApiCommands {
             }
             catch (error) {
                 yield this.afterCommandExecution(instruction, error instanceof Error ? error : new Error(String(error)));
-                return Promise.reject(new ui_control_client_error_1.UiControlClientError(`A problem occurred while executing the instruction: ${instruction.valueHumanReadable}. Reason ${error}`));
+                return Promise.reject(error);
             }
         });
     }

package/dist/cjs/execution/ui-controller-client-error.d.ts

@@ -0,0 +1,3 @@
+export declare class UiControllerClientError extends Error {
+    constructor(message: string);
+}

package/dist/cjs/execution/ui-controller-client-error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiControllerClientError = void 0;
+class UiControllerClientError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UiControllerClientError';
+    }
+}
+exports.UiControllerClientError = UiControllerClientError;

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

@@ -1,8 +1,7 @@
-import { AnnotationLevel } from './annotation-level';
 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, ReporterConfig } from '../core/reporting';
 /**
  * Configuration options for the askui UI Control Client
  *
@@ -18,10 +17,6 @@ import { Reporter, ReporterConfig } from '@/core/reporting';
  * But it can cause a decrease in the prediction quality.
  * @param {string} inferenceServerUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.
- * @param {AnnotationLevel} annotationLevel - Default: AnnotationLevel.DISABLED
- * Usage of annotate command
- * after execution of test steps.
- * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
  * @param {CredentialArgs} credentials - We need to provide credentials for
  * the authentication of the askui Inference Server.
  * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
@@ -31,7 +26,6 @@ import { Reporter, ReporterConfig } from '@/core/reporting';
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
     readonly inferenceServerUrl?: string;
-    readonly annotationLevel?: AnnotationLevel;
     readonly credentials?: CredentialArgs | undefined;
     readonly proxyAgents?: ProxyAgentArgs | undefined;
     readonly resize?: number;
@@ -41,11 +35,7 @@ export interface ClientArgs {
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;
     readonly inferenceServerUrl: string;
-    readonly annotationLevel: AnnotationLevel;
     readonly reporter: Required<Reporter> & {
         config: Required<ReporterConfig>;
     };
 }
-export interface UiControlClientConfig {
-    annotationLevel: AnnotationLevel;
-}

package/dist/cjs/execution/ui-controller-client.js

@@ -9,7 +9,7 @@ const runner_protocol_1 = require("../core/runner-protocol");
 const logger_1 = require("../lib/logger");
 const ui_controller_client_connection_state_1 = require("./ui-controller-client-connection-state");
 const read_recording_response_stream_handler_1 = require("./read-recording-response-stream-handler");
-const ui_control_client_error_1 = require("./ui-control-client-error");
+const ui_controller_client_error_1 = require("./ui-controller-client-error");
 class UiControllerClient {
     constructor(url) {
         this.url = url;
@@ -47,13 +47,13 @@ class UiControllerClient {
                 });
                 this.ws.on('error', (error) => {
                     this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.ERROR;
-                    reject(new ui_control_client_error_1.UiControlClientError(`Connection to UI Controller cannot be established,
+                    reject(new ui_controller_client_error_1.UiControllerClientError(`Connection to UI Controller cannot be established,
           Probably it was not started. Make sure you started UI Controller with this 
-          Url ${this.url}. Error message  ${error.message}`));
+          Url ${this.url}. Cause: ${error}`));
                 });
             }
             catch (error) {
-                reject(new ui_control_client_error_1.UiControlClientError(`Connection to UI Controller cannot be established. Reason: ${error}`));
+                reject(new ui_controller_client_error_1.UiControllerClientError(`Connection to UI Controller cannot be established. Cause: ${error}`));
             }
         });
     }
@@ -67,17 +67,16 @@ class UiControllerClient {
             this.currentReject = reject;
             try {
                 this.send(msg, requestTimeout);
-                this.timeout = setTimeout(() => this.currentReject(`Request to UI Controller timed out.
-          It seems that the UI Controller is not running. Please, make sure that it is running when executing tests.`), UiControllerClient.REQUEST_TIMEOUT_IN_MS);
+                this.timeout = setTimeout(() => this.currentReject(new ui_controller_client_error_1.UiControllerClientError('Request to UI Controller timed out. It seems that the UI Controller is not running. Please, make sure that it is running when executing tests.')), UiControllerClient.REQUEST_TIMEOUT_IN_MS);
             }
             catch (error) {
-                this.currentReject(`The communication to the UI Controller is broken. Reason: ${error}`);
+                this.currentReject(new ui_controller_client_error_1.UiControllerClientError(`The communication to the UI Controller is broken. Cause: ${error}`));
             }
         });
     }
     send(msg, _requestTimeout = UiControllerClient.REQUEST_TIMEOUT_IN_MS) {
         if (!this.currentReject || !this.currentResolve) {
-            throw Error('Request is not finished! It is not possible to have multiple requests at the same time.');
+            throw new ui_controller_client_error_1.UiControllerClientError('Request is not finished! It is not possible to have multiple requests at the same time.');
         }
         logger_1.logger.debug(`Send: ${JSON.stringify(msg.msgName)}`);
         this.ws.send(JSON.stringify(msg));

package/dist/cjs/lib/download-binaries.js

@@ -54,7 +54,7 @@ function getBinaryFilePath(version) {
 }
 exports.getBinaryFilePath = getBinaryFilePath;
 function getBinaryDownloadUrl(binaryVersion) {
-    const baseUrl = `https://askui-public.s3.eu-central-1.amazonaws.com/releases/askui-ui-controller/${binaryVersion}`;
+    const baseUrl = `https://files.askui.com/releases/askui-ui-controller/${binaryVersion}`;
     const arch = os_1.default.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }

package/dist/cjs/main.d.ts

@@ -1,4 +1,6 @@
 export { UiController } from './lib';
-export { AnnotationLevel, UiControlClient } from './execution';
+export { UiControlClient } from './execution';
 export { Instruction, Reporter, ReporterConfig, Snapshot, SnapshotDetailLevel, Step, StepStatus, StepStatusEnd, } from './core/reporting';
+export { Annotation } from './core/annotation/annotation';
+export { DetectedElement } from './core/model/annotation-result/detected-element';
 export { LogLevels } from './shared';

package/dist/cjs/main.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevels = exports.UiControlClient = exports.AnnotationLevel = exports.UiController = void 0;
+exports.LogLevels = exports.DetectedElement = exports.Annotation = exports.UiControlClient = exports.UiController = void 0;
 var lib_1 = require("./lib");
 Object.defineProperty(exports, "UiController", { enumerable: true, get: function () { return lib_1.UiController; } });
 var execution_1 = require("./execution");
-Object.defineProperty(exports, "AnnotationLevel", { enumerable: true, get: function () { return execution_1.AnnotationLevel; } });
 Object.defineProperty(exports, "UiControlClient", { enumerable: true, get: function () { return execution_1.UiControlClient; } });
+var annotation_1 = require("./core/annotation/annotation");
+Object.defineProperty(exports, "Annotation", { enumerable: true, get: function () { return annotation_1.Annotation; } });
+var detected_element_1 = require("./core/model/annotation-result/detected-element");
+Object.defineProperty(exports, "DetectedElement", { enumerable: true, get: function () { return detected_element_1.DetectedElement; } });
 var shared_1 = require("./shared");
 Object.defineProperty(exports, "LogLevels", { enumerable: true, get: function () { return shared_1.LogLevels; } });

package/dist/esm/core/reporting/default-step.js

@@ -1,3 +1,4 @@
+import { ControlCommandError } from '../../execution/control-command-error';
 export class DefaultStep {
     constructor(instruction) {
         this.instruction = instruction;
@@ -63,9 +64,12 @@ export class DefaultStep {
         return this;
     }
     static determineLastRunStatus(error) {
-        if (error !== undefined) {
+        if (error instanceof ControlCommandError) {
             return 'failed';
         }
+        if (error !== undefined) {
+            return 'erroneous';
+        }
         return 'passed';
     }
 }

package/dist/esm/core/reporting/instruction.d.ts

@@ -1,4 +1,4 @@
-import { CustomElement } from '@/core/model/custom-element';
+import { CustomElement } from '../model/custom-element';
 export interface Instruction {
     readonly value: string;
     readonly valueHumanReadable: string;

package/dist/esm/execution/dsl.d.ts

@@ -104,7 +104,15 @@ export declare class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    col(index: number): FluentFiltersOrRelations;
+    column(index: number): FluentFiltersOrRelations;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelations;
     /**
      *
      * @return {FluentFiltersOrRelations}
@@ -652,7 +660,15 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    col(index: number): FluentFiltersOrRelationsCondition;
+    column(index: number): FluentFiltersOrRelationsCondition;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelationsCondition;
     /**
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -1645,7 +1661,15 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    col(index: number): FluentFiltersOrRelationsGetter;
+    column(index: number): FluentFiltersOrRelationsGetter;
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    cell(row_index: number, column_index: number): FluentFiltersOrRelationsGetter;
     /**
      *
      * @return {FluentFiltersOrRelationsGetter}

package/dist/esm/execution/dsl.js

@@ -171,12 +171,28 @@ export class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelations(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelations(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelations}
@@ -873,12 +889,28 @@ export class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelationsCondition(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelationsCondition(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -2196,12 +2228,28 @@ export class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    col(index) {
+    column(index) {
         this._textStr = '';
-        this._textStr += 'col';
+        this._textStr += 'column';
         this._textStr += ` ${index}`;
         return new FluentFiltersOrRelationsGetter(this);
     }
+    /**
+     *
+     * @param {number} row_index - row index
+     * @param {number} column_index - column index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    cell(row_index, column_index) {
+        this._textStr = '';
+        this._textStr += 'cell';
+        this._textStr += ' row';
+        this._textStr += ` ${row_index}`;
+        this._textStr += ' column';
+        this._textStr += ` ${column_index}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
     /**
      *
      * @return {FluentFiltersOrRelationsGetter}

package/dist/esm/execution/index.d.ts

@@ -1,2 +1 @@
-export { AnnotationLevel } from './annotation-level';
 export { UiControlClient } from './ui-control-client';

package/dist/esm/execution/index.js

@@ -1,2 +1 @@
-export { AnnotationLevel } from './annotation-level';
 export { UiControlClient } from './ui-control-client';

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

@@ -13,7 +13,6 @@ import { InferenceClient } from './inference-client';
 import { envCredentials } from './read-environment-credentials';
 import { Analytics } from '../utils/analytics';
 import { envProxyAgents } from '../utils/proxy/proxy-builder';
-import { AnnotationLevel } from './annotation-level';
 import { ExecutionRuntime } from './execution-runtime';
 import { DEFAULT_REPORTER, StepReporter, } from '../core/reporting';
 export class UiControlClientDependencyBuilder {
@@ -60,9 +59,9 @@ export class UiControlClientDependencyBuilder {
         };
     }
     static getClientArgsWithDefaults(clientArgs) {
-        var _a, _b, _c, _d, _e;
+        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', annotationLevel: (_c = clientArgs.annotationLevel) !== null && _c !== void 0 ? _c : AnnotationLevel.DISABLED, credentials: (_d = clientArgs.credentials) !== null && _d !== void 0 ? _d : envCredentials(), proxyAgents: (_e = clientArgs.proxyAgents) !== null && _e !== void 0 ? _e : 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(), reporter: UiControlClientDependencyBuilder.buildReporter(clientArgs.reporter) });
         });
     }
 }

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

@@ -1,2 +1,3 @@
 export declare class UiControlClientError extends Error {
+    constructor(message: string);
 }

package/dist/esm/execution/ui-control-client-error.js

@@ -1,2 +1,6 @@
 export class UiControlClientError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UiControlClientError';
+    }
 }

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

@@ -6,7 +6,6 @@ import { AnnotationRequest } from '../core/model/annotation-result/annotation-in
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ClientArgs } from './ui-controller-client-interface';
 export declare class UiControlClient extends ApiCommands {
-    private config;
     private executionRuntime;
     private stepReporter;
     private constructor();
@@ -28,7 +27,6 @@ export declare class UiControlClient extends ApiCommands {
     startVideoRecording(): Promise<void>;
     stopVideoRecording(): Promise<void>;
     readVideoRecording(): Promise<string>;
-    private shouldWriteAnntotationAfterCommandExecution;
     private shouldAnnotateAfterCommandExecution;
     private afterCommandExecution;
     annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;

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

@@ -11,13 +11,10 @@ import { CustomElement } from '../core/model/custom-element';
 import { ApiCommands, Separators, } from './dsl';
 import { AnnotationWriter } from '../core/annotation/annotation-writer';
 import { logger } from '../lib/logger';
-import { AnnotationLevel } from './annotation-level';
-import { UiControlClientError } from './ui-control-client-error';
 import { UiControlClientDependencyBuilder } from './ui-control-client-dependency-builder';
 export class UiControlClient extends ApiCommands {
-    constructor(config, executionRuntime, stepReporter) {
+    constructor(executionRuntime, stepReporter) {
         super();
-        this.config = config;
         this.executionRuntime = executionRuntime;
         this.stepReporter = stepReporter;
         this.secretText = undefined;
@@ -27,9 +24,7 @@ export class UiControlClient extends ApiCommands {
             const builder = UiControlClientDependencyBuilder;
             const clientArgsWithDefaults = yield builder.getClientArgsWithDefaults(clientArgs);
             const { executionRuntime, stepReporter } = yield builder.build(clientArgsWithDefaults);
-            return new UiControlClient({
-                annotationLevel: clientArgsWithDefaults.annotationLevel,
-            }, executionRuntime, stepReporter);
+            return new UiControlClient(executionRuntime, stepReporter);
         });
     }
     /**
@@ -69,14 +64,8 @@ export class UiControlClient extends ApiCommands {
             return this.executionRuntime.readVideoRecording();
         });
     }
-    shouldWriteAnntotationAfterCommandExecution(error) {
-        const { annotationLevel } = this.config;
-        return annotationLevel === AnnotationLevel.ALL
-            || (annotationLevel === AnnotationLevel.ON_FAILURE && error !== undefined);
-    }
     shouldAnnotateAfterCommandExecution(error) {
-        return this.shouldWriteAnntotationAfterCommandExecution(error)
-            || (this.stepReporter.config.withDetectedElements === 'onFailure' && error !== undefined)
+        return (this.stepReporter.config.withDetectedElements === 'onFailure' && error !== undefined)
             || (this.stepReporter.config.withDetectedElements === 'always');
     }
     afterCommandExecution(instruction, error) {
@@ -88,9 +77,6 @@ export class UiControlClient extends ApiCommands {
             if (this.shouldAnnotateAfterCommandExecution(error)) {
                 annotation = yield this.executionRuntime.annotateImage(undefined, instruction.customElements);
             }
-            if (annotation !== undefined && this.shouldWriteAnntotationAfterCommandExecution(error)) {
-                AnnotationWriter.write(annotation.toHtml(), undefined, `${error !== undefined ? 'failed' : 'passed'}_testStep_annotation`);
-            }
             if (annotation !== undefined || this.stepReporter.config.withScreenshots === 'always') {
                 screenshot = (_a = annotation === null || annotation === void 0 ? void 0 : annotation.image) !== null && _a !== void 0 ? _a : yield this.executionRuntime.getScreenshot();
             }
@@ -144,7 +130,7 @@ export class UiControlClient extends ApiCommands {
             }
             catch (error) {
                 yield this.afterCommandExecution(instruction, error instanceof Error ? error : new Error(String(error)));
-                return Promise.reject(new UiControlClientError(`A problem occurred while executing the instruction: ${instruction.valueHumanReadable}. Reason ${error}`));
+                return Promise.reject(error);
             }
         });
     }

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

@@ -0,0 +1,3 @@
+export declare class UiControllerClientError extends Error {
+    constructor(message: string);
+}

package/dist/esm/execution/ui-controller-client-error.js

@@ -0,0 +1,6 @@
+export class UiControllerClientError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UiControllerClientError';
+    }
+}

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

@@ -1,8 +1,7 @@
-import { AnnotationLevel } from './annotation-level';
 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, ReporterConfig } from '../core/reporting';
 /**
  * Configuration options for the askui UI Control Client
  *
@@ -18,10 +17,6 @@ import { Reporter, ReporterConfig } from '@/core/reporting';
  * But it can cause a decrease in the prediction quality.
  * @param {string} inferenceServerUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.
- * @param {AnnotationLevel} annotationLevel - Default: AnnotationLevel.DISABLED
- * Usage of annotate command
- * after execution of test steps.
- * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
  * @param {CredentialArgs} credentials - We need to provide credentials for
  * the authentication of the askui Inference Server.
  * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
@@ -31,7 +26,6 @@ import { Reporter, ReporterConfig } from '@/core/reporting';
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
     readonly inferenceServerUrl?: string;
-    readonly annotationLevel?: AnnotationLevel;
     readonly credentials?: CredentialArgs | undefined;
     readonly proxyAgents?: ProxyAgentArgs | undefined;
     readonly resize?: number;
@@ -41,11 +35,7 @@ export interface ClientArgs {
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;
     readonly inferenceServerUrl: string;
-    readonly annotationLevel: AnnotationLevel;
     readonly reporter: Required<Reporter> & {
         config: Required<ReporterConfig>;
     };
 }
-export interface UiControlClientConfig {
-    annotationLevel: AnnotationLevel;
-}

package/dist/esm/execution/ui-controller-client.js

@@ -3,7 +3,7 @@ import { CaptureScreenshotRequest, ControlRequest, StartRecordingRequest, StopRe
 import { logger } from '../lib/logger';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 import { ReadRecordingResponseStreamHandler } from './read-recording-response-stream-handler';
-import { UiControlClientError } from './ui-control-client-error';
+import { UiControllerClientError } from './ui-controller-client-error';
 export class UiControllerClient {
     constructor(url) {
         this.url = url;
@@ -41,13 +41,13 @@ export class UiControllerClient {
                 });
                 this.ws.on('error', (error) => {
                     this.connectionState = UiControllerClientConnectionState.ERROR;
-                    reject(new UiControlClientError(`Connection to UI Controller cannot be established,
+                    reject(new UiControllerClientError(`Connection to UI Controller cannot be established,
           Probably it was not started. Make sure you started UI Controller with this 
-          Url ${this.url}. Error message  ${error.message}`));
+          Url ${this.url}. Cause: ${error}`));
                 });
             }
             catch (error) {
-                reject(new UiControlClientError(`Connection to UI Controller cannot be established. Reason: ${error}`));
+                reject(new UiControllerClientError(`Connection to UI Controller cannot be established. Cause: ${error}`));
             }
         });
     }
@@ -61,17 +61,16 @@ export class UiControllerClient {
             this.currentReject = reject;
             try {
                 this.send(msg, requestTimeout);
-                this.timeout = setTimeout(() => this.currentReject(`Request to UI Controller timed out.
-          It seems that the UI Controller is not running. Please, make sure that it is running when executing tests.`), UiControllerClient.REQUEST_TIMEOUT_IN_MS);
+                this.timeout = setTimeout(() => this.currentReject(new UiControllerClientError('Request to UI Controller timed out. It seems that the UI Controller is not running. Please, make sure that it is running when executing tests.')), UiControllerClient.REQUEST_TIMEOUT_IN_MS);
             }
             catch (error) {
-                this.currentReject(`The communication to the UI Controller is broken. Reason: ${error}`);
+                this.currentReject(new UiControllerClientError(`The communication to the UI Controller is broken. Cause: ${error}`));
             }
         });
     }
     send(msg, _requestTimeout = UiControllerClient.REQUEST_TIMEOUT_IN_MS) {
         if (!this.currentReject || !this.currentResolve) {
-            throw Error('Request is not finished! It is not possible to have multiple requests at the same time.');
+            throw new UiControllerClientError('Request is not finished! It is not possible to have multiple requests at the same time.');
         }
         logger.debug(`Send: ${JSON.stringify(msg.msgName)}`);
         this.ws.send(JSON.stringify(msg));

package/dist/esm/lib/download-binaries.js

@@ -46,7 +46,7 @@ export function getBinaryFilePath(version) {
     return path.join(getPathToNodeModulesRoot(), 'release', version, ...binarySubPathsByPlatform[platform()]);
 }
 function getBinaryDownloadUrl(binaryVersion) {
-    const baseUrl = `https://askui-public.s3.eu-central-1.amazonaws.com/releases/askui-ui-controller/${binaryVersion}`;
+    const baseUrl = `https://files.askui.com/releases/askui-ui-controller/${binaryVersion}`;
     const arch = os.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }

package/dist/esm/main.d.ts

@@ -1,4 +1,6 @@
 export { UiController } from './lib';
-export { AnnotationLevel, UiControlClient } from './execution';
+export { UiControlClient } from './execution';
 export { Instruction, Reporter, ReporterConfig, Snapshot, SnapshotDetailLevel, Step, StepStatus, StepStatusEnd, } from './core/reporting';
+export { Annotation } from './core/annotation/annotation';
+export { DetectedElement } from './core/model/annotation-result/detected-element';
 export { LogLevels } from './shared';

package/dist/esm/main.js

@@ -1,3 +1,5 @@
 export { UiController } from './lib';
-export { AnnotationLevel, UiControlClient } from './execution';
+export { UiControlClient } from './execution';
+export { Annotation } from './core/annotation/annotation';
+export { DetectedElement } from './core/model/annotation-result/detected-element';
 export { LogLevels } from './shared';

package/dist/example_projects_templates/typescript_jest/test/README.md

@@ -1,15 +1,15 @@
-# Askui first test
-
-Example to introduce  how to use the askui lib.
-The lib is helps to control the operating system with
+# AskUI First Run
+Example of using the askui SDK.
+The lib helps to control the operating system with
 commands.
-Using Jest as test framework to execute all tests.
+Using Jest as runner framework to execute all your
+AskUI workflows.
 
 ## Installation of Jest and Typescript
 
 Use following command to set up Jest:
 ```shell
-npm i -D jest @types/jest ts-jest typescript
+npm i -D jest @types/jest ts-jest typescript 
 ```
 
 ## How to execute the example

package/dist/example_projects_templates/typescript_jest/test/helper/jest.setup.ts

@@ -1,4 +1,6 @@
 import { UiControlClient, UiController } from 'askui';
+import 'jest-allure-circus';
+import { AskUIAllureStepReporter } from '@askui/askui-reporters';
 
 // Server for controlling the operating system
 let uiController: UiController;
@@ -25,13 +27,24 @@ beforeAll(async () => {
       workspaceId: '<your workspace id>',
       token: '<your access token>',
     },
+    reporter: new AskUIAllureStepReporter(),
   });
 
   await aui.connect();
 });
 
+beforeEach(async () => {
+  await aui.startVideoRecording();
+});
+
+afterEach(async () => {
+  await aui.stopVideoRecording();
+  const video = await aui.readVideoRecording();
+  AskUIAllureStepReporter.createAllureAttachment(video);
+});
+
 afterAll(async () => {
-  aui.close();
+  aui.disconnect();
 
   await uiController.stop();
 });

package/dist/example_projects_templates/typescript_jest/test/jest.config.ts

@@ -2,7 +2,7 @@ import type { Config } from '@jest/types';
 
 const config: Config.InitialOptions = {
   preset: 'ts-jest',
-  testEnvironment: 'node',
+  testEnvironment: 'jest-allure-circus',
   setupFilesAfterEnv: ['./helper/jest.setup.ts'],
   sandboxInjectedGlobals: [
     'Math',

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.10.5",
+    "version": "0.11.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",