askui 0.2.0 → 0.2.3

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

@@ -23,12 +23,13 @@ const annotation_level_1 = require("./annotation-level");
 const ui_control_client_error_1 = require("./ui-control-client-error");
 const read_environment_credentials_1 = require("./read-environment-credentials");
 const analytics_1 = require("../utils/analytics");
-const getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://localhost:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: annotation_level_1.AnnotationLevel.DISABLED }, clientArgs));
+const getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://127.0.0.1:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: annotation_level_1.AnnotationLevel.DISABLED }, clientArgs));
 class UiControlClient extends dsl_1.FluentCommand {
     constructor(httpClient, clientArgs) {
         super();
         this.httpClient = httpClient;
         this.clientArgs = clientArgs;
+        this.secretText = undefined;
     }
     static build(clientArgs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -88,16 +89,15 @@ class UiControlClient extends dsl_1.FluentCommand {
             }
         });
     }
-    exec(instruction, customElementJson) {
+    exec(instruction, customElementJson = []) {
         return __awaiter(this, void 0, void 0, function* () {
-            let customElements = [];
-            if (customElementJson !== undefined) {
-                customElements = yield test_case_dto_1.CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
-            }
+            const customElements = yield test_case_dto_1.CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
+            const { secretText } = this;
             try {
                 yield this.executionRuntime.executeTestStep({
                     instruction,
                     customElements,
+                    secretText,
                 });
                 yield this.annotateByDefault(test_case_result_dto_1.TestStepState.PASSED, customElements);
                 return yield Promise.resolve();
@@ -108,6 +108,56 @@ class UiControlClient extends dsl_1.FluentCommand {
             }
         });
     }
+    /**
+     * Types a text inside the filtered element.
+     *
+     * By default, the `text` is included in the logs and sent over to the askui Inference server to
+     * predict in which context the typing has to occur. You can exclude the `text` from the logs
+     * and the request to the askui Inference server setting `options.isSecret` to `true`.
+     * This should not change the quality of the prediction of the askui Inference server. In this
+     * case, `options.secretMask` is included in logs and sent over instead of the `text`.
+     *
+     * @param {string} text - A text to type.
+     * @param {Object} [options]
+     * @param {boolean} [options.isSecret = false] - If set to `true`, `text` is neither included in
+     *   logs of askui nor sent over to askui Inference for prediction.
+     * @param {string} [options.secretMask = '****'] - If `options.isSecret` is set to `true`, this
+     *   is included in logs and sent over to askui Inference for prediction instead of the `text`.
+     *
+     * @return {FluentFilters}
+     */
+    typeIn(text, { isSecret = false, secretMask = '****' } = {}) {
+        if (isSecret) {
+            this.secretText = text;
+            return super.typeIn(secretMask);
+        }
+        return super.typeIn(text);
+    }
+    /**
+     * Types a text at the current position.
+     *
+     * By default, the `text` is included in the logs and sent over to the askui Inference server to
+     * predict in which context the typing has to occur. You can exclude the `text` from the logs
+     * and the request to the askui Inference server setting `options.isSecret` to `true`.
+     * This should not change the quality of the prediction of the askui Inference server. In this
+     * case, `options.secretMask` is included in logs and sent over instead of the `text`.
+     *
+     * @param {string} text - A text to type.
+     * @param {Object} options
+     * @param {boolean} [options.isSecret = false] - If set to `true`, `text` is neither included in
+     *   logs of askui nor sent over to askui Inference for prediction.
+     * @param {string} [options.secretMask = '****'] - If `options.isSecret` is set to `true`, this
+     *   is included in logs and sent over to askui Inference for prediction instead of the `text`.
+     *
+     * @return {Exec}
+     */
+    type(text, { isSecret = false, secretMask = '****' } = {}) {
+        if (isSecret) {
+            this.secretText = text;
+            return super.type(secretMask);
+        }
+        return super.type(text);
+    }
     /**
      * Waits for `<delayInMs>` ms, e.g., 1000 ms. The exact delay may be a little longer
      * than `<delayInMs>` but never shorter than that.

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

@@ -3,7 +3,7 @@ import { AnnotationLevel } from './annotation-level';
 /**
  * Configuration options for the askui UI Control Client
  *
- * @param {string} uiControllerUrl - Default: http://localhost:6769
+ * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
  * The adress of the askui UI Controller server.
  * @param {string} inferenceClientUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.

package/dist/cjs/lib/copy-example-project.js

@@ -7,6 +7,7 @@ exports.init = void 0;
 const commander_1 = require("commander");
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_2 = require("../utils/path");
 const createProgram = () => {
     const program = new commander_1.Command('askui');
     program.usage('<command> [options]');
@@ -14,7 +15,7 @@ const createProgram = () => {
 };
 function copyExampleProject() {
     const exampleProjectPath = path_1.default.join('example_projects_templates', 'typescript_jest');
-    fs_extra_1.default.copySync(path_1.default.join(__dirname, '..', '..', exampleProjectPath), '.');
+    fs_extra_1.default.copySync(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), exampleProjectPath), '.');
 }
 function init(argv) {
     const args = argv || process.argv;

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

@@ -8,6 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const got_1 = __importDefault(require("got"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
+const path_2 = require("../utils/path");
 const logger_1 = require("./logger");
 var SupportedPlatform;
 (function (SupportedPlatform) {
@@ -35,7 +36,7 @@ function buildBinaryNotAvailbleError(binaryVersion) {
     return new Error(`It seems that the UI Controller version "${binaryVersion}" for your system "${platform()} ${os_1.default.arch}" is not availble, Please contact as at info@askui.com for more information`);
 }
 function getBinaryPath(version) {
-    return path_1.default.join(__dirname, '..', '..', 'release', version, ...binarySubPathsByPlatform[platform()]);
+    return path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), 'release', version, ...binarySubPathsByPlatform[platform()]);
 }
 exports.getBinaryPath = getBinaryPath;
 function getBinaryDownloadUrl(binaryVersion) {

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

@@ -129,7 +129,7 @@ class UiControllerFacade {
             }
             catch (err) {
                 throw new Error(`The UI Controller could not be started. Log file :  ${this.serverLogFile}. ErrorReason: ${err}
-      Check this website for more information: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems`);
+      Check this website for more information: https://docs.askui.com/docs/general/Troubleshooting`);
             }
         });
     }

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

@@ -27,7 +27,7 @@ class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
             const runCommand = (0, util_1.promisify)(child_process_1.exec);
             const waylandStatus = yield runCommand('echo $WAYLAND_DISPLAY');
             if (waylandStatus.stdout.trim().includes('wayland')) {
-                throw new wayland_error_1.WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems#wayland');
+                throw new wayland_error_1.WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/linux#wayland');
             }
             /* First we want to check if the user is using a debian distribution.
             * and in the following if libfuse2 is installed.
@@ -44,7 +44,7 @@ class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
                 yield runCommand('dpkg -s libfuse2 | grep Status');
             }
             catch (_a) {
-                throw new libfuse_error_1.LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems#libfuse2');
+                throw new libfuse_error_1.LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2');
             }
         });
     }

package/dist/cjs/utils/analytics/analytics.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Analytics = void 0;
 const os_1 = __importDefault(require("os"));
 const user_identifier_1 = require("./user-identifier");
+const installation_timestamp_1 = require("./installation-timestamp");
 class Analytics {
     constructor() {
         this.userIdentifier = new user_identifier_1.UserIdentifier();
@@ -22,10 +23,15 @@ class Analytics {
     getAnalyticsHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const userID = yield this.userIdentifier.userId();
-            return {
+            const headers = {
                 'askui-user-id': userID,
                 'askui-user-agent': `os:${os_1.default.platform()};arch:${os_1.default.arch()}`,
             };
+            const askuiInstalledAt = yield installation_timestamp_1.InstallationTimestamp.get();
+            if (askuiInstalledAt) {
+                headers['askui-installed-at'] = askuiInstalledAt.toISOString();
+            }
+            return headers;
         });
     }
 }

package/dist/cjs/utils/analytics/installation-timestamp-create-error.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+export declare class InstallationTimestampCreateError extends Error {
+    constructor(err: NodeJS.ErrnoException);
+}

package/dist/cjs/utils/analytics/installation-timestamp-create-error.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallationTimestampCreateError = void 0;
+class InstallationTimestampCreateError extends Error {
+    constructor(err) {
+        super(`Installation timestamp could not be created. \n${err.message}`);
+    }
+}
+exports.InstallationTimestampCreateError = InstallationTimestampCreateError;

package/dist/cjs/utils/analytics/installation-timestamp-get-error.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+export declare class InstallationTimestampGetError extends Error {
+    constructor(err: NodeJS.ErrnoException);
+}

package/dist/cjs/utils/analytics/installation-timestamp-get-error.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallationTimestampGetError = void 0;
+class InstallationTimestampGetError extends Error {
+    constructor(err) {
+        super(`Installation timestamp does not exist. Try reinstalling the lib to create it. \n${err.message}`);
+    }
+}
+exports.InstallationTimestampGetError = InstallationTimestampGetError;

package/dist/cjs/utils/analytics/installation-timestamp.d.ts

@@ -0,0 +1,7 @@
+export declare abstract class InstallationTimestamp {
+    private static fileName;
+    private static value?;
+    static create(): Promise<void>;
+    static get(): Promise<Date | null>;
+    private static getFromFile;
+}

package/dist/cjs/utils/analytics/installation-timestamp.js

@@ -0,0 +1,68 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallationTimestamp = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const lib_1 = require("../../lib");
+const installation_timestamp_create_error_1 = require("./installation-timestamp-create-error");
+const installation_timestamp_get_error_1 = require("./installation-timestamp-get-error");
+const path_2 = require("../path");
+class InstallationTimestamp {
+    static create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const timestamp = new Date().toISOString();
+            return new Promise((resolve, reject) => {
+                fs_1.default.writeFile(InstallationTimestamp.fileName, timestamp, { encoding: 'utf-8' }, (err) => {
+                    if (err) {
+                        reject(new installation_timestamp_create_error_1.InstallationTimestampCreateError(err));
+                    }
+                    else {
+                        resolve();
+                    }
+                });
+            });
+        });
+    }
+    static get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (InstallationTimestamp.value === undefined) {
+                try {
+                    InstallationTimestamp.value = yield this.getFromFile();
+                }
+                catch (err) {
+                    InstallationTimestamp.value = null;
+                    lib_1.logger.warn(err.message);
+                }
+            }
+            return InstallationTimestamp.value;
+        });
+    }
+    static getFromFile() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                fs_1.default.readFile(InstallationTimestamp.fileName, 'utf-8', (err, isoDateStr) => {
+                    if (err) {
+                        reject(new installation_timestamp_get_error_1.InstallationTimestampGetError(err));
+                    }
+                    else {
+                        resolve(new Date(isoDateStr));
+                    }
+                });
+            });
+        });
+    }
+}
+exports.InstallationTimestamp = InstallationTimestamp;
+InstallationTimestamp.fileName = path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), 'install-timestamp');

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

@@ -1,5 +1,5 @@
 export interface CredentialArgs {
-    tenant: string;
+    workspaceId: string;
     email: string;
     token: string;
 }

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

@@ -12,7 +12,7 @@ class Credentials {
         return Buffer.from(`${this.userName}:${this.credentials.token}`);
     }
     get userName() {
-        return `${this.credentials.tenant}|${this.credentials.email}`;
+        return `${this.credentials.workspaceId}|${this.credentials.email}`;
     }
 }
 exports.Credentials = Credentials;

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

@@ -4,8 +4,8 @@ const credentials_1 = require("./credentials");
 describe('Credentials', () => {
     describe('base64Encoded()', () => {
         test('should return base64-encoded credentials', () => {
-            const credentials = new credentials_1.Credentials({ tenant: 'tenant', email: 'name@tenant.com', token: 'password' });
-            expect(credentials.base64Encoded).toBe('dGVuYW50fG5hbWVAdGVuYW50LmNvbTpwYXNzd29yZA==');
+            const credentials = new credentials_1.Credentials({ workspaceId: 'id123', email: 'name@tenant.com', token: 'password' });
+            expect(credentials.base64Encoded).toBe('aWQxMjN8bmFtZUB0ZW5hbnQuY29tOnBhc3N3b3Jk');
         });
     });
 });

package/dist/cjs/utils/path.d.ts

@@ -0,0 +1 @@
+export declare function getPathToNodeModulesRoot(): string;

package/dist/cjs/utils/path.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPathToNodeModulesRoot = void 0;
+const path_1 = __importDefault(require("path"));
+function getPathToNodeModulesRoot() {
+    return path_1.default.join(__dirname, '..', '..');
+}
+exports.getPathToNodeModulesRoot = getPathToNodeModulesRoot;

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

@@ -1,2 +1 @@
 export { CustomElement } from './custom-element';
-export { TestStep } from './test-step';

package/dist/esm/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/esm/core/model/test-case-dto/test-step.js

@@ -1,10 +1 @@
-import { CustomElement } from './custom-element';
-export class TestStep {
-    constructor(instruction, customElements = []) {
-        this.instruction = instruction;
-        this.customElements = customElements;
-    }
-    static fromJson(step) {
-        return new TestStep(step.instruction, (step.customElements || []).map((customELement) => CustomElement.fromJson(customELement)));
-    }
-}
+export {};

package/dist/esm/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/esm/core/ui-control-commands/control-command.js

@@ -1,5 +1,6 @@
 import { Action } from './action';
 import { ControlCommandCode } from './control-command-code';
+import { InputEvent } from './input-event';
 export class ControlCommand {
     constructor(code, actions, tryToRepeat = false) {
         this.code = code;
@@ -9,4 +10,8 @@ export class ControlCommand {
     static fromJson(json, resizeRatio = 1) {
         return new ControlCommand(ControlCommandCode[json.code], json.actions.map((action) => Action.fromJson(action, resizeRatio)), json.tryToRepeat);
     }
+    setTextToBeTyped(text) {
+        this.actions = this.actions.map((action) => ([InputEvent.TYPE, InputEvent.TYPE_TEXT].includes(action.inputEvent)
+            ? new Action(action.inputEvent, action.position, text) : action));
+    }
 }

package/dist/esm/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/esm/core/ui-control-commands/input-event.js

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

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

@@ -426,6 +426,15 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelations}
      */
     icon(): FluentFiltersOrRelations;
@@ -461,6 +470,22 @@ export declare class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withText(text: string): FluentFiltersOrRelations;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelations;
     /**
      * Filters for equal text.
      *
@@ -1060,6 +1085,15 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon(): FluentFiltersOrRelationsCondition;
@@ -1095,6 +1129,22 @@ export declare class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withText(text: string): FluentFiltersOrRelationsCondition;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelationsCondition;
     /**
      * Filters for equal text.
      *
@@ -1331,7 +1381,7 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     typeIn(text: string): FluentFilters;
     /**
-     * Moves mouse to the filtered element and scrolls in the x and y direction
+     * 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.