askui 0.13.1 → 0.15.0

package/README.md

@@ -1,9 +1,8 @@
-# AskUI - Humanizing UI Automation
+# AskUI - What Can Be Said Can Be Solved
 
 **AskUI** allows you to automate the interaction with an application, multiple applications or even the entire operating system. 
 You can use this to write end-to-end tests or automate any kind of application.
 
-
 ## Start
 
 To use **AskUI** follow these steps:

package/dist/cjs/execution/read-credentials.d.ts

@@ -0,0 +1,3 @@
+import { CredentialArgs } from './credentials-args';
+import { ClientArgs } from './ui-controller-client-interface';
+export declare function readCredentials(clientArgs: ClientArgs): CredentialArgs;

package/dist/cjs/execution/read-credentials.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readCredentials = void 0;
+const lib_1 = require("../lib");
+const read_environment_credentials_1 = require("./read-environment-credentials");
+function readCredentials(clientArgs) {
+    const environmentCredentials = (0, read_environment_credentials_1.envCredentials)();
+    const inCodeCredentials = clientArgs.credentials;
+    const credentials = inCodeCredentials !== null && inCodeCredentials !== void 0 ? inCodeCredentials : environmentCredentials;
+    if (!credentials) {
+        throw new Error('No credentials are defined! Please define a token and a Workspace ID in the environment variables ASKUI_TOKEN and ASKUI_WORKSPACE_ID or define them in the UiControlClient.build.');
+    }
+    if (!(credentials === null || credentials === void 0 ? void 0 : credentials.token)) {
+        throw new Error('No Token is defined! Please define a token in the environment variable ASKUI_TOKEN or define a token in the UiControlClient.');
+    }
+    if (!(credentials === null || credentials === void 0 ? void 0 : credentials.workspaceId)) {
+        throw new Error('No Workspace ID is defined! Please define a workspace ID in the environment variable ASKUI_WORKSPACE_ID or define a workspace ID in the UiControlClient.');
+    }
+    if (environmentCredentials && inCodeCredentials) {
+        lib_1.logger.warn('In-code credentials in UiControlClient.build and ENV variables(ASKUI_WORKSPACE_ID und ASKUI_TOKEN) are defined! We recommend to remove the in-code credentials for security reason! In-code credentials will be used for this execution.');
+    }
+    return credentials;
+}
+exports.readCredentials = readCredentials;

package/dist/cjs/execution/read-environment-credentials.js

@@ -6,7 +6,7 @@ function envCredentials() {
     const envToken = process.env['ASKUI_TOKEN'];
     const envWorkspaceId = process.env['ASKUI_WORKSPACE_ID'];
     if (envToken && envWorkspaceId) {
-        lib_1.logger.info('Credentials are used from ENV variables: ASKUI_TOKEN and ASKUI_WORKSPACE_ID');
+        lib_1.logger.debug('AskUI credentials are being read from ENV variables: ASKUI_TOKEN and ASKUI_WORKSPACE_ID');
         return {
             workspaceId: envWorkspaceId,
             token: envToken,

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

@@ -13,11 +13,11 @@ exports.UiControlClientDependencyBuilder = void 0;
 const http_client_got_1 = require("../utils/http/http-client-got");
 const ui_controller_client_1 = require("./ui-controller-client");
 const inference_client_1 = require("./inference-client");
-const read_environment_credentials_1 = require("./read-environment-credentials");
 const analytics_1 = require("../utils/analytics");
 const proxy_builder_1 = require("../utils/proxy/proxy-builder");
 const execution_runtime_1 = require("./execution-runtime");
 const reporting_1 = require("../core/reporting");
+const read_credentials_1 = require("./read-credentials");
 class UiControlClientDependencyBuilder {
     static buildHttpClient(clientArgs) {
         var _a;
@@ -50,9 +50,9 @@ class UiControlClientDependencyBuilder {
         });
     }
     static getClientArgsWithDefaults(clientArgs) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            return Object.assign(Object.assign({}, clientArgs), { uiControllerUrl: (_a = clientArgs.uiControllerUrl) !== null && _a !== void 0 ? _a : 'http://127.0.0.1:6769', inferenceServerUrl: (_b = clientArgs.inferenceServerUrl) !== null && _b !== void 0 ? _b : 'https://inference.askui.com', credentials: (_c = clientArgs.credentials) !== null && _c !== void 0 ? _c : (0, read_environment_credentials_1.envCredentials)(), proxyAgents: (_d = clientArgs.proxyAgents) !== null && _d !== void 0 ? _d : yield (0, proxy_builder_1.envProxyAgents)() });
+            return Object.assign(Object.assign({}, clientArgs), { uiControllerUrl: (_a = clientArgs.uiControllerUrl) !== null && _a !== void 0 ? _a : 'http://127.0.0.1:6769', inferenceServerUrl: (_b = clientArgs.inferenceServerUrl) !== null && _b !== void 0 ? _b : 'https://inference.askui.com', credentials: (0, read_credentials_1.readCredentials)(clientArgs), proxyAgents: (_c = clientArgs.proxyAgents) !== null && _c !== void 0 ? _c : (yield (0, proxy_builder_1.envProxyAgents)()) });
         });
     }
 }

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

