askui 0.7.0 → 0.7.2

package/dist/cjs/lib/ui-controller-facade.d.ts

@@ -1,6 +1,6 @@
 import { UiControllerArgs, UiControllerArgsWithDefaults } from './ui-controller-args';
 export declare abstract class UiControllerFacade {
-    protected binaryPath: string;
+    protected binaryFilePath: string;
     protected serverLogFile: string;
     protected readonly DefaultmaxWaitingForStartingInMs: number;
     start(args?: UiControllerArgs, maxWaitingForStartingInSeconds?: number): Promise<void>;
@@ -11,7 +11,6 @@ export declare abstract class UiControllerFacade {
     protected makeBinaryExecutable(): void;
     protected runPreStartChecks(): Promise<void>;
     protected waitUntilStarted(args: UiControllerArgsWithDefaults, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    private isBinaryValid;
     private getBinary;
     private startWithDefaults;
 }

package/dist/cjs/lib/ui-controller-facade.js

@@ -27,7 +27,7 @@ const unkown_error_1 = require("./unkown-error");
 const proxy_builder_1 = require("../utils/proxy/proxy-builder");
 class UiControllerFacade {
     constructor() {
-        this.binaryPath = (0, download_binaries_1.getBinaryPath)('latest');
+        this.binaryFilePath = (0, download_binaries_1.getBinaryFilePath)('latest');
         this.DefaultmaxWaitingForStartingInMs = 30 * 1000;
     }
     start(args, maxWaitingForStartingInSeconds) {
@@ -35,7 +35,7 @@ class UiControllerFacade {
             yield this.runPreStartChecks();
             const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
-            this.binaryPath = (0, download_binaries_1.getBinaryPath)(argsWithLogPath.binaryVersion);
+            this.binaryFilePath = (0, download_binaries_1.getBinaryFilePath)(argsWithLogPath.binaryVersion);
             yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary, argsWithLogPath.proxyAgents || (yield (0, proxy_builder_1.buildProxyAgentArgsFromEnvironment)()));
             this.makeBinaryExecutable();
             logger_1.logger.debug(`UI Controller log path "${this.serverLogFile}"`);
@@ -71,7 +71,7 @@ class UiControllerFacade {
         });
     }
     getStartingCommand() {
-        return `"${this.binaryPath}"`;
+        return `"${this.binaryFilePath}"`;
     }
     // eslint-disable-next-line class-methods-use-this
     makeBinaryExecutable() {
@@ -105,19 +105,14 @@ class UiControllerFacade {
             }
         });
     }
-    isBinaryValid() {
-        const sizeThresholdInMB = 100;
-        const binarysizeInMB = fs_extra_1.default.statSync(this.binaryPath).size / (1024 * 1024);
-        return binarysizeInMB > sizeThresholdInMB;
-    }
     getBinary(binaryVersion, overWriteBinary = false, proxyAgent) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!fs_extra_1.default.existsSync(this.binaryPath) || overWriteBinary || !this.isBinaryValid()) {
-                logger_1.logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
+            if (!fs_extra_1.default.existsSync(this.binaryFilePath) || overWriteBinary) {
+                logger_1.logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryFilePath}"`);
                 yield (0, download_binaries_1.downloadServerBinaries)(binaryVersion, proxyAgent);
             }
             else {
-                logger_1.logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);
+                logger_1.logger.debug(`Binary of UI Controller is already present at "${this.binaryFilePath}".`);
             }
         });
     }

package/dist/cjs/lib/ui-controller-linux.js

