askui 0.3.2 → 0.5.0

package/dist/esm/execution/dsl.js

@@ -22,25 +22,38 @@ class FluentBase {
         });
         return paramsList;
     }
-    commandStringBuilder(currentInstruction = '', paramsList = new Map()) {
+    fluentCommandStringBuilder(currentInstruction = '', paramsList = new Map()) {
         const newCurrentInstruction = `${this.textStr} ${currentInstruction}`;
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof FluentCommand) {
             const fluentCommand = this;
             const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
-            return fluentCommand.exec(newCurrentInstruction.trim(), customElements);
+            return fluentCommand.fluentCommandExecutor(newCurrentInstruction.trim(), customElements);
         }
         if (!this.prev) {
             throw new Error('Prev element not defined');
         }
-        return this.prev.commandStringBuilder(newCurrentInstruction, newParamsList);
+        return this.prev.fluentCommandStringBuilder(newCurrentInstruction, newParamsList);
+    }
+    getterStringBuilder(currentInstruction = '', paramsList = new Map()) {
+        const newCurrentInstruction = `${this.textStr} ${currentInstruction}`;
+        const newParamsList = FluentBase.addParams(paramsList, this._params);
+        if (this instanceof Getter) {
+            const getter = this;
+            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
+            return getter.getterExecutor(newCurrentInstruction.trim(), customElements);
+        }
+        if (!this.prev) {
+            throw new Error('Prev element not defined');
+        }
+        return this.prev.getterStringBuilder(newCurrentInstruction, newParamsList);
     }
     get textStr() { return this._textStr; }
     get params() { return this._params; }
 }
 export class Exec extends FluentBase {
     exec() {
-        return this.commandStringBuilder();
+        return this.fluentCommandStringBuilder();
     }
 }
 // Filters
