askui 0.10.4 → 0.11.0

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/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/inference-client.d.ts

@@ -5,13 +5,13 @@ import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
-    baseUrl: string;
-    httpClient: HttpClientGot;
-    resize?: number | undefined;
+    private readonly baseUrl;
+    private readonly httpClient;
+    private readonly resize?;
     readonly workspaceId?: string | undefined;
     readonly modelComposition?: ModelCompositionBranch[] | undefined;
-    apiVersion: string;
-    url: string;
+    private readonly apiVersion;
+    private urls;
     constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;

package/dist/cjs/execution/inference-client.js

@@ -29,9 +29,14 @@ class InferenceClient {
         this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = (0, url_join_1.default)(this.baseUrl, 'api', this.apiVersion);
-        this.url = workspaceId
+        const url = workspaceId
             ? (0, url_join_1.default)(versionedBaseUrl, 'workspaces', workspaceId)
             : versionedBaseUrl;
+        this.urls = {
+            inference: (0, url_join_1.default)(url, 'inference'),
+            isImageRequired: (0, url_join_1.default)(url, 'instruction', 'is-image-required'),
+        };
+        this.httpClient.urlsToRetry = Object.values(this.urls);
         if (this.resize !== undefined && this.resize <= 0) {
             throw new config_error_1.ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
         }
@@ -39,11 +44,9 @@ class InferenceClient {
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = (0, url_join_1.default)(this.url, 'instruction', 'is-image-required');
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.isImageRequired, {
                 instruction,
-            };
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             return response.body.isImageRequired;
         });
     }
@@ -59,14 +62,12 @@ class InferenceClient {
     inference(customElements = [], image, instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.inference, {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
                 modelComposition: this.modelComposition,
-            };
-            const url = (0, url_join_1.default)(this.url, 'inference');
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             InferenceClient.logMetaInformation(response);
             return ui_control_commands_1.InferenceResponse.fromJson(response.body, resizedImage.resizeRatio, image);
         });

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/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/cjs/utils/http/http-client-got.d.ts

@@ -12,10 +12,14 @@ export declare class HttpClientGot {
     } | undefined;
     private headers;
     private askuiGot;
+    urlsToRetry: string[];
     constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    private buildGotExtendOptions;