@@ -1,5 +1,5 @@
 import { CustomElementJson } from '../core/model/custom-element-json';
-import { Exec, Executable, FluentFilters, ApiCommands } from './dsl';
+import { Exec, Executable, FluentFilters, ApiCommands, PC_AND_MODIFIER_KEY } from './dsl';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 import { Annotation } from '../core/annotation/annotation';
 import { AnnotationRequest } from '../core/model/annotation-result/annotation-interface';
@@ -56,8 +56,8 @@ export declare class UiControlClient extends ApiCommands {
      * @return {FluentFilters}
      */
     typeIn(text: string, { isSecret, secretMask }?: {
-        isSecret?: boolean | undefined;
-        secretMask?: string | undefined;
+        isSecret?: boolean;
+        secretMask?: string;
     }): FluentFilters;
     /**
      * Types a text at the current position.
@@ -78,8 +78,8 @@ export declare class UiControlClient extends ApiCommands {
      * @return {Exec}
      */
     type(text: string, { isSecret, secretMask }?: {
-        isSecret?: boolean | undefined;
-        secretMask?: string | undefined;
+        isSecret?: boolean;
+        secretMask?: string;
     }): Exec;
     /**
      * Waits for `<delayInMs>` ms, e.g., 1000 ms. The exact delay may be a little longer
@@ -90,4 +90,69 @@ export declare class UiControlClient extends ApiCommands {
      * @return {Executable}
      */
     waitFor(delayInMs: number): Executable;
+    /**
+     * Press a key multiple times. At least two times.
+     *
+     * @param {PC_AND_MODIFIER_KEY} key
+     *
+     * @param {number} times
+     */
+    pressKeyNTimes(key: PC_AND_MODIFIER_KEY, times?: number): Promise<void>;
+    /**
+     * Press an array of keys one after another.
+     *
+     * For example press the following keys: right, left, enter.
+     *
+     * pressKeys(['right', 'left', 'enter'])
+     *
+     * @param {PC_AND_MODIFIER_KEY[]} keys
+     */
+    pressKeys(keys: PC_AND_MODIFIER_KEY[]): Promise<void>;
+    /**
+     * Searches for a text element and clicks it when found.
+     *
+     * @param {string} text - A text to be searched.
+     */
+    clickText(text: string): Promise<void>;
+    /**
+     * Searches for text elements and clicks them
+     * one after another when found.
+     *
+     * @param {string[]} texts - An array of texts to be searched.
+     */
+    clickTexts(texts: string[]): Promise<void>;
+    /**
+     * Searches for an element of type button
+     * with a label and clicks it when found.
+     *
+     * @param {string} label - The buttons label.
+     */
+    clickButton(label: string): Promise<void>;
+    /**
+     * Searches for an element of type textfield with a specific placeholder text.
+     * If found, clicks it.
+     *
+     * @param {string} placeholder - The textfields placeholder text.
+     */
+    clickTextfield(placeholder: string): Promise<void>;
+    /**
+     * Clicks an icon based on a description.
+     *
+     * @param {string} description
+     */
+    clickIcon(description: string): Promise<void>;
+    /**
+     * Wait until an AskUICommand does not fail.
+     *
+     * Use it to wait for an element to appear like this:
+     *
+     * await waitUntil(
+     *     aui.expect().text('Github').exists()
+     *   );
+     *
+     * @param {Executable} AskUICommand - For example: aui.moveMouse(0, 0)
+     * @param {number} maxTry - Number of maximum retries
+     * @param {number} waitTime - Time in milliseconds
+     */
+    waitUntil(AskUICommand: Executable, maxTry?: number, waitTime?: number): Promise<void>;
 }

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

