askui 0.13.0 → 0.14.0

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

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

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

@@ -1,6 +0,0 @@
-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

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

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

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

package/dist/esm/lib/copy-example-project.d.ts

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

package/dist/esm/lib/copy-example-project.js

@@ -1,58 +0,0 @@
-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 { Command } from 'commander';
-import path from 'path';
-import fs from 'fs-extra';
-import { getPathToNodeModulesRoot } from '../utils/path';
-import { logger } from './logger';
-const createProgram = () => {
-    const program = new Command('askui');
-    program.usage('<command> [options]');
-    return program;
-};
-function replaceStringInFile(filePath, replace, replacement) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const data = yield fs.readFile(filePath, 'utf8');
-            const result = data.replace(replace, replacement);
-            yield fs.writeFile(filePath, result, 'utf8');
-        }
-        catch (error) {
-            logger.error(`Could not replace '${replace}' with '${replacement}' in file '${path}'`);
-            logger.error(error.message);
-        }
-    });
-}
-function copyExampleProject(options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const exampleProjectPath = path.join('example_projects_templates', 'typescript_jest');
-        fs.copySync(path.join(getPathToNodeModulesRoot(), exampleProjectPath), '.');
-        if (options['workspaceId']) {
-            yield replaceStringInFile('./test/helper/jest.setup.ts', '<your workspace id>', options['workspaceId']);
-        }
-        if (options['accessToken']) {
-            yield replaceStringInFile('./test/helper/jest.setup.ts', '<your access token>', options['accessToken']);
-        }
-    });
-}
-export function init(argv) {
-    const args = argv || process.argv;
-    const program = createProgram();
-    program
-        .command('init')
-        .description('creates a typescript example project')
-        .option('-w, --workspace-id <value>', 'a workspace id')
-        .option('-a, --access-token <value>', 'an access token for the workspace with the id')
-        .usage('[-w workspace_id] [-a access_token]')
-        .action((opts) => __awaiter(this, void 0, void 0, function* () {
-        yield copyExampleProject(opts);
-    }));
-    return program.parse(args);
-}

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

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

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

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

package/dist/example_projects_templates/typescript/.eslintignore

@@ -1 +0,0 @@
-node_modules

package/dist/example_projects_templates/typescript/.eslintrc.json

@@ -1,20 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": [
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "plugins": [
-    "import",
-    "askui"
-  ],
-  "rules": {
-      "askui/no-missing-askui-exec": "error"
-  }
-}

package/dist/example_projects_templates/typescript/askui_example/helpers/askui-helper.ts

@@ -1,39 +0,0 @@
-import { UiControlClient, UiController } from 'askui';
-
-// Server for controlling the operating system
-let uiController: UiController;
-
-// Client is necessary to use the askui API
-// eslint-disable-next-line import/no-mutable-exports
-let aui: UiControlClient;
-
-// timeout_placeholder
-
-beforeAll(async () => {
-  uiController = new UiController({
-    /**
-     * Select the display you want to run your tests on, display 0 is your main display;
-     * ignore if you have only one display
-     */
-    display: 0,
-  });
-
-  await uiController.start();
-
-  aui = await UiControlClient.build({
-    credentials: {
-      workspaceId: '<your workspace id>',
-      token: '<your access token>',
-    },
-  });
-
-  await aui.connect();
-});
-
-afterAll(async () => {
-  aui.close();
-
-  await uiController.stop();
-});
-
-export { aui };

package/dist/example_projects_templates/typescript_jest/test/README.md

@@ -1,21 +0,0 @@
-# AskUI First Run
-Example of using the askui SDK.
-The lib helps to control the operating system with
-commands.
-Using Jest as runner framework to execute all your
-AskUI workflows.
-
-## Installation of Jest and Typescript
-
-Use following command to set up Jest:
-```shell
-npm i -D jest @types/jest ts-jest typescript 
-```
-
-## How to execute the example
-
-This can be executed with the following command:
-```shell
-npx jest --config ./test/jest.config.ts
-```
-

package/dist/example_projects_templates/typescript_jest/test/helper/jest.setup.ts

@@ -1,51 +0,0 @@
-import { UiControlClient, UiController } from 'askui';
-import { AskUIAllureStepReporter } from '@askui/askui-reporters';
-
-// Server for controlling the operating system
-let uiController: UiController;
-
-// Client is necessary to use the askui API
-// eslint-disable-next-line import/no-mutable-exports
-let aui: UiControlClient;
-
-jest.setTimeout(60 * 1000 * 60);
-
-beforeAll(async () => {
-  uiController = new UiController({
-    /**
-     * Select the display you want to run your tests on, display 0 is your main display;
-     * ignore if you have only one display
-     */
-    display: 0,
-  });
-
-  await uiController.start();
-
-  aui = await UiControlClient.build({
-    credentials: {
-      workspaceId: '<your workspace id>',
-      token: '<your access token>',
-    },
-    reporter: new AskUIAllureStepReporter(),
-  });
-
-  await aui.connect();
-});
-
-beforeEach(async () => {
-  await aui.startVideoRecording();
-});
-
-afterEach(async () => {
-  await aui.stopVideoRecording();
-  const video = await aui.readVideoRecording();
-  AskUIAllureStepReporter.attachVideo(video);
-});
-
-afterAll(async () => {
-  aui.disconnect();
-
-  await uiController.stop();
-});
-
-export { aui };

package/dist/example_projects_templates/typescript_jest/test/jest.config.ts

@@ -1,13 +0,0 @@
-import type { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  testEnvironment: '@askui/jest-allure-circus',
-  setupFilesAfterEnv: ['./helper/jest.setup.ts'],
-  sandboxInjectedGlobals: [
-    'Math',
-  ],
-};
-
-// eslint-disable-next-line import/no-default-export
-export default config;

package/dist/example_projects_templates/typescript_jest/test/my-first-askui-test-suite.test.ts

@@ -1,21 +0,0 @@
-import { aui } from './helper/jest.setup';
-
-describe('jest with askui', () => {
-  it('should generate an (interactive) annotation', async () => {
-    // For Windows users:
-    // Use annotate() to create an annotated HTML file
-    // of your screen that is saved under <project_root>/report
-    await aui.annotate();
-
-    // Uncomment for macOS and Linux
-    // Delete the lines above to not trigger annotate()
-    // await aui.annotateInteractively();
-  });
-
-  it('should click on my element', async () => {
-    await aui
-      .click();
-    // <INSERT YOUR COPIED ELEMENT DESCRIPTION HERE AND UNCOMMENT THIS AND THE NEXT LINE>
-    // .exec();
-  });
-});

package/dist/example_projects_templates/typescript_jest/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "CommonJS",
-    "esModuleInterop": true,
-    "moduleResolution": "node"
-  }
-}