@@ -781,6 +794,120 @@ export class FluentFilters extends FluentBase {
 }
 // Relations
 export class FluentFiltersOrRelations extends FluentFilters {
+    /**
+     * Logic or operator
+     *
+     * **Examples:**
+     * ```text
+     * scene 1
+     * --------------  ---------------
+     * |  button    |  |  icon       |
+     * --------------  ---------------
+     *
+     * scene 2
+     * --------------  ---------------
+     * |  button    |  |  text       |
+     * --------------  ---------------
+     *
+     * ```
+     * In case, that your reference element can have multiple values, in the following example, the element right of the button can be either icon or text.
+     * You can use **the `or()` relation**, so your teststep is valid for both scenes
+     * ```typescript
+     * const button = await aui.get().button().rightOf().icon().or().text().exec();
+     * console.log(button);
+     * ```
+     * Returns the same button for both cases
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'BUTTON',
+     *      text: 'button',
+     *      colors: [ 'red', 'black', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFilters}
+     */
+    or() {
+        this._textStr = 'or';
+        return new FluentFilters(this);
+    }
+    /**
+     * Logic and operator
+     *
+     * **Examples:**
+     * ```text
+     * example scene:
+     *  --------------------------   --------------------------
+     *  |  icon user colored black | |  icon  user colored red |
+     *  --------------------------   --------------------------
+     * ```
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').exec();
+     * console.log(icons);
+     * ```
+     * Using only the filter withText, the get command will return both icons because they share the same text
+     * ```text
+     * console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'black', 'black', 'black' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 1000,
+     *         ymin: 1010,
+     *         xmax: 1020,
+     *         ymax: 1030
+     *      }
+     *   },
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     * You can combine filters with **the `and()` relation** and specify exactly which icon you want
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').and().colored('red').exec()
+     * console.log(icons)
+     * ```
+     * The get command returns only the red icon although both icons have the same text
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFilters}
+     */
+    and() {
+        this._textStr = 'and';
+        return new FluentFilters(this);
+    }
     /**
      * Filters for an element inside another element.
      *
@@ -950,7 +1077,7 @@ export class FluentFiltersOrRelations extends FluentFilters {
         return new FluentFilters(this);
     }
     exec() {
-        return this.commandStringBuilder();
+        return this.fluentCommandStringBuilder();
     }
 }
 // Filters
@@ -1691,6 +1818,120 @@ export class FluentFiltersCondition extends FluentBase {
 }
 // Relations
 export class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
+    /**
+     * Logic or operator
+     *
+     * **Examples:**
+     * ```text
+     * scene 1
+     * --------------  ---------------
+     * |  button    |  |  icon       |
+     * --------------  ---------------
+     *
+     * scene 2
+     * --------------  ---------------
+     * |  button    |  |  text       |
+     * --------------  ---------------
+     *
+     * ```
+     * In case, that your reference element can have multiple values, in the following example, the element right of the button can be either icon or text.
+     * You can use **the `or()` relation**, so your teststep is valid for both scenes
+     * ```typescript
+     * const button = await aui.get().button().rightOf().icon().or().text().exec();
+     * console.log(button);
+     * ```
+     * Returns the same button for both cases
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'BUTTON',
+     *      text: 'button',
+     *      colors: [ 'red', 'black', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFiltersCondition}
+     */
+    or() {
+        this._textStr = 'or';
+        return new FluentFiltersCondition(this);
+    }
+    /**
+     * Logic and operator
+     *
+     * **Examples:**
+     * ```text
+     * example scene:
+     *  --------------------------   --------------------------
+     *  |  icon user colored black | |  icon  user colored red |
+     *  --------------------------   --------------------------
+     * ```
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').exec();
+     * console.log(icons);
+     * ```
+     * Using only the filter withText, the get command will return both icons because they share the same text
+     * ```text
+     * console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'black', 'black', 'black' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 1000,
+     *         ymin: 1010,
+     *         xmax: 1020,
+     *         ymax: 1030
+     *      }
+     *   },
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     * You can combine filters with **the `and()` relation** and specify exactly which icon you want
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').and().colored('red').exec()
+     * console.log(icons)
+     * ```
+     * The get command returns only the red icon although both icons have the same text
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFiltersCondition}
+     */
+    and() {
+        this._textStr = 'and';
+        return new FluentFiltersCondition(this);
+    }
     /**
      * Filters for an element inside another element.
      *
@@ -1993,7 +2234,7 @@ export class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     moveMouse(x_coordinate, y_coordinate) {
-        this._textStr = `Move mouse to  x ${x_coordinate} y ${y_coordinate}`;
+        this._textStr = `Move mouse to x ${x_coordinate} y ${y_coordinate}`;
         return new Exec(this);
     }
     /**
@@ -2166,3 +2407,1121 @@ export class FluentCommand extends FluentBase {
         return new Exec(this);
     }
 }
+export class ExecGetter extends FluentBase {
+    exec() {
+        return this.getterStringBuilder();
+    }
+}
+// Filters
+export class FluentFiltersGetter extends FluentBase {
+    /**
+     * Filters for a UI element 'wizard item active'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizardItemActive() {
+        this._textStr = 'wizard item active';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'wizard item'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizardItem() {
+        this._textStr = 'wizard item';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'wizard'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizard() {
+        this._textStr = 'wizard';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'windows bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    windowsBar() {
+        this._textStr = 'windows bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'window'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    window() {
+        this._textStr = 'window';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'video'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    video() {
+        this._textStr = 'video';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'url'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    url() {
+        this._textStr = 'url';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'tooltip'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tooltip() {
+        this._textStr = 'tooltip';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'textfield'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    textfield() {
+        this._textStr = 'textfield';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'textarea'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    textarea() {
+        this._textStr = 'textarea';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'table row'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableRow() {
+        this._textStr = 'table row';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'table header'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableHeader() {
+        this._textStr = 'table header';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'table column'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableColumn() {
+        this._textStr = 'table column';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'table'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    table() {
+        this._textStr = 'table';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'tab selected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabSelected() {
+        this._textStr = 'tab selected';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'tab bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabBar() {
+        this._textStr = 'tab bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'tab active'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabActive() {
+        this._textStr = 'tab active';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'tab'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tab() {
+        this._textStr = 'tab';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'switch enabled'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    switchEnabled() {
+        this._textStr = 'switch enabled';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'switch disabled'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    switchDisabled() {
+        this._textStr = 'switch disabled';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'status bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    statusBar() {
+        this._textStr = 'status bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'slider indicator'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    sliderIndicator() {
+        this._textStr = 'slider indicator';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'slider'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    slider() {
+        this._textStr = 'slider';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'sidebar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    sidebar() {
+        this._textStr = 'sidebar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'scroll bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    scrollBar() {
+        this._textStr = 'scroll bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'rect'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    rect() {
+        this._textStr = 'rect';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'recaptcha'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    recaptcha() {
+        this._textStr = 'recaptcha';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'rate'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    rate() {
+        this._textStr = 'rate';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'radio button unselected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    radioButtonUnselected() {
+        this._textStr = 'radio button unselected';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'radio button selected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    radioButtonSelected() {
+        this._textStr = 'radio button selected';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'progressbar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    progressbar() {
+        this._textStr = 'progressbar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'progress bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    progressBar() {
+        this._textStr = 'progress bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'popover'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    popover() {
+        this._textStr = 'popover';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'pil'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    pil() {
+        this._textStr = 'pil';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'password'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    password() {
+        this._textStr = 'password';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'pager'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    pager() {
+        this._textStr = 'pager';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'navigation bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    navigationBar() {
+        this._textStr = 'navigation bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'mouse text'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mouseText() {
+        this._textStr = 'mouse text';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'mouse pointer'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mousePointer() {
+        this._textStr = 'mouse pointer';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'mouse cursor'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mouseCursor() {
+        this._textStr = 'mouse cursor';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'modal'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    modal() {
+        this._textStr = 'modal';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'message box'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    messageBox() {
+        this._textStr = 'message box';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'map'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    map() {
+        this._textStr = 'map';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'logo'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    logo() {
+        this._textStr = 'logo';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'link'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    link() {
+        this._textStr = 'link';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'keyboard'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    keyboard() {
+        this._textStr = 'keyboard';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'image'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    image() {
+        this._textStr = 'image';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'header'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    header() {
+        this._textStr = 'header';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'footer'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    footer() {
+        this._textStr = 'footer';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'flag'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    flag() {
+        this._textStr = 'flag';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'dropdown menu'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    dropdownMenu() {
+        this._textStr = 'dropdown menu';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'divider'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    divider() {
+        this._textStr = 'divider';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'circle'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    circle() {
+        this._textStr = 'circle';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'checkbox unchecked'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkboxUnchecked() {
+        this._textStr = 'checkbox unchecked';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'checkbox checked'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkboxChecked() {
+        this._textStr = 'checkbox checked';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'chart pie'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    chartPie() {
+        this._textStr = 'chart pie';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'chart'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    chart() {
+        this._textStr = 'chart';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'card'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    card() {
+        this._textStr = 'card';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'browser bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    browserBar() {
+        this._textStr = 'browser bar';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'breadcrumb'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    breadcrumb() {
+        this._textStr = 'breadcrumb';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'banner'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    banner() {
+        this._textStr = 'banner';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'badge'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    badge() {
+        this._textStr = 'badge';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'alert'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    alert() {
+        this._textStr = 'alert';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'unknown'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    unknown() {
+        this._textStr = 'unknown';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for an UI element 'button'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    button() {
+        this._textStr = 'button';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for an UI element 'text'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    text() {
+        this._textStr = 'text';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for an UI element 'dropdown'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    dropdown() {
+        this._textStr = 'dropdown';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for an UI element 'icon'.
+     *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    icon() {
+        this._textStr = 'icon';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a custom UI element (see {@link CustomElementJson}).
+     *
+     * **Important**: This increases the runtime quite a bit. So
+     *  only use it when absolutely necessary.
+     *
+     * @param {CustomElementJson} customElement - The custom element to filter for.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    customElement(customElement) {
+        this._textStr = 'custom element';
+        this._params.set('customElement', customElement);
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for a UI element 'checkbox' checked or unchecked.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkbox() {
+        this._textStr = 'checkbox';
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for similar (doesn't need to be a 100% equal) text.
+     *
+     * **Examples:**
+     * ```typescript
+     * 'text' === withText('text') => true
+     * 'test' === withText('text') => true
+     * 'other' === withText('text') => false
+     * ```
+     *
+     * @param {string} text - A text to be matched.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    withText(text) {
+        this._textStr = `with text ${Separators.STRING}${text}${Separators.STRING}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    withTextRegex(regex_pattern) {
+        this._textStr = `match regex pattern ${Separators.STRING}${regex_pattern}${Separators.STRING}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for equal text.
+     *
+     * **Note:** This should be only used in cases where the similarity
+     *  comparison of {@link FluentFilters.withText()} allows not for
+     *  specific enough filtering (too many elements).
+     *
+     * **Examples:**
+     * ```typescript
+     * 'text' === withExactText('text') => true
+     * 'test' === withExactText('text') => false
+     * 'other' === withExactText('text') => false
+     * ```
+     *
+     * @param {string} text - A text to be matched.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    withExactText(text) {
+        this._textStr = `equals text ${Separators.STRING}${text}${Separators.STRING}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for text containing the text provided as an argument.
+     *
+     * **Examples:**
+     * ```typescript
+     * 'This is an text' === containsText('text') => true
+     * 'This is an text' === containsText('other text') => false
+     * 'This is an text' === containsText('other') => false
+     * ```
+     *
+     * @param {string} text - A text to be matched.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    containsText(text) {
+        this._textStr = `contain text ${Separators.STRING}${text}${Separators.STRING}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+    /**
+     * Filters for elements having a specific color.
+     *
+     * @param {COLOR} color - A color to match
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    colored(color) {
+        this._textStr = `with color ${color}`;
+        return new FluentFiltersOrRelationsGetter(this);
+    }
+}
+// Relations
+export class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
+    /**
+     * Logic or operator
+     *
+     * **Examples:**
+     * ```text
+     * scene 1
+     * --------------  ---------------
+     * |  button    |  |  icon       |
+     * --------------  ---------------
+     *
+     * scene 2
+     * --------------  ---------------
+     * |  button    |  |  text       |
+     * --------------  ---------------
+     *
+     * ```
+     * In case, that your reference element can have multiple values, in the following example, the element right of the button can be either icon or text.
+     * You can use **the `or()` relation**, so your teststep is valid for both scenes
+     * ```typescript
+     * const button = await aui.get().button().rightOf().icon().or().text().exec();
+     * console.log(button);
+     * ```
+     * Returns the same button for both cases
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'BUTTON',
+     *      text: 'button',
+     *      colors: [ 'red', 'black', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    or() {
+        this._textStr = 'or';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Logic and operator
+     *
+     * **Examples:**
+     * ```text
+     * example scene:
+     *  --------------------------   --------------------------
+     *  |  icon user colored black | |  icon  user colored red |
+     *  --------------------------   --------------------------
+     * ```
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').exec();
+     * console.log(icons);
+     * ```
+     * Using only the filter withText, the get command will return both icons because they share the same text
+     * ```text
+     * console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'black', 'black', 'black' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 1000,
+     *         ymin: 1010,
+     *         xmax: 1020,
+     *         ymax: 1030
+     *      }
+     *   },
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     * You can combine filters with **the `and()` relation** and specify exactly which icon you want
+     * ```typescript
+     * const icons = await aui.get().icon().withText('user').and().colored('red').exec()
+     * console.log(icons)
+     * ```
+     * The get command returns only the red icon although both icons have the same text
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'user',
+     *      colors: [ 'red', 'red', 'red' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 900,
+     *         ymin: 910,
+     *         xmax: 920,
+     *         ymax: 930
+     *      }
+     *   }
+     *  ]
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    and() {
+        this._textStr = 'and';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element inside another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------------
+     * |     outerEl      |
+     * |  --------------  |
+     * |  |  innerEl   |  |
+     * |  --------------  |
+     * |                  |
+     * --------------------
+     *
+     * // Returns innerEl because innerEl is inside outerEl
+     * ...innerEl().in().outerEl()
+     * // Returns nothing because innerEl is not inside outerEl
+     * ...outerEl().in().innerEl()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    in() {
+        this._textStr = 'in';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element right of another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------  --------------
+     * |  leftEl    |  |  rightEl   |
+     * --------------  --------------
+     *
+     * // Returns rightEl because rightEl is right of leftEl
+     * ...rightEl().rightOf().leftEl()
+     * // Returns no element because leftEl is left of rightEl
+     * ...leftEl().rightOf().rightEl()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    rightOf() {
+        this._textStr = 'right of';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element left of another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------  --------------
+     * |  leftEl    |  |  rightEl   |
+     * --------------  --------------
+     *
+     * // Returns leftEl because leftEl is left of rightEl
+     * ...leftEl().leftOf().rightEl()
+     * // Returns no element because rightEl is left of leftEl
+     * ...rightEl().leftOf().leftEl()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    leftOf() {
+        this._textStr = 'left of';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element below another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------
+     * |    text    |
+     * --------------
+     * --------------
+     * |   button   |
+     * --------------
+     *
+     * // Returns button because button is below text
+     * ...button().below().text()
+     * // Returns no element because text is above button
+     * ...text().below().button()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    below() {
+        this._textStr = 'below';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element above another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------
+     * |    text    |
+     * --------------
+     * --------------
+     * |   button   |
+     * --------------
+     *
+     * // Returns text because text is above button
+     * ...text().above().button()
+     * // Returns no element because button is below text
+     * ...button().above().text()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    above() {
+        this._textStr = 'above';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element nearest to another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * --------------
+     * |  button 1  |
+     * --------------
+     * --------------
+     * |   text     |
+     * --------------
+     *
+     *
+     *
+     * --------------
+     * |  button 2  |
+     * --------------
+     *
+     * // Returns button 1 because button 1 is nearer to the text than button 2
+     * ...button().nearestTo().text()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    nearestTo() {
+        this._textStr = 'nearest to';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Filters for an element containing another element.
+     *
+     * **Example:**
+     * ```typescript
+     * --------------------
+     * |     outerEl      |
+     * |  --------------  |
+     * |  |  innerEl   |  |
+     * |  --------------  |
+     * |                  |
+     * --------------------
+     *
+     * // Returns outerEl because outerEl contains innerEl
+     * ...outerEl().contains().innerEl()
+     * //  Returns no element because innerEl contains no outerEl
+     * ...innerEl().contains().outerEl()
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    contains() {
+        this._textStr = 'contains';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
+    exec() {
+        return this.getterStringBuilder();
+    }
+}
+// Commands
+export class Getter extends FluentCommand {
+    /**
+     * Returns an array with all filtered elements.
+     * A detected element has the following properties:
+     * - `name` of the element
+     * - `text` content of element
+     * - `colors` of element
+     * - `bndbox`: location of element described with coordinates of a bounding box
+     * **Examples:**
+     * ```typescript
+     * const text = await aui.get().text().withText('Sign').exec();
+     * console.log(text);
+     * ```
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'TEXT',
+     *      text: 'Sign In',
+     *      colors: [ 'black', 'gray', 'gray' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 1128.2720982142857,
+     *         ymin: 160.21332310267857,
+     *         xmax: 1178.8204241071428,
+     *         ymax: 180.83512834821428
+     *      }
+     *  }
+     *  ]
+     * ```
+     *
+     * @return {FluentFiltersGetter}
+     */
+    get() {
+        this._textStr = 'get element';
+        return new FluentFiltersGetter(this);
+    }
+    /**
+     * Returns an array with all detected elements.
+     * A detected element has the following properties:
+     * - `name` of the element
+     * - `text` content of element
+     * - `colors` of element
+     * - `bndbox`: location of element described with coordinates of a bounding box
+     * **Examples:**
+     * ```typescript
+     * const detectedElements = await aui.getAll().exec();
+     * console.log(detectedElements);
+     * ```
+     * ```text
+     *  console output: [
+     *   DetectedElement {
+     *      name: 'TEXT',
+     *      text: 'Sign In',
+     *      colors: [ 'black', 'gray', 'gray' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 1128.2720982142857,
+     *         ymin: 160.21332310267857,
+     *         xmax: 1178.8204241071428,
+     *         ymax: 180.83512834821428
+     *      },
+     *   DetectedElement {
+     *      name: 'ICON',
+     *      text: 'search',
+     *      colors: [ 'black', 'red', 'gray' ],
+     *      bndbox: BoundingBox {
+     *         xmin: 250.8204241071428,
+     *         ymin: 300.21332310267857,
+     *         xmax: 450.6304241071428,
+     *         ymax: 950.47812834821428
+     *      },
+     *      ... 381 more items
+     *  }
+     *  ]
+     * ```
+     *
+     * @return {ExecGetter}
+     */
+    getAll() {
+        this._textStr = 'get all elements';
+        return new ExecGetter(this);
+    }
+}
+export class ApiCommands extends Getter {
+}