askui 0.1.5 → 0.2.1

package/README.md

@@ -42,6 +42,12 @@ npx askui init
 
 Visit our [documentation](https://docs.askui.com) for examples and a full list of supported commands.
 
+### Notes
+
+Important note for Linux users: Currently, Wayland is not supported.
+You can read more in our [troubleshooting chapter](https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#wayland).
+If you want to use the askui library libfuse2 is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#libfuse2)).
+
 ## Example
 
 The following example shows the use of **askui** for testing a desktop application.

package/bin/askui-postinstall

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const { access } = require('fs/promises');
+const { join } = require('path');
+
+async function shouldBeExecuted() {
+  try {
+    await access(join(__dirname, '../.no-askui-postinstall'));
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return true;
+    }
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+  return false;
+}
+
+async function createInstallationTimestamp() {
+  try {
+    const { InstallationTimestamp } = require('../dist/cjs/utils/analytics/installation-timestamp');
+    InstallationTimestamp.create();
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+}
+
+async function main() {
+  if (await shouldBeExecuted()) {
+    await createInstallationTimestamp();
+  }
+}
+
+main();

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

@@ -4,13 +4,13 @@ export declare class CustomElement implements CustomElementJson {
     name?: string | undefined;
     threshold?: number | undefined;
     rotationDegreePerStep?: number | undefined;
-    imageCompareFormat?: "grayscale" | "RGB" | undefined;
+    imageCompareFormat?: "RGB" | "grayscale" | undefined;
     mask?: {
         x: number;
         y: number;
     }[] | undefined;
     private static schema;
-    constructor(customImage: string, name?: string | undefined, threshold?: number | undefined, rotationDegreePerStep?: number | undefined, imageCompareFormat?: "grayscale" | "RGB" | undefined, mask?: {
+    constructor(customImage: string, name?: string | undefined, threshold?: number | undefined, rotationDegreePerStep?: number | undefined, imageCompareFormat?: "RGB" | "grayscale" | undefined, mask?: {
         x: number;
         y: number;
     }[] | undefined);

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

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomElement = void 0;
 const yup_1 = require("yup");
-const transformations_1 = require("../../../utils/transformations");
+const base_64_image_1 = require("../../../utils/base_64_image/base-64-image");
 class CustomElement {
     constructor(customImage, name, threshold, rotationDegreePerStep, imageCompareFormat, mask) {
         this.customImage = customImage;
@@ -28,7 +28,7 @@ class CustomElement {
     }
     static fromJsonWithImagePathOrImage(ceJson) {
         return __awaiter(this, void 0, void 0, function* () {
-            const customImage = yield (0, transformations_1.toBase64ImageIfNeeded)(ceJson.customImage);
+            const customImage = (yield base_64_image_1.Base64Image.fromPathOrString(ceJson.customImage)).toString();
             const customElement = CustomElement.fromJson(Object.assign(Object.assign({}, ceJson), { customImage }));
             customElement.validate();
             return customElement;

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

@@ -10,12 +10,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const custom_element_1 = require("./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 custom_element_1.CustomElement('data:image', 'Dummy_element', 0.7, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+            const expected = new custom_element_1.CustomElement(base64ImageString, 'Dummy_element', 0.7, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
             const actual = yield custom_element_1.CustomElement.fromJsonWithImagePathOrImage({
-                customImage: 'data:image',
+                customImage: base64ImageString,
                 name: 'Dummy_element',
                 threshold: 0.7,
                 rotationDegreePerStep: 10,
@@ -26,25 +27,25 @@ describe('CustomElement', () => {
         }));
         test('should throw ValidationError if threshold is invalid', () => {
             expect(() => {
-                const customElement = new custom_element_1.CustomElement('data:image', 'Dummy_element', 1.1, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+                const customElement = new custom_element_1.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 custom_element_1.CustomElement('data:image', 'Dummy_element', 0.9, -90, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }, { x: 3, y: 4 }]);
+                const customElement = new custom_element_1.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 custom_element_1.CustomElement('data:image', 'Dummy_element', 0.9, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }]);
+                const customElement = new custom_element_1.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 custom_element_1.CustomElement('data:image', 'Dummy_element', 90, 10, 'RGB', [{ x: 0, y: 1 }, { x: 1, y: 2 }]);
+                const customElement = new custom_element_1.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/cjs/core/model/test-case-dto/index.js

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

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

@@ -1,10 +1,6 @@
 import { CustomElement } from './custom-element';
-import { CustomElementJson } from './custom-element-json';
-export declare class TestStep {
+export interface TestStep {
     instruction: string;
-    customElements: CustomElement[];
-    constructor(instruction: string, customElements?: CustomElement[]);
-    static fromJson(step: TestStep & {
-        customElements: CustomElementJson[];
-    }): TestStep;
+    customElements?: CustomElement[];
+    secretText?: string | undefined;
 }

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

@@ -1,14 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStep = void 0;
-const custom_element_1 = require("./custom-element");
-class TestStep {
-    constructor(instruction, customElements = []) {
-        this.instruction = instruction;
-        this.customElements = customElements;
-    }
-    static fromJson(step) {
-        return new TestStep(step.instruction, (step.customElements || []).map((customELement) => custom_element_1.CustomElement.fromJson(customELement)));
-    }
-}
-exports.TestStep = TestStep;

package/dist/cjs/core/ui-control-commands/control-command.d.ts

@@ -6,4 +6,5 @@ export declare class ControlCommand {
     tryToRepeat: boolean;
     constructor(code: ControlCommandCode, actions: Action[], tryToRepeat?: boolean);
     static fromJson(json: ControlCommand, resizeRatio?: number): ControlCommand;
+    setTextToBeTyped(text: string): void;
 }

package/dist/cjs/core/ui-control-commands/control-command.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControlCommand = void 0;
 const action_1 = require("./action");
 const control_command_code_1 = require("./control-command-code");
+const input_event_1 = require("./input-event");
 class ControlCommand {
     constructor(code, actions, tryToRepeat = false) {
         this.code = code;
@@ -12,5 +13,9 @@ class ControlCommand {
     static fromJson(json, resizeRatio = 1) {
         return new ControlCommand(control_command_code_1.ControlCommandCode[json.code], json.actions.map((action) => action_1.Action.fromJson(action, resizeRatio)), json.tryToRepeat);
     }
+    setTextToBeTyped(text) {
+        this.actions = this.actions.map((action) => ([input_event_1.InputEvent.TYPE, input_event_1.InputEvent.TYPE_TEXT].includes(action.inputEvent)
+            ? new action_1.Action(action.inputEvent, action.position, text) : action));
+    }
 }
 exports.ControlCommand = ControlCommand;

package/dist/cjs/core/ui-control-commands/input-event.d.ts

@@ -16,6 +16,5 @@ export declare enum InputEvent {
     MOUSE_MOVE = "MOUSE_MOVE",
     MOUSE_DOWN = "MOUSE_DOWN",
     MOUSE_UP = "MOUSE_UP",
-    EXECUTE_COMMAND = "EXECUTE_COMMAND",
-    WAIT = "WAIT"
+    EXECUTE_COMMAND = "EXECUTE_COMMAND"
 }

package/dist/cjs/core/ui-control-commands/input-event.js

@@ -21,5 +21,4 @@ var InputEvent;
     InputEvent["MOUSE_DOWN"] = "MOUSE_DOWN";
     InputEvent["MOUSE_UP"] = "MOUSE_UP";
     InputEvent["EXECUTE_COMMAND"] = "EXECUTE_COMMAND";
-    InputEvent["WAIT"] = "WAIT";
 })(InputEvent = exports.InputEvent || (exports.InputEvent = {}));

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

@@ -1,9 +1,4 @@
 import { CustomElementJson } from '../core/model/test-case-dto';
-export declare enum TimeUnit {
-    MS = "millisecond",
-    S = "seconds",
-    MIN = "minutes"
-}
 export declare type PC_KEY = 'backspace' | 'delete' | 'enter' | 'tab' | 'escape' | 'up' | 'down' | 'right' | 'left' | 'home' | 'end' | 'pageup' | 'pagedown' | 'f1' | 'f2' | 'f3' | 'f4' | 'f5' | 'f6' | 'f7' | 'f8' | 'f9' | 'f10' | 'f11' | 'f12' | 'space' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '!' | '"' | '#' | '$' | '%' | '&' | "'" | '(' | ')' | '*' | '+' | ',' | '-' | '.' | '/' | ':' | ';' | '<' | '=' | '>' | '?' | '@' | '[' | '\\' | ']' | '^' | '_' | '`' | '{' | '|' | '}' | '~ ';
 export declare type ANDROID_KEY = 'home' | 'back' | 'call' | 'endcall' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'star' | 'pound' | 'dpad_up' | 'dpad_down' | 'dpad_left' | 'dpad_right' | 'dpad_center' | 'volume_up' | 'volume_down' | 'power' | 'camera' | 'clear' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'comma' | 'period' | 'alt_left' | 'alt_right' | 'shift_left' | 'shift_right' | 'tab' | 'space' | 'sym' | 'explorer' | 'envelope' | 'enter' | 'del' | 'grave' | 'minus' | 'equals' | 'left_bracket' | 'right_bracket' | 'backslash' | 'semicolon' | 'apostrophe' | 'slash' | 'at' | 'num' | 'headsethook' | 'focus' | 'plus' | 'menu' | 'notification' | 'search' | 'media_play_pause' | 'media_stop' | 'media_next' | 'media_previous' | 'media_rewind' | 'media_fast_forward' | 'mute' | 'page_up' | 'page_down' | 'switch_charset' | 'escape' | 'forward_del' | 'ctrl_left' | 'ctrl_right' | 'caps_lock' | 'scroll_lock' | 'function' | 'break' | 'move_home' | 'move_end' | 'insert' | 'forward' | 'media_play' | 'media_pause' | 'media_close' | 'media_eject' | 'media_record' | 'f1' | 'f2' | 'f3' | 'f4' | 'f5' | 'f6' | 'f7' | 'f8' | 'f9' | 'f10' | 'f11' | 'f12' | 'num_lock' | 'numpad_0' | 'numpad_1' | 'numpad_2' | 'numpad_3' | 'numpad_4' | 'numpad_5' | 'numpad_6' | 'numpad_7' | 'numpad_8' | 'numpad_9' | 'numpad_divide' | 'numpad_multiply' | 'numpad_subtract' | 'numpad_add' | 'numpad_dot' | 'numpad_comma' | 'numpad_enter' | 'numpad_equals' | 'numpad_left_paren' | 'numpad_right_paren' | 'volume_mute' | 'info' | 'channel_up' | 'channel_down' | 'zoom_in' | 'zoom_out' | 'window' | 'guide' | 'bookmark' | 'captions' | 'settings' | 'app_switch' | 'language_switch' | 'contacts' | 'calendar' | 'music' | 'calculator' | 'assist' | 'brightness_down' | 'brightness_up' | 'media_audio_track' | 'sleep' | 'wakeup' | 'pairing' | 'media_top_menu' | 'last_channel' | 'tv_data_service' | 'voice_assist' | 'help' | 'navigate_previous' | 'navigate_next' | 'navigate_in' | 'navigate_out' | 'dpad_up_left' | 'dpad_down_left' | 'dpad_up_right' | 'dpad_down_right' | 'media_skip_forward' | 'media_skip_backward' | 'media_step_forward' | 'media_step_backward' | 'soft_sleep' | 'cut' | 'copy' | 'paste' | 'all_apps' | 'refresh';
 export declare type MODIFIER_KEY = 'command' | 'alt' | 'control' | 'shift' | 'right_shift';
@@ -19,7 +14,10 @@ declare abstract class FluentBase {
     protected get textStr(): string;
     protected get params(): Map<string, unknown>;
 }
-declare class Exec extends FluentBase {
+export interface Executable {
+    exec(): Promise<void>;
+}
+export declare class Exec extends FluentBase implements Executable {
     exec(): Promise<void>;
 }
 export declare class FluentFilters extends FluentBase {
@@ -1333,14 +1331,14 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     typeIn(text: string): FluentFilters;
     /**
-     * Scrolls in the x and y direction, e.g., until an element is visible.
+     * Moves mouse to the filtered element and scrolls in the x and y direction
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
      * @return {FluentFilters}
      */
-    scrollUntil(x_offset: number, y_offset: number): FluentFilters;
+    scrollInside(x_offset: number, y_offset: number): FluentFilters;
     /**
      * Moves the mouse relatively to an element in the direction.
      * This can be used when the mouse should not hover over on an element anymore.
@@ -1368,15 +1366,6 @@ export declare abstract class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     type(text: string): Exec;
-    /**
-     * Waits for `<timeValue> <timeUnit>`, e.g., 10 seconds.
-     *
-     * @param {number} timeValue - A number of time unit, e.g., ms or min, to wait for.
-     * @param {TimeUnit} timeUnit - A time unit, e.g., ms, s or min.
-     *
-     * @return {Exec}
-     */
-    waitFor(timeValue: number, timeUnit: TimeUnit): Exec;
     /**
      * Moves the mouse from the current position (relative) in x and y direction.
      *

package/dist/cjs/execution/dsl.js

@@ -4,13 +4,7 @@
 /* eslint-disable max-classes-per-file */
 // Autogenerated from typescript.template file
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.TimeUnit = void 0;
-var TimeUnit;
-(function (TimeUnit) {
-    TimeUnit["MS"] = "millisecond";
-    TimeUnit["S"] = "seconds";
-    TimeUnit["MIN"] = "minutes";
-})(TimeUnit = exports.TimeUnit || (exports.TimeUnit = {}));
+exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.Exec = void 0;
 class FluentBase {
     constructor(prev) {
         this.prev = prev;
@@ -47,6 +41,7 @@ class Exec extends FluentBase {
         return this.commandStringBuilder();
     }
 }
+exports.Exec = Exec;
 // Filters
 class FluentFilters extends FluentBase {
     /**
@@ -1877,14 +1872,14 @@ class FluentCommand extends FluentBase {
         return new FluentFilters(this);
     }
     /**
-     * Scrolls in the x and y direction, e.g., until an element is visible.
+     * Moves mouse to the filtered element and scrolls in the x and y direction
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
      * @return {FluentFilters}
      */
-    scrollUntil(x_offset, y_offset) {
+    scrollInside(x_offset, y_offset) {
         this._textStr = `Scroll x ${x_offset} y ${y_offset} in`;
         return new FluentFilters(this);
     }
@@ -1924,18 +1919,6 @@ class FluentCommand extends FluentBase {
         this._textStr = `Type "${text}"`;
         return new Exec(this);
     }
-    /**
-     * Waits for `<timeValue> <timeUnit>`, e.g., 10 seconds.
-     *
-     * @param {number} timeValue - A number of time unit, e.g., ms or min, to wait for.
-     * @param {TimeUnit} timeUnit - A time unit, e.g., ms, s or min.
-     *
-     * @return {Exec}
-     */
-    waitFor(timeValue, timeUnit) {
-        this._textStr = `Wait for ${timeValue} ${timeUnit}`;
-        return new Exec(this);
-    }
     /**
      * Moves the mouse from the current position (relative) in x and y direction.
      *

package/dist/cjs/execution/execution-runtime.d.ts

@@ -1,13 +1,14 @@
 import { TestStep } from '../core/model/test-case-dto';
-import { ControlYourUiClient } from './control-your-ui-client';
-import { ControlYourUiApi } from './control-your-ui-api';
+import { UiControllerClient } from './ui-controller-client';
+import { InferenceClient } from './inference-client';
 import { Annotation } from '../core/annotation/annotation';
 import { CustomElementJson } from '../core/model/test-case-dto/custom-element-json';
 export declare class ExecutionRuntime {
-    private client;
-    private api;
-    constructor(client: ControlYourUiClient, api: ControlYourUiApi);
+    private uiControllerClient;
+    private inferenceClient;
+    constructor(uiControllerClient: UiControllerClient, inferenceClient: InferenceClient);
     executeTestStep(step: TestStep): Promise<void>;
+    private requestControl;
     /**
      * @param {TestStep} step - Test step used for predicting command.
      */
@@ -20,6 +21,7 @@ export declare class ExecutionRuntime {
      * --> retry with linear back-off
      */
     private predictCommandWithRetry;
+    private getImageIfRequired;
     private predictCommand;
     annotateInteractively(): Promise<void>;
     takeScreenshotIfImageisNotProvided(imagePath?: string): Promise<string>;

package/dist/cjs/execution/execution-runtime.js

@@ -15,12 +15,12 @@ const test_case_dto_1 = require("../core/model/test-case-dto");
 const repeat_error_1 = require("./repeat-error");
 const misc_1 = require("./misc");
 const control_command_error_1 = require("./control-command-error");
-const transformations_1 = require("../utils/transformations");
 const logger_1 = require("../lib/logger");
+const base_64_image_1 = require("../utils/base_64_image/base-64-image");
 class ExecutionRuntime {
-    constructor(client, api) {
-        this.client = client;
-        this.api = api;
+    constructor(uiControllerClient, inferenceClient) {
+        this.uiControllerClient = uiControllerClient;
+        this.inferenceClient = inferenceClient;
         this.EXEC_REPETITION_COUNT = 25;
         this.PREDICT_COMMAND_RETRY_COUNT = 2;
     }
@@ -30,6 +30,11 @@ class ExecutionRuntime {
             yield this.executeCommand(step);
         });
     }
+    requestControl(controlCommand) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.uiControllerClient.requestControl(controlCommand);
+        });
+    }
     /**
      * @param {TestStep} step - Test step used for predicting command.
      */
@@ -38,15 +43,13 @@ class ExecutionRuntime {
         return __awaiter(this, void 0, void 0, function* () {
             const controlCommand = yield this.predictCommandWithRetry(step);
             if (controlCommand.code === ui_control_commands_1.ControlCommandCode.OK) {
-                yield this.client.requestControl(controlCommand);
-            }
-            else if (controlCommand.tryToRepeat) {
-                yield this.client.requestControl(controlCommand);
-                this.executeCommandRepeatedly(step);
+                return this.requestControl(controlCommand);
             }
-            else {
-                throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
+            if (controlCommand.tryToRepeat) {
+                yield this.requestControl(controlCommand);
+                return this.executeCommandRepeatedly(step);
             }
+            throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
         });
     }
     executeCommandRepeatedly(step) {
@@ -63,8 +66,8 @@ class ExecutionRuntime {
                 if (controlCommand.code === ui_control_commands_1.ControlCommandCode.OK) {
                     break;
                 }
-                else if (controlCommand.tryToRepeat) {
-                    yield this.client.requestControl(controlCommand);
+                if (controlCommand.tryToRepeat) {
+                    yield this.requestControl(controlCommand);
                 }
                 else {
                     throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
@@ -94,31 +97,40 @@ class ExecutionRuntime {
             return command;
         });
     }
+    getImageIfRequired(instruction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const isImageRequired = yield this.inferenceClient.isImageRequired(instruction);
+            if (!isImageRequired) {
+                return undefined;
+            }
+            const screenshotResponse = yield this.uiControllerClient.requestScreenshot();
+            return screenshotResponse.data.image;
+        });
+    }
     predictCommand(step) {
         return __awaiter(this, void 0, void 0, function* () {
-            const isImageRequired = yield this.api.isImageRequired(step.instruction);
-            let image;
-            if (isImageRequired) {
-                const screenshotResponse = yield this.client.requestScreenshot();
-                image = screenshotResponse.data.image;
+            const image = yield this.getImageIfRequired(step.instruction);
+            const controlCommand = yield this.inferenceClient.predictControlCommand(step.instruction, step.customElements, image);
+            if (step.secretText !== undefined) {
+                controlCommand.setTextToBeTyped(step.secretText);
             }
-            return this.api.predictControlCommand(step.instruction, step.customElements, image);
+            return controlCommand;
         });
     }
     annotateInteractively() {
         return __awaiter(this, void 0, void 0, function* () {
             const annotationResponse = yield this.annotateImage();
-            yield this.client.annotateInteractively(annotationResponse.objects, annotationResponse.image);
+            yield this.uiControllerClient.annotateInteractively(annotationResponse.objects, annotationResponse.image);
         });
     }
     takeScreenshotIfImageisNotProvided(imagePath) {
         return __awaiter(this, void 0, void 0, function* () {
             let base64Image = '';
             if (imagePath !== undefined) {
-                base64Image = yield (0, transformations_1.toBase64Image)(imagePath);
+                base64Image = (yield base_64_image_1.Base64Image.fromPath(imagePath)).toString();
             }
             if (imagePath === undefined) {
-                const screenshotResponse = yield this.client.requestScreenshot();
+                const screenshotResponse = yield this.uiControllerClient.requestScreenshot();
                 base64Image = screenshotResponse.data.image;
             }
             return base64Image;
@@ -131,7 +143,7 @@ class ExecutionRuntime {
             if (customElementJson !== undefined) {
                 customElements = yield test_case_dto_1.CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
             }
-            return this.api.predictImageAnnotation(base64Image, customElements);
+            return this.inferenceClient.predictImageAnnotation(base64Image, customElements);
         });
     }
 }

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

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

package/dist/cjs/execution/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AskuiClient = void 0;
-var client_1 = require("./client");
-Object.defineProperty(exports, "AskuiClient", { enumerable: true, get: function () { return client_1.AskuiClient; } });
+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; } });
+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/{control-your-ui-api.d.ts → inference-client.d.ts}

@@ -2,12 +2,12 @@ import { HttpClientGot } from '../utils/http/http-client-got';
 import { ControlCommand } from '../core/ui-control-commands';
 import { CustomElement } from '../core/model/test-case-dto';
 import { Annotation } from '../core/annotation/annotation';
-export declare class ControlYourUiApi {
-    apiEndpointUrl: string;
+export declare class InferenceClient {
+    url: string;
     httpClient: HttpClientGot;
-    constructor(apiEndpointUrl: string, httpClient: HttpClientGot);
+    constructor(url: string, httpClient: HttpClientGot);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
-    predictControlCommand(instruction: string, customElements: CustomElement[], image?: string): Promise<ControlCommand>;
+    predictControlCommand(instruction: string, customElements?: CustomElement[], image?: string): Promise<ControlCommand>;
     predictImageAnnotation(image: string, customElements?: CustomElement[]): Promise<Annotation>;
 }

package/dist/cjs/execution/{control-your-ui-api.js → inference-client.js}

@@ -12,19 +12,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlYourUiApi = void 0;
+exports.InferenceClient = void 0;
 const url_join_1 = __importDefault(require("url-join"));
 const ui_control_commands_1 = require("../core/ui-control-commands");
 const annotation_1 = require("../core/annotation/annotation");
 const transformations_1 = require("../utils/transformations");
-class ControlYourUiApi {
-    constructor(apiEndpointUrl, httpClient) {
-        this.apiEndpointUrl = apiEndpointUrl;
+class InferenceClient {
+    constructor(url, httpClient) {
+        this.url = url;
         this.httpClient = httpClient;
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = (0, url_join_1.default)(this.apiEndpointUrl, 'instruction', 'is-image-required');
+            const url = (0, url_join_1.default)(this.url, 'instruction', 'is-image-required');
             const httpBody = {
                 instruction,
             };
@@ -41,7 +41,7 @@ class ControlYourUiApi {
             return (0, transformations_1.resizeBase64ImageWithSameRatio)(image);
         });
     }
-    predictControlCommand(instruction, customElements, image) {
+    predictControlCommand(instruction, customElements = [], image) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
             const httpBody = {
@@ -49,7 +49,7 @@ class ControlYourUiApi {
                 instruction,
                 customElements,
             };
-            const url = (0, url_join_1.default)(this.apiEndpointUrl, 'api', 'v1', 'predict-command');
+            const url = (0, url_join_1.default)(this.url, 'api', 'v1', 'predict-command');
             const httpResponse = yield this.httpClient.post(url, httpBody);
             return ui_control_commands_1.ControlCommand.fromJson(httpResponse, resizedImage.resizeRatio);
         });
@@ -61,10 +61,10 @@ class ControlYourUiApi {
                 image: resizedImage.base64Image,
                 customElements,
             };
-            const url = (0, url_join_1.default)(this.apiEndpointUrl, 'annotate', '?format=json');
+            const url = (0, url_join_1.default)(this.url, 'annotate', '?format=json');
             const httpResponse = yield this.httpClient.post(url, httpBody);
             return annotation_1.Annotation.fromJson(Object.assign(Object.assign({}, httpResponse), { image }), resizedImage.resizeRatio);
         });
     }
 }
-exports.ControlYourUiApi = ControlYourUiApi;
+exports.InferenceClient = InferenceClient;

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

@@ -0,0 +1,2 @@
+export declare class UiControlClientError extends Error {
+}

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiControlClientError = void 0;
+class UiControlClientError extends Error {
+}
+exports.UiControlClientError = UiControlClientError;