askui 0.12.1 → 0.13.0

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

@@ -0,0 +1,293 @@
+"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.CreateExampleProject = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const util_1 = require("util");
+const child_process_1 = require("child_process");
+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");
+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.helperTemplateConfig = {};
+    }
+    copyTemplateProject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const exampleProjectPath = path_1.default.join('example_projects_templates', 'typescript', this.exampleFolderName);
+            const runCommand = (0, util_1.promisify)(child_process_1.exec);
+            return [
+                {
+                    title: 'Detect Operating System',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        if (process.platform === 'win32') {
+                            this.cliOptions.operatingSystem = 'windows';
+                        }
+                        else if (process.platform === 'darwin') {
+                            this.cliOptions.operatingSystem = 'macos';
+                        }
+                        else if (process.platform === 'linux'
+                            || process.platform === 'freebsd'
+                            || process.platform === 'openbsd') {
+                            this.cliOptions.operatingSystem = 'linux';
+                        }
+                        else {
+                            throw new Error(`The detected operating system is ${process.platform}. We only support 'windows', 'macos' and 'linux'`);
+                        }
+                    }),
+                },
+                {
+                    title: 'Copy project files',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        return fs_extra_1.default.copy(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), exampleProjectPath), this.distexampleFolderPath);
+                    }),
+                },
+                {
+                    title: 'Install askui dependency',
+                    task: () => __awaiter(this, void 0, void 0, function* () { return runCommand('npm i -D askui '); }),
+                },
+            ];
+        });
+    }
+    copyTestFrameworkConfig() {
+        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]));
+        });
+    }
+    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];
+        });
+    }
+    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();
+  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]);
+        });
+    }
+    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');
+        });
+    }
+    createAskUIHelperFromTemplate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return [{
+                    title: 'Write askui config',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        return new listr_1.default([
+                            {
+                                title: 'Create askui-helper.ts ',
+                                task: () => __awaiter(this, void 0, void 0, function* () {
+                                    const askuiHelperTemplateFilePath = path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), 'example_projects_templates', 'templates');
+                                    let templateFileName = 'askui-helper.nj';
+                                    if (this.cliOptions.operatingSystem === 'windows') {
+                                        templateFileName = 'askui-helper-windows.nj';
+                                    }
+                                    nunjucks_1.default.configure(askuiHelperTemplateFilePath, { autoescape: false });
+                                    const result = nunjucks_1.default.render(templateFileName, this.helperTemplateConfig);
+                                    const filePath = path_1.default.join(this.distexampleFolderPath, 'helpers', 'askui-helper.ts');
+                                    yield fs_extra_1.default.mkdir(path_1.default.join(this.distexampleFolderPath, 'helpers'));
+                                    yield fs_extra_1.default.writeFile(filePath, result, 'utf8');
+                                }),
+                            },
+                        ]);
+                    }),
+                }];
+        });
+    }
+    setupTestFrameWork() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return [{
+                    title: 'Setup Test framework',
+                    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: 'Copy config file',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return this.copyTestFrameworkConfig(); }),
+                            },
+                            {
+                                title: 'Add timeout',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return this.addTestFrameWorkTimeout(); }),
+                            },
+                            {
+                                title: 'Add reporter (only Jest)',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return this.addReporterConfig(); }),
+                            },
+                            {
+                                title: 'Add askui run command',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return this.addAskuiRunCommand(); }),
+                            },
+                            {
+                                title: 'Add eslint run command',
+                                task: () => __awaiter(this, void 0, void 0, function* () { return this.addESLintRunCommand(); }),
+                            },
+                        ]);
+                    }),
+                }];
+        });
+    }
+    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',
+            };
+            yield runCommand(frameworkDepencies[this.cliOptions.testFramework]);
+        });
+    }
+    addUserCredentails() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return [{
+                    title: 'Add user credentails',
+                    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; }),
+                            },
+                        ]);
+                    }),
+                }];
+        });
+    }
+    copyESLintConfigFiles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const esLintRcFilePath = path_1.default.join('example_projects_templates', 'typescript', '.eslintrc.json-template');
+            const esLintIgnoreFilePath = path_1.default.join('example_projects_templates', 'typescript', '.eslintignore-template');
+            return [{
+                    title: 'Copy ESLint config files',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        return new listr_1.default([
+                            {
+                                title: 'Add eslintrc.json',
+                                task: () => __awaiter(this, void 0, void 0, function* () {
+                                    return fs_extra_1.default.copyFile(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), esLintRcFilePath), path_1.default.join(this.baseDirPath, '.eslintrc.json'));
+                                }),
+                            },
+                            {
+                                title: 'Add .eslintignore',
+                                task: () => __awaiter(this, void 0, void 0, function* () {
+                                    return fs_extra_1.default.copyFile(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), esLintIgnoreFilePath), path_1.default.join(this.baseDirPath, '.eslintignore'));
+                                }),
+                            },
+                        ]);
+                    }),
+                }];
+        });
+    }
+    copyTsConfigFile() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tsConfigFilePath = path_1.default.join('example_projects_templates', 'typescript', 'tsconfig.json');
+            return [{
+                    title: 'Copy ts config file',
+                    enabled: () => this.cliOptions.typescriptConfig,
+                    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'));
+                    }),
+                }];
+        });
+    }
+    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.addUserCredentails(),
+                ...yield this.createAskUIHelperFromTemplate(),
+                ...yield this.installProxy(),
+            ]);
+            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(`You can start your automation with this command ${chalk_1.default.green('npm run askui')}`);
+            /* eslint-enable no-console */
+        });
+    }
+}
+exports.CreateExampleProject = CreateExampleProject;

