askui 0.12.2 → 0.13.1

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

@@ -0,0 +1,39 @@
+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/askui_example/my-first-askui-test-suite.test.ts

@@ -0,0 +1,21 @@
+import { aui } from './helpers/askui-helper';
+
+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();
+  });
+
+  xit('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/tsconfig.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.12.2",
+    "version": "0.13.1",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",
@@ -49,13 +49,17 @@
         "dist/example_projects_templates/"
     ],
     "dependencies": {
+        "chalk": "4.1.1",
         "commander": "8.3.0",
         "fkill": "7.2.1",
         "fs-extra": "10.0.0",
         "got": "11.8.6",
+        "inquirer": "8.2.5",
         "jsdom": "20.0.0",
+        "listr": "0.14.3",
         "lodash": "^4.17.21",
         "node-machine-id": "1.1.12",
+        "nunjucks": "^3.2.4",
         "pino": "7.8.1",
         "pino-pretty": "7.5.3",
         "tough-cookie": "4.1.2",
@@ -66,9 +70,12 @@
     },
     "devDependencies": {
         "@types/fs-extra": "9.0.13",
+        "@types/inquirer": "9.0.3",
         "@types/jest": "27.4.0",
         "@types/jsdom": "20.0.0",
+        "@types/listr": "0.14.4",
         "@types/node": "17.0.10",
+        "@types/nunjucks": "^3.2.5",
         "@types/sharp": "0.30.4",
         "@types/url-join": "4.0.1",
         "@types/webrtc": "0.0.30",