askui 0.14.0 → 0.16.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

@@ -141,22 +141,6 @@ export declare class UiControlClient extends ApiCommands {
      * @param {string} description
      */
     clickIcon(description: string): Promise<void>;
-    /**
-     * Drags element1 to element2.
-     *
-     * Both must be a `moveMouse()` or `moveMouseTo()`
-     * instruction as in the example below.
-     *
-     * Usage example:
-     * dragTo(
-     *   aui.moveMouseTo().text('AskUI'),
-     *   aui.moveMouseTo().text('UI Automation')
-     * )
-     *
-     * @param {Executable} element1
-     * @param {Executable} element2
-     */
-    dragTo(element1: Executable, element2: Executable): Promise<void>;
     /**
      * Wait until an AskUICommand does not fail.
      *

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

@@ -307,30 +307,6 @@ class UiControlClient extends dsl_1.ApiCommands {
             yield this.click().icon().matching(description).exec();
         });
     }
-    /**
-     * Drags element1 to element2.
-     *
-     * Both must be a `moveMouse()` or `moveMouseTo()`
-     * instruction as in the example below.
-     *
-     * Usage example:
-     * dragTo(
-     *   aui.moveMouseTo().text('AskUI'),
-     *   aui.moveMouseTo().text('UI Automation')
-     * )
-     *
-     * @param {Executable} element1
-     * @param {Executable} element2
-     */
-    dragTo(element1, element2) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield element1.exec();
-            yield this.mouseLeftClick().exec();
-            yield this.mouseToggleDown().exec();
-            yield element2.exec();
-            yield this.mouseToggleUp().exec();
-        });
-    }
     /**
      * Wait until an AskUICommand does not fail.
      *

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 static installTestFrameworkPackages;
     private addUserCredentials;
     private copyESLintConfigFiles;
     private copyTsConfigFile;
-    private installProxy;
-    private normalizeCliOptions;
     createExampleProject(): Promise<void>;
 }

package/dist/cjs/lib/interactive_cli/create-example-project.js

@@ -21,15 +21,14 @@ const listr_1 = __importDefault(require("listr"));
 const chalk_1 = __importDefault(require("chalk"));
 const nunjucks_1 = __importDefault(require("nunjucks"));
 const path_2 = require("../../utils/path");
-const add_script_package_json_1 = require("./add-script-package-json");
+const add_remove_script_package_json_1 = require("./add-remove-script-package-json");
 class CreateExampleProject {
     constructor(cliOptions) {
         this.cliOptions = cliOptions;
         this.baseDirPath = process.cwd();
         this.exampleFolderName = 'askui_example';
         this.distexampleFolderPath = path_1.default.join(this.baseDirPath, this.exampleFolderName);
-        this.proxyDocUrl = 'https://docs.askui.com/docs/general/Troubleshooting/proxy';
-        this.remoteDeviceControllerUrl = 'https://docs.askui.com/docs/api/Remote-Device-Controller';
+        this.askUIControllerUrl = 'https://docs.askui.com/docs/general/Components/AskUI-Controller';
         this.helperTemplateConfig = {};
     }
     copyTemplateProject() {
@@ -64,7 +63,11 @@ class CreateExampleProject {
                 },
                 {
                     title: 'Install askui dependency',
-                    task: () => __awaiter(this, void 0, void 0, function* () { return runCommand('npm i -D askui '); }),
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        yield runCommand('npm init -y');
+                        yield (0, add_remove_script_package_json_1.removeScript)(`${this.baseDirPath}/package.json`, 'test');
+                        yield runCommand('npm i -D askui ');
+                    }),
                 },
             ];
         });
@@ -73,43 +76,38 @@ class CreateExampleProject {
         return __awaiter(this, void 0, void 0, function* () {
             const frameworkConfigs = {
                 jest: 'jest.config.ts',
-                jasmine: 'jasmine.config.json',
             };
-            const configFilePath = path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), 'example_projects_templates', 'configs', frameworkConfigs[this.cliOptions.testFramework]);
-            yield fs_extra_1.default.copyFile(configFilePath, path_1.default.join(this.distexampleFolderPath, frameworkConfigs[this.cliOptions.testFramework]));
+            const configFilePath = path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), 'example_projects_templates', 'configs', frameworkConfigs.jest);
+            yield fs_extra_1.default.copyFile(configFilePath, path_1.default.join(this.distexampleFolderPath, frameworkConfigs.jest));
         });
     }
     addTestFrameWorkTimeout() {
         return __awaiter(this, void 0, void 0, function* () {
             const frameworkTimeoutstring = {
                 jest: 'jest.setTimeout(60 * 1000 * 60);',
-                jasmine: 'jasmine.DEFAULT_TIMEOUT_INTERVAL = 60 * 1000 * 60;',
             };
-            this.helperTemplateConfig['timeout_placeholder'] = frameworkTimeoutstring[this.cliOptions.testFramework];
+            this.helperTemplateConfig['timeout_placeholder'] = frameworkTimeoutstring.jest;
         });
     }
     addReporterConfig() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.cliOptions.testFramework === 'jest') {
-                this.helperTemplateConfig['allure_stepreporter_import'] = "import { AskUIAllureStepReporter } from '@askui/askui-reporters';";
-                this.helperTemplateConfig['reporter_placeholder'] = 'reporter: new AskUIAllureStepReporter(),';
-                this.helperTemplateConfig['allure_stepreporter_attach_video'] = `const video = await aui.readVideoRecording();
+            this.helperTemplateConfig['allure_stepreporter_import'] = "import { AskUIAllureStepReporter } from '@askui/askui-reporters';";
+            this.helperTemplateConfig['reporter_placeholder'] = 'reporter: new AskUIAllureStepReporter(),';
+            this.helperTemplateConfig['allure_stepreporter_attach_video'] = `const video = await aui.readVideoRecording();
   await AskUIAllureStepReporter.attachVideo(video);`;
-            }
         });
     }
     addAskuiRunCommand() {
         return __awaiter(this, void 0, void 0, function* () {
             const frameworkExecutionCommand = {
                 jest: `jest --config ./${this.exampleFolderName}/jest.config.ts --runInBand`,
-                jasmine: `jasmine --config=${this.exampleFolderName}/jasmine.config.json`,
             };
-            yield (0, add_script_package_json_1.addScript)(`${this.baseDirPath}/package.json`, 'askui', frameworkExecutionCommand[this.cliOptions.testFramework]);
+            yield (0, add_remove_script_package_json_1.addScript)(`${this.baseDirPath}/package.json`, 'askui', frameworkExecutionCommand.jest);
         });
     }
     addESLintRunCommand() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, add_script_package_json_1.addScript)(`${this.baseDirPath}/package.json`, 'lint', 'eslint . --ext .ts');
+            yield (0, add_remove_script_package_json_1.addScript)(`${this.baseDirPath}/package.json`, 'lint', 'eslint . --ext .ts');
         });
     }
     createAskUIHelperFromTemplate() {
@@ -147,8 +145,8 @@ class CreateExampleProject {
                     task: () => __awaiter(this, void 0, void 0, function* () {
                         return new listr_1.default([
                             {
-                                title: `Install ${this.cliOptions.testFramework}`,
-                                task: () => __awaiter(this, void 0, void 0, function* () { return this.installTestFrameworkPackages(); }),
+                                title: 'Install jest',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return CreateExampleProject.installTestFrameworkPackages(); }),
                             },
                             {
                                 title: 'Copy config file',
@@ -159,7 +157,7 @@ class CreateExampleProject {
                                 task: () => __awaiter(this, void 0, void 0, function* () { return this.addTestFrameWorkTimeout(); }),
                             },
                             {
-                                title: 'Add reporter (only Jest)',
+                                title: 'Add reporter',
                                 task: () => __awaiter(this, void 0, void 0, function* () { return this.addReporterConfig(); }),
                             },
                             {
@@ -175,33 +173,29 @@ class CreateExampleProject {
                 }];
         });
     }
-    installTestFrameworkPackages() {
+    static installTestFrameworkPackages() {
         return __awaiter(this, void 0, void 0, function* () {
             const runCommand = (0, util_1.promisify)(child_process_1.exec);
-            const frameworkDepencies = {
-                jest: 'npm i -D @askui/askui-reporters typescript ts-node @types/jest ts-jest jest @askui/jest-allure-circus eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-askui',
-                jasmine: 'npm i -D @askui/askui-reporters typescript ts-node @types/jasmine jasmine @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-askui',
+            const frameworkDependencies = {
+                jest: 'npm i -D @askui/askui-reporters typescript ts-node @types/jest ts-jest jest @askui/jest-allure-circus eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-askui hpagent',
             };
-            yield runCommand(frameworkDepencies[this.cliOptions.testFramework]);
+            yield runCommand(frameworkDependencies.jest);
         });
     }
     addUserCredentials() {
         return __awaiter(this, void 0, void 0, function* () {
-            return [{
+            return [
+                {
                     title: 'Add user credentials',
+                    enabled: () => !this.cliOptions.skipCredentials,
                     task: () => __awaiter(this, void 0, void 0, function* () {
-                        return new listr_1.default([
-                            {
-                                title: 'Add workspace id ',
-                                task: () => __awaiter(this, void 0, void 0, function* () { this.helperTemplateConfig['workspace_id'] = this.cliOptions.workspaceId; }),
-                            },
-                            {
-                                title: 'Add access token',
-                                task: () => __awaiter(this, void 0, void 0, function* () { this.helperTemplateConfig['access_token'] = this.cliOptions.accessToken; }),
-                            },
-                        ]);
+                        this.helperTemplateConfig['credentials'] = ` credentials: {
+        workspaceId: '${this.cliOptions.workspaceId}',
+        token: '${this.cliOptions.accessToken}',
+      },`;
                     }),
-                }];
+                },
+            ];
         });
     }
     copyESLintConfigFiles() {
@@ -226,68 +220,47 @@ class CreateExampleProject {
                             },
                         ]);
                     }),
-                }];
+                },
+            ];
         });
     }
     copyTsConfigFile() {
         return __awaiter(this, void 0, void 0, function* () {
             const tsConfigFilePath = path_1.default.join('example_projects_templates', 'typescript', 'tsconfig.json');
-            return [{
+            const tsConfigTargetFilePath = path_1.default.join(this.baseDirPath, 'tsconfig.json');
+            return [
+                {
                     title: 'Copy ts config file',
-                    enabled: () => this.cliOptions.typescriptConfig,
+                    enabled: () => this.cliOptions.typescriptConfig || !fs_extra_1.default.existsSync(tsConfigTargetFilePath),
                     task: () => __awaiter(this, void 0, void 0, function* () {
-                        return fs_extra_1.default.copyFile(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), tsConfigFilePath), path_1.default.join(this.baseDirPath, 'tsconfig.json'));
+                        return fs_extra_1.default.copyFile(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), tsConfigFilePath), tsConfigTargetFilePath);
                     }),
-                }];
-        });
-    }
-    installProxy() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const runCommand = (0, util_1.promisify)(child_process_1.exec);
-            return [{
-                    title: 'Install Proxy',
-                    enabled: () => this.cliOptions.usingProxy,
-                    task: () => __awaiter(this, void 0, void 0, function* () { return runCommand('npm install --save-dev hpagent '); }),
-                }];
+                },
+            ];
         });
     }
-    normalizeCliOptions() {
-        let useProxy = this.cliOptions.usingProxy;
-        if (typeof useProxy !== 'boolean') {
-            useProxy = (useProxy === 'true');
-        }
-        this.cliOptions.usingProxy = useProxy;
-        let { typescriptConfig } = this.cliOptions;
-        if (typeof typescriptConfig !== 'boolean') {
-            typescriptConfig = (typescriptConfig === 'true');
-        }
-        this.cliOptions.typescriptConfig = typescriptConfig;
-    }
     createExampleProject() {
         return __awaiter(this, void 0, void 0, function* () {
             const tasks = new listr_1.default();
-            this.normalizeCliOptions();
             tasks.add([
-                ...yield this.copyTemplateProject(),
-                ...yield this.setupTestFrameWork(),
-                ...yield this.copyESLintConfigFiles(),
-                ...yield this.copyTsConfigFile(),
-                ...yield this.addUserCredentials(),
-                ...yield this.createAskUIHelperFromTemplate(),
-                ...yield this.installProxy(),
+                ...(yield this.copyTemplateProject()),
+                ...(yield this.setupTestFrameWork()),
+                ...(yield this.copyESLintConfigFiles()),
+                ...(yield this.copyTsConfigFile()),
+                ...(yield this.addUserCredentials()),
+                ...(yield this.createAskUIHelperFromTemplate()),
             ]);
             yield tasks.run();
             /* eslint-disable no-console */