package/dist/cjs/lib/interactive_cli/index.d.ts

@@ -0,0 +1 @@
+export { init } from './cli';

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = void 0;
+var cli_1 = require("./cli");
+Object.defineProperty(exports, "init", { enumerable: true, get: function () { return cli_1.init; } });

package/dist/cjs/lib/interactive_cli/replace-string-in-file.d.ts

@@ -0,0 +1 @@
+export declare function replaceStringInFile(filePath: string, replace: string, replacement: string): Promise<void>;

package/dist/cjs/lib/interactive_cli/replace-string-in-file.js

@@ -0,0 +1,31 @@
+"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.replaceStringInFile = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const logger_1 = require("../logger");
+function replaceStringInFile(filePath, replace, replacement) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const data = yield fs_extra_1.default.readFile(filePath, 'utf8');
+            const result = data.replace(replace, replacement);
+            yield fs_extra_1.default.writeFile(filePath, result, 'utf8');
+        }
+        catch (error) {
+            logger_1.logger.error(`Could not replace '${replace}' with '${replacement}' in file '${filePath}'`);
+            logger_1.logger.error(error.message);
+        }
+    });
+}
+exports.replaceStringInFile = replaceStringInFile;

package/dist/cjs/utils/base_64_image/base-64-image.d.ts

@@ -1,18 +1,15 @@
-/// <reference types="node" />
+import type sharp from 'sharp';
 export declare class Base64Image {
-    private readonly aSharp;
-    private info;
     private buffer;
     static readonly strPrefix = "data:image/png;base64,";
+    private _sharp?;
     private constructor();
-    private static fromSharp;
     static fromPathOrString(pathOrStr: string): Promise<Base64Image>;
-    static fromPath(path: string): Promise<Base64Image>;
+    static fromPath(filePath: string): Promise<Base64Image>;
     static fromString(str: string): Promise<Base64Image>;
-    static fromBuffer(buffer: Buffer): Promise<Base64Image>;
-    get width(): number;
-    get height(): number;
+    private static fromBuffer;
+    private getSharp;
+    getInfo(): Promise<sharp.OutputInfo>;
     resizeToFitInto(dimension: number): Promise<Base64Image>;
     toString(): string;
-    toBuffer(): Buffer;
 }

package/dist/cjs/utils/base_64_image/base-64-image.js