@@ -217,5 +217,122 @@ class UiControlClient extends dsl_1.ApiCommands {
             },
         };
     }
+    /**
+     * Press a key multiple times. At least two times.
+     *
+     * @param {PC_AND_MODIFIER_KEY} key
+     *
+     * @param {number} times
+     */
+    pressKeyNTimes(key, times = 2) {
+        return __awaiter(this, void 0, void 0, function* () {
+            /* eslint-disable no-await-in-loop */
+            for (let i = 0; i < times; i += 1) {
+                yield this.pressKey(key).exec();
+            }
+        });
+    }
+    /**
+     * Press an array of keys one after another.
+     *
+     * For example press the following keys: right, left, enter.
+     *
+     * pressKeys(['right', 'left', 'enter'])
+     *
+     * @param {PC_AND_MODIFIER_KEY[]} keys
+     */
+    pressKeys(keys) {
+        return __awaiter(this, void 0, void 0, function* () {
+            /* eslint-disable no-await-in-loop */
+            for (let i = 0; i < keys.length; i += 1) {
+                yield this.pressKey(keys[i]).exec();
+            }
+        });
+    }
+    /**
+     * Searches for a text element and clicks it when found.
+     *
+     * @param {string} text - A text to be searched.
+     */
+    clickText(text) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.click().text(text).exec();
+        });
+    }
+    /**
+     * Searches for text elements and clicks them
+     * one after another when found.
+     *
+     * @param {string[]} texts - An array of texts to be searched.
+     */
+    clickTexts(texts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            /* eslint-disable no-await-in-loop */
+            for (let i = 0; i < texts.length; i += 1) {
+                yield this.click().text(texts[i]).exec();
+            }
+        });
+    }
+    /**
+     * Searches for an element of type button
+     * with a label and clicks it when found.
+     *
+     * @param {string} label - The buttons label.
+     */
+    clickButton(label) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.click().button().withText(label).exec();
+        });
+    }
+    /**
+     * Searches for an element of type textfield with a specific placeholder text.
+     * If found, clicks it.
+     *
+     * @param {string} placeholder - The textfields placeholder text.
+     */
+    clickTextfield(placeholder) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.click().textfield().contains().text()
+                .withText(placeholder)
+                .exec();
+        });
+    }
+    /**
+     * Clicks an icon based on a description.
+     *
+     * @param {string} description
+     */
+    clickIcon(description) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.click().icon().matching(description).exec();
+        });
+    }
+    /**
+     * Wait until an AskUICommand does not fail.
+     *
+     * Use it to wait for an element to appear like this:
+     *
+     * await waitUntil(
+     *     aui.expect().text('Github').exists()
+     *   );
+     *
+     * @param {Executable} AskUICommand - For example: aui.moveMouse(0, 0)
+     * @param {number} maxTry - Number of maximum retries
+     * @param {number} waitTime - Time in milliseconds
+     */
+    waitUntil(AskUICommand, maxTry = 5, waitTime = 2000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield AskUICommand.exec();
+            }
+            catch (error) {
+                if (maxTry === 0) {
+                    throw error;
+                }
+                yield this.waitFor(waitTime).exec();
+                yield this.waitUntil(AskUICommand, maxTry - 1);
+            }
+        });
+    }
 }
 exports.UiControlClient = UiControlClient;

