askui 0.20.3 → 0.20.5

package/dist/cjs/core/ui-control-commands/action.d.ts

@@ -1,4 +1,7 @@
 import { InputEvent } from './input-event';
+export declare type ActionParameters = {
+    [key: string]: string | number | boolean | string[] | ActionParameters;
+};
 export declare class Action {
     inputEvent: InputEvent;
     position: {
@@ -6,9 +9,10 @@ export declare class Action {
         y: number;
     };
     text: string;
+    parameters: ActionParameters;
     constructor(inputEvent: InputEvent, position: {
         x: number;
         y: number;
-    }, text: string);
+    }, text: string, parameters?: ActionParameters);
     static fromJson(action: Action, resizeRatio?: number): Action;
 }

package/dist/cjs/core/ui-control-commands/action.js

@@ -3,16 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Action = void 0;
 const input_event_1 = require("./input-event");
 class Action {
-    constructor(inputEvent, position, text) {
+    constructor(inputEvent, position, text, parameters = {}) {
         this.inputEvent = inputEvent;
         this.position = position;
         this.text = text;
+        this.parameters = parameters;
     }
     static fromJson(action, resizeRatio = 1) {
         return new Action(input_event_1.InputEvent[action.inputEvent], {
             x: action.position.x * resizeRatio,
             y: action.position.y * resizeRatio,
-        }, action.text);
+        }, action.text, action.parameters ? action.parameters : {});
     }
 }
 exports.Action = Action;

package/dist/cjs/core/ui-control-commands/control-command.js

@@ -16,7 +16,7 @@ class ControlCommand {
     }
     setTextToBeTyped(text) {
         this.actions = this.actions.map((action) => ([input_event_1.InputEvent.TYPE, input_event_1.InputEvent.TYPE_TEXT].includes(action.inputEvent)
-            ? new action_1.Action(action.inputEvent, action.position, text) : action));
+            ? new action_1.Action(action.inputEvent, action.position, text, action.parameters) : action));
     }
 }
 exports.ControlCommand = ControlCommand;

package/dist/cjs/execution/dsl.d.ts

