askui 0.12.2 → 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/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 {};

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

@@ -0,0 +1,21 @@
+import { CustomElementJson } from './custom-element-json';
+export declare class CustomElement implements CustomElementJson {
+    customImage: string;
+    name?: string | undefined;
+    threshold?: number | undefined;
+    rotationDegreePerStep?: number | undefined;
+    imageCompareFormat?: "RGB" | "grayscale" | undefined;
+    mask?: {
+        x: number;
+        y: number;
+    }[] | undefined;
+    private static schema;
+    constructor(customImage: string, name?: string | undefined, threshold?: number | undefined, rotationDegreePerStep?: number | undefined, imageCompareFormat?: "RGB" | "grayscale" | undefined, mask?: {
+        x: number;
+        y: number;
+    }[] | undefined);
+    static fromJsonListWithImagePathOrImage(ceJson?: CustomElementJson[]): Promise<CustomElement[]>;
+    static fromJsonWithImagePathOrImage(ceJson: CustomElementJson): Promise<CustomElement>;
+    static fromJson(ceJson: CustomElementJson): CustomElement;
+    validate(): void;
+}

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

@@ -0,0 +1,50 @@
+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());
+    });
+};
+import { array, number, object, ValidationError, } from 'yup';
+import { Base64Image } from '../../../utils/base_64_image/base-64-image';
+export class CustomElement {
+    constructor(customImage, name, threshold, rotationDegreePerStep, imageCompareFormat, mask) {
+        this.customImage = customImage;
+        this.name = name;
+        this.threshold = threshold;
+        this.rotationDegreePerStep = rotationDegreePerStep;
+        this.imageCompareFormat = imageCompareFormat;
+        this.mask = mask;
+    }
+    static fromJsonListWithImagePathOrImage(ceJson = []) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Promise.all(ceJson.map((customElement) => CustomElement.fromJsonWithImagePathOrImage(customElement)));
+        });
+    }
+    static fromJsonWithImagePathOrImage(ceJson) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const customImage = (yield Base64Image.fromPathOrString(ceJson.customImage)).toString();
+            const customElement = CustomElement.fromJson(Object.assign(Object.assign({}, ceJson), { customImage }));
+            customElement.validate();
+            return customElement;
+        });
+    }
+    static fromJson(ceJson) {
+        return new CustomElement(ceJson.customImage, ceJson.name, ceJson.threshold, ceJson.rotationDegreePerStep, ceJson.imageCompareFormat, ceJson.mask);
+    }
+    validate() {
+        try {
+            CustomElement.schema.validateSync(this, { abortEarly: false, strict: true });
+        }
+        catch (e) { // ValidationError
+            throw new ValidationError(e.errors.join(', '));
+        }
+    }
+}
+CustomElement.schema = object({
+    threshold: number().optional().min(0).max(1),
+    rotationDegreePerStep: number().optional().min(0).lessThan(360),
+    mask: array().optional().min(3, 'mask must contain at least 3 points'),
+});

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

@@ -0,0 +1,3 @@
+export { CustomElement } from './custom-element';
+export { CustomElementJson } from './custom-element-json';
+export { TestStep } from './test-step';

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

@@ -0,0 +1 @@
+export { CustomElement } from './custom-element';

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

@@ -0,0 +1,6 @@
+import { CustomElement } from './custom-element';
+export interface TestStep {
+    instruction: string;
+    customElements?: CustomElement[];
+    secretText?: string | undefined;
+}

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

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

package/dist/esm/core/model/test-case-result-dto/index.d.ts

@@ -0,0 +1,2 @@
+export { TestStepResultDto } from './test-step-result-dto';
+export { TestStepState } from './test-step-state';

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

@@ -0,0 +1,2 @@
+export { TestStepResultDto } from './test-step-result-dto';
+export { TestStepState } from './test-step-state';

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

@@ -0,0 +1,9 @@
+import { TestStepState } from './test-step-state';
+export declare class TestStepResultDto {
+    state: TestStepState;
+    comment: string;
+    createDate: Date;
+    updateDate: Date;
+    constructor(state: TestStepState, comment?: string, createDate?: Date, updateDate?: Date);
+    static fromJson(testStepResult: TestStepResultDto): TestStepResultDto;
+}

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

