askui 0.12.2 → 0.13.0

package/README.md

@@ -1,50 +1,44 @@
-# askui - Humanizing UI Automation
+# AskUI - Humanizing UI Automation
 
-**askui** allows you to automate the interaction with an application, multiple applications or even the entire operating system. 
+**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:
+To use **AskUI** follow these steps:
 
-### 0. Create *node.js* project
+### 0. Initialize AskUI with All Needed Dependencies
 
-```
-npm init
-```
-
-### 1. Install askui with Needed Dependencies
+Answer the questions to set up **AskUI** when you run this command.
 
 ```
-npm i -D askui typescript ts-node @types/jest ts-jest jest
+npx askui@latest init
 ```
 
-### 2. Create your First Test
+### 1. Execute Your First Instruction
 
-```
-npx askui init
-```
+[Request an **Access Token** first.](https://docs.askui.com/docs/general/Getting%20Started/getting-started#access-token)
 
-### 3. Execute the Test
+Then follow [our guide](https://docs.askui.com/docs/general/Getting%20Started/write-your-first-instruction#configuration) to run your first instruction: 
 
 ```
-npx jest test/my-first-askui-test-suite.test.ts --config ./test/jest.config.ts 
+npm run askui
 ```
 
 ## Documentation
 
-Visit our [documentation](https://docs.askui.com) for examples and a full list of supported commands.
+Visit our [documentation](https://docs.askui.com) for examples and a [full list of supported instructions](https://docs.askui.com/docs/api/API/table-of-contents).
 
 ### Notes
 
 Important note for Linux users: Currently, Wayland is not supported.
 You can read more in our [troubleshooting chapter](https://docs.askui.com/docs/general/Troubleshooting/linux#wayland).
-If you want to use the askui library libfuse2 is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2)).
+If you want to use the AskUI library `libfuse2`` is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2)).
 
 ## Example
 
-The following example shows the use of **askui** for testing a desktop application.
+The following example shows the use of **AskUI** for testing a desktop application.
 
 ```typescript
 it('should be able to add to liked songs', async () => {

package/bin/askui

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../dist/cjs/lib/copy-example-project').init();
+require('../dist/cjs/lib').init();

package/dist/cjs/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/cjs/core/model/test-case-dto/custom-element-json.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/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/cjs/core/model/test-case-dto/custom-element.js

@@ -0,0 +1,54 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomElement = void 0;
+const yup_1 = require("yup");
+const base_64_image_1 = require("../../../utils/base_64_image/base-64-image");
+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 base_64_image_1.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 yup_1.ValidationError(e.errors.join(', '));
+        }
+    }
+}
+exports.CustomElement = CustomElement;
+CustomElement.schema = (0, yup_1.object)({
+    threshold: (0, yup_1.number)().optional().min(0).max(1),
+    rotationDegreePerStep: (0, yup_1.number)().optional().min(0).lessThan(360),
+    mask: (0, yup_1.array)().optional().min(3, 'mask must contain at least 3 points'),
+});

package/dist/cjs/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/cjs/core/model/test-case-dto/index.js

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

package/dist/cjs/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/cjs/core/model/test-case-dto/test-step.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/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/cjs/core/model/test-case-result-dto/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestStepState = exports.TestStepResultDto = void 0;
+var test_step_result_dto_1 = require("./test-step-result-dto");
+Object.defineProperty(exports, "TestStepResultDto", { enumerable: true, get: function () { return test_step_result_dto_1.TestStepResultDto; } });
+var test_step_state_1 = require("./test-step-state");
+Object.defineProperty(exports, "TestStepState", { enumerable: true, get: function () { return test_step_state_1.TestStepState; } });

package/dist/cjs/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/cjs/core/model/test-case-result-dto/test-step-result-dto.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestStepResultDto = void 0;
+const test_step_state_1 = require("./test-step-state");
+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(test_step_state_1.TestStepState[testStepResult.state], testStepResult.comment, new Date(testStepResult.createDate), new Date(testStepResult.updateDate));
+    }
+}
+exports.TestStepResultDto = TestStepResultDto;

package/dist/cjs/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/cjs/core/model/test-case-result-dto/test-step-state.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestStepState = void 0;
+var TestStepState;
+(function (TestStepState) {
+    TestStepState["PASSED"] = "PASSED";
+    TestStepState["FAILED"] = "FAILED";
+})(TestStepState = exports.TestStepState || (exports.TestStepState = {}));

package/dist/cjs/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/cjs/core/reporting/default-reporter.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_REPORTER = void 0;
+exports.DEFAULT_REPORTER = {
+    config: {
+        withScreenshots: 'onFailure',
+        withDetectedElements: 'onFailure',
+    },
+    onStepBegin: (_step) => Promise.resolve(),
+    onStepRetry: (_step) => Promise.resolve(),
+    onStepEnd: (_step) => Promise.resolve(),
+};

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

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

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnotationLevel = void 0;
+var AnnotationLevel;
+(function (AnnotationLevel) {
+    AnnotationLevel["DISABLED"] = "disabled";
+    AnnotationLevel["ON_FAILURE"] = "onFailure";
+    AnnotationLevel["ALL"] = "all";
+})(AnnotationLevel = exports.AnnotationLevel || (exports.AnnotationLevel = {}));

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

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

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiControlClientError = void 0;
+class UiControlClientError extends Error {
+}
+exports.UiControlClientError = UiControlClientError;

package/dist/cjs/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/cjs/lib/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.UiController = exports.TimeoutError = exports.UnkownError = void 0;
+exports.logger = exports.UiController = exports.TimeoutError = exports.UnkownError = exports.init = void 0;
+var interactive_cli_1 = require("./interactive_cli");
+Object.defineProperty(exports, "init", { enumerable: true, get: function () { return interactive_cli_1.init; } });
 var unkown_error_1 = require("./unkown-error");
 Object.defineProperty(exports, "UnkownError", { enumerable: true, get: function () { return unkown_error_1.UnkownError; } });
 var timeout_error_1 = require("./timeout-error");

package/dist/cjs/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/cjs/lib/interactive_cli/add-script-package-json.js

@@ -0,0 +1,38 @@
+"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.addScript = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const logger_1 = require("../logger");
+function addScript(filePath, name, command) {
+    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) {
+                jsonData.scripts = { [name]: `${command}` };
+            }
+            else {
+                jsonData.scripts[name] = command;
+            }
+            const jsonString = JSON.stringify(jsonData, null, 2);
+            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(error.message);
+        }
+    });
+}
+exports.addScript = addScript;

package/dist/cjs/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/cjs/lib/interactive_cli/cli-options-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,115 @@
+"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.init = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const commander_1 = require("commander");
+const create_example_project_1 = require("./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 commander_1.Command('askui');
+    program.usage('<command> [options]');
+    return program;
+};
+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 commander_1.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_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();
+        }
+    }));
+    return program.parse(args);
+}
+exports.init = init;

package/dist/cjs/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>;
+}