@@ -1913,11 +1913,12 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.execOnShell("chrome").exec();
      * ```
      *
-     * @param {string} shell_command - A shell command which is executed.
+     * @param {string} shellCommand - A shell command which is executed.
+     * @param {number} [timeoutInMilliseconds=1] - A timeout in milliseconds.
      *
      * @return {Exec}
      */
-    execOnShell(shell_command: string): Exec;
+    execOnShell(shellCommand: string, timeoutInMilliseconds?: number): Exec;
     /**
      * Clicks with left mouse key.
      *
@@ -2962,10 +2963,10 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      */
     contains(): FluentFiltersGetter;
     /**
-     * Returns a list of detected elements
-     *
-     * @return {DetectedElement[]}
-     */
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
     exec(): Promise<DetectedElement[]>;
 }
 export declare abstract class Getter extends FluentCommand {

package/dist/cjs/execution/dsl.js

@@ -6,6 +6,33 @@
 // Autogenerated from typescript.template file
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiCommands = exports.Getter = exports.FluentFiltersOrRelationsGetter = exports.FluentFiltersGetter = exports.ExecGetter = exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.Exec = exports.Separators = void 0;
+function isStackTraceCodeline(line) {
+    return /[ \t]+at .+/.test(line);
+}
+function splitStackTrace(stacktrace) {
+    const errorStackTraceLines = stacktrace.split('\n');
+    const errorIndexOfFirstCodeLine = errorStackTraceLines.findIndex(isStackTraceCodeline);
+    const errorStacktraceHead = errorStackTraceLines.slice(0, errorIndexOfFirstCodeLine);
+    const errorStacktraceCodeLines = errorStackTraceLines.slice(errorIndexOfFirstCodeLine);
+    return { head: errorStacktraceHead, codelines: errorStacktraceCodeLines };
+}
+function rewriteStackTraceForError(error, newStackTrace) {
+    const errorCopy = new Error(error.message);
+    if (!error.stack) {
+        errorCopy.stack = newStackTrace;
+        return errorCopy;
+    }
+    const errorStacktraceSplit = splitStackTrace(error.stack);
+    const newStacktraceSplit = splitStackTrace(newStackTrace);
+    errorCopy.stack = [
+        ...errorStacktraceSplit.head,
+        ...newStacktraceSplit.codelines,
+        ' ',
+        ...errorStacktraceSplit.head,
+        ...errorStacktraceSplit.codelines,
+    ].join('\n');
+    return errorCopy;
+}
 var Separators;
 (function (Separators) {
     Separators["STRING"] = "<|string|>";
@@ -30,12 +57,8 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof FluentCommand) {
             const fluentCommand = this;
-            const customElements = newParamsList.has('customElement')
-                ? newParamsList.get('customElement')
-                : [];
-            const aiElementNames = newParamsList.has('aiElementName')
-                ? newParamsList.get('aiElementName')
-                : [];
+            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
+            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
             return fluentCommand.fluentCommandExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -51,12 +74,8 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof Getter) {
             const getter = this;
-            const customElements = newParamsList.has('customElement')
-                ? newParamsList.get('customElement')
-                : [];
-            const aiElementNames = newParamsList.has('aiElementName')
-                ? newParamsList.get('aiElementName')
-                : [];
+            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
+            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
             return getter.getterExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -67,16 +86,14 @@ class FluentBase {
         }
         return this.prev.getterStringBuilder(newCurrentInstruction, newParamsList);
     }
-    get textStr() {
-        return this._textStr;
-    }
-    get params() {
-        return this._params;
-    }
+    get textStr() { return this._textStr; }
+    get params() { return this._params; }
 }
 class Exec extends FluentBase {
     exec() {
-        return this.fluentCommandStringBuilder();
+        const originStacktrace = { stack: '' };
+        Error.captureStackTrace(originStacktrace, this.exec);
+        return this.fluentCommandStringBuilder().catch((err) => Promise.reject(rewriteStackTraceForError(err, originStacktrace.stack)));
     }
 }
 exports.Exec = Exec;
@@ -1074,7 +1091,9 @@ class FluentFiltersOrRelations extends FluentFilters {
         return new FluentFilters(this);
     }
     exec() {
-        return this.fluentCommandStringBuilder();
+        const originStacktrace = { stack: '' };
+        Error.captureStackTrace(originStacktrace, this.exec);
+        return this.fluentCommandStringBuilder().catch((err) => Promise.reject(rewriteStackTraceForError(err, originStacktrace.stack)));
     }
 }
 exports.FluentFiltersOrRelations = FluentFiltersOrRelations;
@@ -2433,16 +2452,20 @@ class FluentCommand extends FluentBase {
      * await aui.execOnShell("chrome").exec();
      * ```
      *
-     * @param {string} shell_command - A shell command which is executed.
+     * @param {string} shellCommand - A shell command which is executed.
+     * @param {number} [timeoutInMilliseconds=1] - A timeout in milliseconds.
      *
      * @return {Exec}
      */
-    execOnShell(shell_command) {
+    execOnShell(shellCommand, timeoutInMilliseconds = 1) {
         this._textStr = '';
         this._textStr += 'Execute';
         this._textStr += ' shell';
         this._textStr += ' command';
-        this._textStr += ` ${Separators.STRING}${shell_command}${Separators.STRING}`;
+        this._textStr += ` ${Separators.STRING}${shellCommand}${Separators.STRING}`;
+        if (timeoutInMilliseconds !== undefined) {
+            this._textStr += ` with ${timeoutInMilliseconds} milliseconds timeout`;
+        }
         return new Exec(this);
     }
     /**
@@ -3751,10 +3774,10 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
         return new FluentFiltersGetter(this);
     }
     /**
-     * Returns a list of detected elements
-     *
-     * @return {DetectedElement[]}
-     */
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
     exec() {
         return this.getterStringBuilder();
     }

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

@@ -20,6 +20,7 @@ export declare class CreateExampleProject {
     private static installTestFrameworkPackages;
     private addUserCredentials;
     private copyESLintConfigFiles;
+    private copyGitignore;
     private copyTsConfigFile;
     createExampleProject(): Promise<void>;
 }

package/dist/cjs/lib/interactive_cli/create-example-project.js

@@ -237,6 +237,25 @@ class CreateExampleProject {
             ];
         });
     }
