askui 0.12.1 → 0.13.0

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);
+        }
+    });
+}

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

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

package/dist/esm/lib/interactive_cli/cli-options-interface.js

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

package/dist/esm/lib/interactive_cli/cli.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function init(argv: string[]): Command;

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

@@ -0,0 +1,108 @@
+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 inquirer from 'inquirer';
+import { Command, Option } from 'commander';
+import { CreateExampleProject } from './create-example-project';
+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'],
+    },
+    {
+        type: 'input',
+        name: 'workspaceId',
+        message: 'Your workspace id',
+        validate: nonEmpty('workspace id'),
+    },
+    {
+        type: 'password',
+        name: 'accessToken',
+        message: 'Your access token',
+        mask: '*',
+        validate: nonEmpty('access token'),
+    },
+    {
+        type: 'confirm',
+        name: 'usingProxy',
+        message: 'Are you using a proxy?',
+        default: false,
+    },
+    {
+        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,
+    },
+];
+const options = [
+    {
+        option: '-f, --test-framework <value>',
+        choices: ['jasmine', 'jest'],
+        description: 'the test framework to use',
+    },
+    {
+        option: '-w, --workspace-id <value>',
+        choices: [],
+        description: 'a workspace id',
+    },
+    {
+        option: '-a, --access-token <value>',
+        choices: [],
+        description: 'an access token for the workspace with the id',
+    },
+    {
+        option: '-p, --using-proxy <value>',
+        choices: ['true', 'false'],
+        description: 'use a proxy',
+    },
+    {
+        option: '-t, --typescript-config <value>',
+        choices: ['true', 'false'],
+        description: 'overwrite tsconfig.json flag',
+    },
+];
+const createProgram = () => {
+    const program = new Command('askui');
+    program.usage('<command> [options]');
+    return program;
+};
+export function init(argv) {
+    const args = argv || process.argv;
+    const program = createProgram();
+    const programInit = program.command('init');
+    programInit.description('Creates a askui example project');
+    // Loop through the options object and register each option with the program
+    options.forEach((opt) => {
+        const tempOption = new Option(opt.option, opt.description);
+        if (opt.choices.length > 0) {
+            tempOption.choices(opt.choices);
+        }
+        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* () {
+        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.prompt(missingOptions).then((answers) => __awaiter(this, void 0, void 0, function* () {
+                yield new CreateExampleProject(Object.assign(Object.assign({}, userAnswers), answers)).createExampleProject();
+            }));
+        }
+        else {
+            yield new CreateExampleProject(userAnswers).createExampleProject();
+        }
+    }));
+    return program.parse(args);
+}

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

@@ -0,0 +1,26 @@
+import { CliOptions } from './cli-options-interface';
+export declare class CreateExampleProject {
+    readonly cliOptions: CliOptions;
+    private distexampleFolderPath;
+    private exampleFolderName;
+    private baseDirPath;
+    private proxyDocUrl;
+    private remoteDeviceControllerUrl;
+    private helperTemplateConfig;
+    constructor(cliOptions: CliOptions);
+    private copyTemplateProject;
+    private copyTestFrameworkConfig;
+    private addTestFrameWorkTimeout;
+    private addReporterConfig;
+    private addAskuiRunCommand;
+    private addESLintRunCommand;
+    private createAskUIHelperFromTemplate;
+    private setupTestFrameWork;
+    private installTestFrameworkPackages;
+    private addUserCredentails;
+    private copyESLintConfigFiles;
+    private copyTsConfigFile;
+    private installProxy;
+    private normalizeCliOptions;
+    createExampleProject(): Promise<void>;
+}