@@ -19,7 +19,7 @@ const libfuse_error_1 = require("./libfuse-error");
 class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
     // eslint-disable-next-line class-methods-use-this
     makeBinaryExecutable() {
-        (0, child_process_1.exec)(`chmod +x "${this.binaryPath}"`, (_exception, stdout) => logger_1.logger.debug(stdout));
+        (0, child_process_1.exec)(`chmod +x "${this.binaryFilePath}"`, (_exception, stdout) => logger_1.logger.debug(stdout));
     }
     // eslint-disable-next-line class-methods-use-this
     runPreStartChecks() {

package/dist/cjs/utils/http/credentials.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/utils/http/credentials.spec.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const credentials_1 = require("./credentials");
+describe('Credentials', () => {
+    describe('base64Encoded()', () => {
+        test('should return base64-encoded credentials', () => {
+            const credentials = new credentials_1.Credentials('password');
+            expect(credentials.base64Encoded).toBe('cGFzc3dvcmQ=');
+        });
+    });
+});

package/dist/cjs/utils/http/http-client-got.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { OptionsOfJSONResponseBody } from 'got';
 import http from 'http';
 import https from 'https';
@@ -17,6 +18,9 @@ export declare class HttpClientGot {
     } | undefined);
     private initHeaders;
     private injectHeadersAndCookies;
-    post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;
+    post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{
+        headers: http.IncomingHttpHeaders;
+        body: T;
+    }>;
     get<T>(url: string, options?: OptionsOfJSONResponseBody): Promise<T>;
 }

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