+    copyGitignore() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const gitignoreFilePath = path_1.default.join('example_projects_templates', 'typescript', '.gitignore');
+            return [{
+                    title: 'Copy .gitignore',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        return new listr_1.default([
+                            {
+                                title: 'Add .gitignore',
+                                task: () => __awaiter(this, void 0, void 0, function* () {
+                                    return fs_extra_1.default.copyFile(path_1.default.join((0, path_2.getPathToNodeModulesRoot)(), gitignoreFilePath), path_1.default.join(this.projectRootDirectoryPath, '.gitignore'));
+                                }),
+                            },
+                        ]);
+                    }),
+                },
+            ];
+        });
+    }
     copyTsConfigFile() {
         return __awaiter(this, void 0, void 0, function* () {
             const tsConfigFilePath = path_1.default.join('example_projects_templates', 'typescript', 'tsconfig.json');
@@ -261,6 +280,7 @@ class CreateExampleProject {
                 ...(yield this.copyTemplateProject()),
                 ...(yield this.setupTestFrameWork()),
                 ...(yield this.copyESLintConfigFiles()),
+                ...(yield this.copyGitignore()),
                 ...(yield this.copyTsConfigFile()),
                 ...(yield this.addUserCredentials()),
                 ...(yield this.createAskUIHelperFromTemplate()),

package/dist/esm/core/ui-control-commands/action.d.ts

@@ -1,4 +1,7 @@
 import { InputEvent } from './input-event';
+export declare type ActionParameters = {
+    [key: string]: string | number | boolean | string[] | ActionParameters;
+};
 export declare class Action {
     inputEvent: InputEvent;
     position: {
@@ -6,9 +9,10 @@ export declare class Action {
         y: number;
     };
     text: string;
+    parameters: ActionParameters;
     constructor(inputEvent: InputEvent, position: {
         x: number;
         y: number;
-    }, text: string);
+    }, text: string, parameters?: ActionParameters);
     static fromJson(action: Action, resizeRatio?: number): Action;
 }

package/dist/esm/core/ui-control-commands/action.js

@@ -1,14 +1,15 @@
 import { InputEvent } from './input-event';
 export class Action {
-    constructor(inputEvent, position, text) {
+    constructor(inputEvent, position, text, parameters = {}) {
         this.inputEvent = inputEvent;
         this.position = position;
         this.text = text;
+        this.parameters = parameters;
     }
     static fromJson(action, resizeRatio = 1) {
         return new Action(InputEvent[action.inputEvent], {
             x: action.position.x * resizeRatio,
             y: action.position.y * resizeRatio,
-        }, action.text);
+        }, action.text, action.parameters ? action.parameters : {});
     }
 }

package/dist/esm/core/ui-control-commands/control-command.js

@@ -13,6 +13,6 @@ export class ControlCommand {
     }
     setTextToBeTyped(text) {
         this.actions = this.actions.map((action) => ([InputEvent.TYPE, InputEvent.TYPE_TEXT].includes(action.inputEvent)
-            ? new Action(action.inputEvent, action.position, text) : action));
+            ? new Action(action.inputEvent, action.position, text, action.parameters) : action));
     }
 }

package/dist/esm/execution/dsl.d.ts