@@ -13,36 +13,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Base64Image = void 0;
-const sharp_1 = __importDefault(require("sharp"));
+const fs_1 = __importDefault(require("fs"));
+const sharp_1 = require("./sharp");
 const base_64_image_string_error_1 = require("./base-64-image-string-error");
 class Base64Image {
-    constructor(aSharp, info, buffer) {
-        this.aSharp = aSharp;
-        this.info = info;
+    constructor(buffer) {
         this.buffer = buffer;
     }
-    static fromSharp(s) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { info, data } = yield s.toBuffer({ resolveWithObject: true });
-            return new Base64Image(s, info, data);
-        });
-    }
     static fromPathOrString(pathOrStr) {
         return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield Base64Image.fromString(pathOrStr);
-            }
-            catch (error) {
-                if (!(error instanceof base_64_image_string_error_1.Base64ImageStringError)) {
-                    throw error;
-                }
+            if (pathOrStr.startsWith(Base64Image.strPrefix)) {
+                return Base64Image.fromString(pathOrStr);
             }
             return Base64Image.fromPath(pathOrStr);
         });
     }
-    static fromPath(path) {
+    static fromPath(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp((0, sharp_1.default)(path));
+            const data = yield fs_1.default.promises.readFile(filePath, 'base64');
+            return Base64Image.fromString(`${Base64Image.strPrefix}${data}`);
         });
     }
     static fromString(str) {
@@ -51,36 +40,46 @@ class Base64Image {
                 throw new base_64_image_string_error_1.Base64ImageStringError(str, Base64Image.strPrefix);
             }
             const data = str.substring(Base64Image.strPrefix.length);
-            return Base64Image.fromSharp((0, sharp_1.default)(Buffer.from(data, 'base64')));
+            return new Base64Image(Buffer.from(data, 'base64'));
         });
     }
     static fromBuffer(buffer) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp((0, sharp_1.default)(buffer));
+            return new Base64Image(buffer);
         });
     }
-    get width() {
-        return this.info.width;
+    getSharp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._sharp === undefined) {
+                const createSharp = yield (0, sharp_1.getSharpFactory)();
+                this._sharp = createSharp(this.buffer);
+            }
+            return this._sharp;
+        });
     }
-    get height() {
-        return this.info.height;
+    getInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.getSharp())
+                .toBuffer({ resolveWithObject: true })
+                .then(({ info }) => info);
+        });
     }
     resizeToFitInto(dimension) {
         return __awaiter(this, void 0, void 0, function* () {
-            const buffer = yield this.aSharp.resize({
-                width: this.width >= this.height ? dimension : undefined,
-                height: this.height > this.width ? dimension : undefined,
-                fit: sharp_1.default.fit.contain,
-            }).toBuffer();
+            const { width, height } = yield this.getInfo();
+            const buffer = yield (yield this.getSharp())
+                .resize({
+                width: width >= height ? dimension : undefined,
+                height: height > width ? dimension : undefined,
+                fit: 'contain',
+            })
+                .toBuffer();
             return Base64Image.fromBuffer(buffer);
         });
     }
     toString() {
         return `${Base64Image.strPrefix}${this.buffer.toString('base64')}`;
     }
-    toBuffer() {
-        return this.buffer;
-    }
 }
 exports.Base64Image = Base64Image;
 Base64Image.strPrefix = 'data:image/png;base64,';

package/dist/cjs/utils/base_64_image/sharp.d.ts

@@ -0,0 +1,2 @@
+import type sharp from 'sharp';
+export declare function getSharpFactory(): Promise<typeof sharp>;

package/dist/cjs/utils/base_64_image/sharp.js

@@ -0,0 +1,56 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSharpFactory = void 0;
+let lazilyInitializedSharpFactory;
+class SharpImportError extends Error {
+}
+function dynamicallyImportSharp() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const sharp = yield Promise.resolve().then(() => __importStar(require('sharp')));
+            return sharp.default;
+        }
+        catch (err) {
+            throw new SharpImportError('Can\'t find "sharp" module to do resizing of image!'
+                + ' Please, install sharp for resizing support with'
+                + ' "npm install --save-dev sharp" or "npm install --save sharp".');
+        }
+    });
+}
+function getSharpFactory() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (lazilyInitializedSharpFactory === undefined) {
+            lazilyInitializedSharpFactory = yield dynamicallyImportSharp();
+        }
+        return lazilyInitializedSharpFactory;
+    });
+}
+exports.getSharpFactory = getSharpFactory;

package/dist/cjs/utils/proxy/proxy-builder.js