@@ -0,0 +1,12 @@
+import { TestStepState } from './test-step-state';
+export class TestStepResultDto {
+    constructor(state, comment = '', createDate = new Date(), updateDate = new Date()) {
+        this.state = state;
+        this.comment = comment;
+        this.createDate = createDate;
+        this.updateDate = updateDate;
+    }
+    static fromJson(testStepResult) {
+        return new TestStepResultDto(TestStepState[testStepResult.state], testStepResult.comment, new Date(testStepResult.createDate), new Date(testStepResult.updateDate));
+    }
+}

package/dist/esm/core/model/test-case-result-dto/test-step-state.d.ts

@@ -0,0 +1,4 @@
+export declare enum TestStepState {
+    PASSED = "PASSED",
+    FAILED = "FAILED"
+}

package/dist/esm/core/model/test-case-result-dto/test-step-state.js

@@ -0,0 +1,5 @@
+export var TestStepState;
+(function (TestStepState) {
+    TestStepState["PASSED"] = "PASSED";
+    TestStepState["FAILED"] = "FAILED";
+})(TestStepState || (TestStepState = {}));

package/dist/esm/core/reporting/default-reporter.d.ts

@@ -0,0 +1,10 @@
+import { Step } from './step';
+export declare const DEFAULT_REPORTER: {
+    config: {
+        readonly withScreenshots: "onFailure";
+        readonly withDetectedElements: "onFailure";
+    };
+    onStepBegin: (_step: Step) => Promise<void>;
+    onStepRetry: (_step: Step) => Promise<void>;
+    onStepEnd: (_step: Step) => Promise<void>;
+};

package/dist/esm/core/reporting/default-reporter.js

@@ -0,0 +1,9 @@
+export const DEFAULT_REPORTER = {
+    config: {
+        withScreenshots: 'onFailure',
+        withDetectedElements: 'onFailure',
+    },
+    onStepBegin: (_step) => Promise.resolve(),
+    onStepRetry: (_step) => Promise.resolve(),
+    onStepEnd: (_step) => Promise.resolve(),
+};

package/dist/esm/execution/annotation-level.d.ts

@@ -0,0 +1,5 @@
+export declare enum AnnotationLevel {
+    DISABLED = "disabled",
+    ON_FAILURE = "onFailure",
+    ALL = "all"
+}

package/dist/esm/execution/annotation-level.js

@@ -0,0 +1,6 @@
+export var AnnotationLevel;
+(function (AnnotationLevel) {
+    AnnotationLevel["DISABLED"] = "disabled";
+    AnnotationLevel["ON_FAILURE"] = "onFailure";
+    AnnotationLevel["ALL"] = "all";
+})(AnnotationLevel || (AnnotationLevel = {}));

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

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

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

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

package/dist/esm/lib/index.d.ts

@@ -1,3 +1,4 @@
+export { init } from './interactive_cli';
 export { UnkownError } from './unkown-error';
 export { TimeoutError } from './timeout-error';
 export { UiController } from './ui-controller';

package/dist/esm/lib/index.js

@@ -1,3 +1,4 @@
+export { init } from './interactive_cli';
 export { UnkownError } from './unkown-error';
 export { TimeoutError } from './timeout-error';
 export { UiController } from './ui-controller';

package/dist/esm/lib/interactive_cli/add-script-package-json.d.ts

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

package/dist/esm/lib/interactive_cli/add-script-package-json.js

@@ -0,0 +1,31 @@
+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());
+    });
+};
+import fs from 'fs-extra';
+import { logger } from '../logger';
+export function addScript(filePath, name, command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const data = yield fs.readFile(filePath, 'utf8');
+            const jsonData = JSON.parse(data);
+            if (jsonData.scripts === undefined) {
+                jsonData.scripts = { [name]: `${command}` };
+            }
+            else {
+                jsonData.scripts[name] = command;
+            }
+            const jsonString = JSON.stringify(jsonData, null, 2);
+            yield fs.writeFile(filePath, jsonString, 'utf8');
+        }
+        catch (error) {
+            logger.error(`Could write script '${command}' in file '${filePath}'`);
+            logger.error(error.message);
+        }
+    });
+}