@@ -1913,11 +1913,12 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.execOnShell("chrome").exec();
      * ```
      *
-     * @param {string} shell_command - A shell command which is executed.
+     * @param {string} shellCommand - A shell command which is executed.
+     * @param {number} [timeoutInMilliseconds=1] - A timeout in milliseconds.
      *
      * @return {Exec}
      */
-    execOnShell(shell_command: string): Exec;
+    execOnShell(shellCommand: string, timeoutInMilliseconds?: number): Exec;
     /**
      * Clicks with left mouse key.
      *
@@ -2962,10 +2963,10 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      */
     contains(): FluentFiltersGetter;
     /**
-     * Returns a list of detected elements
-     *
-     * @return {DetectedElement[]}
-     */
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
     exec(): Promise<DetectedElement[]>;
 }
 export declare abstract class Getter extends FluentCommand {

package/dist/esm/execution/dsl.js

@@ -3,6 +3,33 @@
 /* eslint-disable max-classes-per-file */
 /* eslint-disable max-len */
 // Autogenerated from typescript.template file
+function isStackTraceCodeline(line) {
+    return /[ \t]+at .+/.test(line);
+}
+function splitStackTrace(stacktrace) {
+    const errorStackTraceLines = stacktrace.split('\n');
+    const errorIndexOfFirstCodeLine = errorStackTraceLines.findIndex(isStackTraceCodeline);
+    const errorStacktraceHead = errorStackTraceLines.slice(0, errorIndexOfFirstCodeLine);
+    const errorStacktraceCodeLines = errorStackTraceLines.slice(errorIndexOfFirstCodeLine);
+    return { head: errorStacktraceHead, codelines: errorStacktraceCodeLines };
+}
+function rewriteStackTraceForError(error, newStackTrace) {
+    const errorCopy = new Error(error.message);
+    if (!error.stack) {
+        errorCopy.stack = newStackTrace;
+        return errorCopy;
+    }
+    const errorStacktraceSplit = splitStackTrace(error.stack);
+    const newStacktraceSplit = splitStackTrace(newStackTrace);
+    errorCopy.stack = [
+        ...errorStacktraceSplit.head,
+        ...newStacktraceSplit.codelines,
+        ' ',
+        ...errorStacktraceSplit.head,
+        ...errorStacktraceSplit.codelines,
+    ].join('\n');
+    return errorCopy;
+}
 export var Separators;
 (function (Separators) {
     Separators["STRING"] = "<|string|>";
@@ -27,12 +54,8 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof FluentCommand) {
             const fluentCommand = this;
-            const customElements = newParamsList.has('customElement')
-                ? newParamsList.get('customElement')
-                : [];
-            const aiElementNames = newParamsList.has('aiElementName')
-                ? newParamsList.get('aiElementName')
-                : [];
+            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
+            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
             return fluentCommand.fluentCommandExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -48,12 +71,8 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof Getter) {
             const getter = this;
-            const customElements = newParamsList.has('customElement')
-                ? newParamsList.get('customElement')
-                : [];
-            const aiElementNames = newParamsList.has('aiElementName')
-                ? newParamsList.get('aiElementName')
-                : [];
+            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
+            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
             return getter.getterExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -64,16 +83,14 @@ class FluentBase {
         }
         return this.prev.getterStringBuilder(newCurrentInstruction, newParamsList);
     }
-    get textStr() {
-        return this._textStr;
-    }
-    get params() {
-        return this._params;
-    }
+    get textStr() { return this._textStr; }
+    get params() { return this._params; }
 }
 export class Exec extends FluentBase {
     exec() {
-        return this.fluentCommandStringBuilder();
+        const originStacktrace = { stack: '' };
+        Error.captureStackTrace(originStacktrace, this.exec);
+        return this.fluentCommandStringBuilder().catch((err) => Promise.reject(rewriteStackTraceForError(err, originStacktrace.stack)));
     }
 }
 // Filters
@@ -1069,7 +1086,9 @@ export class FluentFiltersOrRelations extends FluentFilters {
         return new FluentFilters(this);
     }
     exec() {
-        return this.fluentCommandStringBuilder();
+        const originStacktrace = { stack: '' };
+        Error.captureStackTrace(originStacktrace, this.exec);
+        return this.fluentCommandStringBuilder().catch((err) => Promise.reject(rewriteStackTraceForError(err, originStacktrace.stack)));
     }
 }
 // Filters
@@ -2425,16 +2444,20 @@ export class FluentCommand extends FluentBase {
      * await aui.execOnShell("chrome").exec();
      * ```
      *
-     * @param {string} shell_command - A shell command which is executed.
+     * @param {string} shellCommand - A shell command which is executed.
+     * @param {number} [timeoutInMilliseconds=1] - A timeout in milliseconds.
      *
      * @return {Exec}
      */