+    private shouldRetryOnError;
+    private shouldRetryPostRequest;
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{

package/dist/cjs/utils/http/http-client-got.js

@@ -25,8 +25,55 @@ class HttpClientGot {
         this.cookies = cookies;
         this.proxyAgents = proxyAgents;
         this.headers = {};
+        this.urlsToRetry = [];
         this.initHeaders(token, customHeaders);
-        this.askuiGot = got_1.default.extend(proxyAgents ? { agent: proxyAgents } : {});
+        const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
+        this.askuiGot = got_1.default.extend(gotExtendOptions);
+    }
+    buildGotExtendOptions(proxyAgents) {
+        const gotExtendOptions = {
+            retry: {
+                limit: 5,
+                methods: ['POST', 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE'],
+                statusCodes: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                errorCodes: [
+                    'ETIMEDOUT',
+                    'ECONNRESET',
+                    'EADDRINUSE',
+                    'ECONNREFUSED',
+                    'EPIPE',
+                    'ENOTFOUND',
+                    'ENETUNREACH',
+                    'EAI_AGAIN',
+                ],
+                calculateDelay: ({ attemptCount, retryOptions, error, computedValue, }) => {
+                    var _a, _b, _c;
+                    if (attemptCount > retryOptions.limit
+                        || !this.shouldRetryOnError(error)) {
+                        return 0;
+                    }
+                    if (error.response !== undefined
+                        && error.response.headers['retry-after'] === undefined) {
+                        lib_1.logger.debug(`Request to ${(_a = error.request) === null || _a === void 0 ? void 0 : _a.requestUrl} failed with status code ${(_b = error.response) === null || _b === void 0 ? void 0 : _b.statusCode}.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                        return Math.min(1000 * Math.pow(2, (attemptCount - 1)) + Math.random() * 100, Number.MAX_SAFE_INTEGER);
+                    }
+                    lib_1.logger.debug(`Request to ${(_c = error.request) === null || _c === void 0 ? void 0 : _c.requestUrl} failed.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                    return computedValue;
+                },
+            },
+        };
+        if (proxyAgents) {
+            gotExtendOptions.agent = proxyAgents;
+        }
+        return gotExtendOptions;
+    }
+    shouldRetryOnError(error) {
+        var _a;
+        return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
+            || this.shouldRetryPostRequest(error.request));
+    }
+    shouldRetryPostRequest(request) {
+        return (request !== undefined && this.urlsToRetry.includes(request.requestUrl));
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new credentials_1.Credentials(token) : undefined;

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/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/inference-client.d.ts

@@ -5,13 +5,13 @@ import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
-    baseUrl: string;
-    httpClient: HttpClientGot;
-    resize?: number | undefined;
+    private readonly baseUrl;
+    private readonly httpClient;
+    private readonly resize?;
     readonly workspaceId?: string | undefined;
     readonly modelComposition?: ModelCompositionBranch[] | undefined;
-    apiVersion: string;
-    url: string;
+    private readonly apiVersion;
+    private urls;
     constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;

package/dist/esm/execution/inference-client.js

@@ -23,9 +23,14 @@ export class InferenceClient {
         this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
-        this.url = workspaceId
+        const url = workspaceId
             ? urljoin(versionedBaseUrl, 'workspaces', workspaceId)
             : versionedBaseUrl;
+        this.urls = {
+            inference: urljoin(url, 'inference'),
+            isImageRequired: urljoin(url, 'instruction', 'is-image-required'),
+        };
+        this.httpClient.urlsToRetry = Object.values(this.urls);
         if (this.resize !== undefined && this.resize <= 0) {
             throw new ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
         }
@@ -33,11 +38,9 @@ export class InferenceClient {
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = urljoin(this.url, 'instruction', 'is-image-required');
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.isImageRequired, {
                 instruction,
-            };
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             return response.body.isImageRequired;
         });
     }
@@ -53,14 +56,12 @@ export class InferenceClient {
     inference(customElements = [], image, instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.inference, {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
                 modelComposition: this.modelComposition,
-            };
-            const url = urljoin(this.url, 'inference');
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             InferenceClient.logMetaInformation(response);
             return InferenceResponse.fromJson(response.body, resizedImage.resizeRatio, image);
         });

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/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/esm/utils/http/http-client-got.d.ts

@@ -12,10 +12,14 @@ export declare class HttpClientGot {
     } | undefined;
     private headers;
     private askuiGot;
+    urlsToRetry: string[];
     constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    private buildGotExtendOptions;
+    private shouldRetryOnError;
+    private shouldRetryPostRequest;
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{

package/dist/esm/utils/http/http-client-got.js

@@ -19,8 +19,55 @@ export class HttpClientGot {
         this.cookies = cookies;
         this.proxyAgents = proxyAgents;
         this.headers = {};
+        this.urlsToRetry = [];
         this.initHeaders(token, customHeaders);
-        this.askuiGot = got.extend(proxyAgents ? { agent: proxyAgents } : {});
+        const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
+        this.askuiGot = got.extend(gotExtendOptions);
+    }
+    buildGotExtendOptions(proxyAgents) {
+        const gotExtendOptions = {
+            retry: {
+                limit: 5,
+                methods: ['POST', 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE'],
+                statusCodes: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                errorCodes: [
+                    'ETIMEDOUT',
+                    'ECONNRESET',
+                    'EADDRINUSE',
+                    'ECONNREFUSED',
+                    'EPIPE',
+                    'ENOTFOUND',
+                    'ENETUNREACH',
+                    'EAI_AGAIN',
+                ],
+                calculateDelay: ({ attemptCount, retryOptions, error, computedValue, }) => {
+                    var _a, _b, _c;
+                    if (attemptCount > retryOptions.limit
+                        || !this.shouldRetryOnError(error)) {
+                        return 0;
+                    }
+                    if (error.response !== undefined
+                        && error.response.headers['retry-after'] === undefined) {
+                        logger.debug(`Request to ${(_a = error.request) === null || _a === void 0 ? void 0 : _a.requestUrl} failed with status code ${(_b = error.response) === null || _b === void 0 ? void 0 : _b.statusCode}.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                        return Math.min(1000 * Math.pow(2, (attemptCount - 1)) + Math.random() * 100, Number.MAX_SAFE_INTEGER);
+                    }
+                    logger.debug(`Request to ${(_c = error.request) === null || _c === void 0 ? void 0 : _c.requestUrl} failed.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                    return computedValue;
+                },
+            },
+        };
+        if (proxyAgents) {
+            gotExtendOptions.agent = proxyAgents;
+        }
+        return gotExtendOptions;
+    }
+    shouldRetryOnError(error) {
+        var _a;
+        return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
+            || this.shouldRetryPostRequest(error.request));
+    }
+    shouldRetryPostRequest(request) {
+        return (request !== undefined && this.urlsToRetry.includes(request.requestUrl));
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new Credentials(token) : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.10.4",
+    "version": "0.11.0",
     "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",
@@ -52,7 +52,7 @@
         "commander": "8.3.0",
         "fkill": "7.2.1",
         "fs-extra": "10.0.0",
-        "got": "11.8.2",
+        "got": "11.8.6",
         "jsdom": "20.0.0",
         "node-machine-id": "1.1.12",
         "pino": "7.8.1",