-            if (this.cliOptions.usingProxy) {
-                console.log(chalk_1.default.redBright('Since you are using a Proxy. Please don\'t forget to configure it!'));
-                console.log(chalk_1.default.gray(`You can find more information under ${this.proxyDocUrl}`));
-            }
             console.log(chalk_1.default.greenBright('\nCongratulations!'));
             console.log(`askui example was created under ${chalk_1.default.gray(this.distexampleFolderPath)}`);
             if (this.cliOptions.operatingSystem === 'windows') {
-                console.log(chalk_1.default.redBright(`\nPlease install and start the Remote Device Controller: ${this.remoteDeviceControllerUrl}\n`));
+                console.log(chalk_1.default.redBright(`\nPlease make sure the AskUI Controller is running: ${this.askUIControllerUrl}\n`));
+                console.log(`You can start your automation with this command ${chalk_1.default.green('AskUI-RunProject')}`);
+            }
+            else {
+                console.log(`You can start your automation with this command ${chalk_1.default.green('npm run askui')}`);
             }
-            console.log(`You can start your automation with this command ${chalk_1.default.green('npm run askui')}`);
             /* eslint-enable no-console */
         });
     }

package/dist/cjs/lib/logger.d.ts

@@ -1,8 +1,2 @@
-declare const logger: import("pino").Logger<{
-    name: string;
-    level: string;
-    customLevels: {
-        verbose: number;
-    };
-}>;
+declare const logger: import("pino").Logger<"verbose">;
 export { logger };

package/dist/esm/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/esm/execution/read-credentials.js

@@ -0,0 +1,20 @@
+import { logger } from '../lib';
+import { envCredentials } from './read-environment-credentials';
+export function readCredentials(clientArgs) {
+    const environmentCredentials = 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) {
+        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;
+}

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

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