@@ -30,18 +30,26 @@ class HttpClientGot {
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new credentials_1.Credentials(token) : undefined;
-        this.headers = Object.assign(Object.assign({}, (credentials ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` } : {})), customHeaders);
+        this.headers = Object.assign(Object.assign({}, (credentials
+            ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` }
+            : {})), customHeaders);
     }
     injectHeadersAndCookies(url, options) {
         const cookieJar = new tough_cookie_1.CookieJar();
-        Object.keys(this.cookies).map((key) => `${key}=${this.cookies[key]}`).forEach((cookie) => {
+        Object.keys(this.cookies)
+            .map((key) => `${key}=${this.cookies[key]}`)
+            .forEach((cookie) => {
             cookieJar.setCookieSync(cookie, url);
         });
         return Object.assign(Object.assign({}, options), { headers: this.headers, cookieJar });
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
+            const options = this.injectHeadersAndCookies(url, {
+                json: data,
+                responseType: 'json',
+                throwHttpErrors: false,
+            });
             const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
             if (headers['deprecation'] !== undefined) {
                 lib_1.logger.warn(headers['deprecation']);
@@ -49,7 +57,7 @@ class HttpClientGot {
             if (statusCode !== 200) {
                 throw (0, custom_errors_1.httpClientErrorHandler)(statusCode, JSON.stringify(body));
             }
-            return body;
+            return { headers, body };
         });
     }
     get(url, options = { responseType: 'json' }) {

package/dist/esm/core/annotation/annotation-json.d.ts

@@ -0,0 +1,5 @@
+import { DetectedElement } from '../model/annotation-result/detected-element';
+export interface AnnotationJson {
+    image: string;
+    objects: DetectedElement[];
+}

package/dist/esm/core/annotation/annotation-json.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/inference-response/inference-response.d.ts

@@ -1,15 +1,11 @@
 import { ControlCommand } from '../ui-control-commands/control-command';
 import { Annotation } from '../annotation/annotation';
-export declare class InferenceResponse {
-    type: string;
-    data: ControlCommand | Annotation;
-    constructor(type: string, data: ControlCommand | Annotation);
-    static fromJson(json: unknown, resizeRatio?: number, image?: string): ControlCommand | Annotation;
-    static createModels(type: string, data: ControlCommand | Annotation, resizeRatio: number, image?: string): ControlCommand | Annotation;
-    static models: Models;
+import { ModelType } from './model-type';
+export interface InferenceResponseBody {
+    type: ModelType;
+    data: ModelType extends 'COMMANDS' ? ControlCommand : Annotation;
 }
-interface Models {
-    DETECTED_ELEMENTS: CallableFunction;
-    COMMANDS: CallableFunction;
+export declare class InferenceResponse {
+    static fromJson(json: InferenceResponseBody, resizeRatio?: number, image?: string): ControlCommand | Annotation;
+    static createModels(type: ModelType, data: ModelType extends 'COMMANDS' ? ControlCommand : Annotation, resizeRatio: number, image?: string): ControlCommand | Annotation;
 }
-export {};

package/dist/esm/core/inference-response/inference-response.js

@@ -1,21 +1,16 @@
 import { ControlCommand } from '../ui-control-commands/control-command';
 import { Annotation } from '../annotation/annotation';
+import { InvalidModelTypeError } from './invalid-model-type-error';
 export class InferenceResponse {
-    constructor(type, data) {
-        this.type = type;
-        this.data = data;
-    }
     static fromJson(json, resizeRatio = 1, image) {
-        const inferenceResponse = json;
-        return this.createModels(inferenceResponse.type, inferenceResponse.data, resizeRatio, image);
+        return this.createModels(json.type, json.data, resizeRatio, image);
     }
     static createModels(type, data, resizeRatio, image) {
-        return this.models[type](data, resizeRatio, image);
+        if (type === 'COMMANDS')
+            return ControlCommand.fromJson(data, resizeRatio);
+        if (type === 'DETECTED_ELEMENTS') {
+            return Annotation.fromJson({ image, detected_elements: data.detected_elements }, resizeRatio);
+        }
+        throw new InvalidModelTypeError(type);
     }
 }
-InferenceResponse.models = {
-    DETECTED_ELEMENTS: (data, resizeRatio, image) => Annotation
-        .fromJson({ image, detected_elements: data.detected_elements }, resizeRatio),
-    COMMANDS: (data, resizeRatio) => ControlCommand
-        .fromJson(data, resizeRatio),
-};

package/dist/esm/core/inference-response/invalid-model-type-error.d.ts

@@ -0,0 +1,4 @@
+import { ModelType } from './model-type';
+export declare class InvalidModelTypeError extends Error {
+    constructor(type: ModelType);
+}

package/dist/esm/core/inference-response/invalid-model-type-error.js

@@ -0,0 +1,5 @@
+export class InvalidModelTypeError extends Error {
+    constructor(type) {
+        super(`Invalid model type: ${type}`);
+    }
+}

package/dist/esm/core/inference-response/model-type.d.ts

@@ -0,0 +1 @@
+export declare type ModelType = 'DETECTED_ELEMENTS' | 'COMMANDS';

package/dist/esm/core/inference-response/model-type.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,51 @@
+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());
+    });
+};
+import { CustomElement } from './custom-element';
+const base64ImageString = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAAA8CAYAAADWibxkAAAACXBIWXMAABYlAAAWJQFJUiTwAAAN20lEQVRogXVa3XrbSg7T7XHsfZyNneSJtm2cOH1/7UeCIMCRz4Xa2NYPhwRBkKPtdv7e306P/e3le7+dP+v43t9eHvt7HOfH/nb53q/12/vLdx5vL/f97RT/x/G53y73/e1S19Q5ccS9buc7zrt87+/nL1x/wvW3Sxz3/f3lnr/p/Pgu7HrUb/c8j/fC/XHdR9rJa2F7rieeV3/zmrhv3OP9BWvZciF1QvxwO9339xNPlvF+cX4+h2E/fe3bJf7GZxj2MMfiPrn4s84LJ9wu4bwwBosOJ6dN6Rhcm8+OxedBp69BgG08ImBxwB4G5qccEvbhui2ih+jy4jKAjokHnL73jzO9HOf/qRv/mEfj7wfuEWioB8O4QNGjIljO+k8hxc4nCuHQOF/RC4eEEyayLHCJQDoLqILzfvaP89884AA4vh1wLU9h8X9ycXQGoISFEdpKE0LUUBKQPoX36RQaGAbFgiKVaCzgncYy5c50UhyKWEY9I+8OKBsqRRk0OBUO78iffwp5SNc4cJ9HOEAGZ3RPf0YeEZaZ/5EambcF3YhWQ7VQE7A+uQPKmbHgiHwiipwh1DDKXFin3eW+Xy8RJMv9QiKDQFjLQfMz0MM0/oOUK3u3fFgQUhrCiMXfIsbXl9/pGPEFcwzOohG4jukjx3Ua8EikhBP4LEsBg+fMa6WCf5cQN9LryGcgxCfOY7Lvvm+3jAhvsOYibpDGVlT9YjA4HfAjBr945YCh7dyGvKVHoUWcYc+oRQZaWDGUolU9ysFMNRD0dKAqhx8POIBGzCMgj1xRBMETOIqR0wGAcqYSr3GvR/5npOHYhPMpokQO4EKRo5OHCHM5INO2iVYl0T+vaRVph8/xfdj42D/OP0gB5V0s4rGHUzwigmg83IlSBDbqfZ0n3eAO8FpNp8rpt+AgGmsHCBEldCCty5oIsmHfVaTKbKAyuKvS+T0Q0GUko+eLib8RWeUzcx//I5r4DC5h+brv1xPrsKeVLarShKW2mT6JVlUH9qAayQnF8gV1Ov6jz6nfkvmt7vfz8Pnj3A4IY393fedCHfrUC7nw4IR0ANCgKsK0MMLrqGjR+mxGuYEtcgr+vRBeW867HHNajjO05X2MZzo9H/sGUjEhZJyAyIOxAWsckLFVNomI01dGHUTKGq6IKPoiJRpJNNFgV3HM2y67hSgESSnHBVLP+HmOwjU9Ny5iyOE01oWMGJlQh+iRUQn5/OwiSkqOjuzyZ9F2pp69gFWky5JOlWJ5tB3l4AwYkWOIW6vLORDQN5ga2nW0qoSJj3aAyHDeg/nrEWc0zDnliFmJyOpKwya4dhxRMSU8GyjnmC6vJZf9902lCeWHXABFKFhmOalUmLIYYmYVLlNdQkc4DLsjTHaG7p/OBMdMNM1myDXFcDRLKxds4qlRVN9t8U8ovVR7dEDCS4uIaDoKWGqwsBnpgYJ0oiqHS2vyCNj6bxtEkho9yuXfyq3KdKeuiSVf6EQSOtO3kMIgMBjr8Fd5Y4QrAoGCiuas++QOGCVik0O8kUJPUB1cNCuLMvTD87aPkrwu4dV1Sl2qeqh9h4YoBFxLdIB9BVPWeizMBybqG545YDyk4E2EwAmT/Bhl2eAVaFYMRZSL4P2lD+ActsboO8QNVhoz5b7RDrP0zaiXgaXMBsx60HFvo9N5lW9alLM7ERJKTnOD2Y1WCU01KsSQuNqm4IYapAykVFSvh04RfKHvNZTZ4PG4eaXB6etJX1AtLhuimsIwPcaC4kGnLz0072czg/Pf/RaNDQkwnc+hCPv3r4M+kPosYr2QpGWX5HSVaoO9l0vwABCzUaPjBFs8azbRkGVP5MTzydBk/uglEpLnaF6it/C8psNonCoB0ZHRX0qyI3JyjE+emPsiu5GiXdX8mp/gACg4GC+FNf5PZCxaoVtkTxdEDvDyxoURFGI4nppkR8P9mjK6GptnvLAqSwqgriBDbksf3MgB12Vhc7GqEp7zNPBYnmblYI6/Vr7TCGkJooodmmo822tVDxNeXd+fkWY1UDUqGxOulNVqzTeMtxjtaopywV8LIaoC9MIMBd0nDLnpytJytAgLuS6ilWxlOomI1zYcs0XCfU6fVZFM/trc0IXVpnynAyhe2N1RiJSYKSjOinFk8uYFIipJTg0UoekqUUptOncQXDK/5/rUA42+ngXQ6cfK8J5VoKL9jHRaC5gxXb+LN6C8vF9wiM0+4EhuswkiCtXQKL1Go2RqTxMgcI6cURMq47F0dM8RcGxjwU6IlQLsCzQIedb4lIO6HHmnOHt88YqN1gbLlwOqI+VIa8wdMmWJVnaJcxbgvMTKoxmEULCB8FSevMWEM9gjOC+IrCZBLrtMSzkFAzO/FxHDDq1JVOTYzVoTolKp07BmfXg2S7EarFh4bu50P4CyuYnxpbKECjRK19NvIx/tDA3JXOxKz08nuuJb5wtzVuhObEfVLg8DwDI2JlGcIWST41UGqPXmSdXmUTqgPVpwdwF0YPvYJ6BiXNOhtAAJ1VPH0DPJUhp+yOKVVwxhnDR5X5FT5lZ+2rOcpXHpHF/KAbcToPKaJVBGq8Y/9muowF70o/hiyubWDGyF6bR8hvHMU3WohimHMT4wtW5Sm5zOLZ771mu0ipUDxtouKYXpUUWhS9UwLoyHpx2OQA0mQIia32fV8J4GEkmcHrHjXHd1qfc5dfZJ9dx8IXoMTUzL3Fh5jNnELZRgT01GcyO1J0ZlJyhNwB5BSNAIO3Zy2kG20aGW2B3gc0mQJhbr1cOFjk2vkp/oUNpSgaC+qFI923xwyybIOqsyytQIcy7YA5Q0lNtijC7HW/4w5wLjk9Mf8MniJE6ZaNfM5xqVkWCLxBlAF0eTw8qphrRbDEReY96fcPZ2GMbnb2PASaf4w90B6rhcYHVTskZxzBn8AIp43twQ9TG357trEG74esmttArB1PPHe5Fgly2KHkXEyxeJj20wr5uiyOBeDpA0ttmBkRTnC6MKGPmt1WOWzSnK5k62p93kCabBdhA+pxiQ/q9upG0w/LaQWkI4zl9mfw1xRnltcefmhqDKaTQduGqUZ2P4ueGB4a5v48kGCDebfV4yBSoPK6eRl7/02es7y+HBaaz9s3doxIwZg3HNuP/c6MDmB+7RozabLrm4QsWI+08R5y38Mz3xRiUonb9MiLnd5dGryZAiHp+10TFnCqwqs1tUdCdfdKdpIus1YG3dnA9re1O2Wl2l7mycOr3svmqGTotXW+A4g5YxiRZXgJKj1OBxNKoWvT9z2PNb9+s3SExHvFJrOEqK1MZ9662QZ88iCbvueI9mKPO3oqFBCKcyK5s7WrwqEGoiOfYQ68Tp9cm2mXeigqvDt/inN27rueYkCrpg//5tGdZM5YmOdcODLd8XBCQE48Wi8mwSTS2CAw0apr8hQvjClRNiXlv64Rkrr+KIU15tzrik9Qan3g4r7pg7ws8IGc7YlPcqcbx556+R3WFmYEIpI549QDjgp8iReQ4nIz3m9tsYxJSydE4S27O0QQX6W61TI/CtUu8XdF9PkW06gG99rIMP5o9FbDRDzGnsMeLBIYVr5MW3SUpoTbJaJ1F4RWcMVw7zCmqVOZabQmvRGt4Nslc4xVC0S5fqI5m39woSrlBdqxKcJAodoRGbHQ3BOQ6T+JIMv47v2cmVQ5vsZiVxwTWnRVMszYr2iW4QCmrCuj09FgnjWj47KQ1dsDD2SJ8SOzUzoHJzXQ8twkmUyu1AZb2RShu7gvDliWUfY77jJMm+ObzhXZ/SKBJQe9DoqAABVQ0fp5hyp3HKQ33vu1AqtZ1SJX5Q+628NZu7UxSk3ocYDRy5wTWE+OONr8pOiEizd4kbO0BzjNWk2B4/bme5A/DCI+7der9TYJk/jJ1jk+RGnkSQnGXSt3eTuB4SuO67qdGZnrsu37HzmiM0jrpEYIKqG3wUPFMF6m0zh/lQqd2EUfWtcnztLv3FK59qzcBss9lh+TEC/Fcm/lxIZxFTNCiNMlVI2Vu5GqnVzdRpzg/62WV4D0XZ5bU2sVJt7bNzw0S20LVpwImb6nUZV1nMOYuYC6AelDoHPCMiDVSOCBEyQvrCKaYNnvQTo+wt8JZStPa67VUXuuFBLAvQ8FB+tmhLE2dtRm4lvTlbmK2xRJQ3Xfp+ONunSGPPgfeXWBtONjm8pspaGTZGH16ndrcF2JTItb/k86oFFA2gqQYrweyJEt9zoCq0UvgUcVPx+XzCU9JVo1rsZ0MRkfeGkzjY4M6w5n5MkV5kaXwuzrfKD5I6FyWn0hlzEdh9amQ96R6nA3wQsozpvLny8jck8HTSpsXUgkrgNOk4MbZj8BtTZZDQmBI7lH1/cZ0/fu7/Pf3aX/9RykjXe/laecml72y/Z/5XeT9V+TUnbMxlqDtWgjgRbAmx4xGG6PDNEfURjIhHfpHEPamZkUA6zBzlOHz+zjLNhbh0Zkl27pj7hdraxznbUGIDxrEQ9gDrBod3bEepTLU1RYpYXjM7J1lqiDlWG+e1TZwHfM8ehVrCbNOz+Q7RIQU+rXxZu2u9/SwxrAaAnIaiaz4ufcDoID/36z/6ngq0ecPIVAGaQxF33NxWW6T82gD16/64bnvW3a2sj0X+6irhg9SuHN5EWat8lK84Mt9NPrv66+bniV2H/ckDaZqSbVu0FpIie57NGRs8MAcSLFVeruQAzQ7YJQ4uaX6Z7xtN5TZl8GEy1LZIq/jmzUDL4ZUaG4baMNcD/H8hlYADpzRH1QAAAABJRU5ErkJggg==';
+describe('CustomElement', () => {
+    describe('fromJsonWithImagePathOrImage', () => {
+        test('should return CustomElement if CustomElement created from JSON is valid', () => __awaiter(void 0, void 0, void 0, function* () {
+            const expected = new CustomElement(base64ImageString, 'Dummy_element', 0.7, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+            const actual = yield CustomElement.fromJsonWithImagePathOrImage({
+                customImage: base64ImageString,
+                name: 'Dummy_element',
+                threshold: 0.7,
+                rotationDegreePerStep: 10,
+                imageCompareFormat: 'RGB',
+                mask: [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }],
+            });
+            expect(actual).toStrictEqual(expected);
+        }));
+        test('should throw ValidationError if threshold is invalid', () => {
+            expect(() => {
+                const customElement = new CustomElement(base64ImageString, 'Dummy_element', 1.1, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+                customElement.validate();
+            }).toThrow('threshold must be less than or equal to 1');
+        });
+        test('should throw ValidationError if rotationDegreePerStep is invalid', () => {
+            expect(() => {
+                const customElement = new CustomElement(base64ImageString, 'Dummy_element', 0.9, -90, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+                customElement.validate();
+            }).toThrow('rotationDegreePerStep must be greater than or equal to 0');
+        });
+        test('should throw ValidationError if mask is invalid', () => {
+            expect(() => {
+                const customElement = new CustomElement(base64ImageString, 'Dummy_element', 0.9, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }]);
+                customElement.validate();
+            }).toThrow('mask must contain at least 3 points');
+        });
+        test('should throw ValidationError if mask and threshold are both invalid', () => {
+            expect(() => {
+                const customElement = new CustomElement(base64ImageString, 'Dummy_element', 90, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }]);
+                customElement.validate();
+            }).toThrow('threshold must be less than or equal to 1, mask must contain at least 3 points');
+        });
+    });
+});

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