package/dist/cjs/lib/interactive_cli/{add-script-package-json.d.ts → add-remove-script-package-json.d.ts}

@@ -1 +1,2 @@
 export declare function addScript(filePath: string, name: string, command: string): Promise<void>;
+export declare function removeScript(filePath: string, name: string): Promise<void>;

package/dist/cjs/lib/interactive_cli/{add-script-package-json.js → add-remove-script-package-json.js}

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addScript = void 0;
+exports.removeScript = exports.addScript = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const logger_1 = require("../logger");
 function addScript(filePath, name, command) {
@@ -30,9 +30,28 @@ function addScript(filePath, name, command) {
             yield fs_extra_1.default.writeFile(filePath, jsonString, 'utf8');
         }
         catch (error) {
-            logger_1.logger.error(`Could write script '${command}' in file '${filePath}'`);
+            logger_1.logger.error(`Could not write script '${command}' in file '${filePath}'`);
             logger_1.logger.error(error.message);
         }
     });
 }
 exports.addScript = addScript;
+function removeScript(filePath, name) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const data = yield fs_extra_1.default.readFile(filePath, 'utf8');
+            const jsonData = JSON.parse(data);
+            if (jsonData.scripts === undefined) {
+                return;
+            }
+            delete jsonData.scripts[name];
+            const jsonString = JSON.stringify(jsonData, null, 2);
+            yield fs_extra_1.default.writeFile(filePath, jsonString, 'utf8');
+        }
+        catch (error) {
+            logger_1.logger.error(`Could not remove script '${name}' in file '${filePath}'`);
+            logger_1.logger.error(error.message);
+        }
+    });
+}
+exports.removeScript = removeScript;

package/dist/cjs/lib/interactive_cli/cli-options-interface.d.ts

@@ -1,8 +1,8 @@
 export interface CliOptions {
+    skipCredentials: boolean;
     operatingSystem: 'windows' | 'linux' | 'macos';
     workspaceId: string;
     accessToken: string;
-    testFramework: 'jasmine' | 'jest';
-    usingProxy: boolean;
+    testFramework: 'jest';
     typescriptConfig: boolean;
 }

package/dist/cjs/lib/interactive_cli/cli.js

@@ -15,65 +15,65 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
 const inquirer_1 = __importDefault(require("inquirer"));
 const commander_1 = require("commander");
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const create_example_project_1 = require("./create-example-project");
-const nonEmpty = (subject) => (input) => (input.trim().length > 0) || `${subject} is required.`;
+const nonEmpty = (subject) => (input) => input.trim().length > 0 || `${subject} is required.`;
 const questions = [
     {
         type: 'list',
         name: 'testFramework',
-        message: 'Which framework do you prefer',
-        choices: ['jest', 'jasmine'],
+        message: 'Which framework do you prefer?:',
+        choices: ['jest'],
     },
     {
         type: 'input',
         name: 'workspaceId',
-        message: 'Your workspace id',
+        message: 'Your workspace id:',
         validate: nonEmpty('workspace id'),
+        when: (answers) => !answers.skipCredentials,
     },
     {
         type: 'password',
         name: 'accessToken',
-        message: 'Your access token',
+        message: 'Your access token:',
         mask: '*',
         validate: nonEmpty('access token'),
-    },
-    {
-        type: 'confirm',
-        name: 'usingProxy',
-        message: 'Are you using a proxy?',
-        default: false,
+        when: (answers) => !answers.skipCredentials,
     },
     {
         type: 'confirm',
         name: 'typescriptConfig',
-        message: 'Do you want to add the tsconfig.json file? This action will overwrite the file if it exists. Default True ',
-        default: true,
+        message: 'Do you want to overwrite the tsconfig.json file? Default No:',
+        default: false,
+        when: (_answers) => fs_extra_1.default.existsSync('tsconfig.json'),
     },
 ];
 const options = [
     {
         option: '-f, --test-framework <value>',
-        choices: ['jasmine', 'jest'],
-        description: 'the test framework to use',
+        choices: ['jest'],
+        description: 'the test framework to use.',
+        default: 'jest',
     },
     {
-        option: '-w, --workspace-id <value>',
+        option: '-sc, --skip-credentials',
         choices: [],
-        description: 'a workspace id',
+        description: 'skip the credentials setup.',
+        default: false,
     },
     {
-        option: '-a, --access-token <value>',
+        option: '-w, --workspace-id <value>',
         choices: [],
-        description: 'an access token for the workspace with the id',
+        description: 'a workspace id.',
     },
     {
-        option: '-p, --using-proxy <value>',
-        choices: ['true', 'false'],
-        description: 'use a proxy',
+        option: '-a, --access-token <value>',
+        choices: [],
+        description: 'an access token for the workspace with the id.',
     },
     {
-        option: '-t, --typescript-config <value>',
-        choices: ['true', 'false'],
+        option: '-t, --typescript-config',
+        choices: [],
         description: 'overwrite tsconfig.json flag',
     },
 ];