-    execOnShell(shell_command) {
+    execOnShell(shellCommand, timeoutInMilliseconds = 1) {
         this._textStr = '';
         this._textStr += 'Execute';
         this._textStr += ' shell';
         this._textStr += ' command';
-        this._textStr += ` ${Separators.STRING}${shell_command}${Separators.STRING}`;
+        this._textStr += ` ${Separators.STRING}${shellCommand}${Separators.STRING}`;
+        if (timeoutInMilliseconds !== undefined) {
+            this._textStr += ` with ${timeoutInMilliseconds} milliseconds timeout`;
+        }
         return new Exec(this);
     }
     /**
@@ -3740,10 +3763,10 @@ export class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
         return new FluentFiltersGetter(this);
     }
     /**
-     * Returns a list of detected elements
-     *
-     * @return {DetectedElement[]}
-     */
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
     exec() {
         return this.getterStringBuilder();
     }

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

@@ -20,6 +20,7 @@ export declare class CreateExampleProject {
     private static installTestFrameworkPackages;
     private addUserCredentials;
     private copyESLintConfigFiles;
+    private copyGitignore;
     private copyTsConfigFile;
     createExampleProject(): Promise<void>;
 }

package/dist/esm/lib/interactive_cli/create-example-project.js

@@ -231,6 +231,25 @@ export class CreateExampleProject {
             ];
         });
     }
+    copyGitignore() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const gitignoreFilePath = path.join('example_projects_templates', 'typescript', '.gitignore');
+            return [{
+                    title: 'Copy .gitignore',
+                    task: () => __awaiter(this, void 0, void 0, function* () {
+                        return new Listr([
+                            {
+                                title: 'Add .gitignore',
+                                task: () => __awaiter(this, void 0, void 0, function* () {
+                                    return fs.copyFile(path.join(getPathToNodeModulesRoot(), gitignoreFilePath), path.join(this.projectRootDirectoryPath, '.gitignore'));
+                                }),
+                            },
+                        ]);
+                    }),
+                },
+            ];
+        });
+    }
     copyTsConfigFile() {
         return __awaiter(this, void 0, void 0, function* () {
             const tsConfigFilePath = path.join('example_projects_templates', 'typescript', 'tsconfig.json');
@@ -255,6 +274,7 @@ export class CreateExampleProject {
                 ...(yield this.copyTemplateProject()),
                 ...(yield this.setupTestFrameWork()),
                 ...(yield this.copyESLintConfigFiles()),
+                ...(yield this.copyGitignore()),
                 ...(yield this.copyTsConfigFile()),
                 ...(yield this.addUserCredentials()),
                 ...(yield this.createAskUIHelperFromTemplate()),

package/dist/example_projects_templates/configs/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
       "module": "CommonJS",
       "esModuleInterop": true,
-      "moduleResolution": "node"
+      "moduleResolution": "node",
+      "sourceMap": true
     }
   }

package/dist/example_projects_templates/templates/askui-helper-windows.nj

@@ -17,12 +17,16 @@ beforeAll(async () => {
 });
 
 beforeEach(async () => {
+  /* Uncomment to enable video recording
   await aui.startVideoRecording();
+  */
 });
 
 afterEach(async () => {
+  /* Uncomment to enable video recording
   await aui.stopVideoRecording();
   {{ allure_stepreporter_attach_video }}
+  */
 });
 
 afterAll(async () => {

package/dist/example_projects_templates/templates/askui-helper.nj

@@ -29,12 +29,16 @@ beforeAll(async () => {
 });
 
 beforeEach(async () => {
+  /* Uncomment to enable video recording
   await aui.startVideoRecording();
+  */
 });
 
 afterEach(async () => {
+  /* Uncomment to enable video recording
   await aui.stopVideoRecording();
   {{ allure_stepreporter_attach_video }}
+  */
 });
 
 afterAll(async () => {

package/dist/example_projects_templates/typescript/tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "module": "CommonJS",
     "esModuleInterop": true,
-    "moduleResolution": "node"
+    "moduleResolution": "node",
+    "sourceMap": true
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.20.3",
+    "version": "0.20.5",
     "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",