@@ -1779,6 +1779,54 @@ export declare abstract class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     execOnShell(shell_command: string): Exec;
+    /**
+     * Clicks with left mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseLeftClick(): Exec;
+    /**
+     * Clicks with right mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseRightClick(): Exec;
+    /**
+     * Clicks with middle mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseMiddleClick(): Exec;
+    /**
+     * Double-clicks with left mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleLeftClick(): Exec;
+    /**
+     * Double-clicks with right mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleRightClick(): Exec;
+    /**
+     * Double-clicks with middle mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleMiddleClick(): Exec;
+    /**
+     * Toggles mouse down (Left mouse key).
+     *
+     * @return {Exec}
+     */
+    mouseToggleDown(): Exec;
+    /**
+     * Toggles mouse up (Left mouse key).
+     *
+     * @return {Exec}
+     */
+    mouseToggleUp(): Exec;
     /**
      * Press three keys like `CTRL+ALT+DEL`
      *

package/dist/esm/execution/dsl.js

@@ -2361,6 +2361,78 @@ export class FluentCommand extends FluentBase {
         this._textStr = `Execute shell command ${Separators.STRING}${shell_command}${Separators.STRING}`;
         return new Exec(this);
     }
+    /**
+     * Clicks with left mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseLeftClick() {
+        this._textStr = 'Mouse left click';
+        return new Exec(this);
+    }
+    /**
+     * Clicks with right mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseRightClick() {
+        this._textStr = 'Mouse right click';
+        return new Exec(this);
+    }
+    /**
+     * Clicks with middle mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseMiddleClick() {
+        this._textStr = 'Mouse middle click';
+        return new Exec(this);
+    }
+    /**
+     * Double-clicks with left mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleLeftClick() {
+        this._textStr = 'Mouse double left click';
+        return new Exec(this);
+    }
+    /**
+     * Double-clicks with right mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleRightClick() {
+        this._textStr = 'Mouse double right click';
+        return new Exec(this);
+    }
+    /**
+     * Double-clicks with middle mouse key.
+     *
+     * @return {Exec}
+     */
+    mouseDoubleMiddleClick() {
+        this._textStr = 'Mouse double middle click';
+        return new Exec(this);
+    }
+    /**
+     * Toggles mouse down (Left mouse key).
+     *
+     * @return {Exec}
+     */
+    mouseToggleDown() {
+        this._textStr = 'Mouse toggle down';
+        return new Exec(this);
+    }
+    /**
+     * Toggles mouse up (Left mouse key).
+     *
+     * @return {Exec}
+     */
+    mouseToggleUp() {
+        this._textStr = 'Mouse toggle up';
+        return new Exec(this);
+    }
     /**
      * Press three keys like `CTRL+ALT+DEL`
      *

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

@@ -0,0 +1 @@
+export {};

package/dist/esm/execution/dsl.spec.js

@@ -0,0 +1,73 @@
+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());
+    });
+};
+import { FluentCommand } from './dsl';
+class TestCommand extends FluentCommand {
+    // eslint-disable-next-line class-methods-use-this
+    fluentCommandExecutor(instruction, customElements) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // eslint-disable-next-line no-console
+            console.log(`${instruction} ${customElements}`);
+            return Promise.resolve();
+        });
+    }
+}
+describe('DSL', () => {
+    describe('custom element', () => {
+        test('should call exec function with zero custom element', () => __awaiter(void 0, void 0, void 0, function* () {
+            const underTest = new TestCommand();
+            const testCommandSpy = jest.spyOn(underTest, 'fluentCommandExecutor');
+            yield underTest.click().button()
+                .exec();
+            expect(testCommandSpy).toHaveBeenCalledWith('Click on button', []);
+        }));
+        test('should call exec function with one custom element', () => __awaiter(void 0, void 0, void 0, function* () {
+            const underTest = new TestCommand();
+            const testCommandSpy = jest.spyOn(underTest, 'fluentCommandExecutor');
+            yield underTest.click().customElement({
+                customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                imageCompareFormat: 'grayscale',
+                name: 'custom element 1',
+            }).button()
+                .exec();
+            expect(testCommandSpy).toHaveBeenCalledWith('Click on custom element button', [{
+                    customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                    imageCompareFormat: 'grayscale',
+                    name: 'custom element 1',
+                }]);
+        }));
+        test('should call exec function with two custom element', () => __awaiter(void 0, void 0, void 0, function* () {
+            const underTest = new TestCommand();
+            const testCommandSpy = jest.spyOn(underTest, 'fluentCommandExecutor');
+            yield underTest.click().customElement({
+                customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                imageCompareFormat: 'grayscale',
+                name: 'custom element 1',
+            })
+                .button()
+                .customElement({
+                customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                imageCompareFormat: 'grayscale',
+                name: 'custom element 2',
+            })
+                .exec();
+            expect(testCommandSpy).toHaveBeenCalledWith('Click on custom element button custom element', [{
+                    customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                    imageCompareFormat: 'grayscale',
+                    name: 'custom element 1',
+                },
+                {
+                    customImage: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==',
+                    imageCompareFormat: 'grayscale',
+                    name: 'custom element 2',
+                },
+            ]);
+        }));
+    });
+});

package/dist/esm/execution/inference-client.d.ts

@@ -14,6 +14,7 @@ export declare class InferenceClient {
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     inference(customElements?: CustomElement[], image?: string, instruction?: string): Promise<ControlCommand | Annotation>;
+    private static logMetaInformation;
     predictControlCommand(instruction: string, customElements?: CustomElement[], image?: string): Promise<ControlCommand>;
     getDetectedElements(instruction: string, image: string, customElements?: CustomElement[]): Promise<DetectedElement[]>;
     predictImageAnnotation(image: string, customElements?: CustomElement[]): Promise<Annotation>;

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

@@ -13,6 +13,7 @@ import { Annotation } from '../core/annotation/annotation';
 import { resizeBase64ImageWithSameRatio } from '../utils/transformations';
 import { InferenceResponseError } from './inference-response-error';
 import { ConfigurationError } from './config-error';
+import { logger } from '../lib/logger';
 export class InferenceClient {
     constructor(baseUrl, httpClient, resize, workspaceId, apiVersion = 'v3') {
         this.baseUrl = baseUrl;
@@ -21,7 +22,9 @@ export class InferenceClient {
         this.workspaceId = workspaceId;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
-        this.url = workspaceId ? urljoin(versionedBaseUrl, 'workspaces', workspaceId) : versionedBaseUrl;
+        this.url = workspaceId
+            ? urljoin(versionedBaseUrl, 'workspaces', workspaceId)
+            : versionedBaseUrl;
         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.`);
         }
@@ -30,17 +33,17 @@ export class InferenceClient {
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = urljoin(this.url, 'instruction', 'is-image-required');
-            const httpBody = {
+            const requestBody = {
                 instruction,
             };
-            const httpResponse = yield this.httpClient.post(url, httpBody);
-            return httpResponse.isImageRequired;
+            const response = yield this.httpClient.post(url, requestBody);
+            return response.body.isImageRequired;
         });
     }
     // eslint-disable-next-line class-methods-use-this
     resizeIfNeeded(customElements, image) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(image) || customElements.length > 0 || this.resize === undefined) {
+            if (!image || customElements.length > 0 || this.resize === undefined) {
                 return { base64Image: image, resizeRatio: 1 };
             }
             return resizeBase64ImageWithSameRatio(image, this.resize);
@@ -49,16 +52,22 @@ export class InferenceClient {
     inference(customElements = [], image, instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
-            const httpBody = {
+            const requestBody = {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
             };
             const url = urljoin(this.url, 'inference');
-            const httpResponse = yield this.httpClient.post(url, httpBody);
-            return InferenceResponse.fromJson(httpResponse, resizedImage.resizeRatio, image);
+            const response = yield this.httpClient.post(url, requestBody);
+            InferenceClient.logMetaInformation(response);
+            return InferenceResponse.fromJson(response.body, resizedImage.resizeRatio, image);
         });
     }
+    static logMetaInformation(response) {
+        if (response.headers['askui-usage-warnings'] !== undefined) {
+            logger.warn(response.headers['askui-usage-warnings']);
+        }
+    }
     predictControlCommand(instruction, customElements = [], image) {
         return __awaiter(this, void 0, void 0, function* () {
             const inferenceResponse = yield this.inference(customElements, image, instruction);

package/dist/esm/execution/read-environment-credentials.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/execution/read-environment-credentials.spec.js

@@ -0,0 +1,9 @@
+import { envCredentials } from './read-environment-credentials';
+describe('envCredentials()', () => {
+    test('should read the credentials from the environment variables', () => {
+        process.env['ASKUI_TOKEN'] = 'token';
+        process.env['ASKUI_WORKSPACE_ID'] = 'id123';
+        const credentialsFromTheEnv = envCredentials();
+        expect(credentialsFromTheEnv).toStrictEqual({ workspaceId: 'id123', token: 'token' });
+    });
+});

package/dist/esm/lib/download-binaries.d.ts

@@ -7,7 +7,7 @@ declare enum SupportedPlatform {
     WIN32 = "win32"
 }
 export declare function platform(): SupportedPlatform;
-export declare function getBinaryPath(version: string): string;
+export declare function getBinaryFilePath(version: string): string;
 export declare function downloadServerBinaries(binaryVersion: string, proxyAgent?: {
     http: http.Agent;
     https: https.Agent;