@@ -40,7 +40,9 @@ function dynmicImportHpagent() {
             return yield Promise.resolve().then(() => __importStar(require('hpagent')));
         }
         catch (err) {
-            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy!'
+                + ' Please, install hpagent for proxy support with'
+                + ' "npm install --save-dev hpagent" or "npm install --save hpagent".');
         }
     });
 }

package/dist/cjs/utils/transformations.js

@@ -28,13 +28,15 @@ function resizeBase64ImageWithSameRatio(base64ImageString, maxEdge = 1400) {
         lib_1.logger.debug('Image resizing');
         try {
             const image = yield base_64_image_1.Base64Image.fromString(base64ImageString);
-            if (image.height <= maxEdge && image.width <= maxEdge) {
+            const imageInfo = yield image.getInfo();
+            if (imageInfo.height <= maxEdge && imageInfo.width <= maxEdge) {
                 return { base64Image: base64ImageString, resizeRatio: 1 };
             }
             const resizedImage = yield image.resizeToFitInto(maxEdge);
+            const resizedImageInfo = yield resizedImage.getInfo();
             return {
                 base64Image: resizedImage.toString(),
-                resizeRatio: image.width / resizedImage.width,
+                resizeRatio: imageInfo.width / resizedImageInfo.width,
             };
         }
         catch (error) {

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

@@ -0,0 +1,75 @@
+/**
+ * Defines a 'custom element'. This is a UI element which is defined by
+ * providing an image and other parameters such as degree of rotation.
+ * It allows filtering for a UI element that is not recognized
+ * by our machine learning models by default.
+ * It can also be used for pixel assertions of elements using classical
+ * [template matching](https://en.wikipedia.org/wiki/Template_matching).
+ *
+ * **Important:** The `CustomElementJson` needs to capture as accurately as possible
+ * what the custom element looks like during test execution as otherwise
+ * our machine learning models cannot find it, even with the additional data
+ * provided. This is especially true for the resolution used while cropping
+ * the `CustomElementJson.customImage` which should match the resolution during
+ * test execution.
+ *
+ * Rotated custom elements can be filtered for using
+ * `CustomElementJson.rotationDegreePerStep`.
+ */
+export interface CustomElementJson {
+    /**
+     * An cropped image in form of a base64 string or file path,
+     * e.g., "./custom.png".
+     */
+    customImage: string;
+    /**
+     * A unique name which can be used for filtering for the custom element,
+     * e.g.,
+     * ```typescript
+     * ...customElement({
+     *   name: 'unique-name',
+     *   // ... (rest of the custom element)
+     * }).withText('unique-name')
+     * ```
+     *
+     * If not set, the text inside the custom element is
+     * detected via
+     * [OCR](https://en.wikipedia.org/wiki/Optical_character_recognition).
+     * It can also be used for filtering for the custom element.
+     */
+    name?: string | undefined;
+    /**
+     * A threshold for how similar UI elements shown during test execution
+     * need to be to the custom element as defined by the other fields in
+     * `CustomElementJson` to be recognized as such. Takes values between
+     * `0.0` (= all elements are recognized as the custom element which is
+     * probably not what you want) and `1.0` (= elements need to look exactly
+     * like defined by `CustomElementJson` which is unlikely to be achieved
+     * as even minor differences count). Defaults to `0.9`.
+     */
+    threshold?: number | undefined;
+    /**
+     * A step size in rotation degree. Rotates the custom image by
+     * `rotationDegreePerStep` until 360° is exceeded. Range is between
+     * 0° - 360°. Defaults to 0°.
+     *
+     * **Important**: This increases the prediction time quite a bit. So only use
+     * it when absolutely necessary.
+     */
+    rotationDegreePerStep?: number | undefined;
+    /**
+     * A color compare style. Allows matching a custom element by color, e.g.,
+     * instead of filtering for all icons (blue and green ones),
+     * only the green ones captured by `customImage` are filtered for using 'RGB'.
+     * Defaults to 'grayscale'.
+     *
+     * **Important**: This increases the prediction time quite a bit. So only use
+     * it when absolutely necessary.
+     */
+    imageCompareFormat?: 'RGB' | 'grayscale' | undefined;
+    /** A polygon to match only a certain area of the custom element. */
+    mask?: ({
+        x: number;
+        y: number;
+    })[] | undefined;
+}

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

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