@@ -86,29 +86,26 @@ function init(argv) {
     const args = argv || process.argv;
     const program = createProgram();
     const programInit = program.command('init');
-    programInit.description('Creates a askui example project');
+    // To Ensure Backwards Compatibility
+    programInit.allowUnknownOption(true);
+    programInit.description('Creates an AskUI example project:');
     // Loop through the options object and register each option with the program
     options.forEach((opt) => {
         const tempOption = new commander_1.Option(opt.option, opt.description);
         if (opt.choices.length > 0) {
             tempOption.choices(opt.choices);
         }
+        if (opt.default) {
+            tempOption.default(opt.default);
+        }
         programInit.addOption(tempOption);
     });
-    programInit.usage('[-f test_framework] [-w workspace_id] [-a access_token] [-p boolean] [-t boolean]');
-    programInit
-        .action((_opts) => __awaiter(this, void 0, void 0, function* () {
+    programInit.usage('[options]');
+    programInit.action((_opts) => __awaiter(this, void 0, void 0, function* () {
         const userAnswers = programInit.opts();
-        // Check which options are missing and prompt the user for them
-        const missingOptions = questions.filter((entry) => !(entry.name in userAnswers));
-        if (missingOptions.length > 0) {
-            inquirer_1.default.prompt(missingOptions).then((answers) => __awaiter(this, void 0, void 0, function* () {
-                yield new create_example_project_1.CreateExampleProject(Object.assign(Object.assign({}, userAnswers), answers)).createExampleProject();
-            }));
-        }
-        else {
-            yield new create_example_project_1.CreateExampleProject(userAnswers).createExampleProject();
-        }
+        inquirer_1.default.prompt(questions, userAnswers).then((answers) => __awaiter(this, void 0, void 0, function* () {
+            yield new create_example_project_1.CreateExampleProject(Object.assign(Object.assign({}, userAnswers), answers)).createExampleProject();
+        }));
     }));
     return program.parse(args);
 }

package/dist/cjs/lib/interactive_cli/create-example-project.d.ts

@@ -4,8 +4,7 @@ export declare class CreateExampleProject {
     private distexampleFolderPath;
     private exampleFolderName;
     private baseDirPath;
-    private proxyDocUrl;
-    private remoteDeviceControllerUrl;
+    private askUIControllerUrl;
     private helperTemplateConfig;
     constructor(cliOptions: CliOptions);
     private copyTemplateProject;
@@ -16,11 +15,9 @@ export declare class CreateExampleProject {
     private addESLintRunCommand;
     private createAskUIHelperFromTemplate;
     private setupTestFrameWork;
-    private installTestFrameworkPackages;
-    private addUserCredentails;
+    private static installTestFrameworkPackages;
+    private addUserCredentials;
     private copyESLintConfigFiles;
     private copyTsConfigFile;
-    private installProxy;
-    private normalizeCliOptions;
     createExampleProject(): Promise<void>;
 }